RtfwSetWindowsEnergyPerformanceBias

RtfwSetWindowsEnergyPerformanceBias sets the configuration for the WindowsEnergyPerformanceBias feature.

Syntax

Copy

bool RtfwSetWindowsEnergyPerformanceBias(
    [in]    unsigned int WindowsEnergyPerfBias
);

Parameters

[in] WindowsEnergyPerfBias

The value with which to set the Windows Energy/Performance Bias. Supported values 0-15 and 255:

0 (High Performance / Low Energy Efficiency) through 15 (Low Performance / High Energy Efficiency).
255: uses the current Windows Energy/Performance Bias setting.

You can configure this in Windows through the System Utilities screen (System Configuration > BIOS/Platform Configuration (RBSU) > Power Management > Advanced Power Options > Energy/Performance Bias).

Return Value

If the function succeeds, it returns TRUE. If the function fails, it returns FALSE and sets the last error value. Call GetLastError to obtain an error code.

Possible error codes:

Error code	Meaning
RT_ERROR_FEATURE_NOT_AVAILABLE	The Windows Energy/Performance Bias feature is not supported.
ERROR_INVALID_PARAMETER	An invalid value has been specified for parameter WindowsEnergyPerfBias.
RT_ERROR_RESTART_SUBSYSTEM	The Subsystem was running when this function succeeded. RtfwRestartRequired will report that the wRTOS Subsystem must be restarted. Note: The wRTOS Subsystem must be restarted for the changes to take effect.
RT_ERROR_REGISTRY_MISSING	Could not find a value.

Remarks

Intel^® 64 processors may support an operating system hint to guide power management features to favor either increasing dynamic performance or conserving energy consumption at a per-core level. Since RTSS cores co-exist with Windows cores on the same socket, reducing the energy consumption on Windows cores will make more energy available for RTSS cores, leading to improved performance for RTSS processes and drivers. Therefore, we recommend that you set the Windows Energy/Performance Bias range to a value as close to the Low Performance / High Energy Efficiency end as possible, without degrading Windows performance to an unacceptable level.

Requirements

Minimum supported version	Header	Library
wRTOS 1.0 SDK	RtfwApi.h	RtfwApi.lib