UefiCpuPkg: Move AsmRelocateApLoopStart from Mpfuncs.nasm to AmdSev.nasm

[mirror_edk2.git] / UefiCpuPkg / PiSmmCpuDxeSmm / CpuService.h

/** @file\r
Include file for SMM CPU Services protocol implementation.\r
\r
Copyright (c) 2011 - 2015, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _CPU_SERVICE_H_\r
#define _CPU_SERVICE_H_\r
\r
typedef enum {\r
  SmmCpuNone,\r
  SmmCpuAdd,\r
  SmmCpuRemove,\r
  SmmCpuSwitchBsp\r
} SMM_CPU_OPERATION;\r
\r
//\r
// SMM CPU Service Protocol function prototypes.\r
//\r
\r
/**\r
  Gets processor information on the requested processor at the instant this call is made.\r
\r
  @param[in]  This                 A pointer to the EFI_SMM_CPU_SERVICE_PROTOCOL 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_INVALID_PARAMETER   ProcessorInfoBuffer is NULL.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber is invalid.\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
SmmGetProcessorInfo (\r
  IN CONST EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  IN       UINTN                         ProcessorNumber,\r
  OUT      EFI_PROCESSOR_INFORMATION     *ProcessorInfoBuffer\r
  );\r
\r
/**\r
  This service switches the requested AP to be the BSP since the next SMI.\r
\r
  @param[in] This             A pointer to the EFI_SMM_CPU_SERVICE_PROTOCOL instance.\r
  @param[in] ProcessorNumber  The handle number of AP that is to become the new BSP.\r
\r
  @retval EFI_SUCCESS             BSP will be switched in next SMI.\r
  @retval EFI_UNSUPPORTED         Switching the BSP or a processor to be hot-removed is not supported.\r
  @retval EFI_NOT_FOUND           The processor with the handle specified by ProcessorNumber does not exist.\r
  @retval EFI_INVALID_PARAMETER   ProcessorNumber is invalid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmSwitchBsp (\r
  IN CONST EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  IN       UINTN                         ProcessorNumber\r
  );\r
\r
/**\r
  Notify that a processor was hot-added.\r
\r
  @param[in] This                A pointer to the EFI_SMM_CPU_SERVICE_PROTOCOL instance.\r
  @param[in] ProcessorId         Local APIC ID of the hot-added processor.\r
  @param[out] ProcessorNumber    The handle number of the hot-added processor.\r
\r
  @retval EFI_SUCCESS            The hot-addition of the specified processors was successfully notified.\r
  @retval EFI_UNSUPPORTED        Hot addition of processor is not supported.\r
  @retval EFI_NOT_FOUND          The processor with the handle specified by ProcessorNumber does not exist.\r
  @retval EFI_INVALID_PARAMETER  ProcessorNumber is invalid.\r
  @retval EFI_ALREADY_STARTED    The processor is already online in the system.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmAddProcessor (\r
  IN CONST EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  IN       UINT64                        ProcessorId,\r
  OUT      UINTN                         *ProcessorNumber\r
  );\r
\r
/**\r
  Notify that a processor was hot-removed.\r
\r
  @param[in] This                A pointer to the EFI_SMM_CPU_SERVICE_PROTOCOL instance.\r
  @param[in] ProcessorNumber     The handle number of the hot-added processor.\r
\r
  @retval EFI_SUCCESS            The hot-removal of the specified processors was successfully notified.\r
  @retval EFI_UNSUPPORTED        Hot removal of processor is not supported.\r
  @retval EFI_UNSUPPORTED        Hot removal of BSP is not supported.\r
  @retval EFI_UNSUPPORTED        Hot removal of a processor with pending hot-plug operation is not supported.\r
  @retval EFI_INVALID_PARAMETER  ProcessorNumber is invalid.\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmRemoveProcessor (\r
  IN CONST EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  IN       UINTN                         ProcessorNumber\r
  );\r
\r
/**\r
  This return the handle number for the calling processor.\r
\r
  @param[in] This                 A pointer to the EFI_SMM_CPU_SERVICE_PROTOCOL instance.\r
  @param[out] ProcessorNumber      The handle number of currently executing processor.\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
SmmWhoAmI (\r
  IN CONST EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  OUT      UINTN                         *ProcessorNumber\r
  );\r
\r
/**\r
  Register exception handler.\r
\r
  @param  This                  A pointer to the SMM_CPU_SERVICE_PROTOCOL instance.\r
  @param  ExceptionType         Defines which interrupt or exception to hook. Type EFI_EXCEPTION_TYPE and\r
                                the valid values for this parameter are defined in EFI_DEBUG_SUPPORT_PROTOCOL\r
                                of the UEFI 2.0 specification.\r
  @param  InterruptHandler      A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER\r
                                that is called when a processor interrupt occurs.\r
                                If this parameter is NULL, then the handler will be uninstalled.\r
\r
  @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.\r
  @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was previously installed.\r
  @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not previously installed.\r
  @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmRegisterExceptionHandler (\r
  IN EFI_SMM_CPU_SERVICE_PROTOCOL  *This,\r
  IN EFI_EXCEPTION_TYPE            ExceptionType,\r
  IN EFI_CPU_INTERRUPT_HANDLER     InterruptHandler\r
  );\r
\r
//\r
// Internal function prototypes\r
//\r
\r
/**\r
  Update the SMM CPU list per the pending operation.\r
\r
  This function is called after return from SMI handlers.\r
**/\r
VOID\r
SmmCpuUpdate (\r
  VOID\r
  );\r
\r
/**\r
  Initialize SMM CPU Services.\r
\r
  It installs EFI SMM CPU Services Protocol.\r
\r
  @param ImageHandle The firmware allocated handle for the EFI image.\r
\r
  @retval EFI_SUCCESS    EFI SMM CPU Services Protocol was installed successfully.\r
**/\r
EFI_STATUS\r
InitializeSmmCpuServices (\r
  IN EFI_HANDLE  Handle\r
  );\r
\r
#endif\r