2 Definitions to install Multiple Processor PPI.
4 Copyright (c) 2015 - 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.
15 #ifndef _CPU_MP_PEI_H_
16 #define _CPU_MP_PEI_H_
20 #include <Ppi/MpServices.h>
21 #include <Ppi/SecPlatformInformation.h>
22 #include <Ppi/SecPlatformInformation2.h>
23 #include <Ppi/EndOfPeiPhase.h>
24 #include <Ppi/VectorHandoffInfo.h>
26 #include <Register/Cpuid.h>
27 #include <Register/LocalApic.h>
28 #include <Register/Msr.h>
30 #include <Library/BaseLib.h>
31 #include <Library/BaseMemoryLib.h>
32 #include <Library/DebugLib.h>
33 #include <Library/HobLib.h>
34 #include <Library/LocalApicLib.h>
35 #include <Library/MtrrLib.h>
36 #include <Library/PcdLib.h>
37 #include <Library/PeimEntryPoint.h>
38 #include <Library/PeiServicesLib.h>
39 #include <Library/ReportStatusCodeLib.h>
40 #include <Library/SynchronizationLib.h>
41 #include <Library/TimerLib.h>
42 #include <Library/UefiCpuLib.h>
43 #include <Library/CpuLib.h>
44 #include <Library/CpuExceptionHandlerLib.h>
46 #include "Microcode.h"
57 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
66 // AP reset code information
69 UINT8
*RendezvousFunnelAddress
;
70 UINTN ModeEntryOffset
;
71 UINTN RendezvousFunnelSize
;
72 } MP_ASSEMBLY_ADDRESS_MAP
;
75 // CPU exchange information for switch BSP
78 UINT8 State
; // offset 0
79 UINTN StackPointer
; // offset 4 / 8
80 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
81 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
82 } CPU_EXCHANGE_ROLE_INFO
;
84 typedef struct _PEI_CPU_MP_DATA PEI_CPU_MP_DATA
;
89 // MP CPU exchange information for AP reset code
90 // This structure is required to be packed because fixed field offsets
91 // into this structure are used in assembly code in this module
98 IA32_DESCRIPTOR GdtrProfile
;
99 IA32_DESCRIPTOR IdtrProfile
;
102 UINTN NumApsExecuting
;
106 PEI_CPU_MP_DATA
*PeiCpuMpData
;
107 } MP_CPU_EXCHANGE_INFO
;
121 } CPU_VOLATILE_REGISTERS
;
124 volatile UINT32
*StartupApSignal
;
126 EFI_HEALTH_FLAGS Health
;
129 CPU_VOLATILE_REGISTERS VolatileRegisters
;
133 // PEI CPU MP Data save in memory
135 struct _PEI_CPU_MP_DATA
{
140 UINTN CpuApStackSize
;
141 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
144 UINTN BackupBufferSize
;
146 UINTN ApFunctionArgument
;
147 volatile UINT32 FinishedCount
;
148 BOOLEAN EndOfPeiFlag
;
150 BOOLEAN X2ApicEnable
;
151 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
152 CPU_EXCHANGE_ROLE_INFO APInfo
;
153 MTRR_SETTINGS MtrrTable
;
155 UINT8 ApTargetCState
;
156 PEI_CPU_DATA
*CpuData
;
157 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
159 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
163 Assembly code to get starting address and size of the rendezvous entry for APs.
164 Information for fixing a jump instruction in the code is also returned.
166 @param AddressMap Output buffer for address map information.
171 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
175 Assembly code to load GDT table and update segment accordingly.
177 @param Gdtr Pointer to GDT descriptor
182 IN IA32_DESCRIPTOR
*Gdtr
186 Get available system memory below 1MB by specified size.
188 @param PeiCpuMpData Pointer to PEI CPU MP Data
191 BackupAndPrepareWakeupBuffer(
192 IN PEI_CPU_MP_DATA
*PeiCpuMpData
196 Restore wakeup buffer data.
198 @param PeiCpuMpData Pointer to PEI CPU MP Data
202 IN PEI_CPU_MP_DATA
*PeiCpuMpData
206 Notify function on End Of Pei PPI.
208 On S3 boot, this function will restore wakeup buffer data.
209 On normal boot, this function will flag wakeup buffer to be un-used type.
211 @param PeiServices The pointer to the PEI Services Table.
212 @param NotifyDescriptor Address of the notification descriptor data structure.
213 @param Ppi Address of the PPI that was installed.
215 @retval EFI_SUCCESS When everything is OK.
220 CpuMpEndOfPeiCallback (
221 IN EFI_PEI_SERVICES
**PeiServices
,
222 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
227 This function will be called by BSP to wakeup AP.
229 @param PeiCpuMpData Pointer to PEI CPU MP Data
230 @param Broadcast TRUE: Send broadcast IPI to all APs
231 FALSE: Send IPI to AP by ApicId
232 @param ProcessorNumber The handle number of specified processor
233 @param Procedure The function to be invoked by AP
234 @param ProcedureArgument The argument to be passed into AP function
238 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
239 IN BOOLEAN Broadcast
,
240 IN UINTN ProcessorNumber
,
241 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
242 IN VOID
*ProcedureArgument OPTIONAL
246 Get CPU MP Data pointer from the Guided HOB.
248 @return Pointer to Pointer to PEI CPU MP Data
256 Find the current Processor number by APIC ID.
258 @param PeiCpuMpData Pointer to PEI CPU MP Data
259 @param ProcessorNumber Return the pocessor number found
261 @retval EFI_SUCCESS ProcessorNumber is found and returned.
262 @retval EFI_NOT_FOUND ProcessorNumber is not found.
266 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
267 OUT UINTN
*ProcessorNumber
271 Collects BIST data from PPI.
273 This function collects BIST data from Sec Platform Information2 PPI
274 or SEC Platform Information PPI.
276 @param PeiServices Pointer to PEI Services Table
277 @param PeiCpuMpData Pointer to PEI CPU MP Data
281 CollectBistDataFromPpi (
282 IN CONST EFI_PEI_SERVICES
**PeiServices
,
283 IN PEI_CPU_MP_DATA
*PeiCpuMpData
287 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
289 @param PeiServices The pointer to the PEI Services Table.
290 @param StructureSize The pointer to the variable describing size of the input buffer.
291 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
293 @retval EFI_SUCCESS The data was successfully returned.
294 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
295 hold the record is returned in StructureSize.
300 SecPlatformInformation2 (
301 IN CONST EFI_PEI_SERVICES
**PeiServices
,
302 IN OUT UINT64
*StructureSize
,
303 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2
307 Detect whether specified processor can find matching microcode patch and load it.
309 @param PeiCpuMpData Pointer to PEI CPU MP Data
313 IN PEI_CPU_MP_DATA
*PeiCpuMpData