xref: /freebsd/usr.sbin/bluetooth/iwmbtfw/iwmbtfw.8 (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1.\" Copyright (c) 2013, 2016 Adrian Chadd <adrian@freebsd.org>
2.\" Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org>
3.\" Copyright (c) 2021 Philippe Michaud-Boudreault <pitwuu@gmail.com>
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 May 3, 2021
27.Dt IWMBTFW 8
28.Os
29.Sh NAME
30.Nm iwmbtfw
31.Nd firmware download utility for Intel Wireless 7260/8260/8265 chip based Bluetooth
32USB devices
33.Sh SYNOPSIS
34.Nm
35.Fl d Ar device_name
36.Fl f Ar firmware_path
37.Nm
38.Fl h
39.Sh DESCRIPTION
40The
41.Nm
42utility downloads the specified firmware file to the specified
43.Xr ugen 4
44device.
45.Pp
46This utility will
47.Em only
48work with Intel Wireless 7260/8260/8265 chip based Bluetooth USB devices and some of
49their successors.
50The identification is currently based on USB vendor ID/product ID pair.
51The vendor ID should be 0x8087
52.Pq Dv USB_VENDOR_INTEL2
53and the product ID should be one of the supported devices.
54.Pp
55Firmware files are available in the
56.Pa comms/iwmbt-firmware
57port.
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 indent
66.It Fl D
67Enable verbose debugging.
68.It Fl d Ar device_name
69Specify
70.Xr ugen 4
71device name.
72.It Fl I
73Enable informational debugging.
74.It Fl f Ar firmware_path
75Specify the directory containing the firmware files to search and upload.
76.It Fl h
77Display usage message and exit.
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
86.Nm
87is based on
88.Xr ath3kfw 8
89utility used as firmware downloader template and on Linux btintel driver
90source code.
91It is written by
92.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
93.Pp
94Support for the 7260 card added by
95.An Philippe Michaud-Boudreault Aq Mt pitwuu@gmail.com .
96.Sh BUGS
97Most likely.
98Please report if found.
99