FrameworkMpService.h

Go to the documentation of this file.

 
#ifndef _FRAMEWORK_MP_SERVICE_PROTOCOL_H_
#define _FRAMEWORK_MP_SERVICE_PROTOCOL_H_
 
#define FRAMEWORK_EFI_MP_SERVICES_PROTOCOL_GUID \
  { \
    0xf33261e7, 0x23cb, 0x11d5, {0xbd, 0x5c, 0x0, 0x80, 0xc7, 0x3c, 0x88, 0x81} \
  }
 
typedef struct _FRAMEWORK_EFI_MP_SERVICES_PROTOCOL FRAMEWORK_EFI_MP_SERVICES_PROTOCOL;
 
#define DELIVERY_MODE_FIXED  0x0
 
#define DELIVERY_MODE_LOWEST_PRIORITY  0x1
 
#define DELIVERY_MODE_SMI  0x2
 
#define DELIVERY_MODE_REMOTE_READ  0x3
 
#define DELIVERY_MODE_NMI  0x4
 
#define DELIVERY_MODE_INIT  0x5
 
#define DELIVERY_MODE_SIPI  0x6
 
#define DELIVERY_MODE_MAX  0x7
 
#define EFI_MP_HEALTH_FLAGS_STATUS_HEALTHY  0x0
 
#define EFI_MP_HEALTH_FLAGS_STATUS_PERFORMANCE_RESTRICTED  0x1
 
#define EFI_MP_HEALTH_FLAGS_STATUS_FUNCTIONALLY_RESTRICTED  0x2
 
typedef union {
  struct {
    UINT32    Status                   : 2;
    UINT32    Tested                   : 1;
    UINT32    Reserved1                : 13;
    UINT32    VirtualMemoryUnavailable : 1;
    UINT32    Ia32ExecutionUnavailable : 1;
    UINT32    FloatingPointUnavailable : 1;
    UINT32    MiscFeaturesUnavailable  : 1;
    UINT32    Reserved2                : 12;
  } Bits;
  UINT32    Uint32;
} EFI_MP_HEALTH_FLAGS;
 
typedef struct {
  EFI_MP_HEALTH_FLAGS    Flags;
  UINT32                 TestStatus;
} EFI_MP_HEALTH;
 
typedef enum {
  EfiCpuAP = 0,                 
  EfiCpuBSP,                    
  EfiCpuDesignationMaximum
} EFI_CPU_DESIGNATION;
 
typedef struct {
  UINT32                 ApicID;
  BOOLEAN                Enabled;
  EFI_CPU_DESIGNATION    Designation;
  EFI_MP_HEALTH    Health;
  UINTN            PackageNumber;
  UINTN            NumberOfCores;
  UINTN            NumberOfThreads;
  UINT64           ProcessorPALCompatibilityFlags;
  UINT64    ProcessorTestMask;
} EFI_MP_PROC_CONTEXT;
 
typedef
VOID
(EFIAPI *EFI_AP_PROCEDURE)(
  IN OUT VOID  *Buffer
  );
 
typedef
VOID
(EFIAPI *FRAMEWORK_EFI_AP_PROCEDURE)(
  IN  VOID  *Buffer
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_GET_GENERAL_MP_INFO)(
  IN  FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  OUT UINTN                               *NumberOfCPUs          OPTIONAL,
  OUT UINTN                               *MaximumNumberOfCPUs   OPTIONAL,
  OUT UINTN                               *NumberOfEnabledCPUs   OPTIONAL,
  OUT UINTN                               *RendezvousIntNumber   OPTIONAL,
  OUT UINTN                               *RendezvousProcLength  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_GET_PROCESSOR_CONTEXT)(
  IN     FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN     UINTN                               ProcessorNumber,
  IN OUT UINTN                               *BufferLength,
  OUT    EFI_MP_PROC_CONTEXT                 *ProcessorContextBuffer
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_STARTUP_ALL_APS)(
  IN  FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN  FRAMEWORK_EFI_AP_PROCEDURE          Procedure,
  IN  BOOLEAN                             SingleThread,
  IN  EFI_EVENT                           WaitEvent           OPTIONAL,
  IN  UINTN                               TimeoutInMicroSecs,
  IN  VOID                                *ProcArguments      OPTIONAL,
  OUT UINTN                               *FailedCPUList      OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_STARTUP_THIS_AP)(
  IN FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN FRAMEWORK_EFI_AP_PROCEDURE          Procedure,
  IN UINTN                               ProcessorNumber,
  IN EFI_EVENT                           WaitEvent            OPTIONAL,
  IN UINTN                               TimeoutInMicroSecs,
  IN OUT VOID                            *ProcArguments       OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_SWITCH_BSP)(
  IN FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN UINTN                               ProcessorNumber,
  IN BOOLEAN                             EnableOldBSP
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_SEND_IPI)(
  IN FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN UINTN                               ProcessorNumber,
  IN UINTN                               VectorNumber,
  IN UINTN                               DeliveryMode
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_ENABLEDISABLEAP)(
  IN FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  IN UINTN                               ProcessorNumber,
  IN BOOLEAN                             NewAPState,
  IN EFI_MP_HEALTH                       *HealthState  OPTIONAL
  );
 
typedef
EFI_STATUS
(EFIAPI *FRAMEWORK_EFI_MP_SERVICES_WHOAMI)(
  IN  FRAMEWORK_EFI_MP_SERVICES_PROTOCOL  *This,
  OUT UINTN                               *ProcessorNumber
  );
 
struct _FRAMEWORK_EFI_MP_SERVICES_PROTOCOL {
  FRAMEWORK_EFI_MP_SERVICES_GET_GENERAL_MP_INFO      GetGeneralMPInfo;
  FRAMEWORK_EFI_MP_SERVICES_GET_PROCESSOR_CONTEXT    GetProcessorContext;
  FRAMEWORK_EFI_MP_SERVICES_STARTUP_ALL_APS          StartupAllAPs;
  FRAMEWORK_EFI_MP_SERVICES_STARTUP_THIS_AP          StartupThisAP;
  FRAMEWORK_EFI_MP_SERVICES_SWITCH_BSP               SwitchBSP;
  FRAMEWORK_EFI_MP_SERVICES_SEND_IPI                 SendIPI;
  FRAMEWORK_EFI_MP_SERVICES_ENABLEDISABLEAP          EnableDisableAP;
  FRAMEWORK_EFI_MP_SERVICES_WHOAMI                   WhoAmI;
};
 
extern EFI_GUID  gFrameworkEfiMpServiceProtocolGuid;
 
#endif