Fwupd – 2.0

A BIOS setting that represents a setting in the firmware.

Allow client code to call the daemon methods.

A physical device on the host with optionally updatable firmware.

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

A firmware release with a specific version.

A source of metadata that provides firmware.

A firmware report from a vendor.

A user request from the device.

A Host Security ID attribute that represents something that was measured.

Flags used to represent device attributes.

Problems are reasons why the device is not updatable.

Flags used to represent plugin attributes.

Flags used to represent release attributes.

Flags used to represent report attributes.

Flags used to represent request attributes.

The type of BIOS setting.

Type of keyring used on a remote.

The release urgency.

The kind of remote.

The kind of request we are asking of the user.

The HSI level.

The HSI result.

The flags to show daemon status.

The update state.

The flags used when parsing version numbers.

The options to use for downloading.

The options to use for uploading.

The flags to the feature capabilities of the front-end client.

The flags to show how the data should be converted.

Flags to set when performing the firmware update or install.

The flags available for the remote.

The flags available for HSI attributes.

Flags to set when performing the firmware update or install.

The flags to show the level of trust.

The error code.

Builds a JSON report for the list of devices. No filtering is done on the devices array, and it is expected that the caller will filter to something sane, e.g. FWUPD_DEVICE_FLAG_REPORTED at the bare minimum.

since: 1.0.4

Gets a salted hash of the /etc/machine-id contents. This can be used to identify a specific machine. It is not possible to recover the original machine-id from the machine-hash.

since: 1.0.4

Builds a user-agent to use for the download.

since: 1.0.3

Formats a checksum for display.

since: 0.9.3

Gets a the best possible checksum kind.

since: 0.9.4

Gets a specific checksum kind.

since: 0.9.4

Guesses the checksum kind based on the length of the hash.

since: 0.9.3

Formats a checksum type for display.

since: 1.9.6

Converts a string to an enumerated error.

since: 0.7.0

An error quark.

since: 0.1.1

Converts an enumerated error to a string.

since: 0.7.0

Converts a string to an enumerated feature flag.

since: 1.4.5

Converts a feature flag to a string.

since: 1.4.5

Loads information from the system os-release file.

since: 1.0.7

Loads information from a defined system os-release file.

since: 1.8.8

Converts a string GUID into its binary encoding. All string GUIDs are formatted as big endian but on-disk can be encoded in different ways.

since: 1.2.5

Returns a GUID for some data. This uses a hash and so even small differences in the data will produce radically different return values.

since: 1.2.5

Returns a GUID for a given string. This uses a hash and so even small differences in the str will produce radically different return values.

since: 1.2.5

Checks the string is a valid GUID.

since: 1.2.5

Returns a text GUID of mixed or BE endian for a packed buffer.

since: 1.2.5

Converts an printable string to an enumerated keyring kind.

since: 0.9.7

Converts an enumerated keyring kind to a printable string.

since: 0.9.7

Converts a string to an enumerated status.

since: 0.1.1

Converts an enumerated status to a string.

since: 0.1.1

Converts a string to an enumerated trust flag.

since: 0.7.0

Converts an enumerated trust flag to a string.

since: 0.7.0

Converts a string to an enumerated update state.

since: 0.7.0

Converts an enumerated update state to a string.

since: 0.7.0

Converts text to a display version type.

since: 1.2.9

Converts an enumerated version format to text.

since: 1.2.9

Gets the libfwupd installed runtime version.

since: 1.6.1

Check whether a fwupd version equal to or greater than major.minor.micro.

This value signifies the battery level is either unset, or the value cannot be discovered.

The dbus interface.

The D-Bus socket address when using point-to-point connections.

The dbus path.

The dbus service.

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

The device is warning that a volume with full-disk-encryption was found on this machine, typically a Windows NTFS partition with BitLocker. Updating the firmware on this device may invalidate secrets used to decrypt the volume, and the recovery key may be required.

The device requires the update to be retried, possibly with a different plugin.

The device firmware should be saved before installing firmware.

The device checksums can be compared against metadata.

The device application firmware image can be dumped from device for verification.

The device firmware update architecture uses a redundancy mechanism such as A/B partitions for updates.

The device is emulated and should not be recorded by the backend.

The device should be recorded by the backend, allowing emulation.

The device is no longer supported by the original hardware vendor as it is considered end-of-life. It it unlikely to receive firmware updates, even for security issues.

Deprecated, no not use.

The device supports switching to a different stream of firmware.

The device is used for historical data only.

When processing an update for the device, plugins should ignore all validation safety checks.

Install each intermediate releases for the device rather than jumping directly to the newest.

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

Device is internal to the platform and cannot be removed easily.

The device is currently in a read-only bootloader mode and not running application code.

The device can not be updated without manual user interaction.

Deprecated, no not use.

Deprecated, no not use.

Deprecated, no not use.

Deprecated, no not use.

The device update needs to be separately activated. This process may occur automatically on shutdown in some operating systems or when the device is unplugged with some devices.

The device requires entering a bootloader mode to be manually.

The device requires a system reboot to apply firmware or to reload hardware.

The device requires the system to be shutdown to finish application of new firmware.

Deprecated, no not use.

Deprecated, no not use.

No flags set.

The user has been notified about a change in the device state.

The device should stay on one firmware version unless the new version is explicitly specified.

Update can only be done from a limited functionality OS (offline mode).

Deprecated, no not use.

The device firmware can only be updated to a newer version and never downgraded or reinstalled.

The device has been registered with other plugins.

The success or failure of a previous update has been reported to a metadata server.

Device requires an external power source to be connected or the battery level at a minimum threshold to update.

In flashing mode, the device will only accept intended payloads and will revert back to a valid firmware image if an invalid or incomplete payload was sent.

The firmware payload is verified on-device the payload using strong cryptography such as RSA, AES or ECC.

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

The device is found in metadata loaded into the daemon.

A trusted client is reading information about the device. Extra metadata such as serial number can be exposed about this device.

The device is currently unreachable, perhaps because it is in a lower power state or is out of wireless range.

The firmware payload is unsigned and it is possible to modify and flash custom firmware.

Device has the ability to be updated in this or any other mode.

The device is updatable but is currently inhibited from updates in the client. Reasons include but are not limited to low power or requiring reboot from a previous update.

The device remains usable while the update flashes or schedules the update. The update will implicitly be applied next time the device is power cycled or possibly activated.

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

All firmware updates for this device require a firmware version check.

The device is in the middle of and update and the hardware is waiting to be probed/replugged.

All devices with matching GUIDs will be updated at the same time.

The device will disappear after the update is complete and success or failure can’t be verified.

Wildcard used for matching all device ids in fwupd.

The device cannot be used while there are no displays plugged in.

The device is in use and cannot be interrupted, for instance taking a phone call.

The device is emulated from a different host.

The device cannot be used while the laptop lid is closed.

The device cannot be updated due to missing vendor’s license.

No device problems detected.

The device battery power is too low.

The device requires AC power to be connected.

The device cannot be updated due to a system-wide inhibit.

The system power is too low to perform the update.

The device is unreachable, or out of wireless range.

The device cannot be updated as it is already being updated.

The device is waiting for the update to be applied.

The compile-time major version.

The compile-time micro version.

The compile-time minor version.

The plugin requires the user to provide authentication details. Supported clients will display this information to a user.

The plugin discovered that UEFI UpdateCapsule are unsupported. Supported clients will display this information to a user.

When the plugin loads it should clear the UPDATABLE flag from any devices. This typically happens when the device requires a system restart.

The plugin has been disabled, either by daemon configuration or a problem.

The plugin discovered the efivar filesystem is not found and is required for this plugin. Supported clients will display this information to a user.

The plugins discovered that the EFI system partition was not found. Supported clients will display this information to a user.

The plugins discovered that the EFI system partition may not be valid. Supported clients will display this information to a user.

Failed to open plugin (missing dependency). Supported clients will display this information to a user.

The feature is not supported as the kernel is too old.

The plugin discovered the system is running in legacy CSM mode. Supported clients will display this information to a user.

The plugin will be checked that it preserves system state such as KEK, PK, BOOT#### etc.

The plugin is loaded from an external module.

The plugin won’t load because no supported hardware was found. This typically happens with plugins designed for a specific platform design (such as the dell plugin only works on Dell systems).

No plugin flags are set.

The plugin is ready for use and all devices have been coldplugged.

A specific HWID is required to use this plugin.

The plugin requires the config file to be saved with permissions that only allow the root user to read.

The plugin discovered that hardware unlock is required. Supported clients will display this information to a user.

The plugin has a problem and would like to show a user warning to a supported client.

The installation of the release is blocked as release not approved by an administrator.

The installation of the release is blocked as below device version-lowest.

The release is an alternate branch of firmware.

The release is supported by the community and not the hardware vendor.

The release is older than the device version.

The release is newer than the device version.

No flags are set.

The payload metadata is trusted.

The payload binary is trusted.

The payload has been tested by a report we trust.

The report was generated by the OEM.

No report flags are set.

Use a generic (translated) request image.

Use a generic (translated) request message.

Device requires to show the user a custom image for the action to make sense.

Device requires a non-generic interaction with custom non-translatable text.

No flags are set.

Show the user a message not to unplug the machine from the AC power, e.g. “Do not turn off your computer or remove the AC adaptor until you are sure the update has completed.”

The user needs to insert the cable to complete the update, e.g. “The update will continue when the device USB cable has been re-inserted.”

The user needs to press unlock on the device to continue, e.g. “Press unlock on the device to continue the update process.”

The user needs to remove and reinsert the device to complete the update, e.g. “The update will continue when the device USB cable has been unplugged and then re-inserted.”

The user needs to remove the device to complete the update, e.g. “The update will continue when the device USB cable has been unplugged.”

Show the user a message to replug the device and then install the firmware, e.g. “Unplug and replug the device, to continue the update process.”

Show the user a message to replug the power connector, e.g. “The update will continue when the device power cable has been unplugged and then re-inserted.”

Result key to represent AppstreamId.

Result key to represent the current battery level in percent. Expressed from 0-100%, or 101 for invalid or unset.

Result key to represent the minimum battery level required to perform an update. Expressed from 0-100%, or 101 for invalid or unset.

Result key to represent the current value of BIOS setting.

Result key to represent the unique identifier of the BIOS setting.

Result key to represent the upper bound for an integer BIOS setting. or minimum length for string BIOS setting. The D-Bus type signature string is ‘t’ i.e. a unsigned 64 bit integer.

Result key to represent possible values.

Result key to represent whether BIOS setting is read only.

Result key to represent the scalar increment for an integer BIOS setting.

Result key to represent the value that would enable this attribute.

Result key to represent the type of BIOS setting. 0 is invalid, 1+ represent an attribute type.

Result key to represent the lower bound for an integer BIOS setting or maximum length for string BIOS setting.

Result key to represent Branch.

Result key to represent Categories.

Result key to represent Checksum.

Result key to represent CompositeId.

Result key to represent Created.

Result key to represent Description.

Result key to represent DetachCaption.

Result key to represent DetachImage.

Result key to represent DetailsUrl.

Result key to represent DeviceId.

Result key to represent the device name.

Result key to represent the distribution ID.

Result key to represent the distribution variant.

Result key to represent the distribution version.

Result key to represent Filename.

Result key to represent Flags.

Result key to represent FlashesLeft.

Result key to represent Guid.

Result key to represent Homepage.

Result key to represent HsiLevel.

Result key to represent HsiResult.

Result key to represent the fallback HsiResult.

Result key to represent the desired HsiResult.

Result key to represent Icon.

Result key to represent InstallDuration.

Result key to represent InstanceIds.

Result key to represent Issues.

Result key to represent the current kernel setting.

Result key to represent the target kernel setting.

Result key to represent License.

Result key to represent Locations.

Result key to represent Metadata.

Result key to represent Modified.

Result key to represent Name.

Result key to represent NameVariantSuffix.

Result key to represent ParentDeviceId.

Result key to represent progress percentage, typically installation or verification.

Result key to represent Plugin.

Result key to represent problems.

Result key to represent Protocol.

Result key to represent Release.

Result key to represent the release ID.

Result key to represent RemoteId.

Result key to represent an array of reports.

Result key to represent RequestFlags.

Result key to represent RequestKind.

Result key to represent Serial.

Result key to represent Size.

Result key to represent SourceUrl.

Result key to represent Status.

Result key to represent Summary.

Result key to represent release tags.

Result key to represent TrustFlags.

Result key to represent UpdateError.

Result key to represent UpdateImage.

Result key to represent UpdateMessage.

Result key to represent UpdateState.

Result key to represent Urgency.

Result key to represent Uri.

Result key to represent Vendor.

Result key to represent VendorId.

Result key to represent Version.

Result key to represent VersionBootloader.

Result key to represent VersionBootloaderRaw.

Result key to represent VersionBuildDate.

Result key to represent VersionFormat.

Result key to represent VersionLowest.

Result key to represent VersionLowestRaw.

Result key to represent the old version string.

Result key to represent VersionRaw.

Host Security ID attribute for Rollback protection of AMD platform firmware.

Host Security ID attribute for SPI replay protection.

Host Security ID attribute for SPI Write protection.

Host Security ID attribute indicating Capsule updates are supported by the BIOS.

Host Security ID attribute for Rollback protection of BIOS firmware.

Host Security ID attribute indicating encrypted RAM available.

Host Security ID attribute for attestation.

Host Security ID attribute for plugins.

Host Security ID attribute for updates.

Host Security ID attribute for host emulation.

Host Security ID attribute for Intel Bootguard ACM.

Host Security ID attribute for Intel Bootguard enabled.

Host Security ID attribute for Intel Bootguard OTP fuse.

Host Security ID attribute for Intel Bootguard policy.

Host Security ID attribute for Intel Bootguard verified.

Host Security ID attribute for Intel CET active.

Host Security ID attribute for Intel CET enabled.

Host Security ID attribute indicating the processor is safe against Gather Data Sampling.

Host Security ID attribute for Intel SMAP.

Host Security ID attribute for IOMMU.

Host Security ID attribute for kernel lockdown.

Host Security ID attribute for kernel swap.

Host Security ID attribute for kernel taint.

Host Security ID attribute for Intel ME Key Manifest.

Host Security ID attribute for Intel ME manufacturing mode.

Host Security ID attribute for Intel ME override strap.

Host Security ID attribute for Intel ME version.

Host Security ID attribute for parts with debugging capabilities enabled.

Host Security ID attribute for parts locked from debugging.

Host Security ID attribute for fused parts.

Host Security ID attribute for Pre-boot DMA protection.

Host Security ID attribute for Intel SPI BIOSWE configuration.

Host Security ID attribute for Intel SPI BLE configuration.

Host Security ID attribute for Intel SPI descriptor.

Host Security ID attribute for Intel SPI SMM BWP.

Host Security ID attribute for Supported CPU.

Host Security ID attribute for Suspend to Idle.

Host Security ID attribute for Suspend to RAM.

Host Security ID attribute for empty PCR.

Host Security ID attribute for TPM PCR0 reconstruction.

Host Security ID attribute for TPM 2.0

Host Security ID attribute indicating if Bootservice-only variables are hidden.

Host Security ID attribute for UEFI PK.

Host Security ID attribute for UEFI secure boot.