From 25cfda03f6f5942a0c8508af8d31d3b15b736634 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Mon, 8 Dec 2008 03:24:04 +0000 Subject: [PATCH] Remove undefined comments for status PCD. Add comments for DebugImageInfoTable, FileInfo, FileSystemInfo and FileSystemVolumeLabelInfo Guid structure. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6914 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Guid/DebugImageInfoTable.h | 29 ++++++++++++--- MdePkg/Include/Guid/FileInfo.h | 36 ++++++++++++++----- MdePkg/Include/Guid/FileSystemInfo.h | 24 +++++++++++-- .../Include/Guid/FileSystemVolumeLabelInfo.h | 10 +++--- MdePkg/MdePkg.dec | 19 ---------- 5 files changed, 81 insertions(+), 37 deletions(-) diff --git a/MdePkg/Include/Guid/DebugImageInfoTable.h b/MdePkg/Include/Guid/DebugImageInfoTable.h index d86e64f02e..4404ace03b 100644 --- a/MdePkg/Include/Guid/DebugImageInfoTable.h +++ b/MdePkg/Include/Guid/DebugImageInfoTable.h @@ -20,6 +20,9 @@ #include +/// +/// EFI_DEBUG_IMAGE_INFO_TABLE configuration table GUID declaration. +/// #define EFI_DEBUG_IMAGE_INFO_TABLE_GUID \ { \ 0x49152e77, 0x1ada, 0x4764, {0xb7, 0xa2, 0x7a, 0xfe, 0xfe, 0xd9, 0x5e, 0x8b } \ @@ -31,14 +34,24 @@ #define EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL 0x01 typedef struct { - UINT64 Signature; - EFI_PHYSICAL_ADDRESS EfiSystemTableBase; - UINT32 Crc32; + UINT64 Signature; /// A constant UINT64 that has the value EFI_SYSTEM_TABLE_SIGNATURE + EFI_PHYSICAL_ADDRESS EfiSystemTableBase; /// The physical address of the EFI system table. + UINT32 Crc32; /// A 32-bit CRC value that is used to verify the EFI_SYSTEM_TABLE_POINTER structure is valid. } EFI_SYSTEM_TABLE_POINTER; typedef struct { + /// + /// Indicates the type of image info structure. For PE32 EFI images, + /// this is set to EFI_DEBUG_IMAGE_INFO_TYPE_NORMAL. + /// UINT32 ImageInfoType; + /// + /// A pointer to an instance of the loaded image protocol for the associated image. + /// EFI_LOADED_IMAGE_PROTOCOL *LoadedImageProtocolInstance; + /// + /// Indicates the image handle of the associated image. + /// EFI_HANDLE ImageHandle; } EFI_DEBUG_IMAGE_INFO_NORMAL; @@ -48,12 +61,20 @@ typedef union { } EFI_DEBUG_IMAGE_INFO; typedef struct { + /// + /// UpdateStatus is used by the system to indicate the state of the debug image info table. + /// volatile UINT32 UpdateStatus; + /// + /// The number of EFI_DEBUG_IMAGE_INFO elements in the array pointed to by EfiDebugImageInfoTable. + /// UINT32 TableSize; + /// + /// A pointer to the first element of an array of EFI_DEBUG_IMAGE_INFO structures. + /// EFI_DEBUG_IMAGE_INFO *EfiDebugImageInfoTable; } EFI_DEBUG_IMAGE_INFO_TABLE_HEADER; - extern EFI_GUID gEfiDebugImageInfoTableGuid; #endif diff --git a/MdePkg/Include/Guid/FileInfo.h b/MdePkg/Include/Guid/FileInfo.h index a9f64666f3..271005f309 100644 --- a/MdePkg/Include/Guid/FileInfo.h +++ b/MdePkg/Include/Guid/FileInfo.h @@ -1,13 +1,9 @@ /** @file - SimpleFileSystem guid and data structure as defined in the UEFI 2.0 specification. + Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.SetInfo() + and EFI_FILE_PROTOCOL.GetInfo() to set or get generic file information. + This guid is defined in UEFI specification. - The SimpleFileSystem protocol is the programatic access to the FAT (12,16,32) - file system specified in UEFI 2.0. It can also be used to abstract any - file system other than FAT. - - UEFI 2.0 can boot from any valid EFI image contained in a SimpleFileSystem - - Copyright (c) 2006, Intel Corporation + Copyright (c) 2006 - 2008, 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 @@ -27,13 +23,37 @@ } typedef struct { + /// + /// Size of the EFI_FILE_INFO structure, including the Nullterminated Unicode FileName string. + /// UINT64 Size; + /// + /// The size of the file in bytes. + /// UINT64 FileSize; + /// + /// PhysicalSize The amount of physical space the file consumes on the file system volume. + /// UINT64 PhysicalSize; + /// + /// The time the file was created. + /// EFI_TIME CreateTime; + /// + /// The time when the file was last accessed. + /// EFI_TIME LastAccessTime; + /// + /// The time when the file's contents were last modified. + /// EFI_TIME ModificationTime; + /// + /// The attribute bits for the file. + /// UINT64 Attribute; + /// + /// The Null-terminated Unicode name of the file. + /// CHAR16 FileName[1]; } EFI_FILE_INFO; diff --git a/MdePkg/Include/Guid/FileSystemInfo.h b/MdePkg/Include/Guid/FileSystemInfo.h index 6ed28b4f20..d1515a8c2a 100644 --- a/MdePkg/Include/Guid/FileSystemInfo.h +++ b/MdePkg/Include/Guid/FileSystemInfo.h @@ -1,7 +1,9 @@ /** @file - FileSystemInfo guid and data structure as defined in the UEFI 2.0 specification. + Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo() + or EFI_FILE_PROTOCOL.SetInfo() to get or set information about the system's volume. + This guid is defined in UEFI specification. - Copyright (c) 2006, Intel Corporation + Copyright (c) 2006 - 2008, 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 @@ -21,11 +23,29 @@ } typedef struct { + /// + /// Size of the EFI_FILE_SYSTEM_INFO structure, including the Null-terminated Unicode VolumeLabel string. + /// UINT64 Size; + /// + /// TRUE if the volume only supports read access. + /// BOOLEAN ReadOnly; + /// + /// The number of bytes managed by the file system. + /// UINT64 VolumeSize; + /// + /// The number of available bytes for use by the file system. + /// UINT64 FreeSpace; + /// + /// The nominal block size by which files are typically grown. + /// UINT32 BlockSize; + /// + /// The Null-terminated string that is the volume's label. + /// CHAR16 VolumeLabel[1]; } EFI_FILE_SYSTEM_INFO; diff --git a/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h b/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h index 6413ee7da0..b9c2d4d4a5 100644 --- a/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h +++ b/MdePkg/Include/Guid/FileSystemVolumeLabelInfo.h @@ -1,5 +1,7 @@ /** @file - FileSystemVolumeLabelInfo guid and data structure as defined in the UEFI 2.0 specification. + Provides a GUID and a data structure that can be used with EFI_FILE_PROTOCOL.GetInfo() + or EFI_FILE_PROTOCOL.SetInfo() to get or set the system's volume label. + This guid is defined in UEFI specification. Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials @@ -20,13 +22,13 @@ 0xDB47D7D3, 0xFE81, 0x11d3, {0x9A, 0x35, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } \ } -// -// Protocol Name defined in spec. -// #define EFI_FILE_SYSTEM_VOLUME_LABEL_ID \ EFI_FILE_SYSTEM_VOLUME_LABEL_INFO_ID_GUID typedef struct { + /// + /// The Null-terminated string that is the volume's label. + /// CHAR16 VolumeLabel[1]; } EFI_FILE_SYSTEM_VOLUME_LABEL_INFO; diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index c361db3490..1eb0240fcf 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -440,35 +440,27 @@ gEfiMdePkgTokenSpaceGuid.PcdUefiLibMaxPrintBufferSize|320|UINT32|0x101 ## Status code value for indicating a watchdog timer is expired - # EFI_COMPUTING_UNIT_HOST_PROCESSOR | EFI_CU_HP_EC_TIMER_EXPIRED gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueEfiWatchDogTimerExpired|0x00011003|UINT32|0x00000013 ## Status code value for indicating the invocation of SetVirtualAddressMap() - # EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_RS_PC_SET_VIRTUAL_ADDRESS_MAP gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueSetVirtualAddressMap|0x03101004|UINT32|0x00000014 ## Status code value for indicating the start of memory test - # EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_PC_TEST gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueMemoryTestStarted|0x00051006|UINT32|0x00000015 ## Status code value for indicating memory error in memory test - # EFI_COMPUTING_UNIT_MEMORY | EFI_CU_MEMORY_EC_UNCORRECTABLE gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueUncorrectableMemoryError|0x00051003|UINT32|0x00000016 ## Status code value for indicating the failure of console operation - # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_CONTROLLER_ERROR gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleError|0x01040006|UINT32|0x00000017 ## Status code value for indicating the failure of console reset operation - # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_PC_RESET gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleReset|0x01040001|UINT32|0x00000018 ## Status code value for indicating the failure of console input operation - # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_INPUT_ERROR gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleInputError|0x01040007|UINT32|0x00000019 ## Status code value for indicating the failure of console output operation - # EFI_PERIPHERAL_REMOTE_CONSOLE | EFI_P_EC_OUTPUT_ERROR gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueRemoteConsoleOutputError|0x01040008|UINT32|0x0000001a ## Status code value for indicating the failure of mouse operation @@ -542,35 +534,27 @@ gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType|0|UINT8|0x00000024 ## Status code value for indicating the handoff from Pei phase to Dxe phase - # EFI_SOFTWARE_PEI_MODULE | EFI_SW_PEI_CORE_PC_HANDOFF_TO_NEXT gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeiHandoffToDxe|0x3031001|UINT32|0x3000100d ## Status code value for indicating one PEIM is dispatched. - # value: EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT_BEGIN gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeimDispatch|0x3020002|UINT32|0x3000100e ## Status code value for indicating entering PeiCore - # value: EFI_SOFTWARE_PEI_CORE | EFI_SW_PC_INIT gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValuePeiCoreEntry|0x3020000|UINT32|0x3000100f ## Status code value for indicating entering DxeCore - # EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_ENTRY_POINT gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeCoreEntry|0x3041000|UINT32|0x30001010 ## Status code value for indicating the handoff from DxeCore to Bds - # EFI_SOFTWARE_DXE_CORE | EFI_SW_DXE_CORE_PC_HANDOFF_TO_NEXT gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeCoreHandoffToBds|0x3041001|UINT32|0x30001011 ## Status code value for indicating the exit of boot service - # EFI_SOFTWARE_EFI_BOOT_SERVICE | EFI_SW_BS_PC_EXIT_BOOT_SERVICES gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueBootServiceExit|0x3100019|UINT32|0x30001012 ## Status code value for indicating the begin of Dxe driver - # EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_BEGIN gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeDriverBegin|0x3040002|UINT32|0x30001013 ## Status code value for indicating the end of Dxe driver - # EFI_SOFTWARE_DXE_CORE | EFI_SW_PC_INIT_END gEfiMdePkgTokenSpaceGuid.PcdStatusCodeValueDxeDriverEnd|0x3040003|UINT32|0x30001014 [PcdsFixedAtBuild.IPF] @@ -646,6 +630,3 @@ ## This value is used to set the base address of pci express hierarchy gEfiMdePkgTokenSpaceGuid.PcdPciExpressBaseAddress|0xE0000000|UINT64|0x0000000a - - - -- 2.39.2