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>
66 * Definition of type for avr flash module.
68 typedef uint16_t avr_page_addr_t;
72 * Temporary buffer cointaing data block to
75 static uint8_t page_buf[SPM_PAGESIZE];
82 * Private avr flush funtion.
84 * Write current buffered page in flash memory (if modified).
85 * This function erase flash memory page before writing.
87 * This function is only use internaly in this module.
89 static void flash_avr_flush(KFileFlashAvr *fd)
91 if (fd->page_modified)
93 kprintf("Flushing page %d\n", fd->curr_page);
95 // Wait while the SPM instruction is busy.
98 kprintf("Filling temparary page buffer...");
100 // Fill the temporary buffer of the AVR
101 for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
103 uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr];
105 ATOMIC(boot_page_fill(page_addr, word));
111 kprintf("Erasing page, addr %u...", fd->curr_page * SPM_PAGESIZE);
114 ATOMIC(boot_page_erase(fd->curr_page * SPM_PAGESIZE));
116 /* Wait until the memory is erased. */
117 boot_spm_busy_wait();
120 kprintf("Writing page, addr %u...", fd->curr_page * SPM_PAGESIZE);
122 /* Store buffer in flash page. */
123 ATOMIC(boot_page_write(fd->curr_page * SPM_PAGESIZE));
124 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
127 * Reenable RWW-section again. We need this if we want to jump back
128 * to the application after bootloading.
130 ATOMIC(boot_rww_enable());
132 fd->page_modified = false;
139 * Flush avr flash function.
141 * Write current buffered page in flash memory (if modified).
142 * This function erase flash memory page before writing.
144 static int flash_avr_kfileFlush(struct KFile *_fd)
146 KFileFlashAvr *fd = KFILEFLASHAVR(_fd);
153 * Check current page and if \a page is different, load it in
156 static void flash_avr_loadPage(KFileFlashAvr *fd, avr_page_t page)
158 if (page != fd->curr_page)
162 memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
163 fd->curr_page = page;
164 kprintf("Loaded page %d\n", fd->curr_page);
169 * Write program memory.
170 * Write \a size bytes from buffer \a _buf to file \a fd
171 * \note Write operations are buffered.
173 static size_t flash_avr_write(struct KFile *_fd, const void *_buf, size_t size)
175 KFileFlashAvr *fd = KFILEFLASHAVR(_fd);
176 const uint8_t *buf =(const uint8_t *)_buf;
179 avr_page_addr_t page_addr;
180 size_t total_write = 0;
183 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= (kfile_off_t)fd->fd.size);
184 size = MIN((uint32_t)size, fd->fd.size - fd->fd.seek_pos);
186 kprintf("Writing at pos[%u]\n", fd->fd.seek_pos);
189 page = fd->fd.seek_pos / SPM_PAGESIZE;
190 page_addr = fd->fd.seek_pos % SPM_PAGESIZE;
192 flash_avr_loadPage(fd, page);
194 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
195 memcpy(page_buf + page_addr, buf, wr_len);
196 fd->page_modified = true;
199 fd->fd.seek_pos += wr_len;
201 total_write += wr_len;
203 kprintf("written %u bytes\n", total_write);
208 * Open flash file \a fd
209 * \a name and \a mode are unused, cause flash memory is
210 * threated like one file.
212 static void flash_avr_open(struct KFileFlashAvr *fd)
215 memcpy_P(page_buf, (const char *)(fd->curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
218 fd->fd.size = (uint16_t)(FLASHEND - CONFIG_FLASH_AVR_BOOTSIZE + 1);
219 fd->page_modified = false;
221 kprintf("Flash file opened\n");
227 static int flash_avr_close(struct KFile *_fd)
229 KFileFlashAvr *fd = KFILEFLASHAVR(_fd);
231 kprintf("Flash file closed\n");
238 static struct KFile *flash_avr_reopen(struct KFile *fd)
240 KFileFlashAvr *_fd = KFILEFLASHAVR(fd);
248 * Read from file \a fd \a size bytes and put it in buffer \a buf
249 * \return the number of bytes read.
251 static size_t flash_avr_read(struct KFile *_fd, void *buf, size_t size)
253 KFileFlashAvr *fd = KFILEFLASHAVR(_fd);
254 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= (kfile_off_t)fd->fd.size);
255 size = MIN((uint32_t)size, fd->fd.size - fd->fd.seek_pos);
257 kprintf("Reading at pos[%u]\n", fd->fd.seek_pos);
258 // Flush current buffered page (if modified).
262 * AVR pointers are 16 bits wide, this hack is needed to avoid
263 * compiler warning, cause fd->seek_pos is a 32bit offset.
265 const uint8_t *pgm_addr = (const uint8_t *)0;
266 pgm_addr += fd->fd.seek_pos;
268 memcpy_P(buf, pgm_addr, size);
269 fd->fd.seek_pos += size;
270 kprintf("Read %u bytes\n", size);
275 * Init AVR flash read/write file.
277 void flash_avr_init(struct KFileFlashAvr *fd)
279 memset(fd, 0, sizeof(*fd));
280 DB(fd->fd._type = KFT_FLASHAVR);
282 // Set up flash programming functions.
283 fd->fd.reopen = flash_avr_reopen;
284 fd->fd.close = flash_avr_close;
285 fd->fd.read = flash_avr_read;
286 fd->fd.write = flash_avr_write;
287 fd->fd.seek = kfile_genericSeek;
288 fd->fd.flush = flash_avr_kfileFlush;