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 *
  37 * \author Stefano Fedrigo <aleph@develer.com>
  38 *
  39 * $WIZ$ module_name = "mt29f"
  40 * $WIZ$ module_depends = "timer", "kblock", "heap"
  41 * $WIZ$ module_configuration = "bertos/cfg/cfg_mt29f.h"
  42 */
  43
  44 #ifndef DRV_MT29F_H
  45 #define DRV_MT29F_H
  46
  47 #include "cfg/cfg_mt29f.h"
  48 #include <cfg/macros.h>
  49 #include <io/kblock.h>
  50
  51
  52 /**
  53  * \name Error codes.
  54  * \{
  55  */
  56 #define MT29F_ERR_ERASE     BV(1)   ///< Error erasing a block
  57 #define MT29F_ERR_WRITE     BV(2)   ///< Error writing a page
  58 #define MT29F_ERR_RD_TMOUT  BV(3)   ///< Read timeout
  59 #define MT29F_ERR_WR_TMOUT  BV(4)   ///< Write timeout
  60 #define MT29F_ERR_ECC       BV(5)   ///< Unrecoverable ECC error
  61 /** \} */
  62
  63
  64 /**
  65  * MT29F context.
  66  */
  67 typedef struct Mt29f
  68 {
  69         KBlock    fd;           // KBlock descriptor
  70
  71         uint8_t   chip_select;  // Chip select where NAND is connected
  72         uint8_t   status;       // Status bitmap
  73
  74         uint16_t *block_map;    // For bad blocks remapping
  75         uint16_t  remap_start;  // First unused remap block
  76 } Mt29f;
  77
  78 /*
  79  * Kblock id.
  80  */
  81 #define KBT_NAND  MAKE_ID('N', 'A', 'N', 'D')
  82
  83 /**
  84 * Convert + ASSERT from generic KBlock to NAND context.
  85 */
  86 INLINE Mt29f *MT29F_CAST(KBlock *kb)
  87 {
  88         ASSERT(kb->priv.type == KBT_NAND);
  89         return (Mt29f *)kb;
  90 }
  91
  92 struct Heap;
  93
  94 // Kblock interface
  95 bool mt29f_init(Mt29f *chip, struct Heap *heap, unsigned chip_select);
  96 bool mt29f_initUnbuffered(Mt29f *chip, struct Heap *heap, unsigned chip_select);
  97
  98 // Private functions: use at your own risk, could change in any moment
  99 bool mt29f_getDevId(Mt29f *chip, uint8_t dev_id[5]);
 100 int mt29f_blockErase(Mt29f *chip, uint16_t block);
 101
 102
 103 #endif /* DRV_MT29F_H */