]> git.proxmox.com Git - mirror_edk2.git/blame - UefiCpuPkg/CpuMpPei/CpuMpPei.h
UefiCpuPkg/CpuMpPei: Add CPU_VOLATILE_REGISTERS & worker functions
[mirror_edk2.git] / UefiCpuPkg / CpuMpPei / CpuMpPei.h
CommitLineData
ea0f431c
JF
1/** @file\r
2 Definitions to install Multiple Processor PPI.\r
3\r
4 Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
5 This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#ifndef _CPU_MP_PEI_H_\r
16#define _CPU_MP_PEI_H_\r
17\r
18#include <PiPei.h>\r
19\r
20#include <Ppi/MpServices.h>\r
21#include <Ppi/SecPlatformInformation.h>\r
22#include <Ppi/SecPlatformInformation2.h>\r
23#include <Ppi/EndOfPeiPhase.h>\r
24\r
28a7ddf0 25#include <Register/Cpuid.h>\r
ea0f431c
JF
26#include <Register/LocalApic.h>\r
27\r
28#include <Library/BaseLib.h>\r
29#include <Library/BaseMemoryLib.h>\r
30#include <Library/DebugLib.h>\r
31#include <Library/HobLib.h>\r
32#include <Library/LocalApicLib.h>\r
33#include <Library/MtrrLib.h>\r
34#include <Library/PcdLib.h>\r
35#include <Library/PeimEntryPoint.h>\r
36#include <Library/PeiServicesLib.h>\r
37#include <Library/ReportStatusCodeLib.h>\r
38#include <Library/SynchronizationLib.h>\r
39#include <Library/TimerLib.h>\r
40#include <Library/UefiCpuLib.h>\r
41\r
42#include "Microcode.h"\r
43\r
44//\r
45// AP state\r
46//\r
47typedef enum {\r
48 CpuStateIdle,\r
49 CpuStateBusy,\r
50 CpuStateDisabled\r
51} CPU_STATE;\r
52\r
53//\r
54// AP reset code information\r
55//\r
56typedef struct {\r
57 UINT8 *RendezvousFunnelAddress;\r
58 UINTN PModeEntryOffset;\r
59 UINTN LModeEntryOffset;\r
60 UINTN RendezvousFunnelSize;\r
61} MP_ASSEMBLY_ADDRESS_MAP;\r
62\r
63//\r
64// CPU exchange information for switch BSP\r
65//\r
66typedef struct {\r
67 UINT8 State; // offset 0\r
68 UINTN StackPointer; // offset 4 / 8\r
69 IA32_DESCRIPTOR Gdtr; // offset 8 / 16\r
70 IA32_DESCRIPTOR Idtr; // offset 14 / 26\r
71} CPU_EXCHANGE_ROLE_INFO;\r
72\r
73typedef struct _PEI_CPU_MP_DATA PEI_CPU_MP_DATA;\r
74\r
75#pragma pack()\r
76\r
77typedef union {\r
78 struct {\r
79 UINT32 LimitLow : 16;\r
80 UINT32 BaseLow : 16;\r
81 UINT32 BaseMid : 8;\r
82 UINT32 Type : 4;\r
83 UINT32 System : 1;\r
84 UINT32 Dpl : 2;\r
85 UINT32 Present : 1;\r
86 UINT32 LimitHigh : 4;\r
87 UINT32 Software : 1;\r
88 UINT32 Reserved : 1;\r
89 UINT32 DefaultSize : 1;\r
90 UINT32 Granularity : 1;\r
91 UINT32 BaseHigh : 8;\r
92 } Bits;\r
93 UINT64 Uint64;\r
94} IA32_GDT;\r
95\r
96//\r
97// MP CPU exchange information for AP reset code\r
98//\r
99typedef struct {\r
100 UINTN Lock;\r
101 UINTN StackStart;\r
102 UINTN StackSize;\r
103 UINTN CFunction;\r
104 IA32_DESCRIPTOR GdtrProfile;\r
105 IA32_DESCRIPTOR IdtrProfile;\r
106 UINTN BufferStart;\r
107 UINTN PmodeOffset;\r
108 UINTN NumApsExecuting;\r
109 UINTN LmodeOffset;\r
110 UINTN Cr3;\r
111 PEI_CPU_MP_DATA *PeiCpuMpData;\r
112} MP_CPU_EXCHANGE_INFO;\r
113\r
114#pragma pack()\r
115\r
ef1fdb80
JF
116typedef struct {\r
117 UINTN Cr0;\r
118 UINTN Cr3;\r
119 UINTN Cr4;\r
120 UINTN Dr0;\r
121 UINTN Dr1;\r
122 UINTN Dr2;\r
123 UINTN Dr3;\r
124 UINTN Dr6;\r
125 UINTN Dr7;\r
126} CPU_VOLATILE_REGISTERS;\r
127\r
ea0f431c
JF
128typedef struct {\r
129 UINT32 ApicId;\r
130 EFI_HEALTH_FLAGS Health;\r
131 CPU_STATE State;\r
132 BOOLEAN CpuHealthy;\r
ef1fdb80 133 CPU_VOLATILE_REGISTERS VolatileRegisters;\r
ea0f431c
JF
134} PEI_CPU_DATA;\r
135\r
136//\r
137// PEI CPU MP Data save in memory\r
138//\r
139struct _PEI_CPU_MP_DATA {\r
2f0261b7 140 SPIN_LOCK MpLock;\r
ea0f431c
JF
141 UINT32 CpuCount;\r
142 UINT32 BspNumber;\r
143 UINTN Buffer;\r
144 UINTN CpuApStackSize;\r
145 MP_ASSEMBLY_ADDRESS_MAP AddressMap;\r
146 UINTN WakeupBuffer;\r
147 UINTN BackupBuffer;\r
148 UINTN BackupBufferSize;\r
149 UINTN ApFunction;\r
150 UINTN ApFunctionArgument;\r
151 volatile UINT32 FinishedCount;\r
152 BOOLEAN EndOfPeiFlag;\r
153 BOOLEAN InitFlag;\r
2f0261b7 154 BOOLEAN X2ApicEnable;\r
ea0f431c
JF
155 CPU_EXCHANGE_ROLE_INFO BSPInfo;\r
156 CPU_EXCHANGE_ROLE_INFO APInfo;\r
157 MTRR_SETTINGS MtrrTable;\r
158 PEI_CPU_DATA *CpuData;\r
159 volatile MP_CPU_EXCHANGE_INFO *MpCpuExchangeInfo;\r
160};\r
161extern EFI_PEI_PPI_DESCRIPTOR mPeiCpuMpPpiDesc;\r
162\r
163\r
164/**\r
165 Assembly code to get starting address and size of the rendezvous entry for APs.\r
166 Information for fixing a jump instruction in the code is also returned.\r
167\r
168 @param AddressMap Output buffer for address map information.\r
169**/\r
170VOID\r
171EFIAPI\r
172AsmGetAddressMap (\r
173 OUT MP_ASSEMBLY_ADDRESS_MAP *AddressMap\r
174 );\r
175\r
176/**\r
177 Assembly code to load GDT table and update segment accordingly.\r
178\r
179 @param Gdtr Pointer to GDT descriptor\r
180**/\r
181VOID\r
182EFIAPI\r
183AsmInitializeGdt (\r
184 IN IA32_DESCRIPTOR *Gdtr\r
185 );\r
186\r
187/**\r
188 Assembly code to do CLI-HALT loop.\r
189\r
190**/\r
191VOID\r
192EFIAPI\r
193AsmCliHltLoop (\r
194 VOID\r
195 );\r
196\r
197/**\r
198 Get available system memory below 1MB by specified size.\r
199\r
200 @param PeiCpuMpData Pointer to PEI CPU MP Data\r
201**/\r
202VOID\r
203BackupAndPrepareWakeupBuffer(\r
204 IN PEI_CPU_MP_DATA *PeiCpuMpData\r
205 );\r
206\r
207/**\r
208 Restore wakeup buffer data.\r
209\r
210 @param PeiCpuMpData Pointer to PEI CPU MP Data\r
211**/\r
212VOID\r
213RestoreWakeupBuffer(\r
214 IN PEI_CPU_MP_DATA *PeiCpuMpData\r
215 );\r
216\r
217/**\r
218 Notify function on End Of Pei PPI.\r
219\r
220 On S3 boot, this function will restore wakeup buffer data.\r
221 On normal boot, this function will flag wakeup buffer to be un-used type.\r
222\r
223 @param PeiServices The pointer to the PEI Services Table.\r
224 @param NotifyDescriptor Address of the notification descriptor data structure.\r
225 @param Ppi Address of the PPI that was installed.\r
226\r
227 @retval EFI_SUCCESS When everything is OK.\r
228\r
229**/\r
230EFI_STATUS\r
231EFIAPI\r
232CpuMpEndOfPeiCallback (\r
233 IN EFI_PEI_SERVICES **PeiServices,\r
234 IN EFI_PEI_NOTIFY_DESCRIPTOR *NotifyDescriptor,\r
235 IN VOID *Ppi\r
236 );\r
237\r
238/**\r
239 This function will be called by BSP to wakeup AP.\r
240\r
241 @param PeiCpuMpData Pointer to PEI CPU MP Data\r
242 @param Broadcast TRUE: Send broadcast IPI to all APs\r
243 FALSE: Send IPI to AP by ApicId\r
244 @param ApicId Apic ID for the processor to be waked\r
245 @param Procedure The function to be invoked by AP\r
246 @param ProcedureArgument The argument to be passed into AP function\r
247**/\r
248VOID\r
249WakeUpAP (\r
250 IN PEI_CPU_MP_DATA *PeiCpuMpData,\r
251 IN BOOLEAN Broadcast,\r
252 IN UINT32 ApicId,\r
253 IN EFI_AP_PROCEDURE Procedure, OPTIONAL\r
254 IN VOID *ProcedureArgument OPTIONAL\r
255 );\r
256\r
257/**\r
258 Get CPU MP Data pointer from the Guided HOB.\r
259\r
260 @return Pointer to Pointer to PEI CPU MP Data\r
261**/\r
262PEI_CPU_MP_DATA *\r
263GetMpHobData (\r
264 VOID\r
265 );\r
266\r
267/**\r
268 Find the current Processor number by APIC ID.\r
269\r
270 @param PeiCpuMpData Pointer to PEI CPU MP Data\r
271 @param ProcessorNumber Return the pocessor number found\r
272\r
273 @retval EFI_SUCCESS ProcessorNumber is found and returned.\r
274 @retval EFI_NOT_FOUND ProcessorNumber is not found.\r
275**/\r
276EFI_STATUS\r
277GetProcessorNumber (\r
278 IN PEI_CPU_MP_DATA *PeiCpuMpData,\r
279 OUT UINTN *ProcessorNumber\r
280 );\r
281\r
282/**\r
283 Collects BIST data from PPI.\r
284\r
285 This function collects BIST data from Sec Platform Information2 PPI\r
286 or SEC Platform Information PPI.\r
287\r
288 @param PeiServices Pointer to PEI Services Table\r
289 @param PeiCpuMpData Pointer to PEI CPU MP Data\r
290\r
291**/\r
292VOID\r
293CollectBistDataFromPpi (\r
294 IN CONST EFI_PEI_SERVICES **PeiServices,\r
295 IN PEI_CPU_MP_DATA *PeiCpuMpData\r
296 );\r
297\r
298/**\r
299 Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.\r
300\r
301 @param PeiServices The pointer to the PEI Services Table.\r
302 @param StructureSize The pointer to the variable describing size of the input buffer.\r
303 @param PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.\r
304\r
305 @retval EFI_SUCCESS The data was successfully returned.\r
306 @retval EFI_BUFFER_TOO_SMALL The buffer was too small. The current buffer size needed to\r
307 hold the record is returned in StructureSize.\r
308\r
309**/\r
310EFI_STATUS\r
311EFIAPI\r
312SecPlatformInformation2 (\r
313 IN CONST EFI_PEI_SERVICES **PeiServices,\r
314 IN OUT UINT64 *StructureSize,\r
315 OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2 *PlatformInformationRecord2\r
316 );\r
317\r
318#endif\r