2 Report Status Code Library Post Code functions for DXE Phase.
4 Copyright (c) 2006, 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.
17 Sends an 32-bit value to a POST card.
19 Sends the 32-bit value specified by Value to a POST card, and returns Value.
20 Some implementations of this library function may perform I/O operations
21 directly to a POST card device. Other implementations may send Value to
22 ReportStatusCode(), and the status code reporting mechanism will eventually
23 display the 32-bit value on the status reporting device.
25 PostCode() must actively prevent recursion. If PostCode() is called while
26 processing another any other Report Status Code Library function, then
27 PostCode() must return Value immediately.
29 @param Value The 32-bit value to write to the POST card.
41 // Todo: Use approapriate ReportStatusCode
48 Sends an 32-bit value to a POST and associated ASCII string.
50 Sends the 32-bit value specified by Value to a POST card, and returns Value.
51 If Description is not NULL, then the ASCII string specified by Description is
52 also passed to the handler that displays the POST card value. Some
53 implementations of this library function may perform I/O operations directly
54 to a POST card device. Other implementations may send Value to ReportStatusCode(),
55 and the status code reporting mechanism will eventually display the 32-bit
56 value on the status reporting device.
58 PostCodeWithDescription()must actively prevent recursion. If
59 PostCodeWithDescription() is called while processing another any other Report
60 Status Code Library function, then PostCodeWithDescription() must return Value
63 @param Value The 32-bit value to write to the POST card.
64 @param Description Pointer to an ASCII string that is a description of the
65 POST code value. This is an optional parameter that may
73 PostCodeWithDescription (
75 IN CONST CHAR8
*Description OPTIONAL
79 // Todo: Use approapriate ReportStatusCode
86 Returns TRUE if POST Codes are enabled.
88 This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED
89 bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
91 @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
92 PcdPostCodeProperyMask is set.
93 @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
94 PcdPostCodeProperyMask is clear.
103 return ((PcdGet8(PcdPostCodePropertyMask
) & POST_CODE_PROPERTY_POST_CODE_ENABLED
) != 0);
108 Returns TRUE if POST code descriptions are enabled.
110 This function returns TRUE if the
111 POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
112 PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
114 @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED
115 bit of PcdPostCodeProperyMask is set.
116 @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED
117 bit of PcdPostCodeProperyMask is clear.
122 PostCodeDescriptionEnabled (
126 return ((PcdGet8(PcdPostCodePropertyMask
) & POST_CODE_PROPERTY_POST_CODE_ENABLED
) != 0);