UefiCpuPkg/Library/MpInitLib/MpLib.h

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