fwupd/plugins/fastboot/README.md
2021-07-18 14:42:47 -05:00

57 lines
1.5 KiB
Markdown

# Fastboot
## Introduction
This plugin is used to update hardware that uses the fastboot protocol.
## Firmware Format
The daemon will decompress the cabinet archive and extract a firmware blob in
ZIP file format. Inside the zip file must be all the firmware images for each
partition and a manifest file. The partition images can be in any format, but
the manifest must be either an Android `flashfile.xml` format file, or a QFIL
`partition_nand.xml` format file.
For both types, all partitions with a defined image found in the zip file will
be updated.
This plugin supports the following protocol ID:
* com.google.fastboot
## GUID Generation
These devices use the standard USB DeviceInstanceId values, e.g.
* `USB\VID_18D1&PID_4EE0&REV_0001`
* `USB\VID_18D1&PID_4EE0`
* `USB\VID_18D1`
## Update Behavior
A fastboot device usually presents in runtime mode (or with no interface),
but if the user puts the device into fastboot mode using a physical button
it then enumerates with a USB descriptor. On attach the device reboots to
runtime mode which *may* mean the device "goes away".
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.
## Quirk Use
This plugin uses the following plugin-specific quirk:
### FastbootBlockSize
Block size to use for transfers.
Since: 1.2.2
## Vendor ID Security
The vendor ID is set from the USB vendor, for example `USB:0x18D1`
## External Interface Access
This plugin requires read/write access to `/dev/bus/usb`.