pointer verification (not NULL) and buffer overrun fixes.

[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
VOID\r
PrintBitsInfo (\r
  IN  TABLE_ITEM    *Table,\r
  IN  UINTN         Number,\r
  IN  UINT32        Bits\r
  );\r
\r
//\r
// Display the element detail information\r
//\r
VOID\r
DisplayStructureTypeInfo (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// System Information (Type 1)\r
//\r
VOID\r
DisplaySystemWakeupType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
\r
//\r
// System Enclosure (Type 3)\r
//\r
VOID\r
DisplaySystemEnclosureType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySystemEnclosureStatus (\r
  UINT8 Status,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySESecurityStatus (\r
  UINT8 Status,\r
  UINT8 Option\r
  );\r
\r
//\r
// Processor Information (Type 4)\r
//\r
VOID\r
DisplayProcessorType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayProcessorUpgrade (\r
  UINT8 Upgrade,\r
  UINT8 Option\r
  );\r
\r
//\r
// Memory Controller Information (Type 5)\r
//\r
VOID\r
DisplayMcErrorDetectMethod (\r
  UINT8 Method,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMcErrorCorrectCapability (\r
  UINT8 Capability,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMcInterleaveSupport (\r
  UINT8 Support,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMcMemorySpeeds (\r
  UINT16  Speed,\r
  UINT8   Option\r
  );\r
VOID\r
DisplayMemoryModuleVoltage (\r
  UINT8 Voltage,\r
  UINT8 Option\r
  );\r
\r
//\r
// Memory Module Information (Type 6)\r
//\r
VOID\r
DisplayMmMemoryType (\r
  UINT16  Type,\r
  UINT8   Option\r
  );\r
VOID\r
DisplayMmErrorStatus (\r
  UINT8 Status,\r
  UINT8 Option\r
  );\r
\r
//\r
// Cache Information (Type 7)\r
//\r
VOID\r
DisplayCacheSRAMType (\r
  UINT16  Type,\r
  UINT8   Option\r
  );\r
VOID\r
DisplayCacheErrCorrectingType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayCacheSystemCacheType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayCacheAssociativity (\r
  UINT8 Associativity,\r
  UINT8 Option\r
  );\r
\r
//\r
// Port Connector Information  (Type 8)\r
//\r
VOID\r
DisplayPortConnectorType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayPortType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
\r
//\r
// System Slots (Type 9)\r
//\r
VOID\r
DisplaySystemSlotType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySystemSlotDataBusWidth (\r
  UINT8 Width,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySystemSlotCurrentUsage (\r
  UINT8 Usage,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySystemSlotLength (\r
  UINT8 Length,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySlotCharacteristics1 (\r
  UINT8 Chara1,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySlotCharacteristics2 (\r
  UINT8 Chara2,\r
  UINT8 Option\r
  );\r
\r
//\r
// On Board Devices Information (Type 10)\r
//\r
VOID\r
DisplayOnboardDeviceTypes (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
\r
//\r
// System Event Log (Type 15)\r
//\r
VOID\r
DisplaySELTypes (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplaySELVarDataFormatType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayPostResultsBitmapDw1 (\r
  UINT32  Key,\r
  UINT8   Option\r
  );\r
VOID\r
DisplayPostResultsBitmapDw2 (\r
  UINT32  Key,\r
  UINT8   Option\r
  );\r
VOID\r
DisplaySELSysManagementTypes (\r
  UINT32  SMType,\r
  UINT8   Option\r
  );\r
\r
//\r
// Physical Memory Array (Type 16)\r
//\r
VOID\r
DisplayPMALocation (\r
  UINT8 Location,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayPMAUse (\r
  UINT8 Use,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayPMAErrorCorrectionTypes (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
\r
//\r
// Memory Device (Type 17)\r
//\r
VOID\r
DisplayMemoryDeviceFormFactor (\r
  UINT8 FormFactor,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMemoryDeviceType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMemoryDeviceTypeDetail (\r
  UINT16  Parameter,\r
  UINT8   Option\r
  );\r
\r
//\r
// 32-bit Memory Error Information (Type 18)\r
//\r
VOID\r
DisplayMemoryErrorType (\r
  UINT8 ErrorType,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMemoryErrorGranularity (\r
  UINT8 Granularity,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMemoryErrorOperation (\r
  UINT8 Operation,\r
  UINT8 Option\r
  );\r
\r
//\r
// Memory Array Mapped Address (Type 19)\r
// Memory Device Mapped Address  (Type 20)\r
//\r
// Built-in Pointing Device  (Type 21)\r
//\r
VOID\r
DisplayPointingDeviceType (\r
  UINT8 Type,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayPointingDeviceInterface (\r
  UINT8   Interface,\r
  UINT8   Option\r
  );\r
\r
//\r
// Portable Battery  (Type 22)\r
//\r
VOID\r
DisplayPBDeviceChemistry (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Voltage Probe (Type 26)\r
//\r
VOID\r
DisplayVPLocation (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayVPStatus (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Voltage Probe (Type 27)\r
//\r
VOID\r
DisplayCoolingDeviceStatus (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayCoolingDeviceType (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Temperature Probe  (Type 28)\r
//\r
VOID\r
DisplayTemperatureProbeStatus (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayTemperatureProbeLoc (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Electrical Current Probe (Type 29)\r
//\r
VOID\r
DisplayECPStatus (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayECPLoc (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Management Device  (Type 34)\r
//\r
VOID\r
DisplayMDType (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
VOID\r
DisplayMDAddressType (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// Memory Channel  (Type 37)\r
//\r
VOID\r
DisplayMemoryChannelType (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
//\r
// IPMI Device Information  (Type 38)\r
//\r
VOID\r
DisplayIPMIDIBMCInterfaceType (\r
  UINT8 Key,\r
  UINT8 Option\r
  );\r
\r
#endif\r