]>
Commit | Line | Data |
---|---|---|
dc2b05a2 | 1 | /** @file\r |
2 | PI SMM Status Code Protocol on Framework SMM Status Code Protocol Thunk.\r | |
3 | \r | |
4 | This thunk driver produces PI SMM Status Code Protocol and SMM Report Status Code Handler Protocol.\r | |
5 | And it registers a status code handler within itself to route status codes into Framework SMM Status\r | |
6 | Code Protocol.\r | |
7 | \r | |
8 | Note that Framework SMM Status Code Protocol and PI SMM Status Code Protocol have identical protocol\r | |
9 | GUID and interface structure, but they are in different handle databases.\r | |
10 | \r | |
584d5652 | 11 | Copyright (c) 2010, Intel Corporation. All rights reserved.<BR>\r |
dc2b05a2 | 12 | This program and the accompanying materials are licensed and made available under \r |
13 | the terms and conditions of the BSD License that accompanies this distribution. \r | |
dc2b05a2 | 14 | The full text of the license may be found at\r |
15 | http://opensource.org/licenses/bsd-license.php. \r | |
16 | \r | |
17 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
18 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
19 | \r | |
20 | **/\r | |
21 | \r | |
22 | #include "PiSmmStatusCodeOnFrameworkSmmStatusCodeThunk.h"\r | |
23 | \r | |
24 | LIST_ENTRY mCallbackListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackListHead);\r | |
25 | \r | |
26 | //\r | |
27 | // Report operation nest status.\r | |
28 | // If it is set, then the report operation has nested.\r | |
29 | //\r | |
30 | UINT32 mStatusCodeNestStatus = 0;\r | |
31 | \r | |
32 | EFI_SMM_STATUS_CODE_PROTOCOL mSmmStatusCodeProtocol = {\r | |
33 | ReportDispatcher\r | |
34 | };\r | |
35 | \r | |
36 | EFI_SMM_RSC_HANDLER_PROTOCOL mSmmRscHandlerProtocol = {\r | |
37 | Register,\r | |
38 | Unregister\r | |
39 | };\r | |
40 | \r | |
41 | EFI_SMM_STATUS_CODE_PROTOCOL *mFrameworkSmmStatusCode;\r | |
42 | \r | |
43 | /**\r | |
44 | Register the callback function for ReportStatusCode() notification.\r | |
45 | \r | |
46 | When this function is called the function pointer is added to an internal list and any future calls to\r | |
47 | ReportStatusCode() will be forwarded to the Callback function.\r | |
48 | \r | |
49 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is called\r | |
50 | when a call to ReportStatusCode() occurs.\r | |
51 | \r | |
52 | @retval EFI_SUCCESS Function was successfully registered.\r | |
53 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
54 | @retval EFI_OUT_OF_RESOURCES The internal buffer ran out of space. No more functions can be\r | |
55 | registered.\r | |
56 | @retval EFI_ALREADY_STARTED The function was already registered. It can't be registered again.\r | |
57 | \r | |
58 | **/\r | |
59 | EFI_STATUS\r | |
60 | EFIAPI\r | |
61 | Register (\r | |
62 | IN EFI_SMM_RSC_HANDLER_CALLBACK Callback\r | |
63 | )\r | |
64 | {\r | |
65 | LIST_ENTRY *Link;\r | |
66 | SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
67 | \r | |
68 | if (Callback == NULL) {\r | |
69 | return EFI_INVALID_PARAMETER;\r | |
70 | }\r | |
71 | \r | |
72 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
73 | CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
74 | if (CallbackEntry->RscHandlerCallback == Callback) {\r | |
75 | //\r | |
76 | // If the function was already registered. It can't be registered again.\r | |
77 | //\r | |
78 | return EFI_ALREADY_STARTED;\r | |
79 | }\r | |
80 | }\r | |
81 | \r | |
82 | CallbackEntry = (SMM_RSC_HANDLER_CALLBACK_ENTRY *)AllocatePool (sizeof (SMM_RSC_HANDLER_CALLBACK_ENTRY));\r | |
83 | ASSERT (CallbackEntry != NULL);\r | |
84 | \r | |
85 | CallbackEntry->Signature = SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE;\r | |
86 | CallbackEntry->RscHandlerCallback = Callback;\r | |
87 | \r | |
88 | InsertTailList (&mCallbackListHead, &CallbackEntry->Node);\r | |
89 | \r | |
90 | return EFI_SUCCESS;\r | |
91 | }\r | |
92 | \r | |
93 | /**\r | |
94 | Remove a previously registered callback function from the notification list.\r | |
95 | \r | |
96 | ReportStatusCode() messages will no longer be forwarded to the Callback function.\r | |
97 | \r | |
98 | @param[in] Callback A pointer to a function of type EFI_PEI_RSC_HANDLER_CALLBACK that is to be\r | |
99 | unregistered.\r | |
100 | \r | |
101 | @retval EFI_SUCCESS The function was successfully unregistered.\r | |
102 | @retval EFI_INVALID_PARAMETER The callback function was NULL.\r | |
103 | @retval EFI_NOT_FOUND The callback function was not found to be unregistered.\r | |
104 | \r | |
105 | **/\r | |
106 | EFI_STATUS\r | |
107 | EFIAPI\r | |
108 | Unregister (\r | |
109 | IN EFI_SMM_RSC_HANDLER_CALLBACK Callback\r | |
110 | )\r | |
111 | {\r | |
112 | LIST_ENTRY *Link;\r | |
113 | SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
114 | \r | |
115 | if (Callback == NULL) {\r | |
116 | return EFI_INVALID_PARAMETER;\r | |
117 | }\r | |
118 | \r | |
119 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
120 | CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
121 | if (CallbackEntry->RscHandlerCallback == Callback) {\r | |
122 | //\r | |
123 | // If the function is found in list, delete it and return.\r | |
124 | //\r | |
125 | RemoveEntryList (&CallbackEntry->Node);\r | |
126 | FreePool (CallbackEntry);\r | |
127 | return EFI_SUCCESS;\r | |
128 | }\r | |
129 | }\r | |
130 | \r | |
131 | return EFI_NOT_FOUND;\r | |
132 | }\r | |
133 | \r | |
134 | \r | |
135 | /**\r | |
136 | Provides an interface that a software module can call to report a status code.\r | |
137 | \r | |
138 | @param This EFI_SMM_STATUS_CODE_PROTOCOL instance.\r | |
139 | @param Type Indicates the type of status code being reported.\r | |
140 | @param Value Describes the current status of a hardware or software entity.\r | |
141 | This included information about the class and subclass that is used to\r | |
142 | classify the entity as well as an operation.\r | |
143 | @param Instance The enumeration of a hardware or software entity within\r | |
144 | the system. Valid instance numbers start with 1.\r | |
145 | @param CallerId This optional parameter may be used to identify the caller.\r | |
146 | This parameter allows the status code driver to apply different rules to\r | |
147 | different callers.\r | |
148 | @param Data This optional parameter may be used to pass additional data.\r | |
149 | \r | |
150 | @retval EFI_SUCCESS The function completed successfully\r | |
151 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
152 | \r | |
153 | **/\r | |
154 | EFI_STATUS\r | |
155 | EFIAPI\r | |
156 | ReportDispatcher (\r | |
157 | IN CONST EFI_SMM_STATUS_CODE_PROTOCOL *This,\r | |
158 | IN EFI_STATUS_CODE_TYPE Type,\r | |
159 | IN EFI_STATUS_CODE_VALUE Value,\r | |
160 | IN UINT32 Instance,\r | |
161 | IN CONST EFI_GUID *CallerId OPTIONAL,\r | |
162 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
163 | )\r | |
164 | {\r | |
165 | LIST_ENTRY *Link;\r | |
166 | SMM_RSC_HANDLER_CALLBACK_ENTRY *CallbackEntry;\r | |
167 | \r | |
168 | //\r | |
169 | // Use atom operation to avoid the reentant of report.\r | |
170 | // If current status is not zero, then the function is reentrancy.\r | |
171 | //\r | |
172 | if (InterlockedCompareExchange32 (&mStatusCodeNestStatus, 0, 1) == 1) {\r | |
173 | return EFI_DEVICE_ERROR;\r | |
174 | }\r | |
175 | \r | |
176 | for (Link = GetFirstNode (&mCallbackListHead); !IsNull (&mCallbackListHead, Link); Link = GetNextNode (&mCallbackListHead, Link)) {\r | |
177 | CallbackEntry = CR (Link, SMM_RSC_HANDLER_CALLBACK_ENTRY, Node, SMM_RSC_HANDLER_CALLBACK_ENTRY_SIGNATURE);\r | |
178 | \r | |
179 | CallbackEntry->RscHandlerCallback (\r | |
180 | Type,\r | |
181 | Value,\r | |
182 | Instance,\r | |
183 | (EFI_GUID*)CallerId,\r | |
184 | Data\r | |
185 | );\r | |
186 | \r | |
187 | }\r | |
188 | \r | |
189 | //\r | |
190 | // Restore the nest status of report\r | |
191 | //\r | |
192 | InterlockedCompareExchange32 (&mStatusCodeNestStatus, 1, 0);\r | |
193 | \r | |
194 | return EFI_SUCCESS;\r | |
195 | }\r | |
196 | \r | |
197 | /**\r | |
198 | This SMM Status Code Handler routes status codes to Framework SMM Status Code Protocol.\r | |
199 | \r | |
200 | @param CodeType Indicates the type of status code being reported.\r | |
201 | @param Value Describes the current status of a hardware or software entity.\r | |
202 | This included information about the class and subclass that is used to\r | |
203 | classify the entity as well as an operation.\r | |
204 | @param Instance The enumeration of a hardware or software entity within\r | |
205 | the system. Valid instance numbers start with 1.\r | |
206 | @param CallerId This optional parameter may be used to identify the caller.\r | |
207 | This parameter allows the status code driver to apply different rules to\r | |
208 | different callers.\r | |
209 | @param Data This optional parameter may be used to pass additional data.\r | |
210 | \r | |
211 | @retval EFI_SUCCESS The function completed successfully.\r | |
212 | @retval EFI_DEVICE_ERROR The function should not be completed due to a device error.\r | |
213 | \r | |
214 | **/\r | |
215 | EFI_STATUS\r | |
12496963 | 216 | EFIAPI\r |
dc2b05a2 | 217 | SmmStatusCodeHandler (\r |
218 | IN EFI_STATUS_CODE_TYPE CodeType,\r | |
219 | IN EFI_STATUS_CODE_VALUE Value,\r | |
220 | IN UINT32 Instance,\r | |
221 | IN EFI_GUID *CallerId,\r | |
222 | IN EFI_STATUS_CODE_DATA *Data OPTIONAL\r | |
223 | )\r | |
224 | {\r | |
225 | return mFrameworkSmmStatusCode->ReportStatusCode (\r | |
226 | mFrameworkSmmStatusCode,\r | |
227 | CodeType,\r | |
228 | Value,\r | |
229 | Instance,\r | |
230 | CallerId,\r | |
231 | Data\r | |
232 | ); \r | |
233 | }\r | |
234 | \r | |
235 | /**\r | |
236 | Entry point of PI SMM Status Code Protocol on Framework SMM Status Code Protocol thunk driver.\r | |
237 | \r | |
238 | @param ImageHandle The firmware allocated handle for the EFI image.\r | |
239 | @param SystemTable A pointer to the EFI System Table.\r | |
240 | \r | |
241 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
242 | \r | |
243 | **/\r | |
244 | EFI_STATUS\r | |
245 | EFIAPI\r | |
246 | SmmStatusCodeThunkMain (\r | |
247 | IN EFI_HANDLE ImageHandle,\r | |
248 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
249 | )\r | |
250 | {\r | |
251 | EFI_STATUS Status;\r | |
252 | EFI_HANDLE Handle;\r | |
253 | \r | |
254 | //\r | |
255 | // Locate Framework SMM Status Code Protocol in UEFI handle database.\r | |
256 | //\r | |
257 | Status = SystemTable->BootServices->LocateProtocol (\r | |
258 | &gEfiSmmStatusCodeProtocolGuid,\r | |
259 | NULL,\r | |
260 | (VOID **)&mFrameworkSmmStatusCode\r | |
261 | );\r | |
262 | ASSERT_EFI_ERROR (Status);\r | |
263 | \r | |
264 | //\r | |
265 | // Registers status code handler to route status codes into Framework SMM Status Code Protocol.\r | |
266 | //\r | |
267 | Register (SmmStatusCodeHandler);\r | |
268 | \r | |
269 | Handle = NULL;\r | |
270 | \r | |
271 | //\r | |
272 | // Install SmmRscHandler Protocol\r | |
273 | //\r | |
274 | Status = gSmst->SmmInstallProtocolInterface (\r | |
275 | &Handle,\r | |
276 | &gEfiSmmRscHandlerProtocolGuid,\r | |
277 | EFI_NATIVE_INTERFACE,\r | |
278 | &mSmmRscHandlerProtocol\r | |
279 | );\r | |
280 | ASSERT_EFI_ERROR (Status);\r | |
281 | \r | |
282 | //\r | |
283 | // Install SmmStatusCode Protocol\r | |
284 | //\r | |
285 | Status = gSmst->SmmInstallProtocolInterface (\r | |
286 | &Handle,\r | |
287 | &gEfiSmmStatusCodeProtocolGuid,\r | |
288 | EFI_NATIVE_INTERFACE,\r | |
289 | &mSmmStatusCodeProtocol\r | |
290 | );\r | |
291 | ASSERT_EFI_ERROR (Status);\r | |
292 | \r | |
293 | return EFI_SUCCESS;\r | |
294 | }\r |