TianoCore EDK2 master
Loading...
Searching...
No Matches
PrintInfo.h File Reference

Go to the source code of this file.

Macros

#define SHOW_NONE   0x00
 
#define SHOW_OUTLINE   0x01
 
#define SHOW_NORMAL   0x02
 
#define SHOW_DETAIL   0x03
 
#define SHOW_ALL   0x04
 
#define SHOW_STATISTICS   0x05
 
#define AS_UINT16(pData)   (*((UINT16 *) pData))
 
#define AS_UINT32(pData)   (*((UINT32 *) pData))
 
#define AS_UINT64(pData)   (*((UINT64 *) pData))
 

Functions

VOID SmbiosPrintEPSInfo (IN SMBIOS_TABLE_ENTRY_POINT *SmbiosTable, IN UINT8 Option)
 
VOID Smbios64BitPrintEPSInfo (IN SMBIOS_TABLE_3_0_ENTRY_POINT *SmbiosTable, IN UINT8 Option)
 
EFI_STATUS SmbiosPrintStructure (IN SMBIOS_STRUCTURE_POINTER *Struct, IN UINT8 Option)
 
VOID DisplayBiosCharacteristics (IN UINT64 Chara, IN UINT8 Option)
 
VOID DisplayBiosCharacteristicsExt1 (IN UINT8 Byte1, IN UINT8 Option)
 
VOID DisplayBiosCharacteristicsExt2 (IN UINT8 Byte2, IN UINT8 Option)
 
VOID DisplayProcessorFamily (UINT8 Family, UINT8 Option)
 
VOID DisplayProcessorFamily2 (IN UINT16 Family2, IN UINT8 Option)
 
VOID DisplayProcessorVoltage (IN UINT8 Voltage, IN UINT8 Option)
 
VOID DisplayProcessorStatus (IN UINT8 Status, IN UINT8 Option)
 
VOID DisplayMaxMemoryModuleSize (IN UINT8 Size, IN UINT8 SlotNum, IN UINT8 Option)
 
VOID DisplayMemoryModuleConfigHandles (IN UINT16 *Handles, IN UINT8 SlotNum, IN UINT8 Option)
 
VOID DisplayMmBankConnections (IN UINT8 BankConnections, IN UINT8 Option)
 
VOID DisplayMmMemorySize (IN UINT8 Size, IN UINT8 Option)
 
VOID DisplayCacheConfiguration (IN UINT16 CacheConfiguration, IN UINT8 Option)
 
VOID DisplaySystemSlotId (IN UINT16 SlotId, IN UINT8 SlotType, IN UINT8 Option)
 
VOID DisplaySBDSManufactureDate (IN UINT16 Date, IN UINT8 Option)
 
VOID DisplaySystemResetCapabilities (IN UINT8 Reset, IN UINT8 Option)
 
VOID DisplayHardwareSecuritySettings (IN UINT8 Settings, IN UINT8 Option)
 
VOID DisplayOBRAConnections (IN UINT8 Connections, IN UINT8 Option)
 
VOID DisplaySystemBootStatus (IN UINT8 Parameter, IN UINT8 Option)
 
VOID DisplaySPSCharacteristics (IN UINT16 Characteristics, IN UINT8 Option)
 
VOID DisplayTpmDeviceCharacteristics (IN UINT64 Chara, IN UINT8 Option)
 
VOID DisplayProcessorArchitectureType (IN UINT8 Key, IN UINT8 Option)
 
VOID DisplayFirmwareCharacteristics (IN UINT16 Chara, IN UINT8 Option)
 
VOID DisplayFirmwareState (IN UINT8 Key, IN UINT8 Option)
 

Variables

UINT8 SmbiosMajorVersion
 
UINT8 SmbiosMinorVersion
 

Detailed Description

Module to clarify the element info of the smbios structure.

Copyright (c) 2005 - 2015, Intel Corporation. All rights reserved.
(C) Copyright 2017 - 2019 Hewlett Packard Enterprise Development LP
Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved. SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file PrintInfo.h.

Macro Definition Documentation

◆ AS_UINT16

#define AS_UINT16 (   pData)    (*((UINT16 *) pData))

Definition at line 29 of file PrintInfo.h.

◆ AS_UINT32

#define AS_UINT32 (   pData)    (*((UINT32 *) pData))

Definition at line 30 of file PrintInfo.h.

◆ AS_UINT64

#define AS_UINT64 (   pData)    (*((UINT64 *) pData))

Definition at line 31 of file PrintInfo.h.

◆ SHOW_ALL

#define SHOW_ALL   0x04

Definition at line 26 of file PrintInfo.h.

◆ SHOW_DETAIL

#define SHOW_DETAIL   0x03

Definition at line 22 of file PrintInfo.h.

◆ SHOW_NONE

#define SHOW_NONE   0x00

Definition at line 19 of file PrintInfo.h.

◆ SHOW_NORMAL

#define SHOW_NORMAL   0x02

Definition at line 21 of file PrintInfo.h.

◆ SHOW_OUTLINE

#define SHOW_OUTLINE   0x01

Definition at line 20 of file PrintInfo.h.

◆ SHOW_STATISTICS

#define SHOW_STATISTICS   0x05

Definition at line 27 of file PrintInfo.h.

Function Documentation

◆ DisplayBiosCharacteristics()

VOID DisplayBiosCharacteristics ( IN UINT64  Chara,
IN UINT8  Option 
)

Display BIOS Information (Type 0) information.

Parameters
[in]CharaThe information bits.
[in]OptionThe optional information.

Definition at line 1456 of file PrintInfo.c.

◆ DisplayBiosCharacteristicsExt1()

VOID DisplayBiosCharacteristicsExt1 ( IN UINT8  Byte1,
IN UINT8  Option 
)

Display Bios Characteristice extensions1 information.

Parameters
[in]Byte1The information.
[in]OptionThe optional information.

Definition at line 1617 of file PrintInfo.c.

◆ DisplayBiosCharacteristicsExt2()

VOID DisplayBiosCharacteristicsExt2 ( IN UINT8  byte2,
IN UINT8  Option 
)

Display Bios Characteristice extensions2 information.

Parameters
[in]Byte2The information.
[in]OptionThe optional information.

Display Bios Characteristice extensions2 information.

Parameters
[in]byte2The information.
[in]OptionThe optional information.

Definition at line 1671 of file PrintInfo.c.

◆ DisplayCacheConfiguration()

VOID DisplayCacheConfiguration ( IN UINT16  CacheConfiguration,
IN UINT8  Option 
)

Display Cache Configuration.

Parameters
[in]CacheConfigurationCache Configuration. Bits 15:10 Reserved, must be 0 Bits 9:8 Operational Mode 0h - Write Through 1h - Write Back 2h - Varies with Memory Address 3h - Unknown Bit 7 Enabled/Disabled 1 - Enabled 0 - Disabled Bits 6:5 Location 0h - Internal 1h - External 2h - Reserved 3h - Unknown Bit 4 Reserved, must be zero Bit 3 Cache Socketed 1 - Socketed 0 - Unsocketed Bits 2:0 Cache Level 1 through 8 (For example, an L1 cache would use value 000b and an L3 cache would use 010b.)
[in]OptionThe option

Definition at line 3069 of file PrintInfo.c.

◆ DisplayFirmwareCharacteristics()

VOID DisplayFirmwareCharacteristics ( IN UINT16  Chara,
IN UINT8  Option 
)

Display Firmware Characteristics (Type 45) details.

Parameters
[in]CharaThe information bits.
[in]OptionThe optional information.

Definition at line 5251 of file QueryTable.c.

◆ DisplayFirmwareState()

VOID DisplayFirmwareState ( IN UINT8  Key,
IN UINT8  Option 
)

Display Firmware state (Type 45) details.

Parameters
[in]KeyThe key of the structure.
[in]OptionThe optional information.

Definition at line 5268 of file QueryTable.c.

◆ DisplayHardwareSecuritySettings()

VOID DisplayHardwareSecuritySettings ( IN UINT8  Settings,
IN UINT8  Option 
)

Display Hardware Security (Type 24) information.

Routine Description: Identifies the password and reset status for the system:

Bits 7:6 Power-on Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 5:4 Keyboard Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 3:2 Administrator Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 1:0 Front Panel Reset Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown

Parameters
[in]SettingsThe device settings.
[in]OptionThe device options.

Display Hardware Security (Type 24) information.

Identifies the password and reset status for the system:

Bits 7:6 Power-on Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 5:4 Keyboard Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 3:2 Administrator Password Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown Bits 1:0 Front Panel Reset Status, one of: 00b Disabled 01b Enabled 10b Not Implemented 11b Unknown

Parameters
[in]SettingsThe device settings.
[in]OptionThe device options.

Definition at line 3457 of file PrintInfo.c.

◆ DisplayMaxMemoryModuleSize()

VOID DisplayMaxMemoryModuleSize ( IN UINT8  Size,
IN UINT8  SlotNum,
IN UINT8  Option 
)

Display information about Memory Controller Information (Type 5).

Parameters
[in]SizeMemory size.
[in]SlotNumWhich slot is this about.
[in]OptionOption for the level of detail output required.

Definition at line 2896 of file PrintInfo.c.

◆ DisplayMemoryModuleConfigHandles()

VOID DisplayMemoryModuleConfigHandles ( IN UINT16 *  Handles,
IN UINT8  SlotNum,
IN UINT8  Option 
)

Display information about memory configuration handles.

Parameters
[in]HandlesThe buffer of handles to output info on.
[in]SlotNumThe number of handles in the above buffer.
[in]OptionOption for the level of detail output required.

Definition at line 2925 of file PrintInfo.c.

◆ DisplayMmBankConnections()

VOID DisplayMmBankConnections ( IN UINT8  BankConnections,
IN UINT8  Option 
)

Display Memory Module Information (Type 6).

Parameters
[in]BankConnections
[in]Option

Definition at line 2957 of file PrintInfo.c.

◆ DisplayMmMemorySize()

VOID DisplayMmMemorySize ( IN UINT8  Size,
IN UINT8  Option 
)

Display memory informcation.

Bits 0:6 Size (n), where 2**n is the size in MB with three special-case values: 7Dh Not determinable (Installed Size only) 7Eh Module is installed, but no memory has been enabled 7Fh Not installed Bit 7 Defines whether the memory module has a single- (0) or double-bank (1) connection.

Parameters
[in]Size- The size
[in]Option- The option

Definition at line 3006 of file PrintInfo.c.

◆ DisplayOBRAConnections()

VOID DisplayOBRAConnections ( IN UINT8  Connections,
IN UINT8  Option 
)

Display Out-of-Band Remote Access (Type 30) information.

Parameters
[in]ConnectionsThe device characteristics.
[in]OptionThe device options.

Definition at line 3567 of file PrintInfo.c.

◆ DisplayProcessorArchitectureType()

VOID DisplayProcessorArchitectureType ( IN UINT8  Key,
IN UINT8  Option 
)

Display Processor Architecture Type (Type 44).

Parameters
[in]KeyThe key of the structure.
[in]OptionThe optional information.

Definition at line 5234 of file QueryTable.c.

◆ DisplayProcessorFamily()

VOID DisplayProcessorFamily ( UINT8  Family,
UINT8  Option 
)

Display Processor Information (Type 4) information.

Parameters
[in]FamilyThe family value.
[in]OptionThe option value.

Definition at line 1728 of file PrintInfo.c.

◆ DisplayProcessorFamily2()

VOID DisplayProcessorFamily2 ( IN UINT16  Family2,
IN UINT8  Option 
)

Display processor family information.

Parameters
[in]Family2The family value.
[in]OptionThe option value.

Definition at line 2558 of file PrintInfo.c.

◆ DisplayProcessorStatus()

VOID DisplayProcessorStatus ( IN UINT8  Status,
IN UINT8  Option 
)

Display processor information.

Parameters
[in]StatusThe status. Bit 7 Reserved, must be 0 Bit 6 CPU Socket Populated 1 - CPU Socket Populated 0 - CPU Socket Unpopulated Bits 5:3 Reserved, must be zero Bits 2:0 CPU Status 0h - Unknown 1h - CPU Enabled 2h - CPU Disabled by User via BIOS Setup 3h - CPU Disabled By BIOS (POST Error) 4h - CPU is Idle, waiting to be enabled. 5-6h - Reserved 7h - Other
[in]OptionThe option

Definition at line 2828 of file PrintInfo.c.

◆ DisplayProcessorVoltage()

VOID DisplayProcessorVoltage ( IN UINT8  Voltage,
IN UINT8  Option 
)

Display processor voltage information.

Parameters
[in]VoltageThe Voltage. Bit 7 Set to 0, indicating 'legacy' mode for processor voltage Bits 6:4 Reserved, must be zero Bits 3:0 Voltage Capability. A Set bit indicates that the voltage is supported. Bit 0 - 5V Bit 1 - 3.3V Bit 2 - 2.9V Bit 3 - Reserved, must be zero.

Note: Setting of multiple bits indicates the socket is configurable If bit 7 is set to 1, the remaining seven bits of the field are set to contain the processor's current voltage times 10. For example, the field value for a processor voltage of 1.8 volts would be 92h = 80h + (1.8 * 10) = 80h + 18 = 80h +12h.

Parameters
[in]OptionThe option.

Definition at line 2760 of file PrintInfo.c.

◆ DisplaySBDSManufactureDate()

VOID DisplaySBDSManufactureDate ( IN UINT16  Date,
IN UINT8  Option 
)

Display Portable Battery (Type 22) information.

The date the cell pack was manufactured, in packed format: Bits 15:9 Year, biased by 1980, in the range 0 to 127. Bits 8:5 Month, in the range 1 to 12. Bits 4:0 Date, in the range 1 to 31. For example, 01 February 2000 would be identified as 0010 1000 0100 0001b (0x2841).

Parameters
[in]DateThe date
[in]OptionThe option

Definition at line 3298 of file PrintInfo.c.

◆ DisplaySPSCharacteristics()

VOID DisplaySPSCharacteristics ( IN UINT16  Characteristics,
IN UINT8  Option 
)

Display System Power Supply (Type 39) information.

Parameters
[in]CharacteristicsThe device characteristics.
[in]OptionThe device options.

Definition at line 3608 of file PrintInfo.c.

◆ DisplaySystemBootStatus()

VOID DisplaySystemBootStatus ( IN UINT8  Parameter,
IN UINT8  Option 
)

Display System Boot Information (Type 32) information.

Parameters
[in]ParameterThe parameter.
[in]OptionThe options.

Definition at line 3241 of file PrintInfo.c.

◆ DisplaySystemResetCapabilities()

VOID DisplaySystemResetCapabilities ( IN UINT8  Reset,
IN UINT8  Option 
)

Display System Reset (Type 23) information.

Routine Description: Identifies the system-reset capabilities for the system. Bits 7:6 Reserved for future assignment via this specification, set to 00b. Bit 5 System contains a watchdog timer, either True (1) or False (0). Bits 4:3 Boot Option on Limit. Identifies the system action to be taken when the Reset Limit is reached, one of: 00b Reserved, do not use. 01b Operating system 10b System utilities 11b Do not rebootBits 2:1 Boot Option. Indicates the action to be taken following a watchdog reset, one of: 00b Reserved, do not use. 01b Operating system 10b System utilities 11b Do not reboot Bit 0 Status. 1b The system reset is enabled by the user 0b The system reset is not enabled by the user

Parameters
[in]ResetReset
[in]OptionThe option

Display System Reset (Type 23) information.

Identifies the system-reset capabilities for the system. Bits 7:6 Reserved for future assignment via this specification, set to 00b. Bit 5 System contains a watchdog timer, either True (1) or False (0). Bits 4:3 Boot Option on Limit. Identifies the system action to be taken when the Reset Limit is reached, one of: 00b Reserved, do not use. 01b Operating system 10b System utilities 11b Do not rebootBits 2:1 Boot Option. Indicates the action to be taken following a watchdog reset, one of: 00b Reserved, do not use. 01b Operating system 10b System utilities 11b Do not reboot Bit 0 Status. 1b The system reset is enabled by the user 0b The system reset is not enabled by the user

Parameters
[in]ResetReset
[in]OptionThe option

Definition at line 3344 of file PrintInfo.c.

◆ DisplaySystemSlotId()

VOID DisplaySystemSlotId ( IN UINT16  SlotId,
IN UINT8  SlotType,
IN UINT8  Option 
)

The Slot ID field of the System Slot structure provides a mechanism to correlate the physical attributes of the slot to its logical access method (which varies based on the Slot Type field).

Parameters
[in]SlotId- The slot ID
[in]SlotType- The slot type
[in]Option- The Option

Definition at line 3166 of file PrintInfo.c.

◆ DisplayTpmDeviceCharacteristics()

VOID DisplayTpmDeviceCharacteristics ( IN UINT64  Chara,
IN UINT8  Option 
)

Display TPM Device (Type 43) Characteristics.

Parameters
[in]CharaThe information bits.
[in]OptionThe optional information.

Definition at line 3767 of file PrintInfo.c.

◆ Smbios64BitPrintEPSInfo()

VOID Smbios64BitPrintEPSInfo ( IN SMBIOS_TABLE_3_0_ENTRY_POINT SmbiosTable,
IN UINT8  Option 
)

Print the info of 64-bit EPS(Entry Point Structure).

Parameters
[in]SmbiosTablePointer to the SMBIOS table entry point.
[in]OptionDisplay option.

Definition at line 220 of file PrintInfo.c.

◆ SmbiosPrintEPSInfo()

VOID SmbiosPrintEPSInfo ( IN SMBIOS_TABLE_ENTRY_POINT SmbiosTable,
IN UINT8  Option 
)

Print the info of EPS(Entry Point Structure).

Parameters
[in]SmbiosTablePointer to the SMBIOS table entry point.
[in]OptionDisplay option.

Definition at line 135 of file PrintInfo.c.

◆ SmbiosPrintStructure()

EFI_STATUS SmbiosPrintStructure ( IN SMBIOS_STRUCTURE_POINTER Struct,
IN UINT8  Option 
)

This function print the content of the structure pointed by Struct.

Parameters
[in]StructPoint to the structure to be printed.
[in]OptionPrint option of information detail.
Return values
EFI_SUCCESSSuccessfully Printing this function.
EFI_INVALID_PARAMETERInvalid Structure.
EFI_UNSUPPORTEDUnsupported.

Definition at line 305 of file PrintInfo.c.

Variable Documentation

◆ SmbiosMajorVersion

UINT8 SmbiosMajorVersion
extern

Definition at line 21 of file SmbiosView.c.

◆ SmbiosMinorVersion

UINT8 SmbiosMinorVersion
extern

Definition at line 22 of file SmbiosView.c.