UefiCpuPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / UefiCpuPkg / Library / CpuCommonFeaturesLib / LimitCpuIdMaxval.c

/** @file\r
  LimitCpuidMaxval Feature.\r
\r
  Copyright (c) 2017 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "CpuCommonFeatures.h"\r
\r
/**\r
  Detects if LimitCpuidMaxval 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     LimitCpuidMaxval feature is supported.\r
  @retval FALSE    LimitCpuidMaxval feature is not supported.\r
\r
  @note This service could be called by BSP/APs.\r
**/\r
BOOLEAN\r
EFIAPI\r
LimitCpuidMaxvalSupport (\r
  IN UINTN                             ProcessorNumber,\r
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,\r
  IN VOID                              *ConfigData  OPTIONAL\r
  )\r
{\r
  UINT32  Eax;\r
\r
  AsmCpuid (CPUID_SIGNATURE, &Eax, NULL, NULL, NULL);\r
  return (Eax > 2);\r
}\r
\r
/**\r
  Initializes LimitCpuidMaxval feature to specific state.\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 LimitCpuidMaxval feature must be enabled.\r
                               If FALSE, then the LimitCpuidMaxval feature must be disabled.\r
\r
  @retval RETURN_SUCCESS       LimitCpuidMaxval feature is initialized.\r
\r
  @note This service could be called by BSP only.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
LimitCpuidMaxvalInitialize (\r
  IN UINTN                             ProcessorNumber,\r
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,\r
  IN VOID                              *ConfigData,  OPTIONAL\r
  IN BOOLEAN                           State\r
  )\r
{\r
  //\r
  // The scope of LimitCpuidMaxval bit in the MSR_IA32_MISC_ENABLE is core for below\r
  // processor type, only program MSR_IA32_MISC_ENABLE for thread 0 in each core.\r
  //\r
  if (IS_PENTIUM_4_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel) ||\r\r
      IS_SILVERMONT_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel) ||\r
      IS_GOLDMONT_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel) ||\r
      IS_CORE_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel) ||\r
      IS_CORE2_PROCESSOR (CpuInfo->DisplayFamily, CpuInfo->DisplayModel)) {\r
    if (CpuInfo->ProcessorInfo.Location.Thread != 0) {\r
      return RETURN_SUCCESS;\r
    }\r
  }\r
\r
  CPU_REGISTER_TABLE_WRITE_FIELD (\r
    ProcessorNumber,\r
    Msr,\r
    MSR_IA32_MISC_ENABLE,\r
    MSR_IA32_MISC_ENABLE_REGISTER,\r
    Bits.LimitCpuidMaxval,\r
    (State) ? 1 : 0\r
    );\r
  return RETURN_SUCCESS;\r
}\r