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
;
118 EFI_HEALTH_FLAGS Health
;
124 // PEI CPU MP Data save in memory
126 struct _PEI_CPU_MP_DATA
{
131 UINTN CpuApStackSize
;
132 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
135 UINTN BackupBufferSize
;
137 UINTN ApFunctionArgument
;
138 volatile UINT32 FinishedCount
;
139 BOOLEAN EndOfPeiFlag
;
141 BOOLEAN X2ApicEnable
;
142 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
143 CPU_EXCHANGE_ROLE_INFO APInfo
;
144 MTRR_SETTINGS MtrrTable
;
145 PEI_CPU_DATA
*CpuData
;
146 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
148 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
152 Assembly code to get starting address and size of the rendezvous entry for APs.
153 Information for fixing a jump instruction in the code is also returned.
155 @param AddressMap Output buffer for address map information.
160 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
164 Assembly code to load GDT table and update segment accordingly.
166 @param Gdtr Pointer to GDT descriptor
171 IN IA32_DESCRIPTOR
*Gdtr
175 Assembly code to do CLI-HALT loop.
185 Get available system memory below 1MB by specified size.
187 @param PeiCpuMpData Pointer to PEI CPU MP Data
190 BackupAndPrepareWakeupBuffer(
191 IN PEI_CPU_MP_DATA
*PeiCpuMpData
195 Restore wakeup buffer data.
197 @param PeiCpuMpData Pointer to PEI CPU MP Data
201 IN PEI_CPU_MP_DATA
*PeiCpuMpData
205 Notify function on End Of Pei PPI.
207 On S3 boot, this function will restore wakeup buffer data.
208 On normal boot, this function will flag wakeup buffer to be un-used type.
210 @param PeiServices The pointer to the PEI Services Table.
211 @param NotifyDescriptor Address of the notification descriptor data structure.
212 @param Ppi Address of the PPI that was installed.
214 @retval EFI_SUCCESS When everything is OK.
219 CpuMpEndOfPeiCallback (
220 IN EFI_PEI_SERVICES
**PeiServices
,
221 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
226 This function will be called by BSP to wakeup AP.
228 @param PeiCpuMpData Pointer to PEI CPU MP Data
229 @param Broadcast TRUE: Send broadcast IPI to all APs
230 FALSE: Send IPI to AP by ApicId
231 @param ApicId Apic ID for the processor to be waked
232 @param Procedure The function to be invoked by AP
233 @param ProcedureArgument The argument to be passed into AP function
237 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
238 IN BOOLEAN Broadcast
,
240 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
241 IN VOID
*ProcedureArgument OPTIONAL
245 Get CPU MP Data pointer from the Guided HOB.
247 @return Pointer to Pointer to PEI CPU MP Data
255 Find the current Processor number by APIC ID.
257 @param PeiCpuMpData Pointer to PEI CPU MP Data
258 @param ProcessorNumber Return the pocessor number found
260 @retval EFI_SUCCESS ProcessorNumber is found and returned.
261 @retval EFI_NOT_FOUND ProcessorNumber is not found.
265 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
266 OUT UINTN
*ProcessorNumber
270 Collects BIST data from PPI.
272 This function collects BIST data from Sec Platform Information2 PPI
273 or SEC Platform Information PPI.
275 @param PeiServices Pointer to PEI Services Table
276 @param PeiCpuMpData Pointer to PEI CPU MP Data
280 CollectBistDataFromPpi (
281 IN CONST EFI_PEI_SERVICES
**PeiServices
,
282 IN PEI_CPU_MP_DATA
*PeiCpuMpData
286 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
288 @param PeiServices The pointer to the PEI Services Table.
289 @param StructureSize The pointer to the variable describing size of the input buffer.
290 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
292 @retval EFI_SUCCESS The data was successfully returned.
293 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
294 hold the record is returned in StructureSize.
299 SecPlatformInformation2 (
300 IN CONST EFI_PEI_SERVICES
**PeiServices
,
301 IN OUT UINT64
*StructureSize
,
302 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2