UefiCpuPkg: Replace BSD License with BSD+Patent License

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

/** @file\r
  Clock Modulation 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 Clock Modulation 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     Clock Modulation feature is supported.\r
  @retval FALSE    Clock Modulation feature is not supported.\r
\r
  @note This service could be called by BSP/APs.\r
**/\r
BOOLEAN\r
EFIAPI\r
ClockModulationSupport (\r
  IN UINTN                             ProcessorNumber,\r
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,\r
  IN VOID                              *ConfigData  OPTIONAL\r
  )\r
{\r
  return (CpuInfo->CpuIdVersionInfoEdx.Bits.ACPI == 1);\r
}\r
\r
/**\r
  Initializes Clock Modulation 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 Clock Modulation feature must be enabled.\r
                               If FALSE, then the Clock Modulation feature must be disabled.\r
\r
  @retval RETURN_SUCCESS       Clock Modulation feature is initialized.\r
\r
  @note This service could be called by BSP only.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
ClockModulationInitialize (\r
  IN UINTN                             ProcessorNumber,\r
  IN REGISTER_CPU_FEATURE_INFORMATION  *CpuInfo,\r
  IN VOID                              *ConfigData,  OPTIONAL\r
  IN BOOLEAN                           State\r
  )\r
{\r
  CPUID_THERMAL_POWER_MANAGEMENT_EAX   ThermalPowerManagementEax;\r
  AsmCpuid (CPUID_THERMAL_POWER_MANAGEMENT, &ThermalPowerManagementEax.Uint32, NULL, NULL, NULL);\r
\r
  CPU_REGISTER_TABLE_WRITE_FIELD (\r
    ProcessorNumber,\r
    Msr,\r
    MSR_IA32_CLOCK_MODULATION,\r
    MSR_IA32_CLOCK_MODULATION_REGISTER,\r
    Bits.OnDemandClockModulationDutyCycle,\r
    PcdGet8 (PcdCpuClockModulationDutyCycle) >> 1\r
    );\r
  if (ThermalPowerManagementEax.Bits.ECMD == 1) {\r
    CPU_REGISTER_TABLE_WRITE_FIELD (\r
      ProcessorNumber,\r
      Msr,\r
      MSR_IA32_CLOCK_MODULATION,\r
      MSR_IA32_CLOCK_MODULATION_REGISTER,\r
      Bits.ExtendedOnDemandClockModulationDutyCycle,\r
      PcdGet8 (PcdCpuClockModulationDutyCycle) & BIT0\r
      );\r
  }\r
  CPU_REGISTER_TABLE_WRITE_FIELD (\r
    ProcessorNumber,\r
    Msr,\r
    MSR_IA32_CLOCK_MODULATION,\r
    MSR_IA32_CLOCK_MODULATION_REGISTER,\r
    Bits.OnDemandClockModulationEnable,\r
    (State) ? 1 : 0\r
    );\r
  return RETURN_SUCCESS;\r
}\r