Move SmmLib from IntelFrameworkPkg to MdePkg because this library is useful to both...
[mirror_edk2.git] / IntelFrameworkPkg / FrameworkSpecConformance.txt
1 ##
2 # This file is used to document mismatches between Intel Platform Innovation Framework specification
3 # (http://www.intel.com/technology/framework/spec.htm) and data structures defind at IntelFrameworkPkg
4 # package in EdkII Open Source Project (https://edk2.tianocore.org/source/browse/edk2/trunk/edk2/IntelFrameworkPkg)
5 ##
6
7 ##
8 # The general consideration about keeping the mismatches in EdkII:
9 # 1. Some definitions defined in Framework specification may bring a little complexity on implementation. EdkII
10 # makes changes on them from the view of code development.
11 # 2. Some definitions are NOT defined in Framework specification, but introduced in Edk. EdkII chooses to keep
12 # them for backward-compatibility.
13 # 3. The name of some definitions are NOT consistent with Framework specification. If the name doesn't bring
14 # misunderstanding literally, EdkII chooses to keep them for backward-compatibility.
15 # 4. Some defintitions don't exactly match Framework specification, some new field members are introduced in EdkII
16 # to reflect the latest industry standard.
17 #
18 # Note:
19 # The IntelFrameworkPkg contains Framework specification contents that were not adopted by UEFI/PI, and names may be
20 # changed (such as adding "FRAMEWORK_") to avoid name collisions with approved UEFI/PI specifications.
21 ##
22
23 ##
24 # Mismatch with Intel Platform Innovation Framework for DataHubSubclass Specification (Version 0.90)
25 ##
26 1. Guid/DataHubRecords.h
27 #define EFI_STRING_TOKEN UINT16
28
29 This macro named "EFI_STRING_TOKEN" is *NOT* defined in Framework specification. Keeping this inconsistency
30 for backward compatibility.
31
32 2. Guid/DataHubRecords.h
33 #pragma pack(1)
34 typedef struct {
35 UINT8 LastPciBus;
36 } EFI_MISC_LAST_PCI_BUS_DATA;
37 ...
38 typedef struct {
39 EFI_SUBCLASS_TYPE1_HEADER Header;
40 EFI_MISC_SUBCLASS_RECORDS Record;
41 } EFI_MISC_SUBCLASS_DRIVER_DATA;
42 #pragma pack()
43
44 Section "Alignment" in DataHubSubclass specification say "Fields in a data hub record should be aligned at their
45 natural boundaries". But in EdkII, the data structures above are packed.
46 Keeping this inconsistency for backward compatibility.
47
48 3. Guid/DataHubRecords.h
49 #define EFI_SUBCLASS_INSTANCE_RESERVED 0
50 #define EFI_SUBCLASS_INSTANCE_NON_APPLICABLE 0xFFFF
51
52 The symbols above are *NOT* defined in DataHubSubclass specification. But the values are defined and are meaningful.
53 According to DataHubSubclass spec, value 0 means Reserved and -1 means Not Applicable. EdkII introduces these macros
54 to faciliate user development.
55
56 ##
57 # Mismatch with Intel Platform Innovation Framework for CacheSubclass Specification (Version 0.90)
58 ##
59 1. Guid/DataHubRecords.h
60 typedef EFI_EXP_BASE2_DATA EFI_MAXIMUM_CACHE_SIZE_DATA;
61
62 The definition named "EFI_MAXIMUM_CACHE_SIZE_DATA" is *NOT* consistent with CacheSubclass specification, in which
63 the name should be EFI_CACHE_MAXIMUM_SIZE_DATA. Keeping this inconsistency for backward compatibility.
64
65 2. Guid/DataHubRecords.h
66 typedef struct {
67 UINT32 Level :3;
68 UINT32 Socketed :1;
69 UINT32 Reserved2 :1;
70 UINT32 Location :2;
71 UINT32 Enable :1;
72 UINT32 OperationalMode :2;
73 UINT32 Reserved1 :22;
74 } EFI_CACHE_CONFIGURATION_DATA;
75
76 The field type of the definition is *NOT* consistent with CacheSubclass specification. Specification defines
77 them as UINT16, which is incorrect and should be UINT32 because the total width of bit-fields is 32bits width.
78
79 3. Guid/DataHubRecords.h
80 typedef enum {
81 CacheSizeRecordType = 1,
82 MaximumSizeCacheRecordType = 2,
83 CacheSpeedRecordType = 3,
84 CacheSocketRecordType = 4,
85 CacheSramTypeRecordType = 5,
86 CacheInstalledSramTypeRecordType = 6,
87 CacheErrorTypeRecordType = 7,
88 CacheTypeRecordType = 8,
89 CacheAssociativityRecordType = 9,
90 CacheConfigRecordType = 10
91 } EFI_CACHE_VARIABLE_RECORD_TYPE;
92
93 The data structure and all enumeration fields are *NOT* defined in CacheSubclass specification, which only
94 defines the following macros to specify the record number of the data record:
95 #define EFI_CACHE_SIZE_RECORD_NUMBER 0x00000001
96 #define EFI_CACHE_MAXIMUM_SIZE_RECORD_NUMBER 0x00000002
97 #define EFI_CACHE_SPEED_RECORD_NUMBER 0x00000003
98 #define EFI_CACHE_SOCKET_RECORD_NUMBER 0x00000004
99 #define EFI_CACHE_SRAM_SUPPORT_RECORD_NUMBER 0x00000005
100 #define EFI_CACHE_SRAM_INSTALL_RECORD_NUMBER 0x00000006
101 #define EFI_CACHE_ERROR_SUPPORT_RECORD_NUMBER 0x00000007
102 #define EFI_CACHE_TYPE_RECORD_NUMBER 0x00000008
103 #define EFI_CACHE_ASSOCIATIVITY_RECORD_NUMBER 0x00000009
104 #define EFI_CACHE_CONFIGURATION_RECORD_NUMBER 0x0000000A
105 Keeping this inconsistency for backward compatibility.
106
107 4. Guid/DataHubRecords.h
108 typedef union {
109 EFI_CACHE_SIZE_DATA CacheSize;
110 ...
111 EFI_CACHE_ASSOCIATION_DATA CacheAssociation;
112 } EFI_CACHE_VARIABLE_RECORD;
113
114 typedef struct {
115 EFI_SUBCLASS_TYPE1_HEADER DataRecordHeader;
116 EFI_CACHE_VARIABLE_RECORD VariableRecord;
117 } EFI_CACHE_DATA_RECORD;
118
119 The definitions above are *NOT* defined in CacheSubclass specification. EdkII introduces them to simplify the
120 code logic. Therefore developer doesn't need to allocate memory dynamically to construct variable length data record.
121 Keeping this inconsistency for backward compatibility.
122
123 ##
124 # Mismatch with Intel Platform Innovation Framework for ProcSubclass Specification (Version 0.90)
125 ##
126 1. Guid/DataHubRecords.h
127 #define EFI_PROCESSOR_SUBCLASS_VERSION 0x00010000
128
129 The value of the definition is *NOT* consistent with ProcSubclass specification, in which the value is 0x0100.
130 Keeping this inconsistency from the perspective of binary consistency.
131
132 2. Guid/DataHubRecords.h
133 typedef struct {
134 UINT32 ProcessorBrandIndex :8;
135 UINT32 ProcessorClflush :8;
136 UINT32 ProcessorReserved :8;
137 UINT32 ProcessorDfltApicId :8;
138 } EFI_PROCESSOR_MISC_INFO;
139
140 The definition is *NOT* consistent with ProcSubclass specification, in which the name of third field is defined
141 as "LogicalProcessorCount" rather than "ProcessorReserved".
142 Keeping this inconsistency for backward compatibility.
143
144 3. Guid/DataHubRecords.h
145 typedef enum {
146 ...
147 EfiProcessorFamilyUltraSparcIIIi = 0x58,
148 ...
149 EfiProcessorFamilyIntelPentiumM = 0xB9,
150 EfiProcessorFamilyIntelCeleronD = 0xBA,
151 EfiProcessorFamilyIntelPentiumD = 0xBB,
152 EfiProcessorFamilyIntelPentiumEx = 0xBC,
153 EfiProcessorFamilyIntelCoreSolo = 0xBD,
154 EfiProcessorFamilyReserved = 0xBE,
155 EfiProcessorFamilyIntelCore2 = 0xBF,
156 ...
157 EfiProcessorFamilyG6 = 0xCB,
158 EfiProcessorFamilyzArchitectur = 0xCC,
159 EfiProcessorFamilyViaC7M = 0xD2,
160 EfiProcessorFamilyViaC7D = 0xD3,
161 EfiProcessorFamilyViaC7 = 0xD4,
162 EfiProcessorFamilyViaEden = 0xD5,
163 ...
164 EfiProcessorFamilyIndicatorFamily2 = 0xFE,
165 EfiProcessorFamilyReserved1 = 0xFF
166 } EFI_PROCESSOR_FAMILY_DATA;
167
168 a. In ProcSubclass specification 0.9, the field name whose value equals to 0x58 is "EfiProcessorFamilyUltraSparcIIi".
169 Due to the name has been defined in previous field, changing it to "EfiProcessorFamilyUltraSparcIIIi" to avoid
170 build break.
171 b. The other fields listed here are *NOT* defined in ProcSubclass specification 0.9. They are introduced to
172 support new processor family (type 4) defined in SmBios 2.6 specification.
173 Keeping this inconsistency to reflect the latest industry standard.
174
175 4. Guid/DataHubRecords.h
176 typedef enum {
177 ...
178 EfiProcessorSocket939 = 0x12,
179 EfiProcessorSocketmPGA604 = 0x13,
180 EfiProcessorSocketLGA771 = 0x14,
181 EfiProcessorSocketLGA775 = 0x15
182 } EFI_PROCESSOR_SOCKET_TYPE_DATA;
183
184 The fields listed here are *NOT* defined in ProcSubclass specification 0.9. They are introduced to support
185 new processor upgrade (type 4 offset 19h) defined in SmBios 2.6 specification.
186 Keeping this inconsistency to reflect the latest industry standard.
187
188 5. Guid/DataHubRecords.h
189 typedef EFI_INTER_LINK_DATA EFI_CACHE_ASSOCIATION_DATA;
190
191 The definition name "EFI_CACHE_ASSOCIATION_DATA" is *NOT* consistent with ProcSubclass specification 0.9, in which
192 the name should be "EFI_PROCESSOR_CACHE_ASSOCIATION_DATA". Keeping this inconsistency for backward compatibility.
193
194 6. Guid/DataHubRecords.h
195 typedef enum {
196 EfiProcessorHealthy = 1,
197 EfiProcessorPerfRestricted = 2,
198 EfiProcessorFuncRestricted = 3
199 } EFI_PROCESSOR_HEALTH_STATUS;
200
201 The structure name "EFI_PROCESSOR_HEALTH_STATUS" is *NOT* consistent with ProcSubclass specification 0.9, in which
202 the name should be "EFI_PROCESSOR_HEALTH_STATUS_DATA". Keeping this inconsistency for backward compatibility.
203
204 7. Guid/DataHubRecords.h
205 typedef enum {
206 ProcessorCoreFrequencyRecordType = 1,
207 ProcessorFsbFrequencyRecordType = 2,
208 ProcessorVersionRecordType = 3,
209 ProcessorManufacturerRecordType = 4,
210 ProcessorSerialNumberRecordType = 5,
211 ProcessorIdRecordType = 6,
212 ProcessorTypeRecordType = 7,
213 ProcessorFamilyRecordType = 8,
214 ProcessorVoltageRecordType = 9,
215 ProcessorApicBaseAddressRecordType = 10,
216 ProcessorApicIdRecordType = 11,
217 ProcessorApicVersionNumberRecordType = 12,
218 CpuUcodeRevisionDataRecordType = 13,
219 ProcessorStatusRecordType = 14,
220 ProcessorSocketTypeRecordType = 15,
221 ProcessorSocketNameRecordType = 16,
222 CacheAssociationRecordType = 17,
223 ProcessorMaxCoreFrequencyRecordType = 18,
224 ProcessorAssetTagRecordType = 19,
225 ProcessorMaxFsbFrequencyRecordType = 20,
226 ProcessorPackageNumberRecordType = 21,
227 ProcessorCoreFrequencyListRecordType = 22,
228 ProcessorFsbFrequencyListRecordType = 23,
229 ProcessorHealthStatusRecordType = 24
230 } EFI_CPU_VARIABLE_RECORD_TYPE;
231
232 The data structure and all enumeration fields are *NOT* defined in ProcSubclass specification 0.9, which only
233 defines the following macros to specify the record number of the data record:
234 #define EFI_PROCESSOR_FREQUENCY_RECORD_NUMBER 0x00000001
235 #define EFI_PROCESSOR_BUS_FREQUENCY_RECORD_NUMBER 0x00000002
236 #define EFI_PROCESSOR_VERSION_RECORD_NUMBER 0x00000003
237 #define EFI_PROCESSOR_MANUFACTURER_RECORD_NUMBER 0x00000004
238 #define EFI_PROCESSOR_SERIAL_NUMBER_RECORD_NUMBER 0x00000005
239 #define EFI_PROCESSOR_ID_RECORD_NUMBER 0x00000006
240 #define EFI_PROCESSOR_TYPE_RECORD_NUMBER 0x00000007
241 #define EFI_PROCESSOR_FAMILY_RECORD_NUMBER 0x00000008
242 #define EFI_PROCESSOR_VOLTAGE_RECORD_NUMBER 0x00000009
243 #define EFI_PROCESSOR_APIC_BASE_ADDRESS_RECORD_NUMBER 0x0000000A
244 #define EFI_PROCESSOR_APIC_ID_RECORD_NUMBER 0x0000000B
245 #define EFI_PROCESSOR_APIC_VER_NUMBER_RECORD_NUMBER 0x0000000C
246 #define EFI_PROCESSOR_MICROCODE_REVISION_RECORD_NUMBER 0x0000000D
247 #define EFI_PROCESSOR_STATUS_RECORD_NUMBER 0x0000000E
248 #define EFI_PROCESSOR_SOCKET_TYPE_RECORD_NUMBER 0x0000000F
249 #define EFI_PROCESSOR_SOCKET_NAME_RECORD_NUMBER 0x00000010
250 #define EFI_PROCESSOR_CACHE_ASSOCIATION_RECORD_NUMBER 0x00000011
251 #define EFI_PROCESSOR_MAX_FREQUENCY_RECORD_NUMBER 0x00000012
252 #define EFI_PROCESSOR_ASSET_TAG_RECORD_NUMBER 0x00000013
253 #define EFI_PROCESSOR_MAX_FSB_FREQUENCY_RECORD_NUMBER 0x00000014
254 #define EFI_PROCESSOR_PACKAGE_NUMBER_RECORD_NUMBER 0x00000015
255 #define EFI_PROCESSOR_FREQUENCY_LIST_RECORD_NUMBER 0x00000016
256 #define EFI_PROCESSOR_FSB_FREQUENCY_LIST_RECORD_NUMBER 0x00000017
257 #define EFI_PROCESSOR_HEALTH_STATUS_RECORD_NUMBER 0x00000018
258 Keeping this inconsistency for backward compatibility.
259
260 8. Guid/DataHubRecords.h
261 typedef union {
262 EFI_PROCESSOR_CORE_FREQUENCY_LIST_DATA ProcessorCoreFrequencyList;
263 ...
264 EFI_PROCESSOR_PACKAGE_NUMBER_DATA ProcessorPackageNumber;
265 } EFI_CPU_VARIABLE_RECORD;
266
267 typedef struct {
268 EFI_SUBCLASS_TYPE1_HEADER DataRecordHeader;
269 EFI_CPU_VARIABLE_RECORD VariableRecord;
270 } EFI_CPU_DATA_RECORD;
271
272 The definitions above are *NOT* defined in ProcSubclass specification 0.9. EdkII introduces them to simplify the
273 code logic. Therefore developer doesn't need to allocate memory dynamically to construct variable length data record.
274 Keeping this inconsistency for backward compatibility.
275
276 ##
277 # Mismatch with Intel Platform Innovation Framework for MemSubclass Specification (Version 0.90)
278 ##
279 1. Guid/DataHubRecords.h
280 typedef enum _EFI_MEMORY_FORM_FACTOR {
281 ...
282 EfiMemoryFormFactorFbDimm = 0x0F
283 } EFI_MEMORY_FORM_FACTOR;
284
285 typedef enum _EFI_MEMORY_ARRAY_TYPE {
286 ...
287 EfiMemoryTypeDdr2 = 0x13,
288 EfiMemoryTypeDdr2FbDimm = 0x14
289 } EFI_MEMORY_ARRAY_TYPE;
290
291 typedef enum {
292 ...
293 EfiMemoryStatePartial = 6
294 } EFI_MEMORY_STATE;
295
296 The fields listed above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support
297 new memory device (type 17) defined in SmBios 2.6 specification.
298 Keeping this inconsistency to reflect the latest industry standard.
299
300 2. Guid/DataHubRecords.h
301 typedef struct {
302 ...
303 EFI_EXP_BASE10_DATA MemorySpeed;
304 ...
305 } EFI_MEMORY_ARRAY_LINK_DATA;
306
307 The field name "MemorySpeed" in the definition above is *NOT* consistent with MemSubclass specification 0.9,
308 in which it is defined as MemoryTypeSpeed. Keeping this inconsistency for backward compatibility.
309
310 3. Guid/DataHubRecords.h
311 #define EFI_MEMORY_CONTROLLER_INFORMATION_RECORD_NUMBER 0x00000008
312
313 typedef enum {
314 EfiErrorDetectingMethodOther = 1,
315 EfiErrorDetectingMethodUnknown = 2,
316 EfiErrorDetectingMethodNone = 3,
317 EfiErrorDetectingMethodParity = 4,
318 EfiErrorDetectingMethod32Ecc = 5,
319 EfiErrorDetectingMethod64Ecc = 6,
320 EfiErrorDetectingMethod128Ecc = 7,
321 EfiErrorDetectingMethodCrc = 8
322 } EFI_MEMORY_ERROR_DETECT_METHOD_TYPE;
323
324 typedef struct {
325 UINT8 Other :1;
326 UINT8 Unknown :1;
327 UINT8 None :1;
328 UINT8 SingleBitErrorCorrect :1;
329 UINT8 DoubleBitErrorCorrect :1;
330 UINT8 ErrorScrubbing :1;
331 UINT8 Reserved :2;
332 } EFI_MEMORY_ERROR_CORRECT_CAPABILITY;
333
334 typedef enum {
335 EfiMemoryInterleaveOther = 1,
336 EfiMemoryInterleaveUnknown = 2,
337 EfiMemoryInterleaveOneWay = 3,
338 EfiMemoryInterleaveTwoWay = 4,
339 EfiMemoryInterleaveFourWay = 5,
340 EfiMemoryInterleaveEightWay = 6,
341 EfiMemoryInterleaveSixteenWay = 7
342 } EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE;
343
344 typedef struct {
345 UINT16 Other :1;
346 UINT16 Unknown :1;
347 UINT16 SeventyNs:1;
348 UINT16 SixtyNs :1;
349 UINT16 FiftyNs :1;
350 UINT16 Reserved :11;
351 } EFI_MEMORY_SPEED_TYPE;
352
353 typedef struct {
354 UINT16 Other :1;
355 UINT16 Unknown :1;
356 UINT16 Standard :1;
357 UINT16 FastPageMode:1;
358 UINT16 EDO :1;
359 UINT16 Parity :1;
360 UINT16 ECC :1;
361 UINT16 SIMM :1;
362 UINT16 DIMM :1;
363 UINT16 BurstEdo :1;
364 UINT16 SDRAM :1;
365 UINT16 Reserved :5;
366 } EFI_MEMORY_SUPPORTED_TYPE;
367
368 typedef struct {
369 UINT8 Five :1;
370 UINT8 Three :1;
371 UINT8 Two :1;
372 UINT8 Reserved:5;
373 } EFI_MEMORY_MODULE_VOLTAGE_TYPE;
374
375 typedef struct {
376 EFI_MEMORY_ERROR_DETECT_METHOD_TYPE ErrorDetectingMethod;
377 EFI_MEMORY_ERROR_CORRECT_CAPABILITY ErrorCorrectingCapability;
378 EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE MemorySupportedInterleave;
379 EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE MemoryCurrentInterleave;
380 UINT8 MaxMemoryModuleSize;
381 EFI_MEMORY_SPEED_TYPE MemorySpeedType;
382 EFI_MEMORY_SUPPORTED_TYPE MemorySupportedType;
383 EFI_MEMORY_MODULE_VOLTAGE_TYPE MemoryModuleVoltage;
384 UINT8 NumberofMemorySlot;
385 EFI_MEMORY_ERROR_CORRECT_CAPABILITY EnabledCorrectingCapability;
386 UINT16 *MemoryModuleConfigHandles;
387 } EFI_MEMORY_CONTROLLER_INFORMATION;
388
389 typedef struct {
390 EFI_MEMORY_ERROR_DETECT_METHOD_TYPE ErrorDetectingMethod;
391 EFI_MEMORY_ERROR_CORRECT_CAPABILITY ErrorCorrectingCapability;
392 EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE MemorySupportedInterleave;
393 EFI_MEMORY_SUPPORT_INTERLEAVE_TYPE MemoryCurrentInterleave;
394 UINT8 MaxMemoryModuleSize;
395 EFI_MEMORY_SPEED_TYPE MemorySpeedType;
396 EFI_MEMORY_SUPPORTED_TYPE MemorySupportedType;
397 EFI_MEMORY_MODULE_VOLTAGE_TYPE MemoryModuleVoltage;
398 UINT8 NumberofMemorySlot;
399 EFI_MEMORY_ERROR_CORRECT_CAPABILITY EnabledCorrectingCapability;
400 EFI_INTER_LINK_DATA MemoryModuleConfig[1];
401 } EFI_MEMORY_CONTROLLER_INFORMATION_DATA;
402
403 The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support
404 new memory controller information (type 5) defined in SmBios 2.6 specification.
405 Keeping this inconsistency to reflect the latest industry standard.
406
407 4. Guid/DataHubRecords.h
408 #define EFI_MEMORY_32BIT_ERROR_INFORMATION_RECORD_NUMBER 0x00000009
409
410 typedef enum {
411 EfiMemoryErrorOther = 1,
412 EfiMemoryErrorUnknown = 2,
413 EfiMemoryErrorOk = 3,
414 EfiMemoryErrorBadRead = 4,
415 EfiMemoryErrorParity = 5,
416 EfiMemoryErrorSigleBit = 6,
417 EfiMemoryErrorDoubleBit = 7,
418 EfiMemoryErrorMultiBit = 8,
419 EfiMemoryErrorNibble = 9,
420 EfiMemoryErrorChecksum = 10,
421 EfiMemoryErrorCrc = 11,
422 EfiMemoryErrorCorrectSingleBit = 12,
423 EfiMemoryErrorCorrected = 13,
424 EfiMemoryErrorUnCorrectable = 14
425 } EFI_MEMORY_ERROR_TYPE;
426
427 typedef enum {
428 EfiMemoryGranularityOther = 1,
429 EfiMemoryGranularityOtherUnknown = 2,
430 EfiMemoryGranularityDeviceLevel = 3,
431 EfiMemoryGranularityMemPartitionLevel = 4
432 } EFI_MEMORY_ERROR_GRANULARITY_TYPE;
433
434 typedef enum {
435 EfiMemoryErrorOperationOther = 1,
436 EfiMemoryErrorOperationUnknown = 2,
437 EfiMemoryErrorOperationRead = 3,
438 EfiMemoryErrorOperationWrite = 4,
439 EfiMemoryErrorOperationPartialWrite = 5
440 } EFI_MEMORY_ERROR_OPERATION_TYPE;
441
442 typedef struct {
443 EFI_MEMORY_ERROR_TYPE MemoryErrorType;
444 EFI_MEMORY_ERROR_GRANULARITY_TYPE MemoryErrorGranularity;
445 EFI_MEMORY_ERROR_OPERATION_TYPE MemoryErrorOperation;
446 UINT32 VendorSyndrome;
447 UINT32 MemoryArrayErrorAddress;
448 UINT32 DeviceErrorAddress;
449 UINT32 DeviceErrorResolution;
450 } EFI_MEMORY_32BIT_ERROR_INFORMATION;
451
452 The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support
453 new 32-bit memory error information (type 18) defined in SmBios 2.6 specification.
454 Keeping this inconsistency to reflect the latest industry standard.
455
456 5. Guid/DataHubRecords.h
457 #define EFI_MEMORY_64BIT_ERROR_INFORMATION_RECORD_NUMBER 0x0000000A
458
459 typedef struct {
460 EFI_MEMORY_ERROR_TYPE MemoryErrorType;
461 EFI_MEMORY_ERROR_GRANULARITY_TYPE MemoryErrorGranularity;
462 EFI_MEMORY_ERROR_OPERATION_TYPE MemoryErrorOperation;
463 UINT32 VendorSyndrome;
464 UINT64 MemoryArrayErrorAddress;
465 UINT64 DeviceErrorAddress;
466 UINT32 DeviceErrorResolution;
467 } EFI_MEMORY_64BIT_ERROR_INFORMATION;
468
469 The definitions above are *NOT* defined in MemSubclass specification 0.9. They are introduced to support
470 new 64-bit memory error information (type 33) defined in SmBios 2.6 specification.
471 Keeping this inconsistency to reflect the latest industry standard.
472
473 6. Guid/DataHubRecords.h
474 typedef union _EFI_MEMORY_SUBCLASS_RECORDS {
475 EFI_MEMORY_SIZE_DATA SizeData;
476 ...
477 EFI_MEMORY_64BIT_ERROR_INFORMATION Memory64bitErrorInfo;
478 } EFI_MEMORY_SUBCLASS_RECORDS;
479
480 typedef struct {
481 EFI_SUBCLASS_TYPE1_HEADER Header;
482 EFI_MEMORY_SUBCLASS_RECORDS Record;
483 } EFI_MEMORY_SUBCLASS_DRIVER_DATA;
484
485 The definitions above are *NOT* defined in MemSubclass specification 0.9. EdkII introduces them to simplify the
486 code logic. Therefore developer doesn't need to allocate memory dynamically to construct variable length data record.
487 Keeping this inconsistency for backward compatibility.
488
489 ##
490 # Mismatch with Intel Platform Innovation Framework for MiscSubclass Specification (Version 0.90)
491 ##
492 1. Guid/DataHubRecords.h
493 #pragma pack(1)
494 typedef struct _USB_PORT_DEVICE_PATH {
495 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
496 PCI_DEVICE_PATH PciBusDevicePath;
497 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
498 } USB_PORT_DEVICE_PATH;
499
500 typedef struct _IDE_DEVICE_PATH {
501 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
502 PCI_DEVICE_PATH PciBusDevicePath;
503 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
504 } IDE_DEVICE_PATH;
505
506 typedef struct _RMC_CONN_DEVICE_PATH {
507 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
508 PCI_DEVICE_PATH PciBridgeDevicePath;
509 PCI_DEVICE_PATH PciBusDevicePath;
510 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
511 } RMC_CONN_DEVICE_PATH;
512
513 typedef struct _RIDE_DEVICE_PATH {
514 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
515 PCI_DEVICE_PATH PciBridgeDevicePath;
516 PCI_DEVICE_PATH PciBusDevicePath;
517 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
518 } RIDE_DEVICE_PATH;
519
520 typedef struct _GB_NIC_DEVICE_PATH {
521 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
522 PCI_DEVICE_PATH PciBridgeDevicePath;
523 PCI_DEVICE_PATH PciXBridgeDevicePath;
524 PCI_DEVICE_PATH PciXBusDevicePath;
525 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
526 } GB_NIC_DEVICE_PATH;
527
528 typedef struct _PS2_CONN_DEVICE_PATH {
529 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
530 PCI_DEVICE_PATH LpcBridgeDevicePath;
531 ACPI_HID_DEVICE_PATH LpcBusDevicePath;
532 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
533 } PS2_CONN_DEVICE_PATH;
534
535 typedef struct _SERIAL_CONN_DEVICE_PATH {
536 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
537 PCI_DEVICE_PATH LpcBridgeDevicePath;
538 ACPI_HID_DEVICE_PATH LpcBusDevicePath;
539 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
540 } SERIAL_CONN_DEVICE_PATH;
541
542 typedef struct _PARALLEL_CONN_DEVICE_PATH {
543 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
544 PCI_DEVICE_PATH LpcBridgeDevicePath;
545 ACPI_HID_DEVICE_PATH LpcBusDevicePath;
546 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
547 } PARALLEL_CONN_DEVICE_PATH;
548
549 typedef struct _FLOOPY_CONN_DEVICE_PATH {
550 ACPI_HID_DEVICE_PATH PciRootBridgeDevicePath;
551 PCI_DEVICE_PATH LpcBridgeDevicePath;
552 ACPI_HID_DEVICE_PATH LpcBusDevicePath;
553 EFI_DEVICE_PATH_PROTOCOL EndDevicePath;
554 } FLOOPY_CONN_DEVICE_PATH;
555
556 typedef union _EFI_MISC_PORT_DEVICE_PATH {
557 USB_PORT_DEVICE_PATH UsbDevicePath;
558 IDE_DEVICE_PATH IdeDevicePath;
559 RMC_CONN_DEVICE_PATH RmcConnDevicePath;
560 RIDE_DEVICE_PATH RideDevicePath;
561 GB_NIC_DEVICE_PATH GbNicDevicePath;
562 PS2_CONN_DEVICE_PATH Ps2ConnDevicePath;
563 SERIAL_CONN_DEVICE_PATH SerialConnDevicePath;
564 PARALLEL_CONN_DEVICE_PATH ParallelConnDevicePath;
565 FLOOPY_CONN_DEVICE_PATH FloppyConnDevicePath;
566 } EFI_MISC_PORT_DEVICE_PATH;
567 #pragma pack()
568
569 a. The definitions above are *NOT* defined in MiscSubclass specifications 0.9. EdkII introduces them to simplify the
570 code logic. Therefore developer doesn't need to allocate memory dynamically to construct variable length device
571 path for various device.
572 Keeping this inconsistency for backward compatibility.
573
574 b. The definitions above are packed. This way violates the rule of alignment defined in DataHubSubclass specification.
575 Section "Alignment" in DataHubSubclass specification say "Fields in a data hub record should be aligned at their
576 natural boundaries". Keeping this inconsistency for backward compatibility.
577
578 2. Guid/DataHubRecords.h
579 typedef struct {
580 ...
581 EFI_MISC_PORT_DEVICE_PATH PortPath;
582 } EFI_MISC_PORT_INTERNAL_CONNECTOR_DESIGNATOR_DATA;
583
584 The definition is *NOT* consistent with MiscSubclass specification, in which the type of last field is defined as
585 "EFI_DEVICE_PATH_PROTOCOL". The definition in Specification may bring a little complexity on implementation. User
586 have to allocate variable length memory to contain device path info and free them finially.
587 EdkII introduced an union type named EFI_MISC_PORT_DEVICE_PATH to avoid the logic above.
588
589 3. Guid/DataHubRecords.h
590 typedef struct {
591 ...
592 UINT8 BiosMajorRelease;
593 UINT8 BiosMinorRelease;
594 UINT8 BiosEmbeddedFirmwareMajorRelease;
595 UINT8 BiosEmbeddedFirmwareMinorRelease;
596 } EFI_MISC_BIOS_VENDOR_DATA;
597
598 The fields listed above are *NOT* defined in MiscSubclass specification 0.9. They are introduced to support
599 new bios information (type 0) defined in SmBios 2.6 specification.
600 Keeping this inconsistency to reflect the latest industry standard.
601
602 4. Guid/DataHubRecords.h
603 typedef struct {
604 ...
605 STRING_REF SystemSKUNumber;
606 STRING_REF SystemFamily;
607 } EFI_MISC_SYSTEM_MANUFACTURER_DATA;
608
609 The fields listed above are *NOT* defined in MiscSubclass specification 0.9. They are introduced to support
610 new system information (type 1) defined in SmBios 2.6 specification.
611 Keeping this inconsistency to reflect the latest industry standard.
612
613 5. Guid/DataHubRecords.h
614 typedef struct {
615 ...
616 EFI_INTER_LINK_DATA ManagementDeviceThresholdLink;
617 } EFI_MISC_MANAGEMENT_DEVICE_COMPONENT_DESCRIPTION_DATA;
618
619 The field listed above is *NOT* defined in MiscSubclass specification 0.9. It is introduced to support
620 new management device component (type 35) defined in SmBios 2.6 specification.
621 Keeping this inconsistency to reflect the latest industry standard.
622
623 6. Guid/DataHubRecords.h
624 typedef struct {
625 UINT32 ChassisType :16;
626 UINT32 ChassisLockPresent:1;
627 UINT32 Reserved :15;
628 } EFI_MISC_CHASSIS_STATUS;
629
630 The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the first field is assigned a wrong field
631 name "EFI_MISC_CHASSIS_TYPE". Due to EFI_MISC_CHASSIS_TYPE has been declared as a data type, it can not be used as a
632 field name again. EdkII changes its name to "ChassisType" to pass build.
633
634 7. Guid/DataHubRecords.h
635 typedef enum {
636 ...
637 EfiSlotTypeAgp2X = 0x10,
638 ...
639 EfiSlotTypePciExpress = 0xA5
640 } EFI_MISC_SLOT_TYPE;
641
642 a. The field name "EfiSlotTypeAgp2X" is *NOT* consistent with MiscSubclass specification 0.9, in which it is named
643 "EfiSlotTypeApg2X".
644 From its literal sense, this field represents a AGP type display card, so it should be named as "EfiSlotTypeAgp2X".
645 b. The "EfiSlotTypePciExpress" field is *NOT* defined in MiscSubclass specification 0.9. It isintroduced to support
646 new system slots (type 9) defined in SmBios 2.6 specification.
647 Keeping this inconsistency to reflect the latest industry standard.
648
649 8. Guid/DataHubRecords.h
650 typedef struct {
651 ...
652 EFI_MISC_ONBOARD_DEVICE_STATUS OnBoardDeviceStatus;
653 ...
654 } EFI_MISC_ONBOARD_DEVICE_DATA;
655
656 The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the field "OnBoardDeviceStatus" is
657 named as "OnBoardDeviceType". Keeping this inconsistency for backward compatibility.
658
659 9. Guid/DataHubRecords.h
660 #define EFI_MISC_PORTABLE_BATTERY_RECORD_NUMBER 0x00000010
661
662 The name of the definition is *NOT* consistent with MiscSubclass specification 0.9, in which it is defined as
663 "EFI_MISC_BATTERY_LOCATION_RECORD_NUMBER". Keeping this inconsistency for backward compatibility.
664
665 10. Guid/DataHubRecords.h
666 typedef enum {
667 EfiPortableBatteryDeviceChemistryOther = 1,
668 EfiPortableBatteryDeviceChemistryUnknown = 2,
669 EfiPortableBatteryDeviceChemistryLeadAcid = 3,
670 EfiPortableBatteryDeviceChemistryNickelCadmium = 4,
671 EfiPortableBatteryDeviceChemistryNickelMetalHydride = 5,
672 EfiPortableBatteryDeviceChemistryLithiumIon = 6,
673 EfiPortableBatteryDeviceChemistryZincAir = 7,
674 EfiPortableBatteryDeviceChemistryLithiumPolymer = 8
675 } EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY;
676
677 The name of the definition is *NOT* consistent with MiscSubclass specification, in which it is defined as
678 "EFI_MISC_BATTERY_DEVICE_CHEMISTRY". And all field names have a redundant "Portable" string compared with MisSubclass
679 specification 0.9.
680 Keeping this inconsistency for backward compatibility.
681
682 11. Guid/DataHubRecords.h
683 typedef struct {
684 STRING_REF Location;
685 STRING_REF Manufacturer;
686 STRING_REF ManufactureDate;
687 STRING_REF SerialNumber;
688 STRING_REF DeviceName;
689 EFI_MISC_PORTABLE_BATTERY_DEVICE_CHEMISTRY DeviceChemistry;
690 UINT16 DesignCapacity;
691 UINT16 DesignVoltage;
692 STRING_REF SBDSVersionNumber;
693 UINT8 MaximumError;
694 UINT16 SBDSSerialNumber;
695 UINT16 SBDSManufactureDate;
696 STRING_REF SBDSDeviceChemistry;
697 UINT8 DesignCapacityMultiplier;
698 UINT32 OEMSpecific;
699 UINT8 BatteryNumber;
700 BOOLEAN Valid;
701 } EFI_MISC_PORTABLE_BATTERY;
702
703 The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the structure name is defined as
704 "EFI_MISC_BATTERY_LOCATION_DATA". Moreover, the name and the order of all fields are also different with MiscSubclass
705 specification 0.9. Keeping this inconsistency for backward compatibility.
706
707 12. Guid/DataHubRecords.h
708 typedef enum {
709 ...
710 } EFI_MISC_BOOT_INFORMATION_STATUS_DATA_TYPE;
711
712 The name of the definition is *NOT* consistent with MiscSubclass specification 0.9, in which it is defined as
713 "EFI_MISC_BOOT_INFORMATION_STATUS_TYPE". Keeping this inconsistency for backward compatibility.
714
715 13. Guid/DataHubRecords.h
716 typedef struct {
717 EFI_MISC_BOOT_INFORMATION_STATUS_DATA_TYPE BootInformationStatus;
718 ...
719 } EFI_MISC_BOOT_INFORMATION_STATUS_DATA;
720
721 The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is
722 "EFI_MISC_BOOT_INFORMATION_STATUS_TYPE". Keeping this inconsistency for backward compatibility.
723
724 14. Guid/DataHubRecords.h
725 typedef struct {
726 ...
727 } EFI_MISC_SYSTEM_POWER_SUPPLY_DATA;
728
729 The name of the definition is *NOT* consistent with MiscSubclass specification 0.9, in which it is defined as
730 "EFI_MISC_POWER_SUPPLY_UNIT_GROUP_DATA". Keeping this inconsistency for backward compatibility.
731
732 15. Guid/DataHubRecords.h
733 typedef struct {
734 ...
735 } SMBIOS_STRUCTURE_HDR;
736
737 The name of the definition is *NOT* consistent with MiscSubclass specification 0.9, in which the structure name
738 is defined as "EFI_SMBIOS_STRUCTURE_HDR". Due to this structure is commonly used by vendor to construct SmBios
739 type 0x80~0xFF table, Keeping this inconsistency for backward compatibility.
740
741 16. Guid/DataHubRecords.h
742 typedef struct {
743 SMBIOS_STRUCTURE_HDR Header;
744 ...
745 } EFI_MISC_SMBIOS_STRUCT_ENCAPSULATION_DATA;
746
747 The definition is *NOT* consistent with MiscSubclass specification 0.9, in which the type of the first field is
748 "EFI_SMBIOS_STRUCTURE_HDR". Keeping this inconsistency for backward compatibility.
749
750 17. Guid/DataHubRecords.h
751 typedef struct {
752 UINT16 PowerSupplyHotReplaceable:1;
753 UINT16 PowerSupplyPresent :1;
754 UINT16 PowerSupplyUnplugged :1;
755 UINT16 InputVoltageRangeSwitch :4;
756 UINT16 PowerSupplyStatus :3;
757 UINT16 PowerSupplyType :4;
758 UINT16 Reserved :2;
759 } EFI_MISC_POWER_SUPPLY_CHARACTERISTICS;
760
761 all field type in the definition are *NOT* consistent with MiscSubclass specification 0.9, in which it is defined as
762 "UINT32" and the total width of bit-fields is 32bits width.
763 Keeping this inconsistency for backward compatibility.
764
765 18. Guid/DataHubRecords.h
766 #define EFI_MISC_SYSTEM_EVENT_LOG_RECORD_NUMBER 0x00000020
767
768 typedef struct {
769 UINT16 LogAreaLength;
770 UINT16 LogHeaderStartOffset;
771 UINT16 LogDataStartOffset;
772 UINT8 AccessMethod;
773 UINT8 LogStatus;
774 UINT32 LogChangeToken;
775 UINT32 AccessMethodAddress;
776 UINT8 LogHeaderFormat;
777 UINT8 NumberOfSupportedLogType;
778 UINT8 LengthOfLogDescriptor;
779 } EFI_MISC_SYSTEM_EVENT_LOG_DATA;
780
781 #define ACCESS_INDEXIO_1INDEX8BIT_DATA8BIT 0x00
782 #define ACCESS_INDEXIO_2INDEX8BIT_DATA8BIT 0X01
783 #define ACCESS_INDEXIO_1INDEX16BIT_DATA8BIT 0X02
784 #define ACCESS_MEMORY_MAPPED 0x03
785 #define ACCESS_GPNV 0x04
786
787 The definitions listed above are *NOT* defined in MiscSubclass specification 0.9. It is introduced to support
788 new system event log (type 15) defined in SmBios 2.6 specification.
789 Keeping this inconsistency to reflect the latest industry standard.
790
791 19. Guid/DataHubRecords.h
792 #define EFI_MISC_MANAGEMENT_DEVICE_THRESHOLD_RECORD_NUMBER 0x00000021
793
794 typedef struct {
795 UINT16 LowerThresNonCritical;
796 UINT16 UpperThresNonCritical;
797 UINT16 LowerThresCritical;
798 UINT16 UpperThresCritical;
799 UINT16 LowerThresNonRecover;
800 UINT16 UpperThresNonRecover;
801 } EFI_MISC_MANAGEMENT_DEVICE_THRESHOLD;
802
803 The definitions listed above are *NOT* defined in MiscSubclass specification 0.9. It is introduced to support
804 new management device threshold data (type 36) defined in SmBios 2.6 specification.
805 Keeping this inconsistency to reflect the latest industry standard.
806
807 20. Guid/DataHubRecords.h
808 typedef union {
809 EFI_MISC_LAST_PCI_BUS_DATA LastPciBus;
810 ...
811 EFI_MISC_MANAGEMENT_DEVICE_THRESHOLD MiscManagementDeviceThreshold;
812 } EFI_MISC_SUBCLASS_RECORDS;
813
814 typedef struct {
815 EFI_SUBCLASS_TYPE1_HEADER Header;
816 EFI_MISC_SUBCLASS_RECORDS Record;
817 } EFI_MISC_SUBCLASS_DRIVER_DATA;
818
819 The definitions above are *NOT* defined in MemSubclass specification 0.9. EdkII introduces them to simplify the
820 code logic. Therefore developer doesn't need to allocate memory dynamically to construct variable length data record.
821 Keeping this inconsistency for backward compatibility.
822
823 ##
824 # Mismatch with Intel Platform Innovation Framework for Status Codes Specification (Version 0.92)
825 ##
826 1. Include/Framework/StatusCode.h
827 #define EFI_IOB_ATA_BUS_SMART_ENABLE (EFI_SUBCLASS_SPECIFIC | 0x00000000)
828 #define EFI_IOB_ATA_BUS_SMART_DISABLE (EFI_SUBCLASS_SPECIFIC | 0x00000001)
829 #define EFI_IOB_ATA_BUS_SMART_OVERTHRESHOLD (EFI_SUBCLASS_SPECIFIC | 0x00000002)
830 #define EFI_IOB_ATA_BUS_SMART_UNDERTHRESHOLD (EFI_SUBCLASS_SPECIFIC | 0x00000003)
831
832 #define EFI_IOB_ATA_BUS_SMART_NOTSUPPORTED (EFI_SUBCLASS_SPECIFIC | 0x00000000)
833 #define EFI_IOB_ATA_BUS_SMART_DISABLED (EFI_SUBCLASS_SPECIFIC | 0x00000001)
834
835 #define EFI_SW_DXE_BS_PC_BEGIN_CONNECTING_DRIVERS (EFI_SUBCLASS_SPECIFIC | 0x00000005)
836 #define EFI_SW_DXE_BS_PC_VERIFYING_PASSWORD (EFI_SUBCLASS_SPECIFIC | 0x00000006)
837
838 #define EFI_SW_DXE_RT_PC_S0 (EFI_SUBCLASS_SPECIFIC | 0x00000000)
839 #define EFI_SW_DXE_RT_PC_S1 (EFI_SUBCLASS_SPECIFIC | 0x00000001)
840 #define EFI_SW_DXE_RT_PC_S2 (EFI_SUBCLASS_SPECIFIC | 0x00000002)
841 #define EFI_SW_DXE_RT_PC_S3 (EFI_SUBCLASS_SPECIFIC | 0x00000003)
842 #define EFI_SW_DXE_RT_PC_S4 (EFI_SUBCLASS_SPECIFIC | 0x00000004)
843 #define EFI_SW_DXE_RT_PC_S5 (EFI_SUBCLASS_SPECIFIC | 0x00000005)
844
845 #define EFI_SW_CSM_LEGACY_ROM_INIT (EFI_SUBCLASS_SPECIFIC | 0x00000000)
846
847 The definitions above are *NOT* defined in Framework StatusCodes specification 0.92. But these subclass-specific error code
848 operations are needed for EdkII implementation.
849 Keeping this inconsistency for backward compatibility.
850
851 2. Include/Framework/StatusCode.h
852 typedef union {
853 CHAR8 *Ascii;
854 CHAR16 *Unicode;
855 ...
856 } EFI_STATUS_CODE_STRING;
857
858 The definition is *NOT* consistent with Framework SatausCodes specification 0.92, in which the first field is defined as "CHAR8 Ascii[]"
859 and the second field is defined as "CHAR16 Unicode[]". Keeping this inconsistency for backward compatibility.
860
861 3. Include/Framework/StatusCode.h
862 #define EFI_SW_EC_X64_DIVIDE_ERROR EXCEPT_X64_DIVIDE_ERROR
863 #define EFI_SW_EC_X64_DEBUG EXCEPT_X64_DEBUG
864 #define EFI_SW_EC_X64_NMI EXCEPT_X64_NMI
865 #define EFI_SW_EC_X64_BREAKPOINT EXCEPT_X64_BREAKPOINT
866 #define EFI_SW_EC_X64_OVERFLOW EXCEPT_X64_OVERFLOW
867 #define EFI_SW_EC_X64_BOUND EXCEPT_X64_BOUND
868 #define EFI_SW_EC_X64_INVALID_OPCODE EXCEPT_X64_INVALID_OPCODE
869 #define EFI_SW_EC_X64_DOUBLE_FAULT EXCEPT_X64_DOUBLE_FAULT
870 #define EFI_SW_EC_X64_INVALID_TSS EXCEPT_X64_INVALID_TSS
871 #define EFI_SW_EC_X64_SEG_NOT_PRESENT EXCEPT_X64_SEG_NOT_PRESENT
872 #define EFI_SW_EC_X64_STACK_FAULT EXCEPT_X64_STACK_FAULT
873 #define EFI_SW_EC_X64_GP_FAULT EXCEPT_X64_GP_FAULT
874 #define EFI_SW_EC_X64_PAGE_FAULT EXCEPT_X64_PAGE_FAULT
875 #define EFI_SW_EC_X64_FP_ERROR EXCEPT_X64_FP_ERROR
876 #define EFI_SW_EC_X64_ALIGNMENT_CHECK EXCEPT_X64_ALIGNMENT_CHECK
877 #define EFI_SW_EC_X64_MACHINE_CHECK EXCEPT_X64_MACHINE_CHECK
878 #define EFI_SW_EC_X64_SIMD EXCEPT_X64_SIMD
879
880 The definitions are *NOT* defined in Framework StatusCodes specification 0.92, in which IA32 and IPF exception subclass error code definitions
881 are defined but omit the corresponding definitions for X64. EdkII introduce these definitions for implementation.
882
883 ##
884 # Mismatch with Intel Platform Innovation Framework for EFI Boot Script Specification (Version 0.91)
885 ##
886 1. Include/Protocol/BootScriptSave.h
887 #define EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID \
888 { \
889 0x470e1529, 0xb79e, 0x4e32, {0xa0, 0xfe, 0x6a, 0x15, 0x6d, 0x29, 0xf9, 0xb2 } \
890 }
891
892 The macro name "EFI_BOOT_SCRIPT_SAVE_PROTOCOL_GUID" is *NOT* consistent with Framework BootScript specification 0.91,
893 in which it's defined as "EFI_BOOT_SCRIPT_SAVE_GUID". Keeping this inconsistency for backward compatibility.
894
895 2. Include/Protocol/BootScriptSave.h
896 EFI_STATUS
897 EFI_BOOTSERVICE
898 (EFIAPI *EFI_BOOT_SCRIPT_WRITE) (
899 IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,
900 ...
901 );
902
903 The first parameter's type is *NOT* consistent with Framework BootScript specification 0.91, in which it's defined as
904 "struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL". Keeping this inconsistency for backward compatibility.
905
906 3. Include/Framework/BootScript.h
907 #define EFI_BOOT_SCRIPT_MEM_POLL_OPCODE 0x09
908 #define EFI_BOOT_SCRIPT_INFORMATION_OPCODE 0x0A
909 #define EFI_BOOT_SCRIPT_PCI_CONFIG2_WRITE_OPCODE 0x0B
910 #define EFI_BOOT_SCRIPT_PCI_CONFIG2_READ_WRITE_OPCODE 0x0C
911 #define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x0D
912
913 The OPCODEs above are not defined in Framework BootScript Specification 0.91, but adopted by PI 1.0 Spec. And they
914 are needed for EdkII implementation.
915
916 4. Include/Framework/BootScript.h
917 #define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA
918 #define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF
919
920 The two OPCODEs are *NOT* defined in Framework BootScript specification 0.91. EdkII introduces them to indicate the start
921 or end of the boot script table.
922 Keeping this inconsistency for backward compatibility.
923
924 5. Include/Protocol/BootScriptSave.h
925 typedef
926 EFI_STATUS
927 (EFIAPI *EFI_BOOT_SCRIPT_CLOSE_TABLE) (
928 IN EFI_BOOT_SCRIPT_SAVE_PROTOCOL *This,
929 ...
930 );
931
932 The first parameter's type is *NOT* consistent with BootScript specification, in which it's defined as
933 "struct _EFI_BOOT_SCRIPT_SAVE_PROTOCOL". Keeping this inconsistency for backward compatibility.
934
935 6. Include/Include/BootScriptExecuter.h
936 typedef
937 EFI_STATUS
938 (EFIAPI *EFI_PEI_BOOT_SCRIPT_EXECUTE)(
939 IN EFI_PEI_SERVICES **PeiServices,
940 IN EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI *This,
941 ...
942 );
943
944 The second parameter's type is *NOT* consistent with BootScript specification, in which it's defined as
945 "struct _EFI_PEI_BOOT_SCRIPT_EXECUTER_PPI". Keeping this inconsistency for backward compatibility.
946
947 ##
948 # Mismatch with Intel Platform Innovation Framework for EFI DXE CIS (Version 0.91)
949 ##
950 1. Include/Framework/DxeCis.h
951 EFI_STATUS_CODE_ARCH_PROTOCOL is removed.
952
953 EdkII doesn't provide EFI_STATUS_CODE_ARCH_PROTOCOL definition due to ReportStatusCode() field has been
954 removed from EFI Runtime Service Table of PI specification. EFI_STATUS_CODE_ARCH_PROTOCOL is *NOT* required,
955 and is replaced with EFI_STATUS_CODE_RUNTIME_PROTOCOL.
956
957 ##
958 # Mismatch with Intel Platform Innovation Framework for EFI Firmware Volume Specification (Version 0.9)
959 ##
960 1. Include/Framework/FirmwareVolumeImageFormat.h
961 #define EFI_AGGREGATE_AUTH_STATUS_ALL 0x00000f
962 #define EFI_LOCAL_AUTH_STATUS_ALL 0x0f0000
963
964 The two macros are *NOT* defined in Framework FV specification 0.9. EdkII introduces them as a mask to calculate the
965 value of authentication status.
966
967 ##
968 # Mismatch with Intel Platform Innovation Framework for EFI Human Interface Infrastructure Specification (Version 0.92)
969 ##
970 1. Include/Protocol/FrameworkHii.h
971 #define EFI_HII_PROTOCOL_GUID \
972 { \
973 0xd7ad636e, 0xb997, 0x459b, {0xbf, 0x3f, 0x88, 0x46, 0x89, 0x79, 0x80, 0xe1} \
974 }
975
976 The Framework HII specification 0.92 changed part of HII interfaces but did not update the protocol GUID.
977 This change should cause a change of GUID in both of code and HII spec. EdkII updates the GUID in code,
978 but the Framework HII specification 0.92 is not updated. This is a known issue.
979
980 2. Include/Protocol/FrameworkHii.h
981 typedef struct {
982 ...
983 EFI_HANDLE COBExportHandle;
984 } EFI_HII_HANDLE_PACK;
985
986 The last field "COBExportHandle" of EFI_HII_HANDLE_PACK is *NOT* defined in the Framework HII specification
987 0.92. Keeping this inconsistency for backward compatibility.
988
989 3. Include/Protocol/FrameworkHii.h
990 typedef struct {
991 UINTN NumberOfPackages;
992 EFI_GUID *GuidId;
993 } EFI_HII_PACKAGES;
994
995 The definition is *NOT* consistent with Framework HII specification 0.92, in which a field "HandlePack" is defined.
996 EdkII changes the EFI_HII_PACKAGES to contain various number of packages of different types just after the structure
997 as inline data, which will bring the flexibility on development.
998
999 4. Include/Protocol/FrameworkHii.h
1000 struct _EFI_HII_PROTOCOL {
1001 ...
1002 EFI_HII_RESET_STRINGS ResetStrings;
1003 ...
1004 };
1005
1006 The field listed above is *NOT* defined in Framework HII specification 0.92. EdkII adds this field to provide
1007 an ability of removing any new strings that were added after the initial string export for this handle.
1008
1009 5. Include/Protocol/FrameworkHii.h
1010 typedef
1011 EFI_STATUS
1012 (EFIAPI *EFI_HII_GLYPH_TO_BLT)(
1013 ...
1014 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Foreground,
1015 IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL Background,
1016 ...
1017 IN OUT EFI_GRAPHICS_OUTPUT_BLT_PIXEL *BltBuffer
1018 );
1019
1020 The type of the parameters listed above are *NOT* consistent with Framework HII specification 0.92, in which
1021 the type of these parameters is EFI_UGA_PIXEL. Here the definition uses the EFI_GRAPHICS_OUTPUT_BLT_PIXEL which
1022 defined in UEFI2.1 spec. Keeping this inconsistency for backward compatibility.
1023
1024 6. Include/Protocol/FrameworkHii.h
1025 typedef struct {
1026 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1027 UINT8 Flags;
1028 } EFI_IFR_SUPPRESS;
1029
1030 typedef struct {
1031 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1032 UINT8 Flags;
1033 } EFI_IFR_GRAY_OUT;
1034
1035 typedef struct {
1036 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1037 STRING_REF Popup;
1038 UINT8 Flags;
1039 } EFI_IFR_INCONSISTENT;
1040
1041 typedef struct {
1042 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1043 UINT16 QuestionId;
1044 UINT8 Width;
1045 UINT16 Value;
1046 } FRAMEWORK_EFI_IFR_EQ_ID_VAL;
1047
1048 typedef struct {
1049 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1050 UINT16 QuestionId;
1051 UINT8 Width;
1052 UINT16 ListLength;
1053 UINT16 ValueList[1];
1054 } FRAMEWORK_EFI_IFR_EQ_ID_LIST;
1055
1056 typedef struct {
1057 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1058 UINT16 QuestionId1;
1059 UINT8 Width;
1060 UINT16 QuestionId2;
1061 } FRAMEWORK_EFI_IFR_EQ_ID_ID;
1062
1063 typedef struct {
1064 FRAMEWORK_EFI_IFR_OP_HEADER Header;
1065 UINT16 VariableId;
1066 UINT16 Value;
1067 } EFI_IFR_EQ_VAR_VAL;
1068
1069 The defintions are not complied with Framework HII spec 0.92. Keeping the inconsistent for implementation needed.
1070
1071 7. Include/Protocol/FrameworkFormCallback.h
1072 #define RESET_REQUIRED 1
1073 #define EXIT_REQUIRED 2
1074 #define SAVE_REQUIRED 4
1075 #define NV_CHANGED 8
1076 #define NV_NOT_CHANGED 16
1077
1078 These macros are *NOT* defined in the Framework HII specification 0.92. These Flags are introduced to describe
1079 the standard behavior of the browser after the callback.
1080 Keeping this inconsistency for backward compatibility.
1081
1082 8. Include/Protocol/FrameworkFormCallback.h
1083 typedef
1084 EFI_STATUS
1085 (EFIAPI *EFI_NV_WRITE)(
1086 ...
1087 IN UINT32 Attributes,
1088 ...
1089 );
1090
1091 The definition is *NOT* consistent with Framework HII specification 0.92, in which the type of Attributes
1092 parameter is defined as "UINT32 *". EdkII changes the type of Attributes from UINT32 * to UINT32 because
1093 the input paramter is not necessary to use pointer date type.
1094
1095 ##
1096 # Mismatch with Intel Platform Innovation Framework for PEI CIS Specification (Version 0.91)
1097 ##
1098 1. Include/Ppi/ReadOnlyVariable.h
1099 #define EFI_VARIABLE_READ_ONLY 0x00000008
1100
1101 In Framework PeiCis specification 0.91, neither the macro or its value is defined.
1102 Keeping this inconsistency for backward compatibility.
1103
1104 2. Include/Ppi/FindFv.h
1105 typedef
1106 EFI_STATUS
1107 (EFIAPI *EFI_PEI_FIND_FV_FINDFV)(
1108 IN EFI_PEI_FIND_FV_PPI *This,
1109 IN EFI_PEI_SERVICES **PeiServices,
1110 IN UINT8 *FvNumber,
1111 IN OUT EFI_FIRMWARE_VOLUME_HEADER **FVAddress
1112 );
1113
1114 The definition is *NOT* consistent with Framework PeiCis specification 0.91. Compared with spec, the order
1115 of the first and second parameters is reversed. Keeping this inconsistency for backward compatibility.
1116
1117 ##
1118 # Mismatch with Intel Platform Innovation Framework for EFI SMM CIS (Version 0.91)
1119 ##
1120 1. Include/Guid/SmramMemoryReserve.h
1121 typedef struct {
1122 ...
1123 } EFI_SMRAM_HOB_DESCRIPTOR_BLOCK;
1124
1125 The name of the definition is *NOT* consistent with Framework SmmCis specification 0.91, in which it's
1126 defined as "EFI_HOB_SMRAM_DESCRIPTOR_BLOCK" rather than "EFI_SMRAM_HOB_DESCRIPTOR_BLOCK".
1127 Keeping this inconsistency for backward compatibility.
1128
1129 2. Include/Guid/SmramMemoryReserve.h
1130 typedef enum {
1131 ...
1132 IchnIoTrap3,
1133 IchnIoTrap2,
1134 IchnIoTrap1,
1135 IchnIoTrap0,
1136 IchnPciExpress,
1137 IchnMonitor,
1138 IchnSpi,
1139 IchnQRT,
1140 IchnGpioUnlock,
1141 ...
1142 } EFI_SMM_ICHN_SMI_TYPE;
1143
1144 The enumeration fields listed above are *NOT* defined in Framework SmmCis specification 0.91. EdkII introduces
1145 these fields to support new SMI types.
1146
1147 ##
1148 # Mismatch with Intel Platform Innovation Framework for EFI S3 Resume Boot Path Specification (Version 0.9)
1149 ##
1150 1. Include/Protocol/AcpiS3Save.h
1151 typedef
1152 EFI_STATUS
1153 EFI_BOOTSERVICE
1154 (EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE) (
1155 IN EFI_ACPI_S3_SAVE_PROTOCOL *This,
1156 OUT UINTN *Size
1157 );
1158
1159 The first parameter's type is *NOT* consistent with Framework S3Resume specification, in which it's defined as
1160 "struct _EFI_ACPI_S3_SAVE_PROTOCOL". Keeping this inconsistency for backward compatibility.
1161
1162 2. Include/Protocol/AcpiS3Save.h
1163 typedef
1164 EFI_STATUS
1165 (EFIAPI *EFI_ACPI_S3_SAVE) (
1166 IN EFI_ACPI_S3_SAVE_PROTOCOL *This,
1167 IN VOID *LegacyMemoryAddress
1168 );
1169
1170 The first parameter's type is *NOT* consistent with Framework S3Resume specification, in which it's defined as
1171 "struct _EFI_ACPI_S3_SAVE_PROTOCOL". Also the EFI_BOOTSERVICE modifier is removed from the function declaration.
1172
1173 3. Include/Protocol/AcpiS3Save.h
1174 typedef
1175 EFI_STATUS
1176 (EFIAPI *EFI_ACPI_GET_LEGACY_MEMORY_SIZE)(
1177 IN EFI_ACPI_S3_SAVE_PROTOCOL *This,
1178 OUT UINTN *Size
1179 );
1180
1181 The first parameter's type is *NOT* consistent with Framework S3Resume specification, in which it's defined as
1182 "struct _EFI_ACPI_S3_SAVE_PROTOCOL". Also the EFI_BOOTSERVICE modifier is removed from the function declaration.
1183
1184 ##
1185 # Mismatch with Intel Platform Innovation Framework for EFI ACPI Specification (Version 0.91)
1186 ##
1187 1. Include/Protocol/AcpiSupport.h
1188 typedef
1189 EFI_STATUS
1190 (EFIAPI *EFI_ACPI_GET_ACPI_TABLE)(
1191 ...
1192 );
1193
1194 The function modifier is *NOT* consistent with Framework Acpi specification. The EFI_BOOTSERVICE modifier
1195 is removed from the function declaration.
1196
1197 2. Include/Protocol/AcpiSupport.h
1198 typedef
1199 EFI_STATUS
1200 (EFIAPI *EFI_ACPI_SET_ACPI_TABLE)(
1201 ...
1202 );
1203
1204 The function modifier is *NOT* consistent with Framework Acpi specification. The EFI_BOOTSERVICE modifier
1205 is removed from the function declaration.
1206
1207 3. Include/Protocol/AcpiSupport.h
1208 typedef
1209 EFI_STATUS
1210 (EFIAPI *EFI_ACPI_PUBLISH_TABLES)(
1211 ...
1212 );
1213
1214 The function modifier is *NOT* consistent with Framework Acpi specification. The EFI_BOOTSERVICE modifier
1215 is removed from the function declaration.