xref: /freebsd/usr.sbin/bluetooth/rtlbtfw/rtlbtfw.8 (revision 24e4dcf4ba5e9dedcf89efd358ea3e1fe5867020)
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 15, 2025
27.Dt RTLBTFW 8
28.Os
29.Sh NAME
30.Nm rtlbtfw
31.Nd load firmware for Realtek 87XX/88XX Bluetooth USB devices
32.Sh SYNOPSIS
33.Nm
34.Fl d Ar device_name
35.Fl f Ar firmware_path
36.Nm
37.Fl h
38.Sh DESCRIPTION
39The
40.Nm
41utility downloads the specified firmware file to the specified
42.Xr ugen 4
43device.
44.Pp
45This utility will
46.Em only
47work with Realtek 87XX/88XX chip based Bluetooth USB devices and some of
48their successors.
49The identification is currently based on USB vendor ID/product ID pair and
50interface class.
51For Realtek devices the vendor ID should be 0x0bda
52.Pq Dv USB_VENDOR_REALTEK
53and the 0-th interface class/subclass/protocol should be a Bluetooth RF
54Wireless Controller.
55Non-Realtek devices are identified based on USB vendor ID/product ID pair.
56.Pp
57Firmware files are available in the
58.Pa comms/rtlbt-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 ng_ubt 4 ,
86.Xr ugen 4 ,
87.Xr devd 8
88.Sh AUTHORS
89.Nm
90is based on
91.Xr ath3kfw 8
92utility used as firmware downloader template and on Linux btrtl driver
93source code.
94It is written by
95.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org
96under sponsorship from Future Crew LLC.
97.Sh BUGS
98Most likely.
99Please report if found.
100