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>
29 #include <Library/BaseLib.h>
30 #include <Library/BaseMemoryLib.h>
31 #include <Library/DebugLib.h>
32 #include <Library/HobLib.h>
33 #include <Library/LocalApicLib.h>
34 #include <Library/MtrrLib.h>
35 #include <Library/PcdLib.h>
36 #include <Library/PeimEntryPoint.h>
37 #include <Library/PeiServicesLib.h>
38 #include <Library/ReportStatusCodeLib.h>
39 #include <Library/SynchronizationLib.h>
40 #include <Library/TimerLib.h>
41 #include <Library/UefiCpuLib.h>
42 #include <Library/CpuLib.h>
43 #include <Library/CpuExceptionHandlerLib.h>
45 #include "Microcode.h"
56 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
65 // AP reset code information
68 UINT8
*RendezvousFunnelAddress
;
69 UINTN PModeEntryOffset
;
70 UINTN LModeEntryOffset
;
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
;
100 UINT32 DefaultSize
: 1;
101 UINT32 Granularity
: 1;
108 // MP CPU exchange information for AP reset code
109 // This structure is required to be packed because fixed field offsets
110 // into this structure are used in assembly code in this module
117 IA32_DESCRIPTOR GdtrProfile
;
118 IA32_DESCRIPTOR IdtrProfile
;
121 UINTN NumApsExecuting
;
124 PEI_CPU_MP_DATA
*PeiCpuMpData
;
125 } MP_CPU_EXCHANGE_INFO
;
139 } CPU_VOLATILE_REGISTERS
;
142 volatile UINT32
*StartupApSignal
;
144 EFI_HEALTH_FLAGS Health
;
147 CPU_VOLATILE_REGISTERS VolatileRegisters
;
151 // PEI CPU MP Data save in memory
153 struct _PEI_CPU_MP_DATA
{
158 UINTN CpuApStackSize
;
159 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
162 UINTN BackupBufferSize
;
164 UINTN ApFunctionArgument
;
165 volatile UINT32 FinishedCount
;
166 BOOLEAN EndOfPeiFlag
;
168 BOOLEAN X2ApicEnable
;
169 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
170 CPU_EXCHANGE_ROLE_INFO APInfo
;
171 MTRR_SETTINGS MtrrTable
;
173 UINT8 ApTargetCState
;
174 PEI_CPU_DATA
*CpuData
;
175 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
177 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
181 Assembly code to get starting address and size of the rendezvous entry for APs.
182 Information for fixing a jump instruction in the code is also returned.
184 @param AddressMap Output buffer for address map information.
189 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
193 Assembly code to load GDT table and update segment accordingly.
195 @param Gdtr Pointer to GDT descriptor
200 IN IA32_DESCRIPTOR
*Gdtr
204 Get available system memory below 1MB by specified size.
206 @param PeiCpuMpData Pointer to PEI CPU MP Data
209 BackupAndPrepareWakeupBuffer(
210 IN PEI_CPU_MP_DATA
*PeiCpuMpData
214 Restore wakeup buffer data.
216 @param PeiCpuMpData Pointer to PEI CPU MP Data
220 IN PEI_CPU_MP_DATA
*PeiCpuMpData
224 Notify function on End Of Pei PPI.
226 On S3 boot, this function will restore wakeup buffer data.
227 On normal boot, this function will flag wakeup buffer to be un-used type.
229 @param PeiServices The pointer to the PEI Services Table.
230 @param NotifyDescriptor Address of the notification descriptor data structure.
231 @param Ppi Address of the PPI that was installed.
233 @retval EFI_SUCCESS When everything is OK.
238 CpuMpEndOfPeiCallback (
239 IN EFI_PEI_SERVICES
**PeiServices
,
240 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
245 This function will be called by BSP to wakeup AP.
247 @param PeiCpuMpData Pointer to PEI CPU MP Data
248 @param Broadcast TRUE: Send broadcast IPI to all APs
249 FALSE: Send IPI to AP by ApicId
250 @param ProcessorNumber The handle number of specified processor
251 @param Procedure The function to be invoked by AP
252 @param ProcedureArgument The argument to be passed into AP function
256 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
257 IN BOOLEAN Broadcast
,
258 IN UINTN ProcessorNumber
,
259 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
260 IN VOID
*ProcedureArgument OPTIONAL
264 Get CPU MP Data pointer from the Guided HOB.
266 @return Pointer to Pointer to PEI CPU MP Data
274 Find the current Processor number by APIC ID.
276 @param PeiCpuMpData Pointer to PEI CPU MP Data
277 @param ProcessorNumber Return the pocessor number found
279 @retval EFI_SUCCESS ProcessorNumber is found and returned.
280 @retval EFI_NOT_FOUND ProcessorNumber is not found.
284 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
285 OUT UINTN
*ProcessorNumber
289 Collects BIST data from PPI.
291 This function collects BIST data from Sec Platform Information2 PPI
292 or SEC Platform Information PPI.
294 @param PeiServices Pointer to PEI Services Table
295 @param PeiCpuMpData Pointer to PEI CPU MP Data
299 CollectBistDataFromPpi (
300 IN CONST EFI_PEI_SERVICES
**PeiServices
,
301 IN PEI_CPU_MP_DATA
*PeiCpuMpData
305 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
307 @param PeiServices The pointer to the PEI Services Table.
308 @param StructureSize The pointer to the variable describing size of the input buffer.
309 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
311 @retval EFI_SUCCESS The data was successfully returned.
312 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
313 hold the record is returned in StructureSize.
318 SecPlatformInformation2 (
319 IN CONST EFI_PEI_SERVICES
**PeiServices
,
320 IN OUT UINT64
*StructureSize
,
321 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2