408ede45c72b143c75e756c2ed9e57c178173c79
[mirror_edk2.git] / MdePkg / Library / PeiDxePostCodeLibReportStatusCode / PostCode.c
1 /** @file
2 Report Status Code Library Post Code functions for DXE Phase.
3
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
9
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.
12
13 **/
14
15 /**
16 Converts POST code value to status code value.
17
18 This macro converts the post code to status code value. Bits 0..4 of PostCode
19 are mapped to bits 16..20 of status code value, and bits 5..7 of PostCode are mapped to bits
20 24..26 of status code value.
21
22 @param PostCode POST code value.
23
24 @return The converted status code value.
25
26 **/
27 #define POST_CODE_TO_STATUS_CODE_VALUE(PostCode) \
28 ((EFI_STATUS_CODE_VALUE) (((PostCode & 0x1f) << 16) | ((PostCode & 0x3) << 19)))
29
30 /**
31 Sends an 32-bit value to a POST card.
32
33 Sends the 32-bit value specified by Value to a POST card, and returns Value.
34 Some implementations of this library function may perform I/O operations
35 directly to a POST card device. Other implementations may send Value to
36 ReportStatusCode(), and the status code reporting mechanism will eventually
37 display the 32-bit value on the status reporting device.
38
39 PostCode() must actively prevent recursion. If PostCode() is called while
40 processing another any other Report Status Code Library function, then
41 PostCode() must return Value immediately.
42
43 @param Value The 32-bit value to write to the POST card.
44
45 @return Value
46
47 **/
48 UINT32
49 EFIAPI
50 PostCode (
51 IN UINT32 Value
52 )
53 {
54 REPORT_STATUS_CODE (EFI_PROGRESS_CODE, POST_CODE_TO_STATUS_CODE_VALUE (Value));
55 return Value;
56 }
57
58
59 /**
60 Sends an 32-bit value to a POST and associated ASCII string.
61
62 Sends the 32-bit value specified by Value to a POST card, and returns Value.
63 If Description is not NULL, then the ASCII string specified by Description is
64 also passed to the handler that displays the POST card value. Some
65 implementations of this library function may perform I/O operations directly
66 to a POST card device. Other implementations may send Value to ReportStatusCode(),
67 and the status code reporting mechanism will eventually display the 32-bit
68 value on the status reporting device.
69
70 PostCodeWithDescription()must actively prevent recursion. If
71 PostCodeWithDescription() is called while processing another any other Report
72 Status Code Library function, then PostCodeWithDescription() must return Value
73 immediately.
74
75 @param Value The 32-bit value to write to the POST card.
76 @param Description Pointer to an ASCII string that is a description of the
77 POST code value. This is an optional parameter that may
78 be NULL.
79
80 @return Value
81
82 **/
83 UINT32
84 EFIAPI
85 PostCodeWithDescription (
86 IN UINT32 Value,
87 IN CONST CHAR8 *Description OPTIONAL
88 )
89 {
90 if (Description == NULL) {
91 REPORT_STATUS_CODE (
92 EFI_PROGRESS_CODE,
93 POST_CODE_TO_STATUS_CODE_VALUE (Value)
94 );
95 } else {
96 REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
97 EFI_PROGRESS_CODE,
98 POST_CODE_TO_STATUS_CODE_VALUE (Value),
99 Description,
100 AsciiStrSize (Description)
101 );
102 }
103
104 return Value;
105 }
106
107
108 /**
109 Returns TRUE if POST Codes are enabled.
110
111 This function returns TRUE if the POST_CODE_PROPERTY_POST_CODE_ENABLED
112 bit of PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
113
114 @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
115 PcdPostCodeProperyMask is set.
116 @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
117 PcdPostCodeProperyMask is clear.
118
119 **/
120 BOOLEAN
121 EFIAPI
122 PostCodeEnabled (
123 VOID
124 )
125 {
126 return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);
127 }
128
129
130 /**
131 Returns TRUE if POST code descriptions are enabled.
132
133 This function returns TRUE if the
134 POST_CODE_PROPERTY_POST_CODE_ENABLED bit of
135 PcdPostCodePropertyMask is set. Otherwise FALSE is returned.
136
137 @retval TRUE The POST_CODE_PROPERTY_POST_CODE_ENABLED
138 bit of PcdPostCodeProperyMask is set.
139 @retval FALSE The POST_CODE_PROPERTY_POST_CODE_ENABLED
140 bit of PcdPostCodeProperyMask is clear.
141
142 **/
143 BOOLEAN
144 EFIAPI
145 PostCodeDescriptionEnabled (
146 VOID
147 )
148 {
149 return (BOOLEAN) ((PcdGet8(PcdPostCodePropertyMask) & POST_CODE_PROPERTY_POST_CODE_ENABLED) != 0);
150 }