bertos/drv/flash.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 2005 Develer S.r.l. (http://www.develer.com/)
  30 * -->
  31 *
  32 *
  33 * \brief Embedded flash for cpu.
  34 *
  35 * \author Francesco Sacchi <batt@develer.com>
  36 * \author Daniele Basile <asterix@develer.com>
  37 *
  38 * $WIZ$ module_name = "flash"
  39 * $WIZ$ module_depends = "kfile"
  40 */
  41
  42 #ifndef DRV_FLASH_H
  43 #define DRV_FLASH_H
  44
  45 #include <cfg/macros.h>
  46
  47 #include <io/kblock.h>
  48
  49 /*
  50  * Embedded flash error flags
  51  */
  52 #define FLASH_WR_OK             0     ///< Write ok.
  53 #define FLASH_NOT_ERASED     BV(1)    ///< Flash memory was not erased before to write it.
  54 #define FLASH_WR_PROTECT     BV(2)    ///< Write not allowed the flash memory was protected.
  55 #define FLASH_WR_TIMEOUT     BV(3)    ///<
  56
  57 struct FlashHardware;
  58
  59 /**
  60  * EmbFlash KFile context structure.
  61  */
  62 typedef struct Flash
  63 {
  64         KBlock blk;
  65         struct FlashHardware *hw;
  66 } Flash;
  67
  68 /**
  69  * ID for FLASH
  70  */
  71 #define KBT_FLASH MAKE_ID('F', 'L', 'A', 'S')
  72
  73 /**
  74 * Convert + ASSERT from generic KFile to Flash.
  75 */
  76 INLINE Flash *FLASH_CAST(KBlock *fls)
  77 {
  78         ASSERT(fls->priv.type == KBT_FLASH);
  79         return (Flash *)fls;
  80 }
  81
  82 void flash_hw_init(Flash *fls);
  83 void flash_hw_initUnbuffered(Flash *fls);
  84
  85 #include CPU_HEADER(flash)
  86
  87 INLINE void flash_init(Flash *fls)
  88 {
  89         flash_hw_init(fls);
  90 }
  91
  92 INLINE void flash_initUnbuffered(Flash *fls)
  93 {
  94         flash_hw_initUnbuffered(fls);
  95 }
  96
  97 #if 0
  98 /**
  99  * EmbFlash KFile context structure.
 100  */
 101 typedef struct Flash
 102 {
 103         /**
 104          * File descriptor.
 105          */
 106         KFile fd;
 107
 108         /**
 109          * Flag for checking if current page is modified.
 110          */
 111         bool page_dirty;
 112
 113         /**
 114          * Current buffered page.
 115          */
 116         page_t curr_page;
 117
 118         /**
 119          * Temporary buffer cointaing data block to
 120          * write on flash.
 121          */
 122         uint8_t page_buf[FLASH_PAGE_SIZE];
 123 } Flash;
 124
 125 /**
 126 * ID for FLASH
 127 */
 128 #define KFT_FLASH MAKE_ID('F', 'L', 'A', 'S')
 129
 130 /**
 131 * Convert + ASSERT from generic KFile to Flash.
 132 */
 133 INLINE Flash * FLASH_CAST(KFile *fd)
 134 {
 135         ASSERT(fd->_type == KFT_FLASH);
 136         return (Flash *)fd;
 137 }
 138
 139
 140 MOD_DEFINE(flash);
 141
 142 /**
 143  *
 144  * Initialize PWM hw.
 145  */
 146 INLINE void flash_init(Flash *fd)
 147 {
 148         flash_hw_init(fd);
 149
 150         MOD_INIT(flash);
 151 }
 152
 153 #endif
 154
 155
 156 #endif /* DRV_FLASH_H */
 157