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