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