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>
61 typedef uint16_t avr_page_addr_t;
62 typedef uint16_t avr_page_t;
65 * Temporary buffer cointaing data block to
68 static uint8_t page_buf[SPM_PAGESIZE];
70 bool page_modified; /// Flag for checking if current page is modified.
73 * Current buffered page.
75 static avr_page_t curr_page = 0;
78 * Write current buffered page in flash memory (if modified).
79 * This function erase flash memory page before writing.
81 static void flash_avr_flush(void)
85 kprintf("Flushing page %d\n", curr_page);
87 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
89 kprintf("Filling temparary page buffer...");
90 /* Fill the temporary buffer of the AVR */
91 for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
93 uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr];
95 ATOMIC(boot_page_fill(page_addr, word));
101 kprintf("Erasing page, addr %u...", curr_page * SPM_PAGESIZE);
104 ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE));
106 /* Wait until the memory is erased. */
107 boot_spm_busy_wait();
110 kprintf("Writing page, addr %u...", curr_page * SPM_PAGESIZE);
112 /* Store buffer in flash page. */
113 ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE));
114 boot_spm_busy_wait(); // Wait while the SPM instruction is busy.
117 * Reenable RWW-section again. We need this if we want to jump back
118 * to the application after bootloading.
120 ATOMIC(boot_rww_enable());
122 page_modified = false;
129 * Check current page and if \a page is different, load it in
132 static void flash_avr_loadPage(avr_page_t page)
134 if (page != curr_page)
138 memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
140 kprintf("Loaded page %d\n", curr_page);
145 * Write program memory.
146 * Write \a size bytes from buffer \a _buf to file \a fd
147 * \note Write operations are buffered.
149 static size_t flash_avr_write(struct _KFile *fd, const void *_buf, size_t size)
151 const uint8_t *buf =(const uint8_t *)_buf;
154 avr_page_addr_t page_addr;
155 size_t total_write = 0;
157 ASSERT(fd->seek_pos + size <= fd->size);
158 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
160 kprintf("Writing at pos[%u]\n", fd->seek_pos);
163 page = fd->seek_pos / SPM_PAGESIZE;
164 page_addr = fd->seek_pos % SPM_PAGESIZE;
166 flash_avr_loadPage(page);
168 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
169 memcpy(page_buf + page_addr, buf, wr_len);
170 page_modified = true;
173 fd->seek_pos += wr_len;
175 total_write += wr_len;
177 kprintf("written %u bytes\n", total_write);
182 * Open flash file \a fd
183 * \a name and \a mode are unused, cause flash memory is
184 * threated like one file.
186 static bool flash_avr_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode))
189 memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
192 fd->size = (uint16_t)(FLASHEND - CONFIG_BOOT_SIZE + 1);
193 page_modified = false;
195 kprintf("Flash file opened\n");
202 static bool flash_avr_close(UNUSED_ARG(struct _KFile *,fd))
205 kprintf("Flash file closed\n");
210 * Move \a fd file seek position of \a offset bytes
211 * from current position.
213 static int32_t flash_avr_seek(struct _KFile *fd, int32_t offset, KSeekMode whence)
223 seek_pos = fd->size - 1;
226 seek_pos = fd->seek_pos;
235 if (seek_pos + offset > fd->size)
241 fd->seek_pos = seek_pos + offset;
242 kprintf("Flash seek to [%u]\n", fd->seek_pos);
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 ASSERT(fd->seek_pos + size <= fd->size);
254 size = MIN((uint32_t)size, fd->size - fd->seek_pos);
256 kprintf("Reading at pos[%u]\n", fd->seek_pos);
257 // Flush current buffered page (if modified).
261 * AVR pointers are 16 bits wide, this hack is needed to avoid
262 * compiler warning, cause fd->seek_pos is a 32bit offset.
264 const uint8_t *pgm_addr = (const uint8_t *)0;
265 pgm_addr += fd->seek_pos;
267 memcpy_P(buf, pgm_addr, size);
268 fd->seek_pos += size;
269 kprintf("Read %u bytes\n", size);
274 * Init AVR flash read/write file.
276 void flash_avr_init(struct _KFile *fd)
278 // Set up flash programming functions.
279 fd->open = flash_avr_open;
280 fd->close = flash_avr_close;
281 fd->read = flash_avr_read;
282 fd->write = flash_avr_write;
283 fd->seek = flash_avr_seek;
288 #define TEST_SIZE 683
289 #define ONE_BYTE_TEST_ADDRESS 347
291 uint8_t test_buf[TEST_SIZE];
292 uint8_t save_buf[TEST_SIZE];
295 * Program memory read/write subtest.
296 * Try to write/read in the same \a f file location \a _size bytes.
297 * \return true if all is ok, false otherwise
298 * \note Restore file position at exit (if no error)
299 * \note Test buffer \a buf must be filled with
300 * the following statement:
305 static bool flash_avr_rwTest(KFile *f, uint8_t *buf, size_t _size)
307 int32_t size = _size;
309 if (f->write(f, buf, size) != size)
311 f->seek(f, -size, SEEK_CUR);
314 memset(buf, 0, size);
316 // Read flash in test buffer
317 if (f->read(f, buf, size) != size)
319 f->seek(f, -size, SEEK_CUR);
322 for (size_t i = 0; i < size; i++)
323 if (buf[i] != (i & 0xff))
330 * Test for program memory read/write.
332 bool flash_avr_test(void)
336 // Set up flash programming functions.
339 // Fill in test buffer
340 for (int i = 0; i < TEST_SIZE; i++)
341 test_buf[i] = (i & 0xff);
344 fd.open(&fd, NULL, 0);
345 // Save flash content (for later restore).
346 fd.read(&fd, save_buf, sizeof(save_buf));
348 if (fd.seek(&fd, 0, SEEK_SET) != 0)
349 goto flash_avr_test_end;
351 // Test flash read/write to address 0..TEST_SIZE
352 if (!flash_avr_rwTest(&fd, test_buf, TEST_SIZE))
353 goto flash_avr_test_end;
355 // One byte read/write test
356 fd.seek(&fd, ONE_BYTE_TEST_ADDRESS, SEEK_CUR); // Random address
357 if (!flash_avr_rwTest(&fd, test_buf, 1))
358 goto flash_avr_test_end;
359 fd.seek(&fd, -(int32_t)ONE_BYTE_TEST_ADDRESS, SEEK_CUR);
361 // Restore old flash data
362 if (fd.write(&fd, save_buf, sizeof(test_buf)) != TEST_SIZE)
363 goto flash_avr_test_end;
364 fd.seek(&fd, -TEST_SIZE, SEEK_CUR);
366 // Go to the Flash end
367 fd.seek(&fd, -TEST_SIZE, SEEK_END);
368 // Save flash content (for later restore).
369 fd.read(&fd, save_buf, sizeof(save_buf));
370 fd.seek(&fd, -TEST_SIZE, SEEK_CUR);
372 // Test flash read/write to address (FLASHEND - TEST_SIZE) ... FLASHEND
373 if (!flash_avr_rwTest(&fd, test_buf, TEST_SIZE))
374 goto flash_avr_test_end;
376 // Go to half test size.
377 fd.seek(&fd, (TEST_SIZE / 2), SEEK_CUR);
379 // This test should FAIL, cause we try to write over file end.
380 kprintf("This test should fail.\n");
381 if (flash_avr_rwTest(&fd, test_buf, TEST_SIZE))
382 goto flash_avr_test_end;
384 fd.seek(&fd, -TEST_SIZE, SEEK_CUR);
385 // Restore old flash data
386 fd.write(&fd, save_buf, TEST_SIZE);