2 Common header file for MP Initialize Library.
4 Copyright (c) 2016, 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.
20 #include <Register/Cpuid.h>
21 #include <Register/Msr.h>
22 #include <Register/LocalApic.h>
23 #include <Register/Microcode.h>
25 #include <Library/MpInitLib.h>
26 #include <Library/BaseLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/MemoryAllocationLib.h>
29 #include <Library/DebugLib.h>
30 #include <Library/LocalApicLib.h>
31 #include <Library/CpuLib.h>
32 #include <Library/UefiCpuLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/SynchronizationLib.h>
35 #include <Library/MtrrLib.h>
36 #include <Library/HobLib.h>
39 // AP loop state when APs are in idle state
40 // It's value is the same with PcdCpuApLoopMode
49 // AP initialization state during APs wakeup
69 // CPU volatile registers around INIT-SIPI-SIPI
81 } CPU_VOLATILE_REGISTERS
;
88 volatile UINT32
*StartupApSignal
;
89 volatile UINTN ApFunction
;
90 volatile UINTN ApFunctionArgument
;
95 volatile CPU_STATE State
;
96 CPU_VOLATILE_REGISTERS VolatileRegisters
;
106 // Basic CPU information saved in Guided HOB.
107 // Because the contents will be shard between PEI and DXE,
108 // we need to make sure the each fields offset same in different
112 UINT32 InitialApicId
;
118 // AP reset code information including code address and size,
119 // this structure will be shared be C code and assembly code.
120 // It is natural aligned by design.
123 UINT8
*RendezvousFunnelAddress
;
124 UINTN ModeEntryOffset
;
125 UINTN RendezvousFunnelSize
;
126 UINT8
*RelocateApLoopFuncAddress
;
127 UINTN RelocateApLoopFuncSize
;
128 } MP_ASSEMBLY_ADDRESS_MAP
;
130 typedef struct _CPU_MP_DATA CPU_MP_DATA
;
135 // MP CPU exchange information for AP reset code
136 // This structure is required to be packed because fixed field offsets
137 // into this structure are used in assembly code in this module
144 IA32_DESCRIPTOR GdtrProfile
;
145 IA32_DESCRIPTOR IdtrProfile
;
148 UINTN NumApsExecuting
;
151 UINTN EnableExecuteDisable
;
153 CPU_MP_DATA
*CpuMpData
;
154 } MP_CPU_EXCHANGE_INFO
;
159 // CPU MP Data save in memory
161 struct _CPU_MP_DATA
{
166 // The above fields data will be passed from PEI to DXE
167 // Please make sure the fields offset same in the different
172 UINTN CpuApStackSize
;
173 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
176 UINTN BackupBufferSize
;
177 BOOLEAN EndOfPeiFlag
;
179 volatile UINT32 StartCount
;
180 volatile UINT32 FinishedCount
;
181 volatile UINT32 RunningCount
;
182 BOOLEAN SingleThread
;
183 EFI_AP_PROCEDURE Procedure
;
190 UINTN
**FailedCpuList
;
192 AP_INIT_STATE InitFlag
;
193 BOOLEAN X2ApicEnable
;
194 MTRR_SETTINGS MtrrTable
;
196 UINT8 ApTargetCState
;
197 UINT16 PmCodeSegment
;
198 CPU_AP_DATA
*CpuData
;
199 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
202 Assembly code to place AP into safe loop mode.
204 Place AP into targeted C-State if MONITOR is supported, otherwise
205 place AP into hlt state.
206 Place AP in protected mode if the current is long mode. Due to AP maybe
207 wakeup by some hardware event. It could avoid accessing page table that
208 may not available during booting to OS.
210 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
211 FALSE indicates MONITOR is not supported.
212 @param[in] ApTargetCState Target C-State value.
213 @param[in] PmCodeSegment Protected mode code segment value.
217 (EFIAPI
* ASM_RELOCATE_AP_LOOP
) (
218 IN BOOLEAN MwaitSupport
,
219 IN UINTN ApTargetCState
,
220 IN UINTN PmCodeSegment
224 Assembly code to get starting address and size of the rendezvous entry for APs.
225 Information for fixing a jump instruction in the code is also returned.
227 @param[out] AddressMap Output buffer for address map information.
232 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap