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