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 2010 Develer S.r.l. (http://www.develer.com/)
33 * \brief STM32F103xx internal flash memory driver.
35 * \author Daniele Basile <asterix@develer.com>
38 #include "flash_stm32.h"
40 #include "cfg/cfg_emb_flash.h"
42 // Define log settings for cfg/log.h
43 #define LOG_LEVEL CONFIG_FLASH_EMB_LOG_LEVEL
44 #define LOG_FORMAT CONFIG_FLASH_EMB_LOG_FORMAT
47 #include <drv/timer.h>
48 #include <drv/flash.h>
50 #include <cpu/power.h>
51 #include <cpu/detect.h>
57 #define EMB_FLASH ((struct stm32_flash*)FLASH_R_BASE)
64 static bool flash_wait(struct KBlock *blk)
66 Flash *fls = FLASH_CAST(blk);
67 ticks_t start = timer_clock();
71 if (!(EMB_FLASH->SR & FLASH_FLAG_BSY))
74 if (EMB_FLASH->SR & FLASH_FLAG_PGERR)
76 fls->hw->status |= FLASH_NOT_ERASED;
77 LOG_ERR("flash not erased..\n");
81 if (EMB_FLASH->SR & FLASH_FLAG_WRPRTERR)
83 fls->hw->status |= FLASH_WR_PROTECT;
84 LOG_ERR("wr protect..\n");
88 if (timer_clock() - start > ms_to_ticks(CONFIG_FLASH_WR_TIMEOUT))
90 fls->hw->status |= FLASH_WR_TIMEOUT;
91 LOG_ERR("Timeout..\n");
99 static bool stm32_erasePage(struct KBlock *blk, uint32_t page_add)
102 EMB_FLASH->CR |= CR_PER_SET;
103 EMB_FLASH->AR = page_add;
104 EMB_FLASH->CR |= CR_STRT_SET;
106 if (!flash_wait(blk))
109 EMB_FLASH->CR &= CR_PER_RESET;
116 static bool stm32_eraseAll(struct KBlock *blk)
118 EMB_FLASH->CR |= CR_MER_SET;
119 EMB_FLASH->CR |= CR_STRT_SET;
121 if (!flash_wait(blk))
124 EMB_FLASH->CR &= CR_MER_RESET;
130 static int stm32_flash_error(struct KBlock *blk)
132 Flash *fls = FLASH_CAST(blk);
133 return fls->hw->status;
136 static void stm32_flash_clearerror(struct KBlock *blk)
138 Flash *fls = FLASH_CAST(blk);
142 static size_t stm32_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
144 memcpy(buf, (void *)(idx * blk->blk_size + offset), size);
149 INLINE bool stm32_writeWord(struct KBlock *blk, uint32_t addr, uint16_t data)
153 EMB_FLASH->CR |= CR_PG_SET;
155 *(reg16_t *)addr = data;
157 if (!flash_wait(blk))
160 EMB_FLASH->CR &= CR_PG_RESET;
165 static size_t stm32_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
168 ASSERT(size == blk->blk_size);
170 if (!stm32_erasePage(blk, (idx * blk->blk_size)))
173 uint32_t addr = idx * blk->blk_size;
174 const uint8_t *buf = (const uint8_t *)_buf;
178 uint16_t data = (*(buf + 1) << 8) | *buf;
179 if (!stm32_writeWord(blk, addr, data))
187 return blk->blk_size;
190 static const KBlockVTable flash_stm32_buffered_vt =
192 .readDirect = stm32_flash_readDirect,
193 .writeDirect = stm32_flash_writeDirect,
195 .readBuf = kblock_swReadBuf,
196 .writeBuf = kblock_swWriteBuf,
197 .load = kblock_swLoad,
198 .store = kblock_swStore,
200 .close = kblock_swClose,
202 .error = stm32_flash_error,
203 .clearerr = stm32_flash_clearerror,
206 static const KBlockVTable flash_stm32_unbuffered_vt =
208 .readDirect = stm32_flash_readDirect,
209 .writeDirect = stm32_flash_writeDirect,
211 .close = kblock_swClose,
213 .error = stm32_flash_error,
214 .clearerr = stm32_flash_clearerror,
217 static struct FlashHardware flash_stm32_hw;
218 static uint8_t flash_buf[FLASH_PAGE_SIZE];
220 static void common_init(Flash *fls)
222 memset(fls, 0, sizeof(*fls));
223 DB(fls->blk.priv.type = KBT_FLASH);
225 fls->hw = &flash_stm32_hw;
227 fls->blk.blk_size = FLASH_PAGE_SIZE;
228 fls->blk.blk_cnt = (F_SIZE * 1024) / FLASH_PAGE_SIZE;
230 /* Unlock flash memory for the FPEC Access */
231 EMB_FLASH->KEYR = FLASH_KEY1;
232 EMB_FLASH->KEYR = FLASH_KEY2;
236 void flash_hw_init(Flash *fls, UNUSED_ARG(int, flags))
239 fls->blk.priv.vt = &flash_stm32_buffered_vt;
240 fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
241 fls->blk.priv.buf = flash_buf;
243 /* Load the first block in the cache */
244 void *flash_start = 0x0;
245 memcpy(fls->blk.priv.buf, flash_start, fls->blk.blk_size);
248 void flash_hw_initUnbuffered(Flash *fls, UNUSED_ARG(int, flags))
251 fls->blk.priv.vt = &flash_stm32_unbuffered_vt;