xref: /freebsd/usr.sbin/bluetooth/ath3kfw/ath3kfw.8 (revision cc68614da8232d8baaca0ae0d0dd8f890f06623e)
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.\" $FreeBSD$
27.\"
28.Dd June 4, 2016
29.Dt ATH3KFW 8
30.Os
31.Sh NAME
32.Nm ath3kfw
33.Nd firmware download utility for Atheros AR3011/AR3012 chip based Bluetooth USB devices
34.Sh SYNOPSIS
35.Nm
36.Fl d Ar device_name
37.Fl f Ar firmware_path
38.Nm
39.Fl h
40.Sh DESCRIPTION
41The
42.Nm
43utility downloads the specified firmware file to the specified
44.Xr ugen 4
45device.
46.Pp
47This utility will
48.Em only
49work with Atheros AR3011 and AR3012 chip based Bluetooth USB devices.
50The identification is currently based on USB vendor ID/product ID pair.
51The vendor ID should be 0x0cf3
52.Pq Dv USB_VENDOR_ATHEROS2
53and the product ID should be one of the supported devices.
54.Pp
55Firmware files are available in the linux-firmware RPM.
56.Pp
57The
58.Nm
59utility will query the device to determine which firmware image and board
60configuration to load in at runtime.
61.Pp
62The options are as follows:
63.Bl -tag -width indent
64.It Fl D
65Enable verbose debugging.
66.It Fl d Ar device_name
67Specify
68.Xr ugen 4
69device name.
70.It I
71Enable informational debugging.
72.It Fl f Ar firmware_path
73Specify the directory containing the firmware files to search and upload.
74.It Fl h
75Display usage message and exit.
76.El
77.Sh EXIT STATUS
78.Ex -std
79.Sh SEE ALSO
80.Xr libusb 3 ,
81.Xr ugen 4 ,
82.Xr devd 8
83.Sh AUTHORS
84The original utility was written by
85.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com .
86This was written based on Linux ath3k by
87.An Adrian Chadd Aq Mt adrian@freebsd.org .
88.Sh BUGS
89Most likely.
90Please report if found.
91