i2c.h

Go to the documentation of this file.

// Copyright (C) 2013-2026 Efinix Inc. All rights reserved.
// Full license header bsp/efinix/EfxSapphireSocRV64/include/LICENSE.MD
 
#ifndef I2C_H
#define I2C_H

 
 
#include <stdint.h>
#include "type.h"
#include "soc.h"
 
#ifdef __cplusplus
extern  "C" {
#endif
 
/* ========================================================================== */
/* SUB-GROUP : REGISTER DEFINITIONS                                          */
/* ========================================================================== */ 

    #define I2C_MODE_CPOL                   (1 << 0)    
    #define I2C_MODE_CPHA                   (1 << 1)    

    #define I2C_TX_VALUE                    (0xFF)      
    #define I2C_TX_VALID                    (1 << 8)    
    #define I2C_TX_ENABLE                   (1 << 9)    
    #define I2C_TX_REPEAT                   (1 << 10)   
    #define I2C_TX_DISABLE_ON_DATA_CONFLICT (1 << 11)   
    #define I2C_RX_VALUE                    (0xFF)      
    #define I2C_RX_VALID                    (1 << 8)    
    #define I2C_RX_LISTEN                   (1 << 9)    

    #define I2C_MASTER_BUSY                 (1 << 0)    
    #define I2C_MASTER_START                (1 << 4)    
    #define I2C_MASTER_STOP                 (1 << 5)    
    #define I2C_MASTER_DROP                 (1 << 6)    
    #define I2C_MASTER_RECOVER              (1 << 7)    
    #define I2C_MASTER_START_DROPPED        (1 << 9)    
    #define I2C_MASTER_STOP_DROPPED         (1 << 10)   
    #define I2C_MASTER_RECOVER_DROPPED      (1 << 11)   
    #define I2C_SLAVE_STATUS_IN_FRAME       (1 << 0)    
    #define I2C_SLAVE_STATUS_SDA            (1 << 1)    
    #define I2C_SLAVE_STATUS_SCL            (1 << 2)    
    #define I2C_SLAVE_OVERRIDE_SDA          (1 << 1)    
    #define I2C_SLAVE_OVERRIDE_SCL          (1 << 2)    

    #define I2C_FILTER_7_BITS               (0)         
    #define I2C_FILTER_10_BITS              (1 << 14)   
    #define I2C_FILTER_ENABLE               (1 << 15)   

    #define I2C_READ                        0x01    
    #define I2C_WRITE                       0x00    
 
  
    #ifndef TX_AND_CHECK
    #define TX_AND_CHECK(inst, byte)             \
        do {                                     \
            i2c_sendTxByte(inst, (byte));            \
            i2c_sendNackBlocking(inst);            \
            i2c_waitRxAck(inst);                 \
        } while(0)
    #endif
 // End of I2C_Macros group
 
/* ========================================================================== */
/* SUB-GROUP : Data Types                                                    */
/* ========================================================================== */


    
        typedef enum {
            I2C_INTERRUPT_RX_DATA           = (1 << 0), 
            I2C_INTERRUPT_RX_ACK            = (1 << 1), 
            I2C_INTERRUPT_TX_DATA           = (1 << 2), 
            I2C_INTERRUPT_TX_ACK            = (1 << 3), 
            I2C_INTERRUPT_START             = (1 << 4), 
            I2C_INTERRUPT_RESTART           = (1 << 5), 
            I2C_INTERRUPT_END               = (1 << 6), 
            I2C_INTERRUPT_DROP              = (1 << 7),  
            I2C_INTERRUPT_CLOCK_GEN_EXIT    = (1 << 15), 
            I2C_INTERRUPT_CLOCK_GEN_ENTER   = (1 << 16), 
            I2C_INTERRUPT_FILTER            = (1 << 17)  
        } i2c_interrupt_t;

 // End of I2C_ENUM group
 
 
/* ========================================================================== */
/* SUB-GROUP : DATA STRUCTS                                                     */
/* ========================================================================== */

    typedef volatile struct 
    {
        u32 FILTER_CONFIG_0; 
        u32 FILTER_CONFIG_1; 
 
    } i2c_filter_hwreg_t;

    typedef volatile struct{
        u32 TX_DATA;                
        u32 TX_ACK;                 
        u32 RX_DATA;                
        u32 RX_ACK;                 
        u32 RESERVED0[4];           
        u32 INTERRUPT;              
        u32 INTERRUPT_CLEAR;        
        u32 SAMPLING_CLOCK_DIVIDER; 
        u32 TIMEOUT;                
        u32 TSU_DATA;               
        u32 RESERVED1[3];           
        u32 MASTER_STATUS;          
        u32 SLAVE_STATUS;           
        u32 SLAVE_OVERRIDE;         
        u32 RESERVED2;              
        u32 tLOW;                   
        u32 tHIGH;                  
        u32 tBUF;                   
        u32 RESERVED3[9];           
        u32 HIT_CONTEXT;            
        u32 FILTER_STATUS;          
        i2c_filter_hwreg_t FILTER[3];   
    } i2c_hwreg_t;

    typedef struct{
        i2c_hwreg_t     *hwreg;                 
        u32             slaveAddress;           
        u32             samplingClockDivider;   
        u32             timeout;                
        u32             tsuDat;                 
        u32             tLow;                   
        u32             tHigh;                  
        u32             tBuf;                   
    }i2c_instance_t;
 
 
 // End of I2C_Types group
 
/* ========================================================================== */
/* SUB-GROUP: FUNCTIONS                                                     */
/* ========================================================================== */


    void i2c_applyConfig(i2c_instance_t *inst);

    void i2c_setSlaveOverride(i2c_instance_t *inst, u32 value);
    
        u32 i2c_getSlaveStatus(i2c_instance_t *inst);
        u32 i2c_getMasterStatus(i2c_instance_t *inst);
        u32 i2c_getFilteringHit(i2c_instance_t *inst);
        u32 i2c_getInterruptFlag (i2c_instance_t *inst);
        u32 i2c_getInterruptEnable (i2c_instance_t *inst);
        u32 i2c_getFilteringStatus(i2c_instance_t *inst);
        u32 i2c_getSlaveOverride(i2c_instance_t *inst);


    
        void i2c_startMaster(i2c_instance_t *inst);
        void i2c_restartMaster(i2c_instance_t *inst);
        void i2c_recoverMaster(i2c_instance_t *inst);
        void i2c_startMasterBlocking(i2c_instance_t *inst);
        void i2c_restartMasterBlocking(i2c_instance_t *inst);
        void i2c_stopMaster(i2c_instance_t *inst);
        void i2c_stopMasterBlocking(i2c_instance_t *inst);
        void i2c_recoverMasterBlocking(i2c_instance_t *inst);
        void i2c_dropMaster(i2c_instance_t *inst);
        u32 i2c_checkMasterBusy(i2c_instance_t *inst); //End of I2C Master Functions group
 

        void i2c_listenAck(i2c_instance_t *inst);
        void i2c_sendTxByte(i2c_instance_t *inst,u8 byte);
        void i2c_sendTxAck(i2c_instance_t *inst);
        void i2c_sendTxNack(i2c_instance_t *inst);
        void i2c_waitTxAck(i2c_instance_t *inst);
        void i2c_waitRxAck(i2c_instance_t *inst);
        void i2c_sendAckBlocking(i2c_instance_t *inst);
        void i2c_sendNackBlocking(i2c_instance_t *inst);
        u32 i2c_getRxData(i2c_instance_t *inst);
        u32 i2c_getRxAck(i2c_instance_t *inst);
        u32 i2c_getRxNack(i2c_instance_t *inst);
        void i2c_sendTxByteRepeat(i2c_instance_t *inst,u8 byte);
        void i2c_sendTxNackRepeat(i2c_instance_t *inst);
   //End of I2C Transmit/Receive Functions group

        void i2c_enableFilter(i2c_instance_t *inst, u32 filterId, u32 config);
        void i2c_setFilterConfig(i2c_instance_t *inst, u32 filterId, u32 value);
        void i2c_enableInterrupt(i2c_instance_t *inst, i2c_interrupt_t value);
        void i2c_disableInterrupt(i2c_instance_t *inst, i2c_interrupt_t value);
        void i2c_clearInterruptFlag(i2c_instance_t *inst, i2c_interrupt_t value);
   //End of I2C Control Functions group

        void i2c_writeData_b(i2c_instance_t *inst, u8 regAddr, u8 *data, u32 length);
        void i2c_writeData_w(i2c_instance_t *inst, u16 regAddr, u8 *data, u32 length);
        void i2c_readData_b(i2c_instance_t *inst, u8 regAddr, u8 *data , u32 length);
        void i2c_readData_w(i2c_instance_t *inst, u16 regAddr, u8 *data , u32 length);
        void i2c_setMux(i2c_instance_t *inst, const uint8_t cr);
   //End of I2C Read/Write Functions group
   //End of I2C Funcs group
#ifdef __cplusplus
}
#endif // C_plusplus
 // End of MAIN I2C Group
 
#endif // I2C_H