UefiCpuPkg/CpuMpPei/CpuMpPei.h

   1 /** @file
   2   Definitions to install Multiple Processor PPI.
   3
   4   Copyright (c) 2015, 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_MP_PEI_H_
  16 #define _CPU_MP_PEI_H_
  17
  18 #include <PiPei.h>
  19
  20 #include <Ppi/MpServices.h>
  21 #include <Ppi/SecPlatformInformation.h>
  22 #include <Ppi/SecPlatformInformation2.h>
  23 #include <Ppi/EndOfPeiPhase.h>
  24
  25 #include <Register/Cpuid.h>
  26 #include <Register/LocalApic.h>
  27
  28 #include <Library/BaseLib.h>
  29 #include <Library/BaseMemoryLib.h>
  30 #include <Library/DebugLib.h>
  31 #include <Library/HobLib.h>
  32 #include <Library/LocalApicLib.h>
  33 #include <Library/MtrrLib.h>
  34 #include <Library/PcdLib.h>
  35 #include <Library/PeimEntryPoint.h>
  36 #include <Library/PeiServicesLib.h>
  37 #include <Library/ReportStatusCodeLib.h>
  38 #include <Library/SynchronizationLib.h>
  39 #include <Library/TimerLib.h>
  40 #include <Library/UefiCpuLib.h>
  41
  42 #include "Microcode.h"
  43
  44 //
  45 // AP state
  46 //
  47 typedef enum {
  48   CpuStateIdle,
  49   CpuStateBusy,
  50   CpuStateDisabled
  51 } CPU_STATE;
  52
  53 //
  54 // AP reset code information
  55 //
  56 typedef struct {
  57   UINT8             *RendezvousFunnelAddress;
  58   UINTN             PModeEntryOffset;
  59   UINTN             LModeEntryOffset;
  60   UINTN             RendezvousFunnelSize;
  61 } MP_ASSEMBLY_ADDRESS_MAP;
  62
  63 //
  64 // CPU exchange information for switch BSP
  65 //
  66 typedef struct {
  67   UINT8             State;        // offset 0
  68   UINTN             StackPointer; // offset 4 / 8
  69   IA32_DESCRIPTOR   Gdtr;         // offset 8 / 16
  70   IA32_DESCRIPTOR   Idtr;         // offset 14 / 26
  71 } CPU_EXCHANGE_ROLE_INFO;
  72
  73 typedef struct _PEI_CPU_MP_DATA  PEI_CPU_MP_DATA;
  74
  75 #pragma pack()
  76
  77 typedef union {
  78   struct {
  79     UINT32  LimitLow    : 16;
  80     UINT32  BaseLow     : 16;
  81     UINT32  BaseMid     : 8;
  82     UINT32  Type        : 4;
  83     UINT32  System      : 1;
  84     UINT32  Dpl         : 2;
  85     UINT32  Present     : 1;
  86     UINT32  LimitHigh   : 4;
  87     UINT32  Software    : 1;
  88     UINT32  Reserved    : 1;
  89     UINT32  DefaultSize : 1;
  90     UINT32  Granularity : 1;
  91     UINT32  BaseHigh    : 8;
  92   } Bits;
  93   UINT64  Uint64;
  94 } IA32_GDT;
  95
  96 //
  97 // MP CPU exchange information for AP reset code
  98 //
  99 typedef struct {
 100   UINTN                 Lock;
 101   UINTN                 StackStart;
 102   UINTN                 StackSize;
 103   UINTN                 CFunction;
 104   IA32_DESCRIPTOR       GdtrProfile;
 105   IA32_DESCRIPTOR       IdtrProfile;
 106   UINTN                 BufferStart;
 107   UINTN                 PmodeOffset;
 108   UINTN                 NumApsExecuting;
 109   UINTN                 LmodeOffset;
 110   UINTN                 Cr3;
 111   PEI_CPU_MP_DATA       *PeiCpuMpData;
 112 } MP_CPU_EXCHANGE_INFO;
 113
 114 #pragma pack()
 115
 116 typedef struct {
 117   UINTN                          Cr0;
 118   UINTN                          Cr3;
 119   UINTN                          Cr4;
 120   UINTN                          Dr0;
 121   UINTN                          Dr1;
 122   UINTN                          Dr2;
 123   UINTN                          Dr3;
 124   UINTN                          Dr6;
 125   UINTN                          Dr7;
 126 } CPU_VOLATILE_REGISTERS;
 127
 128 typedef struct {
 129   UINT32                         ApicId;
 130   EFI_HEALTH_FLAGS               Health;
 131   CPU_STATE                      State;
 132   BOOLEAN                        CpuHealthy;
 133   CPU_VOLATILE_REGISTERS         VolatileRegisters;
 134 } PEI_CPU_DATA;
 135
 136 //
 137 // PEI CPU MP Data save in memory
 138 //
 139 struct _PEI_CPU_MP_DATA {
 140   SPIN_LOCK                      MpLock;
 141   UINT32                         CpuCount;
 142   UINT32                         BspNumber;
 143   UINTN                          Buffer;
 144   UINTN                          CpuApStackSize;
 145   MP_ASSEMBLY_ADDRESS_MAP        AddressMap;
 146   UINTN                          WakeupBuffer;
 147   UINTN                          BackupBuffer;
 148   UINTN                          BackupBufferSize;
 149   UINTN                          ApFunction;
 150   UINTN                          ApFunctionArgument;
 151   volatile UINT32                FinishedCount;
 152   BOOLEAN                        EndOfPeiFlag;
 153   BOOLEAN                        InitFlag;
 154   BOOLEAN                        X2ApicEnable;
 155   CPU_EXCHANGE_ROLE_INFO         BSPInfo;
 156   CPU_EXCHANGE_ROLE_INFO         APInfo;
 157   MTRR_SETTINGS                  MtrrTable;
 158   PEI_CPU_DATA                   *CpuData;
 159   volatile MP_CPU_EXCHANGE_INFO  *MpCpuExchangeInfo;
 160 };
 161 extern EFI_PEI_PPI_DESCRIPTOR   mPeiCpuMpPpiDesc;
 162
 163
 164 /**
 165   Assembly code to get starting address and size of the rendezvous entry for APs.
 166   Information for fixing a jump instruction in the code is also returned.
 167
 168   @param AddressMap  Output buffer for address map information.
 169 **/
 170 VOID
 171 EFIAPI
 172 AsmGetAddressMap (
 173   OUT MP_ASSEMBLY_ADDRESS_MAP    *AddressMap
 174   );
 175
 176 /**
 177   Assembly code to load GDT table and update segment accordingly.
 178
 179   @param Gdtr   Pointer to GDT descriptor
 180 **/
 181 VOID
 182 EFIAPI
 183 AsmInitializeGdt (
 184   IN IA32_DESCRIPTOR  *Gdtr
 185   );
 186
 187 /**
 188   Assembly code to do CLI-HALT loop.
 189
 190 **/
 191 VOID
 192 EFIAPI
 193 AsmCliHltLoop (
 194   VOID
 195   );
 196
 197 /**
 198   Get available system memory below 1MB by specified size.
 199
 200   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 201 **/
 202 VOID
 203 BackupAndPrepareWakeupBuffer(
 204   IN PEI_CPU_MP_DATA         *PeiCpuMpData
 205   );
 206
 207 /**
 208   Restore wakeup buffer data.
 209
 210   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 211 **/
 212 VOID
 213 RestoreWakeupBuffer(
 214   IN PEI_CPU_MP_DATA         *PeiCpuMpData
 215   );
 216
 217 /**
 218   Notify function on End Of Pei PPI.
 219
 220   On S3 boot, this function will restore wakeup buffer data.
 221   On normal boot, this function will flag wakeup buffer to be un-used type.
 222
 223   @param  PeiServices        The pointer to the PEI Services Table.
 224   @param  NotifyDescriptor   Address of the notification descriptor data structure.
 225   @param  Ppi                Address of the PPI that was installed.
 226
 227   @retval EFI_SUCCESS        When everything is OK.
 228
 229 **/
 230 EFI_STATUS
 231 EFIAPI
 232 CpuMpEndOfPeiCallback (
 233   IN      EFI_PEI_SERVICES        **PeiServices,
 234   IN EFI_PEI_NOTIFY_DESCRIPTOR    *NotifyDescriptor,
 235   IN VOID                         *Ppi
 236   );
 237
 238 /**
 239   This function will be called by BSP to wakeup AP.
 240
 241   @param PeiCpuMpData       Pointer to PEI CPU MP Data
 242   @param Broadcast          TRUE:  Send broadcast IPI to all APs
 243                             FALSE: Send IPI to AP by ApicId
 244   @param ApicId             Apic ID for the processor to be waked
 245   @param Procedure          The function to be invoked by AP
 246   @param ProcedureArgument  The argument to be passed into AP function
 247 **/
 248 VOID
 249 WakeUpAP (
 250   IN PEI_CPU_MP_DATA           *PeiCpuMpData,
 251   IN BOOLEAN                   Broadcast,
 252   IN UINT32                    ApicId,
 253   IN EFI_AP_PROCEDURE          Procedure,              OPTIONAL
 254   IN VOID                      *ProcedureArgument      OPTIONAL
 255   );
 256
 257 /**
 258   Get CPU MP Data pointer from the Guided HOB.
 259
 260   @return  Pointer to Pointer to PEI CPU MP Data
 261 **/
 262 PEI_CPU_MP_DATA *
 263 GetMpHobData (
 264   VOID
 265   );
 266
 267 /**
 268   Find the current Processor number by APIC ID.
 269
 270   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 271   @param ProcessorNumber     Return the pocessor number found
 272
 273   @retval EFI_SUCCESS        ProcessorNumber is found and returned.
 274   @retval EFI_NOT_FOUND      ProcessorNumber is not found.
 275 **/
 276 EFI_STATUS
 277 GetProcessorNumber (
 278   IN PEI_CPU_MP_DATA         *PeiCpuMpData,
 279   OUT UINTN                  *ProcessorNumber
 280   );
 281
 282 /**
 283   Collects BIST data from PPI.
 284
 285   This function collects BIST data from Sec Platform Information2 PPI
 286   or SEC Platform Information PPI.
 287
 288   @param PeiServices         Pointer to PEI Services Table
 289   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 290
 291 **/
 292 VOID
 293 CollectBistDataFromPpi (
 294   IN CONST EFI_PEI_SERVICES             **PeiServices,
 295   IN PEI_CPU_MP_DATA                    *PeiCpuMpData
 296   );
 297
 298 /**
 299   Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
 300
 301   @param  PeiServices                The pointer to the PEI Services Table.
 302   @param  StructureSize              The pointer to the variable describing size of the input buffer.
 303   @param  PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
 304
 305   @retval EFI_SUCCESS                The data was successfully returned.
 306   @retval EFI_BUFFER_TOO_SMALL       The buffer was too small. The current buffer size needed to
 307                                      hold the record is returned in StructureSize.
 308
 309 **/
 310 EFI_STATUS
 311 EFIAPI
 312 SecPlatformInformation2 (
 313   IN CONST EFI_PEI_SERVICES                   **PeiServices,
 314   IN OUT UINT64                               *StructureSize,
 315      OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2 *PlatformInformationRecord2
 316   );
 317
 318 #endif