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