FwupdPluginDevice

Converts a string to an internal device flag.

since: 1.5.5

Converts an internal device flag to a string.

since: 1.5.5

Activates up a device, which normally means the device switches to a new firmware version. This should only be called when data loss cannot occur.

since: 1.2.6

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

since: 1.0.8

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.1.2

Adds a device flag to the device.

since: 0.1.0

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

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

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

Adds an instance ID with all parameters set.

since: 1.2.9

Assign a value for the key.

since: 1.7.7

Assign a sanitized value for the key.

since: 1.7.7

Assign a uppercase value for the key.

since: 1.7.7

Assign a value to the key, which is padded as 4X.

since: 1.7.7

Assign a value to the key, which is padded as 8X.

since: 1.7.7

Assign a value to the key, which is padded as 1X.

since: 1.7.7

Assign a value to the key, which is padded as 2X.

since: 1.7.7

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

since: 1.5.5

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.

since: 1.0.8

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.

since: 1.6.2

Adds a plugin name to the list of plugins that might be able to handle this device. This is typically called from a quirk handler.

since: 1.5.1

Adds a private flag that can be used by the plugin for any purpose.

since: 1.6.2

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

since: 1.8.1

Adds HSI security attributes.

since: 1.6.0

Add daemon-specific device metadata to an existing string.

since: 1.7.1

Attaches a device from the bootloader into application mode.

since: 1.0.8

Attaches a device from the bootloader into application mode.

since: 1.7.0

Binds a driver to the device, which normally means the kernel driver takes control of the hardware.

since: 1.5.0

Creates an instance ID from a prefix and some key values. If the key value cannot be found, the parent and then proxy is also queried.

since: 1.7.7

Creates an quirk-only instance ID from a prefix and some key values. If any of the key values are unset then no instance ID is added.

since: 1.7.7

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

since: 1.3.3

Closes a device, optionally running a object-specific vfunc.

since: 1.1.2

Converts all the Device instance IDs added using fu_device_add_instance_id() into actual GUIDs, unless FU_DEVICE_INTERNAL_FLAG_NO_AUTO_INSTANCE_IDS has been set.

since: 1.2.5

Detaches a device from the application into bootloader mode.

since: 1.0.8

Detaches a device from the application into bootloader mode.

since: 1.7.0

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

Emit a request from a plugin to the client.

since: 1.6.2

If not already set, generates a device ID with the optional physical and logical IDs.

since: 1.1.2

Returns the time the daemon should wait for devices to finish hotplugging after the update has completed.

since: 1.8.3

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

since: 0.7.2

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

since: 1.1.0

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

Returns the battery level.

since: 1.5.8

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

since: 1.6.0

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

Gets the context assigned for this device.

since: 1.6.0

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

since: 1.1.0

Gets any equivalent ID for a device.

since: 0.6.1

Gets the default firmware type for the device.

since: 1.7.2

Gets the maximum size of the firmware blob.

since: 1.2.6

Gets the minimum size of the firmware blob.

since: 1.2.6

Gets the device GUIDs as a joined string, which may be useful for error messages.

since: 1.0.8

Gets all the internal flags.

since: 1.7.1

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

since: 1.1.2

Gets an item of metadata from the device.

since: 0.1.0

Gets an item of metadata from the device.

since: 0.9.7

Gets an item of metadata from the device.

since: 0.9.7

Gets the device order, where higher numbers are installed after lower numbers.

since: 1.0.8

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

since: 1.0.8

Gets any parent device GUIDs. If a device is added to the daemon that matches any GUIDs added from fu_device_add_parent_guid() then this device is marked the parent of self.

since: 1.0.8

Gets any parent device IDs. If a device is added to the daemon that matches the physical ID added from fu_device_add_parent_physical_id() then this device is marked the parent of self.

since: 1.6.2

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

since: 1.1.2

Gets the list of possible plugin names, typically added from quirk files.

since: 1.3.3

Gets the device priority, where higher numbers are better.

since: 1.1.1

Returns all the private flags that can be used by the plugin for any purpose.

since: 1.6.2

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.

since: 1.4.1

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

since: 1.4.1

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

since: 1.6.2

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

since: 1.0.2

Returns the number of requests of a specific kind. This function is only useful to the daemon, which uses it to synthesize artificial events for plugins not yet ported to FwupdRequest.

since: 1.6.2

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

since: 1.6.2

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

since: 1.4.0

Gets the specialized type of the device.

since: 1.3.3

Gets the update request ID as specified from LVFS::UpdateRequestId.

since: 1.8.6

Finds out if the device has a specific GUID.

since: 1.2.2

Check if the device already has an inhibit with a specific ID.

since: 1.8.0

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

since: 1.5.5

Searches the list of parent GUIDs for a string match.

since: 1.0.8

Searches the list of parent IDs for a string match.

since: 1.6.2

Tests for a private flag that can be used by the plugin for any purpose.

since: 1.6.2

Query if a device has a specific problem.

since: 1.8.11

Copy all properties from the donor object if they have not already been set.

since: 1.1.0

Copy the value of a specific flag from the donor object.

since: 1.3.5

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

since: 1.6.0

Opens a device, optionally running a object-specific vfunc.

since: 1.1.2

Polls a device, typically querying the hardware for status.

since: 1.1.2

Returns a device locker that prevents polling on the device. If there are no open poll lockers then the poll callback will be called.

since: 1.8.1

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

since: 1.3.3

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.

since: 1.1.2

Probes a device, setting parameters on the object that does not need the device open or the interface claimed. If the device is not compatible then an error should be returned.

since: 1.1.2

Tell the device that all probing has finished. This allows it to release any resources that are only valid during coldplug or hotplug.

since: 1.8.12

Normally when calling fu_device_probe() multiple times it is only done once. Calling this method causes the next requests to fu_device_probe() and fu_device_setup() actually probe the hardware.

since: 1.1.2

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.

since: 1.0.8

Registers a private device flag so that it can be set from quirk files.

since: 1.6.2

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

since: 1.3.3

Removes child device.

since: 1.6.2

Removes a device flag from the device.

since: 1.6.0

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

since: 1.5.5

Removes an item of metadata on the device.

since: 1.3.3

Removes a private flag that can be used by the plugin for any purpose.

since: 1.6.2

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.

since: 1.8.1

Collects metadata that would be useful for debugging a failed update report.

since: 1.5.0

Collects metadata that would be useful for debugging a failed update report.

since: 1.5.0

Rescans a device, re-adding GUIDs or flags based on some hardware change.

since: 1.3.1

Calls a specific function a number of times, optionally handling the error with a reset action.

since: 1.4.0

Sets the optional function to be called when fu_device_retry() fails, which is possibly a device reset.

since: 1.4.0

Calls a specific function a number of times, optionally handling the error with a reset action.

since: 1.5.5

Sets the recovery delay between failed retries.

since: 1.4.0

Creates a new FwupdSecurityAttr for this specific device.

since: 1.8.4

Sets the time the daemon should wait for devices to finish hotplugging after the update has completed.

since: 1.8.3

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

since: 0.7.2

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

since: 1.1.0

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

Sets the battery level, or FWUPD_BATTERY_LEVEL_INVALID.

since: 1.5.8

Sets the battery level, or FWUPD_BATTERY_LEVEL_INVALID for the default.

since: 1.6.0

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

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

Sets any equivalent ID for a device.

since: 0.6.1

Sets the default firmware type for the device.

since: 1.7.2

Sets the exact allowed size of the firmware blob.

since: 1.2.6

Sets the maximum allowed size of the firmware blob.

since: 1.1.2

Sets the minimum allowed size of the firmware blob.

since: 1.1.2

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.

since: 0.7.1

Sets the internal flags.

since: 1.7.1

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

since: 1.1.2

Sets an item of metadata on the device.

since: 0.1.0

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

since: 0.9.7

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

since: 0.9.7

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

since: 0.7.1

Sets the device order, where higher numbers are installed after lower numbers.

since: 1.0.8

Sets any parent device. An parent device is logically “above” the current device and this may be reflected in client tools.

since: 1.0.8

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.

since: 1.1.2

Polls the hardware every interval period. If the subclassed ->poll() method returns FALSE then a warning is printed to the console and the poll is disabled until the next call to fu_device_set_poll_interval().

since: 1.1.2

Sets the device priority, where higher numbers are better.

since: 1.1.1

Sets private flags that can be used by the plugin for any purpose.

since: 1.6.2

Sets steps on the progress object used to write firmware.

since: 1.7.0

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

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

since: 1.4.1

Sets a specific quirk on the device.

since: 1.8.5

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

since: 1.0.2

Sets the update request ID as specified in LVFS::UpdateRequestId.

since: 1.8.6

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

since: 1.6.2

Sets the vendor name on the device.

since: 1.6.2

Sets the device version, sanitizing the string if required.

since: 1.2.9

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

since: 1.4.0

Sets the device version format.

since: 1.4.0

Sets the device version from a integer value and the device version format.

since: 1.8.9

Sets the device version from a integer value and the device version format.

since: 1.8.9

Sets the device version from a integer value and the device version format.

since: 1.8.9

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

since: 1.4.0

Sets up a device, setting parameters on the object that requires the device to be open and have the interface claimed. If the device is not compatible then an error should be returned.

since: 1.1.2

Delays program execution up to 100 seconds, unless the device is emulated where no delays is performed.

since: 1.8.11

Delays program execution up to 1000 seconds, unless the device is emulated where no delays is performed.

since: 1.8.11

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

since: 0.9.8

Unbinds the driver from the device, which normally means the kernel releases the hardware so it can be used from userspace.

since: 1.5.0

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.

since: 1.6.0

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

since: 1.0.8