diff --git a/MdePkg/Include/Guid/WinCertificate.h b/MdePkg/Include/Guid/WinCertificate.h index 9d60262fd0..317dad97b5 100644 --- a/MdePkg/Include/Guid/WinCertificate.h +++ b/MdePkg/Include/Guid/WinCertificate.h @@ -1,14 +1,14 @@ /** @file - GUID for UEFI WIN_CERTIFICATE structure. + GUID for UEFI WIN_CERTIFICATE structure. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: GUID defined in UEFI 2.0 spec. @@ -19,7 +19,7 @@ // // _WIN_CERTIFICATE.wCertificateType -// +// #define WIN_CERT_TYPE_PKCS_SIGNED_DATA 0x0002 #define WIN_CERT_TYPE_EFI_PKCS115 0x0EF0 #define WIN_CERT_TYPE_EFI_GUID 0x0EF1 @@ -29,23 +29,23 @@ /// typedef struct { /// - /// The length of the entire certificate, - /// including the length of the header, in bytes. + /// The length of the entire certificate, + /// including the length of the header, in bytes. /// UINT32 dwLength; /// - /// The revision level of the WIN_CERTIFICATE - /// structure. The current revision level is 0x0200. + /// The revision level of the WIN_CERTIFICATE + /// structure. The current revision level is 0x0200. /// UINT16 wRevision; /// - /// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI - /// certificate types. The UEFI specification reserves the range of - /// certificate type values from 0x0EF0 to 0x0EFF. + /// The certificate type. See WIN_CERT_TYPE_xxx for the UEFI + /// certificate types. The UEFI specification reserves the range of + /// certificate type values from 0x0EF0 to 0x0EFF. /// UINT16 wCertificateType; /// - /// The following is the actual certificate. The format of + /// The following is the actual certificate. The format of /// the certificate depends on wCertificateType. /// /// UINT8 bCertificate[ANYSIZE_ARRAY]; @@ -54,13 +54,13 @@ typedef struct { /// /// WIN_CERTIFICATE_UEFI_GUID.CertType -/// +/// #define EFI_CERT_TYPE_RSA2048_SHA256_GUID \ {0xa7717414, 0xc616, 0x4977, {0x94, 0x20, 0x84, 0x47, 0x12, 0xa7, 0x35, 0xbf } } /// /// WIN_CERTIFICATE_UEFI_GUID.CertData -/// +/// typedef struct { EFI_GUID HashType; UINT8 PublicKey[256]; @@ -74,17 +74,17 @@ typedef struct { typedef struct { /// /// This is the standard WIN_CERTIFICATE header, where - /// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID. - /// + /// wCertificateType is set to WIN_CERT_TYPE_EFI_GUID. + /// WIN_CERTIFICATE Hdr; /// - /// This is the unique id which determines the + /// This is the unique id which determines the /// format of the CertData. . /// EFI_GUID CertType; - /// + /// /// The following is the certificate data. The format of - /// the data is determined by the CertType. + /// the data is determined by the CertType. /// If CertType is EFI_CERT_TYPE_RSA2048_SHA256_GUID, /// the CertData will be EFI_CERT_BLOCK_RSA_2048_SHA256 structure. /// @@ -92,32 +92,32 @@ typedef struct { } WIN_CERTIFICATE_UEFI_GUID; -/// +/// /// Certificate which encapsulates the RSASSA_PKCS1-v1_5 digital signature. -/// +/// /// The WIN_CERTIFICATE_UEFI_PKCS1_15 structure is derived from -/// WIN_CERTIFICATE and encapsulate the information needed to -/// implement the RSASSA-PKCS1-v1_5 digital signature algorithm as -/// specified in RFC2437. -/// -typedef struct { +/// WIN_CERTIFICATE and encapsulate the information needed to +/// implement the RSASSA-PKCS1-v1_5 digital signature algorithm as +/// specified in RFC2437. +/// +typedef struct { /// - /// This is the standard WIN_CERTIFICATE header, where - /// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15. + /// This is the standard WIN_CERTIFICATE header, where + /// wCertificateType is set to WIN_CERT_TYPE_UEFI_PKCS1_15. /// WIN_CERTIFICATE Hdr; /// /// This is the hashing algorithm which was performed on the - /// UEFI executable when creating the digital signature. + /// UEFI executable when creating the digital signature. /// EFI_GUID HashAlgorithm; /// - /// The following is the actual digital signature. The - /// size of the signature is the same size as the key - /// (1024-bit key is 128 bytes) and can be determined by + /// The following is the actual digital signature. The + /// size of the signature is the same size as the key + /// (1024-bit key is 128 bytes) and can be determined by /// subtracting the length of the other parts of this header - /// from the total length of the certificate as found in - /// Hdr.dwLength. + /// from the total length of the certificate as found in + /// Hdr.dwLength. /// /// UINT8 Signature[]; /// diff --git a/MdePkg/Include/Library/HobLib.h b/MdePkg/Include/Library/HobLib.h index c990076a95..e28328fad6 100644 --- a/MdePkg/Include/Library/HobLib.h +++ b/MdePkg/Include/Library/HobLib.h @@ -3,9 +3,9 @@ and DXE module types. The HOB Library supports the efficient creation and searching of HOBs - defined in the PI Specification. - A HOB is a Hand-Off Block, defined in the Framework architecture, that - allows the PEI phase to pass information to the DXE phase. HOBs are position + defined in the PI Specification. + A HOB is a Hand-Off Block, defined in the Framework architecture, that + allows the PEI phase to pass information to the DXE phase. HOBs are position independent and can be relocated easily to different memory memory locations. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
@@ -26,15 +26,15 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. Returns the pointer to the HOB list. This function returns the pointer to first HOB in the list. - For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer + For PEI phase, the PEI service GetHobList() can be used to retrieve the pointer to the HOB list. For the DXE phase, the HOB list pointer can be retrieved through the EFI System Table by looking up theHOB list GUID in the System Configuration Table. - Since the System Configuration Table does not exist that the time the DXE Core is - launched, the DXE Core uses a global variable from the DXE Core Entry Point Library + Since the System Configuration Table does not exist that the time the DXE Core is + launched, the DXE Core uses a global variable from the DXE Core Entry Point Library to manage the pointer to the HOB list. - + If the pointer to the HOB list is NULL, then ASSERT(). - + @return The pointer to the HOB list. **/ @@ -47,12 +47,12 @@ GetHobList ( /** Returns the next instance of a HOB type from the starting HOB. - This function searches the first instance of a HOB type from the starting HOB pointer. + This function searches the first instance of a HOB type from the starting HOB pointer. If there does not exist such HOB type from the starting HOB pointer, it will return NULL. In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer unconditionally: it returns HobStart back if HobStart itself meets the requirement; caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart. - + If HobStart is NULL, then ASSERT(). @param Type The HOB type to return. @@ -71,9 +71,9 @@ GetNextHob ( /** Returns the first instance of a HOB type among the whole HOB list. - This function searches the first instance of a HOB type among the whole HOB list. - If there does not exist such HOB type in the HOB list, it will return NULL. - + This function searches the first instance of a HOB type among the whole HOB list. + If there does not exist such HOB type in the HOB list, it will return NULL. + If the pointer to the HOB list is NULL, then ASSERT(). @param Type The HOB type to return. @@ -89,17 +89,17 @@ GetFirstHob ( /** Returns the next instance of the matched GUID HOB from the starting HOB. - - This function searches the first instance of a HOB from the starting HOB pointer. - Such HOB should satisfy two conditions: - its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. - If there does not exist such HOB from the starting HOB pointer, it will return NULL. + + This function searches the first instance of a HOB from the starting HOB pointer. + Such HOB should satisfy two conditions: + its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. + If there does not exist such HOB from the starting HOB pointer, it will return NULL. Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE () to extract the data section and its size info respectively. In contrast with macro GET_NEXT_HOB(), this function does not skip the starting HOB pointer unconditionally: it returns HobStart back if HobStart itself meets the requirement; caller is required to use GET_NEXT_HOB() if it wishes to skip current HobStart. - + If Guid is NULL, then ASSERT(). If HobStart is NULL, then ASSERT(). @@ -118,14 +118,14 @@ GetNextGuidHob ( /** Returns the first instance of the matched GUID HOB among the whole HOB list. - - This function searches the first instance of a HOB among the whole HOB list. + + This function searches the first instance of a HOB among the whole HOB list. Such HOB should satisfy two conditions: its HOB type is EFI_HOB_TYPE_GUID_EXTENSION and its GUID Name equals to the input Guid. If there does not exist such HOB from the starting HOB pointer, it will return NULL. Caller is required to apply GET_GUID_HOB_DATA () and GET_GUID_HOB_DATA_SIZE () to extract the data section and its size info respectively. - + If the pointer to the HOB list is NULL, then ASSERT(). If Guid is NULL, then ASSERT(). @@ -143,11 +143,11 @@ GetFirstGuidHob ( /** Get the system boot mode from the HOB list. - This function returns the system boot mode information from the + This function returns the system boot mode information from the PHIT HOB in HOB list. If the pointer to the HOB list is NULL, then ASSERT(). - + @param VOID @return The Boot Mode. @@ -165,7 +165,7 @@ GetBootModeHob ( This function builds a HOB for a loaded PE32 module. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If ModuleName is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). @@ -190,7 +190,7 @@ BuildModuleHob ( This function builds a HOB that describes a chunk of system memory. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param ResourceType The type of resource described by this HOB. @@ -209,15 +209,15 @@ BuildResourceDescriptorHob ( ); /** - Builds a customized HOB tagged with a GUID for identification and returns + Builds a customized HOB tagged with a GUID for identification and returns the start address of GUID HOB data. - This function builds a customized HOB tagged with a GUID for identification - and returns the start address of GUID HOB data so that caller can fill the customized data. + This function builds a customized HOB tagged with a GUID for identification + and returns the start address of GUID HOB data so that caller can fill the customized data. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If Guid is NULL, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). If DataLength > (0xFFF8 - sizeof (EFI_HOB_GUID_TYPE)), then ASSERT(). @@ -238,16 +238,16 @@ BuildGuidHob ( ); /** - Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB + Builds a customized HOB tagged with a GUID for identification, copies the input data to the HOB data field, and returns the start address of the GUID HOB data. This function builds a customized HOB tagged with a GUID for identification and copies the input - data to the HOB data field and returns the start address of the GUID HOB data. It can only be - invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. + data to the HOB data field and returns the start address of the GUID HOB data. It can only be + invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. The HOB Header and Name field is already stripped. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If Guid is NULL, then ASSERT(). If Data is NULL and DataLength > 0, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). @@ -276,7 +276,7 @@ BuildGuidDataHob ( This function builds a Firmware Volume HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param BaseAddress The base address of the Firmware Volume. @@ -296,14 +296,14 @@ BuildFvHob ( This function builds a EFI_HOB_TYPE_FV2 HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param BaseAddress The base address of the Firmware Volume. @param Length The size of the Firmware Volume in bytes. @param FvName The name of the Firmware Volume. @param FileName The name of the file. - + **/ VOID EFIAPI @@ -320,7 +320,7 @@ BuildFv2Hob ( This function builds a Capsule Volume HOB. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If the platform does not support Capsule Volume HOBs, then ASSERT(). If there is no additional space for HOB creation, then ASSERT(). @@ -341,7 +341,7 @@ BuildCvHob ( This function builds a HOB for the CPU. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param SizeOfMemorySpace The maximum physical memory addressability of the processor. @@ -361,7 +361,7 @@ BuildCpuHob ( This function builds a HOB for the stack. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param BaseAddress The 64 bit physical address of the Stack. @@ -381,7 +381,7 @@ BuildStackHob ( This function builds a HOB for BSP store. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param BaseAddress The 64 bit physical address of the BSP. @@ -403,7 +403,7 @@ BuildBspStoreHob ( This function builds a HOB for the memory allocation. It can only be invoked during PEI phase; for DXE phase, it will ASSERT() since PEI HOB is read-only for DXE phase. - + If there is no additional space for HOB creation, then ASSERT(). @param BaseAddress The 64 bit physical address of the memory. @@ -422,13 +422,13 @@ BuildMemoryAllocationHob ( /** Returns the type of a HOB. - This macro returns the HobType field from the HOB header for the + This macro returns the HobType field from the HOB header for the HOB specified by HobStart. @param HobStart A pointer to a HOB. - + @return HobType. - + **/ #define GET_HOB_TYPE(HobStart) \ ((*(EFI_HOB_GENERIC_HEADER **)&(HobStart))->HobType) @@ -436,7 +436,7 @@ BuildMemoryAllocationHob ( /** Returns the length, in bytes, of a HOB. - This macro returns the HobLength field from the HOB header for the + This macro returns the HobLength field from the HOB header for the HOB specified by HobStart. @param HobStart A pointer to a HOB. @@ -450,7 +450,7 @@ BuildMemoryAllocationHob ( /** Returns a pointer to the next HOB in the HOB list. - This macro returns a pointer to HOB that follows the + This macro returns a pointer to HOB that follows the HOB specified by HobStart in the HOB List. @param HobStart A pointer to a HOB. @@ -463,9 +463,9 @@ BuildMemoryAllocationHob ( /** Determines if a HOB is the last HOB in the HOB list. - - This macro determine if the HOB specified by HobStart is the - last HOB in the HOB list. If HobStart is last HOB in the HOB list, + + This macro determine if the HOB specified by HobStart is the + last HOB in the HOB list. If HobStart is last HOB in the HOB list, then TRUE is returned. Otherwise, FALSE is returned. @param HobStart A pointer to a HOB. @@ -480,12 +480,12 @@ BuildMemoryAllocationHob ( Returns a pointer to data buffer from a HOB of type EFI_HOB_TYPE_GUID_EXTENSION. This macro returns a pointer to the data buffer in a HOB specified by HobStart. - HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION. + HobStart is assumed to be a HOB of type EFI_HOB_TYPE_GUID_EXTENSION. @param GuidHob A pointer to a HOB. @return A pointer to the data buffer in a HOB. - + **/ #define GET_GUID_HOB_DATA(HobStart) \ (VOID *)(*(UINT8 **)&(HobStart) + sizeof (EFI_HOB_GUID_TYPE)) diff --git a/MdePkg/Include/Pi/PiBootMode.h b/MdePkg/Include/Pi/PiBootMode.h index 53986861b9..b5ef2eb4c5 100644 --- a/MdePkg/Include/Pi/PiBootMode.h +++ b/MdePkg/Include/Pi/PiBootMode.h @@ -2,13 +2,13 @@ Present the boot mode values in PI. Copyright (c) 2006 - 2012, Intel Corporation. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.2.1A @@ -20,12 +20,12 @@ /// /// EFI boot mode -/// +/// typedef UINT32 EFI_BOOT_MODE; // // 0x21 - 0xf..f are reserved. -// +// #define BOOT_WITH_FULL_CONFIGURATION 0x00 #define BOOT_WITH_MINIMAL_CONFIGURATION 0x01 #define BOOT_ASSUMING_NO_CONFIGURATION_CHANGES 0x02 diff --git a/MdePkg/Include/Pi/PiFirmwareFile.h b/MdePkg/Include/Pi/PiFirmwareFile.h index 3e020b4208..1f94429188 100644 --- a/MdePkg/Include/Pi/PiFirmwareFile.h +++ b/MdePkg/Include/Pi/PiFirmwareFile.h @@ -2,13 +2,13 @@ The firmware file related definitions in PI. Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
-This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. +http://opensource.org/licenses/bsd-license.php. -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.2. @@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #pragma pack(1) /// /// Used to verify the integrity of the file. -/// +/// typedef union { struct { /// @@ -60,7 +60,7 @@ typedef UINT8 EFI_FFS_FILE_STATE; /// /// File Types Definitions -/// +/// #define EFI_FV_FILETYPE_ALL 0x00 #define EFI_FV_FILETYPE_RAW 0x01 #define EFI_FV_FILETYPE_FREEFORM 0x02 @@ -82,17 +82,17 @@ typedef UINT8 EFI_FFS_FILE_STATE; #define EFI_FV_FILETYPE_FFS_MIN 0xf0 #define EFI_FV_FILETYPE_FFS_MAX 0xff #define EFI_FV_FILETYPE_FFS_PAD 0xf0 -/// +/// /// FFS File Attributes. -/// +/// #define FFS_ATTRIB_LARGE_FILE 0x01 #define FFS_ATTRIB_FIXED 0x04 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38 #define FFS_ATTRIB_CHECKSUM 0x40 -/// +/// /// FFS File State Bits. -/// +/// #define EFI_FILE_HEADER_CONSTRUCTION 0x01 #define EFI_FILE_HEADER_VALID 0x02 #define EFI_FILE_DATA_VALID 0x04 @@ -102,9 +102,9 @@ typedef UINT8 EFI_FFS_FILE_STATE; /// -/// Each file begins with the header that describe the +/// Each file begins with the header that describe the /// contents and state of the files. -/// +/// typedef struct { /// /// This GUID is the file name. It is used to uniquely identify the file. @@ -139,22 +139,22 @@ typedef struct { /// volume, except if the file type is EFI_FV_FILETYPE_FFS_PAD. /// EFI_GUID Name; - + /// /// Used to verify the integrity of the file. - /// + /// EFI_FFS_INTEGRITY_CHECK IntegrityCheck; - + /// /// Identifies the type of file. - /// + /// EFI_FV_FILETYPE Type; - + /// /// Declares various file attribute bits. - /// + /// EFI_FFS_FILE_ATTRIBUTES Attributes; - + /// /// The length of the file in bytes, including the FFS header. /// The length of the file data is either (Size - sizeof(EFI_FFS_FILE_HEADER)). This calculation means a @@ -163,12 +163,12 @@ typedef struct { /// located at the next 8-byte aligned firmware volume offset following the last byte of the file F. /// UINT8 Size[3]; - + /// /// Used to track the state of the file throughout the life of the file from creation to deletion. /// EFI_FFS_FILE_STATE State; - + /// /// If FFS_ATTRIB_LARGE_FILE is set in Attributes, then ExtendedSize exists and Size must be set to zero. /// If FFS_ATTRIB_LARGE_FILE is not set then EFI_FFS_FILE_HEADER is used. @@ -220,10 +220,10 @@ typedef UINT8 EFI_SECTION_TYPE; /// /// Common section header. -/// +/// typedef struct { /// - /// A 24-bit unsigned integer that contains the total size of the section in bytes, + /// A 24-bit unsigned integer that contains the total size of the section in bytes, /// including the EFI_COMMON_SECTION_HEADER. /// UINT8 Size[3]; @@ -235,36 +235,36 @@ typedef struct { typedef struct { /// - /// A 24-bit unsigned integer that contains the total size of the section in bytes, + /// A 24-bit unsigned integer that contains the total size of the section in bytes, /// including the EFI_COMMON_SECTION_HEADER. /// UINT8 Size[3]; - + EFI_SECTION_TYPE Type; - + /// /// If Size is 0xFFFFFF, then ExtendedSize contains the size of the section. If - /// Size is not equal to 0xFFFFFF, then this field does not exist. + /// Size is not equal to 0xFFFFFF, then this field does not exist. /// UINT32 ExtendedSize; } EFI_COMMON_SECTION_HEADER2; /// -/// Leaf section type that contains an +/// Leaf section type that contains an /// IA-32 16-bit executable image. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_COMPATIBILITY16_SECTION2; /// /// CompressionType of EFI_COMPRESSION_SECTION. -/// +/// #define EFI_NOT_COMPRESSED 0x00 #define EFI_STANDARD_COMPRESSION 0x01 /// -/// An encapsulation section type in which the +/// An encapsulation section type in which the /// section data is compressed. -/// +/// typedef struct { /// /// Usual common section header. CommonHeader.Type = EFI_SECTION_COMPRESSION. @@ -309,19 +309,19 @@ typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2; /// /// The leaf section which could be used to determine the dispatch order of DXEs. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_DXE_DEPEX_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_DXE_DEPEX_SECTION2; /// /// The leaf section which contains a PI FV. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_FIRMWARE_VOLUME_IMAGE_SECTION2; /// /// The leaf section which contains a single GUID. -/// +/// typedef struct { /// /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID. @@ -340,18 +340,18 @@ typedef struct { EFI_COMMON_SECTION_HEADER2 CommonHeader; /// /// This GUID is defined by the creator of the file. It is a vendor-defined file type. - /// + /// EFI_GUID SubTypeGuid; } EFI_FREEFORM_SUBTYPE_GUID_SECTION2; /// /// Attributes of EFI_GUID_DEFINED_SECTION. -/// +/// #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02 /// /// The leaf section which is encapsulation defined by specific GUID. -/// +/// typedef struct { /// /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED. @@ -378,27 +378,27 @@ typedef struct { EFI_COMMON_SECTION_HEADER2 CommonHeader; /// /// The GUID that defines the format of the data that follows. It is a vendor-defined section type. - /// + /// EFI_GUID SectionDefinitionGuid; /// /// Contains the offset in bytes from the beginning of the common header to the first byte of the data. - /// + /// UINT16 DataOffset; /// /// The bit field that declares some specific characteristics of the section contents. - /// + /// UINT16 Attributes; } EFI_GUID_DEFINED_SECTION2; /// /// The leaf section which contains PE32+ image. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2; /// /// The leaf section used to determine the dispatch order of PEIMs. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_PEI_DEPEX_SECTION2; @@ -416,37 +416,37 @@ typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2; /// /// The leaf section which constains the position-independent-code image. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_TE_SECTION2; /// /// The leaf section which contains an array of zero or more bytes. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_RAW_SECTION2; -/// +/// /// The SMM dependency expression section is a leaf section that contains a dependency expression that /// is used to determine the dispatch order for SMM drivers. Before the SMRAM invocation of the /// SMM driver's entry point, this dependency expression must evaluate to TRUE. See the Platform /// Initialization Specification, Volume 2, for details regarding the format of the dependency expression. /// The dependency expression may refer to protocols installed in either the UEFI or the SMM protocol /// database. EFI_SMM_DEPEX_SECTION2 must be used if the section is 16MB or larger. -/// +/// typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2; /// -/// The leaf section which contains a unicode string that +/// The leaf section which contains a unicode string that /// is human readable file name. -/// +/// typedef struct { EFI_COMMON_SECTION_HEADER CommonHeader; /// /// Array of unicode string. - /// + /// CHAR16 FileNameString[1]; } EFI_USER_INTERFACE_SECTION; @@ -457,15 +457,15 @@ typedef struct { /// /// The leaf section which contains a numeric build number and -/// an optional unicode string that represents the file revision. -/// +/// an optional unicode string that represents the file revision. +/// typedef struct { EFI_COMMON_SECTION_HEADER CommonHeader; UINT16 BuildNumber; /// /// Array of unicode string. - /// + /// CHAR16 VersionString[1]; } EFI_VERSION_SECTION; diff --git a/MdePkg/Include/Pi/PiFirmwareVolume.h b/MdePkg/Include/Pi/PiFirmwareVolume.h index 7aa2e5e016..79fde13190 100644 --- a/MdePkg/Include/Pi/PiFirmwareVolume.h +++ b/MdePkg/Include/Pi/PiFirmwareVolume.h @@ -2,13 +2,13 @@ The firmware volume related definitions in PI. Copyright (c) 2006 - 2013, Intel Corporation. All rights reserved.
- This program and the accompanying materials - are licensed and made available under the terms and conditions of the BSD License - which accompanies this distribution. The full text of the license may be found at - http://opensource.org/licenses/bsd-license.php + This program and the accompanying materials + are licensed and made available under the terms and conditions of the BSD License + which accompanies this distribution. The full text of the license may be found at + http://opensource.org/licenses/bsd-license.php - THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, - WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, + WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.3 @@ -25,19 +25,19 @@ typedef UINT32 EFI_FV_FILE_ATTRIBUTES; // // Value of EFI_FV_FILE_ATTRIBUTES. -// +// #define EFI_FV_FILE_ATTRIB_ALIGNMENT 0x0000001F #define EFI_FV_FILE_ATTRIB_FIXED 0x00000100 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200 /// /// type of EFI FVB attribute -/// +/// typedef UINT32 EFI_FVB_ATTRIBUTES_2; -// +// // Attributes bit definitions -// +// #define EFI_FVB2_READ_DISABLED_CAP 0x00000001 #define EFI_FVB2_READ_ENABLED_CAP 0x00000002 #define EFI_FVB2_READ_STATUS 0x00000004 @@ -104,7 +104,7 @@ typedef struct { /// typedef struct { /// - /// The first 16 bytes are reserved to allow for the reset vector of + /// The first 16 bytes are reserved to allow for the reset vector of /// processors whose reset vector is at address 0. /// UINT8 ZeroVector[16]; @@ -162,7 +162,7 @@ typedef struct { /// /// Extension header pointed by ExtHeaderOffset of volume header. -/// +/// typedef struct { /// /// Firmware volume name. @@ -176,7 +176,7 @@ typedef struct { /// /// Entry struture for describing FV extension header -/// +/// typedef struct { /// /// Size of this header extension. @@ -191,7 +191,7 @@ typedef struct { #define EFI_FV_EXT_TYPE_OEM_TYPE 0x01 /// /// This extension header provides a mapping between a GUID and an OEM file type. -/// +/// typedef struct { /// /// Standard extension entry, with the type EFI_FV_EXT_TYPE_OEM_TYPE. @@ -204,7 +204,7 @@ typedef struct { UINT32 TypeMask; /// /// An array of GUIDs, each GUID representing an OEM file type. - /// + /// /// EFI_GUID Types[1]; /// } EFI_FIRMWARE_VOLUME_EXT_ENTRY_OEM_TYPE; diff --git a/MdePkg/Include/Pi/PiHob.h b/MdePkg/Include/Pi/PiHob.h index 7d9169f496..9c65d5b12b 100644 --- a/MdePkg/Include/Pi/PiHob.h +++ b/MdePkg/Include/Pi/PiHob.h @@ -2,13 +2,13 @@ HOB related definitions in PI. Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
-This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. +http://opensource.org/licenses/bsd-license.php. -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. @par Revision Reference: PI Version 1.0 @@ -20,7 +20,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. // // HobType of EFI_HOB_GENERIC_HEADER. -// +// #define EFI_HOB_TYPE_HANDOFF 0x0001 #define EFI_HOB_TYPE_MEMORY_ALLOCATION 0x0002 #define EFI_HOB_TYPE_RESOURCE_DESCRIPTOR 0x0003 @@ -35,9 +35,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF /// -/// Describes the format and size of the data inside the HOB. +/// Describes the format and size of the data inside the HOB. /// All HOBs must contain this generic HOB header. -/// +/// typedef struct { /// /// Identifies the HOB data structure type. @@ -56,13 +56,13 @@ typedef struct { /// /// Value of version in EFI_HOB_HANDOFF_INFO_TABLE. -/// +/// #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009 /// -/// Contains general state information used by the HOB producer phase. +/// Contains general state information used by the HOB producer phase. /// This HOB must be the first one in the HOB list. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_HANDOFF. @@ -70,7 +70,7 @@ typedef struct { EFI_HOB_GENERIC_HEADER Header; /// /// The version number pertaining to the PHIT HOB definition. - /// This value is four bytes in length to provide an 8-byte aligned entry + /// This value is four bytes in length to provide an 8-byte aligned entry /// when it is combined with the 4-byte BootMode. /// UINT32 Version; @@ -88,7 +88,7 @@ typedef struct { /// EFI_PHYSICAL_ADDRESS EfiMemoryBottom; /// - /// The highest address location of free memory that is currently available + /// The highest address location of free memory that is currently available /// for use by the HOB producer phase. /// EFI_PHYSICAL_ADDRESS EfiFreeMemoryTop; @@ -102,19 +102,19 @@ typedef struct { EFI_PHYSICAL_ADDRESS EfiEndOfHobList; } EFI_HOB_HANDOFF_INFO_TABLE; -/// +/// /// EFI_HOB_MEMORY_ALLOCATION_HEADER describes the /// various attributes of the logical memory allocation. The type field will be used for /// subsequent inclusion in the UEFI memory map. -/// +/// typedef struct { /// /// A GUID that defines the memory allocation region's type and purpose, as well as /// other fields within the memory allocation HOB. This GUID is used to define the /// additional data within the HOB that may be present for the memory allocation HOB. /// Type EFI_GUID is defined in InstallProtocolInterface() in the UEFI 2.0 - /// specification. - /// + /// specification. + /// EFI_GUID Name; /// @@ -124,16 +124,16 @@ typedef struct { /// EFI_PHYSICAL_ADDRESS MemoryBaseAddress; - /// + /// /// The length in bytes of memory allocated by this HOB. - /// + /// UINT64 MemoryLength; /// /// Defines the type of memory allocated by this HOB. The memory type definition /// follows the EFI_MEMORY_TYPE definition. Type EFI_MEMORY_TYPE is defined /// in AllocatePages() in the UEFI 2.0 specification. - /// + /// EFI_MEMORY_TYPE MemoryType; /// @@ -143,8 +143,8 @@ typedef struct { } EFI_HOB_MEMORY_ALLOCATION_HEADER; /// -/// Describes all memory ranges used during the HOB producer -/// phase that exist outside the HOB list. This HOB type +/// Describes all memory ranges used during the HOB producer +/// phase that exist outside the HOB list. This HOB type /// describes how memory is used, not the physical attributes of memory. /// typedef struct { @@ -165,10 +165,10 @@ typedef struct { /// -/// Describes the memory stack that is produced by the HOB producer +/// Describes the memory stack that is produced by the HOB producer /// phase and upon which all post-memory-installed executable /// content in the HOB producer phase is executing. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION. @@ -182,11 +182,11 @@ typedef struct { } EFI_HOB_MEMORY_ALLOCATION_STACK; /// -/// Defines the location of the boot-strap +/// Defines the location of the boot-strap /// processor (BSP) BSPStore ("Backing Store Pointer Store"). -/// This HOB is valid for the Itanium processor family only +/// This HOB is valid for the Itanium processor family only /// register overflow store. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_ALLOCATION. @@ -213,12 +213,12 @@ typedef struct { /// EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader; /// - /// The GUID specifying the values of the firmware file system name + /// The GUID specifying the values of the firmware file system name /// that contains the HOB consumer phase component. /// EFI_GUID ModuleName; /// - /// The address of the memory-mapped firmware volume + /// The address of the memory-mapped firmware volume /// that contains the HOB consumer phase firmware file. /// EFI_PHYSICAL_ADDRESS EntryPoint; @@ -226,12 +226,12 @@ typedef struct { /// /// The resource type. -/// +/// typedef UINT32 EFI_RESOURCE_TYPE; // // Value of ResourceType in EFI_HOB_RESOURCE_DESCRIPTOR. -// +// #define EFI_RESOURCE_SYSTEM_MEMORY 0x00000000 #define EFI_RESOURCE_MEMORY_MAPPED_IO 0x00000001 #define EFI_RESOURCE_IO 0x00000002 @@ -243,7 +243,7 @@ typedef UINT32 EFI_RESOURCE_TYPE; /// /// A type of recount attribute type. -/// +/// typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE; // @@ -277,10 +277,10 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE; #define EFI_RESOURCE_ATTRIBUTE_EXECUTION_PROTECTABLE 0x00400000 /// -/// Describes the resource properties of all fixed, +/// Describes the resource properties of all fixed, /// nonrelocatable resource ranges found on the processor /// host bus during the HOB producer phase. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_RESOURCE_DESCRIPTOR. @@ -300,7 +300,7 @@ typedef struct { /// EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute; /// - /// The physical start address of the resource region. + /// The physical start address of the resource region. /// EFI_PHYSICAL_ADDRESS PhysicalStart; /// @@ -310,9 +310,9 @@ typedef struct { } EFI_HOB_RESOURCE_DESCRIPTOR; /// -/// Allows writers of executable content in the HOB producer phase to +/// Allows writers of executable content in the HOB producer phase to /// maintain and manage HOBs with specific GUID. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_GUID_EXTENSION. @@ -329,7 +329,7 @@ typedef struct { /// /// Details the location of firmware volumes that contain firmware files. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV. @@ -346,9 +346,9 @@ typedef struct { } EFI_HOB_FIRMWARE_VOLUME; /// -/// Details the location of a firmware volume that was extracted +/// Details the location of a firmware volume that was extracted /// from a file within another firmware volume. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_FV2. @@ -398,7 +398,7 @@ typedef struct { /// /// Describes pool memory allocations. -/// +/// typedef struct { /// /// The HOB generic header. Header.HobType = EFI_HOB_TYPE_MEMORY_POOL. @@ -418,7 +418,7 @@ typedef struct { /// The HOB generic header where Header.HobType = EFI_HOB_TYPE_UEFI_CAPSULE. /// EFI_HOB_GENERIC_HEADER Header; - + /// /// The physical memory-mapped base address of an UEFI capsule. This value is set to /// point to the base of the contiguous memory of the UEFI capsule. @@ -449,4 +449,4 @@ typedef union { } EFI_PEI_HOB_POINTERS; -#endif +#endif diff --git a/MdePkg/Include/Uefi/UefiMultiPhase.h b/MdePkg/Include/Uefi/UefiMultiPhase.h index e0142710ef..a7a7dcf88c 100644 --- a/MdePkg/Include/Uefi/UefiMultiPhase.h +++ b/MdePkg/Include/Uefi/UefiMultiPhase.h @@ -2,13 +2,13 @@ This includes some definitions introduced in UEFI that will be used in both PEI and DXE phases. Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.
-This program and the accompanying materials are licensed and made available under -the terms and conditions of the BSD License that accompanies this distribution. +This program and the accompanying materials are licensed and made available under +the terms and conditions of the BSD License that accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php. - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +http://opensource.org/licenses/bsd-license.php. + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -18,14 +18,14 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #include /// /// Enumeration of memory types introduced in UEFI. -/// +/// typedef enum { /// /// Not used. /// EfiReservedMemoryType, /// - /// The code portions of a loaded application. + /// The code portions of a loaded application. /// (Note that UEFI OS loaders are UEFI applications.) /// EfiLoaderCode, @@ -87,7 +87,7 @@ typedef enum { /// /// Data structure that precedes all of the standard EFI table types. -/// +/// typedef struct { /// /// A 64-bit signature that identifies the type of table that follows. @@ -119,14 +119,14 @@ typedef struct { /// /// Attributes of variable. -/// +/// #define EFI_VARIABLE_NON_VOLATILE 0x00000001 #define EFI_VARIABLE_BOOTSERVICE_ACCESS 0x00000002 #define EFI_VARIABLE_RUNTIME_ACCESS 0x00000004 /// -/// This attribute is identified by the mnemonic 'HR' +/// This attribute is identified by the mnemonic 'HR' /// elsewhere in this specification. -/// +/// #define EFI_VARIABLE_HARDWARE_ERROR_RECORD 0x00000008 /// /// Attributes of Authenticated Variable @@ -136,7 +136,7 @@ typedef struct { #define EFI_VARIABLE_APPEND_WRITE 0x00000040 -/// +/// /// AuthInfo is a WIN_CERTIFICATE using the wCertificateType /// WIN_CERTIFICATE_UEFI_GUID and the CertType /// EFI_CERT_TYPE_RSA2048_SHA256_GUID. If the attribute specifies @@ -150,41 +150,41 @@ typedef struct { /// WIN_CERTIFICATE shall be used to describe the signature of the /// Variable data *Data. In addition, the signature will also /// include the MonotonicCount value to guard against replay attacks. -/// +/// typedef struct { /// - /// Included in the signature of + /// Included in the signature of /// AuthInfo.Used to ensure freshness/no - /// replay. Incremented during each - /// "Write" access. - /// + /// replay. Incremented during each + /// "Write" access. + /// UINT64 MonotonicCount; /// - /// Provides the authorization for the variable - /// access. It is a signature across the - /// variable data and the Monotonic Count - /// value. Caller uses Private key that is - /// associated with a public key that has been - /// provisioned via the key exchange. + /// Provides the authorization for the variable + /// access. It is a signature across the + /// variable data and the Monotonic Count + /// value. Caller uses Private key that is + /// associated with a public key that has been + /// provisioned via the key exchange. /// WIN_CERTIFICATE_UEFI_GUID AuthInfo; } EFI_VARIABLE_AUTHENTICATION; /// -/// When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is +/// When the attribute EFI_VARIABLE_TIME_BASED_AUTHENTICATED_WRITE_ACCESS is /// set, then the Data buffer shall begin with an instance of a complete (and serialized) -/// EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new -/// variable value and DataSize shall reflect the combined size of the descriptor and the new -/// variable value. The authentication descriptor is not part of the variable data and is not +/// EFI_VARIABLE_AUTHENTICATION_2 descriptor. The descriptor shall be followed by the new +/// variable value and DataSize shall reflect the combined size of the descriptor and the new +/// variable value. The authentication descriptor is not part of the variable data and is not /// returned by subsequent calls to GetVariable(). /// typedef struct { /// - /// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and + /// For the TimeStamp value, components Pad1, Nanosecond, TimeZone, Daylight and /// Pad2 shall be set to 0. This means that the time shall always be expressed in GMT. /// EFI_TIME TimeStamp; - /// + /// /// Only a CertType of EFI_CERT_TYPE_PKCS7_GUID is accepted. /// WIN_CERTIFICATE_UEFI_GUID AuthInfo;