adapter.h File Reference

Contains all adapter-related functions exposed by ADL for Linux and Windows(XP, Vista and above); 32bit and 64bit platforms. More...


Defines

#define ADL_EXTERNC

Functions

int ADL2_Adapter_Active_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not.
int ADL_Adapter_Active_Get (int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not.
int ADL2_Adapter_Aspects_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, char *lpAspects, int iSize)
 ADL local interface. Function to retrieve the supported aspects list.
int ADL_Adapter_Aspects_Get (int iAdapterIndex, char *lpAspects, int iSize)
 ADL local interface. Function to retrieve the supported aspects list.
int ADL2_Adapter_NumberOfAdapters_Get (ADL_CONTEXT_HANDLE context, int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters.
int ADL_Adapter_NumberOfAdapters_Get (int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters.
int ADL2_Flush_Driver_Data (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to save driver data.
int ADL_Flush_Driver_Data (int iAdapterIndex)
 Function to save driver data.
int ADL2_Adapter_AdapterInfo_Get (ADL_CONTEXT_HANDLE context, LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information.
int ADL_Adapter_AdapterInfo_Get (LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information.
int ADL2_Adapter_AdapterInfoX2_Get (ADL_CONTEXT_HANDLE context, AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information.
int ADL_Adapter_AdapterInfoX2_Get (AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information.
int ADL2_Adapter_ASICFamilyType_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter.
int ADL_Adapter_ASICFamilyType_Get (int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter.
int ADL2_Adapter_Speed_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCaps, int *lpValid)
 Function to get the current Force3DClock setting 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 ADL2_Adapter_Speed_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCurrent, int *lpDefault)
 Function to get the current Speed 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 ADL2_Adapter_Speed_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSpeed)
 Function to set 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 ADL2_Adapter_Accessibility_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAccessibility)
 Function to check if the GPU is accessible or not at the time of this call.
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 ADL2_Adapter_VideoBiosInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information.
int ADL_Adapter_VideoBiosInfo_Get (int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information.
int ADL2_Adapter_ID_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter.
int ADL_Adapter_ID_Get (int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter.
int ADL2_AdapterX2_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information.
int ADL_AdapterX2_Caps (int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information.
int ADL2_Adapter_Crossfire_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpPreferred, int *lpNumComb, ADLCrossfireComb **ppCrossfireComb)
 Function to retrieve CrossfireX capabilities of the system.
int ADL_Adapter_Crossfire_Caps (int iAdapterIndex, int *lpPreferred, int *lpNumComb, ADLCrossfireComb **ppCrossfireComb)
 Function to retrieve CrossfireX capabilities of the system.
int ADL2_Adapter_Crossfire_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 Function to get current CrossfireX combination settings.
int ADL_Adapter_Crossfire_Get (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 Function to get current CrossfireX combination settings.
int ADL2_Adapter_Crossfire_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
 Function to set CrossfireX combination settings.
int ADL_Adapter_Crossfire_Set (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
 Function to set CrossfireX combination settings.
int ADL2_Adapter_MVPU_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iState)
 Function to set CrossfireX status.
int ADL2_Adapter_MemoryInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfo *lpMemoryInfo)
 Function to retrieve memory information from the adapter.
int ADL_Adapter_MemoryInfo_Get (int iAdapterIndex, ADLMemoryInfo *lpMemoryInfo)
 Function to retrieve memory information from the adapter.
int ADL2_Adapter_ConfigMemory_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iScreenWidth, int iScreenHeight, int displayFeatureMask, int numDisplays, ADLMemoryDisplayFeatures *displayFeatureList, int *iNumMemTypes, ADLMemoryRequired **lppMemRequired)
 Function to get the memory configuration of an adapter.
int ADL_Adapter_ConfigMemory_Get (int iAdapterIndex, int iScreenWidth, int iScreenHeight, int displayFeatureMask, int numDisplays, ADLMemoryDisplayFeatures *displayFeatureList, int *iNumMemTypes, ADLMemoryRequired **lppMemRequired)
 Function to get the memory configuration of an adapter.
int ADL2_Adapter_ObservedClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCoreClock, int *lpMemoryClock)
 Function to get the core and memory clock info of an adapter.  This is the clock displayed on CCC information center.          Specific logic is used to select appropriate clock for display in current configuration.
int ADL_Adapter_ObservedClockInfo_Get (int iAdapterIndex, int *lpCoreClock, int *lpMemoryClock)
 Function to get the core and memory clock info of an adapter.  This is the clock displayed on CCC information center.          Specific logic is used to select appropriate clock for display in current configuration.
int ADL2_Adapter_BoardLayout_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValidFlags, int *lpNumberSlots, ADLBracketSlotInfo **lppBracketSlot, int *lpNumberConnector, ADLConnectorInfo **lppConnector)
 Function to get the board layout information.
int ADL_Adapter_BoardLayout_Get (int iAdapterIndex, int *lpValidFlags, int *lpNumberSlots, ADLBracketSlotInfo **lppBracketSlot, int *lpNumberConnector, ADLConnectorInfo **lppConnector)
 Function to get the board layout information.
int ADL2_Adapter_SupportedConnections_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, ADLSupportedConnections *lpADLSupportedConnections)
 Function to get the supported connection types of given connector.
int ADL_Adapter_SupportedConnections_Get (int iAdapterIndex, ADLDevicePort devicePort, ADLSupportedConnections *lpADLSupportedConnections)
 Function to get the supported connection types of given connector.
int ADL2_Adapter_ConnectionState_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionState *lpADLConnectionState)
 Function to get the current emulation state of a given connector.
int ADL_Adapter_ConnectionState_Get (int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionState *lpADLConnectionState)
 Function to get the current emulation state of a given connector.
int ADL2_Adapter_EmulationMode_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, int iEmulationMode)
 Function to sets the emulation mode of given connector.
int ADL_Adapter_EmulationMode_Set (int iAdapterIndex, ADLDevicePort devicePort, int iEmulationMode)
 Function to sets the emulation mode of given connector.
int ADL2_Adapter_ConnectionData_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionData ConnectionData)
 Function to set the emulation data to on specified connector.
int ADL_Adapter_ConnectionData_Set (int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionData ConnectionData)
 Function to set the emulation data to on specified connector.
int ADL2_Adapter_ConnectionData_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, int iQueryType, ADLConnectionData *lpConnectionData)
 Function to gets the emulation data on specified connector.
int ADL_Adapter_ConnectionData_Get (int iAdapterIndex, ADLDevicePort devicePort, int iQueryType, ADLConnectionData *lpConnectionData)
 Function to gets the emulation data on specified connector.
int ADL2_Adapter_ConnectionData_Remove (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort)
 Function to remove emulation on specified connector.
int ADL_Adapter_ConnectionData_Remove (int iAdapterIndex, ADLDevicePort devicePort)
 Function to remove emulation on specified connector.
int ADL2_Adapter_EDIDManagement_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)
 Function to retrieve EDID management feature support.
int ADL_Adapter_EDIDManagement_Caps (int iAdapterIndex, int *lpSupported)
 Function to retrieve EDID management feature support.
int ADL2_Workstation_GlobalEDIDPersistence_Get (ADL_CONTEXT_HANDLE context, int *lpCurResultValue, int *lpDefResultValue)
 Function to get the EDID Persistence state of the system.
int ADL_Workstation_GlobalEDIDPersistence_Get (int *lpCurResultValue, int *lpDefResultValue)
 Function to get the EDID Persistence state of the system.
int ADL2_Workstation_GlobalEDIDPersistence_Set (ADL_CONTEXT_HANDLE context, int iCurState)
 Function to set the EDID Persistence state of the system.
int ADL_Workstation_GlobalEDIDPersistence_Set (int iCurState)
 Function to set the EDID Persistence state of the system.
int ADL2_Adapter_ClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLClockInfo *lpClockInfo)
 Function to retrieve clock information for an adapter.
int ADL_Adapter_ClockInfo_Get (int iAdapterIndex, ADLClockInfo *lpClockInfo)
 Function to retrieve clock information for an adapter.
int ADL2_Display_AdapterID_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter. Will be removed! Use ADL_Adapter_ID_Get().
int ADL_Display_AdapterID_Get (int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter. Will be removed! Use ADL_Adapter_ID_Get().
int ADL2_Adapter_EDC_ErrorRecords_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *pErrorrecordCount, ADLErrorRecord *errorRecords)
 Function to retrieve Gfx EDC Error Log.
int ADL2_Adapter_EDC_ErrorInjection_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLErrorInjection *errorInjection)
 Function to inject Gfx EDC Error .
int ADL2_Adapter_Graphic_Core_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLGraphicCoreInfo *pGraphicCoreInfo)
 Function to retrieve Graphic Core Info.


Detailed Description

Contains all adapter-related functions exposed by ADL for Linux and Windows(XP, Vista and above); 32bit and 64bit platforms.

Contains all graphics-related functions exposed by ADL for Linux and Windows(XP, Vista and above); 32bit and 64bit platforms.

Copyright (c) 2008 - 2009 Advanced Micro Devices, Inc. THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE. This file contains all adapter-related functions exposed by ADL for Linux and Windows(XP, Vista and above); 32bit and 64bit platforms. All functions in this file can be used as a reference to ensure the appropriate function pointers can be used by the appropriate runtime dynamic library loaders.

Copyright (c) 2008 - 2009 Advanced Micro Devices, Inc. THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE. This file contains all graphics-related functions exposed by ADL for Linux and Windows(XP, Vista and above); 32bit and 64bit platforms. All functions found in this file can be used as a reference when creating specific function pointers to be used by the appropriate runtime dynamic library loaders.


Define Documentation

#define ADL_EXTERNC


Function Documentation

int ADL2_Adapter_ClockInfo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLClockInfo lpClockInfo 
)

Function to retrieve clock information for an adapter.

This function retrieves the clock information for a specified graphics adapter. Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpClockInfo The pointer to the structure storing the retrieved core and memory clock information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it does not provide accurate clocks when the ASIC is over-clocked. Use the OD5 set of APIs, when OverDrive5 is supported.
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Adapter_ClockInfo_Get ( int  iAdapterIndex,
ADLClockInfo lpClockInfo 
)

Function to retrieve clock information for an adapter.

This function retrieves the clock information for a specified graphics adapter. Linux and Windows(XP, Vista and above); 32bit and 64bit

Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpClockInfo The pointer to the structure storing the retrieved core and memory clock information.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Deprecated:
This API has been deprecated because it does not provide accurate clocks when the ASIC is over-clocked. Use the OD5 set of APIs, when OverDrive5 is supported.

int ADL2_Display_AdapterID_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpAdapterID 
)

Function to get the unique identifier of an adapter. Will be removed! Use ADL_Adapter_ID_Get().

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 above); 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[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
Deprecated:
This API will be removed. Use the duplicate API ADL_Adapter_ID_Get()
Remarks:
Clients can use ADL2 version of the API to assure that there is no interference with other ADL clients that are running in the same process . Such clients have to call ADL2_Main_Control_Create first to obtain ADL_CONTEXT_HANDLE instance that has to be passed to each subsequent ADL2 call and finally destroyed using ADL2_Main_Control_Destroy.

int ADL_Display_AdapterID_Get ( int  iAdapterIndex,
int *  lpAdapterID 
)

Function to get the unique identifier of an adapter. Will be removed! Use ADL_Adapter_ID_Get().

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 above); 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
Deprecated:
This API will be removed. Use the duplicate API ADL_Adapter_ID_Get()

int ADL2_Adapter_EDC_ErrorRecords_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  pErrorrecordCount,
ADLErrorRecord errorRecords 
)

Function to retrieve Gfx EDC Error Log.

This function implements a call to retrieve Gfx EDC Error Logs.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] pErrorrecordCount The pointer to the number of error records
[out] errorRecords The pointer to error records
Returns:
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

int ADL2_Adapter_EDC_ErrorInjection_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLErrorInjection errorInjection 
)

Function to inject Gfx EDC Error .

This function implements a call to inject Gfx EDC Error.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] errorInjection The pointer to error injection
Returns:
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

int ADL2_Adapter_Graphic_Core_Info_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLGraphicCoreInfo pGraphicCoreInfo 
)

Function to retrieve Graphic Core Info.

This function implements a call to retrieve Graphic Core Info.

Supported Platforms:
Windows Vista and Windows 7; 32bit and 64bit
Parameters:
[in] context,: Client's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] pGraphicCoreInfo The pointer to Graphic Core Info
Returns:
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes


Copyright © 2009-2016 Advanced Micro Devices, Inc. All rights reserved.