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_ubt.4,v 1.3 2003/05/21 19:37:35 max Exp $ 26.\" $FreeBSD$ 27.\" 28.Dd September 13, 2004 29.Dt NG_UBT 4 30.Os 31.Sh NAME 32.Nm ng_ubt 33.Nd Netgraph node type that is also a driver for Bluetooth USB devices 34.Sh SYNOPSIS 35.In sys/types.h 36.In netgraph/bluetooth/include/ng_ubt.h 37.Sh DESCRIPTION 38The 39.Nm ubt 40node type is both a persistent Netgraph node type and a driver for 41Bluetooth USB devices. 42It implements a Bluetooth USB transport layer 43as per chapter H2 of the Bluetooth Specification Book v1.1. 44A new node is created when a supported USB device is plugged in. 45.Pp 46The node has a single hook called 47.Dv hook . 48Incoming bytes received on the device are re-assembled into HCI frames 49(according to the length). 50Full HCI frames are sent out on the hook. 51The node will add a HCI frame indicator if the device did not send it. 52HCI frames received on 53.Dv hook 54are transmitted out. 55The node will drop the HCI frame indicator unless the device 56requires it to be present. 57.Sh HARDWARE 58The 59.Nm 60driver supports all Bluetooth USB devices that conform with 61the Bluetooth specification v1.1 including: 62.Pp 63.Bl -bullet -compact 64.It 653Com 3CREB96 66.It 67AIPTEK BR0R02 68.It 69EPoX BT-DG02 70.It 71Mitsumi Bluetooth USB adapter 72.It 73MSI MS-6967 74.It 75TDK Bluetooth USB adapter 76.El 77.Sh HOOKS 78This node type supports the following hooks: 79.Bl -tag -width indent 80.It Dv hook 81single HCI frame contained in a single 82.Vt mbuf 83structure. 84.El 85.Sh CONTROL MESSAGES 86This node type supports the generic control messages, plus the following: 87.Bl -tag -width indent 88.It Dv NGM_UBT_NODE_GET_DEBUG 89Returns an integer containing the current debug level for the node. 90.It Dv NGM_UBT_NODE_SET_DEBUG 91This command takes an integer argument and sets the current debug level 92for the node. 93.It Dv NGM_UBT_NODE_GET_QLEN 94This command takes a parameter that specifies the queue number and returns 95the current maximal length of the queue for the node. 96.It Dv NGM_UBT_NODE_SET_QLEN 97This command takes two parameters that specify the queue number and the maximum 98length of the queue and sets the maximal length of the queue for the node. 99.It Dv NGM_UBT_NODE_GET_STAT 100Returns various statistic information for the node, such as: number of 101bytes (frames) sent, number of bytes (frames) received and number of 102input (output) errors. 103.It Dv NGM_UBT_NODE_RESET_STAT 104Reset all statistic counters to zero. 105.It Dv NGM_UBT_NODE_DEV_NODES 106This command takes a single integer parameter. 107If the parameter's value is not zero, then the driver will create device nodes 108for the control, interrupt, bulk-in and bulk-out endpoints. 109If the parameter's value is zero, then the driver will destroy the device nodes 110for the endpoints. 111The device nodes interface is mutually exclusive with the Netgraph interface. 112.El 113.Sh DEVICE NODES INTERFACE 114The 115.Nm ubt 116driver can create or destroy endpoint device nodes on request. 117This feature can be used to implement an external firmware download utility. 118.Pp 119Control transfers can only happen on the control endpoint which 120is always endpoint 0. 121Control requests are issued by 122.Xr ioctl 2 123calls. 124.Pp 125Only incoming transfers are supported on an interrupt endpoint. 126To perform I/O on an interrupt endpoint, 127.Xr read 2 128should be used. 129All I/O operations on an interrupt endpoint are unbuffered. 130.Pp 131The bulk transfers can be in or out depending on the endpoint. 132To perform I/O on a bulk endpoint, 133.Xr read 2 134and 135.Xr write 2 136should be used. 137All I/O operations on a bulk endpoint are unbuffered. 138.Pp 139The control endpoint (endpoint 0) handles the following 140.Xr ioctl 2 141calls: 142.Bl -tag -width indent 143.It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t 144Return the device descriptor. 145.It Dv USB_GET_STRING_DESC Pq Vt "struct usb_string_desc" 146Get a string descriptor for the given language ID and string index. 147.Bd -literal 148struct usb_string_desc { 149 int string_index; 150 int language_id; 151 usb_string_descriptor_t desc; 152}; 153.Ed 154.It Dv USB_DO_REQUEST Pq Vt "struct usb_ctl_request" 155Send a USB request to the device on the control endpoint. 156Any data sent to/from the device is located at 157.Va data . 158The size of the transferred data is determined from the 159.Va request . 160The 161.Va addr 162field is ignored in this call. 163The 164.Va flags 165field can be used to flag that the request is allowed to 166be shorter than the requested size, and the 167.Va actlen 168will contain the actual size on completion. 169.Bd -literal 170struct usb_ctl_request { 171 int addr; 172 usb_device_request_t request; 173 void *data; 174 int flags; 175#define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ 176 int actlen; /* actual length transferred */ 177}; 178.Ed 179This is a dangerous operation in that it can perform arbitrary operations 180on the device. 181Some of the most dangerous (e.g., changing the device address) are not allowed. 182.It Dv USB_GET_DEVICEINFO Pq Vt "struct usb_device_info" 183Get an information summary for the device. 184This call will not issue any USB transactions. 185.El 186.Sh SHUTDOWN 187This node shuts down when the corresponding USB device is un-plugged. 188.Sh BUGS 189Isochronous USB transfers are broken. 190This means that the USB device will not be able to transfer SCO data (voice). 191USB interrupt transfers are implemented as bulk-in transfers (not really a bug). 192.Sh FILES 193.Bl -tag -width ".Pa /dev/ubt Ns Ar N Ns Pa \&. Ns Ar EE" -compact 194.It Pa /dev/ubt Ns Ar N Ns Pa \&. Ns Ar EE 195Endpoint 196.Ar EE 197of device 198.Ar N . 199.El 200.Sh SEE ALSO 201.Xr netgraph 4 , 202.Xr ugen 4 , 203.Xr usb 4 , 204.Xr ngctl 8 205.Sh HISTORY 206The 207.Nm ubt 208node type was implemented in 209.Fx 5.0 . 210.Sh AUTHORS 211.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com 212