System Management BIOS. More...

#include <stdint.h>
#include <ipxe/api.h>
#include <config/general.h>
#include <ipxe/uaccess.h>
#include <ipxe/efi/efi_smbios.h>
#include <ipxe/linux/linux_smbios.h>
#include <bits/smbios.h>

Data Structures
struct	smbios_entry
	SMBIOS 32-bit entry point. More...

struct	smbios3_entry
	SMBIOS 64-bit entry point. More...

struct	smbios_header
	An SMBIOS structure header. More...

struct	smbios_structure
	SMBIOS structure descriptor. More...

struct	smbios_system_information
	SMBIOS system information structure. More...

struct	smbios_base_board_information
	SMBIOS base board information structure. More...

struct	smbios_enclosure_information
	SMBIOS enclosure information structure. More...

struct	smbios
	SMBIOS entry point descriptor. More...

Macros
#define	PROVIDE_SMBIOS(_subsys, _api_func, _func) PROVIDE_SINGLE_API ( SMBIOS_PREFIX_ ## _subsys, _api_func, _func )
	Provide an SMBIOS API implementation. More...

#define	SMBIOS_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '_' << 24 ) )
	Signature for 32-bit SMBIOS entry point. More...

#define	SMBIOS3_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '3' << 24 ) )
	Signature for 64-bit SMBIOS entry point. More...

#define	SMBIOS_TYPE_SYSTEM_INFORMATION 1
	SMBIOS system information structure type. More...

#define	SMBIOS_TYPE_BASE_BOARD_INFORMATION 2
	SMBIOS base board information structure type. More...

#define	SMBIOS_TYPE_ENCLOSURE_INFORMATION 3
	SMBIOS enclosure information structure type. More...

#define	SMBIOS_TYPE_OEM_STRINGS 11
	SMBIOS OEM strings structure type. More...

#define	SMBIOS_TYPE_END 127
	SMBIOS end of table type. More...

#define	SMBIOS_VERSION(major, minor) ( ( (major) << 8 ) \| (minor) )
	Calculate SMBIOS version. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)

struct smbios_entry	__attribute__ ((packed))

int	find_smbios (struct smbios *smbios)

int	find_smbios_entry (userptr_t start, size_t len, struct smbios_entry *entry)
	Scan for SMBIOS entry point structure. More...

int	find_smbios_structure (unsigned int type, unsigned int instance, struct smbios_structure *structure)
	Find specific structure type within SMBIOS. More...

int	read_smbios_structure (struct smbios_structure structure, void data, size_t len)
	Copy SMBIOS structure. More...

int	read_smbios_string (struct smbios_structure structure, unsigned int index, void data, size_t len)
	Find indexed string within SMBIOS structure. More...

int	smbios_version (void)
	Get SMBIOS version. More...

void	smbios_clear (void)
	Clear SMBIOS entry point descriptor. More...

Variables
uint32_t	signature
	Signature. More...

uint8_t	checksum
	Checksum. More...

uint8_t	len
	Length. More...

uint8_t	major
	Major version. More...

uint8_t	minor
	Minor version. More...

uint16_t	max
	Maximum structure size. More...

uint8_t	revision
	Entry point revision. More...

uint8_t	formatted [5]
	Formatted area. More...

uint8_t	dmi_signature [5]
	DMI Signature. More...

uint8_t	dmi_checksum
	DMI checksum. More...

uint16_t	smbios_len
	Structure table length. More...

uint32_t	smbios_address
	Structure table address. More...

uint16_t	smbios_count
	Number of SMBIOS structures. More...

uint8_t	bcd_revision
	BCD revision. More...

uint8_t	extra
	Signature extra byte. More...

uint8_t	docrev
	Documentation revision. More...

uint8_t	reserved
	Reserved. More...

uint8_t	type
	Type. More...

uint16_t	handle
	Handle. More...

struct smbios_structure	__attribute__

struct smbios_header	header
	SMBIOS structure header. More...

uint8_t	manufacturer
	Manufacturer string. More...

uint8_t	product
	Product string. More...

uint8_t	version
	Version string. More...

uint8_t	serial
	Serial number string. More...

uint8_t	uuid [16]
	UUID. More...

uint8_t	wakeup
	Wake-up type. More...

uint8_t	asset_tag
	Asset tag. More...

Detailed Description

System Management BIOS.

Definition in file smbios.h.

Macro Definition Documentation

◆ PROVIDE_SMBIOS

#define PROVIDE_SMBIOS	(	_subsys,
		_api_func,
		_func
	)	PROVIDE_SINGLE_API ( SMBIOS_PREFIX_ ## _subsys, _api_func, _func )

Provide an SMBIOS API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function
_func	Implementing function

Definition at line 24 of file smbios.h.

◆ SMBIOS_SIGNATURE

#define SMBIOS_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '_' << 24 ) )

Signature for 32-bit SMBIOS entry point.

Definition at line 35 of file smbios.h.

◆ SMBIOS3_SIGNATURE

#define SMBIOS3_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '3' << 24 ) )

Signature for 64-bit SMBIOS entry point.

Definition at line 39 of file smbios.h.

◆ SMBIOS_TYPE_SYSTEM_INFORMATION

#define SMBIOS_TYPE_SYSTEM_INFORMATION 1

SMBIOS system information structure type.

Definition at line 157 of file smbios.h.

◆ SMBIOS_TYPE_BASE_BOARD_INFORMATION

#define SMBIOS_TYPE_BASE_BOARD_INFORMATION 2

SMBIOS base board information structure type.

Definition at line 174 of file smbios.h.

◆ SMBIOS_TYPE_ENCLOSURE_INFORMATION

#define SMBIOS_TYPE_ENCLOSURE_INFORMATION 3

SMBIOS enclosure information structure type.

Definition at line 193 of file smbios.h.

◆ SMBIOS_TYPE_OEM_STRINGS

#define SMBIOS_TYPE_OEM_STRINGS 11

SMBIOS OEM strings structure type.

Definition at line 196 of file smbios.h.

◆ SMBIOS_TYPE_END

#define SMBIOS_TYPE_END 127

SMBIOS end of table type.

Definition at line 199 of file smbios.h.

◆ SMBIOS_VERSION

#define SMBIOS_VERSION	(	major,
		minor
	)	( ( (major) << 8 ) \| (minor) )

Calculate SMBIOS version.

Parameters

major	Major version
minor	Minor version

Return values

version SMBIOS version

Definition at line 225 of file smbios.h.

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ attribute()

struct smbios_entry __attribute__ ( (packed) )

◆ find_smbios()

int find_smbios ( struct smbios * smbios )

Referenced by find_smbios_structure(), and smbios_version().

◆ find_smbios_entry()

int find_smbios_entry	(	userptr_t	start,
		size_t	len,
		struct smbios_entry *	entry
	)

Scan for SMBIOS entry point structure.

Parameters

start	Start address of region to scan
len	Length of region to scan
entry	SMBIOS entry point structure to fill in

Return values

rc	Return status code

Definition at line 52 of file smbios.c.

                                                      {
         uint8_t buf[256]; /* 256 is maximum length possible */
         static size_t offset = 0; /* Avoid repeated attempts to locate SMBIOS */
         size_t entry_len;
         unsigned int i;
         uint8_t sum;
 
         /* Try to find SMBIOS */
         for ( ; offset < len ; offset += 0x10 ) {
 
                 /* Read start of header and verify signature */
                 copy_from_user ( entry, start, offset, sizeof ( *entry ) );
                 if ( entry->signature != SMBIOS_SIGNATURE )
                         continue;
 
                 /* Read whole header and verify checksum */
                 entry_len = entry->len;
                 assert ( entry_len <= sizeof ( buf ) );
                 copy_from_user ( buf, start, offset, entry_len );
                 for ( i = 0, sum = 0 ; i < entry_len ; i++ ) {
                         sum += buf[i];
                 }
                 if ( sum != 0 ) {
                         DBG ( "SMBIOS at %08lx has bad checksum %02x\n",
                               user_to_phys ( start, offset ), sum );
                         continue;
                 }
 
                 /* Fill result structure */
                 DBG ( "Found SMBIOS v%d.%d entry point at %08lx\n",
                       entry->major, entry->minor,
                       user_to_phys ( start, offset ) );
                 return 0;
         }
 
         DBG ( "No SMBIOS found\n" );
         return -ENODEV;
 }

References assert(), copy_from_user(), DBG, ENODEV, entry, len, offset, SMBIOS_SIGNATURE, start, and user_to_phys().

Referenced by bios_find_smbios().

◆ find_smbios_structure()

int find_smbios_structure	(	unsigned int	type,
		unsigned int	instance,
		struct smbios_structure *	structure
	)

Find specific structure type within SMBIOS.

Parameters

type	Structure type to search for
instance	Instance of this type of structure
structure	SMBIOS structure descriptor to fill in

Return values

rc	Return status code

Definition at line 118 of file smbios.c.

                                                                  {
         unsigned int count = 0;
         size_t offset = 0;
         size_t strings_offset;
         size_t terminator_offset;
         int rc;
 
         /* Find SMBIOS */
         if ( ( smbios.address == UNULL ) &&
              ( ( rc = find_smbios ( &smbios ) ) != 0 ) )
                 return rc;
         assert ( smbios.address != UNULL );
 
         /* Scan through list of structures */
         while ( ( ( offset + sizeof ( structure->header ) ) < smbios.len ) &&
                 ( ( smbios.count == 0 ) || ( count < smbios.count ) ) ) {
 
                 /* Read next SMBIOS structure header */
                 copy_from_user ( &structure->header, smbios.address, offset,
                                  sizeof ( structure->header ) );
 
                 /* Determine start and extent of strings block */
                 strings_offset = ( offset + structure->header.len );
                 if ( strings_offset > smbios.len ) {
                         DBG ( "SMBIOS structure at offset %zx with length "
                               "%x extends beyond SMBIOS\n", offset,
                               structure->header.len );
                         return -ENOENT;
                 }
                 terminator_offset = find_strings_terminator ( strings_offset );
                 if ( ! terminator_offset ) {
                         DBG ( "SMBIOS structure at offset %zx has "
                               "unterminated strings section\n", offset );
                         return -ENOENT;
                 }
                 structure->strings_len = ( terminator_offset - strings_offset);
 
                 DBG ( "SMBIOS structure at offset %zx has type %d, length %x, "
                       "strings length %zx\n", offset, structure->header.type,
                       structure->header.len, structure->strings_len );
 
                 /* Stop if we have reached an end-of-table marker */
                 if ( ( smbios.count == 0 ) &&
                      ( structure->header.type == SMBIOS_TYPE_END ) )
                         break;
 
                 /* If this is the structure we want, return */
                 if ( ( structure->header.type == type ) &&
                      ( instance-- == 0 ) ) {
                         structure->offset = offset;
                         return 0;
                 }
 
                 /* Move to next SMBIOS structure */
                 offset = ( terminator_offset + 1 );
                 count++;
         }
 
         DBG ( "SMBIOS structure type %d not found\n", type );
         return -ENOENT;
 }

References smbios::address, assert(), copy_from_user(), count, smbios::count, DBG, ENOENT, find_smbios(), find_strings_terminator(), smbios_structure::header, smbios_header::len, smbios::len, smbios_structure::offset, offset, rc, SMBIOS_TYPE_END, smbios_structure::strings_len, type, smbios_header::type, and UNULL.

Referenced by smbios_fetch(), and smsc95xx_vm3_fetch_mac().

◆ read_smbios_structure()

int read_smbios_structure	(	struct smbios_structure *	structure,
		void *	data,
		size_t	len
	)

Copy SMBIOS structure.

Parameters

structure	SMBIOS structure descriptor
data	Buffer to hold SMBIOS structure
len	Length of buffer

Return values

rc	Return status code

Definition at line 189 of file smbios.c.

                                                      {
 
         assert ( smbios.address != UNULL );
 
         if ( len > structure->header.len )
                 len = structure->header.len;
         copy_from_user ( data, smbios.address, structure->offset, len );
         return 0;
 }

References smbios::address, assert(), copy_from_user(), data, smbios_structure::header, len, smbios_header::len, smbios_structure::offset, and UNULL.

Referenced by smbios_fetch(), and smsc95xx_vm3_fetch_mac().

◆ read_smbios_string()

int read_smbios_string	(	struct smbios_structure *	structure,
		unsigned int	index,
		void *	data,
		size_t	len
	)

Find indexed string within SMBIOS structure.

Parameters

structure	SMBIOS structure descriptor
index	String index
data	Buffer for string
len	Length of string buffer

Return values

rc	Length of string, or negative error

Definition at line 209 of file smbios.c.

                                                                       {
         size_t strings_start = ( structure->offset + structure->header.len );
         size_t strings_end = ( strings_start + structure->strings_len );
         size_t offset;
         size_t string_len;
 
         assert ( smbios.address != UNULL );
 
         /* String numbers start at 1 (0 is used to indicate "no string") */
         if ( ! index )
                 return -ENOENT;
 
         for ( offset = strings_start ; offset < strings_end ;
               offset += ( string_len + 1 ) ) {
                 /* Get string length.  This is known safe, since the
                  * smbios_strings struct is constructed so as to
                  * always end on a string boundary.
                  */
                 string_len = strlen_user ( smbios.address, offset );
                 if ( --index == 0 ) {
                         /* Copy string, truncating as necessary. */
                         if ( len > string_len )
                                 len = string_len;
                         copy_from_user ( data, smbios.address, offset, len );
                         return string_len;
                 }
         }
 
         DBG ( "SMBIOS string index %d not found\n", index );
         return -ENOENT;
 }

References smbios::address, assert(), copy_from_user(), data, DBG, ENOENT, smbios_structure::header, index, len, smbios_header::len, smbios_structure::offset, offset, smbios_structure::strings_len, strlen_user(), and UNULL.

Referenced by smbios_fetch(), and smsc95xx_vm3_fetch_mac().

◆ smbios_version()

int smbios_version ( void )

Get SMBIOS version.

Return values

version Version, or negative error

Definition at line 247 of file smbios.c.

                             {
         int rc;
 
         /* Find SMBIOS */
         if ( ( smbios.address == UNULL ) &&
              ( ( rc = find_smbios ( &smbios ) ) != 0 ) )
                 return rc;
         assert ( smbios.address != UNULL );
 
         return smbios.version;
 }

References smbios::address, assert(), find_smbios(), rc, UNULL, and smbios::version.

Referenced by smbios_fetch().

◆ smbios_clear()

void smbios_clear ( void )

Clear SMBIOS entry point descriptor.

Definition at line 263 of file smbios.c.

                            {
 
         /* Clear address */
         smbios.address = UNULL;
 }

References smbios::address, and UNULL.

Variable Documentation

◆ signature

uint32_t signature

Signature.

Must be equal to SMBIOS_SIGNATURE

Must be equal to SMBIOS3_SIGNATURE

Definition at line 15 of file smbios.h.

◆ checksum

uint8_t checksum

Checksum.

Definition at line 17 of file smbios.h.

◆ len

uint8_t len

Length.

Definition at line 19 of file smbios.h.

◆ major

uint8_t major

Major version.

Definition at line 21 of file smbios.h.

◆ minor

uint8_t minor

Minor version.

Definition at line 23 of file smbios.h.

◆ max

uint16_t max

Maximum structure size.

Definition at line 25 of file smbios.h.

◆ revision

uint8_t revision

Entry point revision.

Definition at line 27 of file smbios.h.

◆ formatted

uint8_t formatted[5]

Formatted area.

Definition at line 29 of file smbios.h.

Referenced by uri_churi_okx(), and uri_resolve_okx().

◆ dmi_signature

uint8_t dmi_signature[5]

DMI Signature.

Definition at line 31 of file smbios.h.

◆ dmi_checksum

uint8_t dmi_checksum

DMI checksum.

Definition at line 33 of file smbios.h.

◆ smbios_len

uint32_t smbios_len

Structure table length.

Definition at line 35 of file smbios.h.

◆ smbios_address

uint64_t smbios_address

Structure table address.

Definition at line 37 of file smbios.h.

◆ smbios_count

uint16_t smbios_count

Number of SMBIOS structures.

Definition at line 39 of file smbios.h.

◆ bcd_revision

uint8_t bcd_revision

BCD revision.

Definition at line 41 of file smbios.h.

◆ extra

uint8_t extra

Signature extra byte.

Definition at line 17 of file smbios.h.

Referenced by asn1_grow(), asn1_start(), deflate_inflate(), der_probe(), and gzip_extract().

◆ docrev

uint8_t docrev

Documentation revision.

Definition at line 27 of file smbios.h.

◆ reserved

uint8_t reserved

Reserved.

Definition at line 31 of file smbios.h.

◆ type

uint8_t type

Type.

Type string.

Definition at line 12 of file smbios.h.

◆ handle

uint16_t handle

Handle.

Definition at line 16 of file smbios.h.

Referenced by dbg_efi_opener(), dbg_efi_openers(), dbg_efi_protocols(), efi_block_boot_image(), efi_close_protocol_wrapper(), efi_download_install(), efi_download_uninstall(), efi_dump_image(), efi_file_install(), efi_file_path_claim(), efi_file_uninstall(), efi_handle_name(), efi_handle_protocol_wrapper(), efi_image_exec(), efi_image_probe(), efi_init_stack_guard(), efi_install_multiple_protocol_interfaces_wrapper(), efi_install_protocol_interface_wrapper(), efi_open_protocol_information_wrapper(), efi_open_protocol_wrapper(), efi_protocols_per_handle_wrapper(), efi_pxe_find(), efi_pxe_install(), efi_pxe_uninstall(), efi_reinstall_protocol_interface_wrapper(), efi_shim_exit_boot_services(), efi_shim_inhibit_pxe(), efi_shim_install(), efi_stack_cookie(), efi_uninstall_multiple_protocol_interfaces_wrapper(), efi_uninstall_protocol_interface_wrapper(), efi_veto_close_handle(), efi_veto_close_protocol(), efi_veto_disconnect(), efi_wrap(), efipci_ioremap(), efipci_read(), efipci_root_close(), efipci_root_match(), efipci_root_open(), efipci_write(), find_snpdev(), phantom_poll(), phantom_post_rds(), phantom_refill_rx_ring(), usbio_bulk_in_poll(), usbio_bulk_out_poll(), usbio_config(), usbio_control_poll(), usbio_endpoint_open(), usbio_interface(), usbio_interfaces(), usbio_interrupt_callback(), usbio_interrupt_open(), usbio_open(), usbio_path(), usbio_start(), usbio_stop(), and usbio_supported().

◆ attribute

struct smbios __attribute__

◆ header

struct smbios_header header

SMBIOS structure header.

Definition at line 12 of file smbios.h.

◆ manufacturer

uint8_t manufacturer

Manufacturer string.

Definition at line 14 of file smbios.h.

Referenced by efi_veto(), efi_veto_find(), efi_veto_hp_xhci(), and efi_veto_ip4config().

◆ product

uint8_t product

Product string.

Definition at line 16 of file smbios.h.

Referenced by __attribute__(), and isa_id_string().

◆ version

uint8_t version

Version string.

Definition at line 18 of file smbios.h.

◆ serial

uint8_t serial

Serial number string.

Definition at line 20 of file smbios.h.

◆ uuid

uint8_t uuid[16]

UUID.

Definition at line 22 of file smbios.h.

Referenced by format_uuid_setting(), peerdisc_create(), and smbios_fetch().

◆ wakeup

uint8_t wakeup

Wake-up type.

Definition at line 24 of file smbios.h.

◆ asset_tag

uint8_t asset_tag

Asset tag.

Definition at line 22 of file smbios.h.

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ PROVIDE_SMBIOS

◆ SMBIOS_SIGNATURE

◆ SMBIOS3_SIGNATURE

◆ SMBIOS_TYPE_SYSTEM_INFORMATION

◆ SMBIOS_TYPE_BASE_BOARD_INFORMATION

◆ SMBIOS_TYPE_ENCLOSURE_INFORMATION

◆ SMBIOS_TYPE_OEM_STRINGS

◆ SMBIOS_TYPE_END

◆ SMBIOS_VERSION

Function Documentation

◆ FILE_LICENCE()

◆ __attribute__()

◆ find_smbios()

◆ find_smbios_entry()

◆ find_smbios_structure()

◆ read_smbios_structure()

◆ read_smbios_string()

◆ smbios_version()

◆ smbios_clear()

Variable Documentation

◆ signature

◆ checksum

◆ len

◆ major

◆ minor

◆ max

◆ revision

◆ formatted

◆ dmi_signature

◆ dmi_checksum

◆ smbios_len

◆ smbios_address

◆ smbios_count

◆ bcd_revision

◆ extra

◆ docrev

◆ reserved

◆ type

◆ handle

◆ __attribute__

◆ header

◆ manufacturer

◆ product

◆ version

◆ serial

◆ uuid

◆ wakeup

◆ asset_tag

◆ attribute()

◆ attribute