MdePkg/Include/Protocol/Smbios.h

   1 /** @file
   2   SMBIOS Protocol as defined in PI1.2 Specification VOLUME 5 Standard.
   3
   4   SMBIOS protocol allows consumers to log SMBIOS data records, and enables the producer
   5   to create the SMBIOS tables for a platform.
   6
   7   This protocol provides an interface to add, remove or discover SMBIOS records. The driver which
   8   produces this protocol is responsible for creating the SMBIOS data tables and installing the pointer
   9   to the tables in the EFI System Configuration Table.
  10   The caller is responsible for only adding SMBIOS records that are valid for the SMBIOS
  11   MajorVersion and MinorVersion. When an enumerated SMBIOS field's values are
  12   controlled by the DMTF, new values can be used as soon as they are defined by the DMTF without
  13   requiring an update to MajorVersion and MinorVersion.
  14   The SMBIOS protocol can only be called a TPL < TPL_NOTIFY.
  15
  16   Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>
  17   SPDX-License-Identifier: BSD-2-Clause-Patent
  18
  19 **/
  20
  21 #ifndef __SMBIOS_PROTOCOL_H__
  22 #define __SMBIOS_PROTOCOL_H__
  23
  24 #include <IndustryStandard/SmBios.h>
  25
  26 #define EFI_SMBIOS_PROTOCOL_GUID \
  27     { 0x3583ff6, 0xcb36, 0x4940, { 0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7 }}
  28
  29 #define EFI_SMBIOS_TYPE_BIOS_INFORMATION                     SMBIOS_TYPE_BIOS_INFORMATION
  30 #define EFI_SMBIOS_TYPE_SYSTEM_INFORMATION                   SMBIOS_TYPE_SYSTEM_INFORMATION
  31 #define EFI_SMBIOS_TYPE_BASEBOARD_INFORMATION                SMBIOS_TYPE_BASEBOARD_INFORMATION
  32 #define EFI_SMBIOS_TYPE_SYSTEM_ENCLOSURE                     SMBIOS_TYPE_SYSTEM_ENCLOSURE
  33 #define EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION                SMBIOS_TYPE_PROCESSOR_INFORMATION
  34 #define EFI_SMBIOS_TYPE_MEMORY_CONTROLLER_INFORMATION        SMBIOS_TYPE_MEMORY_CONTROLLER_INFORMATION
  35 #define EFI_SMBIOS_TYPE_MEMORY_MODULE_INFORMATON             SMBIOS_TYPE_MEMORY_MODULE_INFORMATON
  36 #define EFI_SMBIOS_TYPE_CACHE_INFORMATION                    SMBIOS_TYPE_CACHE_INFORMATION
  37 #define EFI_SMBIOS_TYPE_PORT_CONNECTOR_INFORMATION           SMBIOS_TYPE_PORT_CONNECTOR_INFORMATION
  38 #define EFI_SMBIOS_TYPE_SYSTEM_SLOTS                         SMBIOS_TYPE_SYSTEM_SLOTS
  39 #define EFI_SMBIOS_TYPE_ONBOARD_DEVICE_INFORMATION           SMBIOS_TYPE_ONBOARD_DEVICE_INFORMATION
  40 #define EFI_SMBIOS_TYPE_OEM_STRINGS                          SMBIOS_TYPE_OEM_STRINGS
  41 #define EFI_SMBIOS_TYPE_SYSTEM_CONFIGURATION_OPTIONS         SMBIOS_TYPE_SYSTEM_CONFIGURATION_OPTIONS
  42 #define EFI_SMBIOS_TYPE_BIOS_LANGUAGE_INFORMATION            SMBIOS_TYPE_BIOS_LANGUAGE_INFORMATION
  43 #define EFI_SMBIOS_TYPE_GROUP_ASSOCIATIONS                   SMBIOS_TYPE_GROUP_ASSOCIATIONS
  44 #define EFI_SMBIOS_TYPE_SYSTEM_EVENT_LOG                     SMBIOS_TYPE_SYSTEM_EVENT_LOG
  45 #define EFI_SMBIOS_TYPE_PHYSICAL_MEMORY_ARRAY                SMBIOS_TYPE_PHYSICAL_MEMORY_ARRAY
  46 #define EFI_SMBIOS_TYPE_MEMORY_DEVICE                        SMBIOS_TYPE_MEMORY_DEVICE
  47 #define EFI_SMBIOS_TYPE_32BIT_MEMORY_ERROR_INFORMATION       SMBIOS_TYPE_32BIT_MEMORY_ERROR_INFORMATION
  48 #define EFI_SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS          SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS
  49 #define EFI_SMBIOS_TYPE_MEMORY_DEVICE_MAPPED_ADDRESS         SMBIOS_TYPE_MEMORY_DEVICE_MAPPED_ADDRESS
  50 #define EFI_SMBIOS_TYPE_BUILT_IN_POINTING_DEVICE             SMBIOS_TYPE_BUILT_IN_POINTING_DEVICE
  51 #define EFI_SMBIOS_TYPE_PORTABLE_BATTERY                     SMBIOS_TYPE_PORTABLE_BATTERY
  52 #define EFI_SMBIOS_TYPE_SYSTEM_RESET                         SMBIOS_TYPE_SYSTEM_RESET
  53 #define EFI_SMBIOS_TYPE_HARDWARE_SECURITY                    SMBIOS_TYPE_HARDWARE_SECURITY
  54 #define EFI_SMBIOS_TYPE_SYSTEM_POWER_CONTROLS                SMBIOS_TYPE_SYSTEM_POWER_CONTROLS
  55 #define EFI_SMBIOS_TYPE_VOLTAGE_PROBE                        SMBIOS_TYPE_VOLTAGE_PROBE
  56 #define EFI_SMBIOS_TYPE_COOLING_DEVICE                       SMBIOS_TYPE_COOLING_DEVICE
  57 #define EFI_SMBIOS_TYPE_TEMPERATURE_PROBE                    SMBIOS_TYPE_TEMPERATURE_PROBE
  58 #define EFI_SMBIOS_TYPE_ELECTRICAL_CURRENT_PROBE             SMBIOS_TYPE_ELECTRICAL_CURRENT_PROBE
  59 #define EFI_SMBIOS_TYPE_OUT_OF_BAND_REMOTE_ACCESS            SMBIOS_TYPE_OUT_OF_BAND_REMOTE_ACCESS
  60 #define EFI_SMBIOS_TYPE_BOOT_INTEGRITY_SERVICE               SMBIOS_TYPE_BOOT_INTEGRITY_SERVICE
  61 #define EFI_SMBIOS_TYPE_SYSTEM_BOOT_INFORMATION              SMBIOS_TYPE_SYSTEM_BOOT_INFORMATION
  62 #define EFI_SMBIOS_TYPE_64BIT_MEMORY_ERROR_INFORMATION       SMBIOS_TYPE_64BIT_MEMORY_ERROR_INFORMATION
  63 #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE                    SMBIOS_TYPE_MANAGEMENT_DEVICE
  64 #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE_COMPONENT          SMBIOS_TYPE_MANAGEMENT_DEVICE_COMPONENT
  65 #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE_THRESHOLD_DATA     SMBIOS_TYPE_MANAGEMENT_DEVICE_THRESHOLD_DATA
  66 #define EFI_SMBIOS_TYPE_MEMORY_CHANNEL                       SMBIOS_TYPE_MEMORY_CHANNEL
  67 #define EFI_SMBIOS_TYPE_IPMI_DEVICE_INFORMATION              SMBIOS_TYPE_IPMI_DEVICE_INFORMATION
  68 #define EFI_SMBIOS_TYPE_SYSTEM_POWER_SUPPLY                  SMBIOS_TYPE_SYSTEM_POWER_SUPPLY
  69 #define EFI_SMBIOS_TYPE_ADDITIONAL_INFORMATION               SMBIOS_TYPE_ADDITIONAL_INFORMATION
  70 #define EFI_SMBIOS_TYPE_ONBOARD_DEVICES_EXTENDED_INFORMATION SMBIOS_TYPE_ONBOARD_DEVICES_EXTENDED_INFORMATION
  71 #define EFI_SMBIOS_TYPE_MANAGEMENT_CONTROLLER_HOST_INTERFACE SMBIOS_TYPE_MANAGEMENT_CONTROLLER_HOST_INTERFACE
  72 #define EFI_SMBIOS_TYPE_INACTIVE                             SMBIOS_TYPE_INACTIVE
  73 #define EFI_SMBIOS_TYPE_END_OF_TABLE                         SMBIOS_TYPE_END_OF_TABLE
  74 #define EFI_SMBIOS_OEM_BEGIN                                 SMBIOS_OEM_BEGIN
  75 #define EFI_SMBIOS_OEM_END                                   SMBIOS_OEM_END
  76
  77 typedef SMBIOS_TABLE_STRING EFI_SMBIOS_STRING;
  78 typedef SMBIOS_TYPE         EFI_SMBIOS_TYPE;
  79 typedef SMBIOS_HANDLE       EFI_SMBIOS_HANDLE;
  80 typedef SMBIOS_STRUCTURE    EFI_SMBIOS_TABLE_HEADER;
  81
  82 typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL;
  83
  84 /**
  85   Add an SMBIOS record.
  86
  87   This function allows any agent to add SMBIOS records. The caller is responsible for ensuring
  88   Record is formatted in a way that matches the version of the SMBIOS specification as defined in
  89   the MajorRevision and MinorRevision fields of the EFI_SMBIOS_PROTOCOL.
  90   Record must follow the SMBIOS structure evolution and usage guidelines in the SMBIOS
  91   specification. Record starts with the formatted area of the SMBIOS structure and the length is
  92   defined by EFI_SMBIOS_TABLE_HEADER.Length. Each SMBIOS structure is terminated by a
  93   double-null (0x0000), either directly following the formatted area (if no strings are present) or
  94   directly following the last string. The number of optional strings is not defined by the formatted area,
  95   but is fixed by the call to Add(). A string can be a place holder, but it must not be a NULL string as
  96   two NULL strings look like the double-null that terminates the structure.
  97
  98   @param[in]        This                The EFI_SMBIOS_PROTOCOL instance.
  99   @param[in]        ProducerHandle      The handle of the controller or driver associated with the SMBIOS information. NULL means no handle.
 100   @param[in, out]   SmbiosHandle        On entry, the handle of the SMBIOS record to add. If FFFEh, then a unique handle
 101                                         will be assigned to the SMBIOS record. If the SMBIOS handle is already in use,
 102                                         EFI_ALREADY_STARTED is returned and the SMBIOS record is not updated.
 103   @param[in]        Record              The data for the fixed portion of the SMBIOS record. The format of the record is
 104                                         determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted
 105                                         area is defined by EFI_SMBIOS_TABLE_HEADER.Length and either followed
 106                                         by a double-null (0x0000) or a set of null terminated strings and a null.
 107
 108   @retval EFI_SUCCESS                   Record was added.
 109   @retval EFI_OUT_OF_RESOURCES          Record was not added.
 110   @retval EFI_ALREADY_STARTED           The SmbiosHandle passed in was already in use.
 111 **/
 112 typedef
 113 EFI_STATUS
 114 (EFIAPI *EFI_SMBIOS_ADD)(
 115   IN CONST      EFI_SMBIOS_PROTOCOL     *This,
 116   IN            EFI_HANDLE              ProducerHandle OPTIONAL,
 117   IN OUT        EFI_SMBIOS_HANDLE       *SmbiosHandle,
 118   IN            EFI_SMBIOS_TABLE_HEADER *Record
 119 );
 120
 121 /**
 122   Update the string associated with an existing SMBIOS record.
 123
 124   This function allows the update of specific SMBIOS strings. The number of valid strings for any
 125   SMBIOS record is defined by how many strings were present when Add() was called.
 126
 127   @param[in]    This            The EFI_SMBIOS_PROTOCOL instance.
 128   @param[in]    SmbiosHandle    SMBIOS Handle of structure that will have its string updated.
 129   @param[in]    StringNumber    The non-zero string number of the string to update.
 130   @param[in]    String          Update the StringNumber string with String.
 131
 132   @retval EFI_SUCCESS           SmbiosHandle had its StringNumber String updated.
 133   @retval EFI_INVALID_PARAMETER SmbiosHandle does not exist.
 134   @retval EFI_UNSUPPORTED       String was not added because it is longer than the SMBIOS Table supports.
 135   @retval EFI_NOT_FOUND         The StringNumber.is not valid for this SMBIOS record.
 136 **/
 137 typedef
 138 EFI_STATUS
 139 (EFIAPI *EFI_SMBIOS_UPDATE_STRING)(
 140    IN CONST EFI_SMBIOS_PROTOCOL *This,
 141    IN       EFI_SMBIOS_HANDLE   *SmbiosHandle,
 142    IN       UINTN               *StringNumber,
 143    IN       CHAR8               *String
 144 );
 145
 146 /**
 147   Remove an SMBIOS record.
 148
 149   This function removes an SMBIOS record using the handle specified by SmbiosHandle.
 150
 151   @param[in]    This                The EFI_SMBIOS_PROTOCOL instance.
 152   @param[in]    SmbiosHandle        The handle of the SMBIOS record to remove.
 153
 154   @retval EFI_SUCCESS               SMBIOS record was removed.
 155   @retval EFI_INVALID_PARAMETER     SmbiosHandle does not specify a valid SMBIOS record.
 156 **/
 157 typedef
 158 EFI_STATUS
 159 (EFIAPI *EFI_SMBIOS_REMOVE)(
 160    IN CONST EFI_SMBIOS_PROTOCOL *This,
 161    IN       EFI_SMBIOS_HANDLE   SmbiosHandle
 162 );
 163
 164 /**
 165   Allow the caller to discover all or some of the SMBIOS records.
 166
 167   This function allows all of the SMBIOS records to be discovered. It's possible to find
 168   only the SMBIOS records that match the optional Type argument.
 169
 170   @param[in]        This            The EFI_SMBIOS_PROTOCOL instance.
 171   @param[in, out]   SmbiosHandle    On entry, points to the previous handle of the SMBIOS record. On exit, points to the
 172                                     next SMBIOS record handle. If it is FFFEh on entry, then the first SMBIOS record
 173                                     handle will be returned. If it returns FFFEh on exit, then there are no more SMBIOS records.
 174   @param[in]        Type            On entry, it points to the type of the next SMBIOS record to return. If NULL, it
 175                                     indicates that the next record of any type will be returned. Type is not
 176                                     modified by the this function.
 177   @param[out]       Record          On exit, points to a pointer to the the SMBIOS Record consisting of the formatted area
 178                                     followed by the unformatted area. The unformatted area optionally contains text strings.
 179   @param[out]       ProducerHandle  On exit, points to the ProducerHandle registered by Add(). If no
 180                                     ProducerHandle was passed into Add() NULL is returned. If a NULL pointer is
 181                                     passed in no data will be returned.
 182   @retval EFI_SUCCESS               SMBIOS record information was successfully returned in Record.
 183                                     SmbiosHandle is the handle of the current SMBIOS record
 184   @retval EFI_NOT_FOUND             The SMBIOS record with SmbiosHandle was the last available record.
 185 **/
 186 typedef
 187 EFI_STATUS
 188 (EFIAPI *EFI_SMBIOS_GET_NEXT)(
 189    IN     CONST EFI_SMBIOS_PROTOCOL     *This,
 190    IN OUT       EFI_SMBIOS_HANDLE       *SmbiosHandle,
 191    IN           EFI_SMBIOS_TYPE         *Type              OPTIONAL,
 192    OUT          EFI_SMBIOS_TABLE_HEADER **Record,
 193    OUT          EFI_HANDLE              *ProducerHandle    OPTIONAL
 194 );
 195
 196 struct _EFI_SMBIOS_PROTOCOL {
 197   EFI_SMBIOS_ADD           Add;
 198   EFI_SMBIOS_UPDATE_STRING UpdateString;
 199   EFI_SMBIOS_REMOVE        Remove;
 200   EFI_SMBIOS_GET_NEXT      GetNext;
 201   UINT8                    MajorVersion;    ///< The major revision of the SMBIOS specification supported.
 202   UINT8                    MinorVersion;    ///< The minor revision of the SMBIOS specification supported.
 203 };
 204
 205 extern EFI_GUID gEfiSmbiosProtocolGuid;
 206
 207 #endif // __SMBIOS_PROTOCOL_H__