xref: /freebsd/usr.sbin/bluetooth/iwmbtfw/iwmbtfw.8 (revision 5036d9652a5701d00e9e40ea942c278e9f77d33d)
1.\"-
2.\" SPDX-License-Identifier: BSD-2-Clause
3.\"
4.\" Copyright (c) 2013, 2016 Adrian Chadd <adrian@freebsd.org>
5.\" Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org>
6.\" Copyright (c) 2021 Philippe Michaud-Boudreault <pitwuu@gmail.com>
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 September 15, 2024
30.Dt IWMBTFW 8
31.Os
32.Sh NAME
33.Nm iwmbtfw
34.Nd download firmware for Intel Wireless AC 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 Intel Wireless 7260/8260/9260 chip based Bluetooth USB devices
52and some of their successors.
53The identification is currently based on USB vendor ID/product ID pair.
54The vendor ID should be 0x8087
55.Pq Dv USB_VENDOR_INTEL2
56and the product ID should be one of the supported devices.
57.Pp
58Firmware files are available in the
59.Pa comms/iwmbt-firmware
60port.
61.Pp
62The
63.Nm
64utility will query the device to determine which firmware image and board
65configuration to load in at runtime.
66.Pp
67The options are as follows:
68.Bl -tag -width "-f firmware_path"
69.It Fl D
70Enable verbose debugging.
71.It Fl d Ar device_name
72Specify
73.Xr ugen 4
74device name.
75.It Fl f Ar firmware_path
76Specify the directory containing the firmware files to search and upload.
77.It Fl h
78Display usage message and exit.
79.It Fl I
80Enable informational debugging.
81.El
82.Sh EXIT STATUS
83.Ex -std
84.Sh SEE ALSO
85.Xr libusb 3 ,
86.Xr ugen 4 ,
87.Xr devd 8
88.Sh AUTHORS
89.Nm
90is based on
91.Xr ath3kfw 8
92utility used as firmware downloader template and on Linux btintel driver
93source code.
94It is written by
95.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
96.Pp
97Support for the 7260 card added by
98.An Philippe Michaud-Boudreault Aq Mt pitwuu@gmail.com .
99.Sh BUGS
100Most likely.
101Please report if found.
102