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 // Global pointer to the Status Code Protocol
18 static EFI_STATUS_CODE_PROTOCOL
*gStatusCode
= NULL
;
21 Internal worker function that reports a status code through the Status Code Protocol
23 This function checks to see if a Status Code Protocol is present in the handle
24 database. If a Status Code Protocol is not present, then EFI_UNSUPPORTED is
25 returned. If a Status Code Protocol is present, then it is cached in gStatusCode,
26 and the ReportStatusCode() service of the Status Code Protocol is called passing in
27 Type, Value, Instance, CallerId, and Data. The result of this call is returned.
29 @param Type Status code type.
30 @param Value Status code value.
31 @param Instance Status code instance number.
32 @param CallerId Pointer to a GUID that identifies the caller of this
33 function. This is an optional parameter that may be
35 @param Data Pointer to the extended data buffer. This is an
36 optional parameter that may be NULL.
38 @retval EFI_SUCCESS The status code was reported.
39 @retval EFI_OUT_OF_RESOURCES There were not enough resources to report the status code.
40 @retval EFI_UNSUPPORTED Status Code Protocol is not available.
45 InternalReportStatusCode (
46 IN EFI_STATUS_CODE_TYPE Type
,
47 IN EFI_STATUS_CODE_VALUE Value
,
49 IN CONST EFI_GUID
*CallerId OPTIONAL
,
50 IN EFI_STATUS_CODE_DATA
*Data OPTIONAL
56 // If gStatusCode is NULL, then see if a Status Code Protocol instance is present
57 // in the handle database.
59 if (gStatusCode
== NULL
) {
61 return EFI_UNSUPPORTED
;
63 Status
= gBS
->LocateProtocol (&gEfiStatusCodeRuntimeProtocolGuid
, NULL
, (VOID
**)&gStatusCode
);
64 if (EFI_ERROR (Status
) || gStatusCode
== NULL
) {
65 return EFI_UNSUPPORTED
;
70 // A Status Code Protocol is present in the handle database, so pass in all the
71 // parameters to the ReportStatusCode() service of the Status Code Protocol
73 return gStatusCode
->ReportStatusCode (Type
, Value
, Instance
, (EFI_GUID
*)CallerId
, Data
);
78 Computes and returns the size, in bytes, of a device path.
80 @param DevicePath A pointer to a device path.
82 @return The size, in bytes, of DevicePath.
87 InternalReportStatusCodeDevicePathSize (
88 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
91 CONST EFI_DEVICE_PATH_PROTOCOL
*Start
;
94 // Search for the end of the device path structure
97 while (!EfiIsDevicePathEnd (DevicePath
)) {
98 DevicePath
= EfiNextDevicePathNode (DevicePath
);
102 // Subtract the start node from the end node and add in the size of the end node
104 return ((UINTN
) DevicePath
- (UINTN
) Start
) + DevicePathNodeLength (DevicePath
);
109 Converts a status code to an 8-bit POST code value.
111 Converts the status code specified by CodeType and Value to an 8-bit POST code
112 and returns the 8-bit POST code in PostCode. If CodeType is an
113 EFI_PROGRESS_CODE or CodeType is an EFI_ERROR_CODE, then bits 0..4 of PostCode
114 are set to bits 16..20 of Value, and bits 5..7 of PostCode are set to bits
115 24..26 of Value., and TRUE is returned. Otherwise, FALSE is returned.
117 If PostCode is NULL, then ASSERT().
119 @param CodeType The type of status code being converted.
120 @param Value The status code value being converted.
121 @param PostCode A pointer to the 8-bit POST code value to return.
123 @retval TRUE The status code specified by CodeType and Value was converted
124 to an 8-bit POST code and returned in PostCode.
125 @retval FALSE The status code specified by CodeType and Value could not be
126 converted to an 8-bit POST code value.
132 IN EFI_STATUS_CODE_TYPE CodeType
,
133 IN EFI_STATUS_CODE_VALUE Value
,
138 // If PostCode is NULL, then ASSERT()
140 ASSERT (PostCode
!= NULL
);
143 // Convert Value to an 8 bit post code
145 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_PROGRESS_CODE
) ||
146 ((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) ) {
147 *PostCode
= (UINT8
) ((((Value
& EFI_STATUS_CODE_CLASS_MASK
) >> 24) << 5) |
148 (((Value
& EFI_STATUS_CODE_SUBCLASS_MASK
) >> 16) & 0x1f));
156 Extracts ASSERT() information from a status code structure.
158 Converts the status code specified by CodeType, Value, and Data to the ASSERT()
159 arguments specified by Filename, Description, and LineNumber. If CodeType is
160 an EFI_ERROR_CODE, and CodeType has a severity of EFI_ERROR_UNRECOVERED, and
161 Value has an operation mask of EFI_SW_EC_ILLEGAL_SOFTWARE_STATE, extract
162 Filename, Description, and LineNumber from the optional data area of the
163 status code buffer specified by Data. The optional data area of Data contains
164 a Null-terminated ASCII string for the FileName, followed by a Null-terminated
165 ASCII string for the Description, followed by a 32-bit LineNumber. If the
166 ASSERT() information could be extracted from Data, then return TRUE.
167 Otherwise, FALSE is returned.
169 If Data is NULL, then ASSERT().
170 If Filename is NULL, then ASSERT().
171 If Description is NULL, then ASSERT().
172 If LineNumber is NULL, then ASSERT().
174 @param CodeType The type of status code being converted.
175 @param Value The status code value being converted.
176 @param Data Pointer to status code data buffer.
177 @param Filename Pointer to the source file name that generated the ASSERT().
178 @param Description Pointer to the description of the ASSERT().
179 @param LineNumber Pointer to source line number that generated the ASSERT().
181 @retval TRUE The status code specified by CodeType, Value, and Data was
182 converted ASSERT() arguments specified by Filename, Description,
184 @retval FALSE The status code specified by CodeType, Value, and Data could
185 not be converted to ASSERT() arguments.
190 ReportStatusCodeExtractAssertInfo (
191 IN EFI_STATUS_CODE_TYPE CodeType
,
192 IN EFI_STATUS_CODE_VALUE Value
,
193 IN CONST EFI_STATUS_CODE_DATA
*Data
,
194 OUT CHAR8
**Filename
,
195 OUT CHAR8
**Description
,
196 OUT UINT32
*LineNumber
199 EFI_DEBUG_ASSERT_DATA
*AssertData
;
201 ASSERT (Data
!= NULL
);
202 ASSERT (Filename
!= NULL
);
203 ASSERT (Description
!= NULL
);
204 ASSERT (LineNumber
!= NULL
);
206 if (((CodeType
& EFI_STATUS_CODE_TYPE_MASK
) == EFI_ERROR_CODE
) &&
207 ((CodeType
& EFI_STATUS_CODE_SEVERITY_MASK
) == EFI_ERROR_UNRECOVERED
) &&
208 ((Value
& EFI_STATUS_CODE_OPERATION_MASK
) == EFI_SW_EC_ILLEGAL_SOFTWARE_STATE
)) {
209 AssertData
= (EFI_DEBUG_ASSERT_DATA
*)(Data
+ 1);
210 *Filename
= (CHAR8
*)(AssertData
+ 1);
211 *Description
= *Filename
+ AsciiStrLen (*Filename
) + 1;
212 *LineNumber
= AssertData
->LineNumber
;
220 Extracts DEBUG() information from a status code structure.
222 Converts the status code specified by Data to the DEBUG() arguments specified
223 by ErrorLevel, Marker, and Format. If type GUID in Data is
224 EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID, then extract ErrorLevel, Marker, and
225 Format from the optional data area of the status code buffer specified by Data.
226 The optional data area of Data contains a 32-bit ErrorLevel followed by Marker
227 which is 12 UINTN parameters, followed by a Null-terminated ASCII string for
228 the Format. If the DEBUG() information could be extracted from Data, then
229 return TRUE. Otherwise, FALSE is returned.
231 If Data is NULL, then ASSERT().
232 If ErrorLevel is NULL, then ASSERT().
233 If Marker is NULL, then ASSERT().
234 If Format is NULL, then ASSERT().
236 @param Data Pointer to status code data buffer.
237 @param ErrorLevel Pointer to error level mask for a debug message.
238 @param Marker Pointer to the variable argument list associated with Format.
239 @param Format Pointer to a Null-terminated ASCII format string of a
242 @retval TRUE The status code specified by Data was converted DEBUG() arguments
243 specified by ErrorLevel, Marker, and Format.
244 @retval FALSE The status code specified by Data could not be converted to
250 ReportStatusCodeExtractDebugInfo (
251 IN CONST EFI_STATUS_CODE_DATA
*Data
,
252 OUT UINT32
*ErrorLevel
,
257 EFI_DEBUG_INFO
*DebugInfo
;
259 ASSERT (Data
!= NULL
);
260 ASSERT (ErrorLevel
!= NULL
);
261 ASSERT (Marker
!= NULL
);
262 ASSERT (Format
!= NULL
);
265 // If the GUID type is not EFI_STATUS_CODE_DATA_TYPE_DEBUG_GUID then return FALSE
267 if (!CompareGuid (&Data
->Type
, &gEfiStatusCodeDataTypeDebugGuid
)) {
272 // Retrieve the debug information from the status code record
274 DebugInfo
= (EFI_DEBUG_INFO
*)(Data
+ 1);
276 *ErrorLevel
= DebugInfo
->ErrorLevel
;
279 // The first 12 * UINTN bytes of the string are really an
280 // argument stack to support varargs on the Format string.
282 *Marker
= (VA_LIST
) (DebugInfo
+ 1);
283 *Format
= (CHAR8
*)(((UINT64
*)*Marker
) + 12);
290 Reports a status code.
292 Reports the status code specified by the parameters Type and Value. Status
293 code also require an instance, caller ID, and extended data. This function
294 passed in a zero instance, NULL extended data, and a caller ID of
295 gEfiCallerIdGuid, which is the GUID for the module.
297 ReportStatusCode()must actively prevent recusrsion. If ReportStatusCode()
298 is called while processing another any other Report Status Code Library function,
299 then ReportStatusCode() must return immediately.
301 @param Type Status code type.
302 @param Value Status code value.
304 @retval EFI_SUCCESS The status code was reported.
305 @retval EFI_DEVICE_ERROR There status code could not be reported due to a
307 @retval EFI_UNSUPPORTED Report status code is not supported
313 IN EFI_STATUS_CODE_TYPE Type
,
314 IN EFI_STATUS_CODE_VALUE Value
317 return InternalReportStatusCode (Type
, Value
, 0, &gEfiCallerIdGuid
, NULL
);
322 Reports a status code with a Device Path Protocol as the extended data.
324 Allocates and fills in the extended data section of a status code with the
325 Device Path Protocol specified by DevicePath. This function is responsible
326 for allocating a buffer large enough for the standard header and the device
327 path. The standard header is filled in with a GUID of
328 gEfiStatusCodeSpecificDataGuid. The status code is reported with a zero
329 instance and a caller ID of gEfiCallerIdGuid.
331 ReportStatusCodeWithDevicePath()must actively prevent recursion. If
332 ReportStatusCodeWithDevicePath() is called while processing another any other
333 Report Status Code Library function, then ReportStatusCodeWithDevicePath()
334 must return EFI_DEVICE_ERROR immediately.
336 If DevicePath is NULL, then ASSERT().
338 @param Type Status code type.
339 @param Value Status code value.
340 @param DevicePath Pointer to the Device Path Protocol to be reported.
342 @retval EFI_SUCCESS The status code was reported with the extended
343 data specified by DevicePath.
344 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
345 extended data section.
346 @retval EFI_UNSUPPORTED Report status code is not supported
351 ReportStatusCodeWithDevicePath (
352 IN EFI_STATUS_CODE_TYPE Type
,
353 IN EFI_STATUS_CODE_VALUE Value
,
354 IN CONST EFI_DEVICE_PATH_PROTOCOL
*DevicePath
357 ASSERT (DevicePath
!= NULL
);
358 return ReportStatusCodeWithExtendedData (
362 InternalReportStatusCodeDevicePathSize (DevicePath
)
368 Reports a status code with an extended data buffer.
370 Allocates and fills in the extended data section of a status code with the
371 extended data specified by ExtendedData and ExtendedDataSize. ExtendedData
372 is assumed to be one of the data structures specified in Related Definitions.
373 These data structure do not have the standard header, so this function is
374 responsible for allocating a buffer large enough for the standard header and
375 the extended data passed into this function. The standard header is filled
376 in with a GUID of gEfiStatusCodeSpecificDataGuid. The status code is reported
377 with a zero instance and a caller ID of gEfiCallerIdGuid.
379 ReportStatusCodeWithExtendedData()must actively prevent recursion. If
380 ReportStatusCodeWithExtendedData() is called while processing another any other
381 Report Status Code Library function, then ReportStatusCodeWithExtendedData()
382 must return EFI_DEVICE_ERROR immediately.
384 If ExtendedData is NULL, then ASSERT().
385 If ExtendedDataSize is 0, then ASSERT().
387 @param Type Status code type.
388 @param Value Status code value.
389 @param ExtendedData Pointer to the extended data buffer to be reported.
390 @param ExtendedDataSize The size, in bytes, of the extended data buffer to
393 @retval EFI_SUCCESS The status code was reported with the extended
394 data specified by ExtendedData and ExtendedDataSize.
395 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the
396 extended data section.
397 @retval EFI_UNSUPPORTED Report status code is not supported
402 ReportStatusCodeWithExtendedData (
403 IN EFI_STATUS_CODE_TYPE Type
,
404 IN EFI_STATUS_CODE_VALUE Value
,
405 IN CONST VOID
*ExtendedData
,
406 IN UINTN ExtendedDataSize
409 ASSERT (ExtendedData
!= NULL
);
410 ASSERT (ExtendedDataSize
!= 0);
411 return ReportStatusCodeEx (
424 Reports a status code with full parameters.
426 The function reports a status code. If ExtendedData is NULL and ExtendedDataSize
427 is 0, then an extended data buffer is not reported. If ExtendedData is not
428 NULL and ExtendedDataSize is not 0, then an extended data buffer is allocated.
429 ExtendedData is assumed not have the standard status code header, so this function
430 is responsible for allocating a buffer large enough for the standard header and
431 the extended data passed into this function. The standard header is filled in
432 with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a
433 GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with
434 an instance specified by Instance and a caller ID specified by CallerId. If
435 CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.
437 ReportStatusCodeEx()must actively prevent recursion. If ReportStatusCodeEx()
438 is called while processing another any other Report Status Code Library function,
439 then ReportStatusCodeEx() must return EFI_DEVICE_ERROR immediately.
441 If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().
442 If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().
444 @param Type Status code type.
445 @param Value Status code value.
446 @param Instance Status code instance number.
447 @param CallerId Pointer to a GUID that identifies the caller of this
448 function. If this parameter is NULL, then a caller
449 ID of gEfiCallerIdGuid is used.
450 @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.
451 If this parameter is NULL, then a the status code
452 standard header is filled in with
453 gEfiStatusCodeSpecificDataGuid.
454 @param ExtendedData Pointer to the extended data buffer. This is an
455 optional parameter that may be NULL.
456 @param ExtendedDataSize The size, in bytes, of the extended data buffer.
458 @retval EFI_SUCCESS The status code was reported.
459 @retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate
460 the extended data section if it was specified.
461 @retval EFI_UNSUPPORTED Report status code is not supported
467 IN EFI_STATUS_CODE_TYPE Type
,
468 IN EFI_STATUS_CODE_VALUE Value
,
470 IN CONST EFI_GUID
*CallerId OPTIONAL
,
471 IN CONST EFI_GUID
*ExtendedDataGuid OPTIONAL
,
472 IN CONST VOID
*ExtendedData OPTIONAL
,
473 IN UINTN ExtendedDataSize
477 EFI_STATUS_CODE_DATA
*StatusCodeData
;
479 ASSERT (!((ExtendedData
== NULL
) && (ExtendedDataSize
!= 0)));
480 ASSERT (!((ExtendedData
!= NULL
) && (ExtendedDataSize
== 0)));
483 return EFI_UNSUPPORTED
;
487 // Allocate space for the Status Code Header and its buffer
489 StatusCodeData
= NULL
;
490 gBS
->AllocatePool (EfiBootServicesData
, sizeof (EFI_STATUS_CODE_DATA
) + ExtendedDataSize
, (VOID
**)&StatusCodeData
);
491 if (StatusCodeData
== NULL
) {
492 return EFI_OUT_OF_RESOURCES
;
496 // Fill in the extended data header
498 StatusCodeData
->HeaderSize
= sizeof (EFI_STATUS_CODE_DATA
);
499 StatusCodeData
->Size
= (UINT16
)ExtendedDataSize
;
500 if (ExtendedDataGuid
== NULL
) {
501 ExtendedDataGuid
= &gEfiStatusCodeSpecificDataGuid
;
503 CopyGuid (&StatusCodeData
->Type
, ExtendedDataGuid
);
506 // Fill in the extended data buffer
508 CopyMem (StatusCodeData
+ 1, ExtendedData
, ExtendedDataSize
);
511 // Report the status code
513 if (CallerId
== NULL
) {
514 CallerId
= &gEfiCallerIdGuid
;
516 Status
= InternalReportStatusCode (Type
, Value
, Instance
, CallerId
, StatusCodeData
);
519 // Free the allocated buffer
521 gBS
->FreePool (StatusCodeData
);
528 Returns TRUE if status codes of type EFI_PROGRESS_CODE are enabled
530 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
531 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
533 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
534 PcdReportStatusCodeProperyMask is set.
535 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED bit of
536 PcdReportStatusCodeProperyMask is clear.
541 ReportProgressCodeEnabled (
545 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_PROGRESS_CODE_ENABLED
) != 0);
550 Returns TRUE if status codes of type EFI_ERROR_CODE are enabled
552 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
553 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
555 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
556 PcdReportStatusCodeProperyMask is set.
557 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED bit of
558 PcdReportStatusCodeProperyMask is clear.
563 ReportErrorCodeEnabled (
567 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_ERROR_CODE_ENABLED
) != 0);
572 Returns TRUE if status codes of type EFI_DEBUG_CODE are enabled
574 This function returns TRUE if the REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
575 bit of PcdReportStatusCodeProperyMask is set. Otherwise FALSE is returned.
577 @retval TRUE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
578 PcdReportStatusCodeProperyMask is set.
579 @retval FALSE The REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED bit of
580 PcdReportStatusCodeProperyMask is clear.
585 ReportDebugCodeEnabled (
589 return (BOOLEAN
) ((PcdGet8(PcdReportStatusCodePropertyMask
) & REPORT_STATUS_CODE_PROPERTY_DEBUG_CODE_ENABLED
) != 0);