usr.sbin/bluetooth/ath3kfw/ath3kfw.8

   1 .\" Copyright (c) 2010 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   2 .\" All rights reserved.
   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 November 9, 2010
  28 .Dt ATH3KFW 8
  29 .Os
  30 .Sh NAME
  31 .Nm ath3kfw
  32 .Nd firmware download utility for Atheros AR3011 chip based Bluetooth USB devices
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Fl d Ar device_name
  36 .Fl f Ar firmware_file_name
  37 .Nm
  38 .Fl h
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 utility downloads the specified firmware file to the specified
  43 .Xr ugen 4
  44 device.
  45 .Pp
  46 This utility will
  47 .Em only
  48 work with Atheros AR3011 chip based Bluetooth USB devices.
  49 The identification is currently based on USB vendor ID/product ID pair.
  50 The vendor ID should be 0x0cf3
  51 .Pq Dv USB_VENDOR_ATHEROS2
  52 and the product ID should be 0x3000.
  53 .Pp
  54 Firmware files ath3k-1.fw and ath3k-2.fw can be obtained from the
  55 linux-firmware RPM.
  56 .Pp
  57 The options are as follows:
  58 .Bl -tag -width indent
  59 .It Fl d Ar device_name
  60 Specify
  61 .Xr ugen 4
  62 device name.
  63 .It Fl f Ar firmware_file_name
  64 Specify firmware file name for download.
  65 .It Fl h
  66 Display usage message and exit.
  67 .El
  68 .Sh EXIT STATUS
  69 .Ex -std
  70 .Sh SEE ALSO
  71 .Xr libusb 3 ,
  72 .Xr ugen 4 ,
  73 .Xr devd 8
  74 .Sh AUTHORS
  75 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
  76 .Sh BUGS
  77 Most likely.
  78 Please report if found.