]>
Commit | Line | Data |
---|---|---|
9e620719 | 1 | /** @file\r |
2 | SMM Base Helper SMM driver.\r | |
3 | \r | |
4 | This driver is the counterpart of the SMM Base On SMM Base2 Thunk driver. It\r | |
5 | provides helping services in SMM to the SMM Base On SMM Base2 Thunk driver.\r | |
6 | \r | |
d5bcf13e | 7 | Caution: This module requires additional review when modified.\r |
8 | This driver will have external input - communicate buffer in SMM mode.\r | |
9 | This external input must be validated carefully to avoid security issue like\r | |
10 | buffer overflow, integer overflow.\r | |
11 | \r | |
12 | SmmHandlerEntry() will receive untrusted input and do validation.\r | |
13 | \r | |
071586ee | 14 | Copyright (c) 2009 - 2015, Intel Corporation. All rights reserved.<BR>\r |
584d5652 | 15 | This program and the accompanying materials\r |
9e620719 | 16 | are licensed and made available under the terms and conditions of the BSD License\r |
17 | which accompanies this distribution. The full text of the license may be found at\r | |
18 | http://opensource.org/licenses/bsd-license.php\r | |
19 | \r | |
20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
22 | \r | |
23 | **/\r | |
24 | \r | |
a7932d9a | 25 | #include <PiSmm.h>\r |
26 | #include <Library/DebugLib.h>\r | |
27 | #include <Library/UefiBootServicesTableLib.h>\r | |
28 | #include <Library/SmmServicesTableLib.h>\r | |
29 | #include <Library/BaseLib.h>\r | |
30 | #include <Library/BaseMemoryLib.h>\r | |
31 | #include <Library/PeCoffLib.h>\r | |
32 | #include <Library/DevicePathLib.h>\r | |
33 | #include <Library/CacheMaintenanceLib.h>\r | |
27af6f9d | 34 | #include <Library/MemoryAllocationLib.h>\r |
ff443d3e | 35 | #include <Library/SynchronizationLib.h>\r |
36 | #include <Library/CpuLib.h>\r | |
dd62310a | 37 | #include <Library/SmmMemLib.h>\r |
a7932d9a | 38 | #include <Guid/SmmBaseThunkCommunication.h>\r |
39 | #include <Protocol/SmmBaseHelperReady.h>\r | |
40 | #include <Protocol/SmmCpu.h>\r | |
41 | #include <Protocol/LoadedImage.h>\r | |
42 | #include <Protocol/SmmCpuSaveState.h>\r | |
e906eae4 | 43 | #include <Protocol/MpService.h>\r |
673c1498 | 44 | #include <Protocol/LoadPe32Image.h>\r |
8edfbe02 | 45 | #include <Protocol/SmmReadyToLock.h>\r |
a7932d9a | 46 | \r |
09fc7dbb SZ |
47 | /**\r |
48 | Register SMM image to SMRAM profile.\r | |
49 | \r | |
50 | @param[in] FilePath File path of the image.\r | |
51 | @param[in] ImageBuffer Image base address.\r | |
52 | @param[in] NumberOfPage Number of page.\r | |
53 | \r | |
54 | @retval TRUE Register success.\r | |
55 | @retval FALSE Register fail.\r | |
56 | \r | |
57 | **/\r | |
58 | BOOLEAN\r | |
59 | RegisterSmramProfileImage (\r | |
60 | IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r | |
61 | IN PHYSICAL_ADDRESS ImageBuffer,\r | |
62 | IN UINTN NumberOfPage\r | |
63 | );\r | |
64 | \r | |
65 | /**\r | |
66 | Unregister SMM image from SMRAM profile.\r | |
67 | \r | |
68 | @param[in] FilePath File path of the image.\r | |
69 | @param[in] ImageBuffer Image base address.\r | |
70 | @param[in] NumberOfPage Number of page.\r | |
71 | \r | |
72 | @retval TRUE Unregister success.\r | |
73 | @retval FALSE Unregister fail.\r | |
74 | \r | |
75 | **/\r | |
76 | BOOLEAN\r | |
77 | UnregisterSmramProfileImage (\r | |
78 | IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r | |
79 | IN PHYSICAL_ADDRESS ImageBuffer,\r | |
80 | IN UINTN NumberOfPage\r | |
81 | );\r | |
82 | \r | |
a7932d9a | 83 | ///\r |
84 | /// Structure for tracking paired information of registered Framework SMI handler\r | |
85 | /// and correpsonding dispatch handle for SMI handler thunk.\r | |
86 | ///\r | |
87 | typedef struct {\r | |
88 | LIST_ENTRY Link;\r | |
89 | EFI_HANDLE DispatchHandle;\r | |
90 | EFI_HANDLE SmmImageHandle;\r | |
91 | EFI_SMM_CALLBACK_ENTRY_POINT CallbackAddress;\r | |
18e78927 | 92 | VOID *CommunicationBuffer;\r |
93 | UINTN *SourceSize;\r | |
a7932d9a | 94 | } CALLBACK_INFO;\r |
95 | \r | |
96 | typedef struct {\r | |
97 | ///\r | |
98 | /// PI SMM CPU Save State register index\r | |
99 | ///\r | |
100 | EFI_SMM_SAVE_STATE_REGISTER Register;\r | |
101 | ///\r | |
102 | /// Offset in Framework SMST\r | |
103 | ///\r | |
104 | UINTN Offset;\r | |
105 | } CPU_SAVE_STATE_CONVERSION;\r | |
106 | \r | |
107 | #define CPU_SAVE_STATE_GET_OFFSET(Field) (UINTN)(&(((EFI_SMM_CPU_SAVE_STATE *) 0)->Ia32SaveState.Field))\r | |
108 | \r | |
9e620719 | 109 | \r |
110 | EFI_HANDLE mDispatchHandle;\r | |
111 | EFI_SMM_CPU_PROTOCOL *mSmmCpu;\r | |
673c1498 | 112 | EFI_PE32_IMAGE_PROTOCOL *mLoadPe32Image;\r |
9e620719 | 113 | EFI_GUID mEfiSmmCpuIoGuid = EFI_SMM_CPU_IO_GUID;\r |
114 | EFI_SMM_BASE_HELPER_READY_PROTOCOL *mSmmBaseHelperReady;\r | |
115 | EFI_SMM_SYSTEM_TABLE *mFrameworkSmst;\r | |
e906eae4 | 116 | UINTN mNumberOfProcessors;\r |
8edfbe02 | 117 | BOOLEAN mLocked = FALSE;\r |
ff443d3e | 118 | BOOLEAN mPageTableHookEnabled;\r |
119 | BOOLEAN mHookInitialized;\r | |
120 | UINT64 *mCpuStatePageTable;\r | |
121 | SPIN_LOCK mPFLock;\r | |
122 | UINT64 mPhyMask;\r | |
123 | VOID *mOriginalHandler;\r | |
124 | EFI_SMM_CPU_SAVE_STATE *mShadowSaveState;\r | |
9e620719 | 125 | \r |
126 | LIST_ENTRY mCallbackInfoListHead = INITIALIZE_LIST_HEAD_VARIABLE (mCallbackInfoListHead);\r | |
127 | \r | |
128 | CPU_SAVE_STATE_CONVERSION mCpuSaveStateConvTable[] = {\r | |
129 | {EFI_SMM_SAVE_STATE_REGISTER_LDTBASE , CPU_SAVE_STATE_GET_OFFSET(LDTBase)},\r | |
130 | {EFI_SMM_SAVE_STATE_REGISTER_ES , CPU_SAVE_STATE_GET_OFFSET(ES)},\r | |
131 | {EFI_SMM_SAVE_STATE_REGISTER_CS , CPU_SAVE_STATE_GET_OFFSET(CS)},\r | |
132 | {EFI_SMM_SAVE_STATE_REGISTER_SS , CPU_SAVE_STATE_GET_OFFSET(SS)},\r | |
133 | {EFI_SMM_SAVE_STATE_REGISTER_DS , CPU_SAVE_STATE_GET_OFFSET(DS)},\r | |
134 | {EFI_SMM_SAVE_STATE_REGISTER_FS , CPU_SAVE_STATE_GET_OFFSET(FS)},\r | |
135 | {EFI_SMM_SAVE_STATE_REGISTER_GS , CPU_SAVE_STATE_GET_OFFSET(GS)},\r | |
136 | {EFI_SMM_SAVE_STATE_REGISTER_TR_SEL , CPU_SAVE_STATE_GET_OFFSET(TR)},\r | |
137 | {EFI_SMM_SAVE_STATE_REGISTER_DR7 , CPU_SAVE_STATE_GET_OFFSET(DR7)},\r | |
138 | {EFI_SMM_SAVE_STATE_REGISTER_DR6 , CPU_SAVE_STATE_GET_OFFSET(DR6)},\r | |
139 | {EFI_SMM_SAVE_STATE_REGISTER_RAX , CPU_SAVE_STATE_GET_OFFSET(EAX)},\r | |
140 | {EFI_SMM_SAVE_STATE_REGISTER_RBX , CPU_SAVE_STATE_GET_OFFSET(EBX)},\r | |
141 | {EFI_SMM_SAVE_STATE_REGISTER_RCX , CPU_SAVE_STATE_GET_OFFSET(ECX)},\r | |
142 | {EFI_SMM_SAVE_STATE_REGISTER_RDX , CPU_SAVE_STATE_GET_OFFSET(EDX)},\r | |
143 | {EFI_SMM_SAVE_STATE_REGISTER_RSP , CPU_SAVE_STATE_GET_OFFSET(ESP)},\r | |
144 | {EFI_SMM_SAVE_STATE_REGISTER_RBP , CPU_SAVE_STATE_GET_OFFSET(EBP)},\r | |
145 | {EFI_SMM_SAVE_STATE_REGISTER_RSI , CPU_SAVE_STATE_GET_OFFSET(ESI)},\r | |
146 | {EFI_SMM_SAVE_STATE_REGISTER_RDI , CPU_SAVE_STATE_GET_OFFSET(EDI)},\r | |
147 | {EFI_SMM_SAVE_STATE_REGISTER_RIP , CPU_SAVE_STATE_GET_OFFSET(EIP)},\r | |
148 | {EFI_SMM_SAVE_STATE_REGISTER_RFLAGS , CPU_SAVE_STATE_GET_OFFSET(EFLAGS)},\r | |
149 | {EFI_SMM_SAVE_STATE_REGISTER_CR0 , CPU_SAVE_STATE_GET_OFFSET(CR0)},\r | |
150 | {EFI_SMM_SAVE_STATE_REGISTER_CR3 , CPU_SAVE_STATE_GET_OFFSET(CR3)}\r | |
151 | };\r | |
152 | \r | |
e9ba23c7 LG |
153 | /**\r |
154 | Page fault handler.\r | |
155 | \r | |
156 | **/\r | |
ff443d3e | 157 | VOID\r |
158 | PageFaultHandlerHook (\r | |
159 | VOID\r | |
160 | );\r | |
161 | \r | |
097e25cb | 162 | /**\r |
163 | Read CpuSaveStates from PI for Framework use.\r | |
164 | \r | |
165 | The function reads PI style CpuSaveStates of CpuIndex-th CPU for Framework driver use. If\r | |
166 | ToRead is specified, the CpuSaveStates will be copied to ToRead, otherwise copied to\r | |
167 | mFrameworkSmst->CpuSaveState[CpuIndex].\r | |
168 | \r | |
169 | @param[in] CpuIndex The zero-based CPU index.\r | |
170 | @param[in, out] ToRead If not NULL, CpuSaveStates will be copied to it.\r | |
171 | \r | |
172 | **/\r | |
ff443d3e | 173 | VOID\r |
174 | ReadCpuSaveState (\r | |
097e25cb | 175 | IN UINTN CpuIndex,\r |
176 | IN OUT EFI_SMM_CPU_SAVE_STATE *ToRead\r | |
ff443d3e | 177 | )\r |
178 | {\r | |
179 | EFI_STATUS Status;\r | |
180 | UINTN Index;\r | |
181 | EFI_SMM_CPU_STATE *State;\r | |
182 | EFI_SMI_CPU_SAVE_STATE *SaveState;\r | |
183 | \r | |
184 | State = (EFI_SMM_CPU_STATE *)gSmst->CpuSaveState[CpuIndex];\r | |
185 | if (ToRead != NULL) {\r | |
186 | SaveState = &ToRead->Ia32SaveState;\r | |
187 | } else {\r | |
188 | SaveState = &mFrameworkSmst->CpuSaveState[CpuIndex].Ia32SaveState;\r | |
189 | }\r | |
190 | \r | |
2e7c8ac4 | 191 | //\r |
192 | // Note that SMBASE/SMMRevId/IORestart/AutoHALTRestart are in same location in IA32 and X64 CPU Save State Map.\r | |
193 | //\r | |
194 | SaveState->SMBASE = State->x86.SMBASE;\r | |
195 | SaveState->SMMRevId = State->x86.SMMRevId;\r | |
196 | SaveState->IORestart = State->x86.IORestart;\r | |
197 | SaveState->AutoHALTRestart = State->x86.AutoHALTRestart;\r | |
ff443d3e | 198 | \r |
199 | for (Index = 0; Index < sizeof (mCpuSaveStateConvTable) / sizeof (CPU_SAVE_STATE_CONVERSION); Index++) {\r | |
200 | ///\r | |
201 | /// Try to use SMM CPU Protocol to access CPU save states if possible\r | |
202 | ///\r | |
203 | Status = mSmmCpu->ReadSaveState (\r | |
204 | mSmmCpu,\r | |
205 | (UINTN)sizeof (UINT32),\r | |
206 | mCpuSaveStateConvTable[Index].Register,\r | |
207 | CpuIndex,\r | |
208 | ((UINT8 *)SaveState) + mCpuSaveStateConvTable[Index].Offset\r | |
209 | );\r | |
210 | ASSERT_EFI_ERROR (Status);\r | |
211 | }\r | |
212 | }\r | |
213 | \r | |
097e25cb | 214 | /**\r |
215 | Write CpuSaveStates from Framework into PI.\r | |
216 | \r | |
217 | The function writes back CpuSaveStates of CpuIndex-th CPU from PI to Framework. If\r | |
218 | ToWrite is specified, it contains the CpuSaveStates to write from, otherwise CpuSaveStates\r | |
219 | to write from mFrameworkSmst->CpuSaveState[CpuIndex].\r | |
220 | \r | |
221 | @param[in] CpuIndex The zero-based CPU index.\r | |
222 | @param[in] ToWrite If not NULL, CpuSaveStates to write from.\r | |
223 | \r | |
224 | **/\r | |
ff443d3e | 225 | VOID\r |
226 | WriteCpuSaveState (\r | |
097e25cb | 227 | IN UINTN CpuIndex,\r |
228 | IN EFI_SMM_CPU_SAVE_STATE *ToWrite\r | |
ff443d3e | 229 | )\r |
230 | {\r | |
2e7c8ac4 | 231 | EFI_STATUS Status;\r |
232 | UINTN Index;\r | |
233 | EFI_SMM_CPU_STATE *State;\r | |
ff443d3e | 234 | EFI_SMI_CPU_SAVE_STATE *SaveState;\r |
235 | \r | |
2e7c8ac4 | 236 | State = (EFI_SMM_CPU_STATE *)gSmst->CpuSaveState[CpuIndex];\r |
237 | \r | |
ff443d3e | 238 | if (ToWrite != NULL) {\r |
239 | SaveState = &ToWrite->Ia32SaveState;\r | |
240 | } else {\r | |
241 | SaveState = &mFrameworkSmst->CpuSaveState[CpuIndex].Ia32SaveState;\r | |
242 | }\r | |
2e7c8ac4 | 243 | \r |
244 | //\r | |
245 | // SMMRevId is read-only.\r | |
246 | // Note that SMBASE/IORestart/AutoHALTRestart are in same location in IA32 and X64 CPU Save State Map.\r | |
247 | //\r | |
248 | State->x86.SMBASE = SaveState->SMBASE;\r | |
249 | State->x86.IORestart = SaveState->IORestart;\r | |
250 | State->x86.AutoHALTRestart = SaveState->AutoHALTRestart;\r | |
ff443d3e | 251 | \r |
252 | for (Index = 0; Index < sizeof (mCpuSaveStateConvTable) / sizeof (CPU_SAVE_STATE_CONVERSION); Index++) {\r | |
253 | Status = mSmmCpu->WriteSaveState (\r | |
254 | mSmmCpu,\r | |
255 | (UINTN)sizeof (UINT32),\r | |
256 | mCpuSaveStateConvTable[Index].Register,\r | |
257 | CpuIndex,\r | |
258 | ((UINT8 *)SaveState) + \r | |
259 | mCpuSaveStateConvTable[Index].Offset\r | |
260 | );\r | |
261 | }\r | |
262 | }\r | |
263 | \r | |
097e25cb | 264 | /**\r |
265 | Read or write a page that contains CpuSaveStates. Read is from PI to Framework.\r | |
266 | Write is from Framework to PI.\r | |
267 | \r | |
268 | This function reads or writes a page that contains CpuSaveStates. The page contains Framework\r | |
269 | CpuSaveStates. On read, it reads PI style CpuSaveStates and fill the page up. On write, it\r | |
270 | writes back from the page content to PI CpuSaveStates struct.\r | |
271 | The first Framework CpuSaveStates (for CPU 0) is from mFrameworkSmst->CpuSaveState which is\r | |
272 | page aligned. Because Framework CpuSaveStates are continuous, we can know which CPUs' SaveStates\r | |
273 | are in the page start from PageAddress.\r | |
274 | \r | |
275 | @param[in] PageAddress The base address for a page.\r | |
276 | @param[in] IsRead TRUE for Read, FALSE for Write.\r | |
277 | \r | |
278 | **/\r | |
ff443d3e | 279 | VOID\r |
280 | ReadWriteCpuStatePage (\r | |
097e25cb | 281 | IN UINT64 PageAddress,\r |
282 | IN BOOLEAN IsRead\r | |
ff443d3e | 283 | )\r |
284 | {\r | |
285 | UINTN FirstSSIndex; // Index of first CpuSaveState in the page\r | |
286 | UINTN LastSSIndex; // Index of last CpuSaveState in the page\r | |
287 | BOOLEAN FirstSSAligned; // Whether first CpuSaveState is page-aligned\r | |
288 | BOOLEAN LastSSAligned; // Whether the end of last CpuSaveState is page-aligned\r | |
289 | UINTN ClippedSize;\r | |
290 | UINTN CpuIndex;\r | |
291 | \r | |
292 | FirstSSIndex = ((UINTN)PageAddress - (UINTN)mFrameworkSmst->CpuSaveState) / sizeof (EFI_SMM_CPU_SAVE_STATE);\r | |
293 | FirstSSAligned = TRUE;\r | |
294 | if (((UINTN)PageAddress - (UINTN)mFrameworkSmst->CpuSaveState) % sizeof (EFI_SMM_CPU_SAVE_STATE) != 0) {\r | |
295 | FirstSSIndex++;\r | |
296 | FirstSSAligned = FALSE;\r | |
297 | }\r | |
298 | LastSSIndex = ((UINTN)PageAddress + SIZE_4KB - (UINTN)mFrameworkSmst->CpuSaveState - 1) / sizeof (EFI_SMM_CPU_SAVE_STATE);\r | |
299 | LastSSAligned = TRUE;\r | |
300 | if (((UINTN)PageAddress + SIZE_4KB - (UINTN)mFrameworkSmst->CpuSaveState) % sizeof (EFI_SMM_CPU_SAVE_STATE) != 0) {\r | |
301 | LastSSIndex--;\r | |
302 | LastSSAligned = FALSE;\r | |
303 | }\r | |
304 | for (CpuIndex = FirstSSIndex; CpuIndex <= LastSSIndex && CpuIndex < mNumberOfProcessors; CpuIndex++) {\r | |
305 | if (IsRead) {\r | |
306 | ReadCpuSaveState (CpuIndex, NULL);\r | |
307 | } else {\r | |
308 | WriteCpuSaveState (CpuIndex, NULL);\r | |
309 | }\r | |
310 | }\r | |
311 | if (!FirstSSAligned) {\r | |
312 | ReadCpuSaveState (FirstSSIndex - 1, mShadowSaveState);\r | |
313 | ClippedSize = (UINTN)&mFrameworkSmst->CpuSaveState[FirstSSIndex] & (SIZE_4KB - 1);\r | |
314 | if (IsRead) {\r | |
315 | CopyMem ((VOID*)(UINTN)PageAddress, (VOID*)((UINTN)(mShadowSaveState + 1) - ClippedSize), ClippedSize);\r | |
316 | } else {\r | |
317 | CopyMem ((VOID*)((UINTN)(mShadowSaveState + 1) - ClippedSize), (VOID*)(UINTN)PageAddress, ClippedSize);\r | |
318 | WriteCpuSaveState (FirstSSIndex - 1, mShadowSaveState);\r | |
319 | }\r | |
320 | }\r | |
321 | if (!LastSSAligned && LastSSIndex + 1 < mNumberOfProcessors) {\r | |
322 | ReadCpuSaveState (LastSSIndex + 1, mShadowSaveState);\r | |
323 | ClippedSize = SIZE_4KB - ((UINTN)&mFrameworkSmst->CpuSaveState[LastSSIndex + 1] & (SIZE_4KB - 1));\r | |
324 | if (IsRead) {\r | |
325 | CopyMem (&mFrameworkSmst->CpuSaveState[LastSSIndex + 1], mShadowSaveState, ClippedSize);\r | |
326 | } else {\r | |
327 | CopyMem (mShadowSaveState, &mFrameworkSmst->CpuSaveState[LastSSIndex + 1], ClippedSize);\r | |
328 | WriteCpuSaveState (LastSSIndex + 1, mShadowSaveState);\r | |
329 | }\r | |
330 | }\r | |
331 | }\r | |
332 | \r | |
097e25cb | 333 | /**\r |
334 | The page fault handler that on-demand read PI CpuSaveStates for framework use. If the fault\r | |
335 | is not targeted to mFrameworkSmst->CpuSaveState range, the function will return FALSE to let\r | |
336 | PageFaultHandlerHook know it needs to pass the fault over to original page fault handler.\r | |
337 | \r | |
338 | @retval TRUE The page fault is correctly handled.\r | |
339 | @retval FALSE The page fault is not handled and is passed through to original handler.\r | |
340 | \r | |
341 | **/\r | |
ff443d3e | 342 | BOOLEAN\r |
343 | PageFaultHandler (\r | |
344 | VOID\r | |
345 | )\r | |
346 | {\r | |
347 | BOOLEAN IsHandled;\r | |
348 | UINT64 *PageTable;\r | |
349 | UINT64 PFAddress;\r | |
350 | UINTN NumCpuStatePages;\r | |
351 | \r | |
352 | ASSERT (mPageTableHookEnabled);\r | |
353 | AcquireSpinLock (&mPFLock);\r | |
354 | \r | |
355 | PageTable = (UINT64*)(UINTN)(AsmReadCr3 () & mPhyMask);\r | |
356 | PFAddress = AsmReadCr2 ();\r | |
357 | NumCpuStatePages = EFI_SIZE_TO_PAGES (mNumberOfProcessors * sizeof (EFI_SMM_CPU_SAVE_STATE));\r | |
358 | IsHandled = FALSE;\r | |
359 | if (((UINTN)mFrameworkSmst->CpuSaveState & ~(SIZE_2MB-1)) == (PFAddress & ~(SIZE_2MB-1))) {\r | |
360 | if ((UINTN)mFrameworkSmst->CpuSaveState <= PFAddress &&\r | |
361 | PFAddress < (UINTN)mFrameworkSmst->CpuSaveState + EFI_PAGES_TO_SIZE (NumCpuStatePages)\r | |
362 | ) {\r | |
363 | mCpuStatePageTable[BitFieldRead64 (PFAddress, 12, 20)] |= BIT0 | BIT1; // present and rw\r | |
364 | CpuFlushTlb ();\r | |
365 | ReadWriteCpuStatePage (PFAddress & ~(SIZE_4KB-1), TRUE);\r | |
366 | IsHandled = TRUE;\r | |
367 | } else {\r | |
368 | ASSERT (FALSE);\r | |
369 | }\r | |
370 | }\r | |
371 | \r | |
372 | ReleaseSpinLock (&mPFLock);\r | |
373 | return IsHandled;\r | |
374 | }\r | |
375 | \r | |
097e25cb | 376 | /**\r |
377 | Write back the dirty Framework CpuSaveStates to PI.\r | |
378 | \r | |
379 | The function scans the page table for dirty pages in mFrameworkSmst->CpuSaveState\r | |
380 | to write back to PI CpuSaveStates. It is meant to be called on each SmmBaseHelper SMI\r | |
381 | callback after Framework handler is called.\r | |
382 | \r | |
383 | **/\r | |
ff443d3e | 384 | VOID\r |
385 | WriteBackDirtyPages (\r | |
386 | VOID\r | |
387 | )\r | |
388 | {\r | |
389 | UINTN NumCpuStatePages;\r | |
390 | UINTN PTIndex;\r | |
391 | UINTN PTStartIndex;\r | |
392 | UINTN PTEndIndex;\r | |
393 | \r | |
394 | NumCpuStatePages = EFI_SIZE_TO_PAGES (mNumberOfProcessors * sizeof (EFI_SMM_CPU_SAVE_STATE));\r | |
9af300fc LG |
395 | PTStartIndex = (UINTN)BitFieldRead64 ((UINT64) (UINTN) mFrameworkSmst->CpuSaveState, 12, 20);\r |
396 | PTEndIndex = (UINTN)BitFieldRead64 ((UINT64) (UINTN) mFrameworkSmst->CpuSaveState + EFI_PAGES_TO_SIZE(NumCpuStatePages) - 1, 12, 20);\r | |
ff443d3e | 397 | for (PTIndex = PTStartIndex; PTIndex <= PTEndIndex; PTIndex++) {\r |
398 | if ((mCpuStatePageTable[PTIndex] & (BIT0|BIT6)) == (BIT0|BIT6)) { // present and dirty?\r | |
399 | ReadWriteCpuStatePage (mCpuStatePageTable[PTIndex] & mPhyMask, FALSE);\r | |
400 | }\r | |
401 | }\r | |
402 | }\r | |
403 | \r | |
097e25cb | 404 | /**\r |
405 | Hook IDT with our page fault handler so that the on-demand paging works on page fault.\r | |
406 | \r | |
407 | The function hooks the IDT with PageFaultHandlerHook to get on-demand paging work for\r | |
408 | PI<->Framework CpuSaveStates marshalling. It also saves original handler for pass-through\r | |
409 | purpose.\r | |
410 | \r | |
411 | **/\r | |
ff443d3e | 412 | VOID\r |
413 | HookPageFaultHandler (\r | |
414 | VOID\r | |
415 | )\r | |
416 | {\r | |
417 | IA32_DESCRIPTOR Idtr;\r | |
418 | IA32_IDT_GATE_DESCRIPTOR *IdtGateDesc;\r | |
419 | UINT32 OffsetUpper;\r | |
420 | \r | |
421 | InitializeSpinLock (&mPFLock);\r | |
422 | \r | |
423 | AsmReadIdtr (&Idtr);\r | |
424 | IdtGateDesc = (IA32_IDT_GATE_DESCRIPTOR *) Idtr.Base;\r | |
425 | OffsetUpper = *(UINT32*)((UINT64*)IdtGateDesc + 1);\r | |
426 | mOriginalHandler = (VOID *)(UINTN)(LShiftU64 (OffsetUpper, 32) + IdtGateDesc[14].Bits.OffsetLow + (IdtGateDesc[14].Bits.OffsetHigh << 16));\r | |
427 | IdtGateDesc[14].Bits.OffsetLow = (UINT32)((UINTN)PageFaultHandlerHook & ((1 << 16) - 1));\r | |
428 | IdtGateDesc[14].Bits.OffsetHigh = (UINT32)(((UINTN)PageFaultHandlerHook >> 16) & ((1 << 16) - 1));\r | |
429 | }\r | |
430 | \r | |
097e25cb | 431 | /**\r |
432 | Initialize page table for pages contain HookData.\r | |
433 | \r | |
434 | The function initialize PDE for 2MB range that contains HookData. If the related PDE points\r | |
435 | to a 2MB page, a page table will be allocated and initialized for 4KB pages. Otherwise we juse\r | |
436 | use the original page table.\r | |
437 | \r | |
438 | @param[in] HookData Based on which to initialize page table.\r | |
439 | \r | |
440 | @return The pointer to a Page Table that points to 4KB pages which contain HookData.\r | |
441 | **/\r | |
ff443d3e | 442 | UINT64 *\r |
443 | InitCpuStatePageTable (\r | |
097e25cb | 444 | IN VOID *HookData\r |
ff443d3e | 445 | )\r |
446 | {\r | |
447 | UINTN Index;\r | |
448 | UINT64 *PageTable;\r | |
e9ba23c7 | 449 | UINT64 *Pdpte;\r |
ff443d3e | 450 | UINT64 HookAddress;\r |
e9ba23c7 | 451 | UINT64 Pde;\r |
ff443d3e | 452 | UINT64 Address;\r |
453 | \r | |
454 | //\r | |
455 | // Initialize physical address mask\r | |
456 | // NOTE: Physical memory above virtual address limit is not supported !!!\r | |
457 | //\r | |
458 | AsmCpuid (0x80000008, (UINT32*)&Index, NULL, NULL, NULL);\r | |
459 | mPhyMask = LShiftU64 (1, (UINT8)Index) - 1;\r | |
460 | mPhyMask &= (1ull << 48) - EFI_PAGE_SIZE;\r | |
461 | \r | |
462 | HookAddress = (UINT64)(UINTN)HookData;\r | |
463 | PageTable = (UINT64 *)(UINTN)(AsmReadCr3 () & mPhyMask);\r | |
464 | PageTable = (UINT64 *)(UINTN)(PageTable[BitFieldRead64 (HookAddress, 39, 47)] & mPhyMask);\r | |
465 | PageTable = (UINT64 *)(UINTN)(PageTable[BitFieldRead64 (HookAddress, 30, 38)] & mPhyMask);\r | |
466 | \r | |
e9ba23c7 LG |
467 | Pdpte = (UINT64 *)(UINTN)PageTable;\r |
468 | Pde = Pdpte[BitFieldRead64 (HookAddress, 21, 29)];\r | |
469 | ASSERT ((Pde & BIT0) != 0); // Present and 2M Page\r | |
ff443d3e | 470 | \r |
e9ba23c7 LG |
471 | if ((Pde & BIT7) == 0) { // 4KB Page Directory\r |
472 | PageTable = (UINT64 *)(UINTN)(Pde & mPhyMask);\r | |
ff443d3e | 473 | } else {\r |
e9ba23c7 | 474 | ASSERT ((Pde & mPhyMask) == (HookAddress & ~(SIZE_2MB-1))); // 2MB Page Point to HookAddress\r |
ff443d3e | 475 | PageTable = AllocatePages (1);\r |
983ae8ce | 476 | ASSERT (PageTable != NULL);\r |
ff443d3e | 477 | Address = HookAddress & ~(SIZE_2MB-1);\r |
478 | for (Index = 0; Index < 512; Index++) {\r | |
479 | PageTable[Index] = Address | BIT0 | BIT1; // Present and RW\r | |
480 | Address += SIZE_4KB;\r | |
481 | }\r | |
e9ba23c7 | 482 | Pdpte[BitFieldRead64 (HookAddress, 21, 29)] = (UINT64)(UINTN)PageTable | BIT0 | BIT1; // Present and RW\r |
ff443d3e | 483 | }\r |
484 | return PageTable;\r | |
485 | }\r | |
486 | \r | |
097e25cb | 487 | /**\r |
488 | Mark all the CpuSaveStates as not present.\r | |
489 | \r | |
490 | The function marks all CpuSaveStates memory range as not present so that page fault can be triggered\r | |
491 | on CpuSaveStates access. It is meant to be called on each SmmBaseHelper SMI callback before Framework\r | |
492 | handler is called.\r | |
493 | \r | |
494 | @param[in] CpuSaveState The base of CpuSaveStates.\r | |
495 | \r | |
496 | **/\r | |
ff443d3e | 497 | VOID\r |
498 | HookCpuStateMemory (\r | |
097e25cb | 499 | IN EFI_SMM_CPU_SAVE_STATE *CpuSaveState\r |
ff443d3e | 500 | )\r |
501 | {\r | |
502 | UINT64 Index;\r | |
503 | UINT64 PTStartIndex;\r | |
504 | UINT64 PTEndIndex;\r | |
505 | \r | |
506 | PTStartIndex = BitFieldRead64 ((UINTN)CpuSaveState, 12, 20);\r | |
507 | PTEndIndex = BitFieldRead64 ((UINTN)CpuSaveState + mNumberOfProcessors * sizeof (EFI_SMM_CPU_SAVE_STATE) - 1, 12, 20);\r | |
508 | for (Index = PTStartIndex; Index <= PTEndIndex; Index++) {\r | |
509 | mCpuStatePageTable[Index] &= ~(BIT0|BIT5|BIT6); // not present nor accessed nor dirty\r | |
510 | }\r | |
511 | } \r | |
512 | \r | |
9e620719 | 513 | /**\r |
514 | Framework SMST SmmInstallConfigurationTable() Thunk.\r | |
515 | \r | |
516 | This thunk calls the PI SMM SmmInstallConfigurationTable() and then update the configuration\r | |
517 | table related fields in the Framework SMST because the PI SMM SmmInstallConfigurationTable()\r | |
518 | function may modify these fields.\r | |
519 | \r | |
520 | @param[in] SystemTable A pointer to the SMM System Table.\r | |
521 | @param[in] Guid A pointer to the GUID for the entry to add, update, or remove.\r | |
522 | @param[in] Table A pointer to the buffer of the table to add.\r | |
523 | @param[in] TableSize The size of the table to install.\r | |
524 | \r | |
525 | @retval EFI_SUCCESS The (Guid, Table) pair was added, updated, or removed.\r | |
526 | @retval EFI_INVALID_PARAMETER Guid is not valid.\r | |
527 | @retval EFI_NOT_FOUND An attempt was made to delete a non-existent entry.\r | |
528 | @retval EFI_OUT_OF_RESOURCES There is not enough memory available to complete the operation.\r | |
529 | **/\r | |
530 | EFI_STATUS\r | |
531 | EFIAPI\r | |
532 | SmmInstallConfigurationTable (\r | |
533 | IN EFI_SMM_SYSTEM_TABLE *SystemTable,\r | |
534 | IN EFI_GUID *Guid,\r | |
535 | IN VOID *Table,\r | |
536 | IN UINTN TableSize\r | |
537 | )\r | |
538 | {\r | |
539 | EFI_STATUS Status;\r | |
540 | \r | |
541 | Status = gSmst->SmmInstallConfigurationTable (gSmst, Guid, Table, TableSize);\r | |
542 | if (!EFI_ERROR (Status)) {\r | |
543 | mFrameworkSmst->NumberOfTableEntries = gSmst->NumberOfTableEntries;\r | |
544 | mFrameworkSmst->SmmConfigurationTable = gSmst->SmmConfigurationTable;\r | |
545 | }\r | |
546 | return Status; \r | |
547 | }\r | |
548 | \r | |
097e25cb | 549 | /**\r |
550 | Initialize all the stuff needed for on-demand paging hooks for PI<->Framework\r | |
551 | CpuSaveStates marshalling.\r | |
552 | \r | |
553 | @param[in] FrameworkSmst Framework SMM system table pointer.\r | |
554 | \r | |
555 | **/\r | |
ff443d3e | 556 | VOID\r |
557 | InitHook (\r | |
097e25cb | 558 | IN EFI_SMM_SYSTEM_TABLE *FrameworkSmst\r |
ff443d3e | 559 | )\r |
560 | {\r | |
561 | UINTN NumCpuStatePages;\r | |
562 | UINTN CpuStatePage;\r | |
563 | UINTN Bottom2MPage;\r | |
564 | UINTN Top2MPage;\r | |
565 | \r | |
566 | mPageTableHookEnabled = FALSE;\r | |
567 | NumCpuStatePages = EFI_SIZE_TO_PAGES (mNumberOfProcessors * sizeof (EFI_SMM_CPU_SAVE_STATE));\r | |
568 | //\r | |
569 | // Only hook page table for X64 image and less than 2MB needed to hold all CPU Save States\r | |
570 | //\r | |
571 | if (EFI_IMAGE_MACHINE_TYPE_SUPPORTED(EFI_IMAGE_MACHINE_X64) && NumCpuStatePages <= EFI_SIZE_TO_PAGES (SIZE_2MB)) {\r | |
572 | //\r | |
573 | // Allocate double page size to make sure all CPU Save States are in one 2MB page.\r | |
574 | //\r | |
575 | CpuStatePage = (UINTN)AllocatePages (NumCpuStatePages * 2);\r | |
576 | ASSERT (CpuStatePage != 0);\r | |
577 | Bottom2MPage = CpuStatePage & ~(SIZE_2MB-1);\r | |
578 | Top2MPage = (CpuStatePage + EFI_PAGES_TO_SIZE (NumCpuStatePages * 2) - 1) & ~(SIZE_2MB-1);\r | |
579 | if (Bottom2MPage == Top2MPage ||\r | |
580 | CpuStatePage + EFI_PAGES_TO_SIZE (NumCpuStatePages * 2) - Top2MPage >= EFI_PAGES_TO_SIZE (NumCpuStatePages)\r | |
581 | ) {\r | |
582 | //\r | |
583 | // If the allocated 4KB pages are within the same 2MB page or higher portion is larger, use higher portion pages.\r | |
584 | //\r | |
585 | FrameworkSmst->CpuSaveState = (EFI_SMM_CPU_SAVE_STATE *)(CpuStatePage + EFI_PAGES_TO_SIZE (NumCpuStatePages));\r | |
586 | FreePages ((VOID*)CpuStatePage, NumCpuStatePages);\r | |
587 | } else {\r | |
588 | FrameworkSmst->CpuSaveState = (EFI_SMM_CPU_SAVE_STATE *)CpuStatePage;\r | |
589 | FreePages ((VOID*)(CpuStatePage + EFI_PAGES_TO_SIZE (NumCpuStatePages)), NumCpuStatePages);\r | |
590 | }\r | |
591 | //\r | |
592 | // Add temporary working buffer for hooking\r | |
593 | //\r | |
594 | mShadowSaveState = (EFI_SMM_CPU_SAVE_STATE*) AllocatePool (sizeof (EFI_SMM_CPU_SAVE_STATE));\r | |
595 | ASSERT (mShadowSaveState != NULL);\r | |
596 | //\r | |
597 | // Allocate and initialize 4KB Page Table for hooking CpuSaveState.\r | |
598 | // Replace the original 2MB PDE with new 4KB page table.\r | |
599 | //\r | |
600 | mCpuStatePageTable = InitCpuStatePageTable (FrameworkSmst->CpuSaveState);\r | |
601 | //\r | |
602 | // Mark PTE for CpuSaveState as non-exist.\r | |
603 | //\r | |
604 | HookCpuStateMemory (FrameworkSmst->CpuSaveState);\r | |
605 | HookPageFaultHandler ();\r | |
606 | CpuFlushTlb ();\r | |
607 | mPageTableHookEnabled = TRUE;\r | |
608 | }\r | |
609 | mHookInitialized = TRUE;\r | |
610 | }\r | |
611 | \r | |
9e620719 | 612 | /**\r |
613 | Construct a Framework SMST based on the PI SMM SMST.\r | |
614 | \r | |
615 | @return Pointer to the constructed Framework SMST.\r | |
616 | **/\r | |
617 | EFI_SMM_SYSTEM_TABLE *\r | |
618 | ConstructFrameworkSmst (\r | |
619 | VOID\r | |
620 | )\r | |
621 | {\r | |
9e620719 | 622 | EFI_SMM_SYSTEM_TABLE *FrameworkSmst;\r |
623 | \r | |
27af6f9d | 624 | FrameworkSmst = (EFI_SMM_SYSTEM_TABLE *)AllocatePool (sizeof (EFI_SMM_SYSTEM_TABLE));\r |
625 | ASSERT (FrameworkSmst != NULL);\r | |
9e620719 | 626 | \r |
627 | ///\r | |
628 | /// Copy same things from PI SMST to Framework SMST\r | |
629 | ///\r | |
630 | CopyMem (FrameworkSmst, gSmst, (UINTN)(&((EFI_SMM_SYSTEM_TABLE *)0)->SmmIo));\r | |
631 | CopyMem (\r | |
632 | &FrameworkSmst->SmmIo, \r | |
633 | &gSmst->SmmIo,\r | |
634 | sizeof (EFI_SMM_SYSTEM_TABLE) - (UINTN)(&((EFI_SMM_SYSTEM_TABLE *)0)->SmmIo)\r | |
635 | );\r | |
636 | \r | |
637 | ///\r | |
638 | /// Update Framework SMST\r | |
639 | ///\r | |
640 | FrameworkSmst->Hdr.Revision = EFI_SMM_SYSTEM_TABLE_REVISION;\r | |
641 | CopyGuid (&FrameworkSmst->EfiSmmCpuIoGuid, &mEfiSmmCpuIoGuid);\r | |
642 | \r | |
ff443d3e | 643 | mHookInitialized = FALSE;\r |
e906eae4 | 644 | FrameworkSmst->CpuSaveState = (EFI_SMM_CPU_SAVE_STATE *)AllocateZeroPool (mNumberOfProcessors * sizeof (EFI_SMM_CPU_SAVE_STATE));\r |
27af6f9d | 645 | ASSERT (FrameworkSmst->CpuSaveState != NULL);\r |
9e620719 | 646 | \r |
647 | ///\r | |
648 | /// Do not support floating point state now\r | |
649 | ///\r | |
650 | FrameworkSmst->CpuOptionalFloatingPointState = NULL;\r | |
651 | \r | |
652 | FrameworkSmst->SmmInstallConfigurationTable = SmmInstallConfigurationTable;\r | |
653 | \r | |
654 | return FrameworkSmst;\r | |
655 | }\r | |
656 | \r | |
657 | /**\r | |
658 | Load a given Framework SMM driver into SMRAM and invoke its entry point.\r | |
659 | \r | |
673c1498 | 660 | @param[in] ParentImageHandle Parent Image Handle.\r |
9e620719 | 661 | @param[in] FilePath Location of the image to be installed as the handler.\r |
662 | @param[in] SourceBuffer Optional source buffer in case the image file\r | |
663 | is in memory.\r | |
664 | @param[in] SourceSize Size of the source image file, if in memory.\r | |
665 | @param[out] ImageHandle The handle that the base driver uses to decode \r | |
666 | the handler. Unique among SMM handlers only, \r | |
667 | not unique across DXE/EFI.\r | |
668 | \r | |
669 | @retval EFI_SUCCESS The operation was successful.\r | |
670 | @retval EFI_OUT_OF_RESOURCES There were no additional SMRAM resources to load the handler\r | |
671 | @retval EFI_UNSUPPORTED Can not find its copy in normal memory.\r | |
672 | @retval EFI_INVALID_PARAMETER The handlers was not the correct image type\r | |
673 | **/\r | |
674 | EFI_STATUS\r | |
675 | LoadImage (\r | |
673c1498 | 676 | IN EFI_HANDLE ParentImageHandle,\r |
9e620719 | 677 | IN EFI_DEVICE_PATH_PROTOCOL *FilePath,\r |
678 | IN VOID *SourceBuffer,\r | |
679 | IN UINTN SourceSize,\r | |
680 | OUT EFI_HANDLE *ImageHandle\r | |
681 | )\r | |
682 | {\r | |
673c1498 | 683 | EFI_STATUS Status;\r |
684 | UINTN PageCount;\r | |
685 | UINTN OrgPageCount;\r | |
686 | EFI_PHYSICAL_ADDRESS DstBuffer;\r | |
9e620719 | 687 | \r |
688 | if (FilePath == NULL || ImageHandle == NULL) { \r | |
689 | return EFI_INVALID_PARAMETER;\r | |
690 | }\r | |
691 | \r | |
673c1498 | 692 | PageCount = 1;\r |
693 | do {\r | |
694 | OrgPageCount = PageCount;\r | |
695 | DstBuffer = (UINTN)-1;\r | |
696 | Status = gSmst->SmmAllocatePages (\r | |
697 | AllocateMaxAddress,\r | |
698 | EfiRuntimeServicesCode,\r | |
699 | PageCount,\r | |
700 | &DstBuffer\r | |
9e620719 | 701 | );\r |
673c1498 | 702 | if (EFI_ERROR (Status)) {\r |
703 | return Status;\r | |
9e620719 | 704 | }\r |
705 | \r | |
673c1498 | 706 | Status = mLoadPe32Image->LoadPeImage (\r |
707 | mLoadPe32Image,\r | |
708 | ParentImageHandle,\r | |
709 | FilePath,\r | |
710 | SourceBuffer,\r | |
711 | SourceSize,\r | |
712 | DstBuffer,\r | |
713 | &PageCount,\r | |
714 | ImageHandle,\r | |
715 | NULL,\r | |
716 | EFI_LOAD_PE_IMAGE_ATTRIBUTE_NONE\r | |
717 | );\r | |
718 | if (EFI_ERROR (Status)) {\r | |
719 | FreePages ((VOID *)(UINTN)DstBuffer, OrgPageCount);\r | |
9e620719 | 720 | }\r |
673c1498 | 721 | } while (Status == EFI_BUFFER_TOO_SMALL);\r |
9e620719 | 722 | \r |
9e620719 | 723 | if (!EFI_ERROR (Status)) {\r |
673c1498 | 724 | ///\r |
725 | /// Update MP state in Framework SMST before transferring control to Framework SMM driver entry point\r | |
673c1498 | 726 | ///\r |
5b9fc2f0 | 727 | mFrameworkSmst->SmmStartupThisAp = gSmst->SmmStartupThisAp;\r |
728 | mFrameworkSmst->NumberOfCpus = mNumberOfProcessors;\r | |
673c1498 | 729 | mFrameworkSmst->CurrentlyExecutingCpu = gSmst->CurrentlyExecutingCpu;\r |
730 | \r | |
09fc7dbb | 731 | RegisterSmramProfileImage (FilePath, DstBuffer, PageCount);\r |
673c1498 | 732 | Status = gBS->StartImage (*ImageHandle, NULL, NULL);\r |
733 | if (EFI_ERROR (Status)) {\r | |
071586ee | 734 | UnregisterSmramProfileImage (FilePath, DstBuffer, PageCount);\r |
673c1498 | 735 | mLoadPe32Image->UnLoadPeImage (mLoadPe32Image, *ImageHandle);\r |
736 | *ImageHandle = NULL;\r | |
737 | FreePages ((VOID *)(UINTN)DstBuffer, PageCount);\r | |
738 | }\r | |
9e620719 | 739 | }\r |
740 | \r | |
673c1498 | 741 | return Status;\r |
9e620719 | 742 | }\r |
743 | \r | |
744 | /** \r | |
745 | Thunk service of EFI_SMM_BASE_PROTOCOL.Register().\r | |
746 | \r | |
17d2c9a3 | 747 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r |
748 | **/\r | |
9e620719 | 749 | VOID\r |
750 | Register (\r | |
751 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r | |
752 | )\r | |
753 | {\r | |
754 | EFI_STATUS Status;\r | |
755 | \r | |
8edfbe02 | 756 | if (mLocked || FunctionData->Args.Register.LegacyIA32Binary) {\r |
9e620719 | 757 | Status = EFI_UNSUPPORTED;\r |
758 | } else {\r | |
759 | Status = LoadImage (\r | |
673c1498 | 760 | FunctionData->SmmBaseImageHandle,\r |
9e620719 | 761 | FunctionData->Args.Register.FilePath,\r |
762 | FunctionData->Args.Register.SourceBuffer,\r | |
763 | FunctionData->Args.Register.SourceSize,\r | |
764 | FunctionData->Args.Register.ImageHandle\r | |
765 | );\r | |
766 | }\r | |
767 | FunctionData->Status = Status;\r | |
768 | }\r | |
769 | \r | |
770 | /** \r | |
771 | Thunk service of EFI_SMM_BASE_PROTOCOL.UnRegister().\r | |
772 | \r | |
17d2c9a3 | 773 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r |
774 | **/\r | |
9e620719 | 775 | VOID\r |
776 | UnRegister (\r | |
777 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r | |
778 | )\r | |
779 | {\r | |
780 | ///\r | |
781 | /// Unregister not supported now\r | |
782 | ///\r | |
783 | FunctionData->Status = EFI_UNSUPPORTED;\r | |
784 | }\r | |
785 | \r | |
786 | /**\r | |
787 | Search for Framework SMI handler information according to specific PI SMM dispatch handle.\r | |
788 | \r | |
789 | @param[in] DispatchHandle The unique handle assigned by SmiHandlerRegister(). \r | |
790 | \r | |
17d2c9a3 | 791 | @return Pointer to CALLBACK_INFO. If NULL, no callback info record is found.\r |
9e620719 | 792 | **/\r |
793 | CALLBACK_INFO *\r | |
794 | GetCallbackInfo (\r | |
795 | IN EFI_HANDLE DispatchHandle\r | |
796 | )\r | |
797 | {\r | |
798 | LIST_ENTRY *Node;\r | |
799 | \r | |
800 | Node = GetFirstNode (&mCallbackInfoListHead);\r | |
801 | while (!IsNull (&mCallbackInfoListHead, Node)) {\r | |
802 | if (((CALLBACK_INFO *)Node)->DispatchHandle == DispatchHandle) {\r | |
803 | return (CALLBACK_INFO *)Node;\r | |
804 | }\r | |
805 | Node = GetNextNode (&mCallbackInfoListHead, Node);\r | |
806 | }\r | |
807 | return NULL;\r | |
808 | }\r | |
809 | \r | |
810 | /**\r | |
811 | Callback thunk for Framework SMI handler.\r | |
812 | \r | |
813 | This thunk functions calls the Framework SMI handler and converts the return value\r | |
814 | defined from Framework SMI handlers to a correpsonding return value defined by PI SMM.\r | |
815 | \r | |
816 | @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r | |
817 | @param[in] Context Points to an optional handler context which was specified when the\r | |
818 | handler was registered.\r | |
26a76fbc | 819 | @param[in, out] CommBuffer A pointer to a collection of data in memory that will\r |
9e620719 | 820 | be conveyed from a non-SMM environment into an SMM environment.\r |
26a76fbc | 821 | @param[in, out] CommBufferSize The size of the CommBuffer.\r |
9e620719 | 822 | \r |
823 | @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers \r | |
824 | should still be called.\r | |
825 | @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should \r | |
826 | still be called.\r | |
827 | @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still \r | |
828 | be called.\r | |
829 | @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.\r | |
830 | **/\r | |
831 | EFI_STATUS\r | |
832 | EFIAPI\r | |
833 | CallbackThunk (\r | |
834 | IN EFI_HANDLE DispatchHandle,\r | |
835 | IN CONST VOID *Context OPTIONAL,\r | |
836 | IN OUT VOID *CommBuffer OPTIONAL,\r | |
837 | IN OUT UINTN *CommBufferSize OPTIONAL\r | |
838 | )\r | |
839 | {\r | |
840 | EFI_STATUS Status;\r | |
841 | CALLBACK_INFO *CallbackInfo;\r | |
9e620719 | 842 | UINTN CpuIndex;\r |
9e620719 | 843 | \r |
844 | ///\r | |
845 | /// Before transferring the control into the Framework SMI handler, update CPU Save States\r | |
846 | /// and MP states in the Framework SMST.\r | |
847 | ///\r | |
848 | \r | |
ff443d3e | 849 | if (!mHookInitialized) {\r |
850 | InitHook (mFrameworkSmst);\r | |
851 | }\r | |
852 | if (mPageTableHookEnabled) {\r | |
853 | HookCpuStateMemory (mFrameworkSmst->CpuSaveState);\r | |
854 | CpuFlushTlb ();\r | |
855 | } else {\r | |
856 | for (CpuIndex = 0; CpuIndex < mNumberOfProcessors; CpuIndex++) {\r | |
857 | ReadCpuSaveState (CpuIndex, NULL);\r | |
9e620719 | 858 | }\r |
859 | }\r | |
860 | \r | |
33f30f1e | 861 | mFrameworkSmst->SmmStartupThisAp = gSmst->SmmStartupThisAp;\r |
862 | mFrameworkSmst->NumberOfCpus = mNumberOfProcessors;\r | |
9e620719 | 863 | mFrameworkSmst->CurrentlyExecutingCpu = gSmst->CurrentlyExecutingCpu;\r |
864 | \r | |
865 | ///\r | |
866 | /// Search for Framework SMI handler information\r | |
867 | ///\r | |
868 | CallbackInfo = GetCallbackInfo (DispatchHandle);\r | |
869 | ASSERT (CallbackInfo != NULL);\r | |
870 | \r | |
871 | ///\r | |
872 | /// Thunk into original Framwork SMI handler\r | |
873 | ///\r | |
874 | Status = (CallbackInfo->CallbackAddress) (\r | |
875 | CallbackInfo->SmmImageHandle,\r | |
18e78927 | 876 | CallbackInfo->CommunicationBuffer,\r |
877 | CallbackInfo->SourceSize\r | |
9e620719 | 878 | );\r |
879 | ///\r | |
880 | /// Save CPU Save States in case any of them was modified\r | |
881 | ///\r | |
ff443d3e | 882 | if (mPageTableHookEnabled) {\r |
883 | WriteBackDirtyPages ();\r | |
884 | } else {\r | |
885 | for (CpuIndex = 0; CpuIndex < mNumberOfProcessors; CpuIndex++) {\r | |
886 | WriteCpuSaveState (CpuIndex, NULL);\r | |
9e620719 | 887 | }\r |
888 | }\r | |
889 | \r | |
890 | ///\r | |
891 | /// Conversion of returned status code\r | |
892 | ///\r | |
893 | switch (Status) {\r | |
894 | case EFI_HANDLER_SUCCESS:\r | |
895 | Status = EFI_WARN_INTERRUPT_SOURCE_QUIESCED;\r | |
896 | break;\r | |
897 | case EFI_HANDLER_CRITICAL_EXIT:\r | |
898 | case EFI_HANDLER_SOURCE_QUIESCED:\r | |
899 | Status = EFI_SUCCESS;\r | |
900 | break;\r | |
901 | case EFI_HANDLER_SOURCE_PENDING:\r | |
902 | Status = EFI_WARN_INTERRUPT_SOURCE_PENDING;\r | |
903 | break;\r | |
904 | }\r | |
905 | return Status;\r | |
906 | }\r | |
907 | \r | |
908 | /** \r | |
909 | Thunk service of EFI_SMM_BASE_PROTOCOL.RegisterCallback().\r | |
910 | \r | |
17d2c9a3 | 911 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r |
912 | **/\r | |
9e620719 | 913 | VOID\r |
914 | RegisterCallback (\r | |
27af6f9d | 915 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r |
9e620719 | 916 | )\r |
917 | {\r | |
9e620719 | 918 | CALLBACK_INFO *Buffer;\r |
919 | \r | |
8edfbe02 | 920 | if (mLocked) {\r |
921 | FunctionData->Status = EFI_UNSUPPORTED;\r | |
922 | return;\r | |
923 | }\r | |
924 | \r | |
9e620719 | 925 | ///\r |
926 | /// Note that MakeLast and FloatingPointSave options are not supported in PI SMM\r | |
927 | ///\r | |
928 | \r | |
929 | ///\r | |
930 | /// Allocate buffer for callback thunk information\r | |
931 | ///\r | |
18e78927 | 932 | Buffer = (CALLBACK_INFO *)AllocateZeroPool (sizeof (CALLBACK_INFO));\r |
27af6f9d | 933 | if (Buffer == NULL) {\r |
934 | FunctionData->Status = EFI_OUT_OF_RESOURCES;\r | |
935 | return;\r | |
9e620719 | 936 | }\r |
27af6f9d | 937 | \r |
938 | ///\r | |
939 | /// Fill SmmImageHandle and CallbackAddress into the thunk\r | |
940 | ///\r | |
941 | Buffer->SmmImageHandle = FunctionData->Args.RegisterCallback.SmmImageHandle;\r | |
942 | Buffer->CallbackAddress = FunctionData->Args.RegisterCallback.CallbackAddress;\r | |
943 | \r | |
944 | ///\r | |
945 | /// Register the thunk code as a root SMI handler\r | |
946 | ///\r | |
947 | FunctionData->Status = gSmst->SmiHandlerRegister (\r | |
948 | CallbackThunk,\r | |
949 | NULL,\r | |
950 | &Buffer->DispatchHandle\r | |
951 | );\r | |
952 | if (EFI_ERROR (FunctionData->Status)) {\r | |
953 | FreePool (Buffer);\r | |
954 | return;\r | |
955 | }\r | |
956 | \r | |
957 | ///\r | |
958 | /// Save this callback info\r | |
959 | ///\r | |
960 | InsertTailList (&mCallbackInfoListHead, &Buffer->Link);\r | |
9e620719 | 961 | }\r |
962 | \r | |
963 | \r | |
964 | /** \r | |
965 | Thunk service of EFI_SMM_BASE_PROTOCOL.SmmAllocatePool().\r | |
966 | \r | |
17d2c9a3 | 967 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r |
968 | **/\r | |
9e620719 | 969 | VOID\r |
970 | HelperAllocatePool (\r | |
971 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r | |
972 | )\r | |
973 | {\r | |
8edfbe02 | 974 | if (mLocked) {\r |
975 | FunctionData->Status = EFI_UNSUPPORTED;\r | |
976 | } else {\r | |
977 | FunctionData->Status = gSmst->SmmAllocatePool (\r | |
978 | FunctionData->Args.AllocatePool.PoolType,\r | |
979 | FunctionData->Args.AllocatePool.Size,\r | |
980 | FunctionData->Args.AllocatePool.Buffer\r | |
981 | );\r | |
982 | }\r | |
9e620719 | 983 | }\r |
984 | \r | |
985 | /** \r | |
986 | Thunk service of EFI_SMM_BASE_PROTOCOL.SmmFreePool().\r | |
987 | \r | |
17d2c9a3 | 988 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r |
989 | **/\r | |
9e620719 | 990 | VOID\r |
991 | HelperFreePool (\r | |
992 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r | |
993 | )\r | |
994 | {\r | |
8edfbe02 | 995 | if (mLocked) {\r |
996 | FunctionData->Status = EFI_UNSUPPORTED;\r | |
997 | } else {\r | |
998 | FreePool (FunctionData->Args.FreePool.Buffer);\r | |
999 | FunctionData->Status = EFI_SUCCESS;\r | |
1000 | }\r | |
9e620719 | 1001 | }\r |
1002 | \r | |
bade9bf5 | 1003 | /** \r |
1004 | Thunk service of EFI_SMM_BASE_PROTOCOL.Communicate().\r | |
1005 | \r | |
1006 | @param[in, out] FunctionData Pointer to SMMBASE_FUNCTION_DATA.\r | |
1007 | **/\r | |
1008 | VOID\r | |
1009 | HelperCommunicate (\r | |
1010 | IN OUT SMMBASE_FUNCTION_DATA *FunctionData\r | |
1011 | )\r | |
1012 | {\r | |
1013 | LIST_ENTRY *Node;\r | |
1014 | CALLBACK_INFO *CallbackInfo;\r | |
1015 | \r | |
1016 | if (FunctionData->Args.Communicate.CommunicationBuffer == NULL) {\r | |
1017 | FunctionData->Status = EFI_INVALID_PARAMETER;\r | |
1018 | return;\r | |
1019 | }\r | |
1020 | \r | |
1021 | Node = GetFirstNode (&mCallbackInfoListHead);\r | |
1022 | while (!IsNull (&mCallbackInfoListHead, Node)) {\r | |
1023 | CallbackInfo = (CALLBACK_INFO *)Node;\r | |
1024 | \r | |
1025 | if (FunctionData->Args.Communicate.ImageHandle == CallbackInfo->SmmImageHandle) {\r | |
18e78927 | 1026 | CallbackInfo->CommunicationBuffer = FunctionData->Args.Communicate.CommunicationBuffer;\r |
1027 | CallbackInfo->SourceSize = FunctionData->Args.Communicate.SourceSize;\r | |
1028 | \r | |
bade9bf5 | 1029 | ///\r |
1030 | /// The message was successfully posted.\r | |
1031 | ///\r | |
1032 | FunctionData->Status = EFI_SUCCESS;\r | |
1033 | return;\r | |
1034 | }\r | |
1035 | Node = GetNextNode (&mCallbackInfoListHead, Node);\r | |
1036 | }\r | |
1037 | \r | |
1038 | FunctionData->Status = EFI_INVALID_PARAMETER;\r | |
1039 | }\r | |
1040 | \r | |
9e620719 | 1041 | /**\r |
1042 | Communication service SMI Handler entry.\r | |
1043 | \r | |
1044 | This SMI handler provides services for the SMM Base Thunk driver.\r | |
1045 | \r | |
d5bcf13e | 1046 | Caution: This function may receive untrusted input during runtime.\r |
1047 | The communicate buffer is external input, so this function will do operations only if the communicate\r | |
1048 | buffer is outside of SMRAM so that returning the status code in the buffer won't overwrite anywhere in SMRAM.\r | |
1049 | \r | |
9e620719 | 1050 | @param[in] DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().\r |
26a76fbc | 1051 | @param[in] RegisterContext Points to an optional handler context which was specified when the\r |
9e620719 | 1052 | handler was registered.\r |
26a76fbc | 1053 | @param[in, out] CommBuffer A pointer to a collection of data in memory that will\r |
9e620719 | 1054 | be conveyed from a non-SMM environment into an SMM environment.\r |
26a76fbc | 1055 | @param[in, out] CommBufferSize The size of the CommBuffer.\r |
9e620719 | 1056 | \r |
1057 | @retval EFI_SUCCESS The interrupt was handled and quiesced. No other handlers \r | |
1058 | should still be called.\r | |
1059 | @retval EFI_WARN_INTERRUPT_SOURCE_QUIESCED The interrupt has been quiesced but other handlers should \r | |
1060 | still be called.\r | |
1061 | @retval EFI_WARN_INTERRUPT_SOURCE_PENDING The interrupt is still pending and other handlers should still \r | |
1062 | be called.\r | |
1063 | @retval EFI_INTERRUPT_PENDING The interrupt could not be quiesced.\r | |
1064 | **/\r | |
1065 | EFI_STATUS\r | |
1066 | EFIAPI\r | |
1067 | SmmHandlerEntry (\r | |
1068 | IN EFI_HANDLE DispatchHandle,\r | |
1069 | IN CONST VOID *RegisterContext,\r | |
1070 | IN OUT VOID *CommBuffer,\r | |
1071 | IN OUT UINTN *CommBufferSize\r | |
1072 | )\r | |
1073 | {\r | |
1074 | SMMBASE_FUNCTION_DATA *FunctionData;\r | |
1075 | \r | |
1076 | ASSERT (CommBuffer != NULL);\r | |
d5bcf13e | 1077 | ASSERT (CommBufferSize != NULL);\r |
1078 | \r | |
1079 | if (*CommBufferSize == sizeof (SMMBASE_FUNCTION_DATA) &&\r | |
dd62310a | 1080 | SmmIsBufferOutsideSmmValid ((EFI_PHYSICAL_ADDRESS)(UINTN)CommBuffer, (UINT64)*CommBufferSize)) {\r |
d5bcf13e | 1081 | FunctionData = (SMMBASE_FUNCTION_DATA *)CommBuffer;\r |
1082 | \r | |
1083 | switch (FunctionData->Function) {\r | |
1084 | case SmmBaseFunctionRegister:\r | |
1085 | Register (FunctionData);\r | |
1086 | break;\r | |
1087 | case SmmBaseFunctionUnregister:\r | |
1088 | UnRegister (FunctionData);\r | |
1089 | break;\r | |
1090 | case SmmBaseFunctionRegisterCallback:\r | |
1091 | RegisterCallback (FunctionData);\r | |
1092 | break;\r | |
1093 | case SmmBaseFunctionAllocatePool:\r | |
1094 | HelperAllocatePool (FunctionData);\r | |
1095 | break;\r | |
1096 | case SmmBaseFunctionFreePool:\r | |
1097 | HelperFreePool (FunctionData);\r | |
1098 | break;\r | |
1099 | case SmmBaseFunctionCommunicate:\r | |
1100 | HelperCommunicate (FunctionData);\r | |
1101 | break;\r | |
1102 | default:\r | |
1103 | DEBUG ((EFI_D_WARN, "SmmBaseHelper: invalid SMM Base function.\n"));\r | |
1104 | FunctionData->Status = EFI_UNSUPPORTED;\r | |
1105 | }\r | |
9e620719 | 1106 | }\r |
1107 | return EFI_SUCCESS;\r | |
1108 | }\r | |
1109 | \r | |
8edfbe02 | 1110 | /**\r |
1111 | Smm Ready To Lock event notification handler.\r | |
1112 | \r | |
1113 | It sets a flag indicating that SMRAM has been locked.\r | |
1114 | \r | |
1115 | @param[in] Protocol Points to the protocol's unique identifier.\r | |
1116 | @param[in] Interface Points to the interface instance.\r | |
1117 | @param[in] Handle The handle on which the interface was installed.\r | |
1118 | \r | |
1119 | @retval EFI_SUCCESS Notification handler runs successfully.\r | |
1120 | **/\r | |
1121 | EFI_STATUS\r | |
1122 | EFIAPI\r | |
1123 | SmmReadyToLockEventNotify (\r | |
1124 | IN CONST EFI_GUID *Protocol,\r | |
1125 | IN VOID *Interface,\r | |
1126 | IN EFI_HANDLE Handle\r | |
1127 | )\r | |
1128 | {\r | |
1129 | mLocked = TRUE;\r | |
1130 | return EFI_SUCCESS;\r | |
1131 | }\r | |
1132 | \r | |
9e620719 | 1133 | /**\r |
1134 | Entry point function of the SMM Base Helper SMM driver.\r | |
1135 | \r | |
1136 | @param[in] ImageHandle The firmware allocated handle for the EFI image. \r | |
1137 | @param[in] SystemTable A pointer to the EFI System Table.\r | |
1138 | \r | |
1139 | @retval EFI_SUCCESS The entry point is executed successfully.\r | |
1140 | @retval other Some error occurs when executing this entry point.\r | |
1141 | **/\r | |
1142 | EFI_STATUS\r | |
1143 | EFIAPI\r | |
1144 | SmmBaseHelperMain (\r | |
1145 | IN EFI_HANDLE ImageHandle,\r | |
1146 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1147 | )\r | |
1148 | {\r | |
1149 | EFI_STATUS Status;\r | |
e906eae4 | 1150 | EFI_MP_SERVICES_PROTOCOL *MpServices;\r |
26a76fbc | 1151 | EFI_HANDLE Handle;\r |
e906eae4 | 1152 | UINTN NumberOfEnabledProcessors;\r |
8edfbe02 | 1153 | VOID *Registration;\r |
26a76fbc LG |
1154 | \r |
1155 | Handle = NULL;\r | |
9e620719 | 1156 | ///\r |
17d2c9a3 | 1157 | /// Locate SMM CPU Protocol which is used later to retrieve/update CPU Save States\r |
9e620719 | 1158 | ///\r |
1159 | Status = gSmst->SmmLocateProtocol (&gEfiSmmCpuProtocolGuid, NULL, (VOID **) &mSmmCpu);\r | |
1160 | ASSERT_EFI_ERROR (Status);\r | |
1161 | \r | |
673c1498 | 1162 | ///\r |
1163 | /// Locate PE32 Image Protocol which is used later to load Framework SMM driver\r | |
1164 | ///\r | |
1165 | Status = SystemTable->BootServices->LocateProtocol (&gEfiLoadPeImageProtocolGuid, NULL, (VOID **) &mLoadPe32Image);\r | |
1166 | ASSERT_EFI_ERROR (Status);\r | |
1167 | \r | |
e906eae4 | 1168 | //\r |
1169 | // Get MP Services Protocol\r | |
1170 | //\r | |
1171 | Status = SystemTable->BootServices->LocateProtocol (&gEfiMpServiceProtocolGuid, NULL, (VOID **)&MpServices);\r | |
1172 | ASSERT_EFI_ERROR (Status);\r | |
1173 | \r | |
1174 | //\r | |
1175 | // Use MP Services Protocol to retrieve the number of processors and number of enabled processors\r | |
1176 | //\r | |
1177 | Status = MpServices->GetNumberOfProcessors (MpServices, &mNumberOfProcessors, &NumberOfEnabledProcessors);\r | |
1178 | ASSERT_EFI_ERROR (Status);\r | |
1179 | \r | |
9e620719 | 1180 | ///\r |
1181 | /// Interface structure of SMM BASE Helper Ready Protocol is allocated from UEFI pool\r | |
1182 | /// instead of SMM pool so that SMM Base Thunk driver can access it in Non-SMM mode.\r | |
1183 | ///\r | |
1184 | Status = gBS->AllocatePool (\r | |
1185 | EfiBootServicesData,\r | |
1186 | sizeof (EFI_SMM_BASE_HELPER_READY_PROTOCOL),\r | |
1187 | (VOID **)&mSmmBaseHelperReady\r | |
1188 | );\r | |
1189 | ASSERT_EFI_ERROR (Status);\r | |
1190 | \r | |
1191 | ///\r | |
1192 | /// Construct Framework SMST from PI SMST\r | |
1193 | ///\r | |
1194 | mFrameworkSmst = ConstructFrameworkSmst ();\r | |
1195 | mSmmBaseHelperReady->FrameworkSmst = mFrameworkSmst;\r | |
1196 | mSmmBaseHelperReady->ServiceEntry = SmmHandlerEntry;\r | |
1197 | \r | |
8edfbe02 | 1198 | //\r |
1199 | // Register SMM Ready To Lock Protocol notification\r | |
1200 | //\r | |
1201 | Status = gSmst->SmmRegisterProtocolNotify (\r | |
1202 | &gEfiSmmReadyToLockProtocolGuid,\r | |
1203 | SmmReadyToLockEventNotify,\r | |
1204 | &Registration\r | |
1205 | );\r | |
1206 | ASSERT_EFI_ERROR (Status);\r | |
1207 | \r | |
9e620719 | 1208 | ///\r |
1209 | /// Register SMM Base Helper services for SMM Base Thunk driver\r | |
1210 | ///\r | |
1211 | Status = gSmst->SmiHandlerRegister (SmmHandlerEntry, &gEfiSmmBaseThunkCommunicationGuid, &mDispatchHandle);\r | |
1212 | ASSERT_EFI_ERROR (Status);\r | |
1213 | \r | |
1214 | ///\r | |
1215 | /// Install EFI SMM Base Helper Protocol in the UEFI handle database\r | |
1216 | ///\r | |
1217 | Status = gBS->InstallProtocolInterface (\r | |
1218 | &Handle,\r | |
1219 | &gEfiSmmBaseHelperReadyProtocolGuid,\r | |
1220 | EFI_NATIVE_INTERFACE,\r | |
1221 | mSmmBaseHelperReady\r | |
1222 | );\r | |
1223 | ASSERT_EFI_ERROR (Status);\r | |
1224 | \r | |
1225 | return Status;\r | |
1226 | }\r | |
1227 | \r |