General Adapter APIs
[Adapter Related APIs]


Functions

int ADL_Adapter_Active_Get (int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not.
int ADL_Adapter_NumberOfAdapters_Get (int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters.
int ADL_Flush_Driver_Data (int iAdapterIndex)
 Function to save driver data.
int ADL_Adapter_AdapterInfo_Get (LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information.
int ADL_Adapter_AdapterInfoX2_Get (AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information.
int ADL_Adapter_ASICFamilyType_Get (int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter.
int ADL_Adapter_Speed_Caps (int iAdapterIndex, int *lpCaps, int *lpValid)
 Function to get the current Force3DClock setting from the adapter.
int ADL_Adapter_Speed_Get (int iAdapterIndex, int *lpCurrent, int *lpDefault)
 Function to get the current Speed setting from the adapter.
int ADL_Adapter_Speed_Set (int iAdapterIndex, int iSpeed)
 Function to set the current Speed setting from the adapter.
int ADL_Adapter_Accessibility_Get (int iAdapterIndex, int *lpAccessibility)
 Function to check if the GPU is accessible or not at the time of this call.
int ADL_Adapter_VideoBiosInfo_Get (int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information.
int ADL_Adapter_ID_Get (int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter.

Detailed Description

This group describes general Adapter APIs.

Function Documentation

int ADL_Adapter_Active_Get ( int  iAdapterIndex,
int *  lpStatus 
)

Function to determine if the adapter is active or not.

The function is used to check if the adapter associated with iAdapterIndex is active. Logic is different for Windows and Linux!

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] lpStatus The pointer to the retrieved status. ADL_TRUE : Active; ADL_FALSE : Disabled.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Sample-Managed/ADL.cs.

int ADL_Adapter_NumberOfAdapters_Get ( int *  lpNumAdapters  ) 

Function to retrieve the number of OS-known adapters.

This function retrieves the number of graphics adapters recognized by the OS (OS-known adapters). OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[out] lpNumAdapters The pointer to the number of OS-known adapters.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Examples:
Sample-Managed/ADL.cs, and Sample/main.c.

int ADL_Flush_Driver_Data ( int  iAdapterIndex  ) 

Function to save driver data.

This function saves all required data from driver to persist updated settings

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

int ADL_Adapter_AdapterInfo_Get ( LPAdapterInfo  lpInfo,
int  iInputSize 
)

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iInputSize The size of the lpInfo buffer.
[out] lpInfo The pointer to the buffer containing the retrieved adapter information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API take a fixed-size output array. For dynamic-size output, use ADL_Adapter_AdapterInfoX2_Get function.
Examples:
Sample-Managed/ADL.cs, and Sample/main.c.

int ADL_Adapter_AdapterInfoX2_Get ( AdapterInfo **  lppAdapterInfo  ) 

Retrieves all OS-known adapter information.

This function retrieves the adapter information of all OS-known adapters in the system. OS-known adapters can include adapters that are physically present in the system (logical adapters) as well as ones that are no longer present in the system but are still recognized by the OS.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[out] lppAdapterInfo is pointer to the pointer of AdapterInfo array. Initialize to NULL before calling this API. ADL will allocate the necessary memory, using the user provided callback function.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API uses the memory allocation callback function provided by the user.

int ADL_Adapter_ASICFamilyType_Get ( int  iAdapterIndex,
int *  lpAsicTypes,
int *  lpValids 
)

Function to get the ASICFamilyType from the adapter.

This function retrieves the display Color Caps information for a specified adapter and display.

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] lpAsicTypes The pointer to the Color Caps information retrieved from the driver. Detailed asic types
[out] lpValids The pointer to the bit vector indicating which bit is valid on the lpAsicTypes returned.
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_Adapter_Speed_Caps ( int  iAdapterIndex,
int *  lpCaps,
int *  lpValid 
)

Function to get the current Force3DClock setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return valud can be ADL_ADAPTER_SPEEDCAPS_SUPPORTED or “0”

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] lpCaps The caps of adapter speed settings
[out] lpValid The valid bits of adapter speed settings
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_Adapter_Speed_Get ( int  iAdapterIndex,
int *  lpCurrent,
int *  lpDefault 
)

Function to get the current Speed setting from the adapter.

This function retrieves the adapter speed information for a specified adapter. Return value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

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] lpCurrent The current speed setting
[out] lpDefault The default speed setting
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_Adapter_Speed_Set ( int  iAdapterIndex,
int  iSpeed 
)

Function to set the current Speed setting from the adapter.

This function set the adapter speed information for a specified adapter. Input value is either ADL_CONTEXT_SPEED_UNFORCED or ADL_CONTEXT_SPEED_FORCEHIGH

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] iSpeed The speed to set on specified adapter
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_Adapter_Accessibility_Get ( int  iAdapterIndex,
int *  lpAccessibility 
)

Function to check if the GPU is accessible or not at the time of this call.

Some GPUs enter into various power savings mode when not in use, and during this time, direct access to the GPU can result in failures. Access through proper channels (such as via ADL) always works because the software accounts for the GPU's accessibility. However, direct access outside of authorised mechanisms may fail. Use this API to find out if the GPU is currently accessible or not. If API returns GPU accessible, this status will be maintained for 2 seconds.

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] lpAccessibility The pointer to an int value which indicates if the adapter is accessible or not (ADL_TRUE : Accessible, ADL_FALSE : Not accessible)
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Adapter_VideoBiosInfo_Get ( int  iAdapterIndex,
ADLBiosInfo lpBiosInfo 
)

ADL local interface. Function to retrieve BIOS information.

This function retrieves the BIOS information for a specified adapter.

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

int ADL_Adapter_ID_Get ( int  iAdapterIndex,
int *  lpAdapterID 
)

Function to get the unique identifier of an adapter.

This function retrieves the unique identifier of a specified adapter.
The adapter ID is a unique value and will be used to determine what other controllers share the same adapter.
The desktop will use this to find which HDCs are associated with an 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] lpAdapterID The pointer to the adapter identifier. Zero means: The adapter is not AMD.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
This API is a duplicate to ADL_Display_AdapterID_Get()


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