fwupd/plugins/synaptics-cape/README.md
Simon Ho 471c3e0c36
synaptics-cape: Add interrupt endpoint support (#3798)
Add new flag can receive HID report over Interrupt In endpoint instead
of control endpoint.

This commit also fixes a false error within software reset function.
2021-09-27 16:53:08 +08:00

43 lines
1.0 KiB
Markdown

# Synaptics CAPE devices
## Introduction
This plugin is used to update Synaptics CAPE based audio devices.
## Firmware Format
The daemon will decompress the cabinet archive and extract a firmware blob.
This plugin supports the following protocol ID:
* com.synaptics.cape
## GUID Generation
These devices use the standard USB DeviceInstanceId values, e.g.
* `USB\VID_1395&PID_0293`
These devices also use custom GUID values, e.g.
* `SYNAPTICS_CAPE\CX31993`
* `SYNAPTICS_CAPE\CX31988`
## 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.
## Vendor ID Security
The vendor ID is set from the USB vendor, in this instance set to `USB:0x1395`
### Plugin-specific flags
* use-in-report-interrupt: some devices will support IN_REPORT that allow host communicate with
device over interrupt instead of control endpoint, since: 1.7.0
## External Interface Access
This plugin requires read/write access to `/dev/bus/usb`.