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