bertos/cpu/avr/drv/flash_avr.h

   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 (interface).
  34  *
  35  * \version $Id$
  36  * \author Francesco Sacchi <batt@develer.com>
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40 #ifndef DRV_FLASH_AVR_H
  41 #define DRV_FLASH_AVR_H
  42
  43 #include <cfg/compiler.h>
  44 #include <kern/kfile.h>
  45 #include <avr/io.h>
  46
  47
  48 /**
  49  * Definition of type for avr flash module.
  50  */
  51 typedef uint16_t avr_page_t;
  52
  53
  54 /**
  55  * FlashAvr KFile context structure.
  56  */
  57 typedef struct FlashAvrKFile
  58 {
  59         /**
  60          * File descriptor.
  61          */
  62         KFile fd;
  63
  64         /**
  65          * Current buffered page.
  66          */
  67         avr_page_t curr_page;
  68
  69         /**
  70          * Flag for checking if current page is modified.
  71          */
  72         bool page_dirty;
  73
  74         /**
  75          * Temporary buffer cointaing data block to
  76          * write on flash.
  77          */
  78         uint8_t page_buf[SPM_PAGESIZE];
  79
  80
  81 } FlashAvrKFile;
  82
  83
  84
  85 /**
  86  * ID for FlashAvr
  87  */
  88 #define KFT_FLASHAVR MAKE_ID('F', 'L', 'A', 'V')
  89
  90 /**
  91  * Convert + ASSERT from generic KFile to FlashAvrKFile.
  92  */
  93 INLINE FlashAvrKFile * FLASHAVRKFILE(KFile *fd)
  94 {
  95         ASSERT(fd->_type == KFT_FLASHAVR);
  96         return (FlashAvrKFile *)fd;
  97 }
  98
  99
 100 void flash_avr_init(struct FlashAvrKFile *fd);
 101
 102
 103
 104 #endif /* DRV_FLASH_AVR_H */