2 The Quark CPU specific programming for PiSmmCpuDxeSmm module.
4 Copyright (c) 2010 - 2015, Intel Corporation. All rights reserved.<BR>
5 This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this 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.
16 #include <Library/SmmCpuFeaturesLib.h>
17 #include <Register/SmramSaveStateMap.h>
18 #include <Library/QNCAccessLib.h>
20 #define EFI_MSR_SMRR_PHYS_MASK_VALID BIT11
21 #define EFI_MSR_SMRR_MASK 0xFFFFF000
24 Called during the very first SMI into System Management Mode to initialize
25 CPU features, including SMBASE, for the currently executing CPU. Since this
26 is the first SMI, the SMRAM Save State Map is at the default address of
27 SMM_DEFAULT_SMBASE + SMRAM_SAVE_STATE_MAP_OFFSET. The currently executing
28 CPU is specified by CpuIndex and CpuIndex can be used to access information
29 about the currently executing CPU in the ProcessorInfo array and the
30 HotPlugCpuData data structure.
32 @param[in] CpuIndex The index of the CPU to initialize. The value
33 must be between 0 and the NumberOfCpus field in
34 the System Management System Table (SMST).
35 @param[in] IsMonarch TRUE if the CpuIndex is the index of the CPU that
36 was elected as monarch during System Management
38 FALSE if the CpuIndex is not the index of the CPU
39 that was elected as monarch during System
40 Management Mode initialization.
41 @param[in] ProcessorInfo Pointer to an array of EFI_PROCESSOR_INFORMATION
42 structures. ProcessorInfo[CpuIndex] contains the
43 information for the currently executing CPU.
44 @param[in] CpuHotPlugData Pointer to the CPU_HOT_PLUG_DATA structure that
45 contains the ApidId and SmBase arrays.
49 SmmCpuFeaturesInitializeProcessor (
52 IN EFI_PROCESSOR_INFORMATION
*ProcessorInfo
,
53 IN CPU_HOT_PLUG_DATA
*CpuHotPlugData
56 SMRAM_SAVE_STATE_MAP
*CpuState
;
61 CpuState
= (SMRAM_SAVE_STATE_MAP
*)(UINTN
)(SMM_DEFAULT_SMBASE
+ SMRAM_SAVE_STATE_MAP_OFFSET
);
62 CpuState
->x86
.SMBASE
= CpuHotPlugData
->SmBase
[CpuIndex
];
65 // Use QNC to initialize SMRR on Quark
67 QNCPortWrite(QUARK_NC_HOST_BRIDGE_SB_PORT_ID
, QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSBASE
, CpuHotPlugData
->SmrrBase
);
68 QNCPortWrite(QUARK_NC_HOST_BRIDGE_SB_PORT_ID
, QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSMASK
, (~(CpuHotPlugData
->SmrrSize
- 1) & EFI_MSR_SMRR_MASK
) | EFI_MSR_SMRR_PHYS_MASK_VALID
);
72 This function updates the SMRAM save state on the currently executing CPU
73 to resume execution at a specific address after an RSM instruction. This
74 function must evaluate the SMRAM save state to determine the execution mode
75 the RSM instruction resumes and update the resume execution address with
76 either NewInstructionPointer32 or NewInstructionPoint. The auto HALT restart
77 flag in the SMRAM save state must always be cleared. This function returns
78 the value of the instruction pointer from the SMRAM save state that was
79 replaced. If this function returns 0, then the SMRAM save state was not
82 This function is called during the very first SMI on each CPU after
83 SmmCpuFeaturesInitializeProcessor() to set a flag in normal execution mode
84 to signal that the SMBASE of each CPU has been updated before the default
85 SMBASE address is used for the first SMI to the next CPU.
87 @param[in] CpuIndex The index of the CPU to hook. The value
88 must be between 0 and the NumberOfCpus
89 field in the System Management System Table
91 @param[in] CpuState Pointer to SMRAM Save State Map for the
92 currently executing CPU.
93 @param[in] NewInstructionPointer32 Instruction pointer to use if resuming to
94 32-bit execution mode from 64-bit SMM.
95 @param[in] NewInstructionPointer Instruction pointer to use if resuming to
96 same execution mode as SMM.
98 @retval 0 This function did modify the SMRAM save state.
99 @retval > 0 The original instruction pointer value from the SMRAM save state
100 before it was replaced.
104 SmmCpuFeaturesHookReturnFromSmm (
106 IN SMRAM_SAVE_STATE_MAP
*CpuState
,
107 IN UINT64 NewInstructionPointer32
,
108 IN UINT64 NewInstructionPointer
115 Hook point in normal execution mode that allows the one CPU that was elected
116 as monarch during System Management Mode initialization to perform additional
117 initialization actions immediately after all of the CPUs have processed their
118 first SMI and called SmmCpuFeaturesInitializeProcessor() relocating SMBASE
119 into a buffer in SMRAM and called SmmCpuFeaturesHookReturnFromSmm().
123 SmmCpuFeaturesSmmRelocationComplete (
130 Return the size, in bytes, of a custom SMI Handler in bytes. If 0 is
131 returned, then a custom SMI handler is not provided by this library,
132 and the default SMI handler must be used.
134 @retval 0 Use the default SMI handler.
135 @retval > 0 Use the SMI handler installed by SmmCpuFeaturesInstallSmiHandler()
136 The caller is required to allocate enough SMRAM for each CPU to
137 support the size of the custom SMI handler.
141 SmmCpuFeaturesGetSmiHandlerSize (
149 Install a custom SMI handler for the CPU specified by CpuIndex. This function
150 is only called if SmmCpuFeaturesGetSmiHandlerSize() returns a size is greater
151 than zero and is called by the CPU that was elected as monarch during System
152 Management Mode initialization.
154 @param[in] CpuIndex The index of the CPU to install the custom SMI handler.
155 The value must be between 0 and the NumberOfCpus field
156 in the System Management System Table (SMST).
157 @param[in] SmBase The SMBASE address for the CPU specified by CpuIndex.
158 @param[in] SmiStack The stack to use when an SMI is processed by the
159 the CPU specified by CpuIndex.
160 @param[in] StackSize The size, in bytes, if the stack used when an SMI is
161 processed by the CPU specified by CpuIndex.
162 @param[in] GdtBase The base address of the GDT to use when an SMI is
163 processed by the CPU specified by CpuIndex.
164 @param[in] GdtSize The size, in bytes, of the GDT used when an SMI is
165 processed by the CPU specified by CpuIndex.
166 @param[in] IdtBase The base address of the IDT to use when an SMI is
167 processed by the CPU specified by CpuIndex.
168 @param[in] IdtSize The size, in bytes, of the IDT used when an SMI is
169 processed by the CPU specified by CpuIndex.
170 @param[in] Cr3 The base address of the page tables to use when an SMI
171 is processed by the CPU specified by CpuIndex.
175 SmmCpuFeaturesInstallSmiHandler (
190 Determines if MTRR registers must be configured to set SMRAM cache-ability
191 when executing in System Management Mode.
193 @retval TRUE MTRR registers must be configured to set SMRAM cache-ability.
194 @retval FALSE MTRR registers do not need to be configured to set SMRAM
199 SmmCpuFeaturesNeedConfigureMtrrs (
207 Disable SMRR register if SMRR is supported and SmmCpuFeaturesNeedConfigureMtrrs()
212 SmmCpuFeaturesDisableSmrr (
217 // Use QNC to disable SMRR on Quark
220 QUARK_NC_HOST_BRIDGE_SB_PORT_ID
,
221 QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSMASK
,
222 QNCPortRead(QUARK_NC_HOST_BRIDGE_SB_PORT_ID
, QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSMASK
) & ~EFI_MSR_SMRR_PHYS_MASK_VALID
227 Enable SMRR register if SMRR is supported and SmmCpuFeaturesNeedConfigureMtrrs()
232 SmmCpuFeaturesReenableSmrr (
237 // Use QNC to enable SMRR on Quark
240 QUARK_NC_HOST_BRIDGE_SB_PORT_ID
,
241 QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSMASK
,
242 QNCPortRead(QUARK_NC_HOST_BRIDGE_SB_PORT_ID
, QUARK_NC_HOST_BRIDGE_IA32_MTRR_SMRR_PHYSMASK
) | EFI_MSR_SMRR_PHYS_MASK_VALID
247 Processor specific hook point each time a CPU enters System Management Mode.
249 @param[in] CpuIndex The index of the CPU that has entered SMM. The value
250 must be between 0 and the NumberOfCpus field in the
251 System Management System Table (SMST).
255 SmmCpuFeaturesRendezvousEntry (
262 Processor specific hook point each time a CPU exits System Management Mode.
264 @param[in] CpuIndex The index of the CPU that is exiting SMM. The value must
265 be between 0 and the NumberOfCpus field in the System
266 Management System Table (SMST).
270 SmmCpuFeaturesRendezvousExit (
277 Check to see if an SMM register is supported by a specified CPU.
279 @param[in] CpuIndex The index of the CPU to check for SMM register support.
280 The value must be between 0 and the NumberOfCpus field
281 in the System Management System Table (SMST).
282 @param[in] RegName Identifies the SMM register to check for support.
284 @retval TRUE The SMM register specified by RegName is supported by the CPU
285 specified by CpuIndex.
286 @retval FALSE The SMM register specified by RegName is not supported by the
287 CPU specified by CpuIndex.
291 SmmCpuFeaturesIsSmmRegisterSupported (
293 IN SMM_REG_NAME RegName
300 Returns the current value of the SMM register for the specified CPU.
301 If the SMM register is not supported, then 0 is returned.
303 @param[in] CpuIndex The index of the CPU to read the SMM register. The
304 value must be between 0 and the NumberOfCpus field in
305 the System Management System Table (SMST).
306 @param[in] RegName Identifies the SMM register to read.
308 @return The value of the SMM register specified by RegName from the CPU
309 specified by CpuIndex.
313 SmmCpuFeaturesGetSmmRegister (
315 IN SMM_REG_NAME RegName
322 Sets the value of an SMM register on a specified CPU.
323 If the SMM register is not supported, then no action is performed.
325 @param[in] CpuIndex The index of the CPU to write the SMM register. The
326 value must be between 0 and the NumberOfCpus field in
327 the System Management System Table (SMST).
328 @param[in] RegName Identifies the SMM register to write.
329 registers are read-only.
330 @param[in] Value The value to write to the SMM register.
334 SmmCpuFeaturesSetSmmRegister (
336 IN SMM_REG_NAME RegName
,
343 Read an SMM Save State register on the target processor. If this function
344 returns EFI_UNSUPPORTED, then the caller is responsible for reading the
345 SMM Save Sate register.
347 @param[in] CpuIndex The index of the CPU to read the SMM Save State. The
348 value must be between 0 and the NumberOfCpus field in
349 the System Management System Table (SMST).
350 @param[in] Register The SMM Save State register to read.
351 @param[in] Width The number of bytes to read from the CPU save state.
352 @param[out] Buffer Upon return, this holds the CPU register value read
355 @retval EFI_SUCCESS The register was read from Save State.
356 @retval EFI_INVALID_PARAMTER Buffer is NULL.
357 @retval EFI_UNSUPPORTED This function does not support reading Register.
362 SmmCpuFeaturesReadSaveStateRegister (
364 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
369 return EFI_UNSUPPORTED
;
373 Writes an SMM Save State register on the target processor. If this function
374 returns EFI_UNSUPPORTED, then the caller is responsible for writing the
375 SMM Save Sate register.
377 @param[in] CpuIndex The index of the CPU to write the SMM Save State. The
378 value must be between 0 and the NumberOfCpus field in
379 the System Management System Table (SMST).
380 @param[in] Register The SMM Save State register to write.
381 @param[in] Width The number of bytes to write to the CPU save state.
382 @param[in] Buffer Upon entry, this holds the new CPU register value.
384 @retval EFI_SUCCESS The register was written to Save State.
385 @retval EFI_INVALID_PARAMTER Buffer is NULL.
386 @retval EFI_UNSUPPORTED This function does not support writing Register.
390 SmmCpuFeaturesWriteSaveStateRegister (
392 IN EFI_SMM_SAVE_STATE_REGISTER Register
,
394 IN CONST VOID
*Buffer
397 return EFI_UNSUPPORTED
;
401 This function is hook point called after the gEfiSmmReadyToLockProtocolGuid
402 notification is completely processed.
406 SmmCpuFeaturesCompleteSmmReadyToLock (
413 This API provides a method for a CPU to allocate a specific region for storing page tables.
415 This API can be called more once to allocate memory for page tables.
417 Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
418 allocated buffer. The buffer returned is aligned on a 4KB boundary. If Pages is 0, then NULL
419 is returned. If there is not enough memory remaining to satisfy the request, then NULL is
422 This function can also return NULL if there is no preference on where the page tables are allocated in SMRAM.
424 @param Pages The number of 4 KB pages to allocate.
426 @return A pointer to the allocated buffer for page tables.
427 @retval NULL Fail to allocate a specific region for storing page tables,
428 Or there is no preference on where the page tables are allocated in SMRAM.
433 SmmCpuFeaturesAllocatePageTableMemory (