fwupd Reference Manual
fwupd
Description:
This project aims to make updating firmware on Linux automatic, safe and reliable.
Home:
https://fwupd.org/
C-Documentation:
https://fwupd.github.io/
Content:
Namespaces:
Fwupd
Classes:
Client
Device
Plugin
Release
Remote
SecurityAttr
Structs:
DeviceFlags
-
The device flags.
PluginFlags
-
The plugin flags.
ReleaseFlags
-
The release flags.
Enums:
ClientDownloadFlags
-
The options to use for downloading.
ClientUploadFlags
-
The options to use for uploading.
FeatureFlags
-
The flags to the feature capabilities of the front-end client.
GuidFlags
-
The flags to show how the data should be converted.
InstallFlags
-
Flags to set when performing the firmware update or install.
KeyringKind
-
The update state.
ReleaseUrgency
-
The release urgency.
RemoteKind
-
The kind of remote.
SecurityAttrFlags
-
The flags available for HSI attributes.
SecurityAttrLevel
-
The HSI level.
SecurityAttrResult
-
The HSI result.
SelfSignFlags
-
Flags to set when performing the firmware update or install.
Status
-
The flags to show daemon status.
TrustFlags
-
The flags to show the level of trust.
UpdateState
-
The update state.
VersionFormat
-
The flags used when parsing version numbers.
Error domains:
Error
-
The error code.
Constants:
public
const
string
DBUS_INTERFACE
public
const
string
DBUS_PATH
public
const
string
DBUS_SERVICE
public
const
int
DEVICE_FLAG_ADD_COUNTERPART_GUIDS
public
const
int
DEVICE_FLAG_ANOTHER_WRITE_REQUIRED
public
const
int
DEVICE_FLAG_BACKUP_BEFORE_INSTALL
public
const
int
DEVICE_FLAG_CAN_VERIFY
public
const
int
DEVICE_FLAG_CAN_VERIFY_IMAGE
public
const
int
DEVICE_FLAG_DUAL_IMAGE
public
const
int
DEVICE_FLAG_ENSURE_SEMVER
public
const
int
DEVICE_FLAG_HAS_MULTIPLE_BRANCHES
public
const
int
DEVICE_FLAG_HISTORICAL
public
const
int
DEVICE_FLAG_IGNORE_VALIDATION
public
const
int
DEVICE_FLAG_INSTALL_ALL_RELEASES
public
const
int
DEVICE_FLAG_INSTALL_PARENT_FIRST
public
const
int
DEVICE_FLAG_INTERNAL
public
const
int
DEVICE_FLAG_IS_BOOTLOADER
public
const
int
DEVICE_FLAG_LOCKED
public
const
int
DEVICE_FLAG_MD_SET_ICON
public
const
int
DEVICE_FLAG_MD_SET_NAME
public
const
int
DEVICE_FLAG_MD_SET_NAME_CATEGORY
public
const
int
DEVICE_FLAG_MD_SET_VERFMT
public
const
int
DEVICE_FLAG_NEEDS_ACTIVATION
public
const
int
DEVICE_FLAG_NEEDS_BOOTLOADER
public
const
int
DEVICE_FLAG_NEEDS_REBOOT
public
const
int
DEVICE_FLAG_NEEDS_SHUTDOWN
public
const
int
DEVICE_FLAG_NONE
public
const
int
DEVICE_FLAG_NOTIFIED
public
const
int
DEVICE_FLAG_NO_AUTO_INSTANCE_IDS
public
const
int
DEVICE_FLAG_NO_GUID_MATCHING
public
const
int
DEVICE_FLAG_ONLY_OFFLINE
public
const
int
DEVICE_FLAG_ONLY_SUPPORTED
public
const
int
DEVICE_FLAG_REGISTERED
public
const
int
DEVICE_FLAG_REPORTED
public
const
int
DEVICE_FLAG_REQUIRE_AC
public
const
int
DEVICE_FLAG_SELF_RECOVERY
public
const
int
DEVICE_FLAG_SKIPS_RESTART
public
const
int
DEVICE_FLAG_SUPPORTED
public
const
int
DEVICE_FLAG_TRUSTED
public
const
int
DEVICE_FLAG_UPDATABLE
public
const
int
DEVICE_FLAG_UPDATABLE_HIDDEN
public
const
int
DEVICE_FLAG_USABLE_DURING_UPDATE
public
const
int
DEVICE_FLAG_USE_RUNTIME_VERSION
public
const
int
DEVICE_FLAG_VERSION_CHECK_REQUIRED
public
const
int
DEVICE_FLAG_WAIT_FOR_REPLUG
public
const
int
DEVICE_FLAG_WILL_DISAPPEAR
public
const
string
DEVICE_ID_ANY
public
const
int
PLUGIN_FLAG_CAPSULES_UNSUPPORTED
public
const
int
PLUGIN_FLAG_CLEAR_UPDATABLE
public
const
int
PLUGIN_FLAG_DISABLED
public
const
int
PLUGIN_FLAG_EFIVAR_NOT_MOUNTED
public
const
int
PLUGIN_FLAG_ESP_NOT_FOUND
public
const
int
PLUGIN_FLAG_FAILED_OPEN
public
const
int
PLUGIN_FLAG_LEGACY_BIOS
public
const
int
PLUGIN_FLAG_NONE
public
const
int
PLUGIN_FLAG_NO_HARDWARE
public
const
int
PLUGIN_FLAG_UNLOCK_REQUIRED
public
const
int
PLUGIN_FLAG_USER_WARNING
public
const
int
RELEASE_FLAG_BLOCKED_APPROVAL
public
const
int
RELEASE_FLAG_BLOCKED_VERSION
public
const
int
RELEASE_FLAG_IS_ALTERNATE_BRANCH
public
const
int
RELEASE_FLAG_IS_DOWNGRADE
public
const
int
RELEASE_FLAG_IS_UPGRADE
public
const
int
RELEASE_FLAG_NONE
public
const
int
RELEASE_FLAG_TRUSTED_METADATA
public
const
int
RELEASE_FLAG_TRUSTED_PAYLOAD
public
const
string
RESULT_KEY_APPSTREAM_ID
public
const
string
RESULT_KEY_BRANCH
public
const
string
RESULT_KEY_CATEGORIES
public
const
string
RESULT_KEY_CHECKSUM
public
const
string
RESULT_KEY_CREATED
public
const
string
RESULT_KEY_DESCRIPTION
public
const
string
RESULT_KEY_DETACH_CAPTION
public
const
string
RESULT_KEY_DETACH_IMAGE
public
const
string
RESULT_KEY_DETAILS_URL
public
const
string
RESULT_KEY_DEVICE_ID
public
const
string
RESULT_KEY_FILENAME
public
const
string
RESULT_KEY_FLAGS
public
const
string
RESULT_KEY_FLASHES_LEFT
public
const
string
RESULT_KEY_GUID
public
const
string
RESULT_KEY_HOMEPAGE
public
const
string
RESULT_KEY_HSI_LEVEL
public
const
string
RESULT_KEY_HSI_RESULT
public
const
string
RESULT_KEY_ICON
public
const
string
RESULT_KEY_INSTALL_DURATION
public
const
string
RESULT_KEY_INSTANCE_IDS
public
const
string
RESULT_KEY_ISSUES
public
const
string
RESULT_KEY_LICENSE
public
const
string
RESULT_KEY_LOCATIONS
public
const
string
RESULT_KEY_METADATA
public
const
string
RESULT_KEY_MODIFIED
public
const
string
RESULT_KEY_NAME
public
const
string
RESULT_KEY_NAME_VARIANT_SUFFIX
public
const
string
RESULT_KEY_PARENT_DEVICE_ID
public
const
string
RESULT_KEY_PLUGIN
public
const
string
RESULT_KEY_PROTOCOL
public
const
string
RESULT_KEY_RELEASE
public
const
string
RESULT_KEY_REMOTE_ID
public
const
string
RESULT_KEY_SERIAL
public
const
string
RESULT_KEY_SIZE
public
const
string
RESULT_KEY_SOURCE_URL
public
const
string
RESULT_KEY_STATUS
public
const
string
RESULT_KEY_SUMMARY
public
const
string
RESULT_KEY_TRUST_FLAGS
public
const
string
RESULT_KEY_UPDATE_ERROR
public
const
string
RESULT_KEY_UPDATE_IMAGE
public
const
string
RESULT_KEY_UPDATE_MESSAGE
public
const
string
RESULT_KEY_UPDATE_STATE
public
const
string
RESULT_KEY_URGENCY
public
const
string
RESULT_KEY_URI
public
const
string
RESULT_KEY_VENDOR
public
const
string
RESULT_KEY_VENDOR_ID
public
const
string
RESULT_KEY_VERSION
public
const
string
RESULT_KEY_VERSION_BOOTLOADER
public
const
string
RESULT_KEY_VERSION_BOOTLOADER_RAW
public
const
string
RESULT_KEY_VERSION_FORMAT
public
const
string
RESULT_KEY_VERSION_LOWEST
public
const
string
RESULT_KEY_VERSION_LOWEST_RAW
public
const
string
RESULT_KEY_VERSION_RAW
public
const
string
SECURITY_ATTR_ID_ACPI_DMAR
public
const
string
SECURITY_ATTR_ID_ENCRYPTED_RAM
public
const
string
SECURITY_ATTR_ID_FWUPD_ATTESTATION
public
const
string
SECURITY_ATTR_ID_FWUPD_PLUGINS
public
const
string
SECURITY_ATTR_ID_FWUPD_UPDATES
public
const
string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_ACM
public
const
string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_ENABLED
public
const
string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_OTP
public
const
string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_POLICY
public
const
string
SECURITY_ATTR_ID_INTEL_BOOTGUARD_VERIFIED
public
const
string
SECURITY_ATTR_ID_INTEL_CET_ACTIVE
public
const
string
SECURITY_ATTR_ID_INTEL_CET_ENABLED
public
const
string
SECURITY_ATTR_ID_INTEL_DCI_ENABLED
public
const
string
SECURITY_ATTR_ID_INTEL_DCI_LOCKED
public
const
string
SECURITY_ATTR_ID_INTEL_SMAP
public
const
string
SECURITY_ATTR_ID_IOMMU
public
const
string
SECURITY_ATTR_ID_KERNEL_LOCKDOWN
public
const
string
SECURITY_ATTR_ID_KERNEL_SWAP
public
const
string
SECURITY_ATTR_ID_KERNEL_TAINTED
public
const
string
SECURITY_ATTR_ID_MEI_MANUFACTURING_MODE
public
const
string
SECURITY_ATTR_ID_MEI_OVERRIDE_STRAP
public
const
string
SECURITY_ATTR_ID_MEI_VERSION
public
const
string
SECURITY_ATTR_ID_SPI_BIOSWE
public
const
string
SECURITY_ATTR_ID_SPI_BLE
public
const
string
SECURITY_ATTR_ID_SPI_SMM_BWP
public
const
string
SECURITY_ATTR_ID_SUSPEND_TO_IDLE
public
const
string
SECURITY_ATTR_ID_SUSPEND_TO_RAM
public
const
string
SECURITY_ATTR_ID_TPM_RECONSTRUCTION_PCR0
public
const
string
SECURITY_ATTR_ID_TPM_VERSION_20
public
const
string
SECURITY_ATTR_ID_UEFI_PK
public
const
string
SECURITY_ATTR_ID_UEFI_SECUREBOOT
Methods:
public
string
build_history_report_json
(
GenericArray
<
Device
> devices)
throws
Error
Builds a JSON report for the list of devices.
public
string
build_machine_id
(
string
salt)
throws
Error
Gets a salted hash of the /etc/machine-id contents.
public
string
build_user_agent
(
string
package_name,
string
package_version)
Builds a user-agent to use for the download.
public
string
checksum_format_for_display
(
string
checksum)
Formats a checksum for display.
public
unowned
string
checksum_get_best
(
GenericArray
<
string
> checksums)
Gets a the best possible checksum kind.
public
unowned
string
checksum_get_by_kind
(
GenericArray
<
string
> checksums,
ChecksumType
kind)
Gets a specific checksum kind.
public
ChecksumType
checksum_guess_kind
(
string
checksum)
Guesses the checksum kind based on the length of the hash.
public
FeatureFlags
feature_flag_from_string
(
string
feature_flag)
Converts a string to a
FeatureFlags
.
public
unowned
string
feature_flag_to_string
(
FeatureFlags
feature_flag)
Converts a
FeatureFlags
to a string.
public
HashTable
<
unowned
string
,
unowned
string
>
get_os_release
()
throws
Error
Loads information from the system os-release file.
public
bool
guid_from_string
(
string
? guidstr,
uint8
guid,
GuidFlags
flags)
throws
Error
Converts a string GUID into its binary encoding.
public
string
guid_hash_data
(
uint8
data,
size_t
datasz,
GuidFlags
flags)
Returns a GUID for some data.
public
string
guid_hash_string
(
string
str)
Returns a GUID for a given string.
public
bool
guid_is_valid
(
string
guid)
Checks the string is a valid GUID.
public
string
guid_to_string
(
uint8
guid,
GuidFlags
flags)
Returns a text GUID of mixed or BE endian for a packed buffer.
public
TrustFlags
trust_flag_from_string
(
string
trust_flag)
Converts a string to a
TrustFlags
.
public
unowned
string
trust_flag_to_string
(
TrustFlags
trust_flag)
Converts a
TrustFlags
to a string.
2022 vala-language.org