2 Definitions to install Multiple Processor PPI.
4 Copyright (c) 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.
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>
25 #include <Register/Cpuid.h>
26 #include <Register/LocalApic.h>
28 #include <Library/BaseLib.h>
29 #include <Library/BaseMemoryLib.h>
30 #include <Library/DebugLib.h>
31 #include <Library/HobLib.h>
32 #include <Library/LocalApicLib.h>
33 #include <Library/MtrrLib.h>
34 #include <Library/PcdLib.h>
35 #include <Library/PeimEntryPoint.h>
36 #include <Library/PeiServicesLib.h>
37 #include <Library/ReportStatusCodeLib.h>
38 #include <Library/SynchronizationLib.h>
39 #include <Library/TimerLib.h>
40 #include <Library/UefiCpuLib.h>
42 #include "Microcode.h"
54 // AP reset code information
57 UINT8
*RendezvousFunnelAddress
;
58 UINTN PModeEntryOffset
;
59 UINTN LModeEntryOffset
;
60 UINTN RendezvousFunnelSize
;
61 } MP_ASSEMBLY_ADDRESS_MAP
;
64 // CPU exchange information for switch BSP
67 UINT8 State
; // offset 0
68 UINTN StackPointer
; // offset 4 / 8
69 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
70 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
71 } CPU_EXCHANGE_ROLE_INFO
;
73 typedef struct _PEI_CPU_MP_DATA PEI_CPU_MP_DATA
;
89 UINT32 DefaultSize
: 1;
90 UINT32 Granularity
: 1;
97 // MP CPU exchange information for AP reset code
104 IA32_DESCRIPTOR GdtrProfile
;
105 IA32_DESCRIPTOR IdtrProfile
;
108 UINTN NumApsExecuting
;
111 PEI_CPU_MP_DATA
*PeiCpuMpData
;
112 } MP_CPU_EXCHANGE_INFO
;
126 } CPU_VOLATILE_REGISTERS
;
130 EFI_HEALTH_FLAGS Health
;
133 CPU_VOLATILE_REGISTERS VolatileRegisters
;
137 // PEI CPU MP Data save in memory
139 struct _PEI_CPU_MP_DATA
{
144 UINTN CpuApStackSize
;
145 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
148 UINTN BackupBufferSize
;
150 UINTN ApFunctionArgument
;
151 volatile UINT32 FinishedCount
;
152 BOOLEAN EndOfPeiFlag
;
154 BOOLEAN X2ApicEnable
;
155 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
156 CPU_EXCHANGE_ROLE_INFO APInfo
;
157 MTRR_SETTINGS MtrrTable
;
158 PEI_CPU_DATA
*CpuData
;
159 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
161 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
165 Assembly code to get starting address and size of the rendezvous entry for APs.
166 Information for fixing a jump instruction in the code is also returned.
168 @param AddressMap Output buffer for address map information.
173 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
177 Assembly code to load GDT table and update segment accordingly.
179 @param Gdtr Pointer to GDT descriptor
184 IN IA32_DESCRIPTOR
*Gdtr
188 Assembly code to do CLI-HALT loop.
198 Get available system memory below 1MB by specified size.
200 @param PeiCpuMpData Pointer to PEI CPU MP Data
203 BackupAndPrepareWakeupBuffer(
204 IN PEI_CPU_MP_DATA
*PeiCpuMpData
208 Restore wakeup buffer data.
210 @param PeiCpuMpData Pointer to PEI CPU MP Data
214 IN PEI_CPU_MP_DATA
*PeiCpuMpData
218 Notify function on End Of Pei PPI.
220 On S3 boot, this function will restore wakeup buffer data.
221 On normal boot, this function will flag wakeup buffer to be un-used type.
223 @param PeiServices The pointer to the PEI Services Table.
224 @param NotifyDescriptor Address of the notification descriptor data structure.
225 @param Ppi Address of the PPI that was installed.
227 @retval EFI_SUCCESS When everything is OK.
232 CpuMpEndOfPeiCallback (
233 IN EFI_PEI_SERVICES
**PeiServices
,
234 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
239 This function will be called by BSP to wakeup AP.
241 @param PeiCpuMpData Pointer to PEI CPU MP Data
242 @param Broadcast TRUE: Send broadcast IPI to all APs
243 FALSE: Send IPI to AP by ApicId
244 @param ApicId Apic ID for the processor to be waked
245 @param Procedure The function to be invoked by AP
246 @param ProcedureArgument The argument to be passed into AP function
250 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
251 IN BOOLEAN Broadcast
,
253 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
254 IN VOID
*ProcedureArgument OPTIONAL
258 Get CPU MP Data pointer from the Guided HOB.
260 @return Pointer to Pointer to PEI CPU MP Data
268 Find the current Processor number by APIC ID.
270 @param PeiCpuMpData Pointer to PEI CPU MP Data
271 @param ProcessorNumber Return the pocessor number found
273 @retval EFI_SUCCESS ProcessorNumber is found and returned.
274 @retval EFI_NOT_FOUND ProcessorNumber is not found.
278 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
279 OUT UINTN
*ProcessorNumber
283 Collects BIST data from PPI.
285 This function collects BIST data from Sec Platform Information2 PPI
286 or SEC Platform Information PPI.
288 @param PeiServices Pointer to PEI Services Table
289 @param PeiCpuMpData Pointer to PEI CPU MP Data
293 CollectBistDataFromPpi (
294 IN CONST EFI_PEI_SERVICES
**PeiServices
,
295 IN PEI_CPU_MP_DATA
*PeiCpuMpData
299 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
301 @param PeiServices The pointer to the PEI Services Table.
302 @param StructureSize The pointer to the variable describing size of the input buffer.
303 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
305 @retval EFI_SUCCESS The data was successfully returned.
306 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
307 hold the record is returned in StructureSize.
312 SecPlatformInformation2 (
313 IN CONST EFI_PEI_SERVICES
**PeiServices
,
314 IN OUT UINT64
*StructureSize
,
315 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2