flash.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_flash_isr_t
struct	vsf_flash_cfg_t
struct	vsf_flash_status_t
	Flash status structure that can be reimplemented in specific HAL drivers. More...
struct	vsf_flash_capability_t

Macros
#define	__HAL_DRIVER_   ${SERIES/FLASH_IP}_FLASH_H__
#define	VSF_   ${FLASH_IP}_FLASH_CFG_MULTI_CLASS VSF_FLASH_CFG_MULTI_CLASS
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE   ENABLED
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG   ENABLED
#define	VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedefs
typedef enum vsf_flash_irq_mask_t	vsf_flash_irq_mask_t
typedef uint_fast32_t	vsf_flash_size_t
typedef struct vsf_flash_t	vsf_flash_t
typedef void	vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)
typedef struct vsf_flash_isr_t	vsf_flash_isr_t
typedef struct vsf_flash_cfg_t	vsf_flash_cfg_t
typedef struct vsf_flash_status_t	vsf_flash_status_t
typedef struct vsf_flash_capability_t	vsf_flash_capability_t

Enumerations
enum	vsf_flash_irq_mask_t {   VSF_FLASH_IRQ_ERASE_MASK = (0x1ul << 0) ,   VSF_FLASH_IRQ_WRITE_MASK = (0x1ul << 1) ,   VSF_FLASH_IRQ_READ_MASK = (0x1ul << 2) ,   VSF_FLASH_IRQ_ERASE_ERROR_MASK = (0x1ul << 3) ,   VSF_FLASH_IRQ_WRITE_ERROR_MASK = (0x1ul << 4) ,   VSF_FLASH_IRQ_READ_ERROR_MASK = (0x1ul << 5) }

Variables
class vsf_$ *	reg
vsf_flash_isr_t	isr

Macro Definition Documentation

__HAL_DRIVER_

#define __HAL_DRIVER_   ${SERIES/FLASH_IP}_FLASH_H__

VSF_

#define VSF_   ${FLASH_IP}_FLASH_CFG_MULTI_CLASS VSF_FLASH_CFG_MULTI_CLASS

Note

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

VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE   ENABLED

VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS   ENABLED

VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK   ENABLED

VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL   ENABLED

VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG   ENABLED

VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY

#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY   ENABLED

Typedef Documentation

vsf_flash_irq_mask_t

typedef enum vsf_flash_irq_mask_t vsf_flash_irq_mask_t

vsf_flash_size_t

typedef uint_fast32_t vsf_flash_size_t

vsf_flash_t

typedef struct vsf_flash_t vsf_flash_t

vsf_flash_isr_handler_t

typedef void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)

vsf_flash_isr_t

typedef struct vsf_flash_isr_t vsf_flash_isr_t

vsf_flash_cfg_t

typedef struct vsf_flash_cfg_t vsf_flash_cfg_t

vsf_flash_status_t

typedef struct vsf_flash_status_t vsf_flash_status_t

vsf_flash_capability_t

typedef struct vsf_flash_capability_t vsf_flash_capability_t

Enumeration Type Documentation

vsf_flash_irq_mask_t

enum vsf_flash_irq_mask_t

Enumerator
VSF_FLASH_IRQ_ERASE_MASK
VSF_FLASH_IRQ_WRITE_MASK
VSF_FLASH_IRQ_READ_MASK
VSF_FLASH_IRQ_ERASE_ERROR_MASK
VSF_FLASH_IRQ_WRITE_ERROR_MASK
VSF_FLASH_IRQ_READ_ERROR_MASK

Variable Documentation

reg

class vsf_$* reg

isr

vsf_flash_isr_t isr