ADL (AMD Display Library) Public APIs  Version 17.1
Macros | Functions
adapter.h File Reference

Copyright (c) 2008 - 2022 Advanced Micro Devices, Inc. More...

#include "adl_structures.h"

Go to the source code of this file.

Macros

#define ADL_EXTERNC
 

Functions

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. More...
 
int ADL2_Adapter_AceDefaults_Restore (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 
int ADL2_Adapter_Active_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not. More...
 
int ADL2_Adapter_Active_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iStatus, int *lpNewlyActivate)
 Function to set the current extended desktop mode status for a display. More...
 
int ADL2_Adapter_Active_SetPrefer (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iStatus, int iNumPreferTarget, ADLDisplayTarget *lpPreferTarget, int *lpNewlyActivate)
 Function to set the current extended desktop mode status for the display. More...
 
int ADL2_Adapter_AdapterInfo_Get (ADL_CONTEXT_HANDLE context, LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information. More...
 
int ADL2_Adapter_AdapterInfoX2_Get (ADL_CONTEXT_HANDLE context, AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information. More...
 
int ADL2_Adapter_AdapterInfoX3_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *numAdapters, AdapterInfo **lppAdapterInfo)
 
int ADL2_Adapter_AdapterInfoX4_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *numAdapters, AdapterInfoX2 **lppAdapterInfoX2)
 
int ADL2_Adapter_AdapterList_Disable (ADL_CONTEXT_HANDLE context, int iNumAdapters, int *lpAdapterIndexList, bool isSkipSaveDB=false)
 
int ADL2_Adapter_ASICFamilyType_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter. More...
 
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. More...
 
int ADL2_Adapter_BigSw_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpBigSwSupportMajor, int *lpBigSwSupportMinor, int *lpRedStoneSupport)
 
int ADL2_Adapter_BoardLayout_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValidFlags, int *lpNumberSlots, ADLBracketSlotInfo **lppBracketSlot, int *lpNumberConnector, ADLConnectorInfo **lppConnector)
 
int ADL2_Adapter_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCaps *adapterCaps)
 
int ADL2_Adapter_ChipSetInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLChipSetInfo *lpChipSetInfo)
 
int ADL2_Adapter_ClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLClockInfo *lpClockInfo)
 Function to retrieve clock information for an adapter. More...
 
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. More...
 
int ADL2_Adapter_ConnectionData_Remove (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort)
 Function to remove emulation on specified connector. More...
 
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. More...
 
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. More...
 
int ADL2_Adapter_Crossfire_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpPreferred, int *lpNumComb, ADLCrossfireComb **ppCrossfireComb)
 
int ADL2_Adapter_Crossfire_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 
int ADL2_Adapter_Crossfire_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
 Function to set CrossfireX combination settings. More...
 
int ADL2_Adapter_CrossfireX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 Function to get current CrossfireX settings for both QUAD and Software crossfire. More...
 
int ADL2_Adapter_DedicatedVRAMUsage_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVRAMUsageInMB)
 
int ADL2_Adapter_EDC_ErrorInjection_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLErrorInjection *errorInjection)
 Function to inject Gfx EDC Error . More...
 
int ADL2_Adapter_EDC_ErrorRecords_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *pErrorrecordCount, ADLErrorRecord *errorRecords)
 Function to retrieve Gfx EDC Error Log. More...
 
int ADL2_Adapter_EDIDManagement_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)
 Function to retrieve EDID management feature support. More...
 
int ADL2_Adapter_EmulationMode_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLDevicePort devicePort, int iEmulationMode)
 Function to sets the emulation mode of given connector. More...
 
int ADL2_Adapter_Feature_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int *iIsFeatureSupported)
 
int ADL2_Adapter_FrameMetrics_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iIsFrameMonitorSupported)
 
int ADL2_Adapter_FrameMetrics_FrameDuration_Disable (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRAME_DURATION_HANDLE *frameDurationHandle)
 
int ADL2_Adapter_FrameMetrics_FrameDuration_Enable (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_FRAME_DURATION_HANDLE *frameDurationHandle)
 
int ADL2_Adapter_FrameMetrics_FrameDuration_Get (ADL_CONTEXT_HANDLE context, ADL_FRAME_DURATION_HANDLE frameDurationHandle, unsigned long long *pFrameDurationsArr, unsigned int frameDurationsArrSize, unsigned int *elementsCopied)
 
int ADL2_Adapter_FrameMetrics_FrameDuration_Start (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)
 
int ADL2_Adapter_FrameMetrics_FrameDuration_Stop (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)
 
int ADL2_Adapter_FrameMetrics_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId, float *iFramesPerSecond)
 
int ADL2_Adapter_FrameMetrics_Start (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)
 
int ADL2_Adapter_FrameMetrics_Stop (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int VidPnSourceId)
 
int ADL2_Adapter_HBC_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpHbcCapable)
 
int ADL2_Adapter_Headless_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpHeadless)
 
int ADL2_Adapter_ID_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter. More...
 
int ADL2_Adapter_IsGamingDriver_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpCwgSupport, int *lpIsGamingMode)
 
int ADL2_Adapter_KeepAwake_Start (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_D3DKMT_HANDLE hDevice)
 Function to start keeping adatper awake. More...
 
int ADL2_Adapter_KeepAwake_Stop (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_D3DKMT_HANDLE hDevice)
 Function to stop keeping adapter awake. More...
 
int ADL2_Adapter_LED_Support_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion)
 
int ADL2_Adapter_MemoryInfo2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfo2 *lpMemoryInfo2)
 
int ADL2_Adapter_MemoryInfoX4_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLMemoryInfoX4 *lpMemoryInfoX4)
 
int ADL2_Adapter_Modes_ReEnumerate (ADL_CONTEXT_HANDLE context)
 
int ADL2_Adapter_ModeSwitch (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to perform a mode switch for an adapter. More...
 
int ADL2_Adapter_MVPU_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iState)
 Function to set CrossfireX status. More...
 
int ADL2_Adapter_NumberOfAdapters_Get (ADL_CONTEXT_HANDLE context, int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters. More...
 
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. More...
 
int ADL2_Adapter_Primary_Get (ADL_CONTEXT_HANDLE context, int *lpPrimaryAdapterIndex)
 Function to retrieve the primary display adapter index. More...
 
int ADL2_Adapter_Primary_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to set the primary display adapter index. More...
 
int ADL2_Adapter_RegValueInt_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int *lpKeyValue)
 ADL local interface. Function to query a integer registry value set by driver. More...
 
int ADL2_Adapter_RegValueInt_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iKeyValue)
 ADL local interface. Function to set a driver registry integer value. More...
 
int ADL2_Adapter_RegValueString_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to query a string registry value set by driver. More...
 
int ADL2_Adapter_RegValueString_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to set a driver registry string value. More...
 
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. More...
 
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. More...
 
int ADL2_Adapter_Speed_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSpeed)
 Function to set the current Speed setting from the adapter. More...
 
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. More...
 
int ADL2_Adapter_TRNG_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iTRNGSize, int iTRNGBufferSize, char *lpTRNGBuffer)
 
int ADL2_Adapter_VerndorID_Int_get (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Retrieves adapter vendor id. More...
 
int ADL2_Adapter_VideoBiosInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information. More...
 
int ADL2_Adapter_VideoTheaterModeInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpOverlayDisplayMode, int *lpSavedSettings)
 Function to get MM video theater mode info. More...
 
int ADL2_Adapter_VideoTheaterModeInfo_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iOverlayDisplayMode, int iSavedSettings)
 Function to set MM video theater mode info. More...
 
int ADL2_Adapter_VRAMUsage_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVRAMUsageInMB)
 
int ADL2_AdapterX2_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information. More...
 
int ADL2_BOOST_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_BOOST_SETTINGS *settings)
 Function to get the BOOST settings This function retrieves the BOOST settings for a specified display adapter. More...
 
int ADL2_BOOST_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_BOOST_SETTINGS settings, ADL_BOOST_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set BOOST settings This function sets the user input values to BOOST feature. More...
 
int ADL2_BOOST_SettingsX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_BOOST_SETTINGS settings, ADL_BOOST_NOTFICATION_REASON changeReason, ADL_ERROR_REASON2 *errorReason)
 
int ADL2_Chill_Caps_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iCheckCaps)
 
int ADL2_Chill_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpEnabled)
 
int ADL2_Chill_Settings_Notify (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iChanged)
 
int ADL2_Chill_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iEnabled)
 
int ADL2_CHILL_SettingsX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_CHILL_SETTINGS *settings)
 Function to get the CHILL settings This function retrieves the CHILL settings for a specified display adapter. More...
 
int ADL2_CHILL_SettingsX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_CHILL_SETTINGS settings, ADL_CHILL_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set CHILL settings This function sets the user input values to CHILL feature. More...
 
int ADL2_CHILL_SettingsX3_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_CHILL_SETTINGS settings, ADL_CHILL_NOTFICATION_REASON changeReason, ADL_ERROR_REASON2 *errorReason)
 
int ADL2_DELAG_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_DELAG_SETTINGS *settings)
 Function to get the DELAG settings This function retrieves the DELAG settings for a specified display adapter. More...
 
int ADL2_DELAG_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_DELAG_SETTINGS settings, ADL_DELAG_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set DELAG settings This function sets the user input values to DELAG feature. More...
 
int ADL2_DELAG_SettingsX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_DELAG_SETTINGS settings, ADL_DELAG_NOTFICATION_REASON changeReason, ADL_ERROR_REASON2 *errorReason)
 
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() More...
 
int ADL2_ElmCompatibilityMode_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_ElmCompatibilityMode_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValue)
 
int ADL2_ElmCompatibilityMode_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iValue)
 
int ADL2_Feature_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int *iCurrent)
 
int ADL2_Feature_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_UIFEATURES_GROUP iFeatureID, int iCurrent)
 
int ADL2_Flush_Driver_Data (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to save driver data. More...
 
int ADL2_FPS_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpVersion)
 Function to retrieve FPS Global Setting Capability. More...
 
int ADL2_FPS_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFPSSettingsOutput *lpFPSSettings)
 Function to retrieve FPS Global Settings. More...
 
int ADL2_FPS_Settings_Reset (ADL_CONTEXT_HANDLE context, int iAdapterIndex)
 Function to reset FPS Global Settings. More...
 
int ADL2_FPS_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFPSSettingsInput lpFPSSettings)
 Function to update FPS Global Settings. More...
 
int ADL2_GcnAsicInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLGcnInfo *gcnInfo)
 
int ADL2_GPUVMPageSize_Info_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iVMPageSizeSupport, int *iVMPageSizeType)
 
int ADL2_GPUVMPageSize_Info_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iVMPageSizeType)
 
int ADL2_MMD_Features_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureCaps **lppFeatureCaps, int *lpFeatureCount)
 
int ADL2_MMD_FeatureValues_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureValues **lppFeatureValues, int *lpFeatureCount)
 
int ADL2_MMD_FeatureValues_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLFeatureValues *lpFeatureValues, int iFeatureCount, int ClientID)
 
int ADL2_PageMigration_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLVirtualSegmentSettingsOutput *lpVirtualSegSettings)
 
int ADL2_PageMigration_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iEnabled, int iNewSize)
 
int ADL2_PerformanceTuning_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_PerfTuning_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpPTuningValue)
 
int ADL2_PerfTuning_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int lpPTuningValue)
 
int ADL2_PPW_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpDefault)
 
int ADL2_PPW_Status_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpFPWValue)
 
int ADL2_PPW_Status_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iFPWValue)
 
int ADL2_PROVSR_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_PROVSR_SETTINGS *settings)
 Function to get the Pro VSR settings This function retrieves the Pro VSR for a specified display adapter. More...
 
int ADL2_PROVSR_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_PROVSR_SETTINGS settings, ADL_PROVSR_NOTFICATION_REASON changeReason, ADL_ERROR_REASON *errorReason)
 Function to set Pro VSR settings This function sets the user input values to VSR feature. More...
 
int ADL2_RIS_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_RIS_SETTINGS *settings)
 Function to get the RIS settings This function retrieves the RIS settings for a specified display adapter. More...
 
int ADL2_RIS_Settings_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADL_RIS_SETTINGS settings, ADL_RIS_NOTFICATION_REASON changeReason)
 Function to set RIS settings This function sets the user input values to RIS feature. More...
 
int ADL2_SmartShift_DeltaGain_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iMode, int iValue)
 
int ADL2_SmartShift_Settings_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLSmartShiftSettings *lpCurrent)
 
int ADL2_SmartShift_Support (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported, int *lpVersion)
 
int ADL2_Stress_Test_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion)
 
int ADL2_Throttle_Notification_Cap (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion)
 
int ADL2_Workstation_GlobalEDIDPersistence_Get (ADL_CONTEXT_HANDLE context, int *lpCurResultValue, int *lpDefResultValue)
 Function to get the EDID Persistence state of the system. More...
 
int ADL2_Workstation_GlobalEDIDPersistence_Set (ADL_CONTEXT_HANDLE context, int iCurState)
 Function to set the EDID Persistence state of the system. More...
 
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. More...
 
int ADL_Adapter_Active_Get (int iAdapterIndex, int *lpStatus)
 Function to determine if the adapter is active or not. More...
 
int ADL_Adapter_Active_Set (int iAdapterIndex, int iStatus, int *lpNewlyActivate)
 Function to set the current extended desktop mode status for a display. More...
 
int ADL_Adapter_Active_SetPrefer (int iAdapterIndex, int iStatus, int iNumPreferTarget, ADLDisplayTarget *lpPreferTarget, int *lpNewlyActivate)
 Function to set the current extended desktop mode status for the display. More...
 
int ADL_Adapter_AdapterInfo_Get (LPAdapterInfo lpInfo, int iInputSize)
 Retrieves all OS-known adapter information. More...
 
int ADL_Adapter_AdapterInfoX2_Get (AdapterInfo **lppAdapterInfo)
 Retrieves all OS-known adapter information. More...
 
int ADL_Adapter_AdapterList_Disable (int iNumAdapters, int *lpAdapterIndexList)
 
int ADL_Adapter_ASICFamilyType_Get (int iAdapterIndex, int *lpAsicTypes, int *lpValids)
 Function to get the ASICFamilyType from the adapter. More...
 
int ADL_Adapter_Aspects_Get (int iAdapterIndex, char *lpAspects, int iSize)
 ADL local interface. Function to retrieve the supported aspects list. More...
 
int ADL_Adapter_BigSw_Info_Get (int iAdapterIndex, int *lpBigSwSupportMajor, int *lpBigSwSupportMinor, int *lpRedStoneSupport)
 
int ADL_Adapter_BoardLayout_Get (int iAdapterIndex, int *lpValidFlags, int *lpNumberSlots, ADLBracketSlotInfo **lppBracketSlot, int *lpNumberConnector, ADLConnectorInfo **lppConnector)
 Function to get the board layout information. More...
 
int ADL_Adapter_Caps (int iAdapterIndex, ADLAdapterCaps *adapterCaps)
 
int ADL_Adapter_ChipSetInfo_Get (int iAdapterIndex, ADLChipSetInfo *lpChipSetInfo)
 
int ADL_Adapter_ClockInfo_Get (int iAdapterIndex, ADLClockInfo *lpClockInfo)
 Function to retrieve clock information for an adapter. More...
 
int ADL_Adapter_ConnectionData_Get (int iAdapterIndex, ADLDevicePort devicePort, int iQueryType, ADLConnectionData *lpConnectionData)
 Function to gets the emulation data on specified connector. More...
 
int ADL_Adapter_ConnectionData_Remove (int iAdapterIndex, ADLDevicePort devicePort)
 Function to remove emulation on specified connector. More...
 
int ADL_Adapter_ConnectionData_Set (int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionData ConnectionData)
 Function to set the emulation data to on specified connector. More...
 
int ADL_Adapter_ConnectionState_Get (int iAdapterIndex, ADLDevicePort devicePort, ADLConnectionState *lpADLConnectionState)
 Function to get the current emulation state of a given connector. More...
 
int ADL_Adapter_Crossfire_Caps (int iAdapterIndex, int *lpPreferred, int *lpNumComb, ADLCrossfireComb **ppCrossfireComb)
 Function to retrieve CrossfireX capabilities of the system. More...
 
int ADL_Adapter_Crossfire_Get (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 
int ADL_Adapter_Crossfire_Set (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb)
 Function to set CrossfireX combination settings. More...
 
int ADL_Adapter_CrossfireX2_Get (int iAdapterIndex, ADLCrossfireComb *lpCrossfireComb, ADLCrossfireInfo *lpCrossfireInfo)
 Function to get current CrossfireX settings for both QUAD and Software crossfire. More...
 
int ADL_Adapter_EDIDManagement_Caps (int iAdapterIndex, int *lpSupported)
 Function to retrieve EDID management feature support. More...
 
int ADL_Adapter_EmulationMode_Set (int iAdapterIndex, ADLDevicePort devicePort, int iEmulationMode)
 Function to sets the emulation mode of given connector. More...
 
int ADL_Adapter_ID_Get (int iAdapterIndex, int *lpAdapterID)
 Function to get the unique identifier of an adapter. More...
 
int ADL_Adapter_MemoryInfo2_Get (int iAdapterIndex, ADLMemoryInfo2 *lpMemoryInfo2)
 
int ADL_Adapter_Modes_ReEnumerate ()
 
int ADL_Adapter_ModeSwitch (int iAdapterIndex)
 Function to perform a mode switch for an adapter. More...
 
int ADL_Adapter_NumberOfAdapters_Get (int *lpNumAdapters)
 Function to retrieve the number of OS-known adapters. More...
 
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. More...
 
int ADL_Adapter_ObservedGameClockInfo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpBaseClock, int *lpGameClock, int *lpBoostClock, int *lpMemoryClock)
 Function to get the base, game, boost and memory clock info of an adapter.          Specific logic is used to select appropriate clock for display in current configuration. More...
 
int ADL_Adapter_Primary_Get (int *lpPrimaryAdapterIndex)
 Function to retrieve the primary display adapter index. More...
 
int ADL_Adapter_Primary_Set (int iAdapterIndex)
 Function to set the primary display adapter index. More...
 
int ADL_Adapter_RegValueInt_Get (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int *lpKeyValue)
 ADL local interface. Function to query a integer registry value set by driver. More...
 
int ADL_Adapter_RegValueInt_Set (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iKeyValue)
 ADL local interface. Function to set a driver registry integer value. More...
 
int ADL_Adapter_RegValueString_Get (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to query a string registry value set by driver. More...
 
int ADL_Adapter_RegValueString_Set (int iAdapterIndex, int iDriverPathOption, char *szSubKey, char *szKeyName, int iSize, char *lpKeyValue)
 ADL local interface. Function to set a driver registry string value. More...
 
int ADL_Adapter_Speed_Caps (int iAdapterIndex, int *lpCaps, int *lpValid)
 Function to get the current Force3DClock setting from the adapter. More...
 
int ADL_Adapter_Speed_Get (int iAdapterIndex, int *lpCurrent, int *lpDefault)
 Function to get the current Speed setting from the adapter. More...
 
int ADL_Adapter_Speed_Set (int iAdapterIndex, int iSpeed)
 Function to set the current Speed setting from the adapter. More...
 
int ADL_Adapter_SupportedConnections_Get (int iAdapterIndex, ADLDevicePort devicePort, ADLSupportedConnections *lpADLSupportedConnections)
 Function to get the supported connection types of given connector. More...
 
int ADL_Adapter_VideoBiosInfo_Get (int iAdapterIndex, ADLBiosInfo *lpBiosInfo)
 ADL local interface. Function to retrieve BIOS information. More...
 
int ADL_Adapter_VideoTheaterModeInfo_Get (int iAdapterIndex, int *lpOverlayDisplayMode, int *lpSavedSettings)
 Function to get MM video theater mode info. More...
 
int ADL_Adapter_VideoTheaterModeInfo_Set (int iAdapterIndex, int iOverlayDisplayMode, int iSavedSettings)
 Function to set MM video theater mode info. More...
 
int ADL_AdapterX2_Caps (int iAdapterIndex, ADLAdapterCapsX2 *adapterCaps)
 Function to retrieve adapter caps information. More...
 
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() More...
 
int ADL_Flush_Driver_Data (int iAdapterIndex)
 Function to save driver data. More...
 
int ADL_MMD_Features_Caps (int iAdapterIndex, ADLFeatureCaps **lppFeatureCaps, int *lpFeatureCount)
 
int ADL_MMD_FeatureValues_Get (int iAdapterIndex, ADLFeatureValues **lppFeatureValues, int *lpFeatureCount)
 
int ADL_MMD_FeatureValues_Set (int iAdapterIndex, ADLFeatureValues *lpFeatureValues, int iFeatureCount, int ClientID)
 
int ADL_Workstation_GlobalEDIDPersistence_Get (int *lpCurResultValue, int *lpDefResultValue)
 Function to get the EDID Persistence state of the system. More...
 
int ADL_Workstation_GlobalEDIDPersistence_Set (int iCurState)
 Function to set the EDID Persistence state of the system. More...
 

Detailed Description

Copyright (c) 2008 - 2022 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.

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

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.

Macro Definition Documentation

◆ ADL_EXTERNC

#define ADL_EXTERNC

Function Documentation

◆ ADL2_Adapter_ClockInfo_Get()

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]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpClockInfoThe 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.

◆ ADL2_Adapter_EDC_ErrorInjection_Set()

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]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]errorInjectionThe pointer to error injection
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_EDC_ErrorRecords_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]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]pErrorrecordCountThe pointer to the number of error records
[out]errorRecordsThe pointer to error records
Returns
If the function succeeds, the return value is ADL_OK, or an ADL error code otherwise. Result Codes

◆ ADL2_Adapter_KeepAwake_Start()

int ADL2_Adapter_KeepAwake_Start ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_D3DKMT_HANDLE  hDevice 
)

Function to start keeping adatper awake.

This function implements a call to start keeping specified adapter awake.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]hDeviceThe D3D device handle associate with the applicatioin.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Adapter_KeepAwake_Stop()

int ADL2_Adapter_KeepAwake_Stop ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADL_D3DKMT_HANDLE  hDevice 
)

Function to stop keeping adapter awake.

This function implments a call to stop keeping specified adapter awake.

Supported Platforms:
Windows 7, 10 and above; 32bit and 64bit
Parameters
[in]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]hDeviceThe D3D device handle associate with the applicatioin.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Display_AdapterID_Get()

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]contextClient's ADL context handle ADL_CONTEXT_HANDLE obtained from ADL2_Main_Control_Create.
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpAdapterIDThe 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.

◆ ADL_Adapter_ClockInfo_Get()

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]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpClockInfoThe 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.

◆ ADL_Display_AdapterID_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()

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]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpAdapterIDThe 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()

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