fwupd-enums

fwupd-enums — enumerated values shared by the daemon and library

Synopsis

enum                FwupdStatus;
enum                FwupdTrustFlags;
#define             FWUPD_DEVICE_FLAG_NONE
#define             FWUPD_DEVICE_FLAG_INTERNAL
#define             FWUPD_DEVICE_FLAG_UPDATABLE
#define             FWUPD_DEVICE_FLAG_ONLY_OFFLINE
#define             FWUPD_DEVICE_FLAG_REQUIRE_AC
#define             FWUPD_DEVICE_FLAG_LOCKED
#define             FWUPD_DEVICE_FLAG_SUPPORTED
#define             FWUPD_DEVICE_FLAG_NEEDS_BOOTLOADER
#define             FWUPD_DEVICE_FLAG_REGISTERED
#define             FWUPD_DEVICE_FLAG_NEEDS_REBOOT
#define             FWUPD_DEVICE_FLAG_UNKNOWN
typedef             FwupdDeviceFlags;
enum                FwupdInstallFlags;
enum                FwupdUpdateState;
enum                FwupdKeyringKind;
const gchar *       fwupd_status_to_string              (FwupdStatus status);
FwupdStatus         fwupd_status_from_string            (const gchar *status);
const gchar *       fwupd_device_flag_to_string         (FwupdDeviceFlags device_flag);
FwupdDeviceFlags    fwupd_device_flag_from_string       (const gchar *device_flag);
const gchar *       fwupd_update_state_to_string        (FwupdUpdateState update_state);
FwupdUpdateState    fwupd_update_state_from_string      (const gchar *update_state);
const gchar *       fwupd_trust_flag_to_string          (FwupdTrustFlags trust_flag);
FwupdTrustFlags     fwupd_trust_flag_from_string        (const gchar *trust_flag);
FwupdKeyringKind    fwupd_keyring_kind_from_string      (const gchar *keyring_kind);
const gchar *       fwupd_keyring_kind_to_string        (FwupdKeyringKind keyring_kind);

Description

This file also provides helper functions to map enums to strings and back again.

See also: fwupd-error

Details

enum FwupdStatus

typedef enum {
	FWUPD_STATUS_UNKNOWN,				/* Since: 0.1.1 */
	FWUPD_STATUS_IDLE,				/* Since: 0.1.1 */
	FWUPD_STATUS_LOADING,				/* Since: 0.1.1 */
	FWUPD_STATUS_DECOMPRESSING,			/* Since: 0.1.1 */
	FWUPD_STATUS_DEVICE_RESTART,			/* Since: 0.1.1 */
	FWUPD_STATUS_DEVICE_WRITE,			/* Since: 0.1.1 */
	FWUPD_STATUS_DEVICE_VERIFY,			/* Since: 0.1.1 */
	FWUPD_STATUS_SCHEDULING,			/* Since: 0.1.1 */
	FWUPD_STATUS_DOWNLOADING,			/* Since: 0.9.4 */
	FWUPD_STATUS_DEVICE_READ,			/* Since: 1.0.0 */
	FWUPD_STATUS_DEVICE_ERASE,			/* Since: 1.0.0 */
	FWUPD_STATUS_WAITING_FOR_AUTH,			/* Since: 1.0.0 */
	FWUPD_STATUS_DEVICE_BUSY,			/* Since: 1.0.1 */
} FwupdStatus;

The flags to show daemon status.

FWUPD_STATUS_UNKNOWN

 Unknown state

FWUPD_STATUS_IDLE

 Idle

FWUPD_STATUS_LOADING

 Loading a resource

FWUPD_STATUS_DECOMPRESSING

 Decompressing firmware

FWUPD_STATUS_DEVICE_RESTART

 Restarting the device

FWUPD_STATUS_DEVICE_WRITE

 Writing to a device

FWUPD_STATUS_DEVICE_VERIFY

 Verifying (reading) a device

FWUPD_STATUS_SCHEDULING

 Scheduling an offline update

FWUPD_STATUS_DOWNLOADING

 A file is downloading

FWUPD_STATUS_DEVICE_READ

 Reading from a device

FWUPD_STATUS_DEVICE_ERASE

 Erasing a device

FWUPD_STATUS_WAITING_FOR_AUTH

 Waiting for authentication

FWUPD_STATUS_DEVICE_BUSY

 The device is busy

enum FwupdTrustFlags

typedef enum {
	FWUPD_TRUST_FLAG_NONE		= 0,		/* Since: 0.1.2 */
	FWUPD_TRUST_FLAG_PAYLOAD = 1 << 0, /* Since: 0.1.2 */
	FWUPD_TRUST_FLAG_METADATA = 1 << 1, /* Since: 0.1.2 */
} FwupdTrustFlags;

The flags to show the level of trust.

FWUPD_TRUST_FLAG_NONE

 No trust

FWUPD_TRUST_FLAG_PAYLOAD

 The firmware is trusted

FWUPD_TRUST_FLAG_METADATA

 The metadata is trusted

FWUPD_DEVICE_FLAG_NONE

#define FWUPD_DEVICE_FLAG_NONE			(0u)		/* Since: 0.1.3 */

FWUPD_DEVICE_FLAG_INTERNAL

#define FWUPD_DEVICE_FLAG_INTERNAL		(1u << 0) /* Since: 0.1.3 */

FWUPD_DEVICE_FLAG_UPDATABLE

#define FWUPD_DEVICE_FLAG_UPDATABLE		(1u << 1) /* Since: 0.9.7 */

FWUPD_DEVICE_FLAG_ONLY_OFFLINE

#define FWUPD_DEVICE_FLAG_ONLY_OFFLINE		(1u << 2) /* Since: 0.9.7 */

FWUPD_DEVICE_FLAG_REQUIRE_AC

#define FWUPD_DEVICE_FLAG_REQUIRE_AC		(1u << 3) /* Since: 0.6.3 */

FWUPD_DEVICE_FLAG_LOCKED

#define FWUPD_DEVICE_FLAG_LOCKED		(1u << 4) /* Since: 0.6.3 */

FWUPD_DEVICE_FLAG_SUPPORTED

#define FWUPD_DEVICE_FLAG_SUPPORTED		(1u << 5) /* Since: 0.7.1 */

FWUPD_DEVICE_FLAG_NEEDS_BOOTLOADER

#define FWUPD_DEVICE_FLAG_NEEDS_BOOTLOADER (1u << 6) /* Since: 0.7.3 */

FWUPD_DEVICE_FLAG_REGISTERED

#define FWUPD_DEVICE_FLAG_REGISTERED		(1u << 7) /* Since: 0.9.7 */

FWUPD_DEVICE_FLAG_NEEDS_REBOOT

#define FWUPD_DEVICE_FLAG_NEEDS_REBOOT		(1u << 8) /* Since: 0.9.7 */

FWUPD_DEVICE_FLAG_UNKNOWN

#define FWUPD_DEVICE_FLAG_UNKNOWN		G_MAXUINT64 /* Since: 0.7.3 */

FwupdDeviceFlags

typedef guint64 FwupdDeviceFlags;

The device flags.

enum FwupdInstallFlags

typedef enum {
	FWUPD_INSTALL_FLAG_NONE			= 0, /* Since: 0.7.0 */
	FWUPD_INSTALL_FLAG_OFFLINE		= 1, /* Since: 0.7.0 */
	FWUPD_INSTALL_FLAG_ALLOW_REINSTALL = 2, /* Since: 0.7.0 */
	FWUPD_INSTALL_FLAG_ALLOW_OLDER		= 4, /* Since: 0.7.0 */
	FWUPD_INSTALL_FLAG_FORCE		= 8, /* Since: 0.7.1 */
} FwupdInstallFlags;

Flags to set when performing the firwmare update or install.

FWUPD_INSTALL_FLAG_NONE

 No flags set

FWUPD_INSTALL_FLAG_OFFLINE

 Schedule this for next boot

FWUPD_INSTALL_FLAG_ALLOW_REINSTALL

 Allow reinstalling the same version

FWUPD_INSTALL_FLAG_ALLOW_OLDER

 Allow downgrading firmware

FWUPD_INSTALL_FLAG_FORCE

 Force the update even if not a good idea

enum FwupdUpdateState

typedef enum {
	FWUPD_UPDATE_STATE_UNKNOWN,			/* Since: 0.7.0 */
	FWUPD_UPDATE_STATE_PENDING,			/* Since: 0.7.0 */
	FWUPD_UPDATE_STATE_SUCCESS,			/* Since: 0.7.0 */
	FWUPD_UPDATE_STATE_FAILED,			/* Since: 0.7.0 */
} FwupdUpdateState;

The update state.

FWUPD_UPDATE_STATE_UNKNOWN

 Unknown

FWUPD_UPDATE_STATE_PENDING

 Update is pending

FWUPD_UPDATE_STATE_SUCCESS

 Update was successfull

FWUPD_UPDATE_STATE_FAILED

 Update failed

enum FwupdKeyringKind

typedef enum {
	FWUPD_KEYRING_KIND_UNKNOWN,			/* Since: 0.9.7 */
	FWUPD_KEYRING_KIND_NONE,			/* Since: 0.9.7 */
	FWUPD_KEYRING_KIND_GPG,				/* Since: 0.9.7 */
	FWUPD_KEYRING_KIND_PKCS7,			/* Since: 0.9.7 */
} FwupdKeyringKind;

The update state.

FWUPD_KEYRING_KIND_UNKNOWN

 Unknown

FWUPD_KEYRING_KIND_NONE

 No verification

FWUPD_KEYRING_KIND_GPG

 Verification using GPG

FWUPD_KEYRING_KIND_PKCS7

 Verification using PKCS7

fwupd_status_to_string ()

const gchar *       fwupd_status_to_string              (FwupdStatus status);

Converts a FwupdStatus to a string.

status :

 A FwupdStatus, e.g. FWUPD_STATUS_DECOMPRESSING

Returns :

 identifier string

Since 0.1.1

fwupd_status_from_string ()

FwupdStatus         fwupd_status_from_string            (const gchar *status);

Converts a string to a FwupdStatus.

status :

 A string, e.g. `decompressing`

Returns :

 enumerated value

Since 0.1.1

fwupd_device_flag_to_string ()

const gchar *       fwupd_device_flag_to_string         (FwupdDeviceFlags device_flag);

Converts a FwupdDeviceFlags to a string.

device_flag :

 A FwupdDeviceFlags, e.g. FWUPD_DEVICE_FLAG_REQUIRE_AC

Returns :

 identifier string

Since 0.7.0

fwupd_device_flag_from_string ()

FwupdDeviceFlags    fwupd_device_flag_from_string       (const gchar *device_flag);

Converts a string to a FwupdDeviceFlags.

device_flag :

 A string, e.g. `require-ac`

Returns :

 enumerated value

Since 0.7.0

fwupd_update_state_to_string ()

const gchar *       fwupd_update_state_to_string        (FwupdUpdateState update_state);

Converts a FwupdUpdateState to a string.

update_state :

 A FwupdUpdateState, e.g. FWUPD_UPDATE_STATE_PENDING

Returns :

 identifier string

Since 0.7.0

fwupd_update_state_from_string ()

FwupdUpdateState    fwupd_update_state_from_string      (const gchar *update_state);

Converts a string to a FwupdUpdateState.

update_state :

 A string, e.g. `pending`

Returns :

 enumerated value

Since 0.7.0

fwupd_trust_flag_to_string ()

const gchar *       fwupd_trust_flag_to_string          (FwupdTrustFlags trust_flag);

Converts a FwupdTrustFlags to a string.

trust_flag :

 A FwupdTrustFlags, e.g. FWUPD_TRUST_FLAG_PAYLOAD

Returns :

 identifier string

Since 0.7.0

fwupd_trust_flag_from_string ()

FwupdTrustFlags     fwupd_trust_flag_from_string        (const gchar *trust_flag);

Converts a string to a FwupdTrustFlags.

trust_flag :

 A string, e.g. `payload`

Returns :

 enumerated value

Since 0.7.0

fwupd_keyring_kind_from_string ()

FwupdKeyringKind    fwupd_keyring_kind_from_string      (const gchar *keyring_kind);

Converts an printable string to an enumerated type.

keyring_kind :

 a string, e.g. `gpg`

Returns :

 a FwupdKeyringKind, e.g. FWUPD_KEYRING_KIND_GPG

Since 0.9.7

fwupd_keyring_kind_to_string ()

const gchar *       fwupd_keyring_kind_to_string        (FwupdKeyringKind keyring_kind);

Converts an enumerated type to a printable string.

keyring_kind :

 a FwupdKeyringKind, e.g. FWUPD_KEYRING_KIND_GPG

Returns :

 a string, e.g. `gpg`

Since 0.9.7

Generated by GTK-Doc V1.19