ADL (AMD Display Library) Public APIs  Version 17.0
Modules | Functions
Workstation Related APIs

This group outlines all Workstation related APIs. More...

Modules

 EDID Management APIs
 This group describes the EDID Management APIs.
 
 Framelock Genlock related APIs
 This group describes the Framelock Genlock APIs.
 

Functions

int ADL2_Workstation_AdapterNumOfGLSyncConnectors_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpNumOfGLSyncConnectors)
 Function to retrieve the number of GL-Sync connectors on an adapter. More...
 
int ADL2_Workstation_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpValidBits, int *lpCaps)
 Function to retrieve current workstation capabilities. More...
 
int ADL2_Workstation_DeepBitDepth_Get (ADL_CONTEXT_HANDLE context, int *lpCurDBDState, int *lpDefDBDState, int *lpCurGrayscale, int *lpDefGrayscale, int *lpCurBypass, int *lpDefBypass)
 Function to get current requested state of Deep Bit Depth and related settings. More...
 
int ADL2_Workstation_DeepBitDepth_Set (ADL_CONTEXT_HANDLE context, int iDBDState, int iGrayscale, int iBypassGamma)
 Function to set requested state of Deep Bit Depth and related settings. More...
 
int ADL2_Workstation_DeepBitDepthX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDefDBDState, int *lpCurDBDState)
 
int ADL2_Workstation_DeepBitDepthX2_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDBDState)
 
int ADL2_Workstation_ECC_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)
 Function to get ECC (Error Correction Code) Capabilities on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) Capabilities on the specified adapter. More...
 
int ADL2_Workstation_ECC_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDefaultMode, int *lpCurrentMode, int *lpDesiredMode)
 Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter. More...
 
int ADL2_Workstation_ECC_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iDesiredMode)
 Function to set ECC Mode on the specified adapter This function implements the CI call to set ECC (Error Correction Code) to turn on and off this feature on the specified adapter. More...
 
int ADL2_Workstation_ECCData_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLECCData *lpAdlEccData)
 Function to get ECC statistics on the specified adapter. This function implements the CI call to get SEC(Single Error Correct) and DED(Double Error Detect) Counts on the specified adapter. More...
 
int ADL2_Workstation_ECCX2_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpModeType, int *lpDefaultMode, int *lpCurrentMode, int *lpDesiredMode)
 Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter. More...
 
int ADL2_Workstation_LoadBalancing_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpResultMask, int *lpResultValue)
 Function to set the load balancing capabilities for the specified adapter. More...
 
int ADL2_Workstation_LoadBalancing_Get (ADL_CONTEXT_HANDLE context, int *lpResultMask, int *lpCurResultValue, int *lpDefResultValue)
 Function to get the load balancing state of the specified adapter. More...
 
int ADL2_Workstation_LoadBalancing_Set (ADL_CONTEXT_HANDLE context, int iCurState)
 Function to set the load balancing state of the specified adapter. More...
 
int ADL2_Workstation_SDI_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpSupported)
 
int ADL2_Workstation_SDI_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, ADLSDIData *lpDefualt, ADLSDIData *lpDriver, ADLSDIData *lpCurrent)
 
int ADL2_Workstation_SDI_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iSDIState, int iSizeofSDISegment)
 
int ADL2_Workstation_SDISegmentList_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpMemorySegmentCount, int **lppMemorySegmentList)
 
int ADL2_Workstation_Stereo_Get (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *lpDefState, int *lpCurState)
 Function to retreive the worstation stereo mode. More...
 
int ADL2_Workstation_Stereo_Set (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int iCurState)
 Function to set the workstation stereo mode. More...
 
int ADL2_WS_Overdrive_Caps (ADL_CONTEXT_HANDLE context, int iAdapterIndex, int *iSupported, int *iEnabled, int *iVersion)
 
int ADL_Workstation_AdapterNumOfGLSyncConnectors_Get (int iAdapterIndex, int *lpNumOfGLSyncConnectors)
 Function to retrieve the number of GL-Sync connectors on an adapter. More...
 
int ADL_Workstation_Caps (int iAdapterIndex, int *lpValidBits, int *lpCaps)
 Function to retrieve current workstation capabilities. More...
 
int ADL_Workstation_DeepBitDepth_Get (int *lpCurDBDState, int *lpDefDBDState, int *lpCurGrayscale, int *lpDefGrayscale, int *lpCurBypass, int *lpDefBypass)
 Function to get current requested state of Deep Bit Depth and related settings. More...
 
int ADL_Workstation_DeepBitDepth_Set (int iDBDState, int iGrayscale, int iBypassGamma)
 Function to set requested state of Deep Bit Depth and related settings. More...
 
int ADL_Workstation_DeepBitDepthX2_Get (int iAdapterIndex, int *lpDefDBDState, int *lpCurDBDState)
 
int ADL_Workstation_DeepBitDepthX2_Set (int iAdapterIndex, int iDBDState)
 
int ADL_Workstation_ECC_Caps (int iAdapterIndex, int *lpSupported)
 Function to get ECC (Error Correction Code) Capabilities on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) Capabilities on the specified adapter. More...
 
int ADL_Workstation_ECC_Get (int iAdapterIndex, int *lpDefaultMode, int *lpCurrentMode, int *lpDesiredMode)
 Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter. More...
 
int ADL_Workstation_ECC_Set (int iAdapterIndex, int iDesiredMode)
 Function to set ECC Mode on the specified adapter This function implements the CI call to set ECC (Error Correction Code) to turn on and off this feature on the specified adapter. More...
 
int ADL_Workstation_ECCData_Get (int iAdapterIndex, ADLECCData *lpAdlEccData)
 Function to get ECC statistics on the specified adapter. This function implements the CI call to get SEC(Single Error Correct) and DED(Double Error Detect) Counts on the specified adapter. More...
 
int ADL_Workstation_ECCX2_Get (int iAdapterIndex, int *lpModeType, int *lpDefaultMode, int *lpCurrentMode, int *lpDesiredMode)
 Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter. More...
 
int ADL_Workstation_LoadBalancing_Caps (int iAdapterIndex, int *lpResultMask, int *lpResultValue)
 Function to set the load balancing capabilities for the specified adapter. More...
 
int ADL_Workstation_LoadBalancing_Get (int *lpResultMask, int *lpCurResultValue, int *lpDefResultValue)
 Function to get the load balancing state of the specified adapter. More...
 
int ADL_Workstation_LoadBalancing_Set (int iCurState)
 Function to set the load balancing state of the specified adapter. More...
 
int ADL_Workstation_SDI_Caps (int iAdapterIndex, int *lpSupported)
 Function to check for Serial Digital Interface capabilities. More...
 
int ADL_Workstation_SDI_Get (int iAdapterIndex, ADLSDIData *lpDefualt, ADLSDIData *lpDriver, ADLSDIData *lpCurrent)
 
int ADL_Workstation_SDI_Set (int iAdapterIndex, int iSDIState, int iSizeofSDISegment)
 
int ADL_Workstation_SDISegmentList_Get (int iAdapterIndex, int *lpMemorySegmentCount, int **lppMemorySegmentList)
 
int ADL_Workstation_Stereo_Get (int iAdapterIndex, int *lpDefState, int *lpCurState)
 Function to retreive the worstation stereo mode. More...
 
int ADL_Workstation_Stereo_Set (int iAdapterIndex, int iCurState)
 Function to set the workstation stereo mode. More...
 

Detailed Description

This group outlines all Workstation related APIs.

Function Documentation

◆ ADL2_Workstation_AdapterNumOfGLSyncConnectors_Get()

int ADL2_Workstation_AdapterNumOfGLSyncConnectors_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpNumOfGLSyncConnectors 
)

Function to retrieve the number of GL-Sync connectors on an adapter.

This function retrieves the number of GL-Sync connectors that are available on a specified 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]lpNumOfGLSyncConnectorsThe pointer to the retrieved number of GL-Sync connectors on the specified adapter.
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
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_Caps()

int ADL2_Workstation_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpValidBits,
int *  lpCaps 
)

Function to retrieve current workstation capabilities.

This function retrieves information regarding the capabilities of a specified workstation card.

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]lpValidBitsThe pointer to a bit-oriented value. If a bit is set to 1, then the corresponding bit in lpCaps is valid. If a bit is set to 0, then the corresponding bit in lpCaps should be ignored.
[out]lpCapsThe pointer to a bit-oriented value representing a specific workstation capability. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If lpValidBits and/or lpCaps is NULL, ADL_ERR_NULL_POINTER is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_DeepBitDepth_Get()

int ADL2_Workstation_DeepBitDepth_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpCurDBDState,
int *  lpDefDBDState,
int *  lpCurGrayscale,
int *  lpDefGrayscale,
int *  lpCurBypass,
int *  lpDefBypass 
)

Function to get current requested state of Deep Bit Depth and related settings.

This function returns if specified adapter supports Deep Bit Depth, grayscale and gamma bypass and their defaults. These settings are applicable to system wide to all currently known adapters.

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]lpCurDBDState: The requested deep bit depth state. This is the state the user wishes to put the deep bit depth feature to Deep Bit Depth
[out]lpDefDBDStateThe default deep bit depth state state of the system. Deep Bit Depth
[out]lpCurGrayscaleNot currently used. It is there for future use.
[out]lpDefGrayscaleNot currently used. It is there for future use.
[out]lpCurBypassNot currently used. It is there for future use.
[out]lpDefBypassNot currently used. It is there for future use.
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_DeepBitDepth_Set()

int ADL2_Workstation_DeepBitDepth_Set ( ADL_CONTEXT_HANDLE  context,
int  iDBDState,
int  iGrayscale,
int  iBypassGamma 
)

Function to set requested state of Deep Bit Depth and related settings.

This function sets for the specified adapter supports Deep Bit Depth, grayscale and gamma bypass These settings are applicable to system wide to all currently known adapters. A restart is required to apply settings, ADL_OK_RESTART will be return from function.

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]iDBDStateThe requested Deep bit depth state to set the system to.Deep Bit Depth
[in]iGrayscaleNot currently used. It is there for future use.
[in]iBypassGammaNot currently used. It is there for future use.
Returns
If the function succeeds, the return value is ADL_OK_RESTART. Otherwise the return value is an ADL error code. Result Codes

◆ ADL2_Workstation_DeepBitDepthX2_Get()

int ADL2_Workstation_DeepBitDepthX2_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDefDBDState,
int *  lpCurDBDState 
)
Function to get current requested state of Deep Bit Depth and related settings

This function returns if specified adapter supports Deep Bit Depth and their defaults.

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]lpDBDDefaultThe default deep bit depth state of the system. DISPLAY_10BIT_MODE_STATE
[out]lpCurDBDState: The requested deep bit depth state. This is the state the user wishes to put the deep bit depth feature to DISPLAY_10BIT_MODE_STATE
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_DeepBitDepthX2_Set()

int ADL2_Workstation_DeepBitDepthX2_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDBDState 
)
Function to set requested state of Deep Bit Depth

This function Deep Bit Depth sets for the specified adapter A restart is required to apply settings, ADL_OK_RESTART will be return from function.

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]iDBDStateThe requested Deep bit depth state to set the system to.DISPLAY_10BIT_MODE_STATE
Returns
If the function succeeds, the return value is ADL_OK_RESTART. 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_ECC_Caps()

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

Function to get ECC (Error Correction Code) Capabilities on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) Capabilities on the specified 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]iAdapterIndex- The index of the desired adapter.
[out]lpSupported- returns the bolean capability, whether ECC is supported or not(ADL_TRUE or ADL_FALSE) for the specified adapter
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_ECC_Get()

int ADL2_Workstation_ECC_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDefaultMode,
int *  lpCurrentMode,
int *  lpDesiredMode 
)

Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified 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]iAdapterIndex- The index of the desired adapter.
[out]lpDefaultMode- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON).Define_ecc_mode_states.
[out]lpCurrentMode- ECC Mode that is currently stored in the permanent store for driver. (ECC_MODE_OFF, ECC_MODE_ON).Define_ecc_mode_states.
[out]lpDesiredMode- Desired ECC mode from the user, once the user reboots the machine DesiredMode will be applied to CurrentMode (ECC_MODE_OFF, ECC_MODE_ON). Define_ecc_mode_states.
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_ECC_Set()

int ADL2_Workstation_ECC_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iDesiredMode 
)

Function to set ECC Mode on the specified adapter This function implements the CI call to set ECC (Error Correction Code) to turn on and off this feature on the specified 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]iAdapterIndex- The index of the desired adapter.
[in]iDesiredMode- ECC Mode currently accepts ECC_MODE_OFF or ECC_MODE_ON. Define_ecc_mode_states
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_ECCData_Get()

int ADL2_Workstation_ECCData_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLECCData lpAdlEccData 
)

Function to get ECC statistics on the specified adapter. This function implements the CI call to get SEC(Single Error Correct) and DED(Double Error Detect) Counts on the specified 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]iAdapterIndex- The index of the desired adapter.
[out]lpAdlEccData- is of type ADLECCData. Gets the SEC & DED counts ADLECCData
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_ECCX2_Get()

int ADL2_Workstation_ECCX2_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpModeType,
int *  lpDefaultMode,
int *  lpCurrentMode,
int *  lpDesiredMode 
)

Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified 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]iAdapterIndex- The index of the desired adapter.
[out]lpModeType- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpDefaultMode- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpCurrentMode- ECC Mode that is currently stored in the permanent store for driver. (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpDesiredMode- Desired ECC mode from the user, once the user reboots the machine DesiredMode will be applied to CurrentMode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM ). Define_ecc_mode_states.
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_LoadBalancing_Caps()

int ADL2_Workstation_LoadBalancing_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpResultMask,
int *  lpResultValue 
)

Function to set the load balancing capabilities for the specified adapter.

This function implements the CI call to Get the load balancing caps for a specified 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]lpResultMaskThe int pointer to the mask bits of load balancing of the specified adapter, It can be combination of ADL_WORKSTATION_LOADBALANCING_SUPPORTED, ref ADL_WORKSTATION_LOADBALANCING_AVAILABLE.
[out]lpResultValueThe int pointer to the capable load balancing bits of the specified adapter. It can be combination of ADL_WORKSTATION_LOADBALANCING_SUPPORTED, ref ADL_WORKSTATION_LOADBALANCING_AVAILABLE
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_LoadBalancing_Get()

int ADL2_Workstation_LoadBalancing_Get ( ADL_CONTEXT_HANDLE  context,
int *  lpResultMask,
int *  lpCurResultValue,
int *  lpDefResultValue 
)

Function to get the load balancing state of the specified adapter.

This function implements the PCS access to Get the load balancing state for a specified 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.
[out]lpResultMaskThe int pointer to mask bit of state. It can be combination of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
[out]lpCurResultValueThe int pointer to the current state It can be one of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
[out]lpDefResultValueThe int pointer to the dafault state It can be one of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_LoadBalancing_Set()

int ADL2_Workstation_LoadBalancing_Set ( ADL_CONTEXT_HANDLE  context,
int  iCurState 
)

Function to set the load balancing state of the specified adapter.

This function implements the PCS access to set the load balancing mode for a specified 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]iCurStateThe current state to set for the specified adapter.
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_SDI_Caps()

int ADL2_Workstation_SDI_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpSupported 
)
Function to check for Serial Digital Interface capabilities
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]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpSupported,Thepointer to the caps of adapter settings. If the specified adapter supports SDI, it is set to ADL_TRUE, else set to ADL_FALSE
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
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_SDI_Get()

int ADL2_Workstation_SDI_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
ADLSDIData lpDefualt,
ADLSDIData lpDriver,
ADLSDIData lpCurrent 
)
Function to get the default, driver and user requested Serial Digital Interface Data for the specified 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]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpDefualt,pointerto the default SDI settings of the specified adapter.
[out]lpCurrent,pointerto the driver SDI settings of the specified adapter.
[out]lpDriver,pointerto the user requested SDI seetings of the 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
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_SDI_Set()

int ADL2_Workstation_SDI_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iSDIState,
int  iSizeofSDISegment 
)
Function to set the user requested Serial Digital Interface Data for the specified 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]iAdapterIndex,ADLindex handle of the desired adapter.
[in]iSDIState,SDIstate (possiable values ADL_SDI_ON or ADL_SDI_OFF
[in]iSizeofSDISegment,sizeof the apreture
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
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_SDISegmentList_Get()

int ADL2_Workstation_SDISegmentList_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpMemorySegmentCount,
int **  lppMemorySegmentList 
)
Function to set the user requested Serial Digital Interface Data for the specified 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]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpMemorySegmentCount,pointerto the supported memory segment count of the specified adapter
[out]lppMemorySegmentList,pointerto the supported memory segment list of the 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
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_Stereo_Get()

int ADL2_Workstation_Stereo_Get ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  lpDefState,
int *  lpCurState 
)

Function to retreive the worstation stereo mode.

This function retrieves the current and default workstation stereo mode.

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]lpDefStateThe pointer to the default stereo mode. Workstation Capabilities
[out]lpCurStateThe pointer to the current stereo mode. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If lpDefState and/or lpCurState are NULL, ADL_ERR_NULL_POINTER is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. 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_Stereo_Set()

int ADL2_Workstation_Stereo_Set ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int  iCurState 
)

Function to set the workstation stereo mode.

This function sets the current workstation stereo mode.

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]iCurStateThe desired workstation stereo mode. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
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_WS_Overdrive_Caps()

int ADL2_WS_Overdrive_Caps ( ADL_CONTEXT_HANDLE  context,
int  iAdapterIndex,
int *  iSupported,
int *  iEnabled,
int *  iVersion 
)
Function to retrieve current workattaion overdrive support capabilities

This function retrieves current workattaion overdrivecapabilities for a specified 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]iSupportedThe pointer to an int variable which indicates if Overdrive feature is supported ( ADL_TRUE : supported, ADL_FALSE : not supported)
[in]iEnabledThe pointer to an int variable which indicates if Overdrive feature is enabled ( ADL_TRUE : enabled, ADL_FALSE : disabled)
[in]iVersionThe pointer to an int variable receiving the Overdrive feature version.
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. If Overdrive feature is not supported the return code is ADL_ERR_NOT_SUPPORTED
Remarks
Call this API prior to calling any other Overdrive APIs to determine if this feature is supported and enabled.
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_Workstation_AdapterNumOfGLSyncConnectors_Get()

int ADL_Workstation_AdapterNumOfGLSyncConnectors_Get ( int  iAdapterIndex,
int *  lpNumOfGLSyncConnectors 
)

Function to retrieve the number of GL-Sync connectors on an adapter.

This function retrieves the number of GL-Sync connectors that are available on a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpNumOfGLSyncConnectorsThe pointer to the retrieved number of GL-Sync connectors on the specified adapter.
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_Caps()

int ADL_Workstation_Caps ( int  iAdapterIndex,
int *  lpValidBits,
int *  lpCaps 
)

Function to retrieve current workstation capabilities.

This function retrieves information regarding the capabilities of a specified workstation card.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpValidBitsThe pointer to a bit-oriented value. If a bit is set to 1, then the corresponding bit in lpCaps is valid. If a bit is set to 0, then the corresponding bit in lpCaps should be ignored.
[out]lpCapsThe pointer to a bit-oriented value representing a specific workstation capability. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If lpValidBits and/or lpCaps is NULL, ADL_ERR_NULL_POINTER is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_DeepBitDepth_Get()

int ADL_Workstation_DeepBitDepth_Get ( int *  lpCurDBDState,
int *  lpDefDBDState,
int *  lpCurGrayscale,
int *  lpDefGrayscale,
int *  lpCurBypass,
int *  lpDefBypass 
)

Function to get current requested state of Deep Bit Depth and related settings.

This function returns if specified adapter supports Deep Bit Depth, grayscale and gamma bypass and their defaults. These settings are applicable to system wide to all currently known adapters.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[out]lpCurDBDState: The requested deep bit depth state. This is the state the user wishes to put the deep bit depth feature to Deep Bit Depth
[out]lpDefDBDStateThe default deep bit depth state state of the system. Deep Bit Depth
[out]lpCurGrayscaleNot currently used. It is there for future use.
[out]lpDefGrayscaleNot currently used. It is there for future use.
[out]lpCurBypassNot currently used. It is there for future use.
[out]lpDefBypassNot currently used. It is there for future use.
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Workstation_DeepBitDepth_Set()

int ADL_Workstation_DeepBitDepth_Set ( int  iDBDState,
int  iGrayscale,
int  iBypassGamma 
)

Function to set requested state of Deep Bit Depth and related settings.

This function sets for the specified adapter supports Deep Bit Depth, grayscale and gamma bypass These settings are applicable to system wide to all currently known adapters. A restart is required to apply settings, ADL_OK_RESTART will be return from function.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iDBDStateThe requested Deep bit depth state to set the system to.Deep Bit Depth
[in]iGrayscaleNot currently used. It is there for future use.
[in]iBypassGammaNot currently used. It is there for future use.
Returns
If the function succeeds, the return value is ADL_OK_RESTART. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Workstation_DeepBitDepthX2_Get()

int ADL_Workstation_DeepBitDepthX2_Get ( int  iAdapterIndex,
int *  lpDefDBDState,
int *  lpCurDBDState 
)
Function to get current requested state of Deep Bit Depth and related settings

This function returns if specified adapter supports Deep Bit Depth and their defaults.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpDBDDefaultThe default deep bit depth state state of the system. DISPLAY_10BIT_MODE_STATE
[out]lpCurDBDState: The requested deep bit depth state. This is the state the user wishes to put the deep bit depth feature to DISPLAY_10BIT_MODE_STATE
Returns
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Workstation_DeepBitDepthX2_Set()

int ADL_Workstation_DeepBitDepthX2_Set ( int  iAdapterIndex,
int  iDBDState 
)
Function to set requested state of Deep Bit Depth

This function Deep Bit Depth sets for the specified adapter A restart is required to apply settings, ADL_OK_RESTART will be return from function.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iDBDStateThe requested Deep bit depth state to set the system to.DISPLAY_10BIT_MODE_STATE
Returns
If the function succeeds, the return value is ADL_OK_RESTART. Otherwise the return value is an ADL error code. Result Codes

◆ ADL_Workstation_ECC_Caps()

int ADL_Workstation_ECC_Caps ( int  iAdapterIndex,
int *  lpSupported 
)

Function to get ECC (Error Correction Code) Capabilities on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) Capabilities on the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex- The index of the desired adapter.
[out]lpSupported- returns the bolean capability, whether ECC is supported or not(ADL_TRUE or ADL_FALSE) for the specified adapter
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_ECC_Get()

int ADL_Workstation_ECC_Get ( int  iAdapterIndex,
int *  lpDefaultMode,
int *  lpCurrentMode,
int *  lpDesiredMode 
)

Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex- The index of the desired adapter.
[out]lpDefaultMode- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON).Define_ecc_mode_states.
[out]lpCurrentMode- ECC Mode that is currently stored in the permanent store for driver. (ECC_MODE_OFF, ECC_MODE_ON).Define_ecc_mode_states.
[out]lpDesiredMode- Desired ECC mode from the user, once the user reboots the machine DesiredMode will be applied to CurrentMode (ECC_MODE_OFF, ECC_MODE_ON). Define_ecc_mode_states.
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_ECC_Set()

int ADL_Workstation_ECC_Set ( int  iAdapterIndex,
int  iDesiredMode 
)

Function to set ECC Mode on the specified adapter This function implements the CI call to set ECC (Error Correction Code) to turn on and off this feature on the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex- The index of the desired adapter.
[in]iDesiredMode- ECC Mode currently accepts ECC_MODE_OFF or ECC_MODE_ON. Define_ecc_mode_states
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_ECCData_Get()

int ADL_Workstation_ECCData_Get ( int  iAdapterIndex,
ADLECCData lpAdlEccData 
)

Function to get ECC statistics on the specified adapter. This function implements the CI call to get SEC(Single Error Correct) and DED(Double Error Detect) Counts on the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex- The index of the desired adapter.
[out]lpAdlEccData- is of type ADLECCData. Gets the SEC & DED counts ADLECCData
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_ECCX2_Get()

int ADL_Workstation_ECCX2_Get ( int  iAdapterIndex,
int *  lpModeType,
int *  lpDefaultMode,
int *  lpCurrentMode,
int *  lpDesiredMode 
)

Function to get ECC (Error Correction Code) current and desired states on the specified adapter. This function implements the CI call to get ECC (Error Correction Code) current mode(driver applied mode) and the desired mode (user requested mode) on the specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex- The index of the desired adapter.
[out]lpModeType- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpDefaultMode- Default ECC Mode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpCurrentMode- ECC Mode that is currently stored in the permanent store for driver. (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM).Define_ecc_mode_states.
[out]lpDesiredMode- Desired ECC mode from the user, once the user reboots the machine DesiredMode will be applied to CurrentMode (ECC_MODE_OFF, ECC_MODE_ON, ECC_MODE_HBM). Define_ecc_mode_states.
Returns
If the function is successful, ADL_OK is returned, If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_LoadBalancing_Caps()

int ADL_Workstation_LoadBalancing_Caps ( int  iAdapterIndex,
int *  lpResultMask,
int *  lpResultValue 
)

Function to set the load balancing capabilities for the specified adapter.

This function implements the CI call to Get the load balancing caps for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpResultMaskThe int pointer to the mask bits of load balancing of the specified adapter, It can be combination of ADL_WORKSTATION_LOADBALANCING_SUPPORTED, ref ADL_WORKSTATION_LOADBALANCING_AVAILABLE.
[out]lpResultValueThe int pointer to the capable load balancing bits of the specified adapter. It can be combination of ADL_WORKSTATION_LOADBALANCING_SUPPORTED, ref ADL_WORKSTATION_LOADBALANCING_AVAILABLE
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_LoadBalancing_Get()

int ADL_Workstation_LoadBalancing_Get ( int *  lpResultMask,
int *  lpCurResultValue,
int *  lpDefResultValue 
)

Function to get the load balancing state of the specified adapter.

This function implements the PCS access to Get the load balancing state for a specified adapter.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[out]lpResultMaskThe int pointer to mask bit of state. It can be combination of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
[out]lpCurResultValueThe int pointer to the current state It can be one of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
[out]lpDefResultValueThe int pointer to the dafault state It can be one of ADL_WORKSTATION_LOADBALANCING_DISABLED, ref ADL_WORKSTATION_LOADBALANCING_ENABLED.
Returns
If the function is successful, ADL_OK is returned. ADL_OK_MODE_CHANGE if success but need mode change,
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_LoadBalancing_Set()

int ADL_Workstation_LoadBalancing_Set ( int  iCurState)

Function to set the load balancing state of the specified adapter.

This function implements the PCS access to set the load balancing mode for a specified adapter.

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

◆ ADL_Workstation_SDI_Caps()

int ADL_Workstation_SDI_Caps ( int  iAdapterIndex,
int *  lpSupported 
)

Function to check for Serial Digital Interface capabilities.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpSupported,Thepointer to the caps of adapter settings. If the specified adapter supports SDI, it is set to ADL_TRUE, else set to ADL_FALSE
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

◆ ADL_Workstation_SDI_Get()

int ADL_Workstation_SDI_Get ( int  iAdapterIndex,
ADLSDIData lpDefualt,
ADLSDIData lpDriver,
ADLSDIData lpCurrent 
)
Function to get the default, driver and user requested Serial Digital Interface Data for the specified adapter.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpDefualt,pointerto the default SDI settings of the specified adapter.
[out]lpCurrent,pointerto the driver SDI settings of the specified adapter.
[out]lpDriver,pointerto the user requested SDI seetings of the 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

◆ ADL_Workstation_SDI_Set()

int ADL_Workstation_SDI_Set ( int  iAdapterIndex,
int  iSDIState,
int  iSizeofSDISegment 
)
Function to set the user requested Serial Digital Interface Data for the specified adapter.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex,ADLindex handle of the desired adapter.
[in]iSDIState,SDIstate (possiable values ADL_SDI_ON or ADL_SDI_OFF
[in]iSizeofSDISegment,sizeof the apreture
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

◆ ADL_Workstation_SDISegmentList_Get()

int ADL_Workstation_SDISegmentList_Get ( int  iAdapterIndex,
int *  lpMemorySegmentCount,
int **  lppMemorySegmentList 
)
Function to set the user requested Serial Digital Interface Data for the specified adapter.
Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndex,ADLindex handle of the desired adapter.
[out]lpMemorySegmentCount,pointerto the supported memory segment count of the specified adapter
[out]lppMemorySegmentList,pointerto the supported memory segment list of the 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

◆ ADL_Workstation_Stereo_Get()

int ADL_Workstation_Stereo_Get ( int  iAdapterIndex,
int *  lpDefState,
int *  lpCurState 
)

Function to retreive the worstation stereo mode.

This function retrieves the current and default workstation stereo mode.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[out]lpDefStateThe pointer to the default stereo mode. Workstation Capabilities
[out]lpCurStateThe pointer to the current stereo mode. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If lpDefState and/or lpCurState are NULL, ADL_ERR_NULL_POINTER is returned.
If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned. If the function is not supported, ADL_ERR_NOT_SUPPORTED is returned. For all other errors, ADL_ERR is returned.

◆ ADL_Workstation_Stereo_Set()

int ADL_Workstation_Stereo_Set ( int  iAdapterIndex,
int  iCurState 
)

Function to set the workstation stereo mode.

This function sets the current workstation stereo mode.

Supported Platforms:
Linux and Windows(XP, Vista and above); 32bit and 64bit
Parameters
[in]iAdapterIndexThe ADL index handle of the desired adapter.
[in]iCurStateThe desired workstation stereo mode. Workstation Capabilities
Returns
If the function is successful, ADL_OK is returned. If iAdapterIndex is an invalid adapter index, ADL_ERR_INVALID_ADL_IDX is returned.
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.