]> git.proxmox.com Git - mirror_edk2.git/blame - MdeModulePkg/Core/PiSmmCore/Smi.c
Change TPM ACCESS_X.activeLocality test timeout to TIMEOUT_A
[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / Smi.c
CommitLineData
e42e9404 1/** @file\r
2 SMI management.\r
3\r
d5b339a9 4 Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>\r
e42e9404 5 This program and the accompanying materials are licensed and made available \r
6 under the terms and conditions of the BSD License which accompanies this \r
7 distribution. The full text of the license may be found at \r
8 http://opensource.org/licenses/bsd-license.php \r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
12\r
13**/\r
14\r
15#include "PiSmmCore.h"\r
16\r
17//\r
18// SMM_HANDLER - used for each SMM handler\r
19//\r
20\r
21#define SMI_ENTRY_SIGNATURE SIGNATURE_32('s','m','i','e')\r
22\r
23 typedef struct {\r
24 UINTN Signature;\r
25 LIST_ENTRY AllEntries; // All entries\r
26\r
27 EFI_GUID HandlerType; // Type of interrupt\r
28 LIST_ENTRY SmiHandlers; // All handlers\r
29} SMI_ENTRY;\r
30\r
31#define SMI_HANDLER_SIGNATURE SIGNATURE_32('s','m','i','h')\r
32\r
33 typedef struct {\r
34 UINTN Signature;\r
35 LIST_ENTRY Link; // Link on SMI_ENTRY.SmiHandlers\r
36 EFI_SMM_HANDLER_ENTRY_POINT2 Handler; // The smm handler's entry point\r
37 SMI_ENTRY *SmiEntry;\r
38} SMI_HANDLER;\r
39\r
40LIST_ENTRY mRootSmiHandlerList = INITIALIZE_LIST_HEAD_VARIABLE (mRootSmiHandlerList);\r
41LIST_ENTRY mSmiEntryList = INITIALIZE_LIST_HEAD_VARIABLE (mSmiEntryList);\r
42\r
43/**\r
44 Finds the SMI entry for the requested handler type.\r
45\r
46 @param HandlerType The type of the interrupt\r
47 @param Create Create a new entry if not found\r
48\r
49 @return SMI entry\r
50\r
51**/\r
52SMI_ENTRY *\r
53EFIAPI\r
54SmmCoreFindSmiEntry (\r
55 IN EFI_GUID *HandlerType,\r
56 IN BOOLEAN Create\r
57 )\r
58{\r
59 LIST_ENTRY *Link;\r
60 SMI_ENTRY *Item;\r
61 SMI_ENTRY *SmiEntry;\r
62\r
63 //\r
64 // Search the SMI entry list for the matching GUID\r
65 //\r
66 SmiEntry = NULL;\r
67 for (Link = mSmiEntryList.ForwardLink;\r
68 Link != &mSmiEntryList;\r
69 Link = Link->ForwardLink) {\r
70\r
71 Item = CR (Link, SMI_ENTRY, AllEntries, SMI_ENTRY_SIGNATURE);\r
72 if (CompareGuid (&Item->HandlerType, HandlerType)) {\r
73 //\r
74 // This is the SMI entry\r
75 //\r
76 SmiEntry = Item;\r
77 break;\r
78 }\r
79 }\r
80\r
81 //\r
82 // If the protocol entry was not found and Create is TRUE, then\r
83 // allocate a new entry\r
84 //\r
85 if ((SmiEntry == NULL) && Create) {\r
86 SmiEntry = AllocatePool (sizeof(SMI_ENTRY));\r
87 if (SmiEntry != NULL) {\r
88 //\r
89 // Initialize new SMI entry structure\r
90 //\r
91 SmiEntry->Signature = SMI_ENTRY_SIGNATURE;\r
92 CopyGuid ((VOID *)&SmiEntry->HandlerType, HandlerType);\r
93 InitializeListHead (&SmiEntry->SmiHandlers);\r
94\r
95 //\r
96 // Add it to SMI entry list\r
97 //\r
98 InsertTailList (&mSmiEntryList, &SmiEntry->AllEntries);\r
99 }\r
100 }\r
101 return SmiEntry;\r
102}\r
103\r
104/**\r
105 Manage SMI of a particular type.\r
106\r
107 @param HandlerType Points to the handler type or NULL for root SMI handlers.\r
108 @param Context Points to an optional context buffer.\r
109 @param CommBuffer Points to the optional communication buffer.\r
110 @param CommBufferSize Points to the size of the optional communication buffer.\r
111\r
d5b339a9 112 @retval EFI_WARN_INTERRUPT_SOURCE_PENDING Interrupt source was processed successfully but not quiesced.\r
e42e9404 113 @retval EFI_INTERRUPT_PENDING One or more SMI sources could not be quiesced.\r
d5b339a9 114 @retval EFI_NOT_FOUND Interrupt source was not handled or quiesced.\r
115 @retval EFI_SUCCESS Interrupt source was handled and quiesced.\r
e42e9404 116\r
117**/\r
118EFI_STATUS\r
119EFIAPI\r
120SmiManage (\r
121 IN CONST EFI_GUID *HandlerType,\r
122 IN CONST VOID *Context OPTIONAL,\r
123 IN OUT VOID *CommBuffer OPTIONAL,\r
124 IN OUT UINTN *CommBufferSize OPTIONAL\r
125 )\r
126{\r
127 LIST_ENTRY *Link;\r
128 LIST_ENTRY *Head;\r
129 SMI_ENTRY *SmiEntry;\r
130 SMI_HANDLER *SmiHandler;\r
131 BOOLEAN InterruptQuiesced;\r
132 EFI_STATUS Status;\r
133 \r
d5b339a9 134 Status = EFI_NOT_FOUND;\r
135 InterruptQuiesced = FALSE;\r
e42e9404 136 if (HandlerType == NULL) {\r
137 //\r
138 // Root SMI handler\r
139 //\r
e42e9404 140\r
141 Head = &mRootSmiHandlerList;\r
d5b339a9 142 } else {\r
e42e9404 143 //\r
d5b339a9 144 // Non-root SMI handler\r
e42e9404 145 //\r
d5b339a9 146 SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, FALSE);\r
147 if (SmiEntry == NULL) {\r
148 //\r
149 // There is no handler registered for this interrupt source\r
150 //\r
151 return Status;\r
152 }\r
153\r
154 Head = &SmiEntry->SmiHandlers;\r
e42e9404 155 }\r
156\r
e42e9404 157 for (Link = Head->ForwardLink; Link != Head; Link = Link->ForwardLink) {\r
158 SmiHandler = CR (Link, SMI_HANDLER, Link, SMI_HANDLER_SIGNATURE);\r
159\r
160 Status = SmiHandler->Handler (\r
161 (EFI_HANDLE) SmiHandler,\r
162 Context,\r
163 CommBuffer,\r
164 CommBufferSize\r
165 );\r
166\r
167 switch (Status) {\r
168 case EFI_INTERRUPT_PENDING:\r
169 //\r
d5b339a9 170 // If a handler returns EFI_INTERRUPT_PENDING then no additional handlers \r
171 // will be processed and EFI_INTERRUPT_PENDING will be returned.\r
e42e9404 172 //\r
173 return EFI_INTERRUPT_PENDING;\r
174\r
175 case EFI_SUCCESS:\r
176 //\r
d5b339a9 177 // If a handler returns EFI_SUCCESS then no additional handlers will be processed.\r
178 // then the function will return EFI_SUCCESS.\r
e42e9404 179 //\r
d5b339a9 180 return EFI_SUCCESS;\r
e42e9404 181\r
182 case EFI_WARN_INTERRUPT_SOURCE_QUIESCED:\r
183 //\r
d5b339a9 184 // If at least one of the handlers returns EFI_WARN_INTERRUPT_SOURCE_QUIESCED\r
185 // then the function will return EFI_SUCCESS. \r
e42e9404 186 //\r
187 InterruptQuiesced = TRUE;\r
188 break;\r
189\r
d5b339a9 190 case EFI_WARN_INTERRUPT_SOURCE_PENDING:\r
191 //\r
192 // If all the handlers returned EFI_WARN_INTERRUPT_SOURCE_PENDING\r
193 // then EFI_WARN_INTERRUPT_SOURCE_PENDING will be returned.\r
194 //\r
195 break;\r
196\r
e42e9404 197 default:\r
d5b339a9 198 //\r
199 // Unexpected status code returned.\r
200 //\r
201 ASSERT (FALSE);\r
e42e9404 202 break;\r
203 }\r
204 }\r
205\r
206 if (InterruptQuiesced) {\r
d5b339a9 207 Status = EFI_SUCCESS;\r
e42e9404 208 }\r
d5b339a9 209\r
e42e9404 210 return Status;\r
211}\r
212\r
213/**\r
214 Registers a handler to execute within SMM.\r
215\r
216 @param Handler Handler service funtion pointer.\r
217 @param HandlerType Points to the handler type or NULL for root SMI handlers.\r
218 @param DispatchHandle On return, contains a unique handle which can be used to later unregister the handler function.\r
219\r
220 @retval EFI_SUCCESS Handler register success.\r
221 @retval EFI_INVALID_PARAMETER Handler or DispatchHandle is NULL.\r
222\r
223**/\r
224EFI_STATUS\r
225EFIAPI\r
226SmiHandlerRegister (\r
227 IN EFI_SMM_HANDLER_ENTRY_POINT2 Handler,\r
228 IN CONST EFI_GUID *HandlerType OPTIONAL,\r
229 OUT EFI_HANDLE *DispatchHandle\r
230 )\r
231{\r
232 SMI_HANDLER *SmiHandler;\r
233 SMI_ENTRY *SmiEntry;\r
234 LIST_ENTRY *List;\r
235\r
236 if (Handler == NULL || DispatchHandle == NULL) {\r
237 return EFI_INVALID_PARAMETER;\r
238 }\r
239\r
240 SmiHandler = AllocateZeroPool (sizeof (SMI_HANDLER));\r
241 if (SmiHandler == NULL) {\r
242 return EFI_OUT_OF_RESOURCES;\r
243 }\r
244\r
245 SmiHandler->Signature = SMI_HANDLER_SIGNATURE;\r
246 SmiHandler->Handler = Handler;\r
247\r
248 if (HandlerType == NULL) {\r
249 //\r
250 // This is root SMI handler\r
251 //\r
252 SmiEntry = NULL;\r
253 List = &mRootSmiHandlerList;\r
254 } else {\r
255 //\r
256 // None root SMI handler\r
257 //\r
258 SmiEntry = SmmCoreFindSmiEntry ((EFI_GUID *) HandlerType, TRUE);\r
259 if (SmiEntry == NULL) {\r
260 return EFI_OUT_OF_RESOURCES;\r
261 }\r
262\r
263 List = &SmiEntry->SmiHandlers;\r
264 }\r
265\r
266 SmiHandler->SmiEntry = SmiEntry;\r
267 InsertTailList (List, &SmiHandler->Link);\r
268\r
269 *DispatchHandle = (EFI_HANDLE) SmiHandler;\r
270\r
271 return EFI_SUCCESS;\r
272}\r
273\r
274/**\r
275 Unregister a handler in SMM.\r
276\r
277 @param DispatchHandle The handle that was specified when the handler was registered.\r
278\r
279 @retval EFI_SUCCESS Handler function was successfully unregistered.\r
280 @retval EFI_INVALID_PARAMETER DispatchHandle does not refer to a valid handle.\r
281\r
282**/\r
283EFI_STATUS\r
284EFIAPI\r
285SmiHandlerUnRegister (\r
286 IN EFI_HANDLE DispatchHandle\r
287 )\r
288{\r
289 SMI_HANDLER *SmiHandler;\r
290 SMI_ENTRY *SmiEntry;\r
291\r
292 SmiHandler = (SMI_HANDLER *) DispatchHandle;\r
293\r
294 if (SmiHandler == NULL) {\r
295 return EFI_INVALID_PARAMETER;\r
296 }\r
297\r
298 if (SmiHandler->Signature != SMI_HANDLER_SIGNATURE) {\r
299 return EFI_INVALID_PARAMETER;\r
300 }\r
301\r
302 SmiEntry = SmiHandler->SmiEntry;\r
303\r
304 RemoveEntryList (&SmiHandler->Link);\r
305 FreePool (SmiHandler);\r
306\r
307 if (SmiEntry == NULL) {\r
308 //\r
309 // This is root SMI handler\r
310 //\r
311 return EFI_SUCCESS;\r
312 }\r
313\r
314 if (IsListEmpty (&SmiEntry->SmiHandlers)) {\r
315 //\r
316 // No handler registered for this interrupt now, remove the SMI_ENTRY\r
317 //\r
318 RemoveEntryList (&SmiEntry->AllEntries);\r
319\r
320 FreePool (SmiEntry);\r
321 }\r
322\r
323 return EFI_SUCCESS;\r
324}\r