From aa4a31e3489b73623372656572c50f84a8044404 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Thu, 2 Jul 2009 08:52:18 +0000 Subject: Update code comments according to intel framework specification. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8724 6f19259b-4bc3-4df7-8a09-765794883524 --- IntelFrameworkPkg/Include/Guid/Capsule.h | 80 ++++++++++++++++++++++++++++---- 1 file changed, 70 insertions(+), 10 deletions(-) (limited to 'IntelFrameworkPkg/Include/Guid') diff --git a/IntelFrameworkPkg/Include/Guid/Capsule.h b/IntelFrameworkPkg/Include/Guid/Capsule.h index dc9d2be42b..90c82cb20e 100644 --- a/IntelFrameworkPkg/Include/Guid/Capsule.h +++ b/IntelFrameworkPkg/Include/Guid/Capsule.h @@ -1,5 +1,5 @@ /** @file - GUIDs used for EFI Capsule + Framework Capule related Definition. Copyright (c) 2007 - 2009, Intel Corporation All rights reserved. This program and the accompanying materials @@ -10,11 +10,8 @@ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. - Module Name: Capsule.h - @par Revision Reference: - GUIDs defined in Capsule Spec Version 0.9 - + Capsule Spec Version 0.9 **/ #ifndef _CAPSULE_GUID_H__ @@ -39,11 +36,11 @@ 0x98B8D59B, 0xE8BA, 0x48EE, {0x98, 0xDD, 0xC2, 0x95, 0x39, 0x2F, 0x1E, 0xDB } \ } -// -// Bits in the flags field of the capsule header -// -#define EFI_CAPSULE_HEADER_FLAG_SETUP 0x00000001 // supports setup changes - +/// +/// Bits in the flags field of the capsule header +/// This flag is set if the capsule can support setup changes and clear if it cannot. +/// +#define EFI_CAPSULE_HEADER_FLAG_SETUP 0x00000001 #define CAPSULE_BLOCK_DESCRIPTOR_SIGNATURE SIGNATURE_32 ('C', 'B', 'D', 'S') @@ -67,19 +64,82 @@ typedef struct { } EFI_CAPSULE_OEM_HEADER; typedef struct { + /// + /// A defined GUID that indicates the start of a capsule. + /// EFI_GUID CapsuleGuid; + /// + /// The size of the EFI_CAPSULE_HEADER structure. + /// UINT32 HeaderSize; + /// + /// A bit-mapped list describing the capsule¡¯s attributes. + /// All undefined bits should be written as zero (0) + /// UINT32 Flags; + /// + /// The length in bytes (27,415 for an image containing 27,415 bytes) of the entire image + /// including all headers. If the this value is greater than the size of the data presented in + /// the capsule body, this means that the image is separated across multiple media. If this + /// value is less than the size of the data, it is an error. + /// UINT32 CapsuleImageSize; + /// + /// 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. + /// UINT32 SequenceNumber; + /// + /// 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. + /// EFI_GUID InstanceId; + /// + /// 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. + /// UINT32 OffsetToSplitInformation; + /// + /// 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. + /// UINT32 OffsetToCapsuleBody; + /// + /// 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. + /// UINT32 OffsetToOemDefinedHeader; + /// + /// 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. + /// UINT32 OffsetToAuthorInformation; + /// + /// 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. + /// UINT32 OffsetToRevisionInformation; + /// + /// 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. + /// UINT32 OffsetToShortDescription; + /// + /// The offset in bytes from the beginning of the header to the start of an EFI string + /// UINT32 OffsetToLongDescription; + /// + /// This field is reserved for future use by this specification. For future compatibility, + /// this field must be set to zero + /// UINT32 OffsetToApplicableDevices; } FRAMEWORK_EFI_CAPSULE_HEADER; -- cgit v1.2.3