I2C#

sl_i2c_instance_t#

sl_i2c_instance_t

Enumeration to represent I2C instances.

sl_i2c_status_t#

sl_i2c_status_t

Enumeration to represent I2C driver status values.

sl_i2c_transfer_type_t#

sl_i2c_transfer_type_t

Enumeration to represent I2C transfer type.

sl_i2c_operating_mode_t#

sl_i2c_operating_mode_t

Enumeration to represent I2C operating mode.

sl_i2c_power_modes_t#

sl_i2c_power_modes_t

Enumeration to represent I2C power modes.

sl_i2c_callback_t#

typedef void(* sl_i2c_callback_t) (sl_i2c_instance_t i2c_instance, uint32_t status) )(sl_i2c_instance_t i2c_instance, uint32_t status)

Callback for I2C Driver.

mode#

sl_i2c_mode_t sl_i2c_config_t::mode

Leader/Follower Mode, 0 for leader mode and 1 for follower mode.

operating_mode#

sl_i2c_operating_mode_t sl_i2c_config_t::operating_mode

Speed mode sl_i2c_operating_mode_t for possible values.

transfer_type#

sl_i2c_transfer_type_t sl_i2c_config_t::transfer_type

Transfer type sl_i2c_transfer_type_t for possible values.

i2c_callback#

sl_i2c_callback_t sl_i2c_config_t::i2c_callback

I2C callback sl_i2c_callback_t.

dma_tx_channel#

uint32_t sl_i2c_dma_config_t::dma_tx_channel

DMA transmit channel number.

dma_rx_channel#

uint32_t sl_i2c_dma_config_t::dma_rx_channel

DMA receive channel number.

tx_buffer#

uint8_t* sl_i2c_transfer_config_t::tx_buffer

Pointer to Tx Data buffer.

tx_len#

uint32_t sl_i2c_transfer_config_t::tx_len

Number of bytes to transmit.

rx_buffer#

uint8_t* sl_i2c_transfer_config_t::rx_buffer

Pointer to Rx Data buffer.

rx_len#

uint32_t sl_i2c_transfer_config_t::rx_len

Number of bytes to receive.

sda_port#

uint8_t sl_i2c_pin_init_t::sda_port

PWM GPIO port.

sda_pin#

uint8_t sl_i2c_pin_init_t::sda_pin

PWM GPIO pin.

sda_mux#

uint8_t sl_i2c_pin_init_t::sda_mux

PWM GPIO mux.

sda_pad#

uint8_t sl_i2c_pin_init_t::sda_pad

PWM GPIO pad.

scl_port#

uint8_t sl_i2c_pin_init_t::scl_port

PWM GPIO port.

scl_pin#

uint8_t sl_i2c_pin_init_t::scl_pin

PWM GPIO pin.

scl_mux#

uint8_t sl_i2c_pin_init_t::scl_mux

PWM GPIO mux.

scl_pad#

uint8_t sl_i2c_pin_init_t::scl_pad

PWM GPIO pad.

sl_i2c_driver_init#

sl_i2c_status_t sl_i2c_driver_init (sl_i2c_instance_t i2c_instance, const sl_i2c_config_t * p_user_config)

Initialize the I2C Module and clock.

Sets I2C instance mode,operating mode (bus-speed), frequency, and transfer type (using Interrupt or DMA). If the transfer type is DMA, it initializes DMA as well. Registers I2C instance callback and clears pending interrupts. Configures SDL and SCL pins as per the instance.

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

  • SL_I2C_CALLBACK_BUSY (0x0D) - Driver is busy

sl_i2c_driver_set_follower_address#

sl_i2c_status_t sl_i2c_driver_set_follower_address (sl_i2c_instance_t i2c_instance, uint16_t address)

This API configures the follower address of the I2C module.

Should be used only in Follower mode after instance initialization. It updates the slave address register I2C leader device initiates transfer with the address that matches slave address register of follower device.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here I2C mode should be set as follower mode

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_configure_fifo_threshold#

sl_i2c_status_t sl_i2c_driver_configure_fifo_threshold (sl_i2c_instance_t i2c_instance, uint8_t tx_threshold_value, uint8_t rx_threshold_value)

This API configures the TX and RX FIFO threshold values.

The valid range is 0-255, with the additional restriction that hardware does not allow this value to be set to a value larger than the depth of the buffer. A value of 0 sets the threshold for 1 entry, and a value of 255 sets the threshold for 256 entries. This should be called after I2C instance initialization.

• Pre-condition:

  • sl_i2c_driver_init

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_get_frequency#

sl_i2c_status_t sl_i2c_driver_get_frequency (sl_i2c_instance_t i2c_instance, uint32_t * frequency)

This API will read the current I2C clock frequency.

This API gets the current clock frequency of I2C in MHz, by reading the system core clock frequency.

• Pre-condition:

  • sl_i2c_driver_init

Returns

• status 0 if successful, else error code as follow.

  • SL_I2C_SUCCESS (0x0000) - Success.

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid.

sl_i2c_driver_send_data_blocking#

sl_i2c_status_t sl_i2c_driver_send_data_blocking (sl_i2c_instance_t i2c_instance, uint16_t address, uint8_t * tx_buffer, uint32_t tx_len)

This API sends the data in blocking mode.

This API sends the data in blocking mode using interrupt, sets follower address when used in leader application, sets transmit empty interrupt and enable I2C interrupts. It keeps the call blocked until the last byte is transferred.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here transfer-type should be set as interrupt-type

  • sl_i2c_driver_set_follower_address (if sending from slave)

  • sl_i2c_driver_configure_fifo_threshold

Note

• Maximum tx_len used can be 80000 (receives in around 10 seconds).

Returns

• status 0 if successful, else error code as follow.

  • SL_I2C_SUCCESS (0x0000) - Success.

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid.

sl_i2c_driver_send_data_non_blocking#

sl_i2c_status_t sl_i2c_driver_send_data_non_blocking (sl_i2c_instance_t i2c_instance, uint16_t address, uint32_t * tx_buffer, uint32_t tx_len, sl_i2c_dma_config_t * p_dma_config)

This API sends the data in non-blocking mode.

This API sends the data in non-blocking mode using DMA also sets the follower address when used in Leader application. Configures DMA rx and tx channels. Registers DMA callback & enables DMA channels. It updates the transfer complete flag SL_I2C_DATA_TRANSFER_COMPLETE after data transfer completion.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here transfer-type should be set as DMA-type

  • sl_i2c_driver_set_follower_address, if used in salve application

Note

• Maximum tx_len values can be 30000 (receives back in around 4 seconds)

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

  • SL_DMA_TRANSFER_ERROR - DMA parameters are invalid

sl_i2c_driver_receive_data_blocking#

sl_i2c_status_t sl_i2c_driver_receive_data_blocking (sl_i2c_instance_t i2c_instance, uint16_t address, uint8_t * rx_buffer, uint32_t rx_len)

This API receives the data in blocking mode.

This API receives the data in blocking mode using interrupt, also sets the follower address when used in Leader application. Sets receive full interrupt and enables I2C interrupts. It keeps the call blocked until the last byte is transferred.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here transfer-type should be set as interrupt-type

  • sl_i2c_driver_set_follower_address, if used in follower application

  • sl_i2c_driver_configure_fifo_threshold

Note

• Maximum rx_len used can be 80000 (receives in around 10 seconds)

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_receive_data_non_blocking#

sl_i2c_status_t sl_i2c_driver_receive_data_non_blocking (sl_i2c_instance_t i2c_instance, uint16_t address, uint8_t * rx_buffer, uint32_t rx_len, sl_i2c_dma_config_t * p_dma_config)

This API receives the data in non-blocking mode.

This API receives the data in non-blocking mode (using DMA), also sets the follower address when used in Leader application. Configures DMA rx and tx channels. Registers DMA callback & enables DMA channels. It updates the transfer complete flag SL_I2C_DATA_TRANSFER_COMPLETE after data transfer completion.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here transfer-type should be set as DMA-type

  • sl_i2c_driver_set_follower_address, if used in salve application

Note

• • Maximum rx_len values can be 30000 (receives back in around 4 seconds).

  • The default values cannot be any of the reserved address locations: that is, 0x00 to 0x07, or 0x78 to 0x7f.

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

  • SL_DMA_TRANSFER_ERROR - DMA parameters are invalid

sl_i2c_driver_transfer_data#

sl_i2c_status_t sl_i2c_driver_transfer_data (sl_i2c_instance_t i2c_instance, sl_i2c_transfer_config_t const * p_transfer_config, uint16_t address)

This API transmits data and then receives data from an I2C device.

This API first transmits data and then receives data from an I2C device using interrupts. Also sets follower address when used in Leader application. Sets & enable transmit empty interrupt while transmitting data . Sets & enable receive full interrupt while receiving data.

• Pre-conditions:

  • sl_i2c_driver_init

  • Here transfer-type should be set as Interrupt-type

  • sl_i2c_driver_set_follower_address, if used in follower application

Note

• Maximum tx_len & rx_len values can be 80000 (sends & receives back in around 20 seconds).

  • The default values cannot be any of the reserved address locations: that is, 0x00 to 0x07, or 0x78 to 0x7f.

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_deinit#

sl_i2c_status_t sl_i2c_driver_deinit (sl_i2c_instance_t i2c_instance)

De-initializes the I2C peripheral and clock.

This API will de-initializes the I2C peripheral, disables its clock and unregisters the callback.

• Pre-condition:

  • sl_i2c_driver_init

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

Note

• When the I2C module is used in combination with other peripherals, while de-initializing in the application, refer to the notes below:

  1. Whenever sl_i2c_driver_deinit() gets called, it will power down the domain (PERI_EFUSE), which contains different peripherals mentioned below: USART, UART, I2C, SSI Master, SSI Slave, Generic-SPI Master, I2S Master, I2S Slave, Micro-DMA Controller, Config Timer, Random-Number Generator, CRC Accelerator, SIO, QEI, MCPWM and EFUSE. Since deinit power downs the PERI_EFUSE doamin, it's recommended to call the sl_i2c_driver_deinit() API at the end of the application.

  2. Few peripherals (ULP Peripherals, UULP Peripherals, GPDMA and SDIO-SPI) have seperate domains that can be powered down indepedently. For additional details, refer to the Power architecture section in the Hardware Reference Manual e.g., To power down ULP I2C, use the API below: RSI_PS_M4ssPeriPowerDown(ULPSS_PWRGATE_ULP_I2C); Here, ULP_I2C has seperate power domain ULPSS_PWRGATE_ULP_I2C, which can be powered down indepedently. Refer to the rsi_power_save.h file for all power gates definitions.

sl_si91x_i2c_pin_init#

sl_i2c_status_t sl_si91x_i2c_pin_init (sl_i2c_pin_init_t * pin_init)

Set the Pin configuration for I2C.

It configures the SDA and SCL pins. Also enables internal pullups of SDA & SCL lines of follower device.

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_leader_reconfig_on_power_mode_change#

sl_i2c_status_t sl_i2c_driver_leader_reconfig_on_power_mode_change (sl_i2c_power_modes_t new_power_mode)

This API re-configures the I2C leader device on power mode changes.

Re-Config the I2C driver leader instance (I2C2) for ULP/HP mode. It will re-config I2C clock frequency required for I2C operating(speed) mode to run in ULP/HP mode.

• Pre-conditions:

  • sl_i2c_driver_init

  • Instance should be ULP mode when new mode is HP

  • Instance should be HP mode when new mode is ULP

  • Instance used should be ULP-I2C instance

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

sl_i2c_driver_enable_repeated_start#

sl_i2c_status_t sl_i2c_driver_enable_repeated_start (sl_i2c_instance_t i2c_instance, boolean_t enable_rep_start)

To enable or disable repeated start, to enable or disable combined format transfer.

Details :

• This API should be called by a leader application to enable repeated start, before starting data transfer.

• By enabling this, one can use combined format transfers.

• With this, I2C can perform combined write/read operations to same or different slave without releasing the line, thus with the guarantee that the operation is not interrupted.

  • Pre-condition:

sl_i2c_driver_init

Returns

• status 0 if successful, else error code as follow

  • SL_I2C_SUCCESS (0x0000) - Success

  • SL_I2C_INVALID_PARAMETER (0x0F) - Parameters are invalid

SL_I2C0_DMA_TX_CHANNEL#

#define SL_I2C0_DMA_TX_CHANNEL

31

I2C Peripheral.

Overview#

I2C standard compliant bus interface with open-drain pins Configurable as Primary or Secondary Four speed modes: Standard Mode (100 kbps), Fast Mode (400 kbps), Fast Mode Plus (1Mbps) and High-Speed Mode (3.4 Mbps) 7 or 10-bit addressing 7 or 10-bit combined format transfers Support for Clock synchronization and Bus Clear Programmable SDA Hold time Integrated transmit and receive buffers with support for DMA Bulk transmit mode in I2C Slave mode Interrupt based operation (polled mode also available)

Initialization#

Call init API with the init parameters. Call set follower address API, in follower mode Call Set FIFO threshold API

SL_I2C0_DMA_RX_CHANNEL#

#define SL_I2C0_DMA_RX_CHANNEL

30

SL_I2C1_DMA_TX_CHANNEL#

#define SL_I2C1_DMA_TX_CHANNEL

3

SL_I2C1_DMA_RX_CHANNEL#

#define SL_I2C1_DMA_RX_CHANNEL

2

SL_I2C2_DMA_TX_CHANNEL#

#define SL_I2C2_DMA_TX_CHANNEL

5

SL_I2C2_DMA_RX_CHANNEL#

#define SL_I2C2_DMA_RX_CHANNEL

4

ULP_I2C#

#define ULP_I2C

SL_I2C2