1REALTEK DRIVER
2==============
3
4This driver supports loading firmware images and optional config data to
5USB dongles with a Realtek chipset.
6A number of USB dongles are supported, but likely not all.
7When using a USB dongle, the USB product ID and vendor ID are used
8to find whether a matching set of firmware image and config data
9is needed for that specific model. If a match exists, the driver will try
10load the firmware image and, if needed, config data.
11Alternatively, the metadata property ``driver=rtk`` may be specified in a transport
12name to force that driver to be used (ex: ``usb:[driver=rtk]0`` instead of just
13``usb:0`` for the first USB device).
14The driver will look for those files by name, in order, in:
15
16  * The directory specified by the environment variable `BUMBLE_RTK_FIRMWARE_DIR`
17    if set.
18  * The directory `<package-dir>/drivers/rtk_fw` where `<package-dir>` is the directory
19    where the `bumble` package is installed.
20  * The current directory.
21
22
23Obtaining Firmware Images and Config Data
24-----------------------------------------
25
26Firmware images and config data may be obtained from a variety of online
27sources.
28To facilitate finding a downloading the, the utility program `bumble-rtk-fw-download`
29may be used.
30
31```
32Usage: bumble-rtk-fw-download [OPTIONS]
33
34  Download RTK firmware images and configs.
35
36Options:
37  --output-dir TEXT               Output directory where the files will be
38                                  saved  [default: .]
39  --source [linux-kernel|realtek-opensource|linux-from-scratch]
40                                  [default: linux-kernel]
41  --single TEXT                   Only download a single image set, by its
42                                  base name
43  --force                         Overwrite files if they already exist
44  --parse                         Parse the FW image after saving
45  --help                          Show this message and exit.
46```
47
48Utility
49-------
50
51The `bumble-rtk-util` utility may be used to interact with a Realtek USB dongle
52and/or firmware images.
53
54```
55Usage: bumble-rtk-util [OPTIONS] COMMAND [ARGS]...
56
57Options:
58  --help  Show this message and exit.
59
60Commands:
61  drop   Drop a firmware image from the USB dongle.
62  info   Get the firmware info from a USB dongle.
63  load   Load a firmware image into the USB dongle.
64  parse  Parse a firmware image.
65```