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