fwupd/plugins/synaptics-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-synaptics-mst.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-self-test.c synaptics-mst: Only probe devices that have opted-in 2021-09-03 21:14:37 +01:00
fu-synaptics-mst-common.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-common.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-connection.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-connection.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-device.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-synaptics-mst-device.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-firmware.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-synaptics-mst-firmware.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
meson.build Allow overriding the quirks directory at runtime 2021-09-03 21:14:37 +01:00
README.md trivial: update markdown for pre-commit style 2021-07-18 14:42:47 -05:00
synaptics-mst-evb.quirk Simplify the quirk file format 2021-03-03 08:30:34 +00:00
synaptics-mst.quirk synaptics-mst: Only probe devices that have opted-in 2021-09-03 21:14:37 +01:00

Synaptics MST

This plugin supports querying and flashing Synaptics MST hubs used in Dell systems and docks.

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.synaptics.mst

GUID Generation

These devices use custom GUID values, e.g.

  • MST-$(board-ID)
  • MST-$(device_kind)-$(chip-ID)-$(board-ID)
  • MST-$(device_kind)-$(board-ID)
  • MST-$(device_kind)

Please refer to the plugin source for more details about how the GUID is constructed for specific hardware.

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. On some hardware the MST device may not enumerate if there is no monitor actually plugged in.

Vendor ID Security

The vendor ID is set from the PCI vendor, for example set to DRM_DP_AUX_DEV:0x$(vid)

Requirements

(Kernel) DP Aux Interface

Kernel 4.6 introduced an DRM DP Aux interface for manipulation of the registers needed to access an MST hub. This patch can be backported to earlier kernels: https://github.com/torvalds/linux/commit/e94cb37b34eb8a88fe847438dba55c3f18bf024a

libsmbios

At compilation time and runtime you will need libsmbios_c version 2.3.0 or later

If you don't want or need this functionality you can use the --disable-dell option.

Usage

Supported devices will be displayed in # fwupdmgr get-devices output.

Here is an example output from a Dell WD15 dock:

Dell WD15/TB16 wired Dock Synaptics VMM3332
  Guid:                 653cd006-5433-57db-8632-0413af4d3fcc
  DeviceID:             MST-1-1-0-0
  Plugin:               synaptics_mst
  Flags:                allow-online
  Version:              3.10.002
  Created:              2017-01-13
  Modified:             2017-01-13
  Trusted:              none

Payloads can be flashed just like any other plugin from LVFS.

Supported devices

Not all Dell systems or accessories contain MST hubs. Here is a sample list of systems known to support them however:

  • Dell WD15 dock
  • Dell TB16 dock
  • Dell TB18DC
  • Latitude E5570
  • Latitude E5470
  • Latitude E5270
  • Latitude E7470
  • Latitude E7270
  • Latitude E7450
  • Latitude E7250
  • Latitude E5550
  • Latitude E5450
  • Latitude E5250
  • Latitude Rugged 5414
  • Latitude Rugged 7214
  • Latitude Rugged 7414

External Interface Access

This plugin requires read/write access to /dev/drm_dp_aux*.