XenevaOS
Loading...
Searching...
No Matches
Public Attributes | List of all members
EFI_FIRMWARE_IMAGE_DESCRIPTOR Struct Reference

#include <FirmwareManagement.h>

Collaboration diagram for EFI_FIRMWARE_IMAGE_DESCRIPTOR:
Collaboration graph
[legend]

Public Attributes

UINT8 ImageIndex
 
EFI_GUID ImageTypeId
 
UINT64 ImageId
 
CHAR16ImageIdName
 
UINT32 Version
 
CHAR16VersionName
 
UINTN Size
 
UINT64 AttributesSupported
 
UINT64 AttributesSetting
 
UINT64 Compatibilities
 
UINT32 LowestSupportedImageVersion
 
UINT32 LastAttemptVersion
 
UINT32 LastAttemptStatus
 
UINT64 HardwareInstance
 

Detailed Description

EFI_FIRMWARE_IMAGE_DESCRIPTOR

Member Data Documentation

◆ AttributesSetting

UINT64 EFI_FIRMWARE_IMAGE_DESCRIPTOR::AttributesSetting

Image attributes. See 'Image Attribute Definitions' for possible returned values of this parameter.

◆ AttributesSupported

UINT64 EFI_FIRMWARE_IMAGE_DESCRIPTOR::AttributesSupported

Image attributes that are supported by this device. See 'Image Attribute Definitions' for possible returned values of this parameter. A value of 1 indicates the attribute is supported and the current setting value is indicated in AttributesSetting. A value of 0 indicates the attribute is not supported and the current setting value in AttributesSetting is meaningless.

◆ Compatibilities

UINT64 EFI_FIRMWARE_IMAGE_DESCRIPTOR::Compatibilities

Image compatibilities. See 'Image Compatibility Definitions' for possible returned values of this parameter.

◆ HardwareInstance

UINT64 EFI_FIRMWARE_IMAGE_DESCRIPTOR::HardwareInstance

An optional number to identify the unique hardware instance within the system for devices that may have multiple instances (Example: a plug in pci network card). This number must be unique within the namespace of the ImageTypeId GUID and ImageIndex. For FMP instances that have multiple descriptors for a single hardware instance, all descriptors must have the same HardwareInstance value. This number must be consistent between boots and should be based on some sort of hardware identified unique id (serial number, etc) whenever possible. If a hardware based number is not available the FMP provider may use some other characteristic such as device path, bus/dev/function, slot num, etc for generating the HardwareInstance. For implementations that will never have more than one instance a zero can be used. A zero means the FMP provider is not able to determine a unique hardware instance number or a hardware instance number is not needed. Only present in version 3 or higher.

◆ ImageId

UINT64 EFI_FIRMWARE_IMAGE_DESCRIPTOR::ImageId

A unique number identifying the firmware image.

◆ ImageIdName

CHAR16* EFI_FIRMWARE_IMAGE_DESCRIPTOR::ImageIdName

A pointer to a null-terminated string representing the firmware image name.

◆ ImageIndex

UINT8 EFI_FIRMWARE_IMAGE_DESCRIPTOR::ImageIndex

A unique number identifying the firmware image within the device. The number is between 1 and DescriptorCount.

◆ ImageTypeId

EFI_GUID EFI_FIRMWARE_IMAGE_DESCRIPTOR::ImageTypeId

A unique GUID identifying the firmware image type.

◆ LastAttemptStatus

UINT32 EFI_FIRMWARE_IMAGE_DESCRIPTOR::LastAttemptStatus

Describes the status that was last attempted to update. If no update has been attempted the value will be LAST_ATTEMPT_STATUS_SUCCESS. Only present in version 3 or higher.

◆ LastAttemptVersion

UINT32 EFI_FIRMWARE_IMAGE_DESCRIPTOR::LastAttemptVersion

Describes the version that was last attempted to update. If no update attempted the value will be 0. If the update attempted was improperly formatted and no version number was available then the value will be zero. Only present in version 3 or higher.

◆ LowestSupportedImageVersion

UINT32 EFI_FIRMWARE_IMAGE_DESCRIPTOR::LowestSupportedImageVersion

Describes the lowest ImageDescriptor version that the device will accept. Only present in version 2 or higher.

◆ Size

UINTN EFI_FIRMWARE_IMAGE_DESCRIPTOR::Size

Size of the image in bytes. If size=0, then only ImageIndex and ImageTypeId are valid.

◆ Version

UINT32 EFI_FIRMWARE_IMAGE_DESCRIPTOR::Version

Identifies the version of the device firmware. The format is vendor specific and new version must have a greater value than an old version.

◆ VersionName

CHAR16* EFI_FIRMWARE_IMAGE_DESCRIPTOR::VersionName

A pointer to a null-terminated string representing the firmware image version name.


The documentation for this struct was generated from the following file: