fwupd/plugins/realtek-mst
Richard Hughes 40cd18fa97 Allow using a per-device global percentage completion
It's actually quite hard to build a front-end for fwupd at the moment
as you're never sure when the progress bar is going to zip back to 0%
and start all over again. Some plugins go 0..100% for write, others
go 0..100% for erase, then again for write, then *again* for verify.

By creating a helper object we can easily split up the progress of the
specific task, e.g. write_firmware().

We can encode at the plugin level "the erase takes 50% of the time, the
write takes 40% and the read takes 10%". This means we can have a
progressbar which goes up just once at a consistent speed.
2021-09-13 14:28:15 +01:00
..
fu-plugin-realtek-mst.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-realtek-mst-device.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-realtek-mst-device.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
meson.build realtek_mst: new plugin supporting RTD2142 2021-06-28 10:09:52 +01:00
README.md realtek-mst: Add a warning that extreme caution should be used 2021-07-30 09:26:43 +01:00
realtek-mst.quirk realtek-mst: add support for RTD2141B 2021-08-06 11:00:35 +10:00

Realtek MST

Introduction

This plugin updates the firmware of DisplayPort MST hub devices made by Realtek, such as the RTD2141b and RTD2142.

These devices communicate over I²C, via the DisplayPort aux channel. Devices are declared by system firmware, and quirks specify the aux channel to which the device is connected for a given system.

System firmware must specify the device's presence because while they can be identified partially through the presence of Realtek's OUI in the Branch Device OUI fields of DPCD (DisplayPort Configuration Data), they do not have unique Device Identification strings.

This plugin was neither written, verified, supported or endorsed by Realtek Semiconductor Corp.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in an unspecified binary file format, which is written to the partition of the device flash that is not currently running.

This plugin supports the following protocol ID:

  • com.realtek.rtd2142

GUID Generation

Devices use custom DeviceInstanceId values derived from device names provided by system firmware and read from sysfs, like:

  • REALTEK-MST\NAME_10EC2142:00
  • REALTEK-MST\NAME_10EC2142:00&FAMILY_Google_Hatch

Quirk Use

This plugin uses the following plugin-specific quirks:

RealtekMstDpAuxName

Specifies the name of the drm_dp_aux_dev channel over which the device should be reached.

Since: 1.6.2

Vendor ID security

The vendor ID is specified by system firmware (such as ACPI tables).

External Interface Access

This plugin requires access to i2c buses associated with the specified DisplayPort aux channel, usually /dev/i2c-5 or similar.