blob: a0f58215a842555bcbbb2d810dffd7058e59fa3c (
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
<table class="head">
<tr>
<td class="head-ltitle">NG_UBT(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">NG_UBT(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_ubt</code> — <span class="Nd">Netgraph
node type that is also a driver for Bluetooth USB devices</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
<<a class="In">sys/types.h</a>></code>
<br/>
<code class="In">#include
<<a class="In">netgraph/bluetooth/include/ng_ubt.h</a>></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">ubt</code> node type is both a persistent
Netgraph node type and a driver for Bluetooth USB devices. It implements a
Bluetooth USB transport layer as per chapter H2 of the Bluetooth
Specification Book v1.1. A new node is created when a supported USB device
is plugged in.</p>
<p class="Pp">The node has a single hook called <code class="Dv">hook</code>.
Incoming bytes received on the device are re-assembled into HCI frames
(according to the length). Full HCI frames are sent out on the hook. The
node will add a HCI frame indicator if the device did not send it. HCI
frames received on <code class="Dv">hook</code> are transmitted out. The
node will drop the HCI frame indicator unless the device requires it to be
present.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">ng_ubt</code> driver supports all Bluetooth
USB devices that conform with the Bluetooth specification v1.1,
including:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
<li>3Com 3CREB96</li>
<li>AIPTEK BR0R02</li>
<li>EPoX BT-DG02</li>
<li>Mitsumi Bluetooth USB adapter</li>
<li>MSI MS-6967</li>
<li>TDK Bluetooth USB adapter</li>
<li>Broadcom Bluetooth USB adapter</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="HOOKS"><a class="permalink" href="#HOOKS">HOOKS</a></h1>
<p class="Pp">This node type supports the following hooks:</p>
<dl class="Bl-tag">
<dt id="hook"><var class="Va">hook</var></dt>
<dd>single HCI frame contained in a single <var class="Vt">mbuf</var>
structure.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="CONTROL_MESSAGES"><a class="permalink" href="#CONTROL_MESSAGES">CONTROL
MESSAGES</a></h1>
<p class="Pp">This node type supports the generic control messages, plus the
following:</p>
<dl class="Bl-tag">
<dt id="NGM_UBT_NODE_GET_DEBUG"><a class="permalink" href="#NGM_UBT_NODE_GET_DEBUG"><code class="Dv">NGM_UBT_NODE_GET_DEBUG</code></a>
(<code class="Ic">get_debug</code>)</dt>
<dd>Returns an integer containing the current debug level for the node.</dd>
<dt id="NGM_UBT_NODE_SET_DEBUG"><a class="permalink" href="#NGM_UBT_NODE_SET_DEBUG"><code class="Dv">NGM_UBT_NODE_SET_DEBUG</code></a>
(<code class="Ic">set_debug</code>)</dt>
<dd>This command takes an integer argument and sets the current debug level
for the node.</dd>
<dt id="NGM_UBT_NODE_GET_QLEN"><a class="permalink" href="#NGM_UBT_NODE_GET_QLEN"><code class="Dv">NGM_UBT_NODE_GET_QLEN</code></a>
(<code class="Ic">get_qlen</code>)</dt>
<dd>This command takes a parameter that specifies the queue number and returns
the current maximal length of the queue for the node.</dd>
<dt id="NGM_UBT_NODE_SET_QLEN"><a class="permalink" href="#NGM_UBT_NODE_SET_QLEN"><code class="Dv">NGM_UBT_NODE_SET_QLEN</code></a>
(<code class="Ic">set_qlen</code>)</dt>
<dd>This command takes two parameters that specify the queue number and the
maximum length of the queue and sets the maximal length of the queue for
the node.</dd>
<dt id="NGM_UBT_NODE_GET_STAT"><a class="permalink" href="#NGM_UBT_NODE_GET_STAT"><code class="Dv">NGM_UBT_NODE_GET_STAT</code></a>
(<code class="Ic">get_stat</code>)</dt>
<dd>Returns various statistic information for the node, such as: number of
bytes (frames) sent, number of bytes (frames) received and number of input
(output) errors.</dd>
<dt id="NGM_UBT_NODE_RESET_STAT"><a class="permalink" href="#NGM_UBT_NODE_RESET_STAT"><code class="Dv">NGM_UBT_NODE_RESET_STAT</code></a>
(<code class="Ic">reset_stat</code>)</dt>
<dd>Reset all statistic counters to zero.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SHUTDOWN"><a class="permalink" href="#SHUTDOWN">SHUTDOWN</a></h1>
<p class="Pp">This node shuts down when the corresponding USB device is
un-plugged.</p>
</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">netgraph(4)</a>, <a class="Xr">ugen(4)</a>,
<a class="Xr">usb(4)</a>, <a class="Xr">ngctl(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">ubt</code> node type 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>
<<a class="Mt" href="mailto:m_evmenkin@yahoo.com">m_evmenkin@yahoo.com</a>></p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp">Isochronous USB transfers are broken. This means that the USB
device will not be able to transfer SCO data (voice). USB interrupt
transfers are implemented as bulk-in transfers (not really a bug).</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">December 26, 2012</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
