MpLib.h

Go to the documentation of this file.

 
#ifndef MP_LIB_H_
#define MP_LIB_H_
 
#include <PiPei.h>
#include <Guid/ProcessorResourceHob.h>
#include <Library/PeiServicesLib.h>
 
#include <Library/MpInitLib.h>
#include <Library/BaseLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DebugLib.h>
#include <Library/CpuLib.h>
#include <Library/SynchronizationLib.h>
#include <Library/TimerLib.h>
#include <Library/HobLib.h>
 
#define WAKEUP_AP_SIGNAL  SIGNATURE_32 ('S', 'T', 'A', 'P')
 
#define CPU_INIT_MP_LIB_HOB_GUID \
  { \
    0x58eb6a19, 0x3699, 0x4c68, { 0xa8, 0x36, 0xda, 0xcd, 0x8e, 0xdc, 0xad, 0x4a } \
  }
 
//
// AP loop state when APs are in idle state
// It's value is the same with PcdCpuApLoopMode
//
typedef enum {
  ApInHltLoop = 1,
  ApInRunLoop = 2
} AP_LOOP_MODE;
 
//
// AP initialization state during APs wakeup
//
typedef enum {
  ApInitConfig   = 1,
  ApInitReconfig = 2,
  ApInitDone     = 3
} AP_INIT_STATE;
 
//
// AP state
//
typedef enum {
  CpuStateIdle,
  CpuStateReady,
  CpuStateBusy,
  CpuStateFinished,
  CpuStateDisabled
} CPU_STATE;
 
//
// AP related data
//
typedef struct {
  SPIN_LOCK             ApLock;
  volatile UINT32       *StartupApSignal;
  volatile UINTN        ApFunction;
  volatile UINTN        ApFunctionArgument;
  BOOLEAN               CpuHealthy;
  volatile CPU_STATE    State;
  BOOLEAN               Waiting;
  BOOLEAN               *Finished;
  UINT64                ExpectedTime;
  UINT64                CurrentTime;
  UINT64                TotalTime;
  EFI_EVENT             WaitEvent;
} CPU_AP_DATA;
 
//
// Basic CPU information saved in Guided HOB.
// Because the contents will be shard between PEI and DXE,
// we need to make sure the each fields offset same in different
// architecture.
//
#pragma pack (1)
typedef struct {
  UINT32    ApicId;
  UINT32    Health;
} CPU_INFO_IN_HOB;
#pragma pack ()
 
typedef struct MP_CPU_DATA CPU_MP_DATA;
 
#pragma pack(1)
 
//
// MP CPU exchange information for AP reset code
// This structure is required to be packed because fixed field offsets
// into this structure are used in assembly code in this module
//
typedef struct {
  CPU_MP_DATA    *CpuMpData;
} MP_CPU_EXCHANGE_INFO;
 
#pragma pack()
 
//
// CPU MP Data save in memory
//
struct MP_CPU_DATA {
  UINT64                           CpuInfoInHob;
  UINT32                           CpuCount;
  UINT32                           BspNumber;
  //
  // The above fields data will be passed from PEI to DXE
  // Please make sure the fields offset same in the different
  // architecture.
  //
  SPIN_LOCK                        MpLock;
 
  volatile UINT32                  FinishedCount;
  UINT32                           RunningCount;
  BOOLEAN                          SingleThread;
  EFI_AP_PROCEDURE                 Procedure;
  VOID                             *ProcArguments;
  BOOLEAN                          *Finished;
  UINT64                           ExpectedTime;
  UINT64                           CurrentTime;
  UINT64                           TotalTime;
  EFI_EVENT                        WaitEvent;
 
  AP_INIT_STATE                    InitFlag;
  UINT8                            ApLoopMode;
  CPU_AP_DATA                      *CpuData;
  volatile MP_CPU_EXCHANGE_INFO    *MpCpuExchangeInfo;
};
 
extern EFI_GUID  mCpuInitMpLibHobGuid;
 
CPU_MP_DATA *
GetCpuMpData (
  VOID
  );
 
VOID
SaveCpuMpData (
  IN CPU_MP_DATA  *CpuMpData
  );
 
VOID
WakeUpAP (
  IN CPU_MP_DATA       *CpuMpData,
  IN BOOLEAN           Broadcast,
  IN UINTN             ProcessorNumber,
  IN EFI_AP_PROCEDURE  Procedure               OPTIONAL,
  IN VOID              *ProcedureArgument      OPTIONAL,
  IN BOOLEAN           WakeUpDisabledAps
  );
 
VOID
InitMpGlobalData (
  IN CPU_MP_DATA  *CpuMpData
  );
 
EFI_STATUS
StartupAllCPUsWorker (
  IN  EFI_AP_PROCEDURE  Procedure,
  IN  BOOLEAN           SingleThread,
  IN  BOOLEAN           ExcludeBsp,
  IN  EFI_EVENT         WaitEvent               OPTIONAL,
  IN  UINTN             TimeoutInMicroseconds,
  IN  VOID              *ProcedureArgument      OPTIONAL,
  OUT UINTN             **FailedCpuList         OPTIONAL
  );
 
EFI_STATUS
StartupThisAPWorker (
  IN  EFI_AP_PROCEDURE  Procedure,
  IN  UINTN             ProcessorNumber,
  IN  EFI_EVENT         WaitEvent               OPTIONAL,
  IN  UINTN             TimeoutInMicroseconds,
  IN  VOID              *ProcedureArgument      OPTIONAL,
  OUT BOOLEAN           *Finished               OPTIONAL
  );
 
EFI_STATUS
EnableDisableApWorker (
  IN  UINTN    ProcessorNumber,
  IN  BOOLEAN  EnableAP,
  IN  UINT32   *HealthFlag OPTIONAL
  );
 
CPU_MP_DATA *
GetCpuMpDataFromGuidedHob (
  VOID
  );
 
EFI_STATUS
CheckThisAP (
  IN UINTN  ProcessorNumber
  );
 
EFI_STATUS
CheckAllAPs (
  VOID
  );
 
VOID
CheckAndUpdateApsStatus (
  VOID
  );
 
VOID
EnableDebugAgent (
  VOID
  );
 
#endif