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"
60 // AP reset code information
63 UINT8
*RendezvousFunnelAddress
;
64 UINTN PModeEntryOffset
;
65 UINTN LModeEntryOffset
;
66 UINTN RendezvousFunnelSize
;
67 } MP_ASSEMBLY_ADDRESS_MAP
;
70 // CPU exchange information for switch BSP
73 UINT8 State
; // offset 0
74 UINTN StackPointer
; // offset 4 / 8
75 IA32_DESCRIPTOR Gdtr
; // offset 8 / 16
76 IA32_DESCRIPTOR Idtr
; // offset 14 / 26
77 } CPU_EXCHANGE_ROLE_INFO
;
79 typedef struct _PEI_CPU_MP_DATA PEI_CPU_MP_DATA
;
95 UINT32 DefaultSize
: 1;
96 UINT32 Granularity
: 1;
103 // MP CPU exchange information for AP reset code
104 // This structure is required to be packed because fixed field offsets
105 // into this structure are used in assembly code in this module
112 IA32_DESCRIPTOR GdtrProfile
;
113 IA32_DESCRIPTOR IdtrProfile
;
116 UINTN NumApsExecuting
;
119 PEI_CPU_MP_DATA
*PeiCpuMpData
;
120 } MP_CPU_EXCHANGE_INFO
;
134 } CPU_VOLATILE_REGISTERS
;
138 EFI_HEALTH_FLAGS Health
;
141 CPU_VOLATILE_REGISTERS VolatileRegisters
;
145 // PEI CPU MP Data save in memory
147 struct _PEI_CPU_MP_DATA
{
152 UINTN CpuApStackSize
;
153 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
156 UINTN BackupBufferSize
;
158 UINTN ApFunctionArgument
;
159 volatile UINT32 FinishedCount
;
160 BOOLEAN EndOfPeiFlag
;
162 BOOLEAN X2ApicEnable
;
163 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
164 CPU_EXCHANGE_ROLE_INFO APInfo
;
165 MTRR_SETTINGS MtrrTable
;
166 PEI_CPU_DATA
*CpuData
;
167 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
169 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
173 Assembly code to get starting address and size of the rendezvous entry for APs.
174 Information for fixing a jump instruction in the code is also returned.
176 @param AddressMap Output buffer for address map information.
181 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
185 Assembly code to load GDT table and update segment accordingly.
187 @param Gdtr Pointer to GDT descriptor
192 IN IA32_DESCRIPTOR
*Gdtr
196 Assembly code to do CLI-HALT loop.
206 Get available system memory below 1MB by specified size.
208 @param PeiCpuMpData Pointer to PEI CPU MP Data
211 BackupAndPrepareWakeupBuffer(
212 IN PEI_CPU_MP_DATA
*PeiCpuMpData
216 Restore wakeup buffer data.
218 @param PeiCpuMpData Pointer to PEI CPU MP Data
222 IN PEI_CPU_MP_DATA
*PeiCpuMpData
226 Notify function on End Of Pei PPI.
228 On S3 boot, this function will restore wakeup buffer data.
229 On normal boot, this function will flag wakeup buffer to be un-used type.
231 @param PeiServices The pointer to the PEI Services Table.
232 @param NotifyDescriptor Address of the notification descriptor data structure.
233 @param Ppi Address of the PPI that was installed.
235 @retval EFI_SUCCESS When everything is OK.
240 CpuMpEndOfPeiCallback (
241 IN EFI_PEI_SERVICES
**PeiServices
,
242 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
247 This function will be called by BSP to wakeup AP.
249 @param PeiCpuMpData Pointer to PEI CPU MP Data
250 @param Broadcast TRUE: Send broadcast IPI to all APs
251 FALSE: Send IPI to AP by ApicId
252 @param ApicId Apic ID for the processor to be waked
253 @param Procedure The function to be invoked by AP
254 @param ProcedureArgument The argument to be passed into AP function
258 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
259 IN BOOLEAN Broadcast
,
261 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
262 IN VOID
*ProcedureArgument OPTIONAL
266 Get CPU MP Data pointer from the Guided HOB.
268 @return Pointer to Pointer to PEI CPU MP Data
276 Find the current Processor number by APIC ID.
278 @param PeiCpuMpData Pointer to PEI CPU MP Data
279 @param ProcessorNumber Return the pocessor number found
281 @retval EFI_SUCCESS ProcessorNumber is found and returned.
282 @retval EFI_NOT_FOUND ProcessorNumber is not found.
286 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
287 OUT UINTN
*ProcessorNumber
291 Collects BIST data from PPI.
293 This function collects BIST data from Sec Platform Information2 PPI
294 or SEC Platform Information PPI.
296 @param PeiServices Pointer to PEI Services Table
297 @param PeiCpuMpData Pointer to PEI CPU MP Data
301 CollectBistDataFromPpi (
302 IN CONST EFI_PEI_SERVICES
**PeiServices
,
303 IN PEI_CPU_MP_DATA
*PeiCpuMpData
307 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
309 @param PeiServices The pointer to the PEI Services Table.
310 @param StructureSize The pointer to the variable describing size of the input buffer.
311 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
313 @retval EFI_SUCCESS The data was successfully returned.
314 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
315 hold the record is returned in StructureSize.
320 SecPlatformInformation2 (
321 IN CONST EFI_PEI_SERVICES
**PeiServices
,
322 IN OUT UINT64
*StructureSize
,
323 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2