1 .\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
25 .\" $Id: ng_ubt.4,v 1.3 2003/05/21 19:37:35 max Exp $
33 .Nd Netgraph node type that is also a driver for Bluetooth USB devices
36 .In netgraph/bluetooth/include/ng_ubt.h
40 node type is both a persistent Netgraph node type and a driver for
41 Bluetooth USB devices.
42 It implements a Bluetooth USB transport layer
43 as per chapter H2 of the Bluetooth Specification Book v1.1.
44 A new node is created when a supported USB device is plugged in.
46 The node has a single hook called
48 Incoming bytes received on the device are re-assembled into HCI frames
49 (according to the length).
50 Full HCI frames are sent out on the hook.
51 The node will add a HCI frame indicator if the device did not send it.
52 HCI frames received on
55 The node will drop the HCI frame indicator unless the device
56 requires it to be present.
60 driver supports all Bluetooth USB devices that conform with
61 the Bluetooth specification v1.1, including:
71 Mitsumi Bluetooth USB adapter
75 TDK Bluetooth USB adapter
77 Broadcom Bluetooth USB adapter
80 This node type supports the following hooks:
81 .Bl -tag -width ".Va hook"
83 single HCI frame contained in a single
88 This node type supports the generic control messages, plus the following:
89 .Bl -tag -width indent
90 .It Dv NGM_UBT_NODE_GET_DEBUG Pq Ic get_debug
91 Returns an integer containing the current debug level for the node.
92 .It Dv NGM_UBT_NODE_SET_DEBUG Pq Ic set_debug
93 This command takes an integer argument and sets the current debug level
95 .It Dv NGM_UBT_NODE_GET_QLEN Pq Ic get_qlen
96 This command takes a parameter that specifies the queue number and returns
97 the current maximal length of the queue for the node.
98 .It Dv NGM_UBT_NODE_SET_QLEN Pq Ic set_qlen
99 This command takes two parameters that specify the queue number and the maximum
100 length of the queue and sets the maximal length of the queue for the node.
101 .It Dv NGM_UBT_NODE_GET_STAT Pq Ic get_stat
102 Returns various statistic information for the node, such as: number of
103 bytes (frames) sent, number of bytes (frames) received and number of
104 input (output) errors.
105 .It Dv NGM_UBT_NODE_RESET_STAT Pq Ic reset_stat
106 Reset all statistic counters to zero.
109 This node shuts down when the corresponding USB device is un-plugged.
118 node type was implemented in
121 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
123 Isochronous USB transfers are broken.
124 This means that the USB device will not be able to transfer SCO data (voice).
125 USB interrupt transfers are implemented as bulk-in transfers (not really a bug).