hal_i2c.h

浏览该文件的文档.

 
#ifndef HAL_I2C_H
#define HAL_I2C_H
 
#include <stdint.h>
#include "errcode.h"
#include "i2c_porting.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#define I2C_SS_MODE_BAUDRATE_HIGH_LIMIT  (100 * 1000)    
#define I2C_FS_MODE_BAUDRATE_HIGH_LIMIT  (400 * 1000)    
#define I2C_HS_MODE_BAUDRATE_HIGH_LIMIT  (3400 * 1000)   
#define I2C_HS_MODE_MASTER_CODE_MAX  7   
typedef enum hal_i2c_speed_mode {
    I2C_SPEED_MODE_HARDCODE = 0,
    I2C_SPEED_MODE_SS = 0,              
    I2C_SPEED_MODE_FS,                  
    I2C_SPEED_MODE_HS,                  
    I2C_SPEED_MODE_MAX_NUM
} hal_i2c_speed_mode_t;
 
typedef enum hal_i2c_data_operation_type {
    I2C_DATA_OPERATION_TYPE_POLL,    
    I2C_DATA_OPERATION_TYPE_INT,     
    I2C_DATA_OPERATION_TYPE_DMA,     
    I2C_DATA_OPERATION_TYPE_INVLAID
} hal_i2c_data_operation_type_t;
 
typedef enum hal_i2c_evt_id {
    I2C_EVT_TX_READY = 0,           
    I2C_EVT_RX_READY,               
    I2C_EVT_TX_AVAILABLE,           
    I2C_EVT_TRANSMITION_START,      
    I2C_EVT_TRANSMITION_DONE,       
    I2C_EVT_TRANSMITION_ABRT,       
    I2C_EVT_TRANSMITION_BUSY,       
    I2C_EVT_INVALID = 0xF
} hal_i2c_evt_id_t;
 
typedef enum hal_i2c_ctrl_id {
    I2C_CTRL_WRITE_PREPARE = 0,     
    I2C_CTRL_WRITE_RESTORE,         
    I2C_CTRL_READ_PREPARE,          
    I2C_CTRL_READ_RESTORE,          
    I2C_CTRL_GET_WRITE_NUM,         
    I2C_CTRL_GET_READ_NUM,          
    I2C_CTRL_CHECK_TX_AVAILABLE,    
    I2C_CTRL_CHECK_RX_AVAILABLE,    
    I2C_CTRL_FLUSH_RX_FIFO,         
    I2C_CTRL_CHECK_TX_PROCESS_DONE, 
    I2C_CTRL_CHECK_RX_PROCESS_DONE, 
    I2C_CTRL_CHECK_RESTART_READY,   
    I2C_CTRL_NORMAL_MAX = I2C_CTRL_CHECK_RESTART_READY,
    I2C_CTRL_CHECK_TRANSMIT_ABRT,   
    I2C_CTRL_GET_DMA_DATA_ADDR,     
    I2C_CTRL_CHECK_TX_FIFO_EMPTY,   
    I2C_CTRL_MAX,
    I2C_CTRL_ID_INVALID = 0x1F
} hal_i2c_ctrl_id_t;
 
typedef struct hal_i2c_prepare_config {
    uint8_t operation_type;         
    uint8_t reserved;
    uint16_t addr;                  
    uint32_t total_len;             
} hal_i2c_prepare_config_t;
 
typedef struct hal_i2c_buffer_wrap {
    uint8_t *buffer;                
    uint32_t len;                   
    uint8_t stop_flag;              
    uint8_t restart_flag;           
    uint8_t reserved[2];
} hal_i2c_buffer_wrap_t;
 
typedef errcode_t (*hal_i2c_callback_t)(i2c_bus_t bus, hal_i2c_evt_id_t evt, uintptr_t param);
 
errcode_t hal_i2c_master_init(i2c_bus_t bus, uint32_t baudrate,
                              uint8_t hscode, hal_i2c_callback_t callback);
 
errcode_t hal_i2c_slave_init(i2c_bus_t bus, uint32_t baudrate,
                             uint16_t addr, hal_i2c_callback_t callback);
 
errcode_t hal_i2c_deinit(i2c_bus_t bus);
 
errcode_t hal_i2c_ctrl(i2c_bus_t bus, hal_i2c_ctrl_id_t id, uintptr_t param);
 
errcode_t hal_i2c_write(i2c_bus_t bus, hal_i2c_buffer_wrap_t *data);
 
errcode_t hal_i2c_read(i2c_bus_t bus, hal_i2c_buffer_wrap_t *data);
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif