i2s.h File Reference

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

Go to the source code of this file.

Data Structures
class	vsf_$
struct	vsf_i2s_status_t
struct	vsf_i2s_capability_t
struct	vsf_i2s_isr_t
	i2s interrupt configuration More...
struct	vsf_i2s_cfg_t
	i2s configuration More...

Macros
#define	__HAL_DRIVER_   ${SERIES/I2S_IP}_I2S_H__
#define	VSF_   ${I2S_IP}_I2S_CFG_MULTI_CLASS VSF_I2S_CFG_MULTI_CLASS
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE   ENABLED
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedefs
typedef enum vsf_i2s_irq_mask_t	vsf_i2s_irq_mask_t
typedef struct vsf_i2s_status_t	vsf_i2s_status_t
typedef struct vsf_i2s_capability_t	vsf_i2s_capability_t
typedef struct vsf_i2s_t	vsf_i2s_t
typedef void	vsf_i2s_isr_handler_t(void *target_ptr, vsf_i2s_t *i2s_ptr, vsf_i2s_irq_mask_t irq_mask)
typedef struct vsf_i2s_isr_t	vsf_i2s_isr_t
typedef struct vsf_i2s_cfg_t	vsf_i2s_cfg_t

Enumerations
enum	vsf_i2s_irq_mask_t {   VSF_I2S_IRQ_MASK_TX_TGL_BUFFER = (0x1ul << 0) ,   VSF_I2S_IRQ_MASK_RX_TGL_BUFFER = (0x1ul << 1) }

Variables
class vsf_$ *	reg
vsf_i2s_isr_t	isr
	$

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/I2S_IP}_I2S_H__

VSF_

#define VSF_   ${I2S_IP}_I2S_CFG_MULTI_CLASS VSF_I2S_CFG_MULTI_CLASS

Note

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

VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_MODE   ENABLED

VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_I2S_CFG_REIMPLEMENT_TYPE_CTRL

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED

VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_I2S_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_i2s_irq_mask_t

typedef enum vsf_i2s_irq_mask_t vsf_i2s_irq_mask_t

vsf_i2s_status_t

typedef struct vsf_i2s_status_t vsf_i2s_status_t

vsf_i2s_capability_t

typedef struct vsf_i2s_capability_t vsf_i2s_capability_t

vsf_i2s_t

typedef struct vsf_i2s_t vsf_i2s_t

vsf_i2s_isr_handler_t

typedef void vsf_i2s_isr_handler_t(void *target_ptr, vsf_i2s_t *i2s_ptr, vsf_i2s_irq_mask_t irq_mask)

vsf_i2s_isr_t

typedef struct vsf_i2s_isr_t vsf_i2s_isr_t

vsf_i2s_cfg_t

typedef struct vsf_i2s_cfg_t vsf_i2s_cfg_t

Enumeration Type Documentation

vsf_i2s_irq_mask_t

enum vsf_i2s_irq_mask_t

Enumerator
VSF_I2S_IRQ_MASK_TX_TGL_BUFFER
VSF_I2S_IRQ_MASK_RX_TGL_BUFFER

Variable Documentation

reg

class vsf_$* reg

isr

vsf_i2s_isr_t isr

$

$

Initial value:

{I2S_IP}_I2S_CLASS_IMPLEMENT
${I2S_IP}_I2S_CLASS_INHERIT__
 
 
 
 
typedef enum vsf_i2s_mode_t {
    VSF_I2S_MODE_MASTER             = (0x01ul << 0),
    VSF_I2S_MODE_SLAVE              = (0x00ul << 0),
 
    VSF_I2S_DATA_BITLEN_16          = (0x01ul << 1),
    VSF_I2S_DATA_BITLEN_24          = (0x02ul << 1),
    VSF_I2S_DATA_BITLEN_32          = (0x03ul << 1),
 
    VSF_I2S_FRAME_BITLEN_16         = (0x01ul << 3),
    VSF_I2S_FRAME_BITLEN_24         = (0x02ul << 3),
    VSF_I2S_FRAME_BITLEN_32         = (0x03ul << 3),
 
    VSF_I2S_STANDARD_PHILIPS        = (0x01ul << 5),
    VSF_I2S_STANDARD_MSB            = (0x02ul << 5),
    VSF_I2S_STANDARD_LSB            = (0x03ul << 5),
 
    VSF_I2S_LRCK_POL                = (0x01ul << 7),
    VSF_I2S_BCK_POL                 = (0x01ul << 8),
    VSF_I2S_MCLK_OUTPUT             = (0x01ul << 9),
} vsf_i2s_mode_t