UefiCpuPkg/PiSmmCpuDxeSmm/PiSmmCpuDxeSmm.h

   1 /** @file
   2 Agent Module to load other modules to deploy SMM Entry Vector for X86 CPU.
   3
   4 Copyright (c) 2009 - 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 _CPU_PISMMCPUDXESMM_H_
  16 #define _CPU_PISMMCPUDXESMM_H_
  17
  18 #include <PiSmm.h>
  19
  20 #include <Protocol/MpService.h>
  21 #include <Protocol/SmmConfiguration.h>
  22 #include <Protocol/SmmCpu.h>
  23 #include <Protocol/SmmAccess2.h>
  24 #include <Protocol/SmmReadyToLock.h>
  25 #include <Protocol/SmmCpuService.h>
  26
  27 #include <Guid/AcpiS3Context.h>
  28
  29 #include <Library/BaseLib.h>
  30 #include <Library/IoLib.h>
  31 #include <Library/TimerLib.h>
  32 #include <Library/SynchronizationLib.h>
  33 #include <Library/DebugLib.h>
  34 #include <Library/BaseMemoryLib.h>
  35 #include <Library/PcdLib.h>
  36 #include <Library/CacheMaintenanceLib.h>
  37 #include <Library/MtrrLib.h>
  38 #include <Library/SmmCpuPlatformHookLib.h>
  39 #include <Library/SmmServicesTableLib.h>
  40 #include <Library/MemoryAllocationLib.h>
  41 #include <Library/UefiBootServicesTableLib.h>
  42 #include <Library/UefiRuntimeServicesTableLib.h>
  43 #include <Library/DebugAgentLib.h>
  44 #include <Library/HobLib.h>
  45 #include <Library/LocalApicLib.h>
  46 #include <Library/UefiCpuLib.h>
  47 #include <Library/CpuExceptionHandlerLib.h>
  48 #include <Library/ReportStatusCodeLib.h>
  49 #include <Library/SmmCpuFeaturesLib.h>
  50 #include <Library/PeCoffGetEntryPointLib.h>
  51
  52 #include <AcpiCpuData.h>
  53 #include <CpuHotPlugData.h>
  54
  55 #include <Register/Cpuid.h>
  56 #include <Register/Msr.h>
  57
  58 #include "CpuService.h"
  59 #include "SmmProfile.h"
  60
  61 //
  62 // MSRs required for configuration of SMM Code Access Check
  63 //
  64 #define EFI_MSR_SMM_MCA_CAP                    0x17D
  65 #define  SMM_CODE_ACCESS_CHK_BIT               BIT58
  66
  67 #define  SMM_FEATURE_CONTROL_LOCK_BIT          BIT0
  68 #define  SMM_CODE_CHK_EN_BIT                   BIT2
  69
  70 ///
  71 /// Page Table Entry
  72 ///
  73 #define IA32_PG_P                   BIT0
  74 #define IA32_PG_RW                  BIT1
  75 #define IA32_PG_U                   BIT2
  76 #define IA32_PG_WT                  BIT3
  77 #define IA32_PG_CD                  BIT4
  78 #define IA32_PG_A                   BIT5
  79 #define IA32_PG_D                   BIT6
  80 #define IA32_PG_PS                  BIT7
  81 #define IA32_PG_PAT_2M              BIT12
  82 #define IA32_PG_PAT_4K              IA32_PG_PS
  83 #define IA32_PG_PMNT                BIT62
  84 #define IA32_PG_NX                  BIT63
  85
  86 #define PAGE_ATTRIBUTE_BITS         (IA32_PG_RW | IA32_PG_P)
  87 //
  88 // Bits 1, 2, 5, 6 are reserved in the IA32 PAE PDPTE
  89 // X64 PAE PDPTE does not have such restriction
  90 //
  91 #define IA32_PAE_PDPTE_ATTRIBUTE_BITS    (IA32_PG_P)
  92
  93 //
  94 // Size of Task-State Segment defined in IA32 Manual
  95 //
  96 #define TSS_SIZE              104
  97 #define TSS_X64_IST1_OFFSET   36
  98 #define TSS_IA32_CR3_OFFSET   28
  99 #define TSS_IA32_ESP_OFFSET   56
 100
 101 //
 102 // Code select value
 103 //
 104 #define PROTECT_MODE_CODE_SEGMENT          0x08
 105 #define LONG_MODE_CODE_SEGMENT             0x38
 106
 107 //
 108 // The size 0x20 must be bigger than
 109 // the size of template code of SmmInit. Currently,
 110 // the size of SmmInit requires the 0x16 Bytes buffer
 111 // at least.
 112 //
 113 #define BACK_BUF_SIZE  0x20
 114
 115 #define EXCEPTION_VECTOR_NUMBER     0x20
 116
 117 #define INVALID_APIC_ID 0xFFFFFFFFFFFFFFFFULL
 118
 119 typedef UINT32                              SMM_CPU_ARRIVAL_EXCEPTIONS;
 120 #define ARRIVAL_EXCEPTION_BLOCKED           0x1
 121 #define ARRIVAL_EXCEPTION_DELAYED           0x2
 122 #define ARRIVAL_EXCEPTION_SMI_DISABLED      0x4
 123
 124 //
 125 // Private structure for the SMM CPU module that is stored in DXE Runtime memory
 126 // Contains the SMM Configuration Protocols that is produced.
 127 // Contains a mix of DXE and SMM contents.  All the fields must be used properly.
 128 //
 129 #define SMM_CPU_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('s', 'c', 'p', 'u')
 130
 131 typedef struct {
 132   UINTN                           Signature;
 133
 134   EFI_HANDLE                      SmmCpuHandle;
 135
 136   EFI_PROCESSOR_INFORMATION       *ProcessorInfo;
 137   SMM_CPU_OPERATION               *Operation;
 138   UINTN                           *CpuSaveStateSize;
 139   VOID                            **CpuSaveState;
 140
 141   EFI_SMM_RESERVED_SMRAM_REGION   SmmReservedSmramRegion[1];
 142   EFI_SMM_ENTRY_CONTEXT           SmmCoreEntryContext;
 143   EFI_SMM_ENTRY_POINT             SmmCoreEntry;
 144
 145   EFI_SMM_CONFIGURATION_PROTOCOL  SmmConfiguration;
 146 } SMM_CPU_PRIVATE_DATA;
 147
 148 extern SMM_CPU_PRIVATE_DATA  *gSmmCpuPrivate;
 149 extern CPU_HOT_PLUG_DATA      mCpuHotPlugData;
 150 extern UINTN                  mMaxNumberOfCpus;
 151 extern UINTN                  mNumberOfCpus;
 152 extern BOOLEAN                mRestoreSmmConfigurationInS3;
 153 extern EFI_SMM_CPU_PROTOCOL   mSmmCpu;
 154
 155 ///
 156 /// The mode of the CPU at the time an SMI occurs
 157 ///
 158 extern UINT8  mSmmSaveStateRegisterLma;
 159
 160
 161 //
 162 // SMM CPU Protocol function prototypes.
 163 //
 164
 165 /**
 166   Read information from the CPU save state.
 167
 168   @param  This      EFI_SMM_CPU_PROTOCOL instance
 169   @param  Width     The number of bytes to read from the CPU save state.
 170   @param  Register  Specifies the CPU register to read form the save state.
 171   @param  CpuIndex  Specifies the zero-based index of the CPU save state
 172   @param  Buffer    Upon return, this holds the CPU register value read from the save state.
 173
 174   @retval EFI_SUCCESS   The register was read from Save State
 175   @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
 176   @retval EFI_INVALID_PARAMTER   This or Buffer is NULL.
 177
 178 **/
 179 EFI_STATUS
 180 EFIAPI
 181 SmmReadSaveState (
 182   IN CONST EFI_SMM_CPU_PROTOCOL         *This,
 183   IN UINTN                              Width,
 184   IN EFI_SMM_SAVE_STATE_REGISTER        Register,
 185   IN UINTN                              CpuIndex,
 186   OUT VOID                              *Buffer
 187   );
 188
 189 /**
 190   Write data to the CPU save state.
 191
 192   @param  This      EFI_SMM_CPU_PROTOCOL instance
 193   @param  Width     The number of bytes to read from the CPU save state.
 194   @param  Register  Specifies the CPU register to write to the save state.
 195   @param  CpuIndex  Specifies the zero-based index of the CPU save state
 196   @param  Buffer    Upon entry, this holds the new CPU register value.
 197
 198   @retval EFI_SUCCESS   The register was written from Save State
 199   @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
 200   @retval EFI_INVALID_PARAMTER   ProcessorIndex or Width is not correct
 201
 202 **/
 203 EFI_STATUS
 204 EFIAPI
 205 SmmWriteSaveState (
 206   IN CONST EFI_SMM_CPU_PROTOCOL         *This,
 207   IN UINTN                              Width,
 208   IN EFI_SMM_SAVE_STATE_REGISTER        Register,
 209   IN UINTN                              CpuIndex,
 210   IN CONST VOID                         *Buffer
 211   );
 212
 213 /**
 214 Read a CPU Save State register on the target processor.
 215
 216 This function abstracts the differences that whether the CPU Save State register is in the
 217 IA32 CPU Save State Map or X64 CPU Save State Map.
 218
 219 This function supports reading a CPU Save State register in SMBase relocation handler.
 220
 221 @param[in]  CpuIndex       Specifies the zero-based index of the CPU save state.
 222 @param[in]  RegisterIndex  Index into mSmmCpuWidthOffset[] look up table.
 223 @param[in]  Width          The number of bytes to read from the CPU save state.
 224 @param[out] Buffer         Upon return, this holds the CPU register value read from the save state.
 225
 226 @retval EFI_SUCCESS           The register was read from Save State.
 227 @retval EFI_NOT_FOUND         The register is not defined for the Save State of Processor.
 228 @retval EFI_INVALID_PARAMTER  This or Buffer is NULL.
 229
 230 **/
 231 EFI_STATUS
 232 EFIAPI
 233 ReadSaveStateRegister (
 234   IN UINTN                        CpuIndex,
 235   IN EFI_SMM_SAVE_STATE_REGISTER  Register,
 236   IN UINTN                        Width,
 237   OUT VOID                        *Buffer
 238   );
 239
 240 /**
 241 Write value to a CPU Save State register on the target processor.
 242
 243 This function abstracts the differences that whether the CPU Save State register is in the
 244 IA32 CPU Save State Map or X64 CPU Save State Map.
 245
 246 This function supports writing a CPU Save State register in SMBase relocation handler.
 247
 248 @param[in] CpuIndex       Specifies the zero-based index of the CPU save state.
 249 @param[in] RegisterIndex  Index into mSmmCpuWidthOffset[] look up table.
 250 @param[in] Width          The number of bytes to read from the CPU save state.
 251 @param[in] Buffer         Upon entry, this holds the new CPU register value.
 252
 253 @retval EFI_SUCCESS           The register was written to Save State.
 254 @retval EFI_NOT_FOUND         The register is not defined for the Save State of Processor.
 255 @retval EFI_INVALID_PARAMTER  ProcessorIndex or Width is not correct.
 256
 257 **/
 258 EFI_STATUS
 259 EFIAPI
 260 WriteSaveStateRegister (
 261   IN UINTN                        CpuIndex,
 262   IN EFI_SMM_SAVE_STATE_REGISTER  Register,
 263   IN UINTN                        Width,
 264   IN CONST VOID                   *Buffer
 265   );
 266
 267 //
 268 //
 269 //
 270 typedef struct {
 271   UINT32                            Offset;
 272   UINT16                            Segment;
 273   UINT16                            Reserved;
 274 } IA32_FAR_ADDRESS;
 275
 276 extern IA32_FAR_ADDRESS             gSmmJmpAddr;
 277
 278 extern CONST UINT8                  gcSmmInitTemplate[];
 279 extern CONST UINT16                 gcSmmInitSize;
 280 extern UINT32                       gSmmCr0;
 281 extern UINT32                       gSmmCr3;
 282 extern UINT32                       gSmmCr4;
 283 extern UINTN                        gSmmInitStack;
 284
 285 /**
 286   Semaphore operation for all processor relocate SMMBase.
 287 **/
 288 VOID
 289 EFIAPI
 290 SmmRelocationSemaphoreComplete (
 291   VOID
 292   );
 293
 294 ///
 295 /// The type of SMM CPU Information
 296 ///
 297 typedef struct {
 298   SPIN_LOCK                         Busy;
 299   volatile EFI_AP_PROCEDURE         Procedure;
 300   volatile VOID                     *Parameter;
 301   volatile UINT32                   Run;
 302   volatile BOOLEAN                  Present;
 303 } SMM_CPU_DATA_BLOCK;
 304
 305 typedef enum {
 306   SmmCpuSyncModeTradition,
 307   SmmCpuSyncModeRelaxedAp,
 308   SmmCpuSyncModeMax
 309 } SMM_CPU_SYNC_MODE;
 310
 311 typedef struct {
 312   //
 313   // Pointer to an array. The array should be located immediately after this structure
 314   // so that UC cache-ability can be set together.
 315   //
 316   SMM_CPU_DATA_BLOCK            *CpuData;
 317   volatile UINT32               Counter;
 318   volatile UINT32               BspIndex;
 319   volatile BOOLEAN              InsideSmm;
 320   volatile BOOLEAN              AllCpusInSync;
 321   volatile SMM_CPU_SYNC_MODE    EffectiveSyncMode;
 322   volatile BOOLEAN              SwitchBsp;
 323   volatile BOOLEAN              *CandidateBsp;
 324 } SMM_DISPATCHER_MP_SYNC_DATA;
 325
 326 typedef struct {
 327   SPIN_LOCK    SpinLock;
 328   UINT32       MsrIndex;
 329 } MP_MSR_LOCK;
 330
 331 #define SMM_PSD_OFFSET              0xfb00
 332
 333 typedef struct {
 334   UINT64                            Signature;              // Offset 0x00
 335   UINT16                            Reserved1;              // Offset 0x08
 336   UINT16                            Reserved2;              // Offset 0x0A
 337   UINT16                            Reserved3;              // Offset 0x0C
 338   UINT16                            SmmCs;                  // Offset 0x0E
 339   UINT16                            SmmDs;                  // Offset 0x10
 340   UINT16                            SmmSs;                  // Offset 0x12
 341   UINT16                            SmmOtherSegment;        // Offset 0x14
 342   UINT16                            Reserved4;              // Offset 0x16
 343   UINT64                            Reserved5;              // Offset 0x18
 344   UINT64                            Reserved6;              // Offset 0x20
 345   UINT64                            Reserved7;              // Offset 0x28
 346   UINT64                            SmmGdtPtr;              // Offset 0x30
 347   UINT32                            SmmGdtSize;             // Offset 0x38
 348   UINT32                            Reserved8;              // Offset 0x3C
 349   UINT64                            Reserved9;              // Offset 0x40
 350   UINT64                            Reserved10;             // Offset 0x48
 351   UINT16                            Reserved11;             // Offset 0x50
 352   UINT16                            Reserved12;             // Offset 0x52
 353   UINT32                            Reserved13;             // Offset 0x54
 354   UINT64                            MtrrBaseMaskPtr;        // Offset 0x58
 355 } PROCESSOR_SMM_DESCRIPTOR;
 356
 357
 358 ///
 359 /// All global semaphores' pointer
 360 ///
 361 typedef struct {
 362   volatile UINT32      *Counter;
 363   volatile BOOLEAN     *InsideSmm;
 364   volatile BOOLEAN     *AllCpusInSync;
 365   SPIN_LOCK            *PFLock;
 366   SPIN_LOCK            *CodeAccessCheckLock;
 367 } SMM_CPU_SEMAPHORE_GLOBAL;
 368
 369 ///
 370 /// All semaphores' information
 371 ///
 372 typedef struct {
 373   SMM_CPU_SEMAPHORE_GLOBAL          SemaphoreGlobal;
 374 } SMM_CPU_SEMAPHORES;
 375
 376 extern IA32_DESCRIPTOR                     gcSmiGdtr;
 377 extern IA32_DESCRIPTOR                     gcSmiIdtr;
 378 extern VOID                                *gcSmiIdtrPtr;
 379 extern CONST PROCESSOR_SMM_DESCRIPTOR      gcPsd;
 380 extern UINT64                              gPhyMask;
 381 extern ACPI_CPU_DATA                       mAcpiCpuData;
 382 extern SMM_DISPATCHER_MP_SYNC_DATA         *mSmmMpSyncData;
 383 extern VOID                                *mGdtForAp;
 384 extern VOID                                *mIdtForAp;
 385 extern VOID                                *mMachineCheckHandlerForAp;
 386 extern UINTN                               mSmmStackArrayBase;
 387 extern UINTN                               mSmmStackArrayEnd;
 388 extern UINTN                               mSmmStackSize;
 389 extern EFI_SMM_CPU_SERVICE_PROTOCOL        mSmmCpuService;
 390 extern IA32_DESCRIPTOR                     gcSmiInitGdtr;
 391
 392 /**
 393   Create 4G PageTable in SMRAM.
 394
 395   @param          ExtraPages       Additional page numbers besides for 4G memory
 396   @param          Is32BitPageTable Whether the page table is 32-bit PAE
 397   @return         PageTable Address
 398
 399 **/
 400 UINT32
 401 Gen4GPageTable (
 402   IN      UINTN                     ExtraPages,
 403   IN      BOOLEAN                   Is32BitPageTable
 404   );
 405
 406
 407 /**
 408   Initialize global data for MP synchronization.
 409
 410   @param Stacks       Base address of SMI stack buffer for all processors.
 411   @param StackSize    Stack size for each processor in SMM.
 412
 413 **/
 414 UINT32
 415 InitializeMpServiceData (
 416   IN VOID        *Stacks,
 417   IN UINTN       StackSize
 418   );
 419
 420 /**
 421   Initialize Timer for SMM AP Sync.
 422
 423 **/
 424 VOID
 425 InitializeSmmTimer (
 426   VOID
 427   );
 428
 429 /**
 430   Start Timer for SMM AP Sync.
 431
 432 **/
 433 UINT64
 434 EFIAPI
 435 StartSyncTimer (
 436   VOID
 437   );
 438
 439 /**
 440   Check if the SMM AP Sync timer is timeout.
 441
 442   @param Timer  The start timer from the begin.
 443
 444 **/
 445 BOOLEAN
 446 EFIAPI
 447 IsSyncTimerTimeout (
 448   IN      UINT64                    Timer
 449   );
 450
 451 /**
 452   Initialize IDT for SMM Stack Guard.
 453
 454 **/
 455 VOID
 456 EFIAPI
 457 InitializeIDTSmmStackGuard (
 458   VOID
 459   );
 460
 461 /**
 462   Initialize Gdt for all processors.
 463
 464   @param[in]   Cr3          CR3 value.
 465   @param[out]  GdtStepSize  The step size for GDT table.
 466
 467   @return GdtBase for processor 0.
 468           GdtBase for processor X is: GdtBase + (GdtStepSize * X)
 469 **/
 470 VOID *
 471 InitGdt (
 472   IN  UINTN  Cr3,
 473   OUT UINTN  *GdtStepSize
 474   );
 475
 476 /**
 477
 478   Register the SMM Foundation entry point.
 479
 480   @param          This              Pointer to EFI_SMM_CONFIGURATION_PROTOCOL instance
 481   @param          SmmEntryPoint     SMM Foundation EntryPoint
 482
 483   @retval         EFI_SUCCESS       Successfully to register SMM foundation entry point
 484
 485 **/
 486 EFI_STATUS
 487 EFIAPI
 488 RegisterSmmEntry (
 489   IN CONST EFI_SMM_CONFIGURATION_PROTOCOL  *This,
 490   IN EFI_SMM_ENTRY_POINT                   SmmEntryPoint
 491   );
 492
 493 /**
 494   Create PageTable for SMM use.
 495
 496   @return     PageTable Address
 497
 498 **/
 499 UINT32
 500 SmmInitPageTable (
 501   VOID
 502   );
 503
 504 /**
 505   Schedule a procedure to run on the specified CPU.
 506
 507   @param   Procedure        The address of the procedure to run
 508   @param   CpuIndex         Target CPU number
 509   @param   ProcArguments    The parameter to pass to the procedure
 510
 511   @retval   EFI_INVALID_PARAMETER    CpuNumber not valid
 512   @retval   EFI_INVALID_PARAMETER    CpuNumber specifying BSP
 513   @retval   EFI_INVALID_PARAMETER    The AP specified by CpuNumber did not enter SMM
 514   @retval   EFI_INVALID_PARAMETER    The AP specified by CpuNumber is busy
 515   @retval   EFI_SUCCESS - The procedure has been successfully scheduled
 516
 517 **/
 518 EFI_STATUS
 519 EFIAPI
 520 SmmStartupThisAp (
 521   IN      EFI_AP_PROCEDURE          Procedure,
 522   IN      UINTN                     CpuIndex,
 523   IN OUT  VOID                      *ProcArguments OPTIONAL
 524   );
 525
 526 /**
 527   Schedule a procedure to run on the specified CPU in a blocking fashion.
 528
 529   @param  Procedure                The address of the procedure to run
 530   @param  CpuIndex                 Target CPU Index
 531   @param  ProcArguments            The parameter to pass to the procedure
 532
 533   @retval EFI_INVALID_PARAMETER    CpuNumber not valid
 534   @retval EFI_INVALID_PARAMETER    CpuNumber specifying BSP
 535   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber did not enter SMM
 536   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber is busy
 537   @retval EFI_SUCCESS              The procedure has been successfully scheduled
 538
 539 **/
 540 EFI_STATUS
 541 EFIAPI
 542 SmmBlockingStartupThisAp (
 543   IN      EFI_AP_PROCEDURE          Procedure,
 544   IN      UINTN                     CpuIndex,
 545   IN OUT  VOID                      *ProcArguments OPTIONAL
 546   );
 547
 548 /**
 549   Initialize MP synchronization data.
 550
 551 **/
 552 VOID
 553 EFIAPI
 554 InitializeMpSyncData (
 555   VOID
 556   );
 557
 558 /**
 559
 560   Find out SMRAM information including SMRR base and SMRR size.
 561
 562   @param          SmrrBase          SMRR base
 563   @param          SmrrSize          SMRR size
 564
 565 **/
 566 VOID
 567 FindSmramInfo (
 568   OUT UINT32   *SmrrBase,
 569   OUT UINT32   *SmrrSize
 570   );
 571
 572 /**
 573   The function is invoked before SMBASE relocation in S3 path to restores CPU status.
 574
 575   The function is invoked before SMBASE relocation in S3 path. It does first time microcode load
 576   and restores MTRRs for both BSP and APs.
 577
 578 **/
 579 VOID
 580 EarlyInitializeCpu (
 581   VOID
 582   );
 583
 584 /**
 585   The function is invoked after SMBASE relocation in S3 path to restores CPU status.
 586
 587   The function is invoked after SMBASE relocation in S3 path. It restores configuration according to
 588   data saved by normal boot path for both BSP and APs.
 589
 590 **/
 591 VOID
 592 InitializeCpu (
 593   VOID
 594   );
 595
 596 /**
 597   Page Fault handler for SMM use.
 598
 599   @param  InterruptType    Defines the type of interrupt or exception that
 600                            occurred on the processor.This parameter is processor architecture specific.
 601   @param  SystemContext    A pointer to the processor context when
 602                            the interrupt occurred on the processor.
 603 **/
 604 VOID
 605 EFIAPI
 606 SmiPFHandler (
 607     IN EFI_EXCEPTION_TYPE   InterruptType,
 608     IN EFI_SYSTEM_CONTEXT   SystemContext
 609   );
 610
 611 /**
 612   Perform the remaining tasks.
 613
 614 **/
 615 VOID
 616 PerformRemainingTasks (
 617   VOID
 618   );
 619
 620 /**
 621   Perform the pre tasks.
 622
 623 **/
 624 VOID
 625 PerformPreTasks (
 626   VOID
 627   );
 628
 629 /**
 630   Initialize MSR spin lock by MSR index.
 631
 632   @param  MsrIndex       MSR index value.
 633
 634 **/
 635 VOID
 636 InitMsrSpinLockByIndex (
 637   IN UINT32      MsrIndex
 638   );
 639
 640 /**
 641   Hook return address of SMM Save State so that semaphore code
 642   can be executed immediately after AP exits SMM to indicate to
 643   the BSP that an AP has exited SMM after SMBASE relocation.
 644
 645   @param[in] CpuIndex     The processor index.
 646   @param[in] RebasedFlag  A pointer to a flag that is set to TRUE
 647                           immediately after AP exits SMM.
 648
 649 **/
 650 VOID
 651 SemaphoreHook (
 652   IN UINTN             CpuIndex,
 653   IN volatile BOOLEAN  *RebasedFlag
 654   );
 655
 656 /**
 657 Configure SMM Code Access Check feature for all processors.
 658 SMM Feature Control MSR will be locked after configuration.
 659 **/
 660 VOID
 661 ConfigSmmCodeAccessCheck (
 662   VOID
 663   );
 664
 665 /**
 666   Hook the code executed immediately after an RSM instruction on the currently
 667   executing CPU.  The mode of code executed immediately after RSM must be
 668   detected, and the appropriate hook must be selected.  Always clear the auto
 669   HALT restart flag if it is set.
 670
 671   @param[in] CpuIndex                 The processor index for the currently
 672                                       executing CPU.
 673   @param[in] CpuState                 Pointer to SMRAM Save State Map for the
 674                                       currently executing CPU.
 675   @param[in] NewInstructionPointer32  Instruction pointer to use if resuming to
 676                                       32-bit mode from 64-bit SMM.
 677   @param[in] NewInstructionPointer    Instruction pointer to use if resuming to
 678                                       same mode as SMM.
 679
 680   @retval The value of the original instruction pointer before it was hooked.
 681
 682 **/
 683 UINT64
 684 EFIAPI
 685 HookReturnFromSmm (
 686   IN UINTN              CpuIndex,
 687   SMRAM_SAVE_STATE_MAP  *CpuState,
 688   UINT64                NewInstructionPointer32,
 689   UINT64                NewInstructionPointer
 690   );
 691
 692 /**
 693   Get the size of the SMI Handler in bytes.
 694
 695   @retval The size, in bytes, of the SMI Handler.
 696
 697 **/
 698 UINTN
 699 EFIAPI
 700 GetSmiHandlerSize (
 701   VOID
 702   );
 703
 704 /**
 705   Install the SMI handler for the CPU specified by CpuIndex.  This function
 706   is called by the CPU that was elected as monarch during System Management
 707   Mode initialization.
 708
 709   @param[in] CpuIndex   The index of the CPU to install the custom SMI handler.
 710                         The value must be between 0 and the NumberOfCpus field
 711                         in the System Management System Table (SMST).
 712   @param[in] SmBase     The SMBASE address for the CPU specified by CpuIndex.
 713   @param[in] SmiStack   The stack to use when an SMI is processed by the
 714                         the CPU specified by CpuIndex.
 715   @param[in] StackSize  The size, in bytes, if the stack used when an SMI is
 716                         processed by the CPU specified by CpuIndex.
 717   @param[in] GdtBase    The base address of the GDT to use when an SMI is
 718                         processed by the CPU specified by CpuIndex.
 719   @param[in] GdtSize    The size, in bytes, of the GDT used when an SMI is
 720                         processed by the CPU specified by CpuIndex.
 721   @param[in] IdtBase    The base address of the IDT to use when an SMI is
 722                         processed by the CPU specified by CpuIndex.
 723   @param[in] IdtSize    The size, in bytes, of the IDT used when an SMI is
 724                         processed by the CPU specified by CpuIndex.
 725   @param[in] Cr3        The base address of the page tables to use when an SMI
 726                         is processed by the CPU specified by CpuIndex.
 727 **/
 728 VOID
 729 EFIAPI
 730 InstallSmiHandler (
 731   IN UINTN   CpuIndex,
 732   IN UINT32  SmBase,
 733   IN VOID    *SmiStack,
 734   IN UINTN   StackSize,
 735   IN UINTN   GdtBase,
 736   IN UINTN   GdtSize,
 737   IN UINTN   IdtBase,
 738   IN UINTN   IdtSize,
 739   IN UINT32  Cr3
 740   );
 741
 742 /**
 743   Search module name by input IP address and output it.
 744
 745   @param CallerIpAddress   Caller instruction pointer.
 746
 747 **/
 748 VOID
 749 DumpModuleInfoByIp (
 750   IN  UINTN              CallerIpAddress
 751   );
 752
 753 /**
 754   This API provides a way to allocate memory for page table.
 755
 756   This API can be called more once to allocate memory for page tables.
 757
 758   Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
 759   allocated buffer.  The buffer returned is aligned on a 4KB boundary.  If Pages is 0, then NULL
 760   is returned.  If there is not enough memory remaining to satisfy the request, then NULL is
 761   returned.
 762
 763   @param  Pages                 The number of 4 KB pages to allocate.
 764
 765   @return A pointer to the allocated buffer or NULL if allocation fails.
 766
 767 **/
 768 VOID *
 769 AllocatePageTableMemory (
 770   IN UINTN           Pages
 771   );
 772
 773 #endif