ADL (AMD Display Library) Public APIs  Version 17.0
Functions
EDID Management APIs

This group describes the EDID Management APIs. More...

Functions

int ADL2_Adapter_BoardLayout_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValidFlags, int *lpNumberSlots, ADLBracketSlotInfo **lppBracketSlot, int *lpNumberConnector, ADLConnectorInfo **lppConnector)
 
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_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_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_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_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_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_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_SupportedConnections_Get (int iAdapterIndex, ADLDevicePort devicePort, ADLSupportedConnections *lpADLSupportedConnections)
 Function to get the supported connection types of given connector. More...
 
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

This group describes the EDID Management APIs.

Function to get the board layout information.

This function retrieves the ASIC layout information of a specified adapter.
layout information includes number of slots, size and number of connectors and properties of connectors

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]lpValidFlagsThe integer pointer, specifies the valid bits of the slot & connector information.
[out]lpNumberSlotsThe integer pointer, specifies the number of slots
[out]lppBracketSlotThe pointer to the structure, storing the bracket slot information.
[out]lpNumberConnectorThe integer pointer, specifies the number of connectors in GPU
[out]lppConnectorThe pointer to the structure, storing the connectors information
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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.

Function Documentation

◆ ADL2_Adapter_BoardLayout_Get()

int ADL2_Adapter_BoardLayout_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpValidFlags,
int *  lpNumberSlots,
ADLBracketSlotInfo **  lppBracketSlot,
int *  lpNumberConnector,
ADLConnectorInfo **  lppConnector 
)

◆ ADL2_Adapter_ConnectionData_Get()

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.

This function to gets the emulation data

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.
[in]devicePortspecifies connector index and relative MST address.
[in]iQueryTypeThe Specifies type of query. Define_emulation_query
[out]lpConnectionDataThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_ConnectionData_Remove()

int ADL2_Adapter_ConnectionData_Remove ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLDevicePort  devicePort 
)

Function to remove emulation on specified connector.

This function removes the emulation which are emulated already

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.
[in]devicePortspecifies connector index and relative mst address.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_ConnectionData_Set()

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.

This function sets the emulation data

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.
[in]devicePortspecifies connector index and relative MST address.
[in]ConnectionDatacontains connection data including the EDID data
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_ConnectionState_Get()

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.

This function retrieves the current emulation state

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.
[in]devicePortspecifies connector index and relative MST address.
[out]lpADLConnectionStateThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_EDIDManagement_Caps()

int ADL2_Adapter_EDIDManagement_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported 
)

Function to retrieve EDID management feature support.

This function retrieves EDID Management supprot for specific 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]lpSupportedIf the specified adapter supports EDID Management then returns ADL_TRUE else ADL_FALSE
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_EmulationMode_Set()

int ADL2_Adapter_EmulationMode_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLDevicePort  devicePort,
int  iEmulationMode 
)

Function to sets the emulation mode of given connector.

This function set the emulation mode to the driver

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.
[in]devicePortspecifies connector index and relative MST address.
[in]iEmulationModeselected Emulated mode. Define_emulation_mode
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_SupportedConnections_Get()

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.

This function retrieves the supported connection types and its properties

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.
[in]devicePortspecifies connector index and relative MST address.
[out]lpADLSupportedConnectionsThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
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_Workstation_GlobalEDIDPersistence_Get()

int ADL2_Workstation_GlobalEDIDPersistence_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpCurResultValue,
int *  lpDefResultValue 
)

Function to get the EDID Persistence state of the system.

This function implements the functionality to get the EDID Persistence state of the system.

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.
[out]lpCurResultValueThe int pointer to the current state It can be one of Define_persistence_state
[out]lpDefResultValueThe int pointer to the default state It can be one of Define_persistence_state
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.
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_Workstation_GlobalEDIDPersistence_Set()

int ADL2_Workstation_GlobalEDIDPersistence_Set ( ADL_CONTEXT_HANDLE  context,
int  iCurState 
)

Function to set the EDID Persistence state of the system.

This function implements the functionality to set the EDID Persistence mode for a system.

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]iCurStateThe current state to set for the specified adapter. Define_persistence_state
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.
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_BoardLayout_Get()

int ADL_Adapter_BoardLayout_Get ( int  iAdapterIndex,
int *  lpValidFlags,
int *  lpNumberSlots,
ADLBracketSlotInfo **  lppBracketSlot,
int *  lpNumberConnector,
ADLConnectorInfo **  lppConnector 
)

Function to get the board layout information.

This function retrieves the ASIC layout information of a specified adapter.
layout information includes number of slots, size and number of connectors and properties of connectors

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpValidFlagsThe integer pointer, specifies the valid bits of the slot & connector information.
[out]lpNumberSlotsThe integer pointer, specifies the number of slots
[out]lppBracketSlotThe pointer to the structure, storing the bracket slot information.
[out]lpNumberConnectorThe integer pointer, specifies the number of connectors in GPU
[out]lppConnectorThe pointer to the structure, storing the connectors information
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_ConnectionData_Get()

int ADL_Adapter_ConnectionData_Get ( int  iAdapterIndex,
ADLDevicePort  devicePort,
int  iQueryType,
ADLConnectionData lpConnectionData 
)

Function to gets the emulation data on specified connector.

This function to gets the emulation data

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]devicePortspecifies connector index and relative MST address.
[in]iQueryTypeThe Specifies type of query. Define_emulation_query
[out]lpConnectionDataThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_ConnectionData_Remove()

int ADL_Adapter_ConnectionData_Remove ( int  iAdapterIndex,
ADLDevicePort  devicePort 
)

Function to remove emulation on specified connector.

This function removes the emulation which are emulated already

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

◆ ADL_Adapter_ConnectionData_Set()

int ADL_Adapter_ConnectionData_Set ( int  iAdapterIndex,
ADLDevicePort  devicePort,
ADLConnectionData  ConnectionData 
)

Function to set the emulation data to on specified connector.

This function sets the emulation data

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]devicePortspecifies connector index and relative MST address.
[in]ConnectionDatacontains connection data including the EDID data
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_ConnectionState_Get()

int ADL_Adapter_ConnectionState_Get ( int  iAdapterIndex,
ADLDevicePort  devicePort,
ADLConnectionState lpADLConnectionState 
)

Function to get the current emulation state of a given connector.

This function retrieves the current emulation state

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]devicePortspecifies connector index and relative MST address.
[out]lpADLConnectionStateThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_EDIDManagement_Caps()

int ADL_Adapter_EDIDManagement_Caps ( int  iAdapterIndex,
int *  lpSupported 
)

Function to retrieve EDID management feature support.

This function retrieves EDID Management supprot for specific adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpSupportedIf the specified adapter supports EDID Management then returns ADL_TRUE else ADL_FALSE
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_EmulationMode_Set()

int ADL_Adapter_EmulationMode_Set ( int  iAdapterIndex,
ADLDevicePort  devicePort,
int  iEmulationMode 
)

Function to sets the emulation mode of given connector.

This function set the emulation mode to the driver

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]devicePortspecifies connector index and relative MST address.
[in]iEmulationModeselected Emulated mode. Define_emulation_mode
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Adapter_SupportedConnections_Get()

int ADL_Adapter_SupportedConnections_Get ( int  iAdapterIndex,
ADLDevicePort  devicePort,
ADLSupportedConnections lpADLSupportedConnections 
)

Function to get the supported connection types of given connector.

This function retrieves the supported connection types and its properties

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]devicePortspecifies connector index and relative MST address.
[out]lpADLSupportedConnectionsThe pointer to the structure storing the retrieved information.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Workstation_GlobalEDIDPersistence_Get()

int ADL_Workstation_GlobalEDIDPersistence_Get ( int *  lpCurResultValue,
int *  lpDefResultValue 
)

Function to get the EDID Persistence state of the system.

This function implements the functionality to get the EDID Persistence state of the system.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[out]lpCurResultValueThe int pointer to the current state It can be one of Define_persistence_state
[out]lpDefResultValueThe int pointer to the default state It can be one of Define_persistence_state
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_GlobalEDIDPersistence_Set()

int ADL_Workstation_GlobalEDIDPersistence_Set ( int  iCurState)

Function to set the EDID Persistence state of the system.

This function implements the functionality to set the EDID Persistence mode for a system.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iCurStateThe current state to set for the specified adapter. Define_persistence_state
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

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