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 /**
  51  * Define data type to manage page and memory address.
  52  */
  53 typedef uint32_t arm_page_t;
  54 typedef uint32_t arm_page_addr_t;
  55
  56 /**
  57  * FlashAt91 KFile context structure.
  58  */
  59 typedef struct FlashAt91
  60 {
  61         /**
  62          * File descriptor.
  63          */
  64         KFile fd;
  65
  66         /**
  67          * Flag for checking if current page is modified.
  68          */
  69         bool page_dirty;
  70
  71         /**
  72          * Current buffered page.
  73          */
  74         arm_page_t curr_page;
  75
  76         /**
  77          * Temporary buffer cointaing data block to
  78          * write on flash.
  79          */
  80         uint8_t page_buf[FLASH_PAGE_SIZE_BYTES];
  81
  82
  83 } FlashAt91;
  84
  85 /**
  86  * ID for FlashAt91
  87  */
  88 #define KFT_FLASHAT91 MAKE_ID('F', 'A', '9', '1')
  89
  90 /**
  91  * Convert + ASSERT from generic KFile to FlashAt91.
  92  */
  93 INLINE FlashAt91 * FLASHAT91_CAST(KFile *fd)
  94 {
  95         ASSERT(fd->_type == KFT_FLASHAT91);
  96         return (FlashAt91 *)fd;
  97 }
  98
  99
 100 void flash_at91_init(FlashAt91 *fd);
 101
 102 #endif