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