xref: /freebsd/share/man/man4/ng_ubt.4 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
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.\" $FreeBSD$
26.\"
27.Dd June 14, 2002
28.Dt NG_UBT 4
29.Os
30.Sh NAME
31.Nm ng_ubt
32.Nd Netgraph node type that is also a driver for Bluetooth USB devices
33.Sh SYNOPSIS
34.In sys/types.h
35.In ng_ubt.h
36.Sh DESCRIPTION
37The
38.Nm ubt
39node type is both a persistent Netgraph node type and a driver for
40Bluetooth USB devices.
41It implements a Bluetooth USB transport layer
42as per chapter H2 of the Bluetooth Specification Book v1.1.
43A new node is created when supported USB device is plugged.
44.Pp
45The node has a single hook called
46.Dv hook .
47Incoming bytes received on the device are re-assembled into HCI frames
48(according to the length).
49Full HCI frames are sent out on the hook.
50The node will add HCI frame indicator if device did not send it.
51HCI frames received on
52.Dv hook
53are transmitted out.
54The node will drop HCI frame indicator unless device
55requires it to be present.
56.Sh HOOKS
57This node type supports the following hooks:
58.Bl -tag -width indent
59.It Dv hook
60single HCI frame contained in single
61.Vt mbuf
62structure.
63.El
64.Sh CONTROL MESSAGES
65This node type supports the generic control messages, plus the following:
66.Bl -tag -width indent
67.It Dv NGM_UBT_NODE_GET_DEBUG
68Returns an integer containing the current debug level for the node.
69.It Dv NGM_UBT_NODE_SET_DEBUG
70This command takes an integer argument and sets current debug level
71for the node.
72.It Dv NGM_UBT_NODE_GET_QLEN
73This command takes a parameter that specifies queue number and returns
74current maximal length of the queue for the node.
75.It Dv NGM_UBT_NODE_SET_QLEN
76This command takes two parameters that specify queue number and maximum
77length of the queue and sets maximal length of the queue for the node.
78.It Dv NGM_UBT_NODE_GET_STAT
79Returns various statistic information for the node, such as: number of
80bytes (frames) sent, number of bytes (frames) received and number of
81input (output) errors.
82.It Dv NGM_UBT_NODE_RESET_STAT
83Reset all statistic counters to zero.
84.El
85.Sh SHUTDOWN
86This node shuts down when the corresponding USB device is un-plugged.
87.Sh BUGS
88Isochronous USB transfers are probably broken.
89It means that USB device probably will not be able to transfer SCO data (voice).
90Driver does not support firmware upgrade procedure.
91USB interrupt transfers are implemented as bulk-in transfers (not really a bug).
92.Sh SEE ALSO
93.Xr netgraph 4 ,
94.Xr usb 4 ,
95.Xr ngctl 8
96.Sh HISTORY
97The
98.Nm ubt
99node type was implemented in
100.Fx 5.0 .
101.Sh AUTHORS
102.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
103