summaryrefslogtreecommitdiff
path: root/MdeModulePkg/Include/Guid
diff options
context:
space:
mode:
authormyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-17 20:48:52 +0000
committermyronporter <myronporter@6f19259b-4bc3-4df7-8a09-765794883524>2010-03-17 20:48:52 +0000
commit64a80549c8ab874c5b23b376adbb99008e6143b0 (patch)
treef2bfcfac958920ed47b3f94cce38bbc019ed2ff3 /MdeModulePkg/Include/Guid
parentd96d37d8b95d08264557ea91ca6a6e2b5f07767b (diff)
downloadedk2-platforms-64a80549c8ab874c5b23b376adbb99008e6143b0.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@10269 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include/Guid')
-rw-r--r--MdeModulePkg/Include/Guid/CapsuleVendor.h24
-rw-r--r--MdeModulePkg/Include/Guid/ConsoleInDevice.h12
-rw-r--r--MdeModulePkg/Include/Guid/ConsoleOutDevice.h12
-rw-r--r--MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h14
-rw-r--r--MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h18
-rw-r--r--MdeModulePkg/Include/Guid/MdeModuleHii.h78
-rw-r--r--MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h16
-rw-r--r--MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h28
-rw-r--r--MdeModulePkg/Include/Guid/MemoryTypeInformation.h18
-rw-r--r--MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h26
-rw-r--r--MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h16
-rw-r--r--MdeModulePkg/Include/Guid/Performance.h54
-rw-r--r--MdeModulePkg/Include/Guid/StandardErrorDevice.h14
-rw-r--r--MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h16
-rw-r--r--MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h20
-rw-r--r--MdeModulePkg/Include/Guid/SystemNvDataGuid.h27
-rw-r--r--MdeModulePkg/Include/Guid/VariableFormat.h72
17 files changed, 233 insertions, 232 deletions
diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h
index b3ac377af4..9f1d545357 100644
--- a/MdeModulePkg/Include/Guid/CapsuleVendor.h
+++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h
@@ -1,21 +1,21 @@
/** @file
This file defines:
- * the capsule vendor GUID for capsule variables and the HOB
- * the capsule variable name
+ * the capsule vendor GUID for capsule variables and the HOB.
+ * the capsule variable name.
* the capsule GUID HOB data structure.
The capsule HOB and variable can be used to store the capsule image start address and length.
They are used by EDKII implementation of capsule update across a system reset.
@par Note: EDKII implementation of capsule updating has discarded this capsule GUID HOB data
- structur and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
+ structure and used one UEFI Capsule HOB (defined in PI Specification 1.2) instead.
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -34,17 +34,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
{ 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 } }
///
-/// Name of capsule variable
+/// Name of capsule variable.
///
#define EFI_CAPSULE_VARIABLE_NAME L"CapsuleUpdateData"
///
-/// Data structure of capsule guid hob entry
+/// The data structure of the capsule guid hob entry.
/// Note: EDKII implementation has discarded this structure and used
/// UEFI_CAPSULE_HOB instead.
///
typedef struct {
- EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address
+ EFI_PHYSICAL_ADDRESS BaseAddress; ///< Capsule data start address.
UINT32 Length; ///< Length of capsule data.
} CAPSULE_HOB_INFO;
diff --git a/MdeModulePkg/Include/Guid/ConsoleInDevice.h b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
index 81c2d93505..0f7b9472ad 100644
--- a/MdeModulePkg/Include/Guid/ConsoleInDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleInDevice.h
@@ -2,13 +2,13 @@
This GUID can be installed to the device handle to specify that the device is the console-in device.
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
diff --git a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
index f09f427e44..962ffdbf05 100644
--- a/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
+++ b/MdeModulePkg/Include/Guid/ConsoleOutDevice.h
@@ -1,13 +1,13 @@
/** @file
This GUID can be installed to the device handle to specify that the device is the console-out device.
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
diff --git a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
index f608ae4ae9..9691fa5589 100644
--- a/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
+++ b/MdeModulePkg/Include/Guid/Crc32GuidedSectionExtraction.h
@@ -2,14 +2,14 @@
This file defines CRC32 GUID to specify the CRC32
encapsulation scheme for the GUIDed section.
- 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.
**/
diff --git a/MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h b/MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
index a04e0b224d..d2b01cea68 100644
--- a/MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
+++ b/MdeModulePkg/Include/Guid/LoadModuleAtFixedAddress.h
@@ -3,16 +3,16 @@
This configuration table is to hold the top address below which the Dxe runtime code and
boot time code will be loaded and Tseg base. When this feature is enabled, Build tools will assigned
- module loading address relative to these 2 address.
+ module loading address relative to these two addresses.
-Copyright (c) 2010, Intel Corporation. <BR>
-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) 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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -27,8 +27,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
extern EFI_GUID gLoadFixedAddressConfigurationTableGuid;
typedef struct {
- EFI_PHYSICAL_ADDRESS DxeCodeTopAddress; ///< The top address below which the Dxe runtime code and below which the Dxe runtime/boot code and PEI code.
- EFI_PHYSICAL_ADDRESS SmramBase; ///< SMM RAME base. build tool will assigned an offset relative to SMRAM base for SMM driver
+ EFI_PHYSICAL_ADDRESS DxeCodeTopAddress; ///< The top address below which the Dxe runtime code and below which the Dxe runtime/boot code and PEI code.
+ EFI_PHYSICAL_ADDRESS SmramBase; ///< SMM RAME base. build tool will assigned an offset relative to SMRAM base for SMM driver.
} EFI_LOAD_FIXED_ADDRESS_CONFIGURATION_TABLE;
#endif
diff --git a/MdeModulePkg/Include/Guid/MdeModuleHii.h b/MdeModulePkg/Include/Guid/MdeModuleHii.h
index 5cfc45cec3..512cfd9fb7 100644
--- a/MdeModulePkg/Include/Guid/MdeModuleHii.h
+++ b/MdeModulePkg/Include/Guid/MdeModuleHii.h
@@ -1,13 +1,13 @@
/** @file
EDKII extented HII IFR guid opcodes.
-Copyright (c) 2006 - 2008, Intel Corporation. <BR>
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -20,13 +20,13 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define NON_BREAKING_CHAR 0xFFF2
///
-/// State defined for password statemachine
+/// State defined for password statemachine .
///
#define BROWSER_STATE_VALIDATE_PASSWORD 0
#define BROWSER_STATE_SET_PASSWORD 1
///
-/// GUIDed opcodes defined for EDKII implementation
+/// GUIDed opcodes defined for EDKII implementation.
///
#define EFI_IFR_TIANO_GUID \
{ 0xf0b1735, 0x87a0, 0x4193, {0xb2, 0x66, 0x53, 0x8c, 0x38, 0xaf, 0x48, 0xce} }
@@ -43,20 +43,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
#define EFI_IFR_EXTEND_OP_SUBCLASS 0x4
///
-/// Label opcode
+/// Label opcode.
///
typedef struct _EFI_IFR_GUID_LABEL {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_TIANO_GUID
+ /// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_LABEL
+ /// EFI_IFR_EXTEND_OP_LABEL.
///
UINT8 ExtendOpCode;
///
- /// Label Number
+ /// Label Number.
///
UINT16 Number;
} EFI_IFR_GUID_LABEL;
@@ -66,37 +66,37 @@ typedef struct _EFI_IFR_GUID_LABEL {
#define EFI_IFR_BANNER_ALIGN_RIGHT 2
///
-/// Banner opcode
+/// Banner opcode.
///
typedef struct _EFI_IFR_GUID_BANNER {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_TIANO_GUID
+ /// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
/// EFI_IFR_EXTEND_OP_BANNER
///
UINT8 ExtendOpCode;
- EFI_STRING_ID Title; ///< The string token for the banner title
- UINT16 LineNumber; ///< 1-based line number
- UINT8 Alignment; ///< left, center, or right-aligned
+ EFI_STRING_ID Title; ///< The string token for the banner title.
+ UINT16 LineNumber; ///< 1-based line number.
+ UINT8 Alignment; ///< left, center, or right-aligned.
} EFI_IFR_GUID_BANNER;
///
-/// Timeout opcode
+/// Timeout opcode.
///
typedef struct _EFI_IFR_GUID_TIMEOUT {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_TIANO_GUID
+ /// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_TIMEOUT
+ /// EFI_IFR_EXTEND_OP_TIMEOUT.
///
UINT8 ExtendOpCode;
- UINT16 TimeOut; ///< TimeOut Value
+ UINT16 TimeOut; ///< TimeOut Value.
} EFI_IFR_GUID_TIMEOUT;
#define EFI_NON_DEVICE_CLASS 0x00
@@ -108,19 +108,19 @@ typedef struct _EFI_IFR_GUID_TIMEOUT {
#define EFI_OTHER_DEVICE_CLASS 0x20
///
-/// Device Class opcode
+/// Device Class opcode.
///
typedef struct _EFI_IFR_GUID_CLASS {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_TIANO_GUID
+ /// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_CLASS
+ /// EFI_IFR_EXTEND_OP_CLASS.
///
UINT8 ExtendOpCode;
- UINT16 Class; ///< Device Class from the above
+ UINT16 Class; ///< Device Class from the above.
} EFI_IFR_GUID_CLASS;
#define EFI_SETUP_APPLICATION_SUBCLASS 0x00
@@ -134,14 +134,14 @@ typedef struct _EFI_IFR_GUID_CLASS {
typedef struct _EFI_IFR_GUID_SUBCLASS {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_TIANO_GUID
+ /// EFI_IFR_TIANO_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_SUBCLASS
+ /// EFI_IFR_EXTEND_OP_SUBCLASS.
///
UINT8 ExtendOpCode;
- UINT16 SubClass; ///< Sub Class type from the above
+ UINT16 SubClass; ///< Sub Class type from the above.
} EFI_IFR_GUID_SUBCLASS;
///
@@ -152,27 +152,27 @@ typedef struct _EFI_IFR_GUID_SUBCLASS {
///
/// Two extended opcodes are added, and new extensions can be added here later.
-/// One is for framework OneOf question Option Key value,
-/// Another is for framework vareqval.
+/// One is for framework OneOf question Option Key value;
+/// another is for framework vareqval.
///
#define EFI_IFR_EXTEND_OP_OPTIONKEY 0x0
#define EFI_IFR_EXTEND_OP_VAREQNAME 0x1
///
-/// Store the framework vfr option key value
+/// Store the framework vfr option key value.
///
typedef struct _EFI_IFR_GUID_OPTIONKEY {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_FRAMEWORK_GUID
+ /// EFI_IFR_FRAMEWORK_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_OPTIONKEY
+ /// EFI_IFR_EXTEND_OP_OPTIONKEY.
///
UINT8 ExtendOpCode;
///
- /// OneOf Questiond ID binded by OneOf Option
+ /// OneOf Questiond ID binded by OneOf Option.
///
EFI_QUESTION_ID QuestionId;
///
@@ -186,16 +186,16 @@ typedef struct _EFI_IFR_GUID_OPTIONKEY {
} EFI_IFR_GUID_OPTIONKEY;
///
-/// Store the framework vfr vareqval name number
+/// Store the framework vfr vareqval name number.
///
typedef struct _EFI_IFR_GUID_VAREQNAME {
EFI_IFR_OP_HEADER Header;
///
- /// EFI_IFR_FRAMEWORK_GUID
+ /// EFI_IFR_FRAMEWORK_GUID.
///
EFI_GUID Guid;
///
- /// EFI_IFR_EXTEND_OP_VAREQNAME
+ /// EFI_IFR_EXTEND_OP_VAREQNAME.
///
UINT8 ExtendOpCode;
///
@@ -204,8 +204,8 @@ typedef struct _EFI_IFR_GUID_VAREQNAME {
EFI_QUESTION_ID QuestionId;
///
/// For vareqval (0x100), NameId is 0x100.
- /// This value will converte to a Unicode String following this rule.
- /// sprintf(StringBuffer, "%d", NameId)
+ /// This value will convert to a Unicode String following this rule;
+ /// sprintf(StringBuffer, "%d", NameId) .
/// The the Unicode String will be used as a EFI Variable Name.
///
UINT16 NameId;
diff --git a/MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h b/MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h
index 6df22b6e52..a59c1a3b25 100644
--- a/MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h
+++ b/MdeModulePkg/Include/Guid/MdeModulePkgTokenSpace.h
@@ -1,14 +1,14 @@
/** @file
- GUID for MdeModulePkg PCD Token Space
+ GUID for MdeModulePkg PCD Token Space.
- 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.
**/
diff --git a/MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h b/MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h
index 7599926f12..cb9eb65070 100644
--- a/MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h
+++ b/MdeModulePkg/Include/Guid/MemoryStatusCodeRecord.h
@@ -1,14 +1,14 @@
/** @file
- GUID used to identify status code records HOB that originate from the PEI status code
+ GUID used to identify status code records HOB that originate from the PEI status code.
- 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
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+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.
**/
@@ -17,7 +17,7 @@
///
/// Global ID used to identify GUIDed HOBs that start with a structure of type
-/// MEMORY_STATUSCODE_PACKET_HEADER followed by an array of structures of type
+/// MEMORY_STATUSCODE_PACKET_HEADER, followed by an array of structures of type
/// MEMORY_STATUSCODE_RECORD. These GUIDed HOBs record all the information
/// passed into the ReportStatusCode() service of PEI Services Table.
///
@@ -42,15 +42,15 @@
///
typedef struct {
///
- /// Index of the packet
+ /// Index of the packet.
///
UINT16 PacketIndex;
///
- /// The number of active records in the packet
+ /// The number of active records in the packet.
///
UINT16 RecordIndex;
///
- /// The maximum number of records that the packet can store
+ /// The maximum number of records that the packet can store.
///
UINT32 MaxRecordsNumber;
} MEMORY_STATUSCODE_PACKET_HEADER;
@@ -73,7 +73,7 @@ typedef struct {
///
/// The enumeration of a hardware or software entity within
- /// the system. Valid instance numbers start with 1
+ /// the system. Valid instance numbers start with the number 1.
///
UINT32 Instance;
} MEMORY_STATUSCODE_RECORD;
diff --git a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
index c37880a229..082c5ef9ab 100644
--- a/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
+++ b/MdeModulePkg/Include/Guid/MemoryTypeInformation.h
@@ -1,19 +1,19 @@
/** @file
This file defines:
- * Memory Type Information GUID for HOB and Variable
- * Memory Type Information Variable Name
- * Memory Type Information GUID HOB data structure
+ * Memory Type Information GUID for HOB and Variable.
+ * Memory Type Information Variable Name.
+ * Memory Type Information GUID HOB data structure.
The memory type information HOB and variable can
be used to store the information for each memory type in Variable or HOB.
-Copyright (c) 2006 - 2009, Intel Corporation. <BR>
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
diff --git a/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h b/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
index 68acd906a0..65cff8bfd3 100644
--- a/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
+++ b/MdeModulePkg/Include/Guid/NicIp4ConfigNvData.h
@@ -1,13 +1,13 @@
/** @file
This file defines NIC_IP4_CONFIG_INFO structure.
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -48,9 +48,9 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/// a specific NIC.
///
typedef struct {
- UINT16 Type; ///< Interface type
- UINT8 Len; ///< Length of MAC address
- EFI_MAC_ADDRESS MacAddr; ///< MAC address of interface
+ UINT16 Type; ///< Interface type.
+ UINT8 Len; ///< Length of MAC address.
+ EFI_MAC_ADDRESS MacAddr; ///< MAC address of interface.
} NIC_ADDR;
///
@@ -59,10 +59,10 @@ typedef struct {
/// of variable length.
///
typedef struct {
- NIC_ADDR NicAddr; ///< Link layer address to identify the NIC
- UINT32 Source; ///< Static or DHCP
- BOOLEAN Perment; ///< Survive the reboot or not
- EFI_IP4_IPCONFIG_DATA Ip4Info; ///< IP addresses
+ NIC_ADDR NicAddr; ///< Link layer address to identify the NIC.
+ UINT32 Source; ///< Static or DHCP.
+ BOOLEAN Perment; ///< Survive the reboot or not.
+ EFI_IP4_IPCONFIG_DATA Ip4Info; ///< IP addresses.
} NIC_IP4_CONFIG_INFO;
extern EFI_GUID gEfiNicIp4ConfigVariableGuid;
diff --git a/MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h b/MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h
index 3a65716866..39ab107900 100644
--- a/MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h
+++ b/MdeModulePkg/Include/Guid/PcdDataBaseHobGuid.h
@@ -1,14 +1,14 @@
/** @file
- Hob guid for Pcd DataBase
+ Hob guid for Pcd DataBase.
- 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.
**/
diff --git a/MdeModulePkg/Include/Guid/Performance.h b/MdeModulePkg/Include/Guid/Performance.h
index de813da4b7..73b2419094 100644
--- a/MdeModulePkg/Include/Guid/Performance.h
+++ b/MdeModulePkg/Include/Guid/Performance.h
@@ -1,16 +1,16 @@
/** @file
This file defines performance-related definitions, including the format of:
- * performance GUID HOB
- * performance protocol interfaces
+ * performance GUID HOB.
+ * performance protocol interfaces.
* performance variables.
-Copyright (c) 2009, Intel Corporation. <BR>
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
@@ -26,17 +26,17 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
- CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
- CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name
- UINT64 StartTimeStamp; ///< Start time point
- UINT64 EndTimeStamp; ///< End time point
+ CHAR8 Token[PEI_PERFORMANCE_STRING_SIZE]; ///< Measured token string name.
+ CHAR8 Module[PEI_PERFORMANCE_STRING_SIZE]; ///< Module string name.
+ UINT64 StartTimeStamp; ///< Start time point.
+ UINT64 EndTimeStamp; ///< End time point.
} PEI_PERFORMANCE_LOG_ENTRY;
//
// The header must be aligned at 8 bytes.
//
typedef struct {
- UINT32 NumberOfEntries; ///< The number of all performance log entries
+ UINT32 NumberOfEntries; ///< The number of all performance log entries.
UINT32 Reserved;
} PEI_PERFORMANCE_LOG_HEADER;
@@ -86,17 +86,17 @@ typedef struct _PERFORMANCE_PROTOCOL PERFORMANCE_PROTOCOL;
typedef struct {
EFI_PHYSICAL_ADDRESS Handle;
- CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name
- CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name
- UINT64 StartTimeStamp; ///< Start time point
- UINT64 EndTimeStamp; ///< End time point
+ CHAR8 Token[DXE_PERFORMANCE_STRING_SIZE]; ///< Measured token string name.
+ CHAR8 Module[DXE_PERFORMANCE_STRING_SIZE]; ///< Module string name.
+ UINT64 StartTimeStamp; ///< Start time point.
+ UINT64 EndTimeStamp; ///< End time point.
} GAUGE_DATA_ENTRY;
//
// The header must be aligned at 8 bytes
//
typedef struct {
- UINT32 NumberOfEntries; ///< The number of all performance gauge entries
+ UINT32 NumberOfEntries; ///< The number of all performance gauge entries.
UINT32 Reserved;
} GAUGE_DATA_HEADER;
@@ -110,13 +110,13 @@ typedef struct {
If TimeStamp is zero, the start time in the record is filled in with the value
read from the current time stamp.
- @param Handle Pointer to environment specific context used
+ @param Handle The pointer to environment specific context used
to identify the component being measured.
- @param Token Pointer to a Null-terminated ASCII string
+ @param Token The pointer to a Null-terminated ASCII string
that identifies the component being measured.
- @param Module Pointer to a Null-terminated ASCII string
+ @param Module The pointer to a Null-terminated ASCII string
that identifies the module being measured.
- @param TimeStamp 64-bit time stamp.
+ @param TimeStamp The 64-bit time stamp.
@retval EFI_SUCCESS The data was read correctly from the device.
@retval EFI_OUT_OF_RESOURCES There are not enough resources to record the measurement.
@@ -136,20 +136,20 @@ EFI_STATUS
for the first matching record that contains a zero end time and fills in a valid end time.
Searches the performance measurement log from the beginning of the log
- for the first record that matches Handle, Token, and Module and has an end time value of zero.
+ for the first record that matches Handle, Token, and Module, and has an end time value of zero.
If the record can not be found then return EFI_NOT_FOUND.
If the record is found and TimeStamp is not zero,
then the end time in the record is filled in with the value specified by TimeStamp.
If the record is found and TimeStamp is zero, then the end time in the matching record
is filled in with the current time stamp value.
- @param Handle Pointer to environment specific context used
+ @param Handle The pointer to environment specific context used
to identify the component being measured.
- @param Token Pointer to a Null-terminated ASCII string
+ @param Token The pointer to a Null-terminated ASCII string
that identifies the component being measured.
- @param Module Pointer to a Null-terminated ASCII string
+ @param Module The pointer to a Null-terminated ASCII string
that identifies the module being measured.
- @param TimeStamp 64-bit time stamp.
+ @param TimeStamp The 64-bit time stamp.
@retval EFI_SUCCESS The end of the measurement was recorded.
@retval EFI_NOT_FOUND The specified measurement record could not be found.
diff --git a/MdeModulePkg/Include/Guid/StandardErrorDevice.h b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
index f464fb7040..9d7dc17343 100644
--- a/MdeModulePkg/Include/Guid/StandardErrorDevice.h
+++ b/MdeModulePkg/Include/Guid/StandardErrorDevice.h
@@ -1,14 +1,14 @@
/** @file
- This GUID is installed to the device handler to specify that the device is StdErr device.
+ This GUID is installed to the device handler to specify that the device is a StdErr device.
-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,
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
diff --git a/MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h b/MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h
index ab4a8cbe27..52a90a064d 100644
--- a/MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h
+++ b/MdeModulePkg/Include/Guid/StatusCodeCallbackGuid.h
@@ -2,14 +2,14 @@
GUID used to identify HOB for pointers to callback functios registered on
PEI report status code router.
- 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
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
+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.
**/
diff --git a/MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h b/MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
index 52e7c95e73..db53fcb7c2 100644
--- a/MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
+++ b/MdeModulePkg/Include/Guid/StatusCodeDataTypeDebug.h
@@ -2,14 +2,14 @@
This file defines the GUID and data structure used to pass DEBUG() macro
information to the Status Code Protocol and Status Code PPI.
- Copyright (c) 2007 - 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) 2007 - 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.
**/
@@ -17,7 +17,7 @@
#define _STATUS_CODE_DATA_TYPE_DEBUG_H_
///
-/// Global ID used to identify a structure of type EFI_DEBUG_INFO
+/// The Global ID used to identify a structure of type EFI_DEBUG_INFO.
///
#define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \
{ \
@@ -25,14 +25,14 @@
}
///
-/// The maximum size of an EFI_DEBUG_INFO structure
+/// The maximum size of an EFI_DEBUG_INFO structure.
///
#define EFI_STATUS_CODE_DATA_MAX_SIZE 200
///
/// This structure contains the ErrorLevel passed into the DEBUG() macro, followed
/// by a 96-byte buffer that contains the variable argument list passed to the
-// DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is
+/// DEBUG() macro that has been converted to a BASE_LIST. The 96-byte buffer is
/// followed by a Null-terminated ASCII string that is the Format string passed
/// to the DEBUG() macro. The maximum size of this structure is defined by
/// EFI_STATUS_CODE_DATA_MAX_SIZE.
diff --git a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
index 048ea651da..3d537fbde1 100644
--- a/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
+++ b/MdeModulePkg/Include/Guid/SystemNvDataGuid.h
@@ -4,12 +4,12 @@
this FV image contains NV data, such as NV variable data.
This guid can also be used as the signature of FTW working block header.
-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.
@@ -22,7 +22,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
{0xfff12b8d, 0x7696, 0x4c8b, {0xa9, 0x85, 0x27, 0x47, 0x7, 0x5b, 0x4f, 0x50} }
///
-/// NvDataFv GUID used as the signature of FTW working block header.
+/// An NvDataFv GUID used as the signature of FTW working block header.
///
extern EFI_GUID gEfiSystemNvDataFvGuid;
@@ -30,20 +30,20 @@ extern EFI_GUID gEfiSystemNvDataFvGuid;
#define WORKING_BLOCK_INVALID 0x2
///
-/// EDKII Fault tolerant working block header
+/// The EDKII Fault tolerant working block header.
/// The header is immediately followed by the write queue data.
///
typedef struct {
///
- /// System Non Volatile FV Guid
+ /// System Non Volatile FV Guid.
///
EFI_GUID Signature;
///
- /// 32bit CRC caculated for this header
+ /// 32bit CRC caculated for this header.
///
UINT32 Crc;
///
- /// Working block valid bit
+ /// Working block valid bit.
///
UINT8 WorkingBlockValid : 1;
UINT8 WorkingBlockInvalid : 1;
@@ -54,8 +54,9 @@ typedef struct {
///
UINT64 WriteQueueSize;
///
- /// Write Queue data
- /// UINT8 WriteQueue[WriteQueueSize];
+ /// Write Queue data.
+ ///
+ UINT8 WriteQueue[WriteQueueSize];
///
} EFI_FAULT_TOLERANT_WORKING_BLOCK_HEADER;
diff --git a/MdeModulePkg/Include/Guid/VariableFormat.h b/MdeModulePkg/Include/Guid/VariableFormat.h
index b1dcc283bd..efff79a0d0 100644
--- a/MdeModulePkg/Include/Guid/VariableFormat.h
+++ b/MdeModulePkg/Include/Guid/VariableFormat.h
@@ -2,14 +2,14 @@
The variable data structures are related to EDK II-specific implementation of UEFI variables.
VariableFormat.h defines variable data headers and variable storage region headers.
- Copyright (c) 2006 - 2008 Intel Corporation. <BR>
- 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.
**/
@@ -23,8 +23,8 @@ extern EFI_GUID gEfiVariableGuid;
///
/// Alignment of variable name and data, according to the architecture:
-/// * For IA-32 and Intel(R) 64 architectures: 1
-/// * For IA-64 architecture: 8
+/// * For IA-32 and Intel(R) 64 architectures: 1.
+/// * For IA-64 architecture: 8.
///
#if defined (MDE_CPU_IPF)
#define ALIGNMENT 8
@@ -42,13 +42,13 @@ extern EFI_GUID gEfiVariableGuid;
#endif
///
-/// Alignment of Variable Data Header in Variable Store region
+/// Alignment of Variable Data Header in Variable Store region.
///
#define HEADER_ALIGNMENT 4
#define HEADER_ALIGN(Header) (((UINTN) (Header) + HEADER_ALIGNMENT - 1) & (~(HEADER_ALIGNMENT - 1)))
///
-/// Status of Variable Store Region
+/// Status of Variable Store Region.
///
typedef enum {
EfiRaw,
@@ -62,13 +62,13 @@ typedef enum {
#define VARIABLE_STORE_SIGNATURE EFI_VARIABLE_GUID
///
-/// Variable Store Header Format and State
+/// Variable Store Header Format and State.
///
#define VARIABLE_STORE_FORMATTED 0x5a
#define VARIABLE_STORE_HEALTHY 0xfe
///
-/// Variable Store region header
+/// Variable Store region header.
///
typedef struct {
///
@@ -81,11 +81,11 @@ typedef struct {
///
UINT32 Size;
///
- /// variable region format state
+ /// Variable region format state.
///
UINT8 Format;
///
- /// variable region healthy state
+ /// Variable region healthy state.
///
UINT8 State;
UINT16 Reserved;
@@ -93,41 +93,41 @@ typedef struct {
} VARIABLE_STORE_HEADER;
///
-/// Variable data start flag
+/// Variable data start flag.
///
#define VARIABLE_DATA 0x55AA
///
-/// Variable State flags
+/// Variable State flags.
///
-#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition
-#define VAR_DELETED 0xfd ///< Variable is obsolete
-#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid
-#define VAR_ADDED 0x3f ///< Variable has been completely added
+#define VAR_IN_DELETED_TRANSITION 0xfe ///< Variable is in obsolete transition.
+#define VAR_DELETED 0xfd ///< Variable is obsolete.
+#define VAR_HEADER_VALID_ONLY 0x7f ///< Variable header has been valid.
+#define VAR_ADDED 0x3f ///< Variable has been completely added.
///
-/// Single Variable Data Header Structure
+/// Single Variable Data Header Structure.
///
typedef struct {
///
- /// Variable Data Start Flag
+ /// Variable Data Start Flag.
///
UINT16 StartId;
///
- /// Variable State defined above
+ /// Variable State defined above.
///
UINT8 State;
UINT8 Reserved;
///
- /// Attributes of variable defined in UEFI spec
+ /// Attributes of variable defined in UEFI specification.
///
UINT32 Attributes;
///
- /// Size of variable null-terminated Unicode string name
+ /// Size of variable null-terminated Unicode string name.
///
UINT32 NameSize;
///
- /// Size of the variable data without this header
+ /// Size of the variable data without this header.
///
UINT32 DataSize;
///
@@ -146,15 +146,15 @@ typedef struct _VARIABLE_INFO_ENTRY VARIABLE_INFO_ENTRY;
/// This is an optional feature to dump all used variables in shell environment.
///
struct _VARIABLE_INFO_ENTRY {
- VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry
- EFI_GUID VendorGuid; ///< Guid of Variable
- CHAR16 *Name; ///< Name of Variable
- UINT32 Attributes; ///< Attributes of variable defined in UEFI spec
- UINT32 ReadCount; ///< Number of times to read this variable
- UINT32 WriteCount; ///< Number of times to write this variable
- UINT32 DeleteCount; ///< Number of times to delete this variable
- UINT32 CacheCount; ///< Number of times that cache hits this variable
- BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile
+ VARIABLE_INFO_ENTRY *Next; ///< Pointer to next entry.
+ EFI_GUID VendorGuid; ///< Guid of Variable.
+ CHAR16 *Name; ///< Name of Variable.
+ UINT32 Attributes; ///< Attributes of variable defined in UEFI specification.
+ UINT32 ReadCount; ///< Number of times to read this variable.
+ UINT32 WriteCount; ///< Number of times to write this variable.
+ UINT32 DeleteCount; ///< Number of times to delete this variable.
+ UINT32 CacheCount; ///< Number of times that cache hits this variable.
+ BOOLEAN Volatile; ///< TRUE if volatile, FALSE if non-volatile.
};
#endif // _EFI_VARIABLE_H_