4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Framework Capule related Definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncCopyright (c) 2007 - 2010, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThis program and the accompanying materials are licensed and made available under
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncthe terms and conditions of the BSD License that accompanies this distribution.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncThe full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncTHE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncWITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Capsule Spec Version 0.9
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This is the GUID of the capsule header of the image on disk.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x3B6686BD, 0x0D76, 0x4030, {0xB7, 0x0E, 0xB5, 0x51, 0x9E, 0x2F, 0xC5, 0xA0 } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// This is the GUID of the configuration results file created by the capsule
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// application.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0x98B8D59B, 0xE8BA, 0x48EE, {0x98, 0xDD, 0xC2, 0x95, 0x39, 0x2F, 0x1E, 0xDB } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// Bits in the flags field of the capsule header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// This flag is set if the capsule can support setup changes, and cleared if it cannot.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define CAPSULE_BLOCK_DESCRIPTOR_SIGNATURE SIGNATURE_32 ('C', 'B', 'D', 'S')
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// An array of these structs describe the blocks that make up a capsule for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync// a capsule update.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_PHYSICAL_ADDRESS Data; ///< Physical address of the data block.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync // UINT8 OemHdrData[];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A defined GUID that indicates the start of a capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of the EFI_CAPSULE_HEADER structure.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A bit-mapped list describing the capsule's attributes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// All undefined bits should be written as zero (0).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The length in bytes (27,415 for an image containing 27,415 bytes) of the entire image
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// including all headers. If this value is greater than the size of the data presented in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the capsule body, the image is separated across multiple media. If this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value is less than the size of the data, it is an error.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A zero-based number that enables a capsule to be split into pieces and then
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// recombined for easier transfer across media with limited size. The lower the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// SequenceNumber, the earlier in the final image that the part of the capsule is to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// appear. In capsules that are not split, this value shall be zero.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Used to group the various pieces of a split capsule to ensure that they comprise the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// same base image. It is valid for this item to be zero, in which case the capsule cannot
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// be split into components.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of an EFI string that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// contains a description of the identity of the subcapsules that make up the capsule. If
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the capsule is not split, this value should be zero. The same string should be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// presented for all subcapsules that constitute the same capsule.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of the part of the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// capsule that is to be transferred to DXE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of the OEM-defined
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// header. This value must be less than OffsetToCapsuleBody.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of human-readable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// text that describes the entity that created the capsule. This value must be less than OffsetToCapsuleBody.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of human-readable
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// text that describes the revision of the capsule and/or the capsule's contents. This
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value must be less than OffsetToCapsuleBody.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of a one-line (less
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// than 40 Unicode characters in any language) description of the capsule. It is intended
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to be used by OS-present applications when providing a list of capsules from which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the user can choose. This value must be less than OffsetToCapsuleBody.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The offset in bytes from the beginning of the header to the start of an EFI string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field is reserved for future use by this specification. For future compatibility,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// this field must be set to zero