xref: /freebsd/share/man/man4/ubtbcmfw.4 (revision 2357939bc239bd5334a169b62313806178dd8f30)
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.\" $FreeBSD$
27.\"
28.Dd April 28, 2003
29.Dt UBTBCMFW 4
30.Os
31.Sh NAME
32.Nm ubtbcmfw
33.Nd Firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices
34.Sh DESCRIPTION
35The
36.Nm
37is a firmware driver for Broadcom BCM2033 chip based Bluetooth USB devices.
38It provides minimal access to the parts of the device required to download
39firmware.
40.Pp
41The
42.Nm
43driver creates three fixed endpoint device nodes.
44.Pp
45The control transfers can only happen on the control endpoint which
46is always endpoint 0.
47Control requests are issued by
48.Xr ioctl 2
49calls.
50.Pp
51Only incoming transfers are supported on an interrupt endpoint.
52To perform I/O on an interrupt endpoint,
53.Xr read 2
54should be used.
55All I/O operations on an interrupt endpoint are unbuffered.
56Interrupt endpoint is always endpoint 1.
57.Pp
58Only outgoing bulk transfers are supported on a bulk endpoint.
59To perform I/O on a bulk endpoint,
60.Xr write 2
61should be used.
62All I/O operations on a bulk endpoint are unbuffered.
63Outgoing bulk endpoint is always enpoint 2.
64.Pp
65The control endpoint (endpoint 0) handles the following
66.Xr ioctl 2
67calls:
68.Bl -tag -width indent
69.It Dv USB_GET_DEVICE_DESC Pq Vt usb_device_descriptor_t
70Return the device descriptor.
71.El
72.Sh BUGS
73Most likely.
74Please report if found.
75.Sh FILES
76.Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact
77.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE
78Endpoint
79.Ar EE
80of device
81.Ar N .
82.El
83.Sh SEE ALSO
84.Xr ng_ubt 4 ,
85.Xr ugen 4 ,
86.Xr usb 4 ,
87.Xr bcmfw 8
88.Sh HISTORY
89The
90.Nm
91driver was implemented in
92.Fx 5.0 .
93.Sh AUTHORS
94.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
95