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.
35 * \author Francesco Sacchi <batt@develer.com>
36 * \author Daniele Basile <asterix@develer.com>
38 * This module implements a kfile-like access for Atmel avr
40 * Internal flash writing access is controlled by BOOTSZ fuses, check
41 * datasheet for details.
44 #include "flash_avr.h"
46 #include "cfg/cfg_flash_avr.h"
47 #include <cfg/macros.h> // MIN()
48 #include <cfg/compiler.h>
49 #include <cfg/debug.h>
52 // Define log settings for cfg/log.h
53 #define LOG_LEVEL CONFIG_FLASH_AVR_LOG_LEVEL
54 #define LOG_FORMAT CONFIG_FLASH_AVR_LOG_FORMAT
58 #include <drv/flash.h>
64 #include <avr/pgmspace.h>
70 * Definition of type for avr flash module.
72 typedef uint16_t page_addr_t;
76 * Private avr flush funtion.
78 * Write current buffered page in flash memory (if modified).
79 * This function erase flash memory page before writing.
81 * This function is only use internally in this module.
83 static void flash_avr_flush(Flash *fd)
88 LOG_INFO("Flushing page %d\n", fd->curr_page);
90 // Wait while the SPM instruction is busy.
93 LOG_INFO("Filling temparary page buffer...");
95 // Fill the temporary buffer of the AVR
96 for (page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
98 uint16_t word = ((uint16_t)fd->page_buf[page_addr + 1] << 8) | fd->page_buf[page_addr];
100 ATOMIC(boot_page_fill(page_addr, word));
106 LOG_INFO("Erasing page, addr %u...", fd->curr_page * SPM_PAGESIZE);
109 ATOMIC(boot_page_erase(fd->curr_page * SPM_PAGESIZE));
111 /* Wait until the memory is erased. */
112 boot_spm_busy_wait();
115 LOG_INFO("Writing page, addr %u...", fd->curr_page * SPM_PAGESIZE);
117 /* Store buffer in flash page. */
118 ATOMIC(boot_page_write(fd->curr_page * SPM_PAGESIZE));
119 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
122 * Reenable RWW-section again. We need this if we want to jump back
123 * to the application after bootloading.
125 ATOMIC(boot_rww_enable());
127 fd->page_dirty = false;
134 * Flush avr flash function.
136 * Write current buffered page in flash memory (if modified).
137 * This function erase flash memory page before writing.
139 static int flash_avr_kfileFlush(struct KFile *_fd)
141 Flash *fd = FLASH_CAST(_fd);
148 * Check current page and if \a page is different, load it in
151 static void flash_avr_loadPage(Flash *fd, page_t page)
153 if (page != fd->curr_page)
157 memcpy_P(fd->page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
158 fd->curr_page = page;
159 LOG_INFO("Loaded page %d\n", fd->curr_page);
164 * Write program memory.
165 * Write \a size bytes from buffer \a _buf to file \a fd
166 * \note Write operations are buffered.
168 static size_t flash_avr_write(struct KFile *_fd, const void *_buf, size_t size)
170 Flash *fd = FLASH_CAST(_fd);
171 const uint8_t *buf =(const uint8_t *)_buf;
174 page_addr_t page_addr;
175 size_t total_write = 0;
178 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= (kfile_off_t)fd->fd.size);
179 size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
181 LOG_INFO("Writing at pos[%u]\n", fd->fd.seek_pos);
184 page = fd->fd.seek_pos / SPM_PAGESIZE;
185 page_addr = fd->fd.seek_pos % SPM_PAGESIZE;
187 flash_avr_loadPage(fd, page);
189 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
190 memcpy(fd->page_buf + page_addr, buf, wr_len);
191 fd->page_dirty = true;
194 fd->fd.seek_pos += wr_len;
196 total_write += wr_len;
198 LOG_INFO("written %u bytes\n", total_write);
203 * Open flash file \a fd
204 * \a name and \a mode are unused, cause flash memory is
205 * threated like one file.
207 static void flash_avr_open(struct Flash *fd)
210 memcpy_P(fd->page_buf, (const char *)(fd->curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
213 fd->fd.size = (uint16_t)(FLASHEND - CONFIG_FLASH_AVR_BOOTSIZE + 1);
214 fd->page_dirty = false;
216 LOG_INFO("Flash file opened\n");
222 static int flash_avr_close(struct KFile *_fd)
224 Flash *fd = FLASH_CAST(_fd);
226 LOG_INFO("Flash file closed\n");
233 static struct KFile *flash_avr_reopen(struct KFile *fd)
235 Flash *_fd = FLASH_CAST(fd);
237 flash_avr_open((struct Flash *)_fd);
243 * Read from file \a fd \a size bytes and put it in buffer \a buf
244 * \return the number of bytes read.
246 static size_t flash_avr_read(struct KFile *_fd, void *buf, size_t size)
248 Flash *fd = FLASH_CAST(_fd);
249 ASSERT(fd->fd.seek_pos + (kfile_off_t)size <= (kfile_off_t)fd->fd.size);
250 size = MIN((kfile_off_t)size, fd->fd.size - fd->fd.seek_pos);
252 LOG_INFO("Reading at pos[%u]\n", fd->fd.seek_pos);
253 // Flush current buffered page (if modified).
257 * AVR pointers are 16 bits wide, this hack is needed to avoid
258 * compiler warning, cause fd->seek_pos is a 32bit offset.
260 const uint8_t *pgm_addr = (const uint8_t *)0;
261 pgm_addr += fd->fd.seek_pos;
263 memcpy_P(buf, pgm_addr, size);
264 fd->fd.seek_pos += size;
265 LOG_INFO("Read %u bytes\n", size);
270 * Init AVR flash read/write file.
272 void flash_hw_init(struct Flash *fd)
274 memset(fd, 0, sizeof(*fd));
275 DB(fd->fd._type = KFT_FLASH);
277 // Set up flash programming functions.
278 fd->fd.reopen = flash_avr_reopen;
279 fd->fd.close = flash_avr_close;
280 fd->fd.read = flash_avr_read;
281 fd->fd.write = flash_avr_write;
282 fd->fd.seek = kfile_genericSeek;
283 fd->fd.flush = flash_avr_kfileFlush;