smbios_settings.c File Reference

#include <stdint.h>
#include <string.h>
#include <errno.h>
#include <ipxe/settings.h>
#include <ipxe/init.h>
#include <ipxe/uuid.h>
#include <ipxe/smbios.h>

Go to the source code of this file.

Macros
#define	SMBIOS_RAW_TAG(_type, _structure, _field)
	Construct SMBIOS raw-data tag.
#define	SMBIOS_STRING_TAG(_type, _structure, _field)
	Construct SMBIOS string tag.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
static int	smbios_applies (struct settings *settings __unused, const struct setting *setting)
	Check applicability of SMBIOS setting.
static int	smbios_fetch (struct settings *settings, struct setting *setting, void *data, size_t len)
	Fetch value of SMBIOS setting.
static void	smbios_init (void)
	Initialise SMBIOS settings.
struct init_fn smbios_init_fn	__init_fn (INIT_NORMAL)
	SMBIOS settings initialiser.
const struct setting uuid_setting	__setting (SETTING_HOST, uuid)
	UUID setting obtained via SMBIOS.
const struct setting manufacturer_setting	__setting (SETTING_HOST_EXTRA, manufacturer)
	Manufacturer name setting.
const struct setting product_setting	__setting (SETTING_HOST_EXTRA, product)
	Product name setting.
const struct setting serial_setting	__setting (SETTING_HOST_EXTRA, serial)
	Serial number setting.
const struct setting asset_setting	__setting (SETTING_HOST_EXTRA, asset)
	Asset tag setting.
const struct setting board_serial_setting	__setting (SETTING_HOST_EXTRA, board-serial)
	Board serial number setting (may differ from chassis serial number)

Variables
static const struct settings_scope	smbios_settings_scope
	SMBIOS settings scope.
static struct settings_operations	smbios_settings_operations
	SMBIOS settings operations.
static struct settings	smbios_settings
	SMBIOS settings.

Macro Definition Documentation

SMBIOS_RAW_TAG

#define SMBIOS_RAW_TAG	(		_type,
			_structure,
			_field )

Value:

        ( ( (_type) << 16 ) |                                   \
          ( offsetof ( _structure, _field ) << 8 ) |            \
          ( sizeof ( ( ( _structure * ) 0 )->_field ) ) )

Construct SMBIOS raw-data tag.

Parameters

_type	SMBIOS structure type number
_structure	SMBIOS structure data type
_field	Field within SMBIOS structure data type

Return values

tag	SMBIOS setting tag

Definition at line 46 of file smbios_settings.c.

#define SMBIOS_RAW_TAG( _type, _structure, _field )             \
        ( ( (_type) << 16 ) |                                   \
          ( offsetof ( _structure, _field ) << 8 ) |            \
          ( sizeof ( ( ( _structure * ) 0 )->_field ) ) )

Referenced by __setting().

SMBIOS_STRING_TAG

#define SMBIOS_STRING_TAG	(		_type,
			_structure,
			_field )

Value:

        ( ( (_type) << 16 ) |                                   \
          ( offsetof ( _structure, _field ) << 8 ) )

Construct SMBIOS string tag.

Parameters

_type	SMBIOS structure type number
_structure	SMBIOS structure data type
_field	Field within SMBIOS structure data type

Return values

tag	SMBIOS setting tag

Definition at line 59 of file smbios_settings.c.

#define SMBIOS_STRING_TAG( _type, _structure, _field )          \
        ( ( (_type) << 16 ) |                                   \
          ( offsetof ( _structure, _field ) << 8 ) )

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

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

smbios_applies()

int smbios_applies ( struct settings *settings __unused, const struct setting * setting )

static

Check applicability of SMBIOS setting.

Parameters

settings	Settings block
setting	Setting

Return values

applies

Setting applies within this settings block

Definition at line 70 of file smbios_settings.c.

                                                            {
 
        return ( setting->scope == &smbios_settings_scope );
}

References __unused, setting::scope, and smbios_settings_scope.

smbios_fetch()

int smbios_fetch ( struct settings * settings, struct setting * setting, void * data, size_t len )

static

Fetch value of SMBIOS setting.

Parameters

settings	Settings block, or NULL to search all blocks
setting	Setting to fetch
data	Buffer to fill with setting data
len	Length of buffer

Return values

len	Length of setting data, or negative error

Definition at line 85 of file smbios_settings.c.

                                                   {
        const struct smbios_header *structure;
        unsigned int tag_instance;
        unsigned int tag_type;
        unsigned int tag_offset;
        unsigned int tag_len;
        const void *src;
        size_t src_len;
        unsigned int string;
        union uuid uuid;
 
        /* Split tag into instance, type, offset and length */
        tag_instance = ( ( setting->tag >> 24 ) & 0xff );
        tag_type = ( ( setting->tag >> 16 ) & 0xff );
        tag_offset = ( ( setting->tag >> 8 ) & 0xff );
        tag_len = ( setting->tag & 0xff );
 
        /* Find SMBIOS structure */
        structure = smbios_structure ( tag_type, tag_instance );
        if ( ! structure )
                return -ENOENT;
        src = structure;
        src_len = structure->len;
        string = 0;
 
        /* A <length> of zero indicates that the byte at <offset>
         * contains a string index.  An <offset> of zero indicates
         * that the <length> contains a literal string index.
         *
         * Since the byte at offset zero can never contain a string
         * index, and a literal string index can never be zero, the
         * combination of both <length> and <offset> being zero
         * indicates that the entire structure is to be read.
         */
        if ( ( tag_len == 0 ) && ( tag_offset == 0 ) ) {
                /* Read whole structure */
        } else if ( ( tag_len == 0 ) || ( tag_offset == 0 ) ) {
                /* Read string */
                string = tag_len;
                if ( ( string == 0 ) && ( tag_offset < src_len ) )
                        string = *( ( uint8_t * ) src + tag_offset );
                src = smbios_string ( structure, string );
                if ( ! src )
                        return -ENOENT;
                assert ( string > 0 );
                src_len = strlen ( src );
        } else if ( tag_offset > src_len ) {
                /* Empty read beyond end of structure */
                src_len = 0;
        } else {
                /* Read partial structure */
                src += tag_offset;
                src_len -= tag_offset;
                if ( src_len > tag_len )
                        src_len = tag_len;
        }
 
        /* Mangle UUIDs if necessary.  iPXE treats UUIDs as being in
         * network byte order (big-endian).  SMBIOS specification
         * version 2.6 states that UUIDs are stored with little-endian
         * values in the first three fields; earlier versions did not
         * specify an endianness.  dmidecode assumes that the byte
         * order is little-endian if and only if the SMBIOS version is
         * 2.6 or higher; we match this behaviour.
         */
        if ( ( ( setting->type == &setting_type_uuid ) ||
               ( setting->type == &setting_type_guid ) ) &&
             ( src_len == sizeof ( uuid ) ) &&
             ( smbios_version() >= SMBIOS_VERSION ( 2, 6 ) ) ) {
                DBGC ( settings, "SMBIOS detected mangled UUID\n" );
                memcpy ( &uuid, src, sizeof ( uuid ) );
                uuid_mangle ( &uuid );
                src = &uuid;
        }
 
        /* Return data */
        if ( len > src_len )
                len = src_len;
        memcpy ( data, src, len );
 
        /* Set default type */
        if ( ! setting->type ) {
                setting->type = ( string ? &setting_type_string :
                                  &setting_type_hex );
        }
 
        return src_len;
}

References assert, data, DBGC, ENOENT, len, smbios_header::len, memcpy(), smbios_string(), smbios_structure(), SMBIOS_VERSION, smbios_version(), src, string, strlen(), setting::tag, setting::type, and uuid_mangle().

smbios_init()

void smbios_init ( void )

static

Initialise SMBIOS settings.

Definition at line 191 of file smbios_settings.c.

                                 {
        struct settings *settings = &smbios_settings;
        int rc;
 
        if ( ( rc = register_settings ( settings, NULL, "smbios" ) ) != 0 ) {
                DBGC ( settings, "SMBIOS could not register settings: %s\n",
                       strerror ( rc ) );
                return;
        }
}

References DBGC, NULL, rc, register_settings(), smbios_settings, and strerror().

Referenced by __init_fn().

__init_fn()

struct init_fn smbios_init_fn __init_fn

(

INIT_NORMAL

)

SMBIOS settings initialiser.

References __init_fn, INIT_NORMAL, and smbios_init().

__setting() [1/6]

const struct setting uuid_setting __setting	(	SETTING_HOST	,
		uuid	)

UUID setting obtained via SMBIOS.

References __setting, SETTING_HOST, SMBIOS_RAW_TAG, smbios_settings_scope, and SMBIOS_TYPE_SYSTEM_INFORMATION.

__setting() [2/6]

const struct setting manufacturer_setting __setting	(	SETTING_HOST_EXTRA	,
		manufacturer	)

Manufacturer name setting.

References __setting, manufacturer, SETTING_HOST_EXTRA, smbios_settings_scope, SMBIOS_STRING_TAG, and SMBIOS_TYPE_SYSTEM_INFORMATION.

__setting() [3/6]

const struct setting product_setting __setting	(	SETTING_HOST_EXTRA	,
		product	)

Product name setting.

References __setting, product, SETTING_HOST_EXTRA, smbios_settings_scope, SMBIOS_STRING_TAG, and SMBIOS_TYPE_SYSTEM_INFORMATION.

__setting() [4/6]

const struct setting serial_setting __setting	(	SETTING_HOST_EXTRA	,
		serial	)

Serial number setting.

References __setting, serial, SETTING_HOST_EXTRA, smbios_settings_scope, SMBIOS_STRING_TAG, and SMBIOS_TYPE_SYSTEM_INFORMATION.

__setting() [5/6]

const struct setting asset_setting __setting	(	SETTING_HOST_EXTRA	,
		asset	)

Asset tag setting.

References __setting, asset_tag, SETTING_HOST_EXTRA, smbios_settings_scope, SMBIOS_STRING_TAG, and SMBIOS_TYPE_ENCLOSURE_INFORMATION.

__setting() [6/6]

const struct setting board_serial_setting __setting	(	SETTING_HOST_EXTRA	,
		board-	serial )

Board serial number setting (may differ from chassis serial number)

References __setting, serial, SETTING_HOST_EXTRA, smbios_settings_scope, SMBIOS_STRING_TAG, and SMBIOS_TYPE_BASE_BOARD_INFORMATION.

Variable Documentation

smbios_settings_scope

const struct settings_scope smbios_settings_scope

static

SMBIOS settings scope.

Definition at line 36 of file smbios_settings.c.

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

smbios_settings_operations

struct settings_operations smbios_settings_operations

static

Initial value:

= {
        .applies = smbios_applies,
        .fetch = smbios_fetch,
}

SMBIOS settings operations.

Definition at line 176 of file smbios_settings.c.

                                                               {
        .applies = smbios_applies,
        .fetch = smbios_fetch,
};

smbios_settings

struct settings smbios_settings

static

Initial value:

= {
        .refcnt = NULL,
        .siblings = LIST_HEAD_INIT ( smbios_settings.siblings ),
        .children = LIST_HEAD_INIT ( smbios_settings.children ),
        .op = &smbios_settings_operations,
        .default_scope = &smbios_settings_scope,
}

SMBIOS settings.

Definition at line 182 of file smbios_settings.c.

                                         {
        .refcnt = NULL,
        .siblings = LIST_HEAD_INIT ( smbios_settings.siblings ),
        .children = LIST_HEAD_INIT ( smbios_settings.children ),
        .op = &smbios_settings_operations,
        .default_scope = &smbios_settings_scope,
};

Referenced by smbios_init().