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", "kfile_block", "kblock"
  40 * $WIZ$ module_configuration = "bertos/cfg/cfg_emb_flash.h"
  41 */
  42
  43 #ifndef DRV_FLASH_H
  44 #define DRV_FLASH_H
  45
  46 #include "cfg/cfg_emb_flash.h"
  47
  48 #include <cfg/macros.h>
  49 #include <cfg/compiler.h>
  50
  51 #include <io/kblock.h>
  52 #include <io/kfile.h>
  53 #include <io/kfile_block.h>
  54
  55 #include <cpu/attr.h>
  56
  57 #if COMPILER_C99
  58         #define flash_init(...)           PP_CAT(flash_init_, COUNT_PARMS(__VA_ARGS__)) (__VA_ARGS__)
  59 #else
  60         #define flash_init(args...)       PP_CAT(flash_init_, COUNT_PARMS(args)) (args)
  61 #endif
  62
  63 /*
  64  * Embedded flash error flags
  65  */
  66 #define FLASH_WR_OK             0     ///< Write ok.
  67 #define FLASH_NOT_ERASED     BV(1)    ///< Flash memory was not erased before to write it.
  68 #define FLASH_WR_PROTECT     BV(2)    ///< Write not allowed the flash memory was protected.
  69 #define FLASH_WR_TIMEOUT     BV(3)    ///< Timeout while writing
  70 #define FLASH_WR_ERR         BV(4)    ///< Invalid command and/or a bad keywords
  71
  72 struct FlashHardware;
  73
  74 /**
  75  * EmbFlash KFile context structure.
  76  */
  77 typedef struct Flash
  78 {
  79         KBlock blk;
  80         struct FlashHardware *hw;
  81         #if !CONFIG_FLASH_DISABLE_OLD_API
  82         union {
  83                 KFile fd;
  84                 KFileBlock fdblk;
  85         } DEPRECATED;
  86         #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
  87 } Flash;
  88
  89 /**
  90  * ID for FLASH
  91  */
  92 #define KBT_FLASH MAKE_ID('F', 'L', 'A', 'S')
  93
  94 /**
  95 * Convert + ASSERT from generic KBlock to Flash.
  96 */
  97 INLINE Flash *FLASH_CAST(KBlock *fls)
  98 {
  99         ASSERT(fls->priv.type == KBT_FLASH);
 100         return (Flash *)fls;
 101 }
 102
 103 void flash_hw_init(Flash *fls, int flags);
 104 void flash_hw_initUnbuffered(Flash *fls, int flags);
 105
 106 #include CPU_HEADER(flash)
 107
 108 #define FLASH_WRITE_ONCE   BV(0) ///< Allow only one write per block.
 109 #define FLASH_BUFFERED     BV(1) ///< Open flash memory using page caching, allowing the modification and partial write.
 110
 111 #define flash_init_2(fls, flags)    (flags & FLASH_BUFFERED) ? \
 112                                                                                 flash_hw_initUnbuffered(fls, flags) : flash_hw_init(fls, flags)
 113
 114 #if !CONFIG_FLASH_DISABLE_OLD_API
 115 INLINE DEPRECATED void flash_init_1(Flash *fls)
 116 {
 117         flash_hw_init(fls, 0);
 118         kfileblock_init(&fls->fdblk, &fls->blk);
 119 }
 120 #endif /* !CONFIG_FLASH_DISABLE_OLD_API */
 121
 122 #endif /* DRV_FLASH_H */