fwupd/plugins/dfu
Richard Hughes 40cd18fa97 Allow using a per-device global percentage completion
It's actually quite hard to build a front-end for fwupd at the moment
as you're never sure when the progress bar is going to zip back to 0%
and start all over again. Some plugins go 0..100% for write, others
go 0..100% for erase, then again for write, then *again* for verify.

By creating a helper object we can easily split up the progress of the
specific task, e.g. write_firmware().

We can encode at the plugin level "the erase takes 50% of the time, the
write takes 40% and the read takes 10%". This means we can have a
progressbar which goes up just once at a consistent speed.
2021-09-13 14:28:15 +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 Check the quirk format as part of precommit 2021-08-23 18:10:12 +01:00
fu-dfu-common.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-common.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-device.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-device.h Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-sector.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-sector.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-self-test.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-target-avr.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-target-avr.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-target-private.h Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-target-stm.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-target-stm.h trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
fu-dfu-target.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-target.h Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-dfu-tool.c Allow using a per-device global percentage completion 2021-09-13 14:28:15 +01:00
fu-plugin-dfu.c trivial: reformat the whole tree to match new format 2021-08-24 11:18:40 -05:00
meson.build trivial: dfu: depend on plugin_deps rather than hardcoding libraries 2021-06-14 09:25:24 +01:00
README.md trivial: update markdown for pre-commit style 2021-07-18 14:42:47 -05:00

DFU

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:

DfuFlags

Optional quirks for a DFU device which doesn't follow the DFU 1.0 or 1.1 specification.

Since: 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.

Since: 1.0.1

DfuForceTimeout

Forces a specific device timeout, in ms.

Since: 1.4.0

DfuForceTransferSize

Forces a target transfer size, in bytes.

Since: 1.5.6

External Interface Access

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