Ucs_Return_t Ucs_I2c_CreatePort	(	Ucs_Inst_t *	self,
		uint16_t	node_address,
		uint8_t	index,
		Ucs_I2c_Speed_t	speed,
		uint8_t	i2c_int_mask,
		Ucs_I2c_CreatePortResCb_t	result_fptr
	)

Creates an I2C Port with its associated parameter.

This function corresponds with the INIC function INIC.I2CPortCreate.

Parameters

self	The UNICENS instance pointer
node_address	Address of the target device. Use the UCS_ADDR_LOCAL_NODE macro to target the local device. The following address ranges are supported: [0x10 ... 0x2FF] [0x500 ... 0xFEF] UCS_ADDR_LOCAL_NODE
index	I2C Port instance.   Index
speed	The speed grade of the I2C Port.   Speed
i2c_int_mask	The bit mask corresponding to the I2C-interrupt on the GPIO Port.
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 NULL.
UCS_RET_ERR_BUFFER_OVERFLOW	No message buffer is available.
UCS_RET_ERR_API_LOCKED	API is currently locked.
UCS_RET_ERR_NOT_SUPPORTED	API is not supported in the current Network Supervisor Mode.
UCS_RET_ERR_NOT_INITIALIZED	UNICENS is not initialized.

Attention

The below points should be considered in order to receive the notification of the I2C interrupt:

• The Ucs_I2c_IntEventReportCb_t callback function should be registered in the Ucs_InitData_t init structure.
• The GPIO port has to be opened and the I2C interrupt pin associated with that port configured correctly.

See also section Example for Ucs_I2c_CreatePort for an example implementation.