fwupd/plugins/dell-dock
Richard Hughes aaa77c6f51 Allow adding and removing custom flags on devices
The CustomFlags feature is a bit of a hack where we just join the flags
and store in the device metadata section as a string. This makes it
inefficient to check if just one flag exists as we have to split the
string to a temporary array each time.

Rather than adding to the hack by splitting, appending (if not exists)
then joining again, store the flags in the plugin privdata directly.

This allows us to support negating custom properties (e.g. ~hint) and
also allows quirks to append custom values without duplicating them on
each GUID match, e.g.

[USB\VID_17EF&PID_307F]
Plugin = customflag1
[USB\VID_17EF&PID_307F&HUB_0002]
Flags = customflag2

...would result in customflag1,customflag2 which is the same as you'd
get from an enumerated device flag doing the same thing.
2021-06-23 07:59:15 +01:00
..
dell-dock.quirk dell-dock: add usb protocol for USB4 device 2021-06-19 16:44:24 +01:00
fu-dell-dock-common.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-common.h dell-dock: add usb protocol for USB4 device 2021-06-19 16:44:24 +01:00
fu-dell-dock-hid.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-hid.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-hub.c Allow adding and removing custom flags on devices 2021-06-23 07:59:15 +01:00
fu-dell-dock-hub.h Allow adding and removing custom flags on devices 2021-06-23 07:59:15 +01:00
fu-dell-dock-i2c-ec.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-i2c-ec.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-i2c-mst.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-i2c-mst.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-i2c-tbt.c trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-i2c-tbt.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-status.c Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-dell-dock-status.h trivial: fixup includes for a variety of plugins 2021-06-14 10:12:45 +01:00
fu-dell-dock-usb-usb4.c dell-dock: add usb protocol for USB4 device 2021-06-19 16:44:24 +01:00
fu-dell-dock-usb-usb4.h dell-dock: add usb protocol for USB4 device 2021-06-19 16:44:24 +01:00
fu-plugin-dell-dock.c Allow adding and removing custom flags on devices 2021-06-23 07:59:15 +01:00
meson.build dell-dock: add usb protocol for USB4 device 2021-06-19 16:44:24 +01:00
README.md dell-dock: Add initial support for USB4 module 2021-06-04 22:31:18 -05:00

Dell USB-C Dock

Dell System

Unlike previous Dell USB-C devices, a Dell system is not needed for updating.

Components

The device contains components the following directly updatable components:

  • USB hubs
  • MST controller
  • Thunderbolt controller
  • Embedded controller

This plugin is used to perform the update on the USB hubs as well as the Dell Embedded controller. The USB hubs are updated directly over a USB HID endpoint while the embedded controller is updated using an I2C over HID interface.

The fwupd thunderbolt plugin is used for updating the Titan Ridge controller.

The MST controller is updated through either the DP Aux interface (SynapticsMST plugin) or I2C over HID interface provided by this plugin.

Device topology

When this plugin is used, devices present in other plugins may be shown in the topology of this dock. This is intentional as this plugin works together with those plugins to manage the flashing of all components.

Firmware Format

The daemon will decompress the cabinet archive and extract several firmware blobs with an unspecified binary file format.

This plugin supports the following protocol ID:

  • com.dell.dock
  • com.synaptics.mst

GUID Generation

These devices use several different generation schemes, e.g.

  • USB Hub1: USB\VID_413C&PID_B06F&hub
  • USB Hub2: USB\VID_413C&PID_B06E&hub
  • Embedded Controller: USB\VID_413C&PID_B06E&hub&embedded
  • Update Level: USB\VID_413C&PID_B06E&hub&status
  • MST Hub: MST-panamera-vmm5331-259
  • Thunderbolt Controller: TBT-00d4b070
  • USB4 Controller: TBT-00d4b071

Update Behavior

All devices will be updated the next time the usb-c plug from the dock is unplugged from the host.

Vendor ID Security

The vendor ID is set from the USB vendor, in this instance set to USB:0x413C

Quirk use

This plugin uses the following plugin-specific quirks:

Quirk Description Minimum fwupd version
DellDockUnlockTarget The EC argument needed for unlocking certain device usage. 1.1.3
DellDockBlobMajorOffset The offset of the major version number in a payload 1.1.3
DellDockBlobMinorOffset The offset of the minor version number in a payload 1.1.3
DellDockBlobBuildOffset The offset of the build version number in a payload 1.1.3
DellDockBlobVersionOffset The offset of the ASCII representation of a version string in a payload 1.1.3
DellDockBoardMin The minimum board revision required to safely operate the plugin 1.1.3
DellDockVersionLowest The minimum component version required to safely operate the plugin 1.1.3
DellDockBoard* The board description of a board revision 1.1.3
DellDockInstallDurationI2C The duration of time required to install a payload via I2C. 1.1.3

External interface access

This plugin requires read/write access to /dev/bus/usb.