fwupd/plugins/elantp
Richard Hughes 52441f28a4 Allow objects to deserialize to XML
This makes a lot more sense; we can parse a firmware and export the same XML
we would use in a .builder.xml file. This allows us to two two things:

 * Check we can round trip from XML -> binary -> XML

 * Using a .builder.xml file we can check ->write() is endian safe
2021-03-15 12:07:30 +00:00
..
elantp.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
fu-elantp-common.c elantp: Add a plugin to update Elan Touchpads using HID 2020-09-01 12:17:44 +01:00
fu-elantp-common.h elaptp: Allow recovery when the HID firmware fails to load 2020-09-14 16:19:45 +01:00
fu-elantp-firmware.c Allow objects to deserialize to XML 2021-03-15 12:07:30 +00:00
fu-elantp-firmware.h elantp: Add a plugin to update Elan Touchpads using HID 2020-09-01 12:17:44 +01:00
fu-elantp-hid-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-elantp-hid-device.h elantp: Add a plugin to update Elan Touchpads using HID 2020-09-01 12:17:44 +01:00
fu-elantp-i2c-device.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-elantp-i2c-device.h elaptp: Allow recovery when the HID firmware fails to load 2020-09-14 16:19:45 +01:00
fu-plugin-elantp.c Be more strict for custom quirk keys 2021-03-03 08:30:34 +00:00
fu-self-test.c Allow objects to deserialize to XML 2021-03-15 12:07:30 +00:00
meson.build Allow objects to deserialize to XML 2021-03-15 12:07:30 +00:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

Elan TouchPad

Introduction

This plugin allows updating Touchpad devices from Elan. Devices are enumerated using HID and raw I²C nodes. The I²C mode is used for firmware recovery.

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:

  • tw.com.emc.elantp

GUID Generation

These device uses the standard DeviceInstanceId values, e.g.

  • HIDRAW\VEN_04F3&DEV_3010

Additionally another instance ID is added which corresponds to the module ID:

  • HIDRAW\VEN_04F3&DEV_3010&MOD_1234

These devices also use custom GUID values for the IC configuration, e.g.

  • ELANTP\ICTYPE_09

Additionally another instance ID is added which corresponds to the IC type & module ID:

  • ELANTP\ICTYPE_09&MOD_1234

Update Behavior

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

On flash failure the device is nonfunctional, but is recoverable by writing to the i2c device. This is typically much slower than updating the device using HID and also requires a model-specific HWID quirk to match.

Vendor ID Security

The vendor ID is set from the HID vendor, for example set to HIDRAW:0x17EF

Quirk use

This plugin uses the following plugin-specific quirks:

Quirk Description Minimum fwupd version
ElantpIcPageCount The IC page count 1.4.6
ElantpIapPassword The IAP password 1.4.6

External interface access

This plugin requires ioctl access to HIDIOCSFEATURE and HIDIOCGFEATURE.