[mirror_edk2.git] / UefiCpuPkg / CpuMpPei / PeiMpServices.c

/** @file\r
  Implementation of Multiple Processor PPI services.\r
\r
  Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "PeiMpServices.h"\r
\r
//\r
// CPU MP PPI to be installed\r
//\r
EFI_PEI_MP_SERVICES_PPI                mMpServicesPpi = {\r
  PeiGetNumberOfProcessors,\r
  PeiGetProcessorInfo,\r
  PeiStartupAllAPs,\r
  PeiStartupThisAP,\r
  PeiSwitchBSP,\r
  PeiEnableDisableAP,\r
  PeiWhoAmI,\r
};\r
\r
EFI_PEI_PPI_DESCRIPTOR           mPeiCpuMpPpiDesc = {\r
  (EFI_PEI_PPI_DESCRIPTOR_PPI | EFI_PEI_PPI_DESCRIPTOR_TERMINATE_LIST),\r
  &gEfiPeiMpServicesPpiGuid,\r
  &mMpServicesPpi\r
};\r
\r
/**\r
  Get CPU Package/Core/Thread location information.\r
\r
  @param InitialApicId     CPU APIC ID\r
  @param Location          Pointer to CPU location information\r
**/\r
VOID\r
ExtractProcessorLocation (\r
  IN  UINT32                     InitialApicId,\r
  OUT EFI_CPU_PHYSICAL_LOCATION  *Location\r
  )\r
{\r
  BOOLEAN  TopologyLeafSupported;\r
  UINTN    ThreadBits;\r
  UINTN    CoreBits;\r
  UINT32   RegEax;\r
  UINT32   RegEbx;\r
  UINT32   RegEcx;\r
  UINT32   RegEdx;\r
  UINT32   MaxCpuIdIndex;\r
  UINT32   SubIndex;\r
  UINTN    LevelType;\r
  UINT32   MaxLogicProcessorsPerPackage;\r
  UINT32   MaxCoresPerPackage;\r
\r
  //\r
  // Check if the processor is capable of supporting more than one logical processor.\r
  //\r
  AsmCpuid (CPUID_VERSION_INFO, NULL, NULL, NULL, &RegEdx);\r
  if ((RegEdx & BIT28) == 0) {\r
    Location->Thread  = 0;\r
    Location->Core    = 0;\r
    Location->Package = 0;\r
    return;\r
  }\r
\r
  ThreadBits = 0;\r
  CoreBits = 0;\r
\r
  //\r
  // Assume three-level mapping of APIC ID: Package:Core:SMT.\r
  //\r
\r
  TopologyLeafSupported = FALSE;\r
  //\r
  // Get the max index of basic CPUID\r
  //\r
  AsmCpuid (CPUID_SIGNATURE, &MaxCpuIdIndex, NULL, NULL, NULL);\r
\r
  //\r
  // If the extended topology enumeration leaf is available, it\r
  // is the preferred mechanism for enumerating topology.\r
  //\r
  if (MaxCpuIdIndex >= CPUID_EXTENDED_TOPOLOGY) {\r
    AsmCpuidEx (CPUID_EXTENDED_TOPOLOGY, 0, &RegEax, &RegEbx, &RegEcx, NULL);\r
    //\r
    // If CPUID.(EAX=0BH, ECX=0H):EBX returns zero and maximum input value for\r
    // basic CPUID information is greater than 0BH, then CPUID.0BH leaf is not\r
    // supported on that processor.\r
    //\r
    if (RegEbx != 0) {\r
      TopologyLeafSupported = TRUE;\r
\r
      //\r
      // Sub-leaf index 0 (ECX= 0 as input) provides enumeration parameters to extract\r
      // the SMT sub-field of x2APIC ID.\r
      //\r
      LevelType = (RegEcx >> 8) & 0xff;\r
      ASSERT (LevelType == CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_SMT);\r
      ThreadBits = RegEax & 0x1f;\r
\r
      //\r
      // Software must not assume any "level type" encoding\r
      // value to be related to any sub-leaf index, except sub-leaf 0.\r
      //\r
      SubIndex = 1;\r
      do {\r
        AsmCpuidEx (CPUID_EXTENDED_TOPOLOGY, SubIndex, &RegEax, NULL, &RegEcx, NULL);\r
        LevelType = (RegEcx >> 8) & 0xff;\r
        if (LevelType == CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_CORE) {\r
          CoreBits = (RegEax & 0x1f) - ThreadBits;\r
          break;\r
        }\r
        SubIndex++;\r
      } while (LevelType != CPUID_EXTENDED_TOPOLOGY_LEVEL_TYPE_INVALID);\r
    }\r
  }\r
\r
  if (!TopologyLeafSupported) {\r
    AsmCpuid (CPUID_VERSION_INFO, NULL, &RegEbx, NULL, NULL);\r
    MaxLogicProcessorsPerPackage = (RegEbx >> 16) & 0xff;\r
    if (MaxCpuIdIndex >= CPUID_CACHE_PARAMS) {\r
      AsmCpuidEx (CPUID_CACHE_PARAMS, 0, &RegEax, NULL, NULL, NULL);\r
      MaxCoresPerPackage = (RegEax >> 26) + 1;\r
    } else {\r
      //\r
      // Must be a single-core processor.\r
      //\r
      MaxCoresPerPackage = 1;\r
    }\r
\r
    ThreadBits = (UINTN) (HighBitSet32 (MaxLogicProcessorsPerPackage / MaxCoresPerPackage - 1) + 1);\r
    CoreBits = (UINTN) (HighBitSet32 (MaxCoresPerPackage - 1) + 1);\r
  }\r
\r
  Location->Thread  = InitialApicId & ~((-1) << ThreadBits);\r
  Location->Core    = (InitialApicId >> ThreadBits) & ~((-1) << CoreBits);\r
  Location->Package = (InitialApicId >> (ThreadBits + CoreBits));\r
}\r
\r
/**\r
  Find the current Processor number by APIC ID.\r
\r
  @param PeiCpuMpData        Pointer to PEI CPU MP Data\r
  @param ProcessorNumber     Return the pocessor number found\r
\r
  @retval EFI_SUCCESS        ProcessorNumber is found and returned.\r
  @retval EFI_NOT_FOUND      ProcessorNumber is not found.\r
**/\r
EFI_STATUS\r
GetProcessorNumber (\r
  IN PEI_CPU_MP_DATA         *PeiCpuMpData,\r
  OUT UINTN                  *ProcessorNumber\r
  )\r
{\r
  UINTN                   TotalProcessorNumber;\r
  UINTN                   Index;\r
\r
  TotalProcessorNumber = PeiCpuMpData->CpuCount;\r
  for (Index = 0; Index < TotalProcessorNumber; Index ++) {\r
    if (PeiCpuMpData->CpuData[Index].ApicId == GetInitialApicId ()) {\r
      *ProcessorNumber = Index;\r
      return EFI_SUCCESS;\r
    }\r
  }\r
  return EFI_NOT_FOUND;\r
}\r
\r
/**\r
  Worker function for SwitchBSP().\r
\r
  Worker function for SwitchBSP(), assigned to the AP which is intended to become BSP.\r
\r
  @param Buffer        Pointer to CPU MP Data\r
**/\r
VOID\r
EFIAPI\r
FutureBSPProc (\r
  IN  VOID                *Buffer\r
  )\r
{\r
  PEI_CPU_MP_DATA         *DataInHob;\r
\r
  DataInHob = (PEI_CPU_MP_DATA *) Buffer;\r
  AsmExchangeRole (&DataInHob->APInfo, &DataInHob->BSPInfo);\r
}\r
\r
/**\r
  This service retrieves the number of logical processor in the platform\r
  and the number of those logical processors that are enabled on this boot.\r
  This service may only be called from the BSP.\r
\r
  This function is used to retrieve the following information:\r
    - The number of logical processors that are present in the system.\r
    - The number of enabled logical processors in the system at the instant\r
      this call is made.\r
\r
  Because MP Service Ppi provides services to enable and disable processors\r
  dynamically, the number of enabled logical processors may vary during the\r
  course of a boot session.\r
\r
  If this service is called from an AP, then EFI_DEVICE_ERROR is returned.\r
  If NumberOfProcessors or NumberOfEnabledProcessors is NULL, then\r
  EFI_INVALID_PARAMETER is returned. Otherwise, the total number of processors\r
  is returned in NumberOfProcessors, the number of currently enabled processor\r
  is returned in NumberOfEnabledProcessors, and EFI_SUCCESS is returned.\r
\r
  @param[in]  PeiServices         An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in]  This                Pointer to this instance of the PPI.\r
  @param[out] NumberOfProcessors  Pointer to the total number of logical processors in\r
                                  the system, including the BSP and disabled APs.\r
  @param[out] NumberOfEnabledProcessors\r
                                  Number of processors in the system that are enabled.\r
\r
  @retval EFI_SUCCESS             The number of logical processors and enabled\r
                                  logical processors was retrieved.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_INVALID_PARAMETER   NumberOfProcessors is NULL.\r
                                  NumberOfEnabledProcessors is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetNumberOfProcessors (\r
  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI   *This,\r
  OUT UINTN                     *NumberOfProcessors,\r
  OUT UINTN                     *NumberOfEnabledProcessors\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   CallerNumber;\r
  UINTN                   ProcessorNumber;\r
  UINTN                   EnabledProcessorNumber;\r
  UINTN                   Index;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if ((NumberOfProcessors == NULL) || (NumberOfEnabledProcessors == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ProcessorNumber        = PeiCpuMpData->CpuCount;\r
  EnabledProcessorNumber = 0;\r
  for (Index = 0; Index < ProcessorNumber; Index++) {\r
    if (PeiCpuMpData->CpuData[Index].State != CpuStateDisabled) {\r
      EnabledProcessorNumber ++;\r
    }\r
  }\r
\r
  *NumberOfProcessors = ProcessorNumber;\r
  *NumberOfEnabledProcessors = EnabledProcessorNumber;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Gets detailed MP-related information on the requested processor at the\r
  instant this call is made. This service may only be called from the BSP.\r
\r
  This service retrieves detailed MP-related information about any processor\r
  on the platform. Note the following:\r
    - The processor information may change during the course of a boot session.\r
    - The information presented here is entirely MP related.\r
\r
  Information regarding the number of caches and their sizes, frequency of operation,\r
  slot numbers is all considered platform-related information and is not provided\r
  by this service.\r
\r
  @param[in]  PeiServices         An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in]  This                Pointer to this instance of the PPI.\r
  @param[in]  ProcessorNumber     Pointer to the total number of logical processors in\r
                                  the system, including the BSP and disabled APs.\r
  @param[out] ProcessorInfoBuffer Number of processors in the system that are enabled.\r
\r
  @retval EFI_SUCCESS             Processor information was returned.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_INVALID_PARAMETER   ProcessorInfoBuffer is NULL.\r
  @retval EFI_NOT_FOUND           The processor with the handle specified by\r
                                  ProcessorNumber does not exist in the platform.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiGetProcessorInfo (\r
  IN  CONST EFI_PEI_SERVICES     **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI    *This,\r
  IN  UINTN                      ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION  *ProcessorInfoBuffer\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   CallerNumber;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (ProcessorInfoBuffer == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (ProcessorNumber >= PeiCpuMpData->CpuCount) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  ProcessorInfoBuffer->ProcessorId = (UINT64) PeiCpuMpData->CpuData[ProcessorNumber].ApicId;\r
  ProcessorInfoBuffer->StatusFlag  = 0;\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].ApicId == GetInitialApicId()) {\r
    ProcessorInfoBuffer->StatusFlag |= PROCESSOR_AS_BSP_BIT;\r
  }\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].CpuHealthy) {\r
    ProcessorInfoBuffer->StatusFlag |= PROCESSOR_HEALTH_STATUS_BIT;\r
  }\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].State == CpuStateDisabled) {\r
    ProcessorInfoBuffer->StatusFlag &= ~PROCESSOR_ENABLED_BIT;\r
  } else {\r
    ProcessorInfoBuffer->StatusFlag |= PROCESSOR_ENABLED_BIT;\r
  }\r
\r
  //\r
  // Get processor location information\r
  //\r
  ExtractProcessorLocation (PeiCpuMpData->CpuData[ProcessorNumber].ApicId, &ProcessorInfoBuffer->Location);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This service executes a caller provided function on all enabled APs. APs can\r
  run either simultaneously or one at a time in sequence. This service supports\r
  both blocking requests only. This service may only\r
  be called from the BSP.\r
\r
  This function is used to dispatch all the enabled APs to the function specified\r
  by Procedure.  If any enabled AP is busy, then EFI_NOT_READY is returned\r
  immediately and Procedure is not started on any AP.\r
\r
  If SingleThread is TRUE, all the enabled APs execute the function specified by\r
  Procedure one by one, in ascending order of processor handle number. Otherwise,\r
  all the enabled APs execute the function specified by Procedure simultaneously.\r
\r
  If the timeout specified by TimeoutInMicroSeconds expires before all APs return\r
  from Procedure, then Procedure on the failed APs is terminated. All enabled APs\r
  are always available for further calls to EFI_PEI_MP_SERVICES_PPI.StartupAllAPs()\r
  and EFI_PEI_MP_SERVICES_PPI.StartupThisAP(). If FailedCpuList is not NULL, its\r
  content points to the list of processor handle numbers in which Procedure was\r
  terminated.\r
\r
  Note: It is the responsibility of the consumer of the EFI_PEI_MP_SERVICES_PPI.StartupAllAPs()\r
  to make sure that the nature of the code that is executed on the BSP and the\r
  dispatched APs is well controlled. The MP Services Ppi does not guarantee\r
  that the Procedure function is MP-safe. Hence, the tasks that can be run in\r
  parallel are limited to certain independent tasks and well-controlled exclusive\r
  code. PEI services and Ppis may not be called by APs unless otherwise\r
  specified.\r
\r
  In blocking execution mode, BSP waits until all APs finish or\r
  TimeoutInMicroSeconds expires.\r
\r
  @param[in] PeiServices          An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in] This                 A pointer to the EFI_PEI_MP_SERVICES_PPI instance.\r
  @param[in] Procedure            A pointer to the function to be run on enabled APs of\r
                                  the system.\r
  @param[in] SingleThread         If TRUE, then all the enabled APs execute the function\r
                                  specified by Procedure one by one, in ascending order\r
                                  of processor handle number. If FALSE, then all the\r
                                  enabled APs execute the function specified by Procedure\r
                                  simultaneously.\r
  @param[in] TimeoutInMicroSeconds\r
                                  Indicates the time limit in microseconds for APs to\r
                                  return from Procedure, for blocking mode only. Zero\r
                                  means infinity. If the timeout expires before all APs\r
                                  return from Procedure, then Procedure on the failed APs\r
                                  is terminated. All enabled APs are available for next\r
                                  function assigned by EFI_PEI_MP_SERVICES_PPI.StartupAllAPs()\r
                                  or EFI_PEI_MP_SERVICES_PPI.StartupThisAP(). If the\r
                                  timeout expires in blocking mode, BSP returns\r
                                  EFI_TIMEOUT.\r
  @param[in] ProcedureArgument    The parameter passed into Procedure for all APs.\r
\r
  @retval EFI_SUCCESS             In blocking mode, all APs have finished before the\r
                                  timeout expired.\r
  @retval EFI_DEVICE_ERROR        Caller processor is AP.\r
  @retval EFI_NOT_STARTED         No enabled APs exist in the system.\r
  @retval EFI_NOT_READY           Any enabled APs are busy.\r
  @retval EFI_TIMEOUT             In blocking mode, the timeout expired before all\r
                                  enabled APs have finished.\r
  @retval EFI_INVALID_PARAMETER   Procedure is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiStartupAllAPs (\r
  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI   *This,\r
  IN  EFI_AP_PROCEDURE          Procedure,\r
  IN  BOOLEAN                   SingleThread,\r
  IN  UINTN                     TimeoutInMicroSeconds,\r
  IN  VOID                      *ProcedureArgument      OPTIONAL\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   ProcessorNumber;\r
  UINTN                   Index;\r
  UINTN                   CallerNumber;\r
  BOOLEAN                 HasEnabledAp;\r
  BOOLEAN                 HasEnabledIdleAp;\r
  volatile UINT32         *FinishedCount;\r
  EFI_STATUS              Status;\r
  UINTN                   WaitCountIndex;\r
  UINTN                   WaitCountNumber;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (Procedure == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  ProcessorNumber = PeiCpuMpData->CpuCount;\r
\r
  HasEnabledAp     = FALSE;\r
  HasEnabledIdleAp = FALSE;\r
  for (Index = 0; Index < ProcessorNumber; Index ++) {\r
    if (Index == CallerNumber) {\r
      //\r
      // Skip BSP\r
      //\r
      continue;\r
    }\r
    if (PeiCpuMpData->CpuData[Index].State != CpuStateDisabled) {\r
      HasEnabledAp = TRUE;\r
      if (PeiCpuMpData->CpuData[Index].State != CpuStateBusy) {\r
        HasEnabledIdleAp = TRUE;\r
      }\r
    }\r
  }\r
  if (!HasEnabledAp) {\r
    //\r
    // If no enabled AP exists, return EFI_NOT_STARTED.\r
    //\r
    return EFI_NOT_STARTED;\r
  }\r
  if (!HasEnabledIdleAp) {\r
    //\r
    // If any enabled APs are busy, return EFI_NOT_READY.\r
    //\r
    return EFI_NOT_READY;\r
  }\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Backup original data and copy AP reset vector in it\r
    //\r
    BackupAndPrepareWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  WaitCountNumber = TimeoutInMicroSeconds / CPU_CHECK_AP_INTERVAL + 1;\r
  WaitCountIndex = 0;\r
  FinishedCount = &PeiCpuMpData->FinishedCount;\r
  if (!SingleThread) {\r
    WakeUpAP (PeiCpuMpData, TRUE, 0, Procedure, ProcedureArgument);\r
    //\r
    // Wait to finish\r
    //\r
    if (TimeoutInMicroSeconds == 0) {\r
      while (*FinishedCount < ProcessorNumber - 1) {\r
        CpuPause ();\r
      }\r
      Status = EFI_SUCCESS;\r
    } else {\r
      Status = EFI_TIMEOUT;\r
      for (WaitCountIndex = 0; WaitCountIndex < WaitCountNumber; WaitCountIndex++) {\r
        MicroSecondDelay (CPU_CHECK_AP_INTERVAL);\r
        if (*FinishedCount >= ProcessorNumber - 1) {\r
          Status = EFI_SUCCESS;\r
          break;\r
        }\r
      }\r
    }\r
  } else {\r
    Status = EFI_SUCCESS;\r
    for (Index = 0; Index < ProcessorNumber; Index++) {\r
      if (Index == CallerNumber) {\r
        continue;\r
      }\r
      WakeUpAP (PeiCpuMpData, FALSE, PeiCpuMpData->CpuData[Index].ApicId, Procedure, ProcedureArgument);\r
      //\r
      // Wait to finish\r
      //\r
      if (TimeoutInMicroSeconds == 0) {\r
        while (*FinishedCount < 1) {\r
          CpuPause ();\r
        }\r
      } else {\r
        for (WaitCountIndex = 0; WaitCountIndex < WaitCountNumber; WaitCountIndex++) {\r
          MicroSecondDelay (CPU_CHECK_AP_INTERVAL);\r
          if (*FinishedCount >= 1) {\r
            break;\r
          }\r
        }\r
        if (WaitCountIndex == WaitCountNumber) {\r
          Status = EFI_TIMEOUT;\r
        }\r
      }\r
    }\r
  }\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Restore original data\r
    //\r
    RestoreWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This service lets the caller get one enabled AP to execute a caller-provided\r
  function. The caller can request the BSP to wait for the completion\r
  of the AP. This service may only be called from the BSP.\r
\r
  This function is used to dispatch one enabled AP to the function specified by\r
  Procedure passing in the argument specified by ProcedureArgument.\r
  The execution is in blocking mode. The BSP waits until the AP finishes or\r
  TimeoutInMicroSecondss expires.\r
\r
  If the timeout specified by TimeoutInMicroseconds expires before the AP returns\r
  from Procedure, then execution of Procedure by the AP is terminated. The AP is\r
  available for subsequent calls to EFI_PEI_MP_SERVICES_PPI.StartupAllAPs() and\r
  EFI_PEI_MP_SERVICES_PPI.StartupThisAP().\r
\r
  @param[in] PeiServices          An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in] This                 A pointer to the EFI_PEI_MP_SERVICES_PPI instance.\r
  @param[in] Procedure            A pointer to the function to be run on enabled APs of\r
                                  the system.\r
  @param[in] ProcessorNumber      The handle number of the AP. The range is from 0 to the\r
                                  total number of logical processors minus 1. The total\r
                                  number of logical processors can be retrieved by\r
                                  EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().\r
  @param[in] TimeoutInMicroseconds\r
                                  Indicates the time limit in microseconds for APs to\r
                                  return from Procedure, for blocking mode only. Zero\r
                                  means infinity. If the timeout expires before all APs\r
                                  return from Procedure, then Procedure on the failed APs\r
                                  is terminated. All enabled APs are available for next\r
                                  function assigned by EFI_PEI_MP_SERVICES_PPI.StartupAllAPs()\r
                                  or EFI_PEI_MP_SERVICES_PPI.StartupThisAP(). If the\r
                                  timeout expires in blocking mode, BSP returns\r
                                  EFI_TIMEOUT.\r
  @param[in] ProcedureArgument    The parameter passed into Procedure for all APs.\r
\r
  @retval EFI_SUCCESS             In blocking mode, specified AP finished before the\r
                                  timeout expires.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_TIMEOUT             In blocking mode, the timeout expired before the\r
                                  specified AP has finished.\r
  @retval EFI_NOT_FOUND           The processor with the handle specified by\r
                                  ProcessorNumber does not exist.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber specifies the BSP or disabled AP.\r
  @retval EFI_INVALID_PARAMETER   Procedure is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiStartupThisAP (\r
  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI   *This,\r
  IN  EFI_AP_PROCEDURE          Procedure,\r
  IN  UINTN                     ProcessorNumber,\r
  IN  UINTN                     TimeoutInMicroseconds,\r
  IN  VOID                      *ProcedureArgument      OPTIONAL\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   CallerNumber;\r
  volatile UINT32         *FinishedCount;\r
  EFI_STATUS              Status;\r
  UINTN                   WaitCountIndex;\r
  UINTN                   WaitCountNumber;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (ProcessorNumber >= PeiCpuMpData->CpuCount) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (ProcessorNumber == PeiCpuMpData->BspNumber || Procedure == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check whether specified AP is disabled\r
  //\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].State == CpuStateDisabled) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Backup original data and copy AP reset vector in it\r
    //\r
    BackupAndPrepareWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  WaitCountNumber = TimeoutInMicroseconds / CPU_CHECK_AP_INTERVAL + 1;\r
  WaitCountIndex = 0;\r
  FinishedCount = &PeiCpuMpData->FinishedCount;\r
\r
  WakeUpAP (PeiCpuMpData, FALSE, PeiCpuMpData->CpuData[ProcessorNumber].ApicId, Procedure, ProcedureArgument);\r
\r
  //\r
  // Wait to finish\r
  //\r
  if (TimeoutInMicroseconds == 0) {\r
    while (*FinishedCount < 1) {\r
      CpuPause() ;\r
    }\r
    Status = EFI_SUCCESS;\r
  } else {\r
    Status = EFI_TIMEOUT;\r
    for (WaitCountIndex = 0; WaitCountIndex < WaitCountNumber; WaitCountIndex++) {\r
      MicroSecondDelay (CPU_CHECK_AP_INTERVAL);\r
      if (*FinishedCount >= 1) {\r
        Status = EFI_SUCCESS;\r
        break;\r
      }\r
    }\r
  }\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Backup original data and copy AP reset vector in it\r
    //\r
    RestoreWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  return Status;\r
}\r
\r
/**\r
  This service switches the requested AP to be the BSP from that point onward.\r
  This service changes the BSP for all purposes.   This call can only be performed\r
  by the current BSP.\r
\r
  This service switches the requested AP to be the BSP from that point onward.\r
  This service changes the BSP for all purposes. The new BSP can take over the\r
  execution of the old BSP and continue seamlessly from where the old one left\r
  off.\r
\r
  If the BSP cannot be switched prior to the return from this service, then\r
  EFI_UNSUPPORTED must be returned.\r
\r
  @param[in] PeiServices          An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in] This                 A pointer to the EFI_PEI_MP_SERVICES_PPI instance.\r
  @param[in] ProcessorNumber      The handle number of the AP. The range is from 0 to the\r
                                  total number of logical processors minus 1. The total\r
                                  number of logical processors can be retrieved by\r
                                  EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().\r
  @param[in] EnableOldBSP         If TRUE, then the old BSP will be listed as an enabled\r
                                  AP. Otherwise, it will be disabled.\r
\r
  @retval EFI_SUCCESS             BSP successfully switched.\r
  @retval EFI_UNSUPPORTED         Switching the BSP cannot be completed prior to this\r
                                  service returning.\r
  @retval EFI_UNSUPPORTED         Switching the BSP is not supported.\r
  @retval EFI_SUCCESS             The calling processor is an AP.\r
  @retval EFI_NOT_FOUND           The processor with the handle specified by\r
                                  ProcessorNumber does not exist.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber specifies the current BSP or a disabled\r
                                  AP.\r
  @retval EFI_NOT_READY           The specified AP is busy.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiSwitchBSP (\r
  IN  CONST EFI_PEI_SERVICES   **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI  *This,\r
  IN  UINTN                    ProcessorNumber,\r
  IN  BOOLEAN                  EnableOldBSP\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   CallerNumber;\r
  MSR_IA32_APIC_BASE      ApicBaseMsr;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_SUCCESS;\r
  }\r
\r
  if (ProcessorNumber >= PeiCpuMpData->CpuCount) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Check whether specified AP is disabled\r
  //\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].State == CpuStateDisabled) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check whether ProcessorNumber specifies the current BSP\r
  //\r
  if (ProcessorNumber == PeiCpuMpData->BspNumber) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check whether specified AP is busy\r
  //\r
  if (PeiCpuMpData->CpuData[ProcessorNumber].State == CpuStateBusy) {\r
    return EFI_NOT_READY;\r
  }\r
\r
  //\r
  // Clear the BSP bit of MSR_IA32_APIC_BASE\r
  //\r
  ApicBaseMsr.Uint64 = AsmReadMsr64 (MSR_IA32_APIC_BASE_ADDRESS);\r
  ApicBaseMsr.Bits.Bsp = 0;\r
  AsmWriteMsr64 (MSR_IA32_APIC_BASE_ADDRESS, ApicBaseMsr.Uint64);\r
\r
  PeiCpuMpData->BSPInfo.State = CPU_SWITCH_STATE_IDLE;\r
  PeiCpuMpData->APInfo.State  = CPU_SWITCH_STATE_IDLE;\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Backup original data and copy AP reset vector in it\r
    //\r
    BackupAndPrepareWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  //\r
  // Need to wakeUp AP (future BSP).\r
  //\r
  WakeUpAP (PeiCpuMpData, FALSE, PeiCpuMpData->CpuData[ProcessorNumber].ApicId, FutureBSPProc, PeiCpuMpData);\r
\r
  AsmExchangeRole (&PeiCpuMpData->BSPInfo, &PeiCpuMpData->APInfo);\r
\r
  if (PeiCpuMpData->EndOfPeiFlag) {\r
    //\r
    // Backup original data and copy AP reset vector in it\r
    //\r
    RestoreWakeupBuffer(PeiCpuMpData);\r
  }\r
\r
  //\r
  // Set the BSP bit of MSR_IA32_APIC_BASE on new BSP\r
  //\r
  ApicBaseMsr.Uint64 = AsmReadMsr64 (MSR_IA32_APIC_BASE_ADDRESS);\r
  ApicBaseMsr.Bits.Bsp = 1;\r
  AsmWriteMsr64 (MSR_IA32_APIC_BASE_ADDRESS, ApicBaseMsr.Uint64);\r
  //\r
  // Set old BSP enable state\r
  //\r
  if (!EnableOldBSP) {\r
    PeiCpuMpData->CpuData[PeiCpuMpData->BspNumber].State = CpuStateDisabled;\r
  }\r
  //\r
  // Save new BSP number\r
  //\r
  PeiCpuMpData->BspNumber = (UINT32) ProcessorNumber;\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This service lets the caller enable or disable an AP from this point onward.\r
  This service may only be called from the BSP.\r
\r
  This service allows the caller enable or disable an AP from this point onward.\r
  The caller can optionally specify the health status of the AP by Health. If\r
  an AP is being disabled, then the state of the disabled AP is implementation\r
  dependent. If an AP is enabled, then the implementation must guarantee that a\r
  complete initialization sequence is performed on the AP, so the AP is in a state\r
  that is compatible with an MP operating system.\r
\r
  If the enable or disable AP operation cannot be completed prior to the return\r
  from this service, then EFI_UNSUPPORTED must be returned.\r
\r
  @param[in] PeiServices          An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in] This                 A pointer to the EFI_PEI_MP_SERVICES_PPI instance.\r
  @param[in] ProcessorNumber      The handle number of the AP. The range is from 0 to the\r
                                  total number of logical processors minus 1. The total\r
                                  number of logical processors can be retrieved by\r
                                  EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().\r
  @param[in] EnableAP             Specifies the new state for the processor for enabled,\r
                                  FALSE for disabled.\r
  @param[in] HealthFlag           If not NULL, a pointer to a value that specifies the\r
                                  new health status of the AP. This flag corresponds to\r
                                  StatusFlag defined in EFI_PEI_MP_SERVICES_PPI.GetProcessorInfo().\r
                                  Only the PROCESSOR_HEALTH_STATUS_BIT is used. All other\r
                                  bits are ignored. If it is NULL, this parameter is\r
                                  ignored.\r
\r
  @retval EFI_SUCCESS             The specified AP was enabled or disabled successfully.\r
  @retval EFI_UNSUPPORTED         Enabling or disabling an AP cannot be completed prior\r
                                  to this service returning.\r
  @retval EFI_UNSUPPORTED         Enabling or disabling an AP is not supported.\r
  @retval EFI_DEVICE_ERROR        The calling processor is an AP.\r
  @retval EFI_NOT_FOUND           Processor with the handle specified by ProcessorNumber\r
                                  does not exist.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber specifies the BSP.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiEnableDisableAP (\r
  IN  CONST EFI_PEI_SERVICES    **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI   *This,\r
  IN  UINTN                     ProcessorNumber,\r
  IN  BOOLEAN                   EnableAP,\r
  IN  UINT32                    *HealthFlag OPTIONAL\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
  UINTN                   CallerNumber;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Check whether caller processor is BSP\r
  //\r
  PeiWhoAmI (PeiServices, This, &CallerNumber);\r
  if (CallerNumber != PeiCpuMpData->BspNumber) {\r
    return EFI_DEVICE_ERROR;\r
  }\r
\r
  if (ProcessorNumber == PeiCpuMpData->BspNumber) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (ProcessorNumber >= PeiCpuMpData->CpuCount) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (!EnableAP) {\r
    PeiCpuMpData->CpuData[ProcessorNumber].State = CpuStateDisabled;\r
  } else {\r
    PeiCpuMpData->CpuData[ProcessorNumber].State = CpuStateIdle;\r
  }\r
\r
  if (HealthFlag != NULL) {\r
    PeiCpuMpData->CpuData[ProcessorNumber].CpuHealthy =\r
          (BOOLEAN) ((*HealthFlag & PROCESSOR_HEALTH_STATUS_BIT) != 0);\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  This return the handle number for the calling processor.  This service may be\r
  called from the BSP and APs.\r
\r
  This service returns the processor handle number for the calling processor.\r
  The returned value is in the range from 0 to the total number of logical\r
  processors minus 1. The total number of logical processors can be retrieved\r
  with EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors(). This service may be\r
  called from the BSP and APs. If ProcessorNumber is NULL, then EFI_INVALID_PARAMETER\r
  is returned. Otherwise, the current processors handle number is returned in\r
  ProcessorNumber, and EFI_SUCCESS is returned.\r
\r
  @param[in]  PeiServices         An indirect pointer to the PEI Services Table\r
                                  published by the PEI Foundation.\r
  @param[in]  This                A pointer to the EFI_PEI_MP_SERVICES_PPI instance.\r
  @param[out] ProcessorNumber     The handle number of the AP. The range is from 0 to the\r
                                  total number of logical processors minus 1. The total\r
                                  number of logical processors can be retrieved by\r
                                  EFI_PEI_MP_SERVICES_PPI.GetNumberOfProcessors().\r
\r
  @retval EFI_SUCCESS             The current processor handle number was returned in\r
                                  ProcessorNumber.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber is NULL.\r
**/\r
EFI_STATUS\r
EFIAPI\r
PeiWhoAmI (\r
  IN  CONST EFI_PEI_SERVICES   **PeiServices,\r
  IN  EFI_PEI_MP_SERVICES_PPI  *This,\r
  OUT UINTN                    *ProcessorNumber\r
  )\r
{\r
  PEI_CPU_MP_DATA         *PeiCpuMpData;\r
\r
  PeiCpuMpData = GetMpHobData ();\r
  if (PeiCpuMpData == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  if (ProcessorNumber == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return GetProcessorNumber (PeiCpuMpData, ProcessorNumber);\r
}\r
\r