diff options
author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-09 06:26:42 +0000 |
---|---|---|
committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2009-01-09 06:26:42 +0000 |
commit | e56187913724379012649c0411668f94ac2ffd9f (patch) | |
tree | f455b0004585ba7f2b38fd51ec4e1c82a2e58e8b /MdeModulePkg/Include | |
parent | b3ff502f6dbbd343c75859ee04de4ee1683cdecc (diff) | |
download | edk2-platforms-e56187913724379012649c0411668f94ac2ffd9f.tar.xz |
Add INF extension Information
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7228 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Include')
-rw-r--r-- | MdeModulePkg/Include/Guid/Bmp.h | 10 | ||||
-rw-r--r-- | MdeModulePkg/Include/Guid/CapsuleVendor.h | 5 | ||||
-rw-r--r-- | MdeModulePkg/Include/Guid/GenericPlatformVariable.h | 2 | ||||
-rw-r--r-- | MdeModulePkg/Include/MdeModuleHii.h | 14 | ||||
-rw-r--r-- | MdeModulePkg/Include/VariableFormat.h | 41 | ||||
-rw-r--r-- | MdeModulePkg/Include/WorkingBlockHeader.h | 4 |
6 files changed, 37 insertions, 39 deletions
diff --git a/MdeModulePkg/Include/Guid/Bmp.h b/MdeModulePkg/Include/Guid/Bmp.h index 0ab73790fb..093a9587c5 100644 --- a/MdeModulePkg/Include/Guid/Bmp.h +++ b/MdeModulePkg/Include/Guid/Bmp.h @@ -1,6 +1,6 @@ /** @file
- This file defines header data structures for BMP file and default
- FFS GUID Filename for BMP logo file.
+ This file defines BMP file header data structures.
+ It also defines the File GUID for default BMP logo file.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -34,10 +34,10 @@ typedef struct { UINT32 HeaderSize;
UINT32 PixelWidth;
UINT32 PixelHeight;
- UINT16 Planes; /// Must be 1
- UINT16 BitPerPixel; /// 1, 4, 8, or 24
+ UINT16 Planes; ///> Must be 1
+ UINT16 BitPerPixel; ///> 1, 4, 8, or 24
UINT32 CompressionType;
- UINT32 ImageSize; /// Compressed image size in bytes
+ UINT32 ImageSize; ///> Compressed image size in bytes
UINT32 XPixelsPerMeter;
UINT32 YPixelsPerMeter;
UINT32 NumberOfColors;
diff --git a/MdeModulePkg/Include/Guid/CapsuleVendor.h b/MdeModulePkg/Include/Guid/CapsuleVendor.h index b326018c49..58ac355bd4 100644 --- a/MdeModulePkg/Include/Guid/CapsuleVendor.h +++ b/MdeModulePkg/Include/Guid/CapsuleVendor.h @@ -1,7 +1,6 @@ /** @file
-
- This file defines capsule vendor guid, capsule variable name
- and capsule guid hob data structure.
+ This file defines capsule vendor guid for capsule variable and hob.
+ It also defines capsule varialbe name and capsule guid hob data structure.
They are used by EDKII implementation of capsule update across a system reset.
Copyright (c) 2006 - 2008, Intel Corporation
diff --git a/MdeModulePkg/Include/Guid/GenericPlatformVariable.h b/MdeModulePkg/Include/Guid/GenericPlatformVariable.h index 92c73234f0..f63fe9588d 100644 --- a/MdeModulePkg/Include/Guid/GenericPlatformVariable.h +++ b/MdeModulePkg/Include/Guid/GenericPlatformVariable.h @@ -1,6 +1,6 @@ /** @file
This file defines the genenic platform guid for EFI variable.
- Common drivers can use this generic guid with its variable name to specify
+ Generic drivers can use this guid with its variable name to specify
its EFI variable without defining another new guid.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
diff --git a/MdeModulePkg/Include/MdeModuleHii.h b/MdeModulePkg/Include/MdeModuleHii.h index 9f5c3e3e0e..092cdaf310 100644 --- a/MdeModulePkg/Include/MdeModuleHii.h +++ b/MdeModulePkg/Include/MdeModuleHii.h @@ -1,5 +1,5 @@ /** @file
- EDK II implementation specific HII relative definition.
+ EDKII extented HII IFR guid opcodes.
Copyright (c) 2006 - 2008, Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -98,9 +98,9 @@ typedef struct _EFI_IFR_GUID_BANNER { /// 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;
///
@@ -116,7 +116,7 @@ typedef struct _EFI_IFR_GUID_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
@@ -140,7 +140,7 @@ typedef struct _EFI_IFR_GUID_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
@@ -161,7 +161,7 @@ typedef struct _EFI_IFR_GUID_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;
///
diff --git a/MdeModulePkg/Include/VariableFormat.h b/MdeModulePkg/Include/VariableFormat.h index 2f7c7c6663..6e4ad1a9ca 100644 --- a/MdeModulePkg/Include/VariableFormat.h +++ b/MdeModulePkg/Include/VariableFormat.h @@ -1,5 +1,6 @@ /** @file
- The variable data structure related to EDK II specific UEFI variable implementation.
+ The variable data structures are related to EDK II specific UEFI variable implementation.
+ Variable data header and Variable storage region header are defined here.
Copyright (c) 2006 - 2008 Intel Corporation. <BR>
All rights reserved. This program and the accompanying materials
@@ -16,23 +17,8 @@ #define __VARIABLE_FORMAT_H__
///
-/// Maximum buffer for the single variable.
-///
-#ifndef MAX_VARIABLE_SIZE
-#define MAX_VARIABLE_SIZE FixedPcdGet32(PcdMaxVariableSize)
-#endif
-
-///
-/// Maximum buffer for Hardware error record variable
-///
-#ifndef MAX_HARDWARE_ERROR_VARIABLE_SIZE
-#define MAX_HARDWARE_ERROR_VARIABLE_SIZE FixedPcdGet32(PcdMaxHardwareErrorVariableSize)
-#endif
-
-///
-/// The alignment of variable's start offset.
-/// For IA32/X64 architecture, the alignment is set to 1, and
-/// 8 is for IPF archtecture.
+/// Alignment of variable name and data.
+/// For IA32/X64 architecture, the alignment is set to 1, and 8 is for IPF archtecture.
///
#if defined (MDE_CPU_IPF)
#define ALIGNMENT 8
@@ -40,10 +26,23 @@ #define ALIGNMENT 1
#endif
+//
+// Define GET_PAD_SIZE to optimize compiler
+//
+#if ((ALIGNMENT == 0) || (ALIGNMENT == 1))
+#define GET_PAD_SIZE(a) (0)
+#else
+#define GET_PAD_SIZE(a) (((~a) + 1) & (ALIGNMENT - 1))
+#endif
+
+///
+/// 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)))
///
-/// Variable Store Status
+/// Status of Variable Store Region
///
typedef enum {
EfiRaw,
@@ -100,7 +99,7 @@ typedef struct { #define VAR_ADDED 0x3f ///< Variable has been completely added
///
-/// Variable Data Header Structure
+/// Single Variable Data Header Structure
///
typedef struct {
///
@@ -125,7 +124,7 @@ typedef struct { ///
UINT32 DataSize;
///
- /// A unique identifier for the vendor.
+ /// A unique identifier for the vendor that produce and consume this varaible.
///
EFI_GUID VendorGuid;
} VARIABLE_HEADER;
diff --git a/MdeModulePkg/Include/WorkingBlockHeader.h b/MdeModulePkg/Include/WorkingBlockHeader.h index 93a0c8d934..4298d5fe18 100644 --- a/MdeModulePkg/Include/WorkingBlockHeader.h +++ b/MdeModulePkg/Include/WorkingBlockHeader.h @@ -20,8 +20,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. #define WORKING_BLOCK_INVALID 0x2
///
-/// EFI Fault tolerant working block header
-/// The header is immediately followed by the write queue.
+/// EDKII Fault tolerant working block header
+/// The header is immediately followed by the write queue data.
///
typedef struct {
///
|