4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
33 * \addtogroup drv_emb_flash
34 * \brief Embedded flash for cpu.
36 * This module allows to access in reading and writing to the internal
37 * flash memory of the micro. It is a block device, so it must be
38 * accessed using the KBlock interface functions (see kblock.h).
40 * Once you have opened the flash for writing, you may want to use
41 * kblock_trim() to avoid overwriting data on other flash banks.
46 * flash_init(&fls.blk, 0);
47 * // enable access only on desired blocks
48 * // start block = 50, num blocks = 20
49 * kblock_trim(&fls, 50, 20);
51 * // now write to the flash
52 * // block number is automatically converted
53 * kblock_write(&fls.blk, 0, buf, 0, 128);
56 * \author Francesco Sacchi <batt@develer.com>
57 * \author Daniele Basile <asterix@develer.com>
59 * $WIZ$ module_name = "flash"
60 * $WIZ$ module_depends = "kfile", "kfile_block", "kblock"
61 * $WIZ$ module_configuration = "bertos/cfg/cfg_emb_flash.h"
67 #include "cfg/cfg_emb_flash.h"
69 #include <cfg/macros.h>
70 #include <cfg/compiler.h>
72 #include <io/kblock.h>
74 #include <io/kfile_block.h>
79 * \defgroup drv_emb_flash Embedded flash driver
84 #define flash_init(...) PP_CAT(flash_init_, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
87 * Init function for flash driver.
89 * This macro cannot fail, so no error conditions are reported.
91 * This macro expands to
92 * - flash_init_2(Flash *fls, flags), the new KBlock API
93 * - flash_init_1(Flash *fls), old API, provided for compatibility
95 * Do NOT use the above functions directly, use flash_init() instead.
96 * Disable old API if you are not upgrading an existing project.
98 #define flash_init(args...) PP_CAT(flash_init_, COUNT_PARMS(args)) (args)
102 * \name Embedded flash error values
105 #define FLASH_WR_OK 0 ///< Write ok.
106 #define FLASH_NOT_ERASED BV(1) ///< Flash memory was not erased before to write it.
107 #define FLASH_WR_PROTECT BV(2) ///< Write not allowed the flash memory was protected.
108 #define FLASH_WR_TIMEOUT BV(3) ///< Timeout while writing
109 #define FLASH_WR_ERR BV(4) ///< Invalid command and/or a bad keywords
112 struct FlashHardware;
115 * EmbFlash KBlock context structure.
119 KBlock blk; ///< KBlock context
120 struct FlashHardware *hw;
121 #if !CONFIG_FLASH_DISABLE_OLD_API
126 #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
132 #define KBT_FLASH MAKE_ID('F', 'L', 'A', 'S')
135 * Convert + ASSERT from generic KBlock to Flash.
137 INLINE Flash *FLASH_CAST(KBlock *fls)
139 ASSERT(fls->priv.type == KBT_FLASH);
143 void flash_hw_init(Flash *fls, int flags);
144 void flash_hw_initUnbuffered(Flash *fls, int flags);
146 #include CPU_HEADER(flash)
149 * \name Flash init flags
152 #define FLASH_WRITE_ONCE BV(0) ///< Allow only one write per block.
153 #define FLASH_UNBUFFERED BV(1) ///< Open flash memory disabling page caching, no modification and partial write are allowed.
157 * Initialize \a fls Flash context structure.
158 * \param fls Flash context structure
159 * \param flags A combination of flash init flags
161 #define flash_init_2(fls, flags) (flags & FLASH_UNBUFFERED) ? \
162 flash_hw_initUnbuffered(fls, flags) : flash_hw_init(fls, flags)
164 #if !CONFIG_FLASH_DISABLE_OLD_API
165 INLINE DEPRECATED void flash_init_1(Flash *fls)
167 flash_hw_init(fls, 0);
168 kfileblock_init(&fls->fdblk, &fls->blk);
170 #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
174 #endif /* DRV_FLASH_H */