spi.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 __HAL_DRIVER_${SERIES/SPI_IP}_SPI_H__
#define __HAL_DRIVER_${SERIES/SPI_IP}_SPI_H__
 
/*============================ INCLUDES ======================================*/
 
#include "hal/vsf_hal_cfg.h"
 
#if VSF_HAL_USE_SPI == ENABLED
 
// HW/IPCore
#include "hal/driver/common/template/vsf_template_hal_driver.h"
// HW/IPCore end
 
/*\note Refer to template/README.md for usage cases.
 *      For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
 *      For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
 *      For emulated drivers, **** No reimplementation ****.
 */
 
/*\note Includes CAN ONLY be put here. */
/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
 
// IPCore
#if     defined(__VSF_HAL_${SPI_IP}_SPI_CLASS_IMPLEMENT)
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_HAL_${SPI_IP}_SPI_CLASS_INHERIT__)
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
// IPCore end
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*============================ MACROS ========================================*/
 
/*\note VSF_${SPI_IP}_SPI_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
 *          while VSF_HW_SPI_CFG_MULTI_CLASS should be in spi.c.
 */
 
// IPCore
#ifndef VSF_${SPI_IP}_SPI_CFG_MULTI_CLASS
#   define VSF_${SPI_IP}_SPI_CFG_MULTI_CLASS    VSF_SPI_CFG_MULTI_CLASS
#endif
// IPCore end
 
// HW
/*\note hw SPI driver can reimplement following types:
 *      To enable reimplementation, please enable macro below:
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_MODE for vsf_spi_mode_t
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS for vsf_spi_status_t
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_spi_irq_mask_t
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL for vsf_spi_ctrl_t
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG for vsf_spi_cfg_t
 *          VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_spi_capability_t
 *      Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
 *      *** DO NOT reimplement these in emulated drivers. ***
 */
 
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_MODE         ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_IRQ_MASK     ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS       ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL         ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG          ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED
 
#define VSF_SPI_CFG_REIMPLEMENT_MODE_TO_DATA_BITS ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_DATA_BITS_TO_MODE ENABLED
#define VSF_SPI_CFG_REIMPLEMENT_MODE_TO_BYTES     ENABLED
// HW end
 
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ TYPES =========================================*/
 
// IPCore
vsf_class(vsf_${spi_ip}_spi_t) {
#if VSF_${SPI_IP}_CFG_MULTI_CLASS == ENABLED
    public_member(
        vsf_spi_t               vsf_spi;
    )
#endif
 
/*\note You can add more member in vsf_${spi_ip}_spi_t instance.
 *      For members accessible from child, put in protected_member.
 *      Else, put in private_member.
 */
 
    protected_member(
        vsf_${spi_ip}_spi_reg_t *reg;
        vsf_spi_isr_t           isr;
    )
};
// IPCore end
 
// HW/IPCore, not for emulated drivers
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_MODE == ENABLED
typedef enum vsf_spi_mode_t {
    VSF_SPI_MASTER                  = 0x00ul << 0,
    VSF_SPI_SLAVE                   = 0x01ul << 0,
    VSF_SPI_MSB_FIRST               = 0x00ul << 1,
    VSF_SPI_LSB_FIRST               = 0x01ul << 1,
 
    // SPI mode (bits 2-3: CPOL and CPHA)
    VSF_SPI_MODE_0                  = 0x00ul << 2,
    VSF_SPI_MODE_1                  = 0x01ul << 2,
    VSF_SPI_MODE_2                  = 0x02ul << 2,
    VSF_SPI_MODE_3                  = 0x03ul << 2,
 
    VSF_SPI_CS_SOFTWARE_MODE        = 0x00ul << 4,
    VSF_SPI_CS_HARDWARE_MODE        = 0x01ul << 4,
    VSF_SPI_DATASIZE_8              = 0x00ul << 8,
    VSF_SPI_DATASIZE_16             = 0x01ul << 8,
    VSF_SPI_DATASIZE_32             = 0x02ul << 8,
 
    // Standard Optional: only include these if hardware supports them
    //VSF_SPI_CPOL_LOW                = 0x00ul << 2,
    //VSF_SPI_CPOL_HIGH               = 0x01ul << 2,
    //VSF_SPI_CPHA_LOW                = 0x00ul << 3,
    //VSF_SPI_CPHA_HIGH               = 0x01ul << 3,
 
    // more vendor specified modes can be added here
} vsf_spi_mode_t;
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
typedef enum vsf_spi_irq_mask_t {
    VSF_SPI_IRQ_MASK_TX                 = 0x01ul << 0,
    VSF_SPI_IRQ_MASK_RX                 = 0x01ul << 1,
    VSF_SPI_IRQ_MASK_TX_CPL             = 0x01ul << 2,
    VSF_SPI_IRQ_MASK_RX_CPL             = 0x01ul << 3,
    VSF_SPI_IRQ_MASK_RX_OVERFLOW_ERR    = 0x01ul << 4,
 
    // more vendor specified irq_masks can be added here
} vsf_spi_irq_mask_t;
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
typedef struct vsf_spi_status_t {
    union {
        struct {
            uint32_t is_busy : 1;
        };
    };
 
    // more vendor specified status can be added here
} vsf_spi_status_t;
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
typedef struct vsf_spi_capability_t {
    vsf_spi_irq_mask_t irq_mask;
    uint8_t support_hardware_cs : 1;
    uint8_t support_software_cs : 1;
    uint8_t cs_count            : 6;
    uint32_t max_clock_hz;
    uint32_t min_clock_hz;
 
    // more vendor specified capability can be added here
} vsf_spi_capability_t;
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
typedef struct vsf_spi_t vsf_spi_t;
typedef void vsf_spi_isr_handler_t(void *target_ptr,
                                   vsf_spi_t *spi_ptr,
                                   vsf_spi_irq_mask_t irq_mask);
typedef struct vsf_spi_isr_t {
    vsf_spi_isr_handler_t *handler_fn;
    void                  *target_ptr;
    vsf_arch_prio_t        prio;
} vsf_spi_isr_t;
typedef struct vsf_spi_cfg_t {
    vsf_spi_mode_t   mode;
    uint32_t         clock_hz;
    vsf_spi_isr_t    isr;
    uint8_t          auto_cs_index;
 
    // more vendor specified cfg can be added here
} vsf_spi_cfg_t;
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL == ENABLED
typedef enum vsf_spi_ctrl_t {
    __VSF_SPI_CTRL_DUMMY = 0,
} vsf_spi_ctrl_t;
#endif
// HW/IPCore end
 
/*============================ INLINE FUNCTIONS ==============================*/
 
#if VSF_SPI_CFG_REIMPLEMENT_MODE_TO_DATA_BITS == ENABLED
// Ensure VSF_SPI_DATASIZE_MASK and related macros are defined before using them
// They will be defined in vsf_template_spi.h, but we need them here for the inline function
// Use macro definitions if template header hasn't been included yet
#ifndef VSF_SPI_DATASIZE_MASK
#   define VSF_SPI_DATASIZE_MASK       (VSF_SPI_DATASIZE_8 | VSF_SPI_DATASIZE_16 | VSF_SPI_DATASIZE_32)
#endif
#ifndef VSF_SPI_DATASIZE_BIT_OFFSET
#   define VSF_SPI_DATASIZE_BIT_OFFSET    8
#endif
#ifndef VSF_SPI_DATASIZE_VALUE_OFFSET
#   define VSF_SPI_DATASIZE_VALUE_OFFSET  1
#endif
 
static inline uint8_t vsf_spi_mode_to_data_bits(vsf_spi_mode_t mode)
{
    int bits = (mode & VSF_SPI_DATASIZE_MASK) >> VSF_SPI_DATASIZE_BIT_OFFSET;
    return bits + VSF_SPI_DATASIZE_VALUE_OFFSET;
}
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_DATA_BITS_TO_MODE == ENABLED
// Ensure VSF_SPI_DATASIZE_BIT_OFFSET and VSF_SPI_DATASIZE_VALUE_OFFSET are defined
#ifndef VSF_SPI_DATASIZE_BIT_OFFSET
#   define VSF_SPI_DATASIZE_BIT_OFFSET    8
#endif
#ifndef VSF_SPI_DATASIZE_VALUE_OFFSET
#   define VSF_SPI_DATASIZE_VALUE_OFFSET  1
#endif
 
static inline vsf_spi_mode_t vsf_spi_data_bits_to_mode(uint8_t data_bits)
{
    return (vsf_spi_mode_t)((data_bits - VSF_SPI_DATASIZE_VALUE_OFFSET) << VSF_SPI_DATASIZE_BIT_OFFSET);
}
#endif
 
#if VSF_SPI_CFG_REIMPLEMENT_MODE_TO_BYTES == ENABLED
static inline uint8_t vsf_spi_mode_to_data_bytes(vsf_spi_mode_t mode)
{
    uint8_t bits = vsf_spi_mode_to_data_bits(mode);
    if (bits == 0) {
        return 0;   // Error: invalid data bits
    } else if (bits <= 8) {
        return 1;
    } else if (bits <= 16) {
        return 2;
    } else {
        return 4;
    }
}
#endif
 
/*============================ INCLUDES ======================================*/
 
// IPCore
/*\note Extern APIs for ip core diriver.
 *      There is no requirement about how APIs of IPCore drivers should be implemented.
 *      Just consider the simplicity for actual peripheral drivers.
 */
// IPCore end
 
#ifdef __cplusplus
}
#endif
 
// IPCore
#undef __VSF_HAL_${SPI_IP}_SPI_CLASS_IMPLEMENT
#undef __VSF_HAL_${SPI_IP}_SPI_CLASS_INHERIT__
// IPCore end
 
#endif      // VSF_HAL_USE_SPI
#endif      // __HAL_DRIVER_${SERIES/SPI_IP}_SPI_H__
/* EOF */