Top | ![]() |
![]() |
![]() |
![]() |
const gchar *
fwupd_status_to_string (FwupdStatus status
);
Converts a enumerated status to a string.
Since: 0.1.1
FwupdStatus
fwupd_status_from_string (const gchar *status
);
Converts a string to an enumerated status.
Since: 0.1.1
const gchar *
fwupd_device_flag_to_string (FwupdDeviceFlags device_flag
);
Converts a device flag to a string.
Since: 0.7.0
FwupdDeviceFlags
fwupd_device_flag_from_string (const gchar *device_flag
);
Converts a string to a enumerated device flag.
Since: 0.7.0
const gchar *
fwupd_plugin_flag_to_string (FwupdPluginFlags plugin_flag
);
Converts an enumerated plugin flag to a string.
Since: 1.5.0
FwupdPluginFlags
fwupd_plugin_flag_from_string (const gchar *plugin_flag
);
Converts a string to an enumerated plugin flag.
Since: 1.5.0
const gchar *
fwupd_release_flag_to_string (FwupdReleaseFlags release_flag
);
Converts a enumerated release flag to a string.
Since: 1.2.6
FwupdReleaseFlags
fwupd_release_flag_from_string (const gchar *release_flag
);
Converts a string to an enumerated release flag.
Since: 1.2.6
const gchar *
fwupd_release_urgency_to_string (FwupdReleaseUrgency release_urgency
);
Converts an enumerated release urgency to a string.
Since: 1.4.0
FwupdReleaseUrgency
fwupd_release_urgency_from_string (const gchar *release_urgency
);
Converts a string to an enumerated release urgency value.
Since: 1.4.0
const gchar *
fwupd_update_state_to_string (FwupdUpdateState update_state
);
Converts a enumerated update state to a string.
Since: 0.7.0
FwupdUpdateState
fwupd_update_state_from_string (const gchar *update_state
);
Converts a string to a enumerated update state.
Since: 0.7.0
const gchar *
fwupd_trust_flag_to_string (FwupdTrustFlags trust_flag
);
Converts a enumerated trust flag to a string.
Since: 0.7.0
FwupdTrustFlags
fwupd_trust_flag_from_string (const gchar *trust_flag
);
Converts a string to a enumerated trust flag.
Since: 0.7.0
const gchar *
fwupd_feature_flag_to_string (FwupdFeatureFlags feature_flag
);
Converts a feature flag to a string.
Since: 1.4.5
FwupdFeatureFlags
fwupd_feature_flag_from_string (const gchar *feature_flag
);
Converts a string to a enumerated feature flag.
Since: 1.4.5
FwupdKeyringKind
fwupd_keyring_kind_from_string (const gchar *keyring_kind
);
Converts an printable string to an enumerated keyring kind.
Since: 0.9.7
const gchar *
fwupd_keyring_kind_to_string (FwupdKeyringKind keyring_kind
);
Converts an enumerated keyring kind to a printable string.
Since: 0.9.7
FwupdVersionFormat
fwupd_version_format_from_string (const gchar *str
);
Converts text to a display version type.
Since: 1.2.9
const gchar *
fwupd_version_format_to_string (FwupdVersionFormat kind
);
Converts an enumerated version format to text.
Since: 1.2.9
The flags to show daemon status.
Unknown state |
||
Idle |
||
Loading a resource |
||
Decompressing firmware |
||
Restarting the device |
||
Writing to a device |
||
Verifying (reading) a device |
||
Scheduling an offline update |
||
A file is downloading |
||
Reading from a device |
||
Erasing a device |
||
Waiting for authentication |
||
The device is busy |
||
The daemon is shutting down |
The flags to the feature capabilities of the front-end client.
#define FWUPD_DEVICE_FLAG_INTERNAL (1u << 0)
Device is internal to the platform and cannot be removed easily.
Since 0.1.3
#define FWUPD_DEVICE_FLAG_UPDATABLE (1u << 1)
Device has the ability to be updated in this or any other mode.
Since 0.9.7
#define FWUPD_DEVICE_FLAG_ONLY_OFFLINE (1u << 2)
Update can only be done from a limited functionality OS (offline mode).
Since 0.9.7
#define FWUPD_DEVICE_FLAG_REQUIRE_AC (1u << 3)
Device requires an external power source to be connected or the battery level at a minimum threshold to update.
Since 0.6.3
#define FWUPD_DEVICE_FLAG_LOCKED (1u << 4)
The device can not be updated without manual user interaction.
Since 0.6.3
#define FWUPD_DEVICE_FLAG_SUPPORTED (1u << 5)
The device is found in metadata loaded into the daemon.
Since 0.7.1
#define FWUPD_DEVICE_FLAG_REGISTERED (1u << 7)
The device has been registered with other plugins.
Since 0.9.7
#define FWUPD_DEVICE_FLAG_NEEDS_REBOOT (1u << 8)
The device requires a system reboot to apply firmware or to reload hardware.
Since 0.9.7
#define FWUPD_DEVICE_FLAG_REPORTED (1u << 9)
The success or failure of a previous update has been reported to a metadata server.
Since: 1.0.4
#define FWUPD_DEVICE_FLAG_NOTIFIED (1u << 10)
The user has been notified about a change in the device state.
Since: 1.0.5
#define FWUPD_DEVICE_FLAG_USE_RUNTIME_VERSION (1u << 11)
The device will always display use the runtime version rather than the bootloader version.
Since: 1.0.6
#define FWUPD_DEVICE_FLAG_INSTALL_PARENT_FIRST (1u << 12)
The composite device requires installation of composite firmware on the parent before the child. Normally the child is installed before the parent.
Since: 1.0.8
#define FWUPD_DEVICE_FLAG_WAIT_FOR_REPLUG (1u << 14)
The device is in the middle of and update and the hardware is waiting to be probed/replugged.
Since: 1.1.2
#define FWUPD_DEVICE_FLAG_IGNORE_VALIDATION (1u << 15)
When processing an update for the device, plugins should ignore all validation safety checks.
Since: 1.1.2
#define FWUPD_DEVICE_FLAG_TRUSTED (1u << 16)
A trusted client is reading information about the device. Extra metadata such as serial number can be exposed about this device.
Since: 1.1.2
#define FWUPD_DEVICE_FLAG_NEEDS_SHUTDOWN (1u << 17)
The device requires the system to be shutdown to finish application of new firmware.
Since: 1.2.4
#define FWUPD_DEVICE_FLAG_ANOTHER_WRITE_REQUIRED (1u << 18)
The device requires the update to be retried, possibly with a different plugin.
Since: 1.2.5
#define FWUPD_DEVICE_FLAG_NO_AUTO_INSTANCE_IDS (1u << 19)
Deprecated, no not use
Since: 1.2.5
#define FWUPD_DEVICE_FLAG_NEEDS_ACTIVATION (1u << 20)
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.
Since: 1.2.6
#define FWUPD_DEVICE_FLAG_ENSURE_SEMVER (1u << 21)
Deprecated, no not use
Since: 1.2.9
#define FWUPD_DEVICE_FLAG_HISTORICAL (1u << 22)
The device is used for historical data only.
Since: 1.3.2
#define FWUPD_DEVICE_FLAG_ONLY_SUPPORTED (1u << 23)
Deprecated, no not use
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_WILL_DISAPPEAR (1u << 24)
The device will disappear after the update is complete and success or failure can't be verified.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_CAN_VERIFY (1u << 25)
THe device checksums can be compared against metadata.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_CAN_VERIFY_IMAGE (1u << 26)
The device application firmware image can be dumped from device for verification.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_DUAL_IMAGE (1u << 27)
The device firmware update architecture uses a redundancy mechanism such as A/B partitions for updates.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_SELF_RECOVERY (1u << 28)
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.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_USABLE_DURING_UPDATE (1u << 29)
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.
Since: 1.3.3
#define FWUPD_DEVICE_FLAG_VERSION_CHECK_REQUIRED (1u << 30)
All firmware updates for this device require a firmware version check.
Since: 1.3.7
#define FWUPD_DEVICE_FLAG_INSTALL_ALL_RELEASES (1u << 31)
Install each intermediate releases for the device rather than jumping directly to the newest.
Since: 1.3.7
#define FWUPD_DEVICE_FLAG_MD_SET_NAME (1llu << 32)
Deprecated, no not use
Since: 1.4.0
#define FWUPD_DEVICE_FLAG_MD_SET_NAME_CATEGORY (1llu << 33)
Deprecated, no not use
Since: 1.4.0
#define FWUPD_DEVICE_FLAG_MD_SET_VERFMT (1llu << 34)
Deprecated, no not use
Since: 1.4.0
#define FWUPD_DEVICE_FLAG_ADD_COUNTERPART_GUIDS (1llu << 35)
The device will add counterpart GUIDs from an alternate mode like bootloader. This flag is typically specified in a quirk.
Since: 1.4.0
#define FWUPD_DEVICE_FLAG_NO_GUID_MATCHING (1llu << 36)
Deprecated, no not use
Since: 1.4.1
#define FWUPD_DEVICE_FLAG_UPDATABLE_HIDDEN (1llu << 37)
The device is updatable but is currently inhbitied from updates in the client. Reasons include but are not limited to low power or requiring reboot from a previous update.
Since: 1.4.1
#define FWUPD_DEVICE_FLAG_SKIPS_RESTART (1llu << 38)
The device relies upon activation or power cycle to load firmware.
Since: 1.5.0
#define FWUPD_DEVICE_FLAG_HAS_MULTIPLE_BRANCHES (1llu << 39)
The device supports switching to a different stream of firmware.
Since: 1.5.0
#define FWUPD_DEVICE_FLAG_BACKUP_BEFORE_INSTALL (1llu << 40)
The device firmware should be saved before installing firmware.
Since: 1.5.0
#define FWUPD_DEVICE_FLAG_MD_SET_ICON (1llu << 41)
Deprecated, no not use
Since: 1.5.2
#define FWUPD_DEVICE_FLAG_UNKNOWN G_MAXUINT64
This flag is not defined, this typically will happen from mismatched fwupd library and clients.
Since 0.7.3
#define FWUPD_RELEASE_FLAG_TRUSTED_PAYLOAD (1u << 0)
The payload binary is trusted.
Since: 1.2.6
#define FWUPD_RELEASE_FLAG_TRUSTED_METADATA (1u << 1)
The payload metadata is trusted.
Since: 1.2.6
#define FWUPD_RELEASE_FLAG_BLOCKED_VERSION (1u << 4)
The installation of the release is blocked as below device version-lowest.
Since: 1.2.6
#define FWUPD_RELEASE_FLAG_BLOCKED_APPROVAL (1u << 5)
The installation of the release is blocked as release not approved by an administrator.
Since: 1.2.6
#define FWUPD_RELEASE_FLAG_UNKNOWN G_MAXUINT64
The release flag is unknown, typically caused by using mismatched client and daemon.
Since: 1.2.6
#define FWUPD_PLUGIN_FLAG_DISABLED (1u << 0)
The plugin has been disabled, either by daemon configuration or a problem.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_USER_WARNING (1u << 1)
The plugin has a problem and would like to show a user warning to a supported client.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_CLEAR_UPDATABLE (1u << 2)
When the plugin loads it should clear the UPDATABLE flag from any devices. This typically happens when the device requires a system restart.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_NO_HARDWARE (1u << 3)
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).
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_CAPSULES_UNSUPPORTED (1u << 4)
The plugin discovered that UEFI UpdateCapsule are unsupported. Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_UNLOCK_REQUIRED (1u << 5)
The plugin discovered that hardware unlock is required. Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_EFIVAR_NOT_MOUNTED (1u << 6)
The plugin discovered the efivar filesystem is not found and is required for this plugin. Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_ESP_NOT_FOUND (1u << 7)
The plugins discovered that the EFI system partition was not found. Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_LEGACY_BIOS (1u << 8)
The plugin discovered the system is running in legacy CSM mode. Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_FAILED_OPEN (1u << 9)
Failed to open plugin (missing dependency). Supported clients will display this information to a user.
Since: 1.5.0
#define FWUPD_PLUGIN_FLAG_REQUIRE_HWID (1u << 10)
A specific HWID is required to use this plugin.
Since: 1.5.8
#define FWUPD_PLUGIN_FLAG_UNKNOWN G_MAXUINT64
The plugin flag is Unknown. This is usually caused by a mismatched libfwupdplugin and daemon.
Since: 1.5.0
Flags to set when performing the firmware update or install.
No flags set |
||
Schedule this for next boot |
||
Allow reinstalling the same version |
||
Allow downgrading firmware |
||
Force the update even if not a good idea |
||
Do not write to the history database |
||
Allow firmware branch switching |
||
Ignore firmware CRCs and checksums |
||
Ignore firmware vendor and project checks |
||
Ignore requirement of external power source |
||
Do not use heuristics when parsing the image |
The update state.
The flags used when parsing version numbers.
If no verification is required then FWUPD_VERSION_FORMAT_PLAIN
should
be used to signify an unparsable text string.
Unknown version format |
||
An unidentified format text string |
||
A single integer version number |
||
Two AABB.CCDD version numbers |
||
Microsoft-style AA.BB.CCDD version numbers |
||
UEFI-style AA.BB.CC.DD version numbers |
||
Binary coded decimal notation |
||
Intel ME-style bitshifted notation |
||
Intel ME-style A.B.CC.DDDD notation notation |
||
Legacy Microsoft Surface 10b.12b.10b |
||
Microsoft Surface 8b.16b.8b |
||
Dell BIOS BB.CC.DD style |
||
Hexadecimal 0xAABCCDD style |