]> git.proxmox.com Git - mirror_edk2.git/blame - OldMdePkg/Include/Common/StatusCodeDataTypeId.h
Moved the MdePkg to OldMdePkg so that new code in MdePkg does not break existing...
[mirror_edk2.git] / OldMdePkg / Include / Common / StatusCodeDataTypeId.h
CommitLineData
878ddf1f 1/** @file\r
2 This file defines the data structures to support Status Code Data.\r
3\r
4 Copyright (c) 2006, Intel Corporation \r
5 All rights reserved. This program and the accompanying materials \r
6 are licensed and made available under the terms and conditions of the BSD License \r
7 which accompanies this distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13 Module Name: StatusCodeDataTypeId.h\r
14\r
15 @par Revision Reference:\r
16 These definitions are from Framework of EFI Status Code Spec\r
17 Version 0.92.\r
18\r
19**/\r
20\r
21#ifndef __STATUS_CODE_DATA_TYPE_ID_H__\r
22#define __STATUS_CODE_DATA_TYPE_ID_H__\r
23\r
24\r
25///\r
26/// The size of string\r
27///\r
28#define EFI_STATUS_CODE_DATA_MAX_STRING_SIZE 150\r
29\r
30///\r
31/// This is the max data size including all the headers which can be passed\r
32/// as Status Code data. This data should be multiple of 8 byte\r
33/// to avoid any kind of boundary issue. Also, sum of this data size (inclusive\r
34/// of size of EFI_STATUS_CODE_DATA should not exceed the max record size of\r
35/// data hub\r
36///\r
37#define EFI_STATUS_CODE_DATA_MAX_SIZE 200\r
38\r
39#pragma pack(1)\r
40typedef enum {\r
41 EfiStringAscii,\r
42 EfiStringUnicode,\r
43 EfiStringToken\r
44} EFI_STRING_TYPE;\r
45\r
46typedef struct {\r
47 EFI_HII_HANDLE Handle;\r
48 STRING_REF Token;\r
49} EFI_STATUS_CODE_STRING_TOKEN;\r
50\r
51typedef union {\r
52 CHAR8 *Ascii;\r
53 CHAR16 *Unicode;\r
54 EFI_STATUS_CODE_STRING_TOKEN Hii;\r
55} EFI_STATUS_CODE_STRING;\r
56\r
57typedef struct {\r
58 EFI_STATUS_CODE_DATA DataHeader;\r
59 EFI_STRING_TYPE StringType;\r
60 EFI_STATUS_CODE_STRING String;\r
61} EFI_STATUS_CODE_STRING_DATA;\r
62\r
63#pragma pack()\r
64\r
65#pragma pack(1)\r
66\r
67typedef struct {\r
68 UINT32 ErrorLevel;\r
69 //\r
70 // 12 * sizeof (UINT64) Var Arg stack\r
71 //\r
72 // ascii DEBUG () Format string\r
73 //\r
74} EFI_DEBUG_INFO;\r
75\r
76#pragma pack()\r
77\r
78//\r
79// declaration for EFI_EXP_DATA. This may change\r
80//\r
81// typedef UINTN EFI_EXP_DATA;\r
82\r
83///\r
84/// Voltage Extended Error Data\r
85///\r
86typedef struct {\r
87 EFI_STATUS_CODE_DATA DataHeader;\r
88 EFI_EXP_BASE10_DATA Voltage;\r
89 EFI_EXP_BASE10_DATA Threshold;\r
90} EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r
91\r
92///\r
93/// Microcode Update Extended Error Data\r
94///\r
95typedef struct {\r
96 EFI_STATUS_CODE_DATA DataHeader;\r
97 UINT32 Version;\r
98} EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r
99\r
100///\r
101/// Asynchronous Timer Extended Error Data\r
102///\r
103typedef struct {\r
104 EFI_STATUS_CODE_DATA DataHeader;\r
105 EFI_EXP_BASE10_DATA TimerLimit;\r
106} EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r
107\r
108///\r
109/// Host Processor Mismatch Extended Error Data\r
110///\r
111typedef struct {\r
112 EFI_STATUS_CODE_DATA DataHeader;\r
113 UINT32 Instance;\r
114 UINT16 Attributes;\r
115} EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
116\r
117//\r
118// EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES\r
119// All other attributes are reserved for future use and\r
120// must be initialized to 0.\r
121//\r
122#define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001\r
123#define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002\r
124#define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004\r
125#define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008\r
126#define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010\r
127#define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020\r
128#define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000\r
129#define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000\r
130#define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000\r
131#define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000\r
132\r
133///\r
134/// Thermal Extended Error Data\r
135///\r
136typedef struct {\r
137 EFI_STATUS_CODE_DATA DataHeader;\r
138 EFI_EXP_BASE10_DATA Temperature;\r
139 EFI_EXP_BASE10_DATA Threshold;\r
140} EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r
141\r
142///\r
143/// Processor Disabled Extended Error Data\r
144///\r
145typedef struct {\r
146 EFI_STATUS_CODE_DATA DataHeader;\r
147 UINT32 Cause;\r
148 BOOLEAN SoftwareDisabled;\r
149} EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r
150\r
151typedef enum {\r
152 EfiInitCacheDataOnly,\r
153 EfiInitCacheInstrOnly,\r
154 EfiInitCacheBoth,\r
155 EfiInitCacheUnspecified\r
156} EFI_INIT_CACHE_TYPE;\r
157\r
158///\r
159/// Embedded cache init extended data\r
160///\r
161typedef struct {\r
162 EFI_STATUS_CODE_DATA DataHeader;\r
163 UINT32 Level;\r
164 EFI_INIT_CACHE_TYPE Type;\r
165} EFI_CACHE_INIT_DATA;\r
166\r
167//\r
168// Memory Extended Error Data\r
169//\r
170\r
171///\r
172/// Memory Error Granularity Definition\r
173///\r
174typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY;\r
175\r
176///\r
177/// Memory Error Operation Definition\r
178///\r
179typedef UINT8 EFI_MEMORY_ERROR_OPERATION;\r
180\r
181typedef struct {\r
182 EFI_STATUS_CODE_DATA DataHeader;\r
183 EFI_MEMORY_ERROR_GRANULARITY Granularity;\r
184 EFI_MEMORY_ERROR_OPERATION Operation;\r
185 UINTN Syndrome;\r
186 EFI_PHYSICAL_ADDRESS Address;\r
187 UINTN Resolution;\r
188} EFI_MEMORY_EXTENDED_ERROR_DATA;\r
189\r
190//\r
191// Memory Error Granularities\r
192//\r
193#define EFI_MEMORY_ERROR_OTHER 0x01\r
194#define EFI_MEMORY_ERROR_UNKNOWN 0x02\r
195#define EFI_MEMORY_ERROR_DEVICE 0x03\r
196#define EFI_MEMORY_ERROR_PARTITION 0x04\r
197\r
198//\r
199// Memory Error Operations\r
200//\r
201#define EFI_MEMORY_OPERATION_OTHER 0x01\r
202#define EFI_MEMORY_OPERATION_UNKNOWN 0x02\r
203#define EFI_MEMORY_OPERATION_READ 0x03\r
204#define EFI_MEMORY_OPERATION_WRITE 0x04\r
205#define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05\r
206\r
207//\r
208// Define shorthands to describe Group Operations\r
209// Many memory init operations are essentially group\r
210// operations.\r
211\r
212/// A shorthand to describe that the operation is performed\r
213/// on multiple devices within the array\r
214///\r
215#define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe\r
216///\r
217/// A shorthand to describe that the operation is performed on all devices within the array\r
218///\r
219#define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r
220///\r
221/// A shorthand to describe that the operation is performed on multiple arrays\r
222///\r
223#define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r
224///\r
225/// A shorthand to describe that the operation is performed on all the arrays\r
226///\r
227#define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r
228\r
229//\r
230// DIMM number\r
231//\r
232#pragma pack(1)\r
233typedef struct {\r
234 EFI_STATUS_CODE_DATA DataHeader;\r
235 UINT16 Array;\r
236 UINT16 Device;\r
237} EFI_STATUS_CODE_DIMM_NUMBER;\r
238#pragma pack()\r
239\r
240///\r
241/// Memory Module Mismatch Extended Error Data\r
242///\r
243typedef struct {\r
244 EFI_STATUS_CODE_DATA DataHeader;\r
245 EFI_STATUS_CODE_DIMM_NUMBER Instance;\r
246} EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r
247\r
248///\r
249/// Memory Range Extended Data\r
250///\r
251typedef struct {\r
252 EFI_STATUS_CODE_DATA DataHeader;\r
253 EFI_PHYSICAL_ADDRESS Start;\r
254 EFI_PHYSICAL_ADDRESS Length;\r
255} EFI_MEMORY_RANGE_EXTENDED_DATA;\r
256\r
257///\r
258/// Device handle Extended Data. Used for many\r
259/// errors and progress codes to point to the device.\r
260///\r
261typedef struct {\r
262 EFI_STATUS_CODE_DATA DataHeader;\r
263 EFI_HANDLE Handle;\r
264} EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
265\r
266typedef struct {\r
267 EFI_STATUS_CODE_DATA DataHeader;\r
268 UINT8 *DevicePath;\r
269} EFI_DEVICE_PATH_EXTENDED_DATA;\r
270\r
271typedef struct {\r
272 EFI_STATUS_CODE_DATA DataHeader; \r
273 EFI_HANDLE ControllerHandle;\r
274 EFI_HANDLE DriverBindingHandle;\r
275 UINT16 DevicePathSize;\r
276 UINT8 *RemainingDevicePath;\r
277} EFI_STATUS_CODE_START_EXTENDED_DATA;\r
278\r
279///\r
280/// Resource Allocation Failure Extended Error Data\r
281///\r
282\r
283/*\r
284typedef struct {\r
285 EFI_STATUS_CODE_DATA DataHeader;\r
286 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
287 UINT32 Bar;\r
288 VOID *ReqRes;\r
289 VOID *AllocRes;\r
290} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
291*/\r
292typedef struct {\r
293 EFI_STATUS_CODE_DATA DataHeader;\r
294 UINT32 Bar;\r
295 UINT16 DevicePathSize;\r
296 UINT16 ReqResSize;\r
297 UINT16 AllocResSize;\r
298 UINT8 *DevicePath;\r
299 UINT8 *ReqRes;\r
300 UINT8 *AllocRes;\r
301} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
302\r
303///\r
304/// Extended Error Data for Assert\r
305///\r
306typedef struct {\r
307 EFI_STATUS_CODE_DATA DataHeader;\r
308 UINT32 LineNumber;\r
309 UINT32 FileNameSize;\r
310 EFI_STATUS_CODE_STRING_DATA *FileName;\r
311} EFI_DEBUG_ASSERT_DATA;\r
312\r
313///\r
314/// System Context Data EBC/IA32/IPF\r
315///\r
316typedef union {\r
317 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc;\r
318 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32;\r
319 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf;\r
320} EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT;\r
321\r
322typedef struct {\r
323 EFI_STATUS_CODE_DATA DataHeader;\r
324 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r
325} EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
326\r
327///\r
328/// Legacy Oprom extended data\r
329///\r
330typedef struct {\r
331 EFI_STATUS_CODE_DATA DataHeader;\r
332 EFI_HANDLE DeviceHandle;\r
333 EFI_PHYSICAL_ADDRESS RomImageBase;\r
334} EFI_LEGACY_OPROM_EXTENDED_DATA;\r
335\r
336#endif\r