2 This file defines the data structures to support Status Code Data.
4 Copyright (c) 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: FrameworkStatusCodeDataTypeId.h
15 @par Revision Reference:
16 These definitions are from Framework of EFI Status Code Spec
21 #ifndef __FRAMEWORK_STATUS_CODE_DATA_TYPE_ID_H__
22 #define __FRAMEWORK_STATUS_CODE_DATA_TYPE_ID_H__
24 #include <Framework/DataHubRecords.h>
25 #include <Protocol/DebugSupport.h>
28 /// The size of string
30 #define EFI_STATUS_CODE_DATA_MAX_STRING_SIZE 150
33 /// This is the max data size including all the headers which can be passed
34 /// as Status Code data. This data should be multiple of 8 byte
35 /// to avoid any kind of boundary issue. Also, sum of this data size (inclusive
36 /// of size of EFI_STATUS_CODE_DATA should not exceed the max record size of
39 #define EFI_STATUS_CODE_DATA_MAX_SIZE 200
49 EFI_HII_HANDLE Handle
;
51 } EFI_STATUS_CODE_STRING_TOKEN
;
56 EFI_STATUS_CODE_STRING_TOKEN Hii
;
57 } EFI_STATUS_CODE_STRING
;
60 EFI_STATUS_CODE_DATA DataHeader
;
61 EFI_STRING_TYPE StringType
;
62 EFI_STATUS_CODE_STRING String
;
63 } EFI_STATUS_CODE_STRING_DATA
;
72 // 12 * sizeof (UINT64) Var Arg stack
74 // ascii DEBUG () Format string
81 // declaration for EFI_EXP_DATA. This may change
83 // typedef UINTN EFI_EXP_DATA;
86 /// Voltage Extended Error Data
89 EFI_STATUS_CODE_DATA DataHeader
;
90 EFI_EXP_BASE10_DATA Voltage
;
91 EFI_EXP_BASE10_DATA Threshold
;
92 } EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA
;
95 EFI_EXP_BASE10_DATA Voltage
;
96 EFI_EXP_BASE10_DATA Threshold
;
97 } EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA_PAYLOAD
;
100 /// Microcode Update Extended Error Data
103 EFI_STATUS_CODE_DATA DataHeader
;
105 } EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA
;
109 } EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA_PAYLOAD
;
112 /// Asynchronous Timer Extended Error Data
115 EFI_STATUS_CODE_DATA DataHeader
;
116 EFI_EXP_BASE10_DATA TimerLimit
;
117 } EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA
;
120 EFI_EXP_BASE10_DATA TimerLimit
;
121 } EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA_PAYLOAD
;
124 /// Host Processor Mismatch Extended Error Data
127 EFI_STATUS_CODE_DATA DataHeader
;
130 } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA
;
135 } EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA_PAYLOAD
;
138 // EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES
139 // All other attributes are reserved for future use and
140 // must be initialized to 0.
142 #define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001
143 #define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002
144 #define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004
145 #define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008
146 #define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010
147 #define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020
148 #define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000
149 #define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000
150 #define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000
151 #define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000
154 /// Thermal Extended Error Data
157 EFI_STATUS_CODE_DATA DataHeader
;
158 EFI_EXP_BASE10_DATA Temperature
;
159 EFI_EXP_BASE10_DATA Threshold
;
160 } EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA
;
163 EFI_EXP_BASE10_DATA Temperature
;
164 EFI_EXP_BASE10_DATA Threshold
;
165 } EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA_PAYLOAD
;
168 /// Processor Disabled Extended Error Data
171 EFI_STATUS_CODE_DATA DataHeader
;
173 BOOLEAN SoftwareDisabled
;
174 } EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA
;
178 BOOLEAN SoftwareDisabled
;
179 } EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA_PAYLOAD
;
182 EfiInitCacheDataOnly
,
183 EfiInitCacheInstrOnly
,
185 EfiInitCacheUnspecified
186 } EFI_INIT_CACHE_TYPE
;
189 /// Embedded cache init extended data
192 EFI_STATUS_CODE_DATA DataHeader
;
194 EFI_INIT_CACHE_TYPE Type
;
195 } EFI_CACHE_INIT_DATA
;
199 EFI_INIT_CACHE_TYPE Type
;
200 } EFI_CACHE_INIT_DATA_PAYLOAD
;
203 // Memory Extended Error Data
207 /// Memory Error Granularity Definition
209 typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY
;
212 /// Memory Error Operation Definition
214 typedef UINT8 EFI_MEMORY_ERROR_OPERATION
;
217 EFI_STATUS_CODE_DATA DataHeader
;
218 EFI_MEMORY_ERROR_GRANULARITY Granularity
;
219 EFI_MEMORY_ERROR_OPERATION Operation
;
221 EFI_PHYSICAL_ADDRESS Address
;
223 } EFI_MEMORY_EXTENDED_ERROR_DATA
;
226 EFI_MEMORY_ERROR_GRANULARITY Granularity
;
227 EFI_MEMORY_ERROR_OPERATION Operation
;
229 EFI_PHYSICAL_ADDRESS Address
;
231 } EFI_MEMORY_EXTENDED_ERROR_DATA_PAYLOAD
;
234 // Memory Error Granularities
236 #define EFI_MEMORY_ERROR_OTHER 0x01
237 #define EFI_MEMORY_ERROR_UNKNOWN 0x02
238 #define EFI_MEMORY_ERROR_DEVICE 0x03
239 #define EFI_MEMORY_ERROR_PARTITION 0x04
242 // Memory Error Operations
244 #define EFI_MEMORY_OPERATION_OTHER 0x01
245 #define EFI_MEMORY_OPERATION_UNKNOWN 0x02
246 #define EFI_MEMORY_OPERATION_READ 0x03
247 #define EFI_MEMORY_OPERATION_WRITE 0x04
248 #define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05
251 // Define shorthands to describe Group Operations
252 // Many memory init operations are essentially group
255 /// A shorthand to describe that the operation is performed
256 /// on multiple devices within the array
258 #define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe
260 /// A shorthand to describe that the operation is performed on all devices within the array
262 #define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff
264 /// A shorthand to describe that the operation is performed on multiple arrays
266 #define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe
268 /// A shorthand to describe that the operation is performed on all the arrays
270 #define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff
277 EFI_STATUS_CODE_DATA DataHeader
;
280 } EFI_STATUS_CODE_DIMM_NUMBER
;
285 } EFI_STATUS_CODE_DIMM_NUMBER_PAYLOAD
;
289 /// Memory Module Mismatch Extended Error Data
292 EFI_STATUS_CODE_DATA DataHeader
;
293 EFI_STATUS_CODE_DIMM_NUMBER Instance
;
294 } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA
;
297 EFI_STATUS_CODE_DIMM_NUMBER Instance
;
298 } EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA_PAYLOAD
;
301 /// Memory Range Extended Data
304 EFI_STATUS_CODE_DATA DataHeader
;
305 EFI_PHYSICAL_ADDRESS Start
;
306 EFI_PHYSICAL_ADDRESS Length
;
307 } EFI_MEMORY_RANGE_EXTENDED_DATA
;
310 EFI_PHYSICAL_ADDRESS Start
;
311 EFI_PHYSICAL_ADDRESS Length
;
312 } EFI_MEMORY_RANGE_EXTENDED_DATA_PAYLOAD
;
315 /// Device handle Extended Data. Used for many
316 /// errors and progress codes to point to the device.
319 EFI_STATUS_CODE_DATA DataHeader
;
321 } EFI_DEVICE_HANDLE_EXTENDED_DATA
;
324 EFI_STATUS_CODE_DATA DataHeader
;
326 } EFI_DEVICE_PATH_EXTENDED_DATA
;
329 EFI_STATUS_CODE_DATA DataHeader
;
330 EFI_HANDLE ControllerHandle
;
331 EFI_HANDLE DriverBindingHandle
;
332 UINT16 DevicePathSize
;
333 UINT8
*RemainingDevicePath
;
334 } EFI_STATUS_CODE_START_EXTENDED_DATA
;
338 } EFI_DEVICE_HANDLE_EXTENDED_DATA_PAYLOAD
;
342 } EFI_DEVICE_PATH_EXTENDED_DATA_PAYLOAD
;
345 EFI_HANDLE ControllerHandle
;
346 EFI_HANDLE DriverBindingHandle
;
347 UINT16 DevicePathSize
;
348 UINT8
*RemainingDevicePath
;
349 } EFI_STATUS_CODE_START_EXTENDED_DATA_PAYLOAD
;
352 /// Resource Allocation Failure Extended Error Data
357 EFI_STATUS_CODE_DATA DataHeader;
358 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
362 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;
365 EFI_STATUS_CODE_DATA DataHeader
;
367 UINT16 DevicePathSize
;
373 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA
;
377 UINT16 DevicePathSize
;
383 } EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA_PAYLOAD
;
386 /// Extended Error Data for Assert
389 EFI_STATUS_CODE_DATA DataHeader
;
392 EFI_STATUS_CODE_STRING_DATA
*FileName
;
393 } EFI_DEBUG_ASSERT_DATA
;
398 EFI_STATUS_CODE_STRING_DATA
*FileName
;
399 } EFI_DEBUG_ASSERT_DATA_PAYLOAD
;
402 /// System Context Data EBC/IA32/IPF
405 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc
;
406 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32
;
407 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf
;
408 } EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT
;
411 EFI_STATUS_CODE_DATA DataHeader
;
412 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context
;
413 } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA
;
416 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context
;
417 } EFI_STATUS_CODE_EXCEP_EXTENDED_DATA_PAYLOAD
;
420 /// Legacy Oprom extended data
423 EFI_STATUS_CODE_DATA DataHeader
;
424 EFI_HANDLE DeviceHandle
;
425 EFI_PHYSICAL_ADDRESS RomImageBase
;
426 } EFI_LEGACY_OPROM_EXTENDED_DATA
;
429 EFI_HANDLE DeviceHandle
;
430 EFI_PHYSICAL_ADDRESS RomImageBase
;
431 } EFI_LEGACY_OPROM_EXTENDED_DATA_PAYLOAD
;