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
98 // This structure is required to be packed because fixed field offsets
99 // into this structure are used in assembly code in this module
106 IA32_DESCRIPTOR GdtrProfile
;
107 IA32_DESCRIPTOR IdtrProfile
;
110 UINTN NumApsExecuting
;
113 PEI_CPU_MP_DATA
*PeiCpuMpData
;
114 } MP_CPU_EXCHANGE_INFO
;
128 } CPU_VOLATILE_REGISTERS
;
132 EFI_HEALTH_FLAGS Health
;
135 CPU_VOLATILE_REGISTERS VolatileRegisters
;
139 // PEI CPU MP Data save in memory
141 struct _PEI_CPU_MP_DATA
{
146 UINTN CpuApStackSize
;
147 MP_ASSEMBLY_ADDRESS_MAP AddressMap
;
150 UINTN BackupBufferSize
;
152 UINTN ApFunctionArgument
;
153 volatile UINT32 FinishedCount
;
154 BOOLEAN EndOfPeiFlag
;
156 BOOLEAN X2ApicEnable
;
157 CPU_EXCHANGE_ROLE_INFO BSPInfo
;
158 CPU_EXCHANGE_ROLE_INFO APInfo
;
159 MTRR_SETTINGS MtrrTable
;
160 PEI_CPU_DATA
*CpuData
;
161 volatile MP_CPU_EXCHANGE_INFO
*MpCpuExchangeInfo
;
163 extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc
;
167 Assembly code to get starting address and size of the rendezvous entry for APs.
168 Information for fixing a jump instruction in the code is also returned.
170 @param AddressMap Output buffer for address map information.
175 OUT MP_ASSEMBLY_ADDRESS_MAP
*AddressMap
179 Assembly code to load GDT table and update segment accordingly.
181 @param Gdtr Pointer to GDT descriptor
186 IN IA32_DESCRIPTOR
*Gdtr
190 Assembly code to do CLI-HALT loop.
200 Get available system memory below 1MB by specified size.
202 @param PeiCpuMpData Pointer to PEI CPU MP Data
205 BackupAndPrepareWakeupBuffer(
206 IN PEI_CPU_MP_DATA
*PeiCpuMpData
210 Restore wakeup buffer data.
212 @param PeiCpuMpData Pointer to PEI CPU MP Data
216 IN PEI_CPU_MP_DATA
*PeiCpuMpData
220 Notify function on End Of Pei PPI.
222 On S3 boot, this function will restore wakeup buffer data.
223 On normal boot, this function will flag wakeup buffer to be un-used type.
225 @param PeiServices The pointer to the PEI Services Table.
226 @param NotifyDescriptor Address of the notification descriptor data structure.
227 @param Ppi Address of the PPI that was installed.
229 @retval EFI_SUCCESS When everything is OK.
234 CpuMpEndOfPeiCallback (
235 IN EFI_PEI_SERVICES
**PeiServices
,
236 IN EFI_PEI_NOTIFY_DESCRIPTOR
*NotifyDescriptor
,
241 This function will be called by BSP to wakeup AP.
243 @param PeiCpuMpData Pointer to PEI CPU MP Data
244 @param Broadcast TRUE: Send broadcast IPI to all APs
245 FALSE: Send IPI to AP by ApicId
246 @param ApicId Apic ID for the processor to be waked
247 @param Procedure The function to be invoked by AP
248 @param ProcedureArgument The argument to be passed into AP function
252 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
253 IN BOOLEAN Broadcast
,
255 IN EFI_AP_PROCEDURE Procedure
, OPTIONAL
256 IN VOID
*ProcedureArgument OPTIONAL
260 Get CPU MP Data pointer from the Guided HOB.
262 @return Pointer to Pointer to PEI CPU MP Data
270 Find the current Processor number by APIC ID.
272 @param PeiCpuMpData Pointer to PEI CPU MP Data
273 @param ProcessorNumber Return the pocessor number found
275 @retval EFI_SUCCESS ProcessorNumber is found and returned.
276 @retval EFI_NOT_FOUND ProcessorNumber is not found.
280 IN PEI_CPU_MP_DATA
*PeiCpuMpData
,
281 OUT UINTN
*ProcessorNumber
285 Collects BIST data from PPI.
287 This function collects BIST data from Sec Platform Information2 PPI
288 or SEC Platform Information PPI.
290 @param PeiServices Pointer to PEI Services Table
291 @param PeiCpuMpData Pointer to PEI CPU MP Data
295 CollectBistDataFromPpi (
296 IN CONST EFI_PEI_SERVICES
**PeiServices
,
297 IN PEI_CPU_MP_DATA
*PeiCpuMpData
301 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
303 @param PeiServices The pointer to the PEI Services Table.
304 @param StructureSize The pointer to the variable describing size of the input buffer.
305 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
307 @retval EFI_SUCCESS The data was successfully returned.
308 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to
309 hold the record is returned in StructureSize.
314 SecPlatformInformation2 (
315 IN CONST EFI_PEI_SERVICES
**PeiServices
,
316 IN OUT UINT64
*StructureSize
,
317 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2
*PlatformInformationRecord2