UefiCpuPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / UefiCpuPkg / Library / RegisterCpuFeaturesLib / PeiRegisterCpuFeaturesLib.c

/** @file\r
  CPU Register Table Library functions.\r
\r
  Copyright (c) 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiPei.h>\r
\r
#include <Library/HobLib.h>\r
#include <Library/PeiServicesLib.h>\r
#include <Library/PeiServicesTablePointerLib.h>\r
#include <Ppi/MpServices.h>\r
#include "RegisterCpuFeatures.h"\r
\r
#define REGISTER_CPU_FEATURES_GUID \\r
  { \\r
    0xa694c467, 0x697a, 0x446b, { 0xb9, 0x29, 0x5b, 0x14, 0xa0, 0xcf, 0x39, 0xf } \\r
  }\r
\r
EFI_GUID mRegisterCpuFeaturesHobGuid = REGISTER_CPU_FEATURES_GUID;\r
\r
/**\r
  Worker function to get CPU_FEATURES_DATA pointer.\r
\r
  @return Pointer to CPU_FEATURES_DATA.\r
**/\r
CPU_FEATURES_DATA *\r
GetCpuFeaturesData (\r
  VOID\r
  )\r
{\r
  CPU_FEATURES_DATA       *CpuInitData;\r
  EFI_HOB_GUID_TYPE       *GuidHob;\r
  VOID                    *DataInHob;\r
  UINT64                  Data64;\r
\r
  CpuInitData = NULL;\r
  GuidHob = GetFirstGuidHob (&mRegisterCpuFeaturesHobGuid);\r
  if (GuidHob != NULL) {\r
    DataInHob = GET_GUID_HOB_DATA (GuidHob);\r
    CpuInitData = (CPU_FEATURES_DATA *) (*(UINTN *) DataInHob);\r
    ASSERT (CpuInitData != NULL);\r
  } else {\r
    CpuInitData = AllocateZeroPool (sizeof (CPU_FEATURES_DATA));\r
    ASSERT (CpuInitData != NULL);\r
    //\r
    // Build location of CPU MP DATA buffer in HOB\r
    //\r
    Data64 = (UINT64) (UINTN) CpuInitData;\r
    BuildGuidDataHob (\r
      &mRegisterCpuFeaturesHobGuid,\r
      (VOID *) &Data64,\r
      sizeof (UINT64)\r
      );\r
  }\r
\r
  return CpuInitData;\r
}\r
\r
/**\r
  Worker function to get MP PPI service pointer.\r
\r
  @return MP_SERVICES variable.\r
**/\r
MP_SERVICES\r
GetMpService (\r
  VOID\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  MP_SERVICES                MpService;\r
\r
  //\r
  // Get MP Services Protocol\r
  //\r
  Status = PeiServicesLocatePpi (\r
             &gEfiPeiMpServicesPpiGuid,\r
             0,\r
             NULL,\r
             (VOID **)&MpService.Ppi\r
             );\r
  ASSERT_EFI_ERROR (Status);\r
  return MpService;\r
}\r
\r
/**\r
  Worker function to return processor index.\r
\r
  @param  CpuFeaturesData    Cpu Feature Data structure.\r
\r
  @return  The processor index.\r
**/\r
UINTN\r
GetProcessorIndex (\r
  IN CPU_FEATURES_DATA        *CpuFeaturesData\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EFI_PEI_MP_SERVICES_PPI    *CpuMpPpi;\r
  UINTN                      ProcessorIndex;\r
\r
  CpuMpPpi = CpuFeaturesData->MpService.Ppi;\r
\r
  //\r
  // For two reasons which use NULL for WhoAmI:\r
  // 1. This function will be called by APs and AP should not use PeiServices Table\r
  // 2. Check WhoAmI implementation, this parameter will not be used.\r
  //\r
  Status = CpuMpPpi->WhoAmI(NULL, CpuMpPpi, &ProcessorIndex);\r
  ASSERT_EFI_ERROR (Status);\r
  return ProcessorIndex;\r
}\r
\r
/**\r
  Worker function to MP-related information on the requested processor at the\r
  instant this call is made.\r
\r
  @param[in]  ProcessorNumber       The handle number of processor.\r
  @param[out] ProcessorInfoBuffer   A pointer to the buffer where information for\r
                                    the requested processor is deposited.\r
\r
  @return Status of MpServices->GetProcessorInfo().\r
**/\r
EFI_STATUS\r
GetProcessorInformation (\r
  IN  UINTN                            ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION        *ProcessorInfoBuffer\r
  )\r
{\r
  EFI_PEI_MP_SERVICES_PPI    *CpuMpPpi;\r
  EFI_STATUS                 Status;\r
  CPU_FEATURES_DATA          *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  CpuMpPpi = CpuFeaturesData->MpService.Ppi;\r
\r
  Status = CpuMpPpi->GetProcessorInfo (\r
               GetPeiServicesTablePointer(),\r
               CpuMpPpi,\r
               ProcessorNumber,\r
               ProcessorInfoBuffer\r
               );\r
  return Status;\r
}\r
\r
/**\r
  Worker function to execute a caller provided function on all enabled APs.\r
\r
  @param[in]  Procedure               A pointer to the function to be run on\r
                                      enabled APs of the system.\r
  @param[in]  MpEvent                 The Event used to sync the result.\r
\r
**/\r
VOID\r
StartupAPsWorker (\r
  IN  EFI_AP_PROCEDURE                 Procedure,\r
  IN  EFI_EVENT                        MpEvent\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  EFI_PEI_MP_SERVICES_PPI              *CpuMpPpi;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  CpuMpPpi = CpuFeaturesData->MpService.Ppi;\r
\r
  //\r
  // Wakeup all APs for data collection.\r
  //\r
  Status = CpuMpPpi->StartupAllAPs (\r
                 GetPeiServicesTablePointer (),\r
                 CpuMpPpi,\r
                 Procedure,\r
                 FALSE,\r
                 0,\r
                 CpuFeaturesData\r
                 );\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  Worker function to switch the requested AP to be the BSP from that point onward.\r
\r
  @param[in] ProcessorNumber   The handle number of AP that is to become the new BSP.\r
**/\r
VOID\r
SwitchNewBsp (\r
  IN  UINTN                            ProcessorNumber\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  EFI_PEI_MP_SERVICES_PPI              *CpuMpPpi;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  CpuMpPpi = CpuFeaturesData->MpService.Ppi;\r
\r
  //\r
  // Wakeup all APs for data collection.\r
  //\r
  Status = CpuMpPpi->SwitchBSP (\r
                 GetPeiServicesTablePointer (),\r
                 CpuMpPpi,\r
                 ProcessorNumber,\r
                 TRUE\r
                 );\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  Worker function to retrieve the number of logical processor in the platform.\r
\r
  @param[out] NumberOfCpus                Pointer to the total number of logical\r
                                          processors in the system, including the BSP\r
                                          and disabled APs.\r
  @param[out] NumberOfEnabledProcessors   Pointer to the number of enabled logical\r
                                          processors that exist in system, including\r
                                          the BSP.\r
**/\r
VOID\r
GetNumberOfProcessor (\r
  OUT UINTN                            *NumberOfCpus,\r
  OUT UINTN                            *NumberOfEnabledProcessors\r
  )\r
{\r
  EFI_STATUS                 Status;\r
  EFI_PEI_MP_SERVICES_PPI    *CpuMpPpi;\r
  CPU_FEATURES_DATA          *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  CpuMpPpi = CpuFeaturesData->MpService.Ppi;\r
\r
  //\r
  // Get the number of CPUs\r
  //\r
  Status = CpuMpPpi->GetNumberOfProcessors (\r
                         GetPeiServicesTablePointer (),\r
                         CpuMpPpi,\r
                         NumberOfCpus,\r
                         NumberOfEnabledProcessors\r
                         );\r
  ASSERT_EFI_ERROR (Status);\r
}\r
\r
/**\r
  Performs CPU features Initialization.\r
\r
  This service will invoke MP service to perform CPU features\r
  initialization on BSP/APs per user configuration.\r
\r
  @note This service could be called by BSP only.\r
**/\r
VOID\r
EFIAPI\r
CpuFeaturesInitialize (\r
  VOID\r
  )\r
{\r
  CPU_FEATURES_DATA          *CpuFeaturesData;\r
  UINTN                      OldBspNumber;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
\r
  OldBspNumber = GetProcessorIndex (CpuFeaturesData);\r
  CpuFeaturesData->BspNumber = OldBspNumber;\r
\r
  //\r
  // Known limitation: In PEI phase, CpuFeatures driver not\r
  // support async mode execute tasks. So semaphore type\r
  // register can't been used for this instance, must use\r
  // DXE type instance.\r
  //\r
\r
  //\r
  // Wakeup all APs for programming.\r
  //\r
  StartupAPsWorker (SetProcessorRegister, NULL);\r
  //\r
  // Programming BSP\r
  //\r
  SetProcessorRegister (CpuFeaturesData);\r
\r
  //\r
  // Switch to new BSP if required\r
  //\r
  if (CpuFeaturesData->BspNumber != OldBspNumber) {\r
    SwitchNewBsp (CpuFeaturesData->BspNumber);\r
  }\r
}\r
\r