UefiCpuPkg/MpInitLib: Remove redundant CpuStateFinished State.
[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.h
1 /** @file
2 Common header file for MP Initialize Library.
3
4 Copyright (c) 2016 - 2018, 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
9
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.
12
13 **/
14
15 #ifndef _MP_LIB_H_
16 #define _MP_LIB_H_
17
18 #include <PiPei.h>
19
20 #include <Register/Cpuid.h>
21 #include <Register/Msr.h>
22 #include <Register/LocalApic.h>
23 #include <Register/Microcode.h>
24
25 #include <Library/MpInitLib.h>
26 #include <Library/BaseLib.h>
27 #include <Library/BaseMemoryLib.h>
28 #include <Library/MemoryAllocationLib.h>
29 #include <Library/DebugLib.h>
30 #include <Library/LocalApicLib.h>
31 #include <Library/CpuLib.h>
32 #include <Library/UefiCpuLib.h>
33 #include <Library/TimerLib.h>
34 #include <Library/SynchronizationLib.h>
35 #include <Library/MtrrLib.h>
36 #include <Library/HobLib.h>
37
38 #define WAKEUP_AP_SIGNAL SIGNATURE_32 ('S', 'T', 'A', 'P')
39
40 #define CPU_INIT_MP_LIB_HOB_GUID \
41 { \
42 0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
43 }
44
45 //
46 // The MP data for switch BSP
47 //
48 #define CPU_SWITCH_STATE_IDLE 0
49 #define CPU_SWITCH_STATE_STORED 1
50 #define CPU_SWITCH_STATE_LOADED 2
51
52 //
53 // CPU exchange information for switch BSP
54 //
55 typedef struct {
56 UINT8 State; // offset 0
57 UINTN StackPointer; // offset 4 / 8
58 IA32_DESCRIPTOR Gdtr; // offset 8 / 16
59 IA32_DESCRIPTOR Idtr; // offset 14 / 26
60 } CPU_EXCHANGE_ROLE_INFO;
61
62 //
63 // AP loop state when APs are in idle state
64 // It's value is the same with PcdCpuApLoopMode
65 //
66 typedef enum {
67 ApInHltLoop = 1,
68 ApInMwaitLoop = 2,
69 ApInRunLoop = 3
70 } AP_LOOP_MODE;
71
72 //
73 // AP initialization state during APs wakeup
74 //
75 typedef enum {
76 ApInitConfig = 1,
77 ApInitReconfig = 2,
78 ApInitDone = 3
79 } AP_INIT_STATE;
80
81 //
82 // AP state
83 //
84 // The state transitions for an AP when it process a procedure are:
85 // Idle ----> Ready ----> Busy ----> Idle
86 // [BSP] [AP] [AP]
87 //
88 typedef enum {
89 CpuStateIdle,
90 CpuStateReady,
91 CpuStateBusy,
92 CpuStateDisabled
93 } CPU_STATE;
94
95 //
96 // CPU volatile registers around INIT-SIPI-SIPI
97 //
98 typedef struct {
99 UINTN Cr0;
100 UINTN Cr3;
101 UINTN Cr4;
102 UINTN Dr0;
103 UINTN Dr1;
104 UINTN Dr2;
105 UINTN Dr3;
106 UINTN Dr6;
107 UINTN Dr7;
108 IA32_DESCRIPTOR Gdtr;
109 IA32_DESCRIPTOR Idtr;
110 UINT16 Tr;
111 } CPU_VOLATILE_REGISTERS;
112
113 //
114 // AP related data
115 //
116 typedef struct {
117 SPIN_LOCK ApLock;
118 volatile UINT32 *StartupApSignal;
119 volatile UINTN ApFunction;
120 volatile UINTN ApFunctionArgument;
121 BOOLEAN CpuHealthy;
122 volatile CPU_STATE State;
123 CPU_VOLATILE_REGISTERS VolatileRegisters;
124 BOOLEAN Waiting;
125 BOOLEAN *Finished;
126 UINT64 ExpectedTime;
127 UINT64 CurrentTime;
128 UINT64 TotalTime;
129 EFI_EVENT WaitEvent;
130 } CPU_AP_DATA;
131
132 //
133 // Basic CPU information saved in Guided HOB.
134 // Because the contents will be shard between PEI and DXE,
135 // we need to make sure the each fields offset same in different
136 // architecture.
137 //
138 #pragma pack (1)
139 typedef struct {
140 UINT32 InitialApicId;
141 UINT32 ApicId;
142 UINT32 Health;
143 UINT64 ApTopOfStack;
144 } CPU_INFO_IN_HOB;
145 #pragma pack ()
146
147 //
148 // AP reset code information including code address and size,
149 // this structure will be shared be C code and assembly code.
150 // It is natural aligned by design.
151 //
152 typedef struct {
153 UINT8 *RendezvousFunnelAddress;
154 UINTN ModeEntryOffset;
155 UINTN RendezvousFunnelSize;
156 UINT8 *RelocateApLoopFuncAddress;
157 UINTN RelocateApLoopFuncSize;
158 UINTN ModeTransitionOffset;
159 } MP_ASSEMBLY_ADDRESS_MAP;
160
161 typedef struct _CPU_MP_DATA CPU_MP_DATA;
162
163 #pragma pack(1)
164
165 //
166 // MP CPU exchange information for AP reset code
167 // This structure is required to be packed because fixed field offsets
168 // into this structure are used in assembly code in this module
169 //
170 typedef struct {
171 UINTN Lock;
172 UINTN StackStart;
173 UINTN StackSize;
174 UINTN CFunction;
175 IA32_DESCRIPTOR GdtrProfile;
176 IA32_DESCRIPTOR IdtrProfile;
177 UINTN BufferStart;
178 UINTN ModeOffset;
179 UINTN ApIndex;
180 UINTN CodeSegment;
181 UINTN DataSegment;
182 UINTN EnableExecuteDisable;
183 UINTN Cr3;
184 UINTN InitFlag;
185 CPU_INFO_IN_HOB *CpuInfo;
186 UINTN NumApsExecuting;
187 CPU_MP_DATA *CpuMpData;
188 UINTN InitializeFloatingPointUnitsAddress;
189 UINT32 ModeTransitionMemory;
190 UINT16 ModeTransitionSegment;
191 UINT32 ModeHighMemory;
192 UINT16 ModeHighSegment;
193 } MP_CPU_EXCHANGE_INFO;
194
195 #pragma pack()
196
197 //
198 // CPU MP Data save in memory
199 //
200 struct _CPU_MP_DATA {
201 UINT64 CpuInfoInHob;
202 UINT32 CpuCount;
203 UINT32 BspNumber;
204 //
205 // The above fields data will be passed from PEI to DXE
206 // Please make sure the fields offset same in the different
207 // architecture.
208 //
209 SPIN_LOCK MpLock;
210 UINTN Buffer;
211 UINTN CpuApStackSize;
212 MP_ASSEMBLY_ADDRESS_MAP AddressMap;
213 UINTN WakeupBuffer;
214 UINTN WakeupBufferHigh;
215 UINTN BackupBuffer;
216 UINTN BackupBufferSize;
217
218 volatile UINT32 StartCount;
219 volatile UINT32 FinishedCount;
220 volatile UINT32 RunningCount;
221 BOOLEAN SingleThread;
222 EFI_AP_PROCEDURE Procedure;
223 VOID *ProcArguments;
224 BOOLEAN *Finished;
225 UINT64 ExpectedTime;
226 UINT64 CurrentTime;
227 UINT64 TotalTime;
228 EFI_EVENT WaitEvent;
229 UINTN **FailedCpuList;
230
231 AP_INIT_STATE InitFlag;
232 BOOLEAN X2ApicEnable;
233 BOOLEAN SwitchBspFlag;
234 UINTN NewBspNumber;
235 CPU_EXCHANGE_ROLE_INFO BSPInfo;
236 CPU_EXCHANGE_ROLE_INFO APInfo;
237 MTRR_SETTINGS MtrrTable;
238 UINT8 ApLoopMode;
239 UINT8 ApTargetCState;
240 UINT16 PmCodeSegment;
241 CPU_AP_DATA *CpuData;
242 volatile MP_CPU_EXCHANGE_INFO *MpCpuExchangeInfo;
243
244 UINT32 CurrentTimerCount;
245 UINTN DivideValue;
246 UINT8 Vector;
247 BOOLEAN PeriodicMode;
248 BOOLEAN TimerInterruptState;
249 UINT64 MicrocodePatchAddress;
250 UINT64 MicrocodePatchRegionSize;
251
252 UINT32 ProcessorSignature;
253 UINT32 ProcessorFlags;
254 UINT64 MicrocodeDataAddress;
255 UINT32 MicrocodeRevision;
256
257 //
258 // Whether need to use Init-Sipi-Sipi to wake up the APs.
259 // Two cases need to set this value to TRUE. One is in HLT
260 // loop mode, the other is resume from S3 which loop mode
261 // will be hardcode change to HLT mode by PiSmmCpuDxeSmm
262 // driver.
263 //
264 BOOLEAN WakeUpByInitSipiSipi;
265 };
266
267 extern EFI_GUID mCpuInitMpLibHobGuid;
268
269 /**
270 Assembly code to place AP into safe loop mode.
271
272 Place AP into targeted C-State if MONITOR is supported, otherwise
273 place AP into hlt state.
274 Place AP in protected mode if the current is long mode. Due to AP maybe
275 wakeup by some hardware event. It could avoid accessing page table that
276 may not available during booting to OS.
277
278 @param[in] MwaitSupport TRUE indicates MONITOR is supported.
279 FALSE indicates MONITOR is not supported.
280 @param[in] ApTargetCState Target C-State value.
281 @param[in] PmCodeSegment Protected mode code segment value.
282 **/
283 typedef
284 VOID
285 (EFIAPI * ASM_RELOCATE_AP_LOOP) (
286 IN BOOLEAN MwaitSupport,
287 IN UINTN ApTargetCState,
288 IN UINTN PmCodeSegment,
289 IN UINTN TopOfApStack,
290 IN UINTN NumberToFinish
291 );
292
293 /**
294 Assembly code to get starting address and size of the rendezvous entry for APs.
295 Information for fixing a jump instruction in the code is also returned.
296
297 @param[out] AddressMap Output buffer for address map information.
298 **/
299 VOID
300 EFIAPI
301 AsmGetAddressMap (
302 OUT MP_ASSEMBLY_ADDRESS_MAP *AddressMap
303 );
304
305 /**
306 This function is called by both the BSP and the AP which is to become the BSP to
307 Exchange execution context including stack between them. After return from this
308 function, the BSP becomes AP and the AP becomes the BSP.
309
310 @param[in] MyInfo Pointer to buffer holding the exchanging information for the executing processor.
311 @param[in] OthersInfo Pointer to buffer holding the exchanging information for the peer.
312
313 **/
314 VOID
315 EFIAPI
316 AsmExchangeRole (
317 IN CPU_EXCHANGE_ROLE_INFO *MyInfo,
318 IN CPU_EXCHANGE_ROLE_INFO *OthersInfo
319 );
320
321 /**
322 Get the pointer to CPU MP Data structure.
323
324 @return The pointer to CPU MP Data structure.
325 **/
326 CPU_MP_DATA *
327 GetCpuMpData (
328 VOID
329 );
330
331 /**
332 Save the pointer to CPU MP Data structure.
333
334 @param[in] CpuMpData The pointer to CPU MP Data structure will be saved.
335 **/
336 VOID
337 SaveCpuMpData (
338 IN CPU_MP_DATA *CpuMpData
339 );
340
341
342 /**
343 Get available system memory below 1MB by specified size.
344
345 @param[in] WakeupBufferSize Wakeup buffer size required
346
347 @retval other Return wakeup buffer address below 1MB.
348 @retval -1 Cannot find free memory below 1MB.
349 **/
350 UINTN
351 GetWakeupBuffer (
352 IN UINTN WakeupBufferSize
353 );
354
355 /**
356 Get available EfiBootServicesCode memory below 4GB by specified size.
357
358 This buffer is required to safely transfer AP from real address mode to
359 protected mode or long mode, due to the fact that the buffer returned by
360 GetWakeupBuffer() may be marked as non-executable.
361
362 @param[in] BufferSize Wakeup transition buffer size.
363
364 @retval other Return wakeup transition buffer address below 4GB.
365 @retval 0 Cannot find free memory below 4GB.
366 **/
367 UINTN
368 GetModeTransitionBuffer (
369 IN UINTN BufferSize
370 );
371
372 /**
373 This function will be called by BSP to wakeup AP.
374
375 @param[in] CpuMpData Pointer to CPU MP Data
376 @param[in] Broadcast TRUE: Send broadcast IPI to all APs
377 FALSE: Send IPI to AP by ApicId
378 @param[in] ProcessorNumber The handle number of specified processor
379 @param[in] Procedure The function to be invoked by AP
380 @param[in] ProcedureArgument The argument to be passed into AP function
381 **/
382 VOID
383 WakeUpAP (
384 IN CPU_MP_DATA *CpuMpData,
385 IN BOOLEAN Broadcast,
386 IN UINTN ProcessorNumber,
387 IN EFI_AP_PROCEDURE Procedure, OPTIONAL
388 IN VOID *ProcedureArgument OPTIONAL
389 );
390
391 /**
392 Initialize global data for MP support.
393
394 @param[in] CpuMpData The pointer to CPU MP Data structure.
395 **/
396 VOID
397 InitMpGlobalData (
398 IN CPU_MP_DATA *CpuMpData
399 );
400
401 /**
402 Worker function to execute a caller provided function on all enabled APs.
403
404 @param[in] Procedure A pointer to the function to be run on
405 enabled APs of the system.
406 @param[in] SingleThread If TRUE, then all the enabled APs execute
407 the function specified by Procedure one by
408 one, in ascending order of processor handle
409 number. If FALSE, then all the enabled APs
410 execute the function specified by Procedure
411 simultaneously.
412 @param[in] WaitEvent The event created by the caller with CreateEvent()
413 service.
414 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
415 APs to return from Procedure, either for
416 blocking or non-blocking mode.
417 @param[in] ProcedureArgument The parameter passed into Procedure for
418 all APs.
419 @param[out] FailedCpuList If all APs finish successfully, then its
420 content is set to NULL. If not all APs
421 finish before timeout expires, then its
422 content is set to address of the buffer
423 holding handle numbers of the failed APs.
424
425 @retval EFI_SUCCESS In blocking mode, all APs have finished before
426 the timeout expired.
427 @retval EFI_SUCCESS In non-blocking mode, function has been dispatched
428 to all enabled APs.
429 @retval others Failed to Startup all APs.
430
431 **/
432 EFI_STATUS
433 StartupAllAPsWorker (
434 IN EFI_AP_PROCEDURE Procedure,
435 IN BOOLEAN SingleThread,
436 IN EFI_EVENT WaitEvent OPTIONAL,
437 IN UINTN TimeoutInMicroseconds,
438 IN VOID *ProcedureArgument OPTIONAL,
439 OUT UINTN **FailedCpuList OPTIONAL
440 );
441
442 /**
443 Worker function to let the caller get one enabled AP to execute a caller-provided
444 function.
445
446 @param[in] Procedure A pointer to the function to be run on
447 enabled APs of the system.
448 @param[in] ProcessorNumber The handle number of the AP.
449 @param[in] WaitEvent The event created by the caller with CreateEvent()
450 service.
451 @param[in] TimeoutInMicroseconds Indicates the time limit in microseconds for
452 APs to return from Procedure, either for
453 blocking or non-blocking mode.
454 @param[in] ProcedureArgument The parameter passed into Procedure for
455 all APs.
456 @param[out] Finished If AP returns from Procedure before the
457 timeout expires, its content is set to TRUE.
458 Otherwise, the value is set to FALSE.
459
460 @retval EFI_SUCCESS In blocking mode, specified AP finished before
461 the timeout expires.
462 @retval others Failed to Startup AP.
463
464 **/
465 EFI_STATUS
466 StartupThisAPWorker (
467 IN EFI_AP_PROCEDURE Procedure,
468 IN UINTN ProcessorNumber,
469 IN EFI_EVENT WaitEvent OPTIONAL,
470 IN UINTN TimeoutInMicroseconds,
471 IN VOID *ProcedureArgument OPTIONAL,
472 OUT BOOLEAN *Finished OPTIONAL
473 );
474
475 /**
476 Worker function to switch the requested AP to be the BSP from that point onward.
477
478 @param[in] ProcessorNumber The handle number of AP that is to become the new BSP.
479 @param[in] EnableOldBSP If TRUE, then the old BSP will be listed as an
480 enabled AP. Otherwise, it will be disabled.
481
482 @retval EFI_SUCCESS BSP successfully switched.
483 @retval others Failed to switch BSP.
484
485 **/
486 EFI_STATUS
487 SwitchBSPWorker (
488 IN UINTN ProcessorNumber,
489 IN BOOLEAN EnableOldBSP
490 );
491
492 /**
493 Worker function to let the caller enable or disable an AP from this point onward.
494 This service may only be called from the BSP.
495
496 @param[in] ProcessorNumber The handle number of AP.
497 @param[in] EnableAP Specifies the new state for the processor for
498 enabled, FALSE for disabled.
499 @param[in] HealthFlag If not NULL, a pointer to a value that specifies
500 the new health status of the AP.
501
502 @retval EFI_SUCCESS The specified AP was enabled or disabled successfully.
503 @retval others Failed to Enable/Disable AP.
504
505 **/
506 EFI_STATUS
507 EnableDisableApWorker (
508 IN UINTN ProcessorNumber,
509 IN BOOLEAN EnableAP,
510 IN UINT32 *HealthFlag OPTIONAL
511 );
512
513 /**
514 Get pointer to CPU MP Data structure from GUIDed HOB.
515
516 @return The pointer to CPU MP Data structure.
517 **/
518 CPU_MP_DATA *
519 GetCpuMpDataFromGuidedHob (
520 VOID
521 );
522
523 /** Checks status of specified AP.
524
525 This function checks whether the specified AP has finished the task assigned
526 by StartupThisAP(), and whether timeout expires.
527
528 @param[in] ProcessorNumber The handle number of processor.
529
530 @retval EFI_SUCCESS Specified AP has finished task assigned by StartupThisAPs().
531 @retval EFI_TIMEOUT The timeout expires.
532 @retval EFI_NOT_READY Specified AP has not finished task and timeout has not expired.
533 **/
534 EFI_STATUS
535 CheckThisAP (
536 IN UINTN ProcessorNumber
537 );
538
539 /**
540 Checks status of all APs.
541
542 This function checks whether all APs have finished task assigned by StartupAllAPs(),
543 and whether timeout expires.
544
545 @retval EFI_SUCCESS All APs have finished task assigned by StartupAllAPs().
546 @retval EFI_TIMEOUT The timeout expires.
547 @retval EFI_NOT_READY APs have not finished task and timeout has not expired.
548 **/
549 EFI_STATUS
550 CheckAllAPs (
551 VOID
552 );
553
554 /**
555 Checks APs status and updates APs status if needed.
556
557 **/
558 VOID
559 CheckAndUpdateApsStatus (
560 VOID
561 );
562
563 /**
564 Detect whether specified processor can find matching microcode patch and load it.
565
566 @param[in] CpuMpData The pointer to CPU MP Data structure.
567 @param[in] IsBspCallIn Indicate whether the caller is BSP or not.
568 **/
569 VOID
570 MicrocodeDetect (
571 IN CPU_MP_DATA *CpuMpData,
572 IN BOOLEAN IsBspCallIn
573 );
574
575 /**
576 Detect whether Mwait-monitor feature is supported.
577
578 @retval TRUE Mwait-monitor feature is supported.
579 @retval FALSE Mwait-monitor feature is not supported.
580 **/
581 BOOLEAN
582 IsMwaitSupport (
583 VOID
584 );
585
586 /**
587 Enable Debug Agent to support source debugging on AP function.
588
589 **/
590 VOID
591 EnableDebugAgent (
592 VOID
593 );
594
595 #endif
596