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