UefiCpuPkg/CpuDxe: implement Mp Protocol:EnableDisableAP()

[mirror_edk2.git] / UefiCpuPkg / CpuDxe / CpuMp.h

/** @file\r
  CPU DXE MP support\r
\r
  Copyright (c) 2006 - 2014, 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
#ifndef _CPU_MP_H_\r
#define _CPU_MP_H_\r
\r
#include <Protocol/MpService.h>\r
#include <Library/SynchronizationLib.h>\r
\r
/**\r
  Initialize Multi-processor support.\r
\r
**/\r
VOID\r
InitializeMpSupport (\r
  VOID\r
  );\r
\r
typedef\r
VOID\r
(EFIAPI *STACKLESS_AP_ENTRY_POINT)(\r
  VOID\r
  );\r
\r
/**\r
  Starts the Application Processors and directs them to jump to the\r
  specified routine.\r
\r
  The processor jumps to this code in flat mode, but the processor's\r
  stack is not initialized.\r
\r
  @param ApEntryPoint    Pointer to the Entry Point routine\r
\r
  @retval EFI_SUCCESS           The APs were started\r
  @retval EFI_OUT_OF_RESOURCES  Cannot allocate memory to start APs\r
\r
**/\r
EFI_STATUS\r
StartApsStackless (\r
  IN STACKLESS_AP_ENTRY_POINT ApEntryPoint\r
  );\r
\r
/**\r
  The AP entry point that the Startup-IPI target code will jump to.\r
\r
  The processor jumps to this code in flat mode, but the processor's\r
  stack is not initialized.\r
\r
**/\r
VOID\r
EFIAPI\r
AsmApEntryPoint (\r
  VOID\r
  );\r
\r
/**\r
  Releases the lock preventing other APs from using the shared AP\r
  stack.\r
\r
  Once the AP has transitioned to using a new stack, it can call this\r
  function to allow another AP to proceed with using the shared stack.\r
\r
**/\r
VOID\r
EFIAPI\r
AsmApDoneWithCommonStack (\r
  VOID\r
  );\r
\r
typedef enum {\r
  CpuStateIdle,\r
  CpuStateBlocked,\r
  CpuStateReady,\r
  CpuStateBuzy,\r
  CpuStateFinished\r
} CPU_STATE;\r
\r
/**\r
  Define Individual Processor Data block.\r
\r
**/\r
typedef struct {\r
  EFI_PROCESSOR_INFORMATION      Info;\r
  SPIN_LOCK                      CpuDataLock;\r
  volatile CPU_STATE             State;\r
\r
  EFI_AP_PROCEDURE               Procedure;\r
  VOID                           *Parameter;\r
} CPU_DATA_BLOCK;\r
\r
/**\r
  Define MP data block which consumes individual processor block.\r
\r
**/\r
typedef struct {\r
  CPU_DATA_BLOCK              *CpuDatas;\r
  UINTN                       NumberOfProcessors;\r
  UINTN                       NumberOfEnabledProcessors;\r
} MP_SYSTEM_DATA;\r
\r
/**\r
  This function is called by all processors (both BSP and AP) once and collects MP related data.\r
\r
  @param Bsp             TRUE if the CPU is BSP\r
  @param ProcessorNumber The specific processor number\r
\r
  @retval EFI_SUCCESS    Data for the processor collected and filled in\r
\r
**/\r
EFI_STATUS\r
FillInProcessorInformation (\r
  IN     BOOLEAN              Bsp,\r
  IN     UINTN                ProcessorNumber\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 Protocol 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                        A pointer to the EFI_MP_SERVICES_PROTOCOL\r
                                          instance.\r
  @param[out] NumberOfProcessors          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
  @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
  @retval EFI_INVALID_PARAMETER   NumberOfEnabledProcessors is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
GetNumberOfProcessors (\r
  IN  EFI_MP_SERVICES_PROTOCOL  *This,\r
  OUT UINTN                     *NumberOfProcessors,\r
  OUT UINTN                     *NumberOfEnabledProcessors\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                  A pointer to the EFI_MP_SERVICES_PROTOCOL\r
                                    instance.\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
  @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
**/\r
EFI_STATUS\r
EFIAPI\r
GetProcessorInfo (\r
  IN  EFI_MP_SERVICES_PROTOCOL   *This,\r
  IN  UINTN                      ProcessorNumber,\r
  OUT EFI_PROCESSOR_INFORMATION  *ProcessorInfoBuffer\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. This service may not be supported\r
  after the UEFI Event EFI_EVENT_GROUP_READY_TO_BOOT is signaled.\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 EFI_MP_SERVICES_PROTOCOL instance.\r
  @param[in] ProcessorNumber   The handle number of AP that is to become the new\r
                               BSP. The range is from 0 to the total number of\r
                               logical processors minus 1. The total number of\r
                               logical processors can be retrieved by\r
                               EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
  @param[in] EnableAP          Specifies the new state for the processor for\r
                               enabled, FALSE for disabled.\r
  @param[in] HealthFlag        If not NULL, a pointer to a value that specifies\r
                               the new health status of the AP. This flag\r
                               corresponds to StatusFlag defined in\r
                               EFI_MP_SERVICES_PROTOCOL.GetProcessorInfo(). Only\r
                               the PROCESSOR_HEALTH_STATUS_BIT is used. All other\r
                               bits are ignored.  If it is NULL, this parameter\r
                               is 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\r
                                  prior 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
**/\r
EFI_STATUS\r
EFIAPI\r
EnableDisableAP (\r
  IN  EFI_MP_SERVICES_PROTOCOL  *This,\r
  IN  UINTN                     ProcessorNumber,\r
  IN  BOOLEAN                   EnableAP,\r
  IN  UINT32                    *HealthFlag OPTIONAL\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_MP_SERVICES_PROTOCOL.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 EFI_MP_SERVICES_PROTOCOL instance.\r
  @param[out] ProcessorNumber  The handle number of AP that is to become the new\r
                               BSP. The range is from 0 to the total number of\r
                               logical processors minus 1. The total number of\r
                               logical processors can be retrieved by\r
                               EFI_MP_SERVICES_PROTOCOL.GetNumberOfProcessors().\r
\r
  @retval EFI_SUCCESS             The current processor handle number was returned\r
                                  in ProcessorNumber.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
WhoAmI (\r
  IN EFI_MP_SERVICES_PROTOCOL  *This,\r
  OUT UINTN                    *ProcessorNumber\r
  );\r
\r
#endif // _CPU_MP_H_\r
\r