2 SMM Core Main Entry Point
4 Copyright (c) 2009 - 2012, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials are licensed and made available
6 under the terms and conditions of the BSD License which accompanies this
7 distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #include "PiSmmCore.h"
18 // Physical pointer to private structure shared between SMM IPL and the SMM Core
20 SMM_CORE_PRIVATE_DATA
*gSmmCorePrivate
;
23 // SMM Core global variable for SMM System Table. Only accessed as a physical structure in SMRAM.
25 EFI_SMM_SYSTEM_TABLE2 gSmmCoreSmst
= {
28 EFI_SMM_SYSTEM_TABLE2_REVISION
,
29 sizeof (gSmmCoreSmst
.Hdr
)
31 NULL
, // SmmFirmwareVendor
32 0, // SmmFirmwareRevision
33 SmmInstallConfigurationTable
,
36 (EFI_SMM_CPU_IO2
) SmmEfiNotAvailableYetArg5
, // SmmMemRead
37 (EFI_SMM_CPU_IO2
) SmmEfiNotAvailableYetArg5
// SmmMemWrite
40 (EFI_SMM_CPU_IO2
) SmmEfiNotAvailableYetArg5
, // SmmIoRead
41 (EFI_SMM_CPU_IO2
) SmmEfiNotAvailableYetArg5
// SmmIoWrite
48 NULL
, // SmmStartupThisAp
49 0, // CurrentlyExecutingCpu
51 NULL
, // CpuSaveStateSize
53 0, // NumberOfTableEntries
54 NULL
, // SmmConfigurationTable
55 SmmInstallProtocolInterface
,
56 SmmUninstallProtocolInterface
,
58 SmmRegisterProtocolNotify
,
67 // Flag to determine if the platform has performed a legacy boot.
68 // If this flag is TRUE, then the runtime code and runtime data associated with the
69 // SMM IPL are converted to free memory, so the SMM COre must guarantee that is
70 // does not touch of the code/data associated with the SMM IPL if this flag is TRUE.
72 BOOLEAN mInLegacyBoot
= FALSE
;
75 // Table of SMI Handlers that are registered by the SMM Core when it is initialized
77 SMM_CORE_SMI_HANDLERS mSmmCoreSmiHandlers
[] = {
78 { SmmDriverDispatchHandler
, &gEfiEventDxeDispatchGuid
, NULL
, TRUE
},
79 { SmmReadyToLockHandler
, &gEfiDxeSmmReadyToLockProtocolGuid
, NULL
, TRUE
},
80 { SmmLegacyBootHandler
, &gEfiEventLegacyBootGuid
, NULL
, FALSE
},
81 { SmmEndOfDxeHandler
, &gEfiEndOfDxeEventGroupGuid
, NULL
, FALSE
},
82 { NULL
, NULL
, NULL
, FALSE
}
86 Place holder function until all the SMM System Table Service are available.
88 Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.
96 @return EFI_NOT_AVAILABLE_YET
101 SmmEfiNotAvailableYetArg5 (
110 // This function should never be executed. If it does, then the architectural protocols
111 // have not been designed correctly.
113 return EFI_NOT_AVAILABLE_YET
;
117 Software SMI handler that is called when a Legacy Boot event is signalled. The SMM
118 Core uses this signal to know that a Legacy Boot has been performed and that
119 gSmmCorePrivate that is shared between the UEFI and SMM execution environments can
120 not be accessed from SMM anymore since that structure is considered free memory by
123 @param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
124 @param Context Points to an optional handler context which was specified when the handler was registered.
125 @param CommBuffer A pointer to a collection of data in memory that will
126 be conveyed from a non-SMM environment into an SMM environment.
127 @param CommBufferSize The size of the CommBuffer.
134 SmmLegacyBootHandler (
135 IN EFI_HANDLE DispatchHandle
,
136 IN CONST VOID
*Context
, OPTIONAL
137 IN OUT VOID
*CommBuffer
, OPTIONAL
138 IN OUT UINTN
*CommBufferSize OPTIONAL
141 mInLegacyBoot
= TRUE
;
146 Software SMI handler that is called when the DxeSmmReadyToLock protocol is added
147 or if gEfiEventReadyToBootGuid is signalled. This function unregisters the
148 Software SMIs that are nor required after SMRAM is locked and installs the
149 SMM Ready To Lock Protocol so SMM Drivers are informed that SMRAM is about
150 to be locked. It also verifies the the SMM CPU I/O 2 Protocol has been installed
151 and NULLs gBS and gST because they can not longer be used after SMRAM is locked.
153 @param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
154 @param Context Points to an optional handler context which was specified when the handler was registered.
155 @param CommBuffer A pointer to a collection of data in memory that will
156 be conveyed from a non-SMM environment into an SMM environment.
157 @param CommBufferSize The size of the CommBuffer.
164 SmmReadyToLockHandler (
165 IN EFI_HANDLE DispatchHandle
,
166 IN CONST VOID
*Context
, OPTIONAL
167 IN OUT VOID
*CommBuffer
, OPTIONAL
168 IN OUT UINTN
*CommBufferSize OPTIONAL
173 EFI_HANDLE SmmHandle
;
177 // Unregister SMI Handlers that are no required after the SMM driver dispatch is stopped
179 for (Index
= 0; mSmmCoreSmiHandlers
[Index
].HandlerType
!= NULL
; Index
++) {
180 if (mSmmCoreSmiHandlers
[Index
].UnRegister
) {
181 SmiHandlerUnRegister (mSmmCoreSmiHandlers
[Index
].DispatchHandle
);
186 // Install SMM Ready to lock protocol
189 Status
= SmmInstallProtocolInterface (
191 &gEfiSmmReadyToLockProtocolGuid
,
192 EFI_NATIVE_INTERFACE
,
197 // Make sure SMM CPU I/O 2 Procol has been installed into the handle database
199 Status
= SmmLocateProtocol (&gEfiSmmCpuIo2ProtocolGuid
, NULL
, &Interface
);
202 // Print a message on a debug build if the SMM CPU I/O 2 Protocol is not installed
205 if (EFI_ERROR (Status
)) {
206 DEBUG ((DEBUG_ERROR
, "\nSMM: SmmCpuIo Arch Protocol not present!!\n"));
211 // Assert if the CPU I/O 2 Protocol is not installed
213 ASSERT_EFI_ERROR (Status
);
216 // Display any drivers that were not dispatched because dependency expression
217 // evaluated to false if this is a debug build
220 SmmDisplayDiscoveredNotDispatched ();
224 // Not allowed to use gST or gBS after lock
233 Software SMI handler that is called when the EndOfDxe event is signalled.
234 This function installs the SMM EndOfDxe Protocol so SMM Drivers are informed that
235 platform code will invoke 3rd part code.
237 @param DispatchHandle The unique handle assigned to this handler by SmiHandlerRegister().
238 @param Context Points to an optional handler context which was specified when the handler was registered.
239 @param CommBuffer A pointer to a collection of data in memory that will
240 be conveyed from a non-SMM environment into an SMM environment.
241 @param CommBufferSize The size of the CommBuffer.
249 IN EFI_HANDLE DispatchHandle
,
250 IN CONST VOID
*Context
, OPTIONAL
251 IN OUT VOID
*CommBuffer
, OPTIONAL
252 IN OUT UINTN
*CommBufferSize OPTIONAL
256 EFI_HANDLE SmmHandle
;
258 DEBUG ((EFI_D_INFO
, "SmmEndOfDxeHandler\n"));
260 // Install SMM EndOfDxe protocol
263 Status
= SmmInstallProtocolInterface (
265 &gEfiSmmEndOfDxeProtocolGuid
,
266 EFI_NATIVE_INTERFACE
,
273 The main entry point to SMM Foundation.
275 Note: This function is only used by SMRAM invocation. It is never used by DXE invocation.
277 @param SmmEntryContext Processor information and functionality
278 needed by SMM Foundation.
284 IN CONST EFI_SMM_ENTRY_CONTEXT
*SmmEntryContext
288 EFI_SMM_COMMUNICATE_HEADER
*CommunicateHeader
;
289 BOOLEAN InLegacyBoot
;
291 PERF_START (NULL
, "SMM", NULL
, 0) ;
294 // Update SMST using the context
296 CopyMem (&gSmmCoreSmst
.SmmStartupThisAp
, SmmEntryContext
, sizeof (EFI_SMM_ENTRY_CONTEXT
));
299 // Call platform hook before Smm Dispatch
301 PlatformHookBeforeSmmDispatch ();
304 // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed
306 InLegacyBoot
= mInLegacyBoot
;
309 // Mark the InSmm flag as TRUE, it will be used by SmmBase2 protocol
311 gSmmCorePrivate
->InSmm
= TRUE
;
314 // Check to see if this is a Synchronous SMI sent through the SMM Communication
315 // Protocol or an Asynchronous SMI
317 if (gSmmCorePrivate
->CommunicationBuffer
!= NULL
) {
319 // Synchronous SMI for SMM Core or request from Communicate protocol
321 CommunicateHeader
= (EFI_SMM_COMMUNICATE_HEADER
*)gSmmCorePrivate
->CommunicationBuffer
;
322 gSmmCorePrivate
->BufferSize
-= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
324 &CommunicateHeader
->HeaderGuid
,
326 CommunicateHeader
->Data
,
327 &gSmmCorePrivate
->BufferSize
331 // Update CommunicationBuffer, BufferSize and ReturnStatus
332 // Communicate service finished, reset the pointer to CommBuffer to NULL
334 gSmmCorePrivate
->BufferSize
+= OFFSET_OF (EFI_SMM_COMMUNICATE_HEADER
, Data
);
335 gSmmCorePrivate
->CommunicationBuffer
= NULL
;
336 gSmmCorePrivate
->ReturnStatus
= (Status
== EFI_SUCCESS
) ? EFI_SUCCESS
: EFI_NOT_FOUND
;
341 // Process Asynchronous SMI sources
343 SmiManage (NULL
, NULL
, NULL
, NULL
);
346 // Call platform hook after Smm Dispatch
348 PlatformHookAfterSmmDispatch ();
351 // If a legacy boot has occured, then make sure gSmmCorePrivate is not accessed
355 // Clear the InSmm flag as we are going to leave SMM
357 gSmmCorePrivate
->InSmm
= FALSE
;
360 PERF_END (NULL
, "SMM", NULL
, 0) ;
364 The Entry Point for SMM Core
366 Install DXE Protocols and reload SMM Core into SMRAM and register SMM Core
367 EntryPoint on the SMI vector.
369 Note: This function is called for both DXE invocation and SMRAM invocation.
371 @param ImageHandle The firmware allocated handle for the EFI image.
372 @param SystemTable A pointer to the EFI System Table.
374 @retval EFI_SUCCESS The entry point is executed successfully.
375 @retval Other Some error occurred when executing this entry point.
381 IN EFI_HANDLE ImageHandle
,
382 IN EFI_SYSTEM_TABLE
*SystemTable
389 // Get SMM Core Private context passed in from SMM IPL in ImageHandle.
391 gSmmCorePrivate
= (SMM_CORE_PRIVATE_DATA
*)ImageHandle
;
394 // Fill in SMRAM physical address for the SMM Services Table and the SMM Entry Point.
396 gSmmCorePrivate
->Smst
= &gSmmCoreSmst
;
397 gSmmCorePrivate
->SmmEntryPoint
= SmmEntryPoint
;
400 // Initialize memory service using free SMRAM
402 SmmInitializeMemoryServices (gSmmCorePrivate
->SmramRangeCount
, gSmmCorePrivate
->SmramRanges
);
405 // Register all SMI Handlers required by the SMM Core
407 for (Index
= 0; mSmmCoreSmiHandlers
[Index
].HandlerType
!= NULL
; Index
++) {
408 Status
= SmiHandlerRegister (
409 mSmmCoreSmiHandlers
[Index
].Handler
,
410 mSmmCoreSmiHandlers
[Index
].HandlerType
,
411 &mSmmCoreSmiHandlers
[Index
].DispatchHandle
413 ASSERT_EFI_ERROR (Status
);