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