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