/** @file\r
Null Base Report Status Code Library instance with empty functions.\r
\r
- Copyright (c) 2009, Intel Corporation<BR>\r
- All rights reserved. This program and the accompanying materials\r
+ Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution. The full text of the license may be found at\r
- http://opensource.org/licenses/bsd-license.php\r
+ http://opensource.org/licenses/bsd-license.php.\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
@param CodeType The type of status code being converted.\r
@param Value The status code value being converted.\r
- @param Data Pointer to status code data buffer.\r
- @param Filename Pointer to the source file name that generated the ASSERT().\r
- @param Description Pointer to the description of the ASSERT().\r
- @param LineNumber Pointer to source line number that generated the ASSERT().\r
+ @param Data The pointer to the status code data buffer.\r
+ @param Filename The pointer to the source file name that generated the ASSERT().\r
+ @param Description The pointer to the description of the ASSERT().\r
+ @param LineNumber The pointer to the source line number that generated the ASSERT().\r
\r
@retval TRUE The status code specified by CodeType, Value, and Data was\r
converted ASSERT() arguments specified by Filename, Description,\r
If Marker is NULL, then ASSERT().\r
If Format is NULL, then ASSERT().\r
\r
- @param Data Pointer to status code data buffer.\r
- @param ErrorLevel Pointer to error level mask for a debug message.\r
- @param Marker Pointer to the variable argument list associated with Format.\r
- @param Format Pointer to a Null-terminated ASCII format string of a\r
+ @param Data The pointer to the status code data buffer.\r
+ @param ErrorLevel The pointer to the error level mask for a debug message.\r
+ @param Marker The pointer to the variable argument list associated with Format.\r
+ @param Format The pointer to a Null-terminated ASCII format string of a\r
debug message.\r
\r
@retval TRUE The status code specified by Data was converted DEBUG() arguments\r
OUT CHAR8 **Format\r
)\r
{\r
- ASSERT (Data != NULL);\r
- ASSERT (ErrorLevel != NULL);\r
- ASSERT (StartOfBuffer != NULL);\r
+ ASSERT (Data != NULL);\r
+ ASSERT (ErrorLevel != NULL);\r
+ ASSERT (Marker != NULL);\r
+ ASSERT (Format != NULL);\r
\r
return FALSE;\r
}\r
is called while processing another any other Report Status Code Library function,\r
then ReportStatusCode() must return immediately.\r
\r
- @param Type Status code type.\r
- @param Value Status code value.\r
+ @param Type The status code type.\r
+ @param Value The status code value.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_DEVICE_ERROR There status code could not be reported due to a\r
device error.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
\r
**/\r
EFI_STATUS\r
\r
@param Type Status code type.\r
@param Value Status code value.\r
- @param DevicePath Pointer to the Device Path Protocol to be reported.\r
+ @param DevicePath The pointer to the Device Path Protocol to be reported.\r
\r
@retval EFI_SUCCESS The status code was reported with the extended\r
data specified by DevicePath.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported\r
\r
**/\r
EFI_STATUS\r
\r
@param Type Status code type.\r
@param Value Status code value.\r
- @param ExtendedData Pointer to the extended data buffer to be reported.\r
+ @param ExtendedData The pointer to the extended data buffer to be reported.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer to\r
be reported.\r
\r
data specified by ExtendedData and ExtendedDataSize.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate the\r
extended data section.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
\r
**/\r
EFI_STATUS\r
is responsible for allocating a buffer large enough for the standard header and\r
the extended data passed into this function. The standard header is filled in\r
with a GUID specified by ExtendedDataGuid. If ExtendedDataGuid is NULL, then a\r
- GUID of gEfiStatusCodeSpecificDatauid is used. The status code is reported with\r
+ GUID of gEfiStatusCodeSpecificDataGuid is used. The status code is reported with\r
an instance specified by Instance and a caller ID specified by CallerId. If\r
CallerId is NULL, then a caller ID of gEfiCallerIdGuid is used.\r
\r
If ExtendedData is NULL and ExtendedDataSize is not zero, then ASSERT().\r
If ExtendedData is not NULL and ExtendedDataSize is zero, then ASSERT().\r
\r
- @param Type Status code type.\r
- @param Value Status code value.\r
+ @param Type The status code type.\r
+ @param Value The status code value.\r
@param Instance Status code instance number.\r
- @param CallerId Pointer to a GUID that identifies the caller of this\r
+ @param CallerId The pointer to a GUID that identifies the caller of this\r
function. If this parameter is NULL, then a caller\r
ID of gEfiCallerIdGuid is used.\r
- @param ExtendedDataGuid Pointer to the GUID for the extended data buffer.\r
+ @param ExtendedDataGuid The pointer to the GUID for the extended data buffer.\r
If this parameter is NULL, then a the status code\r
standard header is filled in with\r
gEfiStatusCodeSpecificDataGuid.\r
- @param ExtendedData Pointer to the extended data buffer. This is an\r
+ @param ExtendedData The pointer to the extended data buffer. This is an\r
optional parameter that may be NULL.\r
@param ExtendedDataSize The size, in bytes, of the extended data buffer.\r
\r
@retval EFI_SUCCESS The status code was reported.\r
@retval EFI_OUT_OF_RESOURCES There were not enough resources to allocate\r
the extended data section if it was specified.\r
- @retval EFI_UNSUPPORTED Report status code is not supported\r
+ @retval EFI_UNSUPPORTED The report status code is not supported.\r
\r
**/\r
EFI_STATUS\r
projects / mirror_edk2.git / blobdiff