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