ShellPkg: Apply uncrustify changes

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

/** @file\r
  Tools of clarify the content of the smbios table.\r
\r
  Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _SMBIOS_VIEW_H_\r
#define _SMBIOS_VIEW_H_\r
\r
#define STRUCTURE_TYPE_RANDOM   (UINT8) 0xFE\r
#define STRUCTURE_TYPE_INVALID  (UINT8) 0xFF\r
\r
typedef struct {\r
  UINT16    Index;\r
  UINT8     Type;\r
  UINT16    Handle;\r
  UINT16    Addr;   // offset from table head\r
  UINT16    Length; // total structure length\r
} STRUCTURE_STATISTICS;\r
\r
/**\r
  Query all structures Data from SMBIOS table and Display\r
  the information to users as required display option.\r
\r
  @param[in] QueryType      Structure type to view.\r
  @param[in] QueryHandle    Structure handle to view.\r
  @param[in] Option         Display option: none,outline,normal,detail.\r
  @param[in] RandomView     Support for -h parameter.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
  @retval EFI_BAD_BUFFER_SIZE   structure is out of the range of SMBIOS table.\r
**/\r
EFI_STATUS\r
SMBiosView (\r
  IN  UINT8    QueryType,\r
  IN  UINT16   QueryHandle,\r
  IN  UINT8    Option,\r
  IN  BOOLEAN  RandomView\r
  );\r
\r
/**\r
  Query all structures Data from SMBIOS table and Display\r
  the information to users as required display option.\r
\r
  @param[in] QueryType      Structure type to view.\r
  @param[in] QueryHandle    Structure handle to view.\r
  @param[in] Option         Display option: none,outline,normal,detail.\r
  @param[in] RandomView     Support for -h parameter.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
  @retval EFI_BAD_BUFFER_SIZE   structure is out of the range of SMBIOS table.\r
**/\r
EFI_STATUS\r
SMBios64View (\r
  IN  UINT8    QueryType,\r
  IN  UINT16   QueryHandle,\r
  IN  UINT8    Option,\r
  IN  BOOLEAN  RandomView\r
  );\r
\r
/**\r
  Function to initialize the global mStatisticsTable object.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
**/\r
EFI_STATUS\r
InitSmbiosTableStatistics (\r
  VOID\r
  );\r
\r
/**\r
  Function to initialize the global mSmbios64BitStatisticsTable object.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
**/\r
EFI_STATUS\r
InitSmbios64BitTableStatistics (\r
  VOID\r
  );\r
\r
/**\r
  Function to display the global mStatisticsTable object.\r
\r
  @param[in] Option             ECHO, NORMAL, or DETAIL control the amount of detail displayed.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
**/\r
EFI_STATUS\r
DisplayStatisticsTable (\r
  IN UINT8  Option\r
  );\r
\r
/**\r
  Function to display the global mSmbios64BitStatisticsTable object.\r
\r
  @param[in] Option             ECHO, NORMAL, or DETAIL control the amount of detail displayed.\r
\r
  @retval EFI_SUCCESS           print is successful.\r
**/\r
EFI_STATUS\r
DisplaySmbios64BitStatisticsTable (\r
  IN UINT8  Option\r
  );\r
\r
/**\r
  function to return a string of the detail level.\r
\r
  @param[in] ShowType         The detail level whose name is desired in clear text.\r
\r
  @return   A pointer to a string representing the ShowType (or 'undefined type' if not known).\r
**/\r
CHAR16 *\r
GetShowTypeString (\r
  UINT8  ShowType\r
  );\r
\r
extern UINT8  gShowType;\r
\r
extern UINTN  mSmbios64BitTableLength;\r
\r
#endif\r