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