RegisterCpuFeaturesLib.h

Go to the documentation of this file.

 
#ifndef __REGISTER_CPU_FEATURES_LIB_H__
#define __REGISTER_CPU_FEATURES_LIB_H__
 
#include <AcpiCpuData.h>
#include <Register/Intel/Cpuid.h>
#include <Protocol/MpService.h>
 
#define CPU_FEATURE_AESNI                          0
#define CPU_FEATURE_TURBO_MODE                     1
#define CPU_FEATURE_MWAIT                          2
#define CPU_FEATURE_ACPI                           3
#define CPU_FEATURE_EIST                           4
#define CPU_FEATURE_RESERVED_5                     5
#define CPU_FEATURE_FASTSTRINGS                    6
#define CPU_FEATURE_VMX                            7
#define CPU_FEATURE_SMX                            8
#define CPU_FEATURE_LMCE                           9
#define CPU_FEATURE_LOCK_FEATURE_CONTROL_REGISTER  10
#define CPU_FEATURE_LIMIT_CPUID_MAX_VAL            11
#define CPU_FEATURE_MCE                            12
#define CPU_FEATURE_MCA                            13
#define CPU_FEATURE_MCG_CTL                        14
#define CPU_FEATURE_PENDING_BREAK                  15
#define CPU_FEATURE_C1E                            16
#define CPU_FEATURE_C1_AUTO_DEMOTION               17
#define CPU_FEATURE_C3_AUTO_DEMOTION               18
#define CPU_FEATURE_C1_UNDEMOTION                  19
#define CPU_FEATURE_C3_UNDEMOTION                  20
#define CPU_FEATURE_C_STATE                        21
#define CPU_FEATURE_TM                             22
#define CPU_FEATURE_TM2                            23
#define CPU_FEATURE_X2APIC                         24
#define CPU_FEATURE_RESERVED_25                    25
#define CPU_FEATURE_RESERVED_26                    26
#define CPU_FEATURE_RESERVED_27                    27
#define CPU_FEATURE_RESERVED_28                    28
#define CPU_FEATURE_RESERVED_29                    29
#define CPU_FEATURE_RESERVED_30                    30
#define CPU_FEATURE_RESERVED_31                    31
 
#define CPU_FEATURE_L2_PREFETCHER                 (32+0)
#define CPU_FEATURE_L1_DATA_PREFETCHER            (32+1)
#define CPU_FEATURE_HARDWARE_PREFETCHER           (32+2)
#define CPU_FEATURE_ADJACENT_CACHE_LINE_PREFETCH  (32+3)
#define CPU_FEATURE_DCU_PREFETCHER                (32+4)
#define CPU_FEATURE_IP_PREFETCHER                 (32+5)
#define CPU_FEATURE_MLC_STREAMER_PREFETCHER       (32+6)
#define CPU_FEATURE_MLC_SPATIAL_PREFETCHER        (32+7)
#define CPU_FEATURE_THREE_STRIKE_COUNTER          (32+8)
#define CPU_FEATURE_APIC_TPR_UPDATE_MESSAGE       (32+9)
#define CPU_FEATURE_ENERGY_PERFORMANCE_BIAS       (32+10)
#define CPU_FEATURE_PPIN                          (32+11)
#define CPU_FEATURE_PROC_TRACE                    (32+12)
 
#define CPU_FEATURE_BEFORE_ALL      BIT23
#define CPU_FEATURE_AFTER_ALL       BIT24
#define CPU_FEATURE_THREAD_BEFORE   BIT25
#define CPU_FEATURE_THREAD_AFTER    BIT26
#define CPU_FEATURE_CORE_BEFORE     BIT27
#define CPU_FEATURE_CORE_AFTER      BIT28
#define CPU_FEATURE_PACKAGE_BEFORE  BIT29
#define CPU_FEATURE_PACKAGE_AFTER   BIT30
#define CPU_FEATURE_END             MAX_UINT32
 
typedef struct {
  //
  // Set to 1 when current processor is the first thread in the core it resides in.
  //
  UINT32    Thread   : 1;
  //
  // Set to 1 when current processor is a thread of the first core in the module it resides in.
  //
  UINT32    Core     : 1;
  //
  // Set to 1 when current processor is a thread of the first module in the tile it resides in.
  //
  UINT32    Module   : 1;
  //
  // Set to 1 when current processor is a thread of the first tile in the die it resides in.
  //
  UINT32    Tile     : 1;
  //
  // Set to 1 when current processor is a thread of the first die in the package it resides in.
  //
  UINT32    Die      : 1;
  //
  // Set to 1 when current processor is a thread of the first package in the system.
  //
  UINT32    Package  : 1;
  UINT32    Reserved : 26;
} REGISTER_CPU_FEATURE_FIRST_PROCESSOR;
 
typedef struct {
  EFI_PROCESSOR_INFORMATION               ProcessorInfo;
 
  REGISTER_CPU_FEATURE_FIRST_PROCESSOR    First;
  UINT32                                  DisplayFamily;
  UINT32                                  DisplayModel;
  UINT32                                  SteppingId;
  UINT32                                  ProcessorType;
  CPUID_VERSION_INFO_ECX                  CpuIdVersionInfoEcx;
  CPUID_VERSION_INFO_EDX                  CpuIdVersionInfoEdx;
} REGISTER_CPU_FEATURE_INFORMATION;
 
BOOLEAN
EFIAPI
IsCpuFeatureSupported (
  IN UINT32  Feature
  );
 
BOOLEAN
EFIAPI
IsCpuFeatureInSetting (
  IN UINT32  Feature
  );
 
typedef
VOID *
(EFIAPI *CPU_FEATURE_GET_CONFIG_DATA)(
  IN UINTN               NumberOfProcessors
  );
 
typedef
BOOLEAN
(EFIAPI *CPU_FEATURE_SUPPORT)(
  IN UINTN                             ProcessorNumber,
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,
  IN VOID                              *ConfigData  OPTIONAL
  );
 
typedef
RETURN_STATUS
(EFIAPI *CPU_FEATURE_INITIALIZE)(
  IN UINTN                             ProcessorNumber,
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,
  IN VOID                              *ConfigData   OPTIONAL,
  IN BOOLEAN                           State
  );
 
RETURN_STATUS
EFIAPI
RegisterCpuFeature (
  IN CHAR8                        *FeatureName        OPTIONAL,
  IN CPU_FEATURE_GET_CONFIG_DATA  GetConfigDataFunc   OPTIONAL,
  IN CPU_FEATURE_SUPPORT          SupportFunc         OPTIONAL,
  IN CPU_FEATURE_INITIALIZE       InitializeFunc      OPTIONAL,
  ...
  );
 
VOID
EFIAPI
CpuFeaturesDetect (
  VOID
  );
 
VOID
EFIAPI
CpuFeaturesInitialize (
  VOID
  );
 
VOID
EFIAPI
SwitchBspAfterFeaturesInitialize (
  IN UINTN  ProcessorNumber
  );
 
VOID
EFIAPI
CpuRegisterTableWrite (
  IN UINTN          ProcessorNumber,
  IN REGISTER_TYPE  RegisterType,
  IN UINT64         Index,
  IN UINT64         ValueMask,
  IN UINT64         Value
  );
 
VOID
EFIAPI
CpuRegisterTableTestThenWrite (
  IN UINTN          ProcessorNumber,
  IN REGISTER_TYPE  RegisterType,
  IN UINT64         Index,
  IN UINT64         ValueMask,
  IN UINT64         Value
  );
 
VOID
EFIAPI
PreSmmCpuRegisterTableWrite (
  IN UINTN          ProcessorNumber,
  IN REGISTER_TYPE  RegisterType,
  IN UINT64         Index,
  IN UINT64         ValueMask,
  IN UINT64         Value
  );
 
#define CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value)       \
  do {                                                                                \
    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value);  \
  } while(FALSE);
 
#define CPU_REGISTER_TABLE_TEST_THEN_WRITE32(ProcessorNumber, RegisterType, Index, Value)     \
  do {                                                                                        \
    CpuRegisterTableTestThenWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value);  \
  } while(FALSE);
 
#define CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value)       \
  do {                                                                                \
    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value);  \
  } while(FALSE);
 
#define CPU_REGISTER_TABLE_TEST_THEN_WRITE64(ProcessorNumber, RegisterType, Index, Value)     \
  do {                                                                                        \
    CpuRegisterTableTestThenWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value);  \
  } while(FALSE);
 
#define CPU_REGISTER_TABLE_WRITE_FIELD(ProcessorNumber, RegisterType, Index, Type, Field, Value) \
  do {                                                                                           \
    UINT64  ValueMask;                                                                           \
    ValueMask = MAX_UINT64;                                                                      \
    ((Type *)(&ValueMask))->Field = 0;                                                           \
    CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, ~ValueMask, Value);             \
  } while(FALSE);
 
#define CPU_REGISTER_TABLE_TEST_THEN_WRITE_FIELD(ProcessorNumber, RegisterType, Index, Type, Field, Value) \
  do {                                                                                                     \
    UINT64  ValueMask;                                                                                     \
    ValueMask = MAX_UINT64;                                                                                \
    ((Type *)(&ValueMask))->Field = 0;                                                                     \
    CpuRegisterTableTestThenWrite (ProcessorNumber, RegisterType, Index, ~ValueMask, Value);               \
  } while(FALSE);
 
#define PRE_SMM_CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value)    \
  do {                                                                                     \
    PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value); \
  } while(FALSE);
 
#define PRE_SMM_CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value)    \
  do {                                                                                     \
    PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value); \
  } while(FALSE);
 
#define PRE_SMM_CPU_REGISTER_TABLE_WRITE_FIELD(ProcessorNumber, RegisterType, Index, Type, Field, Value) \
  do {                                                                                                   \
    UINT64  ValueMask;                                                                                   \
    ValueMask = MAX_UINT64;                                                                              \
    ((Type *)(&ValueMask))->Field = 0;                                                                   \
    PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, ~ValueMask, Value);                \
  } while(FALSE);
 
#endif