tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen issue: 

1) comment for structure should be in doxygen format, such as /// , /**, /*!
2) comment for data field of structure should in doxygen format.
3) should not exist blank between ") (" when declaring a type of function point.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5363 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
klu2 2008-06-24 04:37:24 +00:00
parent 6de794cd4a
commit dc53faa3a2
6 changed files with 298 additions and 181 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
MdePkg/Include/Pi/PiBootMode.h
View File

@ -20,6 +20,9 @@
#include <ProcessorBind.h> #include <ProcessorBind.h>
///
/// EFI boot mode
///
typedef UINT32 EFI_BOOT_MODE; typedef UINT32 EFI_BOOT_MODE;
// //

121
MdePkg/Include/Pi/PiDxeCis.h
View File

@ -20,9 +20,9 @@
#include <Pi/PiMultiPhase.h> #include <Pi/PiMultiPhase.h>
// ///
// Global Coherencey Domain types /// Global Coherencey Domain types - Memory type
// ///
typedef enum { typedef enum {
EfiGcdMemoryTypeNonExistent, EfiGcdMemoryTypeNonExistent,
EfiGcdMemoryTypeReserved, EfiGcdMemoryTypeReserved,
@ -31,7 +31,9 @@ typedef enum {
EfiGcdMemoryTypeMaximum EfiGcdMemoryTypeMaximum
} EFI_GCD_MEMORY_TYPE; } EFI_GCD_MEMORY_TYPE;
///
/// Global Coherencey Domain types - IO type
///
typedef enum { typedef enum {
EfiGcdIoTypeNonExistent, EfiGcdIoTypeNonExistent,
EfiGcdIoTypeReserved, EfiGcdIoTypeReserved,
@ -39,7 +41,9 @@ typedef enum {
EfiGcdIoTypeMaximum EfiGcdIoTypeMaximum
} EFI_GCD_IO_TYPE; } EFI_GCD_IO_TYPE;
///
/// The type of allocation to perform.
///
typedef enum { typedef enum {
EfiGcdAllocateAnySearchBottomUp, EfiGcdAllocateAnySearchBottomUp,
EfiGcdAllocateMaxAddressSearchBottomUp, EfiGcdAllocateMaxAddressSearchBottomUp,
@ -49,23 +53,92 @@ typedef enum {
EfiGcdMaxAllocateType EfiGcdMaxAllocateType
} EFI_GCD_ALLOCATE_TYPE; } EFI_GCD_ALLOCATE_TYPE;
///
/// EFI_GCD_MEMORY_SPACE_DESCRIPTOR
///
typedef struct { 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
///
EFI_PHYSICAL_ADDRESS BaseAddress; EFI_PHYSICAL_ADDRESS BaseAddress;
///
/// The number of bytes in the memory region.
///
UINT64 Length; UINT64 Length;
///
/// The bit mask of attributes that the memory region is capable of supporting. The bit
/// mask of available attributes is defined in the GetMemoryMap() function description
/// in the UEFI 2.0 specification.
///
UINT64 Capabilities; UINT64 Capabilities;
///
/// The bit mask of attributes that the memory region is currently using. The bit mask of
/// available attributes is defined in GetMemoryMap().
///
UINT64 Attributes; UINT64 Attributes;
///
/// Type of the memory region. Type EFI_GCD_MEMORY_TYPE is defined in the
/// AddMemorySpace() function description
///
EFI_GCD_MEMORY_TYPE GcdMemoryType; EFI_GCD_MEMORY_TYPE GcdMemoryType;
///
/// The image handle of the agent that allocated the memory resource described by
/// PhysicalStart and NumberOfBytes. If this field is NULL, then the memory
/// resource is not currently allocated. Type EFI_HANDLE is defined in
/// InstallProtocolInterface() in the UEFI 2.0 specification.
///
EFI_HANDLE ImageHandle; EFI_HANDLE ImageHandle;
///
/// The device handle for which the memory resource has been allocated. If
/// ImageHandle is NULL, then the memory resource is not currently allocated. If this
/// field is NULL, then the memory resource is not associated with a device that is
/// described by a device handle. Type EFI_HANDLE is defined in
/// InstallProtocolInterface() in the UEFI 2.0 specification.
///
EFI_HANDLE DeviceHandle; EFI_HANDLE DeviceHandle;
} EFI_GCD_MEMORY_SPACE_DESCRIPTOR; } EFI_GCD_MEMORY_SPACE_DESCRIPTOR;
///
/// EFI_GCD_IO_SPACE_DESCRIPTOR
///
typedef struct { typedef struct {
///
/// Physical address of the first byte in the I/O region. Type
/// EFI_PHYSICAL_ADDRESS is defined in the AllocatePages() function
/// description in the UEFI 2.0 specification.
///
EFI_PHYSICAL_ADDRESS BaseAddress; EFI_PHYSICAL_ADDRESS BaseAddress;
/// Number of bytes in the I/O region.
UINT64 Length; UINT64 Length;
///
/// Type of the I/O region. Type EFI_GCD_IO_TYPE is defined in the
/// AddIoSpace() function description.
///
EFI_GCD_IO_TYPE GcdIoType; EFI_GCD_IO_TYPE GcdIoType;
///
/// The image handle of the agent that allocated the I/O resource described by
/// PhysicalStart and NumberOfBytes. If this field is NULL, then the I/O
/// resource is not currently allocated. Type EFI_HANDLE is defined in
/// InstallProtocolInterface() in the UEFI 2.0 specification.
///
EFI_HANDLE ImageHandle; EFI_HANDLE ImageHandle;
///
/// The device handle for which the I/O resource has been allocated. If ImageHandle
/// is NULL, then the I/O resource is not currently allocated. If this field is NULL, then
/// the I/O resource is not associated with a device that is described by a device handle.
/// Type EFI_HANDLE is defined in InstallProtocolInterface() in the UEFI
/// 2.0 specification.
///
EFI_HANDLE DeviceHandle; EFI_HANDLE DeviceHandle;
} EFI_GCD_IO_SPACE_DESCRIPTOR; } EFI_GCD_IO_SPACE_DESCRIPTOR;
@ -84,7 +157,7 @@ typedef struct {
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_ADD_MEMORY_SPACE) ( (EFIAPI *EFI_ADD_MEMORY_SPACE)(
IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length, IN UINT64 Length,
@ -111,7 +184,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_ALLOCATE_MEMORY_SPACE) ( (EFIAPI *EFI_ALLOCATE_MEMORY_SPACE)(
IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
IN EFI_GCD_MEMORY_TYPE GcdMemoryType, IN EFI_GCD_MEMORY_TYPE GcdMemoryType,
IN UINTN Alignment, IN UINTN Alignment,
@ -134,7 +207,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FREE_MEMORY_SPACE) ( (EFIAPI *EFI_FREE_MEMORY_SPACE)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length IN UINT64 Length
) )
@ -152,7 +225,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_REMOVE_MEMORY_SPACE) ( (EFIAPI *EFI_REMOVE_MEMORY_SPACE)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length IN UINT64 Length
) )
@ -170,7 +243,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_MEMORY_SPACE_DESCRIPTOR) ( (EFIAPI *EFI_GET_MEMORY_SPACE_DESCRIPTOR)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR *Descriptor
) )
@ -189,7 +262,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SET_MEMORY_SPACE_ATTRIBUTES) ( (EFIAPI *EFI_SET_MEMORY_SPACE_ATTRIBUTES)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length, IN UINT64 Length,
IN UINT64 Attributes IN UINT64 Attributes
@ -210,7 +283,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_MEMORY_SPACE_MAP) ( (EFIAPI *EFI_GET_MEMORY_SPACE_MAP)(
OUT UINTN *NumberOfDescriptors, OUT UINTN *NumberOfDescriptors,
OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap OUT EFI_GCD_MEMORY_SPACE_DESCRIPTOR **MemorySpaceMap
) )
@ -228,7 +301,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_ADD_IO_SPACE) ( (EFIAPI *EFI_ADD_IO_SPACE)(
IN EFI_GCD_IO_TYPE GcdIoType, IN EFI_GCD_IO_TYPE GcdIoType,
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length IN UINT64 Length
@ -254,7 +327,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_ALLOCATE_IO_SPACE) ( (EFIAPI *EFI_ALLOCATE_IO_SPACE)(
IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType, IN EFI_GCD_ALLOCATE_TYPE GcdAllocateType,
IN EFI_GCD_IO_TYPE GcdIoType, IN EFI_GCD_IO_TYPE GcdIoType,
IN UINTN Alignment, IN UINTN Alignment,
@ -277,7 +350,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_FREE_IO_SPACE) ( (EFIAPI *EFI_FREE_IO_SPACE)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length IN UINT64 Length
) )
@ -295,7 +368,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_REMOVE_IO_SPACE) ( (EFIAPI *EFI_REMOVE_IO_SPACE)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
IN UINT64 Length IN UINT64 Length
) )
@ -313,7 +386,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_IO_SPACE_DESCRIPTOR) ( (EFIAPI *EFI_GET_IO_SPACE_DESCRIPTOR)(
IN EFI_PHYSICAL_ADDRESS BaseAddress, IN EFI_PHYSICAL_ADDRESS BaseAddress,
OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor OUT EFI_GCD_IO_SPACE_DESCRIPTOR *Descriptor
) )
@ -332,7 +405,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_GET_IO_SPACE_MAP) ( (EFIAPI *EFI_GET_IO_SPACE_MAP)(
OUT UINTN *NumberOfDescriptors, OUT UINTN *NumberOfDescriptors,
OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap OUT EFI_GCD_IO_SPACE_DESCRIPTOR **IoSpaceMap
) )
@ -348,7 +421,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_DISPATCH) ( (EFIAPI *EFI_DISPATCH)(
VOID VOID
) )
; ;
@ -364,7 +437,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_SCHEDULE) ( (EFIAPI *EFI_SCHEDULE)(
IN EFI_HANDLE FirmwareVolumeHandle, IN EFI_HANDLE FirmwareVolumeHandle,
IN EFI_GUID *DriverName IN EFI_GUID *DriverName
) )
@ -381,7 +454,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_TRUST) ( (EFIAPI *EFI_TRUST)(
IN EFI_HANDLE FirmwareVolumeHandle, IN EFI_HANDLE FirmwareVolumeHandle,
IN EFI_GUID *DriverName IN EFI_GUID *DriverName
) )
@ -399,7 +472,7 @@ EFI_STATUS
**/ **/
typedef typedef
EFI_STATUS EFI_STATUS
(EFIAPI *EFI_PROCESS_FIRMWARE_VOLUME) ( (EFIAPI *EFI_PROCESS_FIRMWARE_VOLUME)(
IN VOID *FvHeader, IN VOID *FvHeader,
IN UINTN Size, IN UINTN Size,
OUT EFI_HANDLE *FirmwareVolumeHandle OUT EFI_HANDLE *FirmwareVolumeHandle

155
MdePkg/Include/Pi/PiFirmwareFile.h
View File

@ -22,9 +22,9 @@
#include <ProcessorBind.h> #include <ProcessorBind.h>
#pragma pack(1) #pragma pack(1)
// ///
// Used to verify the integrity of the file. /// Used to verify the integrity of the file.
// ///
typedef union { typedef union {
struct { struct {
UINT8 Header; UINT8 Header;
@ -37,9 +37,9 @@ typedef UINT8 EFI_FV_FILETYPE;
typedef UINT8 EFI_FFS_FILE_ATTRIBUTES; typedef UINT8 EFI_FFS_FILE_ATTRIBUTES;
typedef UINT8 EFI_FFS_FILE_STATE; typedef UINT8 EFI_FFS_FILE_STATE;
// ///
// File Types Definitions /// File Types Definitions
// ///
#define EFI_FV_FILETYPE_ALL 0x00 #define EFI_FV_FILETYPE_ALL 0x00
#define EFI_FV_FILETYPE_RAW 0x01 #define EFI_FV_FILETYPE_RAW 0x01
#define EFI_FV_FILETYPE_FREEFORM 0x02 #define EFI_FV_FILETYPE_FREEFORM 0x02
@ -58,16 +58,16 @@ typedef UINT8 EFI_FFS_FILE_STATE;
#define EFI_FV_FILETYPE_FFS_MIN 0xf0 #define EFI_FV_FILETYPE_FFS_MIN 0xf0
#define EFI_FV_FILETYPE_FFS_MAX 0xff #define EFI_FV_FILETYPE_FFS_MAX 0xff
#define EFI_FV_FILETYPE_FFS_PAD 0xf0 #define EFI_FV_FILETYPE_FFS_PAD 0xf0
// ///
// FFS File Attributes. /// FFS File Attributes.
// ///
#define FFS_ATTRIB_FIXED 0x04 #define FFS_ATTRIB_FIXED 0x04
#define FFS_ATTRIB_DATA_ALIGNMENT 0x38 #define FFS_ATTRIB_DATA_ALIGNMENT 0x38
#define FFS_ATTRIB_CHECKSUM 0x40 #define FFS_ATTRIB_CHECKSUM 0x40
// ///
// FFS File State Bits. /// FFS File State Bits.
// ///
#define EFI_FILE_HEADER_CONSTRUCTION 0x01 #define EFI_FILE_HEADER_CONSTRUCTION 0x01
#define EFI_FILE_HEADER_VALID 0x02 #define EFI_FILE_HEADER_VALID 0x02
#define EFI_FILE_DATA_VALID 0x04 #define EFI_FILE_DATA_VALID 0x04
@ -76,10 +76,10 @@ typedef UINT8 EFI_FFS_FILE_STATE;
#define EFI_FILE_HEADER_INVALID 0x20 #define EFI_FILE_HEADER_INVALID 0x20
// ///
// Each file begins with the header that describe the /// Each file begins with the header that describe the
// contents and state of the files. /// contents and state of the files.
// ///
typedef struct { typedef struct {
EFI_GUID Name; EFI_GUID Name;
EFI_FFS_INTEGRITY_CHECK IntegrityCheck; EFI_FFS_INTEGRITY_CHECK IntegrityCheck;
@ -92,23 +92,23 @@ typedef struct {
typedef UINT8 EFI_SECTION_TYPE; typedef UINT8 EFI_SECTION_TYPE;
// ///
// Pseudo type. It is /// Pseudo type. It is
// used as a wild card when retrieving sections. The section /// used as a wild card when retrieving sections. The section
// type EFI_SECTION_ALL matches all section types. /// type EFI_SECTION_ALL matches all section types.
// ///
#define EFI_SECTION_ALL 0x00 #define EFI_SECTION_ALL 0x00
// ///
// Encapsulation section Type values /// Encapsulation section Type values
// ///
#define EFI_SECTION_COMPRESSION 0x01 #define EFI_SECTION_COMPRESSION 0x01
#define EFI_SECTION_GUID_DEFINED 0x02 #define EFI_SECTION_GUID_DEFINED 0x02
// ///
// Leaf section Type values /// Leaf section Type values
// ///
#define EFI_SECTION_PE32 0x10 #define EFI_SECTION_PE32 0x10
#define EFI_SECTION_PIC 0x11 #define EFI_SECTION_PIC 0x11
#define EFI_SECTION_TE 0x12 #define EFI_SECTION_TE 0x12
@ -121,58 +121,61 @@ typedef UINT8 EFI_SECTION_TYPE;
#define EFI_SECTION_RAW 0x19 #define EFI_SECTION_RAW 0x19
#define EFI_SECTION_PEI_DEPEX 0x1B #define EFI_SECTION_PEI_DEPEX 0x1B
///
/// Common section header
///
typedef struct { typedef struct {
UINT8 Size[3]; UINT8 Size[3];
EFI_SECTION_TYPE Type; EFI_SECTION_TYPE Type;
} EFI_COMMON_SECTION_HEADER; } EFI_COMMON_SECTION_HEADER;
// ///
// Leaf section type that contains an /// Leaf section type that contains an
// IA-32 16-bit executable image. /// IA-32 16-bit executable image.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_COMPATIBILITY16_SECTION;
// ///
// CompressionType of EFI_COMPRESSION_SECTION. /// CompressionType of EFI_COMPRESSION_SECTION.
// ///
#define EFI_NOT_COMPRESSED 0x00 #define EFI_NOT_COMPRESSED 0x00
#define EFI_STANDARD_COMPRESSION 0x01 #define EFI_STANDARD_COMPRESSION 0x01
// ///
// An encapsulation section type in which the /// An encapsulation section type in which the
// section data is compressed. /// section data is compressed.
// ///
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
UINT32 UncompressedLength; UINT32 UncompressedLength;
UINT8 CompressionType; UINT8 CompressionType;
} EFI_COMPRESSION_SECTION; } EFI_COMPRESSION_SECTION;
// ///
// Leaf section which could be used to determine the dispatch order of DXEs. /// 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_HEADER EFI_DXE_DEPEX_SECTION;
// ///
// Leaf section witch contains a PI FV. /// Leaf section witch contains a PI FV.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_FIRMWARE_VOLUME_IMAGE_SECTION;
// ///
// Leaf section which contains a single GUID. /// Leaf section which contains a single GUID.
// ///
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
EFI_GUID SubTypeGuid; EFI_GUID SubTypeGuid;
} EFI_FREEFORM_SUBTYPE_GUID_SECTION; } EFI_FREEFORM_SUBTYPE_GUID_SECTION;
// ///
// Attributes of EFI_GUID_DEFINED_SECTION /// Attributes of EFI_GUID_DEFINED_SECTION
// ///
#define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01 #define EFI_GUIDED_SECTION_PROCESSING_REQUIRED 0x01
#define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02 #define EFI_GUIDED_SECTION_AUTH_STATUS_VALID 0x02
// ///
// Leaf section which is encapsulation defined by specific GUID /// Leaf section which is encapsulation defined by specific GUID
// ///
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
EFI_GUID SectionDefinitionGuid; EFI_GUID SectionDefinitionGuid;
@ -180,45 +183,45 @@ typedef struct {
UINT16 Attributes; UINT16 Attributes;
} EFI_GUID_DEFINED_SECTION; } EFI_GUID_DEFINED_SECTION;
// ///
// Leaf section which contains PE32+ image. /// Leaf section which contains PE32+ image.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_PE32_SECTION;
// ///
// Leaf section which used to determine the dispatch order of PEIMs. /// Leaf section which used to determine the dispatch order of PEIMs.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_PEI_DEPEX_SECTION;
// ///
// Leaf section which constains the position-independent-code image. /// Leaf section which constains the position-independent-code image.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_TE_SECTION;
// ///
// Leaf section which contains an array of zero or more bytes. /// Leaf section which contains an array of zero or more bytes.
// ///
typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION; typedef EFI_COMMON_SECTION_HEADER EFI_RAW_SECTION;
// ///
// Leaf section which contains a unicode string that /// Leaf section which contains a unicode string that
// is human readable file name. /// is human readable file name.
// ///
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
// ///
// Array of unicode string. /// Array of unicode string.
// ///
CHAR16 FileNameString[1]; CHAR16 FileNameString[1];
} EFI_USER_INTERFACE_SECTION; } EFI_USER_INTERFACE_SECTION;
// ///
// Leaf section which contains a numeric build number and /// Leaf section which contains a numeric build number and
// an optional unicode string that represent the file revision. /// an optional unicode string that represent the file revision.
// ///
typedef struct { typedef struct {
EFI_COMMON_SECTION_HEADER CommonHeader; EFI_COMMON_SECTION_HEADER CommonHeader;
UINT16 BuildNumber; UINT16 BuildNumber;

21
MdePkg/Include/Pi/PiFirmwareVolume.h
View File

@ -20,9 +20,9 @@
#include <ProcessorBind.h> #include <ProcessorBind.h>
// ///
// EFI_FV_FILE_ATTRIBUTES /// EFI_FV_FILE_ATTRIBUTES
// ///
typedef UINT32 EFI_FV_FILE_ATTRIBUTES; typedef UINT32 EFI_FV_FILE_ATTRIBUTES;
// //
@ -32,6 +32,9 @@ typedef UINT32 EFI_FV_FILE_ATTRIBUTES;
#define EFI_FV_FILE_ATTRIB_FIXED 0x00000100 #define EFI_FV_FILE_ATTRIB_FIXED 0x00000100
#define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200 #define EFI_FV_FILE_ATTRIB_MEMORY_MAPPED 0x00000200
///
/// type of EFI FVB attribute
///
typedef UINT32 EFI_FVB_ATTRIBUTES; typedef UINT32 EFI_FVB_ATTRIBUTES;
// //
@ -116,20 +119,26 @@ typedef struct {
/// ///
#define EFI_FVH_REVISION 0x02 #define EFI_FVH_REVISION 0x02
// ///
// Extension header pointed by ExtHeaderOffset of volume header. /// Extension header pointed by ExtHeaderOffset of volume header.
// ///
typedef struct { typedef struct {
EFI_GUID FvName; EFI_GUID FvName;
UINT32 ExtHeaderSize; UINT32 ExtHeaderSize;
} EFI_FIRMWARE_VOLUME_EXT_HEADER; } EFI_FIRMWARE_VOLUME_EXT_HEADER;
///
/// Entry struture for describing FV extension header
///
typedef struct { typedef struct {
UINT16 ExtEntrySize; UINT16 ExtEntrySize;
UINT16 ExtEntryType; UINT16 ExtEntryType;
} EFI_FIRMWARE_VOLUME_EXT_ENTRY; } EFI_FIRMWARE_VOLUME_EXT_ENTRY;
#define EFI_FV_EXT_TYPE_OEM_TYPE 0x01 #define EFI_FV_EXT_TYPE_OEM_TYPE 0x01
///
/// This extension header provides a mapping between a GUID and an OEM file type.
///
typedef struct { typedef struct {
EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr; EFI_FIRMWARE_VOLUME_EXT_ENTRY Hdr;
UINT32 TypeMask; UINT32 TypeMask;

155
MdePkg/Include/Pi/PiHob.h
View File

@ -38,10 +38,10 @@
#define EFI_HOB_TYPE_UNUSED 0xFFFE #define EFI_HOB_TYPE_UNUSED 0xFFFE
#define EFI_HOB_TYPE_END_OF_HOB_LIST 0xFFFF #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. /// All HOBs must contain this generic HOB header.
// ///
typedef struct { typedef struct {
UINT16 HobType; UINT16 HobType;
UINT16 HobLength; UINT16 HobLength;
@ -49,14 +49,15 @@ typedef struct {
} EFI_HOB_GENERIC_HEADER; } EFI_HOB_GENERIC_HEADER;
// ///
// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE. /// Value of version ofinEFI_HOB_HANDOFF_INFO_TABLE.
// ///
#define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009 #define EFI_HOB_HANDOFF_TABLE_VERSION 0x0009
//
// Contains general state information used by the HOB producer phase. ///
// This HOB must be the first one in the HOB list. /// Contains general state information used by the HOB producer phase.
// /// This HOB must be the first one in the HOB list.
///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
UINT32 Version; UINT32 Version;
@ -68,25 +69,46 @@ typedef struct {
EFI_PHYSICAL_ADDRESS EfiEndOfHobList; EFI_PHYSICAL_ADDRESS EfiEndOfHobList;
} EFI_HOB_HANDOFF_INFO_TABLE; } 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 { 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.
///
EFI_GUID Name; EFI_GUID Name;
/// The base address of memory allocated by this HOB. Type
/// EFI_PHYSICAL_ADDRESS is defined in AllocatePages() in the UEFI 2.0
/// specification.
EFI_PHYSICAL_ADDRESS MemoryBaseAddress; EFI_PHYSICAL_ADDRESS MemoryBaseAddress;
/// The length in bytes of memory allocated by this HOB.
UINT64 MemoryLength; 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; EFI_MEMORY_TYPE MemoryType;
// ///
// Padding for Itanium processor family /// Padding for Itanium processor family
// ///
UINT8 Reserved[4]; UINT8 Reserved[4];
} EFI_HOB_MEMORY_ALLOCATION_HEADER; } EFI_HOB_MEMORY_ALLOCATION_HEADER;
// ///
// Describes all memory ranges used during the HOB producer /// Describes all memory ranges used during the HOB producer
// phase that exist outside the HOB list. This HOB type /// phase that exist outside the HOB list. This HOB type
// describes how memory is used, /// describes how memory is used,
// not the physical attributes of memory. /// not the physical attributes of memory.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor; EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
@ -97,30 +119,30 @@ typedef struct {
} EFI_HOB_MEMORY_ALLOCATION; } EFI_HOB_MEMORY_ALLOCATION;
// ///
// 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 postmemory-installed executable /// phase and upon which all postmemory-installed executable
// content in the HOB producer phase is executing. /// content in the HOB producer phase is executing.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor; EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
} EFI_HOB_MEMORY_ALLOCATION_STACK; } 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"). /// 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. /// register overflow store.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor; EFI_HOB_MEMORY_ALLOCATION_HEADER AllocDescriptor;
} EFI_HOB_MEMORY_ALLOCATION_BSP_STORE; } EFI_HOB_MEMORY_ALLOCATION_BSP_STORE;
// ///
// Defines the location and entry point of the HOB consumer phase. /// Defines the location and entry point of the HOB consumer phase.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader; EFI_HOB_MEMORY_ALLOCATION_HEADER MemoryAllocationHeader;
@ -128,6 +150,9 @@ typedef struct {
EFI_PHYSICAL_ADDRESS EntryPoint; EFI_PHYSICAL_ADDRESS EntryPoint;
} EFI_HOB_MEMORY_ALLOCATION_MODULE; } EFI_HOB_MEMORY_ALLOCATION_MODULE;
///
/// type of Recount type
///
typedef UINT32 EFI_RESOURCE_TYPE; typedef UINT32 EFI_RESOURCE_TYPE;
// //
@ -142,7 +167,9 @@ typedef UINT32 EFI_RESOURCE_TYPE;
#define EFI_RESOURCE_IO_RESERVED 0x00000006 #define EFI_RESOURCE_IO_RESERVED 0x00000006
#define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007 #define EFI_RESOURCE_MAX_MEMORY_TYPE 0x00000007
///
/// type of recount attribute type
///
typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE; typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
// //
@ -172,11 +199,11 @@ typedef UINT32 EFI_RESOURCE_ATTRIBUTE_TYPE;
#define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000 #define EFI_RESOURCE_ATTRIBUTE_64_BIT_IO 0x00010000
#define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000 #define EFI_RESOURCE_ATTRIBUTE_UNCACHED_EXPORTED 0x00020000
// ///
// Describes the resource properties of all fixed, /// Describes the resource properties of all fixed,
// nonrelocatable resource ranges found on the processor /// nonrelocatable resource ranges found on the processor
// host bus during the HOB producer phase. /// host bus during the HOB producer phase.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_GUID Owner; EFI_GUID Owner;
@ -186,32 +213,32 @@ typedef struct {
UINT64 ResourceLength; UINT64 ResourceLength;
} EFI_HOB_RESOURCE_DESCRIPTOR; } 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. /// maintain and manage HOBs with specific GUID.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_GUID Name; EFI_GUID Name;
// ///
// Guid specific data goes here /// Guid specific data goes here
// ///
} EFI_HOB_GUID_TYPE; } EFI_HOB_GUID_TYPE;
// ///
// Details the location of firmware volumes that contain firmware files. /// Details the location of firmware volumes that contain firmware files.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_PHYSICAL_ADDRESS BaseAddress; EFI_PHYSICAL_ADDRESS BaseAddress;
UINT64 Length; UINT64 Length;
} EFI_HOB_FIRMWARE_VOLUME; } EFI_HOB_FIRMWARE_VOLUME;
// ///
// Details the location of a firmware volume which was extracted /// Details the location of a firmware volume which was extracted
// from a file within another firmware volume. /// from a file within another firmware volume.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
EFI_PHYSICAL_ADDRESS BaseAddress; EFI_PHYSICAL_ADDRESS BaseAddress;
@ -221,9 +248,9 @@ typedef struct {
} EFI_HOB_FIRMWARE_VOLUME2; } EFI_HOB_FIRMWARE_VOLUME2;
// ///
// Describes processor information, such as address space and I/O space capabilities. /// Describes processor information, such as address space and I/O space capabilities.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
UINT8 SizeOfMemorySpace; UINT8 SizeOfMemorySpace;
@ -232,16 +259,16 @@ typedef struct {
} EFI_HOB_CPU; } EFI_HOB_CPU;
// ///
// Describes pool memory allocations. /// Describes pool memory allocations.
// ///
typedef struct { typedef struct {
EFI_HOB_GENERIC_HEADER Header; EFI_HOB_GENERIC_HEADER Header;
} EFI_HOB_MEMORY_POOL; } EFI_HOB_MEMORY_POOL;
// ///
// Union of all the possible HOB Types /// Union of all the possible HOB Types
// ///
typedef union { typedef union {
EFI_HOB_GENERIC_HEADER *Header; EFI_HOB_GENERIC_HEADER *Header;
EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable; EFI_HOB_HANDOFF_INFO_TABLE *HandoffInformationTable;

24
MdePkg/Include/Pi/PiMultiPhase.h
View File

@ -30,9 +30,9 @@
#define EFI_NOT_AVAILABLE_YET EFIERR (32) #define EFI_NOT_AVAILABLE_YET EFIERR (32)
// ///
// Status Code Type Definition /// Status Code Type Definition
// ///
typedef UINT32 EFI_STATUS_CODE_TYPE; typedef UINT32 EFI_STATUS_CODE_TYPE;
// //
@ -67,10 +67,11 @@ typedef UINT32 EFI_STATUS_CODE_TYPE;
#define EFI_ERROR_UNRECOVERED 0x90000000 #define EFI_ERROR_UNRECOVERED 0x90000000
#define EFI_ERROR_UNCONTAINED 0xa0000000 #define EFI_ERROR_UNCONTAINED 0xa0000000
// ///
// Status Code Value Definition /// Status Code Value Definition
// ///
typedef UINT32 EFI_STATUS_CODE_VALUE; typedef UINT32 EFI_STATUS_CODE_VALUE;
// //
// A Status Code Value is made up of the class, subclass, and // A Status Code Value is made up of the class, subclass, and
// an operation. // an operation.
@ -78,11 +79,12 @@ typedef UINT32 EFI_STATUS_CODE_VALUE;
#define EFI_STATUS_CODE_CLASS_MASK 0xFF000000 #define EFI_STATUS_CODE_CLASS_MASK 0xFF000000
#define EFI_STATUS_CODE_SUBCLASS_MASK 0x00FF0000 #define EFI_STATUS_CODE_SUBCLASS_MASK 0x00FF0000
#define EFI_STATUS_CODE_OPERATION_MASK 0x0000FFFF #define EFI_STATUS_CODE_OPERATION_MASK 0x0000FFFF
//
// Definition of Status Code extended data header. ///
// The data will follow HeaderSize bytes from the beginning of /// Definition of Status Code extended data header.
// the structure and is Size bytes long. /// The data will follow HeaderSize bytes from the beginning of
// /// the structure and is Size bytes long.
///
typedef struct { typedef struct {
UINT16 HeaderSize; UINT16 HeaderSize;
UINT16 Size; UINT16 Size;