UefiCpuPkg/Test: Add unit tests for MP service PPI and Protocol

[mirror_edk2.git] / UefiCpuPkg / Test / UnitTest / EfiMpServicesPpiProtocol / EfiMpServiceProtocolUnitTest.c

/** @file\r
  PEI Module to test EfiMpServiceProtocol.\r
\r
  Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <PiDxe.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include "EfiMpServicesUnitTestCommom.h"\r
\r
#define UNIT_TEST_NAME     "EfiMpServiceProtocol Unit Test"\r
#define UNIT_TEST_VERSION  "0.1"\r
\r
/**\r
  Get EFI_MP_SERVICES_PROTOCOL pointer.\r
\r
  @param[out] MpServices    Pointer to the buffer where EFI_MP_SERVICES_PROTOCOL is stored\r
\r
  @retval EFI_SUCCESS       EFI_MP_SERVICES_PROTOCOL interface is returned\r
  @retval EFI_NOT_FOUND     EFI_MP_SERVICES_PROTOCOL interface is not found\r
**/\r
EFI_STATUS\r
MpServicesUnitTestGetMpServices (\r
  OUT MP_SERVICES  *MpServices\r
  )\r
{\r
  return gBS->LocateProtocol (&gEfiMpServiceProtocolGuid, NULL, (VOID **)&MpServices->Protocol);\r
}\r
\r
/**\r
  Retrieve the number of logical processor in the platform and the number of those logical processors that\r
  are enabled on this boot.\r
\r
  @param[in]  MpServices          MP_SERVICES structure.\r
  @param[out] NumberOfProcessors  Pointer to the total number of logical processors in the system, including\r
                                  the BSP and disabled APs.\r
  @param[out] NumberOfEnabledProcessors Pointer to the number of processors in the system that are enabled.\r
\r
  @retval EFI_SUCCESS       Retrieve the number of logical processor successfully\r
  @retval Others            Retrieve the number of logical processor unsuccessfully\r
**/\r
EFI_STATUS\r
MpServicesUnitTestGetNumberOfProcessors (\r
  IN MP_SERVICES  MpServices,\r
  OUT UINTN       *NumberOfProcessors,\r
  OUT UINTN       *NumberOfEnabledProcessors\r
  )\r
{\r
  return MpServices.Protocol->GetNumberOfProcessors (MpServices.Protocol, NumberOfProcessors, NumberOfEnabledProcessors);\r
}\r
\r
/**\r
  Get detailed information on the requested logical processor.\r
\r
  @param[in]  MpServices          MP_SERVICES structure.\r
  @param[in]  ProcessorNumber     The handle number of the processor.\r
  @param[out] ProcessorInfoBuffer Pointer to the buffer where the processor information is stored.\r
\r
  @retval EFI_SUCCESS       Get information on the requested logical processor successfully\r
  @retval Others            Get information on the requested logical processor unsuccessfully\r
**/\r
EFI_STATUS\r
MpServicesUnitTestGetProcessorInfo (\r
  IN MP_SERVICES                 MpServices,\r
  IN UINTN                       ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION  *ProcessorInfoBuffer\r
  )\r
{\r
  return MpServices.Protocol->GetProcessorInfo (MpServices.Protocol, ProcessorNumber, ProcessorInfoBuffer);\r
}\r
\r
/**\r
  Execute a caller provided function on all enabled APs.\r
\r
  @param[in]  MpServices    MP_SERVICES structure.\r
  @param[in]  Procedure     Pointer to the function to be run on enabled APs of the system.\r
  @param[in]  SingleThread  If TRUE, then all the enabled APs execute the function specified by Procedure\r
                            one by one, in ascending order of processor handle number.\r
                            If FALSE, then all the enabled APs execute the function specified by Procedure\r
                            simultaneously.\r
  @param[in]  TimeoutInMicroSeconds Indicates the time limit in microseconds for APs to return from Procedure,\r
                                    for blocking mode only. Zero means infinity.\r
  @param[in]  ProcedureArgument     The parameter passed into Procedure for all APs.\r
\r
  @retval EFI_SUCCESS       Execute a caller provided function on all enabled APs successfully\r
  @retval Others            Execute a caller provided function on all enabled APs unsuccessfully\r
**/\r
EFI_STATUS\r
MpServicesUnitTestStartupAllAPs (\r
  IN MP_SERVICES       MpServices,\r
  IN EFI_AP_PROCEDURE  Procedure,\r
  IN BOOLEAN           SingleThread,\r
  IN UINTN             TimeoutInMicroSeconds,\r
  IN VOID              *ProcedureArgument\r
  )\r
{\r
  return MpServices.Protocol->StartupAllAPs (MpServices.Protocol, Procedure, SingleThread, NULL, TimeoutInMicroSeconds, ProcedureArgument, NULL);\r
}\r
\r
/**\r
  Caller gets one enabled AP to execute a caller-provided function.\r
\r
  @param[in]  MpServices    MP_SERVICES structure.\r
  @param[in]  Procedure     Pointer to the function to be run on enabled APs of the system.\r
  @param[in]  ProcessorNumber       The handle number of the AP.\r
  @param[in]  TimeoutInMicroSeconds Indicates the time limit in microseconds for APs to return from Procedure,\r
                                    for blocking mode only. Zero means infinity.\r
  @param[in]  ProcedureArgument     The parameter passed into Procedure for all APs.\r
\r
\r
  @retval EFI_SUCCESS       Caller gets one enabled AP to execute a caller-provided function successfully\r
  @retval Others            Caller gets one enabled AP to execute a caller-provided function unsuccessfully\r
**/\r
EFI_STATUS\r
MpServicesUnitTestStartupThisAP (\r
  IN MP_SERVICES       MpServices,\r
  IN EFI_AP_PROCEDURE  Procedure,\r
  IN UINTN             ProcessorNumber,\r
  IN UINTN             TimeoutInMicroSeconds,\r
  IN VOID              *ProcedureArgument\r
  )\r
{\r
  return MpServices.Protocol->StartupThisAP (MpServices.Protocol, Procedure, ProcessorNumber, NULL, TimeoutInMicroSeconds, ProcedureArgument, NULL);\r
}\r
\r
/**\r
  Switch the requested AP to be the BSP from that point onward.\r
\r
  @param[in]  MpServices    MP_SERVICES structure.\r
  @param[in]  ProcessorNumber The handle number of AP that is to become the new BSP.\r
  @param[in]  EnableOldBSP  If TRUE, the old BSP will be listed as an enabled AP. Otherwise, it will be disabled.\r
\r
  @retval EFI_SUCCESS       Switch the requested AP to be the BSP successfully\r
  @retval Others            Switch the requested AP to be the BSP unsuccessfully\r
**/\r
EFI_STATUS\r
MpServicesUnitTestSwitchBSP (\r
  IN MP_SERVICES  MpServices,\r
  IN UINTN        ProcessorNumber,\r
  IN BOOLEAN      EnableOldBSP\r
  )\r
{\r
  return MpServices.Protocol->SwitchBSP (MpServices.Protocol, ProcessorNumber, EnableOldBSP);\r
}\r
\r
/**\r
  Caller enables or disables an AP from this point onward.\r
\r
  @param[in]  MpServices    MP_SERVICES structure.\r
  @param[in]  ProcessorNumber The handle number of the AP.\r
  @param[in]  EnableAP      Specifies the new state for the processor for enabled, FALSE for disabled.\r
  @param[in]  HealthFlag    If not NULL, a pointer to a value that specifies the new health status of the AP.\r
\r
  @retval EFI_SUCCESS       Caller enables or disables an AP successfully.\r
  @retval Others            Caller enables or disables an AP unsuccessfully.\r
**/\r
EFI_STATUS\r
MpServicesUnitTestEnableDisableAP (\r
  IN MP_SERVICES  MpServices,\r
  IN UINTN        ProcessorNumber,\r
  IN BOOLEAN      EnableAP,\r
  IN UINT32       *HealthFlag\r
  )\r
{\r
  return MpServices.Protocol->EnableDisableAP (MpServices.Protocol, ProcessorNumber, EnableAP, HealthFlag);\r
}\r
\r
/**\r
  Get the handle number for the calling processor.\r
\r
  @param[in]  MpServices    MP_SERVICES structure.\r
  @param[out] ProcessorNumber The handle number for the calling processor.\r
\r
  @retval EFI_SUCCESS       Get the handle number for the calling processor successfully.\r
  @retval Others            Get the handle number for the calling processor unsuccessfully.\r
**/\r
EFI_STATUS\r
MpServicesUnitTestWhoAmI (\r
  IN MP_SERVICES  MpServices,\r
  OUT UINTN       *ProcessorNumber\r
  )\r
{\r
  return MpServices.Protocol->WhoAmI (MpServices.Protocol, ProcessorNumber);\r
}\r
\r
/**\r
  Standard DXE driver or UEFI application entry point for unit test execution from DXE or UEFI Shell.\r
  Initialize the unit test framework, suite, and unit tests for the EfiMpServiceProtocol and run the unit test.\r
\r
  @param[in]  ImageHandle    The firmware allocated handle for the EFI image.\r
  @param[in]  SystemTable    A pointer to the EFI System Table.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
DxeEntryPoint (\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
  )\r
{\r
  EFI_STATUS                  Status;\r
  UNIT_TEST_FRAMEWORK_HANDLE  Framework;\r
  MP_SERVICE_UT_CONTEXT       Context;\r
\r
  Framework                = NULL;\r
  Context.MpServices.Ppi   = NULL;\r
  Context.CommonBuffer     = NULL;\r
  Context.DisabledApNumber = NULL;\r
\r
  DEBUG ((DEBUG_INFO, "%a v%a\n", UNIT_TEST_NAME, UNIT_TEST_VERSION));\r
\r
  //\r
  // Start setting up the test framework for running the tests.\r
  //\r
  Status = InitUnitTestFramework (&Framework, UNIT_TEST_NAME, gEfiCallerBaseName, UNIT_TEST_VERSION);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Failed in InitUnitTestFramework. Status = %r\n", Status));\r
    goto EXIT;\r
  }\r
\r
  //\r
  // Create test suite and unit tests for both EdkiiPeiMpServices2Ppi and EfiMpServiceProtocol.\r
  //\r
  Status = AddCommonTestCase (Framework, &Context);\r
  if (EFI_ERROR (Status)) {\r
    DEBUG ((DEBUG_ERROR, "Failed in AddCommonTestCase. Status = %r\n", Status));\r
    goto EXIT;\r
  }\r
\r
  //\r
  // Execute the tests.\r
  //\r
  Status = RunAllTestSuites (Framework);\r
\r
EXIT:\r
  if (Framework != NULL) {\r
    FreeUnitTestFramework (Framework);\r
  }\r
\r
  return Status;\r
}\r