]> git.proxmox.com Git - mirror_edk2.git/blame - EdkCompatibilityPkg/Foundation/Framework/Guid/StatusCodeDataTypeId/StatusCodeDataTypeId.h
Add a new line at the end of CpuLib.h for GCC build.
[mirror_edk2.git] / EdkCompatibilityPkg / Foundation / Framework / Guid / StatusCodeDataTypeId / StatusCodeDataTypeId.h
CommitLineData
3eb9473e 1/*++\r
2\r
3Copyright (c) 2004 - 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 StatusCodeDataTypeId.h\r
15 \r
16Abstract:\r
17\r
18 GUID used to identify id for the caller who is initiating the Status Code.\r
19\r
20--*/\r
21\r
22#ifndef _STATUS_CODE_DATA_TYPE_ID_H__\r
23#define _STATUS_CODE_DATA_TYPE_ID_H__\r
24\r
25\r
26#include "EfiStatusCode.h"\r
27#include EFI_PROTOCOL_DEFINITION (DebugSupport)\r
28#include EFI_PROTOCOL_DEFINITION (Hii)\r
29//\r
30// The size of string\r
31//\r
32#define EFI_STATUS_CODE_DATA_MAX_STRING_SIZE 150\r
33\r
34//\r
35// This is the max data size including all the headers which can be passed\r
36// as Status Code data. This data should be multiple of 8 byte\r
37// to avoid any kind of boundary issue. Also, sum of this data size (inclusive\r
38// of size of EFI_STATUS_CODE_DATA should not exceed the max record size of\r
39// data hub\r
40//\r
41#define EFI_STATUS_CODE_DATA_MAX_SIZE 200\r
42\r
43//\r
44// String Data Type defintion. This is part of Status Code Specification\r
45//\r
46#define EFI_STATUS_CODE_DATA_TYPE_STRING_GUID \\r
47 { \\r
48 0x92D11080, 0x496F, 0x4D95, 0xBE, 0x7E, 0x03, 0x74, 0x88, 0x38, 0x2B, 0x0A \\r
49 }\r
50\r
51extern EFI_GUID gEfiStatusCodeDataTypeStringGuid;\r
52\r
53//\r
54// This GUID indicates that the format of the accompanying data depends\r
55// upon the Status Code Value, but follows this Specification\r
56//\r
57#define EFI_STATUS_CODE_SPECIFIC_DATA_GUID \\r
58 { \\r
59 0x335984bd, 0xe805, 0x409a, 0xb8, 0xf8, 0xd2, 0x7e, 0xce, 0x5f, 0xf7, 0xa6 \\r
60 }\r
61\r
62extern EFI_GUID gEfiStatusCodeSpecificDataGuid;\r
63\r
64#pragma pack(1)\r
65\r
66typedef enum {\r
67 EfiStringAscii,\r
68 EfiStringUnicode,\r
69 EfiStringToken\r
70} EFI_STRING_TYPE;\r
71\r
72//\r
73// HII string token\r
74//\r
75typedef struct {\r
76EFI_HII_HANDLE Handle;\r
77STRING_REF Token;\r
78} EFI_STATUS_CODE_STRING_TOKEN;\r
79\r
80typedef union {\r
81CHAR8 *Ascii;\r
82CHAR16 *Unicode;\r
83EFI_STATUS_CODE_STRING_TOKEN Hii;\r
84} EFI_STATUS_CODE_STRING;\r
85\r
86typedef struct {\r
87 EFI_STATUS_CODE_DATA DataHeader;\r
88 EFI_STRING_TYPE StringType;\r
89 EFI_STATUS_CODE_STRING String;\r
90} EFI_STATUS_CODE_STRING_DATA;\r
91\r
92#pragma pack()\r
93//\r
94// Debug Assert Data. This is part of Status Code Specification\r
95//\r
96#define EFI_STATUS_CODE_DATA_TYPE_ASSERT_GUID \\r
97 { \\r
98 0xDA571595, 0x4D99, 0x487C, 0x82, 0x7C, 0x26, 0x22, 0x67, 0x7D, 0x33, 0x07 \\r
99 }\r
100\r
101extern EFI_GUID gEfiStatusCodeDataTypeAssertGuid;\r
102\r
103//\r
104// Exception Data type (CPU REGS)\r
105//\r
106#define EFI_STATUS_CODE_DATA_TYPE_EXCEPTION_HANDLER_GUID \\r
107 { \\r
108 0x3BC2BD12, 0xAD2E, 0x11D5, 0x87, 0xDD, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xB9 \\r
109 }\r
110\r
111extern EFI_GUID gEfiStatusCodeDataTypeExceptionHandlerGuid;\r
112\r
113//\r
114// Debug DataType defintions. User Defined Data Types.\r
115//\r
116#define EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID \\r
117 { \\r
118 0x9A4E9246, 0xD553, 0x11D5, 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xb9 \\r
119 }\r
120\r
121#pragma pack(1)\r
122\r
123typedef struct {\r
124 UINT32 ErrorLevel;\r
125 //\r
126 // 12 * sizeof (UINT64) Var Arg stack\r
127 //\r
128 // ascii DEBUG () Format string\r
129 //\r
130} EFI_DEBUG_INFO;\r
131\r
132#pragma pack()\r
133\r
134extern EFI_GUID gEfiStatusCodeDataTypeDebugGuid;\r
135\r
136//\r
137// Progress Code. User Defined Data Type Guid.\r
138//\r
139#define EFI_STATUS_CODE_DATA_TYPE_ERROR_GUID \\r
140 { \\r
141 0xAB359CE3, 0x99B3, 0xAE18, 0xC8, 0x9D, 0x95, 0xD3, 0xB0, 0x72, 0xE1, 0x9B \\r
142 }\r
143\r
144extern EFI_GUID gEfiStatusCodeDataTypeErrorGuid;\r
145\r
146//\r
147// declaration for EFI_EXP_DATA. This may change\r
148//\r
149typedef UINTN EFI_EXP_DATA;\r
150\r
151//\r
152// Voltage Extended Error Data\r
153//\r
154typedef struct {\r
155 EFI_STATUS_CODE_DATA DataHeader;\r
156 EFI_EXP_DATA Voltage;\r
157 EFI_EXP_DATA Threshold;\r
158} EFI_COMPUTING_UNIT_VOLTAGE_ERROR_DATA;\r
159\r
160//\r
161// Microcode Update Extended Error Data\r
162//\r
163typedef struct {\r
164 EFI_STATUS_CODE_DATA DataHeader;\r
165 UINT32 Version;\r
166} EFI_COMPUTING_UNIT_MICROCODE_UPDATE_ERROR_DATA;\r
167\r
168//\r
169// Asynchronous Timer Extended Error Data\r
170//\r
171typedef struct {\r
172 EFI_STATUS_CODE_DATA DataHeader;\r
173 EFI_EXP_DATA TimerLimit;\r
174} EFI_COMPUTING_UNIT_TIMER_EXPIRED_ERROR_DATA;\r
175\r
176//\r
177// Host Processor Mismatch Extended Error Data\r
178//\r
179typedef struct {\r
180 EFI_STATUS_CODE_DATA DataHeader;\r
181 UINT32 Instance;\r
182 UINT16 Attributes;\r
183} EFI_HOST_PROCESSOR_MISMATCH_ERROR_DATA;\r
184\r
185//\r
186// EFI_COMPUTING_UNIT_MISMATCH_ATTRIBUTES\r
187// All other attributes are reserved for future use and\r
188// must be initialized to 0.\r
189//\r
190#define EFI_COMPUTING_UNIT_MISMATCH_SPEED 0x0001\r
191#define EFI_COMPUTING_UNIT_MISMATCH_FSB_SPEED 0x0002\r
192#define EFI_COMPUTING_UNIT_MISMATCH_FAMILY 0x0004\r
193#define EFI_COMPUTING_UNIT_MISMATCH_MODEL 0x0008\r
194#define EFI_COMPUTING_UNIT_MISMATCH_STEPPING 0x0010\r
195#define EFI_COMPUTING_UNIT_MISMATCH_CACHE_SIZE 0x0020\r
196#define EFI_COMPUTING_UNIT_MISMATCH_OEM1 0x1000\r
197#define EFI_COMPUTING_UNIT_MISMATCH_OEM2 0x2000\r
198#define EFI_COMPUTING_UNIT_MISMATCH_OEM3 0x4000\r
199#define EFI_COMPUTING_UNIT_MISMATCH_OEM4 0x8000\r
200\r
201//\r
202// Thermal Extended Error Data\r
203//\r
204typedef struct {\r
205 EFI_STATUS_CODE_DATA DataHeader;\r
206 EFI_EXP_DATA Temperature;\r
207 EFI_EXP_DATA Threshold;\r
208} EFI_COMPUTING_UNIT_THERMAL_ERROR_DATA;\r
209\r
210//\r
211// Processor Disabled Extended Error Data\r
212//\r
213typedef struct {\r
214 EFI_STATUS_CODE_DATA DataHeader;\r
215 UINT32 Cause;\r
216 BOOLEAN SoftwareDisabled;\r
217} EFI_COMPUTING_UNIT_CPU_DISABLED_ERROR_DATA;\r
218\r
219typedef enum {\r
220 EfiInitCacheDataOnly,\r
221 EfiInitCacheInstrOnly,\r
222 EfiInitCacheBoth,\r
223 EfiInitCacheUnspecified\r
224} EFI_INIT_CACHE_TYPE;\r
225\r
226//\r
227// Embedded cache init extended data\r
228//\r
229typedef struct {\r
230 EFI_STATUS_CODE_DATA DataHeader;\r
231 UINT32 Level;\r
232 EFI_INIT_CACHE_TYPE Type;\r
233} EFI_CACHE_INIT_DATA;\r
234\r
235//\r
236// Memory Extended Error Data\r
237//\r
238//\r
239// Memory Error Granularity Definition\r
240//\r
241typedef UINT8 EFI_MEMORY_ERROR_GRANULARITY;\r
242\r
243//\r
244// Memory Error Operation Definition\r
245//\r
246typedef UINT8 EFI_MEMORY_ERROR_OPERATION;\r
247\r
248typedef struct {\r
249 EFI_STATUS_CODE_DATA DataHeader;\r
250 EFI_MEMORY_ERROR_GRANULARITY Granularity;\r
251 EFI_MEMORY_ERROR_OPERATION Operation;\r
252 UINTN Syndrome;\r
253 EFI_PHYSICAL_ADDRESS Address;\r
254 UINTN Resolution;\r
255} EFI_MEMORY_EXTENDED_ERROR_DATA;\r
256\r
257//\r
258// Memory Error Granularities\r
259//\r
260#define EFI_MEMORY_ERROR_OTHER 0x01\r
261#define EFI_MEMORY_ERROR_UNKNOWN 0x02\r
262#define EFI_MEMORY_ERROR_DEVICE 0x03\r
263#define EFI_MEMORY_ERROR_PARTITION 0x04\r
264\r
265//\r
266// Memory Error Operations\r
267//\r
268#define EFI_MEMORY_OPERATION_OTHER 0x01\r
269#define EFI_MEMORY_OPERATION_UNKNOWN 0x02\r
270#define EFI_MEMORY_OPERATION_READ 0x03\r
271#define EFI_MEMORY_OPERATION_WRITE 0x04\r
272#define EFI_MEMORY_OPERATION_PARTIAL_WRITE 0x05\r
273\r
274//\r
275// Define shorthands to describe Group Operations\r
276// Many memory init operations are essentially group\r
277// operations.\r
278// A shorthand to describe that the operation is performed\r
279// on multiple devices within the array\r
280//\r
281#define EFI_MULTIPLE_MEMORY_DEVICE_OPERATION 0xfffe\r
282//\r
283// A shorthand to describe that the operation is performed // on all devices within the array\r
284//\r
285#define EFI_ALL_MEMORY_DEVICE_OPERATION 0xffff\r
286//\r
287// A shorthand to describe that the operation is performed // on multiple arrays\r
288//\r
289#define EFI_MULTIPLE_MEMORY_ARRAY_OPERATION 0xfffe\r
290//\r
291// A shorthand to describe that the operation is performed // on all the arrays\r
292//\r
293#define EFI_ALL_MEMORY_ARRAY_OPERATION 0xffff\r
294\r
295//\r
296// DIMM number\r
297//\r
298#pragma pack(1)\r
299typedef struct {\r
300 EFI_STATUS_CODE_DATA DataHeader;\r
301 UINT16 Array;\r
302 UINT16 Device;\r
303} EFI_STATUS_CODE_DIMM_NUMBER;\r
304#pragma pack()\r
305//\r
306// Memory Module Mismatch Extended Error Data\r
307//\r
308typedef struct {\r
309 EFI_STATUS_CODE_DATA DataHeader;\r
310 EFI_STATUS_CODE_DIMM_NUMBER Instance;\r
311} EFI_MEMORY_MODULE_MISMATCH_ERROR_DATA;\r
312\r
313//\r
314// Memory Range Extended Data\r
315//\r
316typedef struct {\r
317 EFI_STATUS_CODE_DATA DataHeader;\r
318 EFI_PHYSICAL_ADDRESS Start;\r
319 EFI_PHYSICAL_ADDRESS Length;\r
320} EFI_MEMORY_RANGE_EXTENDED_DATA;\r
321\r
322//\r
323// Device handle Extended Data. Used for many\r
324// errors and progress codes to point to the device.\r
325//\r
326typedef struct {\r
327 EFI_STATUS_CODE_DATA DataHeader;\r
328 EFI_HANDLE Handle;\r
329} EFI_DEVICE_HANDLE_EXTENDED_DATA;\r
330\r
331//\r
332// Resource Allocation Failure Extended Error Data\r
333//\r
334typedef struct {\r
335 EFI_STATUS_CODE_DATA DataHeader;\r
336 EFI_DEVICE_PATH_PROTOCOL *DevicePath;\r
337 UINT32 Bar;\r
338 VOID *ReqRes;\r
339 VOID *AllocRes;\r
340} EFI_RESOURCE_ALLOC_FAILURE_ERROR_DATA;\r
341\r
342//\r
343// Extended Error Data for Assert\r
344//\r
345typedef struct {\r
346 EFI_STATUS_CODE_DATA DataHeader;\r
347 UINT32 LineNumber;\r
348 UINT32 FileNameSize;\r
349 EFI_STATUS_CODE_STRING_DATA *FileName;\r
350} EFI_DEBUG_ASSERT_DATA;\r
351\r
352//\r
353// System Context Data EBC/IA32/IPF\r
354//\r
355typedef union {\r
356 EFI_SYSTEM_CONTEXT_EBC SystemContextEbc;\r
357 EFI_SYSTEM_CONTEXT_IA32 SystemContextIa32;\r
358 EFI_SYSTEM_CONTEXT_IPF SystemContextIpf;\r
359} EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT;\r
360\r
361typedef struct {\r
362 EFI_STATUS_CODE_DATA DataHeader;\r
363 EFI_STATUS_CODE_EXCEP_SYSTEM_CONTEXT Context;\r
364} EFI_STATUS_CODE_EXCEP_EXTENDED_DATA;\r
365\r
366//\r
367// Legacy Oprom extended data\r
368//\r
369typedef struct {\r
370 EFI_STATUS_CODE_DATA DataHeader;\r
371 EFI_HANDLE DeviceHandle;\r
372 EFI_PHYSICAL_ADDRESS RomImageBase;\r
373} EFI_LEGACY_OPROM_EXTENDED_DATA;\r
374\r
375//\r
376// Progress Code. User Defined Data Type Guid.\r
377//\r
378#define EFI_STATUS_CODE_DATA_TYPE_PROGRESS_CODE_GUID \\r
379 { \\r
380 0xA356AB39, 0x35C4, 0x35DA, 0xB3, 0x7A, 0xF8, 0xEA, 0x9E, 0x8B, 0x36, 0xA3 \\r
381 }\r
382\r
383extern EFI_GUID gEfiStatusCodeDataTypeProgressCodeGuid;\r
384\r
385#endif\r