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   UINT32                         ApicId;
 118   EFI_HEALTH_FLAGS               Health;
 119   CPU_STATE                      State;
 120   BOOLEAN                        CpuHealthy;
 121 } PEI_CPU_DATA;
 122
 123 //
 124 // PEI CPU MP Data save in memory
 125 //
 126 struct _PEI_CPU_MP_DATA {
 127   SPIN_LOCK                      MpLock;
 128   UINT32                         CpuCount;
 129   UINT32                         BspNumber;
 130   UINTN                          Buffer;
 131   UINTN                          CpuApStackSize;
 132   MP_ASSEMBLY_ADDRESS_MAP        AddressMap;
 133   UINTN                          WakeupBuffer;
 134   UINTN                          BackupBuffer;
 135   UINTN                          BackupBufferSize;
 136   UINTN                          ApFunction;
 137   UINTN                          ApFunctionArgument;
 138   volatile UINT32                FinishedCount;
 139   BOOLEAN                        EndOfPeiFlag;
 140   BOOLEAN                        InitFlag;
 141   BOOLEAN                        X2ApicEnable;
 142   CPU_EXCHANGE_ROLE_INFO         BSPInfo;
 143   CPU_EXCHANGE_ROLE_INFO         APInfo;
 144   MTRR_SETTINGS                  MtrrTable;
 145   PEI_CPU_DATA                   *CpuData;
 146   volatile MP_CPU_EXCHANGE_INFO  *MpCpuExchangeInfo;
 147 };
 148 extern EFI_PEI_PPI_DESCRIPTOR   mPeiCpuMpPpiDesc;
 149
 150
 151 /**
 152   Assembly code to get starting address and size of the rendezvous entry for APs.
 153   Information for fixing a jump instruction in the code is also returned.
 154
 155   @param AddressMap  Output buffer for address map information.
 156 **/
 157 VOID
 158 EFIAPI
 159 AsmGetAddressMap (
 160   OUT MP_ASSEMBLY_ADDRESS_MAP    *AddressMap
 161   );
 162
 163 /**
 164   Assembly code to load GDT table and update segment accordingly.
 165
 166   @param Gdtr   Pointer to GDT descriptor
 167 **/
 168 VOID
 169 EFIAPI
 170 AsmInitializeGdt (
 171   IN IA32_DESCRIPTOR  *Gdtr
 172   );
 173
 174 /**
 175   Assembly code to do CLI-HALT loop.
 176
 177 **/
 178 VOID
 179 EFIAPI
 180 AsmCliHltLoop (
 181   VOID
 182   );
 183
 184 /**
 185   Get available system memory below 1MB by specified size.
 186
 187   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 188 **/
 189 VOID
 190 BackupAndPrepareWakeupBuffer(
 191   IN PEI_CPU_MP_DATA         *PeiCpuMpData
 192   );
 193
 194 /**
 195   Restore wakeup buffer data.
 196
 197   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 198 **/
 199 VOID
 200 RestoreWakeupBuffer(
 201   IN PEI_CPU_MP_DATA         *PeiCpuMpData
 202   );
 203
 204 /**
 205   Notify function on End Of Pei PPI.
 206
 207   On S3 boot, this function will restore wakeup buffer data.
 208   On normal boot, this function will flag wakeup buffer to be un-used type.
 209
 210   @param  PeiServices        The pointer to the PEI Services Table.
 211   @param  NotifyDescriptor   Address of the notification descriptor data structure.
 212   @param  Ppi                Address of the PPI that was installed.
 213
 214   @retval EFI_SUCCESS        When everything is OK.
 215
 216 **/
 217 EFI_STATUS
 218 EFIAPI
 219 CpuMpEndOfPeiCallback (
 220   IN      EFI_PEI_SERVICES        **PeiServices,
 221   IN EFI_PEI_NOTIFY_DESCRIPTOR    *NotifyDescriptor,
 222   IN VOID                         *Ppi
 223   );
 224
 225 /**
 226   This function will be called by BSP to wakeup AP.
 227
 228   @param PeiCpuMpData       Pointer to PEI CPU MP Data
 229   @param Broadcast          TRUE:  Send broadcast IPI to all APs
 230                             FALSE: Send IPI to AP by ApicId
 231   @param ApicId             Apic ID for the processor to be waked
 232   @param Procedure          The function to be invoked by AP
 233   @param ProcedureArgument  The argument to be passed into AP function
 234 **/
 235 VOID
 236 WakeUpAP (
 237   IN PEI_CPU_MP_DATA           *PeiCpuMpData,
 238   IN BOOLEAN                   Broadcast,
 239   IN UINT32                    ApicId,
 240   IN EFI_AP_PROCEDURE          Procedure,              OPTIONAL
 241   IN VOID                      *ProcedureArgument      OPTIONAL
 242   );
 243
 244 /**
 245   Get CPU MP Data pointer from the Guided HOB.
 246
 247   @return  Pointer to Pointer to PEI CPU MP Data
 248 **/
 249 PEI_CPU_MP_DATA *
 250 GetMpHobData (
 251   VOID
 252   );
 253
 254 /**
 255   Find the current Processor number by APIC ID.
 256
 257   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 258   @param ProcessorNumber     Return the pocessor number found
 259
 260   @retval EFI_SUCCESS        ProcessorNumber is found and returned.
 261   @retval EFI_NOT_FOUND      ProcessorNumber is not found.
 262 **/
 263 EFI_STATUS
 264 GetProcessorNumber (
 265   IN PEI_CPU_MP_DATA         *PeiCpuMpData,
 266   OUT UINTN                  *ProcessorNumber
 267   );
 268
 269 /**
 270   Collects BIST data from PPI.
 271
 272   This function collects BIST data from Sec Platform Information2 PPI
 273   or SEC Platform Information PPI.
 274
 275   @param PeiServices         Pointer to PEI Services Table
 276   @param PeiCpuMpData        Pointer to PEI CPU MP Data
 277
 278 **/
 279 VOID
 280 CollectBistDataFromPpi (
 281   IN CONST EFI_PEI_SERVICES             **PeiServices,
 282   IN PEI_CPU_MP_DATA                    *PeiCpuMpData
 283   );
 284
 285 /**
 286   Implementation of the PlatformInformation2 service in EFI_SEC_PLATFORM_INFORMATION2_PPI.
 287
 288   @param  PeiServices                The pointer to the PEI Services Table.
 289   @param  StructureSize              The pointer to the variable describing size of the input buffer.
 290   @param  PlatformInformationRecord2 The pointer to the EFI_SEC_PLATFORM_INFORMATION_RECORD2.
 291
 292   @retval EFI_SUCCESS                The data was successfully returned.
 293   @retval EFI_BUFFER_TOO_SMALL       The buffer was too small. The current buffer size needed to
 294                                      hold the record is returned in StructureSize.
 295
 296 **/
 297 EFI_STATUS
 298 EFIAPI
 299 SecPlatformInformation2 (
 300   IN CONST EFI_PEI_SERVICES                   **PeiServices,
 301   IN OUT UINT64                               *StructureSize,
 302      OUT EFI_SEC_PLATFORM_INFORMATION_RECORD2 *PlatformInformationRecord2
 303   );
 304
 305 #endif