fwupd/plugins/rts54hid
Richard Hughes bf72d393fd Split up FuUsbDevice into ->open() and ->setup()
Before this change calling FuUsbDevice->open() opened the device, and
also unconditionally added various GUIDs and InstanceIDs which we
normally do in setup.
Then fu_device_setup() would call the FuSubclass->setup() vfunc which
would have no way of either opting out of the FuUsbDevice->setup()-like
behaviour, or controlling if the parent class ->setup is run before or
after the subclass setup.

Split up FuUsbDevice->open() into clear ->open() and ->setup() phases
and add the parent class calls where appropriate.

This means that ->setup() now behaves the same as all the other vfuncs.
2021-06-17 16:21:41 +01:00
..
fu-plugin-rts54hid.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01: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 Split up FuUsbDevice into ->open() and ->setup() 2021-06-17 16:21:41 +01:00
fu-rts54hid-device.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-rts54hid-module.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-rts54hid-module.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +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 Show a warning if the device has no GType and the plugin has no default 2021-04-15 16:52:56 +01: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.