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 * \addtogroup drv_emb_flash
  34 * \brief Embedded flash for cpu.
  35 *
  36 * \author Francesco Sacchi <batt@develer.com>
  37 * \author Daniele Basile <asterix@develer.com>
  38 *
  39 * $WIZ$ module_name = "flash"
  40 * $WIZ$ module_depends = "kfile", "kfile_block", "kblock"
  41 * $WIZ$ module_configuration = "bertos/cfg/cfg_emb_flash.h"
  42 */
  43
  44 #ifndef DRV_FLASH_H
  45 #define DRV_FLASH_H
  46
  47 #include "cfg/cfg_emb_flash.h"
  48
  49 #include <cfg/macros.h>
  50 #include <cfg/compiler.h>
  51
  52 #include <io/kblock.h>
  53 #include <io/kfile.h>
  54 #include <io/kfile_block.h>
  55
  56 #include <cpu/attr.h>
  57
  58 /**
  59  * \defgroup drv_emb_flash Embedded flash driver
  60  * \ingroup drivers
  61  * \{
  62  */
  63 #if COMPILER_C99
  64         #define flash_init(...)           PP_CAT(flash_init_, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  65 #else
  66         /**
  67          * Init function for flash driver.
  68          *
  69          * This macro cannot fail, so no error conditions are reported.
  70          *
  71          * This macro expands to
  72          *  - flash_init_2(Flash *fls, flags), the new KBlock API
  73          *  - flash_init_1(Flash *fls), old API, provided for compatibility
  74          *
  75          * Do NOT use the above functions directly, use flash_init() instead.
  76          * Disable old API if you are not upgrading an existing project.
  77          */
  78         #define flash_init(args...)       PP_CAT(flash_init_, COUNT_PARMS(args)) (args)
  79 #endif
  80
  81 /**
  82  * \name Embedded flash error values
  83  * \{
  84  */
  85 #define FLASH_WR_OK             0     ///< Write ok.
  86 #define FLASH_NOT_ERASED     BV(1)    ///< Flash memory was not erased before to write it.
  87 #define FLASH_WR_PROTECT     BV(2)    ///< Write not allowed the flash memory was protected.
  88 #define FLASH_WR_TIMEOUT     BV(3)    ///< Timeout while writing
  89 #define FLASH_WR_ERR         BV(4)    ///< Invalid command and/or a bad keywords
  90 /** \} */
  91
  92 struct FlashHardware;
  93
  94 /**
  95  * EmbFlash KBlock context structure.
  96  */
  97 typedef struct Flash
  98 {
  99         KBlock blk;
 100         struct FlashHardware *hw;
 101         #if !CONFIG_FLASH_DISABLE_OLD_API
 102         union {
 103                 KFile fd;
 104                 KFileBlock fdblk;
 105         } DEPRECATED;
 106         #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
 107 } Flash;
 108
 109 /**
 110  * ID for FLASH
 111  */
 112 #define KBT_FLASH MAKE_ID('F', 'L', 'A', 'S')
 113
 114 /**
 115 * Convert + ASSERT from generic KBlock to Flash.
 116 */
 117 INLINE Flash *FLASH_CAST(KBlock *fls)
 118 {
 119         ASSERT(fls->priv.type == KBT_FLASH);
 120         return (Flash *)fls;
 121 }
 122
 123 void flash_hw_init(Flash *fls, int flags);
 124 void flash_hw_initUnbuffered(Flash *fls, int flags);
 125
 126 #include CPU_HEADER(flash)
 127
 128 /**
 129  * \name Flash init flags
 130  * \{
 131  */
 132 #define FLASH_WRITE_ONCE   BV(0) ///< Allow only one write per block.
 133 #define FLASH_UNBUFFERED   BV(1) ///< Open flash memory disabling page caching, no modification and partial write are allowed.
 134 /** \} */
 135
 136 /**
 137  * Initialize \a fls Flash context structure.
 138  * \param fls Flash context structure
 139  * \param flags A combination of flash init flags
 140  */
 141 #define flash_init_2(fls, flags)    (flags & FLASH_UNBUFFERED) ? \
 142                                                                                 flash_hw_initUnbuffered(fls, flags) : flash_hw_init(fls, flags)
 143
 144 #if !CONFIG_FLASH_DISABLE_OLD_API
 145 INLINE DEPRECATED void flash_init_1(Flash *fls)
 146 {
 147         flash_hw_init(fls, 0);
 148         kfileblock_init(&fls->fdblk, &fls->blk);
 149 }
 150 #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
 151
 152 /** \} */
 153
 154 #endif /* DRV_FLASH_H */