SmbiosView.c File Reference

#include "UefiShellDebug1CommandsLib.h"
#include "LibSmbiosView.h"
#include "SmbiosView.h"
#include "PrintInfo.h"
#include "QueryTable.h"

Go to the source code of this file.

Functions
SHELL_STATUS EFIAPI	ShellCommandRunSmbiosView (IN EFI_HANDLE ImageHandle, IN EFI_SYSTEM_TABLE *SystemTable)
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	CalculateSmbios64BitStructureCountAndLength (SMBIOS_TABLE_3_0_ENTRY_POINT *Smbios64EntryPoint, UINTN *NumberOfSmbios64Structures, UINTN *Smbios64TableLength)
EFI_STATUS	InitSmbios64BitTableStatistics (VOID)
EFI_STATUS	DisplayStatisticsTable (IN UINT8 Option)
EFI_STATUS	DisplaySmbios64BitStatisticsTable (IN UINT8 Option)
CHAR16 *	GetShowTypeString (UINT8 ShowType)

Variables
UINT8	gShowType = SHOW_DETAIL
STATIC STRUCTURE_STATISTICS *	mStatisticsTable = NULL
STATIC STRUCTURE_STATISTICS *	mSmbios64BitStatisticsTable = NULL
UINT8	SmbiosMajorVersion
UINT8	SmbiosMinorVersion
UINTN	mNumberOfSmbios64BitStructures
UINTN	mSmbios64BitTableLength
STATIC CONST SHELL_PARAM_ITEM	ParamList []

Detailed Description

Tools of clarify the content of the smbios table.

(C) Copyright 2015 Hewlett-Packard Development Company, L.P.
Copyright (c) 2005 - 2018, Intel Corporation. All rights reserved.
Copyright (c) 2023 Apple Inc. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SmbiosView.c.

Function Documentation

CalculateSmbios64BitStructureCountAndLength()

EFI_STATUS CalculateSmbios64BitStructureCountAndLength	(	SMBIOS_TABLE_3_0_ENTRY_POINT *	Smbios64EntryPoint,
		UINTN *	NumberOfSmbios64Structures,
		UINTN *	Smbios64TableLength
	)

Parameters

[in]	Smbios64EntryPoint	SMBIOS 64-bit entry point.
[out]	NumberOfSmbios64Structures	The number of structures in 64-bit SMBIOS table.
[out]	Smbios64TableLength	The total length of 64-bit SMBIOS table.

Return values

EFI_SUCCESS

Calculation was successful.

Definition at line 686 of file SmbiosView.c.

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.

ShellCommandRunSmbiosView()

SHELL_STATUS EFIAPI ShellCommandRunSmbiosView	(	IN EFI_HANDLE	ImageHandle,
		IN EFI_SYSTEM_TABLE *	SystemTable
	)

Function for 'smbiosview' command.

Parameters

[in]	ImageHandle	Handle to the Image (NULL if Internal).
[in]	SystemTable	Pointer to the System Table (NULL if Internal).

Definition at line 43 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 = SHOW_DETAIL

Definition at line 17 of file SmbiosView.c.

mNumberOfSmbios64BitStructures

UINTN mNumberOfSmbios64BitStructures

Definition at line 24 of file SmbiosView.c.

mSmbios64BitStatisticsTable

STATIC STRUCTURE_STATISTICS* mSmbios64BitStatisticsTable = NULL

Definition at line 19 of file SmbiosView.c.

mSmbios64BitTableLength

UINTN mSmbios64BitTableLength

Definition at line 25 of file SmbiosView.c.

mStatisticsTable

STATIC STRUCTURE_STATISTICS* mStatisticsTable = NULL

Definition at line 18 of file SmbiosView.c.

ParamList

STATIC CONST SHELL_PARAM_ITEM ParamList[]

Initial value:

= {
  { L"-t", TypeValue },
  { L"-h", TypeValue },
  { L"-s", TypeFlag  },
  { L"-a", TypeFlag  },
  { NULL,  TypeMax   }
}

Definition at line 27 of file SmbiosView.c.

SmbiosMajorVersion

UINT8 SmbiosMajorVersion

Definition at line 21 of file SmbiosView.c.

SmbiosMinorVersion

UINT8 SmbiosMinorVersion

Definition at line 22 of file SmbiosView.c.