fwupd/plugins/rts54hid
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
..
fu-plugin-rts54hid.c Be more strict for custom quirk keys 2021-03-03 08:30:34 +00:00
fu-rts54hid-common.h Change all instances of master/slave to initiator/target 2020-07-01 15:44:30 +01:00
fu-rts54hid-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-rts54hid-device.h Add FuHidDevice abstraction 2020-03-19 17:02:07 +00:00
fu-rts54hid-module.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-rts54hid-module.h trivial: Remove G_BEGIN_DECLS from all private headers 2019-10-09 20:02:16 +01: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
rts54hid.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00

Realtek RTS54HID HID Support

Introduction

This plugin allows the user to update any supported hub and attached downstream ICs using a custom HID-based flashing protocol. It does not support any RTS54xx device using the HUB update protocol.

Other devices connected to the RTS54HIDxx using I2C will be supported soon.

Firmware Format

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

This plugin supports the following protocol ID:

  • com.realtek.rts54

GUID Generation

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

  • USB\VID_0BDA&PID_1100&REV_0001
  • USB\VID_0BDA&PID_1100
  • USB\VID_0BDA

Child I²C devices are created using the device number as a suffix, for instance:

  • USB\VID_0BDA&PID_1100&I2C_01

Update Behavior

The firmware is deployed when the device is in normal runtime mode, and the device will reset when the new firmware has been written.

Vendor ID Security

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

Quirk use

This plugin uses the following plugin-specific quirks:

Quirk Description Minimum fwupd version
Rts54TargetAddr The target address of a child module. 1.1.3
Rts54I2cSpeed The I2C speed to operate at (0, 1, 2). 1.1.3
Rts54RegisterAddrLen The I2C register address length of commands 1.1.3

External interface access

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