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"
47 #include "cfg/cfg_flash_avr.h"
48 #include <cfg/macros.h> // MIN()
49 #include <cfg/compiler.h>
50 #include <cfg/debug.h>
55 #include <kern/kfile.h>
59 #include <avr/pgmspace.h>
68 * Definition of type for avr flash module.
70 typedef uint16_t avr_page_addr_t;
71 typedef uint16_t avr_page_t;
74 * Temporary buffer cointaing data block to
77 static uint8_t page_buf[SPM_PAGESIZE];
80 * Flag for checking if current page is modified.
85 * Current buffered page.
87 static avr_page_t curr_page = 0;
90 * Private avr flush funtion.
92 * Write current buffered page in flash memory (if modified).
93 * This function erase flash memory page before writing.
95 * This function is only use internaly in this module.
97 static void flash_avr_flush(void)
101 kprintf("Flushing page %d\n", curr_page);
103 // Wait while the SPM instruction is busy.
104 boot_spm_busy_wait();
106 kprintf("Filling temparary page buffer...");
108 // Fill the temporary buffer of the AVR
109 for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
111 uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr];
113 ATOMIC(boot_page_fill(page_addr, word));
119 kprintf("Erasing page, addr %u...", curr_page * SPM_PAGESIZE);
122 ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE));
124 /* Wait until the memory is erased. */
125 boot_spm_busy_wait();
128 kprintf("Writing page, addr %u...", curr_page * SPM_PAGESIZE);
130 /* Store buffer in flash page. */
131 ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE));
132 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
135 * Reenable RWW-section again. We need this if we want to jump back
136 * to the application after bootloading.
138 ATOMIC(boot_rww_enable());
140 page_modified = false;
147 * Flush avr flash function.
149 * Write current buffered page in flash memory (if modified).
150 * This function erase flash memory page before writing.
152 static int flash_avr_kfileFlush(struct KFile * fd)
163 * Check current page and if \a page is different, load it in
166 static void flash_avr_loadPage(avr_page_t page)
168 if (page != curr_page)
172 memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
174 kprintf("Loaded page %d\n", curr_page);
179 * Write program memory.
180 * Write \a size bytes from buffer \a _buf to file \a fd
181 * \note Write operations are buffered.
183 static size_t flash_avr_write(struct KFile *fd, const void *_buf, size_t size)
186 const uint8_t *buf =(const uint8_t *)_buf;
189 avr_page_addr_t page_addr;
190 size_t total_write = 0;
193 ASSERT(fd->seek_pos + size <= fd->size);
194 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
196 kprintf("Writing at pos[%u]\n", fd->seek_pos);
199 page = fd->seek_pos / SPM_PAGESIZE;
200 page_addr = fd->seek_pos % SPM_PAGESIZE;
202 flash_avr_loadPage(page);
204 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
205 memcpy(page_buf + page_addr, buf, wr_len);
206 page_modified = true;
209 fd->seek_pos += wr_len;
211 total_write += wr_len;
213 kprintf("written %u bytes\n", total_write);
218 * Open flash file \a fd
219 * \a name and \a mode are unused, cause flash memory is
220 * threated like one file.
222 static void flash_avr_open(struct KFile *fd)
226 memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
229 fd->size = (uint16_t)(FLASHEND - CONFIG_FLASH_AVR_BOOTSIZE + 1);
230 page_modified = false;
232 kprintf("Flash file opened\n");
238 static int flash_avr_close(UNUSED_ARG(struct KFile *,fd))
242 kprintf("Flash file closed\n");
249 static struct KFile *flash_avr_reopen(struct KFile *fd)
259 * Read from file \a fd \a size bytes and put it in buffer \a buf
260 * \return the number of bytes read.
262 static size_t flash_avr_read(struct KFile *fd, void *buf, size_t size)
265 ASSERT(fd->seek_pos + size <= fd->size);
266 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
268 kprintf("Reading at pos[%u]\n", fd->seek_pos);
269 // Flush current buffered page (if modified).
273 * AVR pointers are 16 bits wide, this hack is needed to avoid
274 * compiler warning, cause fd->seek_pos is a 32bit offset.
276 const uint8_t *pgm_addr = (const uint8_t *)0;
277 pgm_addr += fd->seek_pos;
279 memcpy_P(buf, pgm_addr, size);
280 fd->seek_pos += size;
281 kprintf("Read %u bytes\n", size);
286 * Init AVR flash read/write file.
288 void flash_avr_init(struct KFile *fd)
290 memset(fd, 0, sizeof(*fd));
291 DB(fd->_type = KFT_FLASHAVR);
293 // Set up flash programming functions.
294 fd->reopen = flash_avr_reopen;
295 fd->close = flash_avr_close;
296 fd->read = flash_avr_read;
297 fd->write = flash_avr_write;
298 fd->seek = kfile_genericSeek;
299 fd->flush = flash_avr_kfileFlush;