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 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                          WakeupBufferHigh;
 212   UINTN                          BackupBuffer;
 213   UINTN                          BackupBufferSize;
 214
 215   volatile UINT32                StartCount;
 216   volatile UINT32                FinishedCount;
 217   volatile UINT32                RunningCount;
 218   BOOLEAN                        SingleThread;
 219   EFI_AP_PROCEDURE               Procedure;
 220   VOID                           *ProcArguments;
 221   BOOLEAN                        *Finished;
 222   UINT64                         ExpectedTime;
 223   UINT64                         CurrentTime;
 224   UINT64                         TotalTime;
 225   EFI_EVENT                      WaitEvent;
 226   UINTN                          **FailedCpuList;
 227
 228   AP_INIT_STATE                  InitFlag;
 229   BOOLEAN                        X2ApicEnable;
 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
 250 extern EFI_GUID mCpuInitMpLibHobGuid;
 251
 252 /**
 253   Assembly code to place AP into safe loop mode.
 254
 255   Place AP into targeted C-State if MONITOR is supported, otherwise
 256   place AP into hlt state.
 257   Place AP in protected mode if the current is long mode. Due to AP maybe
 258   wakeup by some hardware event. It could avoid accessing page table that
 259   may not available during booting to OS.
 260
 261   @param[in] MwaitSupport    TRUE indicates MONITOR is supported.
 262                              FALSE indicates MONITOR is not supported.
 263   @param[in] ApTargetCState  Target C-State value.
 264   @param[in] PmCodeSegment   Protected mode code segment value.
 265 **/
 266 typedef
 267 VOID
 268 (EFIAPI * ASM_RELOCATE_AP_LOOP) (
 269   IN BOOLEAN                 MwaitSupport,
 270   IN UINTN                   ApTargetCState,
 271   IN UINTN                   PmCodeSegment,
 272   IN UINTN                   TopOfApStack,
 273   IN UINTN                   NumberToFinish
 274   );
 275
 276 /**
 277   Assembly code to get starting address and size of the rendezvous entry for APs.
 278   Information for fixing a jump instruction in the code is also returned.
 279
 280   @param[out] AddressMap  Output buffer for address map information.
 281 **/
 282 VOID
 283 EFIAPI
 284 AsmGetAddressMap (
 285   OUT MP_ASSEMBLY_ADDRESS_MAP    *AddressMap
 286   );
 287
 288 /**
 289   This function is called by both the BSP and the AP which is to become the BSP to
 290   Exchange execution context including stack between them. After return from this
 291   function, the BSP becomes AP and the AP becomes the BSP.
 292
 293   @param[in] MyInfo      Pointer to buffer holding the exchanging information for the executing processor.
 294   @param[in] OthersInfo  Pointer to buffer holding the exchanging information for the peer.
 295
 296 **/
 297 VOID
 298 EFIAPI
 299 AsmExchangeRole (
 300   IN CPU_EXCHANGE_ROLE_INFO    *MyInfo,
 301   IN CPU_EXCHANGE_ROLE_INFO    *OthersInfo
 302   );
 303
 304 /**
 305   Get the pointer to CPU MP Data structure.
 306
 307   @return  The pointer to CPU MP Data structure.
 308 **/
 309 CPU_MP_DATA *
 310 GetCpuMpData (
 311   VOID
 312   );
 313
 314 /**
 315   Save the pointer to CPU MP Data structure.
 316
 317   @param[in] CpuMpData  The pointer to CPU MP Data structure will be saved.
 318 **/
 319 VOID
 320 SaveCpuMpData (
 321   IN CPU_MP_DATA   *CpuMpData
 322   );
 323
 324
 325 /**
 326   Get available system memory below 1MB by specified size.
 327
 328   @param[in] WakeupBufferSize   Wakeup buffer size required
 329
 330   @retval other   Return wakeup buffer address below 1MB.
 331   @retval -1      Cannot find free memory below 1MB.
 332 **/
 333 UINTN
 334 GetWakeupBuffer (
 335   IN UINTN                WakeupBufferSize
 336   );
 337
 338 /**
 339   Get available EfiBootServicesCode memory below 4GB by specified size.
 340
 341   This buffer is required to safely transfer AP from real address mode to
 342   protected mode or long mode, due to the fact that the buffer returned by
 343   GetWakeupBuffer() may be marked as non-executable.
 344
 345   @param[in] BufferSize   Wakeup transition buffer size.
 346
 347   @retval other   Return wakeup transition buffer address below 4GB.
 348   @retval 0       Cannot find free memory below 4GB.
 349 **/
 350 UINTN
 351 GetModeTransitionBuffer (
 352   IN UINTN                BufferSize
 353   );
 354
 355 /**
 356   This function will be called by BSP to wakeup AP.
 357
 358   @param[in] CpuMpData          Pointer to CPU MP Data
 359   @param[in] Broadcast          TRUE:  Send broadcast IPI to all APs
 360                                 FALSE: Send IPI to AP by ApicId
 361   @param[in] ProcessorNumber    The handle number of specified processor
 362   @param[in] Procedure          The function to be invoked by AP
 363   @param[in] ProcedureArgument  The argument to be passed into AP function
 364 **/
 365 VOID
 366 WakeUpAP (
 367   IN CPU_MP_DATA               *CpuMpData,
 368   IN BOOLEAN                   Broadcast,
 369   IN UINTN                     ProcessorNumber,
 370   IN EFI_AP_PROCEDURE          Procedure,              OPTIONAL
 371   IN VOID                      *ProcedureArgument      OPTIONAL
 372   );
 373
 374 /**
 375   Initialize global data for MP support.
 376
 377   @param[in] CpuMpData  The pointer to CPU MP Data structure.
 378 **/
 379 VOID
 380 InitMpGlobalData (
 381   IN CPU_MP_DATA               *CpuMpData
 382   );
 383
 384 /**
 385   Worker function to execute a caller provided function on all enabled APs.
 386
 387   @param[in]  Procedure               A pointer to the function to be run on
 388                                       enabled APs of the system.
 389   @param[in]  SingleThread            If TRUE, then all the enabled APs execute
 390                                       the function specified by Procedure one by
 391                                       one, in ascending order of processor handle
 392                                       number.  If FALSE, then all the enabled APs
 393                                       execute the function specified by Procedure
 394                                       simultaneously.
 395   @param[in]  WaitEvent               The event created by the caller with CreateEvent()
 396                                       service.
 397   @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for
 398                                       APs to return from Procedure, either for
 399                                       blocking or non-blocking mode.
 400   @param[in]  ProcedureArgument       The parameter passed into Procedure for
 401                                       all APs.
 402   @param[out] FailedCpuList           If all APs finish successfully, then its
 403                                       content is set to NULL. If not all APs
 404                                       finish before timeout expires, then its
 405                                       content is set to address of the buffer
 406                                       holding handle numbers of the failed APs.
 407
 408   @retval EFI_SUCCESS             In blocking mode, all APs have finished before
 409                                   the timeout expired.
 410   @retval EFI_SUCCESS             In non-blocking mode, function has been dispatched
 411                                   to all enabled APs.
 412   @retval others                  Failed to Startup all APs.
 413
 414 **/
 415 EFI_STATUS
 416 StartupAllAPsWorker (
 417   IN  EFI_AP_PROCEDURE          Procedure,
 418   IN  BOOLEAN                   SingleThread,
 419   IN  EFI_EVENT                 WaitEvent               OPTIONAL,
 420   IN  UINTN                     TimeoutInMicroseconds,
 421   IN  VOID                      *ProcedureArgument      OPTIONAL,
 422   OUT UINTN                     **FailedCpuList         OPTIONAL
 423   );
 424
 425 /**
 426   Worker function to let the caller get one enabled AP to execute a caller-provided
 427   function.
 428
 429   @param[in]  Procedure               A pointer to the function to be run on
 430                                       enabled APs of the system.
 431   @param[in]  ProcessorNumber         The handle number of the AP.
 432   @param[in]  WaitEvent               The event created by the caller with CreateEvent()
 433                                       service.
 434   @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for
 435                                       APs to return from Procedure, either for
 436                                       blocking or non-blocking mode.
 437   @param[in]  ProcedureArgument       The parameter passed into Procedure for
 438                                       all APs.
 439   @param[out] Finished                If AP returns from Procedure before the
 440                                       timeout expires, its content is set to TRUE.
 441                                       Otherwise, the value is set to FALSE.
 442
 443   @retval EFI_SUCCESS             In blocking mode, specified AP finished before
 444                                   the timeout expires.
 445   @retval others                  Failed to Startup AP.
 446
 447 **/
 448 EFI_STATUS
 449 StartupThisAPWorker (
 450   IN  EFI_AP_PROCEDURE          Procedure,
 451   IN  UINTN                     ProcessorNumber,
 452   IN  EFI_EVENT                 WaitEvent               OPTIONAL,
 453   IN  UINTN                     TimeoutInMicroseconds,
 454   IN  VOID                      *ProcedureArgument      OPTIONAL,
 455   OUT BOOLEAN                   *Finished               OPTIONAL
 456   );
 457
 458 /**
 459   Worker function to switch the requested AP to be the BSP from that point onward.
 460
 461   @param[in] ProcessorNumber   The handle number of AP that is to become the new BSP.
 462   @param[in] EnableOldBSP      If TRUE, then the old BSP will be listed as an
 463                                enabled AP. Otherwise, it will be disabled.
 464
 465   @retval EFI_SUCCESS          BSP successfully switched.
 466   @retval others               Failed to switch BSP.
 467
 468 **/
 469 EFI_STATUS
 470 SwitchBSPWorker (
 471   IN UINTN                     ProcessorNumber,
 472   IN BOOLEAN                   EnableOldBSP
 473   );
 474
 475 /**
 476   Worker function to let the caller enable or disable an AP from this point onward.
 477   This service may only be called from the BSP.
 478
 479   @param[in] ProcessorNumber   The handle number of AP.
 480   @param[in] EnableAP          Specifies the new state for the processor for
 481                                enabled, FALSE for disabled.
 482   @param[in] HealthFlag        If not NULL, a pointer to a value that specifies
 483                                the new health status of the AP.
 484
 485   @retval EFI_SUCCESS          The specified AP was enabled or disabled successfully.
 486   @retval others               Failed to Enable/Disable AP.
 487
 488 **/
 489 EFI_STATUS
 490 EnableDisableApWorker (
 491   IN  UINTN                     ProcessorNumber,
 492   IN  BOOLEAN                   EnableAP,
 493   IN  UINT32                    *HealthFlag OPTIONAL
 494   );
 495
 496 /**
 497   Get pointer to CPU MP Data structure from GUIDed HOB.
 498
 499   @return  The pointer to CPU MP Data structure.
 500 **/
 501 CPU_MP_DATA *
 502 GetCpuMpDataFromGuidedHob (
 503   VOID
 504   );
 505
 506 /** Checks status of specified AP.
 507
 508   This function checks whether the specified AP has finished the task assigned
 509   by StartupThisAP(), and whether timeout expires.
 510
 511   @param[in]  ProcessorNumber       The handle number of processor.
 512
 513   @retval EFI_SUCCESS           Specified AP has finished task assigned by StartupThisAPs().
 514   @retval EFI_TIMEOUT           The timeout expires.
 515   @retval EFI_NOT_READY         Specified AP has not finished task and timeout has not expired.
 516 **/
 517 EFI_STATUS
 518 CheckThisAP (
 519   IN UINTN        ProcessorNumber
 520   );
 521
 522 /**
 523   Checks status of all APs.
 524
 525   This function checks whether all APs have finished task assigned by StartupAllAPs(),
 526   and whether timeout expires.
 527
 528   @retval EFI_SUCCESS           All APs have finished task assigned by StartupAllAPs().
 529   @retval EFI_TIMEOUT           The timeout expires.
 530   @retval EFI_NOT_READY         APs have not finished task and timeout has not expired.
 531 **/
 532 EFI_STATUS
 533 CheckAllAPs (
 534   VOID
 535   );
 536
 537 /**
 538   Checks APs status and updates APs status if needed.
 539
 540 **/
 541 VOID
 542 CheckAndUpdateApsStatus (
 543   VOID
 544   );
 545
 546 /**
 547   Detect whether specified processor can find matching microcode patch and load it.
 548
 549   @param[in]  CpuMpData  The pointer to CPU MP Data structure.
 550 **/
 551 VOID
 552 MicrocodeDetect (
 553   IN CPU_MP_DATA             *CpuMpData
 554   );
 555
 556 /**
 557   Detect whether Mwait-monitor feature is supported.
 558
 559   @retval TRUE    Mwait-monitor feature is supported.
 560   @retval FALSE   Mwait-monitor feature is not supported.
 561 **/
 562 BOOLEAN
 563 IsMwaitSupport (
 564   VOID
 565   );
 566
 567 /**
 568   Enable Debug Agent to support source debugging on AP function.
 569
 570 **/
 571 VOID
 572 EnableDebugAgent (
 573   VOID
 574   );
 575
 576 #endif
 577