UefiCpuPkg/CpuDxe/CpuMp.h

   1 /** @file
   2   CPU DXE MP support
   3
   4   Copyright (c) 2006 - 2014, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef _CPU_MP_H_
  16 #define _CPU_MP_H_
  17
  18 #include <Protocol/MpService.h>
  19
  20 /**
  21   Initialize Multi-processor support.
  22
  23 **/
  24 VOID
  25 InitializeMpSupport (
  26   VOID
  27   );
  28
  29 typedef
  30 VOID
  31 (EFIAPI *STACKLESS_AP_ENTRY_POINT)(
  32   VOID
  33   );
  34
  35 /**
  36   Starts the Application Processors and directs them to jump to the
  37   specified routine.
  38
  39   The processor jumps to this code in flat mode, but the processor's
  40   stack is not initialized.
  41
  42   @param ApEntryPoint    Pointer to the Entry Point routine
  43
  44   @retval EFI_SUCCESS           The APs were started
  45   @retval EFI_OUT_OF_RESOURCES  Cannot allocate memory to start APs
  46
  47 **/
  48 EFI_STATUS
  49 StartApsStackless (
  50   IN STACKLESS_AP_ENTRY_POINT ApEntryPoint
  51   );
  52
  53 /**
  54   The AP entry point that the Startup-IPI target code will jump to.
  55
  56   The processor jumps to this code in flat mode, but the processor's
  57   stack is not initialized.
  58
  59 **/
  60 VOID
  61 EFIAPI
  62 AsmApEntryPoint (
  63   VOID
  64   );
  65
  66 /**
  67   Releases the lock preventing other APs from using the shared AP
  68   stack.
  69
  70   Once the AP has transitioned to using a new stack, it can call this
  71   function to allow another AP to proceed with using the shared stack.
  72
  73 **/
  74 VOID
  75 EFIAPI
  76 AsmApDoneWithCommonStack (
  77   VOID
  78   );
  79
  80 #endif // _CPU_MP_H_
  81