spi.h File Reference

#include "hal/vsf_hal_cfg.h"
#include "hal/driver/common/template/vsf_template_hal_driver.h"
#include "utilities/ooc_class.h"

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_spi_status_t
	Predefined VSF SPI status that can be reimplemented in specific HAL drivers. Even if the hardware doesn't support these features, these status must be kept. More...
struct	vsf_spi_capability_t
	Predefined VSF SPI capability that can be reimplemented in specific HAL drivers. Even if the hardware doesn't support these features, these capabilities must be kept. More...
struct	vsf_spi_isr_t
	SPI interrupt service routine configuration structure. More...
struct	vsf_spi_cfg_t
	Configuration structure for SPI. More...

Macros
#define	__HAL_DRIVER_   ${SERIES/SPI_IP}_SPI_H__
#define	VSF_   ${SPI_IP}_SPI_CFG_MULTI_CLASS VSF_SPI_CFG_MULTI_CLASS
#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

Typedefs
typedef enum vsf_spi_mode_t	vsf_spi_mode_t
typedef enum vsf_spi_irq_mask_t	vsf_spi_irq_mask_t
typedef struct vsf_spi_status_t	vsf_spi_status_t
typedef struct vsf_spi_capability_t	vsf_spi_capability_t
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_t
typedef struct vsf_spi_cfg_t	vsf_spi_cfg_t
typedef enum vsf_spi_ctrl_t	vsf_spi_ctrl_t

Enumerations
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 ,   VSF_SPI_CPOL_LOW = 0x00ul << 2 ,   VSF_SPI_CPOL_HIGH = 0x01ul << 2 ,   VSF_SPI_CPHA_LOW = 0x00ul << 2 ,   VSF_SPI_CPHA_HIGH = 0x01ul << 2 ,   VSF_SPI_MODE_0 = VSF_SPI_CPOL_LOW | VSF_SPI_CPHA_LOW ,   VSF_SPI_MODE_1 = VSF_SPI_CPOL_LOW | VSF_SPI_CPHA_HIGH ,   VSF_SPI_MODE_2 = VSF_SPI_CPOL_HIGH | VSF_SPI_CPHA_LOW ,   VSF_SPI_MODE_3 = VSF_SPI_CPOL_HIGH | VSF_SPI_CPHA_HIGH ,   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 }
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 }
enum	vsf_spi_ctrl_t { __VSF_SPI_CTRL_DUMMY = 0 }

Variables
class vsf_$ *	reg
vsf_spi_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/SPI_IP}_SPI_H__

VSF_

#define VSF_   ${SPI_IP}_SPI_CFG_MULTI_CLASS VSF_SPI_CFG_MULTI_CLASS

Note

When vsf_peripheral_status_t is inherited, vsf_template_hal_driver.h needs to be included

VSF_SPI_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_MODE   ENABLED

VSF_SPI_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED

VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_SPI_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_spi_mode_t

typedef enum vsf_spi_mode_t vsf_spi_mode_t

vsf_spi_irq_mask_t

typedef enum vsf_spi_irq_mask_t vsf_spi_irq_mask_t

vsf_spi_status_t

typedef struct vsf_spi_status_t vsf_spi_status_t

vsf_spi_capability_t

typedef struct vsf_spi_capability_t vsf_spi_capability_t

vsf_spi_t

typedef struct vsf_spi_t vsf_spi_t

Note

Redefining vsf_spi_cfg_t usually requires declaring vsf_spi_t and vsf_spi_isr_handler_t types and define vsf_spi_isr_t.

vsf_spi_isr_handler_t

typedef void vsf_spi_isr_handler_t(void *target_ptr, vsf_spi_t *spi_ptr, vsf_spi_irq_mask_t irq_mask)

vsf_spi_isr_t

typedef struct vsf_spi_isr_t vsf_spi_isr_t

vsf_spi_cfg_t

typedef struct vsf_spi_cfg_t vsf_spi_cfg_t

vsf_spi_ctrl_t

typedef enum vsf_spi_ctrl_t vsf_spi_ctrl_t

Enumeration Type Documentation

vsf_spi_mode_t

enum vsf_spi_mode_t

Enumerator
VSF_SPI_MASTER
VSF_SPI_SLAVE
VSF_SPI_MSB_FIRST
VSF_SPI_LSB_FIRST
VSF_SPI_CPOL_LOW
VSF_SPI_CPOL_HIGH
VSF_SPI_CPHA_LOW
VSF_SPI_CPHA_HIGH
VSF_SPI_MODE_0
VSF_SPI_MODE_1
VSF_SPI_MODE_2
VSF_SPI_MODE_3
VSF_SPI_CS_SOFTWARE_MODE
VSF_SPI_CS_HARDWARE_MODE
VSF_SPI_DATASIZE_8
VSF_SPI_DATASIZE_16
VSF_SPI_DATASIZE_32

vsf_spi_irq_mask_t

enum vsf_spi_irq_mask_t

Enumerator
VSF_SPI_IRQ_MASK_TX
VSF_SPI_IRQ_MASK_RX
VSF_SPI_IRQ_MASK_TX_CPL
VSF_SPI_IRQ_MASK_RX_CPL
VSF_SPI_IRQ_MASK_RX_OVERFLOW_ERR

vsf_spi_ctrl_t

enum vsf_spi_ctrl_t

Enumerator
__VSF_SPI_CTRL_DUMMY

Variable Documentation

reg

class vsf_$* reg

isr

vsf_spi_isr_t isr