2 Report Status Code Library for DXE Phase.
4 Copyright (c) 2006 - 2007, 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 // The package level header files this module uses
18 #include <FrameworkDxe.h>
20 // The protocols, PPI and GUID defintions for this module
22 #include <Guid/StatusCodeDataTypeId.h>
23 #include <Protocol/StatusCode.h>
25 // The Library classes this module consumes
27 #include <Library/ReportStatusCodeLib.h>
28 #include <Library/DebugLib.h>
29 #include <Library/UefiBootServicesTableLib.h>
30 #include <Library/BaseLib.h>
31 #include <Library/BaseMemoryLib.h>
32 #include <Library/PcdLib.h>
33 #include <Library/UefiRuntimeServicesTableLib.h>
37 Internal worker function that reports a status code through the Status Code Protocol
39 This function checks to see if a Status Code Protocol is present in the handle
40 database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is
41 returned. If a Status Code Protocol is present, then it is cached in gStatusCode,
42 and the ReportStatusCode() service of the Status Code Protocol is called passing in
43 Type, Value, Instance, CallerId, and Data. The result of this call is returned.
45 @param Type Status code type.
46 @param Value Status code value.
47 @param Instance Status code instance number.
48 @param CallerId Pointer to a GUID that identifies the caller of this
49 function. This is an optional parameter that may be
51 @param Data Pointer to the extended data buffer. This is an
52 optional parameter that may be NULL.
54 @retval EFI_SUCCESS The status code was reported.
55 @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.
56 @retval EFI_UNSUPPORTED Status Code Protocol is not available.
61 InternalReportStatusCode (
62 IN EFI_STATUS_CODE_TYPE Type
,
63 IN EFI_STATUS_CODE_VALUE Value
,
65 IN CONST EFI_GUID
*CallerId OPTIONAL
,
66 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
70 EFI_STATUS_CODE_PROTOCOL
*StatusCode
;
71 STATIC EFI_REPORT_STATUS_CODE ReportStatusCode
= NULL
;
74 // If gStatusCode is NULL, then see if a Status Code Protocol instance is present
75 // in the handle database.
77 if (ReportStatusCode
== NULL
) {
79 return EFI_UNSUPPORTED
;
81 Status
= gBS
->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid
, NULL
, (VOID
**)&StatusCode
);
82 if (!EFI_ERROR (Status
) && StatusCode
!= NULL
) {
83 ReportStatusCode
= StatusCode
->ReportStatusCode
;
84 } else if (gRT
->Hdr
.Revision
< 0x20000) {
85 ReportStatusCode
= ((FRAMEWORK_EFI_RUNTIME_SERVICES
*)gRT
)->ReportStatusCode
;
87 return EFI_UNSUPPORTED
;
92 // A Status Code Protocol is present in the handle database, so pass in all the
93 // parameters to the ReportStatusCode() service of the Status Code Protocol
95 return (*ReportStatusCode
) (Type
, Value
, Instance
, (EFI_GUID
*)CallerId
, Data
);
100 Computes and returns the size, in bytes, of a device path.
102 @param DevicePath A pointer to a device path.
104 @return The size, in bytes, of DevicePath.
109 InternalReportStatusCodeDevicePathSize (
110 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
113 CONST EFI_DEVICE_PATH_PROTOCOL
*Start
;
116 // Search for the end of the device path structure
119 while (!EfiIsDevicePathEnd (DevicePath
)) {
120 DevicePath
= EfiNextDevicePathNode (DevicePath
);
124 // Subtract the start node from the end node and add in the size of the end node
126 return ((UINTN
) DevicePath
- (UINTN
) Start
) + DevicePathNodeLength (DevicePath
);
131 Converts a status code to an 8-bit POST code value.
133 Converts the status code specified by CodeType and Value to an 8-bit POST code
134 and returns the 8-bit POST code in PostCode. If CodeType is an
135 EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
136 are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
137 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
139 If PostCode is NULL, then ASSERT().
141 @param CodeType The type of status code being converted.
142 @param Value The status code value being converted.
143 @param PostCode A pointer to the 8-bit POST code value to return.
145 @retval TRUE The status code specified by CodeType and Value was converted
146 to an 8-bit POST code and returned in PostCode.
147 @retval FALSE The status code specified by CodeType and Value could not be
148 converted to an 8-bit POST code value.
154 IN EFI_STATUS_CODE_TYPE CodeType
,
155 IN EFI_STATUS_CODE_VALUE Value
,
160 // If PostCode is NULL, then ASSERT()
162 ASSERT (PostCode
!= NULL
);
165 // Convert Value to an 8 bit post code
167 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
168 ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) ) {
169 *PostCode
= (UINT8
) ((((Value
& EFI_STATUS_CODE_CLASS_MASK
) >> 24) << 5) |
170 (((Value
& EFI_STATUS_CODE_SUBCLASS_MASK
) >> 16) & 0x1f));
178 Extracts ASSERT() information from a status code structure.
180 Converts the status code specified by CodeType, Value, and Data to the ASSERT()
181 arguments specified by Filename, Description, and LineNumber. If CodeType is
182 an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
183 Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
184 Filename, Description, and LineNumber from the optional data area of the
185 status code buffer specified by Data. The optional data area of Data contains
186 a Null-terminated ASCII string for the FileName, followed by a Null-terminated
187 ASCII string for the Description, followed by a 32-bit LineNumber. If the
188 ASSERT() information could be extracted from Data, then return TRUE.
189 Otherwise, FALSE is returned.
191 If Data is NULL, then ASSERT().
192 If Filename is NULL, then ASSERT().
193 If Description is NULL, then ASSERT().
194 If LineNumber is NULL, then ASSERT().
196 @param CodeType The type of status code being converted.
197 @param Value The status code value being converted.
198 @param Data Pointer to status code data buffer.
199 @param Filename Pointer to the source file name that generated the ASSERT().
200 @param Description Pointer to the description of the ASSERT().
201 @param LineNumber Pointer to source line number that generated the ASSERT().
203 @retval TRUE The status code specified by CodeType, Value, and Data was
204 converted ASSERT() arguments specified by Filename, Description,
206 @retval FALSE The status code specified by CodeType, Value, and Data could
207 not be converted to ASSERT() arguments.
212 ReportStatusCodeExtractAssertInfo (
213 IN EFI_STATUS_CODE_TYPE CodeType
,
214 IN EFI_STATUS_CODE_VALUE Value
,
215 IN CONST EFI_STATUS_CODE_DATA
*Data
,
216 OUT CHAR8
**Filename
,
217 OUT CHAR8
**Description
,
218 OUT UINT32
*LineNumber
221 EFI_DEBUG_ASSERT_DATA
*AssertData
;
223 ASSERT (Data
!= NULL
);
224 ASSERT (Filename
!= NULL
);
225 ASSERT (Description
!= NULL
);
226 ASSERT (LineNumber
!= NULL
);
228 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
229 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
) &&
230 ((Value
& EFI_STATUS_CODE_OPERATION_MASK
) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)) {
231 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)(Data
+ 1);
232 *Filename
= (CHAR8
*)(AssertData
+ 1);
233 *Description
= *Filename
+ AsciiStrLen (*Filename
) + 1;
234 *LineNumber
= AssertData
->LineNumber
;
242 Extracts DEBUG() information from a status code structure.
244 Converts the status code specified by Data to the DEBUG() arguments specified
245 by ErrorLevel, Marker, and Format. If type GUID in Data is
246 EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
247 Format from the optional data area of the status code buffer specified by Data.
248 The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
249 which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
250 the Format. If the DEBUG() information could be extracted from Data, then
251 return TRUE. Otherwise, FALSE is returned.
253 If Data is NULL, then ASSERT().
254 If ErrorLevel is NULL, then ASSERT().
255 If Marker is NULL, then ASSERT().
256 If Format is NULL, then ASSERT().
258 @param Data Pointer to status code data buffer.
259 @param ErrorLevel Pointer to error level mask for a debug message.
260 @param Marker Pointer to the variable argument list associated with Format.
261 @param Format Pointer to a Null-terminated ASCII format string of a
264 @retval TRUE The status code specified by Data was converted DEBUG() arguments
265 specified by ErrorLevel, Marker, and Format.
266 @retval FALSE The status code specified by Data could not be converted to
272 ReportStatusCodeExtractDebugInfo (
273 IN CONST EFI_STATUS_CODE_DATA
*Data
,
274 OUT UINT32
*ErrorLevel
,
279 EFI_DEBUG_INFO
*DebugInfo
;
281 ASSERT (Data
!= NULL
);
282 ASSERT (ErrorLevel
!= NULL
);
283 ASSERT (Marker
!= NULL
);
284 ASSERT (Format
!= NULL
);
287 // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
289 if (!CompareGuid (&Data
->Type
, &gEfiStatusCodeDataTypeDebugGuid
)) {
294 // Retrieve the debug information from the status code record
296 DebugInfo
= (EFI_DEBUG_INFO
*)(Data
+ 1);
298 *ErrorLevel
= DebugInfo
->ErrorLevel
;
301 // The first 12 * UINTN bytes of the string are really an
302 // argument stack to support varargs on the Format string.
304 *Marker
= (VA_LIST
) (DebugInfo
+ 1);
305 *Format
= (CHAR8
*)(((UINT64
*)*Marker
) + 12);
312 Reports a status code.
314 Reports the status code specified by the parameters Type and Value. Status
315 code also require an instance, caller ID, and extended data. This function
316 passed in a zero instance, NULL extended data, and a caller ID of
317 gEfiCallerIdGuid, which is the GUID for the module.
319 ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
320 is called while processing another any other Report Status Code Library function,
321 then ReportStatusCode() must return immediately.
323 @param Type Status code type.
324 @param Value Status code value.
326 @retval EFI_SUCCESS The status code was reported.
327 @retval EFI_DEVICE_ERROR There status code could not be reported due to a
329 @retval EFI_UNSUPPORTED Report status code is not supported
335 IN EFI_STATUS_CODE_TYPE Type
,
336 IN EFI_STATUS_CODE_VALUE Value
339 return InternalReportStatusCode (Type
, Value
, 0, &gEfiCallerIdGuid
, NULL
);
344 Reports a status code with a Device Path Protocol as the extended data.
346 Allocates and fills in the extended data section of a status code with the
347 Device Path Protocol specified by DevicePath. This function is responsible
348 for allocating a buffer large enough for the standard header and the device
349 path. The standard header is filled in with a GUID of
350 gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero
351 instance and a caller ID of gEfiCallerIdGuid.
353 ReportStatusCodeWithDevicePath()must actively prevent recursion. If
354 ReportStatusCodeWithDevicePath() is called while processing another any other
355 Report Status Code Library function, then ReportStatusCodeWithDevicePath()
356 must return EFI_DEVICE_ERROR immediately.
358 If DevicePath is NULL, then ASSERT().
360 @param Type Status code type.
361 @param Value Status code value.
362 @param DevicePath Pointer to the Device Path Protocol to be reported.
364 @retval EFI_SUCCESS The status code was reported with the extended
365 data specified by DevicePath.
366 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
367 extended data section.
368 @retval EFI_UNSUPPORTED Report status code is not supported
373 ReportStatusCodeWithDevicePath (
374 IN EFI_STATUS_CODE_TYPE Type
,
375 IN EFI_STATUS_CODE_VALUE Value
,
376 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
379 ASSERT (DevicePath
!= NULL
);
380 return ReportStatusCodeWithExtendedData (
384 InternalReportStatusCodeDevicePathSize (DevicePath
)
390 Reports a status code with an extended data buffer.
392 Allocates and fills in the extended data section of a status code with the
393 extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
394 is assumed to be one of the data structures specified in Related Definitions.
395 These data structure do not have the standard header, so this function is
396 responsible for allocating a buffer large enough for the standard header and
397 the extended data passed into this function. The standard header is filled
398 in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
399 with a zero instance and a caller ID of gEfiCallerIdGuid.
401 ReportStatusCodeWithExtendedData()must actively prevent recursion. If
402 ReportStatusCodeWithExtendedData() is called while processing another any other
403 Report Status Code Library function, then ReportStatusCodeWithExtendedData()
404 must return EFI_DEVICE_ERROR immediately.
406 If ExtendedData is NULL, then ASSERT().
407 If ExtendedDataSize is 0, then ASSERT().
409 @param Type Status code type.
410 @param Value Status code value.
411 @param ExtendedData Pointer to the extended data buffer to be reported.
412 @param ExtendedDataSize The size, in bytes, of the extended data buffer to
415 @retval EFI_SUCCESS The status code was reported with the extended
416 data specified by ExtendedData and ExtendedDataSize.
417 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
418 extended data section.
419 @retval EFI_UNSUPPORTED Report status code is not supported
424 ReportStatusCodeWithExtendedData (
425 IN EFI_STATUS_CODE_TYPE Type
,
426 IN EFI_STATUS_CODE_VALUE Value
,
427 IN CONST VOID
*ExtendedData
,
428 IN UINTN ExtendedDataSize
431 ASSERT (ExtendedData
!= NULL
);
432 ASSERT (ExtendedDataSize
!= 0);
433 return ReportStatusCodeEx (
446 Reports a status code with full parameters.
448 The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
449 is 0, then an extended data buffer is not reported. If ExtendedData is not
450 NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
451 ExtendedData is assumed not have the standard status code header, so this function
452 is responsible for allocating a buffer large enough for the standard header and
453 the extended data passed into this function. The standard header is filled in
454 with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
455 GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with
456 an instance specified by Instance and a caller ID specified by CallerId. If
457 CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
459 ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()
460 is called while processing another any other Report Status Code Library function,
461 then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
463 If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
464 If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
466 @param Type Status code type.
467 @param Value Status code value.
468 @param Instance Status code instance number.
469 @param CallerId Pointer to a GUID that identifies the caller of this
470 function. If this parameter is NULL, then a caller
471 ID of gEfiCallerIdGuid is used.
472 @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
473 If this parameter is NULL, then a the status code
474 standard header is filled in with
475 gEfiStatusCodeSpecificDataGuid.
476 @param ExtendedData Pointer to the extended data buffer. This is an
477 optional parameter that may be NULL.
478 @param ExtendedDataSize The size, in bytes, of the extended data buffer.
480 @retval EFI_SUCCESS The status code was reported.
481 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
482 the extended data section if it was specified.
483 @retval EFI_UNSUPPORTED Report status code is not supported
489 IN EFI_STATUS_CODE_TYPE Type
,
490 IN EFI_STATUS_CODE_VALUE Value
,
492 IN CONST EFI_GUID
*CallerId OPTIONAL
,
493 IN CONST EFI_GUID
*ExtendedDataGuid OPTIONAL
,
494 IN CONST VOID
*ExtendedData OPTIONAL
,
495 IN UINTN ExtendedDataSize
499 EFI_STATUS_CODE_DATA
*StatusCodeData
;
501 ASSERT (!((ExtendedData
== NULL
) && (ExtendedDataSize
!= 0)));
502 ASSERT (!((ExtendedData
!= NULL
) && (ExtendedDataSize
== 0)));
505 return EFI_UNSUPPORTED
;
509 // Allocate space for the Status Code Header and its buffer
511 StatusCodeData
= NULL
;
512 gBS
->AllocatePool (EfiBootServicesData
, sizeof (EFI_STATUS_CODE_DATA
) + ExtendedDataSize
, (VOID
**)&StatusCodeData
);
513 if (StatusCodeData
== NULL
) {
514 return EFI_OUT_OF_RESOURCES
;
518 // Fill in the extended data header
520 StatusCodeData
->HeaderSize
= sizeof (EFI_STATUS_CODE_DATA
);
521 StatusCodeData
->Size
= (UINT16
)ExtendedDataSize
;
522 if (ExtendedDataGuid
== NULL
) {
523 ExtendedDataGuid
= &gEfiStatusCodeSpecificDataGuid
;
525 CopyGuid (&StatusCodeData
->Type
, ExtendedDataGuid
);
528 // Fill in the extended data buffer
530 CopyMem (StatusCodeData
+ 1, ExtendedData
, ExtendedDataSize
);
533 // Report the status code
535 if (CallerId
== NULL
) {
536 CallerId
= &gEfiCallerIdGuid
;
538 Status
= InternalReportStatusCode (Type
, Value
, Instance
, CallerId
, StatusCodeData
);
541 // Free the allocated buffer
543 gBS
->FreePool (StatusCodeData
);
550 Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
552 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
553 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
555 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
556 PcdReportStatusCodeProperyMask is set.
557 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
558 PcdReportStatusCodeProperyMask is clear.
563 ReportProgressCodeEnabled (
567 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
) != 0);
572 Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
574 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
575 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
577 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
578 PcdReportStatusCodeProperyMask is set.
579 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
580 PcdReportStatusCodeProperyMask is clear.
585 ReportErrorCodeEnabled (
589 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
) != 0);
594 Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
596 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
597 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
599 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
600 PcdReportStatusCodeProperyMask is set.
601 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
602 PcdReportStatusCodeProperyMask is clear.
607 ReportDebugCodeEnabled (
611 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
) != 0);