I2C, DDC and EDID APIs


Functions

int ADL_Display_WriteAndReadI2CRev_Get (int iAdapterIndex, int *lpMajor, int *lpMinor)
 Function to retrieve the I2C API revision.
int ADL_Display_WriteAndReadI2C (int iAdapterIndex, ADLI2C *plI2C)
 Function to write and read I2C.
int ADL_Display_DDCBlockAccess_Get (int iAdapterIndex, int iDisplayIndex, int iOption, int iCommandIndex, int iSendMsgLen, char *lpucSendMsgBuf, int *lpulRecvMsgLen, char *lpucRecvMsgBuf)
 Function to get Display DDC block access.
int ADL_Display_DDCInfo_Get (int iAdapterIndex, int iDisplayIndex, ADLDDCInfo *lpInfo)
 Function to get the DDC info.
int ADL_Display_DDCInfo2_Get (int iAdapterIndex, int iDisplayIndex, ADLDDCInfo2 *lpInfo)
 Function to get the DDC info.
int ADL_Display_EdidData_Get (int iAdapterIndex, int iDisplayIndex, ADLDisplayEDIDData *lpEDIDData)
 Function to get the EDID data.

Detailed Description

This group outlines I2C, DDC and EDID related APIs.

Function Documentation

int ADL_Display_WriteAndReadI2CRev_Get ( int  iAdapterIndex,
int *  lpMajor,
int *  lpMinor 
)

Function to retrieve the I2C API revision.

This function retrieves the I2C API revision.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[out] lpMajor The pointer to the major version.
[out] lpMinor The pointer to the minor version.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Display_WriteAndReadI2C ( int  iAdapterIndex,
ADLI2C plI2C 
)

Function to write and read I2C.

This function writes and reads I2C.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in,out] plI2C A pointer to the ADLI2C structure.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Display_DDCBlockAccess_Get ( int  iAdapterIndex,
int  iDisplayIndex,
int  iOption,
int  iCommandIndex,
int  iSendMsgLen,
char *  lpucSendMsgBuf,
int *  lpulRecvMsgLen,
char *  lpucRecvMsgBuf 
)

Function to get Display DDC block access.

This function provides means for applications to send/receive data in the DDC information block via the 12C bus.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in] iOption Combination of ADL_DDC_OPTION_SWITCHDDC2 and ADL_DDC_OPTION_RESTORECOMMAND
[in] iCommandIndex The index of the command to be saved in the registry. This parameter is used only when ADL_DDC_OPTION_RESTORECOMMAND of iOption is specified. Otherwize set this parameter to 0.
[in] iSendMsgLen The size of the send message buffer.
[in] lpucSendMsgBuf The pointer to the send message buffer.
[out] lpulRecvMsgLen The pointer to the size of the receive message buffer.
[out] lpucRecvMsgBuf The pointer to the retrieved receive message buffer.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes
Remarks:
To send data without receiving anything back, specify non-zero send message size and non-NULL buffer, then set the receive message size to 0 and buffer to NULL.
To receive data, you have to send a command defined by the I2C protocol to the display, so you will always have to send some sequence of bytes to the display, even if you only want to read from the display.
To send and receive data at the same time, specify non-zero send and receive message size and non-NULL send and receive message buffers. You will have to worry about sending proper commands to the display, as defined by the I2C protocol.

int ADL_Display_DDCInfo_Get ( int  iAdapterIndex,
int  iDisplayIndex,
ADLDDCInfo lpInfo 
)

Function to get the DDC info.

This function retrieves the display device config (DDC) information only if the device has the information. No assumption should be made that this call will cause the driver will do real time detection. The driver determines when DDC detection should take place. If a display is attached and it supports DDC, all available information should be returned and ADLDDCInfo.ulSupportsDDC should be set to 1. Any fields that are not supported by an attached DDC display should be zeroed on return.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out] lpInfo The pointer to the ADLDDCInfo structure storing all DDC retrieved from the driver.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Display_DDCInfo2_Get ( int  iAdapterIndex,
int  iDisplayIndex,
ADLDDCInfo2 lpInfo 
)

Function to get the DDC info.

This function retrieves the display device config (DDC) information only if the device has the information. No assumption should be made that this call will cause the driver will do real time detection. The driver determines when DDC detection should take place. If a display is attached and it supports DDC, all available information should be returned and ADLDDCInfo.ulSupportsDDC should be set to 1. Any fields that are not supported by an attached DDC display should be zeroed on return.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[out] lpInfo The pointer to the ADLDDCInfo structure storing all DDC retrieved from the driver.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes

int ADL_Display_EdidData_Get ( int  iAdapterIndex,
int  iDisplayIndex,
ADLDisplayEDIDData lpEDIDData 
)

Function to get the EDID data.

This function retrieves the EDID data for a specififed display.

Supported Platforms:
Linux and Windows(XP, Vista and Windows 7); 32bit and 64bit
Parameters:
[in] iAdapterIndex The ADL index handle of the desired adapter.
[in] iDisplayIndex The desired display index. It can be retrieved from the ADLDisplayInfo data structure.
[in,out] lpEDIDData The pointer to the ADLDisplayEDIDData structure storing the retrieved EDID data.
Returns:
If the function succeeds, the return value is ADL_OK. Otherwise the return value is an ADL error code. Result Codes


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