41400a8cc6
At the moment there are commands to convert one file format to another, but not
to 'merge' or alter them. Some firmware files are containers which can store
multiple images, each with optional id, idx and addresses.
This would allow us to, for instance, create a DfuSe file with two different
raw files that are flashed to different addresses on the SPI flash. It would
also allow us to create very small complicated container formats for fuzzing.
This can be used by writing a `firmware.builder.xml` file like:
<?xml version="1.0" encoding="UTF-8"?>
<firmware gtype="FuBcm57xxFirmware">
<version>1.2.3</version>
<image>
<version>4.5.6</version>
<id>header</id>
<idx>456</idx>
<addr>0x456</addr>
<filename>header.bin</filename>
</image>
<image>
<version>7.8.9</version>
<id>payload</id>
<idx>789</idx>
<addr>0x789</addr>
<data>aGVsbG8=</data>
</image>
</firmware>
...and then using something like:
# fwupdtool firmware-convert firmware.builder.xml firmware.dfu builder dfu
|
||
|---|---|---|
| .. | ||
| acpi-dmar | ||
| acpi-facp | ||
| altos | ||
| amt | ||
| ata | ||
| bios | ||
| ccgx | ||
| colorhug | ||
| coreboot | ||
| cpu | ||
| cros-ec | ||
| csr | ||
| dell | ||
| dell-dock | ||
| dell-esrt | ||
| dfu | ||
| ebitdo | ||
| elantp | ||
| emmc | ||
| ep963x | ||
| fastboot | ||
| flashrom | ||
| fresco-pd | ||
| iommu | ||
| jabra | ||
| linux-lockdown | ||
| linux-sleep | ||
| linux-swap | ||
| linux-tainted | ||
| logind | ||
| logitech-hidpp | ||
| modem-manager | ||
| msr | ||
| nitrokey | ||
| nvme | ||
| optionrom | ||
| pci-bcr | ||
| pci-mei | ||
| platform-integrity | ||
| redfish | ||
| rts54hid | ||
| rts54hub | ||
| solokey | ||
| steelseries | ||
| superio | ||
| synaptics-cxaudio | ||
| synaptics-mst | ||
| synaptics-prometheus | ||
| synaptics-rmi | ||
| test | ||
| thelio-io | ||
| thunderbolt | ||
| tpm | ||
| tpm-eventlog | ||
| uefi | ||
| uefi-dbx | ||
| uefi-recovery | ||
| upower | ||
| vli | ||
| wacom-raw | ||
| wacom-usb | ||
| meson.build | ||
| README.md | ||
Adding a new plugin
An extensible architecture allows for providing new plugin types (for reading and writing different firmware) as well as ways quirk their behavior.
You can find more information about the architecture in the developers section of the fwupd website.
You can use the fwupd developer documentation to assist with APIs available to write the plugin.
If you have a firmware specification and would like to see support in this project, please file an issue and share the spec. Patches are also welcome.
We will not accept plugins that upgrade hardware using a proprietary Linux executable, proprietary UEFI executable, proprietary library, or DBus interface.
Plugin interaction
Some plugins may be able to influence the behavior of other plugins. This includes things like one plugin turning on a device, or providing missing metadata to another plugin.
The ABI for these interactions is defined in: https://github.com/fwupd/fwupd/blob/master/src/fu-device-metadata.h
All interactions between plugins should have the interface defined in that file.