Data Structures
struct	XMC_I2C_CH_CONFIG_t

Macros
#define	XMC_I2C0_CH0 XMC_USIC0_CH0

#define	XMC_I2C0_CH1 XMC_USIC0_CH1

#define	XMC_I2C1_CH0 XMC_USIC1_CH0

#define	XMC_I2C1_CH1 XMC_USIC1_CH1

#define	XMC_I2C2_CH0 XMC_USIC2_CH0

#define	XMC_I2C2_CH1 XMC_USIC2_CH1

#define	XMC_I2C_10BIT_ADDR_GROUP (0x7800U)

Enumerations
enum	XMC_I2C_CH_INTERRUPT_NODE_POINTER_t

Functions
void	XMC_I2C_CH_ClearStatusFlag (XMC_USIC_CH_t *const channel, uint32_t flag)

void	XMC_I2C_CH_ConfigExternalInputSignalToBRG (XMC_USIC_CH_t *const channel, const uint16_t pdiv, const uint32_t oversampling, const XMC_USIC_CH_INPUT_COMBINATION_MODE_t combination_mode)

void	XMC_I2C_CH_DisableAcknowledgeAddress0 (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_DisableDataTransmission (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_DisableEvent (XMC_USIC_CH_t *const channel, uint32_t event)

void	XMC_I2C_CH_DisableMasterClock (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_EnableAcknowledgeAddress0 (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_EnableDataTransmission (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_EnableEvent (XMC_USIC_CH_t *const channel, uint32_t event)

void	XMC_I2C_CH_EnableMasterClock (XMC_USIC_CH_t *const channel)

uint8_t	XMC_I2C_CH_GetReceivedData (const XMC_USIC_CH_t *const channel)

uint8_t	XMC_I2C_CH_GetReceiverStatusFlag (XMC_USIC_CH_t *const channel)

uint16_t	XMC_I2C_CH_GetSlaveAddress (const XMC_USIC_CH_t *const channel)

uint32_t	XMC_I2C_CH_GetStatusFlag (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_Init (XMC_USIC_CH_t const channel, const XMC_I2C_CH_CONFIG_t const config)

void	XMC_I2C_CH_InitEx (XMC_USIC_CH_t const channel, const XMC_I2C_CH_CONFIG_t const config, bool init_brg)

void	XMC_I2C_CH_MasterReceiveAck (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_MasterReceiveNack (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_MasterRepeatedStart (XMC_USIC_CH_t *const channel, const uint16_t addr, const XMC_I2C_CH_CMD_t command)

void	XMC_I2C_CH_MasterStart (XMC_USIC_CH_t *const channel, const uint16_t addr, const XMC_I2C_CH_CMD_t command)

void	XMC_I2C_CH_MasterStop (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_MasterTransmit (XMC_USIC_CH_t *const channel, const uint8_t data)

void	XMC_I2C_CH_SelectInterruptNodePointer (XMC_USIC_CH_t *const channel, const XMC_I2C_CH_INTERRUPT_NODE_POINTER_t interrupt_node, const uint32_t service_request)

XMC_I2C_CH_STATUS_t	XMC_I2C_CH_SetBaudrate (XMC_USIC_CH_t *const channel, const uint32_t rate)

XMC_I2C_CH_STATUS_t	XMC_I2C_CH_SetBaudrateEx (XMC_USIC_CH_t *const channel, uint32_t rate, bool normal_divider_mode)

void	XMC_I2C_CH_SetHoldDelay (XMC_USIC_CH_t *const channel, uint32_t hdel)

void	XMC_I2C_CH_SetInputSource (XMC_USIC_CH_t *const channel, const XMC_I2C_CH_INPUT_t input, const uint8_t source)

void	XMC_I2C_CH_SetInterruptNodePointer (XMC_USIC_CH_t *const channel, const uint8_t service_request)

void	XMC_I2C_CH_SetSlaveAddress (XMC_USIC_CH_t *const channel, const uint16_t address)

void	XMC_I2C_CH_SlaveTransmit (XMC_USIC_CH_t *const channel, const uint8_t data)

void	XMC_I2C_CH_Start (XMC_USIC_CH_t *const channel)

XMC_I2C_CH_STATUS_t	XMC_I2C_CH_Stop (XMC_USIC_CH_t *const channel)

void	XMC_I2C_CH_TriggerServiceRequest (XMC_USIC_CH_t *const channel, const uint32_t service_request_line)

Detailed Description

USIC IIC Features:

Two-wire interface, with one line for shift clock transfer and synchronization (shift clock SCL), the other one for the data transfer (shift data SDA)
Communication in standard mode (100 kBit/s) or in fast mode (up to 400 kBit/s)
Support of 7-bit addressing, as well as 10-bit addressing
Master mode operation, where the IIC controls the bus transactions and provides the clock signal.
Slave mode operation, where an external master controls the bus transactions and provides the clock signal.
Multi-master mode operation, where several masters can be connected to the bus and bus arbitration can take place, i.e. the IIC module can be master or slave.
The master/slave operation of an IIC bus participant can change from frame to frame.
Efficient frame handling (low software effort), also allowing DMA transfers
Powerful interrupt handling due to multitude of indication flags

Macro Definition Documentation

◆ XMC_I2C0_CH0

#define XMC_I2C0_CH0 XMC_USIC0_CH0

USIC0 channel 0 base address

◆ XMC_I2C0_CH1

#define XMC_I2C0_CH1 XMC_USIC0_CH1

USIC0 channel 1 base address

◆ XMC_I2C1_CH0

#define XMC_I2C1_CH0 XMC_USIC1_CH0

USIC1 channel 0 base address

◆ XMC_I2C1_CH1

#define XMC_I2C1_CH1 XMC_USIC1_CH1

USIC1 channel 1 base address

◆ XMC_I2C2_CH0

#define XMC_I2C2_CH0 XMC_USIC2_CH0

USIC2 channel 0 base address

◆ XMC_I2C2_CH1

#define XMC_I2C2_CH1 XMC_USIC2_CH1

USIC2 channel 1 base address

◆ XMC_I2C_10BIT_ADDR_GROUP

#define XMC_I2C_10BIT_ADDR_GROUP (0x7800U)

Value to verify the address is 10-bit or not

Enumeration Type Documentation

◆ XMC_I2C_CH_CMD_t

enum XMC_I2C_CH_CMD_t

I2C commands.

Enumerator
XMC_I2C_CH_CMD_WRITE	I2C Command Write
XMC_I2C_CH_CMD_READ	I2C Command Read

◆ XMC_I2C_CH_EVENT_t

enum XMC_I2C_CH_EVENT_t

I2C events.

Enumerator
XMC_I2C_CH_EVENT_RECEIVE_START	Receive start event
XMC_I2C_CH_EVENT_DATA_LOST	Data lost event
XMC_I2C_CH_EVENT_TRANSMIT_SHIFT	Transmit shift event
XMC_I2C_CH_EVENT_TRANSMIT_BUFFER	Transmit buffer event
XMC_I2C_CH_EVENT_STANDARD_RECEIVE	Receive event
XMC_I2C_CH_EVENT_ALTERNATIVE_RECEIVE	Alternate receive event
XMC_I2C_CH_EVENT_BAUD_RATE_GENERATOR	Baudrate generator event
XMC_I2C_CH_EVENT_START_CONDITION_RECEIVED	Start condition received event
XMC_I2C_CH_EVENT_REPEATED_START_CONDITION_RECEIVED	Repeated start condition received event
XMC_I2C_CH_EVENT_STOP_CONDITION_RECEIVED	Stop condition received event
XMC_I2C_CH_EVENT_NACK	NACK received event
XMC_I2C_CH_EVENT_ARBITRATION_LOST	Arbitration lost event
XMC_I2C_CH_EVENT_SLAVE_READ_REQUEST	Slave read request event
XMC_I2C_CH_EVENT_ERROR	Error condition event
XMC_I2C_CH_EVENT_ACK	ACK received event

◆ XMC_I2C_CH_INPUT_t

enum XMC_I2C_CH_INPUT_t

I2C input stage selection.

Enumerator
XMC_I2C_CH_INPUT_SDA	selection of sda input stage
XMC_I2C_CH_INPUT_SCL	selection of scl input stage

◆ XMC_I2C_CH_INTERRUPT_NODE_POINTER_t

enum XMC_I2C_CH_INTERRUPT_NODE_POINTER_t

I2C channel interrupt node pointers

Enumerator
XMC_I2C_CH_INTERRUPT_NODE_POINTER_TRANSMIT_SHIFT	Node pointer for transmit shift interrupt
XMC_I2C_CH_INTERRUPT_NODE_POINTER_TRANSMIT_BUFFER	Node pointer for transmit buffer interrupt
XMC_I2C_CH_INTERRUPT_NODE_POINTER_RECEIVE	Node pointer for receive interrupt
XMC_I2C_CH_INTERRUPT_NODE_POINTER_ALTERNATE_RECEIVE	Node pointer for alternate receive interrupt
XMC_I2C_CH_INTERRUPT_NODE_POINTER_PROTOCOL	Node pointer for protocol related interrupts

◆ XMC_I2C_CH_RECEIVER_STATUS_FLAG_t

enum XMC_I2C_CH_RECEIVER_STATUS_FLAG_t

I2C receiver status. The received data byte is available at the bit positions RBUF[7:0], whereas the additional information is monitored at the bit positions RBUF[12:8].

Enumerator
XMC_I2C_CH_RECEIVER_STATUS_FLAG_ACK	Bit 8: Value of Received Acknowledgement bit
XMC_I2C_CH_RECEIVER_STATUS_FLAG_FIN	Bit 9: A 1 at this bit position indicates that after a (repeated) start condition followed by the address reception the first data byte of a new frame has been received. A 0 at this bit position indicates further data bytes
XMC_I2C_CH_RECEIVER_STATUS_FLAG_MODE	Bit 10: A 0 at this bit position indicates that the data byte has been received when the device has been in slave mode, whereas a 1 indicates a reception in master mode
XMC_I2C_CH_RECEIVER_STATUS_FLAG_ERR	Bit 11: A 1 at this bit position indicates an incomplete/erroneous data byte in the receive buffer
XMC_I2C_CH_RECEIVER_STATUS_FLAG_ADR	Bit 12: A 0 at this bit position indicates that the programmed address has been received. A 1 indicates a general call address.

◆ XMC_I2C_CH_STATUS_FLAG_t

enum XMC_I2C_CH_STATUS_FLAG_t

I2C status.

Enumerator
XMC_I2C_CH_STATUS_FLAG_SLAVE_SELECT	Slave select status
XMC_I2C_CH_STATUS_FLAG_WRONG_TDF_CODE_FOUND	Wrong TDF status
XMC_I2C_CH_STATUS_FLAG_START_CONDITION_RECEIVED	Start condition received status
XMC_I2C_CH_STATUS_FLAG_REPEATED_START_CONDITION_RECEIVED	Repeated start condition received status
XMC_I2C_CH_STATUS_FLAG_STOP_CONDITION_RECEIVED	Stop condition received status
XMC_I2C_CH_STATUS_FLAG_NACK_RECEIVED	NACK received status
XMC_I2C_CH_STATUS_FLAG_ARBITRATION_LOST	Arbitration lost status
XMC_I2C_CH_STATUS_FLAG_SLAVE_READ_REQUESTED	Slave read requested status
XMC_I2C_CH_STATUS_FLAG_ERROR	Error status
XMC_I2C_CH_STATUS_FLAG_ACK_RECEIVED	ACK received status
XMC_I2C_CH_STATUS_FLAG_RECEIVER_START_INDICATION	Receive start indication status
XMC_I2C_CH_STATUS_FLAG_DATA_LOST_INDICATION	Data lost indication status
XMC_I2C_CH_STATUS_FLAG_TRANSMIT_SHIFT_INDICATION	Transmit shift indication status
XMC_I2C_CH_STATUS_FLAG_TRANSMIT_BUFFER_INDICATION	Transmit buffer indication status
XMC_I2C_CH_STATUS_FLAG_RECEIVE_INDICATION	Receive indication status
XMC_I2C_CH_STATUS_FLAG_ALTERNATIVE_RECEIVE_INDICATION	Alternate receive indication status
XMC_I2C_CH_STATUS_FLAG_BAUD_RATE_GENERATOR_INDICATION	Baud rate generator indication status

◆ XMC_I2C_CH_STATUS_t

enum XMC_I2C_CH_STATUS_t

I2C Status.

Enumerator
XMC_I2C_CH_STATUS_OK	Status OK
XMC_I2C_CH_STATUS_ERROR	Status ERROR
XMC_I2C_CH_STATUS_BUSY	Status BUSY

Function Documentation

◆ XMC_I2C_CH_ClearStatusFlag()

void XMC_I2C_CH_ClearStatusFlag	(	XMC_USIC_CH_t *const	channel,
		uint32_t	flag
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
flag	Status flag

Returns: None

Description:: Clears the status flag of I2C channel by setting the input parameter flag in PSCR register.

Related APIs:: XMC_I2C_CH_GetStatusFlag()

◆ XMC_I2C_CH_ConfigExternalInputSignalToBRG()

void XMC_I2C_CH_ConfigExternalInputSignalToBRG	(	XMC_USIC_CH_t *const	channel,
		const uint16_t	pdiv,
		const uint32_t	oversampling,
		const XMC_USIC_CH_INPUT_COMBINATION_MODE_t	combination_mode
	)

Parameters

channel Pointer to USIC channel handler of type XMC_USIC_CH_t
Range: XMC_I2C0_CH0, XMC_I2C0_CH1,XMC_I2C1_CH0,XMC_I2C1_CH1,XMC_I2C2_CH0,XMC_I2C2_CH1

Note: Availability of I2C1 and I2C2 depends on device selection

Parameters

pdiv	Desired divider for the external frequency input. Range: minimum value = 1, maximum value = 1024
oversampling	Required oversampling. The value indicates the number of time quanta for one symbol of data. This can be related to the number of samples for each logic state of the data signal. Range: 1 to 32. Value should be chosen based on the protocol used.
combination_mode	USIC channel input combination mode

Returns: None

Description: Enables the external frequency input for the Baudrate Generator and configures the divider, oversampling and the combination mode of the USIC channel.

Related APIs:: XMC_USIC_CH_SetBRGInputClockSource(), XMC_USIC_CH_SetInputTriggerCombinationMode()

◆ XMC_I2C_CH_DisableAcknowledgeAddress0()

void XMC_I2C_CH_DisableAcknowledgeAddress0 ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: This bit defines that slave device should not be sensitive to the slave address 00H.

Related APIs:: XMC_I2C_CH_EnableAcknowledgeAddress0()

◆ XMC_I2C_CH_DisableDataTransmission()

void XMC_I2C_CH_DisableDataTransmission ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel handle of type XMC_USIC_CH_t
Range: XMC_I2C0_CH0, XMC_I2C0_CH1,XMC_I2C1_CH0,XMC_I2C1_CH1,XMC_I2C2_CH0,XMC_I2C2_CH1

Note: Availability of I2C1 and I2C2 depends on device selection

Returns: None

Description: Disable data transmission.

Use this function in combination with XMC_I2C_CH_EnableDataTransmission() to fill the FIFO and send the FIFO content without gaps in the transmission. FIFO is filled using XMC_USIC_CH_TXFIFO_PutData().

Related APIs:: XMC_I2C_CH_EnableDataTransmission()

◆ XMC_I2C_CH_DisableEvent()

void XMC_I2C_CH_DisableEvent	(	XMC_USIC_CH_t *const	channel,
		uint32_t	event
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
event	ORed values of XMC_I2C_CH_EVENT_t enum

Returns: None

Description:: Disables the input parameter XMC_I2C_CH_EVENT_t event using PCR_IICMode register.

Related APIs:: XMC_I2C_CH_EnableEvent()

◆ XMC_I2C_CH_DisableMasterClock()

void XMC_I2C_CH_DisableMasterClock ( XMC_USIC_CH_t *const channel )

Parameters

channel A constant pointer to XMC_USIC_CH_t, pointing to the USIC channel base address.

Returns: None

Description:: Disables the generation of Master clock by clearing PCR.MCLK bit.

This clock can be enabled by invoking XMC_I2C_CH_EnableMasterClock() as needed in the program.

Related APIs:: XMC_I2C_CH_EnableMasterClock()

◆ XMC_I2C_CH_EnableAcknowledgeAddress0()

void XMC_I2C_CH_EnableAcknowledgeAddress0 ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: Retrieves the status byte of I2C channel using PSR_IICMode register.

Related APIs:: XMC_I2C_CH_DisableAcknowledgeAddress0()

◆ XMC_I2C_CH_EnableDataTransmission()

void XMC_I2C_CH_EnableDataTransmission ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel handle of type XMC_USIC_CH_t
Range: XMC_I2C0_CH0, XMC_I2C0_CH1,XMC_I2C1_CH0,XMC_I2C1_CH1,XMC_I2C2_CH0,XMC_I2C2_CH1

Note: Availability of I2C1 and I2C2 depends on device selection

Returns: None

Description: Enable data transmission.

Use this function in combination with XMC_I2C_CH_DisableDataTransmission() to fill the FIFO and send the FIFO content without gaps in the transmission. FIFO is filled using XMC_USIC_CH_TXFIFO_PutData().

Note: If you need more control over the start of transmission use XMC_USIC_CH_SetStartTransmisionMode()

Related APIs:: XMC_I2C_CH_DisableDataTransmission()

◆ XMC_I2C_CH_EnableEvent()

void XMC_I2C_CH_EnableEvent	(	XMC_USIC_CH_t *const	channel,
		uint32_t	event
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
event	ORed values of XMC_I2C_CH_EVENT_t enum

Returns: None

Description:: Enables the input parameter XMC_I2C_CH_EVENT_t event using PCR_IICMode register.

Related APIs:: XMC_I2C_CH_DisableEvent()

◆ XMC_I2C_CH_EnableMasterClock()

void XMC_I2C_CH_EnableMasterClock ( XMC_USIC_CH_t *const channel )

Parameters

channel A constant pointer to XMC_USIC_CH_t, pointing to the USIC channel base address.

Returns: None

Description:: Enables the generation of Master clock by setting PCR.MCLK bit.

This clock can be used as a clock reference for external devices. This is not enabled during initialization in XMC_I2C_CH_Init(). Invoke XMC_I2C_CH_EnableMasterClock() to enable as needed in the program, or if it is disabled by XMC_I2C_CH_DisableMasterClock().

Related APIs:: XMC_I2C_CH_DisableMasterClock()

◆ XMC_I2C_CH_GetReceivedData()

uint8_t XMC_I2C_CH_GetReceivedData ( const XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: uint8_t OUTR/RBUF register data

Description:: Reads the data from I2C channel.

: Data is read by using OUTR/RBUF register based on FIFO/non-FIFO modes.

Related APIs:: XMC_I2C_CH_MasterTransmit()

◆ XMC_I2C_CH_GetReceiverStatusFlag()

uint8_t XMC_I2C_CH_GetReceiverStatusFlag ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: uint8_t Receiver status flag

Description:: Gets the receiver status of I2C channel using RBUF register of bits 8-12 which gives information about receiver status.

Related APIs:: XMC_I2C_CH_MasterTransmit()

◆ XMC_I2C_CH_GetSlaveAddress()

uint16_t XMC_I2C_CH_GetSlaveAddress ( const XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel handler of type XMC_USIC_CH_t

Returns: uint16_t Slave address

Description:: Gets the I2C channel slave address.

: Returns the address using PCR_IICMode register by checking if it is in 10-bit address group or 7-bit address group.
(If first five bits of address are assigned with 0xF0, then address mode is considered as 10-bit mode otherwise it is 7-bit mode)

Note: A 7-bit address will include an additional bit at the LSB. For example, address 0x05 will be returned as 0x0a. 10-bit address will not include the 10-bit address identifier 0b11110xx at the most signifcant bits.

Related APIs:: XMC_I2C_CH_SetSlaveAddress()

◆ XMC_I2C_CH_GetStatusFlag()

uint32_t XMC_I2C_CH_GetStatusFlag ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: uint32_t Status byte

Description:: Retrieves the status byte of I2C channel using PSR_IICMode register.

Related APIs:: XMC_I2C_CH_ClearStatusFlag()

◆ XMC_I2C_CH_Init()

void XMC_I2C_CH_Init	(	XMC_USIC_CH_t *const	channel,
		const XMC_I2C_CH_CONFIG_t *const	config
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
config	Constant pointer to I2C channel config structure of type XMC_I2C_CH_CONFIG_t

Returns: None

Description:: Initializes the I2C channel.

: Configures the data format in SCTR register. Sets the slave address, baud rate. Enables transmit data valid, clears status flags and disables parity generation.

Related APIs:: XMC_USIC_CH_Enable()

◆ XMC_I2C_CH_InitEx()

void XMC_I2C_CH_InitEx	(	XMC_USIC_CH_t *const	channel,
		const XMC_I2C_CH_CONFIG_t *const	config,
		bool	init_brg
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
config	Constant pointer to I2C channel config structure of type XMC_I2C_CH_CONFIG_t
init_brg	Selects if the baudrate generator should be configured automatically.

Returns: None

Description:: Initializes the I2C channel.

: Configures the data format in SCTR register. Sets the slave address, baud rate. Enables transmit data valid, clears status flags and disables parity generation.

Related APIs:: XMC_USIC_CH_Enable()

◆ XMC_I2C_CH_MasterReceiveAck()

void XMC_I2C_CH_MasterReceiveAck ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: Sends the Ack request from I2C master channel.

: Reads the transmit buffer status is busy or not and thereby updates IN/TBUF register based on FIFO/non-FIFO modes using Master Receive Ack command.

Related APIs:: XMC_I2C_CH_MasterTransmit()

◆ XMC_I2C_CH_MasterReceiveNack()

void XMC_I2C_CH_MasterReceiveNack ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: Sends the Nack request from I2C master channel.

: Reads the transmit buffer status is busy or not and thereby updates IN/TBUF register based on FIFO/non-FIFO modes using Master Receive Nack command.

Related APIs:: XMC_I2C_CH_MasterTransmit()

◆ XMC_I2C_CH_MasterRepeatedStart()

void XMC_I2C_CH_MasterRepeatedStart	(	XMC_USIC_CH_t *const	channel,
		const uint16_t	addr,
		const XMC_I2C_CH_CMD_t	command
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
addr	I2C master address
command	read/write command

Returns: None

Description:: Sends the repeated start condition from I2C master channel.

: Sends the repeated start condition with read/write command by updating IN/TBUF register based on FIFO/non-FIFO modes.

Note: Address(addr) should reserve an additional bit at the LSB for read/write indication. For example, address 0x05 should be provided as 0x0a. If the address is 10-bit, only most significant bits with the 10-bit identifier should be sent using this function. For example, if the 10-bit address is 0x305, the address should be provided as 0xf6(prepend with 0b11110, upper two bits of address 0b11, followed by 1-bit field for read/write).

Related APIs:: XMC_I2C_CH_MasterTransmit(), XMC_USIC_CH_GetTransmitBufferStatus()

◆ XMC_I2C_CH_MasterStart()

void XMC_I2C_CH_MasterStart	(	XMC_USIC_CH_t *const	channel,
		const uint16_t	addr,
		const XMC_I2C_CH_CMD_t	command
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
addr	I2C master address
command	read/write command

Returns: None

Description:: Starts the I2C master channel.

: Sends the Start condition with read/write command by updating IN/TBUF register based on FIFO/non-FIFO modes.

Note: Address(addr) should reserve an additional bit at the LSB for read/write indication. For example, address 0x05 should be provided as 0x0a. If the address is 10-bit, only most significant bits with the 10-bit identifier should be sent using this function. For example, if the 10-bit address is 0x305, the address should be provided as 0xf6(prepend with 0b11110, upper two bits of address 0b11, followed by 1-bit field for read/write).

Related APIs:: XMC_I2C_CH_MasterTransmit(), XMC_USIC_CH_GetTransmitBufferStatus()

◆ XMC_I2C_CH_MasterStop()

void XMC_I2C_CH_MasterStop ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: Stops the I2C master channel.

: Reads the transmit buffer status is busy or not and thereby updates IN/TBUF register based on FIFO/non-FIFO modes using Stop command.

Related APIs:: XMC_I2C_CH_MasterTransmit(), XMC_USIC_CH_GetTransmitBufferStatus()

◆ XMC_I2C_CH_MasterTransmit()

void XMC_I2C_CH_MasterTransmit	(	XMC_USIC_CH_t *const	channel,
		const uint8_t	data
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
data	data to transmit from I2C channel

Returns: None

Description:: Transmit the data from the I2C master channel.

: Reads the transmit buffer status is busy or not and thereby updates IN/TBUF register based on FIFO/non-FIFO modes using Master Send command.

Related APIs:: XMC_USIC_CH_GetTransmitBufferStatus()

◆ XMC_I2C_CH_SelectInterruptNodePointer()

void XMC_I2C_CH_SelectInterruptNodePointer	(	XMC_USIC_CH_t *const	channel,
		const XMC_I2C_CH_INTERRUPT_NODE_POINTER_t	interrupt_node,
		const uint32_t	service_request
	)

Parameters

channel Pointer to USIC channel handler of type XMC_USIC_CH_t
Range: XMC_I2C0_CH0, XMC_I2C0_CH1,XMC_I2C1_CH0,XMC_I2C1_CH1,XMC_I2C2_CH0,XMC_I2C2_CH1

Note: Availability of I2C1 and I2C2 depends on device selection

Parameters

interrupt_node	Interrupt node pointer to be configured. Range: XMC_I2C_CH_INTERRUPT_NODE_POINTER_TRANSMIT_SHIFT, XMC_I2C_CH_INTERRUPT_NODE_POINTER_TRANSMIT_BUFFER etc.
service_request	Service request number. Range: 0 to 5.

Returns: None

Description: Sets the interrupt node for USIC channel events.

For an event to generate interrupt, node pointer should be configured with service request(SR0, SR1..SR5). The NVIC node gets linked to the interrupt event by doing so.
Note: NVIC node should be separately enabled to generate the interrupt.

Related APIs:: XMC_I2C_CH_EnableEvent()

◆ XMC_I2C_CH_SetBaudrate()

XMC_I2C_CH_STATUS_t XMC_I2C_CH_SetBaudrate	(	XMC_USIC_CH_t *const	channel,
		const uint32_t	rate
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
rate	baud rate of I2C channel

Returns: None

Description:: Sets the rate of I2C channel.

Note:: Standard over sampling is considered if rate <= 100KHz and fast over sampling is considered if rate > 100KHz.

Related APIs:: XMC_USIC_CH_SetBaudrate()

◆ XMC_I2C_CH_SetBaudrateEx()

XMC_I2C_CH_STATUS_t XMC_I2C_CH_SetBaudrateEx	(	XMC_USIC_CH_t *const	channel,
		uint32_t	rate,
		bool	normal_divider_mode
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
rate	baud rate of I2C channel
normal_divider_mode	Selects normal divider mode for baudrate generator instead of default fractional divider decreasing jitter of signal at the cost of frequency selection

Returns: None

Description:: Sets the rate of I2C channel.

Note:: Standard over sampling is considered if rate <= 100KHz and fast over sampling is considered if rate > 100KHz.

Related APIs:: XMC_USIC_CH_SetBaudrate()

◆ XMC_I2C_CH_SetHoldDelay()

void XMC_I2C_CH_SetHoldDelay	(	XMC_USIC_CH_t *const	channel,
		uint32_t	hdel
	)

Parameters

channel A constant pointer to XMC_USIC_CH_t, pointing to the USIC channel base address.

Returns: None

Description:

To respect the specified SDA hold time of 300 ns for standard mode and fast mode after a falling edge of signal SCL, a hold delay tHDEL has been introduced. It also prevents an erroneous detection of a start or a stop condition. The length of this delay can be programmed by bit field PCR.HDEL. Taking into account the input sampling and output update, bit field HDEL can be programmed according to:

HDEL >= 300ns x fPPP - (3 x fPPP/fPERIH) + 1 (with digital filter and HDELmin = 2)
HDEL >= 300ns x fPPP - (3 x fPPP/fPERIH) + 2 (without digital filter and HDELmin = 1) If the digital input filter is used, HDEL compensates the filter delay of 2 filter periods (fPPP should be used) in case of a spike on the input signal. This ensures that a data bit on the SDA line changing just before the rising edge or behind the falling edge of SCL will not be treated as a start or stop condition.

◆ XMC_I2C_CH_SetInputSource()

void XMC_I2C_CH_SetInputSource	(	XMC_USIC_CH_t *const	channel,
		const XMC_I2C_CH_INPUT_t	input,
		const uint8_t	source
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
input	I2C channel input stage of type XMC_I2C_CH_INPUT_t
source	Input source select for the input stage(0->DX0A, 1->DX1A, .. 7->DX7G)

Returns: None

Description:: Sets the input source for I2C channel.
Defines the input stage for the corresponding input line.

Note: After configuring the input source for corresponding channel, interrupt node pointer is set.

Related APIs:: XMC_USIC_CH_SetInptSource(), XMC_USIC_CH_SetInterruptNodePointer()

◆ XMC_I2C_CH_SetInterruptNodePointer()

void XMC_I2C_CH_SetInterruptNodePointer	(	XMC_USIC_CH_t *const	channel,
		const uint8_t	service_request
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
service_request	Service request number in the range of 0-5

Returns: None

Description:: Sets the interrupt node for protocol interrupt.

: To generate interrupt for an event, node pointer should be configured with service request number(SR0, SR1..SR5). The NVIC node gets linked to the interrupt event by doing so.

Note:: NVIC node should be separately enabled to generate the interrupt. After setting the node pointer, desired event must be enabled.

Related APIs:: XMC_I2C_CH_EnableEvent(), NVIC_SetPriority(), NVIC_EnableIRQ(), XMC_I2C_CH_SetInputSource()

◆ XMC_I2C_CH_SetSlaveAddress()

void XMC_I2C_CH_SetSlaveAddress	(	XMC_USIC_CH_t *const	channel,
		const uint16_t	address
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
address	I2C slave address

Returns: None

Description:: Sets the I2C channel slave address.

: Address is set in PCR_IICMode register by checking if it is in 10-bit address group or 7-bit address group. (If first five bits of address are assigned with 0xF0, then address mode is 10-bit mode otherwise it is 7-bit mode)

Note: A 7-bit address should include an additional bit at the LSB for read/write indication. For example, address 0x05 should be provided as 0x0a. A 10-bit address should be provided with the identifier 0b11110xx at the most significant bits. For example, address 0x305 should be provided as 0x7b05(bitwise OR with 0x7800).

Related APIs:: XMC_I2C_CH_GetSlaveAddress()

◆ XMC_I2C_CH_SlaveTransmit()

void XMC_I2C_CH_SlaveTransmit	(	XMC_USIC_CH_t *const	channel,
		const uint8_t	data
	)

Parameters

channel	Constant pointer to USIC channel structure of type XMC_USIC_CH_t
data	data to transmit from I2C channel

Returns: None

Description:: Transmit the data from the I2C slave channel.

: Reads the transmit buffer status is busy or not and thereby updates IN/TBUF register based on FIFO/non-FIFO modes using Slave Send command.

Related APIs:: XMC_USIC_CH_GetTransmitBufferStatus(),XMC_I2C_CH_ClearStatusFlag()

◆ XMC_I2C_CH_Start()

void XMC_I2C_CH_Start ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: None

Description:: Starts the I2C channel.

: Sets the USIC input operation mode to I2C mode using CCR register.

Related APIs:: XMC_USIC_CH_SetMode()

◆ XMC_I2C_CH_Stop()

XMC_I2C_CH_STATUS_t XMC_I2C_CH_Stop ( XMC_USIC_CH_t *const channel )

Parameters

channel Constant pointer to USIC channel structure of type XMC_USIC_CH_t

Returns: XMC_I2C_CH_STATUS_t

Description:: Stops the I2C channel.

: Sets the USIC input operation to IDLE mode using CCR register.

Related APIs:: XMC_USIC_CH_SetMode()

◆ XMC_I2C_CH_TriggerServiceRequest()

void XMC_I2C_CH_TriggerServiceRequest	(	XMC_USIC_CH_t *const	channel,
		const uint32_t	service_request_line
	)

Parameters

channel Pointer to USIC channel handler of type XMC_USIC_CH_t
Range: XMC_I2C0_CH0, XMC_I2C0_CH1,XMC_I2C1_CH0,XMC_I2C1_CH1,XMC_I2C2_CH0,XMC_I2C2_CH1

Note: Availability of I2C1 and I2C2 depends on device selection

Parameters

service_request_line service request number of the event to be triggered.
Range: 0 to 5.

Returns: None

Description: Trigger a I2C interrupt service request.

When the I2C service request is triggered, the NVIC interrupt associated with it will be generated if enabled.

Related APIs:: XMC_I2C_CH_SelectInterruptNodePointer()

Data Structures

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ XMC_I2C0_CH0

◆ XMC_I2C0_CH1

◆ XMC_I2C1_CH0

◆ XMC_I2C1_CH1

◆ XMC_I2C2_CH0

◆ XMC_I2C2_CH1

◆ XMC_I2C_10BIT_ADDR_GROUP

Enumeration Type Documentation

◆ XMC_I2C_CH_CMD_t

◆ XMC_I2C_CH_EVENT_t

◆ XMC_I2C_CH_INPUT_t

◆ XMC_I2C_CH_INTERRUPT_NODE_POINTER_t

◆ XMC_I2C_CH_RECEIVER_STATUS_FLAG_t

◆ XMC_I2C_CH_STATUS_FLAG_t

◆ XMC_I2C_CH_STATUS_t

Function Documentation

◆ XMC_I2C_CH_ClearStatusFlag()

◆ XMC_I2C_CH_ConfigExternalInputSignalToBRG()

◆ XMC_I2C_CH_DisableAcknowledgeAddress0()

◆ XMC_I2C_CH_DisableDataTransmission()

◆ XMC_I2C_CH_DisableEvent()

◆ XMC_I2C_CH_DisableMasterClock()

◆ XMC_I2C_CH_EnableAcknowledgeAddress0()

◆ XMC_I2C_CH_EnableDataTransmission()

◆ XMC_I2C_CH_EnableEvent()

◆ XMC_I2C_CH_EnableMasterClock()

◆ XMC_I2C_CH_GetReceivedData()

◆ XMC_I2C_CH_GetReceiverStatusFlag()

◆ XMC_I2C_CH_GetSlaveAddress()

◆ XMC_I2C_CH_GetStatusFlag()

◆ XMC_I2C_CH_Init()

◆ XMC_I2C_CH_InitEx()

◆ XMC_I2C_CH_MasterReceiveAck()

◆ XMC_I2C_CH_MasterReceiveNack()

◆ XMC_I2C_CH_MasterRepeatedStart()

◆ XMC_I2C_CH_MasterStart()

◆ XMC_I2C_CH_MasterStop()

◆ XMC_I2C_CH_MasterTransmit()

◆ XMC_I2C_CH_SelectInterruptNodePointer()

◆ XMC_I2C_CH_SetBaudrate()

◆ XMC_I2C_CH_SetBaudrateEx()

◆ XMC_I2C_CH_SetHoldDelay()

◆ XMC_I2C_CH_SetInputSource()

◆ XMC_I2C_CH_SetInterruptNodePointer()

◆ XMC_I2C_CH_SetSlaveAddress()

◆ XMC_I2C_CH_SlaveTransmit()

◆ XMC_I2C_CH_Start()

◆ XMC_I2C_CH_Stop()

◆ XMC_I2C_CH_TriggerServiceRequest()