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 * \author Francesco Sacchi <batt@develer.com>
34 * \author Daniele Basile <asterix@develer.com>
36 * \brief NPX lpc23xx embedded flash read/write driver.
41 #include "flash_lpc2.h"
42 #include "cfg/cfg_emb_flash.h"
44 // Define log settings for cfg/log.h
45 #define LOG_LEVEL CONFIG_FLASH_EMB_LOG_LEVEL
46 #define LOG_FORMAT CONFIG_FLASH_EMB_LOG_FORMAT
48 #include <cfg/macros.h>
52 #include <cpu/power.h>
53 #include <cpu/types.h>
55 #include <io/kblock.h>
58 #include <drv/timer.h>
59 #include <drv/flash.h>
61 #include <struct/bitarray.h>
65 /* Embedded flash programming defines. */
66 #define IAP_ADDRESS 0x7ffffff1
68 typedef enum IapCommands
70 PREPARE_SECTOR_FOR_WRITE = 50,
71 COPY_RAM_TO_FLASH = 51,
73 BLANK_CHECK_SECTOR = 53,
81 #define FLASH_MEM_SIZE (504 * 1024L)
82 #define FLASH_PAGE_SIZE_BYTES 4096
83 #define FLASH_REAL_PAGE_CNT 28
96 #define FLASH_PAGE_CNT FLASH_MEM_SIZE / FLASH_PAGE_SIZE_BYTES
98 BITARRAY_ALLOC(page_dirty, FLASH_PAGE_CNT);
99 static BitArray lpc2_bitx;
101 uint8_t erase_group[] = {
103 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
104 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
106 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
107 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
109 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
110 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
112 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
113 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
115 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
116 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
118 32768 / FLASH_PAGE_SIZE_BYTES, 32768 / FLASH_PAGE_SIZE_BYTES,
119 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
121 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
122 4096 / FLASH_PAGE_SIZE_BYTES, 4096 / FLASH_PAGE_SIZE_BYTES,
125 typedef struct IapCmd
131 typedef struct IapRes
137 typedef void (*iap_callback_t)(IapCmd *, IapRes *);
139 iap_callback_t iap = (iap_callback_t)IAP_ADDRESS;
141 static size_t sector_size(uint32_t page)
154 static size_t sector_addr(uint32_t page)
159 return (page - 8) * 32768 + 4096 * 8;
161 return (page - 22) * 4096 + 32768 * 14 + 4096 * 8;
168 static uint32_t addr_to_sector(size_t addr)
172 else if (addr < 4096 * 8 + 32768L * 14)
173 return ((addr - 4096 * 8) / 32768) + 8;
174 else if (addr < 4096 * 8 + 32768L * 14 + 4096 * 6)
175 return ((addr - 4096 * 8 - 32768L * 14) / 4096) + 22;
181 static size_t lpc2_flash_readDirect(struct KBlock *blk, block_idx_t idx, void *buf, size_t offset, size_t size)
183 memcpy(buf, (void *)(idx * blk->blk_size + offset), size);
187 static size_t lpc2_flash_writeDirect(struct KBlock *blk, block_idx_t idx, const void *_buf, size_t offset, size_t size)
190 ASSERT(FLASH_PAGE_SIZE_BYTES == size);
192 Flash *fls = FLASH_CAST(blk);
193 if (!(fls->hw->flags & FLASH_WRITE_ONCE))
194 ASSERT(sector_size(idx) <= FLASH_PAGE_SIZE_BYTES);
196 const uint8_t *buf = (const uint8_t *)_buf;
199 //Compute page address of current page.
200 uint32_t addr = idx * blk->blk_size;
201 uint32_t sector = addr_to_sector(addr);
202 // Compute the first page index in the sector to manage the status
203 int idx_sector = sector_addr(sector) / blk->blk_size;
205 LOG_INFO("Writing page[%ld]sector[%ld]idx[%d]\n", idx, sector, idx_sector);
206 IRQ_SAVE_DISABLE(flags);
210 cmd.cmd = PREPARE_SECTOR_FOR_WRITE;
211 cmd.param[0] = cmd.param[1] = sector;
214 if (res.status != CMD_SUCCESS)
217 if ((fls->hw->flags & FLASH_WRITE_ONCE) &&
218 bitarray_isRangeFull(&lpc2_bitx, idx_sector, erase_group[sector]))
220 kputs("blocchi pieni\n");
226 if ((fls->hw->flags & FLASH_WRITE_ONCE) &&
227 bitarray_isRangeEmpty(&lpc2_bitx, idx_sector, erase_group[sector]))
230 if (!(fls->hw->flags & FLASH_WRITE_ONCE))
235 cmd.cmd = ERASE_SECTOR;
236 cmd.param[0] = cmd.param[1] = sector;
237 cmd.param[2] = CPU_FREQ / 1000;
240 if (res.status != CMD_SUCCESS)
244 LOG_INFO("Writing page [%ld], addr [%ld] in sector[%ld]\n", idx, addr, sector);
245 cmd.cmd = PREPARE_SECTOR_FOR_WRITE;
246 cmd.param[0] = cmd.param[1] = sector;
249 if (res.status != CMD_SUCCESS)
252 if (fls->hw->flags & FLASH_WRITE_ONCE)
254 if (bitarray_test(&lpc2_bitx, idx))
260 bitarray_set(&lpc2_bitx, idx);
263 cmd.cmd = COPY_RAM_TO_FLASH;
265 cmd.param[1] = (uint32_t)buf;
266 cmd.param[2] = FLASH_PAGE_SIZE_BYTES;
267 cmd.param[3] = CPU_FREQ / 1000;
270 if (res.status != CMD_SUCCESS)
276 return blk->blk_size;
280 LOG_ERR("%ld\n", res.status);
281 fls->hw->status |= FLASH_WR_ERR;
285 static int lpc2_flash_close(UNUSED_ARG(struct KBlock, *blk))
287 memset(page_dirty, 0, sizeof(page_dirty));
292 static int lpc2_flash_error(struct KBlock *blk)
294 Flash *fls = FLASH_CAST(blk);
295 return fls->hw->status;
298 static void lpc2_flash_clearerror(struct KBlock *blk)
300 Flash *fls = FLASH_CAST(blk);
304 static const KBlockVTable flash_lpc2_buffered_vt =
306 .readDirect = lpc2_flash_readDirect,
307 .writeDirect = lpc2_flash_writeDirect,
309 .readBuf = kblock_swReadBuf,
310 .writeBuf = kblock_swWriteBuf,
311 .load = kblock_swLoad,
312 .store = kblock_swStore,
314 .close = lpc2_flash_close,
316 .error = lpc2_flash_error,
317 .clearerr = lpc2_flash_clearerror,
320 static const KBlockVTable flash_lpc2_unbuffered_vt =
322 .readDirect = lpc2_flash_readDirect,
323 .writeDirect = lpc2_flash_writeDirect,
325 .close = lpc2_flash_close,
327 .error = lpc2_flash_error,
328 .clearerr = lpc2_flash_clearerror,
331 static struct FlashHardware flash_lpc2_hw;
332 static uint8_t flash_buf[FLASH_PAGE_SIZE_BYTES];
334 static void common_init(Flash *fls, int flags)
336 memset(fls, 0, sizeof(*fls));
337 DB(fls->blk.priv.type = KBT_FLASH);
339 fls->hw = &flash_lpc2_hw;
340 fls->hw->flags = flags;
342 fls->blk.blk_size = FLASH_PAGE_SIZE_BYTES;
343 fls->blk.blk_cnt = FLASH_MEM_SIZE / FLASH_PAGE_SIZE_BYTES;
345 bitarray_init(&lpc2_bitx, FLASH_PAGE_CNT, page_dirty, sizeof(page_dirty));
348 void flash_hw_init(Flash *fls, int flags)
350 common_init(fls, flags);
351 fls->blk.priv.vt = &flash_lpc2_buffered_vt;
352 fls->blk.priv.flags |= KB_BUFFERED | KB_PARTIAL_WRITE;
353 fls->blk.priv.buf = flash_buf;
356 /* Load the first block in the cache */
357 void *flash_start = 0x0;
358 memcpy(fls->blk.priv.buf, flash_start, fls->blk.blk_size);
361 void flash_hw_initUnbuffered(Flash *fls, int flags)
363 common_init(fls, flags);
364 fls->blk.priv.vt = &flash_lpc2_unbuffered_vt;