fwupd/plugins/thelio-io/README.md
Richard Hughes 078beafb2d Add a new internal flag to opt-in to GUID matching
It is far too easy to forget to set FWUPD_DEVICE_FLAG_NO_GUID_MATCHING for new
plugins, and without it it all works really well *until* a user has two devices
of the same type installed at the same time and then one 'disappears' for hard
to explain reasons. Typically we only need it for replug anyway!

Explicitly opt-in to this rarely-required behaviour, with the default to just
use the physical and logical IDs. Also document the update behavior for each
plugin to explain why the flag is being used.

This allows you to have two identical Unifying plugged in without one of them
being hidden from the user, at the same time allowing a HIDRAW<->USB transition
when going to and from bootloader and runtime modes.

This removes the workaround added in 99eb3f06b6.

Fixes https://github.com/fwupd/fwupd/issues/2915
2021-02-25 15:47:25 +00:00

39 lines
991 B
Markdown

Thelio IO Support
=================
Introduction
------------
This plugin is used to detach the Thelio IO device to DFU mode.
To switch to this mode `1` has to be written to the `bootloader` file
in sysfs.
GUID Generation
---------------
These devices use the standard USB DeviceInstanceId values, e.g.
* `USB\VID_1209&PID_1776&REV_0001`
Update Behavior
---------------
The device usually presents in runtime mode, but on detach re-enumerates with a
different USB VID and PID in DFU mode. The device is then handled by the `dfu`
plugin.
On DFU attach the device again re-enumerates back to the runtime mode.
For this reason the `REPLUG_MATCH_GUID` internal device flag is used so that
the bootloader and runtime modes are treated as the same device.
Vendor ID Security
------------------
The vendor ID is set from the USB vendor, in this instance set to `USB:0x1209`
External interface access
-------------------------
This plugin requires read/write access to `/dev/bus/usb`.