]>
Commit | Line | Data |
---|---|---|
25126a05 | 1 | /** @file\r |
2 | Report Status Code Router PEIM which produces Report Stataus Code Handler PPI and Status Code PPI.\r | |
3 | \r | |
d1102dba | 4 | Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r |
9d510e61 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
25126a05 | 6 | \r |
7 | **/\r | |
8 | \r | |
9 | #include "ReportStatusCodeRouterPei.h"\r | |
10 | \r | |
11 | EFI_PEI_RSC_HANDLER_PPI mRscHandlerPpi = {\r | |
12 | Register,\r | |
13 | Unregister\r | |
14 | };\r | |
15 | \r | |
16 | EFI_PEI_PROGRESS_CODE_PPI mStatusCodePpi = {\r | |
17 | ReportDispatcher\r | |
18 | };\r | |
19 | \r | |
e9867606 | 20 | EFI_PEI_PPI_DESCRIPTOR mRscHandlerPpiList[] = {\r |
25126a05 | 21 | {\r |
e9867606 | 22 | EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r |
25126a05 | 23 | &gEfiPeiRscHandlerPpiGuid,\r |
24 | &mRscHandlerPpi\r | |
e9867606 | 25 | }\r |
26 | };\r | |
27 | \r | |
28 | EFI_PEI_PPI_DESCRIPTOR mStatusCodePpiList[] = {\r | |
25126a05 | 29 | {\r |
30 | EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST,\r | |
31 | &gEfiPeiStatusCodePpiGuid,\r | |
32 | &mStatusCodePpi\r | |
33 | }\r | |
34 | };\r | |
35 | \r | |
36 | /**\r | |
37 | Worker function to create one memory status code GUID'ed HOB,\r | |
38 | using PacketIndex to identify the packet.\r | |
39 | \r | |
40 | @param PacketIndex Index of records packet.\r | |
41 | \r | |
42 | @return Pointer to the memory status code packet.\r | |
43 | \r | |
44 | **/\r | |
45 | UINTN *\r | |
46 | CreateRscHandlerCallbackPacket (\r | |
47 | VOID\r | |
48 | )\r | |
49 | {\r | |
50 | UINTN *NumberOfEntries;\r | |
51 | \r | |
52 | //\r | |
53 | // Build GUID'ed HOB with PCD defined size.\r | |
54 | //\r | |
55 | NumberOfEntries = BuildGuidHob (\r | |
56 | &gStatusCodeCallbackGuid,\r | |
57 | sizeof (EFI_PEI_RSC_HANDLER_CALLBACK) * 64 + sizeof (UINTN)\r | |
58 | );\r | |
59 | ASSERT (NumberOfEntries != NULL);\r | |
60 | \r | |
61 | *NumberOfEntries = 0;\r | |
62 | \r | |
63 | return NumberOfEntries;\r | |
64 | }\r | |
65 | \r | |
66 | /**\r | |
67 | Register the callback function for ReportStatusCode() notification.\r | |
d1102dba | 68 | \r |
25126a05 | 69 | When this function is called the function pointer is added to an internal list and any future calls to\r |
70 | ReportStatusCode() will be forwarded to the Callback function.\r | |
71 | \r | |
72 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r | |
73 | when a call to ReportStatusCode() occurs.\r | |
d1102dba | 74 | \r |
25126a05 | 75 | @retval EFI_SUCCESS Function was successfully registered.\r |
76 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
77 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
78 | registered.\r | |
79 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r | |
d1102dba | 80 | \r |
25126a05 | 81 | **/\r |
82 | EFI_STATUS\r | |
83 | EFIAPI\r | |
84 | Register (\r | |
85 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
86 | )\r | |
87 | {\r | |
88 | EFI_PEI_HOB_POINTERS Hob;\r | |
89 | EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r | |
90 | UINTN *NumberOfEntries;\r | |
91 | UINTN Index;\r | |
04bbf1f3 | 92 | UINTN FreeEntryIndex;\r |
25126a05 | 93 | UINTN *FreePacket;\r |
94 | \r | |
95 | if (Callback == NULL) {\r | |
96 | return EFI_INVALID_PARAMETER;\r | |
97 | }\r | |
98 | \r | |
04bbf1f3 | 99 | Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r |
100 | FreePacket = NULL;\r | |
101 | FreeEntryIndex = 0;\r | |
25126a05 | 102 | while (Hob.Raw != NULL) {\r |
103 | NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r | |
104 | CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r | |
04bbf1f3 | 105 | if (FreePacket == NULL && *NumberOfEntries < 64) {\r |
106 | //\r | |
107 | // If current total number of handlers does not exceed 64, put new handler\r | |
108 | // at the last of packet\r | |
109 | //\r | |
25126a05 | 110 | FreePacket = NumberOfEntries;\r |
04bbf1f3 | 111 | FreeEntryIndex = *NumberOfEntries;\r |
25126a05 | 112 | }\r |
113 | for (Index = 0; Index < *NumberOfEntries; Index++) {\r | |
114 | if (CallbackEntry[Index] == Callback) {\r | |
115 | //\r | |
116 | // If the function was already registered. It can't be registered again.\r | |
117 | //\r | |
118 | return EFI_ALREADY_STARTED;\r | |
119 | }\r | |
04bbf1f3 | 120 | if (FreePacket == NULL && CallbackEntry[Index] == NULL) {\r |
121 | //\r | |
122 | // If the total number of handlers in current packet is max value 64,\r | |
123 | // search an entry with NULL pointer and fill new handler into this entry.\r | |
d1102dba | 124 | //\r |
04bbf1f3 | 125 | FreePacket = NumberOfEntries;\r |
126 | FreeEntryIndex = Index;\r | |
127 | }\r | |
25126a05 | 128 | }\r |
129 | Hob.Raw = GET_NEXT_HOB (Hob);\r | |
130 | Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r | |
131 | }\r | |
132 | \r | |
133 | if (FreePacket == NULL) {\r | |
134 | FreePacket = CreateRscHandlerCallbackPacket();\r | |
135 | }\r | |
136 | \r | |
137 | CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (FreePacket + 1);\r | |
04bbf1f3 | 138 | CallbackEntry[FreeEntryIndex] = Callback;\r |
d1102dba | 139 | \r |
04bbf1f3 | 140 | if (*FreePacket == FreeEntryIndex) {\r |
141 | //\r | |
142 | // If new registered callback is added as a new entry in the packet,\r | |
143 | // increase the total number of handlers in the packet.\r | |
144 | //\r | |
145 | *FreePacket += 1;\r | |
146 | }\r | |
25126a05 | 147 | \r |
148 | return EFI_SUCCESS;\r | |
149 | }\r | |
150 | \r | |
151 | /**\r | |
152 | Remove a previously registered callback function from the notification list.\r | |
d1102dba | 153 | \r |
25126a05 | 154 | ReportStatusCode() messages will no longer be forwarded to the Callback function.\r |
d1102dba | 155 | \r |
25126a05 | 156 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r |
157 | unregistered.\r | |
158 | \r | |
159 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
160 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
161 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
d1102dba | 162 | \r |
25126a05 | 163 | **/\r |
164 | EFI_STATUS\r | |
165 | EFIAPI\r | |
166 | Unregister (\r | |
167 | IN EFI_PEI_RSC_HANDLER_CALLBACK Callback\r | |
168 | )\r | |
169 | {\r | |
170 | EFI_PEI_HOB_POINTERS Hob;\r | |
171 | EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r | |
172 | UINTN *NumberOfEntries;\r | |
173 | UINTN Index;\r | |
174 | \r | |
175 | if (Callback == NULL) {\r | |
176 | return EFI_INVALID_PARAMETER;\r | |
177 | }\r | |
178 | \r | |
179 | Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r | |
180 | while (Hob.Raw != NULL) {\r | |
181 | NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r | |
182 | CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r | |
183 | for (Index = 0; Index < *NumberOfEntries; Index++) {\r | |
184 | if (CallbackEntry[Index] == Callback) {\r | |
04bbf1f3 | 185 | //\r |
186 | // Set removed entry as NULL.\r | |
187 | //\r | |
188 | CallbackEntry[Index] = NULL;\r | |
25126a05 | 189 | return EFI_SUCCESS;\r |
190 | }\r | |
191 | }\r | |
192 | Hob.Raw = GET_NEXT_HOB (Hob);\r | |
193 | Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r | |
194 | }\r | |
195 | \r | |
196 | return EFI_NOT_FOUND;\r | |
197 | }\r | |
198 | \r | |
199 | /**\r | |
200 | Publishes an interface that allows PEIMs to report status codes.\r | |
201 | \r | |
202 | This function implements EFI_PEI_PROGRESS_CODE_PPI.ReportStatusCode().\r | |
203 | It publishes an interface that allows PEIMs to report status codes.\r | |
204 | \r | |
205 | @param PeiServices An indirect pointer to the EFI_PEI_SERVICES table published by the PEI Foundation.\r | |
206 | @param CodeType Indicates the type of status code being reported.\r | |
207 | @param Value Describes the current status of a hardware or\r | |
208 | software entity. This includes information about the class and\r | |
209 | subclass that is used to classify the entity as well as an operation.\r | |
210 | For progress codes, the operation is the current activity.\r | |
211 | For error codes, it is the exception.For debug codes,it is not defined at this time.\r | |
212 | @param Instance The enumeration of a hardware or software entity within\r | |
213 | the system. A system may contain multiple entities that match a class/subclass\r | |
214 | pairing. The instance differentiates between them. An instance of 0 indicates\r | |
215 | that instance information is unavailable, not meaningful, or not relevant.\r | |
216 | Valid instance numbers start with 1.\r | |
217 | @param CallerId This optional parameter may be used to identify the caller.\r | |
218 | This parameter allows the status code driver to apply different rules to\r | |
219 | different callers.\r | |
220 | @param Data This optional parameter may be used to pass additional data.\r | |
221 | \r | |
222 | @retval EFI_SUCCESS The function completed successfully.\r | |
223 | \r | |
224 | **/\r | |
225 | EFI_STATUS\r | |
226 | EFIAPI\r | |
227 | ReportDispatcher (\r | |
228 | IN CONST EFI_PEI_SERVICES **PeiServices,\r | |
229 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
230 | IN EFI_STATUS_CODE_VALUE Value,\r | |
231 | IN UINT32 Instance,\r | |
232 | IN CONST EFI_GUID *CallerId OPTIONAL,\r | |
233 | IN CONST EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
234 | )\r | |
235 | {\r | |
236 | EFI_PEI_HOB_POINTERS Hob;\r | |
237 | EFI_PEI_RSC_HANDLER_CALLBACK *CallbackEntry;\r | |
238 | UINTN *NumberOfEntries;\r | |
239 | UINTN Index;\r | |
240 | \r | |
241 | Hob.Raw = GetFirstGuidHob (&gStatusCodeCallbackGuid);\r | |
242 | while (Hob.Raw != NULL) {\r | |
243 | NumberOfEntries = GET_GUID_HOB_DATA (Hob);\r | |
244 | CallbackEntry = (EFI_PEI_RSC_HANDLER_CALLBACK *) (NumberOfEntries + 1);\r | |
245 | for (Index = 0; Index < *NumberOfEntries; Index++) {\r | |
e846c180 | 246 | if (CallbackEntry[Index] != NULL) {\r |
25126a05 | 247 | CallbackEntry[Index](\r |
248 | PeiServices,\r | |
249 | CodeType,\r | |
250 | Value,\r | |
251 | Instance,\r | |
252 | CallerId,\r | |
253 | Data\r | |
254 | );\r | |
e846c180 | 255 | }\r |
25126a05 | 256 | }\r |
257 | Hob.Raw = GET_NEXT_HOB (Hob);\r | |
258 | Hob.Raw = GetNextGuidHob (&gStatusCodeCallbackGuid, Hob.Raw);\r | |
259 | }\r | |
260 | \r | |
261 | return EFI_SUCCESS;\r | |
262 | }\r | |
263 | \r | |
264 | /**\r | |
265 | Entry point of Status Code PEIM.\r | |
d1102dba | 266 | \r |
25126a05 | 267 | This function is the entry point of this Status Code Router PEIM.\r |
268 | It produces Report Stataus Code Handler PPI and Status Code PPI.\r | |
269 | \r | |
270 | @param FileHandle Handle of the file being invoked.\r | |
271 | @param PeiServices Describes the list of possible PEI Services.\r | |
272 | \r | |
273 | @retval EFI_SUCESS The entry point of DXE IPL PEIM executes successfully.\r | |
274 | \r | |
275 | **/\r | |
276 | EFI_STATUS\r | |
277 | EFIAPI\r | |
278 | GenericStatusCodePeiEntry (\r | |
279 | IN EFI_PEI_FILE_HANDLE FileHandle,\r | |
280 | IN CONST EFI_PEI_SERVICES **PeiServices\r | |
281 | )\r | |
282 | {\r | |
e9867606 | 283 | EFI_STATUS Status;\r |
284 | EFI_PEI_PPI_DESCRIPTOR *OldDescriptor;\r | |
285 | EFI_PEI_PROGRESS_CODE_PPI *OldStatusCodePpi;\r | |
25126a05 | 286 | \r |
287 | CreateRscHandlerCallbackPacket ();\r | |
288 | \r | |
e9867606 | 289 | //\r |
290 | // Install Report Status Code Handler PPI\r | |
291 | //\r | |
292 | Status = PeiServicesInstallPpi (mRscHandlerPpiList);\r | |
293 | ASSERT_EFI_ERROR (Status);\r | |
294 | \r | |
295 | //\r | |
296 | // Install Status Code PPI. PI spec specifies that there can be only one instance\r | |
297 | // of this PPI in system. So first check if other instance already exists.\r | |
298 | // If no other instance exists, then just install the PPI.\r | |
299 | // If other instance already exists, then reinstall it.\r | |
300 | //\r | |
301 | Status = PeiServicesLocatePpi (\r | |
302 | &gEfiPeiStatusCodePpiGuid,\r | |
303 | 0,\r | |
304 | &OldDescriptor,\r | |
305 | (VOID **) &OldStatusCodePpi\r | |
306 | );\r | |
307 | if (!EFI_ERROR (Status)) {\r | |
308 | Status = PeiServicesReInstallPpi (OldDescriptor, mStatusCodePpiList);\r | |
309 | } else {\r | |
310 | Status = PeiServicesInstallPpi (mStatusCodePpiList);\r | |
311 | }\r | |
25126a05 | 312 | ASSERT_EFI_ERROR (Status);\r |
313 | \r | |
314 | return EFI_SUCCESS;\r | |
315 | }\r |