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_${SERIES/FLASH_IP}_FLASH_H__
19#define __HAL_DRIVER_${SERIES/FLASH_IP}_FLASH_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "hal/vsf_hal_cfg.h"
24
25#if VSF_HAL_USE_FLASH == ENABLED
26
27// HW/IPCore
32// HW/IPCore end
33
34#include "../../__device.h"
35
36/*\note Refer to template/README.md for usage cases.
37 * For peripheral drivers, blackbox mode is recommended but not required, reimplementation part MUST be open.
38 * For IPCore drivers, class structure, MULTI_CLASS configuration, reimplementation and class APIs should be open to user.
39 * For emulated drivers, **** No reimplementation ****.
40 */
41
42/*\note Includes CAN ONLY be put here. */
43/*\note If current header is for a peripheral driver(hw driver), and inherit from an IPCore driver, include IPCore header here. */
44
45// IPCore
46#if defined(__VSF_HAL_${FLASH_IP}_FLASH_CLASS_IMPLEMENT)
47# define __VSF_CLASS_IMPLEMENT__
48#elif defined(__VSF_HAL_${FLASH_IP}_FLASH_CLASS_INHERIT__)
49# define __VSF_CLASS_INHERIT__
50#endif
51
52#include "utilities/ooc_class.h"
53// IPCore end
54
55#ifdef __cplusplus
56extern "C" {
57#endif
58
59/*============================ MACROS ========================================*/
60
61/*\note VSF_${FLASH_IP}_FLASH_CFG_MULTI_CLASS should be implemented for IP drives and open to user,
62 * while VSF_HW_FLASH_CFG_MULTI_CLASS should be in flash.c.
63 */
64
65// IPCore
66#ifndef VSF_${FLASH_IP}_FLASH_CFG_MULTI_CLASS
67# define VSF_${FLASH_IP}_FLASH_CFG_MULTI_CLASS VSF_FLASH_CFG_MULTI_CLASS
68#endif
69// IPCore end
70
71// HW
72/*\note hw FLASH driver can reimplement following types:
73 * To enable reimplementation, please enable macro below:
74 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE for vsf_flash_mode_t
75 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS for vsf_flash_status_t
76 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK for vsf_flash_irq_mask_t
77 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL for vsf_flash_ctrl_t
78 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG for vsf_flash_cfg_t
79 * VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY for vsf_flash_capability_t
80 * Reimplementation is used for optimization hw/IPCore drivers, reimplement the bit mask according to hw registers.
81 * *** DO NOT reimplement these in emulated drivers. ***
82 */
83
84#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_MODE ENABLED
85#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS ENABLED
86#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK ENABLED
87#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CTRL ENABLED
88#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG ENABLED
89#define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY ENABLED
90// HW end
91
92/*============================ TYPES =========================================*/
93
94// IPCore
95vsf_class(vsf_${flash_ip}_flash_t) {
96#if VSF_${FLASH_IP}_CFG_MULTI_CLASS == ENABLED
97 public_member(
98 vsf_flash_t vsf_flash;
99 )
100#endif
101
102/*\note You can add more member in vsf_${flash_ip}_flash_t instance.
103 * For members accessible from child, put in protected_member.
104 * Else, put in private_member.
105 */
106
107 protected_member(
108 vsf_${flash_ip}_flash_reg_t *reg;
111};
112// IPCore end
113
114// HW/IPCore, not for emulated drivers
115#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == ENABLED
124#endif
125
126#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE == ENABLED
128#endif
129
130#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG == ENABLED
132typedef void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask);
133typedef struct vsf_flash_isr_t {
135 void *target_ptr;
138typedef struct vsf_flash_cfg_t {
141#endif
142
143#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS == ENABLED
144typedef struct vsf_flash_status_t {
145 union {
147 struct {
148 uint32_t is_busy : 1;
149 };
150 };
152#endif
153
154#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY == ENABLED
155typedef struct vsf_flash_capability_t {
156#if VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
158#endif
164 struct {
167 };
169#endif
170// HW/IPCore end
171
172/*============================ GLOBAL VARIABLES ==============================*/
173/*============================ PROTOTYPES ====================================*/
174
175// IPCore
176/*\note Extern APIs for ip core diriver.
177 * There is no requirement about how APIs of IPCore drivers should be implemented.
178 * Just consider the simplicity for actual peripheral drivers.
179 */
180// IPCore end
181
182#ifdef __cplusplus
183}
184#endif
185
186// IPCore
187#undef __VSF_HAL_${FLASH_IP}_FLASH_CLASS_IMPLEMENT
188#undef __VSF_HAL_${FLASH_IP}_FLASH_CLASS_INHERIT__
189// IPCore end
190
191#endif // VSF_HAL_USE_FLASH
192#endif // __HAL_DRIVER_${SERIES/FLASH_IP}_FLASH_H__
193/* 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
Definition adc.h:94
vsf_arch_prio_t
Definition cortex_a_generic.h:88
#define vsf_class(__name)
Definition ooc_class.h:48
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:262
vsf_flash_size_t max_size
Definition vsf_template_flash.h:269
uint8_t none_sector_aligned_read
Definition vsf_template_flash.h:275
vsf_flash_size_t write_sector_size
Definition vsf_template_flash.h:271
inherit(vsf_peripheral_capability_t) vsf_flash_irq_mask_t irq_mask
vsf_flash_size_t base_address
Definition vsf_template_flash.h:268
vsf_flash_size_t erase_sector_size
Definition vsf_template_flash.h:270
uint8_t none_sector_aligned_write
Definition vsf_template_flash.h:274
Definition vsf_template_flash.h:238
vsf_flash_isr_t isr
Interrupt configuration.
Definition vsf_template_flash.h:239
Definition vsf_template_flash.h:233
vsf_flash_isr_handler_t * handler_fn
Interrupt handler function.
Definition vsf_template_flash.h:234
vsf_arch_prio_t prio
Interrupt priority.
Definition vsf_template_flash.h:236
void * target_ptr
User target pointer.
Definition vsf_template_flash.h:235
Flash status structure that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:251
Definition vsf_template_flash.h:290
Definition vsf_template_hal_driver.h:203
Definition vsf_template_hal_driver.h:196
vsf_flash_irq_mask_t
Definition flash.h:116
void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)
Definition flash.h:132
vsf_flash_isr_t isr
Definition flash.h:110
class vsf_$ * reg
uint_fast32_t vsf_flash_size_t
Definition flash.h:127
vsf_flash_irq_mask_t
Predefined VSF Flash interrupts that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:197
Generated from commit: vsfteam/vsf@2b286be