Overdrive6 APIs


Functions

int ADL_Overdrive6_Capabilities_Get (int iAdapterIndex, ADLOD6Capabilities *lpODCapabilities)
 Function to retrieve the current Overdrive capabilities.
int ADL_Overdrive6_StateInfo_Get (int iAdapterIndex, int iStateType, ADLOD6StateInfo *lpStateInfo)
 Function to retrieve the current or default Overdrive clock ranges.
int ADL_Overdrive6_State_Set (int iAdapterIndex, int iStateType, ADLOD6StateInfo *lpStateInfo)
 Function to set the current Overdrive clock ranges.
int ADL_Overdrive6_State_Reset (int iAdapterIndex, int iStateType)
 Function to reset the Overdrive clock ranges to default.
int ADL_Overdrive6_CurrentStatus_Get (int iAdapterIndex, ADLOD6CurrentStatus *lpCurrentStatus)
 Function to retrieve current Overdrive and performance-related activity.
int ADL_Overdrive6_ThermalController_Caps (int iAdapterIndex, ADLOD6ThermalControllerCaps *lpThermalControllerCaps)
 Function to retrieve capabilities of the GPU thermal controller.
int ADL_Overdrive6_Temperature_Get (int iAdapterIndex, int *lpTemperature)
 Function to retrieve GPU temperature from the thermal controller.
int ADL_Overdrive6_FanSpeed_Get (int iAdapterIndex, ADLOD6FanSpeedInfo *lpFanSpeedInfo)
 Function to retrieve the fan speed reported by the thermal controller.
int ADL_Overdrive6_FanSpeed_Set (int iAdapterIndex, ADLOD6FanSpeedValue *lpFanSpeedValue)
 Function to set the fan speed.
int ADL_Overdrive6_FanSpeed_Reset (int iAdapterIndex)
 Function to reset the fan speed to the default.
int ADL_Overdrive6_PowerControl_Caps (int iAdapterIndex, int *lpSupported)
 Function to check for PowerControl capabilities.
int ADL_Overdrive6_PowerControlInfo_Get (int iAdapterIndex, ADLOD6PowerControlInfo *lpPowerControlInfo)
 Function to get the PowerControl adjustment range.
int ADL_Overdrive6_PowerControl_Get (int iAdapterIndex, int *lpCurrentValue, int *lpDefaultValue)
 Function to get the current and default PowerControl adjustment values.
int ADL_Overdrive6_PowerControl_Set (int iAdapterIndex, int iValue)
 Function to set the current PowerControl adjustment value.

Detailed Description

This group outlines all Overdrive6 related APIs

Function Documentation

int ADL_Overdrive6_Capabilities_Get ( int  iAdapterIndex,
ADLOD6Capabilities lpODCapabilities 
)

Function to retrieve the current Overdrive capabilities.

This function retrieves the current Overdrive capabilities for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpODCapabilities The pointer to the ADLOD6Capabilities structure storing the retrieved Overdrive parameters.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_StateInfo_Get ( int  iAdapterIndex,
int  iStateType,
ADLOD6StateInfo lpStateInfo 
)

Function to retrieve the current or default Overdrive clock ranges.

This function retrieves the current or default Overdrive clock ranges for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iStateType Specifies if default or current clock ranges for the power state will be retrieved. Currently only performance state is supported. Possible Values: ADL_OD6_GETSTATEINFO_DEFAULT_PERFORMANCE, ADL_OD6_GETSTATEINFO_CUSTOM_PERFORMANCE, ADL_OD6_GETSTATEINFO_CURRENT
[in,out] lpStateInfo Pointer to the retrieved clock range info structure ADLOD6StateInfo.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_State_Set ( int  iAdapterIndex,
int  iStateType,
ADLOD6StateInfo lpStateInfo 
)

Function to set the current Overdrive clock ranges.

This function sets the current Overdrive clock ranges for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iStateType The power state which will have clock ranges changed. Currently only performance state is supported. Possible Values: ADL_OD6_SETSTATE_PERFORMANCE
[in] lpStateInfo Pointer to the structure ADLOD6StateInfo containing clock ranges to be set.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_State_Reset ( int  iAdapterIndex,
int  iStateType 
)

Function to reset the Overdrive clock ranges to default.

This function resets the Overdrive clock ranges to default for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iStateType The power state which will be reset to default clock ranges. Currently only performance state is supported. Possible Values: ADL_OD6_SETSTATE_PERFORMANCE
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_CurrentStatus_Get ( int  iAdapterIndex,
ADLOD6CurrentStatus lpCurrentStatus 
)

Function to retrieve current Overdrive and performance-related activity.

This function retrieves current Overdrive and performance-related activity for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpCurrentStatus The pointer to the ADLOD6CurrentStatus structure storing the retrieved activity information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_ThermalController_Caps ( int  iAdapterIndex,
ADLOD6ThermalControllerCaps lpThermalControllerCaps 
)

Function to retrieve capabilities of the GPU thermal controller.

This function retrieves GPU thermal controller capabilities for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpThermalControllerInfo The pointer to the ADLThermalControllerInfo structure storing the retrieved GPU thermal controller information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_Temperature_Get ( int  iAdapterIndex,
int *  lpTemperature 
)

Function to retrieve GPU temperature from the thermal controller.

This function retrieves GPU temperature from the thermal controller for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpTemperature The pointer to the retrieved temperature.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_FanSpeed_Get ( int  iAdapterIndex,
ADLOD6FanSpeedInfo lpFanSpeedInfo 
)

Function to retrieve the fan speed reported by the thermal controller.

This function retrieves the reported fan speed from a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpFanSpeedInfo The pointer to the ADLOD6FanSpeedInfo structure storing the retrieved fan speed.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_FanSpeed_Set ( int  iAdapterIndex,
ADLOD6FanSpeedValue lpFanSpeedValue 
)

Function to set the fan speed.

This function sets the fan speed for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] lpFanSpeedValue The pointer to the ADLOD6FanSpeedValue structure containing the new fan speed value to be set.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_FanSpeed_Reset ( int  iAdapterIndex  ) 

Function to reset the fan speed to the default.

This function resets the fan speed for a specified adapter to the default.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Overdrive6_PowerControl_Caps ( int  iAdapterIndex,
int *  lpSupported 
)

Function to check for PowerControl capabilities.

This function returns the PowerControl capability of the specified adapter. PowerControl is the feature which allows the performance characteristics of the GPU to be adjusted by changing the PowerTune power limits. Increasing the PowerControl value can increase maximum performance, but may cause more power to be consumed. Decreasing the PowerControl value can lower power consumption, but may cause lower performance.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpSupported The pointer to a value that receives the PowerControl capability of the adapter. Non-zero if PowerControl is supported.
Returns:
If the function succeeds, the return value is ADL_OK (zero). Otherwise the return value is an ADL error code (non-zero). Result Codes

int ADL_Overdrive6_PowerControlInfo_Get ( int  iAdapterIndex,
ADLOD6PowerControlInfo lpPowerControlInfo 
)

Function to get the PowerControl adjustment range.

This function returns the PowerControl adjustment range (in percentage) for the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] lpPowerControlInfo The pointer to the ADLOD6PowerControlInfo returning the PowerControl adjustment range.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code.

int ADL_Overdrive6_PowerControl_Get ( int  iAdapterIndex,
int *  lpCurrentValue,
int *  lpDefaultValue 
)

Function to get the current and default PowerControl adjustment values.

This function returns the current and default PowerControl adjustment values for the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpCurrentValue pointer to the current PowerControl adjustment value.
[out] lpDefaultValue pointer to the default PowerControl adjustment value.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code.

int ADL_Overdrive6_PowerControl_Set ( int  iAdapterIndex,
int  iValue 
)

Function to set the current PowerControl adjustment value.

This function sets the current PowerControl adjustment value.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iValue The new PowerControl adjustment value to be set.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code.


Copyright © 2009-2013 Advanced Micro Devices, Inc. All rights reserved.  AMD Developer