EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER Struct Reference

Data Fields
UINT32	Version
EFI_GUID	UpdateImageTypeId
UINT8	UpdateImageIndex
UINT8	reserved_bytes [3]
UINT32	UpdateImageSize
UINT32	UpdateVendorCodeSize
UINT64	UpdateHardwareInstance
UINT64	ImageCapsuleSupport

Field Documentation

UINT64 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::ImageCapsuleSupport

A 64-bit bitmask that determines what sections are added to the payload. #define CAPSULE_SUPPORT_AUTHENTICATION 0x0000000000000001 #define CAPSULE_SUPPORT_DEPENDENCY 0x0000000000000002

UINT8 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::reserved_bytes[3]

UINT64 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::UpdateHardwareInstance

The HardwareInstance to target with this update. If value is zero it means match all HardwareInstances. This field allows update software to target only a single device in cases where there are more than one device with the same ImageTypeId GUID. This header is outside the signed data of the Authentication Info structure and therefore can be modified without changing the Auth data.

UINT8 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::UpdateImageIndex

Passed as ImageIndex in call to EFI_FIRMWARE_MANAGEMENT_PROTOCOL.SetImage()

UINT32 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::UpdateImageSize

Size of the binary update image which immediately follows this structure

EFI_GUID EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::UpdateImageTypeId

Used to identify device firmware targeted by this update. This guid is matched by system firmware against ImageTypeId field within a EFI_FIRMWARE_IMAGE_DESCRIPTOR

UINT32 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::UpdateVendorCodeSize

Size of the VendorCode bytes which optionally immediately follow binary update image in the capsule

UINT32 EFI_FIRMWARE_MANAGEMENT_CAPSULE_IMAGE_HEADER::Version