From: batt Date: Mon, 1 Oct 2007 17:18:48 +0000 (+0000) Subject: Move mware/prog_avr module to drv/flash_avr; add kfile Ctor; merge flash read/write... X-Git-Tag: 1.0.0~420 X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=4309f8e147e1a4741beb0a0b1933e63218bd89ca;p=bertos.git Move mware/prog_avr module to drv/flash_avr; add kfile Ctor; merge flash read/write test. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@821 38d2e660-2303-0410-9eaa-f027e97ec537 --- diff --git a/drv/flash_avr.c b/drv/flash_avr.c new file mode 100755 index 00000000..913daeca --- /dev/null +++ b/drv/flash_avr.c @@ -0,0 +1,345 @@ +/** + * \file + * + * + * \brief Self programming routines. + * + * \version $Id$ + * \author Francesco Sacchi + * \author Daniele Basile + * + * This module implements a kfile-like access for Atmel avr + * internal flash. + * Internal flash writing access is controlled by BOOTSZ fuses, check + * datasheet for details. + */ + +#include "flash_avr.h" + +#include + +#include +#include // MIN() +#include +#include + +#include +#include +#include + +typedef uint16_t avr_page_addr_t; +typedef uint16_t avr_page_t; + +/** + * Temporary buffer cointaing data block to + * write on flash. + */ +static uint8_t page_buf[SPM_PAGESIZE]; + +bool page_modified; /// Flag for checking if current page is modified. + +/** + * Current buffered page. + */ +static avr_page_t curr_page = 0; + +/** + * Write current buffered page in flash memory (if modified). + * This function erase flash memory page before writing. + */ +static void avrflash_flush(void) +{ + if (page_modified) + { + kprintf("Flushing page %d\n", curr_page); + + boot_spm_busy_wait(); // Wait while the SPM instruction is busy. + + kprintf("Filling temparary page buffer..."); + /* Fill the temporary buffer of the AVR */ + for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2) + { + uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr]; + + ATOMIC(boot_page_fill(page_addr, word)); + } + kprintf("Done.\n"); + + wdt_reset(); + + kprintf("Erasing page, addr %d...", curr_page * SPM_PAGESIZE); + + /* Page erase */ + ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE)); + + /* Wait until the memory is erased. */ + boot_spm_busy_wait(); + + kprintf("Done.\n"); + kprintf("Writing page, addr %d...", curr_page * SPM_PAGESIZE); + + /* Store buffer in flash page. */ + ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE)); + boot_spm_busy_wait(); // Wait while the SPM instruction is busy. + + /* + * Reenable RWW-section again. We need this if we want to jump back + * to the application after bootloading. + */ + ATOMIC(boot_rww_enable()); + + page_modified = false; + kprintf("Done.\n"); + } +} + + +/** + * Check current page and if \a page is different, load it in + * temporary buffer. + */ +static void avrflash_loadPage(avr_page_t page) +{ + if (page != curr_page) + { + avrflash_flush(); + // Load page + memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE); + curr_page = page; + kprintf("Loaded page %d\n", curr_page); + } +} + +/** + * Write program memory. + * Write \a size bytes from buffer \a _buf to file \a *fd + * \note Write operations are buffered. + */ +static size_t avrflash_write(struct _KFile *fd, const void *_buf, size_t size) +{ + const uint8_t *buf =(const uint8_t *)_buf; + + avr_page_t page; + avr_page_addr_t page_addr; + size_t total_write = 0; + + ASSERT(fd->seek_pos + size <= fd->size); + size = MIN((uint32_t)size, fd->size - fd->seek_pos); + + kprintf("Writing at pos[%d]\n", fd->seek_pos); + while (size) + { + page = fd->seek_pos / SPM_PAGESIZE; + page_addr = fd->seek_pos % SPM_PAGESIZE; + + avrflash_loadPage(page); + + size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr); + memcpy(page_buf + page_addr, buf, wr_len); + page_modified = true; + + buf += wr_len; + fd->seek_pos += wr_len; + size -= wr_len; + total_write += wr_len; + } + kprintf("written %d bytes\n", total_write); + return total_write; +} + +/** + * Open flash file \a *fd + * \a name and \a mode are unused, cause flash memory is + * threated like one file. + */ +static bool avrflash_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode)) +{ + curr_page = 0; + memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE); + + fd->seek_pos = 0; + fd->size = (uint16_t)(FLASHEND - CONFIG_BOOT_SIZE + 1); + page_modified = false; + + kprintf("Flash file opened\n"); + return true; +} + +/** + * Close file \a *fd + */ +static bool avrflash_close(UNUSED_ARG(struct _KFile *,fd)) +{ + avrflash_flush(); + kprintf("Flash file closed\n"); + return true; +} + +/** + * Move \a *fd file seek position of \a offset bytes + * from current position. + */ +static bool avrflash_seek(struct _KFile *fd, int32_t offset) +{ + ASSERT(fd->seek_pos + offset <= fd->size); + + /* Bound check */ + if (fd->seek_pos + offset > fd->size) + return false; + + fd->seek_pos += offset; + kprintf("Flash seek to [%d]\n", fd->seek_pos); + + return true; +} + +/** + * Read from file \a *fd \a size bytes and put it in buffer \a *buf + * \return the number of bytes read. + */ +static size_t avrflash_read(struct _KFile *fd, void *buf, size_t size) +{ + ASSERT(fd->seek_pos + size <= fd->size); + size = MIN((uint32_t)size, fd->size - fd->seek_pos); + + kprintf("Reading at pos[%d]\n", fd->seek_pos); + // Flush current buffered page (if modified). + avrflash_flush(); + + /* + * AVR pointers are 16 bits wide, this hack is needed to avoid + * compiler warning, cause fd->seek_pos is a 32bit offset. + */ + const uint8_t *pgm_addr = (const uint8_t *)0; + pgm_addr += fd->seek_pos; + + memcpy_P(buf, pgm_addr, size); + fd->seek_pos += size; + kprintf("Read %d bytes\n", size); + return size; +} + +/** + * Init AVR flash read/write file. + */ +void avrflash_init(struct _KFile *fd) +{ + // Set up flash programming functions. + fd.open = avrflash_open; + fd.close = avrflash_close; + fd.read = avrflash_read; + fd.write = avrflash_write; + fd.seek = avrflash_seek; +} + +#if CONFIG_TEST + +#define TEST_SIZE 683 +#define ONE_BYTE_TEST_ADDRESS 347 + +uint8_t test_buf[TEST_SIZE]; +uint8_t save_buf[TEST_SIZE]; + +/** + * Program memory read/write subtest. + * Try to write/read in the same \param f file location \param _size bytes. + * \return true if all is ok, false otherwise + * \note Restore file position at exit (if no error) + * \note Test buffer \param buf must be filled with + * the following statement: + * 
+ * buf[i] = i & 0xff
+ *
+ */ +static bool avrflash_rwTest(KFile *f, uint8_t *buf, size_t _size) +{ + int32_t size = _size; + // Write test buffer + if (f->write(f, buf, size) != size) + return false; + f->seek(f, -size); + + // Reset test buffer + memset(buf, 0, size); + + // Read flash in test buffer + if (f->read(f, buf, size) != size) + return false; + f->seek(f, -size); + + // Check test result + for (size_t i = 0; i < size; i++) + if (buf[i] != (i & 0xff)) + return false; + + return true; +} + +/** + * Test for program memory read/write. + */ +bool avrflash_test(void) +{ + KFile fd; + + // Set up flash programming functions. + avrflash_init(&fd); + + // Fill in test buffer + for (int i = 0; i < TEST_SIZE; i++) + test_buf[i] = (i & 0xff); + + // Open flash + fd.open(&fd, NULL, 0); + // Save flash content (for later restore). + fd.read(&fd, save_buf, sizeof(save_buf)); + fd.seek(&fd, -TEST_SIZE); + + // Test flash read/write to address 0..TEST_SIZE + if (!avrflash_rwTest(&fd, test_buf, TEST_SIZE)) + goto avrflash_test_end; + + // One byte read/write test + fd.seek(&fd, ONE_BYTE_TEST_ADDRESS); // Random address + if (!avrflash_rwTest(&fd, test_buf, 1)) + goto avrflash_test_end; + fd.seek(&fd, -(int32_t)ONE_BYTE_TEST_ADDRESS); + + // Restore old flash data + if (fd.write(&fd, save_buf, sizeof(test_buf)) != TEST_SIZE) + goto avrflash_test_end; + fd.seek(&fd, -TEST_SIZE); + + // Go to the Flash end + fd.seek(&fd, fd.size - TEST_SIZE); + // Save flash content (for later restore). + fd.read(&fd, save_buf, sizeof(save_buf)); + fd.seek(&fd, -TEST_SIZE); + + // Test flash read/write to address (FLASHEND - TEST_SIZE) ... FLASHEND + if (!avrflash_rwTest(&fd, test_buf, TEST_SIZE)) + goto avrflash_test_end; + + // Go to half test size. + fd.seek(&fd, (TEST_SIZE / 2)); + + // This test should FAIL, cause we try to write over file end. + if (avrflash_rwTest(&fd, test_buf, TEST_SIZE)) + goto avrflash_test_end; + + fd.seek(&fd, -TEST_SIZE); + // Restore old flash data + fd.write(&fd, save_buf, TEST_SIZE); + + fd.close(&fd); + return true; + +avrflash_test_end: + fd.close(&fd); + return false; +} + +#endif diff --git a/drv/flash_avr.h b/drv/flash_avr.h new file mode 100755 index 00000000..1dc7d470 --- /dev/null +++ b/drv/flash_avr.h @@ -0,0 +1,25 @@ +/** + * \file + * + * + * \brief Self programming routines (interface). + * + * \version $Id$ + * \author Francesco Sacchi + * \author Daniele Basile + */ + +#ifndef DRV_FLASH_AVR_H +#define DRV_FLASH_AVR_H + +#include +#include + +bool avrflash_test(void); +void avrflash_init(struct _KFile *fd); + + +#endif /* DRV_FLASH_AVR_H */ diff --git a/mware/prog.c b/mware/prog.c deleted file mode 100755 index a600659c..00000000 --- a/mware/prog.c +++ /dev/null @@ -1,144 +0,0 @@ -/** - * \file - * - * - * \brief Flash memory programmar interface. - * - * \version $Id$ - * \author Stefano Fedrigo - * \author Francesco Sacchi - * \author Daniele Basile - */ - -#include "prog.h" - -#include - -#include -#include -#include - -#include - -/* - * Include platform-specific binding code if we're hosted. - * Try the CPU specific one for bare-metal environments. - */ -#if OS_HOSTED - #include OS_CSOURCE(prog) -#else - #include CPU_CSOURCE(prog) -#endif - - -#define TEST_SIZE 683 -#define ONE_BYTE_TEST_ADDRESS 347 - -uint8_t test_buf[TEST_SIZE]; -uint8_t save_buf[TEST_SIZE]; - -/** - * Program memory read/write subtest. - * Try to write/read in the same \param f file location \param _size bytes. - * \return true if all is ok, false otherwise - * \note Restore file position at exit (if no error) - * \note Test buffer \param buf must be filled with - * the following statement: - * 
- * buf[i] = i & 0xff
- *
- */ -static bool prog_rwTest(KFile *f, uint8_t *buf, size_t _size) -{ - int32_t size = _size; - // Write test buffer - if (f->write(f, buf, size) != size) - return false; - f->seek(f, -size); - - // Reset test buffer - memset(buf, 0, size); - - // Read flash in test buffer - if (f->read(f, buf, size) != size) - return false; - f->seek(f, -size); - - // Check test result - for (size_t i = 0; i < size; i++) - if (buf[i] != (i & 0xff)) - return false; - - return true; -} - -/** - * Test for program memory read/write. - */ -bool prog_test(void) -{ - KFile fd; - - // Set up flash programming functions. - fd.open = prog_open; - fd.close = prog_close; - fd.read = prog_read; - fd.write = prog_write; - fd.seek = prog_seek; - - // Fill in test buffer - for (int i = 0; i < TEST_SIZE; i++) - test_buf[i] = (i & 0xff); - - // Open flash - fd.open(&fd, NULL, 0); - // Save flash content (for later restore). - fd.read(&fd, save_buf, sizeof(save_buf)); - fd.seek(&fd, -TEST_SIZE); - - // Test flash read/write to address 0..TEST_SIZE - if (!prog_rwTest(&fd, test_buf, TEST_SIZE)) - goto prog_test_end; - - // One byte read/write test - fd.seek(&fd, ONE_BYTE_TEST_ADDRESS); // Random address - if (!prog_rwTest(&fd, test_buf, 1)) - goto prog_test_end; - fd.seek(&fd, -(int32_t)ONE_BYTE_TEST_ADDRESS); - - // Restore old flash data - if (fd.write(&fd, save_buf, sizeof(test_buf)) != TEST_SIZE) - goto prog_test_end; - fd.seek(&fd, -TEST_SIZE); - - // Go to the Flash end - fd.seek(&fd, fd.size - TEST_SIZE); - // Save flash content (for later restore). - fd.read(&fd, save_buf, sizeof(save_buf)); - fd.seek(&fd, -TEST_SIZE); - - // Test flash read/write to address (FLASHEND - TEST_SIZE) ... FLASHEND - if (!prog_rwTest(&fd, test_buf, TEST_SIZE)) - goto prog_test_end; - - // Go to half test size. - fd.seek(&fd, (TEST_SIZE / 2)); - - // This test should FAIL, cause we try to write over file end. - if (prog_rwTest(&fd, test_buf, TEST_SIZE)) - goto prog_test_end; - - fd.seek(&fd, -TEST_SIZE); - // Restore old flash data - fd.write(&fd, save_buf, TEST_SIZE); - - fd.close(&fd); - return true; - -prog_test_end: - fd.close(&fd); - return false; -} diff --git a/mware/prog.h b/mware/prog.h deleted file mode 100755 index 76685c87..00000000 --- a/mware/prog.h +++ /dev/null @@ -1,39 +0,0 @@ -/** - * \file - * - * - * \brief Generic program read/write routines interface - * - * This module implements an interface function for programming - * a CPU flash memory. To guarantee correct memory writing, we - * use a rotating hash algorithm. - * - * - * \version $Id$ - * \author Francesco Sacchi - * \author Daniele Basile - */ - -#ifndef PROG_H -#define PROG_H - -#include -#include - -/** - * Prototype of function for manage read/write on - * flash memory. - *\{ - */ -size_t prog_write(struct _KFile *fd, const void *buf, size_t size); -bool prog_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode)); -bool prog_close(struct _KFile *fd); -bool prog_seek(struct _KFile *fd, int32_t offset); -size_t prog_read(struct _KFile *fd, void *buf, size_t size); -bool prog_test(void); -/* \} */ - -#endif /* PROG_H */ diff --git a/mware/prog_avr.c b/mware/prog_avr.c deleted file mode 100755 index 6e35e755..00000000 --- a/mware/prog_avr.c +++ /dev/null @@ -1,219 +0,0 @@ -/** - * \file - * - * - * \brief Self programming routines - * - * \version $Id$ - * \author Francesco Sacchi - * \author Daniele Basile - */ - -#include "prog.h" - -#include - -#include -#include // MIN() -#include -#include - -#include -#include -#include - -typedef uint16_t avr_page_addr_t; -typedef uint16_t avr_page_t; - -/** - * Temporary buffer cointaing data block to - * write on flash. - */ -static uint8_t page_buf[SPM_PAGESIZE]; - -bool page_modified; /// Flag for checking if current page is modified. - -/** - * Current buffered page. - */ -static avr_page_t curr_page = 0; - -/** - * Write current buffered page in flash memory (if modified). - * This function erase flash memory page before writing. - */ -static void prog_flush(void) -{ - if (page_modified) - { - kprintf("Flushing page %d\n", curr_page); - - boot_spm_busy_wait(); // Wait while the SPM instruction is busy. - - kprintf("Filling temparary page buffer..."); - /* Fill the temporary buffer of the AVR */ - for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2) - { - uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr]; - - ATOMIC(boot_page_fill(page_addr, word)); - } - kprintf("Done.\n"); - - wdt_reset(); - - kprintf("Erasing page, addr %d...", curr_page * SPM_PAGESIZE); - - /* Page erase */ - ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE)); - - /* Wait until the memory is erased. */ - boot_spm_busy_wait(); - - kprintf("Done.\n"); - kprintf("Writing page, addr %d...", curr_page * SPM_PAGESIZE); - - /* Store buffer in flash page. */ - ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE)); - boot_spm_busy_wait(); // Wait while the SPM instruction is busy. - - /* - * Reenable RWW-section again. We need this if we want to jump back - * to the application after bootloading. - */ - ATOMIC(boot_rww_enable()); - - page_modified = false; - kprintf("Done.\n"); - } -} - - -/** - * Check current page and if \a page is different, load it in - * temporary buffer. - */ -static void prog_loadPage(avr_page_t page) -{ - if (page != curr_page) - { - prog_flush(); - // Load page - memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE); - curr_page = page; - kprintf("Loaded page %d\n", curr_page); - } -} - -/** - * Write program memory. - * Write \a size bytes from buffer \a _buf to file \a *fd - * \note Write operations are buffered. - */ -size_t prog_write(struct _KFile *fd, const void *_buf, size_t size) -{ - const uint8_t *buf =(const uint8_t *)_buf; - - avr_page_t page; - avr_page_addr_t page_addr; - size_t total_write = 0; - - ASSERT(fd->seek_pos + size <= fd->size); - size = MIN((uint32_t)size, fd->size - fd->seek_pos); - - kprintf("Writing at pos[%d]\n", fd->seek_pos); - while (size) - { - page = fd->seek_pos / SPM_PAGESIZE; - page_addr = fd->seek_pos % SPM_PAGESIZE; - - prog_loadPage(page); - - size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr); - memcpy(page_buf + page_addr, buf, wr_len); - page_modified = true; - - buf += wr_len; - fd->seek_pos += wr_len; - size -= wr_len; - total_write += wr_len; - } - kprintf("written %d bytes\n", total_write); - return total_write; -} - -/** - * Open flash file \a *fd - * \a name and \a mode are unused, cause flash memory is - * threated like one file. - */ -bool prog_open(struct _KFile *fd, UNUSED_ARG(const char *, name), UNUSED_ARG(int, mode)) -{ - curr_page = 0; - memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE); - - fd->seek_pos = 0; - fd->size = (uint16_t)(FLASHEND - CONFIG_BOOT_SIZE + 1); - page_modified = false; - - kprintf("Flash file opened\n"); - return true; -} - -/** - * Close file \a *fd - */ -bool prog_close(UNUSED_ARG(struct _KFile *,fd)) -{ - prog_flush(); - kprintf("Flash file closed\n"); - return true; -} - -/** - * Move \a *fd file seek position of \a offset bytes - * from current position. - */ -bool prog_seek(struct _KFile *fd, int32_t offset) -{ - ASSERT(fd->seek_pos + offset <= fd->size); - - /* Bound check */ - if (fd->seek_pos + offset > fd->size) - return false; - - fd->seek_pos += offset; - kprintf("Flash seek to [%d]\n", fd->seek_pos); - - return true; -} - -/** - * Read from file \a *fd \a size bytes and put it in buffer \a *buf - * \return the number of bytes read. - */ -size_t prog_read(struct _KFile *fd, void *buf, size_t size) -{ - ASSERT(fd->seek_pos + size <= fd->size); - size = MIN((uint32_t)size, fd->size - fd->seek_pos); - - kprintf("Reading at pos[%d]\n", fd->seek_pos); - // Flush current buffered page (if modified). - prog_flush(); - - /* - * AVR pointers are 16 bits wide, this hack is needed to avoid - * compiler warning, cause fd->seek_pos is a 32bit offset. - */ - const uint8_t *pgm_addr = (const uint8_t *)0; - pgm_addr += fd->seek_pos; - - memcpy_P(buf, pgm_addr, size); - fd->seek_pos += size; - kprintf("Read %d bytes\n", size); - return size; -} -