dmi_system_log_header_format

Synopsis

#include <opendmi/entity/system-event-log.h>

typedef enum dmi_system_log_header_format {
    DMI_SYSTEM_LOG_HEADER_FORMAT_NO_HEADER = 0x00,
    DMI_SYSTEM_LOG_HEADER_FORMAT_TYPE_1    = 0x01,
    DMI_SYSTEM_LOG_HEADER_FORMAT_OEM_START = 0x80,
    DMI_SYSTEM_LOG_HEADER_FORMAT_OEM_END   = 0xFF,
} dmi_system_log_header_format_t;

const char *dmi_system_log_header_format_name(
        dmi_system_log_header_format_t value);

Description

The dmi_system_log_header_format_t enumeration tells the format of the header at the start of the system event log area, and is the type of the header_format field of dmi_system_event_log_t. Values 0x02 to 0x7F are reserved by the specification, and values 0x80 to 0xFF are specific to the firmware vendor or the OEM.

The dmi_system_log_header_format_name function returns the printable name of a value, as the command line tool shows it. The name is translated to the locale set with dmi_set_locale, when the library is built with ICU4C support and has a translation of it.

Values

DMI_SYSTEM_LOG_HEADER_FORMAT_NO_HEADER

The log has no header: its data starts right at the start of the area.

DMI_SYSTEM_LOG_HEADER_FORMAT_TYPE_1

Type 1 log header, which holds the settings of the multiple-event counters and the location in CMOS memory of the flag which makes the firmware clear the log on the next boot.

DMI_SYSTEM_LOG_HEADER_FORMAT_OEM_START

First value of the firmware vendor or OEM-specific range.

DMI_SYSTEM_LOG_HEADER_FORMAT_OEM_END

Last value of the firmware vendor or OEM-specific range.

Return value

dmi_system_log_header_format_name returns the name of the value, or nullptr if the value has no name. The name is a static string, which must not be modified or freed.

Errors

None.

Standards

DMTF SMBIOS Specification (DSP0134), version 2.1 or newer.