UefiCpuPkg/Library/MpInitLib/MpLib.h

   1 /** @file
   2   Common header file for MP Initialize Library.
   3
   4   Copyright (c) 2016, 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                 NumApsExecuting;
 173   UINTN                 CodeSegment;
 174   UINTN                 DataSegment;
 175   UINTN                 EnableExecuteDisable;
 176   UINTN                 Cr3;
 177   UINTN                 InitFlag;
 178   CPU_INFO_IN_HOB       *CpuInfo;
 179   CPU_MP_DATA           *CpuMpData;
 180 } MP_CPU_EXCHANGE_INFO;
 181
 182 #pragma pack()
 183
 184 //
 185 // CPU MP Data save in memory
 186 //
 187 struct _CPU_MP_DATA {
 188   UINT64                         CpuInfoInHob;
 189   UINT32                         CpuCount;
 190   UINT32                         BspNumber;
 191   //
 192   // The above fields data will be passed from PEI to DXE
 193   // Please make sure the fields offset same in the different
 194   // architecture.
 195   //
 196   SPIN_LOCK                      MpLock;
 197   UINTN                          Buffer;
 198   UINTN                          CpuApStackSize;
 199   MP_ASSEMBLY_ADDRESS_MAP        AddressMap;
 200   UINTN                          WakeupBuffer;
 201   UINTN                          BackupBuffer;
 202   UINTN                          BackupBufferSize;
 203   BOOLEAN                        SaveRestoreFlag;
 204
 205   volatile UINT32                StartCount;
 206   volatile UINT32                FinishedCount;
 207   volatile UINT32                RunningCount;
 208   BOOLEAN                        SingleThread;
 209   EFI_AP_PROCEDURE               Procedure;
 210   VOID                           *ProcArguments;
 211   BOOLEAN                        *Finished;
 212   UINT64                         ExpectedTime;
 213   UINT64                         CurrentTime;
 214   UINT64                         TotalTime;
 215   EFI_EVENT                      WaitEvent;
 216   UINTN                          **FailedCpuList;
 217
 218   AP_INIT_STATE                  InitFlag;
 219   BOOLEAN                        X2ApicEnable;
 220   BOOLEAN                        SwitchBspFlag;
 221   UINTN                          NewBspNumber;
 222   CPU_EXCHANGE_ROLE_INFO         BSPInfo;
 223   CPU_EXCHANGE_ROLE_INFO         APInfo;
 224   MTRR_SETTINGS                  MtrrTable;
 225   UINT8                          ApLoopMode;
 226   UINT8                          ApTargetCState;
 227   UINT16                         PmCodeSegment;
 228   CPU_AP_DATA                    *CpuData;
 229   volatile MP_CPU_EXCHANGE_INFO  *MpCpuExchangeInfo;
 230 };
 231
 232 extern EFI_GUID mCpuInitMpLibHobGuid;
 233
 234 /**
 235   Assembly code to place AP into safe loop mode.
 236
 237   Place AP into targeted C-State if MONITOR is supported, otherwise
 238   place AP into hlt state.
 239   Place AP in protected mode if the current is long mode. Due to AP maybe
 240   wakeup by some hardware event. It could avoid accessing page table that
 241   may not available during booting to OS.
 242
 243   @param[in] MwaitSupport    TRUE indicates MONITOR is supported.
 244                              FALSE indicates MONITOR is not supported.
 245   @param[in] ApTargetCState  Target C-State value.
 246   @param[in] PmCodeSegment   Protected mode code segment value.
 247 **/
 248 typedef
 249 VOID
 250 (EFIAPI * ASM_RELOCATE_AP_LOOP) (
 251   IN BOOLEAN                 MwaitSupport,
 252   IN UINTN                   ApTargetCState,
 253   IN UINTN                   PmCodeSegment,
 254   IN UINTN                   TopOfApStack
 255   );
 256
 257 /**
 258   Assembly code to get starting address and size of the rendezvous entry for APs.
 259   Information for fixing a jump instruction in the code is also returned.
 260
 261   @param[out] AddressMap  Output buffer for address map information.
 262 **/
 263 VOID
 264 EFIAPI
 265 AsmGetAddressMap (
 266   OUT MP_ASSEMBLY_ADDRESS_MAP    *AddressMap
 267   );
 268
 269 /**
 270   This function is called by both the BSP and the AP which is to become the BSP to
 271   Exchange execution context including stack between them. After return from this
 272   function, the BSP becomes AP and the AP becomes the BSP.
 273
 274   @param[in] MyInfo      Pointer to buffer holding the exchanging information for the executing processor.
 275   @param[in] OthersInfo  Pointer to buffer holding the exchanging information for the peer.
 276
 277 **/
 278 VOID
 279 EFIAPI
 280 AsmExchangeRole (
 281   IN CPU_EXCHANGE_ROLE_INFO    *MyInfo,
 282   IN CPU_EXCHANGE_ROLE_INFO    *OthersInfo
 283   );
 284
 285 /**
 286   Get the pointer to CPU MP Data structure.
 287
 288   @return  The pointer to CPU MP Data structure.
 289 **/
 290 CPU_MP_DATA *
 291 GetCpuMpData (
 292   VOID
 293   );
 294
 295 /**
 296   Save the pointer to CPU MP Data structure.
 297
 298   @param[in] CpuMpData  The pointer to CPU MP Data structure will be saved.
 299 **/
 300 VOID
 301 SaveCpuMpData (
 302   IN CPU_MP_DATA   *CpuMpData
 303   );
 304
 305 /**
 306   Allocate reset vector buffer.
 307
 308   @param[in, out]  CpuMpData  The pointer to CPU MP Data structure.
 309 **/
 310 VOID
 311 AllocateResetVector (
 312   IN OUT CPU_MP_DATA          *CpuMpData
 313   );
 314
 315 /**
 316   Free AP reset vector buffer.
 317
 318   @param[in]  CpuMpData  The pointer to CPU MP Data structure.
 319 **/
 320 VOID
 321 FreeResetVector (
 322   IN CPU_MP_DATA              *CpuMpData
 323   );
 324
 325 /**
 326   This function will be called by BSP to wakeup AP.
 327
 328   @param[in] CpuMpData          Pointer to CPU MP Data
 329   @param[in] Broadcast          TRUE:  Send broadcast IPI to all APs
 330                                 FALSE: Send IPI to AP by ApicId
 331   @param[in] ProcessorNumber    The handle number of specified processor
 332   @param[in] Procedure          The function to be invoked by AP
 333   @param[in] ProcedureArgument  The argument to be passed into AP function
 334 **/
 335 VOID
 336 WakeUpAP (
 337   IN CPU_MP_DATA               *CpuMpData,
 338   IN BOOLEAN                   Broadcast,
 339   IN UINTN                     ProcessorNumber,
 340   IN EFI_AP_PROCEDURE          Procedure,              OPTIONAL
 341   IN VOID                      *ProcedureArgument      OPTIONAL
 342   );
 343
 344 /**
 345   Initialize global data for MP support.
 346
 347   @param[in] CpuMpData  The pointer to CPU MP Data structure.
 348 **/
 349 VOID
 350 InitMpGlobalData (
 351   IN CPU_MP_DATA               *CpuMpData
 352   );
 353
 354 /**
 355   Worker function to execute a caller provided function on all enabled APs.
 356
 357   @param[in]  Procedure               A pointer to the function to be run on
 358                                       enabled APs of the system.
 359   @param[in]  SingleThread            If TRUE, then all the enabled APs execute
 360                                       the function specified by Procedure one by
 361                                       one, in ascending order of processor handle
 362                                       number.  If FALSE, then all the enabled APs
 363                                       execute the function specified by Procedure
 364                                       simultaneously.
 365   @param[in]  WaitEvent               The event created by the caller with CreateEvent()
 366                                       service.
 367   @param[in]  TimeoutInMicrosecsond   Indicates the time limit in microseconds for
 368                                       APs to return from Procedure, either for
 369                                       blocking or non-blocking mode.
 370   @param[in]  ProcedureArgument       The parameter passed into Procedure for
 371                                       all APs.
 372   @param[out] FailedCpuList           If all APs finish successfully, then its
 373                                       content is set to NULL. If not all APs
 374                                       finish before timeout expires, then its
 375                                       content is set to address of the buffer
 376                                       holding handle numbers of the failed APs.
 377
 378   @retval EFI_SUCCESS             In blocking mode, all APs have finished before
 379                                   the timeout expired.
 380   @retval EFI_SUCCESS             In non-blocking mode, function has been dispatched
 381                                   to all enabled APs.
 382   @retval others                  Failed to Startup all APs.
 383
 384 **/
 385 EFI_STATUS
 386 StartupAllAPsWorker (
 387   IN  EFI_AP_PROCEDURE          Procedure,
 388   IN  BOOLEAN                   SingleThread,
 389   IN  EFI_EVENT                 WaitEvent               OPTIONAL,
 390   IN  UINTN                     TimeoutInMicroseconds,
 391   IN  VOID                      *ProcedureArgument      OPTIONAL,
 392   OUT UINTN                     **FailedCpuList         OPTIONAL
 393   );
 394
 395 /**
 396   Worker function to let the caller get one enabled AP to execute a caller-provided
 397   function.
 398
 399   @param[in]  Procedure               A pointer to the function to be run on
 400                                       enabled APs of the system.
 401   @param[in]  ProcessorNumber         The handle number of the AP.
 402   @param[in]  WaitEvent               The event created by the caller with CreateEvent()
 403                                       service.
 404   @param[in]  TimeoutInMicrosecsond   Indicates the time limit in microseconds for
 405                                       APs to return from Procedure, either for
 406                                       blocking or non-blocking mode.
 407   @param[in]  ProcedureArgument       The parameter passed into Procedure for
 408                                       all APs.
 409   @param[out] Finished                If AP returns from Procedure before the
 410                                       timeout expires, its content is set to TRUE.
 411                                       Otherwise, the value is set to FALSE.
 412
 413   @retval EFI_SUCCESS             In blocking mode, specified AP finished before
 414                                   the timeout expires.
 415   @retval others                  Failed to Startup AP.
 416
 417 **/
 418 EFI_STATUS
 419 StartupThisAPWorker (
 420   IN  EFI_AP_PROCEDURE          Procedure,
 421   IN  UINTN                     ProcessorNumber,
 422   IN  EFI_EVENT                 WaitEvent               OPTIONAL,
 423   IN  UINTN                     TimeoutInMicroseconds,
 424   IN  VOID                      *ProcedureArgument      OPTIONAL,
 425   OUT BOOLEAN                   *Finished               OPTIONAL
 426   );
 427
 428 /**
 429   Worker function to switch the requested AP to be the BSP from that point onward.
 430
 431   @param[in] ProcessorNumber   The handle number of AP that is to become the new BSP.
 432   @param[in] EnableOldBSP      If TRUE, then the old BSP will be listed as an
 433                                enabled AP. Otherwise, it will be disabled.
 434
 435   @retval EFI_SUCCESS          BSP successfully switched.
 436   @retval others               Failed to switch BSP.
 437
 438 **/
 439 EFI_STATUS
 440 SwitchBSPWorker (
 441   IN UINTN                     ProcessorNumber,
 442   IN BOOLEAN                   EnableOldBSP
 443   );
 444
 445 /**
 446   Worker function to let the caller enable or disable an AP from this point onward.
 447   This service may only be called from the BSP.
 448
 449   @param[in] ProcessorNumber   The handle number of AP.
 450   @param[in] EnableAP          Specifies the new state for the processor for
 451                                enabled, FALSE for disabled.
 452   @param[in] HealthFlag        If not NULL, a pointer to a value that specifies
 453                                the new health status of the AP.
 454
 455   @retval EFI_SUCCESS          The specified AP was enabled or disabled successfully.
 456   @retval others               Failed to Enable/Disable AP.
 457
 458 **/
 459 EFI_STATUS
 460 EnableDisableApWorker (
 461   IN  UINTN                     ProcessorNumber,
 462   IN  BOOLEAN                   EnableAP,
 463   IN  UINT32                    *HealthFlag OPTIONAL
 464   );
 465
 466 /**
 467   Get pointer to CPU MP Data structure from GUIDed HOB.
 468
 469   @return  The pointer to CPU MP Data structure.
 470 **/
 471 CPU_MP_DATA *
 472 GetCpuMpDataFromGuidedHob (
 473   VOID
 474   );
 475
 476 /** Checks status of specified AP.
 477
 478   This function checks whether the specified AP has finished the task assigned
 479   by StartupThisAP(), and whether timeout expires.
 480
 481   @param[in]  ProcessorNumber       The handle number of processor.
 482
 483   @retval EFI_SUCCESS           Specified AP has finished task assigned by StartupThisAPs().
 484   @retval EFI_TIMEOUT           The timeout expires.
 485   @retval EFI_NOT_READY         Specified AP has not finished task and timeout has not expired.
 486 **/
 487 EFI_STATUS
 488 CheckThisAP (
 489   IN UINTN        ProcessorNumber
 490   );
 491
 492 /**
 493   Checks status of all APs.
 494
 495   This function checks whether all APs have finished task assigned by StartupAllAPs(),
 496   and whether timeout expires.
 497
 498   @retval EFI_SUCCESS           All APs have finished task assigned by StartupAllAPs().
 499   @retval EFI_TIMEOUT           The timeout expires.
 500   @retval EFI_NOT_READY         APs have not finished task and timeout has not expired.
 501 **/
 502 EFI_STATUS
 503 CheckAllAPs (
 504   VOID
 505   );
 506
 507 /**
 508   Checks APs status and updates APs status if needed.
 509
 510 **/
 511 VOID
 512 CheckAndUpdateApsStatus (
 513   VOID
 514   );
 515
 516 /**
 517   Detect whether specified processor can find matching microcode patch and load it.
 518
 519   @param[in]  CpuMpData  The pointer to CPU MP Data structure.
 520 **/
 521 VOID
 522 MicrocodeDetect (
 523   IN CPU_MP_DATA             *CpuMpData
 524   );
 525
 526 /**
 527   Detect whether Mwait-monitor feature is supported.
 528
 529   @retval TRUE    Mwait-monitor feature is supported.
 530   @retval FALSE   Mwait-monitor feature is not supported.
 531 **/
 532 BOOLEAN
 533 IsMwaitSupport (
 534   VOID
 535   );
 536
 537 /**
 538   Notify function on End Of PEI PPI.
 539
 540   On S3 boot, this function will restore wakeup buffer data.
 541   On normal boot, this function will flag wakeup buffer to be un-used type.
 542
 543   @param[in]  PeiServices        The pointer to the PEI Services Table.
 544   @param[in]  NotifyDescriptor   Address of the notification descriptor data structure.
 545   @param[in]  Ppi                Address of the PPI that was installed.
 546
 547   @retval EFI_SUCCESS        When everything is OK.
 548 **/
 549 EFI_STATUS
 550 EFIAPI
 551 CpuMpEndOfPeiCallback (
 552   IN EFI_PEI_SERVICES             **PeiServices,
 553   IN EFI_PEI_NOTIFY_DESCRIPTOR    *NotifyDescriptor,
 554   IN VOID                         *Ppi
 555   );
 556
 557 /**
 558   Get available system memory below 1MB by specified size.
 559
 560   @param[in]  CpuMpData  The pointer to CPU MP Data structure.
 561 **/
 562 VOID
 563 BackupAndPrepareWakeupBuffer(
 564   IN CPU_MP_DATA              *CpuMpData
 565   );
 566
 567 /**
 568   Restore wakeup buffer data.
 569
 570   @param[in]  CpuMpData  The pointer to CPU MP Data structure.
 571 **/
 572 VOID
 573 RestoreWakeupBuffer(
 574   IN CPU_MP_DATA              *CpuMpData
 575   );
 576
 577 #endif
 578