FuDeviceRetryFunc ()

gboolean
(*FuDeviceRetryFunc) (FuDevice *self,
                      gpointer user_data,
                      GError **error);

The device retry iteration callback.

fu_device_new ()

FuDevice *
fu_device_new (void);

Creates a new Fudevice

Since: 0.1.0

fu_device_new_with_context ()

FuDevice *
fu_device_new_with_context (FuContext *ctx);

Creates a new Fudevice

Since: 1.6.2

fu_device_has_flag()

#define fu_device_has_flag(d, v)	   fwupd_device_has_flag(FWUPD_DEVICE(d), v)

fu_device_has_instance_id()

#define fu_device_has_instance_id(d, v)	   fwupd_device_has_instance_id(FWUPD_DEVICE(d), v)

fu_device_has_vendor_id()

#define fu_device_has_vendor_id(d, v)	   fwupd_device_has_vendor_id(FWUPD_DEVICE(d), v)

fu_device_has_protocol()

#define fu_device_has_protocol(d, v)	   fwupd_device_has_protocol(FWUPD_DEVICE(d), v)

fu_device_add_checksum()

#define fu_device_add_checksum(d, v)	   fwupd_device_add_checksum(FWUPD_DEVICE(d), v)

fu_device_add_release()

#define fu_device_add_release(d, v)	   fwupd_device_add_release(FWUPD_DEVICE(d), v)

fu_device_add_icon()

#define fu_device_add_icon(d, v)	   fwupd_device_add_icon(FWUPD_DEVICE(d), v)

fu_device_has_icon()

#define fu_device_has_icon(d, v)	   fwupd_device_has_icon(FWUPD_DEVICE(d), v)

fu_device_add_issue()

#define fu_device_add_issue(d, v)	   fwupd_device_add_issue(FWUPD_DEVICE(d), v)

fu_device_set_created()

#define fu_device_set_created(d, v)	   fwupd_device_set_created(FWUPD_DEVICE(d), v)

fu_device_set_description()

#define fu_device_set_description(d, v)	   fwupd_device_set_description(FWUPD_DEVICE(d), v)

fu_device_set_flags()

#define fu_device_set_flags(d, v)	   fwupd_device_set_flags(FWUPD_DEVICE(d), v)

fu_device_set_modified()

#define fu_device_set_modified(d, v)	   fwupd_device_set_modified(FWUPD_DEVICE(d), v)

fu_device_set_plugin()

#define             fu_device_set_plugin(d, v)

fu_device_set_serial()

#define fu_device_set_serial(d, v)	   fwupd_device_set_serial(FWUPD_DEVICE(d), v)

fu_device_set_summary()

#define fu_device_set_summary(d, v)	   fwupd_device_set_summary(FWUPD_DEVICE(d), v)

fu_device_set_branch()

#define fu_device_set_branch(d, v)	   fwupd_device_set_branch(FWUPD_DEVICE(d), v)

fu_device_set_update_message()

#define fu_device_set_update_message(d, v) fwupd_device_set_update_message(FWUPD_DEVICE(d), v)

fu_device_set_update_image()

#define fu_device_set_update_image(d, v)   fwupd_device_set_update_image(FWUPD_DEVICE(d), v)

fu_device_set_update_error()

#define fu_device_set_update_error(d, v)   fwupd_device_set_update_error(FWUPD_DEVICE(d), v)

fu_device_add_vendor_id()

#define fu_device_add_vendor_id(d, v)	   fwupd_device_add_vendor_id(FWUPD_DEVICE(d), v)

fu_device_add_protocol()

#define fu_device_add_protocol(d, v)	   fwupd_device_add_protocol(FWUPD_DEVICE(d), v)

fu_device_set_version_raw()

#define fu_device_set_version_raw(d, v)	   fwupd_device_set_version_raw(FWUPD_DEVICE(d), v)

fu_device_set_version_lowest_raw()

#define             fu_device_set_version_lowest_raw(d, v)

fu_device_set_version_bootloader_raw()

#define             fu_device_set_version_bootloader_raw(d, v)

fu_device_set_version_build_date()

#define             fu_device_set_version_build_date(d, v)

fu_device_set_flashes_left()

#define fu_device_set_flashes_left(d, v)     fwupd_device_set_flashes_left(FWUPD_DEVICE(d), v)

fu_device_set_install_duration()

#define fu_device_set_install_duration(d, v) fwupd_device_set_install_duration(FWUPD_DEVICE(d), v)

fu_device_get_checksums()

#define fu_device_get_checksums(d)	     fwupd_device_get_checksums(FWUPD_DEVICE(d))

fu_device_get_flags()

#define fu_device_get_flags(d)		     fwupd_device_get_flags(FWUPD_DEVICE(d))

fu_device_get_created()

#define fu_device_get_created(d)	     fwupd_device_get_created(FWUPD_DEVICE(d))

fu_device_get_modified()

#define fu_device_get_modified(d)	     fwupd_device_get_modified(FWUPD_DEVICE(d))

fu_device_get_guids()

#define fu_device_get_guids(d)		     fwupd_device_get_guids(FWUPD_DEVICE(d))

fu_device_get_guid_default()

#define fu_device_get_guid_default(d)	     fwupd_device_get_guid_default(FWUPD_DEVICE(d))

fu_device_get_instance_ids()

#define fu_device_get_instance_ids(d)	     fwupd_device_get_instance_ids(FWUPD_DEVICE(d))

fu_device_get_icons()

#define fu_device_get_icons(d)		     fwupd_device_get_icons(FWUPD_DEVICE(d))

fu_device_get_issues()

#define fu_device_get_issues(d)		     fwupd_device_get_issues(FWUPD_DEVICE(d))

fu_device_get_name()

#define fu_device_get_name(d)		     fwupd_device_get_name(FWUPD_DEVICE(d))

fu_device_get_serial()

#define fu_device_get_serial(d)		     fwupd_device_get_serial(FWUPD_DEVICE(d))

fu_device_get_summary()

#define fu_device_get_summary(d)	     fwupd_device_get_summary(FWUPD_DEVICE(d))

fu_device_get_branch()

#define fu_device_get_branch(d)		     fwupd_device_get_branch(FWUPD_DEVICE(d))

fu_device_get_id()

#define fu_device_get_id(d)		     fwupd_device_get_id(FWUPD_DEVICE(d))

fu_device_get_composite_id()

#define fu_device_get_composite_id(d)	     fwupd_device_get_composite_id(FWUPD_DEVICE(d))

fu_device_get_plugin()

#define fu_device_get_plugin(d)		     fwupd_device_get_plugin(FWUPD_DEVICE(d))

fu_device_get_update_error()

#define fu_device_get_update_error(d)	     fwupd_device_get_update_error(FWUPD_DEVICE(d))

fu_device_get_update_state()

#define fu_device_get_update_state(d)	     fwupd_device_get_update_state(FWUPD_DEVICE(d))

fu_device_get_update_message()

#define fu_device_get_update_message(d)	     fwupd_device_get_update_message(FWUPD_DEVICE(d))

fu_device_get_update_image()

#define fu_device_get_update_image(d)	     fwupd_device_get_update_image(FWUPD_DEVICE(d))

fu_device_get_vendor()

#define fu_device_get_vendor(d)		     fwupd_device_get_vendor(FWUPD_DEVICE(d))

fu_device_get_version()

#define fu_device_get_version(d)	     fwupd_device_get_version(FWUPD_DEVICE(d))

fu_device_get_version_lowest()

#define fu_device_get_version_lowest(d)	     fwupd_device_get_version_lowest(FWUPD_DEVICE(d))

fu_device_get_version_bootloader()

#define fu_device_get_version_bootloader(d)  fwupd_device_get_version_bootloader(FWUPD_DEVICE(d))

fu_device_get_version_format()

#define fu_device_get_version_format(d)	     fwupd_device_get_version_format(FWUPD_DEVICE(d))

fu_device_get_version_raw()

#define fu_device_get_version_raw(d)	     fwupd_device_get_version_raw(FWUPD_DEVICE(d))

fu_device_get_version_lowest_raw()

#define fu_device_get_version_lowest_raw(d)  fwupd_device_get_version_lowest_raw(FWUPD_DEVICE(d))

fu_device_get_version_bootloader_raw()

#define             fu_device_get_version_bootloader_raw(d)

fu_device_get_version_build_date()

#define fu_device_get_version_build_date(d) fwupd_device_get_version_build_date(FWUPD_DEVICE(d))

fu_device_get_vendor_ids()

#define fu_device_get_vendor_ids(d)	    fwupd_device_get_vendor_ids(FWUPD_DEVICE(d))

fu_device_get_protocols()

#define fu_device_get_protocols(d)	    fwupd_device_get_protocols(FWUPD_DEVICE(d))

fu_device_get_flashes_left()

#define fu_device_get_flashes_left(d)	    fwupd_device_get_flashes_left(FWUPD_DEVICE(d))

fu_device_get_install_duration()

#define fu_device_get_install_duration(d)   fwupd_device_get_install_duration(FWUPD_DEVICE(d))

fu_device_to_string ()

gchar *
fu_device_to_string (FuDevice *self);

This allows us to easily print the device, the release and the daemon-specific metadata.

Since: 0.9.8

fu_device_add_string ()

void
fu_device_add_string (FuDevice *self,
                      guint idt,
                      GString *str);

Add daemon-specific device metadata to an existing string.

Since: 1.7.1

fu_device_get_alternate_id ()

const gchar *
fu_device_get_alternate_id (FuDevice *self);

Gets any alternate device ID. An alternate device may be linked to the primary device in some way.

Since: 1.1.0

fu_device_set_alternate_id ()

void
fu_device_set_alternate_id (FuDevice *self,
                            const gchar *alternate_id);

Sets any alternate device ID. An alternate device may be linked to the primary device in some way.

Since: 1.1.0

fu_device_get_equivalent_id ()

const gchar *
fu_device_get_equivalent_id (FuDevice *self);

Gets any equivalent ID for a device

Since: 0.6.1

fu_device_set_equivalent_id ()

void
fu_device_set_equivalent_id (FuDevice *self,
                             const gchar *equivalent_id);

Sets any equivalent ID for a device

Since: 0.6.1

fu_device_add_guid ()

void
fu_device_add_guid (FuDevice *self,
                    const gchar *guid);

Adds a GUID to the device. If the guid argument is not a valid GUID then it is converted to a GUID using fwupd_guid_hash_string().

Since: 0.7.2

fu_device_add_guid_full ()

void
fu_device_add_guid_full (FuDevice *self,
                         const gchar *guid,
                         FuDeviceInstanceFlags flags);

Adds a GUID to the device. If the guid argument is not a valid GUID then it is converted to a GUID using fwupd_guid_hash_string().

Since: 1.6.2

fu_device_has_guid ()

gboolean
fu_device_has_guid (FuDevice *self,
                    const gchar *guid);

Finds out if the device has a specific GUID.

Since: 1.2.2

fu_device_add_instance_id ()

void
fu_device_add_instance_id (FuDevice *self,
                           const gchar *instance_id);

Adds an instance ID to the device. If the instance_id argument is already a valid GUID then fu_device_add_guid() should be used instead.

Since: 1.2.5

fu_device_add_instance_id_full ()

void
fu_device_add_instance_id_full (FuDevice *self,
                                const gchar *instance_id,
                                FuDeviceInstanceFlags flags);

Adds an instance ID with all parameters set

Since: 1.2.9

fu_device_get_alternate ()

FuDevice *
fu_device_get_alternate (FuDevice *self);

Gets any alternate device. An alternate device may be linked to the primary device in some way.

The alternate object will be matched from the ID set in fu_device_set_alternate_id() and will be assigned by the daemon. This means if the ID is not found as an added device, then this function will return NULL.

Since: 0.7.2

fu_device_get_root ()

FuDevice *
fu_device_get_root (FuDevice *self);

Gets the root parent device. A parent device is logically "above" the current device and this may be reflected in client tools.

If there is no parent device defined, then self is returned.

Since: 1.4.0

fu_device_get_parent ()

FuDevice *
fu_device_get_parent (FuDevice *self);

Gets any parent device. An parent device is logically "above" the current device and this may be reflected in client tools.

This information also allows the plugin to optionally verify the parent device, for instance checking the parent device firmware version.

The parent object is not refcounted and if destroyed this function will then return NULL.

Since: 1.0.8

fu_device_get_children ()

GPtrArray *
fu_device_get_children (FuDevice *self);

Gets any child devices. A child device is logically "below" the current device and this may be reflected in client tools.

Since: 1.0.8

fu_device_add_child ()

void
fu_device_add_child (FuDevice *self,
                     FuDevice *child);

Sets any child device. An child device is logically linked to the primary device in some way.

Since: 1.0.8

fu_device_remove_child ()

void
fu_device_remove_child (FuDevice *self,
                        FuDevice *child);

Removes child device.

Since: 1.6.2

fu_device_add_parent_guid ()

void
fu_device_add_parent_guid (FuDevice *self,
                           const gchar *guid);

Sets any parent device using a GUID. An parent device is logically linked to the primary device in some way and can be added before or after self .

The GUIDs are searched in order, and so the order of adding GUIDs may be important if more than one parent device might match.

If the parent device is removed, any children logically linked to it will also be removed.

Since: 1.0.8

fu_device_add_parent_physical_id ()

void
fu_device_add_parent_physical_id (FuDevice *self,
                                  const gchar *physical_id);

Sets any parent device using the physical ID. An parent device is logically linked to the primary device in some way and can be added before or after self .

The IDs are searched in order, and so the order of adding IDs may be important if more than one parent device might match.

Since: 1.6.2

fu_device_add_counterpart_guid ()

void
fu_device_add_counterpart_guid (FuDevice *self,
                                const gchar *guid);

Adds a GUID to the device. If the guid argument is not a valid GUID then it is converted to a GUID using fwupd_guid_hash_string().

A counterpart GUID is typically the GUID of the same device in bootloader or runtime mode, if they have a different device PCI or USB ID. Adding this type of GUID does not cause a "cascade" by matching using the quirk database.

Since: 1.1.2

fu_device_get_proxy ()

FuDevice *
fu_device_get_proxy (FuDevice *self);

Gets any proxy device. A proxy device can be used to perform an action on behalf of another device, for instance attach()ing it after a successful update.

The proxy object is not refcounted and if destroyed this function will then return NULL.

Since: 1.4.1

fu_device_set_proxy ()

void
fu_device_set_proxy (FuDevice *self,
                     FuDevice *proxy);

Sets any proxy device. A proxy device can be used to perform an action on behalf of another device, for instance attach()ing it after a successful update.

Since: 1.4.1

fu_device_get_proxy_with_fallback ()

FuDevice *
fu_device_get_proxy_with_fallback (FuDevice *self);

Gets the proxy device if FU_DEVICE_INTERNAL_FLAG_USE_PROXY_FALLBACK is set, falling back to the device itself.

Since: 1.6.2

fu_device_get_metadata ()

const gchar *
fu_device_get_metadata (FuDevice *self,
                        const gchar *key);

Gets an item of metadata from the device.

Since: 0.1.0

fu_device_get_metadata_boolean ()

gboolean
fu_device_get_metadata_boolean (FuDevice *self,
                                const gchar *key);

Gets an item of metadata from the device.

Since: 0.9.7

fu_device_get_metadata_integer ()

guint
fu_device_get_metadata_integer (FuDevice *self,
                                const gchar *key);

Gets an item of metadata from the device.

Since: 0.9.7

fu_device_remove_metadata ()

void
fu_device_remove_metadata (FuDevice *self,
                           const gchar *key);

Removes an item of metadata on the device.

Since: 1.3.3

fu_device_set_metadata ()

void
fu_device_set_metadata (FuDevice *self,
                        const gchar *key,
                        const gchar *value);

Sets an item of metadata on the device.

Since: 0.1.0

fu_device_set_metadata_boolean ()

void
fu_device_set_metadata_boolean (FuDevice *self,
                                const gchar *key,
                                gboolean value);

Sets an item of metadata on the device. When value is set to TRUE the actual stored value is true.

Since: 0.9.7

fu_device_set_metadata_integer ()

void
fu_device_set_metadata_integer (FuDevice *self,
                                const gchar *key,
                                guint value);

Sets an item of metadata on the device. The integer is stored as a base-10 string internally.

Since: 0.9.7

fu_device_set_id ()

void
fu_device_set_id (FuDevice *self,
                  const gchar *id);

Sets the ID on the device. The ID should represent the *connection* of the device, so that any similar device plugged into a different slot will have a different id string.

The id will be converted to a SHA1 hash if required before the device is added to the daemon, and plugins should not assume that the ID that is set here is the same as what is returned by fu_device_get_id().

Since: 0.7.1

fu_device_set_version_format ()

void
fu_device_set_version_format (FuDevice *self,
                              FwupdVersionFormat fmt);

Sets the device version format.

Since: 1.4.0

fu_device_set_version ()

void
fu_device_set_version (FuDevice *self,
                       const gchar *version);

Sets the device version, sanitizing the string if required.

Since: 1.2.9

fu_device_set_version_lowest ()

void
fu_device_set_version_lowest (FuDevice *self,
                              const gchar *version);

Sets the device lowest version, sanitizing the string if required.

Since: 1.4.0

fu_device_set_version_bootloader ()

void
fu_device_set_version_bootloader (FuDevice *self,
                                  const gchar *version);

Sets the device bootloader version, sanitizing the string if required.

Since: 1.4.0

fu_device_inhibit ()

void
fu_device_inhibit (FuDevice *self,
                   const gchar *inhibit_id,
                   const gchar *reason);

Prevent the device from being updated, changing it from FWUPD_DEVICE_FLAG_UPDATABLE to FWUPD_DEVICE_FLAG_UPDATABLE_HIDDEN if not already inhibited.

If the device already has an inhibit with the same inhibit_id then the request is ignored.

Since: 1.6.0

fu_device_uninhibit ()

void
fu_device_uninhibit (FuDevice *self,
                     const gchar *inhibit_id);

Allow the device from being updated if there are no other inhibitors, changing it from FWUPD_DEVICE_FLAG_UPDATABLE_HIDDEN to FWUPD_DEVICE_FLAG_UPDATABLE.

If the device already has no inhibit with the inhibit_id then the request is ignored.

Since: 1.6.0

fu_device_get_physical_id ()

const gchar *
fu_device_get_physical_id (FuDevice *self);

Gets the physical ID set for the device, which represents the electrical connection used to compare devices.

Multiple FuDevices can share a single physical ID.

Since: 1.1.2

fu_device_set_physical_id ()

void
fu_device_set_physical_id (FuDevice *self,
                           const gchar *physical_id);

Sets the physical ID on the device which represents the electrical connection of the device to the system. Multiple FuDevices can share a physical ID.

The physical ID is used to remove logical devices when a physical device has been removed from the system.

A sysfs or devpath is not a physical ID, but could be something like PCI_SLOT_NAME=0000:3e:00.0.

Since: 1.1.2

fu_device_get_logical_id ()

const gchar *
fu_device_get_logical_id (FuDevice *self);

Gets the logical ID set for the device, which disambiguates devices with the same physical ID.

Since: 1.1.2

fu_device_set_logical_id ()

void
fu_device_set_logical_id (FuDevice *self,
                          const gchar *logical_id);

Sets the logical ID on the device. This is designed to disambiguate devices with the same physical ID.

Since: 1.1.2

fu_device_get_backend_id ()

const gchar *
fu_device_get_backend_id (FuDevice *self);

Gets the ID set for the device as recognized by the backend. This is typically a Linux sysfs path or USB platform ID. If unset, it also falls back to the physical ID as this may be the same value.

Since: 1.5.8

fu_device_set_backend_id ()

void
fu_device_set_backend_id (FuDevice *self,
                          const gchar *backend_id);

Sets the backend ID on the device. This is designed to disambiguate devices with the same physical ID. This is typically a Linux sysfs path or USB platform ID.

Since: 1.5.8

fu_device_get_proxy_guid ()

const gchar *
fu_device_get_proxy_guid (FuDevice *self);

Gets the proxy GUID device, which which is set to let the engine match up the proxy between plugins.

Since: 1.4.1

fu_device_set_proxy_guid ()

void
fu_device_set_proxy_guid (FuDevice *self,
                          const gchar *proxy_guid);

Sets the GUID of the proxy device. The proxy device may update self .

Since: 1.4.1

fu_device_get_priority ()

guint
fu_device_get_priority (FuDevice *self);

Gets the device priority, where higher numbers are better.

Since: 1.1.1

fu_device_set_priority ()

void
fu_device_set_priority (FuDevice *self,
                        guint priority);

Sets the device priority, where higher numbers are better.

Since: 1.1.1

fu_device_add_flag ()

void
fu_device_add_flag (FuDevice *self,
                    FwupdDeviceFlags flag);

Adds a device flag to the device.

Since: 0.1.0

fu_device_remove_flag ()

void
fu_device_remove_flag (FuDevice *self,
                       FwupdDeviceFlags flag);

Removes a device flag from the device.

Since: 1.6.0

fu_device_get_custom_flags ()

const gchar *
fu_device_get_custom_flags (FuDevice *self);

Gets the custom flags for the device from the quirk system.

Since: 1.1.0

fu_device_set_custom_flags ()

void
fu_device_set_custom_flags (FuDevice *self,
                            const gchar *custom_flags);

Sets the custom flags from the quirk system that can be used to affect device matching. The actual string format is defined by the plugin.

Since: 1.1.0

fu_device_set_name ()

void
fu_device_set_name (FuDevice *self,
                    const gchar *value);

Sets the name on the device. Any invalid parts will be converted or removed.

Since: 0.7.1

fu_device_set_vendor ()

void
fu_device_set_vendor (FuDevice *self,
                      const gchar *vendor);

Sets the vendor name on the device.

Since: 1.6.2

fu_device_get_remove_delay ()

guint
fu_device_get_remove_delay (FuDevice *self);

Returns the maximum delay expected when replugging the device going into bootloader mode.

Since: 1.0.2

fu_device_set_remove_delay ()

void
fu_device_set_remove_delay (FuDevice *self,
                            guint remove_delay);

Sets the amount of time a device is allowed to return in bootloader mode.

NOTE: this should be less than 3000ms for devices that just have to reset and automatically re-enumerate, but significantly longer if it involves a user removing a cable, pressing several buttons and removing a cable. A suggested value for this would be 10,000ms.

Since: 1.0.2

fu_device_set_firmware_size ()

void
fu_device_set_firmware_size (FuDevice *self,
                             guint64 size);

Sets the exact allowed size of the firmware blob.

Since: 1.2.6

fu_device_set_firmware_size_min ()

void
fu_device_set_firmware_size_min (FuDevice *self,
                                 guint64 size_min);

Sets the minimum allowed size of the firmware blob.

Since: 1.1.2

fu_device_set_firmware_size_max ()

void
fu_device_set_firmware_size_max (FuDevice *self,
                                 guint64 size_max);

Sets the maximum allowed size of the firmware blob.

Since: 1.1.2

fu_device_get_firmware_size_min ()

guint64
fu_device_get_firmware_size_min (FuDevice *self);

Gets the minimum size of the firmware blob.

Since: 1.2.6

fu_device_get_firmware_size_max ()

guint64
fu_device_get_firmware_size_max (FuDevice *self);

Gets the maximum size of the firmware blob.

Since: 1.2.6

fu_device_get_battery_level ()

guint
fu_device_get_battery_level (FuDevice *self);

Returns the battery level.

Since: 1.5.8

fu_device_set_battery_level ()

void
fu_device_set_battery_level (FuDevice *self,
                             guint battery_level);

Sets the battery level, or FU_BATTERY_VALUE_INVALID.

Setting this allows fwupd to show a warning if the device change is too low to perform the update.

Since: 1.5.8

fu_device_get_battery_threshold ()

guint
fu_device_get_battery_threshold (FuDevice *self);

Returns the battery threshold under which a firmware update cannot be performed.

If fu_device_set_battery_threshold() has not been used, a default value is used instead.

Since: 1.6.0

fu_device_set_battery_threshold ()

void
fu_device_set_battery_threshold (FuDevice *self,
                                 guint battery_threshold);

Sets the battery level, or FU_BATTERY_VALUE_INVALID for the default.

Setting this allows fwupd to show a warning if the device change is too low to perform the update.

Since: 1.6.0

fu_device_set_update_state ()

void
fu_device_set_update_state (FuDevice *self,
                            FwupdUpdateState update_state);

Sets the update state, clearing the update error as required.

Since: 1.6.2

fu_device_set_context ()

void
fu_device_set_context (FuDevice *self,
                       FuContext *ctx);

Sets the optional context which may be useful to this device. This is typically set after the device has been created, but before the device has been opened or probed.

Since: 1.6.0

fu_device_get_context ()

FuContext *
fu_device_get_context (FuDevice *self);

Gets the context assigned for this device.

Since: 1.6.0

fu_device_get_release_default ()

FwupdRelease *
fu_device_get_release_default (FuDevice *self);

Gets the default release for the device, creating one if not found.

Since: 1.0.5

fu_device_get_specialized_gtype ()

GType
fu_device_get_specialized_gtype (FuDevice *self);

Gets the specialized type of the device

Since: 1.3.3

fu_device_get_firmware_gtype ()

GType
fu_device_get_firmware_gtype (FuDevice *self);

Gets the default firmware type for the device.

Since: 1.7.2

fu_device_set_firmware_gtype ()

void
fu_device_set_firmware_gtype (FuDevice *self,
                              GType firmware_gtype);

Sets the default firmware type for the device.

Since: 1.7.2

fu_device_add_internal_flag ()

void
fu_device_add_internal_flag (FuDevice *self,
                             FuDeviceInternalFlags flag);

Adds a private flag that stays internal to the engine and is not leaked to the client.

Since: 1.5.5

fu_device_remove_internal_flag ()

void
fu_device_remove_internal_flag (FuDevice *self,
                                FuDeviceInternalFlags flag);

Removes a private flag that stays internal to the engine and is not leaked to the client.

Since: 1.5.5

fu_device_has_internal_flag ()

gboolean
fu_device_has_internal_flag (FuDevice *self,
                             FuDeviceInternalFlags flag);

Tests for a private flag that stays internal to the engine and is not leaked to the client.

Since: 1.5.5

fu_device_get_results ()

gboolean
fu_device_get_results (FuDevice *self,
                       GError **error);

Gets the results of the last update operation on the device by calling a vfunc.

Since: 1.6.2

fu_device_write_firmware ()

gboolean
fu_device_write_firmware (FuDevice *self,
                          GBytes *fw,
                          FuProgress *progress,
                          FwupdInstallFlags flags,
                          GError **error);

Writes firmware to the device by calling a plugin-specific vfunc.

Since: 1.0.8

fu_device_prepare_firmware ()

FuFirmware *
fu_device_prepare_firmware (FuDevice *self,
                            GBytes *fw,
                            FwupdInstallFlags flags,
                            GError **error);

Prepares the firmware by calling an optional device-specific vfunc for the device, which can do things like decompressing or parsing of the firmware data.

For all firmware, this checks the size of the firmware if limits have been set using fu_device_set_firmware_size_min(), fu_device_set_firmware_size_max() or using a quirk entry.

Since: 1.1.2

fu_device_read_firmware ()

FuFirmware *
fu_device_read_firmware (FuDevice *self,
                         FuProgress *progress,
                         GError **error);

Reads firmware from the device by calling a plugin-specific vfunc. The device subclass should try to ensure the firmware does not contain any serial numbers or user-configuration values and can be used to calculate the device checksum.

The return value can be converted to a blob of memory using fu_firmware_write().

Since: 1.0.8

fu_device_dump_firmware ()

GBytes *
fu_device_dump_firmware (FuDevice *self,
                         FuProgress *progress,
                         GError **error);

Reads the raw firmware image from the device by calling a plugin-specific vfunc. This raw firmware image may contain serial numbers or device-specific configuration but should be a byte-for-byte match compared to using an external SPI programmer.

Since: 1.5.0

fu_device_attach ()

gboolean
fu_device_attach (FuDevice *self,
                  GError **error);

Attaches a device from the bootloader into application mode.

Since: 1.0.8

fu_device_detach ()

gboolean
fu_device_detach (FuDevice *self,
                  GError **error);

Detaches a device from the application into bootloader mode.

Since: 1.0.8

fu_device_attach_full ()

gboolean
fu_device_attach_full (FuDevice *self,
                       FuProgress *progress,
                       GError **error);

Attaches a device from the bootloader into application mode.

Since: 1.7.0

fu_device_detach_full ()

gboolean
fu_device_detach_full (FuDevice *self,
                       FuProgress *progress,
                       GError **error);

Detaches a device from the application into bootloader mode.

Since: 1.7.0

fu_device_reload ()

gboolean
fu_device_reload (FuDevice *self,
                  GError **error);

Reloads a device that has just gone from bootloader into application mode.

Since: 1.3.3

fu_device_prepare ()

gboolean
fu_device_prepare (FuDevice *self,
                   FwupdInstallFlags flags,
                   GError **error);

Prepares a device for update. A different plugin can handle each of FuDevice->prepare(), FuDevice->detach() and FuDevice->write_firmware().

Since: 1.3.3

fu_device_cleanup ()

gboolean
fu_device_cleanup (FuDevice *self,
                   FwupdInstallFlags flags,
                   GError **error);

Cleans up a device after an update. A different plugin can handle each of FuDevice->write_firmware(), FuDevice->attach() and FuDevice->cleanup().