usr.sbin/bluetooth/iwmbtfw/iwmbtfw.8

   1 .\" Copyright (c) 2013, 2016 Adrian Chadd <adrian@freebsd.org>
   2 .\" Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org>
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd June 4, 2019
  28 .Dt IWMBTFW 8
  29 .Os
  30 .Sh NAME
  31 .Nm iwmbtfw
  32 .Nd firmware download utility for Intel Wireless 8260/8265 chip based Bluetooth
  33 USB devices
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Fl d Ar device_name
  37 .Fl f Ar firmware_path
  38 .Nm
  39 .Fl h
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility downloads the specified firmware file to the specified
  44 .Xr ugen 4
  45 device.
  46 .Pp
  47 This utility will
  48 .Em only
  49 work with Intel Wireless 8260/8265 chip based Bluetooth USB devices and some of
  50 their successors.
  51 The identification is currently based on USB vendor ID/product ID pair.
  52 The vendor ID should be 0x8087
  53 .Pq Dv USB_VENDOR_INTEL2
  54 and the product ID should be one of the supported devices.
  55 .Pp
  56 Firmware files are available in the
  57 .Pa comms/iwmbt-firmware
  58 port.
  59 .Pp
  60 The
  61 .Nm
  62 utility will query the device to determine which firmware image and board
  63 configuration to load in at runtime.
  64 .Pp
  65 The options are as follows:
  66 .Bl -tag -width indent
  67 .It Fl D
  68 Enable verbose debugging.
  69 .It Fl d Ar device_name
  70 Specify
  71 .Xr ugen 4
  72 device name.
  73 .It Fl I
  74 Enable informational debugging.
  75 .It Fl f Ar firmware_path
  76 Specify the directory containing the firmware files to search and upload.
  77 .It Fl h
  78 Display usage message and exit.
  79 .El
  80 .Sh EXIT STATUS
  81 .Ex -std
  82 .Sh SEE ALSO
  83 .Xr libusb 3 ,
  84 .Xr ugen 4 ,
  85 .Xr devd 8
  86 .Sh AUTHORS
  87 .Nm
  88 is based on
  89 .Xr ath3kfw 8
  90 utility used as firmware downloader template and on Linux btintel driver
  91 source code.
  92 It is written by
  93 .An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
  94 .Sh BUGS
  95 Most likely.
  96 Please report if found.