vsf_template_i2c.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  Licensed under the Apache License, Version 2.0 (the "License");          *
 *  you may not use this file except in compliance with the License.         *
 *  You may obtain a copy of the License at                                  *
 *                                                                           *
 *     http://www.apache.org/licenses/LICENSE-2.0                            *
 *                                                                           *
 *  Unless required by applicable law or agreed to in writing, software      *
 *  distributed under the License is distributed on an "AS IS" BASIS,        *
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
 *  See the License for the specific language governing permissions and      *
 *  limitations under the License.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __VSF_TEMPLATE_I2C_H__
#define __VSF_TEMPLATE_I2C_H__
 
/*============================ INCLUDES ======================================*/
 
#include "./vsf_template_hal_driver.h"
#include "hal/arch/vsf_arch.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
// multi-class support enabled by default for maximum availability.
#ifndef VSF_I2C_CFG_MULTI_CLASS
#   define VSF_I2C_CFG_MULTI_CLASS                  ENABLED
#endif
 
#if defined(VSF_HW_I2C_COUNT) && !defined(VSF_HW_I2C_MASK)
#   define VSF_HW_I2C_MASK                          VSF_HAL_COUNT_TO_MASK(VSF_HW_I2C_COUNT)
#endif
 
#if defined(VSF_HW_I2C_MASK) && !defined(VSF_HW_I2C_COUNT)
#   define VSF_HW_I2C_COUNT                         VSF_HAL_MASK_TO_COUNT(VSF_HW_I2C_MASK)
#endif
 
// application code can redefine it
#ifndef VSF_I2C_CFG_PREFIX
#   if VSF_I2C_CFG_MULTI_CLASS == ENABLED
#       define VSF_I2C_CFG_PREFIX                   vsf
#   elif defined(VSF_HW_I2C_COUNT) && (VSF_HW_I2C_COUNT != 0)
#       define VSF_I2C_CFG_PREFIX                   vsf_hw
#   else
#       define VSF_I2C_CFG_PREFIX                   vsf
#   endif
#endif
 
#ifndef VSF_I2C_CFG_FUNCTION_RENAME
#   define VSF_I2C_CFG_FUNCTION_RENAME              ENABLED
#endif
 
#ifndef VSF_I2C_CFG_REQUEST_TEMPLATE
#   define VSF_I2C_CFG_REQUEST_TEMPLATE             DISABLED
#endif
 
#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE
#   define VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE        DISABLED
#endif
 
#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD
#   define VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD         DISABLED
#endif
 
#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK
#   define VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK    DISABLED
#endif
 
#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS
#   define VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS      DISABLED
#endif
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
#    define VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG DISABLED
#endif
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
#    define VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
#endif
 
 
#ifndef VSF_I2C_CFG_INHERT_HAL_CAPABILITY
#   define VSF_I2C_CFG_INHERT_HAL_CAPABILITY       ENABLED
#endif
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#define VSF_I2C_APIS(__PREFIX_NAME)                                                                                                                                    \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t,            i2c, init,                  VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr)      \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void,                 i2c, fini,                  VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t,             i2c, enable,                VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, fsm_rt_t,             i2c, disable,               VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void,                 i2c, irq_enable,            VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask) \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, void,                 i2c, irq_disable,           VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask) \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_i2c_status_t,     i2c, status,                VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_i2c_capability_t, i2c, capability,            VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, uint_fast32_t,        i2c, get_transferred_count, VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr)                              \
    __VSF_HAL_TEMPLATE_API(__PREFIX_NAME, vsf_err_t,            i2c, master_request,        VSF_MCONNECT(__PREFIX_NAME, _i2c_t) *i2c_ptr, uint16_t address, vsf_i2c_cmd_t cmd, uint16_t count, uint8_t* buffer_ptr)
 
/*============================ TYPES =========================================*/
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
typedef enum vsf_i2c_mode_t {
    VSF_I2C_MODE_MASTER           = (0x1ul << 28),  // select master mode
    VSF_I2C_MODE_SLAVE            = (0x0ul << 28),  // select slave mode
 
    // TODO: Ultra Fast-mode I2C-bus protocol
    VSF_I2C_SPEED_STANDARD_MODE   = (0x0ul << 29),  // up to 100 kbit/s
    VSF_I2C_SPEED_FAST_MODE       = (0x1ul << 29),  // up to 400 kbit/s
    VSF_I2C_SPEED_FAST_MODE_PLUS  = (0x2ul << 29),  // up to 1 Mbit/s
    VSF_I2C_SPEED_HIGH_SPEED_MODE = (0x3ul << 29),  // up to 3.4 Mbit/s
 
    VSF_I2C_ADDR_7_BITS           = (0x0ul << 31),
    VSF_I2C_ADDR_10_BITS          = (0x1ul << 31),
} vsf_i2c_mode_t;
#endif
 
enum {
    VSF_I2C_MODE_COUNT            = 2,
    VSF_I2C_MODE_MASK             = VSF_I2C_MODE_MASTER |
                                    VSF_I2C_MODE_SLAVE,
 
    VSF_I2C_SPEED_COUNT           = 4,
    VSF_I2C_SPEED_MASK            = VSF_I2C_SPEED_STANDARD_MODE |
                                    VSF_I2C_SPEED_FAST_MODE |
                                    VSF_I2C_SPEED_FAST_MODE_PLUS |
                                    VSF_I2C_SPEED_HIGH_SPEED_MODE,
 
    VSF_I2C_ADDR_COUNT            = 3,
    VSF_I2C_ADDR_MASK             = VSF_I2C_ADDR_7_BITS |
                                    VSF_I2C_ADDR_10_BITS,
 
    VSF_I2C_MODE_MASK_COUNT       = 3,
    VSF_I2C_MODE_ALL_BITS_MASK    = VSF_I2C_MODE_MASK |
                                    VSF_I2C_SPEED_MASK |
                                    VSF_I2C_ADDR_MASK,
};
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD == DISABLED
typedef enum vsf_i2c_cmd_t {
    VSF_I2C_CMD_WRITE           = (0x00ul << 0),
    VSF_I2C_CMD_READ            = (0x01ul << 0),
 
    VSF_I2C_CMD_START           = (0x00ul << 28),
    VSF_I2C_CMD_NO_START        = (0x01ul << 28),
 
    VSF_I2C_CMD_STOP            = (0x00ul << 29),
    VSF_I2C_CMD_RESTART         = (0x01ul << 30),
    VSF_I2C_CMD_NO_STOP_RESTART = (0x01ul << 30),
 
    VSF_I2C_CMD_7_BITS          = (0x00ul << 31),
    VSF_I2C_CMD_10_BITS         = (0x01ul << 31),
} vsf_i2c_cmd_t;
#endif
 
enum {
    VSF_I2C_CMD_RW_COUNT            = 2,
    VSF_I2C_CMD_RW_MASK             = VSF_I2C_CMD_WRITE | VSF_I2C_CMD_READ,
 
    VSF_I2C_CMD_BITS_COUNT          = 2,
    VSF_I2C_CMD_BITS_MASK           = VSF_I2C_CMD_7_BITS |
                                      VSF_I2C_CMD_10_BITS,
 
    VSF_I2C_CMD_START_COUNT         = 2,
    VSF_I2C_CMD_START_MASK          = VSF_I2C_CMD_START | VSF_I2C_CMD_NO_START,
 
    VSF_I2C_CMD_STOP_RESTART_COUNT  = 3,
    VSF_I2C_CMD_STOP_RESTART_MASK   = VSF_I2C_CMD_STOP
                                    | VSF_I2C_CMD_RESTART
                                    | VSF_I2C_CMD_NO_STOP_RESTART,
 
    VSF_I2C_CMD_MASK_COUNT          = 5,
    VSF_I2C_CMD_ALL_BITS_MASK       = VSF_I2C_CMD_RW_MASK
                                    | VSF_I2C_CMD_START
                                    | VSF_I2C_CMD_STOP
                                    | VSF_I2C_CMD_RESTART
                                    | VSF_I2C_CMD_BITS_MASK,
};
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
typedef enum vsf_i2c_irq_mask_t {
    VSF_I2C_IRQ_MASK_MASTER_STARTED                 = (0x1ul <<  0),
    VSF_I2C_IRQ_MASK_MASTER_STOPPED                 = (0x1ul <<  1),
    VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT             = (0x1ul <<  2),    // for multi master
    VSF_I2C_IRQ_MASK_MASTER_NACK_DETECT             = (0x1ul <<  4),
    VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST        = (0x1ul <<  5),
    VSF_I2C_IRQ_MASK_MASTER_TX_EMPTY                = (0x1ul <<  6),
    VSF_I2C_IRQ_MASK_MASTER_ERROR                   = (0x1ul <<  7),
 
    VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE       = (0x1ul <<  8),
    VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK            = (0x1ul <<  9),
} vsf_i2c_irq_mask_t;
#endif
 
enum {
    VSF_I2C_IRQ_COUNT                               = 8,
    VSF_I2C_IRQ_ALL_BITS_MASK                       = VSF_I2C_IRQ_MASK_MASTER_STARTED
                                                    | VSF_I2C_IRQ_MASK_MASTER_STOPPED
                                                    | VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT
                                                    | VSF_I2C_IRQ_MASK_MASTER_NACK_DETECT
                                                    | VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST
                                                    | VSF_I2C_IRQ_MASK_MASTER_TX_EMPTY
                                                    | VSF_I2C_IRQ_MASK_MASTER_ERROR
                                                    | VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE
                                                    | VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK,
};
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
typedef struct vsf_i2c_status_t {
    union {
        inherit(vsf_peripheral_status_t)
        uint32_t value;
    };
} vsf_i2c_status_t;
#endif
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
typedef struct vsf_i2c_capability_t {
#if VSF_I2C_CFG_INHERT_HAL_CAPABILITY == ENABLED
    inherit(vsf_peripheral_capability_t)
#endif
    vsf_i2c_irq_mask_t irq_mask;
 
    // If manual control of the start/stop signal is not supported,
    // then every transmission will generate a start/stop
    uint8_t support_no_start        : 1;
    uint8_t support_no_stop_restart : 1;
    uint8_t support_restart         : 1;
 
    // maximum transfer size
    // specifically, 0 is not a legal value
    uint16_t max_transfer_size;
    // 0, there is no data, just send start condition
    uint16_t min_transfer_size;
} vsf_i2c_capability_t;
#endif
 
#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
typedef struct vsf_i2c_t vsf_i2c_t;
 
typedef void vsf_i2c_isr_handler_t(void *target_ptr,
                                   vsf_i2c_t *i2c_ptr,
                                   vsf_i2c_irq_mask_t irq_mask);
 
typedef struct vsf_i2c_isr_t {
    vsf_i2c_isr_handler_t *handler_fn;      
    void                  *target_ptr;      
    vsf_arch_prio_t        prio;            
} vsf_i2c_isr_t;
 
typedef struct vsf_i2c_cfg_t {
    vsf_i2c_mode_t mode;                    
    uint32_t clock_hz;                      
    vsf_i2c_isr_t isr;                      
    uint16_t slave_addr;                    
} vsf_i2c_cfg_t;
#endif
 
typedef struct vsf_i2c_op_t {
#undef __VSF_HAL_TEMPLATE_API
#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
 
    VSF_I2C_APIS(vsf)
} vsf_i2c_op_t;
 
#if VSF_I2C_CFG_MULTI_CLASS == ENABLED
struct vsf_i2c_t  {
    const vsf_i2c_op_t * op;
};
#endif
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ PROTOTYPES ====================================*/
 
extern vsf_err_t vsf_i2c_init(vsf_i2c_t *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr);
 
extern void vsf_i2c_fini(vsf_i2c_t *i2c_ptr);
 
extern fsm_rt_t vsf_i2c_enable(vsf_i2c_t *i2c_ptr);
 
extern fsm_rt_t vsf_i2c_disable(vsf_i2c_t *i2c_ptr);
 
extern void vsf_i2c_irq_enable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask);
 
extern void vsf_i2c_irq_disable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask);
 
extern vsf_i2c_status_t vsf_i2c_status(vsf_i2c_t *i2c_ptr);
 
extern vsf_i2c_capability_t vsf_i2c_capability(vsf_i2c_t *i2c_ptr);
 
extern vsf_err_t vsf_i2c_master_request(vsf_i2c_t *i2c_ptr,
                                        uint16_t address,
                                        vsf_i2c_cmd_t cmd,
                                        uint16_t count,
                                        uint8_t *buffer_ptr);
 
extern uint_fast32_t vsf_i2c_get_transferred_count(vsf_i2c_t *i2c_ptr);
 
/*============================ INCLUDES ======================================*/
 
#include "hal/driver/common/i2c/i2c_request.h"
 
/*============================ MACROFIED FUNCTIONS ===========================*/
 
#if VSF_I2C_CFG_FUNCTION_RENAME == ENABLED
#   define __vsf_i2c_t                              VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_t)
#   define vsf_i2c_init(__I2C, ...)                 VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_init)                 ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
#   define vsf_i2c_fini(__I2C)                      VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_fini)                 ((__vsf_i2c_t *)(__I2C))
#   define vsf_i2c_enable(__I2C)                    VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_enable)               ((__vsf_i2c_t *)(__I2C))
#   define vsf_i2c_disable(__I2C)                   VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_disable)              ((__vsf_i2c_t *)(__I2C))
#   define vsf_i2c_irq_enable(__I2C, ...)           VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_enable)           ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
#   define vsf_i2c_irq_disable(__I2C, ...)          VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_disable)          ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
#   define vsf_i2c_status(__I2C)                    VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_status)               ((__vsf_i2c_t *)(__I2C))
#   define vsf_i2c_capability(__I2C)                VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_capability)           ((__vsf_i2c_t *)(__I2C))
#   define vsf_i2c_master_request(__I2C, ...)       VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_request)       ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
#   define vsf_i2c_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_get_transferred_count) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif  /*__VSF_TEMPLATE_I2C_H__*/