fwupd/plugins/dfu-csr
Richard Hughes 1981c63d58 Remove FuFirmwareImage and just use FuFirmware instead
This allows us to 'nest' firmware formats, and removes a ton of duplication.

The aim here is to deprecate FuFirmwareImage -- it's almost always acting
as a 'child' FuFirmware instance, and even copies most of the vfuncs to allow
custom types. If I'm struggling to work out what should be a FuFirmware and
what should be a FuFirmwareImage then a plugin author has no hope.

For simple payloads we were adding bytes into an image and then the image into
a firmware. This gets really messy when most plugins are treating the FuFirmware
*as* the binary firmware file.

The GBytes saved in the FuFirmware would be considered the payload with the
aim of not using FuFirmwareImage in the single-image case.
2021-03-09 21:14:12 +00:00
..
data csr: Rename plugin to dfu-csr as it depends on the prefixed plugin 2021-02-18 14:46:20 +00:00
dfu-csr.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
fu-dfu-csr-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-dfu-csr-device.h csr: Rename plugin to dfu-csr as it depends on the prefixed plugin 2021-02-18 14:46:20 +00:00
fu-plugin-dfu-csr.c csr: Rename plugin to dfu-csr as it depends on the prefixed plugin 2021-02-18 14:46:20 +00:00
meson.build Move the plugin build logic to the plugins themselves 2021-02-18 14:46:20 +00:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

DFU CSR Support

Introduction

CSR is often called “driverless DFU” and is used only by BlueCore chips from Cambridge Silicon Radio (now owned by Qualcomm). The driverless just means that it's DFU like, and is routed over HID.

CSR is a ODM that makes most of the Bluetooth audio chips in vendor hardware. The hardware vendor can enable or disable features on the CSR microcontroller depending on licensing options (for instance echo cancellation), and theres even a little virtual machine to do simple vendor-specific things.

All the CSR chips are updatable in-field, and most vendors issue updates to fix sound quality issues or to add support for new protocols or devices.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in DFU file format.

This plugin supports the following protocol ID:

  • com.qualcomm.dfu

GUID Generation

These devices use the standard USB DeviceInstanceId values, e.g.

  • USB\VID_0A12&PID_1337&REV_2520
  • USB\VID_0A12&PID_1337
  • USB\VID_0A12

Update Behavior

A DFU device usually presents in runtime mode (or with no interfaces defined), but if the user puts the device into bootloader mode using a physical button it then enumerates with a HID descriptor. On attach the device returns to runtime mode which may mean the device "goes away".

For this reason the REPLUG_MATCH_GUID internal device flag is used so that the bootloader and runtime modes are treated as the same device.

Vendor ID Security

The vendor ID is set from the USB vendor, in this instance set to USB:0x0A12

External interface access

This plugin requires read/write access to /dev/bus/usb.