xref: /freebsd/share/man/man4/ng_bluetooth.4 (revision 397e83df75e0fcd0d3fcb95ae4d794cb7600fc89)
1.\" Copyright (c) 2001-2002 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.\" $Id: ng_bluetooth.4,v 1.3 2003/05/21 19:37:35 max Exp $
26.\"
27.Dd November 9, 2002
28.Dt NG_BLUETOOTH 4
29.Os
30.Sh NAME
31.Nm ng_bluetooth
32.Nd placeholder for global Bluetooth variables
33.Sh SYNOPSIS
34.In sys/types.h
35.In netgraph/bluetooth/include/ng_bluetooth.h
36.Sh DESCRIPTION
37The
38.Nm
39module is a placeholder for global Bluetooth variables.
40All Bluetooth variables can be examined and changed via
41.Xr sysctl 8 .
42.Ss Bluetooth Variables
43Below is the description of default variables.
44Each Bluetooth module might add its own variables to the tree.
45.Bl -tag -width foo
46.It Va net.bluetooth.version
47A read-only integer variable that shows the current version of the
48Bluetooth stack.
49.It Va net.bluetooth.hci.command_timeout
50A read-write integer variable that controls the Host Controller Interface
51(HCI) command timeout (in seconds), i.e., how long the HCI layer will wait
52for the
53.Dv Command_Complete
54or
55.Dv Command_Status
56event from a Bluetooth device.
57.It Va net.bluetooth.hci.connection_timeout
58A read-write integer variable that controls the HCI connection timeout, i.e.\&
59how long the HCI layer will wait for the
60.Dv Connection_Complete
61event.
62Normally this should not be required as Bluetooth devices have
63connection timeout of their own and will send event back.
64This timeout
65is required to ensure that no connection will stall in case when the HCI
66transport layer is broken.
67Be careful when changing this variable.
68Make sure you understand what you are doing.
69.It Va net.bluetooth.hci.max_neighbor_age
70A read-write integer variable that controls time-to-live (in seconds) for
71entries in the HCI neighbor cache.
72Every time a Bluetooth device performs an
73.Dv Inquiry
74operation, the results will be put in cache.
75Later when a Bluetooth device
76establishes a baseband connection, it will try to find the matching entry in
77the cache and use it.
78This might speed up establishment of the baseband
79connection.
80.It Va net.bluetooth.l2cap.rtx_timeout
81A read-write integer variable that controls the Link Layer Control and
82Adaptation Protocol (L2CAP) Retransmission Timeout (RTX) (in seconds).
83Every time the L2CAP layer submits a control command, the RTX timeout is set.
84The value of the RTX timeout should be greater or equal to the value of
85the HCI connection timeout.
86Be careful when changing this variable.
87Make sure you understand what you are doing.
88.It Va net.bluetooth.l2cap.ertx_timeout
89A read-write integer variable that controls the L2CAP Extended Retransmission
90Timeout (ERTX) (in seconds).
91In some cases remote peer may respond with
92.Dv PENDING
93status to the L2CAP control command.
94In this case the L2CAP command timeout is reset to the ERTX timeout value.
95The value of the ERTX timeout should be
96greater or equal to the value of the RTX timeout.
97Be careful when changing this variable.
98Make sure you understand what you are doing.
99.El
100.Sh SEE ALSO
101.Xr ng_btsocket 4 ,
102.Xr ng_hci 4 ,
103.Xr ng_l2cap 4 ,
104.Xr sysctl 8
105.Sh HISTORY
106The
107.Nm
108module was implemented in
109.Fx 5.0 .
110.Sh AUTHORS
111.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
112