xref: /freebsd/share/man/man4/ubtbcmfw.4 (revision 97759ccc715c4b365432c16d763c50eecfcb1100)
1.\" Copyright (c) 2003 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: ubtbcmfw.4,v 1.3 2003/05/21 19:37:35 max Exp $
26.\"
27.Dd November 22, 2006
28.Dt UBTBCMFW 4
29.Os
30.Sh NAME
31.Nm ubtbcmfw
32.Nd Firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following line in your
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "device ubtbcmfw"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45ubtbcmfw_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50is a firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices.
51It provides minimal access to the parts of the device required to download
52firmware.
53.Pp
54The
55.Nm
56driver creates three fixed endpoint device nodes.
57.Pp
58The control transfers can only happen on the control endpoint which
59is always endpoint 0.
60Control requests are issued by
61.Xr ioctl 2
62calls.
63.Pp
64Only incoming transfers are supported on an interrupt endpoint.
65To perform I/O on an interrupt endpoint,
66.Xr read 2
67should be used.
68All I/O operations on an interrupt endpoint are unbuffered.
69Interrupt endpoint is always endpoint 1.
70.Pp
71Only outgoing bulk transfers are supported on a bulk endpoint.
72To perform I/O on a bulk endpoint,
73.Xr write 2
74should be used.
75All I/O operations on a bulk endpoint are unbuffered.
76Outgoing bulk endpoint is always endpoint 2.
77.Pp
78The control endpoint (endpoint 0) handles the following
79.Xr ioctl 2
80calls:
81.Bl -tag -width indent
82.It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t
83Return the device descriptor.
84.El
85.Sh FILES
86.Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact
87.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE
88Endpoint
89.Ar EE
90of device
91.Ar N .
92.El
93.Sh SEE ALSO
94.Xr ng_ubt 4 ,
95.Xr ugen 4 ,
96.Xr usb 4 ,
97.Xr bcmfw 8
98.Sh HISTORY
99The
100.Nm
101driver was implemented in
102.Fx 5.0 .
103.Sh AUTHORS
104.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
105.Sh BUGS
106Most likely.
107Please report if found.
108