I2C驱动API描述

hal_status_t hal_i2c_init(i2c_handle_t *p_i2c)

根据i2c_init_t中的指定参数初始化I2C外设和初始化关联句柄。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

HAL状态。

hal_status_t hal_i2c_deinit(i2c_handle_t *p_i2c)

反初始化I2C外设。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

HAL状态。

void hal_i2c_msp_init(i2c_handle_t *p_i2c)

初始化I2C所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，开发者需重写该API完成GPIO引脚复用、NVIC中断、DMA通道的初始化。

void hal_i2c_msp_deinit(i2c_handle_t *p_i2c)

反初始化I2C所使用的GPIO引脚复用、NVIC中断、DMA通道等配置。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，开发者需重写该API完成GPIO引脚复用、NVIC中断、DMA通道的反初始化。

hal_status_t hal_i2c_master_transmit(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size, uint32_t timeout)

作为I2C主设备，发送大量数据，轮询方式。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

timeout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_master_receive(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size, uint32_t timeout)

作为I2C主设备，接收大量数据，轮询方式。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

timeout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_slave_transmit(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size, uint32_t timeout)

作为I2C从设备，发送大量数据，轮询方式。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

timeout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_slave_receive(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size, uint32_t timeout)

作为I2C从设备，接收大量数据，轮询方式。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

timeout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_mem_write(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout)

以轮询模式向从设备的指定地址写入大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待写入数据的长度。

timeout：超时时间

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_mem_read(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size, uint32_t timeout)

以轮询模式从从设备的指定地址读取大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待读取数据的长度。

timeout：超时时间。

HAL状态。

返回HAL_ERROR时可调用hal_i2c_get_error()获取具体的错误码。

hal_status_t hal_i2c_master_transmit_it(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size)

作为I2C主设备，以中断非轮询模式发送大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态。

hal_status_t hal_i2c_master_receive_it(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size)

作为I2C主设备，以中断非轮询模式接收大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_i2c_slave_transmit_it(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size)

作为I2C从设备，以中断非轮询模式发送大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态

hal_status_t hal_i2c_slave_receive_it(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size)

作为I2C从设备，以中断非轮询模式接收大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_i2c_mem_write_it(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

以中断非轮询模式向从设备的指定地址写入大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待写入数据的长度。

HAL状态。

hal_status_t hal_i2c_mem_read_it(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

以中断非轮询模式从从设备的指定地址读取大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待读取数据的长度。

HAL状态。

hal_status_t hal_i2c_master_abort_it(i2c_handle_t *p_i2c)

通过中断方式中止I2C主设备中断或DMA方式的数据传输。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

HAL状态。

该函数为非轮询式函数，使能TX_ABRT中断后，该函数立即返回，TX_ABRT中断触发后中止完成，此时hal_i2c_abort_cplt_callback()将会被调用。

hal_status_t hal_i2c_master_transmit_dma(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size)

作为I2C主设备，发送大量数据，DMA方式。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态。

hal_status_t hal_i2c_master_receive_dma(i2c_handle_t *p_i2c, uint16_t dev_address, uint8_t *p_data, uint16_t size)

作为I2C主设备，以DMA非轮询模式接收大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_i2c_slave_transmit_dma(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size)

作为I2C从设备，以DMA非轮询模式发送大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待发送数据的长度。

HAL状态。

hal_status_t hal_i2c_slave_receive_dma(i2c_handle_t *p_i2c, uint8_t *p_data, uint16_t size)

作为I2C从设备，以DMA非轮询模式接收大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

p_data：指向数据缓冲区的指针。

size：待接收数据的长度。

HAL状态。

hal_status_t hal_i2c_mem_write_dma(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

以DMA非轮询模式向指定从设备的指定地址写入大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待写入数据的长度。

HAL状态。

hal_status_t hal_i2c_mem_read_dma(i2c_handle_t *p_i2c, uint16_t dev_address, uint16_t mem_address, uint16_t mem_addr_size, uint8_t *p_data, uint16_t size)

以DMA非轮询模式从指定从设备的指定地址读取大量数据。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

dev_address：从设备地址。

mem_address：从设备的内部指定地址。

mem_addr_size：从设备的内部指定地址的位宽，该参数的取值可以是下列值中的任意一个：

• I2C_MEMADD_SIZE_8BIT（8位）
• I2C_MEMADD_SIZE_16BIT（16位）

p_data：指向数据缓冲区的指针。

size：待读取数据的长度。

HAL状态

void hal_i2c_irq_handler(i2c_handle_t *p_i2c)

处理I2C中断请求。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

void hal_i2c_master_tx_cplt_callback(i2c_handle_t *p_i2c)

主设备发送完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_master_rx_cplt_callback(i2c_handle_t *p_i2c)

主设备接收完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_slave_tx_cplt_callback(i2c_handle_t *p_i2c)

从设备发送完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_slave_rx_cplt_callback(i2c_handle_t *p_i2c)

从设备接收完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_mem_tx_cplt_callback(i2c_handle_t *p_i2c)

从设备写入完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_mem_rx_cplt_callback(i2c_handle_t *p_i2c)

从设备读取完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_error_callback(i2c_handle_t *p_i2c)

I2C错误回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

void hal_i2c_abort_cplt_callback(i2c_handle_t *p_i2c)

I2C中止完成回调函数。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

无

该函数为weak类型的空函数，当开发者需要使用该回调函数时，可重写该API。

hal_i2c_state_t hal_i2c_get_state(i2c_handle_t *p_i2c)

获取I2C运行状态。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

hal_i2c_mode_t hal_i2c_get_mode(i2c_handle_t *p_i2c)

返回I2C模式：主设备、从设备、Memory或者无

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

I2C模式，该参数的取值可以是下列值中的任意一个：

• HAL_I2C_MODE_NONE（无）
• HAL_I2C_MODE_MASTER（作为主设备）
• HAL_I2C_MODE_SLAVE（作为从设备）
• HAL_I2C_MODE_MEM（读写存储设备）

uint32_t hal_i2c_get_error(i2c_handle_t *p_i2c)

返回I2C句柄错误码。

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

I2C错误码，该参数的取值可以是下列值中的任意一个：

• HAL_I2C_ERROR_NONE（无错误）
• HAL_I2C_ERROR_ARB_LOST（仲裁丢失）
• HAL_I2C_ERROR_NOACK（无ACK）
• HAL_I2C_ERROR_OVER（接收溢出）
• HAL_I2C_ERROR_DMA（DMA传输错误）
• HAL_I2C_ERROR_TIMEOUT（超时）

hal_status_t hal_i2c_suspend_reg(i2c_handle_t *p_i2c)

睡眠时挂起I2C配置相关的寄存器

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。

hal_status_t hal_i2c_resume_reg(i2c_handle_t *p_i2c)

唤醒时恢复I2C配置相关的寄存器

p_i2c：指向i2c_handle_t结构体变量的指针，该结构体变量包含指定的I2C的配置信息。