FRAMEWORK_EFI_CAPSULE_HEADER Struct Reference


Data Fields

EFI_GUID CapsuleGuid
UINT32 HeaderSize
UINT32 Flags
UINT32 CapsuleImageSize
UINT32 SequenceNumber
EFI_GUID InstanceId
UINT32 OffsetToSplitInformation
UINT32 OffsetToCapsuleBody
UINT32 OffsetToOemDefinedHeader
UINT32 OffsetToAuthorInformation
UINT32 OffsetToRevisionInformation
UINT32 OffsetToShortDescription
UINT32 OffsetToLongDescription
UINT32 OffsetToApplicableDevices

Field Documentation

A defined GUID that indicates the start of a capsule.

The length in bytes (27,415 for an image containing 27,415 bytes) of the entire image including all headers. If this value is greater than the size of the data presented in the capsule body, the image is separated across multiple media. If this value is less than the size of the data, it is an error.

A bit-mapped list describing the capsule's attributes. All undefined bits should be written as zero (0).

The size of the EFI_CAPSULE_HEADER structure.

Used to group the various pieces of a split capsule to ensure that they comprise the same base image. It is valid for this item to be zero, in which case the capsule cannot be split into components.

This field is reserved for future use by this specification. For future compatibility, this field must be set to zero

The offset in bytes from the beginning of the header to the start of human-readable text that describes the entity that created the capsule. This value must be less than OffsetToCapsuleBody.

The offset in bytes from the beginning of the header to the start of the part of the capsule that is to be transferred to DXE.

The offset in bytes from the beginning of the header to the start of an EFI string

The offset in bytes from the beginning of the header to the start of the OEM-defined header. This value must be less than OffsetToCapsuleBody.

The offset in bytes from the beginning of the header to the start of human-readable text that describes the revision of the capsule and/or the capsule's contents. This value must be less than OffsetToCapsuleBody.

The offset in bytes from the beginning of the header to the start of a one-line (less than 40 Unicode characters in any language) description of the capsule. It is intended to be used by OS-present applications when providing a list of capsules from which the user can choose. This value must be less than OffsetToCapsuleBody.

The offset in bytes from the beginning of the header to the start of an EFI string that contains a description of the identity of the subcapsules that make up the capsule. If the capsule is not split, this value should be zero. The same string should be presented for all subcapsules that constitute the same capsule.

A zero-based number that enables a capsule to be split into pieces and then recombined for easier transfer across media with limited size. The lower the SequenceNumber, the earlier in the final image that the part of the capsule is to appear. In capsules that are not split, this value shall be zero.


Generated on Wed Sep 2 13:08:33 2015 for IntelFrameworkPkg[ALL] by  doxygen 1.5.7.1