mt29f nand: export formatting function and, if DEBUG active, function

[bertos.git] / bertos / drv / mt29f.h

diff --git a/bertos/drv/mt29f.h b/bertos/drv/mt29f.h
index 82078d4b2451f106e2863e7a22144911950f2dee..e2517994833295c34972e016e9d50a600a4ea4b7 100644 (file)
--- a/bertos/drv/mt29f.h
+++ b/bertos/drv/mt29f.h
@@ -33,29 +33,11 @@
 *
 * This module allows read/write access to Micron MT29F serial
 * NANDs.
-* It is a block device, so it must be accessed using the KBlock
-* interface functions (see kblock.h).
-*
-* Once you have opened the flash for writing, you may want to use
-* kblock_trim() to avoid overwriting data on other flash banks.
-*
-* Example usage:
-* \code
-* Mt29f chip;
-* mt29f_init(&chip);
-* // enable access only on desired blocks
-* // start block = 50, num blocks = 20
-* kblock_trim(&chip.blk, 50, 20);
-* // ...
-* // now write to the flash
-* // block number is automatically converted
-* kblock_write(&chip.blk, 0, buf, 0, 128);
-* \endcode
 *
 * \author Stefano Fedrigo <aleph@develer.com>
 *
 * $WIZ$ module_name = "mt29f"
-* $WIZ$ module_depends = "kfile", "kfile_block", "kblock"
+* $WIZ$ module_depends = "timer", "kblock", "heap"
 * $WIZ$ module_configuration = "bertos/cfg/cfg_mt29f.h"
 */
 
@@ -63,11 +45,8 @@
 #define DRV_MT29F_H
 
 #include "cfg/cfg_mt29f.h"
-
 #include <cfg/macros.h>
-//#include <cfg/compiler.h>
-
-//#include <cpu/attr.h>
+#include <io/kblock.h>
 
 
 /**
@@ -76,8 +55,9 @@
  */
 #define MT29F_ERR_ERASE     BV(1)   ///< Error erasing a block
 #define MT29F_ERR_WRITE     BV(2)   ///< Error writing a page
-#define MT29F_ERR_RD_TMOUT  BV(2)   ///< Read timeout
-#define MT29F_ERR_WR_TMOUT  BV(2)   ///< Write timeout
+#define MT29F_ERR_RD_TMOUT  BV(3)   ///< Read timeout
+#define MT29F_ERR_WR_TMOUT  BV(4)   ///< Write timeout
+#define MT29F_ERR_ECC       BV(5)   ///< Unrecoverable ECC error
 /** \} */
 
 
@@ -86,17 +66,43 @@
  */
 typedef struct Mt29f
 {
-       uint8_t chip_select;
-       uint8_t status;
+       KBlock    fd;           // KBlock descriptor
+
+       uint8_t   chip_select;  // Chip select where NAND is connected
+       uint8_t   status;       // Status bitmap
+
+       uint16_t *block_map;    // For bad blocks remapping
+       uint16_t  remap_start;  // First unused remap block
 } Mt29f;
 
-void mt29f_init(Mt29f *chip, uint8_t chip_select);
+/*
+ * Kblock id.
+ */
+#define KBT_NAND  MAKE_ID('N', 'A', 'N', 'D')
+
+/**
+* Convert + ASSERT from generic KBlock to NAND context.
+*/
+INLINE Mt29f *MT29F_CAST(KBlock *kb)
+{
+       ASSERT(kb->priv.type == KBT_NAND);
+       return (Mt29f *)kb;
+}
+
+struct Heap;
+
+// Kblock interface
+bool mt29f_init(Mt29f *chip, struct Heap *heap, unsigned chip_select);
+bool mt29f_initUnbuffered(Mt29f *chip, struct Heap *heap, unsigned chip_select);
+
+// NAND specific functions
 bool mt29f_getDevId(Mt29f *chip, uint8_t dev_id[5]);
-int mt29f_blockErase(Mt29f *chip, uint32_t blk);
-bool mt29f_read(Mt29f *chip, uint32_t page, void *buf, uint16_t size);
-bool mt29f_write(Mt29f *chip, uint32_t page, const void *buf, uint16_t size);
-int mt29f_error(Mt29f *chip);
-void mt29f_clearError(Mt29f *chip);
+int mt29f_blockErase(Mt29f *chip, uint16_t block);
+void mt29f_format(Mt29f *chip);
+
+#ifdef _DEBUG
+void mt29f_ruinSomeBlocks(Mt29f *chip);
+#endif
 
 
 #endif /* DRV_MT29F_H */