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 - 2019, Intel Corporation. All rights reserved.<BR>
   5 Copyright (c) 2017, AMD Incorporated. All rights reserved.<BR>
   6
   7 SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef _CPU_PISMMCPUDXESMM_H_
  12 #define _CPU_PISMMCPUDXESMM_H_
  13
  14 #include <PiSmm.h>
  15
  16 #include <Protocol/MpService.h>
  17 #include <Protocol/SmmConfiguration.h>
  18 #include <Protocol/SmmCpu.h>
  19 #include <Protocol/SmmAccess2.h>
  20 #include <Protocol/SmmReadyToLock.h>
  21 #include <Protocol/SmmCpuService.h>
  22 #include <Protocol/SmmMemoryAttribute.h>
  23 #include <Protocol/MmMp.h>
  24
  25 #include <Guid/AcpiS3Context.h>
  26 #include <Guid/MemoryAttributesTable.h>
  27 #include <Guid/PiSmmMemoryAttributesTable.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/MtrrLib.h>
  37 #include <Library/SmmCpuPlatformHookLib.h>
  38 #include <Library/SmmServicesTableLib.h>
  39 #include <Library/MemoryAllocationLib.h>
  40 #include <Library/UefiBootServicesTableLib.h>
  41 #include <Library/UefiRuntimeServicesTableLib.h>
  42 #include <Library/DebugAgentLib.h>
  43 #include <Library/UefiLib.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 #include <Library/RegisterCpuFeaturesLib.h>
  52
  53 #include <AcpiCpuData.h>
  54 #include <CpuHotPlugData.h>
  55
  56 #include <Register/Intel/Cpuid.h>
  57 #include <Register/Intel/Msr.h>
  58
  59 #include "CpuService.h"
  60 #include "SmmProfile.h"
  61
  62 //
  63 // CET definition
  64 //
  65 #define CPUID_CET_SS   BIT7
  66 #define CPUID_CET_IBT  BIT20
  67
  68 #define CR4_CET_ENABLE  BIT23
  69
  70 #define MSR_IA32_S_CET                     0x6A2
  71 #define MSR_IA32_PL0_SSP                   0x6A4
  72 #define MSR_IA32_INTERRUPT_SSP_TABLE_ADDR  0x6A8
  73
  74 typedef union {
  75   struct {
  76     // enable shadow stacks
  77     UINT32  SH_STK_ENP:1;
  78     // enable the WRSS{D,Q}W instructions.
  79     UINT32  WR_SHSTK_EN:1;
  80     // enable tracking of indirect call/jmp targets to be ENDBRANCH instruction.
  81     UINT32  ENDBR_EN:1;
  82     // enable legacy compatibility treatment for indirect call/jmp tracking.
  83     UINT32  LEG_IW_EN:1;
  84     // enable use of no-track prefix on indirect call/jmp.
  85     UINT32  NO_TRACK_EN:1;
  86     // disable suppression of CET indirect branch tracking on legacy compatibility.
  87     UINT32  SUPPRESS_DIS:1;
  88     UINT32  RSVD:4;
  89     // indirect branch tracking is suppressed.
  90     // This bit can be written to 1 only if TRACKER is written as IDLE.
  91     UINT32  SUPPRESS:1;
  92     // Value of the endbranch state machine
  93     // Values: IDLE (0), WAIT_FOR_ENDBRANCH(1).
  94     UINT32  TRACKER:1;
  95     // linear address of a bitmap in memory indicating valid
  96     // pages as target of CALL/JMP_indirect that do not land on ENDBRANCH when CET is enabled
  97     // and not suppressed. Valid when ENDBR_EN is 1. Must be machine canonical when written on
  98     // parts that support 64 bit mode. On parts that do not support 64 bit mode, the bits 63:32 are
  99     // reserved and must be 0. This value is extended by 12 bits at the low end to form the base address
 100     // (this automatically aligns the address on a 4-Kbyte boundary).
 101     UINT32  EB_LEG_BITMAP_BASE_low:12;
 102     UINT32  EB_LEG_BITMAP_BASE_high:32;
 103   } Bits;
 104   UINT64   Uint64;
 105 } MSR_IA32_CET;
 106
 107 //
 108 // MSRs required for configuration of SMM Code Access Check
 109 //
 110 #define EFI_MSR_SMM_MCA_CAP                    0x17D
 111 #define  SMM_CODE_ACCESS_CHK_BIT               BIT58
 112
 113 #define  SMM_FEATURE_CONTROL_LOCK_BIT          BIT0
 114 #define  SMM_CODE_CHK_EN_BIT                   BIT2
 115
 116 ///
 117 /// Page Table Entry
 118 ///
 119 #define IA32_PG_P                   BIT0
 120 #define IA32_PG_RW                  BIT1
 121 #define IA32_PG_U                   BIT2
 122 #define IA32_PG_WT                  BIT3
 123 #define IA32_PG_CD                  BIT4
 124 #define IA32_PG_A                   BIT5
 125 #define IA32_PG_D                   BIT6
 126 #define IA32_PG_PS                  BIT7
 127 #define IA32_PG_PAT_2M              BIT12
 128 #define IA32_PG_PAT_4K              IA32_PG_PS
 129 #define IA32_PG_PMNT                BIT62
 130 #define IA32_PG_NX                  BIT63
 131
 132 #define PAGE_ATTRIBUTE_BITS         (IA32_PG_D | IA32_PG_A | IA32_PG_U | IA32_PG_RW | IA32_PG_P)
 133 //
 134 // Bits 1, 2, 5, 6 are reserved in the IA32 PAE PDPTE
 135 // X64 PAE PDPTE does not have such restriction
 136 //
 137 #define IA32_PAE_PDPTE_ATTRIBUTE_BITS    (IA32_PG_P)
 138
 139 #define PAGE_PROGATE_BITS           (IA32_PG_NX | PAGE_ATTRIBUTE_BITS)
 140
 141 #define PAGING_4K_MASK  0xFFF
 142 #define PAGING_2M_MASK  0x1FFFFF
 143 #define PAGING_1G_MASK  0x3FFFFFFF
 144
 145 #define PAGING_PAE_INDEX_MASK  0x1FF
 146
 147 #define PAGING_4K_ADDRESS_MASK_64 0x000FFFFFFFFFF000ull
 148 #define PAGING_2M_ADDRESS_MASK_64 0x000FFFFFFFE00000ull
 149 #define PAGING_1G_ADDRESS_MASK_64 0x000FFFFFC0000000ull
 150
 151 #define SMRR_MAX_ADDRESS       BASE_4GB
 152
 153 typedef enum {
 154   PageNone,
 155   Page4K,
 156   Page2M,
 157   Page1G,
 158 } PAGE_ATTRIBUTE;
 159
 160 typedef struct {
 161   PAGE_ATTRIBUTE   Attribute;
 162   UINT64           Length;
 163   UINT64           AddressMask;
 164 } PAGE_ATTRIBUTE_TABLE;
 165
 166 //
 167 // Size of Task-State Segment defined in IA32 Manual
 168 //
 169 #define TSS_SIZE              104
 170 #define EXCEPTION_TSS_SIZE    (TSS_SIZE + 4) // Add 4 bytes SSP
 171 #define TSS_X64_IST1_OFFSET   36
 172 #define TSS_IA32_CR3_OFFSET   28
 173 #define TSS_IA32_ESP_OFFSET   56
 174 #define TSS_IA32_SSP_OFFSET   104
 175
 176 #define CR0_WP                BIT16
 177
 178 //
 179 // Code select value
 180 //
 181 #define PROTECT_MODE_CODE_SEGMENT          0x08
 182 #define LONG_MODE_CODE_SEGMENT             0x38
 183
 184 //
 185 // The size 0x20 must be bigger than
 186 // the size of template code of SmmInit. Currently,
 187 // the size of SmmInit requires the 0x16 Bytes buffer
 188 // at least.
 189 //
 190 #define BACK_BUF_SIZE  0x20
 191
 192 #define EXCEPTION_VECTOR_NUMBER     0x20
 193
 194 #define INVALID_APIC_ID 0xFFFFFFFFFFFFFFFFULL
 195
 196 typedef UINT32                              SMM_CPU_ARRIVAL_EXCEPTIONS;
 197 #define ARRIVAL_EXCEPTION_BLOCKED           0x1
 198 #define ARRIVAL_EXCEPTION_DELAYED           0x2
 199 #define ARRIVAL_EXCEPTION_SMI_DISABLED      0x4
 200
 201 //
 202 // Wrapper used to convert EFI_AP_PROCEDURE2 and EFI_AP_PROCEDURE.
 203 //
 204 typedef struct {
 205   EFI_AP_PROCEDURE  Procedure;
 206   VOID              *ProcedureArgument;
 207 } PROCEDURE_WRAPPER;
 208
 209 #define PROCEDURE_TOKEN_SIGNATURE  SIGNATURE_32 ('P', 'R', 'T', 'S')
 210
 211 typedef struct {
 212   UINTN                   Signature;
 213   LIST_ENTRY              Link;
 214
 215   SPIN_LOCK               *SpinLock;
 216   volatile UINT32         RunningApCount;
 217 } PROCEDURE_TOKEN;
 218
 219 #define PROCEDURE_TOKEN_FROM_LINK(a)  CR (a, PROCEDURE_TOKEN, Link, PROCEDURE_TOKEN_SIGNATURE)
 220
 221 #define TOKEN_BUFFER_SIGNATURE  SIGNATURE_32 ('T', 'K', 'B', 'S')
 222
 223 typedef struct {
 224   UINTN                   Signature;
 225   LIST_ENTRY              Link;
 226
 227   UINT8                   *Buffer;
 228 } TOKEN_BUFFER;
 229
 230 #define TOKEN_BUFFER_FROM_LINK(a)  CR (a, TOKEN_BUFFER, Link, TOKEN_BUFFER_SIGNATURE)
 231
 232 //
 233 // Private structure for the SMM CPU module that is stored in DXE Runtime memory
 234 // Contains the SMM Configuration Protocols that is produced.
 235 // Contains a mix of DXE and SMM contents.  All the fields must be used properly.
 236 //
 237 #define SMM_CPU_PRIVATE_DATA_SIGNATURE  SIGNATURE_32 ('s', 'c', 'p', 'u')
 238
 239 typedef struct {
 240   UINTN                           Signature;
 241
 242   EFI_HANDLE                      SmmCpuHandle;
 243
 244   EFI_PROCESSOR_INFORMATION       *ProcessorInfo;
 245   SMM_CPU_OPERATION               *Operation;
 246   UINTN                           *CpuSaveStateSize;
 247   VOID                            **CpuSaveState;
 248
 249   EFI_SMM_RESERVED_SMRAM_REGION   SmmReservedSmramRegion[1];
 250   EFI_SMM_ENTRY_CONTEXT           SmmCoreEntryContext;
 251   EFI_SMM_ENTRY_POINT             SmmCoreEntry;
 252
 253   EFI_SMM_CONFIGURATION_PROTOCOL  SmmConfiguration;
 254
 255   PROCEDURE_WRAPPER               *ApWrapperFunc;
 256   LIST_ENTRY                      TokenList;
 257
 258   LIST_ENTRY                      OldTokenBufList;
 259
 260   UINT8                           *CurrentTokenBuf;
 261   UINT32                          UsedTokenNum;     // Only record tokens used in CurrentTokenBuf.
 262 } SMM_CPU_PRIVATE_DATA;
 263
 264 extern SMM_CPU_PRIVATE_DATA  *gSmmCpuPrivate;
 265 extern CPU_HOT_PLUG_DATA      mCpuHotPlugData;
 266 extern UINTN                  mMaxNumberOfCpus;
 267 extern UINTN                  mNumberOfCpus;
 268 extern EFI_SMM_CPU_PROTOCOL   mSmmCpu;
 269 extern EFI_MM_MP_PROTOCOL     mSmmMp;
 270
 271 ///
 272 /// The mode of the CPU at the time an SMI occurs
 273 ///
 274 extern UINT8  mSmmSaveStateRegisterLma;
 275
 276 //
 277 // SMM CPU Protocol function prototypes.
 278 //
 279
 280 /**
 281   Read information from the CPU save state.
 282
 283   @param  This      EFI_SMM_CPU_PROTOCOL instance
 284   @param  Width     The number of bytes to read from the CPU save state.
 285   @param  Register  Specifies the CPU register to read form the save state.
 286   @param  CpuIndex  Specifies the zero-based index of the CPU save state
 287   @param  Buffer    Upon return, this holds the CPU register value read from the save state.
 288
 289   @retval EFI_SUCCESS   The register was read from Save State
 290   @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
 291   @retval EFI_INVALID_PARAMTER   This or Buffer is NULL.
 292
 293 **/
 294 EFI_STATUS
 295 EFIAPI
 296 SmmReadSaveState (
 297   IN CONST EFI_SMM_CPU_PROTOCOL         *This,
 298   IN UINTN                              Width,
 299   IN EFI_SMM_SAVE_STATE_REGISTER        Register,
 300   IN UINTN                              CpuIndex,
 301   OUT VOID                              *Buffer
 302   );
 303
 304 /**
 305   Write data to the CPU save state.
 306
 307   @param  This      EFI_SMM_CPU_PROTOCOL instance
 308   @param  Width     The number of bytes to read from the CPU save state.
 309   @param  Register  Specifies the CPU register to write to the save state.
 310   @param  CpuIndex  Specifies the zero-based index of the CPU save state
 311   @param  Buffer    Upon entry, this holds the new CPU register value.
 312
 313   @retval EFI_SUCCESS   The register was written from Save State
 314   @retval EFI_NOT_FOUND The register is not defined for the Save State of Processor
 315   @retval EFI_INVALID_PARAMTER   ProcessorIndex or Width is not correct
 316
 317 **/
 318 EFI_STATUS
 319 EFIAPI
 320 SmmWriteSaveState (
 321   IN CONST EFI_SMM_CPU_PROTOCOL         *This,
 322   IN UINTN                              Width,
 323   IN EFI_SMM_SAVE_STATE_REGISTER        Register,
 324   IN UINTN                              CpuIndex,
 325   IN CONST VOID                         *Buffer
 326   );
 327
 328 /**
 329 Read a CPU Save State register on the target processor.
 330
 331 This function abstracts the differences that whether the CPU Save State register is in the
 332 IA32 CPU Save State Map or X64 CPU Save State Map.
 333
 334 This function supports reading a CPU Save State register in SMBase relocation handler.
 335
 336 @param[in]  CpuIndex       Specifies the zero-based index of the CPU save state.
 337 @param[in]  RegisterIndex  Index into mSmmCpuWidthOffset[] look up table.
 338 @param[in]  Width          The number of bytes to read from the CPU save state.
 339 @param[out] Buffer         Upon return, this holds the CPU register value read from the save state.
 340
 341 @retval EFI_SUCCESS           The register was read from Save State.
 342 @retval EFI_NOT_FOUND         The register is not defined for the Save State of Processor.
 343 @retval EFI_INVALID_PARAMTER  This or Buffer is NULL.
 344
 345 **/
 346 EFI_STATUS
 347 EFIAPI
 348 ReadSaveStateRegister (
 349   IN UINTN                        CpuIndex,
 350   IN EFI_SMM_SAVE_STATE_REGISTER  Register,
 351   IN UINTN                        Width,
 352   OUT VOID                        *Buffer
 353   );
 354
 355 /**
 356 Write value to a CPU Save State register on the target processor.
 357
 358 This function abstracts the differences that whether the CPU Save State register is in the
 359 IA32 CPU Save State Map or X64 CPU Save State Map.
 360
 361 This function supports writing a CPU Save State register in SMBase relocation handler.
 362
 363 @param[in] CpuIndex       Specifies the zero-based index of the CPU save state.
 364 @param[in] RegisterIndex  Index into mSmmCpuWidthOffset[] look up table.
 365 @param[in] Width          The number of bytes to read from the CPU save state.
 366 @param[in] Buffer         Upon entry, this holds the new CPU register value.
 367
 368 @retval EFI_SUCCESS           The register was written to Save State.
 369 @retval EFI_NOT_FOUND         The register is not defined for the Save State of Processor.
 370 @retval EFI_INVALID_PARAMTER  ProcessorIndex or Width is not correct.
 371
 372 **/
 373 EFI_STATUS
 374 EFIAPI
 375 WriteSaveStateRegister (
 376   IN UINTN                        CpuIndex,
 377   IN EFI_SMM_SAVE_STATE_REGISTER  Register,
 378   IN UINTN                        Width,
 379   IN CONST VOID                   *Buffer
 380   );
 381
 382 extern CONST UINT8                  gcSmmInitTemplate[];
 383 extern CONST UINT16                 gcSmmInitSize;
 384 X86_ASSEMBLY_PATCH_LABEL            gPatchSmmCr0;
 385 extern UINT32                       mSmmCr0;
 386 X86_ASSEMBLY_PATCH_LABEL            gPatchSmmCr3;
 387 extern UINT32                       mSmmCr4;
 388 X86_ASSEMBLY_PATCH_LABEL            gPatchSmmCr4;
 389 X86_ASSEMBLY_PATCH_LABEL            gPatchSmmInitStack;
 390 X86_ASSEMBLY_PATCH_LABEL            mPatchCetSupported;
 391 extern BOOLEAN                      mCetSupported;
 392
 393 /**
 394   Semaphore operation for all processor relocate SMMBase.
 395 **/
 396 VOID
 397 EFIAPI
 398 SmmRelocationSemaphoreComplete (
 399   VOID
 400   );
 401
 402 ///
 403 /// The type of SMM CPU Information
 404 ///
 405 typedef struct {
 406   SPIN_LOCK                         *Busy;
 407   volatile EFI_AP_PROCEDURE2        Procedure;
 408   volatile VOID                     *Parameter;
 409   volatile UINT32                   *Run;
 410   volatile BOOLEAN                  *Present;
 411   PROCEDURE_TOKEN                   *Token;
 412   EFI_STATUS                        *Status;
 413 } SMM_CPU_DATA_BLOCK;
 414
 415 typedef enum {
 416   SmmCpuSyncModeTradition,
 417   SmmCpuSyncModeRelaxedAp,
 418   SmmCpuSyncModeMax
 419 } SMM_CPU_SYNC_MODE;
 420
 421 typedef struct {
 422   //
 423   // Pointer to an array. The array should be located immediately after this structure
 424   // so that UC cache-ability can be set together.
 425   //
 426   SMM_CPU_DATA_BLOCK            *CpuData;
 427   volatile UINT32               *Counter;
 428   volatile UINT32               BspIndex;
 429   volatile BOOLEAN              *InsideSmm;
 430   volatile BOOLEAN              *AllCpusInSync;
 431   volatile SMM_CPU_SYNC_MODE    EffectiveSyncMode;
 432   volatile BOOLEAN              SwitchBsp;
 433   volatile BOOLEAN              *CandidateBsp;
 434   EFI_AP_PROCEDURE              StartupProcedure;
 435   VOID                          *StartupProcArgs;
 436 } SMM_DISPATCHER_MP_SYNC_DATA;
 437
 438 #define SMM_PSD_OFFSET              0xfb00
 439
 440 ///
 441 /// All global semaphores' pointer
 442 ///
 443 typedef struct {
 444   volatile UINT32      *Counter;
 445   volatile BOOLEAN     *InsideSmm;
 446   volatile BOOLEAN     *AllCpusInSync;
 447   SPIN_LOCK            *PFLock;
 448   SPIN_LOCK            *CodeAccessCheckLock;
 449 } SMM_CPU_SEMAPHORE_GLOBAL;
 450
 451 ///
 452 /// All semaphores for each processor
 453 ///
 454 typedef struct {
 455   SPIN_LOCK                         *Busy;
 456   volatile UINT32                   *Run;
 457   volatile BOOLEAN                  *Present;
 458   SPIN_LOCK                         *Token;
 459 } SMM_CPU_SEMAPHORE_CPU;
 460
 461 ///
 462 /// All semaphores' information
 463 ///
 464 typedef struct {
 465   SMM_CPU_SEMAPHORE_GLOBAL          SemaphoreGlobal;
 466   SMM_CPU_SEMAPHORE_CPU             SemaphoreCpu;
 467 } SMM_CPU_SEMAPHORES;
 468
 469 extern IA32_DESCRIPTOR                     gcSmiGdtr;
 470 extern EFI_PHYSICAL_ADDRESS                mGdtBuffer;
 471 extern UINTN                               mGdtBufferSize;
 472 extern IA32_DESCRIPTOR                     gcSmiIdtr;
 473 extern VOID                                *gcSmiIdtrPtr;
 474 extern UINT64                              gPhyMask;
 475 extern SMM_DISPATCHER_MP_SYNC_DATA         *mSmmMpSyncData;
 476 extern UINTN                               mSmmStackArrayBase;
 477 extern UINTN                               mSmmStackArrayEnd;
 478 extern UINTN                               mSmmStackSize;
 479 extern EFI_SMM_CPU_SERVICE_PROTOCOL        mSmmCpuService;
 480 extern IA32_DESCRIPTOR                     gcSmiInitGdtr;
 481 extern SMM_CPU_SEMAPHORES                  mSmmCpuSemaphores;
 482 extern UINTN                               mSemaphoreSize;
 483 extern SPIN_LOCK                           *mPFLock;
 484 extern SPIN_LOCK                           *mConfigSmmCodeAccessCheckLock;
 485 extern EFI_SMRAM_DESCRIPTOR                *mSmmCpuSmramRanges;
 486 extern UINTN                               mSmmCpuSmramRangeCount;
 487 extern UINT8                               mPhysicalAddressBits;
 488
 489 //
 490 // Copy of the PcdPteMemoryEncryptionAddressOrMask
 491 //
 492 extern UINT64  mAddressEncMask;
 493
 494 /**
 495   Create 4G PageTable in SMRAM.
 496
 497   @param[in]      Is32BitPageTable Whether the page table is 32-bit PAE
 498   @return         PageTable Address
 499
 500 **/
 501 UINT32
 502 Gen4GPageTable (
 503   IN      BOOLEAN                   Is32BitPageTable
 504   );
 505
 506
 507 /**
 508   Initialize global data for MP synchronization.
 509
 510   @param Stacks             Base address of SMI stack buffer for all processors.
 511   @param StackSize          Stack size for each processor in SMM.
 512   @param ShadowStackSize    Shadow Stack size for each processor in SMM.
 513
 514 **/
 515 UINT32
 516 InitializeMpServiceData (
 517   IN VOID        *Stacks,
 518   IN UINTN       StackSize,
 519   IN UINTN       ShadowStackSize
 520   );
 521
 522 /**
 523   Initialize Timer for SMM AP Sync.
 524
 525 **/
 526 VOID
 527 InitializeSmmTimer (
 528   VOID
 529   );
 530
 531 /**
 532   Start Timer for SMM AP Sync.
 533
 534 **/
 535 UINT64
 536 EFIAPI
 537 StartSyncTimer (
 538   VOID
 539   );
 540
 541 /**
 542   Check if the SMM AP Sync timer is timeout.
 543
 544   @param Timer  The start timer from the begin.
 545
 546 **/
 547 BOOLEAN
 548 EFIAPI
 549 IsSyncTimerTimeout (
 550   IN      UINT64                    Timer
 551   );
 552
 553 /**
 554   Initialize IDT for SMM Stack Guard.
 555
 556 **/
 557 VOID
 558 EFIAPI
 559 InitializeIDTSmmStackGuard (
 560   VOID
 561   );
 562
 563 /**
 564   Initialize Gdt for all processors.
 565
 566   @param[in]   Cr3          CR3 value.
 567   @param[out]  GdtStepSize  The step size for GDT table.
 568
 569   @return GdtBase for processor 0.
 570           GdtBase for processor X is: GdtBase + (GdtStepSize * X)
 571 **/
 572 VOID *
 573 InitGdt (
 574   IN  UINTN  Cr3,
 575   OUT UINTN  *GdtStepSize
 576   );
 577
 578 /**
 579
 580   Register the SMM Foundation entry point.
 581
 582   @param          This              Pointer to EFI_SMM_CONFIGURATION_PROTOCOL instance
 583   @param          SmmEntryPoint     SMM Foundation EntryPoint
 584
 585   @retval         EFI_SUCCESS       Successfully to register SMM foundation entry point
 586
 587 **/
 588 EFI_STATUS
 589 EFIAPI
 590 RegisterSmmEntry (
 591   IN CONST EFI_SMM_CONFIGURATION_PROTOCOL  *This,
 592   IN EFI_SMM_ENTRY_POINT                   SmmEntryPoint
 593   );
 594
 595 /**
 596   Create PageTable for SMM use.
 597
 598   @return     PageTable Address
 599
 600 **/
 601 UINT32
 602 SmmInitPageTable (
 603   VOID
 604   );
 605
 606 /**
 607   Schedule a procedure to run on the specified CPU.
 608
 609   @param   Procedure        The address of the procedure to run
 610   @param   CpuIndex         Target CPU number
 611   @param   ProcArguments    The parameter to pass to the procedure
 612
 613   @retval   EFI_INVALID_PARAMETER    CpuNumber not valid
 614   @retval   EFI_INVALID_PARAMETER    CpuNumber specifying BSP
 615   @retval   EFI_INVALID_PARAMETER    The AP specified by CpuNumber did not enter SMM
 616   @retval   EFI_INVALID_PARAMETER    The AP specified by CpuNumber is busy
 617   @retval   EFI_SUCCESS - The procedure has been successfully scheduled
 618
 619 **/
 620 EFI_STATUS
 621 EFIAPI
 622 SmmStartupThisAp (
 623   IN      EFI_AP_PROCEDURE          Procedure,
 624   IN      UINTN                     CpuIndex,
 625   IN OUT  VOID                      *ProcArguments OPTIONAL
 626   );
 627
 628 /**
 629   Schedule a procedure to run on the specified CPU in a blocking fashion.
 630
 631   @param  Procedure                The address of the procedure to run
 632   @param  CpuIndex                 Target CPU Index
 633   @param  ProcArguments            The parameter to pass to the procedure
 634
 635   @retval EFI_INVALID_PARAMETER    CpuNumber not valid
 636   @retval EFI_INVALID_PARAMETER    CpuNumber specifying BSP
 637   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber did not enter SMM
 638   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber is busy
 639   @retval EFI_SUCCESS              The procedure has been successfully scheduled
 640
 641 **/
 642 EFI_STATUS
 643 EFIAPI
 644 SmmBlockingStartupThisAp (
 645   IN      EFI_AP_PROCEDURE          Procedure,
 646   IN      UINTN                     CpuIndex,
 647   IN OUT  VOID                      *ProcArguments OPTIONAL
 648   );
 649
 650 /**
 651   This function sets the attributes for the memory region specified by BaseAddress and
 652   Length from their current attributes to the attributes specified by Attributes.
 653
 654   @param[in]  BaseAddress      The physical address that is the start address of a memory region.
 655   @param[in]  Length           The size in bytes of the memory region.
 656   @param[in]  Attributes       The bit mask of attributes to set for the memory region.
 657
 658   @retval EFI_SUCCESS           The attributes were set for the memory region.
 659   @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by
 660                                 BaseAddress and Length cannot be modified.
 661   @retval EFI_INVALID_PARAMETER Length is zero.
 662                                 Attributes specified an illegal combination of attributes that
 663                                 cannot be set together.
 664   @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of
 665                                 the memory resource range.
 666   @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory
 667                                 resource range specified by BaseAddress and Length.
 668                                 The bit mask of attributes is not support for the memory resource
 669                                 range specified by BaseAddress and Length.
 670
 671 **/
 672 EFI_STATUS
 673 EFIAPI
 674 SmmSetMemoryAttributes (
 675   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
 676   IN  UINT64                                     Length,
 677   IN  UINT64                                     Attributes
 678   );
 679
 680 /**
 681   This function clears the attributes for the memory region specified by BaseAddress and
 682   Length from their current attributes to the attributes specified by Attributes.
 683
 684   @param[in]  BaseAddress      The physical address that is the start address of a memory region.
 685   @param[in]  Length           The size in bytes of the memory region.
 686   @param[in]  Attributes       The bit mask of attributes to clear for the memory region.
 687
 688   @retval EFI_SUCCESS           The attributes were cleared for the memory region.
 689   @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by
 690                                 BaseAddress and Length cannot be modified.
 691   @retval EFI_INVALID_PARAMETER Length is zero.
 692                                 Attributes specified an illegal combination of attributes that
 693                                 cannot be set together.
 694   @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of
 695                                 the memory resource range.
 696   @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory
 697                                 resource range specified by BaseAddress and Length.
 698                                 The bit mask of attributes is not support for the memory resource
 699                                 range specified by BaseAddress and Length.
 700
 701 **/
 702 EFI_STATUS
 703 EFIAPI
 704 SmmClearMemoryAttributes (
 705   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
 706   IN  UINT64                                     Length,
 707   IN  UINT64                                     Attributes
 708   );
 709
 710 /**
 711   Initialize MP synchronization data.
 712
 713 **/
 714 VOID
 715 EFIAPI
 716 InitializeMpSyncData (
 717   VOID
 718   );
 719
 720 /**
 721
 722   Find out SMRAM information including SMRR base and SMRR size.
 723
 724   @param          SmrrBase          SMRR base
 725   @param          SmrrSize          SMRR size
 726
 727 **/
 728 VOID
 729 FindSmramInfo (
 730   OUT UINT32   *SmrrBase,
 731   OUT UINT32   *SmrrSize
 732   );
 733
 734 /**
 735   Relocate SmmBases for each processor.
 736
 737   Execute on first boot and all S3 resumes
 738
 739 **/
 740 VOID
 741 EFIAPI
 742 SmmRelocateBases (
 743   VOID
 744   );
 745
 746 /**
 747   Page Fault handler for SMM use.
 748
 749   @param  InterruptType    Defines the type of interrupt or exception that
 750                            occurred on the processor.This parameter is processor architecture specific.
 751   @param  SystemContext    A pointer to the processor context when
 752                            the interrupt occurred on the processor.
 753 **/
 754 VOID
 755 EFIAPI
 756 SmiPFHandler (
 757   IN EFI_EXCEPTION_TYPE   InterruptType,
 758   IN EFI_SYSTEM_CONTEXT   SystemContext
 759   );
 760
 761 /**
 762   Perform the remaining tasks.
 763
 764 **/
 765 VOID
 766 PerformRemainingTasks (
 767   VOID
 768   );
 769
 770 /**
 771   Perform the pre tasks.
 772
 773 **/
 774 VOID
 775 PerformPreTasks (
 776   VOID
 777   );
 778
 779 /**
 780   Initialize MSR spin lock by MSR index.
 781
 782   @param  MsrIndex       MSR index value.
 783
 784 **/
 785 VOID
 786 InitMsrSpinLockByIndex (
 787   IN UINT32      MsrIndex
 788   );
 789
 790 /**
 791   Hook return address of SMM Save State so that semaphore code
 792   can be executed immediately after AP exits SMM to indicate to
 793   the BSP that an AP has exited SMM after SMBASE relocation.
 794
 795   @param[in] CpuIndex     The processor index.
 796   @param[in] RebasedFlag  A pointer to a flag that is set to TRUE
 797                           immediately after AP exits SMM.
 798
 799 **/
 800 VOID
 801 SemaphoreHook (
 802   IN UINTN             CpuIndex,
 803   IN volatile BOOLEAN  *RebasedFlag
 804   );
 805
 806 /**
 807 Configure SMM Code Access Check feature for all processors.
 808 SMM Feature Control MSR will be locked after configuration.
 809 **/
 810 VOID
 811 ConfigSmmCodeAccessCheck (
 812   VOID
 813   );
 814
 815 /**
 816   Hook the code executed immediately after an RSM instruction on the currently
 817   executing CPU.  The mode of code executed immediately after RSM must be
 818   detected, and the appropriate hook must be selected.  Always clear the auto
 819   HALT restart flag if it is set.
 820
 821   @param[in] CpuIndex                 The processor index for the currently
 822                                       executing CPU.
 823   @param[in] CpuState                 Pointer to SMRAM Save State Map for the
 824                                       currently executing CPU.
 825   @param[in] NewInstructionPointer32  Instruction pointer to use if resuming to
 826                                       32-bit mode from 64-bit SMM.
 827   @param[in] NewInstructionPointer    Instruction pointer to use if resuming to
 828                                       same mode as SMM.
 829
 830   @retval The value of the original instruction pointer before it was hooked.
 831
 832 **/
 833 UINT64
 834 EFIAPI
 835 HookReturnFromSmm (
 836   IN UINTN              CpuIndex,
 837   SMRAM_SAVE_STATE_MAP  *CpuState,
 838   UINT64                NewInstructionPointer32,
 839   UINT64                NewInstructionPointer
 840   );
 841
 842 /**
 843   Get the size of the SMI Handler in bytes.
 844
 845   @retval The size, in bytes, of the SMI Handler.
 846
 847 **/
 848 UINTN
 849 EFIAPI
 850 GetSmiHandlerSize (
 851   VOID
 852   );
 853
 854 /**
 855   Install the SMI handler for the CPU specified by CpuIndex.  This function
 856   is called by the CPU that was elected as monarch during System Management
 857   Mode initialization.
 858
 859   @param[in] CpuIndex   The index of the CPU to install the custom SMI handler.
 860                         The value must be between 0 and the NumberOfCpus field
 861                         in the System Management System Table (SMST).
 862   @param[in] SmBase     The SMBASE address for the CPU specified by CpuIndex.
 863   @param[in] SmiStack   The stack to use when an SMI is processed by the
 864                         the CPU specified by CpuIndex.
 865   @param[in] StackSize  The size, in bytes, if the stack used when an SMI is
 866                         processed by the CPU specified by CpuIndex.
 867   @param[in] GdtBase    The base address of the GDT to use when an SMI is
 868                         processed by the CPU specified by CpuIndex.
 869   @param[in] GdtSize    The size, in bytes, of the GDT used when an SMI is
 870                         processed by the CPU specified by CpuIndex.
 871   @param[in] IdtBase    The base address of the IDT to use when an SMI is
 872                         processed by the CPU specified by CpuIndex.
 873   @param[in] IdtSize    The size, in bytes, of the IDT used when an SMI is
 874                         processed by the CPU specified by CpuIndex.
 875   @param[in] Cr3        The base address of the page tables to use when an SMI
 876                         is processed by the CPU specified by CpuIndex.
 877 **/
 878 VOID
 879 EFIAPI
 880 InstallSmiHandler (
 881   IN UINTN   CpuIndex,
 882   IN UINT32  SmBase,
 883   IN VOID    *SmiStack,
 884   IN UINTN   StackSize,
 885   IN UINTN   GdtBase,
 886   IN UINTN   GdtSize,
 887   IN UINTN   IdtBase,
 888   IN UINTN   IdtSize,
 889   IN UINT32  Cr3
 890   );
 891
 892 /**
 893   Search module name by input IP address and output it.
 894
 895   @param CallerIpAddress   Caller instruction pointer.
 896
 897 **/
 898 VOID
 899 DumpModuleInfoByIp (
 900   IN  UINTN              CallerIpAddress
 901   );
 902
 903 /**
 904   This function sets memory attribute according to MemoryAttributesTable.
 905 **/
 906 VOID
 907 SetMemMapAttributes (
 908   VOID
 909   );
 910
 911 /**
 912   This function sets UEFI memory attribute according to UEFI memory map.
 913 **/
 914 VOID
 915 SetUefiMemMapAttributes (
 916   VOID
 917   );
 918
 919 /**
 920   Return if the Address is forbidden as SMM communication buffer.
 921
 922   @param[in] Address the address to be checked
 923
 924   @return TRUE  The address is forbidden as SMM communication buffer.
 925   @return FALSE The address is allowed as SMM communication buffer.
 926 **/
 927 BOOLEAN
 928 IsSmmCommBufferForbiddenAddress (
 929   IN UINT64  Address
 930   );
 931
 932 /**
 933   This function caches the UEFI memory map information.
 934 **/
 935 VOID
 936 GetUefiMemoryMap (
 937   VOID
 938   );
 939
 940 /**
 941   This function sets memory attribute for page table.
 942 **/
 943 VOID
 944 SetPageTableAttributes (
 945   VOID
 946   );
 947
 948 /**
 949   Return page table base.
 950
 951   @return page table base.
 952 **/
 953 UINTN
 954 GetPageTableBase (
 955   VOID
 956   );
 957
 958 /**
 959   This function sets the attributes for the memory region specified by BaseAddress and
 960   Length from their current attributes to the attributes specified by Attributes.
 961
 962   @param[in]   BaseAddress      The physical address that is the start address of a memory region.
 963   @param[in]   Length           The size in bytes of the memory region.
 964   @param[in]   Attributes       The bit mask of attributes to set for the memory region.
 965   @param[out]  IsSplitted       TRUE means page table splitted. FALSE means page table not splitted.
 966
 967   @retval EFI_SUCCESS           The attributes were set for the memory region.
 968   @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by
 969                                 BaseAddress and Length cannot be modified.
 970   @retval EFI_INVALID_PARAMETER Length is zero.
 971                                 Attributes specified an illegal combination of attributes that
 972                                 cannot be set together.
 973   @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of
 974                                 the memory resource range.
 975   @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory
 976                                 resource range specified by BaseAddress and Length.
 977                                 The bit mask of attributes is not support for the memory resource
 978                                 range specified by BaseAddress and Length.
 979
 980 **/
 981 EFI_STATUS
 982 EFIAPI
 983 SmmSetMemoryAttributesEx (
 984   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
 985   IN  UINT64                                     Length,
 986   IN  UINT64                                     Attributes,
 987   OUT BOOLEAN                                    *IsSplitted  OPTIONAL
 988   );
 989
 990 /**
 991   This function clears the attributes for the memory region specified by BaseAddress and
 992   Length from their current attributes to the attributes specified by Attributes.
 993
 994   @param[in]   BaseAddress      The physical address that is the start address of a memory region.
 995   @param[in]   Length           The size in bytes of the memory region.
 996   @param[in]   Attributes       The bit mask of attributes to clear for the memory region.
 997   @param[out]  IsSplitted       TRUE means page table splitted. FALSE means page table not splitted.
 998
 999   @retval EFI_SUCCESS           The attributes were cleared for the memory region.
1000   @retval EFI_ACCESS_DENIED     The attributes for the memory resource range specified by
1001                                 BaseAddress and Length cannot be modified.
1002   @retval EFI_INVALID_PARAMETER Length is zero.
1003                                 Attributes specified an illegal combination of attributes that
1004                                 cannot be set together.
1005   @retval EFI_OUT_OF_RESOURCES  There are not enough system resources to modify the attributes of
1006                                 the memory resource range.
1007   @retval EFI_UNSUPPORTED       The processor does not support one or more bytes of the memory
1008                                 resource range specified by BaseAddress and Length.
1009                                 The bit mask of attributes is not support for the memory resource
1010                                 range specified by BaseAddress and Length.
1011
1012 **/
1013 EFI_STATUS
1014 EFIAPI
1015 SmmClearMemoryAttributesEx (
1016   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
1017   IN  UINT64                                     Length,
1018   IN  UINT64                                     Attributes,
1019   OUT BOOLEAN                                    *IsSplitted  OPTIONAL
1020   );
1021
1022 /**
1023   This API provides a way to allocate memory for page table.
1024
1025   This API can be called more once to allocate memory for page tables.
1026
1027   Allocates the number of 4KB pages of type EfiRuntimeServicesData and returns a pointer to the
1028   allocated buffer.  The buffer returned is aligned on a 4KB boundary.  If Pages is 0, then NULL
1029   is returned.  If there is not enough memory remaining to satisfy the request, then NULL is
1030   returned.
1031
1032   @param  Pages                 The number of 4 KB pages to allocate.
1033
1034   @return A pointer to the allocated buffer or NULL if allocation fails.
1035
1036 **/
1037 VOID *
1038 AllocatePageTableMemory (
1039   IN UINTN           Pages
1040   );
1041
1042 /**
1043   Allocate pages for code.
1044
1045   @param[in]  Pages Number of pages to be allocated.
1046
1047   @return Allocated memory.
1048 **/
1049 VOID *
1050 AllocateCodePages (
1051   IN UINTN           Pages
1052   );
1053
1054 /**
1055   Allocate aligned pages for code.
1056
1057   @param[in]  Pages                 Number of pages to be allocated.
1058   @param[in]  Alignment             The requested alignment of the allocation.
1059                                     Must be a power of two.
1060                                     If Alignment is zero, then byte alignment is used.
1061
1062   @return Allocated memory.
1063 **/
1064 VOID *
1065 AllocateAlignedCodePages (
1066   IN UINTN            Pages,
1067   IN UINTN            Alignment
1068   );
1069
1070
1071 //
1072 // S3 related global variable and function prototype.
1073 //
1074
1075 extern BOOLEAN                mSmmS3Flag;
1076
1077 /**
1078   Initialize SMM S3 resume state structure used during S3 Resume.
1079
1080   @param[in] Cr3    The base address of the page tables to use in SMM.
1081
1082 **/
1083 VOID
1084 InitSmmS3ResumeState (
1085   IN UINT32  Cr3
1086   );
1087
1088 /**
1089   Get ACPI CPU data.
1090
1091 **/
1092 VOID
1093 GetAcpiCpuData (
1094   VOID
1095   );
1096
1097 /**
1098   Restore SMM Configuration in S3 boot path.
1099
1100 **/
1101 VOID
1102 RestoreSmmConfigurationInS3 (
1103   VOID
1104   );
1105
1106 /**
1107   Get ACPI S3 enable flag.
1108
1109 **/
1110 VOID
1111 GetAcpiS3EnableFlag (
1112   VOID
1113   );
1114
1115 /**
1116   Transfer AP to safe hlt-loop after it finished restore CPU features on S3 patch.
1117
1118   @param[in] ApHltLoopCode          The address of the safe hlt-loop function.
1119   @param[in] TopOfStack             A pointer to the new stack to use for the ApHltLoopCode.
1120   @param[in] NumberToFinishAddress  Address of Semaphore of APs finish count.
1121
1122 **/
1123 VOID
1124 TransferApToSafeState (
1125   IN UINTN  ApHltLoopCode,
1126   IN UINTN  TopOfStack,
1127   IN UINTN  NumberToFinishAddress
1128   );
1129
1130 /**
1131   Set ShadowStack memory.
1132
1133   @param[in]  Cr3              The page table base address.
1134   @param[in]  BaseAddress      The physical address that is the start address of a memory region.
1135   @param[in]  Length           The size in bytes of the memory region.
1136
1137   @retval EFI_SUCCESS           The shadow stack memory is set.
1138 **/
1139 EFI_STATUS
1140 SetShadowStack (
1141   IN  UINTN                                      Cr3,
1142   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
1143   IN  UINT64                                     Length
1144   );
1145
1146 /**
1147   Set not present memory.
1148
1149   @param[in]  Cr3              The page table base address.
1150   @param[in]  BaseAddress      The physical address that is the start address of a memory region.
1151   @param[in]  Length           The size in bytes of the memory region.
1152
1153   @retval EFI_SUCCESS           The not present memory is set.
1154 **/
1155 EFI_STATUS
1156 SetNotPresentPage (
1157   IN  UINTN                                      Cr3,
1158   IN  EFI_PHYSICAL_ADDRESS                       BaseAddress,
1159   IN  UINT64                                     Length
1160   );
1161
1162 /**
1163   Initialize the shadow stack related data structure.
1164
1165   @param CpuIndex     The index of CPU.
1166   @param ShadowStack  The bottom of the shadow stack for this CPU.
1167 **/
1168 VOID
1169 InitShadowStack (
1170   IN UINTN  CpuIndex,
1171   IN VOID   *ShadowStack
1172   );
1173
1174 /**
1175   This function set given attributes of the memory region specified by
1176   BaseAddress and Length.
1177
1178   @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1179   @param  BaseAddress       The physical address that is the start address of
1180                             a memory region.
1181   @param  Length            The size in bytes of the memory region.
1182   @param  Attributes        The bit mask of attributes to set for the memory
1183                             region.
1184
1185   @retval EFI_SUCCESS           The attributes were set for the memory region.
1186   @retval EFI_INVALID_PARAMETER Length is zero.
1187                                 Attributes specified an illegal combination of
1188                                 attributes that cannot be set together.
1189   @retval EFI_UNSUPPORTED       The processor does not support one or more
1190                                 bytes of the memory resource range specified
1191                                 by BaseAddress and Length.
1192                                 The bit mask of attributes is not supported for
1193                                 the memory resource range specified by
1194                                 BaseAddress and Length.
1195
1196 **/
1197 EFI_STATUS
1198 EFIAPI
1199 EdkiiSmmSetMemoryAttributes (
1200   IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL   *This,
1201   IN  EFI_PHYSICAL_ADDRESS                  BaseAddress,
1202   IN  UINT64                                Length,
1203   IN  UINT64                                Attributes
1204   );
1205
1206 /**
1207   This function clears given attributes of the memory region specified by
1208   BaseAddress and Length.
1209
1210   @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1211   @param  BaseAddress       The physical address that is the start address of
1212                             a memory region.
1213   @param  Length            The size in bytes of the memory region.
1214   @param  Attributes        The bit mask of attributes to clear for the memory
1215                             region.
1216
1217   @retval EFI_SUCCESS           The attributes were cleared for the memory region.
1218   @retval EFI_INVALID_PARAMETER Length is zero.
1219                                 Attributes specified an illegal combination of
1220                                 attributes that cannot be cleared together.
1221   @retval EFI_UNSUPPORTED       The processor does not support one or more
1222                                 bytes of the memory resource range specified
1223                                 by BaseAddress and Length.
1224                                 The bit mask of attributes is not supported for
1225                                 the memory resource range specified by
1226                                 BaseAddress and Length.
1227
1228 **/
1229 EFI_STATUS
1230 EFIAPI
1231 EdkiiSmmClearMemoryAttributes (
1232   IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL   *This,
1233   IN  EFI_PHYSICAL_ADDRESS                  BaseAddress,
1234   IN  UINT64                                Length,
1235   IN  UINT64                                Attributes
1236   );
1237
1238 /**
1239   This function retrieves the attributes of the memory region specified by
1240   BaseAddress and Length. If different attributes are got from different part
1241   of the memory region, EFI_NO_MAPPING will be returned.
1242
1243   @param  This              The EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL instance.
1244   @param  BaseAddress       The physical address that is the start address of
1245                             a memory region.
1246   @param  Length            The size in bytes of the memory region.
1247   @param  Attributes        Pointer to attributes returned.
1248
1249   @retval EFI_SUCCESS           The attributes got for the memory region.
1250   @retval EFI_INVALID_PARAMETER Length is zero.
1251                                 Attributes is NULL.
1252   @retval EFI_NO_MAPPING        Attributes are not consistent cross the memory
1253                                 region.
1254   @retval EFI_UNSUPPORTED       The processor does not support one or more
1255                                 bytes of the memory resource range specified
1256                                 by BaseAddress and Length.
1257
1258 **/
1259 EFI_STATUS
1260 EFIAPI
1261 EdkiiSmmGetMemoryAttributes (
1262   IN  EDKII_SMM_MEMORY_ATTRIBUTE_PROTOCOL   *This,
1263   IN  EFI_PHYSICAL_ADDRESS                  BaseAddress,
1264   IN  UINT64                                Length,
1265   IN  UINT64                                *Attributes
1266   );
1267
1268 /**
1269   This function fixes up the address of the global variable or function
1270   referred in SmmInit assembly files to be the absoute address.
1271 **/
1272 VOID
1273 EFIAPI
1274 PiSmmCpuSmmInitFixupAddress (
1275  );
1276
1277 /**
1278   This function fixes up the address of the global variable or function
1279   referred in SmiEntry assembly files to be the absoute address.
1280 **/
1281 VOID
1282 EFIAPI
1283 PiSmmCpuSmiEntryFixupAddress (
1284  );
1285
1286 /**
1287   This function reads CR2 register when on-demand paging is enabled
1288   for 64 bit and no action for 32 bit.
1289
1290   @param[out]  *Cr2  Pointer to variable to hold CR2 register value.
1291 **/
1292 VOID
1293 SaveCr2 (
1294   OUT UINTN  *Cr2
1295   );
1296
1297 /**
1298   This function writes into CR2 register when on-demand paging is enabled
1299   for 64 bit and no action for 32 bit.
1300
1301   @param[in]  Cr2  Value to write into CR2 register.
1302 **/
1303 VOID
1304 RestoreCr2 (
1305   IN UINTN  Cr2
1306   );
1307
1308 /**
1309   Schedule a procedure to run on the specified CPU.
1310
1311   @param[in]       Procedure                The address of the procedure to run
1312   @param[in]       CpuIndex                 Target CPU Index
1313   @param[in,out]   ProcArguments            The parameter to pass to the procedure
1314   @param[in,out]   Token                    This is an optional parameter that allows the caller to execute the
1315                                             procedure in a blocking or non-blocking fashion. If it is NULL the
1316                                             call is blocking, and the call will not return until the AP has
1317                                             completed the procedure. If the token is not NULL, the call will
1318                                             return immediately. The caller can check whether the procedure has
1319                                             completed with CheckOnProcedure or WaitForProcedure.
1320   @param[in]       TimeoutInMicroseconds    Indicates the time limit in microseconds for the APs to finish
1321                                             execution of Procedure, either for blocking or non-blocking mode.
1322                                             Zero means infinity. If the timeout expires before all APs return
1323                                             from Procedure, then Procedure on the failed APs is terminated. If
1324                                             the timeout expires in blocking mode, the call returns EFI_TIMEOUT.
1325                                             If the timeout expires in non-blocking mode, the timeout determined
1326                                             can be through CheckOnProcedure or WaitForProcedure.
1327                                             Note that timeout support is optional. Whether an implementation
1328                                             supports this feature can be determined via the Attributes data
1329                                             member.
1330   @param[in,out]   CpuStatus                This optional pointer may be used to get the status code returned
1331                                             by Procedure when it completes execution on the target AP, or with
1332                                             EFI_TIMEOUT if the Procedure fails to complete within the optional
1333                                             timeout. The implementation will update this variable with
1334                                             EFI_NOT_READY prior to starting Procedure on the target AP.
1335
1336   @retval EFI_INVALID_PARAMETER    CpuNumber not valid
1337   @retval EFI_INVALID_PARAMETER    CpuNumber specifying BSP
1338   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber did not enter SMM
1339   @retval EFI_INVALID_PARAMETER    The AP specified by CpuNumber is busy
1340   @retval EFI_SUCCESS              The procedure has been successfully scheduled
1341
1342 **/
1343 EFI_STATUS
1344 InternalSmmStartupThisAp (
1345   IN      EFI_AP_PROCEDURE2              Procedure,
1346   IN      UINTN                          CpuIndex,
1347   IN OUT  VOID                           *ProcArguments OPTIONAL,
1348   IN OUT  MM_COMPLETION                  *Token,
1349   IN      UINTN                          TimeoutInMicroseconds,
1350   IN OUT  EFI_STATUS                     *CpuStatus
1351   );
1352
1353 /**
1354   Checks whether the input token is the current used token.
1355
1356   @param[in]  Token      This parameter describes the token that was passed into DispatchProcedure or
1357                          BroadcastProcedure.
1358
1359   @retval TRUE           The input token is the current used token.
1360   @retval FALSE          The input token is not the current used token.
1361 **/
1362 BOOLEAN
1363 IsTokenInUse (
1364   IN SPIN_LOCK           *Token
1365   );
1366
1367 /**
1368   Checks status of specified AP.
1369
1370   This function checks whether the specified AP has finished the task assigned
1371   by StartupThisAP(), and whether timeout expires.
1372
1373   @param[in]  Token             This parameter describes the token that was passed into DispatchProcedure or
1374                                 BroadcastProcedure.
1375
1376   @retval EFI_SUCCESS           Specified AP has finished task assigned by StartupThisAPs().
1377   @retval EFI_NOT_READY         Specified AP has not finished task and timeout has not expired.
1378 **/
1379 EFI_STATUS
1380 IsApReady (
1381   IN SPIN_LOCK  *Token
1382   );
1383
1384 /**
1385   Check whether it is an present AP.
1386
1387   @param   CpuIndex      The AP index which calls this function.
1388
1389   @retval  TRUE           It's a present AP.
1390   @retval  TRUE           This is not an AP or it is not present.
1391
1392 **/
1393 BOOLEAN
1394 IsPresentAp (
1395   IN UINTN        CpuIndex
1396   );
1397
1398 /**
1399   Worker function to execute a caller provided function on all enabled APs.
1400
1401   @param[in]     Procedure               A pointer to the function to be run on
1402                                          enabled APs of the system.
1403   @param[in]     TimeoutInMicroseconds   Indicates the time limit in microseconds for
1404                                          APs to return from Procedure, either for
1405                                          blocking or non-blocking mode.
1406   @param[in,out] ProcedureArguments      The parameter passed into Procedure for
1407                                          all APs.
1408   @param[in,out] Token                   This is an optional parameter that allows the caller to execute the
1409                                          procedure in a blocking or non-blocking fashion. If it is NULL the
1410                                          call is blocking, and the call will not return until the AP has
1411                                          completed the procedure. If the token is not NULL, the call will
1412                                          return immediately. The caller can check whether the procedure has
1413                                          completed with CheckOnProcedure or WaitForProcedure.
1414   @param[in,out] CPUStatus               This optional pointer may be used to get the status code returned
1415                                          by Procedure when it completes execution on the target AP, or with
1416                                          EFI_TIMEOUT if the Procedure fails to complete within the optional
1417                                          timeout. The implementation will update this variable with
1418                                          EFI_NOT_READY prior to starting Procedure on the target AP.
1419
1420   @retval EFI_SUCCESS             In blocking mode, all APs have finished before
1421                                   the timeout expired.
1422   @retval EFI_SUCCESS             In non-blocking mode, function has been dispatched
1423                                   to all enabled APs.
1424   @retval others                  Failed to Startup all APs.
1425
1426 **/
1427 EFI_STATUS
1428 InternalSmmStartupAllAPs (
1429   IN       EFI_AP_PROCEDURE2             Procedure,
1430   IN       UINTN                         TimeoutInMicroseconds,
1431   IN OUT   VOID                          *ProcedureArguments OPTIONAL,
1432   IN OUT   MM_COMPLETION                 *Token,
1433   IN OUT   EFI_STATUS                    *CPUStatus
1434   );
1435
1436 /**
1437
1438   Register the SMM Foundation entry point.
1439
1440   @param[in]      Procedure            A pointer to the code stream to be run on the designated target AP
1441                                        of the system. Type EFI_AP_PROCEDURE is defined below in Volume 2
1442                                        with the related definitions of
1443                                        EFI_MP_SERVICES_PROTOCOL.StartupAllAPs.
1444                                        If caller may pass a value of NULL to deregister any existing
1445                                        startup procedure.
1446   @param[in,out]  ProcedureArguments   Allows the caller to pass a list of parameters to the code that is
1447                                        run by the AP. It is an optional common mailbox between APs and
1448                                        the caller to share information
1449
1450   @retval EFI_SUCCESS                  The Procedure has been set successfully.
1451   @retval EFI_INVALID_PARAMETER        The Procedure is NULL but ProcedureArguments not NULL.
1452
1453 **/
1454 EFI_STATUS
1455 RegisterStartupProcedure (
1456   IN     EFI_AP_PROCEDURE    Procedure,
1457   IN OUT VOID                *ProcedureArguments OPTIONAL
1458   );
1459
1460 /**
1461   Allocate buffer for SpinLock and Wrapper function buffer.
1462
1463 **/
1464 VOID
1465 InitializeDataForMmMp (
1466   VOID
1467   );
1468
1469 /**
1470   Return whether access to non-SMRAM is restricted.
1471
1472   @retval TRUE  Access to non-SMRAM is restricted.
1473   @retval FALSE Access to non-SMRAM is not restricted.
1474 **/
1475 BOOLEAN
1476 IsRestrictedMemoryAccess (
1477   VOID
1478   );
1479
1480 #endif