Plugin: VIA

Introduction

This plugin is used to update USB hubs from VIA.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in an undisclosed binary file format.

This plugin supports the following protocol ID:

  • com.vli.i2c
  • com.vli.pd
  • com.vli.usbhub

GUID Generation

These devices use the standard USB DeviceInstanceId values, e.g.

  • USB\VID_17EF&PID_3083&REV_0001
  • USB\VID_17EF&PID_3083

All VLI devices also use custom GUID values for the device type, e.g.

  • USB\VID_17EF&PID_3083&DEV_VL812B3

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

  • CFI\FLASHID_37303840
  • CFI\FLASHID_3730
  • CFI\FLASHID_37

Optional PD child devices sharing the SPI flash use two extra GUIDs, e.g.

  • USB\VID_17EF&PID_3083&DEV_VL102
  • USB\VID_17EF&PID_3083&APP_26

Optional I²C child devices use just one extra GUID, e.g.

  • USB\VID_17EF&PID_3083&I2C_MSP430
  • USB\VID_17EF&PID_3083&I2C_PS186

Vendor ID Security

The vendor ID is set from the USB vendor, for example set to USB:0x2109

Quirk Use

This plugin uses the following plugin-specific quirks:

VliDeviceKind

Device kind, e.g. VL102.

Since: 1.3.7

VliSpiAutoDetect

SPI autodetect (default 0x1).

Since: 1.3.7

CfiDeviceCmdReadId

Flash command to read the ID.

Since: 1.3.3

CfiDeviceCmdReadIdSz

Size of the ReadId response.

The CfiDeviceCmdReadId and CfiDeviceCmdReadIdSz quirks have to be assigned to the device instance attribute, rather then the flash part as the ID is required to query the other flash chip parameters. For example:

[USB\VID_2109&PID_0210]
Plugin = vli
GType = FuVliUsbhubDevice
CfiDeviceCmdReadId = 0xf8
CfiDeviceCmdReadIdSz = 4

# W3IRDFLASHxxx
[CFI\\FLASHID_37303840]
CfiDeviceCmdChipErase = 0xc7
CfiDeviceCmdSectorErase = 0x20

Flags:attach-with-gpiob

This flag is used if device needs GPIO-B to reset the device.

Flags:unlock-legacy813

This flag is used for unlocking VL813 with a custom VDR request.

Flags:has-shared-spi-pd

This flag is used for devices that share SPI with the PD device.

Flags:has-msp430

This flag is used if device has a MSP430 attached via I²C.

Flags:has-rtd21xx

This flag is used if device has a RTD21XX attached via I²C.

Flags:has-i2c-ps186

This flag is used if device has a PS186 attached via I²C.

Flags:skips-rom

This flag handles cases to update in firmware mode, skips ROM mode entirely.

Flags:attach-with-usb

This flag is used if device needs unplug & re-plug usb cable to reset the device.

Flags:attach-with-power

This flag is used if device needs unplug & re-plug power cord to reset the device.

External Interface Access

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

Version Considerations

This plugin has been available since fwupd version 1.3.3.

Owners

Anyone can submit a pull request to modify this plugin, but the following people should be consulted before making major or functional changes:

  • Emily Miller: memily