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