summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/ng_bluetooth.4 3.html
blob: bb4b6b05b51b521a5adf72ec474691b1efb85311 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<table class="head">
  <tr>
    <td class="head-ltitle">NG_BLUETOOTH(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">NG_BLUETOOTH(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">ng_bluetooth</code> &#x2014;
    <span class="Nd">placeholder for global Bluetooth variables</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include
    &lt;<a class="In">sys/types.h</a>&gt;</code>
  <br/>
  <code class="In">#include
    &lt;<a class="In">netgraph/bluetooth/include/ng_bluetooth.h</a>&gt;</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">ng_bluetooth</code> module is a placeholder
    for global Bluetooth variables. All Bluetooth variables can be examined and
    changed via <a class="Xr">sysctl(8)</a>.</p>
<section class="Ss">
<h2 class="Ss" id="Bluetooth_Variables"><a class="permalink" href="#Bluetooth_Variables">Bluetooth
  Variables</a></h2>
<p class="Pp">Below is the description of default variables. Each Bluetooth
    module might add its own variables to the tree.</p>
<dl class="Bl-tag">
  <dt id="net.bluetooth.version"><var class="Va">net.bluetooth.version</var></dt>
  <dd>A read-only integer variable that shows the current version of the
      Bluetooth stack.</dd>
  <dt id="net.bluetooth.hci.command_timeout"><var class="Va">net.bluetooth.hci.command_timeout</var></dt>
  <dd>A read-write integer variable that controls the Host Controller Interface
      (HCI) command timeout (in seconds), i.e., how long the HCI layer will wait
      for the <code class="Dv">Command_Complete</code> or
      <code class="Dv">Command_Status</code> event from a Bluetooth device.</dd>
  <dt id="net.bluetooth.hci.connection_timeout"><var class="Va">net.bluetooth.hci.connection_timeout</var></dt>
  <dd>A read-write integer variable that controls the HCI connection timeout,
      i.e. how long the HCI layer will wait for the
      <code class="Dv">Connection_Complete</code> event. Normally this should
      not be required as Bluetooth devices have connection timeout of their own
      and will send event back. This timeout is required to ensure that no
      connection will stall in case when the HCI transport layer is broken. Be
      careful when changing this variable. Make sure you understand what you are
      doing.</dd>
  <dt id="net.bluetooth.hci.max_neighbor_age"><var class="Va">net.bluetooth.hci.max_neighbor_age</var></dt>
  <dd>A read-write integer variable that controls time-to-live (in seconds) for
      entries in the HCI neighbor cache. Every time a Bluetooth device performs
      an <code class="Dv">Inquiry</code> operation, the results will be put in
      cache. Later when a Bluetooth device establishes a baseband connection, it
      will try to find the matching entry in the cache and use it. This might
      speed up establishment of the baseband connection.</dd>
  <dt id="net.bluetooth.l2cap.rtx_timeout"><var class="Va">net.bluetooth.l2cap.rtx_timeout</var></dt>
  <dd>A read-write integer variable that controls the Link Layer Control and
      Adaptation Protocol (L2CAP) Retransmission Timeout (RTX) (in seconds).
      Every time the L2CAP layer submits a control command, the RTX timeout is
      set. The value of the RTX timeout should be greater or equal to the value
      of the HCI connection timeout. Be careful when changing this variable.
      Make sure you understand what you are doing.</dd>
  <dt id="net.bluetooth.l2cap.ertx_timeout"><var class="Va">net.bluetooth.l2cap.ertx_timeout</var></dt>
  <dd>A read-write integer variable that controls the L2CAP Extended
      Retransmission Timeout (ERTX) (in seconds). In some cases remote peer may
      respond with <code class="Dv">PENDING</code> status to the L2CAP control
      command. In this case the L2CAP command timeout is reset to the ERTX
      timeout value. The value of the ERTX timeout should be greater or equal to
      the value of the RTX timeout. Be careful when changing this variable. Make
      sure you understand what you are doing.</dd>
</dl>
</section>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">ng_btsocket(4)</a>, <a class="Xr">ng_hci(4)</a>,
    <a class="Xr">ng_l2cap(4)</a>, <a class="Xr">sysctl(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">ng_bluetooth</code> module was implemented in
    <span class="Ux">FreeBSD 5.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp"><span class="An">Maksim Yevmenkin</span>
    &lt;<a class="Mt" href="mailto:m_evmenkin@yahoo.com">m_evmenkin@yahoo.com</a>&gt;</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 9, 2002</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>