Ucs_Return_t Ucs_Xrm_Stream_SetPortConfig	(	Ucs_Inst_t *	self,
		uint16_t	destination_address,
		uint8_t	index,
		Ucs_Stream_PortOpMode_t	op_mode,
		Ucs_Stream_PortOption_t	port_option,
		Ucs_Stream_PortClockMode_t	clock_mode,
		Ucs_Stream_PortClockDataDelay_t	clock_data_delay,
		Ucs_Xrm_Stream_PortCfgResCb_t	result_fptr
	)

This function is used to configure a Streaming Port.

This function corresponds with the INIC function INIC.StreamPortConfiguration.

Parameters

self	The UNICENS instance pointer
destination_address	Device address of the target. 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
index	Streaming Port instance.   Index
op_mode	Operation mode of the Streaming Port.   OperationMode
port_option	Direction of the Streaming Port.   PortOptions
clock_mode	Configuration of the FSY/SCK signals.   ClockMode
clock_data_delay	Configuration of the FSY/SCK signals for Generic Streaming.   ClockDataDelay
result_fptr	Required result callback

Returns

Possible return values are shown in the table below.

Value	Description
UCS_RET_SUCCESS	No error
UCS_RET_ERR_PARAM	The given UNICENS instance pointer is NULL
UCS_RET_ERR_BUFFER_OVERFLOW	No message buffer available
UCS_RET_ERR_NOT_INITIALIZED	UNICENS is not initialized

Example

// Main function
void main()
{
  // ...

  Ucs_Xrm_Stream_SetPortConfig (ucs_inst_ptr,
                                0x555U, 
                                0x0U,
                                UCS_STREAM_PORT_OP_MODE_GENERIC,
                                UCS_STREAM_PORT_OPT_IN_OUT,
                                UCS_STREAM_PORT_CLK_MODE_OUTPUT,
                                UCS_STREAM_PORT_CLK_DLY_NONE,
                                &App_XrmStreamPortCfgResCb);
  // ...

} 


 // The streaming port result callback function
 static void App_XrmStreamPortCfgResCb(uint16_t node_address,
                                       uint8_t index,
                                       Ucs_Stream_PortOpMode_t op_mode,
                                       Ucs_Stream_PortOption_t port_option,
                                       Ucs_Stream_PortClockMode_t clock_mode,
                                       Ucs_Stream_PortClockDataDelay_t clock_data_delay,
                                       Ucs_StdResult_t result,
                                       void *user_ptr)
 {
     if (result.code != UCS_RES_SUCCESS)
     {
         // Do whatever is necessary here...
     }
 }