From 99e8ed219f48b82694424e46c9512d4929d9d54e Mon Sep 17 00:00:00 2001 From: klu2 Date: Thu, 14 Aug 2008 04:29:48 +0000 Subject: [PATCH] Use doxygen comment style for document entity such as struct, enum, variable that use /// but not // git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5649 6f19259b-4bc3-4df7-8a09-765794883524 --- MdePkg/Include/Protocol/AbsolutePointer.h | 12 +-- MdePkg/Include/Protocol/Bds.h | 12 +-- MdePkg/Include/Protocol/Bis.h | 78 +++++++-------- MdePkg/Include/Protocol/BlockIo.h | 12 +-- .../Protocol/BusSpecificDriverOverride.h | 6 +- MdePkg/Include/Protocol/ComponentName.h | 6 +- MdePkg/Include/Protocol/ComponentName2.h | 6 +- MdePkg/Include/Protocol/DebugPort.h | 6 +- MdePkg/Include/Protocol/DebugSupport.h | 30 +++--- MdePkg/Include/Protocol/DeviceIo.h | 12 +-- MdePkg/Include/Protocol/DevicePath.h | 50 +++++----- MdePkg/Include/Protocol/DevicePathFromText.h | 6 +- MdePkg/Include/Protocol/DevicePathToText.h | 6 +- MdePkg/Include/Protocol/DevicePathUtilities.h | 6 +- MdePkg/Include/Protocol/DiskIo.h | 18 ++-- MdePkg/Include/Protocol/DriverBinding.h | 6 +- MdePkg/Include/Protocol/DriverConfiguration.h | 6 +- .../Include/Protocol/DriverConfiguration2.h | 6 +- MdePkg/Include/Protocol/DriverDiagnostics.h | 6 +- MdePkg/Include/Protocol/DriverHealth.h | 12 +-- MdePkg/Include/Protocol/Ebc.h | 12 +-- MdePkg/Include/Protocol/FirmwareVolume2.h | 6 +- MdePkg/Include/Protocol/HiiImage.h | 6 +- MdePkg/Include/Protocol/LoadFile.h | 12 +-- MdePkg/Include/Protocol/LoadedImage.h | 18 ++-- MdePkg/Include/Protocol/Metronome.h | 12 +-- MdePkg/Include/Protocol/Mtftp4.h | 6 +- .../Protocol/NetworkInterfaceIdentifier.h | 18 ++-- MdePkg/Include/Protocol/PciIo.h | 32 +++---- .../Include/Protocol/PlatformDriverOverride.h | 6 +- MdePkg/Include/Protocol/PxeBaseCode.h | 60 ++++++------ MdePkg/Include/Protocol/PxeBaseCodeCallBack.h | 18 ++-- MdePkg/Include/Protocol/RealTimeClock.h | 6 +- MdePkg/Include/Protocol/Reset.h | 6 +- MdePkg/Include/Protocol/Runtime.h | 12 +-- MdePkg/Include/Protocol/ScsiIo.h | 6 +- MdePkg/Include/Protocol/ScsiPassThru.h | 6 +- MdePkg/Include/Protocol/Security.h | 6 +- MdePkg/Include/Protocol/SecurityPolicy.h | 6 +- MdePkg/Include/Protocol/SerialIo.h | 18 ++-- MdePkg/Include/Protocol/ServiceBinding.h | 6 +- MdePkg/Include/Protocol/SimpleFileSystem.h | 18 ++-- MdePkg/Include/Protocol/SimpleNetwork.h | 96 +++++++++---------- MdePkg/Include/Protocol/SimpleTextIn.h | 12 +-- MdePkg/Include/Protocol/SimpleTextOut.h | 12 +-- MdePkg/Include/Protocol/Timer.h | 12 +-- MdePkg/Include/Protocol/UnicodeCollation.h | 18 ++-- MdePkg/Include/Protocol/Usb2HostController.h | 6 +- MdePkg/Include/Protocol/UsbHostController.h | 6 +- MdePkg/Include/Protocol/Variable.h | 6 +- MdePkg/Include/Protocol/VariableWrite.h | 6 +- MdePkg/Include/Protocol/WatchdogTimer.h | 12 +-- 52 files changed, 392 insertions(+), 392 deletions(-) diff --git a/MdePkg/Include/Protocol/AbsolutePointer.h b/MdePkg/Include/Protocol/AbsolutePointer.h index ca7ca6c820..2b8d94d49f 100644 --- a/MdePkg/Include/Protocol/AbsolutePointer.h +++ b/MdePkg/Include/Protocol/AbsolutePointer.h @@ -73,14 +73,14 @@ typedef struct { UINT32 Attributes; } EFI_ABSOLUTE_POINTER_MODE; -// -// If set, indicates this device supports an alternate button input. -// +/// +/// If set, indicates this device supports an alternate button input. +/// #define EFI_ABSP_SupportsAltActive 0x00000001 -// -// If set, indicates this device returns pressure data in parameter CurrentZ. -// +/// +/// If set, indicates this device returns pressure data in parameter CurrentZ. +/// #define EFI_ABSP_SupportsPressureAsZ 0x00000002 diff --git a/MdePkg/Include/Protocol/Bds.h b/MdePkg/Include/Protocol/Bds.h index 8bcfa93fac..843c5e9445 100644 --- a/MdePkg/Include/Protocol/Bds.h +++ b/MdePkg/Include/Protocol/Bds.h @@ -17,15 +17,15 @@ #ifndef __ARCH_PROTOCOL_BDS_H__ #define __ARCH_PROTOCOL_BDS_H__ -// -// Global ID for the BDS Architectural Protocol -// +/// +/// Global ID for the BDS Architectural Protocol +/// #define EFI_BDS_ARCH_PROTOCOL_GUID \ { 0x665E3FF6, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } } -// -// Declare forward reference for the BDS Architectural Protocol -// +/// +/// Declare forward reference for the BDS Architectural Protocol +/// typedef struct _EFI_BDS_ARCH_PROTOCOL EFI_BDS_ARCH_PROTOCOL; /** diff --git a/MdePkg/Include/Protocol/Bis.h b/MdePkg/Include/Protocol/Bis.h index e01d049cbf..eb4f7a60fc 100644 --- a/MdePkg/Include/Protocol/Bis.h +++ b/MdePkg/Include/Protocol/Bis.h @@ -45,19 +45,19 @@ typedef VOID *BIS_APPLICATION_HANDLE; typedef UINT16 BIS_ALG_ID; typedef UINT32 BIS_CERT_ID; -// -// EFI_BIS_DATA type. -// -// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ). -// +/// +/// EFI_BIS_DATA type. +/// +/// EFI_BIS_DATA instances obtained from BIS must be freed by calling Free( ). +/// typedef struct { UINT32 Length; // Length of Data in 8 bit bytes. UINT8 *Data; // 32 Bit Flat Address of data. } EFI_BIS_DATA; -// -// EFI_BIS_VERSION type. -// +/// +/// EFI_BIS_VERSION type. +/// typedef struct { UINT32 Major; // BIS Interface version number. UINT32 Minor; // Build number. @@ -72,53 +72,53 @@ typedef struct { #define BIS_CURRENT_VERSION_MAJOR BIS_VERSION_1 #define BIS_VERSION_1 1 -// -// EFI_BIS_SIGNATURE_INFO type. -// +/// +/// EFI_BIS_SIGNATURE_INFO type. +/// typedef struct { BIS_CERT_ID CertificateID; // Truncated hash of platform Boot Object - // authorization certificate. - // + /// authorization certificate. + /// BIS_ALG_ID AlgorithmID; // A signature algorithm number. UINT16 KeyLength; // Length of alg. keys in bits. } EFI_BIS_SIGNATURE_INFO; -// -// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID. -// The exact numeric values come from -// "Common Data Security Architecture (CDSA) Specification". -// +/// +/// Currently defined values for EFI_BIS_SIGNATURE_INFO.AlgorithmID. +/// The exact numeric values come from +/// "Common Data Security Architecture (CDSA) Specification". +/// #define BIS_ALG_DSA (41) // CSSM_ALGID_DSA #define BIS_ALG_RSA_MD5 (42) // CSSM_ALGID_MD5_WITH_RSA -// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId. -// +/// Currently defined values for EFI_BIS_SIGNATURE_INFO.CertificateId. +/// #define BIS_CERT_ID_DSA BIS_ALG_DSA // CSSM_ALGID_DSA #define BIS_CERT_ID_RSA_MD5 BIS_ALG_RSA_MD5 // CSSM_ALGID_MD5_WITH_RSA -// The following is a mask value that gets applied to the truncated hash of a -// platform Boot Object Authorization Certificate to create the certificateID. -// A certificateID must not have any bits set to the value 1 other than bits in -// this mask. -// +/// The following is a mask value that gets applied to the truncated hash of a +/// platform Boot Object Authorization Certificate to create the certificateID. +/// A certificateID must not have any bits set to the value 1 other than bits in +/// this mask. +/// #define BIS_CERT_ID_MASK (0xFF7F7FFF) -// -// Macros for dealing with the EFI_BIS_DATA object obtained -// from BIS_GetSignatureInfo() -// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO -// elements are contained in a EFI_BIS_DATA struct pointed to -// by the provided EFI_BIS_DATA*. -// +/// +/// Macros for dealing with the EFI_BIS_DATA object obtained +/// from BIS_GetSignatureInfo() +/// BIS_GET_SIGINFO_COUNT - tells how many EFI_BIS_SIGNATURE_INFO +/// elements are contained in a EFI_BIS_DATA struct pointed to +/// by the provided EFI_BIS_DATA*. +/// #define BIS_GET_SIGINFO_COUNT(BisDataPtr) ((BisDataPtr)->Length / sizeof (EFI_BIS_SIGNATURE_INFO)) -// -// BIS_GET_SIGINFO_ARRAY - produces a EFI_BIS_SIGNATURE_INFO* -// from a given EFI_BIS_DATA*. -// +/// +/// BIS_GET_SIGINFO_ARRAY - produces a EFI_BIS_SIGNATURE_INFO* +/// from a given EFI_BIS_DATA*. +/// #define BIS_GET_SIGINFO_ARRAY(BisDataPtr) ((EFI_BIS_SIGNATURE_INFO *) (BisDataPtr)->Data) -// -// Support old name for backward compatible -// +/// +/// Support old name for backward compatible +/// #define BOOT_OBJECT_AUTHORIZATION_PARMSET_GUIDVALUE \ BOOT_OBJECT_AUTHORIZATION_PARMSET_GUID diff --git a/MdePkg/Include/Protocol/BlockIo.h b/MdePkg/Include/Protocol/BlockIo.h index ecfd3a7551..32fe4ef41f 100644 --- a/MdePkg/Include/Protocol/BlockIo.h +++ b/MdePkg/Include/Protocol/BlockIo.h @@ -25,14 +25,14 @@ typedef struct _EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL; -// -// Protocol GUID name defined in EFI1.1. -// +/// +/// Protocol GUID name defined in EFI1.1. +/// #define BLOCK_IO_PROTOCOL EFI_BLOCK_IO_PROTOCOL_GUID -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_BLOCK_IO_PROTOCOL EFI_BLOCK_IO; /** diff --git a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h index 14d24d31c4..1f86c315fb 100644 --- a/MdePkg/Include/Protocol/BusSpecificDriverOverride.h +++ b/MdePkg/Include/Protocol/BusSpecificDriverOverride.h @@ -20,9 +20,9 @@ #ifndef _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_ #define _EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_H_ -// -// Global ID for the Bus Specific Driver Override Protocol -// +/// +/// Global ID for the Bus Specific Driver Override Protocol +/// #define EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL_GUID \ { \ 0x3bc1b285, 0x8a15, 0x4a82, {0xaa, 0xbf, 0x4d, 0x7d, 0x13, 0xfb, 0x32, 0x65 } \ diff --git a/MdePkg/Include/Protocol/ComponentName.h b/MdePkg/Include/Protocol/ComponentName.h index 7ac7ce0a31..3568c057ad 100644 --- a/MdePkg/Include/Protocol/ComponentName.h +++ b/MdePkg/Include/Protocol/ComponentName.h @@ -19,9 +19,9 @@ #include -// -// Global ID for the Component Name Protocol -// +/// +/// Global ID for the Component Name Protocol +/// #define EFI_COMPONENT_NAME_PROTOCOL_GUID \ { \ 0x107a772c, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ diff --git a/MdePkg/Include/Protocol/ComponentName2.h b/MdePkg/Include/Protocol/ComponentName2.h index 7cec01699e..a9562474af 100644 --- a/MdePkg/Include/Protocol/ComponentName2.h +++ b/MdePkg/Include/Protocol/ComponentName2.h @@ -19,9 +19,9 @@ #include -// -// Global ID for the Component Name Protocol -// +/// +/// Global ID for the Component Name Protocol +/// #define EFI_COMPONENT_NAME2_PROTOCOL_GUID \ {0x6a7a5cff, 0xe8d9, 0x4f70, { 0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14 } } diff --git a/MdePkg/Include/Protocol/DebugPort.h b/MdePkg/Include/Protocol/DebugPort.h index 265c47abbe..edfae57367 100644 --- a/MdePkg/Include/Protocol/DebugPort.h +++ b/MdePkg/Include/Protocol/DebugPort.h @@ -19,9 +19,9 @@ #define __DEBUG_PORT_H__ -// -// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0} -// +/// +/// DebugPortIo protocol {EBA4E8D2-3858-41EC-A281-2647BA9660D0} +/// #define EFI_DEBUGPORT_PROTOCOL_GUID \ { \ 0xEBA4E8D2, 0x3858, 0x41EC, {0xA2, 0x81, 0x26, 0x47, 0xBA, 0x96, 0x60, 0xD0 } \ diff --git a/MdePkg/Include/Protocol/DebugSupport.h b/MdePkg/Include/Protocol/DebugSupport.h index 1fa4843ecd..79ec7dbdf6 100644 --- a/MdePkg/Include/Protocol/DebugSupport.h +++ b/MdePkg/Include/Protocol/DebugSupport.h @@ -24,17 +24,17 @@ typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL; -// -// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25} -// +/// +/// Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25} +/// #define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \ { \ 0x2755590C, 0x6F3C, 0x42FA, {0x9E, 0xA4, 0xA3, 0xBA, 0x54, 0x3C, 0xDA, 0x25 } \ } -// -// Debug Support definitions -// +/// +/// Debug Support definitions +/// typedef INTN EFI_EXCEPTION_TYPE; // @@ -448,14 +448,14 @@ typedef struct { #define EXCEPT_EBC_INSTRUCTION_ENCODING 8 // malformed instruction #define EXCEPT_EBC_BAD_BREAK 9 // BREAK 0 or undefined BREAK #define EXCEPT_EBC_STEP 10 // to support debug stepping -// -// For coding convenience, define the maximum valid EBC exception. -// +/// +/// For coding convenience, define the maximum valid EBC exception. +/// #define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP -// -// EBC processor context definition -// +/// +/// EBC processor context definition +/// typedef struct { UINT64 R0; UINT64 R1; @@ -470,9 +470,9 @@ typedef struct { UINT64 Ip; } EFI_SYSTEM_CONTEXT_EBC; -// -// Universal EFI_SYSTEM_CONTEXT definition -// +/// +/// Universal EFI_SYSTEM_CONTEXT definition +/// typedef union { EFI_SYSTEM_CONTEXT_EBC *SystemContextEbc; EFI_SYSTEM_CONTEXT_IA32 *SystemContextIa32; diff --git a/MdePkg/Include/Protocol/DeviceIo.h b/MdePkg/Include/Protocol/DeviceIo.h index 0bc4394904..7b79d2355f 100644 --- a/MdePkg/Include/Protocol/DeviceIo.h +++ b/MdePkg/Include/Protocol/DeviceIo.h @@ -25,14 +25,14 @@ typedef struct _EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL; -// -// Protocol GUID name defined in EFI1.1. -// +/// +/// Protocol GUID name defined in EFI1.1. +/// #define DEVICE_IO_PROTOCOL EFI_DEVICE_IO_PROTOCOL_GUID -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_DEVICE_IO_PROTOCOL EFI_DEVICE_IO_INTERFACE; typedef enum { diff --git a/MdePkg/Include/Protocol/DevicePath.h b/MdePkg/Include/Protocol/DevicePath.h index fddf972bef..48c8f4b77b 100644 --- a/MdePkg/Include/Protocol/DevicePath.h +++ b/MdePkg/Include/Protocol/DevicePath.h @@ -21,9 +21,9 @@ #include -// -// Device Path protocol -// +/// +/// Device Path protocol +/// #define EFI_DEVICE_PATH_PROTOCOL_GUID \ { \ 0x9576e91, 0x6d3f, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \ @@ -33,9 +33,9 @@ // Protocol GUID defined in EFI1.1. // -// -// Device Path information -// +/// +/// Device Path information +/// #define DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH_PROTOCOL_GUID #pragma pack(1) @@ -46,14 +46,14 @@ typedef struct { UINT8 Length[2]; } EFI_DEVICE_PATH_PROTOCOL; -// -// For backward-compatible with EFI1.1. -// +/// +/// For backward-compatible with EFI1.1. +/// typedef EFI_DEVICE_PATH_PROTOCOL EFI_DEVICE_PATH; -// -// Hardware Device Paths -// +/// +/// Hardware Device Paths +/// #define HARDWARE_DEVICE_PATH 0x01 #define HW_PCI_DP 0x01 @@ -89,9 +89,9 @@ typedef struct { UINT32 ControllerNumber; } CONTROLLER_DEVICE_PATH; -// -// ACPI Device Paths -// +/// +/// ACPI Device Paths +/// #define ACPI_DEVICE_PATH 0x02 #define ACPI_DP 0x01 @@ -107,10 +107,10 @@ typedef struct { UINT32 HID; UINT32 UID; UINT32 CID; - // - // Optional variable length _HIDSTR - // Optional variable length _UIDSTR - // + /// + /// Optional variable length _HIDSTR + /// Optional variable length _UIDSTR + /// } ACPI_EXTENDED_HID_DEVICE_PATH; // @@ -151,9 +151,9 @@ typedef struct { (((_Port) & 0xf) << 4) | \ ((_Index) & 0xf) )) -// -// Messaging Device Paths -// +/// +/// Messaging Device Paths +/// #define MESSAGING_DEVICE_PATH 0x03 #define MSG_ATAPI_DP 0x01 @@ -426,9 +426,9 @@ typedef struct { #define BBS_TYPE_UNKNOWN 0xFF -// -// Union of all possible Device Paths and pointers to Device Paths -// +/// +/// Union of all possible Device Paths and pointers to Device Paths +/// typedef union { EFI_DEVICE_PATH_PROTOCOL DevPath; diff --git a/MdePkg/Include/Protocol/DevicePathFromText.h b/MdePkg/Include/Protocol/DevicePathFromText.h index 5caf5dff05..d00614b21d 100644 --- a/MdePkg/Include/Protocol/DevicePathFromText.h +++ b/MdePkg/Include/Protocol/DevicePathFromText.h @@ -18,9 +18,9 @@ #include -// -// Device Path From Text protocol -// +/// +/// Device Path From Text protocol +/// #define EFI_DEVICE_PATH_FROM_TEXT_PROTOCOL_GUID \ { \ 0x5c99a21, 0xc70f, 0x4ad2, {0x8a, 0x5f, 0x35, 0xdf, 0x33, 0x43, 0xf5, 0x1e } \ diff --git a/MdePkg/Include/Protocol/DevicePathToText.h b/MdePkg/Include/Protocol/DevicePathToText.h index bf043e09a9..8e03c7f2fb 100644 --- a/MdePkg/Include/Protocol/DevicePathToText.h +++ b/MdePkg/Include/Protocol/DevicePathToText.h @@ -18,9 +18,9 @@ #include -// -// Device Path To Text protocol -// +/// +/// Device Path To Text protocol +/// #define EFI_DEVICE_PATH_TO_TEXT_PROTOCOL_GUID \ { \ 0x8b843e20, 0x8132, 0x4852, {0x90, 0xcc, 0x55, 0x1a, 0x4e, 0x4a, 0x7f, 0x1c } \ diff --git a/MdePkg/Include/Protocol/DevicePathUtilities.h b/MdePkg/Include/Protocol/DevicePathUtilities.h index 7a8c50934e..830f52e5c5 100644 --- a/MdePkg/Include/Protocol/DevicePathUtilities.h +++ b/MdePkg/Include/Protocol/DevicePathUtilities.h @@ -19,9 +19,9 @@ #include -// -// Device Path Utilities protocol -// +/// +/// Device Path Utilities protocol +/// #define EFI_DEVICE_PATH_UTILITIES_PROTOCOL_GUID \ { \ 0x379be4e, 0xd706, 0x437d, {0xb0, 0x37, 0xed, 0xb8, 0x2f, 0xb7, 0x72, 0xa4 } \ diff --git a/MdePkg/Include/Protocol/DiskIo.h b/MdePkg/Include/Protocol/DiskIo.h index 2f15b70554..a9f1b96032 100644 --- a/MdePkg/Include/Protocol/DiskIo.h +++ b/MdePkg/Include/Protocol/DiskIo.h @@ -24,16 +24,16 @@ 0xce345171, 0xba0b, 0x11d2, {0x8e, 0x4f, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \ } -// -// Protocol GUID name defined in EFI1.1. -// +/// +/// Protocol GUID name defined in EFI1.1. +/// #define DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL_GUID typedef struct _EFI_DISK_IO_PROTOCOL EFI_DISK_IO_PROTOCOL; -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_DISK_IO_PROTOCOL EFI_DISK_IO; /** @@ -95,9 +95,9 @@ EFI_STATUS #define EFI_DISK_IO_PROTOCOL_REVISION 0x00010000 -// -// Revision defined in EFI1.1 -// +/// +/// Revision defined in EFI1.1 +/// #define EFI_DISK_IO_INTERFACE_REVISION EFI_DISK_IO_PROTOCOL_REVISION /** diff --git a/MdePkg/Include/Protocol/DriverBinding.h b/MdePkg/Include/Protocol/DriverBinding.h index 689c1a0a88..7e0cbbda58 100644 --- a/MdePkg/Include/Protocol/DriverBinding.h +++ b/MdePkg/Include/Protocol/DriverBinding.h @@ -20,9 +20,9 @@ #include #include -// -// Global ID for the ControllerHandle Driver Protocol -// +/// +/// Global ID for the ControllerHandle Driver Protocol +/// #define EFI_DRIVER_BINDING_PROTOCOL_GUID \ { \ 0x18a031ab, 0xb443, 0x4d1a, {0xa5, 0xc0, 0xc, 0x9, 0x26, 0x1e, 0x9f, 0x71 } \ diff --git a/MdePkg/Include/Protocol/DriverConfiguration.h b/MdePkg/Include/Protocol/DriverConfiguration.h index c7a2752132..ce94de7f8b 100644 --- a/MdePkg/Include/Protocol/DriverConfiguration.h +++ b/MdePkg/Include/Protocol/DriverConfiguration.h @@ -18,9 +18,9 @@ #include #include -// -// Global ID for the Driver Configuration Protocol defined in UEFI 2.0 -// +/// +/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0 +/// #define EFI_DRIVER_CONFIGURATION_PROTOCOL_GUID \ { \ 0x107a772b, 0xd5e1, 0x11d4, {0x9a, 0x46, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ diff --git a/MdePkg/Include/Protocol/DriverConfiguration2.h b/MdePkg/Include/Protocol/DriverConfiguration2.h index 201599c98f..2d287d66f4 100644 --- a/MdePkg/Include/Protocol/DriverConfiguration2.h +++ b/MdePkg/Include/Protocol/DriverConfiguration2.h @@ -17,9 +17,9 @@ #include -// -// Global ID for the Driver Configuration Protocol defined in UEFI 2.0 -// +/// +/// Global ID for the Driver Configuration Protocol defined in UEFI 2.0 +/// #define EFI_DRIVER_CONFIGURATION2_PROTOCOL_GUID \ { \ 0xbfd7dc1d, 0x24f1, 0x40d9, {0x82, 0xe7, 0x2e, 0x09, 0xbb, 0x6b, 0x4e, 0xbe } \ diff --git a/MdePkg/Include/Protocol/DriverDiagnostics.h b/MdePkg/Include/Protocol/DriverDiagnostics.h index 0751202153..d8cddd963f 100644 --- a/MdePkg/Include/Protocol/DriverDiagnostics.h +++ b/MdePkg/Include/Protocol/DriverDiagnostics.h @@ -17,9 +17,9 @@ #include -// -// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0. -// +/// +/// Global ID for the Driver Diagnostics Protocol as defined in UEFI 2.0. +/// #define EFI_DRIVER_DIAGNOSTICS_PROTOCOL_GUID \ { \ 0x0784924f, 0xe296, 0x11d4, {0x9a, 0x49, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ diff --git a/MdePkg/Include/Protocol/DriverHealth.h b/MdePkg/Include/Protocol/DriverHealth.h index d177c8d890..2b889023f5 100644 --- a/MdePkg/Include/Protocol/DriverHealth.h +++ b/MdePkg/Include/Protocol/DriverHealth.h @@ -22,9 +22,9 @@ typedef struct _EFI_DRIVER_HEALTH_PROTOCOL EFI_DRIVER_HEALTH_PROTOCOL; -// -// EFI_DRIVER_HEALTH_HEALTH_STATUS -// +/// +/// EFI_DRIVER_HEALTH_HEALTH_STATUS +/// typedef enum { EfiDriverHealthStatusHealthy, EfiDriverHealthStatusRepairRequired, @@ -34,9 +34,9 @@ typedef enum { EfiDriverHealthStatusRebootRequired } EFI_DRIVER_HEALTH_HEALTH_STATUS; -// -// EFI_DRIVER_HEALTH_HII_MESSAGE -// +/// +/// EFI_DRIVER_HEALTH_HII_MESSAGE +/// typedef struct { EFI_HII_HANDLE HiiHandle; EFI_STRING_ID StringId; diff --git a/MdePkg/Include/Protocol/Ebc.h b/MdePkg/Include/Protocol/Ebc.h index 7710b2144e..01b4255883 100644 --- a/MdePkg/Include/Protocol/Ebc.h +++ b/MdePkg/Include/Protocol/Ebc.h @@ -20,14 +20,14 @@ 0x13AC6DD1, 0x73D0, 0x11D4, {0xB0, 0x6B, 0x00, 0xAA, 0x00, 0xBD, 0x6D, 0xE7 } \ } -// -// Protocol Guid Name defined in spec. -// +/// +/// Protocol Guid Name defined in spec. +/// #define EFI_EBC_PROTOCOL_GUID EFI_EBC_INTERPRETER_PROTOCOL_GUID -// -// Define for forward reference. -// +/// +/// Define for forward reference. +/// typedef struct _EFI_EBC_PROTOCOL EFI_EBC_PROTOCOL; /** diff --git a/MdePkg/Include/Protocol/FirmwareVolume2.h b/MdePkg/Include/Protocol/FirmwareVolume2.h index fd07c95f55..1d22bbeeea 100644 --- a/MdePkg/Include/Protocol/FirmwareVolume2.h +++ b/MdePkg/Include/Protocol/FirmwareVolume2.h @@ -28,9 +28,9 @@ typedef struct _EFI_FIRMWARE_VOLUME2_PROTOCOL EFI_FIRMWARE_VOLUME2_PROTOCOL; -// -// EFI_FV_ATTRIBUTES -// +/// +/// EFI_FV_ATTRIBUTES +/// typedef UINT64 EFI_FV_ATTRIBUTES; // diff --git a/MdePkg/Include/Protocol/HiiImage.h b/MdePkg/Include/Protocol/HiiImage.h index a9da9e6688..0cc6445d77 100644 --- a/MdePkg/Include/Protocol/HiiImage.h +++ b/MdePkg/Include/Protocol/HiiImage.h @@ -21,9 +21,9 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL; -// -// Flags in EFI_IMAGE_INPUT -// +/// +/// Flags in EFI_IMAGE_INPUT +/// #define EFI_IMAGE_TRANSPARENT 0x00000001 /** diff --git a/MdePkg/Include/Protocol/LoadFile.h b/MdePkg/Include/Protocol/LoadFile.h index c2867f4937..8ee5128277 100644 --- a/MdePkg/Include/Protocol/LoadFile.h +++ b/MdePkg/Include/Protocol/LoadFile.h @@ -26,16 +26,16 @@ 0x56EC3091, 0x954C, 0x11d2, {0x8E, 0x3F, 0x00, 0xA0, 0xC9, 0x69, 0x72, 0x3B } \ } -// -// Protocol Guid defined by EFI1.1. -// +/// +/// Protocol Guid defined by EFI1.1. +/// #define LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL_GUID typedef struct _EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_PROTOCOL; -// -// Backward-compatible with EFI1.1 -// +/// +/// Backward-compatible with EFI1.1 +/// typedef EFI_LOAD_FILE_PROTOCOL EFI_LOAD_FILE_INTERFACE; /** diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h index f87011930b..ecf1826624 100644 --- a/MdePkg/Include/Protocol/LoadedImage.h +++ b/MdePkg/Include/Protocol/LoadedImage.h @@ -30,19 +30,19 @@ 0xbc62157e, 0x3e33, 0x4fec, {0x99, 0x20, 0x2d, 0x3b, 0x36, 0xd7, 0x50, 0xdf } \ } -// -// Protocol GUID defined in EFI1.1. -// +/// +/// Protocol GUID defined in EFI1.1. +/// #define LOADED_IMAGE_PROTOCOL EFI_LOADED_IMAGE_PROTOCOL_GUID -// -// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h -// +/// +/// EFI_SYSTEM_TABLE & EFI_IMAGE_UNLOAD are defined in EfiApi.h +/// #define EFI_LOADED_IMAGE_PROTOCOL_REVISION 0x1000 -// -// Revision defined in EFI1.1. -// +/// +/// Revision defined in EFI1.1. +/// #define EFI_LOADED_IMAGE_INFORMATION_REVISION EFI_LOADED_IMAGE_PROTOCOL_REVISION /** diff --git a/MdePkg/Include/Protocol/Metronome.h b/MdePkg/Include/Protocol/Metronome.h index edc4927d35..41fde89ad2 100644 --- a/MdePkg/Include/Protocol/Metronome.h +++ b/MdePkg/Include/Protocol/Metronome.h @@ -17,15 +17,15 @@ #ifndef __ARCH_PROTOCOL_METRONOME_H__ #define __ARCH_PROTOCOL_METRONOME_H__ -// -// Global ID for the Metronome Architectural Protocol -// +/// +/// Global ID for the Metronome Architectural Protocol +/// #define EFI_METRONOME_ARCH_PROTOCOL_GUID \ { 0x26baccb2, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } } -// -// Declare forward reference for the Metronome Architectural Protocol -// +/// +/// Declare forward reference for the Metronome Architectural Protocol +/// typedef struct _EFI_METRONOME_ARCH_PROTOCOL EFI_METRONOME_ARCH_PROTOCOL; /** diff --git a/MdePkg/Include/Protocol/Mtftp4.h b/MdePkg/Include/Protocol/Mtftp4.h index 4191227e9f..62d8e8d41f 100644 --- a/MdePkg/Include/Protocol/Mtftp4.h +++ b/MdePkg/Include/Protocol/Mtftp4.h @@ -111,9 +111,9 @@ typedef union { #pragma pack() -// -// MTFTP4 option definition -// +/// +/// MTFTP4 option definition +/// typedef struct { UINT8 *OptionStr; UINT8 *ValueStr; diff --git a/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h b/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h index c6514c173d..bb3b9a3905 100644 --- a/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h +++ b/MdePkg/Include/Protocol/NetworkInterfaceIdentifier.h @@ -24,19 +24,19 @@ #define EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION 0x00010000 -// -// Revision defined in EFI1.1. -// +/// +/// Revision defined in EFI1.1. +/// #define EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE_REVISION EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL_REVISION -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL; -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_NETWORK_INTERFACE_IDENTIFIER_PROTOCOL EFI_NETWORK_INTERFACE_IDENTIFIER_INTERFACE; typedef enum { diff --git a/MdePkg/Include/Protocol/PciIo.h b/MdePkg/Include/Protocol/PciIo.h index 09d0ea7773..286d423099 100644 --- a/MdePkg/Include/Protocol/PciIo.h +++ b/MdePkg/Include/Protocol/PciIo.h @@ -16,9 +16,9 @@ #ifndef __PCI_IO_H__ #define __PCI_IO_H__ -// -// Global ID for the PCI I/O Protocol -// +/// +/// Global ID for the PCI I/O Protocol +/// #define EFI_PCI_IO_PROTOCOL_GUID \ { \ 0x4cf5b200, 0x68b8, 0x4ca5, {0x9e, 0xec, 0xb2, 0x3e, 0x3f, 0x50, 0x2, 0x9a } \ @@ -26,9 +26,9 @@ typedef struct _EFI_PCI_IO_PROTOCOL EFI_PCI_IO_PROTOCOL; -// -// Prototypes for the PCI I/O Protocol -// +/// +/// Prototypes for the PCI I/O Protocol +/// typedef enum { EfiPciIoWidthUint8 = 0, EfiPciIoWidthUint16, @@ -73,11 +73,11 @@ typedef enum { #define EFI_PCI_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_IO | EFI_PCI_IO_ATTRIBUTE_MEMORY | EFI_PCI_IO_ATTRIBUTE_BUS_MASTER) #define EFI_VGA_DEVICE_ENABLE (EFI_PCI_IO_ATTRIBUTE_VGA_PALETTE_IO | EFI_PCI_IO_ATTRIBUTE_VGA_MEMORY | EFI_PCI_IO_ATTRIBUTE_VGA_IO | EFI_PCI_IO_ATTRIBUTE_IO) -// -// ******************************************************* -// EFI_PCI_IO_PROTOCOL_OPERATION -// ******************************************************* -// +/// +/// ******************************************************* +/// EFI_PCI_IO_PROTOCOL_OPERATION +/// ******************************************************* +/// typedef enum { EfiPciIoOperationBusMasterRead, EfiPciIoOperationBusMasterWrite, @@ -85,11 +85,11 @@ typedef enum { EfiPciIoOperationMaximum } EFI_PCI_IO_PROTOCOL_OPERATION; -// -// ******************************************************* -// EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION -// ******************************************************* -// +/// +/// ******************************************************* +/// EFI_PCI_IO_PROTOCOL_ATTRIBUTE_OPERATION +/// ******************************************************* +/// typedef enum { EfiPciIoAttributeOperationGet, EfiPciIoAttributeOperationSet, diff --git a/MdePkg/Include/Protocol/PlatformDriverOverride.h b/MdePkg/Include/Protocol/PlatformDriverOverride.h index 71e2a51897..1fa2522c75 100644 --- a/MdePkg/Include/Protocol/PlatformDriverOverride.h +++ b/MdePkg/Include/Protocol/PlatformDriverOverride.h @@ -15,9 +15,9 @@ #ifndef __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__ #define __EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_H__ -// -// Global ID for the Platform Driver Override Protocol -// +/// +/// Global ID for the Platform Driver Override Protocol +/// #define EFI_PLATFORM_DRIVER_OVERRIDE_PROTOCOL_GUID \ { \ 0x6b30c738, 0xa391, 0x11d4, {0x9a, 0x3b, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ diff --git a/MdePkg/Include/Protocol/PxeBaseCode.h b/MdePkg/Include/Protocol/PxeBaseCode.h index c341d46aec..4958cdfb1f 100644 --- a/MdePkg/Include/Protocol/PxeBaseCode.h +++ b/MdePkg/Include/Protocol/PxeBaseCode.h @@ -15,9 +15,9 @@ #ifndef __PXE_BASE_CODE_PROTOCOL_H__ #define __PXE_BASE_CODE_PROTOCOL_H__ -// -// PXE Base Code protocol -// +/// +/// PXE Base Code protocol +/// #define EFI_PXE_BASE_CODE_PROTOCOL_GUID \ { \ 0x03c4e603, 0xac28, 0x11d3, {0x9a, 0x2d, 0x00, 0x90, 0x27, 0x3f, 0xc1, 0x4d } \ @@ -25,20 +25,20 @@ typedef struct _EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE_PROTOCOL; -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_PXE_BASE_CODE_PROTOCOL EFI_PXE_BASE_CODE; -// -// Default IP TTL and ToS. -// +/// +/// Default IP TTL and ToS. +/// #define DEFAULT_TTL 16 #define DEFAULT_ToS 0 -// -// ICMP error format -// +/// +/// ICMP error format +/// typedef struct { UINT8 Type; UINT8 Code; @@ -55,17 +55,17 @@ typedef struct { UINT8 Data[494]; } EFI_PXE_BASE_CODE_ICMP_ERROR; -// -// TFTP error format -// +/// +/// TFTP error format +/// typedef struct { UINT8 ErrorCode; CHAR8 ErrorString[127]; } EFI_PXE_BASE_CODE_TFTP_ERROR; -// -// IP Receive Filter definitions -// +/// +/// IP Receive Filter definitions +/// #define EFI_PXE_BASE_CODE_MAX_IPCNT 8 typedef struct { @@ -80,9 +80,9 @@ typedef struct { #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS 0x0004 #define EFI_PXE_BASE_CODE_IP_FILTER_PROMISCUOUS_MULTICAST 0x0008 -// -// ARP Cache definitions -// +/// +/// ARP Cache definitions +/// typedef struct { EFI_IP_ADDRESS IpAddr; EFI_MAC_ADDRESS MacAddr; @@ -136,9 +136,9 @@ typedef UINT16 EFI_PXE_BASE_CODE_UDP_PORT; #define EFI_PXE_BASE_CODE_BOOT_LAYER_MASK 0x7FFF #define EFI_PXE_BASE_CODE_BOOT_LAYER_INITIAL 0x0000 -// -// Discover() server list structure. -// +/// +/// Discover() server list structure. +/// typedef struct { UINT16 Type; BOOLEAN AcceptAnyResponse; @@ -146,9 +146,9 @@ typedef struct { EFI_IP_ADDRESS IpAddr; } EFI_PXE_BASE_CODE_SRVLIST; -// -// Discover() information override structure. -// +/// +/// Discover() information override structure. +/// typedef struct { BOOLEAN UseMCast; BOOLEAN UseBCast; @@ -159,9 +159,9 @@ typedef struct { EFI_PXE_BASE_CODE_SRVLIST SrvList[1]; } EFI_PXE_BASE_CODE_DISCOVER_INFO; -// -// Mtftp() definitions -// +/// +/// Mtftp() definitions +/// typedef enum { EFI_PXE_BASE_CODE_TFTP_FIRST, EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE, diff --git a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h index 0745d7c655..b79eaf9a63 100644 --- a/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h +++ b/MdePkg/Include/Protocol/PxeBaseCodeCallBack.h @@ -17,9 +17,9 @@ #ifndef _PXE_BASE_CODE_CALLBACK_H_ #define _PXE_BASE_CODE_CALLBACK_H_ -// -// Call Back Definitions -// +/// +/// Call Back Definitions +/// #define EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_GUID \ { \ 0x245dca21, 0xfb7b, 0x11d3, {0x8f, 0x01, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \ @@ -32,14 +32,14 @@ #define EFI_PXE_BASE_CODE_CALLBACK_INTERFACE_REVISION \ EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL_REVISION -// -// Protocol definition -// +/// +/// Protocol definition +/// typedef struct _EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL; -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_PXE_BASE_CODE_CALLBACK_PROTOCOL EFI_PXE_BASE_CODE_CALLBACK; typedef enum { diff --git a/MdePkg/Include/Protocol/RealTimeClock.h b/MdePkg/Include/Protocol/RealTimeClock.h index d25bb75145..3de3d28afa 100644 --- a/MdePkg/Include/Protocol/RealTimeClock.h +++ b/MdePkg/Include/Protocol/RealTimeClock.h @@ -25,9 +25,9 @@ #ifndef __ARCH_PROTOCOL_REAL_TIME_CLOCK_H__ #define __ARCH_PROTOCOL_REAL_TIME_CLOCK_H__ -// -// Global ID for the Real Time Clock Architectural Protocol -// +/// +/// Global ID for the Real Time Clock Architectural Protocol +/// #define EFI_REAL_TIME_CLOCK_ARCH_PROTOCOL_GUID \ { 0x27CFAC87, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } } diff --git a/MdePkg/Include/Protocol/Reset.h b/MdePkg/Include/Protocol/Reset.h index aa7ed3f490..c82a92c87f 100644 --- a/MdePkg/Include/Protocol/Reset.h +++ b/MdePkg/Include/Protocol/Reset.h @@ -22,9 +22,9 @@ #ifndef __ARCH_PROTOCOL_RESET_H__ #define __ARCH_PROTOCOL_RESET_H__ -// -// Global ID for the Reset Architectural Protocol -// +/// +/// Global ID for the Reset Architectural Protocol +/// #define EFI_RESET_ARCH_PROTOCOL_GUID \ { 0x27CFAC88, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } } diff --git a/MdePkg/Include/Protocol/Runtime.h b/MdePkg/Include/Protocol/Runtime.h index 5fb8aee7ca..32c3359af8 100644 --- a/MdePkg/Include/Protocol/Runtime.h +++ b/MdePkg/Include/Protocol/Runtime.h @@ -27,17 +27,17 @@ #ifndef __ARCH_PROTOCOL_RUNTIME_H__ #define __ARCH_PROTOCOL_RUNTIME_H__ -// -// Global ID for the Runtime Architectural Protocol -// +/// +/// Global ID for the Runtime Architectural Protocol +/// #define EFI_RUNTIME_ARCH_PROTOCOL_GUID \ { 0xb7dfb4e1, 0x52f, 0x449f, {0x87, 0xbe, 0x98, 0x18, 0xfc, 0x91, 0xb7, 0x33 } } typedef struct _EFI_RUNTIME_ARCH_PROTOCOL EFI_RUNTIME_ARCH_PROTOCOL; -// -// LIST_ENTRY from BaseType -// +/// +/// LIST_ENTRY from BaseType +/// typedef LIST_ENTRY EFI_LIST_ENTRY; typedef struct _EFI_RUNTIME_IMAGE_ENTRY EFI_RUNTIME_IMAGE_ENTRY; diff --git a/MdePkg/Include/Protocol/ScsiIo.h b/MdePkg/Include/Protocol/ScsiIo.h index 030a06229d..6437efb55e 100644 --- a/MdePkg/Include/Protocol/ScsiIo.h +++ b/MdePkg/Include/Protocol/ScsiIo.h @@ -23,9 +23,9 @@ 0x932f4736, 0x2362, 0x4002, {0x80, 0x3e, 0x3c, 0xd5, 0x4b, 0x13, 0x8f, 0x85 } \ } -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_SCSI_IO_PROTOCOL EFI_SCSI_IO_PROTOCOL; // diff --git a/MdePkg/Include/Protocol/ScsiPassThru.h b/MdePkg/Include/Protocol/ScsiPassThru.h index 2192e9bf49..f406193118 100644 --- a/MdePkg/Include/Protocol/ScsiPassThru.h +++ b/MdePkg/Include/Protocol/ScsiPassThru.h @@ -27,9 +27,9 @@ 0xa59e8fcf, 0xbda0, 0x43bb, {0x90, 0xb1, 0xd3, 0x73, 0x2e, 0xca, 0xa8, 0x77 } \ } -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_SCSI_PASS_THRU_PROTOCOL EFI_SCSI_PASS_THRU_PROTOCOL; #define EFI_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL 0x0001 diff --git a/MdePkg/Include/Protocol/Security.h b/MdePkg/Include/Protocol/Security.h index 9d8c007127..c79c3dc52c 100644 --- a/MdePkg/Include/Protocol/Security.h +++ b/MdePkg/Include/Protocol/Security.h @@ -30,9 +30,9 @@ #include -// -// Global ID for the Security Code Architectural Protocol -// +/// +/// Global ID for the Security Code Architectural Protocol +/// #define EFI_SECURITY_ARCH_PROTOCOL_GUID \ { 0xA46423E3, 0x4617, 0x49f1, {0xB9, 0xFF, 0xD1, 0xBF, 0xA9, 0x11, 0x58, 0x39 } } diff --git a/MdePkg/Include/Protocol/SecurityPolicy.h b/MdePkg/Include/Protocol/SecurityPolicy.h index b9f2ff024f..93dd702a4b 100644 --- a/MdePkg/Include/Protocol/SecurityPolicy.h +++ b/MdePkg/Include/Protocol/SecurityPolicy.h @@ -15,9 +15,9 @@ #ifndef _SECURITY_POLICY_H_ #define _SECURITY_POLICY_H_ -// -// Security policy protocol GUID definition -// +/// +/// Security policy protocol GUID definition +/// #define EFI_SECURITY_POLICY_PROTOCOL_GUID \ {0x78E4D245, 0xCD4D, 0x4a05, {0xA2, 0xBA, 0x47, 0x43, 0xE8, 0x6C, 0xFC, 0xAB} } diff --git a/MdePkg/Include/Protocol/SerialIo.h b/MdePkg/Include/Protocol/SerialIo.h index 3cffd930e5..cf73f87708 100644 --- a/MdePkg/Include/Protocol/SerialIo.h +++ b/MdePkg/Include/Protocol/SerialIo.h @@ -23,22 +23,22 @@ 0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \ } -// -// Protocol GUID defined in EFI1.1. -// +/// +/// Protocol GUID defined in EFI1.1. +/// #define SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL_GUID typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL; -// -// Backward-compatible with EFI1.1. -// +/// +/// Backward-compatible with EFI1.1. +/// typedef EFI_SERIAL_IO_PROTOCOL SERIAL_IO_INTERFACE; -// -// Serial IO Data structures -// +/// +/// Serial IO Data structures +/// typedef enum { DefaultParity, NoParity, diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h index c0b5e83232..5f37727d6e 100644 --- a/MdePkg/Include/Protocol/ServiceBinding.h +++ b/MdePkg/Include/Protocol/ServiceBinding.h @@ -18,9 +18,9 @@ #ifndef __EFI_SERVICE_BINDING_H__ #define __EFI_SERVICE_BINDING_H__ -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_SERVICE_BINDING_PROTOCOL EFI_SERVICE_BINDING_PROTOCOL; /** diff --git a/MdePkg/Include/Protocol/SimpleFileSystem.h b/MdePkg/Include/Protocol/SimpleFileSystem.h index dfc8bc31fb..feead3fb1a 100644 --- a/MdePkg/Include/Protocol/SimpleFileSystem.h +++ b/MdePkg/Include/Protocol/SimpleFileSystem.h @@ -32,14 +32,14 @@ typedef struct _EFI_FILE_PROTOCOL EFI_FILE_PROTOCOL; typedef struct _EFI_FILE_PROTOCOL *EFI_FILE_HANDLE; -// -// Protocol GUID defined in EFI1.1. -// +/// +/// Protocol GUID defined in EFI1.1. +/// #define SIMPLE_FILE_SYSTEM_PROTOCOL EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_GUID -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_SIMPLE_FILE_SYSTEM_PROTOCOL EFI_FILE_IO_INTERFACE; typedef struct _EFI_FILE_PROTOCOL EFI_FILE; @@ -67,9 +67,9 @@ EFI_STATUS ; #define EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION 0x00010000 -// -// Revision defined in EFI1.1 -// +/// +/// Revision defined in EFI1.1 +/// #define EFI_FILE_IO_INTERFACE_REVISION EFI_SIMPLE_FILE_SYSTEM_PROTOCOL_REVISION struct _EFI_SIMPLE_FILE_SYSTEM_PROTOCOL { diff --git a/MdePkg/Include/Protocol/SimpleNetwork.h b/MdePkg/Include/Protocol/SimpleNetwork.h index 74c5163fbb..3766e98f97 100644 --- a/MdePkg/Include/Protocol/SimpleNetwork.h +++ b/MdePkg/Include/Protocol/SimpleNetwork.h @@ -30,72 +30,72 @@ typedef struct _EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK_PROTOCOL; -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_SIMPLE_NETWORK_PROTOCOL EFI_SIMPLE_NETWORK; -// -// Simple Network Protocol data structures -// +/// +/// Simple Network Protocol data structures +/// typedef struct { - // - // Total number of frames received. Includes frames with errors and - // dropped frames. - // + /// + /// Total number of frames received. Includes frames with errors and + /// dropped frames. + /// UINT64 RxTotalFrames; - // - // Number of valid frames received and copied into receive buffers. - // + /// + /// Number of valid frames received and copied into receive buffers. + /// UINT64 RxGoodFrames; - // - // Number of frames below the minimum length for the media. - // This would be <64 for ethernet. - // + /// + /// Number of frames below the minimum length for the media. + /// This would be <64 for ethernet. + /// UINT64 RxUndersizeFrames; - // - // Number of frames longer than the maxminum length for the - // media. This would be >1500 for ethernet. - // + /// + /// Number of frames longer than the maxminum length for the + /// media. This would be >1500 for ethernet. + /// UINT64 RxOversizeFrames; - // - // Valid frames that were dropped because receive buffers were full. - // + /// + /// Valid frames that were dropped because receive buffers were full. + /// UINT64 RxDroppedFrames; - // - // Number of valid unicast frames received and not dropped. - // + /// + /// Number of valid unicast frames received and not dropped. + /// UINT64 RxUnicastFrames; - // - // Number of valid broadcast frames received and not dropped. - // + /// + /// Number of valid broadcast frames received and not dropped. + /// UINT64 RxBroadcastFrames; - // - // Number of valid mutlicast frames received and not dropped. - // + /// + /// Number of valid mutlicast frames received and not dropped. + /// UINT64 RxMulticastFrames; - // - // Number of frames w/ CRC or alignment errors. - // + /// + /// Number of frames w/ CRC or alignment errors. + /// UINT64 RxCrcErrorFrames; - // - // Total number of bytes received. Includes frames with errors - // and dropped frames. + /// + /// Total number of bytes received. Includes frames with errors + /// and dropped frames. // UINT64 RxTotalBytes; - // - // Transmit statistics. - // + /// + /// Transmit statistics. + /// UINT64 TxTotalFrames; UINT64 TxGoodFrames; UINT64 TxUndersizeFrames; @@ -107,14 +107,14 @@ typedef struct { UINT64 TxCrcErrorFrames; UINT64 TxTotalBytes; - // - // Number of collisions detection on this subnet. - // + /// + /// Number of collisions detection on this subnet. + /// UINT64 Collisions; - // - // Number of frames destined for unsupported protocol. - // + /// + /// Number of frames destined for unsupported protocol. + /// UINT64 UnsupportedProtocol; } EFI_NETWORK_STATISTICS; diff --git a/MdePkg/Include/Protocol/SimpleTextIn.h b/MdePkg/Include/Protocol/SimpleTextIn.h index 292339a651..d7d58874e5 100644 --- a/MdePkg/Include/Protocol/SimpleTextIn.h +++ b/MdePkg/Include/Protocol/SimpleTextIn.h @@ -25,16 +25,16 @@ 0x387477c1, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \ } -// -// Protocol GUID defined in EFI1.1. -// +/// +/// Protocol GUID defined in EFI1.1. +/// #define SIMPLE_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL_GUID typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL EFI_SIMPLE_TEXT_INPUT_PROTOCOL; -// -// Backward-compatible with EFI1.1. -// +/// +/// Backward-compatible with EFI1.1. +/// typedef struct _EFI_SIMPLE_TEXT_INPUT_PROTOCOL SIMPLE_INPUT_INTERFACE; // // Data structures diff --git a/MdePkg/Include/Protocol/SimpleTextOut.h b/MdePkg/Include/Protocol/SimpleTextOut.h index 5361e5c03d..6a00cfdb78 100644 --- a/MdePkg/Include/Protocol/SimpleTextOut.h +++ b/MdePkg/Include/Protocol/SimpleTextOut.h @@ -27,16 +27,16 @@ 0x387477c2, 0x69c7, 0x11d2, {0x8e, 0x39, 0x0, 0xa0, 0xc9, 0x69, 0x72, 0x3b } \ } -// -// Protocol GUID defined in EFI1.1. -// +/// +/// Protocol GUID defined in EFI1.1. +/// #define SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL_GUID typedef struct _EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL; -// -// Backward-compatible with EFI1.1. -// +/// +/// Backward-compatible with EFI1.1. +/// typedef EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL SIMPLE_TEXT_OUTPUT_INTERFACE; // diff --git a/MdePkg/Include/Protocol/Timer.h b/MdePkg/Include/Protocol/Timer.h index 12d053d4be..cdf7b9bda9 100644 --- a/MdePkg/Include/Protocol/Timer.h +++ b/MdePkg/Include/Protocol/Timer.h @@ -17,15 +17,15 @@ #ifndef __ARCH_PROTOCOL_TIMER_H__ #define __ARCH_PROTOCOL_TIMER_H__ -// -// Global ID for the Timer Architectural Protocol -// +/// +/// Global ID for the Timer Architectural Protocol +/// #define EFI_TIMER_ARCH_PROTOCOL_GUID \ { 0x26baccb3, 0x6f42, 0x11d4, {0xbc, 0xe7, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } } -// -// Declare forward reference for the Timer Architectural Protocol -// +/// +/// Declare forward reference for the Timer Architectural Protocol +/// typedef struct _EFI_TIMER_ARCH_PROTOCOL EFI_TIMER_ARCH_PROTOCOL; /** diff --git a/MdePkg/Include/Protocol/UnicodeCollation.h b/MdePkg/Include/Protocol/UnicodeCollation.h index 0954f545bd..4ca50d56f8 100644 --- a/MdePkg/Include/Protocol/UnicodeCollation.h +++ b/MdePkg/Include/Protocol/UnicodeCollation.h @@ -30,19 +30,19 @@ typedef struct _EFI_UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL; -// -// Protocol GUID name defined in EFI1.1. -// +/// +/// Protocol GUID name defined in EFI1.1. +/// #define UNICODE_COLLATION_PROTOCOL EFI_UNICODE_COLLATION_PROTOCOL_GUID -// -// Protocol defined in EFI1.1. -// +/// +/// Protocol defined in EFI1.1. +/// typedef EFI_UNICODE_COLLATION_PROTOCOL UNICODE_COLLATION_INTERFACE; -// -// Protocol data structures and defines -// +/// +/// Protocol data structures and defines +/// #define EFI_UNICODE_BYTE_ORDER_MARK (CHAR16) (0xfeff) // diff --git a/MdePkg/Include/Protocol/Usb2HostController.h b/MdePkg/Include/Protocol/Usb2HostController.h index b494b3a156..54f67530dc 100644 --- a/MdePkg/Include/Protocol/Usb2HostController.h +++ b/MdePkg/Include/Protocol/Usb2HostController.h @@ -26,9 +26,9 @@ 0x3e745226, 0x9818, 0x45b6, {0xa2, 0xac, 0xd7, 0xcd, 0xe, 0x8b, 0xa2, 0xbc } \ } -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_USB2_HC_PROTOCOL EFI_USB2_HC_PROTOCOL; diff --git a/MdePkg/Include/Protocol/UsbHostController.h b/MdePkg/Include/Protocol/UsbHostController.h index e42306a4dd..6f9a0109b2 100644 --- a/MdePkg/Include/Protocol/UsbHostController.h +++ b/MdePkg/Include/Protocol/UsbHostController.h @@ -26,9 +26,9 @@ 0xf5089266, 0x1aa0, 0x4953, {0x97, 0xd8, 0x56, 0x2f, 0x8a, 0x73, 0xb5, 0x19 } \ } -// -// Forward reference for pure ANSI compatability -// +/// +/// Forward reference for pure ANSI compatability +/// typedef struct _EFI_USB_HC_PROTOCOL EFI_USB_HC_PROTOCOL; // diff --git a/MdePkg/Include/Protocol/Variable.h b/MdePkg/Include/Protocol/Variable.h index ea60c20e6a..9c09f1b498 100644 --- a/MdePkg/Include/Protocol/Variable.h +++ b/MdePkg/Include/Protocol/Variable.h @@ -23,9 +23,9 @@ #ifndef __ARCH_PROTOCOL_VARIABLE_ARCH_H__ #define __ARCH_PROTOCOL_VARIABLE_ARCH_H__ -// -// Global ID for the Variable Architectural Protocol -// +/// +/// Global ID for the Variable Architectural Protocol +/// #define EFI_VARIABLE_ARCH_PROTOCOL_GUID \ { 0x1e5668e2, 0x8481, 0x11d4, {0xbc, 0xf1, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81 } } diff --git a/MdePkg/Include/Protocol/VariableWrite.h b/MdePkg/Include/Protocol/VariableWrite.h index cb8050eb0d..802026b739 100644 --- a/MdePkg/Include/Protocol/VariableWrite.h +++ b/MdePkg/Include/Protocol/VariableWrite.h @@ -22,9 +22,9 @@ #ifndef __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__ #define __ARCH_PROTOCOL_VARIABLE_WRITE_ARCH_H__ -// -// Global ID for the Variable Write Architectural Protocol -// +/// +/// Global ID for the Variable Write Architectural Protocol +/// #define EFI_VARIABLE_WRITE_ARCH_PROTOCOL_GUID \ { 0x6441f818, 0x6362, 0x4e44, {0xb5, 0x70, 0x7d, 0xba, 0x31, 0xdd, 0x24, 0x53 } } diff --git a/MdePkg/Include/Protocol/WatchdogTimer.h b/MdePkg/Include/Protocol/WatchdogTimer.h index d85dc5bb94..3dc1a587ce 100644 --- a/MdePkg/Include/Protocol/WatchdogTimer.h +++ b/MdePkg/Include/Protocol/WatchdogTimer.h @@ -16,15 +16,15 @@ #ifndef __ARCH_PROTOCOL_WATCHDOG_TIMER_H__ #define __ARCH_PROTOCOL_WATCHDOG_TIMER_H__ -// -// Global ID for the Watchdog Timer Architectural Protocol -// +/// +/// Global ID for the Watchdog Timer Architectural Protocol +/// #define EFI_WATCHDOG_TIMER_ARCH_PROTOCOL_GUID \ { 0x665E3FF5, 0x46CC, 0x11d4, {0x9A, 0x38, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D } } -// -// Declare forward reference for the Timer Architectural Protocol -// +/// +/// Declare forward reference for the Timer Architectural Protocol +/// typedef struct _EFI_WATCHDOG_TIMER_ARCH_PROTOCOL EFI_WATCHDOG_TIMER_ARCH_PROTOCOL; /** -- 2.39.2