FwupdPlugin – 1.0

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 CPU vendor.

The device lid state.

EFI_STATUS is u64le on 64-bit and u32le on 32-bit — but be pragmatic.

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. This does not have to be exactly what the battery is doing, but is supposed to represent the 40,000ft view of the system power state. For example, it is perfectly correct to set FU_POWER_STATE_AC if the system is connected to AC power, but the battery cells are discharging for health or for other performance reasons.

The flags to use when loading the archive.

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.

Adds the content of array2 to array.

Adds the contents of a GBytes to a byte array.

Adds the content of buf at offset to array.

Adds a 16 bit integer to a byte array.

Adds a 24 bit integer to a byte array.

Adds a 32 bit integer to a byte array.

Adds a 64 bit integer to a byte array.

Adds a 8 bit integer to a byte array.

Compares two buffers for equality.

Converts a lowercase hex string to a byte array.

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

Converts the byte array to a lowercase hex string.

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

Compares the buffers for equality.

Converts a lowercase hex string to a GBytes.

Reads a blob of data from a file.

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.

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

Creates a GBytes which is a subsection of another GBytes.

Pads a GBytes to a minimum sz with 0xff.

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

Converts bytes to a lowercase hex string.

Converts an enumerated value to a string.

Converts an enumerated value to a string.

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.

Returns the current kernel command line options.

Returns the size of physical memory.

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

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

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

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

Uses CPUID to discover the CPU vendor.

Calls CPUID and returns the registers for the given leaf.

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

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

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

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

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

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

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

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Returns the MISR check value for the given memory buffer.

Returns the size of the CRC in bits.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Dumps a byte buffer to the screen.

Dumps a raw buffer to the screen.

Dumps a raw buffer to the screen.

Converts a GUID to the known nice name.

Converts an enumerated value to a string.

Parses a UEFI section.

Converts an enumerated value to a string.

Imports an EFI_TIME from XML.

Exports an EFI_TIME to XML.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts an enumerated value to a string.

Convert the error to a FwupdError, if required.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts an enumerated value to a string.

Converts an enumerated value to a string.

Converts an enumerated value to a string.

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

Generates the checksum of the entire stream.

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

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

Returns the arithmetic sum of all bytes in the stream.

Returns the arithmetic sum of all bytes in the stream.

Returns the arithmetic sum of all bytes in the stream.

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

Opens the file as n input stream.

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

Read a GBytes from a stream in a safe way.

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

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

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

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

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

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

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

Reads the total possible of the stream.

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

Add a kernel command line argument.

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

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

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

Determines if kernel lockdown in effect.

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

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

Remove a kernel command line argument.

Converts an enumerated value to a string.

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

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

Compares the buffers for equality.

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.

Duplicates some memory using memdup in a safe way.

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

Read a value from a buffer using a specified endian.

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

Read a value from a buffer using a specified endian.

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

Read a value from a buffer using a specified endian.

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

Read a value from a buffer using a specified endian.

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

Read a value from a buffer in a safe way.

Converts a byte buffer to a ASCII string.

Writes a value to a buffer using a specified endian.

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

Writes a value to a buffer using a specified endian.

Writes a value to a buffer using a specified endian.

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

Writes a value to a buffer using a specified endian.

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

Write a value to a buffer in a safe way.

Converts an enumerated value to a string.

Opens the file as an output stream.

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

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

Looks for a program in the PATH variable.

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

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.

Returns the symlink target.

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

Returns the resolved absolute file name.

Creates any required directories, including any parent directories.

Creates any required directories, including any parent directories.

Recursively removes a directory.

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

Converts an enumerated value to a string.

Performs a checked addition of a and b, ensuring the result does not overflow.

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

Removes leading and trailing whitespace from a mutable string.

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

Hides password strings encoded in HTTP requests.

Converts a string into something that can be safely printed.

Converts a GBytes into something that can be safely printed.

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.

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.

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

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

Removes leading and trailing whitespace from a constant string.

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

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

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

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

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

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

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.

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.

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

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

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.

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.

Returns the arithmetic sum of all bytes in buf.

Returns the arithmetic sum of all bytes in blob.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

Converts a string to an enumerated value.

Converts an enumerated value to a string.

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

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

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

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

Converts an enumerated value to a string.

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

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.

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

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

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

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

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

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

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.

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

Verifies if a version matches the input format.

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

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

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

Clears a bit in a value using a bitwise operation.

Sets a bit in a value using a bitwise operation.

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.

Allow the device version to be specified as an integer in the release XML.

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.

Allow the device version to be unset.

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.

Use the physical ID for the sysfs path rather than the backend ID.

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.