bertos/cpu/arm/drv/flash_at91.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 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \author Daniele Basile <asterix@develer.com>
  34  *
  35  * \brief At91sam7 Internal flash read/write driver.
  36  *
  37  *
  38  */
  39
  40 #ifndef FLASH_AT91_H
  41 #define FLASH_AT91_H
  42
  43 #include <cpu/types.h>
  44
  45 #include <kern/kfile.h>
  46
  47 #include <io/arm.h>
  48
  49
  50 #define FLASH_PAGE_SIZE FLASH_PAGE_SIZE_BYTES
  51
  52 /**
  53  * Define data type to manage page and memory address.
  54  */
  55 typedef uint32_t page_t;
  56 typedef uint32_t page_addr_t;
  57
  58 struct Flash;
  59
  60 /**
  61  * FlashAt91 KFile context structure.
  62  *
  63  * DEPREACTED STRUCTURE!
  64  * Use EmbFlash instead
  65  *
  66  * \{
  67  */
  68 typedef struct FlashAt91
  69 {
  70         /**
  71          * File descriptor.
  72          */
  73         KFile fd;
  74
  75         /**
  76          * Flag for checking if current page is modified.
  77          */
  78         bool page_dirty;
  79
  80         /**
  81          * Current buffered page.
  82          */
  83         page_t curr_page;
  84
  85         /**
  86          * Temporary buffer cointaing data block to
  87          * write on flash.
  88          */
  89         uint8_t page_buf[FLASH_PAGE_SIZE_BYTES];
  90 } FlashAt91;
  91 /* \} */
  92
  93 void flash_hw_init(struct Flash *fd);
  94
  95 /**
  96  * WARNING!
  97  * This function is DEPRECADED!
  98  * use the emb_flash module instead.
  99  */
 100 INLINE void flash_at91_init(struct FlashAt91 *fd)
 101 {
 102         flash_hw_init((struct Flash *)fd);
 103 }
 104
 105 #endif /* DRV_FLASH_ARM_H */