1.\" Copyright (c) 2013, 2016 Adrian Chadd <adrian@freebsd.org> 2.\" Copyright (c) 2019 Vladimir Kondratyev <wulf@FreeBSD.org> 3.\" Copyright (c) 2023 Future Crew LLC. 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 July 19, 2023 27.Dt RTLBTFW 8 28.Os 29.Sh NAME 30.Nm rtlbtfw 31.Nd firmware download utility for Realtek 87XX/88XX 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 Realtek 87XX/88XX chip based Bluetooth USB devices and some of 49their successors. 50The identification is currently based on USB vendor ID/product ID pair and 51interface class. 52For Realtek devices the vendor ID should be 0x0bda 53.Pq Dv USB_VENDOR_REALTEK 54and the 0-th interface class/subclass/protocol should be a Bluetooth RF 55Wireless Controller. 56Non-Realtek devices are identified based on USB vendor ID/product ID pair. 57.Pp 58Firmware files are available in the 59.Pa comms/rtlbt-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 indent 69.It Fl D 70Enable verbose debugging. 71.It Fl d Ar device_name 72Specify 73.Xr ugen 4 74device name. 75.It Fl I 76Enable informational debugging. 77.It Fl f Ar firmware_path 78Specify the directory containing the firmware files to search and upload. 79.It Fl h 80Display usage message and exit. 81.El 82.Sh EXIT STATUS 83.Ex -std 84.Sh SEE ALSO 85.Xr libusb 3 , 86.Xr ng_ubt 4 , 87.Xr ugen 4 , 88.Xr devd 8 89.Sh AUTHORS 90.Nm 91is based on 92.Xr ath3kfw 8 93utility used as firmware downloader template and on Linux btrtl driver 94source code. 95It is written by 96.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org 97under sponsorship from Future Crew LLC. 98.Sh BUGS 99Most likely. 100Please report if found. 101