]> git.proxmox.com Git - mirror_edk2.git/blobdiff - ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c
Refine comments and two code style.
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / QueryTable.c
index 7b7e5928bd204923a96cbf3740e773bcffcc67a7..64997284b078cdafa36999869f3053863fdf4078 100644 (file)
@@ -2936,11 +2936,11 @@ TABLE_ITEM  StructureTypeInfoTable[] = {
     Then all the Key Value between Low and High gets the same string\r
     L"Unused".\r
 \r
-  @param[in] Table    The begin address of table.\r
-  @param[in] Number   The number of table items.\r
-  @param[in] Key      The query Key.\r
-  @param[in,out] Info Input as empty buffer; output as data buffer.\r
-  @param[in] InfoLen  The max number of characters for Info.\r
+  @param[in] Table     The begin address of table.\r
+  @param[in] Number    The number of table items.\r
+  @param[in] Key       The query Key.\r
+  @param[in, out] Info Input as empty buffer; output as data buffer.\r
+  @param[in] InfoLen   The max number of characters for Info.\r
 \r
   @return the found Key and Info is valid.\r
   @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
@@ -2969,7 +2969,7 @@ QueryTable (
     //\r
     if (High > Low && Key >= Low && Key <= High) {\r
       StrnCpy (Info, Table[Index].Info, InfoLen-1);\r
-      StrCat (Info, L"\n");\r
+      StrnCat (Info, L"\n", InfoLen - StrLen(Info));\r
       return Key;\r
     }\r
     //\r
@@ -2977,7 +2977,7 @@ QueryTable (
     //\r
     if (Table[Index].Key == Key) {\r
       StrnCpy (Info, Table[Index].Info, InfoLen-1);\r
-      StrCat (Info, L"\n");\r
+      StrnCat (Info, L"\n", InfoLen - StrLen(Info));\r
       return Key;\r
     }\r
   }\r
@@ -2986,27 +2986,19 @@ QueryTable (
   return QUERY_TABLE_UNFOUND;\r
 }\r
 \r
+/**\r
+  Given a table of bit info and a Key, return the responding info to the Key.\r
+\r
+  @param[in] Table     Point to a table which maintains a map of 'bit' to 'message'.\r
+  @param[in] Number    Number of table items.\r
+  @param[in] Bits      The Key of query the bit map information.\r
+**/\r
 VOID\r
 PrintBitsInfo (\r
   IN  TABLE_ITEM    *Table,\r
   IN  UINTN         Number,\r
   IN  UINT32        Bits\r
   )\r
-/*++\r
-\r
-  Routine Description:\r
-      Given a table of bit info and a Key,\r
-      return the responding info to the Key.\r
-\r
-  Arguments:\r
-    Table     - Point to a table which maintains a map of 'bit' to 'message'\r
-    Number    - Number of table items.\r
-    Bits      - The Key of query the bit map information.\r
-\r
-  Returns:\r
-    None\r
-\r
-**/\r
 {\r
   //\r
   // Get certain bit of 'Value':\r
@@ -3077,28 +3069,33 @@ PrintBitsInfo (
     PrintBitsInfo (Table, Num, (UINT32) bits); \\r
   } while (0);\r
 \r
-//\r
-////////////////////////////////////////////////////////////////////\r
-//\r
-// System Information (Type 1)\r
-//\r
+/**\r
+  Display System Information (Type 1) Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplaySystemWakeupType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_WAKEUP_TYPE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Type, Option);\r
   PRINT_TABLE_ITEM (SystemWakeupTypeTable, Type);\r
 }\r
-//\r
-// System Enclosure (Type 3)\r
-//\r
+\r
+/**\r
+  Display System Enclosure (Type 3) Enclosure Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplaySystemEnclosureType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_CHASSIS_TYPE), gShellDebug1HiiHandle);\r
@@ -3113,10 +3110,16 @@ DisplaySystemEnclosureType (
   }\r
 }\r
 \r
+/**\r
+  Display System Enclosure (Type 3) Enclosure Status.\r
+\r
+  @param[in] Status         The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplaySystemEnclosureStatus (\r
-  UINT8 Status,\r
-  UINT8 Option\r
+  IN UINT8 Status,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_CHASSIS_STATUS), gShellDebug1HiiHandle);\r
@@ -3124,23 +3127,33 @@ DisplaySystemEnclosureStatus (
   PRINT_TABLE_ITEM (SystemEnclosureStatusTable, Status);\r
 }\r
 \r
+/**\r
+  Display System Enclosure (Type 3) Security Status.\r
+\r
+  @param[in] Status         The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplaySESecurityStatus (\r
-  UINT8 Status,\r
-  UINT8 Option\r
+  IN UINT8 Status,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_CHASSIS_SECURITY), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Status, Option);\r
   PRINT_TABLE_ITEM (SESecurityStatusTable, Status);\r
 }\r
-//\r
-// Processor Information (Type 4)\r
-//\r
+\r
+/**\r
+  Display Processor Information (Type 4) Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayProcessorType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PROC_TYPE), gShellDebug1HiiHandle);\r
@@ -3148,23 +3161,33 @@ DisplayProcessorType (
   PRINT_TABLE_ITEM (ProcessorTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Processor Information (Type 4) Upgrade.\r
+\r
+  @param[in] Upgrade        The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayProcessorUpgrade (\r
-  UINT8 Upgrade,\r
-  UINT8 Option\r
+  IN UINT8 Upgrade,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PROC_UPDATE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Upgrade, Option);\r
   PRINT_TABLE_ITEM (ProcessorUpgradeTable, Upgrade);\r
 }\r
-//\r
-// Memory Controller Information (Type 5)\r
-//\r
+\r
+/**\r
+  Display Memory Controller Information (Type 5) method.\r
+\r
+  @param[in] Method         The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMcErrorDetectMethod (\r
-  UINT8 Method,\r
-  UINT8 Option\r
+  IN UINT8 Method,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_DETECTMETHOD), gShellDebug1HiiHandle);\r
@@ -3172,10 +3195,16 @@ DisplayMcErrorDetectMethod (
   PRINT_TABLE_ITEM (McErrorDetectMethodTable, Method);\r
 }\r
 \r
+/**\r
+  Display Memory Controller Information (Type 5) Capability.\r
+\r
+  @param[in] Capability     The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMcErrorCorrectCapability (\r
-  UINT8 Capability,\r
-  UINT8 Option\r
+  IN UINT8 Capability,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_CORRECT_CAPABILITY), gShellDebug1HiiHandle);\r
@@ -3183,10 +3212,16 @@ DisplayMcErrorCorrectCapability (
   PRINT_BITS_INFO (McErrorCorrectCapabilityTable, Capability);\r
 }\r
 \r
+/**\r
+  Display Memory Controller Information (Type 5) Support.\r
+\r
+  @param[in] Support        The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMcInterleaveSupport (\r
-  UINT8 Support,\r
-  UINT8 Option\r
+  IN UINT8 Support,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_INTERLEAVE_SUPPORT), gShellDebug1HiiHandle);\r
@@ -3194,10 +3229,16 @@ DisplayMcInterleaveSupport (
   PRINT_TABLE_ITEM (McInterleaveSupportTable, Support);\r
 }\r
 \r
+/**\r
+  Display Memory Controller Information (Type 5) speeds.\r
+\r
+  @param[in] Speed          The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMcMemorySpeeds (\r
-  UINT16  Speed,\r
-  UINT8   Option\r
+  IN UINT16  Speed,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_MEMORY_SPEED), gShellDebug1HiiHandle);\r
@@ -3205,23 +3246,33 @@ DisplayMcMemorySpeeds (
   PRINT_BITS_INFO (McMemorySpeedsTable, Speed);\r
 }\r
 \r
+/**\r
+  Display Memory Controller Information (Type 5) voltage.\r
+\r
+  @param[in] Voltage        The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryModuleVoltage (\r
-  UINT8 Voltage,\r
-  UINT8 Option\r
+  IN UINT8 Voltage,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_REQUIRED_VOLTAGES), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Voltage, Option);\r
   PRINT_BITS_INFO (MemoryModuleVoltageTable, Voltage);\r
 }\r
-//\r
-// Memory Module Information (Type 6)\r
-//\r
+\r
+/**\r
+  Display Memory Module Information (Type 6) type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMmMemoryType (\r
-  UINT16  Type,\r
-  UINT8   Option\r
+  IN UINT16  Type,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_MODULE_TYPE), gShellDebug1HiiHandle);\r
@@ -3229,23 +3280,33 @@ DisplayMmMemoryType (
   PRINT_BITS_INFO (MmMemoryTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Memory Module Information (Type 6) status.\r
+\r
+  @param[in] Status         The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayMmErrorStatus (\r
-  UINT8 Status,\r
-  UINT8 Option\r
+  IN UINT8 Status,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_MODULE_ERROR_STATUS), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Status, Option);\r
   PRINT_BITS_INFO (MmErrorStatusTable, Status);\r
 }\r
-//\r
-// Cache Information (Type 7)\r
-//\r
+\r
+/**\r
+  Display Cache Information (Type 7) SRAM Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayCacheSRAMType (\r
-  UINT16  Type,\r
-  UINT8   Option\r
+  IN UINT16  Type,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_CACHE_SRAM_TYPE), gShellDebug1HiiHandle);\r
@@ -3253,10 +3314,16 @@ DisplayCacheSRAMType (
   PRINT_BITS_INFO (CacheSRAMTypeTable, (UINT8) Type);\r
 }\r
 \r
+/**\r
+  Display Cache Information (Type 7) correcting Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayCacheErrCorrectingType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_CACHE_ERROR_CORRECTING), gShellDebug1HiiHandle);\r
@@ -3264,10 +3331,16 @@ DisplayCacheErrCorrectingType (
   PRINT_TABLE_ITEM (CacheErrCorrectingTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Cache Information (Type 7) Type.\r
+\r
+  @param[in] Type           The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayCacheSystemCacheType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_CACHE_SYSTEM_TYPE), gShellDebug1HiiHandle);\r
@@ -3275,23 +3348,33 @@ DisplayCacheSystemCacheType (
   PRINT_TABLE_ITEM (CacheSystemCacheTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Cache Information (Type 7) Associativity.\r
+\r
+  @param[in] Associativity  The key of the structure.\r
+  @param[in] Option         The optional information.\r
+**/\r
 VOID\r
 DisplayCacheAssociativity (\r
-  UINT8 Associativity,\r
-  UINT8 Option\r
+  IN UINT8 Associativity,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_CACHE_ASSOCIATIVITY), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Associativity, Option);\r
   PRINT_TABLE_ITEM (CacheAssociativityTable, Associativity);\r
 }\r
-//\r
-// Port Connector Information (Type 8)\r
-//\r
+\r
+/**\r
+  Display Port Connector Information  (Type 8) type.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPortConnectorType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PORT_CONNECTOR_TYPE), gShellDebug1HiiHandle);\r
@@ -3299,23 +3382,33 @@ DisplayPortConnectorType (
   PRINT_TABLE_ITEM (PortConnectorTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Port Connector Information  (Type 8) port type.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPortType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PORT_TYPE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Type, Option);\r
   PRINT_TABLE_ITEM (PortTypeTable, Type);\r
 }\r
-//\r
-// System Slots (Type 9)\r
-//\r
+\r
+/**\r
+  Display System Slots (Type 9) slot type.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySystemSlotType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_SLOT_TYPE), gShellDebug1HiiHandle);\r
@@ -3323,10 +3416,16 @@ DisplaySystemSlotType (
   PRINT_TABLE_ITEM (SystemSlotTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display System Slots (Type 9) data bus width.\r
+\r
+  @param[in] Width      The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySystemSlotDataBusWidth (\r
-  UINT8 Width,\r
-  UINT8 Option\r
+  IN UINT8 Width,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_SLOT_DATA), gShellDebug1HiiHandle);\r
@@ -3334,10 +3433,16 @@ DisplaySystemSlotDataBusWidth (
   PRINT_TABLE_ITEM (SystemSlotDataBusWidthTable, Width);\r
 }\r
 \r
+/**\r
+  Display System Slots (Type 9) usage information.\r
+\r
+  @param[in] Usage      The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySystemSlotCurrentUsage (\r
-  UINT8 Usage,\r
-  UINT8 Option\r
+  IN UINT8 Usage,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_SLOT_CURRENT_USAGE), gShellDebug1HiiHandle);\r
@@ -3345,10 +3450,16 @@ DisplaySystemSlotCurrentUsage (
   PRINT_TABLE_ITEM (SystemSlotCurrentUsageTable, Usage);\r
 }\r
 \r
+/**\r
+  Display System Slots (Type 9) slot length.\r
+\r
+  @param[in] Length     The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySystemSlotLength (\r
-  UINT8 Length,\r
-  UINT8 Option\r
+  IN UINT8 Length,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_SLOT_LENGTH), gShellDebug1HiiHandle);\r
@@ -3356,10 +3467,16 @@ DisplaySystemSlotLength (
   PRINT_TABLE_ITEM (SystemSlotLengthTable, Length);\r
 }\r
 \r
+/**\r
+  Display System Slots (Type 9) characteristics.\r
+\r
+  @param[in] Chara1     The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySlotCharacteristics1 (\r
-  UINT8 Chara1,\r
-  UINT8 Option\r
+  IN UINT8 Chara1,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SLOT_CHARACTERISTICS), gShellDebug1HiiHandle);\r
@@ -3367,36 +3484,50 @@ DisplaySlotCharacteristics1 (
   PRINT_BITS_INFO (SlotCharacteristics1Table, Chara1);\r
 }\r
 \r
+/**\r
+  Display System Slots (Type 9) characteristics.\r
+\r
+  @param[in] Chara2     The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySlotCharacteristics2 (\r
-  UINT8 Chara2,\r
-  UINT8 Option\r
+  IN UINT8 Chara2,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SLOT_CHARACTERISTICS_2), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Chara2, Option);\r
   PRINT_BITS_INFO (SlotCharacteristics2Table, Chara2);\r
 }\r
-//\r
-// On Board Devices Information (Type 10)\r
-//\r
+\r
+/**\r
+  Display On Board Devices Information (Type 10) types.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayOnboardDeviceTypes (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_ONBOARD_DEVICE_TYPE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Type, Option);\r
   PRINT_TABLE_ITEM (OnboardDeviceTypesTable, Type);\r
 }\r
-//\r
-// System Event Log (Type 15)\r
-//\r
+\r
+/**\r
+  Display System Event Log (Type 15) types.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySELTypes (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_SYSTEM_EVENT_LOG_TYPE), gShellDebug1HiiHandle);\r
@@ -3404,10 +3535,16 @@ DisplaySELTypes (
   PRINT_TABLE_ITEM (SELTypesTable, Type);\r
 }\r
 \r
+/**\r
+  Display System Event Log (Type 15) format type.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySELVarDataFormatType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_EVENT_LOG_VAR_DATA_FORMAT), gShellDebug1HiiHandle);\r
@@ -3415,10 +3552,16 @@ DisplaySELVarDataFormatType (
   PRINT_TABLE_ITEM (SELVarDataFormatTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display System Event Log (Type 15) dw1.\r
+\r
+  @param[in] Key        The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPostResultsBitmapDw1 (\r
-  UINT32  Key,\r
-  UINT8   Option\r
+  IN UINT32  Key,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_POST_RESULTS_BITMAP), gShellDebug1HiiHandle);\r
@@ -3426,10 +3569,16 @@ DisplayPostResultsBitmapDw1 (
   PRINT_BITS_INFO (PostResultsBitmapDw1Table, Key);\r
 }\r
 \r
+/**\r
+  Display System Event Log (Type 15) dw2.\r
+\r
+  @param[in] Key        The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPostResultsBitmapDw2 (\r
-  UINT32  Key,\r
-  UINT8   Option\r
+  IN UINT32  Key,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_POST_RESULTS_SECOND_DWORD), gShellDebug1HiiHandle);\r
@@ -3437,10 +3586,16 @@ DisplayPostResultsBitmapDw2 (
   PRINT_BITS_INFO (PostResultsBitmapDw2Table, Key);\r
 }\r
 \r
+/**\r
+  Display System Event Log (Type 15) type.\r
+\r
+  @param[in] SMType     The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplaySELSysManagementTypes (\r
-  UINT32  SMType,\r
-  UINT8   Option\r
+  IN UINT32  SMType,\r
+  IN UINT8   Option\r
   )\r
 {\r
   UINT8       Temp;\r
@@ -3467,13 +3622,17 @@ DisplaySELSysManagementTypes (
     PRINT_TABLE_ITEM (SELSysManagementTypesTable, Temp);\r
   }\r
 }\r
-//\r
-// Physical Memory Array (Type 16)\r
-//\r
+\r
+/**\r
+  Display Physical Memory Array (Type 16) Location.\r
+\r
+  @param[in] Location   The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPMALocation (\r
-  UINT8 Location,\r
-  UINT8 Option\r
+  IN UINT8 Location,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PHYS_MEM_ARRAY_LOCATION), gShellDebug1HiiHandle);\r
@@ -3481,10 +3640,16 @@ DisplayPMALocation (
   PRINT_TABLE_ITEM (PMALocationTable, Location);\r
 }\r
 \r
+/**\r
+  Display Physical Memory Array (Type 16) Use.\r
+\r
+  @param[in] Use        The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPMAUse (\r
-  UINT8 Use,\r
-  UINT8 Option\r
+  IN UINT8 Use,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PHYS_MEM_ARRAY_LOCATION), gShellDebug1HiiHandle);\r
@@ -3492,23 +3657,33 @@ DisplayPMAUse (
   PRINT_TABLE_ITEM (PMAUseTable, Use);\r
 }\r
 \r
+/**\r
+  Display Physical Memory Array (Type 16) Types.\r
+\r
+  @param[in] Type       The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPMAErrorCorrectionTypes (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PHYS_MEM_ARRAY_ERROR), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Type, Option);\r
   PRINT_TABLE_ITEM (PMAErrorCorrectionTypesTable, Type);\r
 }\r
-//\r
-// Memory Device (Type 17)\r
-//\r
+\r
+/**\r
+  Display Memory Device (Type 17) form factor.\r
+\r
+  @param[in] FormFactor The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryDeviceFormFactor (\r
-  UINT8 FormFactor,\r
-  UINT8 Option\r
+  IN UINT8 FormFactor,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_DEVICE_FORM_FACTOR), gShellDebug1HiiHandle);\r
@@ -3516,10 +3691,16 @@ DisplayMemoryDeviceFormFactor (
   PRINT_TABLE_ITEM (MemoryDeviceFormFactorTable, FormFactor);\r
 }\r
 \r
+/**\r
+  Display Memory Device (Type 17) type.\r
+\r
+  @param[in] Type     The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryDeviceType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_DEVICE_TYPE), gShellDebug1HiiHandle);\r
@@ -3527,23 +3708,33 @@ DisplayMemoryDeviceType (
   PRINT_TABLE_ITEM (MemoryDeviceTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Memory Device (Type 17) details.\r
+\r
+  @param[in] Para     The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryDeviceTypeDetail (\r
-  UINT16  para,\r
-  UINT8   Option\r
+  IN UINT16  Para,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_DEVICE_TYPE_DETAIL), gShellDebug1HiiHandle);\r
-  PRINT_INFO_OPTION (para, Option);\r
-  PRINT_BITS_INFO (MemoryDeviceTypeDetailTable, para);\r
+  PRINT_INFO_OPTION (Para, Option);\r
+  PRINT_BITS_INFO (MemoryDeviceTypeDetailTable, Para);\r
 }\r
-//\r
-// 32-bit Memory Error Information (Type 18)\r
-//\r
+\r
+/**\r
+  Display 32-bit Memory Error Information (Type 18) type.\r
+\r
+  @param[in] ErrorType  The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryErrorType (\r
-  UINT8 ErrorType,\r
-  UINT8 Option\r
+  IN UINT8 ErrorType,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_ERROR_INFO), gShellDebug1HiiHandle);\r
@@ -3551,10 +3742,16 @@ DisplayMemoryErrorType (
   PRINT_TABLE_ITEM (MemoryErrorTypeTable, ErrorType);\r
 }\r
 \r
+/**\r
+  Display 32-bit Memory Error Information (Type 18) error granularity.\r
+\r
+  @param[in] Granularity  The key of the structure.\r
+  @param[in] Option       The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryErrorGranularity (\r
-  UINT8 Granularity,\r
-  UINT8 Option\r
+  IN UINT8 Granularity,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_ERROR_GRANULARITY), gShellDebug1HiiHandle);\r
@@ -3562,23 +3759,33 @@ DisplayMemoryErrorGranularity (
   PRINT_TABLE_ITEM (MemoryErrorGranularityTable, Granularity);\r
 }\r
 \r
+/**\r
+  Display 32-bit Memory Error Information (Type 18) error information.\r
+\r
+  @param[in] Operation  The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryErrorOperation (\r
-  UINT8 Operation,\r
-  UINT8 Option\r
+  IN UINT8 Operation,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_ERROR_OP), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Operation, Option);\r
   PRINT_TABLE_ITEM (MemoryErrorOperationTable, Operation);\r
 }\r
-//\r
-// Built-in Pointing Device (Type 21)\r
-//\r
+\r
+/**\r
+  Display Built-in Pointing Device (Type 21) type information.\r
+\r
+  @param[in] Type     The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayPointingDeviceType (\r
-  UINT8 Type,\r
-  UINT8 Option\r
+  IN UINT8 Type,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_POINTING_DEVICE_TYPE), gShellDebug1HiiHandle);\r
@@ -3586,36 +3793,50 @@ DisplayPointingDeviceType (
   PRINT_TABLE_ITEM (PointingDeviceTypeTable, Type);\r
 }\r
 \r
+/**\r
+  Display Built-in Pointing Device (Type 21) information.\r
+\r
+  @param[in] Interface  The key of the structure.\r
+  @param[in] Option     The optional information.\r
+**/\r
 VOID\r
 DisplayPointingDeviceInterface (\r
-  UINT8   Interface,\r
-  UINT8   Option\r
+  IN UINT8   Interface,\r
+  IN UINT8   Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_POINTING_DEVICE_INTERFACE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Interface, Option);\r
   PRINT_TABLE_ITEM (PointingDeviceInterfaceTable, Interface);\r
 }\r
-//\r
-// Portable Battery (Type 22)\r
-//\r
+\r
+/**\r
+  Display Portable Battery  (Type 22) information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayPBDeviceChemistry (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_PORTABLE_BATT_DEV_CHEM), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Key, Option);\r
   PRINT_TABLE_ITEM (PBDeviceChemistryTable, Key);\r
 }\r
-//\r
-// Voltage Probe (Type 26)\r
-//\r
+\r
+/**\r
+  Display Voltage Probe (Type 26) location information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayVPLocation (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Loc;\r
@@ -3626,10 +3847,16 @@ DisplayVPLocation (
   PRINT_TABLE_ITEM (VPLocationTable, Loc);\r
 }\r
 \r
+/**\r
+  Display Voltage Probe (Type 26) status ype information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayVPStatus (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Status;\r
@@ -3639,13 +3866,17 @@ DisplayVPStatus (
   PRINT_INFO_OPTION (Status, Option);\r
   PRINT_TABLE_ITEM (VPStatusTable, Status);\r
 }\r
-//\r
-// Voltage Probe (Type 27)\r
-//\r
+\r
+/**\r
+  Display Cooling (Type 27) status information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayCoolingDeviceStatus (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Status;\r
@@ -3656,10 +3887,16 @@ DisplayCoolingDeviceStatus (
   PRINT_TABLE_ITEM (CoolingDeviceStatusTable, Status);\r
 }\r
 \r
+/**\r
+  Display Cooling (Type 27) type information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayCoolingDeviceType (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Type;\r
@@ -3669,13 +3906,17 @@ DisplayCoolingDeviceType (
   PRINT_INFO_OPTION (Type, Option);\r
   PRINT_TABLE_ITEM (CoolingDeviceTypeTable, Type);\r
 }\r
-//\r
-// Temperature Probe  (Type 28)\r
-//\r
+\r
+/**\r
+  Display Temperature Probe (Type 28) status information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayTemperatureProbeStatus (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Status;\r
@@ -3686,10 +3927,16 @@ DisplayTemperatureProbeStatus (
   PRINT_TABLE_ITEM (TemperatureProbeStatusTable, Status);\r
 }\r
 \r
+/**\r
+  Display Temperature Probe  (Type 28) location information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayTemperatureProbeLoc (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Loc;\r
@@ -3699,13 +3946,17 @@ DisplayTemperatureProbeLoc (
   PRINT_INFO_OPTION (Loc, Option);\r
   PRINT_TABLE_ITEM (TemperatureProbeLocTable, Loc);\r
 }\r
-//\r
-// Electrical Current Probe (Type 29)\r
-//\r
+\r
+/**\r
+  Display Electrical Current Probe (Type 29)  status information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayECPStatus (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Status;\r
@@ -3716,10 +3967,16 @@ DisplayECPStatus (
   PRINT_TABLE_ITEM (ECPStatusTable, Status);\r
 }\r
 \r
+/**\r
+  Display Type 29 information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayECPLoc (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   UINT8       Loc;\r
@@ -3729,13 +3986,17 @@ DisplayECPLoc (
   PRINT_INFO_OPTION (Loc, Option);\r
   PRINT_TABLE_ITEM (ECPLocTable, Loc);\r
 }\r
-//\r
-// Management Device (Type 34)\r
-//\r
+\r
+/**\r
+  Display Management Device (Type 34) information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayMDType (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MANAGEMENT_DEV_TYPE), gShellDebug1HiiHandle);\r
@@ -3743,36 +4004,33 @@ DisplayMDType (
   PRINT_TABLE_ITEM (MDTypeTable, Key);\r
 }\r
 \r
-VOID\r
-DisplayMDAddressType (\r
-  UINT8 Key,\r
-  UINT8 Option\r
-  )\r
-{\r
-  ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MANAGEMENT_DEV_ADDR_TYPE), gShellDebug1HiiHandle);\r
-  PRINT_INFO_OPTION (Key, Option);\r
-  PRINT_TABLE_ITEM (MDAddressTypeTable, Key);\r
-}\r
-//\r
-// Memory Channel (Type 37)\r
-//\r
+/**\r
+  Display Memory Channel (Type 37) information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayMemoryChannelType (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_MEM_CHANNEL_TYPE), gShellDebug1HiiHandle);\r
   PRINT_INFO_OPTION (Key, Option);\r
   PRINT_TABLE_ITEM (MemoryChannelTypeTable, Key);\r
 }\r
-//\r
-// IPMI Device Information (Type 38)\r
-//\r
+\r
+/**\r
+  Display IPMI Device Information (Type 38) information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayIPMIDIBMCInterfaceType (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   ShellPrintHiiEx(-1,-1,NULL,STRING_TOKEN (STR_SMBIOSVIEW_QUERYTABLE_BMC_INTERFACE_TYPE), gShellDebug1HiiHandle);\r
@@ -3780,10 +4038,16 @@ DisplayIPMIDIBMCInterfaceType (
   PRINT_TABLE_ITEM (IPMIDIBMCInterfaceTypeTable, Key);\r
 }\r
 \r
+/**\r
+  Display the structure type information.\r
+\r
+  @param[in] Key      The key of the structure.\r
+  @param[in] Option   The optional information.\r
+**/\r
 VOID\r
 DisplayStructureTypeInfo (\r
-  UINT8 Key,\r
-  UINT8 Option\r
+  IN UINT8 Key,\r
+  IN UINT8 Option\r
   )\r
 {\r
   //\r