fwupd/plugins/rts54hid/README.md
Richard Hughes 078beafb2d Add a new internal flag to opt-in to GUID matching
It is far too easy to forget to set FWUPD_DEVICE_FLAG_NO_GUID_MATCHING for new
plugins, and without it it all works really well *until* a user has two devices
of the same type installed at the same time and then one 'disappears' for hard
to explain reasons. Typically we only need it for replug anyway!

Explicitly opt-in to this rarely-required behaviour, with the default to just
use the physical and logical IDs. Also document the update behavior for each
plugin to explain why the flag is being used.

This allows you to have two identical Unifying plugged in without one of them
being hidden from the user, at the same time allowing a HIDRAW<->USB transition
when going to and from bootloader and runtime modes.

This removes the workaround added in 99eb3f06b6.

Fixes https://github.com/fwupd/fwupd/issues/2915
2021-02-25 15:47:25 +00:00

1.8 KiB

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.