fwupd/plugins/dfu
Mario Limonciello 1e17457b16 Allow building the documentation with gi-docgen and gtk-doc
Until gi-docgen is declared stable support either of them.
This effectively means that hand builds and CI builds will use
gi-docgen, but distro builds use gtk-doc-tools.
2021-06-09 22:21:53 +01:00
..
contrib trivial: correct docstring location for a few python files 2021-04-09 16:02:20 +01:00
dfu-tool.1 Do not use help2man to build manual pages 2021-04-11 13:42:04 +01:00
dfu.quirk dfu: Fix up some overzealous replacement when renaming the DFU files 2021-04-23 13:59:44 -05:00
fu-dfu-common.c Allow building the documentation with gi-docgen and gtk-doc 2021-06-09 22:21:53 +01:00
fu-dfu-common.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-device.c Allow building the documentation with gi-docgen and gtk-doc 2021-06-09 22:21:53 +01:00
fu-dfu-device.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-sector.c Allow building the documentation with gi-docgen and gtk-doc 2021-06-09 22:21:53 +01:00
fu-dfu-sector.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-self-test.c trivial: fix some trailing whitespace problems across the project 2021-04-09 16:02:20 +01:00
fu-dfu-target-avr.c trivial: Standardize on introspection for @error and @cancellable 2021-04-28 16:19:50 +01:00
fu-dfu-target-avr.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-target-private.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-target-stm.c trivial: Standardize on introspection for @error and @cancellable 2021-04-28 16:19:50 +01:00
fu-dfu-target-stm.h dfu: Modernize the coding style to match the other plugings 2021-02-24 10:36:45 +00:00
fu-dfu-target.c Allow building the documentation with gi-docgen and gtk-doc 2021-06-09 22:21:53 +01:00
fu-dfu-target.h Remove FuFirmwareImage and just use FuFirmware instead 2021-03-09 21:14:12 +00:00
fu-dfu-tool.c fu_dfu_tool_get_default_device: Avoid use-after-free 2021-04-21 10:57:51 +01:00
fu-plugin-dfu.c Show a warning if the device has no GType and the plugin has no default 2021-04-15 16:52:56 +01:00
meson.build Do not use help2man to build manual pages 2021-04-11 13:42:04 +01:00
README.md Add a new internal flag to opt-in to GUID matching 2021-02-25 15:47:25 +00:00

DFU Support

Introduction

Device Firmware Update is a standard that allows USB devices to be easily and safely updated by any operating system.

Firmware Format

The daemon will decompress the cabinet archive and extract a firmware blob in DFU or DfuSe file format.

This plugin supports the following protocol IDs:

  • org.usb.dfu
  • com.st.dfuse

GUID Generation

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

  • USB\VID_273F&PID_1003&REV_0001
  • USB\VID_273F&PID_1003
  • USB\VID_273F

Update Behavior

A DFU device usually presents in runtime mode (with optional DFU runtime), but on detach re-enumerates with an additional required DFU descriptor. On 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, for example USB:0x0A12

Quirk use

This plugin uses the following plugin-specific quirks:

Quirk Description Minimum fwupd version
DfuFlags Optional quirks for a DFU device which doesn't follow the DFU 1.0 or 1.1 specification 1.0.1
DfuForceVersion Forces a specific DFU version for the hardware device. This is required if the device does not set, or sets incorrectly, items in the DFU functional descriptor. 1.0.1
DfuForceTimeout Forces a specific device timeout, in ms 1.4.0
DfuForceTransferSize Forces a target transfer size, in bytes 1.5.6

External interface access

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