add comments to function declarations and definitions and updated to match coding...

[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SmbiosView / QueryTable.h

/** @file\r
  Build a table, each item is (key, info) pair.\r
  and give a interface of query a string out of a table.\r
\r
  Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _SMBIOS_QUERY_TABLE_H_\r
#define _SMBIOS_QUERY_TABLE_H_\r
\r
#define QUERY_TABLE_UNFOUND 0xFF\r
\r
typedef struct TABLE_ITEM {\r
  UINT16  Key;\r
  CHAR16  *Info;\r
} TABLE_ITEM;\r
\r
//\r
// Print info by option\r
//\r
#define PRINT_INFO_OPTION(Value, Option) \\r
  do { \\r
    if (Option == SHOW_NONE) { \\r
      return ; \\r
    } \\r
    if (Option < SHOW_DETAIL) { \\r
      Print (L"0x%x\n", Value); \\r
      return ; \\r
    } \\r
  } while (0);\r
\r
/**\r
  Given a table and a Key, return the responding info.\r
\r
  Notes:\r
    Table[Index].Key is change from UINT8 to UINT16,\r
    in order to deal with "0xaa - 0xbb".\r
\r
    For example:\r
      DisplaySELVariableDataFormatTypes(UINT8 Type, UINT8 Option)\r
    has a item:\r
      "0x07-0x7F,   Unused"\r
    Now define Key = 0x7F07, that is to say: High = 0x7F, Low = 0x07.\r
    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
\r
  @return the found Key and Info is valid.\r
  @retval QUERY_TABLE_UNFOUND and Info should be NULL.\r
**/\r
UINT8\r
QueryTable (\r
  IN  TABLE_ITEM    *Table,\r
  IN  UINTN         Number,\r
  IN  UINT8         Key,\r
  IN  OUT CHAR16    *Info,\r
  IN  UINTN         InfoLen\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
  IN UINT8 Key,\r
  IN UINT8 Option\r
  );\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Status,\r
  IN UINT8 Option\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
  IN UINT8 Status,\r
  IN UINT8 Option\r
  )\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Upgrade,\r
  IN UINT8 Option\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
  IN UINT8 Method,\r
  IN UINT8 Option\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
  IN UINT8 Capability,\r
  IN UINT8 Option\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
  IN UINT8 Support,\r
  IN UINT8 Option\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
  IN UINT16  Speed,\r
  IN UINT8   Option\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
  IN UINT8 Voltage,\r
  IN UINT8 Option\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
  IN UINT16  Type,\r
  IN UINT8   Option\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
  IN UINT8 Status,\r
  IN UINT8 Option\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
  IN UINT16  Type,\r
  IN UINT8   Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Associativity,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Width,\r
  IN UINT8 Option\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
  IN UINT8 Usage,\r
  IN UINT8 Option\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
  IN UINT8 Length,\r
  IN UINT8 Option\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
  IN UINT8 Chara1,\r
  IN UINT8 Option\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
  IN UINT8 Chara2,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT32  Key,\r
  IN UINT8   Option\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
  IN UINT32  Key,\r
  IN UINT8   Option\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
  IN UINT32  SMType,\r
  IN UINT8   Option\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
  IN UINT8 Location,\r
  IN UINT8 Option\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
  IN UINT8 Use,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8 FormFactor,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT16  Para,\r
  IN UINT8   Option\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
  IN UINT8 ErrorType,\r
  IN UINT8 Option\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
  IN UINT8 Granularity,\r
  IN UINT8 Option\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
  IN UINT8 Operation,\r
  IN UINT8 Option\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
  IN UINT8 Type,\r
  IN UINT8 Option\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
  IN UINT8   Interface,\r
  IN UINT8   Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\r
  );\r
\r
/**\r
  Display Electrical Current Probe (Type 29) location information.\r
\r
  @param[in] Key      The key of the structure.\r
  @param[in] Option   The optional information.\r
**/\r
VOID\r
DisplayECPLoc (\r
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\r
  );\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
  IN UINT8 Key,\r
  IN UINT8 Option\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
  IN UINT8 Key,\r
  IN UINT8 Option\r
  );\r
\r
#endif\r