CN / EN
文档反馈
感谢关注汇顶文档,期待您的宝贵建议!
感谢您的反馈,祝您愉快!

APP I2C驱动

结构体

app_i2c_pin_t

结构体定义如下:

表 143 app_i2c_pin_t结构体成员
成员 描述 取值

app_io_type_t type

IO类型

app_io_evt_t结构体中描述

app_io_mux_t mux

IO映射功能

查看app_io_init_t结构体定义,具体取值参考芯片Datasheet中的Pin Mux

uint32_t pin

IO引脚

查看app_io_init_t结构体定义,具体取值参考芯片Datasheet中的Pin Mux

app_io_pull_t pull

IO上拉/下拉/浮空

app_io_init_t结构体中描述

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_pin_cfg_t

结构体定义如下:

表 144 app_i2c_pin_cfg_t结构体成员
成员 描述 取值

app_i2c_pin_t scl

I2C SCL引脚配置

参考app_i2c_pin_t结构体

app_i2c_pin_t sda

I2C SDA引脚配置

参考app_i2c_pin_t结构体

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_dma_cfg_t

结构体定义如下:

表 145 app_i2c_dma_cfg_t结构体成员
成员 描述 取值

dma_reg_t *tx_dma_instance

I2C TX指定DMA模块配置

参考app_dma_params_t 章节中,DMA支持的外设

dma_reg_t *rx_dma_instance

I2C RX指定DMA模块配置

参考app_dma_params_t 章节中,DMA支持的外设

dma_channel_t tx_dma_channel

I2C TX的DMA通道选择

app_dma_params_t中通道描述

dma_channel_t rx_dma_channel

I2C RX的DMA通道选择

app_dma_params_t中通道描述

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_params_t

结构体定义如下:

表 146 app_i2c_params_t结构体成员
成员 描述 取值

app_i2c_id_t id

I2C模块ID

  • APP_I2C_ID_0(I2C 0)
  • APP_I2C_ID_1(I2C 1)
  • APP_I2C_ID_2(I2C 2)
  • APP_I2C_ID_3(I2C 3)
  • APP_I2C_ID_4(I2C 4)
  • APP_I2C_ID_5(I2C 5)

app_i2c_role_t role

I2C工作方式

该参数的取值可以是下列值中的任意一个:
  • APP_I2C_ROLE_MASTER(I2C配置为Master)
  • APP_I2C_ROLE_SLAVE(I2C配置为Slave)

app_i2c_pin_cfg_t pin_cfg

I2C引脚功能

参考app_i2c_pin_cfg_t结构体

app_i2c_dma_cfg_t dma_cfg

I2C操作模式

参考app_i2c_dma_cfg_t结构体

i2c_init_t init

I2C初始化参数配置

参考i2c_init_t结构体

i2c_env_t i2c_dev

仅用于记录初始化设备的句柄、相关参数和信号量等,不需要配置

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

i2c_init_t

结构体定义如下:

表 147 i2c_init_t结构体成员
成员 描述 取值

uint32_t speed

I2C传输速率

该参数的取值可以是下列值中的任意一个:
  • I2C_SPEED_100K(100 kHz, standard mode)
  • I2C_SPEED_400K(400 kHz, fast mode)
  • I2C_SPEED_1000K(1000 kHz, fast plus mode)
  • I2C_SPEED_2000K(2000 kHz, high-speed mode)

uint32_t own_address

I2C地址

作为Master主设备时,该参数无意义;作为Slave从设备时,由用户指定配置

uint32_t addressing_mode

I2C地址模式

该参数的取值可以是下列值中的任意一个:
  • I2C_ADDRESSINGMODE_7BIT(7 bits地址)
  • I2C_ADDRESSINGMODE_10BIT(10 bits地址)

uint32_t general_call_mode

通用广播模式

该参数的取值可以是下列值中的任意一个:
  • I2C_GENERALCALL_DISABLE(禁用)
  • I2C_GENERALCALL_ENABLE(使能)

uint32_t tx_hold_time

TX SDA保持时间,单位:ns

uint32_t rx_hold_time

RX SDA保持时间,单位:ns

app_i2c_evt_t

结构体定义如下:

表 148 app_i2c_evt_t结构体成员
成员 描述 取值

app_i2c_evt_type_t type

I2C事件类型

该参数的取值可以是下列值中的任意一个:
  • APP_I2C_EVT_ERROR(I2C传输错误)
  • APP_I2C_EVT_TX_CPLT(I2C发送完成)
  • APP_I2C_EVT_RX_DATA(I2C接收完成)
  • APP_I2C_ABORT(I2C传输中止)

union

{

uint32_t error_code;

uint16_t size;

}data;

  • uint32_t error_code:I2C事件返回的错误号
  • uint16_t size:I2C已接收/发送的数据长度

说明:

若事件类型为传输错误,此处返回错误号;若事件类型为接收/发送完成,此处显示已接收/发送的数据长度

I2C错误号:
  • HAL_I2C_ERROR_NONE(无错误)
  • HAL_I2C_ERROR_INVALID_PARAM(无效参数)
  • HAL_I2C_ERROR_ARB_LOST(仲裁丢失)
  • HAL_I2C_ERROR_NOACK(无回应)
  • HAL_I2C_ERROR_OVER(RX溢出)
  • HAL_I2C_ERROR_SCL_STUCK_AT_LOW(SCL 被强制拉低)
  • HAL_I2C_ERROR_SDA_STUCK_AT_LOW(SDA 被强制拉低)
  • HAL_I2C_ERROR_DMA(DMA错误)
  • HAL_I2C_ERROR_TIMEOUT(超时)

uint16_t slave_addr

I2C从设备地址

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

枚举

app_i2c_id_t

枚举定义如下:

表 149 app_i2c_id_t枚举成员
成员 描述

APP_I2C_ID_0 = 0

I2C模块0

APP_I2C_ID_1 = 1

I2C模块1

APP_I2C_ID_2 = 2

I2C模块2,仅适用于GR5526和GR5x25

APP_I2C_ID_3 = 3

I2C模块3,仅适用于GR5526和GR5x25

APP_I2C_ID_4 = 4

I2C模块4,仅适用于GR5526

APP_I2C_ID_5 = 5

I2C模块5,仅适用于GR5526

APP_I2C_ID_MAX = 6

I2C模块总个数,用于做参数检测

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_role_t

枚举定义如下:

表 150 app_i2c_role_t枚举成员
成员 描述

APP_I2C_ROLE_MASTER = 0

I2C作为Master

APP_I2C_ROLE_SLAVE = 1

I2C作为Slave

APP_I2C_ROLE_MAX = 2

I2C ROLE总个数,用于做参数检测

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_evt_type_t

枚举定义如下:

表 151 app_i2c_evt_type_t枚举成员
成员 描述

APP_I2C_EVT_ERROR = 0

I2C传输错误事件

APP_I2C_EVT_TX_CPLT = 1

I2C发送完成事件

APP_I2C_EVT_RX_DATA = 2

I2C接收完成事件

APP_I2C_ABORT = 3

I2C Master传输中止事件

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_state_t

枚举定义如下:

表 152 app_i2c_state_t枚举成员
成员 描述

APP_I2C_INVALID = 0

I2C不可用

APP_I2C_ACTIVITY = 1

I2C激活

APP_I2C_SLEEP = 2

I2C睡眠

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

app_i2c_dma_state_t

枚举定义如下:

表 153 app_i2c_dma_state_t枚举成员
成员 描述
APP_I2C_DMA_INVALID = 0 I2C DMA不可用
APP_I2C_DMA_ACTIVITY = 1 I2C DMA激活

详细信息请参考文件:SDK_Folder\drivers\inc\app_i2c.h

接口函数

表 154 I2C驱动接口函数
API 芯片
GR551x GR5526 GR5x25 GR533x GR5405

app_i2c_init

Y

Y

Y

Y

Y

app_i2c_deinit

Y

Y

Y

Y

Y

app_i2c_receive_sync

Y

Y

Y

Y

Y

app_i2c_receive_async

Y

Y

Y

Y

Y

app_i2c_transmit_sync

Y

Y

Y

Y

Y

app_i2c_transmit_async

Y

Y

Y

Y

Y

app_i2c_mem_read_sync

Y

Y

Y

Y

Y

app_i2c_mem_read_async

Y

Y

Y

Y

Y

app_i2c_mem_write_sync

Y

Y

Y

Y

Y

app_i2c_mem_write_async

Y

Y

Y

Y

Y

app_i2c_get_handle

Y

Y

Y

Y

Y

app_i2c_master_abort_it

Y

Y

Y

Y

Y

app_i2c_timing_adjust Y Y

Y

Y

Y

app_i2c_timing_get Y Y

Y

Y

Y

app_i2c_transmit_receive_sync Y N N N N

app_i2c_init

表 155 app_i2c_init接口
函数原型

uint16_t app_i2c_init(app_i2c_params_t *p_params, app_i2c_evt_handler_t evt_handler)

功能说明

初始化I2C

输入参数
  • p_params:初始化参数的结构体指针
  • evt_handler:用户自己实现的中断回调函数
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

回调函数形式参照typedef void (*app_i2c_evt_handler_t)(app_i2c_evt_t *p_evt);

HAL层已经实现中断标志位的清理,用户不用关心中断标志的清理,回调函数根据返回事件类型进行相应的处理即可。

app_i2c_deinit

表 156 app_i2c_deinit接口
函数原型

uint16_t app_i2c_deinit(app_i2c_id_t id)

功能说明

反初始化I2C

输入参数

id:I2C模块ID

返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_receive_sync

表 157 app_i2c_receive_sync接口
函数原型

uint16_t app_i2c_receive_sync(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size, uint32_t timeout)

功能说明

I2C轮询方式(同步)接收数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
  • timeout:接收超时时间
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_receive_async

表 158 app_i2c_receive_async接口
函数原型

uint16_t app_i2c_receive_async(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)

功能说明

I2C中断方式(异步)接收数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_transmit_sync

表 159 app_i2c_transmit_sync接口
函数原型

uint16_t app_i2c_receive_sync(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size, uint32_t timeout)

功能说明

I2C轮询方式(同步)发送数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:需要发送的数据buffer指针
  • size:需要发送的数据长度,以Byte为单位
  • timeout:发送超时时间
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_transmit_async

表 160 app_i2c_transmit_async接口
函数原型

uint16_t app_i2c_transmit_async(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)

功能说明

I2C中断方式(异步)发送数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:接收数据的buffer
  • size:需要发送的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_mem_read_sync

表 161 app_i2c_mem_read_sync接口
函数原型

uint16_t app_i2c_mem_read_sync(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout)

功能说明

I2C轮询方式(同步)读取特定内存地址的数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要读取的内存地址
  • mem_addr_size:读取的内存地址长度
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
  • timeout:读取超时时间
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_mem_read_async

表 162 app_i2c_mem_read_async接口
函数原型

uint16_t app_i2c_mem_read_async(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

功能说明

I2C中断方式(异步)读取特定内存地址的数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要读取的内存地址
  • mem_addr_size:读取的内存地址长度
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_mem_write_sync

表 163 app_i2c_mem_write_sync接口
函数原型

uint16_t app_i2c_mem_write_sync(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout);

功能说明

I2C轮询方式(同步)向特定内存地址写入数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要写入的内存地址
  • mem_addr_size:写入的内存地址长度
  • p_data:需要发送的数据buffer指针
  • size:需要发送的数据长度,以Byte为单位
  • timeout:写入超时时间
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_mem_write_async

表 164 app_i2c_mem_write_async接口
函数原型

uint16_t app_i2c_mem_write_async(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size);

功能说明

I2C中断方式向(异步)特定内存地址写入数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要写入的内存地址
  • mem_addr_size:写入的内存地址长度
  • p_data:需要发送的数据buffer指针
  • size:需要发送的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_get_handle

表 165 app_i2c_get_handle接口
函数原型

i2c_handle_t *app_i2c_get_handle(app_i2c_id_t id)

功能说明

获取I2C句柄

输入参数

id:I2C模块ID

返回值

I2C句柄指针

备注

app_i2c_master_abort_it

表 166 app_i2c_master_abort_it接口
函数原型

uint16_t app_i2c_master_abort_it(app_i2c_id_t id)

功能说明

I2C中止Master当前的传输(非阻塞模式)

输入参数

id:I2C模块ID

返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_timing_adjust

表 167 app_i2c_timing_adjust接口
函数原型 uint16_t app_i2c_timing_adjust(app_i2c_id_t id, uint32_t timing_type, int32_t delta)
功能说明 对I2C时序进行微调,包括SCL高电平长度、低电平长度以及SDA保持时间
输入参数
  • id:I2C模块ID
  • timing_type:时序类型(I2C_TIMING_SS_SCL_LOW、I2C_TIMING_SS_SCL_HIGH、I2C_TIMING_FS_SCL_LOW、I2C_TIMING_FS_SCL_HIGH、I2C_TIMING_HS_SCL_LOW、I2C_TIMING_HS_SCL_HIGH、I2C_TIMING_FS_SPK、I2C_TIMING_HS_SPK、I2C_TIMING_SDA_TX_HOLD、I2C_TIMING_SDA_RX_HOLD)
  • delta:时序需要修改的值,单位为I2C的工作时钟(sclk)周期

返回值 APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

若SCL通信时钟周期长度等于4倍的I2C的工作时钟周期长度,当高电平的时序值等于1时,即1个工作时钟(sclk)周期,则高电平在时钟周期占比1/4;如不设置,则默认高低电平时间相同

由于上拉电阻以及电路走线差异,可能会导致I2C时序无法满足标准,导致通信出现异常,可通过此接口进行微调,入参delta为相对变化量,在初始化完成后调用此接口。I2C工作时钟频率在GR551x上等于系统时钟频率,在GR5xx其他系列芯片上等于串行时钟频率

app_i2c_timing_get

表 168 app_i2c_timing_get接口
函数原型 uint16_t app_i2c_timing_get(app_i2c_id_t id, uint32_t timing_type, uint32_t *p_timing_value)
功能说明 获取I2C时序,包括SCL高电平长度、低电平长度以及SDA保持时间
输入参数
  • id:I2C模块ID
  • timing_type:时序类型
  • p_timing_value:对应时序的绝对值,单位为I2C的工作时钟(sclk)周期
返回值 APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

app_i2c_transmit_receive_sync

表 169 app_i2c_transmit_receive_sync接口
函数原型

uint16_t app_i2c_transmit_receive_sync(app_i2c_id_t id, uint16_t dev_address, uint8_t *p_tdata, uint16_t tsize,

uint8_t *p_rdata, uint16_t rsize, uint32_t timeout)

功能说明

I2C Master轮询方式(同步)向特定内存地址写入数据后读取数据,中间没有检测停止位。

I2C Slave轮询方式(同步)接收数据后发送数据,中间没有停止位。

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:需要发送的数据buffer指针
  • tsize:需要发送的数据长度,以Byte为单位
  • p_rdata:需要接收的数据buffer指针
  • rsize:需要接收的数据长度,以Byte为单位
  • timeout:发送与接收的总超时时间
返回值 APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义
备注

DMA接口函数

表 170 DMA接口函数
API 芯片
GR551x GR5526 GR5x25 GR533x GR5405

app_i2c_dma_init

Y

Y

Y

Y

Y

app_i2c_dma_deinit

Y

Y

Y

Y

Y

app_i2c_dma_receive_async

Y

Y

Y

Y

Y

app_i2c_dma_transmit_async

Y

Y

Y

Y

Y

app_i2c_dma_mem_read_async

Y

Y

Y

Y

Y

app_i2c_dma_mem_write_async

Y

Y

Y

Y

Y

app_i2c_dma_init

表 171 app_i2c_dma_init接口
函数原型

uint16_t app_i2c_dma_init(app_i2c_params_t *p_params)

功能说明

初始化I2C的DMA方式传输

输入参数

p_params:初始化参数的结构体指针

返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_dma_deinit

表 172 app_i2c_dma_deinit接口
函数原型

uint16_t app_i2c_dma_deinit(app_i2c_id_t id)

功能说明

反初始化I2C的DMA方式传输

输入参数

id:I2C模块ID

返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_dma_receive_async

表 173 app_i2c_dma_receive_async接口
函数原型

uint16_t app_i2c_dma_receive_async(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)

功能说明

I2C以DMA方式(异步)接收数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_dma_transmit_async

表 174 app_i2c_dma_transmit_async接口
函数原型

uint16_t app_i2c_dma_transmit_async(app_i2c_id_t id, uint16_t target_address, uint8_t *p_data, uint16_t size)

功能说明

I2C以DMA方式(异步)发送数据

输入参数
  • id:I2C模块ID
  • target_address:I2C Slave地址(作为Slave时,该参数无效)
  • p_data:接收数据的buffer
  • size:需要发送的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_dma_mem_read_async

表 175 app_i2c_dma_mem_read_async接口
函数原型

uint16_t app_i2c_dma_mem_read_async(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

功能说明

I2C以DMA方式(异步)读取特定内存地址的数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要读取的内存地址
  • mem_addr_size:读取的内存地址长度
  • p_data:接收数据的buffer
  • size:需要接收的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

app_i2c_dma_mem_write_async

表 176 app_i2c_dma_mem_write_async接口
函数原型

uint16_t app_i2c_dma_mem_write_async(app_i2c_id_t id, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

功能说明

I2C以DMA方式(异步)向特定内存地址写入数据

输入参数
  • id:I2C模块ID
  • dev_address:I2C Slave地址(作为Slave时,该参数无效)
  • mem_address:需要写入的内存地址
  • mem_addr_size:写入的内存地址长度
  • p_data:需要发送的数据buffer指针
  • size:需要发送的数据长度,以Byte为单位
返回值

APP_DRV_xxx:详见SDK_Folder\drivers\inc\app_drv_error.h宏定义

备注

示例工程

I2C Master和Slave相互收发数据(中断方式)

I2C Master和Slave示例实现I2C之间的通信,其中一端为Master主设备,另一端为Slave从设备。Master端工程路径:SDK_Folder\projects\peripheral\i2c\app_i2c_master,Slave端工程路径:SDK_Folder\projects\peripheral\i2c\app_i2c_slave

流程图

图 15 I2C Master和Slave对测(中断方式)示例流程

初始化参数

  1. Master参数配置
    app_i2c_params_t master_params = {
        .id = MASTER_I2C_ID,
        .role = APP_I2C_ROLE_MASTER,
        .pin_cfg = {
            .scl = {
                .type = APP_I2C_MASTER_SCL_IO_TYPE,
                .mux  = APP_I2C_MASTER_SCL_PINMUX,
                .pin  = APP_I2C_MASTER_SCL_PIN,
                .pull = APP_IO_NOPULL,
            },
            .sda = {
                .type = APP_I2C_MASTER_SDA_IO_TYPE,
                .mux  = APP_I2C_MASTER_SDA_PINMUX,
                .pin  = APP_I2C_MASTER_SDA_PIN,
                .pull = APP_IO_NOPULL,
            },
        },
        .dma_cfg = {
            .tx_dma_instance = DMA0,
            .rx_dma_instance = DMA0,
            .tx_dma_channel  = DMA_Channel2,
            .rx_dma_channel  = DMA_Channel3,
        },
        .init = {
            .speed = I2C_SPEED_100K,
            .own_address = MASTER_DEV_ADDR,
            .addressing_mode = I2C_ADDRESSINGMODE_7BIT,
            .general_call_mode = I2C_GENERALCALL_DISABLE,
        },
    };
    
    • id:I2C Master的ID,具体配置值请参考board_SK.h
    • role:角色配置为APP_I2C_ROLE_MASTER。
    • pin_cfg:引脚配置。
      • pin_cfg.scl:时钟引脚配置,包括IO类型、复用MUX模式、引脚和上下拉模式。具体配置值,请参考board_SK.h
      • pin_cfg.sda:数据引脚配置,配置IO复用成IIC的复用模式,IO类型和引脚,上下拉模式,具体配置值,请参考board_SK.h

      以GR5526为例,下面是board_SK.h中相关定义:

      /*******I2C IO CONFIG***************************/
      #define APP_I2C_MASTER_SCL_PIN              APP_IO_PIN_6
      #define APP_I2C_MASTER_SDA_PIN              APP_IO_PIN_7
      #define APP_I2C_MASTER_SCL_IO_TYPE          APP_IO_TYPE_GPIOA
      #define APP_I2C_MASTER_SDA_IO_TYPE          APP_IO_TYPE_GPIOA
      #define APP_I2C_MASTER_SCL_PINMUX           APP_IO_MUX_0
      #define APP_I2C_MASTER_SDA_PINMUX           APP_IO_MUX_0
    • dma_cfg:DMA参数配置
      • dma_cfg.tx_dma_instance:发送使用的DMA实例
      • dma_cfg.rx_dma_instance:接收使用的DMA实例
      • dma_cfg.tx_dma_channel:发送使用的DMA实例通道,选择通道2
      • dma_cfg.rx_dma_channel:接收使用的DMA实例通道,选择通道3
    • init:串口传输参数配置
      • init.speed:传输速率,选择I2C_SPEED_100K,即为100 kHz
      • init.own_address:主设备地址,定义如下
        #define MASTER_DEV_ADDR         0x4D
      • init.addressing_mode:地址模式,7 bits地址
      • init.general_call_mode:使能/禁用通用广播模式,选择I2C_GENERALCALL_DISABLE,表示禁用广播模式。
  2. Slave参数配置
    app_i2c_params_t slave_params = {
        .id = SLAVE_I2C_ID,
        .role = APP_I2C_ROLE_SLAVE,
        .pin_cfg = {
            .scl = {
                .type = APP_I2C_SLAVE_SCL_IO_TYPE,
                .mux  = APP_I2C_SLAVE_SCL_PINMUX,
                .pin  = APP_I2C_SLAVE_SCL_PIN,
                .pull = APP_IO_NOPULL,
            },
            .sda = {
                .type = APP_I2C_SLAVE_SDA_IO_TYPE,
                .mux  = APP_I2C_SLAVE_SDA_PINMUX,
                .pin  = APP_I2C_SLAVE_SDA_PIN,
                .pull = APP_IO_NOPULL,
            },
        },
        .dma_cfg = {
            .tx_dma_instance = DMA0,
            .rx_dma_instance = DMA0,
            .tx_dma_channel  = DMA_Channel2,
            .rx_dma_channel  = DMA_Channel3,
        },
        .init = {
            .speed = I2C_SPEED_100K,
            .own_address = SLAVE_DEV_ADDR,
            .addressing_mode = I2C_ADDRESSINGMODE_7BIT,
            .general_call_mode = I2C_GENERALCALL_DISABLE,
        },
    };
    
    • id:定义Slave使用ID,具体配置值请参考board_SK.h
    • role:角色配置为APP_I2C_ROLE_SLAVE。
    • pin_cfg:引脚配置。
      • pin_cfg.scl:时钟引脚配置,配置IO复用成IIC的复用模式,IO类型和引脚,上下拉模式,具体配置值请参考board_SK.h
      • pin_cfg.scl sda:数据引脚配置,配置IO复用成IIC的复用模式,IO类型和引脚,上下拉模式,具体配置值请参考board_SK.h

      以GR5526为例,下面是board_SK.h中相关定义:

      #define APP_I2C_SLAVE_ID                    APP_I2C_ID_3
      #define APP_I2C_SLAVE_SCL_PIN               APP_IO_PIN_6
      #define APP_I2C_SLAVE_SDA_PIN               APP_IO_PIN_7
      #define APP_I2C_SLAVE_SCL_IO_TYPE           APP_IO_TYPE_GPIOA
      #define APP_I2C_SLAVE_SDA_IO_TYPE           APP_IO_TYPE_GPIOA
      #define APP_I2C_SLAVE_SCL_PINMUX            APP_IO_MUX_0
      #define APP_I2C_SLAVE_SDA_PINMUX            APP_IO_MUX_0
    • dma_cfg:DMA参数配置
      • dma_cfg .tx_dma_instance:发送使用的DMA实例
      • dma_cfg .rx_dma_instance:接收使用的DMA实例
      • dma_cfg .tx_dma_channel:发送使用的DMA实例通道,选择通道2
      • dma_cfg .rx_dma_channel:接收使用的DMA实例通道,选择通道3
    • init:串口传输参数配置
      • init.speed:传输速率,选择I2C_SPEED_100K,100 kHz
      • init. own_address:本设备地址,作为slave时有效,定义如下
        #define SLAVE_DEV_ADDR                 0x55
      • init. addressing_mode:地址模式,7 bits地址
      • init. general_call_mode:配置使能/不使能通用广播模式,此处选择I2C_GENERALCALL_DISABLE表示不使能。
    说明:

    SCL和SDA都需要外部接上拉电阻。

重要函数

  • 模块初始化
    ret = app_i2c_init(&master_params, app_i2c_master_evt_handler)
  • Slave接收数据,第二位I2C Slave地址无效,此处配置为0;rdata为接收数据存放的数组,接收数据长度256字节。
    app_i2c_receive_async(SLAVE_I2C_ID, 0, rdata, 256)
  • Master发送数据,其中从设备地址为SLAVE_DEV_ADDR,待发送数据为wdata,发送数据长度256字节。
    ret = app_i2c_transmit_async(MASTER_I2C_ID, SLAVE_DEV_ADDR, wdata, 256)
  • Slave发送数据,第二位I2C Slave地址无效,此处配置为0;wdata为发送数据存放的数组,发送数据长度256字节。
    app_i2c_transmit_async(SLAVE_I2C_ID, 0, wdata, 256)
  • Master接收数据,其中从设备地址为SLAVE_DEV_ADDR,待接收数据为rdata,接收数据长度256字节。
    ret = app_i2c_receive_async(MASTER_I2C_ID, SLAVE_DEV_ADDR, rdata, 256)

测试验证

  1. 硬件准备:2块开发板(A板和B板)
  2. 引脚连接:参考示例工程代码使用IO进行连接

测试步骤:本示例采用Master和Slave对测方式。Master端代码路径:projects\peripheral\i2c\app_i2c_maste,Slave端代码路径:projects\peripheral\i2c\app_i2c_slave。连接引脚后,B板下载Slave程序,A板下载Master程序,需保证Slave先于Master准备就绪。

Master端打印日志如下:

app i2c interrrupt test.
I2C master send start.

[18:45:56.937] I2C master read start.
I2C master received:
0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 
0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F 
0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 
0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F 
0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 
0x28 0x29 0x2A 0x2B 0x2C 0x2D 0x2E 0x2F 
0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 
0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F 
0x40 0x41 0x42 0x43 0x44 0x45 0x46 0x47 
0x48 0x49 0x4A 0x4B 0x4C 0x4D 0x4E 0x4F 
0x50 0x51 0x52 0x53 0x54 0x55 0x56 0x57 
0x58 0x59 0x5A 0x5B 0x5C 0x5D 0x5E 0x5F 
0x60 0x61 0x62 0x63 0x64 0x65 0x66 0x67 
0x68 0x69 0x6A 0x6B 0x6C 0x6D 0x6E 0x6F 
0x70 0x71 0x72 0x73 0x74 0x75 0x76 0x77 
0x78 0x79 0x7A 0x7B 0x7C 0x7D 0x7E 0x7F 
0x80 0x81 0x82 0x83 0x84 0x85 0x86 0x87 
0x88 0x89 0x8A 0x8B 0x8C 0x8D 0x8E 0x8F 
0x90 0x91 0x92 0x93 0x94 0x95 0x96 0x97 
0x98 0x99 0x9A 0x9B 0x9C 0x9D 0x9E 0x9F 
0xA0 0xA1 0xA2 0xA3 0xA4 0xA5 0xA6 0xA7 
0xA8 0xA9 0xAA 0xAB 0xAC 0xAD 0xAE 0xAF 
0xB0 0xB1 0xB2 0xB3 0xB4 0xB5 0xB6 0xB7 
0xB8 0xB9 0xBA 0xBB 0xBC 0xBD 0xBE 0xBF 
0xC0 0xC1 0xC2 0xC3 0xC4 0xC5 0xC6 0xC7 
0xC8 0xC9 0xCA 0xCB 0xCC 0xCD 0xCE 0xCF 
0xD0 0xD1 0xD2 0xD3 0xD4 0xD5 0xD6 0xD7 
0xD8 0xD9 0xDA 0xDB 0xDC 0xDD 0xDE 0xDF 
0xE0 0xE1 0xE2 0xE3 0xE4 0xE5 0xE6 0xE7 
0xE8 0xE9 0xEA 0xEB 0xEC 0xED 0xEE 0xEF 
0xF0 0xF1 0xF2 0xF3 0xF4 0xF5 0xF6 0xF7 
0xF8 0xF9 0xFA 0xFB 0xFC 0xFD 0xFE 0xFF

Slave端打印日志如下:

app i2c slave interrrupt test.
I2C slave receive start.

[18:55:31.681] I2C slave received:
0x00 0x01 0x02 0x03 0x04 0x05 0x06 0x07 
0x08 0x09 0x0A 0x0B 0x0C 0x0D 0x0E 0x0F 
0x10 0x11 0x12 0x13 0x14 0x15 0x16 0x17 
0x18 0x19 0x1A 0x1B 0x1C 0x1D 0x1E 0x1F 
0x20 0x21 0x22 0x23 0x24 0x25 0x26 0x27 
0x28 0x29 0x2A 0x2B 0x2C 0x2D 0x2E 0x2F 
0x30 0x31 0x32 0x33 0x34 0x35 0x36 0x37 
0x38 0x39 0x3A 0x3B 0x3C 0x3D 0x3E 0x3F 
0x40 0x41 0x42 0x43 0x44 0x45 0x46 0x47 
0x48 0x49 0x4A 0x4B 0x4C 0x4D 0x4E 0x4F 
0x50 0x51 0x52 0x53 0x54 0x55 0x56 0x57 
0x58 0x59 0x5A 0x5B 0x5C 0x5D 0x5E 0x5F 
0x60 0x61 0x62 0x63 0x64 0x65 0x66 0x67 
0x68 0x69 0x6A 0x6B 0x6C 0x6D 0x6E 0x6F 
0x70 0x71 0x72 0x73 0x74 0x75 0x76 0x77 
0x78 0x79 0x7A 0x7B 0x7C 0x7D 0x7E 0x7F 
0x80 0x81 0x82 0x83 0x84 0x85 0x86 0x87 
0x88 0x89 0x8A 0x8B 0x8C 0x8D 0x8E 0x8F 
0x90 0x91 0x92 0x93 0x94 0x95 0x96 0x97 
0x98 0x99 0x9A 0x9B 0x9C 0x9D 0x9E 0x9F 
0xA0 0xA1 0xA2 0xA3 0xA4 0xA5 0xA6 0xA7 
0xA8 0xA9 0xAA 0xAB 0xAC 0xAD 0xAE 0xAF 
0xB0 0xB1 0xB2 0xB3 0xB4 0xB5 0xB6 0xB7 
0xB8 0xB9 0xBA 0xBB 0xBC 0xBD 0xBE 0xBF 
0xC0 0xC1 0xC2 0xC3 0xC4 0xC5 0xC6 0xC7 
0xC8 0xC9 0xCA 0xCB 0xCC 0xCD 0xCE 0xCF 
0xD0 0xD1 0xD2 0xD3 0xD4 0xD5 0xD6 0xD7 
0xD8 0xD9 0xDA 0xDB 0xDC 0xDD 0xDE 0xDF 
0xE0 0xE1 0xE2 0xE3 0xE4 0xE5 0xE6 0xE7 
0xE8 0xE9 0xEA 0xEB 0xEC 0xED 0xEE 0xEF 
0xF0 0xF1 0xF2 0xF3 0xF4 0xF5 0xF6 0xF7 
0xF8 0xF9 0xFA 0xFB 0xFC 0xFD 0xFE 0xFF 
I2C slave send start.

TP报点

GR5526屏幕TP模块如下图所示,包含引脚有RESET、SCL、SDL和INT(中断)。RESET引脚主要通过复位信号复位TP模块,INT引脚在触摸屏幕时产生中断信号,触发报点中断。I2C的SCL和SDL读取触摸点的位置信息。工程路径:SDK_Folder\projects\peripheral\i2c\app_i2c_tp。该示例仅适用于GR5526。

图 16 GR5526屏幕TP模块示意图

初始化参数

  1. I2C配置
    static app_i2c_params_t tp_params = {
        .id = TP_I2C_ID,
        .role = APP_I2C_ROLE_MASTER,
        .pin_cfg = {
            .scl = {
                .type = TP_SCL_IO_TYPE,
                .mux  = TP_SCL_IO_MUX,
                .pin  = TP_SCL_IO_PIN,
                .pull = APP_IO_PULLUP,
            },
            .sda = {
                .type = TP_SDA_IO_TYPE,
                .mux  = TP_SDA_IO_MUX,
                .pin  = TP_SDA_IO_PIN,
                .pull = APP_IO_PULLUP,
            },
        },
        .dma_cfg = {
        #if (APP_DRIVER_CHIP_TYPE == APP_DRIVER_GR5332X)
            .tx_dma_instance = DMA0,
            .rx_dma_instance = DMA0,
        #else
            .tx_dma_instance = DMA1,
            .rx_dma_instance = DMA1,
        #endif
            .tx_dma_channel  = DMA_Channel0,
            .rx_dma_channel  = DMA_Channel1,
        },
        .init = {
            .speed = I2C_SPEED_400K,
            .own_address = 0x00,
            .addressing_mode = I2C_ADDRESSINGMODE_7BIT,
            .general_call_mode = I2C_GENERALCALL_DISABLE,
        },
    };
    
    • id:定义Slave使用ID,具体配置值请参考board_SK.h
    • role:角色配置为APP_I2C_ROLE_SLAVE。
    • pin_cfg:引脚配置
      • pin_cfg.scl:时钟引脚配置,配置IO复用成IIC的复用模式,IO类型和引脚、上下拉模式,具体配置值请参考board_SK.h
      • pin_cfg.scl sda:数据引脚配置,配置IO复用成IIC的复用模式,IO类型和引脚、上下拉模式,具体配置值请参考board_SK.h

      以GR5526为例,下面是board_SK.h中相关定义:

           #define TP_RST_IO_TYPE     APP_IO_TYPE_GPIOB
           #define TP_RST_IO_MUX      APP_IO_MUX_7
           #define TP_RST_IO_PIN      APP_IO_PIN_13
      
           #define TP_INT_IO_TYPE     APP_IO_TYPE_GPIOC
           #define TP_INT_IO_MUX      APP_IO_MUX_7
           #define TP_INT_IO_PIN      APP_IO_PIN_0
      
           #define TP_SCL_IO_TYPE     APP_IO_TYPE_GPIOB
           #define TP_SCL_IO_MUX      APP_IO_MUX_3
           #define TP_SCL_IO_PIN      APP_IO_PIN_14
      
           #define TP_SDA_IO_TYPE     APP_IO_TYPE_GPIOB
           #define TP_SDA_IO_MUX      APP_IO_MUX_3
           #define TP_SDA_IO_PIN      APP_IO_PIN_15
      
    • dma_cfg:DMA参数配置
      • dma_cfg .tx_dma_instance:发送使用的DMA实例
      • dma_cfg .rx_dma_instance:接收使用的DMA实例
      • dma_cfg .tx_dma_channel:发送使用的DMA实例通道,选择通道2
      • dma_cfg .rx_dma_channel:接收使用的DMA实例通道,选择通道3
    • init:串口传输参数配置
      • init.speed:传输速率,选择I2C_SPEED_400K,400 kHz
      • init. own_address:主设备地址,0x00
      • init. addressing_mode:地址模式,7 bits地址
      • init. general_call_mode:配置使能/禁用通用广播模式,此处选择I2C_GENERALCALL_DISABLE表示不使能。
  2. RESET引脚配置

    配置GPIO29为RESET引脚,GPIO29为上拉输出模式。

        app_io_init_t io_init = APP_IO_DEFAULT_CONFIG;
        io_init.pull = APP_IO_PULLUP;
        io_init.mode = APP_IO_MODE_OUTPUT;
        io_init.pin  = TP_RST_IO_PIN;
        io_init.mux  = TP_RST_IO_MUX;
        app_io_init(TP_RST_IO_TYPE, &io_init);
  3. INT引脚配置

    配置GPIO32为中断输入引脚,GPIO32下降沿触发,上拉输入模式。

        app_gpiote_param_t param[1] =
        {
             TP_INT_IO_TYPE,
             TP_INT_IO_PIN,
             APP_IO_MODE_IT_FALLING,
             APP_IO_PULLUP,
             tp_interrupt_callback,
         };
        app_gpiote_init(param, 1);

重要函数

  • 初始化I2C
    app_i2c_init(&tp_params, NULL)
  • 初始化RESET和INT引脚,并注册中断函数
    tp_pin_init()
  • 使能TP模块
    tp_rst()

测试验证

连接带屏幕的开发板到PC端,打开串口调试助手,连接串口,用手触摸屏幕,查看报点信息,如下显示触摸点的屏幕位置。

TP coordinates:x: 0x d4, y: 0x cd
TP coordinates:x: 0x d4, y: 0x cc
TP coordinates:x: 0x d3, y: 0x cb
TP coordinates:x: 0x d3, y: 0x cb
TP coordinates:x: 0x d2, y: 0x cb
TP coordinates:x: 0x d2, y: 0x cb
TP coordinates:x: 0x d2, y: 0x cb

扫描关注

打开微信,使用“扫一扫”即可关注。