System Management BIOS. More...

#include <stdint.h>
#include <ipxe/api.h>
#include <config/general.h>
#include <ipxe/null_smbios.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_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 an SMBIOS API implementation.
#define	SMBIOS_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '_' << 24 ) )
	Signature for 32-bit SMBIOS entry point.
#define	SMBIOS3_SIGNATURE ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '3' << 24 ) )
	Signature for 64-bit SMBIOS entry point.
#define	SMBIOS_TYPE_SYSTEM_INFORMATION 1
	SMBIOS system information structure type.
#define	SMBIOS_TYPE_BASE_BOARD_INFORMATION 2
	SMBIOS base board information structure type.
#define	SMBIOS_TYPE_ENCLOSURE_INFORMATION 3
	SMBIOS enclosure information structure type.
#define	SMBIOS_TYPE_OEM_STRINGS 11
	SMBIOS OEM strings structure type.
#define	SMBIOS_TYPE_END 127
	SMBIOS end of table type.
#define	SMBIOS_VERSION(major, minor)
	Calculate SMBIOS version.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
struct smbios_entry	__attribute__ ((packed))
int	find_smbios (struct smbios *smbios)
const struct smbios_entry *	find_smbios_entry (const void *start, size_t len)
	Scan for SMBIOS 32-bit entry point structure.
const struct smbios3_entry *	find_smbios3_entry (const void *start, size_t len)
	Scan for SMBIOS 64-bit entry point structure.
const struct smbios_header *	smbios_structure (unsigned int type, unsigned int instance)
	Find specific structure type within SMBIOS.
const char *	smbios_string (const struct smbios_header *header, unsigned int index)
	Get indexed string within SMBIOS structure.
int	smbios_version (void)
	Get SMBIOS version.
void	smbios_clear (void)
	Clear SMBIOS entry point descriptor.

Variables
uint32_t	signature
	Signature.
uint8_t	checksum
	Checksum.
uint8_t	len
	Length.
uint8_t	major
	Major version.
uint8_t	minor
	Minor version.
uint16_t	max
	Maximum structure size.
uint8_t	revision
	Entry point revision.
uint8_t	formatted [5]
	Formatted area.
uint8_t	dmi_signature [5]
	DMI Signature.
uint8_t	dmi_checksum
	DMI checksum.
uint16_t	smbios_len
	Structure table length.
uint32_t	smbios_address
	Structure table address.
uint16_t	smbios_count
	Number of SMBIOS structures.
uint8_t	bcd_revision
	BCD revision.
uint8_t	extra
	Signature extra byte.
uint8_t	docrev
	Documentation revision.
uint8_t	reserved
	Reserved.
uint8_t	type
	Type.
uint16_t	handle
	Handle.
struct smbios_header	header
	SMBIOS structure header.
uint8_t	manufacturer
	Manufacturer string.
uint8_t	product
	Product string.
uint8_t	version
	Version string.
uint8_t	serial
	Serial number string.
uint8_t	uuid [16]
	UUID.
uint8_t	wakeup
	Wake-up type.
uint8_t	asset_tag
	Asset tag.
struct smbios	__attribute__

Detailed Description

System Management BIOS.

Definition in file smbios.h.

Macro Definition Documentation

◆ PROVIDE_SMBIOS

#define PROVIDE_SMBIOS	(	_subsys,
		_api_func,
		_func )

Value:

PROVIDE_SINGLE_API ( SMBIOS_PREFIX_ ## _subsys, _api_func, _func )

PROVIDE_SINGLE_API

#define PROVIDE_SINGLE_API(_prefix, _api_func, _func)

Provide an API implementation.

Definition api.h:55

Provide an SMBIOS API implementation.

Parameters

_prefix	Subsystem prefix
_api_func	API function
_func	Implementing function

Definition at line 24 of file smbios.h.

24#define PROVIDE_SMBIOS( _subsys, _api_func, _func ) \

25 PROVIDE_SINGLE_API ( SMBIOS_PREFIX_ ## _subsys, _api_func, _func )

◆ SMBIOS_SIGNATURE

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

Signature for 32-bit SMBIOS entry point.

Definition at line 36 of file smbios.h.

36#define SMBIOS_SIGNATURE \

37 ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '_' << 24 ) )

Referenced by efi_find_smbios(), and find_smbios_entry().

◆ SMBIOS3_SIGNATURE

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

Signature for 64-bit SMBIOS entry point.

Definition at line 40 of file smbios.h.

40#define SMBIOS3_SIGNATURE \

41 ( ( '_' << 0 ) + ( 'S' << 8 ) + ( 'M' << 16 ) + ( '3' << 24 ) )

Referenced by efi_find_smbios(), and find_smbios3_entry().

◆ SMBIOS_TYPE_SYSTEM_INFORMATION

#define SMBIOS_TYPE_SYSTEM_INFORMATION 1

SMBIOS system information structure type.

Definition at line 148 of file smbios.h.

Referenced by __setting(), __setting(), __setting(), __setting(), and smsc95xx_vm3_fetch_mac().

◆ SMBIOS_TYPE_BASE_BOARD_INFORMATION

#define SMBIOS_TYPE_BASE_BOARD_INFORMATION 2

SMBIOS base board information structure type.

Definition at line 165 of file smbios.h.

Referenced by __setting().

◆ SMBIOS_TYPE_ENCLOSURE_INFORMATION

#define SMBIOS_TYPE_ENCLOSURE_INFORMATION 3

SMBIOS enclosure information structure type.

Definition at line 184 of file smbios.h.

Referenced by __setting().

◆ SMBIOS_TYPE_OEM_STRINGS

#define SMBIOS_TYPE_OEM_STRINGS 11

SMBIOS OEM strings structure type.

Definition at line 187 of file smbios.h.

Referenced by smsc95xx_vm3_fetch_mac().

◆ SMBIOS_TYPE_END

#define SMBIOS_TYPE_END 127

SMBIOS end of table type.

Definition at line 190 of file smbios.h.

Referenced by smbios_structure().

◆ SMBIOS_VERSION

#define SMBIOS_VERSION	(		major,
			minor )

Value:

( ( (major) << 8 ) | (minor) )

major

uint32_t major

Major version.

Definition netvsc.h:3

minor

uint32_t minor

Minor version.

Definition netvsc.h:5

Calculate SMBIOS version.

Parameters

major	Major version
minor	Minor version

Return values

version SMBIOS version

Definition at line 216 of file smbios.h.

Referenced by bios_find_smbios2(), bios_find_smbios3(), efi_find_smbios(), and smbios_fetch().

Function Documentation

◆ FILE_LICENCE()

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL )

◆ FILE_SECBOOT()

FILE_SECBOOT ( PERMITTED )

◆ attribute()

struct smbios_entry __attribute__ ( (packed) )

◆ find_smbios()

int find_smbios ( struct smbios * smbios )

extern

References header, index, len, start, and type.

Referenced by PROVIDE_SMBIOS(), PROVIDE_SMBIOS(), PROVIDE_SMBIOS(), smbios_structure(), and smbios_version().

◆ find_smbios_entry()

const struct smbios_entry * find_smbios_entry	(	const void *	start,
		size_t	len )

extern

Scan for SMBIOS 32-bit entry point structure.

Parameters

start	Start address of region to scan
len	Length of region to scan

Return values

entry SMBIOS entry point structure, or NULL if not found

Definition at line 70 of file smbios.c.

                                                             {
        static size_t offset = 0; /* Avoid repeated attempts to locate SMBIOS */
        const struct smbios_entry *entry;
        uint8_t sum;
 
        /* Try to find SMBIOS */
        for ( ; ( offset + sizeof ( *entry ) ) <= len ; offset += 0x10 ) {
 
                /* Verify signature */
                entry = ( start + offset );
                if ( entry->signature != SMBIOS_SIGNATURE )
                        continue;
 
                /* Verify length */
                if ( ( entry->len < sizeof ( *entry ) ) ||
                     ( ( offset + entry->len ) > len ) ) {
                        DBGC ( &smbios, "SMBIOS at %#08lx has bad length "
                               "%#02x\n", virt_to_phys ( entry ), entry->len );
                        continue;
                }
 
                /* Verify checksum */
                if ( ( sum = smbios_checksum ( entry, entry->len ) ) != 0 ) {
                        DBGC ( &smbios, "SMBIOS at %#08lx has bad checksum "
                               "%#02x\n", virt_to_phys ( entry ), sum );
                        continue;
                }
 
                /* Fill result structure */
                DBGC ( &smbios, "Found SMBIOS v%d.%d entry point at %#08lx\n",
                       entry->major, entry->minor, virt_to_phys ( entry ) );
                return entry;
        }
 
        DBGC ( &smbios, "No SMBIOS found\n" );
        return NULL;
}

References DBGC, len, smbios_entry::len, smbios_entry::major, smbios_entry::minor, NULL, offset, smbios_entry::signature, smbios_checksum(), SMBIOS_SIGNATURE, and start.

Referenced by bios_find_smbios2().

◆ find_smbios3_entry()

const struct smbios3_entry * find_smbios3_entry	(	const void *	start,
		size_t	len )

extern

Scan for SMBIOS 64-bit entry point structure.

Parameters

start	Start address of region to scan
len	Length of region to scan

Return values

entry SMBIOS entry point structure, or NULL if not found

Definition at line 116 of file smbios.c.

                                                               {
        static size_t offset = 0; /* Avoid repeated attempts to locate SMBIOS */
        const struct smbios3_entry *entry;
        uint8_t sum;
 
        /* Try to find SMBIOS */
        for ( ; ( offset + sizeof ( *entry ) ) <= len ; offset += 0x10 ) {
 
                /* Verify signature */
                entry = ( start + offset );
                if ( entry->signature != SMBIOS3_SIGNATURE )
                        continue;
 
                /* Verify length */
                if ( ( entry->len < sizeof ( *entry ) ) ||
                     ( ( offset + entry->len ) > len ) ) {
                        DBGC ( &smbios, "SMBIOS at %#08lx has bad length "
                               "%#02x\n", virt_to_phys ( entry ), entry->len );
                        continue;
                }
 
                /* Verify checksum */
                if ( ( sum = smbios_checksum ( entry, entry->len ) ) != 0 ) {
                        DBGC ( &smbios, "SMBIOS3 at %#08lx has bad checksum "
                               "%#02x\n", virt_to_phys ( entry ), sum );
                        continue;
                }
 
                /* Fill result structure */
                DBGC ( &smbios, "Found SMBIOS3 v%d.%d entry point at %#08lx\n",
                       entry->major, entry->minor, virt_to_phys ( entry ) );
                return entry;
        }
 
        DBGC ( &smbios, "No SMBIOS3 found\n" );
        return NULL;
}

References DBGC, len, smbios3_entry::len, smbios3_entry::major, smbios3_entry::minor, NULL, offset, smbios3_entry::signature, SMBIOS3_SIGNATURE, smbios_checksum(), and start.

Referenced by bios_find_smbios3().

◆ smbios_structure()

const struct smbios_header * smbios_structure	(	unsigned int	type,
		unsigned int	instance )

extern

Find specific structure type within SMBIOS.

Parameters

type	Structure type to search for
instance	Instance of this type of structure

Return values

structure SMBIOS structure header, or NULL if not found

Definition at line 183 of file smbios.c.

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

References smbios::address, assert, count, smbios::count, DBGC, find_smbios(), find_strings_terminator(), smbios::len, smbios_header::len, NULL, offset, rc, SMBIOS_TYPE_END, smbios_header::type, and type.

Referenced by smbios_fetch(), and smsc95xx_vm3_fetch_mac().

◆ smbios_string()

const char * smbios_string	(	const struct smbios_header *	structure,
		unsigned int	index )

extern

Get indexed string within SMBIOS structure.

Parameters

structure	SMBIOS structure header
index	String index

Return values

string SMBIOS string, or NULL if not fond

Definition at line 252 of file smbios.c.

                                                  {
        const char *string;
        unsigned int i;
        size_t len;
 
        /* Sanity check */
        assert ( smbios.address != NULL );
 
        /* Step through strings */
        string = ( ( ( const void * ) structure ) + structure->len );
        for ( i = index ; i-- ; ) {
                /* Get string length.  This is known safe, since we
                 * check for the empty-string terminator in
                 * smbios_structure().
                 */
                len = strlen ( string );
                if ( ! len )
                        break;
                if ( i == 0 )
                        return string;
                string += ( len + 1 /* NUL */ );
        }
 
        DBGC ( &smbios, "SMBIOS string index %d not found\n", index );
        return NULL;
}

References smbios::address, assert, DBGC, index, len, smbios_header::len, NULL, string, and strlen().

Referenced by smbios_fetch(), and smsc95xx_vm3_fetch_mac().

◆ smbios_version()

int smbios_version ( void )

extern

Get SMBIOS version.

Return values

version Version, or negative error

Definition at line 285 of file smbios.c.

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

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

Referenced by smbios_fetch().

◆ smbios_clear()

void smbios_clear ( void )

extern

Clear SMBIOS entry point descriptor.

Definition at line 301 of file smbios.c.

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

References smbios::address, and NULL.

Variable Documentation

◆ signature

uint32_t signature

Signature.

Must be equal to SMBIOS_SIGNATURE

Must be equal to SMBIOS3_SIGNATURE

Definition at line 4 of file smbios.h.

◆ checksum

uint8_t checksum

Checksum.

Definition at line 6 of file smbios.h.

◆ len

uint8_t len

Length.

Definition at line 8 of file smbios.h.

◆ major

uint8_t major

Major version.

Definition at line 10 of file smbios.h.

◆ minor

uint8_t minor

Minor version.

Definition at line 12 of file smbios.h.

◆ max

uint16_t max

Maximum structure size.

Definition at line 14 of file smbios.h.

◆ revision

uint8_t revision

Entry point revision.

Definition at line 16 of file smbios.h.

◆ formatted

uint8_t formatted[5]

Formatted area.

Definition at line 18 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 20 of file smbios.h.

◆ dmi_checksum

uint8_t dmi_checksum

DMI checksum.

Definition at line 22 of file smbios.h.

◆ smbios_len

uint32_t smbios_len

Structure table length.

Definition at line 24 of file smbios.h.

◆ smbios_address

uint64_t smbios_address

Structure table address.

Definition at line 26 of file smbios.h.

◆ smbios_count

uint16_t smbios_count

Number of SMBIOS structures.

Definition at line 28 of file smbios.h.

◆ bcd_revision

uint8_t bcd_revision

BCD revision.

Definition at line 30 of file smbios.h.

◆ extra

uint8_t extra

Signature extra byte.

Definition at line 6 of file smbios.h.

Referenced by asn1_grow(), asn1_parse_gcm(), deflate_inflate(), and gzip_extract().

◆ docrev

uint8_t docrev

Documentation revision.

Definition at line 16 of file smbios.h.

◆ reserved

uint8_t reserved

Reserved.

Definition at line 20 of file smbios.h.

◆ type

uint8_t type

Type.

Type string.

Definition at line 1 of file smbios.h.

◆ handle

uint16_t handle

Handle.

Definition at line 5 of file smbios.h.

Referenced by chained_locate(), dbg_efi_opener(), dbg_efi_openers(), dbg_efi_protocol(), dbg_efi_protocols(), efi_autoexec_filesystem(), efi_autoexec_load(), efi_autoexec_network(), efi_block_boot(), efi_block_connect(), efi_block_filename(), efi_block_local(), efi_block_match(), efi_block_root(), efi_block_scan(), efi_close_by_child(), efi_close_by_driver(), efi_close_protocol_wrapper(), efi_close_unsafe(), efi_download_install(), efi_download_uninstall(), efi_driver_handles(), 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_by_child_untyped(), efi_open_by_driver_untyped(), efi_open_protocol_information_wrapper(), efi_open_protocol_wrapper(), efi_open_unsafe_untyped(), efi_open_untyped(), efi_protocols_per_handle_wrapper(), efi_pxe_find(), efi_pxe_install(), efi_pxe_uninstall(), efi_reinstall_protocol_interface_wrapper(), efi_service_add(), efi_service_del(), efi_shim_inhibit_pxe(), efi_shim_install(), efi_stack_cookie(), efi_uninstall_multiple_protocol_interfaces_wrapper(), efi_uninstall_protocol_interface_wrapper(), efi_veto_close(), efi_veto_close_handle(), efi_veto_close_protocol(), efi_veto_disconnect(), efi_wrap_image(), efipci_discover(), efipci_discover_any(), efipci_discover_one(), efipci_ioremap(), efipci_read(), efipci_root_open(), efipci_write(), FILE_SECBOOT(), find_snpdev(), mnptemp_create(), 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().

◆ header

struct smbios_header header

SMBIOS structure header.

Definition at line 1 of file smbios.h.

◆ manufacturer

uint8_t manufacturer

Manufacturer string.

Definition at line 3 of file smbios.h.

Referenced by __setting(), efi_veto(), efi_veto_dhcp6(), efi_veto_find(), efi_veto_hp_xhci(), efi_veto_ip4config(), efi_veto_vmware_uefipxebc(), and smsc95xx_vm3_fetch_mac().

◆ product

uint8_t product

Product string.

Definition at line 5 of file smbios.h.

Referenced by __setting(), aes_entry_column(), bigint_mod_exp_ladder(), bigint_mod_exp_raw(), x25519_multiply_step1::bigint_t(), x25519_multiply_step2::bigint_t(), ecdsa_alloc(), ecdsa_init_values(), ecdsa_invert(), ecdsa_sign_rs(), ecdsa_verify_rs(), isa_id_string(), smsc95xx_vm3_fetch_mac(), weierstrass_done_raw(), weierstrass_exec(), weierstrass_init_curve(), weierstrass_init_raw(), and x25519_invert_okx().

◆ version

uint8_t version

Version string.

Definition at line 7 of file smbios.h.

◆ serial

uint8_t serial

Serial number string.

Definition at line 9 of file smbios.h.

◆ uuid

uint8_t uuid[16]

UUID.

Definition at line 11 of file smbios.h.

◆ wakeup

uint8_t wakeup

Wake-up type.

Definition at line 13 of file smbios.h.

◆ asset_tag

uint8_t asset_tag

Asset tag.

Definition at line 11 of file smbios.h.

Referenced by __setting().

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()

◆ FILE_SECBOOT()

◆ __attribute__()

◆ find_smbios()

◆ find_smbios_entry()

◆ find_smbios3_entry()

◆ smbios_structure()

◆ 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

◆ header

◆ manufacturer

◆ product

◆ version

◆ serial

◆ uuid

◆ wakeup

◆ asset_tag

◆ attribute()