EDK2 doxygen online documents - Firmware Encoding Index 1
EDK2 doxygen online documents - Firmware Encoding Index
Data Structures | Defines | Functions | Variables

ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/SmbiosView.h File Reference

Go to the source code of this file.

Data Structures

struct  STRUCTURE_STATISTICS

Defines

#define STRUCTURE_TYPE_RANDOM   (UINT8) 0xFE
#define STRUCTURE_TYPE_INVALID   (UINT8) 0xFF
#define STRUCTURE_HANDLE_INVALID   (UINT16) 0xFFFF

Functions

EFI_STATUS EFIAPI SMBiosView (IN UINT8 QueryType, IN UINT16 QueryHandle, IN UINT8 Option, IN BOOLEAN RandomView)
EFI_STATUS EFIAPI InitSmbiosTableStatistics (VOID)
EFI_STATUS EFIAPI DisplayStatisticsTable (IN UINT8 Option)
CHAR16 *EFIAPI GetShowTypeString (UINT8 ShowType)

Variables

UINT8 gShowType

Detailed Description

Tools of clarify the content of the smbios table.

Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Definition in file SmbiosView.h.


Define Documentation

#define STRUCTURE_HANDLE_INVALID   (UINT16) 0xFFFF

Definition at line 21 of file SmbiosView.h.

#define STRUCTURE_TYPE_INVALID   (UINT8) 0xFF

Definition at line 19 of file SmbiosView.h.

#define STRUCTURE_TYPE_RANDOM   (UINT8) 0xFE

Definition at line 18 of file SmbiosView.h.


Function Documentation

EFI_STATUS EFIAPI DisplayStatisticsTable ( IN UINT8  Option)

Function to display the global mStatisticsTable object.

Parameters:
[in]OptionECHO, NORMAL, or DETAIL control the amount of detail displayed.
Return values:
EFI_SUCCESSprint is successful.

Definition at line 451 of file SmbiosView.c.

CHAR16* EFIAPI GetShowTypeString ( UINT8  ShowType)

function to return a string of the detail level.

Parameters:
[in]ShowTypeThe detail level whose name is desired in clear text.
Returns:
A pointer to a string representing the ShowType (or 'undefined type' if not known).

Definition at line 532 of file SmbiosView.c.

EFI_STATUS EFIAPI InitSmbiosTableStatistics ( VOID  )

Function to initialize the global mStatisticsTable object.

Return values:
EFI_SUCCESSprint is successful.

Definition at line 362 of file SmbiosView.c.

EFI_STATUS EFIAPI SMBiosView ( IN UINT8  QueryType,
IN UINT16  QueryHandle,
IN UINT8  Option,
IN BOOLEAN  RandomView 
)

Query all structures Data from SMBIOS table and Display the information to users as required display option.

Parameters:
[in]QueryTypeStructure type to view.
[in]QueryHandleStructure handle to view.
[in]OptionDisplay option: none,outline,normal,detail.
[in]RandomViewSupport for -h parameter.
Return values:
EFI_SUCCESSprint is successful.
EFI_BAD_BUFFER_SIZEstructure is out of the range of SMBIOS table.

Definition at line 183 of file SmbiosView.c.


Variable Documentation

Definition at line 21 of file SmbiosView.c.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines