xref: /freebsd/usr.sbin/bluetooth/bcmfw/bcmfw.8 (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
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: bcmfw.8,v 1.7 2003/05/21 00:33:40 max Exp $
26.\"
27.Dd March 31, 2003
28.Dt BCMFW 8
29.Os
30.Sh NAME
31.Nm bcmfw
32.Nd firmware download utility for Broadcom BCM2033 chip based Bluetooth USB devices
33.Sh SYNOPSIS
34.Nm
35.Op Fl h
36.Fl f Ar firmware_file_name
37.Fl m Ar mini-driver_file_name
38.Fl n Ar device_name
39.Sh DESCRIPTION
40The
41.Nm
42utility downloads the specified mini-driver and firmware files to the specified
43device.
44.Pp
45This utility will
46.Em only
47work with Broadcom BCM2033 chip based Bluetooth USB devices.
48The identification is currently based on USB vendor ID/product ID pair.
49The vendor ID should be 0x0a5c
50.Pq Dv USB_VENDOR_BROADCOM
51and the product ID should be 0x2033.
52.Pp
53Due to copyright issues I will no longer provide mini-driver and firmware
54files for the device.
55These files can be obtained from the Linux BlueZ bluez-firmware package.
56.Pp
57Visit
58.Pa http://www.bluez.org/download.html
59for details.
60.Pp
61I am using the following files from the bluez-firmware-1.0 package:
62.Pp
63.Dl "MD5 (BCM2033-MD.hex) = 5580317158d07fc4ace90af04f8e1c73"
64.Dl "MD5 (BCM2033-FW.bin) = b4e142b3272cfe5a84b32fda6b4b032f"
65.Pp
66The options are as follows:
67.Bl -tag -width indent
68.It Fl f Ar firmware_file_name
69Specify firmware file name for download.
70.It Fl h
71Display usage message and exit.
72.It Fl m Ar mini-driver_file_name
73Specify mini-driver file name for download.
74.It Fl n Ar device_name
75Specify device name.
76.El
77.Sh FILES
78.Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact
79.It Pa BCM2033-MD.hex
80Mini-driver image.
81.It Pa BCM2033-FW.bin
82Firmware image.
83.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE
84Endpoint
85.Ar EE
86of device
87.Ar N .
88.El
89.Sh EXIT STATUS
90.Ex -std
91.Sh EXAMPLES
92To download the firmware into the
93.Pa /dev/ubtbcmfw0
94device:
95.Pp
96.Dl "bcmfw -n ubtbcmfw0 -m BCM2033-MD.hex -f BCM2033-FW.bin"
97.Sh SEE ALSO
98.Xr ubtbcmfw 4 ,
99.Xr ugen 4
100.Sh AUTHORS
101.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
102.Sh BUGS
103Most likely.
104Please report if found.
105