xref: /freebsd/usr.sbin/bluetooth/iwmbtfw/iwmbtfw.8 (revision d5b0e70f7e04d971691517ce1304d86a1e367e2e)
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.\" $FreeBSD$
27.\"
28.Dd May 3, 2021
29.Dt IWMBTFW 8
30.Os
31.Sh NAME
32.Nm iwmbtfw
33.Nd firmware download utility for Intel Wireless 7260/8260/8265 chip based Bluetooth
34USB devices
35.Sh SYNOPSIS
36.Nm
37.Fl d Ar device_name
38.Fl f Ar firmware_path
39.Nm
40.Fl h
41.Sh DESCRIPTION
42The
43.Nm
44utility downloads the specified firmware file to the specified
45.Xr ugen 4
46device.
47.Pp
48This utility will
49.Em only
50work with Intel Wireless 7260/8260/8265 chip based Bluetooth USB devices and some of
51their successors.
52The identification is currently based on USB vendor ID/product ID pair.
53The vendor ID should be 0x8087
54.Pq Dv USB_VENDOR_INTEL2
55and the product ID should be one of the supported devices.
56.Pp
57Firmware files are available in the
58.Pa comms/iwmbt-firmware
59port.
60.Pp
61The
62.Nm
63utility will query the device to determine which firmware image and board
64configuration to load in at runtime.
65.Pp
66The options are as follows:
67.Bl -tag -width indent
68.It Fl D
69Enable verbose debugging.
70.It Fl d Ar device_name
71Specify
72.Xr ugen 4
73device name.
74.It Fl I
75Enable informational debugging.
76.It Fl f Ar firmware_path
77Specify the directory containing the firmware files to search and upload.
78.It Fl h
79Display usage message and exit.
80.El
81.Sh EXIT STATUS
82.Ex -std
83.Sh SEE ALSO
84.Xr libusb 3 ,
85.Xr ugen 4 ,
86.Xr devd 8
87.Sh AUTHORS
88.Nm
89is based on
90.Xr ath3kfw 8
91utility used as firmware downloader template and on Linux btintel driver
92source code.
93It is written by
94.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
95.Pp
96Support for the 7260 card added by
97.An Philippe Michaud-Boudreault Aq Mt pitwuu@gmail.com .
98.Sh BUGS
99Most likely.
100Please report if found.
101