fwupd/plugins/synaptics-rmi/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.1 KiB

Synaptics RMI4 Support

Introduction

This plugin updates integrated Synaptics RMI4 devices, typically touchpads.

GUID Generation

The HID DeviceInstanceId values are used, e.g. HIDRAW\VEN_06CB&DEV_4875.

These devices also use custom GUID values constructed using the board ID, e.g.

  • SYNAPTICS_RMI\TM3038-002
  • SYNAPTICS_RMI\TM3038

Update Behavior

The device usually presents in HID mode, and the firmware is written to the device by switching to a SERIO mode where the touchpad is nonfunctional. Once complete the device is reset to get out of SERIO mode and to load the new firmware version.

Vendor ID Security

The vendor ID is set from the udev vendor, in this instance set to HIDRAW:0x06CB

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in a proprietary (but docucumented) file format.

This plugin supports the following protocol ID:

  • com.synaptics.rmi

External interface access

This plugin requires ioctl access to HIDIOCSFEATURE and HIDIOCGFEATURE.