UefiCpuPkg/CpuMpPei: Produce EDKII_PEI_MP_SERVICES2_PPI.

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

/** @file\r
  EDKII_PEI_MP_SERVICES2_PPI Implementation code.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "CpuMpPei.h"\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]  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
EdkiiPeiGetNumberOfProcessors (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI   *This,\r
  OUT UINTN                     *NumberOfProcessors,\r
  OUT UINTN                     *NumberOfEnabledProcessors\r
  )\r
{\r
  if ((NumberOfProcessors == NULL) || (NumberOfEnabledProcessors == NULL)) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  return MpInitLibGetNumberOfProcessors (\r
           NumberOfProcessors,\r
           NumberOfEnabledProcessors\r
           );\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]  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
EdkiiPeiGetProcessorInfo (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI    *This,\r
  IN  UINTN                         ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION     *ProcessorInfoBuffer\r
  )\r
{\r
  return MpInitLibGetProcessorInfo (ProcessorNumber, ProcessorInfoBuffer, NULL);\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 EDKII_PEI_MP_SERVICES2_PPI.StartupAllAPs()\r
  and EDKII_PEI_MP_SERVICES2_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 EDKII_PEI_MP_SERVICES2_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] This                 A pointer to the EDKII_PEI_MP_SERVICES2_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 EDKII_PEI_MP_SERVICES2_PPI.StartupAllAPs()\r
                                  or EDKII_PEI_MP_SERVICES2_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
EdkiiPeiStartupAllAPs (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI   *This,\r
  IN  EFI_AP_PROCEDURE             Procedure,\r
  IN  BOOLEAN                      SingleThread,\r
  IN  UINTN                        TimeoutInMicroSeconds,\r
  IN  VOID                         *ProcedureArgument      OPTIONAL\r
  )\r
{\r
  return MpInitLibStartupAllAPs (\r
           Procedure,\r
           SingleThread,\r
           NULL,\r
           TimeoutInMicroSeconds,\r
           ProcedureArgument,\r
           NULL\r
           );\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 EDKII_PEI_MP_SERVICES2_PPI.StartupAllAPs() and\r
  EDKII_PEI_MP_SERVICES2_PPI.StartupThisAP().\r
\r
  @param[in] This                 A pointer to the EDKII_PEI_MP_SERVICES2_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
                                  EDKII_PEI_MP_SERVICES2_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 EDKII_PEI_MP_SERVICES2_PPI.StartupAllAPs()\r
                                  or EDKII_PEI_MP_SERVICES2_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
EdkiiPeiStartupThisAP (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI   *This,\r
  IN  EFI_AP_PROCEDURE             Procedure,\r
  IN  UINTN                        ProcessorNumber,\r
  IN  UINTN                        TimeoutInMicroseconds,\r
  IN  VOID                         *ProcedureArgument      OPTIONAL\r
  )\r
{\r
  return MpInitLibStartupThisAP (\r
           Procedure,\r
           ProcessorNumber,\r
           NULL,\r
           TimeoutInMicroseconds,\r
           ProcedureArgument,\r
           NULL\r
           );\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] This                 A pointer to the EDKII_PEI_MP_SERVICES2_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
                                  EDKII_PEI_MP_SERVICES2_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_DEVICE_ERROR        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
EdkiiPeiSwitchBSP (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI  *This,\r
  IN  UINTN                       ProcessorNumber,\r
  IN  BOOLEAN                     EnableOldBSP\r
  )\r
{\r
  return MpInitLibSwitchBSP (ProcessorNumber, EnableOldBSP);\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] This                 A pointer to the EDKII_PEI_MP_SERVICES2_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
                                  EDKII_PEI_MP_SERVICES2_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 EDKII_PEI_MP_SERVICES2_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
EdkiiPeiEnableDisableAP (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI   *This,\r
  IN  UINTN                        ProcessorNumber,\r
  IN  BOOLEAN                      EnableAP,\r
  IN  UINT32                       *HealthFlag OPTIONAL\r
  )\r
{\r
  return MpInitLibEnableDisableAP (ProcessorNumber, EnableAP, HealthFlag);\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 EDKII_PEI_MP_SERVICES2_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]  This                A pointer to the EDKII_PEI_MP_SERVICES2_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
                                  EDKII_PEI_MP_SERVICES2_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
EdkiiPeiWhoAmI (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI  *This,\r
  OUT UINTN                       *ProcessorNumber\r
  )\r
{\r
  return MpInitLibWhoAmI (ProcessorNumber);\r
}\r
\r
/**\r
  This service executes a caller provided function on all enabled CPUs. CPUs can\r
  run either simultaneously or one at a time in sequence. This service may only\r
  be called from the BSP.\r
\r
  @param[in] This                 A pointer to the EDKII_PEI_MP_SERVICES2_PPI instance.\r
  @param[in] Procedure            A pointer to the function to be run on enabled APs of\r
                                  the system.\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 in blocking\r
                                  mode, BSP returns EFI_TIMEOUT.\r
  @param[in] ProcedureArgument    The parameter passed into Procedure for all CPUs.\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_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
EdkiiPeiStartupAllCPUs (\r
  IN  EDKII_PEI_MP_SERVICES2_PPI   *This,\r
  IN  EFI_AP_PROCEDURE             Procedure,\r
  IN  UINTN                        TimeoutInMicroSeconds,\r
  IN  VOID                         *ProcedureArgument      OPTIONAL\r
  )\r
{\r
  return MpInitLibStartupAllCPUs (\r
           Procedure,\r
           TimeoutInMicroSeconds,\r
           ProcedureArgument\r
           );\r
}\r
\r
//\r
// CPU MP2 PPI to be installed\r
//\r
EDKII_PEI_MP_SERVICES2_PPI            mMpServices2Ppi = {\r
  EdkiiPeiGetNumberOfProcessors,\r
  EdkiiPeiGetProcessorInfo,\r
  EdkiiPeiStartupAllAPs,\r
  EdkiiPeiStartupThisAP,\r
  EdkiiPeiSwitchBSP,\r
  EdkiiPeiEnableDisableAP,\r
  EdkiiPeiWhoAmI,\r
  EdkiiPeiStartupAllCPUs\r
};\r
\r