VSF Documented
vsf_template_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 specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_TEMPLATE_FLASH_H__
19#define __VSF_TEMPLATE_FLASH_H__
20
21/*============================ INCLUDES ======================================*/
22
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ MACROS ========================================*/
31/*============================ MACROFIED FUNCTIONS ===========================*/
32
40#ifndef VSF_FLASH_CFG_MULTI_CLASS
41# define VSF_FLASH_CFG_MULTI_CLASS ENABLED
42#endif
43
51#if defined(VSF_HW_FLASH_COUNT) && !defined(VSF_HW_FLASH_MASK)
52# define VSF_HW_FLASH_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_FLASH_COUNT)
53#endif
54
62#if defined(VSF_HW_FLASH_MASK) && !defined(VSF_HW_FLASH_COUNT)
63# define VSF_HW_FLASH_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_FLASH_MASK)
64#endif
65
75#ifndef VSF_FLASH_CFG_PREFIX
76# if VSF_FLASH_CFG_MULTI_CLASS == ENABLED
77# define VSF_FLASH_CFG_PREFIX vsf
78# elif defined(VSF_HW_FLASH_COUNT) && (VSF_HW_FLASH_COUNT != 0)
79# define VSF_FLASH_CFG_PREFIX vsf_hw
80# else
81# define VSF_FLASH_CFG_PREFIX vsf
82# endif
83#endif
84
94#ifndef VSF_FLASH_CFG_FUNCTION_RENAME
95# define VSF_FLASH_CFG_FUNCTION_RENAME ENABLED
96#endif
97
105#ifndef VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK
106# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
107#endif
108
116#ifndef VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE
117# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE DISABLED
118#endif
119
127#ifndef VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS
128# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
129#endif
130
140#ifndef VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG
141# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG DISABLED
142#endif
143
153#ifndef VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY
154# define VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
155#endif
156
164#ifndef VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY
165# define VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY ENABLED
166#endif
167
168/*============================ MACROFIED FUNCTIONS ===========================*/
169
170#define VSF_FLASH_APIS(__prefix_name) \
171 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, init, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_cfg_t *cfg_ptr) \
172 __VSF_HAL_TEMPLATE_API(__prefix_name, void, flash, fini, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
173 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, get_configuration, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_cfg_t *cfg_ptr) \
174 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, flash, enable, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
175 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, flash, disable, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
176 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_flash_status_t, flash, status, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
177 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_flash_capability_t, flash, capability, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
178 __VSF_HAL_TEMPLATE_API(__prefix_name, void, flash, irq_enable, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_irq_mask_t irq_mask) \
179 __VSF_HAL_TEMPLATE_API(__prefix_name, void, flash, irq_disable, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_irq_mask_t irq_mask) \
180 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, erase_one_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes) \
181 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, erase_multi_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes, vsf_flash_size_t size_of_bytes) \
182 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, erase_all, VSF_MCONNECT(__prefix_name, _t) *flash_ptr) \
183 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, write_one_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t* buffer, vsf_flash_size_t size_of_bytes) \
184 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, write_multi_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t* buffer, vsf_flash_size_t size_of_bytes) \
185 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, read_one_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t* buffer, vsf_flash_size_t size_of_bytes) \
186 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, flash, read_multi_sector, VSF_MCONNECT(__prefix_name, _t) *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t* buffer, vsf_flash_size_t size_of_bytes)
187
188/*============================ TYPES =========================================*/
189
190#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
201 VSF_FLASH_IRQ_READ_MASK = (0x1ul << 2),
202
207#endif
208
209enum {
217};
218
219#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_FLASH_SIZE == DISABLED
221#endif
222
223#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
232typedef void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr,
234typedef struct vsf_flash_isr_t {
239typedef struct vsf_flash_cfg_t {
242#endif
243
244#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
252typedef struct vsf_flash_status_t {
253 union {
255 struct {
256 uint32_t is_busy : 1;
257 };
258 };
260#endif
261
262#if VSF_FLASH_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
264#if VSF_FLASH_CFG_INHERIT_HAL_CAPABILITY == ENABLED
266#endif
268
273 struct {
274 // Some flash allow only full sectors to be write or read
277 };
279#endif
280
281typedef struct vsf_flash_op_t {
283#undef __VSF_HAL_TEMPLATE_API
284#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
286
287 VSF_FLASH_APIS(vsf_flash)
289
290#if VSF_FLASH_CFG_MULTI_CLASS == ENABLED
293};
294#endif
295
296/*============================ GLOBAL VARIABLES ==============================*/
297/*============================ PROTOTYPES ====================================*/
298
318extern vsf_err_t vsf_flash_init(vsf_flash_t *flash_ptr, vsf_flash_cfg_t *cfg_ptr);
319
331extern void vsf_flash_fini(vsf_flash_t *flash_ptr);
332
351
363extern fsm_rt_t vsf_flash_enable(vsf_flash_t *flash_ptr);
364
376extern fsm_rt_t vsf_flash_disable(vsf_flash_t *flash_ptr);
377
390
403
404
421
436
452 vsf_flash_size_t offset_of_bytes);
453
472 vsf_flash_size_t offset_of_bytes,
473 vsf_flash_size_t size_of_bytes);
474
486extern vsf_err_t vsf_flash_erase_all(vsf_flash_t *flash_ptr);
487
488
508 vsf_flash_size_t offset_of_bytes,
509 uint8_t* buffer,
510 vsf_flash_size_t size_of_bytes);
511
531 vsf_flash_size_t offset_of_bytes,
532 uint8_t* buffer,
533 vsf_flash_size_t size_of_bytes);
534
554 vsf_flash_size_t offset_of_bytes,
555 uint8_t* buffer,
556 vsf_flash_size_t size_of_bytes);
557
577 vsf_flash_size_t offset_of_bytes,
578 uint8_t* buffer,
579 vsf_flash_size_t size_of_bytes);
580
581/*============================ MACROFIED FUNCTIONS ===========================*/
582
584#if VSF_FLASH_CFG_FUNCTION_RENAME == ENABLED
585# define __vsf_flash_t VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_t)
586# define vsf_flash_init(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_init) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
587# define vsf_flash_fini(__FLASH) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_fini) ((__vsf_flash_t *)(__FLASH))
588# define vsf_flash_get_configuration(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_get_configuration) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
589# define vsf_flash_enable(__FLASH) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_enable) ((__vsf_flash_t *)(__FLASH))
590# define vsf_flash_disable(__FLASH) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_disable) ((__vsf_flash_t *)(__FLASH))
591# define vsf_flash_capability(__FLASH) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_capability) ((__vsf_flash_t *)(__FLASH))
592# define vsf_flash_status(__FLASH) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_status) ((__vsf_flash_t *)(__FLASH))
593# define vsf_flash_irq_enable(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_irq_enable) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
594# define vsf_flash_irq_disable(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_irq_disable) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
595# define vsf_flash_erase_one_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_erase_one_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
596# define vsf_flash_erase_multi_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_erase_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
597# define vsf_flash_erase(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_erase_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
598# define vsf_flash_erase_all(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_erase_all) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
599# define vsf_flash_write_one_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_write_one_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
600# define vsf_flash_write_multi_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_write_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
601# define vsf_flash_write(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_write_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
602# define vsf_flash_read_one_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_read_one_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
603# define vsf_flash_read_multi_sector(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_read_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
604# define vsf_flash_read(__FLASH, ...) VSF_MCONNECT(VSF_FLASH_CFG_PREFIX, _flash_read_multi_sector) ((__vsf_flash_t *)(__FLASH), ##__VA_ARGS__)
605#endif
607
608#ifdef __cplusplus
609}
610#endif
611
612#endif /*__VSF_TEMPLATE_FLASH_H__*/
vsf_err_t
Definition __type.h:42
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
Definition vsf_template_flash.h:281
Flash status structure that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:252
Definition vsf_template_flash.h:291
const vsf_flash_op_t * op
Definition vsf_template_flash.h:292
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
fsm_rt_t
Definition vsf_fsm.h:315
vsf_err_t vsf_flash_init(vsf_flash_t *flash_ptr, vsf_flash_cfg_t *cfg_ptr)
Initialize a FLASH instance.
Definition flash_common.c:38
#define VSF_FLASH_APIS(__prefix_name)
Definition vsf_template_flash.h:170
vsf_err_t vsf_flash_read_one_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t *buffer, vsf_flash_size_t size_of_bytes)
flash read one sector
Definition flash_common.c:155
vsf_err_t vsf_flash_write_multi_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t *buffer, vsf_flash_size_t size_of_bytes)
Flash write multi sector.
Definition flash_common.c:146
vsf_flash_irq_mask_t
Predefined VSF Flash interrupts that can be reimplemented in specific HAL drivers.
Definition vsf_template_flash.h:198
@ VSF_FLASH_IRQ_ERASE_MASK
Erase operation complete.
Definition vsf_template_flash.h:199
@ VSF_FLASH_IRQ_READ_MASK
Read operation complete.
Definition vsf_template_flash.h:201
@ VSF_FLASH_IRQ_WRITE_ERROR_MASK
Write operation error.
Definition vsf_template_flash.h:204
@ VSF_FLASH_IRQ_WRITE_MASK
Write operation complete.
Definition vsf_template_flash.h:200
@ VSF_FLASH_IRQ_ERASE_ERROR_MASK
Erase operation error.
Definition vsf_template_flash.h:203
@ VSF_FLASH_IRQ_READ_ERROR_MASK
Read operation error.
Definition vsf_template_flash.h:205
void vsf_flash_isr_handler_t(void *target_ptr, vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t mask)
Definition vsf_template_flash.h:232
vsf_err_t vsf_flash_read_multi_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t *buffer, vsf_flash_size_t size_of_bytes)
flash read multi sector
Definition flash_common.c:164
vsf_err_t vsf_flash_erase_all(vsf_flash_t *flash_ptr)
Flash chip erase.
Definition flash_common.c:128
vsf_err_t vsf_flash_erase_multi_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes, vsf_flash_size_t size_of_bytes)
Flash erase a continuous range.
Definition flash_common.c:119
vsf_flash_status_t vsf_flash_status(vsf_flash_t *flash_ptr)
Get the status of FLASH instance.
Definition flash_common.c:92
fsm_rt_t vsf_flash_disable(vsf_flash_t *flash_ptr)
Disable a FLASH instance.
Definition flash_common.c:65
vsf_err_t vsf_flash_erase_one_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes)
FLASH erase one sector.
Definition flash_common.c:110
@ VSF_FLASH_IRQ_COUNT
Definition vsf_template_flash.h:210
@ VSF_FLASH_IRQ_ALL_BITS_MASK
Definition vsf_template_flash.h:211
vsf_err_t vsf_flash_get_configuration(vsf_flash_t *flash_ptr, vsf_flash_cfg_t *cfg_ptr)
Get current configuration of a FLASH instance.
Definition flash_common.c:173
vsf_flash_capability_t vsf_flash_capability(vsf_flash_t *flash_ptr)
Get the capabilities of FLASH instance.
Definition flash_common.c:101
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
fsm_rt_t vsf_flash_enable(vsf_flash_t *flash_ptr)
Enable a FLASH instance.
Definition flash_common.c:56
struct vsf_flash_status_t vsf_flash_status_t
Flash status structure that can be reimplemented in specific HAL drivers.
uint_fast32_t vsf_flash_size_t
Definition vsf_template_flash.h:220
void vsf_flash_fini(vsf_flash_t *flash_ptr)
Finalize a FLASH instance.
Definition flash_common.c:47
void vsf_flash_irq_disable(vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t irq_mask)
Disable interrupt masks of FLASH instance.
Definition flash_common.c:83
void vsf_flash_irq_enable(vsf_flash_t *flash_ptr, vsf_flash_irq_mask_t irq_mask)
Enable interrupt masks of FLASH instance.
Definition flash_common.c:74
vsf_err_t vsf_flash_write_one_sector(vsf_flash_t *flash_ptr, vsf_flash_size_t offset_of_bytes, uint8_t *buffer, vsf_flash_size_t size_of_bytes)
Flash write one sector.
Definition flash_common.c:137
Generated from commit: vsfteam/vsf@74aa6ce