-/** @file
- Register CPU Features Library to register and manage CPU features.
-
- Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
- This program and the accompanying materials
- are licensed and made available under the terms and conditions of the BSD License
- which accompanies this distribution. The full text of the license may be found at
- http://opensource.org/licenses/bsd-license.php
-
- THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
- WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
-
-**/
-
-#ifndef __REGISTER_CPU_FEATURES_LIB_H__
-#define __REGISTER_CPU_FEATURES_LIB_H__
-
-#include <AcpiCpuData.h>
-#include <Register/Cpuid.h>
-#include <Protocol/MpService.h>
-
-///
-/// Defines used to identify a CPU feature. The lower 16-bits are used to
-/// identify a unique CPU feature and the value represents a bit number in
-/// a bit mask. The upper 16-bits are bit mask values that are used as
-/// modifiers of a CPU feature. When used in a list, the define value
-/// CPU_FEATURE_END is used to terminate a list of CPU feature values.
-/// @{
-#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_XD 5
-#define CPU_FEATURE_FASTSTRINGS 6
-#define CPU_FEATURE_VMX 7
-#define CPU_FEATURE_SMX 8
-#define CPU_FEATURE_SENTER 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_AUTO_UNDEMOTION 19
-#define CPU_FEATURE_C3_AUTO_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_STRICK_COUNTER (32+8)
-#define CPU_FEATURE_APIC_TPR_UPDATE_MESSAGE (32+9)
-#define CPU_FEATURE_ENERGY_PERFORMANCE_BIAS (32+10)
-
-#define CPU_FEATURE_BEFORE_ALL BIT27
-#define CPU_FEATURE_AFTER_ALL BIT28
-#define CPU_FEATURE_BEFORE BIT29
-#define CPU_FEATURE_AFTER BIT30
-#define CPU_FEATURE_END MAX_UINT32
-/// @}
-
-///
-/// CPU Information passed into the SupportFunc and InitializeFunc of the
-/// RegisterCpuFeature() library function. This structure contains information
-/// that is commonly used during CPU feature detection and initialization.
-///
-typedef struct {
- ///
- /// The package that the CPU resides
- ///
- EFI_PROCESSOR_INFORMATION ProcessorInfo;
- ///
- /// The Display Family of the CPU computed from CPUID leaf CPUID_VERSION_INFO
- ///
- UINT32 DisplayFamily;
- ///
- /// The Display Model of the CPU computed from CPUID leaf CPUID_VERSION_INFO
- ///
- UINT32 DisplayModel;
- ///
- /// The Stepping ID of the CPU computed from CPUID leaf CPUID_VERSION_INFO
- ///
- UINT32 SteppingId;
- ///
- /// The Processor Type of the CPU computed from CPUID leaf CPUID_VERSION_INFO
- ///
- UINT32 ProcessorType;
- ///
- /// Bit field structured returned in ECX from CPUID leaf CPUID_VERSION_INFO
- ///
- CPUID_VERSION_INFO_ECX CpuIdVersionInfoEcx;
- ///
- /// Bit field structured returned in EDX from CPUID leaf CPUID_VERSION_INFO
- ///
- CPUID_VERSION_INFO_EDX CpuIdVersionInfoEdx;
-} REGISTER_CPU_FEATURE_INFORMATION;
-
-/**
- Determines if a CPU feature is enabled in PcdCpuFeaturesSupport bit mask.
- If a CPU feature is disabled in PcdCpuFeaturesSupport then all the code/data
- associated with that feature should be optimized away if compiler
- optimizations are enabled.
-
- @param[in] Feature The bit number of the CPU feature to check in the PCD
- PcdCpuFeaturesSupport.
-
- @retval TRUE The CPU feature is set in PcdCpuFeaturesSupport.
- @retval FALSE The CPU feature is not set in PcdCpuFeaturesSupport.
-
- @note This service could be called by BSP only.
-**/
-BOOLEAN
-EFIAPI
-IsCpuFeatureSupported (
- IN UINT32 Feature
- );
-
-/**
- Determines if a CPU feature is set in PcdCpuFeaturesSetting bit mask.
-
- @param[in] Feature The bit number of the CPU feature to check in the PCD
- PcdCpuFeaturesSetting.
-
- @retval TRUE The CPU feature is set in PcdCpuFeaturesSetting.
- @retval FALSE The CPU feature is not set in PcdCpuFeaturesSetting.
-
- @note This service could be called by BSP only.
-**/
-BOOLEAN
-EFIAPI
-IsCpuFeatureInSetting (
- IN UINT32 Feature
- );
-
-/**
- Determines if a CPU feature is set in PcdCpuFeaturesCapability bit mask.
-
- @param[in] Feature The bit number of the CPU feature to check in the PCD
- PcdCpuFeaturesCapability.
-
- @retval TRUE The CPU feature is set in PcdCpuFeaturesCapability.
- @retval FALSE The CPU feature is not set in PcdCpuFeaturesCapability.
-
- @note This service could be called by BSP only.
-**/
-BOOLEAN
-EFIAPI
-IsCpuFeatureCapability (
- IN UINT32 Feature
- );
-
-/**
- Determines if a CPU feature is set in PcdCpuFeaturesUserConfiguration bit mask.
-
- @param[in] Feature The bit number of the CPU feature to check in the PCD
- PcdCpuFeaturesUserConfiguration.
-
- @retval TRUE The CPU feature is set in PcdCpuFeaturesUserConfiguration.
- @retval FALSE The CPU feature is not set in PcdCpuFeaturesUserConfiguration.
-
- @note This service could be called by BSP only.
-**/
-BOOLEAN
-EFIAPI
-IsCpuFeatureUserConfiguration (
- IN UINT32 Feature
- );
-
-/**
- Prepares for the data used by CPU feature detection and initialization.
-
- @param[in] NumberOfProcessors The number of CPUs in the platform.
-
- @return Pointer to a buffer of CPU related configuration data.
-
- @note This service could be called by BSP only.
-**/
-typedef
-VOID *
-(EFIAPI *CPU_FEATURE_GET_CONFIG_DATA)(
- IN UINTN NumberOfProcessors
- );
-
-/**
- Detects if CPU feature supported on current processor.
-
- @param[in] ProcessorNumber The index of the CPU executing this function.
- @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
- structure for the CPU executing this function.
- @param[in] ConfigData A pointer to the configuration buffer returned
- by CPU_FEATURE_GET_CONFIG_DATA. NULL if
- CPU_FEATURE_GET_CONFIG_DATA was not provided in
- RegisterCpuFeature().
-
- @retval TRUE CPU feature is supported.
- @retval FALSE CPU feature is not supported.
-
- @note This service could be called by BSP/APs.
-**/
-typedef
-BOOLEAN
-(EFIAPI *CPU_FEATURE_SUPPORT)(
- IN UINTN ProcessorNumber,
- IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
- IN VOID *ConfigData OPTIONAL
- );
-
-/**
- Initializes CPU feature to specific state.
-
- This service does not initialize hardware and only produces entries in the
- Register Table for specified processor. Hardware initialization on BSP/APs
- will be done in CpuFeaturesInitialize().
-
- @param[in] ProcessorNumber The index of the CPU executing this function.
- @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION
- structure for the CPU executing this function.
- @param[in] ConfigData A pointer to the configuration buffer returned
- by CPU_FEATURE_GET_CONFIG_DATA. NULL if
- CPU_FEATURE_GET_CONFIG_DATA was not provided in
- RegisterCpuFeature().
- @param[in] State If TRUE, then the CPU feature must be enabled.
- If FALSE, then the CPU feature must be disabled.
-
- @retval RETURN_SUCCESS CPU feature is initialized.
-
- @note This service could be called by BSP only.
-**/
-typedef
-RETURN_STATUS
-(EFIAPI *CPU_FEATURE_INITIALIZE)(
- IN UINTN ProcessorNumber,
- IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,
- IN VOID *ConfigData, OPTIONAL
- IN BOOLEAN State
- );
-
-/**
- Registers a CPU Feature.
-
- @param GetConfigDataFunc CPU feature get configuration data function. This
- is an optional parameter that may be NULL. If NULL,
- then the most recently registered function for the
- CPU feature is used. If no functions are registered
- for a CPU feature, then the CPU configuration data
- for the registered feature is NULL.
- @param SupportFunc CPU feature support function. This is an optional
- parameter that may be NULL. If NULL, then the most
- recently registered function for the CPU feature is
- used. If no functions are registered for a CPU
- feature, then the CPU feature is assumed to be
- supported by all CPUs.
- @param InitializeFunc CPU feature initialize function. This is an optional
- parameter that may be NULL. If NULL, then the most
- recently registered function for the CPU feature is
- used. If no functions are registered for a CPU
- feature, then the CPU feature initialization is
- skipped.
- @param ... Variable argument list of UINT32 CPU feature value.
- Values with no modifiers are the features provided
- by the registered functions.
- Values with CPU_FEATURE_BEFORE modifier are features
- that must be initialized after the features provided
- by the registered functions are used.
- Values with CPU_FEATURE_AFTER modifier are features
- that must be initialized before the features provided
- by the registered functions are used.
- The last argument in this variable argument list must
- always be CPU_FEATURE_END.
-
- @retval RETURN_SUCCESS The CPU feature was successfully registered.
- @retval RETURN_OUT_OF_RESOURCES There are not enough resources to register
- the CPU feature.
- @retval RETURN_UNSUPPORTED Registration of the CPU feature is not
- supported due to a circular dependency between
- BEFORE and AFTER features.
-
- @note This service could be called by BSP only.
-**/
-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
- ...
- );
-
-/**
- Performs CPU features detection.
-
- This service will invoke MP service to check CPU features'
- capabilities on BSP/APs.
-
- @note This service could be called by BSP only.
-**/
-VOID
-EFIAPI
-CpuFeaturesDetect (
- VOID
- );
-
-/**
- Performs CPU features Initialization.
-
- This service will invoke MP service to perform CPU features
- initialization on BSP/APs per user configuration.
-
- @note This service could be called by BSP only.
-**/
-VOID
-EFIAPI
-CpuFeaturesInitialize (
- VOID
- );
-
-/**
- Switches to assigned BSP after CPU features initialization.
-
- @param[in] ProcessorNumber The index of the CPU executing this function.
-
- @note This service could be called by BSP only.
-**/
-VOID
-EFIAPI
-SwitchBspAfterFeaturesInitialize (
- IN UINTN ProcessorNumber
- );
-
-/**
- Adds an entry in specified register table.
-
- This function adds an entry in specified register table, with given register type,
- register index, bit section and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] ValueMask Mask of bits in register to write
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-VOID
-EFIAPI
-CpuRegisterTableWrite (
- IN UINTN ProcessorNumber,
- IN REGISTER_TYPE RegisterType,
- IN UINT64 Index,
- IN UINT64 ValueMask,
- IN UINT64 Value
- );
-
-/**
- Adds an entry in specified Pre-SMM register table.
-
- This function adds an entry in specified register table, with given register type,
- register index, bit section and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] ValueMask Mask of bits in register to write
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-VOID
-EFIAPI
-PreSmmCpuRegisterTableWrite (
- IN UINTN ProcessorNumber,
- IN REGISTER_TYPE RegisterType,
- IN UINT64 Index,
- IN UINT64 ValueMask,
- IN UINT64 Value
- );
-
-/**
- Adds a 32-bit register write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-#define CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value) \
- do { \
- CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value); \
- } while(FALSE);
-
-/**
- Adds a 64-bit register write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-#define CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value) \
- do { \
- CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value); \
- } while(FALSE);
-
-/**
- Adds a bit field write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, bit field section, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program.
- @param[in] Index Index of the register to program.
- @param[in] Type The data type name of a register structure.
- @param[in] Field The bit fiel name in register structure to write.
- @param[in] Value Value to write to the bit field.
-
- @note This service could be called by BSP only.
-**/
-#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);
-
-/**
- Adds a 32-bit register write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-#define PRE_SMM_CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value) \
- do { \
- PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value); \
- } while(FALSE);
-
-/**
- Adds a 64-bit register write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program
- @param[in] Index Index of the register to program
- @param[in] Value Value to write
-
- @note This service could be called by BSP only.
-**/
-#define PRE_SMM_CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value) \
- do { \
- PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value); \
- } while(FALSE);
-
-/**
- Adds a bit field write entry in specified register table.
-
- This macro adds an entry in specified register table, with given register type,
- register index, bit field section, and value.
-
- @param[in] ProcessorNumber The index of the CPU to add a register table entry.
- @param[in] RegisterType Type of the register to program.
- @param[in] Index Index of the register to program.
- @param[in] Type The data type name of a register structure.
- @param[in] Field The bit fiel name in register structure to write.
- @param[in] Value Value to write to the bit field.
-
- @note This service could be called by BSP only.
-**/
-#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
+/** @file\r
+ Register CPU Features Library to register and manage CPU features.\r
+\r
+ Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>\r
+ This program and the accompanying materials\r
+ are licensed and made available under the terms and conditions of the BSD License\r
+ which accompanies this distribution. The full text of the license may be found at\r
+ http://opensource.org/licenses/bsd-license.php\r
+\r
+ THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+\r
+**/\r
+\r
+#ifndef __REGISTER_CPU_FEATURES_LIB_H__\r
+#define __REGISTER_CPU_FEATURES_LIB_H__\r
+\r
+#include <AcpiCpuData.h>\r
+#include <Register/Cpuid.h>\r
+#include <Protocol/MpService.h>\r
+\r
+///\r
+/// Defines used to identify a CPU feature. The lower 16-bits are used to\r
+/// identify a unique CPU feature and the value represents a bit number in\r
+/// a bit mask. The upper 16-bits are bit mask values that are used as\r
+/// modifiers of a CPU feature. When used in a list, the define value\r
+/// CPU_FEATURE_END is used to terminate a list of CPU feature values.\r
+/// @{\r
+#define CPU_FEATURE_AESNI 0\r
+#define CPU_FEATURE_TURBO_MODE 1\r
+#define CPU_FEATURE_MWAIT 2\r
+#define CPU_FEATURE_ACPI 3\r
+#define CPU_FEATURE_EIST 4\r
+#define CPU_FEATURE_XD 5\r
+#define CPU_FEATURE_FASTSTRINGS 6\r
+#define CPU_FEATURE_VMX 7\r
+#define CPU_FEATURE_SMX 8\r
+#define CPU_FEATURE_LMCE 9\r
+#define CPU_FEATURE_LOCK_FEATURE_CONTROL_REGISTER 10\r
+#define CPU_FEATURE_LIMIT_CPUID_MAX_VAL 11\r
+#define CPU_FEATURE_MCE 12\r
+#define CPU_FEATURE_MCA 13\r
+#define CPU_FEATURE_MCG_CTL 14\r
+#define CPU_FEATURE_PENDING_BREAK 15\r
+#define CPU_FEATURE_C1E 16\r
+#define CPU_FEATURE_C1_AUTO_DEMOTION 17\r
+#define CPU_FEATURE_C3_AUTO_DEMOTION 18\r
+#define CPU_FEATURE_C1_UNDEMOTION 19\r
+#define CPU_FEATURE_C3_UNDEMOTION 20\r
+#define CPU_FEATURE_C_STATE 21\r
+#define CPU_FEATURE_TM 22\r
+#define CPU_FEATURE_TM2 23\r
+#define CPU_FEATURE_X2APIC 24\r
+#define CPU_FEATURE_RESERVED_25 25\r
+#define CPU_FEATURE_RESERVED_26 26\r
+#define CPU_FEATURE_RESERVED_27 27\r
+#define CPU_FEATURE_RESERVED_28 28\r
+#define CPU_FEATURE_RESERVED_29 29\r
+#define CPU_FEATURE_RESERVED_30 30\r
+#define CPU_FEATURE_RESERVED_31 31\r
+\r
+#define CPU_FEATURE_L2_PREFETCHER (32+0)\r
+#define CPU_FEATURE_L1_DATA_PREFETCHER (32+1)\r
+#define CPU_FEATURE_HARDWARE_PREFETCHER (32+2)\r
+#define CPU_FEATURE_ADJACENT_CACHE_LINE_PREFETCH (32+3)\r
+#define CPU_FEATURE_DCU_PREFETCHER (32+4)\r
+#define CPU_FEATURE_IP_PREFETCHER (32+5)\r
+#define CPU_FEATURE_MLC_STREAMER_PREFETCHER (32+6)\r
+#define CPU_FEATURE_MLC_SPATIAL_PREFETCHER (32+7)\r
+#define CPU_FEATURE_THREE_STRICK_COUNTER (32+8)\r
+#define CPU_FEATURE_APIC_TPR_UPDATE_MESSAGE (32+9)\r
+#define CPU_FEATURE_ENERGY_PERFORMANCE_BIAS (32+10)\r
+#define CPU_FEATURE_PPIN (32+11)\r
+#define CPU_FEATURE_PROC_TRACE (32+12)\r
+\r
+#define CPU_FEATURE_BEFORE_ALL BIT27\r
+#define CPU_FEATURE_AFTER_ALL BIT28\r
+#define CPU_FEATURE_BEFORE BIT29\r
+#define CPU_FEATURE_AFTER BIT30\r
+#define CPU_FEATURE_END MAX_UINT32\r
+/// @}\r
+\r
+///\r
+/// CPU Information passed into the SupportFunc and InitializeFunc of the\r
+/// RegisterCpuFeature() library function. This structure contains information\r
+/// that is commonly used during CPU feature detection and initialization.\r
+///\r
+typedef struct {\r
+ ///\r
+ /// The package that the CPU resides\r
+ ///\r
+ EFI_PROCESSOR_INFORMATION ProcessorInfo;\r
+ ///\r
+ /// The Display Family of the CPU computed from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ UINT32 DisplayFamily;\r
+ ///\r
+ /// The Display Model of the CPU computed from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ UINT32 DisplayModel;\r
+ ///\r
+ /// The Stepping ID of the CPU computed from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ UINT32 SteppingId;\r
+ ///\r
+ /// The Processor Type of the CPU computed from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ UINT32 ProcessorType;\r
+ ///\r
+ /// Bit field structured returned in ECX from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ CPUID_VERSION_INFO_ECX CpuIdVersionInfoEcx;\r
+ ///\r
+ /// Bit field structured returned in EDX from CPUID leaf CPUID_VERSION_INFO\r
+ ///\r
+ CPUID_VERSION_INFO_EDX CpuIdVersionInfoEdx;\r
+} REGISTER_CPU_FEATURE_INFORMATION;\r
+\r
+/**\r
+ Determines if a CPU feature is enabled in PcdCpuFeaturesSupport bit mask.\r
+ If a CPU feature is disabled in PcdCpuFeaturesSupport then all the code/data\r
+ associated with that feature should be optimized away if compiler\r
+ optimizations are enabled.\r
+\r
+ @param[in] Feature The bit number of the CPU feature to check in the PCD\r
+ PcdCpuFeaturesSupport.\r
+\r
+ @retval TRUE The CPU feature is set in PcdCpuFeaturesSupport.\r
+ @retval FALSE The CPU feature is not set in PcdCpuFeaturesSupport.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsCpuFeatureSupported (\r
+ IN UINT32 Feature\r
+ );\r
+\r
+/**\r
+ Determines if a CPU feature is set in PcdCpuFeaturesSetting bit mask.\r
+\r
+ @param[in] Feature The bit number of the CPU feature to check in the PCD\r
+ PcdCpuFeaturesSetting.\r
+\r
+ @retval TRUE The CPU feature is set in PcdCpuFeaturesSetting.\r
+ @retval FALSE The CPU feature is not set in PcdCpuFeaturesSetting.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsCpuFeatureInSetting (\r
+ IN UINT32 Feature\r
+ );\r
+\r
+/**\r
+ Determines if a CPU feature is set in PcdCpuFeaturesCapability bit mask.\r
+\r
+ @param[in] Feature The bit number of the CPU feature to check in the PCD\r
+ PcdCpuFeaturesCapability.\r
+\r
+ @retval TRUE The CPU feature is set in PcdCpuFeaturesCapability.\r
+ @retval FALSE The CPU feature is not set in PcdCpuFeaturesCapability.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsCpuFeatureCapability (\r
+ IN UINT32 Feature\r
+ );\r
+\r
+/**\r
+ Determines if a CPU feature is set in PcdCpuFeaturesUserConfiguration bit mask.\r
+\r
+ @param[in] Feature The bit number of the CPU feature to check in the PCD\r
+ PcdCpuFeaturesUserConfiguration.\r
+\r
+ @retval TRUE The CPU feature is set in PcdCpuFeaturesUserConfiguration.\r
+ @retval FALSE The CPU feature is not set in PcdCpuFeaturesUserConfiguration.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+BOOLEAN\r
+EFIAPI\r
+IsCpuFeatureUserConfiguration (\r
+ IN UINT32 Feature\r
+ );\r
+\r
+/**\r
+ Prepares for the data used by CPU feature detection and initialization.\r
+\r
+ @param[in] NumberOfProcessors The number of CPUs in the platform.\r
+\r
+ @return Pointer to a buffer of CPU related configuration data.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+typedef\r
+VOID *\r
+(EFIAPI *CPU_FEATURE_GET_CONFIG_DATA)(\r
+ IN UINTN NumberOfProcessors\r
+ );\r
+\r
+/**\r
+ Detects if CPU feature supported on current processor.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU executing this function.\r
+ @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION\r
+ structure for the CPU executing this function.\r
+ @param[in] ConfigData A pointer to the configuration buffer returned\r
+ by CPU_FEATURE_GET_CONFIG_DATA. NULL if\r
+ CPU_FEATURE_GET_CONFIG_DATA was not provided in\r
+ RegisterCpuFeature().\r
+\r
+ @retval TRUE CPU feature is supported.\r
+ @retval FALSE CPU feature is not supported.\r
+\r
+ @note This service could be called by BSP/APs.\r
+**/\r
+typedef\r
+BOOLEAN\r
+(EFIAPI *CPU_FEATURE_SUPPORT)(\r
+ IN UINTN ProcessorNumber,\r
+ IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,\r
+ IN VOID *ConfigData OPTIONAL\r
+ );\r
+\r
+/**\r
+ Initializes CPU feature to specific state.\r
+\r
+ This service does not initialize hardware and only produces entries in the\r
+ Register Table for specified processor. Hardware initialization on BSP/APs\r
+ will be done in CpuFeaturesInitialize().\r
+\r
+ @param[in] ProcessorNumber The index of the CPU executing this function.\r
+ @param[in] CpuInfo A pointer to the REGISTER_CPU_FEATURE_INFORMATION\r
+ structure for the CPU executing this function.\r
+ @param[in] ConfigData A pointer to the configuration buffer returned\r
+ by CPU_FEATURE_GET_CONFIG_DATA. NULL if\r
+ CPU_FEATURE_GET_CONFIG_DATA was not provided in\r
+ RegisterCpuFeature().\r
+ @param[in] State If TRUE, then the CPU feature must be enabled.\r
+ If FALSE, then the CPU feature must be disabled.\r
+\r
+ @retval RETURN_SUCCESS CPU feature is initialized.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+typedef\r
+RETURN_STATUS\r
+(EFIAPI *CPU_FEATURE_INITIALIZE)(\r
+ IN UINTN ProcessorNumber,\r
+ IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo,\r
+ IN VOID *ConfigData, OPTIONAL\r
+ IN BOOLEAN State\r
+ );\r
+\r
+/**\r
+ Registers a CPU Feature.\r
+\r
+ @param[in] FeatureName A Null-terminated Ascii string indicates CPU feature\r
+ name.\r
+ @param[in] GetConfigDataFunc CPU feature get configuration data function. This\r
+ is an optional parameter that may be NULL. If NULL,\r
+ then the most recently registered function for the\r
+ CPU feature is used. If no functions are registered\r
+ for a CPU feature, then the CPU configuration data\r
+ for the registered feature is NULL.\r
+ @param[in] SupportFunc CPU feature support function. This is an optional\r
+ parameter that may be NULL. If NULL, then the most\r
+ recently registered function for the CPU feature is\r
+ used. If no functions are registered for a CPU\r
+ feature, then the CPU feature is assumed to be\r
+ supported by all CPUs.\r
+ @param[in] InitializeFunc CPU feature initialize function. This is an optional\r
+ parameter that may be NULL. If NULL, then the most\r
+ recently registered function for the CPU feature is\r
+ used. If no functions are registered for a CPU\r
+ feature, then the CPU feature initialization is\r
+ skipped.\r
+ @param[in] ... Variable argument list of UINT32 CPU feature value.\r
+ Values with no modifiers are the features provided\r
+ by the registered functions.\r
+ Values with CPU_FEATURE_BEFORE modifier are features\r
+ that must be initialized after the features provided\r
+ by the registered functions are used.\r
+ Values with CPU_FEATURE_AFTER modifier are features\r
+ that must be initialized before the features provided\r
+ by the registered functions are used.\r
+ The last argument in this variable argument list must\r
+ always be CPU_FEATURE_END.\r
+\r
+ @retval RETURN_SUCCESS The CPU feature was successfully registered.\r
+ @retval RETURN_OUT_OF_RESOURCES There are not enough resources to register\r
+ the CPU feature.\r
+ @retval RETURN_UNSUPPORTED Registration of the CPU feature is not\r
+ supported due to a circular dependency between\r
+ BEFORE and AFTER features.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+RETURN_STATUS\r
+EFIAPI\r
+RegisterCpuFeature (\r
+ IN CHAR8 *FeatureName, OPTIONAL\r
+ IN CPU_FEATURE_GET_CONFIG_DATA GetConfigDataFunc, OPTIONAL\r
+ IN CPU_FEATURE_SUPPORT SupportFunc, OPTIONAL\r
+ IN CPU_FEATURE_INITIALIZE InitializeFunc, OPTIONAL\r
+ ...\r
+ );\r
+\r
+/**\r
+ Performs CPU features detection.\r
+\r
+ This service will invoke MP service to check CPU features'\r
+ capabilities on BSP/APs.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+VOID\r
+EFIAPI\r
+CpuFeaturesDetect (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Performs CPU features Initialization.\r
+\r
+ This service will invoke MP service to perform CPU features\r
+ initialization on BSP/APs per user configuration.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+VOID\r
+EFIAPI\r
+CpuFeaturesInitialize (\r
+ VOID\r
+ );\r
+\r
+/**\r
+ Switches to assigned BSP after CPU features initialization.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU executing this function.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+VOID\r
+EFIAPI\r
+SwitchBspAfterFeaturesInitialize (\r
+ IN UINTN ProcessorNumber\r
+ );\r
+\r
+/**\r
+ Adds an entry in specified register table.\r
+\r
+ This function adds an entry in specified register table, with given register type,\r
+ register index, bit section and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] ValueMask Mask of bits in register to write\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+VOID\r
+EFIAPI\r
+CpuRegisterTableWrite (\r
+ IN UINTN ProcessorNumber,\r
+ IN REGISTER_TYPE RegisterType,\r
+ IN UINT64 Index,\r
+ IN UINT64 ValueMask,\r
+ IN UINT64 Value\r
+ );\r
+\r
+/**\r
+ Adds an entry in specified Pre-SMM register table.\r
+\r
+ This function adds an entry in specified register table, with given register type,\r
+ register index, bit section and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] ValueMask Mask of bits in register to write\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+VOID\r
+EFIAPI\r
+PreSmmCpuRegisterTableWrite (\r
+ IN UINTN ProcessorNumber,\r
+ IN REGISTER_TYPE RegisterType,\r
+ IN UINT64 Index,\r
+ IN UINT64 ValueMask,\r
+ IN UINT64 Value\r
+ );\r
+\r
+/**\r
+ Adds a 32-bit register write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value) \\r
+ do { \\r
+ CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value); \\r
+ } while(FALSE);\r
+\r
+/**\r
+ Adds a 64-bit register write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value) \\r
+ do { \\r
+ CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value); \\r
+ } while(FALSE);\r
+\r
+/**\r
+ Adds a bit field write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, bit field section, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program.\r
+ @param[in] Index Index of the register to program.\r
+ @param[in] Type The data type name of a register structure.\r
+ @param[in] Field The bit fiel name in register structure to write.\r
+ @param[in] Value Value to write to the bit field.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define CPU_REGISTER_TABLE_WRITE_FIELD(ProcessorNumber, RegisterType, Index, Type, Field, Value) \\r
+ do { \\r
+ UINT64 ValueMask; \\r
+ ValueMask = MAX_UINT64; \\r
+ ((Type *)(&ValueMask))->Field = 0; \\r
+ CpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, ~ValueMask, Value); \\r
+ } while(FALSE);\r
+\r
+/**\r
+ Adds a 32-bit register write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define PRE_SMM_CPU_REGISTER_TABLE_WRITE32(ProcessorNumber, RegisterType, Index, Value) \\r
+ do { \\r
+ PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT32, Value); \\r
+ } while(FALSE);\r
+\r
+/**\r
+ Adds a 64-bit register write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program\r
+ @param[in] Index Index of the register to program\r
+ @param[in] Value Value to write\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define PRE_SMM_CPU_REGISTER_TABLE_WRITE64(ProcessorNumber, RegisterType, Index, Value) \\r
+ do { \\r
+ PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, MAX_UINT64, Value); \\r
+ } while(FALSE);\r
+\r
+/**\r
+ Adds a bit field write entry in specified register table.\r
+\r
+ This macro adds an entry in specified register table, with given register type,\r
+ register index, bit field section, and value.\r
+\r
+ @param[in] ProcessorNumber The index of the CPU to add a register table entry.\r
+ @param[in] RegisterType Type of the register to program.\r
+ @param[in] Index Index of the register to program.\r
+ @param[in] Type The data type name of a register structure.\r
+ @param[in] Field The bit fiel name in register structure to write.\r
+ @param[in] Value Value to write to the bit field.\r
+\r
+ @note This service could be called by BSP only.\r
+**/\r
+#define PRE_SMM_CPU_REGISTER_TABLE_WRITE_FIELD(ProcessorNumber, RegisterType, Index, Type, Field, Value) \\r
+ do { \\r
+ UINT64 ValueMask; \\r
+ ValueMask = MAX_UINT64; \\r
+ ((Type *)(&ValueMask))->Field = 0; \\r
+ PreSmmCpuRegisterTableWrite (ProcessorNumber, RegisterType, Index, ~ValueMask, Value); \\r
+ } while(FALSE);\r
+\r
+#endif\r
projects / mirror_edk2.git / blobdiff