bertos/drv/mt29f.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 2011 Develer S.r.l. (http://www.develer.com/)
  30 * -->
  31 *
  32 * \brief Micron MT29F serial NAND driver
  33 *
  34 * This module allows read/write access to Micron MT29F serial
  35 * NANDs.
  36 * It is a block device, so it must be accessed using the KBlock
  37 * interface functions (see kblock.h).
  38 *
  39 * Once you have opened the flash for writing, you may want to use
  40 * kblock_trim() to avoid overwriting data on other flash banks.
  41 *
  42 * Example usage:
  43 * \code
  44 * Flash fls;
  45 * flash_init(&fls, 0);
  46 * // enable access only on desired blocks
  47 * // start block = 50, num blocks = 20
  48 * kblock_trim(&fls.blk, 50, 20);
  49 * // ...
  50 * // now write to the flash
  51 * // block number is automatically converted
  52 * kblock_write(&fls.blk, 0, buf, 0, 128);
  53 * \endcode
  54 *
  55 * \author Stefano Fedrigo <aleph@develer.com>
  56 *
  57 * $WIZ$ module_name = "mt29f"
  58 * $WIZ$ module_depends = "kfile", "kfile_block", "kblock"
  59 * $WIZ$ module_configuration = "bertos/cfg/cfg_mt29f.h"
  60 */
  61
  62 #ifndef DRV_MT29F_H
  63 #define DRV_MT29F_H
  64
  65 #include "cfg/cfg_mt29f.h"
  66
  67 #include <cfg/macros.h>
  68 #include <cfg/compiler.h>
  69
  70 #include <io/kblock.h>
  71 #include <io/kfile.h>
  72 #include <io/kfile_block.h>
  73
  74 #include <cpu/attr.h>
  75
  76
  77 /**
  78  * \name Error codes
  79  * \{
  80  */
  81 #define MT29F_ERR_ERASE    BV(1)   ///< Error erasing a block
  82 #define MT29F_ERR_WRITE    BV(2)   ///< Error writing a page
  83 /** \} */
  84
  85 struct Mt29fHardware;
  86
  87 /**
  88  * MT29F KBlock context structure.
  89  */
  90 typedef struct Mt29f
  91 {
  92         KBlock blk;                  ///< KBlock context
  93         struct Mt29fHardware *hw;
  94 } Mt29f;
  95
  96 /*
  97  * Kblock type ID.
  98  */
  99 #define KBT_MT29F MAKE_ID('M', 'T', '2', '9')
 100
 101 /**
 102  * Convert + ASSERT from generic KBlock to Flash.
 103  */
 104 INLINE Mt29f *FLASH_CAST(KBlock *fls)
 105 {
 106         ASSERT(fls->priv.type == KBT_MT29F);
 107         return (Mt29f *)fls;
 108 }
 109
 110 void mt29f_hw_init(Mt29f *fls);
 111 void mt29f_hw_initUnbuffered(Mt29f *fls);
 112
 113 #endif /* DRV_MT29F_H */