UefiCpuPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  CPU Register Table Library functions.\r
\r
  Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include "RegisterCpuFeatures.h"\r
\r
CPU_FEATURES_DATA          mCpuFeaturesData = {0};\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
  return &mCpuFeaturesData;\r
}\r
\r
/**\r
  Worker function to get EFI_MP_SERVICES_PROTOCOL 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 = gBS->LocateProtocol (\r
                &gEfiMpServiceProtocolGuid,\r
                NULL,\r
                (VOID **)&MpService.Protocol\r
                );\r
  ASSERT_EFI_ERROR (Status);\r
\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
  UINTN                                ProcessorIndex;\r
  EFI_MP_SERVICES_PROTOCOL             *MpServices;\r
\r
  MpServices = CpuFeaturesData->MpService.Protocol;\r
  Status = MpServices->WhoAmI(MpServices, &ProcessorIndex);\r
  ASSERT_EFI_ERROR (Status);\r
  return ProcessorIndex;\r
}\r
\r
/**\r
  Gets detailed 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_STATUS                           Status;\r
  EFI_MP_SERVICES_PROTOCOL             *MpServices;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  MpServices = CpuFeaturesData->MpService.Protocol;\r
\r
  Status = MpServices->GetProcessorInfo (\r
               MpServices,\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                 A pointer to the event to be used later\r
                                      to check whether procedure has done.\r
**/\r
VOID\r
StartupAPsWorker (\r
  IN  EFI_AP_PROCEDURE                 Procedure,\r
  IN  EFI_EVENT                        MpEvent\r
  )\r
{\r
  EFI_STATUS                           Status;\r
  EFI_MP_SERVICES_PROTOCOL             *MpServices;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  MpServices = CpuFeaturesData->MpService.Protocol;\r
\r
  //\r
  // Wakeup all APs\r
  //\r
  Status = MpServices->StartupAllAPs (\r
                 MpServices,\r
                 Procedure,\r
                 FALSE,\r
                 MpEvent,\r
                 0,\r
                 CpuFeaturesData,\r
                 NULL\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_MP_SERVICES_PROTOCOL             *MpServices;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  MpServices = CpuFeaturesData->MpService.Protocol;\r
\r
  //\r
  // Wakeup all APs\r
  //\r
  Status = MpServices->SwitchBSP (\r
                 MpServices,\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_MP_SERVICES_PROTOCOL             *MpServices;\r
  CPU_FEATURES_DATA                    *CpuFeaturesData;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
  MpServices = CpuFeaturesData->MpService.Protocol;\r
\r
  //\r
  // Get the number of CPUs\r
  //\r
  Status = MpServices->GetNumberOfProcessors (\r
                         MpServices,\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
  EFI_EVENT                  MpEvent;\r
  EFI_STATUS                 Status;\r
\r
  CpuFeaturesData = GetCpuFeaturesData ();\r
\r
  OldBspNumber = GetProcessorIndex (CpuFeaturesData);\r
  CpuFeaturesData->BspNumber = OldBspNumber;\r
\r
  Status = gBS->CreateEvent (\r
                  EVT_NOTIFY_WAIT,\r
                  TPL_CALLBACK,\r
                  EfiEventEmptyFunction,\r
                  NULL,\r
                  &MpEvent\r
                  );\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Wakeup all APs for programming.\r
  //\r
  StartupAPsWorker (SetProcessorRegister, MpEvent);\r
  //\r
  // Programming BSP\r
  //\r
  SetProcessorRegister (CpuFeaturesData);\r
\r
  //\r
  // Wait all processors to finish the task.\r
  //\r
  do {\r
    Status = gBS->CheckEvent (MpEvent);\r
  } while (Status == EFI_NOT_READY);\r
  ASSERT_EFI_ERROR (Status);\r
\r
  //\r
  // Switch to new BSP if required\r
  //\r
  if (CpuFeaturesData->BspNumber != OldBspNumber) {\r
    SwitchNewBsp (CpuFeaturesData->BspNumber);\r
  }\r
}\r
\r