ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/SmbiosView.h

   1 /** @file
   2   Tools of clarify the content of the smbios table.
   3
   4   Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _SMBIOS_VIEW_H_
  16 #define _SMBIOS_VIEW_H_
  17
  18 #define STRUCTURE_TYPE_RANDOM     (UINT8) 0xFE
  19 #define STRUCTURE_TYPE_INVALID    (UINT8) 0xFF
  20
  21 #define STRUCTURE_HANDLE_INVALID  (UINT16) 0xFFFF
  22
  23 typedef struct {
  24   UINT16  Index;
  25   UINT8   Type;
  26   UINT16  Handle;
  27   UINT16  Addr;   // offset from table head
  28   UINT16  Length; // total structure length
  29 } STRUCTURE_STATISTICS;
  30
  31 /**
  32   Query all structures Data from SMBIOS table and Display
  33   the information to users as required display option.
  34
  35   @param[in] QueryType      Structure type to view.
  36   @param[in] QueryHandle    Structure handle to view.
  37   @param[in] Option         Display option: none,outline,normal,detail.
  38   @param[in] RandomView     Support for -h parameter.
  39
  40   @retval EFI_SUCCESS           print is successful.
  41   @retval EFI_BAD_BUFFER_SIZE   structure is out of the range of SMBIOS table.
  42 **/
  43 EFI_STATUS
  44 EFIAPI
  45 SMBiosView (
  46   IN  UINT8     QueryType,
  47   IN  UINT16    QueryHandle,
  48   IN  UINT8     Option,
  49   IN  BOOLEAN   RandomView
  50   );
  51
  52 /**
  53   Function to initialize the global mStatisticsTable object.
  54
  55   @retval EFI_SUCCESS           print is successful.
  56 **/
  57 EFI_STATUS
  58 EFIAPI
  59 InitSmbiosTableStatistics (
  60   VOID
  61   );
  62
  63 /**
  64   Function to display the global mStatisticsTable object.
  65
  66   @param[in] Option             ECHO, NORMAL, or DETAIL control the amount of detail displayed.
  67
  68   @retval EFI_SUCCESS           print is successful.
  69 **/
  70 EFI_STATUS
  71 EFIAPI
  72 DisplayStatisticsTable (
  73   IN UINT8 Option
  74   );
  75
  76 /**
  77   function to return a string of the detail level.
  78
  79   @param[in] ShowType         The detail level whose name is desired in clear text.
  80
  81   @return   A pointer to a string representing the ShowType (or 'undefined type' if not known).
  82 **/
  83 CHAR16*
  84 EFIAPI
  85 GetShowTypeString (
  86   UINT8 ShowType
  87   );
  88
  89 extern UINT8  gShowType;
  90
  91 #endif