fwupd/plugins/synaptics-mst/README.md
Mario Limonciello fd6ffd6dac trivial: rename synapticsmst to synaptics-mst
This brings the naming nomenclature inline with the other plugins
2019-12-12 13:59:41 -06:00

87 lines
2.4 KiB
Markdown

# 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-$(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.
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
* source: https://github.com/dell/libsmbios
* rpms: https://apps.fedoraproject.org/packages/libsmbios
* debs (Debian): http://tracker.debian.org/pkg/libsmbios
* debs (Ubuntu): http://launchpad.net/ubuntu/+source/libsmbios
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