ClockModulation.c File Reference

#include "CpuCommonFeatures.h"

Go to the source code of this file.

Data Structures
struct	CLOCK_MODULATION_CONFIG_DATA

Functions
VOID *EFIAPI	ClockModulationGetConfigData (IN UINTN NumberOfProcessors)
BOOLEAN EFIAPI	ClockModulationSupport (IN UINTN ProcessorNumber, IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo, IN VOID *ConfigData OPTIONAL)
RETURN_STATUS EFIAPI	ClockModulationInitialize (IN UINTN ProcessorNumber, IN REGISTER_CPU_FEATURE_INFORMATION *CpuInfo, IN VOID *ConfigData OPTIONAL, IN BOOLEAN State)

Detailed Description

Clock Modulation feature.

Copyright (c) 2017 - 2019, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file ClockModulation.c.

Function Documentation

ClockModulationGetConfigData()

VOID *EFIAPI ClockModulationGetConfigData

(

IN UINTN

NumberOfProcessors

)

Prepares for the data used by CPU feature detection and initialization.

Parameters

[in]

NumberOfProcessors

The number of CPUs in the platform.

Returns

Pointer to a buffer of CPU related configuration data.

Note

This service could be called by BSP only.

Definition at line 27 of file ClockModulation.c.

ClockModulationInitialize()

RETURN_STATUS EFIAPI ClockModulationInitialize	(	IN UINTN	ProcessorNumber,
		IN REGISTER_CPU_FEATURE_INFORMATION *	CpuInfo,
		IN VOID *ConfigData	OPTIONAL,
		IN BOOLEAN	State
	)

Initializes Clock Modulation feature to specific state.

Parameters

[in]	ProcessorNumber	The index of the CPU executing this function.
[in]	CpuInfo	A pointer to the REGISTER_CPU_FEATURE_INFORMATION structure for the CPU executing this function.
[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().
[in]	State	If TRUE, then the Clock Modulation feature must be enabled. If FALSE, then the Clock Modulation feature must be disabled.

Return values

RETURN_SUCCESS

Clock Modulation feature is initialized.

Note

This service could be called by BSP only.

Definition at line 100 of file ClockModulation.c.

ClockModulationSupport()

BOOLEAN EFIAPI ClockModulationSupport	(	IN UINTN	ProcessorNumber,
		IN REGISTER_CPU_FEATURE_INFORMATION *	CpuInfo,
		IN VOID *ConfigData	OPTIONAL
	)

Detects if Clock Modulation feature supported on current processor.

Parameters

[in]	ProcessorNumber	The index of the CPU executing this function.
[in]	CpuInfo	A pointer to the REGISTER_CPU_FEATURE_INFORMATION structure for the CPU executing this function.
[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().

Return values

TRUE	Clock Modulation feature is supported.
FALSE	Clock Modulation feature is not supported.

Note

This service could be called by BSP/APs.

Definition at line 56 of file ClockModulation.c.