xref: /freebsd/share/man/man5/bluetooth.device.conf.5 (revision e4e9813eb92cd7c4d4b819a8fbed5cbd3d92f5d8)
1.\" Copyright (c) 2005 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd Dec 1, 2005
28.Dt BLUETOOTH.DEVICE.CONF 5
29.Os
30.Sh NAME
31.Nm bluetooth.device.conf
32.Nd Bluetooth device configuration file
33.Sh DESCRIPTION
34Bluetooth device configuration framework provides ability to adjust certain
35Bluetooth device parameters on per-device basis.
36.Pp
37Bluetooth device configuration files are plain text files that should conform
38to basic
39.Xr sh 1
40syntax.
41Even though Bluetooth device are not exactly shell scripts,
42they are parsed and passed through shell
43.Cm eval
44command.
45This makes it possible to use various shell tricks in the Bluetooth device
46configuration files.
47.Pp
48The
49.Pa /etc/rc.d/bluetooth
50script is used to start and stop Bluetooth devices.
51This script is not executed by default when system boots.
52It is called by
53.Xr devd 8
54in response to Bluetooth device arrival and departure events.
55It is possible to execute this script by hand if required.
56The script accepts Bluetooth device driver name as an extra parameter.
57.Pp
58The system wide Bluetooth device configuration file is called
59.Pa /etc/defaults/bluetooth.device.conf .
60Configuration parameters set in the system wide Bluetooth device configuration
61file apply to every Bluetooth device connected to the system.
62.Pp
63Configuration parameters overrides for the specific Bluetooth device
64should be placed in the
65.Pa /etc/bluetooth/DEVICE_DRIVER_NAME.conf
66file.
67Where
68.Va DEVICE_DRIVER_NAME
69is the device driver name of the Bluetooth device.
70.Pp
71The following list provides a name and short description for each
72variable that can be set in a Bluetooth device configuration file.
73.Bl -tag -width indent-two
74.It Va authentication_enable
75.Pq Vt bool
76The
77.Va authentication_enable
78parameter controls if the device requires to authenticate the remote device
79at connection setup.
80If set to
81.Dq Li YES ,
82the device will try to authenticate the other device at connection setup.
83Bluetooth authentication requests are handled by
84.Xr hcsecd 8
85daemon.
86.It Va class
87.Pq Vt str
88The
89.Va class
90parameter is used to indicate the capabilities of the device to
91other devices.
92For more details see
93https://www.bluetooth.org/foundry/assignnumb/document/baseband.
94.It Va connectable
95.Pq Vt bool
96The
97.Va connectable
98parameter controls whether or not the device should periodically scan for
99page attempts from other devices.
100If set to
101.Dq Li YES ,
102the device will periodically scan for page attempts from other devices.
103.It Va discoverable
104.Pq Vt bool
105The
106.Va discoverable
107parameter controls whether or not the device should periodically scan for
108inquiry requests from other devices.
109If set to
110.Dq Li YES ,
111the device will periodically scan for inquiry requests from other devices.
112.It Va encryption_mode
113.Pq Vt str
114The
115.Va encryption_mode
116parameter controls if the device requires encryption to the remote device
117at connection setup.
118At connection setup, only the devices with the
119.Va authentication_enable
120parameter enabled and
121.Va encryption_mode
122parameter enabled will try to encrypt the connection to the other device.
123Possible values are
124.Dq Li NONE
125encryption disabled,
126.Dq Li P2P
127encryption for only point-to-point packets,
128or
129.Dq Li ALL
130encryption for both point-to-point and broadcast packets.
131.It Va hci_debug_level
132.Pq Vt int
133HCI node debug level.
134Higher values mean more verbose output.
135.It Va l2cap_debug_level
136.Pq Vt int
137L2CAP node debug level.
138Higher values mean more verbose output.
139.It Va local_name
140.Pq Vt str
141The
142.Va local_name
143parameter provides the ability to modify the user friendly name for the device.
144.It Va role_switch
145.Pq Vt bool
146The
147.Va role_switch
148parameter controls whether the local device should perform role switch.
149By default, if role switch is supported, the local device will try to perform
150role switch and become Master on incoming connection.
151Some devices do not support role switch and thus incoming connections from
152such devices will fail.
153If
154.Va role switch
155is disabled then accepting device will remain Slave.
156.Sh EXAMPLES
157.Bl -tag -width ".Pa /etc/bluetooth/ubt0.conf"
158.It Pa /etc/bluetooth/ubt0.conf
159file should be used to specify configuration parameters overrides for the
160first USB Bluetooth device
161.Pq device driver name is ubt0 .
162.It Pa /etc/bluetooth/ubt1.conf
163file should be used to specify configuration parameters overrides for the
164second USB Bluetooth device.
165.El
166.Sh FILES
167.Bl -tag -width ".Pa /etc/defaults/bluetooth.device.conf" -compact
168.It Pa /etc/defaults/bluetooth.device.conf
169.It Pa /etc/rc.d/bluetooth
170.El
171.Sh SEE ALSO
172.Xr ng_bt3c 4 ,
173.Xr ng_h4 4 ,
174.Xr ng_hci 4 ,
175.Xr ng_l2cap 4 ,
176.Xr ng_ubt 4 ,
177.Xr devd 8 ,
178.Xr hccontrol 8 ,
179.Xr hcsecd 8 ,
180.Xr l2control 8
181.Sh AUTHORS
182.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
183