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  * \author Francesco Sacchi <batt@develer.com>
  34  * \author Daniele Basile <asterix@develer.com>
  35  *
  36  * \brief AVR Internal flash read/write driver.
  37  *
  38  *
  39  */
  40
  41 #ifndef FLASH_AT91_H
  42 #define FLASH_AT91_H
  43
  44 #include <cpu/types.h>
  45
  46 #include <cfg/compiler.h>
  47
  48 #include <io/kfile.h>
  49
  50 #include <avr/io.h>
  51
  52
  53 #define FLASH_PAGE_SIZE SPM_PAGESIZE
  54
  55 /**
  56  * Definition of type for avr flash module.
  57  */
  58 typedef uint16_t page_t;
  59
  60 /* Forward declaration */
  61 struct Flash;
  62
  63 /**
  64  * FlashAvr KFile context structure.
  65  * DEPREACTED STRUCTURE!
  66  * Use Flash instead
  67  *
  68  * \{
  69  */
  70 typedef struct FlashAvr
  71 {
  72         /**
  73          * File descriptor.
  74          */
  75         KFile fd;
  76
  77         /**
  78          * Flag for checking if current page is modified.
  79          */
  80         bool page_dirty;
  81
  82         /**
  83          * Current buffered page.
  84          */
  85         page_t curr_page;
  86
  87         /**
  88          * Temporary buffer cointaing data block to
  89          * write on flash.
  90          */
  91         uint8_t page_buf[SPM_PAGESIZE];
  92 } FlashAvr;
  93 /* \} */
  94
  95 void flash_hw_init(struct Flash *fd);
  96
  97 /**
  98  * WARNING!
  99  * This function is DEPRECADED!
 100  * use the flash module instead.
 101  */
 102 INLINE void flash_avr_init(struct FlashAvr *fd)
 103 {
 104         flash_hw_init((struct Flash *)fd);
 105 }
 106
 107 #endif /* DRV_FLASH_AVR_H */