cpu/avr/drv/flash_avr.c

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Self programming routines.
  34  *
  35  * \version $Id$
  36  * \author Francesco Sacchi <batt@develer.com>
  37  * \author Daniele Basile <asterix@develer.com>
  38  *
  39  * This module implements a kfile-like access for Atmel avr
  40  * internal flash.
  41  * Internal flash writing access is controlled by BOOTSZ fuses, check
  42  * datasheet for details.
  43  */
  44
  45 #include "flash_avr.h"
  46
  47 #include <avr/io.h>
  48 #include <avr/boot.h>
  49 #include <avr/pgmspace.h>
  50
  51 #include <cfg/macros.h> // MIN()
  52 #include <cfg/compiler.h>
  53 #include <cfg/debug.h>
  54 #include <cpu/irq.h>
  55
  56 #include <drv/wdt.h>
  57
  58 #include <kern/kfile.h>
  59
  60 #include <string.h>
  61
  62 /**
  63  * Definition of type for avr flash module.
  64  */
  65 typedef uint16_t avr_page_addr_t;
  66 typedef uint16_t avr_page_t;
  67
  68 /**
  69  * Temporary buffer cointaing data block to
  70  * write on flash.
  71  */
  72 static uint8_t page_buf[SPM_PAGESIZE];
  73
  74 /**
  75  * Flag for checking if current page is modified.
  76  */
  77 bool page_modified;
  78
  79 /**
  80  * Current buffered page.
  81  */
  82 static avr_page_t curr_page = 0;
  83
  84 /*
  85  * Private avr flush funtion.
  86  *
  87  * Write current buffered page in flash memory (if modified).
  88  * This function erase flash memory page before writing.
  89  *
  90  * This function is only use internaly in this module.
  91  */
  92 static void flash_avr_flush(void)
  93 {
  94         if (page_modified)
  95         {
  96                 kprintf("Flushing page %d\n", curr_page);
  97
  98                 // Wait while the SPM instruction is busy.
  99                 boot_spm_busy_wait();
 100
 101                 kprintf("Filling temparary page buffer...");
 102
 103                 // Fill the temporary buffer of the AVR
 104                 for (avr_page_addr_t page_addr = 0; page_addr < SPM_PAGESIZE; page_addr += 2)
 105                 {
 106                         uint16_t word = ((uint16_t)page_buf[page_addr + 1] << 8) | page_buf[page_addr];
 107
 108                         ATOMIC(boot_page_fill(page_addr, word));
 109                 }
 110                 kprintf("Done.\n");
 111
 112                 wdt_reset();
 113
 114                 kprintf("Erasing page, addr %u...", curr_page * SPM_PAGESIZE);
 115
 116                 /* Page erase */
 117                 ATOMIC(boot_page_erase(curr_page * SPM_PAGESIZE));
 118
 119                 /* Wait until the memory is erased. */
 120                 boot_spm_busy_wait();
 121
 122                 kprintf("Done.\n");
 123                 kprintf("Writing page, addr %u...", curr_page * SPM_PAGESIZE);
 124
 125                 /* Store buffer in flash page. */
 126                 ATOMIC(boot_page_write(curr_page * SPM_PAGESIZE));
 127                 boot_spm_busy_wait();  // Wait while the SPM instruction is busy.
 128
 129                 /*
 130                 * Reenable RWW-section again. We need this if we want to jump back
 131                 * to the application after bootloading.
 132                 */
 133                 ATOMIC(boot_rww_enable());
 134
 135                 page_modified = false;
 136                 kprintf("Done.\n");
 137         }
 138 }
 139
 140
 141 /**
 142  * Flush avr flash function.
 143  *
 144  * Write current buffered page in flash memory (if modified).
 145  * This function erase flash memory page before writing.
 146  */
 147 static int flash_avr_kfileFlush(struct KFile * fd)
 148 {
 149         KFILE_ASSERT_GENERIC(fd);
 150         (void)fd;
 151         flash_avr_flush();
 152         return 0;
 153 }
 154
 155
 156 /**
 157  * Check current page and if \a page is different, load it in
 158  * temporary buffer.
 159  */
 160 static void flash_avr_loadPage(avr_page_t page)
 161 {
 162         if (page != curr_page)
 163         {
 164                 flash_avr_flush();
 165                 // Load page
 166                 memcpy_P(page_buf, (const char *)(page * SPM_PAGESIZE), SPM_PAGESIZE);
 167                 curr_page = page;
 168                 kprintf("Loaded page %d\n", curr_page);
 169         }
 170 }
 171
 172 /**
 173  * Write program memory.
 174  * Write \a size bytes from buffer \a _buf to file \a fd
 175  * \note Write operations are buffered.
 176  */
 177 static size_t flash_avr_write(struct KFile *fd, const void *_buf, size_t size)
 178 {
 179         KFILE_ASSERT_GENERIC(fd);
 180         const uint8_t *buf =(const uint8_t *)_buf;
 181
 182         avr_page_t page;
 183         avr_page_addr_t page_addr;
 184         size_t total_write = 0;
 185
 186         ASSERT(fd->seek_pos + size <= fd->size);
 187         size = MIN((uint32_t)size, fd->size - fd->seek_pos);
 188
 189         kprintf("Writing at pos[%u]\n", fd->seek_pos);
 190         while (size)
 191         {
 192                 page = fd->seek_pos / SPM_PAGESIZE;
 193                 page_addr = fd->seek_pos % SPM_PAGESIZE;
 194
 195                 flash_avr_loadPage(page);
 196
 197                 size_t wr_len = MIN(size, SPM_PAGESIZE - page_addr);
 198                 memcpy(page_buf + page_addr, buf, wr_len);
 199                 page_modified = true;
 200
 201                 buf += wr_len;
 202                 fd->seek_pos += wr_len;
 203                 size -= wr_len;
 204                 total_write += wr_len;
 205         }
 206         kprintf("written %u bytes\n", total_write);
 207         return total_write;
 208 }
 209
 210 /**
 211  * Open flash file \a fd
 212  * \a name and \a mode are unused, cause flash memory is
 213  * threated like one file.
 214  */
 215 static void flash_avr_open(struct KFile *fd)
 216 {
 217         KFILE_ASSERT_GENERIC(fd);
 218         curr_page = 0;
 219         memcpy_P(page_buf, (const char *)(curr_page * SPM_PAGESIZE), SPM_PAGESIZE);
 220
 221         fd->seek_pos = 0;
 222         fd->size = (uint16_t)(FLASHEND - CONFIG_BOOT_SIZE + 1);
 223         page_modified = false;
 224
 225         kprintf("Flash file opened\n");
 226 }
 227
 228 /**
 229  * Close file \a fd
 230  */
 231 static int flash_avr_close(UNUSED_ARG(struct KFile *,fd))
 232 {
 233         KFILE_ASSERT_GENERIC(fd);
 234         flash_avr_flush();
 235         kprintf("Flash file closed\n");
 236         return 0;
 237 }
 238
 239 /**
 240  * Reopen file \a fd
 241  */
 242 static struct KFile *flash_avr_reopen(struct KFile *fd)
 243 {
 244         KFILE_ASSERT_GENERIC(fd);
 245         flash_avr_close(fd);
 246         flash_avr_open(fd);
 247         return fd;
 248 }
 249
 250
 251 /**
 252  * Read from file \a fd \a size bytes and put it in buffer \a buf
 253  * \return the number of bytes read.
 254  */
 255 static size_t flash_avr_read(struct KFile *fd, void *buf, size_t size)
 256 {
 257         KFILE_ASSERT_GENERIC(fd);
 258         ASSERT(fd->seek_pos + size <= fd->size);
 259         size = MIN((uint32_t)size, fd->size - fd->seek_pos);
 260
 261         kprintf("Reading at pos[%u]\n", fd->seek_pos);
 262         // Flush current buffered page (if modified).
 263         flash_avr_flush();
 264
 265         /*
 266          * AVR pointers are 16 bits wide, this hack is needed to avoid
 267          * compiler warning, cause fd->seek_pos is a 32bit offset.
 268          */
 269         const uint8_t *pgm_addr = (const uint8_t *)0;
 270         pgm_addr += fd->seek_pos;
 271
 272         memcpy_P(buf, pgm_addr, size);
 273         fd->seek_pos += size;
 274         kprintf("Read %u bytes\n", size);
 275         return size;
 276 }
 277
 278 /**
 279  * Init AVR flash read/write file.
 280  */
 281 void flash_avr_init(struct KFile *fd)
 282 {
 283         memset(fd, 0, sizeof(*fd));
 284         DB(fd->_type = KFT_GENERIC);
 285
 286         // Set up flash programming functions.
 287         fd->reopen = flash_avr_reopen;
 288         fd->close = flash_avr_close;
 289         fd->read = flash_avr_read;
 290         fd->write = flash_avr_write;
 291         fd->seek = kfile_genericSeek;
 292         fd->flush = flash_avr_kfileFlush;
 293
 294         flash_avr_open(fd);
 295 }
 296