SmbiosView.h File Reference

Go to the source code of this file.

Data Structures
struct	STRUCTURE_STATISTICS

Macros
#define	STRUCTURE_TYPE_RANDOM   (UINT8) 0xFE
#define	STRUCTURE_TYPE_INVALID   (UINT8) 0xFF

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

Variables
UINT8	gShowType
UINTN	mSmbios64BitTableLength

Detailed Description

Tools of clarify the content of the smbios table.

Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SmbiosView.h.

Macro Definition Documentation

STRUCTURE_TYPE_INVALID

#define STRUCTURE_TYPE_INVALID   (UINT8) 0xFF

Definition at line 13 of file SmbiosView.h.

STRUCTURE_TYPE_RANDOM

#define STRUCTURE_TYPE_RANDOM   (UINT8) 0xFE

Definition at line 12 of file SmbiosView.h.

Function Documentation

DisplaySmbios64BitStatisticsTable()

EFI_STATUS DisplaySmbios64BitStatisticsTable

(

IN UINT8

Option

)

Function to display the global mSmbios64BitStatisticsTable object.

Parameters

[in]

Option

ECHO, NORMAL, or DETAIL control the amount of detail displayed.

Return values

EFI_SUCCESS

print is successful.

Definition at line 917 of file SmbiosView.c.

DisplayStatisticsTable()

EFI_STATUS DisplayStatisticsTable

(

IN UINT8

Option

)

Function to display the global mStatisticsTable object.

Parameters

[in]

Option

ECHO, NORMAL, or DETAIL control the amount of detail displayed.

Return values

EFI_SUCCESS

print is successful.

Definition at line 835 of file SmbiosView.c.

GetShowTypeString()

CHAR16 * GetShowTypeString

(

UINT8

ShowType

)

function to return a string of the detail level.

Parameters

[in]

ShowType

The 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 999 of file SmbiosView.c.

InitSmbios64BitTableStatistics()

EFI_STATUS InitSmbios64BitTableStatistics

(

VOID

)

Function to initialize the global mSmbios64BitStatisticsTable object.

Return values

EFI_SUCCESS

print is successful.

Definition at line 736 of file SmbiosView.c.

InitSmbiosTableStatistics()

EFI_STATUS InitSmbiosTableStatistics

(

VOID

)

Function to initialize the global mStatisticsTable object.

Return values

EFI_SUCCESS

print is successful.

Definition at line 595 of file SmbiosView.c.

SMBios64View()

EFI_STATUS SMBios64View	(	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]	QueryType	Structure type to view.
[in]	QueryHandle	Structure handle to view.
[in]	Option	Display option: none,outline,normal,detail.
[in]	RandomView	Support for -h parameter.

Return values

EFI_SUCCESS	print is successful.
EFI_BAD_BUFFER_SIZE	structure is out of the range of SMBIOS table.

Definition at line 424 of file SmbiosView.c.

SMBiosView()

EFI_STATUS 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]	QueryType	Structure type to view.
[in]	QueryHandle	Structure handle to view.
[in]	Option	Display option: none,outline,normal,detail.
[in]	RandomView	Support for -h parameter.

Return values

EFI_SUCCESS	print is successful.
EFI_BAD_BUFFER_SIZE	structure is out of the range of SMBIOS table.

Definition at line 245 of file SmbiosView.c.

Variable Documentation

gShowType

UINT8 gShowType

extern

Definition at line 17 of file SmbiosView.c.

mSmbios64BitTableLength

UINTN mSmbios64BitTableLength

extern

Definition at line 25 of file SmbiosView.c.