diff options
author | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-03-12 22:19:12 +0000 |
---|---|---|
committer | myronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524> | 2010-03-12 22:19:12 +0000 |
commit | af2dc6a70b9380d702bd0720cdb029d630c505e3 (patch) | |
tree | c529d460dbe0b6adbf5b2177f4e532dbb27868d2 /MdePkg/Include/Pi | |
parent | 636f2be673b2f43518167d8fddae56b714f19314 (diff) | |
download | edk2-platforms-af2dc6a70b9380d702bd0720cdb029d630c505e3.tar.xz |
Grammatical and disclaimer changes (does not follow internal C coding stds.)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10235 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Pi')
-rw-r--r-- | MdePkg/Include/Pi/PiDxeCis.h | 34 | ||||
-rw-r--r-- | MdePkg/Include/Pi/PiFirmwareFile.h | 75 | ||||
-rw-r--r-- | MdePkg/Include/Pi/PiHob.h | 38 | ||||
-rw-r--r-- | MdePkg/Include/Pi/PiMultiPhase.h | 34 | ||||
-rw-r--r-- | MdePkg/Include/Pi/PiPeiCis.h | 101 | ||||
-rw-r--r-- | MdePkg/Include/Pi/PiStatusCode.h | 62 |
6 files changed, 173 insertions, 171 deletions
diff --git a/MdePkg/Include/Pi/PiDxeCis.h b/MdePkg/Include/Pi/PiDxeCis.h index b83c4f84b4..2a18459593 100644 --- a/MdePkg/Include/Pi/PiDxeCis.h +++ b/MdePkg/Include/Pi/PiDxeCis.h @@ -1,14 +1,14 @@ /** @file
Include file matches things in PI.
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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
@@ -22,7 +22,7 @@ #include <Pi/PiMultiPhase.h>
///
-/// Global Coherencey Domain types - Memory type
+/// Global Coherencey Domain types - Memory type.
///
typedef enum {
///
@@ -52,7 +52,7 @@ typedef enum { } EFI_GCD_MEMORY_TYPE;
///
-/// Global Coherencey Domain types - IO type
+/// Global Coherencey Domain types - IO type.
///
typedef enum {
///
@@ -106,13 +106,13 @@ typedef enum { } EFI_GCD_ALLOCATE_TYPE;
///
-/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR
+/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR.
///
typedef struct {
///
/// The physical address of the first byte in the memory region. Type
/// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
- /// description in the UEFI 2.0 specification
+ /// description in the UEFI 2.0 specification.
///
EFI_PHYSICAL_ADDRESS BaseAddress;
@@ -134,7 +134,7 @@ typedef struct { UINT64 Attributes;
///
/// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the
- /// AddMemorySpace() function description
+ /// AddMemorySpace() function description.
///
EFI_GCD_MEMORY_TYPE GcdMemoryType;
@@ -157,7 +157,7 @@ typedef struct { } EFI_GCD_MEMORY_SPACE_DESCRIPTOR;
///
-/// EFI_GCD_IO_SPACE_DESCRIPTOR
+/// EFI_GCD_IO_SPACE_DESCRIPTOR.
///
typedef struct {
///
@@ -225,7 +225,7 @@ typedef struct { added to the global coherency domain of the processor.
@retval EFI_ACCESS_DENIED One or more bytes of the memory resource range
specified by BaseAddress and Length was allocated
- in a prior call to AllocateMemorySpace()..
+ in a prior call to AllocateMemorySpace().
**/
typedef
@@ -580,7 +580,7 @@ EFI_STATUS @retval EFI_SUCCESS One or more DXE driver were dispatched.
@retval EFI_NOT_FOUND No DXE drivers were dispatched.
@retval EFI_ALREADY_STARTED An attempt is being made to start the DXE Dispatcher recursively.
- Thus no action was taken.
+ Thus, no action was taken.
**/
typedef
@@ -697,12 +697,12 @@ typedef DXE_SERVICES EFI_DXE_SERVICES; /**
- Function prototype for invoking a function on an Application Processor.
+ The function prototype for invoking a function on an Application Processor.
This definition is used by the UEFI MP Serices Protocol, and the
PI SMM System Table.
- @param[in,out] Buffer Pointer to private data buffer.
+ @param[in,out] Buffer The pointer to private data buffer.
**/
typedef
VOID
diff --git a/MdePkg/Include/Pi/PiFirmwareFile.h b/MdePkg/Include/Pi/PiFirmwareFile.h index 12e80fdd67..b2869dc8da 100644 --- a/MdePkg/Include/Pi/PiFirmwareFile.h +++ b/MdePkg/Include/Pi/PiFirmwareFile.h @@ -1,17 +1,17 @@ /** @file
The firmware file related definitions in PI.
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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
+ PI Version 1.2.
**/
@@ -51,7 +51,7 @@ typedef union { ///
/// FFS_FIXED_CHECKSUM is the checksum value used when the
-/// FFS_ATTRIB_CHECKSUM attribute bit is clear
+/// FFS_ATTRIB_CHECKSUM attribute bit is clear.
///
#define FFS_FIXED_CHECKSUM 0xAA
@@ -171,7 +171,7 @@ typedef struct { 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 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.
///
EFI_FFS_FILE_STATE ExtendedSize;
@@ -180,14 +180,13 @@ typedef struct { typedef UINT8 EFI_SECTION_TYPE;
///
-/// Pseudo type. It is
-/// used as a wild card when retrieving sections. The section
-/// type EFI_SECTION_ALL matches all section types.
+/// Pseudo type. It is used as a wild card when retrieving sections.
+/// The section type EFI_SECTION_ALL matches all section types.
///
#define EFI_SECTION_ALL 0x00
///
-/// Encapsulation section Type values
+/// Encapsulation section Type values.
///
#define EFI_SECTION_COMPRESSION 0x01
@@ -196,7 +195,7 @@ typedef UINT8 EFI_SECTION_TYPE; #define EFI_SECTION_DISPOSABLE 0x03
///
-/// Leaf section Type values
+/// Leaf section Type values.
///
#define EFI_SECTION_PE32 0x10
#define EFI_SECTION_PIC 0x11
@@ -212,7 +211,7 @@ typedef UINT8 EFI_SECTION_TYPE; #define EFI_SECTION_SMM_DEPEX 0x1C
///
-/// Common section header
+/// Common section header.
///
typedef struct {
///
@@ -236,8 +235,8 @@ typedef struct { 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.
+ /// 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.
///
UINT32 ExtendedSize;
} EFI_COMMON_SECTION_HEADER2;
@@ -264,7 +263,7 @@ typedef struct { ///
EFI_COMMON_SECTION_HEADER CommonHeader;
///
- /// UINT32 that indicates the size of the section data after decompression.
+ /// The UINT32 that indicates the size of the section data after decompression.
///
UINT32 UncompressedLength;
///
@@ -301,19 +300,19 @@ typedef EFI_COMMON_SECTION_HEADER EFI_DISPOSABLE_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_DISPOSABLE_SECTION2;
///
-/// Leaf section which could be used to determine the dispatch order of DXEs.
+/// 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;
///
-/// Leaf section which contains a PI FV.
+/// 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;
///
-/// Leaf section which contains a single GUID.
+/// The leaf section which contains a single GUID.
///
typedef struct {
///
@@ -328,7 +327,7 @@ typedef struct { typedef struct {
///
- /// Common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
+ /// The common section header. CommonHeader.Type = EFI_SECTION_FREEFORM_SUBTYPE_GUID.
///
EFI_COMMON_SECTION_HEADER2 CommonHeader;
///
@@ -338,20 +337,20 @@ typedef struct { } EFI_FREEFORM_SUBTYPE_GUID_SECTION2;
///
-/// Attributes of EFI_GUID_DEFINED_SECTION
+/// Attributes of EFI_GUID_DEFINED_SECTION.
///
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
///
-/// Leaf section which is encapsulation defined by specific GUID
+/// The leaf section which is encapsulation defined by specific GUID.
///
typedef struct {
///
- /// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
+ /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
///
EFI_COMMON_SECTION_HEADER CommonHeader;
///
- /// GUID that defines the format of the data that follows. It is a vendor-defined section type.
+ /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
///
EFI_GUID SectionDefinitionGuid;
///
@@ -359,18 +358,18 @@ typedef struct { ///
UINT16 DataOffset;
///
- /// Bit field that declares some specific characteristics of the section contents.
+ /// The bit field that declares some specific characteristics of the section contents.
///
UINT16 Attributes;
} EFI_GUID_DEFINED_SECTION;
typedef struct {
///
- /// Common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
+ /// The common section header. CommonHeader.Type = EFI_SECTION_GUID_DEFINED.
///
EFI_COMMON_SECTION_HEADER2 CommonHeader;
///
- /// GUID that defines the format of the data that follows. It is a vendor-defined section type.
+ /// The GUID that defines the format of the data that follows. It is a vendor-defined section type.
///
EFI_GUID SectionDefinitionGuid;
///
@@ -378,19 +377,19 @@ typedef struct { ///
UINT16 DataOffset;
///
- /// Bit field that declares some specific characteristics of the section contents.
+ /// The bit field that declares some specific characteristics of the section contents.
///
UINT16 Attributes;
} EFI_GUID_DEFINED_SECTION2;
///
-/// Leaf section which contains PE32+ image.
+/// The leaf section which contains PE32+ image.
///
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
typedef EFI_COMMON_SECTION_HEADER2 EFI_PE32_SECTION2;
///
-/// Leaf section which used to determine the dispatch order of PEIMs.
+/// 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;
@@ -408,13 +407,13 @@ typedef EFI_COMMON_SECTION_HEADER EFI_PIC_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_PIC_SECTION2;
///
-/// Leaf section which constains the position-independent-code image.
+/// 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;
///
-/// Leaf section which contains an array of zero or more bytes.
+/// 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;
@@ -423,7 +422,7 @@ 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 2for details regarding the format of the dependency expression.
+/// 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.
///
@@ -431,7 +430,7 @@ typedef EFI_COMMON_SECTION_HEADER EFI_SMM_DEPEX_SECTION; typedef EFI_COMMON_SECTION_HEADER2 EFI_SMM_DEPEX_SECTION2;
///
-/// Leaf section which contains a unicode string that
+/// The leaf section which contains a unicode string that
/// is human readable file name.
///
typedef struct {
@@ -449,7 +448,7 @@ typedef struct { } EFI_USER_INTERFACE_SECTION2;
///
-/// Leaf section which contains a numeric build number and
+/// The leaf section which contains a numeric build number and
/// an optional unicode string that represents the file revision.
///
typedef struct {
diff --git a/MdePkg/Include/Pi/PiHob.h b/MdePkg/Include/Pi/PiHob.h index 12c2e29c87..a6fed4e43f 100644 --- a/MdePkg/Include/Pi/PiHob.h +++ b/MdePkg/Include/Pi/PiHob.h @@ -1,14 +1,14 @@ /** @file
HOB related definitions in PI.
- Copyright (c) 2006 - 2009, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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
@@ -55,7 +55,7 @@ typedef struct { ///
-/// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
+/// Value of version in EFI_HOB_HANDOFF_INFO_TABLE.
///
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
@@ -70,7 +70,7 @@ typedef struct { EFI_HOB_GENERIC_HEADER Header;
///
/// The version number pertaining to the PHIT HOB definition.
- /// This value is 4 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;
@@ -166,7 +166,7 @@ typedef struct { ///
/// Describes the memory stack that is produced by the HOB producer
-/// phase and upon which all postmemory-installed executable
+/// phase and upon which all post-memory-installed executable
/// content in the HOB producer phase is executing.
///
typedef struct {
@@ -225,7 +225,7 @@ typedef struct { } EFI_HOB_MEMORY_ALLOCATION_MODULE;
///
-/// Resource type
+/// The resource type.
///
typedef UINT32 EFI_RESOURCE_TYPE;
@@ -242,7 +242,7 @@ typedef UINT32 EFI_RESOURCE_TYPE; #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
///
-/// type of recount attribute type
+/// A type of recount attribute type.
///
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
@@ -289,7 +289,7 @@ typedef struct { ///
EFI_GUID Owner;
///
- /// Resource type enumeration as defined by EFI_RESOURCE_TYPE.
+ /// The resource type enumeration as defined by EFI_RESOURCE_TYPE.
///
EFI_RESOURCE_TYPE ResourceType;
///
@@ -297,11 +297,11 @@ typedef struct { ///
EFI_RESOURCE_ATTRIBUTE_TYPE ResourceAttribute;
///
- /// Physical start address of the resource region.
+ /// The physical start address of the resource region.
///
EFI_PHYSICAL_ADDRESS PhysicalStart;
///
- /// Number of bytes of the resource region.
+ /// The number of bytes of the resource region.
///
UINT64 ResourceLength;
} EFI_HOB_RESOURCE_DESCRIPTOR;
@@ -343,7 +343,7 @@ typedef struct { } EFI_HOB_FIRMWARE_VOLUME;
///
-/// Details the location of a firmware volume which was extracted
+/// Details the location of a firmware volume that was extracted
/// from a file within another firmware volume.
///
typedef struct {
@@ -364,7 +364,7 @@ typedef struct { ///
EFI_GUID FvName;
///
- /// The name of the firmware file which contained this firmware volume.
+ /// The name of the firmware file that contained this firmware volume.
///
EFI_GUID FileName;
} EFI_HOB_FIRMWARE_VOLUME2;
@@ -419,14 +419,14 @@ typedef struct { ///
/// 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.
- /// The length of the contiguous memory in bytes
+ /// The length of the contiguous memory in bytes.
///
EFI_PHYSICAL_ADDRESS BaseAddress;
UINT64 Length;
} EFI_HOB_UEFI_CAPSULE;
///
-/// Union of all the possible HOB Types
+/// Union of all the possible HOB Types.
///
typedef union {
EFI_HOB_GENERIC_HEADER *Header;
diff --git a/MdePkg/Include/Pi/PiMultiPhase.h b/MdePkg/Include/Pi/PiMultiPhase.h index 8dcc0d1670..a92ba4b62c 100644 --- a/MdePkg/Include/Pi/PiMultiPhase.h +++ b/MdePkg/Include/Pi/PiMultiPhase.h @@ -1,17 +1,17 @@ /** @file
Include file matches things in PI for multiple module types.
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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:
- These elements are defined in UEFI Platform Initialization Specification 1.2
+ These elements are defined in UEFI Platform Initialization Specification 1.2.
**/
@@ -53,21 +53,21 @@ #define EFI_NOT_AVAILABLE_YET DXE_ERROR (2)
///
-/// Success and warning codes reserved for use by PI
-/// Supported 32-bit range is 0x20000000-0x3fffffff
-/// Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff
+/// Success and warning codes reserved for use by PI.
+/// Supported 32-bit range is 0x20000000-0x3fffffff.
+/// Supported 64-bit range is 0x2000000000000000-0x3fffffffffffffff.
///
#define PI_ENCODE_WARNING(a) ((MAX_BIT >> 2) | (a))
///
-/// Error codes reserved for use by PI
-/// Supported 32-bit range is 0xa0000000-0xbfffffff
-/// Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff
+/// Error codes reserved for use by PI.
+/// Supported 32-bit range is 0xa0000000-0xbfffffff.
+/// Supported 64-bit range is 0xa000000000000000-0xbfffffffffffffff.
///
#define PI_ENCODE_ERROR(a) (MAX_BIT | (MAX_BIT >> 2) | (a))
///
-/// Return status codes defined in SMM CIS
+/// Return status codes defined in SMM CIS.
///
#define EFI_INTERRUPT_PENDING PI_ENCODE_ERROR (0)
@@ -80,7 +80,7 @@ /// and the EFI_PEI_GUIDED_SECTION_EXTRACTION_PPI
///
/// xx00 Image was not signed.
-/// xxx1 Platform security policy override. Assumes same meaning as 0010 (the image was signed, the
+/// xxx1 Platform security policy override. Assumes the same meaning as 0010 (the image was signed, the
/// signature was tested, and the signature passed authentication test).
/// 0010 Image was signed, the signature was tested, and the signature passed authentication test.
/// 0110 Image was signed and the signature was not tested.
@@ -106,7 +106,7 @@ #define EFI_NEEDS_ECC_INITIALIZATION 0x00000040
///
-/// Structure describing a SMRAM region and its accessibility attributes
+/// Structure describing a SMRAM region and its accessibility attributes.
///
typedef struct {
///
diff --git a/MdePkg/Include/Pi/PiPeiCis.h b/MdePkg/Include/Pi/PiPeiCis.h index 472f74f908..be01b870c4 100644 --- a/MdePkg/Include/Pi/PiPeiCis.h +++ b/MdePkg/Include/Pi/PiPeiCis.h @@ -1,17 +1,18 @@ /** @file
PI PEI master include file. This file should match the PI spec.
- Copyright (c) 2006 - 2010, 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
+Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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
+ PI Version 1.0.
**/
@@ -22,22 +23,22 @@ #include <Pi/PiMultiPhase.h>
///
-/// Handles of EFI FV.
+/// The handles of EFI FV.
///
typedef VOID *EFI_PEI_FV_HANDLE;
///
-/// Handles of EFI FFS
+/// The handles of EFI FFS.
///
typedef VOID *EFI_PEI_FILE_HANDLE;
///
-/// Declare forward reference data structure for EFI_PEI_SERVICE
+/// Declare the forward reference data structure for EFI_PEI_SERVICE.
///
typedef struct _EFI_PEI_SERVICES EFI_PEI_SERVICES;
///
-/// Declare forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR
+/// Declare the forward reference data structure for EFI_PEI_NOTIFY_DESCRIPTOR.
///
typedef struct _EFI_PEI_NOTIFY_DESCRIPTOR EFI_PEI_NOTIFY_DESCRIPTOR;
@@ -116,7 +117,7 @@ typedef struct { ///
struct _EFI_PEI_NOTIFY_DESCRIPTOR {
///
- /// Details if the type of notification is callback or dispatch.
+ /// Details if the type of notification are callback or dispatch.
///
UINTN Flags;
///
@@ -155,7 +156,9 @@ typedef union { @param PpiList A pointer to the list of interfaces that the caller shall install.
@retval EFI_SUCCESS The interface was successfully installed.
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI
+ descriptors in the list do not have the
+ EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
**/
@@ -225,7 +228,7 @@ EFI_STATUS @param NotifyList A pointer to the list of notification interfaces that the caller shall install.
@retval EFI_SUCCESS The interface was successfully installed.
- @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL or Any of the PEI PPI descriptors in the
+ @retval EFI_INVALID_PARAMETER The PpiList pointer is NULL, or any of the PEI PPI descriptors in the
list do not have the EFI_PEI_PPI_DESCRIPTOR_PPI bit set in the Flags field.
@retval EFI_OUT_OF_RESOURCES There is no additional space in the PPI database.
@@ -243,7 +246,7 @@ EFI_STATUS @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param BootMode A pointer to contain the value of the boot mode.
- @retval EFI_SUCCESS The boot mode was returned successfully.
+ @retval EFI_SUCCESS The boot mode returned successfully.
**/
typedef
@@ -259,7 +262,7 @@ EFI_STATUS @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation
@param BootMode The value of the boot mode to set.
- @retval EFI_SUCCESS The boot mode was returned successfully.
+ @retval EFI_SUCCESS The boot mode returned successfully.
**/
typedef
@@ -287,7 +290,7 @@ EFI_STATUS );
/**
- This service published by the PEI Foundation abstracts the creation of a Hand-Off Block's (HOB's) headers.
+ This service, published by the PEI Foundation, abstracts the creation of a Hand-Off Block's (HOB's) headers.
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param Type The type of HOB to be installed.
@@ -371,7 +374,7 @@ EFI_STATUS This service will search within encapsulation sections (compression and GUIDed) as well. It will
search inside of a GUIDed section or a compressed section, but may not, for example, search a
GUIDed section inside a GUIDes section.
- This service will not search within compression sections or GUIDed sections which require
+ This service will not search within compression sections or GUIDed sections that require
extraction if memory is not present.
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@@ -396,7 +399,7 @@ EFI_STATUS This function registers the found memory configuration with the PEI Foundation.
@param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
- @param MemoryBegin The value of a region of installed memory
+ @param MemoryBegin The value of a region of installed memory.
@param MemoryLength The corresponding length of a region of installed memory.
@retval EFI_SUCCESS The region was successfully installed in a HOB.
@@ -419,12 +422,12 @@ EFI_STATUS @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.
@param MemoryType The type of memory to allocate.
@param Pages The number of contiguous 4 KB pages to allocate.
- @param Memory Pointer to a physical address. On output, the address is set to the base
+ @param Memory A pointer to a physical address. On output, the address is set to the base
of the page range that was allocated.
@retval EFI_SUCCESS The memory range was successfully allocated.
@retval EFI_OUT_OF_RESOURCES The pages could not be allocated.
- @retval EFI_INVALID_PARAMETER Type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,
+ @retval EFI_INVALID_PARAMETER The type is not equal to EfiLoaderCode, EfiLoaderData, EfiRuntimeServicesCode,
EfiRuntimeServicesData, EfiBootServicesCode, EfiBootServicesData,
EfiACPIReclaimMemory, or EfiACPIMemoryNVS.
@@ -461,9 +464,9 @@ EFI_STATUS /**
This service copies the contents of one buffer to another buffer.
- @param Destination Pointer to the destination buffer of the memory copy.
- @param Source Pointer to the source buffer of the memory copy
- @param Length Number of bytes to copy from Source to Destination.
+ @param Destination The pointer to the destination buffer of the memory copy.
+ @param Source The pointer to the source buffer of the memory copy.
+ @param Length The number of bytes to copy from Source to Destination.
**/
typedef
@@ -477,9 +480,9 @@ VOID /**
The service fills a buffer with a specified value.
- @param Buffer Pointer to the buffer to fill.
- @param Size Number of bytes in Buffer to fill.
- @param Value Value to fill Buffer with
+ @param Buffer The pointer to the buffer to fill.
+ @param Size The number of bytes in Buffer to fill.
+ @param Value The value to fill Buffer with.
**/
typedef
@@ -563,8 +566,8 @@ EFI_STATUS @param FileHandle Upon exit, points to the found file's
handle or NULL if it could not be found.
- @retval EFI_SUCCESS File was found.
- @retval EFI_NOT_FOUND File was not found.
+ @retval EFI_SUCCESS The file was found.
+ @retval EFI_NOT_FOUND The file was not found.
@retval EFI_INVALID_PARAMETER VolumeHandle or FileHandle or
FileName was NULL.
@@ -578,7 +581,7 @@ EFI_STATUS );
///
-/// Information of FV file.
+/// The information of the FV file.
///
typedef struct {
///
@@ -610,17 +613,17 @@ typedef struct { This function returns information about a specific file,
including its file name, type, attributes, starting address and
- size. If the firmware volume is not memory mapped then the
+ size. If the firmware volume is not memory mapped, then the
Buffer member will be NULL.
- @param FileHandle Handle of the file.
+ @param FileHandle The handle of the file.
@param FileInfo Upon exit, points to the file's
information.
- @retval EFI_SUCCESS File information returned.
- @retval EFI_INVALID_PARAMETER If FileHandle does not
+ @retval EFI_SUCCESS File information was returned.
+ @retval EFI_INVALID_PARAMETER FileHandle does not
represent a valid file.
- @retval EFI_INVALID_PARAMETER If FileInfo is NULL.
+ @retval EFI_INVALID_PARAMETER FileInfo is NULL.
**/
typedef
@@ -631,7 +634,7 @@ EFI_STATUS );
///
-/// Information of FV volume.
+/// The information of the FV volume.
///
typedef struct {
///
@@ -668,10 +671,10 @@ typedef struct { @param VolumeHandle Handle of the volume.
@param VolumeInfo Upon exit, points to the volume's information.
- @retval EFI_SUCCESS Volume information returned.
+ @retval EFI_SUCCESS The volume information returned.
@retval EFI_INVALID_PARAMETER If VolumeHandle does not represent a valid volume.
@retval EFI_INVALID_PARAMETER If VolumeHandle is NULL.
- @retval EFI_SUCCESS Information successfully returned.
+ @retval EFI_SUCCESS Information was successfully returned.
@retval EFI_INVALID_PARAMETER The volume designated by the VolumeHandle is not available.
**/
@@ -719,19 +722,19 @@ EFI_STATUS #define PEI_SPECIFICATION_MAJOR_REVISION 1
#define PEI_SPECIFICATION_MINOR_REVISION 10
///
-/// Inconsistent with specification here:
-/// In PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But
-/// to pass multiple tool chain, it is append a ULL.
+/// Specification inconsistency here:
+/// In the PI1.0 spec, PEI_SERVICES_SIGNATURE is defined as 0x5652455320494550. But
+/// to pass a multiple tool chain, it appends an ULL.
///
//
// PEI Services Table
//
#define PEI_SERVICES_SIGNATURE 0x5652455320494550ULL
///
-/// Inconsistent with specification here:
-/// In PI1.0 spec, There is a typo error in PEI_SERVICES_REVISION. In the spec. the defintion is
+/// Specification inconsistency here:
+/// In the PI1.0 specification, there is a typo error in PEI_SERVICES_REVISION. In the specification the defintion is
/// #define ((PEI_SPECIFICATION_MAJOR_REVISION<<16) |(PEI_SPECIFICATION_MINOR_REVISION))
-/// and it should be as follow:
+/// and it should be as follows:
///
#define PEI_SERVICES_REVISION ((PEI_SPECIFICATION_MAJOR_REVISION<<16) | (PEI_SPECIFICATION_MINOR_REVISION))
@@ -742,7 +745,7 @@ EFI_STATUS /// - Allocating both early and permanent memory
/// - Supporting the Firmware File System (FFS)
/// - Abstracting the PPI database abstraction
-/// - Creating Hand-Off Blocks (HOBs)
+/// - Creating Hand-Off Blocks (HOBs).
///
struct _EFI_PEI_SERVICES {
///
@@ -814,7 +817,7 @@ struct _EFI_PEI_SERVICES { ///
-/// EFI_SEC_PEI_HAND_OFF structure hold information about
+/// EFI_SEC_PEI_HAND_OFF structure holds information about
/// PEI core's operating environment, such as the size of location of
/// temporary RAM, the stack location and BFV location.
///
@@ -858,7 +861,7 @@ typedef struct _EFI_SEC_PEI_HAND_OFF { VOID *PeiTemporaryRamBase;
///
- /// Size of the available temporary RAM available for
+ /// The size of the available temporary RAM available for
/// use by the PEI Foundation, in bytes.
///
UINTN PeiTemporaryRamSize;
@@ -879,7 +882,7 @@ typedef struct _EFI_SEC_PEI_HAND_OFF { /**
- Entry point of PEI Foundation.
+ The entry point of PEI Foundation.
This function is the entry point for the PEI Foundation, which
allows the SEC phase to pass information about the stack,
diff --git a/MdePkg/Include/Pi/PiStatusCode.h b/MdePkg/Include/Pi/PiStatusCode.h index 5e17af4b92..f928e680ae 100644 --- a/MdePkg/Include/Pi/PiStatusCode.h +++ b/MdePkg/Include/Pi/PiStatusCode.h @@ -1,18 +1,18 @@ /** @file
StatusCode related definitions in PI.
- Copyright (c) 2009, 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
+Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved<BR>
+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.
+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:
- These status codes are defined in UEFI Platform Initialization Specification 1.2
- Volume 3: Shared Architectural Elements
+ These status codes are defined in UEFI Platform Initialization Specification 1.2,
+ Volume 3: Shared Architectural Elements.
**/
@@ -25,12 +25,12 @@ #include <Protocol/DebugSupport.h>
///
-/// Status Code Type Definition
+/// Status Code Type Definition.
///
typedef UINT32 EFI_STATUS_CODE_TYPE;
///
-/// A Status Code Type is made up of the code type and severity
+/// A Status Code Type is made up of the code type and severity.
/// All values masked by EFI_STATUS_CODE_RESERVED_MASK are
/// reserved for use by this specification.
///
@@ -41,7 +41,7 @@ typedef UINT32 EFI_STATUS_CODE_TYPE; ///@}
///
-/// Definition of code types, all other values masked by
+/// Definition of code types. All other values masked by
/// EFI_STATUS_CODE_TYPE_MASK are reserved for use by
/// this specification.
///
@@ -56,7 +56,7 @@ typedef UINT32 EFI_STATUS_CODE_TYPE; /// EFI_STATUS_CODE_SEVERITY_MASK are reserved for use by
/// this specification.
/// Uncontained errors are major errors that could not contained
-/// to the specific component that is reporting the error
+/// to the specific component that is reporting the error.
/// For example, if a memory error was not detected early enough,
/// the bad data could be consumed by other drivers.
///
@@ -68,7 +68,7 @@ typedef UINT32 EFI_STATUS_CODE_TYPE; ///@}
///
-/// Status Code Value Definition
+/// Status Code Value Definition.
///
typedef UINT32 EFI_STATUS_CODE_VALUE;
@@ -103,26 +103,26 @@ typedef struct { } EFI_STATUS_CODE_DATA;
///
-/// General partitioning scheme for Progress and Error Codes are
-/// - 0x0000-0x0FFF Shared by all sub-classes in a given class
-/// - 0x1000-0x7FFF Subclass Specific
-/// - 0x8000-0xFFFF OEM specific
+/// General partitioning scheme for Progress and Error Codes are:
+/// - 0x0000-0x0FFF Shared by all sub-classes in a given class.
+/// - 0x1000-0x7FFF Subclass Specific.
+/// - 0x8000-0xFFFF OEM specific.
///@{
#define EFI_SUBCLASS_SPECIFIC 0x1000
#define EFI_OEM_SPECIFIC 0x8000
///@}
///
-/// Debug Code definitions for all classes and subclass
+/// Debug Code definitions for all classes and subclass.
/// Only one debug code is defined at this point and should
-/// be used for anything that gets sent to debug stream.
+/// be used for anything that is sent to the debug stream.
///
///@{
#define EFI_DC_UNSPECIFIED 0x0
///@}
///
-/// Class definitions
+/// Class definitions.
/// Values of 4-127 are reserved for future use by this specification.
/// Values in the range 127-255 are reserved for OEM use.
///
@@ -209,42 +209,42 @@ typedef struct { //
///
-/// South Bridge initialization prior to memory detection
+/// South Bridge initialization prior to memory detection.
///
#define EFI_CHIPSET_PC_PEI_CAR_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000000)
///
-/// North Bridge initialization prior to memory detection
+/// North Bridge initialization prior to memory detection.
///
#define EFI_CHIPSET_PC_PEI_CAR_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000001)
///
-/// South Bridge initialization after memory detection
+/// South Bridge initialization after memory detection.
///
#define EFI_CHIPSET_PC_PEI_MEM_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000002)
///
-/// North Bridge initialization after memory detection
+/// North Bridge initialization after memory detection.
///
#define EFI_CHIPSET_PC_PEI_MEM_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000003)
///
-/// PCI Host Bridge DXE initialization
+/// PCI Host Bridge DXE initialization.
///
#define EFI_CHIPSET_PC_DXE_HB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000004)
///
-/// North Bridge DXE initialization
+/// North Bridge DXE initialization.
///
#define EFI_CHIPSET_PC_DXE_NB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000005)
///
-/// North Bridge specific SMM initialization in DXE
+/// North Bridge specific SMM initialization in DXE.
///
#define EFI_CHIPSET_PC_DXE_NB_SMM_INIT (EFI_SUBCLASS_SPECIFIC|0x00000006)
///
-/// Initialization of the South Bridge specific UEFI Runtime Services
+/// Initialization of the South Bridge specific UEFI Runtime Services.
///
#define EFI_CHIPSET_PC_DXE_SB_RT_INIT (EFI_SUBCLASS_SPECIFIC|0x00000007)
@@ -254,12 +254,12 @@ typedef struct { #define EFI_CHIPSET_PC_DXE_SB_INIT (EFI_SUBCLASS_SPECIFIC|0x00000008)
///
-/// South Bridge specific SMM initialization in DXE
+/// South Bridge specific SMM initialization in DXE.
///
#define EFI_CHIPSET_PC_DXE_SB_SMM_INIT (EFI_SUBCLASS_SPECIFIC|0x00000009)
///
-/// Initialization of the South Bridge devices
+/// Initialization of the South Bridge devices.
///
#define EFI_CHIPSET_PC_DXE_SB_DEVICES_INIT (EFI_SUBCLASS_SPECIFIC|0x0000000a)
|