2 Instance of Report Status Code Library for PEI Phase.
4 Copyright (c) 2006 - 2009, Intel Corporation<BR>
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.
16 #include <FrameworkPei.h>
18 #include <Guid/StatusCodeDataTypeId.h>
19 #include <Guid/StatusCodeDataTypeDebug.h>
21 #include <Library/ReportStatusCodeLib.h>
22 #include <Library/DebugLib.h>
23 #include <Library/BaseLib.h>
24 #include <Library/BaseMemoryLib.h>
25 #include <Library/PeiServicesTablePointerLib.h>
26 #include <Library/OemHookStatusCodeLib.h>
27 #include <Library/PcdLib.h>
30 // Define the maximum extended data size that is supported in the PEI phase
32 #define MAX_EXTENDED_DATA_SIZE 0x200
35 Internal worker function that reports a status code through the PEI Status Code Service or
36 OEM Hook Status Code Library.
38 This function first tries to report status code via PEI Status Code Service. If the service
39 is not available, it then tries calling OEM Hook Status Code Library.
41 @param Type Status code type.
42 @param Value Status code value.
43 @param Instance Status code instance number.
44 @param CallerId Pointer to a GUID that identifies the caller of this
45 function. This is an optional parameter that may be
47 @param Data Pointer to the extended data buffer. This is an
48 optional parameter that may be NULL.
50 @retval EFI_SUCCESS The status code was reported.
51 @retval EFI_UNSUPPORTED Status code type is not supported.
52 @retval Others Failed to report status code.
56 InternalReportStatusCode (
57 IN EFI_STATUS_CODE_TYPE Type
,
58 IN EFI_STATUS_CODE_VALUE Value
,
60 IN CONST EFI_GUID
*CallerId OPTIONAL
,
61 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
64 CONST EFI_PEI_SERVICES
**PeiServices
;
67 if ((ReportProgressCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
68 (ReportErrorCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) ||
69 (ReportDebugCodeEnabled() && ((Type
) & EFI_STATUS_CODE_TYPE_MASK
) == EFI_DEBUG_CODE
)) {
70 PeiServices
= GetPeiServicesTablePointer ();
71 Status
= (*PeiServices
)->ReportStatusCode (
79 if (Status
== EFI_NOT_AVAILABLE_YET
) {
80 Status
= OemHookStatusCodeInitialize ();
81 if (!EFI_ERROR (Status
)) {
82 return OemHookStatusCodeReport (Type
, Value
, Instance
, (EFI_GUID
*) CallerId
, Data
);
88 return EFI_UNSUPPORTED
;
93 Converts a status code to an 8-bit POST code value.
95 Converts the status code specified by CodeType and Value to an 8-bit POST code
96 and returns the 8-bit POST code in PostCode. If CodeType is an
97 EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
98 are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
99 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
101 If PostCode is NULL, then ASSERT().
103 @param CodeType The type of status code being converted.
104 @param Value The status code value being converted.
105 @param PostCode A pointer to the 8-bit POST code value to return.
107 @retval TRUE The status code specified by CodeType and Value was converted
108 to an 8-bit POST code and returned in PostCode.
109 @retval FALSE The status code specified by CodeType and Value could not be
110 converted to an 8-bit POST code value.
116 IN EFI_STATUS_CODE_TYPE CodeType
,
117 IN EFI_STATUS_CODE_VALUE Value
,
122 // If PostCode is NULL, then ASSERT()
124 ASSERT (PostCode
!= NULL
);
127 // Convert Value to an 8 bit post code
129 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
130 ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
)) {
131 *PostCode
= (UINT8
) ((((Value
& EFI_STATUS_CODE_CLASS_MASK
) >> 24) << 5) |
132 (((Value
& EFI_STATUS_CODE_SUBCLASS_MASK
) >> 16) & 0x1f));
140 Extracts ASSERT() information from a status code structure.
142 Converts the status code specified by CodeType, Value, and Data to the ASSERT()
143 arguments specified by Filename, Description, and LineNumber. If CodeType is
144 an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
145 Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
146 Filename, Description, and LineNumber from the optional data area of the
147 status code buffer specified by Data. The optional data area of Data contains
148 a Null-terminated ASCII string for the FileName, followed by a Null-terminated
149 ASCII string for the Description, followed by a 32-bit LineNumber. If the
150 ASSERT() information could be extracted from Data, then return TRUE.
151 Otherwise, FALSE is returned.
153 If Data is NULL, then ASSERT().
154 If Filename is NULL, then ASSERT().
155 If Description is NULL, then ASSERT().
156 If LineNumber is NULL, then ASSERT().
158 @param CodeType The type of status code being converted.
159 @param Value The status code value being converted.
160 @param Data Pointer to status code data buffer.
161 @param Filename Pointer to the source file name that generated the ASSERT().
162 @param Description Pointer to the description of the ASSERT().
163 @param LineNumber Pointer to source line number that generated the ASSERT().
165 @retval TRUE The status code specified by CodeType, Value, and Data was
166 converted ASSERT() arguments specified by Filename, Description,
168 @retval FALSE The status code specified by CodeType, Value, and Data could
169 not be converted to ASSERT() arguments.
174 ReportStatusCodeExtractAssertInfo (
175 IN EFI_STATUS_CODE_TYPE CodeType
,
176 IN EFI_STATUS_CODE_VALUE Value
,
177 IN CONST EFI_STATUS_CODE_DATA
*Data
,
178 OUT CHAR8
**Filename
,
179 OUT CHAR8
**Description
,
180 OUT UINT32
*LineNumber
183 EFI_DEBUG_ASSERT_DATA
*AssertData
;
185 ASSERT (Data
!= NULL
);
186 ASSERT (Filename
!= NULL
);
187 ASSERT (Description
!= NULL
);
188 ASSERT (LineNumber
!= NULL
);
190 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
191 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
) &&
192 ((Value
& EFI_STATUS_CODE_OPERATION_MASK
) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)) {
193 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)(Data
+ 1);
194 *Filename
= (CHAR8
*)(AssertData
+ 1);
195 *Description
= *Filename
+ AsciiStrLen (*Filename
) + 1;
196 *LineNumber
= AssertData
->LineNumber
;
204 Extracts DEBUG() information from a status code structure.
206 Converts the status code specified by Data to the DEBUG() arguments specified
207 by ErrorLevel, Marker, and Format. If type GUID in Data is
208 EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
209 Format from the optional data area of the status code buffer specified by Data.
210 The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
211 which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
212 the Format. If the DEBUG() information could be extracted from Data, then
213 return TRUE. Otherwise, FALSE is returned.
215 If Data is NULL, then ASSERT().
216 If ErrorLevel is NULL, then ASSERT().
217 If Marker is NULL, then ASSERT().
218 If Format is NULL, then ASSERT().
220 @param Data Pointer to status code data buffer.
221 @param ErrorLevel Pointer to error level mask for a debug message.
222 @param Marker Pointer to the variable argument list associated with Format.
223 @param Format Pointer to a Null-terminated ASCII format string of a
226 @retval TRUE The status code specified by Data was converted DEBUG() arguments
227 specified by ErrorLevel, Marker, and Format.
228 @retval FALSE The status code specified by Data could not be converted to
234 ReportStatusCodeExtractDebugInfo (
235 IN CONST EFI_STATUS_CODE_DATA
*Data
,
236 OUT UINT32
*ErrorLevel
,
237 OUT BASE_LIST
*Marker
,
241 EFI_DEBUG_INFO
*DebugInfo
;
243 ASSERT (Data
!= NULL
);
244 ASSERT (ErrorLevel
!= NULL
);
245 ASSERT (Marker
!= NULL
);
246 ASSERT (Format
!= NULL
);
249 // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
251 if (!CompareGuid (&Data
->Type
, &gEfiStatusCodeDataTypeDebugGuid
)) {
256 // Retrieve the debug information from the status code record
258 DebugInfo
= (EFI_DEBUG_INFO
*)(Data
+ 1);
260 *ErrorLevel
= DebugInfo
->ErrorLevel
;
263 // The first 12 * sizeof (UINT64) bytes following EFI_DEBUG_INFO are for variable arguments
264 // of format in DEBUG string. Its address is returned in Marker and has to be 64-bit aligned.
265 // It must be noticed that EFI_DEBUG_INFO follows EFI_STATUS_CODE_DATA, whose size is
266 // 20 bytes. The size of EFI_DEBUG_INFO is 4 bytes, so we can ensure that Marker
267 // returned is 64-bit aligned.
268 // 64-bit aligned is a must, otherwise retrieving 64-bit parameter from BASE_LIST will
269 // cause unalignment exception.
271 *Marker
= (BASE_LIST
) (DebugInfo
+ 1);
272 *Format
= (CHAR8
*)(((UINT64
*)*Marker
) + 12);
279 Reports a status code.
281 Reports the status code specified by the parameters Type and Value. Status
282 code also require an instance, caller ID, and extended data. This function
283 passed in a zero instance, NULL extended data, and a caller ID of
284 gEfiCallerIdGuid, which is the GUID for the module.
286 ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
287 is called while processing another any other Report Status Code Library function,
288 then ReportStatusCode() must return immediately.
290 @param Type Status code type.
291 @param Value Status code value.
293 @retval EFI_SUCCESS The status code was reported.
294 @retval EFI_DEVICE_ERROR There status code could not be reported due to a
296 @retval EFI_UNSUPPORTED Report status code is not supported
302 IN EFI_STATUS_CODE_TYPE Type
,
303 IN EFI_STATUS_CODE_VALUE Value
306 return InternalReportStatusCode (Type
, Value
, 0, &gEfiCallerIdGuid
, NULL
);
311 Reports a status code with a Device Path Protocol as the extended data.
313 Allocates and fills in the extended data section of a status code with the
314 Device Path Protocol specified by DevicePath. This function is responsible
315 for allocating a buffer large enough for the standard header and the device
316 path. The standard header is filled in with a GUID of
317 gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero
318 instance and a caller ID of gEfiCallerIdGuid.
320 ReportStatusCodeWithDevicePath()must actively prevent recursion. If
321 ReportStatusCodeWithDevicePath() is called while processing another any other
322 Report Status Code Library function, then ReportStatusCodeWithDevicePath()
323 must return EFI_DEVICE_ERROR immediately.
325 If DevicePath is NULL, then ASSERT().
327 @param Type Status code type.
328 @param Value Status code value.
329 @param DevicePath Pointer to the Device Path Protocol to be reported.
331 @retval EFI_SUCCESS The status code was reported with the extended
332 data specified by DevicePath.
333 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
334 extended data section.
335 @retval EFI_UNSUPPORTED Report status code is not supported
340 ReportStatusCodeWithDevicePath (
341 IN EFI_STATUS_CODE_TYPE Type
,
342 IN EFI_STATUS_CODE_VALUE Value
,
343 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
346 ASSERT (DevicePath
!= NULL
);
348 // EFI_UNSUPPORTED is returned for device path is not supported in PEI phase.
350 return EFI_UNSUPPORTED
;
355 Reports a status code with an extended data buffer.
357 Allocates and fills in the extended data section of a status code with the
358 extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
359 is assumed to be one of the data structures specified in Related Definitions.
360 These data structure do not have the standard header, so this function is
361 responsible for allocating a buffer large enough for the standard header and
362 the extended data passed into this function. The standard header is filled
363 in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
364 with a zero instance and a caller ID of gEfiCallerIdGuid.
366 ReportStatusCodeWithExtendedData()must actively prevent recursion. If
367 ReportStatusCodeWithExtendedData() is called while processing another any other
368 Report Status Code Library function, then ReportStatusCodeWithExtendedData()
369 must return EFI_DEVICE_ERROR immediately.
371 If ExtendedData is NULL, then ASSERT().
372 If ExtendedDataSize is 0, then ASSERT().
374 @param Type Status code type.
375 @param Value Status code value.
376 @param ExtendedData Pointer to the extended data buffer to be reported.
377 @param ExtendedDataSize The size, in bytes, of the extended data buffer to
380 @retval EFI_SUCCESS The status code was reported with the extended
381 data specified by ExtendedData and ExtendedDataSize.
382 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
383 extended data section.
384 @retval EFI_UNSUPPORTED Report status code is not supported
389 ReportStatusCodeWithExtendedData (
390 IN EFI_STATUS_CODE_TYPE Type
,
391 IN EFI_STATUS_CODE_VALUE Value
,
392 IN CONST VOID
*ExtendedData
,
393 IN UINTN ExtendedDataSize
396 ASSERT (ExtendedData
!= NULL
);
397 ASSERT (ExtendedDataSize
!= 0);
398 return ReportStatusCodeEx (
411 Reports a status code with full parameters.
413 The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
414 is 0, then an extended data buffer is not reported. If ExtendedData is not
415 NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
416 ExtendedData is assumed not have the standard status code header, so this function
417 is responsible for allocating a buffer large enough for the standard header and
418 the extended data passed into this function. The standard header is filled in
419 with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
420 GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with
421 an instance specified by Instance and a caller ID specified by CallerId. If
422 CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
424 ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()
425 is called while processing another any other Report Status Code Library function,
426 then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
428 If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
429 If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
431 @param Type Status code type.
432 @param Value Status code value.
433 @param Instance Status code instance number.
434 @param CallerId Pointer to a GUID that identifies the caller of this
435 function. If this parameter is NULL, then a caller
436 ID of gEfiCallerIdGuid is used.
437 @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
438 If this parameter is NULL, then a the status code
439 standard header is filled in with
440 gEfiStatusCodeSpecificDataGuid.
441 @param ExtendedData Pointer to the extended data buffer. This is an
442 optional parameter that may be NULL.
443 @param ExtendedDataSize The size, in bytes, of the extended data buffer.
445 @retval EFI_SUCCESS The status code was reported.
446 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
447 the extended data section if it was specified.
448 @retval EFI_UNSUPPORTED Report status code is not supported
454 IN EFI_STATUS_CODE_TYPE Type
,
455 IN EFI_STATUS_CODE_VALUE Value
,
457 IN CONST EFI_GUID
*CallerId OPTIONAL
,
458 IN CONST EFI_GUID
*ExtendedDataGuid OPTIONAL
,
459 IN CONST VOID
*ExtendedData OPTIONAL
,
460 IN UINTN ExtendedDataSize
463 EFI_STATUS_CODE_DATA
*StatusCodeData
;
464 UINT64 Buffer
[MAX_EXTENDED_DATA_SIZE
/ sizeof (UINT64
)];
467 // If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
469 ASSERT (!((ExtendedData
== NULL
) && (ExtendedDataSize
!= 0)));
471 // If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
473 ASSERT (!((ExtendedData
!= NULL
) && (ExtendedDataSize
== 0)));
475 if (ExtendedDataSize
> (MAX_EXTENDED_DATA_SIZE
- sizeof (EFI_STATUS_CODE_DATA
))) {
476 return EFI_OUT_OF_RESOURCES
;
478 StatusCodeData
= (EFI_STATUS_CODE_DATA
*)Buffer
;
479 StatusCodeData
->HeaderSize
= sizeof (EFI_STATUS_CODE_DATA
);
480 StatusCodeData
->Size
= (UINT16
)ExtendedDataSize
;
481 if (ExtendedDataGuid
== NULL
) {
482 ExtendedDataGuid
= &gEfiStatusCodeSpecificDataGuid
;
484 CopyGuid (&StatusCodeData
->Type
, ExtendedDataGuid
);
485 if (ExtendedData
!= NULL
) {
486 CopyMem (StatusCodeData
+ 1, ExtendedData
, ExtendedDataSize
);
488 if (CallerId
== NULL
) {
489 CallerId
= &gEfiCallerIdGuid
;
491 return InternalReportStatusCode (Type
, Value
, Instance
, CallerId
, StatusCodeData
);
496 Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
498 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
499 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
501 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
502 PcdReportStatusCodeProperyMask is set.
503 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
504 PcdReportStatusCodeProperyMask is clear.
509 ReportProgressCodeEnabled (
513 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
) != 0);
518 Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
520 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
521 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
523 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
524 PcdReportStatusCodeProperyMask is set.
525 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
526 PcdReportStatusCodeProperyMask is clear.
531 ReportErrorCodeEnabled (
535 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
) != 0);
540 Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
542 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
543 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
545 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
546 PcdReportStatusCodeProperyMask is set.
547 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
548 PcdReportStatusCodeProperyMask is clear.
553 ReportDebugCodeEnabled (
557 return (BOOLEAN
) ((PcdGet8 (PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
) != 0);