UefiCpuPkg/Library/MpInitLib/MpLib.h

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