FwupdPlugin – 1.0

An generic ACPI table.

An in-memory archive decompressor.

An archive firmware image, typically for nested firmware volumes.

An device discovery backend, for instance USB, BlueZ or UDev.

See also: FuUdevDevice.

See also: FuBlockDevice.

A BlueZ Bluetooth device.

A chip conforming to the Common Flash Memory Interface, typically a SPI flash chip.

A CFU offer. This is a 16 byte blob which contains enough data for the device to either accept or refuse a firmware payload. The offer may be loaded from disk, network, or even constructed manually. There is much left to how the specific firmware implements CFU, and it’s expected that multiple different plugins will use this offer in different ways.

A CFU payload. This contains of a variable number of blocks, each containing the address, size and the chunk data. The chunks do not have to be the same size, and the address ranges do not have to be continuous.

A optionally mutable packet of chunked data with address, page and index.

Create chunked data with address and index as required.

A input stream that is made up of other partial streams, e.g.

A context that represents the shared system state. This object is shared between the engine, the plugins and the devices.

A coSWID SWID section.

A comma seporated value entry.

A comma seporated value file.

A physical or logical device that is exported to the daemon.

A device event, used to enumulate hardware.

Easily close a shared resource (such as a device) when an object goes out of scope.

A DFU firmware image.

A DfuSe firmware image.

A Display Port AUX device.

A DRM device.

See also: FuFirmware.

A UEFI file.

A UEFI filesystem.

A fault tolerant working block store, as found in EDK2 NVRAM blocks.

See also: FuEfiDevicePath.

A UEFI firmware section.

A UEFI Signature as found in an EFI_SIGNATURE_LIST.

A UEFI signature list typically found in the PK and KEK keys.

A UEFI signature list typically found in the KEKUpdate.bin and DBXUpdate.bin files.

A UEFI file volume.

A NVRAM variable store.

A NVRAM authenticated variable.

See also: FuUdevDevice.

A X.509 certificate as found in an EFI_SIGNATURE_LIST.

Executable and Linkable Format is a common standard file format for executable files, object code, shared libraries, core dumps — and sometimes firmware.

A Flattened DeviceTree firmware image.

A Flattened DeviceTree firmware image.

A firmware file which can have children which represent the images within.

A Flat Image Tree.

A FMAP firmware image.

A HECI device.

A HID descriptor.

A Human Interface Device (HID) device.

See also: FuUdevDevice.

See also: FuHidDescriptor.

A the hardware IDs on the system.

A I²C device with an assigned bus number.

An Intel BIOS section.

An Intel Flash Descriptor.

An Intel Flash Descriptor image, e.g. BIOS.

An Intel Code Partition Directory (aka CPD) can be found in IFWI (Integrated Firmware Image) firmware blobs which are used in various Intel products using an IPU (Infrastructure Processing Unit).

An Intel Flash Program Tool (aka FPT) header can be found in IFWI (Integrated Firmware Image) firmware blobs which are used in various Intel products using an IPU (Infrastructure Processing Unit).

A Intel hex (ihex) firmware image.

The Non-Volatile-Memory file-format specification. This is what you would find as the update payload.

The Non-Volatile-Memory device specification. This is what you would find on the device SPI chip.

A bidirectional IO channel which can be read from and written to.

Easily reset the firmware search path.

A firmware made up of concatenated blobs of a different firmware type.

The Intel proprietary Management Engine Interface.

An OptionROM can be found in nearly every PCI device. Multiple OptionROM images may be appended.

A input stream that is a slice of another input stream.

See also: FuUdevDevice.

A PE file consists of a Microsoft MS-DOS stub, the PE signature, the COFF file header, and an optional header, followed by section data.

A PKCS#7 object, typically containing signed X.509 certificates.

A plugin which is used by fwupd to enumerate and update devices.

Objects can use fu_progress_set_percentage() if the absolute percentage is known. Percentages should always go up, not down.

Quirks can be used to modify device behavior. When fwupd is installed in long-term support distros it’s very hard to backport new versions as new hardware is released.

A set of Host Security ID attributes that represents the system state.

See also: FuUdevDevice.

Enumerate the SMBIOS data on the system.

A SREC firmware image.

A UDev device, typically only available on Linux.

A device that represents a UEFI EFI variable.

This object is a thin glib wrapper around a libusb_bos_dev_capability_descriptor.

This object is a thin glib wrapper around a libusb_config_dev_capability_descriptor.

A USB device.

A USB DS20 BOS descriptor.

This object is a thin glib wrapper around a libusb_endpoint_descriptor.

This object is a placeholder for the HID descriptor, and is populated with data after the device has been opened.

This object is a thin glib wrapper around a libusb_interface_descriptor.

A uSWID header with multiple optionally-compressed coSWID CBOR sections.

See also: FuUdevDevice.

Volume abstraction that uses UDisks.

Easily unmount a volume when an object goes out of scope.

An X.509 certificate.

The plugin-allocated private data.

A subset of virtual functions that are implemented by modular plugins.

The endian type, e.g. G_LITTLE_ENDIAN.

The source of the quirk data, ordered by how good the data is.

The CPU vendor.

The type of CRC.

The device lid state.

The kind of SREC record kind.

The device lid state.

Path types to use when dynamically determining a path at runtime.

The rules used for ordering plugins. Plugins are expected to add rules in fu_plugin_initialize().

Flags used when verifying, currently unused.

The system power state.

The flags to use when loading the archive.

The flags to use when loading files in the ESP.

The context flags.

The flags to use when incorporating a device instance.

The flags to use when configuring debugging.

Flags used when calling fu_hid_device_get_report() and fu_hid_device_set_report().

The flags used when reading data from the TTY.

Flags used when calling fu_ioctl_execute() and fu_udev_device_ioctl().

The flags to use when loading quirks.

The flags to use when calculating an HSI version.

Flags for the fu_usb_device_claim_interface and fu_usb_device_release_interface methods flags parameters.

The flags to use when converting to and from UTF-8.

The archive iteration callback.

The context lookup iteration callback.

Callback to use when opening and closing using fu_device_locker_new_full().

The device retry iteration callback.

The quirks iteration callback.

The fu_strsplit_full() iteration callback.

Align a byte array length to a power of 2 boundary, where alignment is the bit position to align to. If alignment is zero then array is unchanged.

since: 1.6.0

Adds the content of array2 to array.

since: 2.0.17

Adds the contents of a GBytes to a byte array.

since: 1.5.8

Adds a 16 bit integer to a byte array.

since: 1.3.1

Adds a 24 bit integer to a byte array.

since: 1.8.13

Adds a 32 bit integer to a byte array.

since: 1.3.1

Adds a 64 bit integer to a byte array.

since: 1.5.8

Adds a 8 bit integer to a byte array.

since: 1.3.1

Compares two buffers for equality.

since: 1.8.0

Converts a lowercase hex string to a byte array.

since: 1.9.6

Sets the size of the GByteArray, expanding with data as required.

since: 1.8.2

Converts the byte array to a lowercase hex string.

since: 1.8.9

Aligns a block of memory to blksize using the padval value; if the block is already aligned then the original bytes is returned.

since: 1.8.2

Compares the buffers for equality.

since: 1.8.2

Converts a lowercase hex string to a GBytes.

since: 2.0.5

Reads a blob of data from a file.

since: 1.8.2

Get the byte data in the GBytes. This data should not be modified. This function will always return the same pointer for a given GBytes.

since: 1.6.0

Checks if a byte array are just empty (0xff) bytes.

since: 1.8.2

Creates a GBytes which is a subsection of another GBytes.

since: 1.8.2

Pads a GBytes to a minimum sz with 0xff.

since: 2.0.7

Writes a blob of data to a filename, creating the parent directories as required.

since: 1.8.2

Converts bytes to a lowercase hex string.

since: 2.0.4

Align a value to a power of 2 boundary, where alignment is the bit position to align to. If alignment is zero then value is always returned unchanged.

since: 1.6.0

Returns the current kernel command line options.

since: 1.5.6

Returns the size of physical memory.

since: 1.5.6

Gets the system Olson timezone ID, as used in the CLDR and ICU specifications.

since: 1.9.7

Checks whether a chunk of memory looks like it could be a GUID.

since: 1.2.5

Gets attributes for the first CPU listed in /proc/cpuinfo.

since: 2.0.7

Uses CPUID to discover the CPU vendor.

since: 1.8.2

Calls CPUID and returns the registers for the given leaf.

since: 1.8.2

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.0

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.2

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.0

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.2

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.0

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.2

Returns the cyclic redundancy kind for the given memory buffer and target CRC.

since: 2.0.0

Returns the MISR check value for the given memory buffer.

since: 1.9.17

Dumps a byte buffer to the screen.

since: 1.8.2

Dumps a raw buffer to the screen.

since: 1.8.2

Dumps a raw buffer to the screen.

since: 1.8.2

Converts a GUID to the known nice name.

since: 1.6.2

Parses a UEFI section.

since: 2.0.0

Imports an EFI_TIME from XML.

since: 2.0.17

Exports an EFI_TIME to XML.

since: 2.0.17

Convert the error to a FwupdError, if required.

since: 2.0.14

Split the stream into blocks and calls a function on each chunk.

since: 2.0.0

Generates the checksum of the entire stream.

since: 2.0.0

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.0

Returns the cyclic redundancy check value for the given memory buffer.

since: 2.0.0

Returns the arithmetic sum of all bytes in the stream.

since: 2.0.0

Returns the arithmetic sum of all bytes in the stream.

since: 2.0.1

Returns the arithmetic sum of all bytes in the stream.

since: 2.0.0

Find a memory buffer within an input stream, without loading the entire stream into a buffer.

since: 2.0.0

Opens the file as n input stream.

since: 2.0.0

Read a byte array from a stream in a safe way.

since: 2.0.0

Read a GBytes from a stream in a safe way.

since: 2.0.0

Tries to read count bytes from the stream into the buffer starting at buf.

since: 2.0.0

Read a UTF-8 string from a stream in a safe way.

since: 2.0.0

Read a value from a stream using a specified endian in a safe way.

since: 2.0.0

Read a value from a stream using a specified endian in a safe way.

since: 2.0.0

Read a value from a stream using a specified endian in a safe way.

since: 2.0.0

Read a value from a stream using a specified endian in a safe way.

since: 2.0.0

Read a value from a stream using a specified endian in a safe way.

since: 2.0.0

Reads the total possible of the stream.

since: 2.0.0

Gets a BSD kernel environment string. This will not work on Linux or Windows.

since: 1.6.1

Add a kernel command line argument.

since: 1.9.5

Determines if the system is running at least a certain required kernel version.

since: 1.8.2

Loads all the kernel /proc/cmdline key/values into a hash table.

since: 1.8.5

Loads all the kernel options into a hash table. Commented out options are not included.

since: 1.8.5

Determines if kernel lockdown in effect.

since: 1.8.2

Parses all the kernel key/values into a hash table, respecting double quotes when required.

since: 1.9.1

Parses all the kernel options into a hash table. Commented out options are not included.

since: 1.9.6

Remove a kernel command line argument.

since: 1.9.5

Works out if reading from a buffer is safe. Providing the buffer sizes allows us to check for buffer overflow.

since: 1.9.1

Works out if writing to a buffer is safe. Providing the buffer sizes allows us to check for buffer overflow.

since: 1.9.1

Compares the buffers for equality.

since: 1.8.2

Copies some memory using memcpy in a safe way. Providing the buffer sizes of both the destination and the source allows us to check for buffer overflow.

since: 1.8.2

Duplicates some memory using memdup in a safe way.

since: 1.8.2

Finds a block of memory in another block of memory in a safe way.

since: 1.8.2

Read a value from a buffer using a specified endian.

since: 1.8.2

Read a value from a buffer using a specified endian in a safe way.

since: 1.8.2

Read a value from a buffer using a specified endian.

since: 1.8.2

Read a value from a buffer using a specified endian in a safe way.

since: 1.8.3

Read a value from a buffer using a specified endian.

since: 1.8.2

Read a value from a buffer using a specified endian in a safe way.

since: 1.8.2

Read a value from a buffer using a specified endian.

since: 1.8.2

Read a value from a buffer using a specified endian in a safe way.

since: 1.8.2

Read a value from a buffer in a safe way.

since: 1.8.2

Converts a byte buffer to a ASCII string.

since: 1.9.3

Writes a value to a buffer using a specified endian.

since: 1.8.2

Write a value to a buffer using a specified endian in a safe way.

since: 1.8.2

Writes a value to a buffer using a specified endian.

since: 1.8.2

Writes a value to a buffer using a specified endian.

since: 1.8.2

Write a value to a buffer using a specified endian in a safe way.

since: 1.8.2

Writes a value to a buffer using a specified endian.

since: 1.8.2

Write a value to a buffer using a specified endian in a safe way.

since: 1.8.2

Write a value to a buffer in a safe way.

since: 1.8.2

Opens the file as an output stream.

since: 2.0.12

Write bytes into the stream, retrying as required. Will block during the operation.

since: 2.0.12

Looks for a program in the PATH variable.

since: 1.8.2

Gets a fwupd-specific system path. These can be overridden with various environment variables, for instance FWUPD_DATADIR.

since: 1.8.2

Returns every file found under directory, and any subdirectory. If any path under directory cannot be accessed due to permissions an error will be returned.

since: 1.8.2

Returns the symlink target.

since: 2.0.0

Returns all the filenames that match a specific glob pattern. Any results are sorted. No matching files will set error.

since: 1.8.2

Returns the resolved absolute file name.

since: 2.0.0

Creates any required directories, including any parent directories.

since: 1.8.2

Creates any required directories, including any parent directories.

since: 1.8.2

Recursively removes a directory.

since: 1.8.2

Determines if the power state can be considered “on AC power”.

since: 1.8.11

Check whether the current process is running inside a snap.

since: 2.0.4

Copies a string from a buffer of a specified size up to (but not including) NUL.

since: 1.8.11

Removes leading and trailing whitespace from a mutable string.

since: 2.0.17

Joins an array of strings together to form one long string, with the optional separator inserted between each of them.

since: 1.8.2

Hides password strings encoded in HTTP requests.

since: 1.9.10

Converts a string into something that can be safely printed.

since: 1.8.2

Converts a GBytes into something that can be safely printed.

since: 2.0.2

Splits a string into a maximum of max_tokens pieces, using the given delimiter. If max_tokens is reached, the remainder of string is appended to the last token.

since: 1.8.2

Splits a string into a maximum of max_tokens pieces, using the given delimiter. If max_tokens is reached, the remainder of string is appended to the last token.

since: 2.0.7

Splits the string, calling the given function for each of the tokens found. If any callback returns FALSE scanning is aborted.

since: 1.8.2

Splits the string, calling the given function for each of the tokens found. If any callback returns FALSE scanning is aborted.

since: 2.0.0

Removes leading and trailing whitespace from a constant string.

since: 1.8.2

Converts a string value to a boolean. Only true and false are accepted values.

since: 1.8.2

Converts a string value to an integer. Values are assumed base 10, unless prefixed with “0x” where they are parsed as base 16.

since: 2.0.0

Converts a string value to an integer. If the value is prefixed with 0x then the base is set to 16 automatically.

since: 2.0.0

Returns the width of the string in displayed characters on the console.

since: 1.8.2

Returns the arithmetic sum of all bytes in buf, adding them one byte at a time.

since: 1.8.2

Returns the arithmetic sum of all bytes in blob, adding them one byte at a time.

since: 1.8.2

Returns the arithmetic sum of all bytes in buf, adding them one word at a time. The caller must ensure that bufsz is a multiple of 2.

since: 1.8.2

Returns the arithmetic sum of all bytes in blob, adding them one word at a time. The caller must ensure that the size of blob is a multiple of 2.

since: 1.8.2

Returns the arithmetic sum of all bytes in buf, adding them one byte at a time.

since: 1.8.2

Returns the arithmetic sum of all bytes in blob, adding them one byte at a time.

since: 1.8.2

Returns the arithmetic sum of all bytes in buf, adding them one dword at a time. The caller must ensure that bufsz is a multiple of 4.

since: 1.8.2

Returns the arithmetic sum of all bytes in blob, adding them one dword at a time. The caller must ensure that the size of blob is a multiple of 4.

since: 1.8.2

Returns the arithmetic sum of all bytes in buf.

since: 1.8.2

Returns the arithmetic sum of all bytes in blob.

since: 1.8.2

Converts a UTF-16 buffer to a UTF-8 string.

since: 1.9.3

Converts a UTF-16 buffer to a UTF-8 string.

since: 1.9.3

Converts UTF-8 string to a buffer of UTF-16, optionially including the trailing NULw.

since: 1.9.3

Converts UTF-8 string to a buffer of UTF-16, optionally including the trailing NULw.

since: 1.9.3

Compares version numbers for sorting taking into account the version format if required.

since: 1.8.2

Builds a semver from the possibly crazy version number. Depending on the semver value the string will be split and a string in the correct format will be returned.

since: 1.8.2

Returns a dotted decimal version string from a 16 bit number.

since: 1.8.2

Returns a dotted hex version string from a 16 bit number.

since: 2.0.0

Returns a dotted decimal version string from a 24 bit number.

since: 1.8.9

Returns a dotted decimal version string from a 32 bit number.

since: 1.8.2

Returns a dotted decimal hex string from a 32 bit number.

since: 2.0.0

Returns a dotted decimal version string from a 64 bit number.

since: 1.8.2

Guesses the version format from the version number. This is only a heuristic and plugins and components should explicitly set the version format whenever possible.

since: 1.8.2

Returns a dotted decimal version string from a version string using fmt. The supported formats are:.

since: 1.8.2

Verifies if a version matches the input format.

since: 1.8.2

Convenience function to add an XML node with a boolean value.

since: 1.6.0

Convenience function to add an XML node with a string value. If value is NULL then no member is added.

since: 1.6.0

Convenience function to add an XML node with an integer value. If value is 0 then no member is added.

since: 1.6.0

Clears a bit in a value using a bitwise operation.

since: 2.0.0

Sets a bit in a value using a bitwise operation.

since: 2.0.0

No address offset is used.

No page size is used.

A generic icon of an AC adapter.

A generic icon of a certificate.

An icon of an audio card.

A generic icon of a fingerprint reader.

A generic icon of a computer.

A generic icon of a dock.

An icon of a dock attached via USB.

A generic icon of a hard disk drive.

A generic icon of a multidisk drive.

A generic icon of a hard disk drive.

A generic icon of a gpu.

A generic icon of a dialpad.

A generic icon of a gaming controller.

A generic icon of a keyboard.

A generic icon of a mouse.

A generic icon of a drawing tablet.

A generic icon of a touchpad.

A generic icon of a memory card.

An icon of a modem.

A generic icon of a wired connection.

A generic icon of a wireless connection.

A generic icon of a PDA.

A generic icon of a thunderbolt device.

An icon of a hub of USB devices.

A generic icon of an USB receiver.

A generic icon of a video camera.

A generic icon of a display.

A generic icon of a web camera.

CPU mitigations required. See the CPU plugin for more details.

Microcode version required to mitigate Sinkclose. See the CPU plugin for more details.

If the Thunderbolt hardware is stuck in safe mode. Consumed by the thunderbolt plugin.

The capsule flags for the UEFI device, e.g. EFI_CAPSULE_HEADER_FLAGS_PERSIST_ACROSS_RESET Consumed by the uefi plugin when other devices register fake devices that need to be handled as a capsule update.

The type of UEFI device, e.g. “system-firmware” or “device-firmware” Consumed by the uefi plugin when other devices register fake devices that need to be handled as a capsule update.

The firmware version of the UEFI device specified as a 32 bit unsigned integer. Consumed by the uefi plugin when other devices register fake devices that need to be handled as a capsule update.

The device will add counterpart GUIDs from an alternate mode like bootloader. This flag is typically specified in a quirk.

Add the _REV instance ID suffix.

Device needs resetting twice for attach after the firmware update.

Automatically assign the parent for children of this device.

Pause polling when reading or writing to the device.

Add the counterpart instance IDs as visible GUID that can be matched in firmware.

Use the device removal delay every time the device is removed, rather than when explicitly waiting for a replug.

Detach, then prepare firmware rather than parsing firmware from the runtime device. For some devices the firmware GType isn’t known until the bootloader gets added.

The device requires a display to be plugged in.

The device requires FuDevice->setup() rather than FuDevice->probe() to add instance IDs during emulated device enumeration.

The device uses a generic instance ID and firmware requires a parent, child, sibling or CHID requirement.

Ensure the version is a valid semantic version, e.g. numbers separated with dots.

Do not automatically set the device order, e.g. updating the child before the parent.

The device represents the main CPU device.

The device should be a child of the main CPU device.

The device represents the main system host firmware.

The device should be a child of the main system host firmware device.

Allow updating firmware when the system power is otherwise too low. This is only really useful when updating the system battery firmware.

Inherit activation status from the history database on startup.

Children of the device are inhibited by the parent.

Restart the detach->write_firmware->attach->reload loop without completing the sequence. This can be set on any step, unlike another-write-required which does all steps.

The composite device requires installation of composite firmware on the parent before the child. Normally the child is installed before the parent.

The device is fake, and constructed from a fake sysfs test directory.

The device opened successfully and ready to use.

Only use the metadata checksum to set device attributes.

Set the device flags from the metadata if available.

Set the device icon from the metadata if available.

Set the device name from the metadata name if available.

Set the device name from the metadata category if available.

Set the device required free size from the metadata if available.

Set the signed/unsigned payload from the metadata if available.

Set the device vendor from the metadata developer_name if available.

Set the device version format from the metadata or history database if available.

Set the device version from the metadata if available.

Do not add instance IDs from the device baseclass.

The device is not auto removed.

Do not auto-remove children in the device list.

Do not add generic GUIDs from outside the plugin.

Do not allow updating when the laptop lid is closed.

Do not probe this device.

Do not attempt to read the device serial number.

Only devices supported in the metadata will be opened.

Use the parent device as the name prefix.

Reference-count the proxy — which is useful when using ProxyGType.

The device has been registered with other plugins.

Match GUIDs on device replug where the physical and logical IDs will be different.

Retry the device open up to 5 times if it fails.

Save the cabinet archive to persistent storage remote before starting the update process.

The device relies upon activation or power cycle to load firmware.

The device is not connected and is probably awaiting replug.

The device has an update that is waiting to be applied.

Use parent for the battery level and threshold.

Use parent to open and close the device.

Use parent for the battery level and threshold.

Use proxy to open and close the device.

The device will always display use the runtime version rather than the bootloader version.

The default removal delay for device re-enumeration taking into account a chain of slow USB hubs. This should be used when the device is able to reset itself between bootloader->runtime->bootloader.

The default removal delay for device re-plug taking into account humans being slow and clumsy. This should be used when the user has to do something, e.g. unplug, press a magic button and then replug.

The Atmel AVR version of the DFU standard in BCD format.

The 1.0 version of the DFU standard in BCD format.

The 1.1 version of the DFU standard in BCD format.

The DfuSe version of the DFU standard in BCD format, defined by ST.

Unknown version of the DFU standard in BCD format.

The key for the kernel command line.

The key for the 2nd-stage loader path.

The usual firmware ID string for the header.

The usual firmware ID string for the payload.

The usual firmware ID string for the signature.

The checksum algorithm for the FIT image, typically a string, e.g. crc32.

The compatible metadata for the FIT image, typically a string list, e.g. pine64,rockpro64-v2.1:pine64,rockpro64.

The raw data for the FIT image, typically a blob.

The external data offset after the FIT image, typically a uint32.

The data size of the external image, typically a uint32.

The offset to skip when writing the FIT image, typically a uint32.

The store offset for the FIT image, typically a uint32.

The creation timestamp of FIT image, typically a uint32.

The value of the checksum, which is typically a blob.

The version of the FIT image, typically a string, e.g. 1.2.3.

The usual firmware ID string for the configurations.

The usual firmware ID string for the images.

UUID for firmware updates.

UUID for MCHI, commonly called MCA.

Another UUID for MCHI, commonly called MCA.

UUID for MKHI, usually a legacy interface.

The HwID key for the baseboard (motherboard) vendor.

The HwID key for baseboard (motherboard) product.

The HwID key for the BIOS major version.

The HwID key for the BIOS minor version.

The HwID key for the BIOS vendor.

The HwID key for the BIOS version.

The HwID key for the enclosure kind.

The HwID key for the deice family.

The HwID key for the firmware major version.

The HwID key for the firmware minor version.

The HwID key for the top-level product vendor.

The HwID key for the top-level product name.

The HwID key for the top-level product SKU.

Do not add the HWID instance IDs.

The index for the IFWI manifest image.

The index for the IFWI metadata image.

The index for the IFWI module data image.

The index for the IFWI checksum image.

The index for the IFWI firmware image.

The index for the IFWI image instance.

The index for the IFWI info image.

The index for the IFWI firmware data image.

The quirk key for the device removal delay in milliseconds, e.g. 2500.

The quirk key for the battery threshold in percent, e.g. 80.

The quirk key for the firmware branch.

The quirk key to set the CFI block size, e.g. 0x100.

The quirk key to set the CFI block erase command, e.g. 0xF8.

The quirk key to set the CFI chip erase command, e.g. 0xF8.

The quirk key to set the CFI page program command, e.g. 0xF8.

The quirk key to set the CFI read data command, e.g. 0xF8.

The quirk key to set the CFI read ID command, e.g. 0xF8.

The quirk key to set the CFI read ID size, e.g. 0xF8.

The quirk key to set the CFI read status command, e.g. 0xF8.

The quirk key to set the CFI sector erase command, e.g. 0xF8.

The quirk key to set the CFI write en command, e.g. 0xF8.

The quirk key to set the CFI write status command, e.g. 0xF8.

The quirk key to set the CFI page size, e.g. 0xF8.

The quirk key to set the CFI sector size, e.g. 0x100.

The quirk key for the children. This should contain the custom GType, e.g. FuRts54xxDeviceUSB\VID_0763&PID_2806&I2C_01.

The quirk key for the counterpart GUID, e.g. 537f7800-8529-5656-b2fa-b0901fe91696.

The quirk key for the custom firmware GType, e.g. FuUswidFirmware.

The quirk key for the exact required firmware size in bytes, e.g. 1024.

The quirk key for the maximum firmware size in bytes, e.g. 1024.

The quirk key for the minimum firmware size in bytes, e.g. 512.

The quirk key for either for public, internal or private flags, e.g. is-bootloader.

The quirk key for the custom GType, e.g. FuCcgxHidDevice.

The quirk key for the GUID, e.g. 537f7800-8529-5656-b2fa-b0901fe91696.

The quirk key for the GUID, only used for quirk matching, e.g. SYNAPTICS_CAPE\CX31993.

The quirk key for the icon, e.g. media-removable.

The quirk key to inhibit the UPDATABLE flag and to set an update error, e.g. In safe mode.

The quirk key for the install duration in seconds, e.g. 60.

The quirk key to add security issues affecting a specific device, e.g. https://www.pugetsystems.com/support/guides/critical-samsung-ssd-firmware-update/.

The quirk key for the name, e.g. ColorHug.

The quirk key for the parent GUID, e.g. 537f7800-8529-5656-b2fa-b0901fe91696.

The quirk key for the plugin name, e.g. csr.

The quirk key for the device priority, e.g. 2.

The quirk key for the protocol, e.g. org.usb.dfu.

The quirk key for the custom proxy GType, e.g. FuCcgxHidDevice.

The quirk key for the proxy GUID, e.g. 537f7800-8529-5656-b2fa-b0901fe91696.

The quirk key for the device removal delay in milliseconds, e.g. 2500.

The quirk key for the summary, e.g. An open source display colorimeter.

The quirk key for the update image shown before the update is performed.

The quirk key for the update message shown after the transaction has completed.

The quirk key for the vendor name, e.g. Hughski Limited.

The quirk key for the vendor ID, e.g. USB:0x123A.

The quirk key for the version, e.g. 1.2.3.

The quirk key for the version format, e.g. quad.

The default IO timeout when reading sysfs attributes.

The GUID for the BDP, see: https://en.wikipedia.org/wiki/Microsoft_basic_data_partition.

The GUID for the ESP, see: https://en.wikipedia.org/wiki/EFI_system_partition.