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 2007 Develer S.r.l. (http://www.develer.com/)
33 * \brief Self programming routines.
36 * \author Francesco Sacchi <batt@develer.com>
37 * \author Daniele Basile <asterix@develer.com>
39 * This module implements a kfile-like access for Atmel avr
41 * Internal flash writing access is controlled by BOOTSZ fuses, check
42 * datasheet for details.
45 #include "flash_avr.h"
49 #include <avr/pgmspace.h>
51 #include <cfg/macros.h> // MIN()
52 #include <cfg/compiler.h>
53 #include <cfg/debug.h>
58 #include <kern/kfile.h>
62 #warning FIXME:This module need to be refactor to kfile interface!
66 * Definition of type for avr flash module.
68 typedef uint16_t avr_page_addr_t;
69 typedef uint16_t avr_page_t;
72 * Temporary buffer cointaing data block to
75 static uint8_t page_buf[SPM_PAGESIZE];
78 * Flag for checking if current page is modified.
83 * Current buffered page.
85 static avr_page_t curr_page = 0;
88 * Private avr flush funtion.
90 * Write current buffered page in flash memory (if modified).
91 * This function erase flash memory page before writing.
93 * This function is only use internaly in this module.
95 static void flash_avr_flush(void)
99 kprintf("Flushing page %d\n", curr_page);
101 // Wait while the SPM instruction is busy.
102 boot_spm_busy_wait();
104 kprintf("Filling temparary page buffer...");
106 // Fill the temporary buffer of the AVR
107 for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
109 uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr];
111 ATOMIC(boot_page_fill(page_addr, word));
117 kprintf("Erasing page, addr %u...", curr_page * SPM_PAGESIZE);
120 ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE));
122 /* Wait until the memory is erased. */
123 boot_spm_busy_wait();
126 kprintf("Writing page, addr %u...", curr_page * SPM_PAGESIZE);
128 /* Store buffer in flash page. */
129 ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE));
130 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
133 * Reenable RWW-section again. We need this if we want to jump back
134 * to the application after bootloading.
136 ATOMIC(boot_rww_enable());
138 page_modified = false;
145 * Flush avr flash function.
147 * Write current buffered page in flash memory (if modified).
148 * This function erase flash memory page before writing.
150 static int flash_avr_kfileFlush(struct KFile * fd)
152 KFILE_ASSERT_GENERIC(fd);
160 * Check current page and if \a page is different, load it in
163 static void flash_avr_loadPage(avr_page_t page)
165 if (page != curr_page)
169 memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
171 kprintf("Loaded page %d\n", curr_page);
176 * Write program memory.
177 * Write \a size bytes from buffer \a _buf to file \a fd
178 * \note Write operations are buffered.
180 static size_t flash_avr_write(struct KFile *fd, const void *_buf, size_t size)
182 KFILE_ASSERT_GENERIC(fd);
183 const uint8_t *buf =(const uint8_t *)_buf;
186 avr_page_addr_t page_addr;
187 size_t total_write = 0;
189 ASSERT(fd->seek_pos + size <= fd->size);
190 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
192 kprintf("Writing at pos[%u]\n", fd->seek_pos);
195 page = fd->seek_pos / SPM_PAGESIZE;
196 page_addr = fd->seek_pos % SPM_PAGESIZE;
198 flash_avr_loadPage(page);
200 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
201 memcpy(page_buf + page_addr, buf, wr_len);
202 page_modified = true;
205 fd->seek_pos += wr_len;
207 total_write += wr_len;
209 kprintf("written %u bytes\n", total_write);
214 * Open flash file \a fd
215 * \a name and \a mode are unused, cause flash memory is
216 * threated like one file.
218 static void flash_avr_open(struct KFile *fd)
220 KFILE_ASSERT_GENERIC(fd);
222 memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
225 fd->size = (uint16_t)(FLASHEND - CONFIG_BOOT_SIZE + 1);
226 page_modified = false;
228 kprintf("Flash file opened\n");
234 static int flash_avr_close(UNUSED_ARG(struct KFile *,fd))
236 KFILE_ASSERT_GENERIC(fd);
238 kprintf("Flash file closed\n");
245 static struct KFile *flash_avr_reopen(struct KFile *fd)
247 KFILE_ASSERT_GENERIC(fd);
255 * Read from file \a fd \a size bytes and put it in buffer \a buf
256 * \return the number of bytes read.
258 static size_t flash_avr_read(struct KFile *fd, void *buf, size_t size)
260 KFILE_ASSERT_GENERIC(fd);
261 ASSERT(fd->seek_pos + size <= fd->size);
262 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
264 kprintf("Reading at pos[%u]\n", fd->seek_pos);
265 // Flush current buffered page (if modified).
269 * AVR pointers are 16 bits wide, this hack is needed to avoid
270 * compiler warning, cause fd->seek_pos is a 32bit offset.
272 const uint8_t *pgm_addr = (const uint8_t *)0;
273 pgm_addr += fd->seek_pos;
275 memcpy_P(buf, pgm_addr, size);
276 fd->seek_pos += size;
277 kprintf("Read %u bytes\n", size);
282 * Init AVR flash read/write file.
284 void flash_avr_init(struct KFile *fd)
286 memset(fd, 0, sizeof(*fd));
287 DB(fd->_type = KFT_GENERIC);
289 // Set up flash programming functions.
290 fd->reopen = flash_avr_reopen;
291 fd->close = flash_avr_close;
292 fd->read = flash_avr_read;
293 fd->write = flash_avr_write;
294 fd->seek = kfile_genericSeek;
295 fd->flush = flash_avr_kfileFlush;