Report Status Code Library Post Code functions for DXE Phase.\r
\r
Copyright (c) 2006, Intel Corporation<BR>\r
- All rights reserved. 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
+ All rights reserved. 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
\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
+ 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
**/\r
\r
+//\r
+// The package level header files this module uses\r
+//\r
+#include <PiPei.h>\r
+//\r
+// The Library classes this module consumes\r
+//\r
+#include <Library/PostCodeLib.h>\r
+#include <Library/ReportStatusCodeLib.h>\r
+#include <Library/PcdLib.h>\r
+#include <Library/BaseLib.h>\r
+\r
/**\r
Converts POST code value to status code value.\r
\r
- This macro converts the post code to status code value. Bits 0..4 of PostCode \r
- are mapped to bits 16..20 of status code value, and bits 5..7 of PostCode are mapped to bits \r
- 24..26 of status code value. \r
+ This macro converts the post code to status code value. Bits 0..4 of PostCode\r
+ are mapped to bits 16..20 of status code value, and bits 5..7 of PostCode are mapped to bits\r
+ 24..26 of status code value.\r
\r
- @param PostCode POST code value. \r
+ @param PostCode POST code value.\r
\r
@return The converted status code value.\r
\r
/**\r
Sends an 32-bit value to a POST card.\r
\r
- Sends the 32-bit value specified by Value to a POST card, and returns Value. \r
- Some implementations of this library function may perform I/O operations \r
- directly to a POST card device. Other implementations may send Value to \r
- ReportStatusCode(), and the status code reporting mechanism will eventually \r
+ Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
+ Some implementations of this library function may perform I/O operations\r
+ directly to a POST card device. Other implementations may send Value to\r
+ ReportStatusCode(), and the status code reporting mechanism will eventually\r
display the 32-bit value on the status reporting device.\r
- \r
- PostCode() must actively prevent recursion. If PostCode() is called while \r
- processing another any other Report Status Code Library function, then \r
+\r
+ PostCode() must actively prevent recursion. If PostCode() is called while\r
+ processing another any other Report Status Code Library function, then\r
PostCode() must return Value immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
Sends an 32-bit value to a POST and associated ASCII string.\r
\r
Sends the 32-bit value specified by Value to a POST card, and returns Value.\r
- If Description is not NULL, then the ASCII string specified by Description is \r
- also passed to the handler that displays the POST card value. Some \r
- implementations of this library function may perform I/O operations directly \r
- to a POST card device. Other implementations may send Value to ReportStatusCode(), \r
- and the status code reporting mechanism will eventually display the 32-bit \r
- value on the status reporting device. \r
-\r
- PostCodeWithDescription()must actively prevent recursion. If \r
- PostCodeWithDescription() is called while processing another any other Report \r
- Status Code Library function, then PostCodeWithDescription() must return Value \r
+ If Description is not NULL, then the ASCII string specified by Description is\r
+ also passed to the handler that displays the POST card value. Some\r
+ implementations of this library function may perform I/O operations directly\r
+ to a POST card device. Other implementations may send Value to ReportStatusCode(),\r
+ and the status code reporting mechanism will eventually display the 32-bit\r
+ value on the status reporting device.\r
+\r
+ PostCodeWithDescription()must actively prevent recursion. If\r
+ PostCodeWithDescription() is called while processing another any other Report\r
+ Status Code Library function, then PostCodeWithDescription() must return Value\r
immediately.\r
\r
@param Value The 32-bit value to write to the POST card.\r
- @param Description Pointer to an ASCII string that is a description of the \r
- POST code value. This is an optional parameter that may \r
+ @param Description Pointer to an ASCII string that is a description of the\r
+ POST code value. This is an optional parameter that may\r
be NULL.\r
\r
@return Value\r
IN CONST CHAR8 *Description OPTIONAL\r
)\r
{\r
- if (Description == NULL) { \r
+ if (Description == NULL) {\r
REPORT_STATUS_CODE (\r
EFI_PROGRESS_CODE,\r
POST_CODE_TO_STATUS_CODE_VALUE (Value)\r
/**\r
Returns TRUE if POST Codes are enabled.\r
\r
- This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED \r
+ This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED\r
bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
PcdPostCodeProperyMask is clear.\r
\r
**/\r
/**\r
Returns TRUE if POST code descriptions are enabled.\r
\r
- This function returns TRUE if the \r
- POST_CODE_PROPERTY_POST_CODE_ENABLED bit of \r
+ This function returns TRUE if the\r
+ POST_CODE_PROPERTY_POST_CODE_ENABLED bit of\r
PcdPostCodePropertyMask is set. Otherwise FALSE is returned.\r
\r
- @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
+ @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED\r
bit of PcdPostCodeProperyMask is set.\r
- @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED \r
+ @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED\r
bit of PcdPostCodeProperyMask is clear.\r
\r
**/\r
projects / mirror_edk2.git / blobdiff