xref: /freebsd/usr.sbin/bluetooth/ath3kfw/ath3kfw.8 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
1.\" Copyright (c) 2010 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" Copyright (c) 2013, 2016 Adrian Chadd <adrian@freebsd.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd June 4, 2016
27.Dt ATH3KFW 8
28.Os
29.Sh NAME
30.Nm ath3kfw
31.Nd firmware download utility for Atheros AR3011/AR3012 chip based Bluetooth USB devices
32.Sh SYNOPSIS
33.Nm
34.Fl d Ar device_name
35.Fl f Ar firmware_path
36.Nm
37.Fl h
38.Sh DESCRIPTION
39The
40.Nm
41utility downloads the specified firmware file to the specified
42.Xr ugen 4
43device.
44.Pp
45This utility will
46.Em only
47work with Atheros AR3011 and AR3012 chip based Bluetooth USB devices.
48The identification is currently based on USB vendor ID/product ID pair.
49The vendor ID should be 0x0cf3
50.Pq Dv USB_VENDOR_ATHEROS2
51and the product ID should be one of the supported devices.
52.Pp
53Firmware files are available in the linux-firmware RPM.
54.Pp
55The
56.Nm
57utility will query the device to determine which firmware image and board
58configuration to load in at runtime.
59.Pp
60The options are as follows:
61.Bl -tag -width indent
62.It Fl D
63Enable verbose debugging.
64.It Fl d Ar device_name
65Specify
66.Xr ugen 4
67device name.
68.It I
69Enable informational debugging.
70.It Fl f Ar firmware_path
71Specify the directory containing the firmware files to search and upload.
72.It Fl h
73Display usage message and exit.
74.El
75.Sh EXIT STATUS
76.Ex -std
77.Sh SEE ALSO
78.Xr libusb 3 ,
79.Xr ugen 4 ,
80.Xr devd 8
81.Sh AUTHORS
82The original utility was written by
83.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com .
84This was written based on Linux ath3k by
85.An Adrian Chadd Aq Mt adrian@freebsd.org .
86.Sh BUGS
87Most likely.
88Please report if found.
89