ShellPkg/UefiShellAcpiViewCommandLib: Fix ECC issues
authorDandan Bi <dandan.bi@intel.com>
Mon, 4 Jun 2018 01:14:51 +0000 (09:14 +0800)
committerEric Dong <eric.dong@intel.com>
Mon, 11 Jun 2018 08:10:21 +0000 (16:10 +0800)
Make the function comments follow EDK2 coding style.

Cc: Sami Mujawar <sami.mujawar@arm.com>
Cc: Evan Lloyd <evan.lloyd@arm.com>
Cc: Jaben Carsey <jaben.carsey@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Dandan Bi <dandan.bi@intel.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>
22 files changed:
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiTableParser.h
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiView.h
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Bgrt/BgrtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Dbg2/Dbg2Parser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Dsdt/DsdtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Fadt/FadtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Gtdt/GtdtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Iort/IortParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Madt/MadtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Mcfg/McfgParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Rsdp/RsdpParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Slit/SlitParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Spcr/SpcrParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Srat/SratParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Ssdt/SsdtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/Parsers/Xsdt/XsdtParser.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.c
ShellPkg/Library/UefiShellAcpiViewCommandLib/UefiShellAcpiViewCommandLib.h

index 318f386..088575d 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   ACPI parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -21,8 +21,9 @@ STATIC UINT32   gIndent;
 STATIC UINT32   mTableErrorCount;\r
 STATIC UINT32   mTableWarningCount;\r
 \r
-/** This function resets the ACPI table error counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table error counter to Zero.\r
+**/\r
 VOID\r
 ResetErrorCount (\r
   VOID\r
@@ -31,10 +32,11 @@ ResetErrorCount (
   mTableErrorCount = 0;\r
 }\r
 \r
-/** This function returns the ACPI table error count.\r
+/**\r
+  This function returns the ACPI table error count.\r
 \r
   @retval Returns the count of errors detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetErrorCount (\r
   VOID\r
@@ -43,8 +45,9 @@ GetErrorCount (
   return mTableErrorCount;\r
 }\r
 \r
-/** This function resets the ACPI table warning counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table warning counter to Zero.\r
+**/\r
 VOID\r
 ResetWarningCount (\r
   VOID\r
@@ -53,10 +56,11 @@ ResetWarningCount (
   mTableWarningCount = 0;\r
 }\r
 \r
-/** This function returns the ACPI table warning count.\r
+/**\r
+  This function returns the ACPI table warning count.\r
 \r
   @retval Returns the count of warning detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetWarningCount (\r
   VOID\r
@@ -65,8 +69,9 @@ GetWarningCount (
   return mTableWarningCount;\r
 }\r
 \r
-/** This function increments the ACPI table error counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table error counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementErrorCount (\r
@@ -76,8 +81,9 @@ IncrementErrorCount (
   mTableErrorCount++;\r
 }\r
 \r
-/** This function increments the ACPI table warning counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table warning counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementWarningCount (\r
@@ -87,7 +93,8 @@ IncrementWarningCount (
   mTableWarningCount++;\r
 }\r
 \r
-/** This function verifies the ACPI table checksum.\r
+/**\r
+  This function verifies the ACPI table checksum.\r
 \r
   This function verifies the checksum for the ACPI table and optionally\r
   prints the status.\r
@@ -98,7 +105,7 @@ IncrementWarningCount (
 \r
   @retval TRUE        The checksum is OK.\r
   @retval FALSE       The checksum failed.\r
-*/\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 VerifyChecksum (\r
@@ -146,11 +153,12 @@ VerifyChecksum (
   return (Checksum == 0);\r
 }\r
 \r
-/** This function performs a raw data dump of the ACPI table.\r
+/**\r
+  This function performs a raw data dump of the ACPI table.\r
 \r
   @param [in] Ptr     Pointer to the start of the table buffer.\r
   @param [in] Length  The length of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpRaw (\r
@@ -205,12 +213,12 @@ DumpRaw (
   Print (L"  %a", AsciiBuffer);\r
 }\r
 \r
-/** This function traces 1 byte of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 1 byte of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint8 (\r
@@ -221,12 +229,12 @@ DumpUint8 (
   Print (Format, *Ptr);\r
 }\r
 \r
-/** This function traces 2 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 2 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint16 (\r
@@ -237,12 +245,12 @@ DumpUint16 (
   Print (Format, *(UINT16*)Ptr);\r
 }\r
 \r
-/** This function traces 4 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 4 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint32 (\r
@@ -253,12 +261,12 @@ DumpUint32 (
   Print (Format, *(UINT32*)Ptr);\r
 }\r
 \r
-/** This function traces 8 bytes of data as specified by the\r
-    format string.\r
+/**\r
+  This function traces 8 bytes of data as specified by the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint64 (\r
@@ -276,14 +284,15 @@ DumpUint64 (
   Print (Format, Val);\r
 }\r
 \r
-/** This function traces 3 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 3 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump3Chars (\r
@@ -299,14 +308,15 @@ Dump3Chars (
     );\r
 }\r
 \r
-/** This function traces 4 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 4 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump4Chars (\r
@@ -323,14 +333,15 @@ Dump4Chars (
     );\r
 }\r
 \r
-/** This function traces 6 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 6 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump6Chars (\r
@@ -349,14 +360,15 @@ Dump6Chars (
     );\r
 }\r
 \r
-/** This function traces 8 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 8 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump8Chars (\r
@@ -377,7 +389,8 @@ Dump8Chars (
     );\r
 }\r
 \r
-/** This function indents and prints the ACPI table Field Name.\r
+/**\r
+  This function indents and prints the ACPI table Field Name.\r
 \r
   @param [in] Indent      Number of spaces to add to the global table indent.\r
                           The global table indent is 0 by default; however\r
@@ -387,7 +400,7 @@ Dump8Chars (
                           Therefore the total indent in the output is\r
                           dependent on from where this function is called.\r
   @param [in] FieldName   Pointer to the Field Name.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 PrintFieldName (\r
@@ -404,7 +417,8 @@ PrintFieldName (
     );\r
 }\r
 \r
-/** This function is used to parse an ACPI table buffer.\r
+/**\r
+  This function is used to parse an ACPI table buffer.\r
 \r
   The ACPI table buffer is parsed using the ACPI table parser information\r
   specified by a pointer to an array of ACPI_PARSER elements. This parser\r
@@ -428,7 +442,7 @@ PrintFieldName (
   @param [in] ParserItems  Number of items in the ACPI_PARSER array.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpi (\r
@@ -540,10 +554,11 @@ ParseAcpi (
   return Offset;\r
 }\r
 \r
-/** An array describing the ACPI Generic Address Structure.\r
+/**\r
+  An array describing the ACPI Generic Address Structure.\r
   The GasParser array is used by the ParseAcpi function to parse and/or trace\r
   the GAS structure.\r
-*/\r
+**/\r
 STATIC CONST ACPI_PARSER GasParser[] = {\r
   {L"Address Space ID", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Register Bit Width", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -552,12 +567,12 @@ STATIC CONST ACPI_PARSER GasParser[] = {
   {L"Address", 8, 4, L"0x%lx", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function indents and traces the GAS structure as described\r
-    by the GasParser.\r
+/**\r
+  This function indents and traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Ptr     Pointer to the start of the buffer.\r
   @param [in] Indent  Number of spaces to indent the output.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGasStruct (\r
@@ -576,11 +591,12 @@ DumpGasStruct (
     );\r
 }\r
 \r
-/** This function traces the GAS structure as described by the GasParser.\r
+/**\r
+  This function traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGas (\r
@@ -591,12 +607,13 @@ DumpGas (
   DumpGasStruct (Ptr, 2);\r
 }\r
 \r
-/** This function traces the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function traces the ACPI header as described by the AcpiHeaderParser.\r
 \r
   @param [in] Ptr          Pointer to the start of the buffer.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 DumpAcpiHeader (\r
@@ -618,7 +635,8 @@ DumpAcpiHeader (
            );\r
 }\r
 \r
-/** This function parses the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function parses the ACPI header as described by the AcpiHeaderParser.\r
 \r
   This function optionally returns the signature, length and revision of the\r
   ACPI table.\r
@@ -629,7 +647,7 @@ DumpAcpiHeader (
   @param [out] Revision   Gets location of the revision of the ACPI table.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpiHeader (\r
index 4dadd4d..ecf7dae 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for ACPI parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 /// that allows us to process the log options.\r
 #define RSDP_TABLE_INFO  SIGNATURE_32('R', 'S', 'D', 'P')\r
 \r
-/** This function increments the ACPI table error counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table error counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function increments the ACPI table warning counter.\r
-*/\r
+/**\r
+  This function increments the ACPI table warning counter.\r
+**/\r
 VOID\r
 EFIAPI\r
 IncrementWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function verifies the ACPI table checksum.\r
+/**\r
+  This function verifies the ACPI table checksum.\r
 \r
   This function verifies the checksum for the ACPI table and optionally\r
   prints the status.\r
@@ -49,7 +52,7 @@ IncrementWarningCount (
 \r
   @retval TRUE         The checksum is OK.\r
   @retval FALSE        The checksum failed.\r
-*/\r
+**/\r
 BOOLEAN\r
 EFIAPI\r
 VerifyChecksum (\r
@@ -58,11 +61,12 @@ VerifyChecksum (
   IN UINT32  Length\r
   );\r
 \r
-/** This function performs a raw data dump of the ACPI table.\r
+/**\r
+  This function performs a raw data dump of the ACPI table.\r
 \r
   @param [in] Ptr     Pointer to the start of the table buffer.\r
   @param [in] Length  The length of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpRaw (\r
@@ -70,12 +74,12 @@ DumpRaw (
   IN UINT32 Length\r
   );\r
 \r
-/** This function traces 1 byte of datum as specified in the\r
-    format string.\r
+/**\r
+  This function traces 1 byte of datum as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint8 (\r
@@ -83,12 +87,12 @@ DumpUint8 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 2 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 2 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint16 (\r
@@ -96,12 +100,12 @@ DumpUint16 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 4 bytes of data as specified in the\r
-    format string.\r
+/**\r
+  This function traces 4 bytes of data as specified in the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint32 (\r
@@ -109,12 +113,12 @@ DumpUint32 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 8 bytes of data as specified by the\r
-    format string.\r
+/**\r
+  This function traces 8 bytes of data as specified by the format string.\r
 \r
   @param [in] Format  The format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpUint64 (\r
@@ -122,14 +126,15 @@ DumpUint64 (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 3 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 3 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump3Chars (\r
@@ -137,14 +142,15 @@ Dump3Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 4 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 4 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump4Chars (\r
@@ -152,14 +158,15 @@ Dump4Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 6 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 6 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump6Chars (\r
@@ -167,14 +174,15 @@ Dump6Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces 8 characters which can be optionally\r
-   formated using the format string if specified.\r
+/**\r
+  This function traces 8 characters which can be optionally\r
+  formated using the format string if specified.\r
 \r
   If no format string is specified the Format must be NULL.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 Dump8Chars (\r
@@ -182,7 +190,8 @@ Dump8Chars (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function indents and prints the ACPI table Field Name.\r
+/**\r
+  This function indents and prints the ACPI table Field Name.\r
 \r
   @param [in] Indent      Number of spaces to add to the global table\r
                           indent. The global table indent is 0 by default;\r
@@ -192,33 +201,36 @@ Dump8Chars (
                           the total indent in the output is dependent on from\r
                           where this function is called.\r
   @param [in] FieldName   Pointer to the Field Name.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 PrintFieldName (\r
   IN UINT32         Indent,\r
   IN CONST CHAR16*  FieldName\r
-);\r
+  );\r
 \r
-/** This function pointer is the template for customizing the trace output\r
+/**\r
+  This function pointer is the template for customizing the trace output\r
 \r
   @param [in] Format  Format string for tracing the data as specified by\r
                       the 'Format' member of ACPI_PARSER.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 typedef VOID (EFIAPI *FNPTR_PRINT_FORMATTER)(CONST CHAR16* Format, UINT8* Ptr);\r
 \r
-/** This function pointer is the template for validating an ACPI table field.\r
+/**\r
+  This function pointer is the template for validating an ACPI table field.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information as specified by\r
                       the 'Context' member of the ACPI_PARSER.\r
                       e.g. this could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 typedef VOID (EFIAPI *FNPTR_FIELD_VALIDATOR)(UINT8* Ptr, VOID* Context);\r
 \r
-/** The ACPI_PARSER structure describes the fields of an ACPI table and\r
-    provides means for the parser to interpret and trace appropriately.\r
+/**\r
+  The ACPI_PARSER structure describes the fields of an ACPI table and\r
+  provides means for the parser to interpret and trace appropriately.\r
 \r
   The first three members are populated based on information present in\r
   in the ACPI table specifications. The remaining members describe how\r
@@ -234,7 +246,7 @@ typedef VOID (EFIAPI *FNPTR_FIELD_VALIDATOR)(UINT8* Ptr, VOID* Context);
 \r
   The 'Format' and 'PrintFormatter' members allow flexibility for\r
   representing the field data.\r
-*/\r
+**/\r
 typedef struct AcpiParser {\r
 \r
   /// String describing the ACPI table field\r
@@ -278,9 +290,10 @@ typedef struct AcpiParser {
   VOID*                 Context;\r
 } ACPI_PARSER;\r
 \r
-/** A structure used to store the pointers to the members of the\r
-    ACPI description header structure that was parsed.\r
-*/\r
+/**\r
+  A structure used to store the pointers to the members of the\r
+  ACPI description header structure that was parsed.\r
+**/\r
 typedef struct AcpiDescriptionHeaderInfo {\r
   /// ACPI table signature\r
   UINT32* Signature;\r
@@ -302,7 +315,8 @@ typedef struct AcpiDescriptionHeaderInfo {
   UINT32* CreatorRevision;\r
 } ACPI_DESCRIPTION_HEADER_INFO;\r
 \r
-/** This function is used to parse an ACPI table buffer.\r
+/**\r
+  This function is used to parse an ACPI table buffer.\r
 \r
   The ACPI table buffer is parsed using the ACPI table parser information\r
   specified by a pointer to an array of ACPI_PARSER elements. This parser\r
@@ -326,7 +340,7 @@ typedef struct AcpiDescriptionHeaderInfo {
   @param [in] ParserItems  Number of items in the ACPI_PARSER array.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpi (\r
@@ -337,19 +351,21 @@ ParseAcpi (
   IN UINT32             Length,\r
   IN CONST ACPI_PARSER* Parser,\r
   IN UINT32             ParserItems\r
-);\r
+  );\r
 \r
-/** This is a helper macro to pass parameters to the Parser functions.\r
+/**\r
+   This is a helper macro to pass parameters to the Parser functions.\r
 \r
   @param [in] Parser The name of the ACPI_PARSER array describing the\r
               ACPI table fields.\r
-*/\r
+**/\r
 #define PARSER_PARAMS(Parser) Parser, sizeof (Parser) / sizeof (Parser[0])\r
 \r
-/** This is a helper macro for describing the ACPI header fields.\r
+/**\r
+  This is a helper macro for describing the ACPI header fields.\r
 \r
   @param [out] Info  Pointer to retrieve the ACPI table header information.\r
-*/\r
+**/\r
 #define PARSE_ACPI_HEADER(Info)                   \\r
   { L"Signature", 4, 0, NULL, Dump4Chars,         \\r
     (VOID**)&(Info)->Signature , NULL, NULL },    \\r
@@ -370,30 +386,32 @@ ParseAcpi (
   { L"Creator Revision", 4, 32, L"0x%X", NULL,    \\r
     (VOID**)&(Info)->CreatorRevision, NULL, NULL }\r
 \r
-/** Length of the ACPI GAS structure.\r
+/**\r
+  Length of the ACPI GAS structure.\r
 \r
   NOTE: This might normally be defined as\r
         sizeof (EFI_ACPI_6_2_GENERIC_ADDRESS_STRUCTURE).\r
         However, we deliberately minimise any reference to the EDK2 ACPI\r
         headers in an attempt to provide cross checking.\r
-*/\r
+**/\r
 #define GAS_LENGTH                     12\r
 \r
-/** Length of the ACPI Header structure.\r
+/**\r
+  Length of the ACPI Header structure.\r
 \r
   NOTE: This might normally be defined as\r
         sizeof (EFI_ACPI_DESCRIPTION_HEADER).\r
         However, we deliberately minimise any reference to the EDK2 ACPI\r
         headers in an attempt to provide cross checking.\r
-*/\r
+**/\r
 #define ACPI_DESCRIPTION_HEADER_LENGTH  36\r
 \r
-/** This function indents and traces the GAS structure as described\r
-    by the GasParser.\r
+/**\r
+  This function indents and traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Ptr     Pointer to the start of the buffer.\r
   @param [in] Indent  Number of spaces to indent the output.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGasStruct (\r
@@ -401,11 +419,12 @@ DumpGasStruct (
   IN UINT32        Indent\r
   );\r
 \r
-/** This function traces the GAS structure as described by the GasParser.\r
+/**\r
+  This function traces the GAS structure as described by the GasParser.\r
 \r
   @param [in] Format  Optional format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 DumpGas (\r
@@ -413,19 +432,21 @@ DumpGas (
   IN UINT8*        Ptr\r
   );\r
 \r
-/** This function traces the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function traces the ACPI header as described by the AcpiHeaderParser.\r
 \r
   @param [in] Ptr          Pointer to the start of the buffer.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 DumpAcpiHeader (\r
   IN UINT8* Ptr\r
   );\r
 \r
-/** This function parses the ACPI header as described by the AcpiHeaderParser.\r
+/**\r
+  This function parses the ACPI header as described by the AcpiHeaderParser.\r
 \r
   This function optionally returns the Signature, Length and revision of the\r
   ACPI table.\r
@@ -436,7 +457,7 @@ DumpAcpiHeader (
   @param [out] Revision   Gets location of the revision of the ACPI table.\r
 \r
   @retval Number of bytes parsed.\r
-*/\r
+**/\r
 UINT32\r
 EFIAPI\r
 ParseAcpiHeader (\r
@@ -446,7 +467,8 @@ ParseAcpiHeader (
   OUT CONST UINT8**  Revision\r
   );\r
 \r
-/** This function parses the ACPI BGRT table.\r
+/**\r
+  This function parses the ACPI BGRT table.\r
   When trace is enabled this function parses the BGRT table and\r
   traces the ACPI table fields.\r
 \r
@@ -456,7 +478,7 @@ ParseAcpiHeader (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiBgrt (\r
@@ -466,7 +488,8 @@ ParseAcpiBgrt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI DBG2 table.\r
+/**\r
+  This function parses the ACPI DBG2 table.\r
   When trace is enabled this function parses the DBG2 table and\r
   traces the ACPI table fields.\r
 \r
@@ -476,7 +499,7 @@ ParseAcpiBgrt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDbg2 (\r
@@ -486,7 +509,8 @@ ParseAcpiDbg2 (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI DSDT table.\r
+/**\r
+  This function parses the ACPI DSDT table.\r
   When trace is enabled this function parses the DSDT table and\r
   traces the ACPI table fields.\r
   For the DSDT table only the ACPI header fields are parsed and\r
@@ -496,7 +520,7 @@ ParseAcpiDbg2 (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDsdt (\r
@@ -506,7 +530,8 @@ ParseAcpiDsdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI FADT table.\r
+/**\r
+  This function parses the ACPI FADT table.\r
   This function parses the FADT table and optionally traces the ACPI\r
   table fields.\r
 \r
@@ -516,7 +541,7 @@ ParseAcpiDsdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiFadt (\r
@@ -526,7 +551,8 @@ ParseAcpiFadt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI GTDT table.\r
+/**\r
+  This function parses the ACPI GTDT table.\r
   When trace is enabled this function parses the GTDT table and\r
   traces the ACPI table fields.\r
 \r
@@ -540,7 +566,7 @@ ParseAcpiFadt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiGtdt (\r
@@ -550,7 +576,8 @@ ParseAcpiGtdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI IORT table.\r
+/**\r
+  This function parses the ACPI IORT table.\r
   When trace is enabled this function parses the IORT table and\r
   traces the ACPI fields.\r
 \r
@@ -568,7 +595,7 @@ ParseAcpiGtdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiIort (\r
@@ -578,7 +605,8 @@ ParseAcpiIort (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI MADT table.\r
+/**\r
+  This function parses the ACPI MADT table.\r
   When trace is enabled this function parses the MADT table and\r
   traces the ACPI table fields.\r
 \r
@@ -596,7 +624,7 @@ ParseAcpiIort (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMadt (\r
@@ -606,7 +634,8 @@ ParseAcpiMadt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI MCFG table.\r
+/**\r
+  This function parses the ACPI MCFG table.\r
   When trace is enabled this function parses the MCFG table and\r
   traces the ACPI table fields.\r
 \r
@@ -616,7 +645,7 @@ ParseAcpiMadt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMcfg (\r
@@ -626,7 +655,8 @@ ParseAcpiMcfg (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI RSDP table.\r
+/**\r
+  This function parses the ACPI RSDP table.\r
 \r
   This function invokes the parser for the XSDT table.\r
   * Note - This function does not support parsing of RSDT table.\r
@@ -638,7 +668,7 @@ ParseAcpiMcfg (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiRsdp (\r
@@ -648,7 +678,8 @@ ParseAcpiRsdp (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SLIT table.\r
+/**\r
+  This function parses the ACPI SLIT table.\r
   When trace is enabled this function parses the SLIT table and\r
   traces the ACPI table fields.\r
 \r
@@ -661,7 +692,7 @@ ParseAcpiRsdp (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSlit (\r
@@ -671,7 +702,8 @@ ParseAcpiSlit (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SPCR table.\r
+/**\r
+  This function parses the ACPI SPCR table.\r
   When trace is enabled this function parses the SPCR table and\r
   traces the ACPI table fields.\r
 \r
@@ -681,7 +713,7 @@ ParseAcpiSlit (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSpcr (\r
@@ -691,7 +723,8 @@ ParseAcpiSpcr (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SRAT table.\r
+/**\r
+  This function parses the ACPI SRAT table.\r
   When trace is enabled this function parses the SRAT table and\r
   traces the ACPI table fields.\r
 \r
@@ -707,7 +740,7 @@ ParseAcpiSpcr (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSrat (\r
@@ -717,7 +750,8 @@ ParseAcpiSrat (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI SSDT table.\r
+/**\r
+  This function parses the ACPI SSDT table.\r
   When trace is enabled this function parses the SSDT table and\r
   traces the ACPI table fields.\r
   For the SSDT table only the ACPI header fields are\r
@@ -727,7 +761,7 @@ ParseAcpiSrat (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSsdt (\r
@@ -737,7 +771,8 @@ ParseAcpiSsdt (
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** This function parses the ACPI XSDT table\r
+/**\r
+  This function parses the ACPI XSDT table\r
   and optionally traces the ACPI table fields.\r
 \r
   This function also performs validation of the XSDT table.\r
@@ -746,7 +781,7 @@ ParseAcpiSsdt (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiXsdt (\r
index 14a8b14..7b1a02c 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   ACPI table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 #include "AcpiTableParser.h"\r
 #include "AcpiView.h"\r
 \r
-/** A list of registered ACPI table parsers.\r
-*/\r
+/**\r
+  A list of registered ACPI table parsers.\r
+**/\r
 STATIC ACPI_TABLE_PARSER mTableParserList[MAX_ACPI_TABLE_PARSERS];\r
 \r
-/** Register the ACPI table Parser\r
+/**\r
+  Register the ACPI table Parser\r
 \r
   This function registers the ACPI table parser.\r
 \r
@@ -35,7 +37,7 @@ STATIC ACPI_TABLE_PARSER mTableParserList[MAX_ACPI_TABLE_PARSERS];
                                 was already registered.\r
   @retval EFI_OUT_OF_RESOURCES  No space to register the\r
                                 parser.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 RegisterParser (\r
@@ -77,7 +79,8 @@ RegisterParser (
   return EFI_OUT_OF_RESOURCES;\r
 }\r
 \r
-/** Deregister the ACPI table Parser\r
+/**\r
+  Deregister the ACPI table Parser\r
 \r
   This function deregisters the ACPI table parser.\r
 \r
@@ -86,7 +89,7 @@ RegisterParser (
   @retval EFI_SUCCESS           The parser was deregistered.\r
   @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
   @retval EFI_NOT_FOUND         A registered parser was not found.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DeregisterParser (\r
@@ -114,7 +117,8 @@ DeregisterParser (
   return EFI_NOT_FOUND;\r
 }\r
 \r
-/** Get the ACPI table Parser\r
+/**\r
+  Get the ACPI table Parser\r
 \r
   This function returns the ACPI table parser proc from the list of\r
   registered parsers.\r
@@ -125,7 +129,7 @@ DeregisterParser (
   @retval EFI_SUCCESS           The parser was returned successfully.\r
   @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
   @retval EFI_NOT_FOUND         A registered parser was not found.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 GetParser (\r
@@ -153,7 +157,8 @@ GetParser (
   return EFI_NOT_FOUND;\r
 }\r
 \r
-/** This function processes the ACPI tables.\r
+/**\r
+  This function processes the ACPI tables.\r
   This function calls ProcessTableReportOptions() to list the ACPI\r
   tables, perform binary dump of the tables and determine if the\r
   ACPI fields should be traced.\r
@@ -165,7 +170,7 @@ GetParser (
 \r
   @param [in] Ptr                Pointer to the start of the ACPI\r
                                  table data buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ProcessAcpiTable (\r
index a69d56d..ca33b93 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for ACPI table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -14,7 +14,8 @@
 #ifndef ACPITABLEPARSER_H_\r
 #define ACPITABLEPARSER_H_\r
 \r
-/** The maximum number of ACPI table parsers.\r
+/**\r
+  The maximum number of ACPI table parsers.\r
 */\r
 #define MAX_ACPI_TABLE_PARSERS          16\r
 \r
 */\r
 #define ACPI_PARSER_SIGNATURE_NULL      0\r
 \r
-/** A function that parses the ACPI table.\r
+/**\r
+  A function that parses the ACPI table.\r
 \r
   @param [in] Trace              If TRUE, trace the ACPI fields.\r
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 typedef\r
 VOID\r
 (EFIAPI * PARSE_ACPI_TABLE_PROC) (\r
@@ -38,8 +40,9 @@ VOID
   IN UINT8   AcpiTableRevision\r
   );\r
 \r
-/** The ACPI table parser information\r
-*/\r
+/**\r
+  The ACPI table parser information\r
+**/\r
 typedef struct AcpiTableParser {\r
   /// ACPI table signature\r
   UINT32                  Signature;\r
@@ -48,7 +51,8 @@ typedef struct AcpiTableParser {
   PARSE_ACPI_TABLE_PROC   Parser;\r
 } ACPI_TABLE_PARSER;\r
 \r
-/** Register the ACPI table Parser\r
+/**\r
+  Register the ACPI table Parser\r
 \r
   This function registers the ACPI table parser.\r
 \r
@@ -61,15 +65,16 @@ typedef struct AcpiTableParser {
                                 was already registered.\r
   @retval EFI_OUT_OF_RESOURCES  No space to register the\r
                                 parser.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 RegisterParser (\r
   IN  UINT32                  Signature,\r
   IN  PARSE_ACPI_TABLE_PROC   ParserProc\r
-);\r
+  );\r
 \r
-/** Deregister the ACPI table Parser\r
+/**\r
+  Deregister the ACPI table Parser\r
 \r
   This function deregisters the ACPI table parser.\r
 \r
@@ -78,14 +83,15 @@ RegisterParser (
   @retval EFI_SUCCESS           The parser was deregistered.\r
   @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
   @retval EFI_NOT_FOUND         A registered parser was not found.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 DeregisterParser (\r
   IN  UINT32                  Signature\r
-);\r
+  );\r
 \r
-/** This function processes the ACPI tables.\r
+/**\r
+  This function processes the ACPI tables.\r
   This function calls ProcessTableReportOptions() to list the ACPI\r
   tables, perform binary dump of the tables and determine if the\r
   ACPI fields should be traced.\r
@@ -97,14 +103,15 @@ DeregisterParser (
 \r
   @param [in] Ptr                Pointer to the start of the ACPI\r
                                  table data buffer.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ProcessAcpiTable (\r
   IN UINT8* Ptr\r
   );\r
 \r
-/** Get the ACPI table Parser\r
+/**\r
+  Get the ACPI table Parser\r
 \r
   This function returns the ACPI table parser proc from the list of\r
   registered parsers.\r
@@ -115,7 +122,7 @@ ProcessAcpiTable (
   @retval EFI_SUCCESS           The parser was returned successfully.\r
   @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
   @retval EFI_NOT_FOUND         A registered parser was not found.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 GetParser (\r
index 3bb1425..f5602e9 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
   This program and the accompanying materials\r
@@ -35,8 +35,9 @@ STATIC BOOLEAN            mVerbose;
 STATIC BOOLEAN            mConsistencyCheck;\r
 STATIC BOOLEAN            mColourHighlighting;\r
 \r
-/** An array of acpiview command line parameters.\r
-*/\r
+/**\r
+  An array of acpiview command line parameters.\r
+**/\r
 STATIC CONST SHELL_PARAM_ITEM ParamList[] = {\r
   {L"/?", TypeFlag},\r
   {L"-c", TypeFlag},\r
@@ -48,10 +49,11 @@ STATIC CONST SHELL_PARAM_ITEM ParamList[] = {
   {NULL, TypeMax}\r
 };\r
 \r
-/** This function returns the colour highlighting status.\r
+/**\r
+  This function returns the colour highlighting status.\r
 \r
   @retval TRUE if colour highlighting is enabled.\r
-*/\r
+**/\r
 BOOLEAN\r
 GetColourHighlighting (\r
   VOID\r
@@ -60,9 +62,12 @@ GetColourHighlighting (
   return mColourHighlighting;\r
 }\r
 \r
-/** This function sets the colour highlighting status.\r
+/**\r
+  This function sets the colour highlighting status.\r
 \r
-*/\r
+  @param  Highlight       The Highlight status.\r
+\r
+**/\r
 VOID\r
 SetColourHighlighting (\r
   BOOLEAN Highlight\r
@@ -71,10 +76,11 @@ SetColourHighlighting (
   mColourHighlighting = Highlight;\r
 }\r
 \r
-/** This function returns the report options.\r
+/**\r
+  This function returns the report options.\r
 \r
   @retval Returns the report option.\r
-*/\r
+**/\r
 STATIC\r
 EREPORT_OPTION\r
 GetReportOption (\r
@@ -84,10 +90,11 @@ GetReportOption (
   return mReportType;\r
 }\r
 \r
-/** This function returns the selected ACPI table.\r
+/**\r
+  This function returns the selected ACPI table.\r
 \r
   @retval Returns signature of the selected ACPI table.\r
-*/\r
+**/\r
 STATIC\r
 UINT32\r
 GetSelectedAcpiTable (\r
@@ -97,13 +104,15 @@ GetSelectedAcpiTable (
   return mSelectedAcpiTable;\r
 }\r
 \r
-/** This function dumps the ACPI table to a file.\r
+/**\r
+  This function dumps the ACPI table to a file.\r
+\r
   @param [in] Ptr       Pointer to the ACPI table data.\r
   @param [in] Length    The length of the ACPI table.\r
 \r
   @retval TRUE          Success.\r
   @retval FALSE         Failure.\r
-*/\r
+**/\r
 STATIC\r
 BOOLEAN\r
 DumpAcpiTableToFile (\r
@@ -160,14 +169,15 @@ DumpAcpiTableToFile (
   return (Length == TransferBytes);\r
 }\r
 \r
-/** This function processes the table reporting options for the ACPI table.\r
+/**\r
+  This function processes the table reporting options for the ACPI table.\r
 \r
   @param [in] Signature The ACPI table Signature.\r
   @param [in] TablePtr  Pointer to the ACPI table data.\r
   @param [in] Length    The length fo the ACPI table.\r
 \r
   @retval Returns TRUE if the ACPI table should be traced.\r
-*/\r
+**/\r
 BOOLEAN\r
 ProcessTableReportOptions (\r
   IN CONST UINT32  Signature,\r
@@ -249,13 +259,14 @@ ProcessTableReportOptions (
   return Log;\r
 }\r
 \r
-/** This function converts a string to ACPI table signature.\r
+/**\r
+  This function converts a string to ACPI table signature.\r
 \r
   @param [in] Str   Pointer to the string to be converted to the\r
                     ACPI table signature.\r
 \r
   @retval The ACPI table signature.\r
-*/\r
+**/\r
 STATIC\r
 UINT32\r
 ConvertStrToAcpiSignature (\r
@@ -277,16 +288,16 @@ ConvertStrToAcpiSignature (
   return *(UINT32*)Ptr;\r
 }\r
 \r
-/** This function iterates the configuration table entries in the\r
-    system table, retrieves the RSDP pointer and starts parsing\r
-    the ACPI tables.\r
+/**\r
+  This function iterates the configuration table entries in the\r
+  system table, retrieves the RSDP pointer and starts parsing the ACPI tables.\r
 \r
   @param [in] SystemTable Pointer to the EFI system table.\r
 \r
   @retval Returns EFI_NOT_FOUND   if the RSDP pointer is not found.\r
           Returns EFI_UNSUPPORTED if the RSDP version is less than 2.\r
           Returns EFI_SUCCESS     if successful.\r
-*/\r
+**/\r
 STATIC\r
 EFI_STATUS\r
 EFIAPI\r
@@ -406,7 +417,7 @@ AcpiView (
 \r
   @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
-*/\r
+**/\r
 SHELL_STATUS\r
 EFIAPI\r
 ShellCommandRunAcpiView (\r
index 03561ea..b035395 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for AcpiView\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 #ifndef ACPIVIEW_H_\r
 #define ACPIVIEW_H_\r
 \r
-/** A macro to define the max file name length\r
-*/\r
+/**\r
+  A macro to define the max file name length\r
+**/\r
 #define MAX_FILE_NAME_LEN    128\r
 \r
-/** Offset to the RSDP revision from the start of the RSDP\r
-*/\r
+/**\r
+  Offset to the RSDP revision from the start of the RSDP\r
+**/\r
 #define RSDP_REVISION_OFFSET 15\r
 \r
-/** Offset to the RSDP length from the start of the RSDP\r
-*/\r
+/**\r
+  Offset to the RSDP length from the start of the RSDP\r
+**/\r
 #define RSDP_LENGTH_OFFSET   20\r
 \r
-/** The EREPORT_OPTION enum describes ACPI table Reporting options.\r
-*/\r
+/**\r
+  The EREPORT_OPTION enum describes ACPI table Reporting options.\r
+**/\r
 typedef enum ReportOption {\r
   EREPORT_ALL,            ///< Report All tables.\r
   EREPORT_SELECTED,       ///< Report Selected table.\r
@@ -36,63 +40,72 @@ typedef enum ReportOption {
   EREPORT_MAX\r
 } EREPORT_OPTION;\r
 \r
-/** This function resets the ACPI table error counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table error counter to Zero.\r
+**/\r
 VOID\r
 ResetErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the ACPI table error count.\r
+/**\r
+  This function returns the ACPI table error count.\r
 \r
   @retval Returns the count of errors detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetErrorCount (\r
   VOID\r
   );\r
 \r
-/** This function resets the ACPI table warning counter to Zero.\r
-*/\r
+/**\r
+  This function resets the ACPI table warning counter to Zero.\r
+**/\r
 VOID\r
 ResetWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the ACPI table warning count.\r
+/**\r
+  This function returns the ACPI table warning count.\r
 \r
   @retval Returns the count of warning detected in the ACPI tables.\r
-*/\r
+**/\r
 UINT32\r
 GetWarningCount (\r
   VOID\r
   );\r
 \r
-/** This function returns the colour highlighting status.\r
+/**\r
+  This function returns the colour highlighting status.\r
 \r
   @retval TRUE if colour highlighting is enabled.\r
-*/\r
+**/\r
 BOOLEAN\r
 GetColourHighlighting (\r
   VOID\r
   );\r
 \r
-/** This function sets the colour highlighting status.\r
+/**\r
+  This function sets the colour highlighting status.\r
+\r
+  @param  Highlight       The Highlight status.\r
 \r
-*/\r
+**/\r
 VOID\r
 SetColourHighlighting (\r
   BOOLEAN Highlight\r
   );\r
 \r
-/** This function processes the table reporting options for the ACPI table.\r
+/**\r
+  This function processes the table reporting options for the ACPI table.\r
 \r
   @param [in] Signature The ACPI table Signature.\r
   @param [in] TablePtr  Pointer to the ACPI table data.\r
   @param [in] Length    The length fo the ACPI table.\r
 \r
   @retval Returns TRUE if the ACPI table should be traced.\r
-*/\r
+**/\r
 BOOLEAN\r
 ProcessTableReportOptions (\r
   IN CONST UINT32  Signature,\r
index 0b3f9a7..c7249d7 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   BGRT table parser\r
 \r
   Copyright (c) 2017 - 2018, ARM Limited. All rights reserved.\r
@@ -22,8 +22,9 @@
 // Local variables\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** An ACPI_PARSER array describing the ACPI BDRT Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI BDRT Table.\r
+**/\r
 STATIC CONST ACPI_PARSER BgrtParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Version", 2, 36, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -34,7 +35,8 @@ STATIC CONST ACPI_PARSER BgrtParser[] = {
   {L"Image Offset Y", 4, 52, L"%d", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function parses the ACPI BGRT table.\r
+/**\r
+  This function parses the ACPI BGRT table.\r
   When trace is enabled this function parses the BGRT table and\r
   traces the ACPI table fields.\r
 \r
@@ -44,7 +46,7 @@ STATIC CONST ACPI_PARSER BgrtParser[] = {
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiBgrt (\r
index f70a132..7f66bce 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   DBG2 table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -32,12 +32,13 @@ STATIC CONST UINT16* BaseAddrRegOffset;
 STATIC CONST UINT16* AddrSizeOffset;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** This function Validates the NameSpace string length.\r
+/**\r
+  This function Validates the NameSpace string length.\r
 \r
   @param [in] Ptr     Pointer to the start of the buffer.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -46,12 +47,13 @@ ValidateNameSpaceStrLen (
   IN  VOID*  Context\r
   );\r
 \r
-/** This function parses the debug device information structure.\r
+/**\r
+  This function parses the debug device information structure.\r
 \r
   @param [in]  Ptr     Pointer to the start of the buffer.\r
   @param [out] Length  Pointer in which the length of the debug\r
                        device information is returned.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -95,12 +97,13 @@ STATIC CONST ACPI_PARSER DbgDevInfoParser[] = {
    (VOID**)&AddrSizeOffset, NULL, NULL}\r
 };\r
 \r
-/** This function validates the NameSpace string length.\r
+/**\r
+  This function validates the NameSpace string length.\r
 \r
   @param [in] Ptr     Pointer to the start of the buffer.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -120,12 +123,13 @@ ValidateNameSpaceStrLen (
   }\r
 }\r
 \r
-/** This function parses the debug device information structure.\r
+/**\r
+  This function parses the debug device information structure.\r
 \r
   @param [in]  Ptr     Pointer to the start of the buffer.\r
-  @param [out] Ptr     Pointer in which the length of the debug\r
+  @param [out] Length  Pointer in which the length of the debug\r
                        device information is returned.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -193,7 +197,8 @@ DumpDbgDeviceInfo (
   *Length = *DbgDevInfoLen;\r
 }\r
 \r
-/** This function parses the ACPI DBG2 table.\r
+/**\r
+  This function parses the ACPI DBG2 table.\r
   When trace is enabled this function parses the DBG2 table and\r
   traces the ACPI table fields.\r
 \r
@@ -203,7 +208,7 @@ DumpDbgDeviceInfo (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDbg2 (\r
index ef459a1..f1935f7 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   DSDT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -19,7 +19,8 @@
 #include "AcpiParser.h"\r
 #include "AcpiTableParser.h"\r
 \r
-/** This function parses the ACPI DSDT table.\r
+/**\r
+  This function parses the ACPI DSDT table.\r
   When trace is enabled this function parses the DSDT table and\r
   traces the ACPI table fields.\r
   For the DSDT table only the ACPI header fields are parsed and\r
@@ -29,7 +30,7 @@
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiDsdt (\r
index fdccb2a..cca25fc 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   FADT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -25,43 +25,68 @@ STATIC CONST UINT64* X_DsdtAddress;
 STATIC CONST UINT8*  FadtMinorRevision;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** A macro defining the Hardware reduced ACPI flag\r
-*/\r
+/**\r
+  A macro defining the Hardware reduced ACPI flag\r
+**/\r
 #define HW_REDUCED_ACPI   BIT20\r
 \r
-// Forward declarations\r
+/**\r
+  Get the ACPI XSDT header info.\r
+**/\r
 CONST ACPI_DESCRIPTION_HEADER_INFO* CONST\r
 EFIAPI\r
 GetAcpiXsdtHeaderInfo (\r
   VOID\r
-);\r
+  );\r
 \r
+/**\r
+  This function validates the Firmware Control Field.\r
+\r
+  @param [in] Ptr     Pointer to the start of the field data.\r
+  @param [in] Context Pointer to context specific information e.g. this\r
+                      could be a pointer to the ACPI table header.\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
 ValidateFirmwareCtrl (\r
   IN UINT8* Ptr,\r
   IN VOID*  Context\r
-);\r
+  );\r
+\r
+/**\r
+  This function validates the X_Firmware Control Field.\r
 \r
+  @param [in] Ptr     Pointer to the start of the field data.\r
+  @param [in] Context Pointer to context specific information e.g. this\r
+                      could be a pointer to the ACPI table header.\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
 ValidateXFirmwareCtrl (\r
   IN UINT8* Ptr,\r
   IN VOID*  Context\r
-);\r
+  );\r
 \r
+/**\r
+  This function validates the flags.\r
+\r
+  @param [in] Ptr     Pointer to the start of the field data.\r
+  @param [in] Context Pointer to context specific information e.g. this\r
+                      could be a pointer to the ACPI table header.\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
 ValidateFlags (\r
   IN UINT8* Ptr,\r
   IN VOID*  Context\r
-);\r
+  );\r
 \r
-/** An ACPI_PARSER array describing the ACPI FADT Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI FADT Table.\r
+**/\r
 STATIC CONST ACPI_PARSER FadtParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"FIRMWARE_CTRL", 4, 36, L"0x%x", NULL, NULL, ValidateFirmwareCtrl, NULL},\r
@@ -123,12 +148,13 @@ STATIC CONST ACPI_PARSER FadtParser[] = {
   {L"Hypervisor VendorIdentity", 8, 268, L"%lx", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function validates the Firmware Control Field.\r
+/**\r
+  This function validates the Firmware Control Field.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -147,12 +173,13 @@ ValidateFirmwareCtrl (
 #endif\r
 }\r
 \r
-/** This function validates the X_Firmware Control Field.\r
+/**\r
+  This function validates the X_Firmware Control Field.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -171,12 +198,13 @@ ValidateXFirmwareCtrl (
 #endif\r
 }\r
 \r
-/** This function validates the flags.\r
+/**\r
+  This function validates the flags.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -195,9 +223,9 @@ ValidateFlags (
 #endif\r
 }\r
 \r
-/** This function parses the ACPI FADT table.\r
-  This function parses the FADT table and optionally traces the ACPI\r
-  table fields.\r
+/**\r
+  This function parses the ACPI FADT table.\r
+  This function parses the FADT table and optionally traces the ACPI table fields.\r
 \r
   This function also performs validation of the ACPI table fields.\r
 \r
@@ -205,7 +233,7 @@ ValidateFlags (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiFadt (\r
index ce96604..30cf3e1 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   GTDT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -29,12 +29,13 @@ STATIC CONST UINT32* GtBlockTimerOffset;
 STATIC CONST UINT16* GtBlockLength;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** This function validates the GT Block timer count.\r
+/**\r
+  This function validates the GT Block timer count.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -43,8 +44,9 @@ ValidateGtBlockTimerCount (
   IN VOID*  Context\r
   );\r
 \r
-/** An ACPI_PARSER array describing the ACPI GTDT Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI GTDT Table.\r
+**/\r
 STATIC CONST ACPI_PARSER GtdtParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"CntControlBase Physical Address", 8, 36, L"0x%lx", NULL, NULL,\r
@@ -69,16 +71,18 @@ STATIC CONST ACPI_PARSER GtdtParser[] = {
    (VOID**)&GtdtPlatformTimerOffset, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Platform timer header.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Platform timer header.\r
+**/\r
 STATIC CONST ACPI_PARSER GtPlatformTimerHeaderParser[] = {\r
   {L"Type", 1, 0, NULL, NULL, (VOID**)&PlatformTimerType, NULL, NULL},\r
   {L"Length", 2, 1, NULL, NULL, (VOID**)&PlatformTimerLength, NULL, NULL},\r
   {L"Reserved", 1, 3, NULL, NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Platform GT Block.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Platform GT Block.\r
+**/\r
 STATIC CONST ACPI_PARSER GtBlockParser[] = {\r
   {L"Type", 1, 0, L"%d", NULL, NULL, NULL, NULL},\r
   {L"Length", 2, 1, L"%d", NULL, (VOID**)&GtBlockLength, NULL, NULL},\r
@@ -90,8 +94,9 @@ STATIC CONST ACPI_PARSER GtBlockParser[] = {
     NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GT Block timer.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GT Block timer.\r
+**/\r
 STATIC CONST ACPI_PARSER GtBlockTimerParser[] = {\r
   {L"Frame Number", 1, 0, L"%d", NULL, NULL, NULL, NULL},\r
   {L"Reserved", 3, 1, L"%x %x %x", Dump3Chars, NULL, NULL, NULL},\r
@@ -105,8 +110,9 @@ STATIC CONST ACPI_PARSER GtBlockTimerParser[] = {
   {L"Common Flags", 4, 36, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Platform Watchdog.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Platform Watchdog.\r
+**/\r
 STATIC CONST ACPI_PARSER SBSAGenericWatchdogParser[] = {\r
   {L"Type", 1, 0, L"%d", NULL, NULL, NULL, NULL},\r
   {L"Length", 2, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -117,12 +123,13 @@ STATIC CONST ACPI_PARSER SBSAGenericWatchdogParser[] = {
   {L"Watchdog Timer Flags", 4, 24, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function validates the GT Block timer count.\r
+/**\r
+  This function validates the GT Block timer count.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -141,11 +148,12 @@ ValidateGtBlockTimerCount (
   }\r
 }\r
 \r
-/** This function parses the Platform GT Block.\r
+/**\r
+  This function parses the Platform GT Block.\r
 \r
   @param [in] Ptr     Pointer to the start of the GT Block data.\r
   @param [in] Length  Length of the GT Block structure.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpGTBlock (\r
@@ -196,11 +204,12 @@ DumpGTBlock (
   }\r
 }\r
 \r
-/** This function parses the Platform Watchdog timer.\r
+/**\r
+  This function parses the Platform Watchdog timer.\r
 \r
   @param [in] Ptr     Pointer to the start of the watchdog timer data.\r
   @param [in] Length  Length of the watchdog timer structure.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpWatchdogTimer (\r
@@ -218,7 +227,8 @@ DumpWatchdogTimer (
     );\r
 }\r
 \r
-/** This function parses the ACPI GTDT table.\r
+/**\r
+  This function parses the ACPI GTDT table.\r
   When trace is enabled this function parses the GTDT table and\r
   traces the ACPI table fields.\r
 \r
@@ -232,7 +242,7 @@ DumpWatchdogTimer (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiGtdt (\r
index 503a745..704dfc4 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   IORT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -23,8 +23,9 @@
 // Local variables\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** The EIORT_NODE enum describes the IORT Node types.\r
-*/\r
+/**\r
+  The EIORT_NODE enum describes the IORT Node types.\r
+**/\r
 typedef enum IortNode {\r
   EIORT_NODE_ITS_GROUP,        ///< ITS Group node\r
   EIORT_NODE_NAMED_COMPONENT,  ///< Named Component node\r
@@ -51,12 +52,13 @@ STATIC CONST UINT32* PmuInterruptOffset;
 \r
 STATIC CONST UINT32* ItsCount;\r
 \r
-/** This function validates the ID Mapping array count for the ITS node.\r
+/**\r
+  This function validates the ID Mapping array count for the ITS node.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -65,12 +67,13 @@ ValidateItsIdMappingCount (
   IN VOID*  Context\r
   );\r
 \r
-/** This function validates the ID Mapping array offset for the ITS node.\r
+/**\r
+  This function validates the ID Mapping array offset for the ITS node.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -79,14 +82,14 @@ ValidateItsIdArrayReference (
   IN VOID*  Context\r
   );\r
 \r
-/** Helper Macro for populating the IORT Node header in the ACPI_PARSER\r
-    array.\r
+/**\r
+  Helper Macro for populating the IORT Node header in the ACPI_PARSER array.\r
 \r
   @param [out] ValidateIdMappingCount    Optional pointer to a function for\r
                                          validating the ID Mapping count.\r
   @param [out] ValidateIdArrayReference  Optional pointer to a function for\r
                                          validating the ID Array reference.\r
-*/\r
+**/\r
 #define PARSE_IORT_NODE_HEADER(ValidateIdMappingCount,                   \\r
                                ValidateIdArrayReference)                 \\r
   { L"Type", 1, 0, L"%d", NULL, (VOID**)&IortNodeType, NULL, NULL },     \\r
@@ -98,8 +101,9 @@ ValidateItsIdArrayReference (
   { L"Reference to ID Array", 4, 12, L"0x%x", NULL,                      \\r
     (VOID**)&IortIdMappingOffset, ValidateIdArrayReference, NULL }\r
 \r
-/** An ACPI_PARSER array describing the ACPI IORT Table\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI IORT Table\r
+**/\r
 STATIC CONST ACPI_PARSER IortParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Number of IORT Nodes", 4, 36, L"%d", NULL,\r
@@ -109,14 +113,16 @@ STATIC CONST ACPI_PARSER IortParser[] = {
   {L"Reserved", 4, 44, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT node header structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT node header structure.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeHeaderParser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL)\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT SMMUv1/2 node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT SMMUv1/2 node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeSmmuV1V2Parser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL),\r
   {L"Base Address", 8, 16, L"0x%lx", NULL, NULL, NULL, NULL},\r
@@ -141,15 +147,17 @@ STATIC CONST ACPI_PARSER IortNodeSmmuV1V2Parser[] = {
   {L"SMMU_NSgCfgIrpt interrupt flags", 4, 72, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the SMMUv1/2 Node Interrupt Array.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the SMMUv1/2 Node Interrupt Array.\r
+**/\r
 STATIC CONST ACPI_PARSER InterruptArrayParser[] = {\r
   {L"  Interrupt GSIV", 4, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"  Flags", 4, 4, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT ID Mapping.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT ID Mapping.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeIdMappingParser[] = {\r
   {L"  Input base", 4, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"  Number of IDs", 4, 4, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -158,8 +166,9 @@ STATIC CONST ACPI_PARSER IortNodeIdMappingParser[] = {
   {L"  Flags", 4, 16, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT SMMUv3 node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT SMMUv3 node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeSmmuV3Parser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL),\r
   {L"Base Address", 8, 16, L"0x%lx", NULL, NULL, NULL, NULL},\r
@@ -173,8 +182,9 @@ STATIC CONST ACPI_PARSER IortNodeSmmuV3Parser[] = {
   {L"Sync", 4, 56, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT ITS node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT ITS node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeItsParser[] = {\r
   PARSE_IORT_NODE_HEADER (\r
     ValidateItsIdMappingCount,\r
@@ -183,14 +193,16 @@ STATIC CONST ACPI_PARSER IortNodeItsParser[] = {
   {L"  Number of ITSs", 4, 16, L"%d", NULL, (VOID**)&ItsCount, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the ITS ID.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ITS ID.\r
+**/\r
 STATIC CONST ACPI_PARSER ItsIdParser[] = {\r
   { L"  GIC ITS Identifier", 4, 0, L"%d", NULL, NULL, NULL }\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT Names Component node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT Names Component node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeNamedComponentParser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL),\r
   {L"Node Flags", 4, 16, L"%d", NULL, NULL, NULL, NULL},\r
@@ -198,8 +210,9 @@ STATIC CONST ACPI_PARSER IortNodeNamedComponentParser[] = {
   {L"Device memory address size limit", 1, 28, L"%d", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT Root Complex node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT Root Complex node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodeRootComplexParser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL),\r
   {L"Memory access properties", 8, 16, L"0x%lx", NULL, NULL, NULL, NULL},\r
@@ -207,8 +220,9 @@ STATIC CONST ACPI_PARSER IortNodeRootComplexParser[] = {
   {L"PCI Segment number", 4, 28, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the IORT PMCG node.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the IORT PMCG node.\r
+**/\r
 STATIC CONST ACPI_PARSER IortNodePmcgParser[] = {\r
   PARSE_IORT_NODE_HEADER (NULL, NULL),\r
   {L"Base Address", 8, 16, L"0x%lx", NULL, NULL, NULL, NULL},\r
@@ -216,18 +230,19 @@ STATIC CONST ACPI_PARSER IortNodePmcgParser[] = {
   {L"Node reference", 4, 28, L"0x%x", NULL, NULL, NULL, NULL},\r
 };\r
 \r
-/** This function validates the ID Mapping array count for the ITS node.\r
+/**\r
+  This function validates the ID Mapping array count for the ITS node.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
 ValidateItsIdMappingCount (\r
   IN UINT8* Ptr,\r
-  VOID*     Context\r
+  IN VOID*     Context\r
   )\r
 {\r
   if (*(UINT32*)Ptr != 0) {\r
@@ -236,12 +251,13 @@ ValidateItsIdMappingCount (
   }\r
 }\r
 \r
-/** This function validates the ID Mapping array offset for the ITS node.\r
+/**\r
+  This function validates the ID Mapping array offset for the ITS node.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -256,13 +272,14 @@ ValidateItsIdArrayReference (
   }\r
 }\r
 \r
-/** This function parses the IORT Node Id Mapping array.\r
+/**\r
+  This function parses the IORT Node Id Mapping array.\r
 \r
   @param [in] Ptr            Pointer to the start of the IORT Table.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeIdMappings (\r
@@ -298,14 +315,15 @@ DumpIortNodeIdMappings (
   }\r
 }\r
 \r
-/** This function parses the IORT SMMUv1/2 node.\r
+/**\r
+  This function parses the IORT SMMUv1/2 node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeSmmuV1V2 (\r
@@ -377,14 +395,15 @@ DumpIortNodeSmmuV1V2 (
   }\r
 }\r
 \r
-/** This function parses the IORT SMMUv3 node.\r
+/**\r
+  This function parses the IORT SMMUv3 node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeSmmuV3 (\r
@@ -408,11 +427,12 @@ DumpIortNodeSmmuV3 (
   }\r
 }\r
 \r
-/** This function parses the IORT ITS node.\r
+/**\r
+  This function parses the IORT ITS node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeIts (\r
@@ -458,14 +478,15 @@ DumpIortNodeIts (
   // Note: ITS does not have the ID Mappings Array\r
 }\r
 \r
-/** This function parses the IORT Named Component node.\r
+/**\r
+  This function parses the IORT Named Component node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeNamedComponent (\r
@@ -504,14 +525,15 @@ DumpIortNodeNamedComponent (
   }\r
 }\r
 \r
-/** This function parses the IORT Root Complex node.\r
+/**\r
+  This function parses the IORT Root Complex node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodeRootComplex (\r
@@ -535,14 +557,15 @@ DumpIortNodeRootComplex (
   }\r
 }\r
 \r
-/** This function parses the IORT PMCG node.\r
+/**\r
+  This function parses the IORT PMCG node.\r
 \r
   @param [in] Ptr            Pointer to the start of the buffer.\r
   @param [in] Length         Length of the buffer.\r
   @param [in] MappingCount   The ID Mapping count.\r
   @param [in] MappingOffset  The offset of the ID Mapping array\r
                              from the start of the IORT table.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpIortNodePmcg (\r
@@ -574,9 +597,9 @@ DumpIortNodePmcg (
   }\r
 }\r
 \r
-/** This function parses the ACPI IORT table.\r
-  When trace is enabled this function parses the IORT table and\r
-  traces the ACPI fields.\r
+/**\r
+  This function parses the ACPI IORT table.\r
+  When trace is enabled this function parses the IORT table and traces the ACPI fields.\r
 \r
   This function also parses the following nodes:\r
     - ITS Group\r
@@ -592,7 +615,7 @@ DumpIortNodePmcg (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiIort (\r
index 2ccbb7b..3ac2708 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   MADT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -24,18 +24,24 @@ STATIC CONST UINT8* MadtInterruptControllerType;
 STATIC CONST UINT8* MadtInterruptControllerLength;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-// Forward declarations\r
+/**\r
+  This function validates the System Vector Base in the GICD.\r
+\r
+  @param [in] Ptr     Pointer to the start of the field data.\r
+  @param [in] Context Pointer to context specific information e.g. this\r
+                      could be a pointer to the ACPI table header.\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
 ValidateGICDSystemVectorBase (\r
   IN UINT8* Ptr,\r
   IN VOID*  Context\r
-);\r
+  );\r
 \r
-/** An ACPI_PARSER array describing the GICC Interrupt\r
-    Controller Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GICC Interrupt Controller Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER GicCParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -59,9 +65,9 @@ STATIC CONST ACPI_PARSER GicCParser[] = {
   {L"Reserved", 3, 77, L"%x %x %x", Dump3Chars, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GICD Interrupt\r
-    Controller Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GICD Interrupt Controller Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER GicDParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -75,9 +81,9 @@ STATIC CONST ACPI_PARSER GicDParser[] = {
   {L"Reserved", 3, 21, L"%x %x %x", Dump3Chars, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the MSI Frame Interrupt\r
-    Controller Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the MSI Frame Interrupt Controller Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER GicMSIFrameParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -91,9 +97,9 @@ STATIC CONST ACPI_PARSER GicMSIFrameParser[] = {
   {L"SPI Base", 2, 22, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GICR Interrupt\r
-    Controller Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GICR Interrupt Controller Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER GicRParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -104,9 +110,9 @@ STATIC CONST ACPI_PARSER GicRParser[] = {
   {L"Discovery Range Length", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GIC ITS Interrupt\r
-    Controller Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GIC ITS Interrupt Controller Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER GicITSParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"%d", NULL, NULL, NULL, NULL},\r
@@ -117,8 +123,9 @@ STATIC CONST ACPI_PARSER GicITSParser[] = {
   {L"Reserved", 4, 16, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the ACPI MADT Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI MADT Table.\r
+**/\r
 STATIC CONST ACPI_PARSER MadtParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Local Interrupt Controller Address", 4, 36, L"0x%x", NULL, NULL, NULL,\r
@@ -126,9 +133,9 @@ STATIC CONST ACPI_PARSER MadtParser[] = {
   {L"Flags", 4, 40, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the MADT Interrupt\r
-    Controller Structure Header Structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the MADT Interrupt Controller Structure Header Structure.\r
+**/\r
 STATIC CONST ACPI_PARSER MadtInterruptControllerHeaderParser[] = {\r
   {NULL, 1, 0, NULL, NULL, (VOID**)&MadtInterruptControllerType, NULL, NULL},\r
   {L"Length", 1, 1, NULL, NULL, (VOID**)&MadtInterruptControllerLength, NULL,\r
@@ -136,12 +143,13 @@ STATIC CONST ACPI_PARSER MadtInterruptControllerHeaderParser[] = {
   {L"Reserved", 2, 2, NULL, NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function validates the System Vector Base in the GICD.\r
+/**\r
+  This function validates the System Vector Base in the GICD.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -158,7 +166,8 @@ ValidateGICDSystemVectorBase (
   }\r
 }\r
 \r
-/** This function parses the ACPI MADT table.\r
+/**\r
+  This function parses the ACPI MADT table.\r
   When trace is enabled this function parses the MADT table and\r
   traces the ACPI table fields.\r
 \r
@@ -176,7 +185,7 @@ ValidateGICDSystemVectorBase (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMadt (\r
index a21b30d..29fc28f 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   MCFG table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 // Local variables\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** An ACPI_PARSER array describing the ACPI MCFG Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI MCFG Table.\r
+**/\r
 STATIC CONST ACPI_PARSER McfgParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Reserved", 8, 36, L"0x%lx", NULL, NULL, NULL, NULL},\r
 };\r
 \r
-/** An ACPI_PARSER array describing the PCI configuration Space\r
-    Base Address structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the PCI configuration Space Base Address structure.\r
+**/\r
 STATIC CONST ACPI_PARSER PciCfgSpaceBaseAddrParser[] = {\r
   {L"Base Address", 8, 0, L"0x%lx", NULL, NULL, NULL, NULL},\r
   {L"PCI Segment Group No.", 2, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -40,7 +41,8 @@ STATIC CONST ACPI_PARSER PciCfgSpaceBaseAddrParser[] = {
   {L"Reserved", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function parses the ACPI MCFG table.\r
+/**\r
+  This function parses the ACPI MCFG table.\r
   When trace is enabled this function parses the MCFG table and\r
   traces the ACPI table fields.\r
 \r
@@ -50,7 +52,7 @@ STATIC CONST ACPI_PARSER PciCfgSpaceBaseAddrParser[] = {
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiMcfg (\r
index c7acdce..c33bb1e 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   RSDP table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 // Local Variables\r
 STATIC CONST UINT64* XsdtAddress;\r
 \r
-/** This function validates the RSDT Address.\r
+/**\r
+  This function validates the RSDT Address.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -35,12 +36,13 @@ ValidateRsdtAddress (
   IN VOID*  Context\r
   );\r
 \r
-/** This function validates the XSDT Address.\r
+/**\r
+  This function validates the XSDT Address.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -49,8 +51,9 @@ ValidateXsdtAddress (
   IN VOID*  Context\r
   );\r
 \r
-/** An array describing the ACPI RSDP Table.\r
-*/\r
+/**\r
+  An array describing the ACPI RSDP Table.\r
+**/\r
 STATIC CONST ACPI_PARSER RsdpParser[] = {\r
   {L"Signature", 8, 0, NULL, Dump8Chars, NULL, NULL, NULL},\r
   {L"Checksum", 1, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -64,12 +67,13 @@ STATIC CONST ACPI_PARSER RsdpParser[] = {
   {L"Reserved", 3, 33, L"%x %x %x", Dump3Chars, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function validates the RSDT Address.\r
+/**\r
+  This function validates the RSDT Address.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -95,12 +99,13 @@ ValidateRsdtAddress (
 #endif\r
 }\r
 \r
-/** This function validates the XSDT Address.\r
+/**\r
+  This function validates the XSDT Address.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -126,7 +131,8 @@ ValidateXsdtAddress (
 #endif\r
 }\r
 \r
-/** This function parses the ACPI RSDP table.\r
+/**\r
+  This function parses the ACPI RSDP table.\r
 \r
   This function invokes the parser for the XSDT table.\r
   * Note - This function does not support parsing of RSDT table.\r
@@ -138,7 +144,7 @@ ValidateXsdtAddress (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiRsdp (\r
index 5f99fd4..a028ae5 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   SLIT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 STATIC CONST UINT64* SlitSystemLocalityCount;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** An ACPI_PARSER array describing the ACPI SLIT table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI SLIT table.\r
+**/\r
 STATIC CONST ACPI_PARSER SlitParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Number of System Localities", 8, 36, L"0x%lx", NULL,\r
    (VOID**)&SlitSystemLocalityCount, NULL, NULL}\r
 };\r
 \r
-/** Macro to get the value of a System Locality\r
-*/\r
+/**\r
+  Macro to get the value of a System Locality\r
+**/\r
 #define SLIT_ELEMENT(Ptr, i, j) *(Ptr + (i * LocalityCount) + j)\r
 \r
-/** This function parses the ACPI SLIT table.\r
+/**\r
+  This function parses the ACPI SLIT table.\r
   When trace is enabled this function parses the SLIT table and\r
   traces the ACPI table fields.\r
 \r
@@ -49,7 +52,7 @@ STATIC CONST ACPI_PARSER SlitParser[] = {
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSlit (\r
index 841a27f..6434088 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   SPCR table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
 // Local variables\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** This function validates the Interrupt Type.\r
+/**\r
+  This function validates the Interrupt Type.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -38,12 +39,13 @@ ValidateInterruptType (
   IN VOID*  Context\r
   );\r
 \r
-/** This function validates the Irq.\r
+/**\r
+  This function validates the Irq.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -52,8 +54,9 @@ ValidateIrq (
   IN VOID*  Context\r
   );\r
 \r
-/** An ACPI_PARSER array describing the ACPI SPCR Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the ACPI SPCR Table.\r
+**/\r
 STATIC CONST ACPI_PARSER SpcrParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Interface Type", 1, 36, L"%d", NULL, NULL, NULL, NULL},\r
@@ -79,12 +82,13 @@ STATIC CONST ACPI_PARSER SpcrParser[] = {
   {L"Reserved", 4, 76, L"%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** This function validates the Interrupt Type.\r
+/**\r
+  This function validates the Interrupt Type.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -106,12 +110,13 @@ ValidateInterruptType (
 #endif\r
 }\r
 \r
-/** This function validates the Irq.\r
+/**\r
+  This function validates the Irq.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -132,7 +137,8 @@ ValidateIrq (
 #endif\r
 }\r
 \r
-/** This function parses the ACPI SPCR table.\r
+/**\r
+  This function parses the ACPI SPCR table.\r
   When trace is enabled this function parses the SPCR table and\r
   traces the ACPI table fields.\r
 \r
@@ -142,7 +148,7 @@ ValidateIrq (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSpcr (\r
index 86da559..fbe943d 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   SRAT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -25,12 +25,13 @@ STATIC CONST UINT8* SratRAType;
 STATIC CONST UINT8* SratRALength;\r
 STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
 \r
-/** This function validates the Reserved field in the SRAT table header.\r
+/**\r
+  This function validates the Reserved field in the SRAT table header.\r
 \r
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -39,11 +40,12 @@ ValidateSratReserved (
   IN VOID*  Context\r
   );\r
 \r
-/** This function traces the APIC Proximity Domain field.\r
+/**\r
+  This function traces the APIC Proximity Domain field.\r
 \r
   @param [in] Format  Format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpSratApicProximity (\r
@@ -51,24 +53,26 @@ DumpSratApicProximity (
   IN  UINT8*         Ptr\r
   );\r
 \r
-/** An ACPI_PARSER array describing the SRAT Table.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the SRAT Table.\r
+**/\r
 STATIC CONST ACPI_PARSER SratParser[] = {\r
   PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
   {L"Reserved", 4, 36, L"0x%x", NULL, NULL, ValidateSratReserved, NULL},\r
   {L"Reserved", 8, 40, L"0x%lx", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Resource Allocation\r
-    structure header.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Resource Allocation structure header.\r
+**/\r
 STATIC CONST ACPI_PARSER SratResourceAllocationParser[] = {\r
   {L"Type", 1, 0, NULL, NULL, (VOID**)&SratRAType, NULL, NULL},\r
   {L"Length", 1, 1, NULL, NULL, (VOID**)&SratRALength, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GICC Affinity structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GICC Affinity structure.\r
+**/\r
 STATIC CONST ACPI_PARSER SratGicCAffinityParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -79,8 +83,9 @@ STATIC CONST ACPI_PARSER SratGicCAffinityParser[] = {
   {L"Clock Domain", 4, 14, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the GIC ITS Affinity structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the GIC ITS Affinity structure.\r
+**/\r
 STATIC CONST ACPI_PARSER SratGicITSAffinityParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -90,8 +95,9 @@ STATIC CONST ACPI_PARSER SratGicITSAffinityParser[] = {
   {L"ITS Id", 4, 8, L"0x%x", NULL, NULL, NULL, NULL},\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Memory Affinity structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Memory Affinity structure.\r
+**/\r
 STATIC CONST ACPI_PARSER SratMemAffinityParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -107,8 +113,9 @@ STATIC CONST ACPI_PARSER SratMemAffinityParser[] = {
   {L"Reserved", 8, 32, L"0x%lx", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the APIC/SAPIC Affinity structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the APIC/SAPIC Affinity structure.\r
+**/\r
 STATIC CONST ACPI_PARSER SratApciSapicAffinityParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -122,9 +129,9 @@ STATIC CONST ACPI_PARSER SratApciSapicAffinityParser[] = {
   {L"Clock Domain", 4, 12, L"0x%x", NULL, NULL, NULL, NULL}\r
 };\r
 \r
-/** An ACPI_PARSER array describing the Processor Local x2APIC\r
-    Affinity structure.\r
-*/\r
+/**\r
+  An ACPI_PARSER array describing the Processor Local x2APIC Affinity structure.\r
+**/\r
 STATIC CONST ACPI_PARSER SratX2ApciAffinityParser[] = {\r
   {L"Type", 1, 0, L"0x%x", NULL, NULL, NULL, NULL},\r
   {L"Length", 1, 1, L"0x%x", NULL, NULL, NULL, NULL},\r
@@ -142,7 +149,7 @@ STATIC CONST ACPI_PARSER SratX2ApciAffinityParser[] = {
   @param [in] Ptr     Pointer to the start of the field data.\r
   @param [in] Context Pointer to context specific information e.g. this\r
                       could be a pointer to the ACPI table header.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 EFIAPI\r
@@ -157,11 +164,12 @@ ValidateSratReserved (
   }\r
 }\r
 \r
-/** This function traces the APIC Proximity Domain field.\r
+/**\r
+  This function traces the APIC Proximity Domain field.\r
 \r
   @param [in] Format  Format string for tracing the data.\r
   @param [in] Ptr     Pointer to the start of the buffer.\r
-*/\r
+**/\r
 STATIC\r
 VOID\r
 DumpSratApicProximity (\r
@@ -173,7 +181,8 @@ DumpSratApicProximity (
   Print (Format, ProximityDomain);\r
 }\r
 \r
-/** This function parses the ACPI SRAT table.\r
+/**\r
+  This function parses the ACPI SRAT table.\r
   When trace is enabled this function parses the SRAT table and\r
   traces the ACPI table fields.\r
 \r
@@ -189,7 +198,7 @@ DumpSratApicProximity (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSrat (\r
index a77ccbe..6979214 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   SSDT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -19,7 +19,8 @@
 #include "AcpiParser.h"\r
 #include "AcpiTableParser.h"\r
 \r
-/** This function parses the ACPI SSDT table.\r
+/**\r
+  This function parses the ACPI SSDT table.\r
   When trace is enabled this function parses the SSDT table and\r
   traces the ACPI table fields.\r
   For the SSDT table only the ACPI header fields are\r
@@ -29,7 +30,7 @@
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiSsdt (\r
index 0ed65d2..99521cd 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   XSDT table parser\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.\r
@@ -29,6 +29,9 @@ STATIC CONST ACPI_PARSER XsdtParser[] = {
   PARSE_ACPI_HEADER (&AcpiHdrInfo)\r
 };\r
 \r
+/**\r
+  Get the ACPI XSDT header info.\r
+**/\r
 CONST ACPI_DESCRIPTION_HEADER_INFO* CONST\r
 EFIAPI\r
 GetAcpiXsdtHeaderInfo (\r
@@ -38,8 +41,8 @@ GetAcpiXsdtHeaderInfo (
   return &AcpiHdrInfo;\r
 }\r
 \r
-/** This function parses the ACPI XSDT table\r
-  and optionally traces the ACPI table fields.\r
+/**\r
+  This function parses the ACPI XSDT table and optionally traces the ACPI table fields.\r
 \r
   This function also performs validation of the XSDT table.\r
 \r
@@ -47,7 +50,7 @@ GetAcpiXsdtHeaderInfo (
   @param [in] Ptr                Pointer to the start of the buffer.\r
   @param [in] AcpiTableLength    Length of the ACPI table.\r
   @param [in] AcpiTableRevision  Revision of the ACPI table.\r
-*/\r
+**/\r
 VOID\r
 EFIAPI\r
 ParseAcpiXsdt (\r
index 7de2869..8479bfb 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Main file for 'acpiview' Shell command function.\r
 \r
   Copyright (c) 2016 - 2018, ARM Limited. All rights reserved.<BR>\r
@@ -49,7 +49,8 @@ ACPI_TABLE_PARSER ParserList[] = {
   {EFI_ACPI_6_2_EXTENDED_SYSTEM_DESCRIPTION_TABLE_SIGNATURE, ParseAcpiXsdt}\r
 };\r
 \r
-/** This function registers all the available table parsers.\r
+/**\r
+  This function registers all the available table parsers.\r
 \r
   @retval EFI_SUCCESS           The parser is registered.\r
   @retval EFI_ALREADY_STARTED   The parser for the ACPI Table\r
@@ -57,7 +58,7 @@ ACPI_TABLE_PARSER ParserList[] = {
   @retval EFI_INVALID_PARAMETER A parameter is invalid.\r
   @retval EFI_OUT_OF_RESOURCES  No space to register the\r
                                 parser.\r
-*/\r
+**/\r
 EFI_STATUS\r
 RegisterAllParsers (\r
   )\r
@@ -80,7 +81,7 @@ RegisterAllParsers (
   Return the file name of the help text file if not using HII.\r
 \r
   @return The string pointer to the file name.\r
-*/\r
+**/\r
 CONST CHAR16*\r
 EFIAPI\r
 ShellCommandGetManFileNameAcpiView (\r
@@ -101,7 +102,7 @@ ShellCommandGetManFileNameAcpiView (
   @retval EFI_SUCCESS           The Shell command handlers were installed\r
                                 successfully.\r
   @retval EFI_DEVICE_ERROR      Hii package failed to install.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 UefiShellAcpiViewCommandLibConstructor (\r
@@ -152,7 +153,7 @@ UefiShellAcpiViewCommandLibConstructor (
 \r
   @param ImageHandle            The image handle of the process.\r
   @param SystemTable            The EFI System Table pointer.\r
-*/\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 UefiShellAcpiViewCommandLibDestructor (\r
index 59c8e21..f547569 100644 (file)
@@ -1,4 +1,4 @@
-/**\r
+/** @file\r
   Header file for 'acpiview' Shell command functions.\r
 \r
   Copyright (c) 2016 - 2017, ARM Limited. All rights reserved.<BR>\r
@@ -21,7 +21,7 @@ extern EFI_HII_HANDLE gShellAcpiViewHiiHandle;
 \r
   @param[in] ImageHandle  Handle to the Image (NULL if Internal).\r
   @param[in] SystemTable  Pointer to the System Table (NULL if Internal).\r
-*/\r
+**/\r
 SHELL_STATUS\r
 EFIAPI\r
 ShellCommandRunAcpiView (\r