xf_hal_i2c.h

浏览该文件的文档.

 
#ifndef __XF_HAL_I2C_H__
#define __XF_HAL_I2C_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_hal_device_config.h"
 
#if XF_HAL_I2C_IS_ENABLE
 
#include "xf_hal_gpio.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
typedef uint32_t xf_i2c_num_t;
 
typedef enum _xf_hal_i2c_address_width_t {
    _XF_HAL_I2C_ADDRESS_WIDTH_BASE = 0,
 
    XF_HAL_I2C_ADDRESS_WIDTH_7BIT = _XF_HAL_I2C_ADDRESS_WIDTH_BASE, 
    XF_HAL_I2C_ADDRESS_WIDTH_10BIT, 
    _XF_HAL_I2C_ADDRESS_WIDTH_MAX
} xf_hal_i2c_address_width_t;
 
typedef enum _xf_hal_i2c_hosts_t {
    _XF_HAL_I2C_HOSTS_BASE = 0,
 
    XF_HAL_I2C_HOSTS_MASTER = _XF_HAL_I2C_HOSTS_BASE, 
    XF_HAL_I2C_HOSTS_SLAVE, 
    _XF_HAL_I2C_HOSTS_MAX
} xf_hal_i2c_hosts_t;
 
typedef enum _xf_hal_i2c_mem_addr_en_t {
    _XF_HAL_I2C_MEM_ADDR_BASE = 0,
 
    XF_HAL_I2C_MEM_ADDR_DISABLE = _XF_HAL_I2C_MEM_ADDR_BASE, 
    XF_HAL_I2C_MEM_ADDR_ENABLE, 
    _XF_HAL_I2C_MEM_ADDR_MAX
} xf_hal_i2c_mem_addr_en_t;
 
typedef enum _xf_hal_i2c_mem_addr_width_t {
    _XF_HAL_I2C_MEM_ADDR_WIDTH_BASE = 0,
 
    XF_HAL_I2C_MEM_ADDR_WIDTH_8BIT = _XF_HAL_I2C_MEM_ADDR_WIDTH_BASE, 
    XF_HAL_I2C_MEM_ADDR_WIDTH_16BIT,    
    XF_HAL_I2C_MEM_ADDR_WIDTH_24BIT,    
    XF_HAL_I2C_MEM_ADDR_WIDTH_32BIT,    
    _XF_HAL_I2C_MEM_ADDR_WIDTH_MAX
} xf_hal_i2c_mem_addr_width_t;
 
typedef enum _xf_hal_i2c_cmd_t {
    XF_HAL_I2C_CMD_DEFAULT          = 0x0,          
    XF_HAL_I2C_CMD_HOSTS            = 0x1 << 0,     
    XF_HAL_I2C_CMD_ENABLE           = 0x1 << 1,     
    XF_HAL_I2C_CMD_ADDRESS_WIDTH    = 0x1 << 2,     
    XF_HAL_I2C_CMD_ADDRESS          = 0x1 << 3,     
    XF_HAL_I2C_CMD_MEM_ADDR_EN      = 0x1 << 4,     
    XF_HAL_I2C_CMD_MEM_ADDR_WIDTH   = 0x1 << 5,     
    XF_HAL_I2C_CMD_MEM_ADDR         = 0x1 << 6,     
    XF_HAL_I2C_CMD_SPEED            = 0x1 << 7,     
    XF_HAL_I2C_CMD_TIMEOUT          = 0x1 << 8,     
    XF_HAL_I2C_CMD_SCL_NUM          = 0x1 << 9,     
    XF_HAL_I2C_CMD_SDA_NUM          = 0x1 << 10,    
    XF_HAL_I2C_CMD_ALL              = 0x7FFFFFFF,  
} xf_hal_i2c_cmd_t;
 
typedef struct _xf_hal_i2c_config_t {
    uint32_t hosts          : 1;    
    uint32_t enable         : 1;    
    uint32_t address_width  : 1;    
    uint32_t address        : 16;   
    uint32_t mem_addr_en    : 1;    
    uint32_t mem_addr_width : 2;    
    uint32_t reserve        : 10;
    uint32_t mem_addr;              
    uint32_t speed;                 
    uint32_t timeout_ms;            
    xf_gpio_num_t scl_num;          
    xf_gpio_num_t sda_num;          
} xf_hal_i2c_config_t;
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_hal_i2c_init(xf_i2c_num_t i2c_num, xf_hal_i2c_hosts_t hosts, uint32_t speed);
 
xf_err_t xf_hal_i2c_deinit(xf_i2c_num_t i2c_num);
 
xf_err_t xf_hal_i2c_enable(xf_i2c_num_t i2c_num);
 
xf_err_t xf_hal_i2c_disable(xf_i2c_num_t i2c_num);
 
xf_err_t xf_hal_i2c_set_gpio(xf_i2c_num_t i2c_num, xf_gpio_num_t scl_num, xf_gpio_num_t sda_num);
 
xf_err_t xf_hal_i2c_set_address_width(xf_i2c_num_t i2c_num, xf_hal_i2c_address_width_t address_width);
 
xf_err_t xf_hal_i2c_set_address(xf_i2c_num_t i2c_num, uint16_t address);
 
xf_err_t xf_hal_i2c_set_mem_addr_width(xf_i2c_num_t i2c_num, xf_hal_i2c_mem_addr_width_t mem_addr_widths);
 
int xf_hal_i2c_write_mem(xf_i2c_num_t i2c_num, uint32_t mem_addr, const uint8_t *buffer, uint32_t size,
                         uint32_t timeout_ms);
 
int xf_hal_i2c_read_mem(xf_i2c_num_t i2c_num, uint32_t mem_addr, uint8_t *buffer, uint32_t size, uint32_t timeout_ms);
 
int xf_hal_i2c_write(xf_i2c_num_t i2c_num, const uint8_t *buffer, uint32_t size, uint32_t timeout_ms);
 
int xf_hal_i2c_read(xf_i2c_num_t i2c_num, uint8_t *buffer, uint32_t size, uint32_t timeout_ms);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // XF_HAL_I2C_IS_ENABLE
 
#endif // __XF_HAL_I2C_H__