Ucs_Return_t Ucs_I2c_ReadPort	(	Ucs_Inst_t *	self,
		uint16_t	destination_address,
		uint16_t	port_handle,
		uint8_t	slave_address,
		uint8_t	data_len,
		uint16_t	timeout,
		Ucs_I2c_ReadPortResCb_t	result_fptr
	)

Reads a block of bytes from an I2C device at a specified I2C address.

This function corresponds with the INIC function INIC.I2CPortRead.

Parameters

self	The UNICENS instance pointer
destination_address	Address of the target device. Use the UCS_ADDR_LOCAL_DEV macro to target the local device. The following address ranges are supported: [0x10 ... 0x2FF] [0x500 ... 0xFEF] UCS_ADDR_LOCAL_DEV
port_handle	Port resource handle.   I2CPortHandle
slave_address	The 7-bit I2C slave address of the peripheral to be read.   SlaveAddress
data_len	Number of bytes to be read from the address.   Length
timeout	The timeout for the I2C Port read.   Timeout
result_fptr	Required result callback function pointer.

Returns

Possible return values are shown in the table below.

Value	Description
UCS_RET_SUCCESS	No error
UCS_RET_ERR_PARAM	At least one parameter is wrong
UCS_RET_ERR_BUFFER_OVERFLOW	No message buffer available
UCS_RET_ERR_API_LOCKED	API is currently locked
UCS_RET_ERR_NOT_INITIALIZED	UNICENS is not initialized

Example

// Main function
void main()
{
   Ucs_Return_t result = Ucs_I2c_ReadPort(0x14U, 0x0F00U, 0x20U, 5U, 0x0FU, &App_I2cReadPortResCb);
   if (result != UCS_RET_SUCCESS)
   {
       // Error handling here 
   }
}

// The event handler function
// Handle I2cReadPort event
static void App_I2cReadPortResCb(uint16_t device_id, uint16_t port_handle, uint8_t slave_address, uint8_t data_len, uint8_t data_ptr[], Ucs_I2c_Result_t result, void * user_ptr)
{
    if (result.code == UCS_I2C_RES_SUCCESS)
    {
       // Do what needs to be..
    }
    else
    {
        // Error handling here
    }
}