Class

FwupdPluginCfuOffer

Description [src]

class FwupdPlugin.CfuOffer : FwupdPlugin.Firmware {
  parent_instance: FuFirmware
}

A CFU offer. This is a 16 byte blob which contains enough data for the device to either accept or refuse a firmware payload. The offer may be loaded from disk, network, or even constructed manually. There is much left to how the specific firmware implements CFU, and it’s expected that multiple different plugins will use this offer in different ways.

Documented: https://docs.microsoft.com/en-us/windows-hardware/drivers/cfu/cfu-specification

See also: FuFirmware

Ancestors

Constructors

fu_cfu_offer_new

Creates a new FuFirmware for a CFU offer.

Available since: 1.7.0

Instance methods

fu_cfu_offer_get_bank

Gets the bank register, used if multiple banks are supported.

Available since: 1.7.0

fu_cfu_offer_get_component_id

Gets the component in the device to apply the firmware update.

Available since: 1.7.0

fu_cfu_offer_get_force_ignore_version

Gets if the in-situ firmware should ignore version mismatch (e.g. downgrade).

Available since: 1.7.0

fu_cfu_offer_get_force_immediate_reset

Gets if the in-situ firmware should reset into the new firmware immediately, rather than waiting for the next time the device is replugged.

Available since: 1.7.0

fu_cfu_offer_get_hw_variant

Gets the hardware variant bitmask corresponding with compatible firmware.

Available since: 1.7.0

fu_cfu_offer_get_milestone

Gets the milestone, which can be used as a version for example EV1, EVT etc.

Available since: 1.7.0

fu_cfu_offer_get_product_id

Gets the product ID for this CFU image.

Available since: 1.7.0

fu_cfu_offer_get_protocol_revision

Gets the CFU protocol version.

Available since: 1.7.0

fu_cfu_offer_get_segment_number

Gets the part of the firmware that is being transferred.

Available since: 1.7.0

fu_cfu_offer_get_token

Gets the token to identify the user specific software making the offer.

Available since: 1.7.0

fu_cfu_offer_set_bank

Sets bank register, used if multiple banks are supported.

Available since: 1.7.0

fu_cfu_offer_set_component_id

Sets the component in the device to apply the firmware update.

Available since: 1.7.0

fu_cfu_offer_set_force_ignore_version

Sets if the in-situ firmware should ignore version mismatch (e.g. downgrade).

Available since: 1.7.0

fu_cfu_offer_set_force_immediate_reset

Sets if the in-situ firmware should reset into the new firmware immediately, rather than waiting for the next time the device is replugged.

Available since: 1.7.0

fu_cfu_offer_set_hw_variant

Sets the hardware variant bitmask corresponding with compatible firmware.

Available since: 1.7.0

fu_cfu_offer_set_milestone

Sets the milestone, which can be used as a version for example EV1, EVT etc.

Available since: 1.7.0

fu_cfu_offer_set_product_id

Sets the product ID for this CFU image.

Available since: 1.7.0

fu_cfu_offer_set_protocol_revision

Sets the CFU protocol version.

Available since: 1.7.0

fu_cfu_offer_set_segment_number

Sets the part of the firmware that is being transferred.

Available since: 1.7.0

fu_cfu_offer_set_token

Sets the token to identify the user specific software making the offer.

Available since: 1.7.0

Methods inherited from FuFirmware (59)
fu_firmware_add_chunk

Adds a chunk to the image.

Available since: 1.6.0

fu_firmware_add_flag

Adds a specific firmware flag to the firmware.

Available since: 1.5.0

fu_firmware_add_image

Adds an image to the firmware.

Available since: 1.3.1

fu_firmware_add_image_full

Adds an image to the firmware. This method will fail if the number of images would be above the limit set by fu_firmware_set_images_max().

Available since: 1.9.3

fu_firmware_add_patch

Adds a byte patch at a specific offset. If a patch already exists at the specified address then it is replaced.

Available since: 1.7.4

fu_firmware_build

Builds a firmware from an XML manifest. The manifest would typically have the following form:

Available since: 1.5.0

fu_firmware_build_from_xml

Builds a firmware from an XML manifest. The manifest would typically have the following form:

Available since: 1.6.0

fu_firmware_check_compatible

Check a new firmware is compatible with the existing firmware.

Available since: 1.8.4

fu_firmware_export

This allows us to build an XML object for the nested firmware.

Available since: 1.6.0

fu_firmware_export_to_xml

This allows us to build an XML object for the nested firmware.

Available since: 1.6.0

fu_firmware_get_addr

Gets the base address of the image.

Available since: 1.6.0

fu_firmware_get_alignment

Gets the alignment of the firmware.

Available since: 1.6.0

fu_firmware_get_bytes

Gets the firmware payload, which does not have any header or footer included.

Available since: 1.6.0

fu_firmware_get_bytes_with_patches

Gets the firmware payload, with any defined patches applied.

Available since: 1.7.4

fu_firmware_get_checksum

Returns a checksum of the payload data.

Available since: 1.6.0

fu_firmware_get_chunks

Gets the optional image chunks.

Available since: 1.6.0

fu_firmware_get_filename

Gets an optional filename that represents the image source or destination.

Available since: 1.6.0

fu_firmware_get_id

Gets the image ID, typically set at construction.

Available since: 1.6.0

fu_firmware_get_idx

Gets the index of the image which is used for ordering.

Available since: 1.6.0

fu_firmware_get_image_by_checksum

Gets the firmware image using the image checksum. The checksum type is guessed based on the length of the input string.

Available since: 1.5.5

fu_firmware_get_image_by_gtype

Gets the firmware image using the image GType.

Available since: 1.9.3

fu_firmware_get_image_by_gtype_bytes

Gets the firmware image bytes using the image GType.

Available since: 1.9.3

fu_firmware_get_image_by_id

Gets the firmware image using the image ID.

Available since: 1.3.1

Class structure

struct FwupdPluginCfuOfferClass {
  FuFirmwareClass parent_class;
  
}
Class members
parent_class
FuFirmwareClass
  No description available.