i2c.h

/***************************************************************************/
 
#ifndef I2C_DRIVER_H
#define I2C_DRIVER_H
 
#include <stdint.h>
#include <stdbool.h>
#include "clk.h"
#include "i2c_registers.h"    /* Hardware register definitions for I²C */
#include "syna_device.h"
 
/***************************************************************************/
 
/*******************************************************************************
 *                              Enumerations
 *******************************************************************************/

typedef enum {
    I2C_SPEED_STANDARD = 1,  
    I2C_SPEED_FAST,          
    I2C_SPEED_FAST_PLUS      
} i2c_speed_en;

typedef enum
{
    I2C_TRANSFER_WRITE  = 0,    
    I2C_TRANSFER_READ   = 1,    
} i2c_transfer_dir_en;

typedef enum
{
    /* I2C Driver */
    I2C_OK                     = 0,  
    I2C_ERROR                  = 1,  
    I2C_ERROR_BUSY             = 2,  
    I2C_ERROR_TIMEOUT          = 3,  
    I2C_ERROR_UNSUPPORTED      = 4,  
    I2C_ERROR_PARAMETER        = 5,  
    I2C_ERROR_SPECIFIC         = 6,  
    I2C_ERROR_NACK             = 7,  
    I2C_ERROR_SDA_STUCK        = 8,  
    I2C_ERROR_ARBITRATION_LOST = 9,  
    I2C_ERROR_TX_FLUSHED       = 10  
} i2c_status_en;

typedef enum {
    I2C_MODE_CONTROLLER = 0,  
    I2C_MODE_TARGET           
} i2c_mode_en;

typedef enum {
    I2C_EVENT_WRITE_COMPLETE,           
    I2C_EVENT_READ_COMPLETE,            
    I2C_EVENT_BUS_ERROR,                
    I2C_EVENT_ABORT,                    
    I2C_EVENT_STOP_DET,                 
    I2C_EVENT_WRITE_IN_TX_FIFO,         
    I2C_EVENT_TX_OVERFLOW,              
    I2C_EVENT_RX_OVERFLOW,              
    I2C_EVENT_RX_UNDERFLOW,             
    I2C_EVENT_ERROR                     
} i2c_event_en;

typedef enum {
    I2C_TRANSFER_STATUS_IDLE = 0,      
    I2C_TRANSFER_STATUS_IN_PROGRESS,   
    I2C_TRANSFER_STATUS_COMPLETE,      
    I2C_TRANSFER_STATUS_ABORTED,       
    I2C_TRANSFER_STATUS_ERROR,         
    I2C_TRANSFER_INVALID_ID            
} i2c_transfer_status_en;

 
/*******************************************************************************
 *                                  Type Definitions
 *******************************************************************************/

typedef void (*i2c_event_cb_t)(i2c_instance_en id, i2c_event_en event, void *user_data);

typedef struct {
    bool          ten_bit_addr;            
    i2c_speed_en  speed;                   
    bool          enable_bus_clear;        
    bool          clear_stuck_sda;         
    uint32_t      scl_stuck_timeout_ms;    
    uint32_t      sda_stuck_timeout_ms;    
} i2c_controller_config_t;

 typedef struct {
    bool          ten_bit_addr;           
    i2c_speed_en  speed;                  
    uint32_t      target_address;         
    bool          general_call_response;  
    uint32_t      scl_stuck_timeout_ms;   
    uint32_t      sda_stuck_timeout_ms;   
} i2c_target_config_t;

typedef struct {
    uint8_t        *buf;       
    uint32_t       size;       
    uint32_t       timeout;    
    bool           send_stop;  
} i2c_blocking_config_t;

typedef struct {
    uint8_t        *buf;        
    uint32_t       size;        
    bool           send_stop;   
} i2c_nonblocking_config_t;

 
/*******************************************************************************
 *                             Function Prototypes
 *******************************************************************************/

 
/*******************************************************************************
*                           Function Name: i2c_init
****************************************************************************/
INIT_CODE i2c_status_en i2c_init(i2c_instance_en id);
 
/*******************************************************************************
*                          Function Name: i2c_deinit
****************************************************************************/
INIT_CODE i2c_status_en i2c_deinit(i2c_instance_en id);
 
/*******************************************************************************
*                 Function Name: i2c_controller_set_config
****************************************************************************/
i2c_status_en i2c_controller_set_config(i2c_instance_en id, i2c_controller_config_t *cfg);
 
/*******************************************************************************
*                     Function Name: i2c_controller_get_config
****************************************************************************/
i2c_status_en i2c_controller_get_config(i2c_instance_en id, i2c_controller_config_t *cfg);
 
/*******************************************************************************
*              Function Name: i2c_controller_set_target_address
****************************************************************************/
i2c_status_en i2c_controller_set_target_address(i2c_instance_en id, uint32_t address);
 
/*******************************************************************************
*              Function Name: i2c_controller_get_target_address
****************************************************************************/
i2c_status_en i2c_controller_get_target_address(i2c_instance_en id, uint32_t *tar_addr);
 
/*******************************************************************************
*                           Function Name: i2c_enable
****************************************************************************/
i2c_status_en i2c_enable(i2c_instance_en id);
 
/*******************************************************************************
 *                          Function Name: i2c_disable
 ****************************************************************************/
i2c_status_en i2c_disable(i2c_instance_en id);
 
/*******************************************************************************
 *                   Function Name: i2c_register_callback
 ****************************************************************************/
i2c_status_en i2c_register_callback(i2c_instance_en id, i2c_event_cb_t cb, void *user_data);
 
/*******************************************************************************
 *              Function Name: i2c_controller_write_blocking
 ****************************************************************************/
i2c_status_en i2c_controller_write_blocking(i2c_instance_en id,
                                          i2c_blocking_config_t *xfer);
 
/*******************************************************************************
 *               Function Name: i2c_controller_read_blocking
 ****************************************************************************/
i2c_status_en i2c_controller_read_blocking(i2c_instance_en id,
                                         i2c_blocking_config_t *xfer);
 
/*******************************************************************************
 *              Function Name: i2c_controller_write_non_blocking
 ****************************************************************************/
 i2c_status_en i2c_controller_write_non_blocking(i2c_instance_en id,
                                 i2c_nonblocking_config_t *xfer);
 
/*******************************************************************************
 *             Function Name: i2c_controller_read_non_blocking
 ****************************************************************************/
 i2c_status_en i2c_controller_read_non_blocking(i2c_instance_en id,
                                 i2c_nonblocking_config_t *xfer);
 
/*******************************************************************************
 *                     Function Name: i2c_controller_abort
 ****************************************************************************/
 i2c_status_en i2c_controller_abort(i2c_instance_en id);
 
/*******************************************************************************
 *             Function Name: i2c_controller_get_transfer_count
 ****************************************************************************/
 i2c_status_en i2c_controller_get_transfer_count(i2c_instance_en id, uint32_t *count);
 
 /*******************************************************************************
 *             Function Name: i2c_controller_get_transfer_status
 ****************************************************************************/
 i2c_transfer_status_en i2c_controller_get_transfer_status(i2c_instance_en id);
 
 /*******************************************************************************
 *                  Function Name: i2c_target_set_config
 ****************************************************************************/
 i2c_status_en i2c_target_set_config(i2c_instance_en id, i2c_target_config_t *cfg);
 
 /*******************************************************************************
  *                   Function Name: i2c_target_get_config
  ****************************************************************************/
 i2c_status_en i2c_target_get_config(i2c_instance_en id, i2c_target_config_t *cfg);
 
 /*******************************************************************************
 *                Function Name: i2c_target_get_transfer_count
 ****************************************************************************/
i2c_status_en i2c_target_get_transfer_count(i2c_instance_en id, uint32_t *count);
 
/*******************************************************************************
 *                     Function Name: i2c_target_abort
 ****************************************************************************/
 i2c_status_en i2c_target_abort(i2c_instance_en id);
 
 /*******************************************************************************
 *                     Function Name: i2c_target_get_transfer_status
 ****************************************************************************/
 i2c_transfer_status_en i2c_target_get_transfer_status(i2c_instance_en id);
 
 /*******************************************************************************
 *              Function Name: i2c_target_prep_controller_write
 ****************************************************************************/
i2c_status_en i2c_target_prep_controller_write(i2c_instance_en id,
                                                uint8_t *buf,
                                                uint32_t size);
 
/*******************************************************************************
 *               Function Name: i2c_target_prep_controller_read
 ****************************************************************************/
i2c_status_en i2c_target_prep_controller_read(i2c_instance_en id,
                                               uint8_t *buf,
                                               uint32_t size);
 
 /*******************************************************************************
 *            Function Name: i2c_s_get_standard_speed_high_low_count
 ****************************************************************************/
i2c_status_en i2c_s_get_standard_speed_high_low_count(i2c_instance_en id,
                                                      uint32_t *ss_low_count,
                                                      uint32_t *ss_high_count);
 
 /*******************************************************************************
 *               Function Name: i2c_s_get_fast_speed_high_low_count
 ****************************************************************************/
i2c_status_en i2c_s_get_fast_speed_high_low_count(i2c_instance_en id,
                                                  uint32_t *fs_low_count,
                                                  uint32_t *fs_high_count);
 
 /*******************************************************************************
 *                  Function Name: i2c_s_get_sda_hold_config
 ****************************************************************************/
i2c_status_en i2c_s_get_sda_hold_config(i2c_instance_en id,
                                        uint32_t *sda_hold_time_rx,
                                        uint32_t *sda_hold_time_tx);
 
 /*******************************************************************************
 *             Function Name: i2c_s_set_standard_speed_high_low_count
 ****************************************************************************/
i2c_status_en i2c_s_set_standard_speed_high_low_count(i2c_instance_en id,
                                                      uint32_t ss_low_count,
                                                      uint32_t ss_high_count);
 
 /*******************************************************************************
 *             Function Name: i2c_s_set_fast_speed_high_low_count
 ****************************************************************************/
i2c_status_en i2c_s_set_fast_speed_high_low_count(i2c_instance_en id,
                                                  uint32_t fs_low_count,
                                                  uint32_t fs_high_count);
 
 /*******************************************************************************
 *             Function Name: i2c_s_set_sda_hold_config
 ****************************************************************************/
i2c_status_en i2c_s_set_sda_hold_config(i2c_instance_en id,
                                         uint32_t sda_hold_time_rx,
                                         uint32_t sda_hold_time_tx);

 
#endif /* I2C_DRIVER_H */