VSF Documented
flash.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the flashecific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __HAL_DRIVER_NATIONS_N32H76X_N32H78X_FLASH_H__
19#define __HAL_DRIVER_NATIONS_N32H76X_N32H78X_FLASH_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_FLASH == ENABLED
26
27/*\note Refer to template/README.md for usage cases.
28 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
29 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
30 * For emulated drivers, **** No reimplementation ****.
31 */
32
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37/*============================ MACROS ========================================*/
38
39// HW
40/*\note hw FLASH driver can reimplement following types:
41 * To enable reimplementation, please enable macro below:
42 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE for vsf_flash_mode_t
43 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS for vsf_flash_status_t
44 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_flash_irq_mask_t
45 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL for vsf_flash_ctrl_t
46 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG for vsf_flash_cfg_t
47 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_flash_capability_t
48 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
49 * *** DO NOT reimplement these in emulated drivers. ***
50 */
51
52#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE DISABLED
53#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
54#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
55#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL DISABLED
56#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG DISABLED
57#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
58
59#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
60# undef VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE
61# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE ENABLED
62#endif
63// HW end
64
65/*============================ TYPES =========================================*/
66
67// HW/IPCore, not for emulated drivers
68#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
77#endif
78
79#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE == ENABLED
81#endif
82
83#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
84typedef struct vsf_flash_t vsf_flash_t;
85typedef void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask);
86typedef struct vsf_flash_isr_t {
88 void *target_ptr;
91typedef struct vsf_flash_cfg_t {
94#endif
95
96#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
97typedef struct vsf_flash_status_t {
98 union {
100 struct {
101 uint32_t is_busy : 1;
102 };
103 };
105#endif
106
107#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
108typedef struct vsf_flash_capability_t {
109#if VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
111#endif
117 struct {
120 };
122#endif
123// HW/IPCore end
124
125/*============================ GLOBAL VARIABLES ==============================*/
126/*============================ PROTOTYPES ====================================*/
127
128#ifdef __cplusplus
129}
130#endif
131
132#endif // VSF_HAL_USE_FLASH
133#endif // __HAL_DRIVER_NATIONS_N32H76X_N32H78X_FLASH_H__
134/* EOF */
vsf_flash_irq_mask_t
Definition flash.h:47
@ VSF_FLASH_IRQ_ERASE_MASK
Definition flash.h:49
@ VSF_FLASH_IRQ_READ_MASK
Definition flash.h:53
@ VSF_FLASH_IRQ_WRITE_ERROR_MASK
Definition flash.h:58
@ VSF_FLASH_IRQ_WRITE_MASK
Definition flash.h:51
@ VSF_FLASH_IRQ_ERASE_ERROR_MASK
Definition flash.h:56
@ VSF_FLASH_IRQ_READ_ERROR_MASK
Definition flash.h:60
void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)
Definition flash.h:85
struct vsf_flash_capability_t vsf_flash_capability_t
struct vsf_flash_cfg_t vsf_flash_cfg_t
struct vsf_flash_isr_t vsf_flash_isr_t
struct vsf_flash_status_t vsf_flash_status_t
uint_fast32_t vsf_flash_size_t
Definition flash.h:80
vsf_arch_prio_t
Definition cortex_a_generic.h:88
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
unsigned uint32_t
Definition stdint.h:9
unsigned int uint_fast32_t
Definition stdint.h:27
unsigned char uint8_t
Definition stdint.h:5
Definition vsf_template_flash.h:263
vsf_flash_size_t max_size
Definition vsf_template_flash.h:270
uint8_t none_sector_aligned_read
Definition vsf_template_flash.h:276
vsf_flash_size_t write_sector_size
Definition vsf_template_flash.h:272
inherit(vsf_peripheral_capability_t) vsf_flash_irq_mask_t irq_mask
vsf_flash_size_t base_address
Definition vsf_template_flash.h:269
vsf_flash_size_t erase_sector_size
Definition vsf_template_flash.h:271
uint8_t none_sector_aligned_write
Definition vsf_template_flash.h:275
Definition vsf_template_flash.h:239
vsf_flash_isr_t isr
Interrupt configuration.
Definition vsf_template_flash.h:240
Definition vsf_template_flash.h:234
vsf_flash_isr_handler_t * handler_fn
Interrupt handler function.
Definition vsf_template_flash.h:235
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_flash.h:237
void * target_ptr
User target pointer.
Definition vsf_template_flash.h:236
Flash status structure that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:252
Definition vsf_template_flash.h:291
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
vsf_flash_irq_mask_t
Definition flash.h:120
void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)
Definition flash.h:136
uint_fast32_t vsf_flash_size_t
Definition flash.h:131
vsf_flash_irq_mask_t
Predefined VSF Flash interrupts that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:198
Generated from commit: vsfteam/vsf@74aa6ce