]>
Commit | Line | Data |
---|---|---|
6a0cd52d | 1 | /** @file\r |
2 | SMBIOS Protocol as defined in PI1.2 Specification VOLUME 5 Standard.\r | |
3 | \r | |
4 | SMBIOS protocol allows consumers to log SMBIOS data records, and enables the producer \r | |
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 | |
16 | Copyright (c) 2006 - 2008, Intel Corporation \r | |
17 | All rights reserved. This program and the accompanying materials \r | |
18 | are licensed and made available under the terms and conditions of the BSD License \r | |
19 | which accompanies this distribution. The full text of the license may be found at \r | |
20 | http://opensource.org/licenses/bsd-license.php \r | |
21 | \r | |
22 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
23 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
24 | \r | |
25 | **/\r | |
26 | \r | |
27 | #ifndef __SMBIOS_PROTOCOL_H__\r | |
28 | #define __SMBIOS_PROTOCOL_H__\r | |
29 | \r | |
30 | #define EFI_SMBIOS_PROTOCOL_GUID \\r | |
31 | { 0x3583ff6, 0xcb36, 0x4940, { 0x94, 0x7e, 0xb9, 0xb3, 0x9f, 0x4a, 0xfa, 0xf7 }}\r | |
32 | \r | |
33 | //\r | |
34 | // SMBIOS type macros which is according to SMBIOS specification.\r | |
35 | // \r | |
36 | #define EFI_SMBIOS_TYPE_BIOS_INFORMATION 0\r | |
37 | #define EFI_SMBIOS_TYPE_SYSTEM_INFORMATION 1\r | |
38 | #define EFI_SMBIOS_TYPE_BASEBOARD_INFORMATION 2\r | |
39 | #define EFI_SMBIOS_TYPE_SYSTEM_ENCLOSURE 3\r | |
40 | #define EFI_SMBIOS_TYPE_PROCESSOR_INFORMATION 4\r | |
41 | #define EFI_SMBIOS_TYPE_MEMORY_CONTROLLER_INFORMATION 5\r | |
42 | #define EFI_SMBIOS_TYPE_MEMORY_MODULE_INFORMATON 6\r | |
43 | #define EFI_SMBIOS_TYPE_CACHE_INFORMATION 7\r | |
44 | #define EFI_SMBIOS_TYPE_PORT_CONNECTOR_INFORMATION 8\r | |
45 | #define EFI_SMBIOS_TYPE_SYSTEM_SLOTS 9\r | |
46 | #define EFI_SMBIOS_TYPE_ONBOARD_DEVICE_INFORMATION 10\r | |
47 | #define EFI_SMBIOS_TYPE_OEM_STRINGS 11\r | |
48 | #define EFI_SMBIOS_TYPE_SYSTEM_CONFIGURATION_OPTIONS 12\r | |
49 | #define EFI_SMBIOS_TYPE_BIOS_LANGUAGE_INFORMATION 13\r | |
50 | #define EFI_SMBIOS_TYPE_GROUP_ASSOCIATIONS 14\r | |
51 | #define EFI_SMBIOS_TYPE_SYSTEM_EVENT_LOG 15\r | |
52 | #define EFI_SMBIOS_TYPE_PHYSICAL_MEMORY_ARRAY 16\r | |
53 | #define EFI_SMBIOS_TYPE_MEMORY_DEVICE 17\r | |
54 | #define EFI_SMBIOS_TYPE_32BIT_MEMORY_ERROR_INFORMATION 18\r | |
55 | #define EFI_SMBIOS_TYPE_MEMORY_ARRAY_MAPPED_ADDRESS 19\r | |
56 | #define EFI_SMBIOS_TYPE_MEMORY_DEVICE_MAPPED_ADDRESS 20\r | |
57 | #define EFI_SMBIOS_TYPE_BUILT_IN_POINTING_DEVICE 21\r | |
58 | #define EFI_SMBIOS_TYPE_PORTABLE_BATTERY 22\r | |
59 | #define EFI_SMBIOS_TYPE_SYSTEM_RESET 23\r | |
60 | #define EFI_SMBIOS_TYPE_HARDWARE_SECURITY 24\r | |
61 | #define EFI_SMBIOS_TYPE_SYSTEM_POWER_CONTROLS 25\r | |
62 | #define EFI_SMBIOS_TYPE_VOLTAGE_PROBE 26\r | |
63 | #define EFI_SMBIOS_TYPE_COOLING_DEVICE 27\r | |
64 | #define EFI_SMBIOS_TYPE_TEMPERATURE_PROBE 28\r | |
65 | #define EFI_SMBIOS_TYPE_ELECTRICAL_CURRENT_PROBE 29\r | |
66 | #define EFI_SMBIOS_TYPE_OUT_OF_BAND_REMOTE_ACCESS 30\r | |
67 | #define EFI_SMBIOS_TYPE_BOOT_INTEGRITY_SERVICE 31\r | |
68 | #define EFI_SMBIOS_TYPE_SYSTEM_BOOT_INFORMATION 32\r | |
69 | #define EFI_SMBIOS_TYPE_64BIT_MEMORY_ERROR_INFORMATION 33\r | |
70 | #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE 34\r | |
71 | #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE_COMPONENT 35\r | |
72 | #define EFI_SMBIOS_TYPE_MANAGEMENT_DEVICE_THRESHOLD_DATA 36\r | |
73 | #define EFI_SMBIOS_TYPE_MEMORY_CHANNEL 37\r | |
74 | #define EFI_SMBIOS_TYPE_IPMI_DEVICE_INFORMATION 38\r | |
75 | #define EFI_SMBIOS_TYPE_SYSTEM_POWER_SUPPLY 39\r | |
76 | #define EFI_SMBIOS_TYPE_INACTIVE 126\r | |
77 | #define EFI_SMBIOS_TYPE_END_OF_TABLE 127\r | |
78 | #define EFI_SMBIOS_OEM_BEGIN 128\r | |
79 | #define EFI_SMBIOS_OEM_END 255\r | |
80 | \r | |
81 | ///\r | |
82 | /// Text strings associated with a given SMBIOS structure are returned in the dmiStrucBuffer, appended directly after\r | |
83 | /// the formatted portion of the structure. This method of returning string information eliminates the need for\r | |
84 | /// application software to deal with pointers embedded in the SMBIOS structure. Each string is terminated with a null\r | |
85 | /// (00h) BYTE and the set of strings is terminated with an additional null (00h) BYTE. When the formatted portion of\r | |
17664848 | 86 | /// a SMBIOS structure references a string, it does so by specifying a non-zero string number within the structure's\r |
6a0cd52d | 87 | /// string-set. For example, if a string field contains 02h, it references the second string following the formatted portion\r |
88 | /// of the SMBIOS structure. If a string field references no string, a null (0) is placed in that string field. If the\r | |
89 | /// formatted portion of the structure contains string-reference fields and all the string fields are set to 0 (no string\r | |
90 | /// references), the formatted section of the structure is followed by two null (00h) BYTES.\r | |
91 | ///\r | |
92 | typedef UINT8 EFI_SMBIOS_STRING; \r | |
93 | \r | |
94 | ///\r | |
95 | /// Types 0 through 127 (7Fh) are reserved for and defined by this\r | |
96 | /// specification. Types 128 through 256 (80h to FFh) are available for system- and OEM-specific information. \r | |
97 | ///\r | |
98 | typedef UINT8 EFI_SMBIOS_TYPE;\r | |
99 | \r | |
100 | ///\r | |
17664848 | 101 | /// Specifies the structure's handle, a unique 16-bit number in the range 0 to 0FFFEh (for version\r |
6a0cd52d | 102 | /// 2.0) or 0 to 0FEFFh (for version 2.1 and later). The handle can be used with the Get SMBIOS\r |
103 | /// Structure function to retrieve a specific structure; the handle numbers are not required to be\r | |
104 | /// contiguous. For v2.1 and later, handle values in the range 0FF00h to 0FFFFh are reserved for\r | |
105 | /// use by this specification.\r | |
106 | /// If the system configuration changes, a previously assigned handle might no longer exist.\r | |
107 | /// However once a handle has been assigned by the BIOS, the BIOS cannot re-assign that handle\r | |
108 | /// number to another structure.\r | |
109 | ///\r | |
110 | typedef UINT16 EFI_SMBIOS_HANDLE;\r | |
111 | \r | |
112 | typedef struct {\r | |
113 | EFI_SMBIOS_TYPE Type;\r | |
114 | UINT8 Length;\r | |
115 | EFI_SMBIOS_HANDLE Handle;\r | |
116 | } EFI_SMBIOS_TABLE_HEADER;\r | |
117 | \r | |
118 | typedef struct _EFI_SMBIOS_PROTOCOL EFI_SMBIOS_PROTOCOL;\r | |
119 | \r | |
120 | /**\r | |
121 | Add an SMBIOS record.\r | |
122 | \r | |
123 | This function allows any agent to add SMBIOS records. The caller is responsible for ensuring\r | |
124 | Record is formatted in a way that matches the version of the SMBIOS specification as defined in\r | |
125 | the MajorRevision and MinorRevision fields of the EFI_SMBIOS_PROTOCOL.\r | |
126 | Record must follow the SMBIOS structure evolution and usage guidelines in the SMBIOS\r | |
127 | specification. Record starts with the formatted area of the SMBIOS structure and the length is\r | |
128 | defined by EFI_SMBIOS_TABLE_HEADER.Length. Each SMBIOS structure is terminated by a\r | |
129 | double-null (0x0000), either directly following the formatted area (if no strings are present) or\r | |
130 | directly following the last string. The number of optional strings is not defined by the formatted area,\r | |
131 | 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 | |
132 | two NULL strings look like the double-null that terminates the structure.\r | |
133 | \r | |
134 | @param[in] This The EFI_SMBIOS_PROTOCOL instance.\r | |
135 | @param[in] ProducerHandle The handle of the controller or driver associated with the SMBIOS information. NULL means no handle.\r | |
136 | @param[in, out] SmbiosHandle On entry, if non-zero, the handle of the SMBIOS record. If zero, then a unique handle\r | |
137 | will be assigned to the SMBIOS record. If the SMBIOS handle is already in use\r | |
138 | EFI_ALREADY_STARTED is returned and the SMBIOS record is not updated.\r | |
139 | @param[in] Record The data for the fixed portion of the SMBIOS record. The format of the record is\r | |
140 | determined by EFI_SMBIOS_TABLE_HEADER.Type. The size of the formatted\r | |
141 | area is defined by EFI_SMBIOS_TABLE_HEADER.Length and either followed\r | |
142 | by a double-null (0x0000) or a set of null terminated strings and a null.\r | |
143 | \r | |
144 | @retval EFI_SUCCESS Record was added.\r | |
145 | @retval EFI_OUT_OF_RESOURCES Record was not added.\r | |
146 | @retval EFI_ALREADY_STARTED The SmbiosHandle passed in was already in use.\r | |
147 | **/\r | |
148 | typedef\r | |
149 | EFI_STATUS\r | |
150 | (EFIAPI *EFI_SMBIOS_ADD)(\r | |
151 | IN CONST EFI_SMBIOS_PROTOCOL *This,\r | |
3e22fec9 | 152 | IN EFI_HANDLE ProducerHandle OPTIONAL,\r |
6a0cd52d | 153 | IN OUT EFI_SMBIOS_HANDLE *SmbiosHandle,\r |
154 | IN EFI_SMBIOS_TABLE_HEADER *Record\r | |
155 | );\r | |
156 | \r | |
157 | /**\r | |
158 | Update the string associated with an existing SMBIOS record.\r | |
159 | \r | |
160 | This function allows the update of specific SMBIOS strings. The number of valid strings for any\r | |
161 | SMBIOS record is defined by how many strings were present when Add() was called.\r | |
162 | \r | |
163 | @param[in] This The EFI_SMBIOS_PROTOCOL instance.\r | |
164 | @param[in] SmbiosHandle SMBIOS Handle of structure that will have its string updated.\r | |
165 | @param[in] StringNumber The non-zero string number of the string to update.\r | |
166 | @param[in] String Update the StringNumber string with String.\r | |
167 | \r | |
168 | @retval EFI_SUCCESS SmbiosHandle had its StringNumber String updated.\r | |
169 | @retval EFI_INVALID_PARAMETER SmbiosHandle does not exist.\r | |
170 | @retval EFI_UNSUPPORTED String was not added since it's longer than 64 significant characters.\r | |
171 | @retval EFI_NOT_FOUND The StringNumber.is not valid for this SMBIOS record. \r | |
172 | **/\r | |
173 | typedef\r | |
174 | EFI_STATUS\r | |
175 | (EFIAPI *EFI_SMBIOS_UPDATE_STRING)(\r | |
176 | IN CONST EFI_SMBIOS_PROTOCOL *This,\r | |
177 | IN EFI_SMBIOS_HANDLE *SmbiosHandle,\r | |
178 | IN UINTN *StringNumber,\r | |
179 | IN CHAR8 *String\r | |
180 | );\r | |
181 | \r | |
182 | /**\r | |
183 | Remove an SMBIOS record.\r | |
184 | \r | |
185 | This function removes an SMBIOS record using the handle specified by SmbiosHandle.\r | |
186 | \r | |
187 | @param[in] This The EFI_SMBIOS_PROTOCOL instance.\r | |
188 | @param[in] SmbiosHandle The handle of the SMBIOS record to remove.\r | |
189 | \r | |
190 | @retval EFI_SUCCESS SMBIOS record was removed.\r | |
191 | @retval EFI_INVALID_PARAMETER SmbiosHandle does not specify a valid SMBIOS record.\r | |
192 | **/\r | |
193 | typedef\r | |
194 | EFI_STATUS\r | |
195 | (EFIAPI *EFI_SMBIOS_REMOVE)(\r | |
196 | IN CONST EFI_SMBIOS_PROTOCOL *This,\r | |
197 | IN EFI_SMBIOS_HANDLE SmbiosHandle\r | |
198 | );\r | |
199 | \r | |
200 | /**\r | |
201 | Allow the caller to discover all or some of the SMBIOS records.\r | |
202 | \r | |
203 | This function allows all of the SMBIOS records to be discovered. It's possible to find\r | |
204 | only the SMBIOS records that match the optional Type argument.\r | |
205 | \r | |
206 | @param[in] This The EFI_SMBIOS_PROTOCOL instance.\r | |
207 | @param[in, out] SmbiosHandle On entry, points to the previous handle of the SMBIOS record. On exit, points to the\r | |
208 | next SMBIOS record handle. If it is zero on entry, then the first SMBIOS record\r | |
209 | handle will be returned. If it returns zero on exit, then there are no more SMBIOS records.\r | |
210 | @param[in] Type On entry, it points to the type of the next SMBIOS record to return. If NULL, it\r | |
211 | indicates that the next record of any type will be returned. Type is not\r | |
212 | modified by the this function.\r | |
213 | @param[out] Record On exit, points to a pointer to the the SMBIOS Record consisting of the formatted area\r | |
214 | followed by the unformatted area. The unformatted area optionally contains text strings.\r | |
215 | @param[out] ProducerHandle On exit, points to the ProducerHandle registered by Add(). If no\r | |
216 | ProducerHandle was passed into Add() NULL is returned. If a NULL pointer is\r | |
217 | passed in no data will be returned.\r | |
218 | @retval EFI_SUCCESS SMBIOS record information was successfully returned in Record.\r | |
219 | SmbiosHandle is the handle of the current SMBIOS record\r | |
220 | @retval EFI_NOT_FOUND The SMBIOS record with SmbiosHandle was the last available record.\r | |
221 | **/\r | |
222 | typedef\r | |
223 | EFI_STATUS\r | |
224 | (EFIAPI *EFI_SMBIOS_GET_NEXT)(\r | |
225 | IN CONST EFI_SMBIOS_PROTOCOL *This,\r | |
226 | IN OUT EFI_SMBIOS_HANDLE *SmbiosHandle,\r | |
3e22fec9 | 227 | IN EFI_SMBIOS_TYPE *Type OPTIONAL,\r |
6a0cd52d | 228 | OUT EFI_SMBIOS_TABLE_HEADER **Record,\r |
3e22fec9 | 229 | OUT EFI_HANDLE *ProducerHandle OPTIONAL\r |
6a0cd52d | 230 | );\r |
231 | \r | |
232 | struct _EFI_SMBIOS_PROTOCOL {\r | |
233 | EFI_SMBIOS_ADD Add;\r | |
234 | EFI_SMBIOS_UPDATE_STRING UpdateString;\r | |
235 | EFI_SMBIOS_REMOVE Remove;\r | |
236 | EFI_SMBIOS_GET_NEXT GetNext;\r | |
237 | UINT8 MajorVersion; ///< The major revision of the SMBIOS specification supported.\r | |
238 | UINT8 MinorVersion; ///< The minor revision of the SMBIOS specification supported.\r | |
239 | };\r | |
240 | \r | |
241 | extern EFI_GUID gEfiSmbiosProtocolGuid;\r | |
242 | \r | |
243 | #endif // __SMBIOS_PROTOCOL_H__\r |