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 LM3S1968 internal flash memory driver.
35 * \author Andrea Righi <arighi@develer.com>
38 #include "flash_lm3s.h"
41 #include <cfg/macros.h>
43 #include <io/kblock.h>
45 #include <drv/timer.h>
46 #include <drv/flash.h>
48 #include <cpu/power.h> /* cpu_relax() */
49 #include <cpu/types.h>
51 #include <string.h> /* memcpy() */
58 static bool flash_wait(struct KBlock *blk)
60 Flash *fls = FLASH_CAST(blk);
61 ticks_t start = timer_clock();
64 if (!(FLASH_FMC_R & FLASH_FMC_ERASE))
67 if (FLASH_FCRIS_R & FLASH_FCRIS_ARIS)
69 fls->hw->status |= FLASH_WR_PROTECT;
70 LOG_ERR("wr protect..\n");
74 if (timer_clock() - start > ms_to_ticks(CONFIG_FLASH_WR_TIMEOUT))
76 fls->hw->status |= FLASH_WR_TIMEOUT;
77 LOG_ERR("Timeout..\n");
87 static int lm3s_erasePage(struct KBlock *blk, uint32_t addr)
89 FLASH_FCMISC_R = FLASH_FCMISC_AMISC;
91 FLASH_FMA_R = (volatile uint32_t)addr;
92 FLASH_FMC_R = FLASH_FMC_WRKEY | FLASH_FMC_ERASE;
94 return flash_wait(blk);
97 static int lm3s_writeWord(struct KBlock *blk, uint32_t addr, uint32_t data)
99 FLASH_FCMISC_R = FLASH_FCMISC_AMISC;
101 FLASH_FMA_R = (volatile uint32_t)addr;
102 FLASH_FMD_R = (volatile uint32_t)data;
103 FLASH_FMC_R = FLASH_FMC_WRKEY | FLASH_FMC_WRITE;
105 return flash_wait(blk);
108 static size_t lm3s_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
110 memcpy(buf, (void *)(idx * blk->blk_size + offset), size);
114 static size_t lm3s_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
117 ASSERT(size == blk->blk_size);
119 if (!lm3s_erasePage(blk, (idx * blk->blk_size)))
122 uint32_t addr = idx * blk->blk_size;
123 const uint8_t *buf = (const uint8_t *)_buf;
127 uint32_t data = (*(buf + 3) << 24) |
132 if (!lm3s_writeWord(blk, addr, data))
140 return blk->blk_size;
143 static int lm3s_flash_error(struct KBlock *blk)
145 Flash *fls = FLASH_CAST(blk);
146 return fls->hw->status;
149 static void lm3s_flash_clearerror(struct KBlock *blk)
151 Flash *fls = FLASH_CAST(blk);
155 static const KBlockVTable flash_lm3s_buffered_vt =
157 .readDirect = lm3s_flash_readDirect,
158 .writeDirect = lm3s_flash_writeDirect,
160 .readBuf = kblock_swReadBuf,
161 .writeBuf = kblock_swWriteBuf,
162 .load = kblock_swLoad,
163 .store = kblock_swStore,
165 .error = lm3s_flash_error,
166 .clearerr = lm3s_flash_clearerror,
169 static const KBlockVTable flash_lm3s_unbuffered_vt =
171 .readDirect = lm3s_flash_readDirect,
172 .writeDirect = lm3s_flash_writeDirect,
174 .error = lm3s_flash_error,
175 .clearerr = lm3s_flash_clearerror,
178 /* Flash memory mapping */
180 #define EMB_FLASH_SIZE 0x40000 //< 256KiB
181 #define EMB_FLASH_PAGE_SIZE 0x400 //< 1KiB
186 static struct FlashHardware flash_lm3s_hw;
187 static uint8_t flash_buf[EMB_FLASH_PAGE_SIZE];
189 static void common_init(Flash *fls)
191 memset(fls, 0, sizeof(*fls));
192 DB(fls->blk.priv.type = KBT_FLASH);
194 FLASH_USECRL_R = CPU_FREQ / 1000000 - 1;
196 fls->hw = &flash_lm3s_hw;
198 fls->blk.blk_size = EMB_FLASH_PAGE_SIZE;
199 fls->blk.blk_cnt = EMB_FLASH_SIZE / EMB_FLASH_PAGE_SIZE;
203 void flash_hw_init(Flash *fls)
206 fls->blk.priv.vt = &flash_lm3s_buffered_vt;
207 fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
208 fls->blk.priv.buf = flash_buf;
211 void flash_hw_initUnbuffered(Flash *fls)
214 fls->blk.priv.vt = &flash_lm3s_unbuffered_vt;