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 * Mt29f chip;
  45 * mt29f_init(&chip);
  46 * // enable access only on desired blocks
  47 * // start block = 50, num blocks = 20
  48 * kblock_trim(&chip.blk, 50, 20);
  49 * // ...
  50 * // now write to the flash
  51 * // block number is automatically converted
  52 * kblock_write(&chip.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 <cpu/attr.h>
  71
  72
  73 /**
  74  * \name Error codes.
  75  * \{
  76  */
  77 #define MT29F_ERR_ERASE     BV(1)   ///< Error erasing a block
  78 #define MT29F_ERR_WRITE     BV(2)   ///< Error writing a page
  79 #define MT29F_ERR_RD_TMOUT  BV(2)   ///< Read timeout
  80 #define MT29F_ERR_WR_TMOUT  BV(2)   ///< Write timeout
  81 /** \} */
  82
  83
  84 /**
  85  * MT29F context.
  86  */
  87 typedef struct Mt29f
  88 {
  89         uint8_t status;
  90 } Mt29f;
  91
  92 void mt29f_init(Mt29f *chip);
  93 bool mt29f_getDevId(Mt29f *chip, uint8_t dev_id[5]);
  94 int mt29f_blockErase(Mt29f *chip, uint32_t blk);
  95 size_t mt29f_pageRead(Mt29f *chip, uint32_t page, void *buf, size_t offset, size_t size);
  96 size_t mt29f_pageWrite(Mt29f *chip, uint32_t page, const void *buf, size_t offset, size_t size);
  97 int mt29f_error(Mt29f *chip);
  98 void mt29f_clearError(Mt29f *chip);
  99
 100
 101 #endif /* DRV_MT29F_H */