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