I2c

This section introduces the Inter-Integrated Circuit (I2C) APIs including terms and acronyms, supported features, details on how to use this driver, enums and functions. More...

Overview

This section introduces the Inter-Integrated Circuit (I2C) APIs including terms and acronyms, supported features, details on how to use this driver, enums and functions.

Terms and Acronyms

Terms	Details
DMA	Direct Memory Access.
FIFO	First In, First Out.
I2C	Inter-Integrated Circuit.

Supported Features

See Supported features for the details of Supported Features.

How to use this driver

• Device driver sample code is as follows:
  
  • sample code (this is the user application sample code on freeRTos):

    - init I2C
     -Call mtk_os_hal_i2c_ctrl_init(i2c_num bus_num)
       to init i2c bus.
    
    - set I2C master transfer speed
      -Call mtk_os_hal_i2c_speed_init(i2c_num bus_num,
                enum i2c_speed_kHz speed)
    
    - I2C master read data from slave device
     -Call mtk_os_hal_i2c_read(i2c_num bus_num,
               u8 device_addr, u8 *buffer, u16 len)
    
    - I2C master write data to slave device
     -Call mtk_os_hal_i2c_write(i2c_num bus_num,
               u8 device_addr, u8 *buffer, u16 len)
    
    -I2C master write data to slave device then read data from device
     -Call mtk_os_hal_i2c_write_read(i2c_num bus_num,
               u8 device_addr, u8 *wr_buf, u8 *rd_buf,
               u16 wr_len, u16 rd_len)
    
    -Set I2C controler slave address
     -Call mtk_os_hal_i2c_set_slave_addr(i2c_num bus_num,
               u8 slv_addr)
    
    -Set I2C slave send data to the master
     -Call mtk_os_hal_i2c_slave_tx(i2c_num bus_num,
               u8 *buffer, u16 len, u32 time_out)
    
    -Set I2C slave receive data from the master
     -Call mtk_os_hal_i2c_slave_rx(i2c_num bus_num,
               u8 *buffer, u16 len, u32 time_out)
    
    - uninit I2C
     - Call  mtk_os_hal_i2c_ctrl_deinit(i2c_num bus_num) to uninit
        i2c and release resource.

Modules
	Enum
	This section introduces the enumerations that I2C uses while performing transfer.
	Function
	This section provides high level APIs to upper layer.