drivers/mtd/nand/nandsim.c

   1 /*
   2  * NAND flash simulator.
   3  *
   4  * Author: Artem B. Bityuckiy <dedekind@oktetlabs.ru>, <dedekind@infradead.org>
   5  *
   6  * Copyright (C) 2004 Nokia Corporation
   7  *
   8  * Note: NS means "NAND Simulator".
   9  * Note: Input means input TO flash chip, output means output FROM chip.
  10  *
  11  * This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the GNU General Public License as published by the
  13  * Free Software Foundation; either version 2, or (at your option) any later
  14  * version.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
  19  * Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
  24  */
  25
  26 #include <linux/init.h>
  27 #include <linux/types.h>
  28 #include <linux/module.h>
  29 #include <linux/moduleparam.h>
  30 #include <linux/vmalloc.h>
  31 #include <linux/math64.h>
  32 #include <linux/slab.h>
  33 #include <linux/errno.h>
  34 #include <linux/string.h>
  35 #include <linux/mtd/mtd.h>
  36 #include <linux/mtd/nand.h>
  37 #include <linux/mtd/nand_bch.h>
  38 #include <linux/mtd/partitions.h>
  39 #include <linux/delay.h>
  40 #include <linux/list.h>
  41 #include <linux/random.h>
  42 #include <linux/sched.h>
  43 #include <linux/fs.h>
  44 #include <linux/pagemap.h>
  45
  46 /* Default simulator parameters values */
  47 #if !defined(CONFIG_NANDSIM_FIRST_ID_BYTE)  || \
  48     !defined(CONFIG_NANDSIM_SECOND_ID_BYTE) || \
  49     !defined(CONFIG_NANDSIM_THIRD_ID_BYTE)  || \
  50     !defined(CONFIG_NANDSIM_FOURTH_ID_BYTE)
  51 #define CONFIG_NANDSIM_FIRST_ID_BYTE  0x98
  52 #define CONFIG_NANDSIM_SECOND_ID_BYTE 0x39
  53 #define CONFIG_NANDSIM_THIRD_ID_BYTE  0xFF /* No byte */
  54 #define CONFIG_NANDSIM_FOURTH_ID_BYTE 0xFF /* No byte */
  55 #endif
  56
  57 #ifndef CONFIG_NANDSIM_ACCESS_DELAY
  58 #define CONFIG_NANDSIM_ACCESS_DELAY 25
  59 #endif
  60 #ifndef CONFIG_NANDSIM_PROGRAMM_DELAY
  61 #define CONFIG_NANDSIM_PROGRAMM_DELAY 200
  62 #endif
  63 #ifndef CONFIG_NANDSIM_ERASE_DELAY
  64 #define CONFIG_NANDSIM_ERASE_DELAY 2
  65 #endif
  66 #ifndef CONFIG_NANDSIM_OUTPUT_CYCLE
  67 #define CONFIG_NANDSIM_OUTPUT_CYCLE 40
  68 #endif
  69 #ifndef CONFIG_NANDSIM_INPUT_CYCLE
  70 #define CONFIG_NANDSIM_INPUT_CYCLE  50
  71 #endif
  72 #ifndef CONFIG_NANDSIM_BUS_WIDTH
  73 #define CONFIG_NANDSIM_BUS_WIDTH  8
  74 #endif
  75 #ifndef CONFIG_NANDSIM_DO_DELAYS
  76 #define CONFIG_NANDSIM_DO_DELAYS  0
  77 #endif
  78 #ifndef CONFIG_NANDSIM_LOG
  79 #define CONFIG_NANDSIM_LOG        0
  80 #endif
  81 #ifndef CONFIG_NANDSIM_DBG
  82 #define CONFIG_NANDSIM_DBG        0
  83 #endif
  84 #ifndef CONFIG_NANDSIM_MAX_PARTS
  85 #define CONFIG_NANDSIM_MAX_PARTS  32
  86 #endif
  87
  88 static uint first_id_byte  = CONFIG_NANDSIM_FIRST_ID_BYTE;
  89 static uint second_id_byte = CONFIG_NANDSIM_SECOND_ID_BYTE;
  90 static uint third_id_byte  = CONFIG_NANDSIM_THIRD_ID_BYTE;
  91 static uint fourth_id_byte = CONFIG_NANDSIM_FOURTH_ID_BYTE;
  92 static uint access_delay   = CONFIG_NANDSIM_ACCESS_DELAY;
  93 static uint programm_delay = CONFIG_NANDSIM_PROGRAMM_DELAY;
  94 static uint erase_delay    = CONFIG_NANDSIM_ERASE_DELAY;
  95 static uint output_cycle   = CONFIG_NANDSIM_OUTPUT_CYCLE;
  96 static uint input_cycle    = CONFIG_NANDSIM_INPUT_CYCLE;
  97 static uint bus_width      = CONFIG_NANDSIM_BUS_WIDTH;
  98 static uint do_delays      = CONFIG_NANDSIM_DO_DELAYS;
  99 static uint log            = CONFIG_NANDSIM_LOG;
 100 static uint dbg            = CONFIG_NANDSIM_DBG;
 101 static unsigned long parts[CONFIG_NANDSIM_MAX_PARTS];
 102 static unsigned int parts_num;
 103 static char *badblocks = NULL;
 104 static char *weakblocks = NULL;
 105 static char *weakpages = NULL;
 106 static unsigned int bitflips = 0;
 107 static char *gravepages = NULL;
 108 static unsigned int rptwear = 0;
 109 static unsigned int overridesize = 0;
 110 static char *cache_file = NULL;
 111 static unsigned int bbt;
 112 static unsigned int bch;
 113
 114 module_param(first_id_byte,  uint, 0400);
 115 module_param(second_id_byte, uint, 0400);
 116 module_param(third_id_byte,  uint, 0400);
 117 module_param(fourth_id_byte, uint, 0400);
 118 module_param(access_delay,   uint, 0400);
 119 module_param(programm_delay, uint, 0400);
 120 module_param(erase_delay,    uint, 0400);
 121 module_param(output_cycle,   uint, 0400);
 122 module_param(input_cycle,    uint, 0400);
 123 module_param(bus_width,      uint, 0400);
 124 module_param(do_delays,      uint, 0400);
 125 module_param(log,            uint, 0400);
 126 module_param(dbg,            uint, 0400);
 127 module_param_array(parts, ulong, &parts_num, 0400);
 128 module_param(badblocks,      charp, 0400);
 129 module_param(weakblocks,     charp, 0400);
 130 module_param(weakpages,      charp, 0400);
 131 module_param(bitflips,       uint, 0400);
 132 module_param(gravepages,     charp, 0400);
 133 module_param(rptwear,        uint, 0400);
 134 module_param(overridesize,   uint, 0400);
 135 module_param(cache_file,     charp, 0400);
 136 module_param(bbt,            uint, 0400);
 137 module_param(bch,            uint, 0400);
 138
 139 MODULE_PARM_DESC(first_id_byte,  "The first byte returned by NAND Flash 'read ID' command (manufacturer ID)");
 140 MODULE_PARM_DESC(second_id_byte, "The second byte returned by NAND Flash 'read ID' command (chip ID)");
 141 MODULE_PARM_DESC(third_id_byte,  "The third byte returned by NAND Flash 'read ID' command");
 142 MODULE_PARM_DESC(fourth_id_byte, "The fourth byte returned by NAND Flash 'read ID' command");
 143 MODULE_PARM_DESC(access_delay,   "Initial page access delay (microseconds)");
 144 MODULE_PARM_DESC(programm_delay, "Page programm delay (microseconds");
 145 MODULE_PARM_DESC(erase_delay,    "Sector erase delay (milliseconds)");
 146 MODULE_PARM_DESC(output_cycle,   "Word output (from flash) time (nanoseconds)");
 147 MODULE_PARM_DESC(input_cycle,    "Word input (to flash) time (nanoseconds)");
 148 MODULE_PARM_DESC(bus_width,      "Chip's bus width (8- or 16-bit)");
 149 MODULE_PARM_DESC(do_delays,      "Simulate NAND delays using busy-waits if not zero");
 150 MODULE_PARM_DESC(log,            "Perform logging if not zero");
 151 MODULE_PARM_DESC(dbg,            "Output debug information if not zero");
 152 MODULE_PARM_DESC(parts,          "Partition sizes (in erase blocks) separated by commas");
 153 /* Page and erase block positions for the following parameters are independent of any partitions */
 154 MODULE_PARM_DESC(badblocks,      "Erase blocks that are initially marked bad, separated by commas");
 155 MODULE_PARM_DESC(weakblocks,     "Weak erase blocks [: remaining erase cycles (defaults to 3)]"
 156                                  " separated by commas e.g. 113:2 means eb 113"
 157                                  " can be erased only twice before failing");
 158 MODULE_PARM_DESC(weakpages,      "Weak pages [: maximum writes (defaults to 3)]"
 159                                  " separated by commas e.g. 1401:2 means page 1401"
 160                                  " can be written only twice before failing");
 161 MODULE_PARM_DESC(bitflips,       "Maximum number of random bit flips per page (zero by default)");
 162 MODULE_PARM_DESC(gravepages,     "Pages that lose data [: maximum reads (defaults to 3)]"
 163                                  " separated by commas e.g. 1401:2 means page 1401"
 164                                  " can be read only twice before failing");
 165 MODULE_PARM_DESC(rptwear,        "Number of erases between reporting wear, if not zero");
 166 MODULE_PARM_DESC(overridesize,   "Specifies the NAND Flash size overriding the ID bytes. "
 167                                  "The size is specified in erase blocks and as the exponent of a power of two"
 168                                  " e.g. 5 means a size of 32 erase blocks");
 169 MODULE_PARM_DESC(cache_file,     "File to use to cache nand pages instead of memory");
 170 MODULE_PARM_DESC(bbt,            "0 OOB, 1 BBT with marker in OOB, 2 BBT with marker in data area");
 171 MODULE_PARM_DESC(bch,            "Enable BCH ecc and set how many bits should "
 172                                  "be correctable in 512-byte blocks");
 173
 174 /* The largest possible page size */
 175 #define NS_LARGEST_PAGE_SIZE    4096
 176
 177 /* The prefix for simulator output */
 178 #define NS_OUTPUT_PREFIX "[nandsim]"
 179
 180 /* Simulator's output macros (logging, debugging, warning, error) */
 181 #define NS_LOG(args...) \
 182         do { if (log) printk(KERN_DEBUG NS_OUTPUT_PREFIX " log: " args); } while(0)
 183 #define NS_DBG(args...) \
 184         do { if (dbg) printk(KERN_DEBUG NS_OUTPUT_PREFIX " debug: " args); } while(0)
 185 #define NS_WARN(args...) \
 186         do { printk(KERN_WARNING NS_OUTPUT_PREFIX " warning: " args); } while(0)
 187 #define NS_ERR(args...) \
 188         do { printk(KERN_ERR NS_OUTPUT_PREFIX " error: " args); } while(0)
 189 #define NS_INFO(args...) \
 190         do { printk(KERN_INFO NS_OUTPUT_PREFIX " " args); } while(0)
 191
 192 /* Busy-wait delay macros (microseconds, milliseconds) */
 193 #define NS_UDELAY(us) \
 194         do { if (do_delays) udelay(us); } while(0)
 195 #define NS_MDELAY(us) \
 196         do { if (do_delays) mdelay(us); } while(0)
 197
 198 /* Is the nandsim structure initialized ? */
 199 #define NS_IS_INITIALIZED(ns) ((ns)->geom.totsz != 0)
 200
 201 /* Good operation completion status */
 202 #define NS_STATUS_OK(ns) (NAND_STATUS_READY | (NAND_STATUS_WP * ((ns)->lines.wp == 0)))
 203
 204 /* Operation failed completion status */
 205 #define NS_STATUS_FAILED(ns) (NAND_STATUS_FAIL | NS_STATUS_OK(ns))
 206
 207 /* Calculate the page offset in flash RAM image by (row, column) address */
 208 #define NS_RAW_OFFSET(ns) \
 209         (((ns)->regs.row << (ns)->geom.pgshift) + ((ns)->regs.row * (ns)->geom.oobsz) + (ns)->regs.column)
 210
 211 /* Calculate the OOB offset in flash RAM image by (row, column) address */
 212 #define NS_RAW_OFFSET_OOB(ns) (NS_RAW_OFFSET(ns) + ns->geom.pgsz)
 213
 214 /* After a command is input, the simulator goes to one of the following states */
 215 #define STATE_CMD_READ0        0x00000001 /* read data from the beginning of page */
 216 #define STATE_CMD_READ1        0x00000002 /* read data from the second half of page */
 217 #define STATE_CMD_READSTART    0x00000003 /* read data second command (large page devices) */
 218 #define STATE_CMD_PAGEPROG     0x00000004 /* start page program */
 219 #define STATE_CMD_READOOB      0x00000005 /* read OOB area */
 220 #define STATE_CMD_ERASE1       0x00000006 /* sector erase first command */
 221 #define STATE_CMD_STATUS       0x00000007 /* read status */
 222 #define STATE_CMD_STATUS_M     0x00000008 /* read multi-plane status (isn't implemented) */
 223 #define STATE_CMD_SEQIN        0x00000009 /* sequential data input */
 224 #define STATE_CMD_READID       0x0000000A /* read ID */
 225 #define STATE_CMD_ERASE2       0x0000000B /* sector erase second command */
 226 #define STATE_CMD_RESET        0x0000000C /* reset */
 227 #define STATE_CMD_RNDOUT       0x0000000D /* random output command */
 228 #define STATE_CMD_RNDOUTSTART  0x0000000E /* random output start command */
 229 #define STATE_CMD_MASK         0x0000000F /* command states mask */
 230
 231 /* After an address is input, the simulator goes to one of these states */
 232 #define STATE_ADDR_PAGE        0x00000010 /* full (row, column) address is accepted */
 233 #define STATE_ADDR_SEC         0x00000020 /* sector address was accepted */
 234 #define STATE_ADDR_COLUMN      0x00000030 /* column address was accepted */
 235 #define STATE_ADDR_ZERO        0x00000040 /* one byte zero address was accepted */
 236 #define STATE_ADDR_MASK        0x00000070 /* address states mask */
 237
 238 /* During data input/output the simulator is in these states */
 239 #define STATE_DATAIN           0x00000100 /* waiting for data input */
 240 #define STATE_DATAIN_MASK      0x00000100 /* data input states mask */
 241
 242 #define STATE_DATAOUT          0x00001000 /* waiting for page data output */
 243 #define STATE_DATAOUT_ID       0x00002000 /* waiting for ID bytes output */
 244 #define STATE_DATAOUT_STATUS   0x00003000 /* waiting for status output */
 245 #define STATE_DATAOUT_STATUS_M 0x00004000 /* waiting for multi-plane status output */
 246 #define STATE_DATAOUT_MASK     0x00007000 /* data output states mask */
 247
 248 /* Previous operation is done, ready to accept new requests */
 249 #define STATE_READY            0x00000000
 250
 251 /* This state is used to mark that the next state isn't known yet */
 252 #define STATE_UNKNOWN          0x10000000
 253
 254 /* Simulator's actions bit masks */
 255 #define ACTION_CPY       0x00100000 /* copy page/OOB to the internal buffer */
 256 #define ACTION_PRGPAGE   0x00200000 /* program the internal buffer to flash */
 257 #define ACTION_SECERASE  0x00300000 /* erase sector */
 258 #define ACTION_ZEROOFF   0x00400000 /* don't add any offset to address */
 259 #define ACTION_HALFOFF   0x00500000 /* add to address half of page */
 260 #define ACTION_OOBOFF    0x00600000 /* add to address OOB offset */
 261 #define ACTION_MASK      0x00700000 /* action mask */
 262
 263 #define NS_OPER_NUM      13 /* Number of operations supported by the simulator */
 264 #define NS_OPER_STATES   6  /* Maximum number of states in operation */
 265
 266 #define OPT_ANY          0xFFFFFFFF /* any chip supports this operation */
 267 #define OPT_PAGE256      0x00000001 /* 256-byte  page chips */
 268 #define OPT_PAGE512      0x00000002 /* 512-byte  page chips */
 269 #define OPT_PAGE2048     0x00000008 /* 2048-byte page chips */
 270 #define OPT_SMARTMEDIA   0x00000010 /* SmartMedia technology chips */
 271 #define OPT_PAGE512_8BIT 0x00000040 /* 512-byte page chips with 8-bit bus width */
 272 #define OPT_PAGE4096     0x00000080 /* 4096-byte page chips */
 273 #define OPT_LARGEPAGE    (OPT_PAGE2048 | OPT_PAGE4096) /* 2048 & 4096-byte page chips */
 274 #define OPT_SMALLPAGE    (OPT_PAGE256  | OPT_PAGE512)  /* 256 and 512-byte page chips */
 275
 276 /* Remove action bits from state */
 277 #define NS_STATE(x) ((x) & ~ACTION_MASK)
 278
 279 /*
 280  * Maximum previous states which need to be saved. Currently saving is
 281  * only needed for page program operation with preceded read command
 282  * (which is only valid for 512-byte pages).
 283  */
 284 #define NS_MAX_PREVSTATES 1
 285
 286 /* Maximum page cache pages needed to read or write a NAND page to the cache_file */
 287 #define NS_MAX_HELD_PAGES 16
 288
 289 /*
 290  * A union to represent flash memory contents and flash buffer.
 291  */
 292 union ns_mem {
 293         u_char *byte;    /* for byte access */
 294         uint16_t *word;  /* for 16-bit word access */
 295 };
 296
 297 /*
 298  * The structure which describes all the internal simulator data.
 299  */
 300 struct nandsim {
 301         struct mtd_partition partitions[CONFIG_NANDSIM_MAX_PARTS];
 302         unsigned int nbparts;
 303
 304         uint busw;              /* flash chip bus width (8 or 16) */
 305         u_char ids[4];          /* chip's ID bytes */
 306         uint32_t options;       /* chip's characteristic bits */
 307         uint32_t state;         /* current chip state */
 308         uint32_t nxstate;       /* next expected state */
 309
 310         uint32_t *op;           /* current operation, NULL operations isn't known yet  */
 311         uint32_t pstates[NS_MAX_PREVSTATES]; /* previous states */
 312         uint16_t npstates;      /* number of previous states saved */
 313         uint16_t stateidx;      /* current state index */
 314
 315         /* The simulated NAND flash pages array */
 316         union ns_mem *pages;
 317
 318         /* Slab allocator for nand pages */
 319         struct kmem_cache *nand_pages_slab;
 320
 321         /* Internal buffer of page + OOB size bytes */
 322         union ns_mem buf;
 323
 324         /* NAND flash "geometry" */
 325         struct {
 326                 uint64_t totsz;     /* total flash size, bytes */
 327                 uint32_t secsz;     /* flash sector (erase block) size, bytes */
 328                 uint pgsz;          /* NAND flash page size, bytes */
 329                 uint oobsz;         /* page OOB area size, bytes */
 330                 uint64_t totszoob;  /* total flash size including OOB, bytes */
 331                 uint pgszoob;       /* page size including OOB , bytes*/
 332                 uint secszoob;      /* sector size including OOB, bytes */
 333                 uint pgnum;         /* total number of pages */
 334                 uint pgsec;         /* number of pages per sector */
 335                 uint secshift;      /* bits number in sector size */
 336                 uint pgshift;       /* bits number in page size */
 337                 uint oobshift;      /* bits number in OOB size */
 338                 uint pgaddrbytes;   /* bytes per page address */
 339                 uint secaddrbytes;  /* bytes per sector address */
 340                 uint idbytes;       /* the number ID bytes that this chip outputs */
 341         } geom;
 342
 343         /* NAND flash internal registers */
 344         struct {
 345                 unsigned command; /* the command register */
 346                 u_char   status;  /* the status register */
 347                 uint     row;     /* the page number */
 348                 uint     column;  /* the offset within page */
 349                 uint     count;   /* internal counter */
 350                 uint     num;     /* number of bytes which must be processed */
 351                 uint     off;     /* fixed page offset */
 352         } regs;
 353
 354         /* NAND flash lines state */
 355         struct {
 356                 int ce;  /* chip Enable */
 357                 int cle; /* command Latch Enable */
 358                 int ale; /* address Latch Enable */
 359                 int wp;  /* write Protect */
 360         } lines;
 361
 362         /* Fields needed when using a cache file */
 363         struct file *cfile; /* Open file */
 364         unsigned char *pages_written; /* Which pages have been written */
 365         void *file_buf;
 366         struct page *held_pages[NS_MAX_HELD_PAGES];
 367         int held_cnt;
 368 };
 369
 370 /*
 371  * Operations array. To perform any operation the simulator must pass
 372  * through the correspondent states chain.
 373  */
 374 static struct nandsim_operations {
 375         uint32_t reqopts;  /* options which are required to perform the operation */
 376         uint32_t states[NS_OPER_STATES]; /* operation's states */
 377 } ops[NS_OPER_NUM] = {
 378         /* Read page + OOB from the beginning */
 379         {OPT_SMALLPAGE, {STATE_CMD_READ0 | ACTION_ZEROOFF, STATE_ADDR_PAGE | ACTION_CPY,
 380                         STATE_DATAOUT, STATE_READY}},
 381         /* Read page + OOB from the second half */
 382         {OPT_PAGE512_8BIT, {STATE_CMD_READ1 | ACTION_HALFOFF, STATE_ADDR_PAGE | ACTION_CPY,
 383                         STATE_DATAOUT, STATE_READY}},
 384         /* Read OOB */
 385         {OPT_SMALLPAGE, {STATE_CMD_READOOB | ACTION_OOBOFF, STATE_ADDR_PAGE | ACTION_CPY,
 386                         STATE_DATAOUT, STATE_READY}},
 387         /* Program page starting from the beginning */
 388         {OPT_ANY, {STATE_CMD_SEQIN, STATE_ADDR_PAGE, STATE_DATAIN,
 389                         STATE_CMD_PAGEPROG | ACTION_PRGPAGE, STATE_READY}},
 390         /* Program page starting from the beginning */
 391         {OPT_SMALLPAGE, {STATE_CMD_READ0, STATE_CMD_SEQIN | ACTION_ZEROOFF, STATE_ADDR_PAGE,
 392                               STATE_DATAIN, STATE_CMD_PAGEPROG | ACTION_PRGPAGE, STATE_READY}},
 393         /* Program page starting from the second half */
 394         {OPT_PAGE512, {STATE_CMD_READ1, STATE_CMD_SEQIN | ACTION_HALFOFF, STATE_ADDR_PAGE,
 395                               STATE_DATAIN, STATE_CMD_PAGEPROG | ACTION_PRGPAGE, STATE_READY}},
 396         /* Program OOB */
 397         {OPT_SMALLPAGE, {STATE_CMD_READOOB, STATE_CMD_SEQIN | ACTION_OOBOFF, STATE_ADDR_PAGE,
 398                               STATE_DATAIN, STATE_CMD_PAGEPROG | ACTION_PRGPAGE, STATE_READY}},
 399         /* Erase sector */
 400         {OPT_ANY, {STATE_CMD_ERASE1, STATE_ADDR_SEC, STATE_CMD_ERASE2 | ACTION_SECERASE, STATE_READY}},
 401         /* Read status */
 402         {OPT_ANY, {STATE_CMD_STATUS, STATE_DATAOUT_STATUS, STATE_READY}},
 403         /* Read multi-plane status */
 404         {OPT_SMARTMEDIA, {STATE_CMD_STATUS_M, STATE_DATAOUT_STATUS_M, STATE_READY}},
 405         /* Read ID */
 406         {OPT_ANY, {STATE_CMD_READID, STATE_ADDR_ZERO, STATE_DATAOUT_ID, STATE_READY}},
 407         /* Large page devices read page */
 408         {OPT_LARGEPAGE, {STATE_CMD_READ0, STATE_ADDR_PAGE, STATE_CMD_READSTART | ACTION_CPY,
 409                                STATE_DATAOUT, STATE_READY}},
 410         /* Large page devices random page read */
 411         {OPT_LARGEPAGE, {STATE_CMD_RNDOUT, STATE_ADDR_COLUMN, STATE_CMD_RNDOUTSTART | ACTION_CPY,
 412                                STATE_DATAOUT, STATE_READY}},
 413 };
 414
 415 struct weak_block {
 416         struct list_head list;
 417         unsigned int erase_block_no;
 418         unsigned int max_erases;
 419         unsigned int erases_done;
 420 };
 421
 422 static LIST_HEAD(weak_blocks);
 423
 424 struct weak_page {
 425         struct list_head list;
 426         unsigned int page_no;
 427         unsigned int max_writes;
 428         unsigned int writes_done;
 429 };
 430
 431 static LIST_HEAD(weak_pages);
 432
 433 struct grave_page {
 434         struct list_head list;
 435         unsigned int page_no;
 436         unsigned int max_reads;
 437         unsigned int reads_done;
 438 };
 439
 440 static LIST_HEAD(grave_pages);
 441
 442 static unsigned long *erase_block_wear = NULL;
 443 static unsigned int wear_eb_count = 0;
 444 static unsigned long total_wear = 0;
 445 static unsigned int rptwear_cnt = 0;
 446
 447 /* MTD structure for NAND controller */
 448 static struct mtd_info *nsmtd;
 449
 450 /*
 451  * Allocate array of page pointers, create slab allocation for an array
 452  * and initialize the array by NULL pointers.
 453  *
 454  * RETURNS: 0 if success, -ENOMEM if memory alloc fails.
 455  */
 456 static int alloc_device(struct nandsim *ns)
 457 {
 458         struct file *cfile;
 459         int i, err;
 460
 461         if (cache_file) {
 462                 cfile = filp_open(cache_file, O_CREAT | O_RDWR | O_LARGEFILE, 0600);
 463                 if (IS_ERR(cfile))
 464                         return PTR_ERR(cfile);
 465                 if (!cfile->f_op || (!cfile->f_op->read && !cfile->f_op->aio_read)) {
 466                         NS_ERR("alloc_device: cache file not readable\n");
 467                         err = -EINVAL;
 468                         goto err_close;
 469                 }
 470                 if (!cfile->f_op->write && !cfile->f_op->aio_write) {
 471                         NS_ERR("alloc_device: cache file not writeable\n");
 472                         err = -EINVAL;
 473                         goto err_close;
 474                 }
 475                 ns->pages_written = vzalloc(ns->geom.pgnum);
 476                 if (!ns->pages_written) {
 477                         NS_ERR("alloc_device: unable to allocate pages written array\n");
 478                         err = -ENOMEM;
 479                         goto err_close;
 480                 }
 481                 ns->file_buf = kmalloc(ns->geom.pgszoob, GFP_KERNEL);
 482                 if (!ns->file_buf) {
 483                         NS_ERR("alloc_device: unable to allocate file buf\n");
 484                         err = -ENOMEM;
 485                         goto err_free;
 486                 }
 487                 ns->cfile = cfile;
 488                 return 0;
 489         }
 490
 491         ns->pages = vmalloc(ns->geom.pgnum * sizeof(union ns_mem));
 492         if (!ns->pages) {
 493                 NS_ERR("alloc_device: unable to allocate page array\n");
 494                 return -ENOMEM;
 495         }
 496         for (i = 0; i < ns->geom.pgnum; i++) {
 497                 ns->pages[i].byte = NULL;
 498         }
 499         ns->nand_pages_slab = kmem_cache_create("nandsim",
 500                                                 ns->geom.pgszoob, 0, 0, NULL);
 501         if (!ns->nand_pages_slab) {
 502                 NS_ERR("cache_create: unable to create kmem_cache\n");
 503                 return -ENOMEM;
 504         }
 505
 506         return 0;
 507
 508 err_free:
 509         vfree(ns->pages_written);
 510 err_close:
 511         filp_close(cfile, NULL);
 512         return err;
 513 }
 514
 515 /*
 516  * Free any allocated pages, and free the array of page pointers.
 517  */
 518 static void free_device(struct nandsim *ns)
 519 {
 520         int i;
 521
 522         if (ns->cfile) {
 523                 kfree(ns->file_buf);
 524                 vfree(ns->pages_written);
 525                 filp_close(ns->cfile, NULL);
 526                 return;
 527         }
 528
 529         if (ns->pages) {
 530                 for (i = 0; i < ns->geom.pgnum; i++) {
 531                         if (ns->pages[i].byte)
 532                                 kmem_cache_free(ns->nand_pages_slab,
 533                                                 ns->pages[i].byte);
 534                 }
 535                 kmem_cache_destroy(ns->nand_pages_slab);
 536                 vfree(ns->pages);
 537         }
 538 }
 539
 540 static char *get_partition_name(int i)
 541 {
 542         char buf[64];
 543         sprintf(buf, "NAND simulator partition %d", i);
 544         return kstrdup(buf, GFP_KERNEL);
 545 }
 546
 547 /*
 548  * Initialize the nandsim structure.
 549  *
 550  * RETURNS: 0 if success, -ERRNO if failure.
 551  */
 552 static int init_nandsim(struct mtd_info *mtd)
 553 {
 554         struct nand_chip *chip = mtd->priv;
 555         struct nandsim   *ns   = chip->priv;
 556         int i, ret = 0;
 557         uint64_t remains;
 558         uint64_t next_offset;
 559
 560         if (NS_IS_INITIALIZED(ns)) {
 561                 NS_ERR("init_nandsim: nandsim is already initialized\n");
 562                 return -EIO;
 563         }
 564
 565         /* Force mtd to not do delays */
 566         chip->chip_delay = 0;
 567
 568         /* Initialize the NAND flash parameters */
 569         ns->busw = chip->options & NAND_BUSWIDTH_16 ? 16 : 8;
 570         ns->geom.totsz    = mtd->size;
 571         ns->geom.pgsz     = mtd->writesize;
 572         ns->geom.oobsz    = mtd->oobsize;
 573         ns->geom.secsz    = mtd->erasesize;
 574         ns->geom.pgszoob  = ns->geom.pgsz + ns->geom.oobsz;
 575         ns->geom.pgnum    = div_u64(ns->geom.totsz, ns->geom.pgsz);
 576         ns->geom.totszoob = ns->geom.totsz + (uint64_t)ns->geom.pgnum * ns->geom.oobsz;
 577         ns->geom.secshift = ffs(ns->geom.secsz) - 1;
 578         ns->geom.pgshift  = chip->page_shift;
 579         ns->geom.oobshift = ffs(ns->geom.oobsz) - 1;
 580         ns->geom.pgsec    = ns->geom.secsz / ns->geom.pgsz;
 581         ns->geom.secszoob = ns->geom.secsz + ns->geom.oobsz * ns->geom.pgsec;
 582         ns->options = 0;
 583
 584         if (ns->geom.pgsz == 256) {
 585                 ns->options |= OPT_PAGE256;
 586         }
 587         else if (ns->geom.pgsz == 512) {
 588                 ns->options |= OPT_PAGE512;
 589                 if (ns->busw == 8)
 590                         ns->options |= OPT_PAGE512_8BIT;
 591         } else if (ns->geom.pgsz == 2048) {
 592                 ns->options |= OPT_PAGE2048;
 593         } else if (ns->geom.pgsz == 4096) {
 594                 ns->options |= OPT_PAGE4096;
 595         } else {
 596                 NS_ERR("init_nandsim: unknown page size %u\n", ns->geom.pgsz);
 597                 return -EIO;
 598         }
 599
 600         if (ns->options & OPT_SMALLPAGE) {
 601                 if (ns->geom.totsz <= (32 << 20)) {
 602                         ns->geom.pgaddrbytes  = 3;
 603                         ns->geom.secaddrbytes = 2;
 604                 } else {
 605                         ns->geom.pgaddrbytes  = 4;
 606                         ns->geom.secaddrbytes = 3;
 607                 }
 608         } else {
 609                 if (ns->geom.totsz <= (128 << 20)) {
 610                         ns->geom.pgaddrbytes  = 4;
 611                         ns->geom.secaddrbytes = 2;
 612                 } else {
 613                         ns->geom.pgaddrbytes  = 5;
 614                         ns->geom.secaddrbytes = 3;
 615                 }
 616         }
 617
 618         /* Fill the partition_info structure */
 619         if (parts_num > ARRAY_SIZE(ns->partitions)) {
 620                 NS_ERR("too many partitions.\n");
 621                 ret = -EINVAL;
 622                 goto error;
 623         }
 624         remains = ns->geom.totsz;
 625         next_offset = 0;
 626         for (i = 0; i < parts_num; ++i) {
 627                 uint64_t part_sz = (uint64_t)parts[i] * ns->geom.secsz;
 628
 629                 if (!part_sz || part_sz > remains) {
 630                         NS_ERR("bad partition size.\n");
 631                         ret = -EINVAL;
 632                         goto error;
 633                 }
 634                 ns->partitions[i].name   = get_partition_name(i);
 635                 ns->partitions[i].offset = next_offset;
 636                 ns->partitions[i].size   = part_sz;
 637                 next_offset += ns->partitions[i].size;
 638                 remains -= ns->partitions[i].size;
 639         }
 640         ns->nbparts = parts_num;
 641         if (remains) {
 642                 if (parts_num + 1 > ARRAY_SIZE(ns->partitions)) {
 643                         NS_ERR("too many partitions.\n");
 644                         ret = -EINVAL;
 645                         goto error;
 646                 }
 647                 ns->partitions[i].name   = get_partition_name(i);
 648                 ns->partitions[i].offset = next_offset;
 649                 ns->partitions[i].size   = remains;
 650                 ns->nbparts += 1;
 651         }
 652
 653         /* Detect how many ID bytes the NAND chip outputs */
 654         for (i = 0; nand_flash_ids[i].name != NULL; i++) {
 655                 if (second_id_byte != nand_flash_ids[i].id)
 656                         continue;
 657         }
 658
 659         if (ns->busw == 16)
 660                 NS_WARN("16-bit flashes support wasn't tested\n");
 661
 662         printk("flash size: %llu MiB\n",
 663                         (unsigned long long)ns->geom.totsz >> 20);
 664         printk("page size: %u bytes\n",         ns->geom.pgsz);
 665         printk("OOB area size: %u bytes\n",     ns->geom.oobsz);
 666         printk("sector size: %u KiB\n",         ns->geom.secsz >> 10);
 667         printk("pages number: %u\n",            ns->geom.pgnum);
 668         printk("pages per sector: %u\n",        ns->geom.pgsec);
 669         printk("bus width: %u\n",               ns->busw);
 670         printk("bits in sector size: %u\n",     ns->geom.secshift);
 671         printk("bits in page size: %u\n",       ns->geom.pgshift);
 672         printk("bits in OOB size: %u\n",        ns->geom.oobshift);
 673         printk("flash size with OOB: %llu KiB\n",
 674                         (unsigned long long)ns->geom.totszoob >> 10);
 675         printk("page address bytes: %u\n",      ns->geom.pgaddrbytes);
 676         printk("sector address bytes: %u\n",    ns->geom.secaddrbytes);
 677         printk("options: %#x\n",                ns->options);
 678
 679         if ((ret = alloc_device(ns)) != 0)
 680                 goto error;
 681
 682         /* Allocate / initialize the internal buffer */
 683         ns->buf.byte = kmalloc(ns->geom.pgszoob, GFP_KERNEL);
 684         if (!ns->buf.byte) {
 685                 NS_ERR("init_nandsim: unable to allocate %u bytes for the internal buffer\n",
 686                         ns->geom.pgszoob);
 687                 ret = -ENOMEM;
 688                 goto error;
 689         }
 690         memset(ns->buf.byte, 0xFF, ns->geom.pgszoob);
 691
 692         return 0;
 693
 694 error:
 695         free_device(ns);
 696
 697         return ret;
 698 }
 699
 700 /*
 701  * Free the nandsim structure.
 702  */
 703 static void free_nandsim(struct nandsim *ns)
 704 {
 705         kfree(ns->buf.byte);
 706         free_device(ns);
 707
 708         return;
 709 }
 710
 711 static int parse_badblocks(struct nandsim *ns, struct mtd_info *mtd)
 712 {
 713         char *w;
 714         int zero_ok;
 715         unsigned int erase_block_no;
 716         loff_t offset;
 717
 718         if (!badblocks)
 719                 return 0;
 720         w = badblocks;
 721         do {
 722                 zero_ok = (*w == '0' ? 1 : 0);
 723                 erase_block_no = simple_strtoul(w, &w, 0);
 724                 if (!zero_ok && !erase_block_no) {
 725                         NS_ERR("invalid badblocks.\n");
 726                         return -EINVAL;
 727                 }
 728                 offset = erase_block_no * ns->geom.secsz;
 729                 if (mtd_block_markbad(mtd, offset)) {
 730                         NS_ERR("invalid badblocks.\n");
 731                         return -EINVAL;
 732                 }
 733                 if (*w == ',')
 734                         w += 1;
 735         } while (*w);
 736         return 0;
 737 }
 738
 739 static int parse_weakblocks(void)
 740 {
 741         char *w;
 742         int zero_ok;
 743         unsigned int erase_block_no;
 744         unsigned int max_erases;
 745         struct weak_block *wb;
 746
 747         if (!weakblocks)
 748                 return 0;
 749         w = weakblocks;
 750         do {
 751                 zero_ok = (*w == '0' ? 1 : 0);
 752                 erase_block_no = simple_strtoul(w, &w, 0);
 753                 if (!zero_ok && !erase_block_no) {
 754                         NS_ERR("invalid weakblocks.\n");
 755                         return -EINVAL;
 756                 }
 757                 max_erases = 3;
 758                 if (*w == ':') {
 759                         w += 1;
 760                         max_erases = simple_strtoul(w, &w, 0);
 761                 }
 762                 if (*w == ',')
 763                         w += 1;
 764                 wb = kzalloc(sizeof(*wb), GFP_KERNEL);
 765                 if (!wb) {
 766                         NS_ERR("unable to allocate memory.\n");
 767                         return -ENOMEM;
 768                 }
 769                 wb->erase_block_no = erase_block_no;
 770                 wb->max_erases = max_erases;
 771                 list_add(&wb->list, &weak_blocks);
 772         } while (*w);
 773         return 0;
 774 }
 775
 776 static int erase_error(unsigned int erase_block_no)
 777 {
 778         struct weak_block *wb;
 779
 780         list_for_each_entry(wb, &weak_blocks, list)
 781                 if (wb->erase_block_no == erase_block_no) {
 782                         if (wb->erases_done >= wb->max_erases)
 783                                 return 1;
 784                         wb->erases_done += 1;
 785                         return 0;
 786                 }
 787         return 0;
 788 }
 789
 790 static int parse_weakpages(void)
 791 {
 792         char *w;
 793         int zero_ok;
 794         unsigned int page_no;
 795         unsigned int max_writes;
 796         struct weak_page *wp;
 797
 798         if (!weakpages)
 799                 return 0;
 800         w = weakpages;
 801         do {
 802                 zero_ok = (*w == '0' ? 1 : 0);
 803                 page_no = simple_strtoul(w, &w, 0);
 804                 if (!zero_ok && !page_no) {
 805                         NS_ERR("invalid weakpagess.\n");
 806                         return -EINVAL;
 807                 }
 808                 max_writes = 3;
 809                 if (*w == ':') {
 810                         w += 1;
 811                         max_writes = simple_strtoul(w, &w, 0);
 812                 }
 813                 if (*w == ',')
 814                         w += 1;
 815                 wp = kzalloc(sizeof(*wp), GFP_KERNEL);
 816                 if (!wp) {
 817                         NS_ERR("unable to allocate memory.\n");
 818                         return -ENOMEM;
 819                 }
 820                 wp->page_no = page_no;
 821                 wp->max_writes = max_writes;
 822                 list_add(&wp->list, &weak_pages);
 823         } while (*w);
 824         return 0;
 825 }
 826
 827 static int write_error(unsigned int page_no)
 828 {
 829         struct weak_page *wp;
 830
 831         list_for_each_entry(wp, &weak_pages, list)
 832                 if (wp->page_no == page_no) {
 833                         if (wp->writes_done >= wp->max_writes)
 834                                 return 1;
 835                         wp->writes_done += 1;
 836                         return 0;
 837                 }
 838         return 0;
 839 }
 840
 841 static int parse_gravepages(void)
 842 {
 843         char *g;
 844         int zero_ok;
 845         unsigned int page_no;
 846         unsigned int max_reads;
 847         struct grave_page *gp;
 848
 849         if (!gravepages)
 850                 return 0;
 851         g = gravepages;
 852         do {
 853                 zero_ok = (*g == '0' ? 1 : 0);
 854                 page_no = simple_strtoul(g, &g, 0);
 855                 if (!zero_ok && !page_no) {
 856                         NS_ERR("invalid gravepagess.\n");
 857                         return -EINVAL;
 858                 }
 859                 max_reads = 3;
 860                 if (*g == ':') {
 861                         g += 1;
 862                         max_reads = simple_strtoul(g, &g, 0);
 863                 }
 864                 if (*g == ',')
 865                         g += 1;
 866                 gp = kzalloc(sizeof(*gp), GFP_KERNEL);
 867                 if (!gp) {
 868                         NS_ERR("unable to allocate memory.\n");
 869                         return -ENOMEM;
 870                 }
 871                 gp->page_no = page_no;
 872                 gp->max_reads = max_reads;
 873                 list_add(&gp->list, &grave_pages);
 874         } while (*g);
 875         return 0;
 876 }
 877
 878 static int read_error(unsigned int page_no)
 879 {
 880         struct grave_page *gp;
 881
 882         list_for_each_entry(gp, &grave_pages, list)
 883                 if (gp->page_no == page_no) {
 884                         if (gp->reads_done >= gp->max_reads)
 885                                 return 1;
 886                         gp->reads_done += 1;
 887                         return 0;
 888                 }
 889         return 0;
 890 }
 891
 892 static void free_lists(void)
 893 {
 894         struct list_head *pos, *n;
 895         list_for_each_safe(pos, n, &weak_blocks) {
 896                 list_del(pos);
 897                 kfree(list_entry(pos, struct weak_block, list));
 898         }
 899         list_for_each_safe(pos, n, &weak_pages) {
 900                 list_del(pos);
 901                 kfree(list_entry(pos, struct weak_page, list));
 902         }
 903         list_for_each_safe(pos, n, &grave_pages) {
 904                 list_del(pos);
 905                 kfree(list_entry(pos, struct grave_page, list));
 906         }
 907         kfree(erase_block_wear);
 908 }
 909
 910 static int setup_wear_reporting(struct mtd_info *mtd)
 911 {
 912         size_t mem;
 913
 914         if (!rptwear)
 915                 return 0;
 916         wear_eb_count = div_u64(mtd->size, mtd->erasesize);
 917         mem = wear_eb_count * sizeof(unsigned long);
 918         if (mem / sizeof(unsigned long) != wear_eb_count) {
 919                 NS_ERR("Too many erase blocks for wear reporting\n");
 920                 return -ENOMEM;
 921         }
 922         erase_block_wear = kzalloc(mem, GFP_KERNEL);
 923         if (!erase_block_wear) {
 924                 NS_ERR("Too many erase blocks for wear reporting\n");
 925                 return -ENOMEM;
 926         }
 927         return 0;
 928 }
 929
 930 static void update_wear(unsigned int erase_block_no)
 931 {
 932         unsigned long wmin = -1, wmax = 0, avg;
 933         unsigned long deciles[10], decile_max[10], tot = 0;
 934         unsigned int i;
 935
 936         if (!erase_block_wear)
 937                 return;
 938         total_wear += 1;
 939         if (total_wear == 0)
 940                 NS_ERR("Erase counter total overflow\n");
 941         erase_block_wear[erase_block_no] += 1;
 942         if (erase_block_wear[erase_block_no] == 0)
 943                 NS_ERR("Erase counter overflow for erase block %u\n", erase_block_no);
 944         rptwear_cnt += 1;
 945         if (rptwear_cnt < rptwear)
 946                 return;
 947         rptwear_cnt = 0;
 948         /* Calc wear stats */
 949         for (i = 0; i < wear_eb_count; ++i) {
 950                 unsigned long wear = erase_block_wear[i];
 951                 if (wear < wmin)
 952                         wmin = wear;
 953                 if (wear > wmax)
 954                         wmax = wear;
 955                 tot += wear;
 956         }
 957         for (i = 0; i < 9; ++i) {
 958                 deciles[i] = 0;
 959                 decile_max[i] = (wmax * (i + 1) + 5) / 10;
 960         }
 961         deciles[9] = 0;
 962         decile_max[9] = wmax;
 963         for (i = 0; i < wear_eb_count; ++i) {
 964                 int d;
 965                 unsigned long wear = erase_block_wear[i];
 966                 for (d = 0; d < 10; ++d)
 967                         if (wear <= decile_max[d]) {
 968                                 deciles[d] += 1;
 969                                 break;
 970                         }
 971         }
 972         avg = tot / wear_eb_count;
 973         /* Output wear report */
 974         NS_INFO("*** Wear Report ***\n");
 975         NS_INFO("Total numbers of erases:  %lu\n", tot);
 976         NS_INFO("Number of erase blocks:   %u\n", wear_eb_count);
 977         NS_INFO("Average number of erases: %lu\n", avg);
 978         NS_INFO("Maximum number of erases: %lu\n", wmax);
 979         NS_INFO("Minimum number of erases: %lu\n", wmin);
 980         for (i = 0; i < 10; ++i) {
 981                 unsigned long from = (i ? decile_max[i - 1] + 1 : 0);
 982                 if (from > decile_max[i])
 983                         continue;
 984                 NS_INFO("Number of ebs with erase counts from %lu to %lu : %lu\n",
 985                         from,
 986                         decile_max[i],
 987                         deciles[i]);
 988         }
 989         NS_INFO("*** End of Wear Report ***\n");
 990 }
 991
 992 /*
 993  * Returns the string representation of 'state' state.
 994  */
 995 static char *get_state_name(uint32_t state)
 996 {
 997         switch (NS_STATE(state)) {
 998                 case STATE_CMD_READ0:
 999                         return "STATE_CMD_READ0";
1000                 case STATE_CMD_READ1:
1001                         return "STATE_CMD_READ1";
1002                 case STATE_CMD_PAGEPROG:
1003                         return "STATE_CMD_PAGEPROG";
1004                 case STATE_CMD_READOOB:
1005                         return "STATE_CMD_READOOB";
1006                 case STATE_CMD_READSTART:
1007                         return "STATE_CMD_READSTART";
1008                 case STATE_CMD_ERASE1:
1009                         return "STATE_CMD_ERASE1";
1010                 case STATE_CMD_STATUS:
1011                         return "STATE_CMD_STATUS";
1012                 case STATE_CMD_STATUS_M:
1013                         return "STATE_CMD_STATUS_M";
1014                 case STATE_CMD_SEQIN:
1015                         return "STATE_CMD_SEQIN";
1016                 case STATE_CMD_READID:
1017                         return "STATE_CMD_READID";
1018                 case STATE_CMD_ERASE2:
1019                         return "STATE_CMD_ERASE2";
1020                 case STATE_CMD_RESET:
1021                         return "STATE_CMD_RESET";
1022                 case STATE_CMD_RNDOUT:
1023                         return "STATE_CMD_RNDOUT";
1024                 case STATE_CMD_RNDOUTSTART:
1025                         return "STATE_CMD_RNDOUTSTART";
1026                 case STATE_ADDR_PAGE:
1027                         return "STATE_ADDR_PAGE";
1028                 case STATE_ADDR_SEC:
1029                         return "STATE_ADDR_SEC";
1030                 case STATE_ADDR_ZERO:
1031                         return "STATE_ADDR_ZERO";
1032                 case STATE_ADDR_COLUMN:
1033                         return "STATE_ADDR_COLUMN";
1034                 case STATE_DATAIN:
1035                         return "STATE_DATAIN";
1036                 case STATE_DATAOUT:
1037                         return "STATE_DATAOUT";
1038                 case STATE_DATAOUT_ID:
1039                         return "STATE_DATAOUT_ID";
1040                 case STATE_DATAOUT_STATUS:
1041                         return "STATE_DATAOUT_STATUS";
1042                 case STATE_DATAOUT_STATUS_M:
1043                         return "STATE_DATAOUT_STATUS_M";
1044                 case STATE_READY:
1045                         return "STATE_READY";
1046                 case STATE_UNKNOWN:
1047                         return "STATE_UNKNOWN";
1048         }
1049
1050         NS_ERR("get_state_name: unknown state, BUG\n");
1051         return NULL;
1052 }
1053
1054 /*
1055  * Check if command is valid.
1056  *
1057  * RETURNS: 1 if wrong command, 0 if right.
1058  */
1059 static int check_command(int cmd)
1060 {
1061         switch (cmd) {
1062
1063         case NAND_CMD_READ0:
1064         case NAND_CMD_READ1:
1065         case NAND_CMD_READSTART:
1066         case NAND_CMD_PAGEPROG:
1067         case NAND_CMD_READOOB:
1068         case NAND_CMD_ERASE1:
1069         case NAND_CMD_STATUS:
1070         case NAND_CMD_SEQIN:
1071         case NAND_CMD_READID:
1072         case NAND_CMD_ERASE2:
1073         case NAND_CMD_RESET:
1074         case NAND_CMD_RNDOUT:
1075         case NAND_CMD_RNDOUTSTART:
1076                 return 0;
1077
1078         case NAND_CMD_STATUS_MULTI:
1079         default:
1080                 return 1;
1081         }
1082 }
1083
1084 /*
1085  * Returns state after command is accepted by command number.
1086  */
1087 static uint32_t get_state_by_command(unsigned command)
1088 {
1089         switch (command) {
1090                 case NAND_CMD_READ0:
1091                         return STATE_CMD_READ0;
1092                 case NAND_CMD_READ1:
1093                         return STATE_CMD_READ1;
1094                 case NAND_CMD_PAGEPROG:
1095                         return STATE_CMD_PAGEPROG;
1096                 case NAND_CMD_READSTART:
1097                         return STATE_CMD_READSTART;
1098                 case NAND_CMD_READOOB:
1099                         return STATE_CMD_READOOB;
1100                 case NAND_CMD_ERASE1:
1101                         return STATE_CMD_ERASE1;
1102                 case NAND_CMD_STATUS:
1103                         return STATE_CMD_STATUS;
1104                 case NAND_CMD_STATUS_MULTI:
1105                         return STATE_CMD_STATUS_M;
1106                 case NAND_CMD_SEQIN:
1107                         return STATE_CMD_SEQIN;
1108                 case NAND_CMD_READID:
1109                         return STATE_CMD_READID;
1110                 case NAND_CMD_ERASE2:
1111                         return STATE_CMD_ERASE2;
1112                 case NAND_CMD_RESET:
1113                         return STATE_CMD_RESET;
1114                 case NAND_CMD_RNDOUT:
1115                         return STATE_CMD_RNDOUT;
1116                 case NAND_CMD_RNDOUTSTART:
1117                         return STATE_CMD_RNDOUTSTART;
1118         }
1119
1120         NS_ERR("get_state_by_command: unknown command, BUG\n");
1121         return 0;
1122 }
1123
1124 /*
1125  * Move an address byte to the correspondent internal register.
1126  */
1127 static inline void accept_addr_byte(struct nandsim *ns, u_char bt)
1128 {
1129         uint byte = (uint)bt;
1130
1131         if (ns->regs.count < (ns->geom.pgaddrbytes - ns->geom.secaddrbytes))
1132                 ns->regs.column |= (byte << 8 * ns->regs.count);
1133         else {
1134                 ns->regs.row |= (byte << 8 * (ns->regs.count -
1135                                                 ns->geom.pgaddrbytes +
1136                                                 ns->geom.secaddrbytes));
1137         }
1138
1139         return;
1140 }
1141
1142 /*
1143  * Switch to STATE_READY state.
1144  */
1145 static inline void switch_to_ready_state(struct nandsim *ns, u_char status)
1146 {
1147         NS_DBG("switch_to_ready_state: switch to %s state\n", get_state_name(STATE_READY));
1148
1149         ns->state       = STATE_READY;
1150         ns->nxstate     = STATE_UNKNOWN;
1151         ns->op          = NULL;
1152         ns->npstates    = 0;
1153         ns->stateidx    = 0;
1154         ns->regs.num    = 0;
1155         ns->regs.count  = 0;
1156         ns->regs.off    = 0;
1157         ns->regs.row    = 0;
1158         ns->regs.column = 0;
1159         ns->regs.status = status;
1160 }
1161
1162 /*
1163  * If the operation isn't known yet, try to find it in the global array
1164  * of supported operations.
1165  *
1166  * Operation can be unknown because of the following.
1167  *   1. New command was accepted and this is the first call to find the
1168  *      correspondent states chain. In this case ns->npstates = 0;
1169  *   2. There are several operations which begin with the same command(s)
1170  *      (for example program from the second half and read from the
1171  *      second half operations both begin with the READ1 command). In this
1172  *      case the ns->pstates[] array contains previous states.
1173  *
1174  * Thus, the function tries to find operation containing the following
1175  * states (if the 'flag' parameter is 0):
1176  *    ns->pstates[0], ... ns->pstates[ns->npstates], ns->state
1177  *
1178  * If (one and only one) matching operation is found, it is accepted (
1179  * ns->ops, ns->state, ns->nxstate are initialized, ns->npstate is
1180  * zeroed).
1181  *
1182  * If there are several matches, the current state is pushed to the
1183  * ns->pstates.
1184  *
1185  * The operation can be unknown only while commands are input to the chip.
1186  * As soon as address command is accepted, the operation must be known.
1187  * In such situation the function is called with 'flag' != 0, and the
1188  * operation is searched using the following pattern:
1189  *     ns->pstates[0], ... ns->pstates[ns->npstates], <address input>
1190  *
1191  * It is supposed that this pattern must either match one operation or
1192  * none. There can't be ambiguity in that case.
1193  *
1194  * If no matches found, the function does the following:
1195  *   1. if there are saved states present, try to ignore them and search
1196  *      again only using the last command. If nothing was found, switch
1197  *      to the STATE_READY state.
1198  *   2. if there are no saved states, switch to the STATE_READY state.
1199  *
1200  * RETURNS: -2 - no matched operations found.
1201  *          -1 - several matches.
1202  *           0 - operation is found.
1203  */
1204 static int find_operation(struct nandsim *ns, uint32_t flag)
1205 {
1206         int opsfound = 0;
1207         int i, j, idx = 0;
1208
1209         for (i = 0; i < NS_OPER_NUM; i++) {
1210
1211                 int found = 1;
1212
1213                 if (!(ns->options & ops[i].reqopts))
1214                         /* Ignore operations we can't perform */
1215                         continue;
1216
1217                 if (flag) {
1218                         if (!(ops[i].states[ns->npstates] & STATE_ADDR_MASK))
1219                                 continue;
1220                 } else {
1221                         if (NS_STATE(ns->state) != NS_STATE(ops[i].states[ns->npstates]))
1222                                 continue;
1223                 }
1224
1225                 for (j = 0; j < ns->npstates; j++)
1226                         if (NS_STATE(ops[i].states[j]) != NS_STATE(ns->pstates[j])
1227                                 && (ns->options & ops[idx].reqopts)) {
1228                                 found = 0;
1229                                 break;
1230                         }
1231
1232                 if (found) {
1233                         idx = i;
1234                         opsfound += 1;
1235                 }
1236         }
1237
1238         if (opsfound == 1) {
1239                 /* Exact match */
1240                 ns->op = &ops[idx].states[0];
1241                 if (flag) {
1242                         /*
1243                          * In this case the find_operation function was
1244                          * called when address has just began input. But it isn't
1245                          * yet fully input and the current state must
1246                          * not be one of STATE_ADDR_*, but the STATE_ADDR_*
1247                          * state must be the next state (ns->nxstate).
1248                          */
1249                         ns->stateidx = ns->npstates - 1;
1250                 } else {
1251                         ns->stateidx = ns->npstates;
1252                 }
1253                 ns->npstates = 0;
1254                 ns->state = ns->op[ns->stateidx];
1255                 ns->nxstate = ns->op[ns->stateidx + 1];
1256                 NS_DBG("find_operation: operation found, index: %d, state: %s, nxstate %s\n",
1257                                 idx, get_state_name(ns->state), get_state_name(ns->nxstate));
1258                 return 0;
1259         }
1260
1261         if (opsfound == 0) {
1262                 /* Nothing was found. Try to ignore previous commands (if any) and search again */
1263                 if (ns->npstates != 0) {
1264                         NS_DBG("find_operation: no operation found, try again with state %s\n",
1265                                         get_state_name(ns->state));
1266                         ns->npstates = 0;
1267                         return find_operation(ns, 0);
1268
1269                 }
1270                 NS_DBG("find_operation: no operations found\n");
1271                 switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
1272                 return -2;
1273         }
1274
1275         if (flag) {
1276                 /* This shouldn't happen */
1277                 NS_DBG("find_operation: BUG, operation must be known if address is input\n");
1278                 return -2;
1279         }
1280
1281         NS_DBG("find_operation: there is still ambiguity\n");
1282
1283         ns->pstates[ns->npstates++] = ns->state;
1284
1285         return -1;
1286 }
1287
1288 static void put_pages(struct nandsim *ns)
1289 {
1290         int i;
1291
1292         for (i = 0; i < ns->held_cnt; i++)
1293                 page_cache_release(ns->held_pages[i]);
1294 }
1295
1296 /* Get page cache pages in advance to provide NOFS memory allocation */
1297 static int get_pages(struct nandsim *ns, struct file *file, size_t count, loff_t pos)
1298 {
1299         pgoff_t index, start_index, end_index;
1300         struct page *page;
1301         struct address_space *mapping = file->f_mapping;
1302
1303         start_index = pos >> PAGE_CACHE_SHIFT;
1304         end_index = (pos + count - 1) >> PAGE_CACHE_SHIFT;
1305         if (end_index - start_index + 1 > NS_MAX_HELD_PAGES)
1306                 return -EINVAL;
1307         ns->held_cnt = 0;
1308         for (index = start_index; index <= end_index; index++) {
1309                 page = find_get_page(mapping, index);
1310                 if (page == NULL) {
1311                         page = find_or_create_page(mapping, index, GFP_NOFS);
1312                         if (page == NULL) {
1313                                 write_inode_now(mapping->host, 1);
1314                                 page = find_or_create_page(mapping, index, GFP_NOFS);
1315                         }
1316                         if (page == NULL) {
1317                                 put_pages(ns);
1318                                 return -ENOMEM;
1319                         }
1320                         unlock_page(page);
1321                 }
1322                 ns->held_pages[ns->held_cnt++] = page;
1323         }
1324         return 0;
1325 }
1326
1327 static int set_memalloc(void)
1328 {
1329         if (current->flags & PF_MEMALLOC)
1330                 return 0;
1331         current->flags |= PF_MEMALLOC;
1332         return 1;
1333 }
1334
1335 static void clear_memalloc(int memalloc)
1336 {
1337         if (memalloc)
1338                 current->flags &= ~PF_MEMALLOC;
1339 }
1340
1341 static ssize_t read_file(struct nandsim *ns, struct file *file, void *buf, size_t count, loff_t *pos)
1342 {
1343         mm_segment_t old_fs;
1344         ssize_t tx;
1345         int err, memalloc;
1346
1347         err = get_pages(ns, file, count, *pos);
1348         if (err)
1349                 return err;
1350         old_fs = get_fs();
1351         set_fs(get_ds());
1352         memalloc = set_memalloc();
1353         tx = vfs_read(file, (char __user *)buf, count, pos);
1354         clear_memalloc(memalloc);
1355         set_fs(old_fs);
1356         put_pages(ns);
1357         return tx;
1358 }
1359
1360 static ssize_t write_file(struct nandsim *ns, struct file *file, void *buf, size_t count, loff_t *pos)
1361 {
1362         mm_segment_t old_fs;
1363         ssize_t tx;
1364         int err, memalloc;
1365
1366         err = get_pages(ns, file, count, *pos);
1367         if (err)
1368                 return err;
1369         old_fs = get_fs();
1370         set_fs(get_ds());
1371         memalloc = set_memalloc();
1372         tx = vfs_write(file, (char __user *)buf, count, pos);
1373         clear_memalloc(memalloc);
1374         set_fs(old_fs);
1375         put_pages(ns);
1376         return tx;
1377 }
1378
1379 /*
1380  * Returns a pointer to the current page.
1381  */
1382 static inline union ns_mem *NS_GET_PAGE(struct nandsim *ns)
1383 {
1384         return &(ns->pages[ns->regs.row]);
1385 }
1386
1387 /*
1388  * Retuns a pointer to the current byte, within the current page.
1389  */
1390 static inline u_char *NS_PAGE_BYTE_OFF(struct nandsim *ns)
1391 {
1392         return NS_GET_PAGE(ns)->byte + ns->regs.column + ns->regs.off;
1393 }
1394
1395 int do_read_error(struct nandsim *ns, int num)
1396 {
1397         unsigned int page_no = ns->regs.row;
1398
1399         if (read_error(page_no)) {
1400                 prandom_bytes(ns->buf.byte, num);
1401                 NS_WARN("simulating read error in page %u\n", page_no);
1402                 return 1;
1403         }
1404         return 0;
1405 }
1406
1407 void do_bit_flips(struct nandsim *ns, int num)
1408 {
1409         if (bitflips && random32() < (1 << 22)) {
1410                 int flips = 1;
1411                 if (bitflips > 1)
1412                         flips = (random32() % (int) bitflips) + 1;
1413                 while (flips--) {
1414                         int pos = random32() % (num * 8);
1415                         ns->buf.byte[pos / 8] ^= (1 << (pos % 8));
1416                         NS_WARN("read_page: flipping bit %d in page %d "
1417                                 "reading from %d ecc: corrected=%u failed=%u\n",
1418                                 pos, ns->regs.row, ns->regs.column + ns->regs.off,
1419                                 nsmtd->ecc_stats.corrected, nsmtd->ecc_stats.failed);
1420                 }
1421         }
1422 }
1423
1424 /*
1425  * Fill the NAND buffer with data read from the specified page.
1426  */
1427 static void read_page(struct nandsim *ns, int num)
1428 {
1429         union ns_mem *mypage;
1430
1431         if (ns->cfile) {
1432                 if (!ns->pages_written[ns->regs.row]) {
1433                         NS_DBG("read_page: page %d not written\n", ns->regs.row);
1434                         memset(ns->buf.byte, 0xFF, num);
1435                 } else {
1436                         loff_t pos;
1437                         ssize_t tx;
1438
1439                         NS_DBG("read_page: page %d written, reading from %d\n",
1440                                 ns->regs.row, ns->regs.column + ns->regs.off);
1441                         if (do_read_error(ns, num))
1442                                 return;
1443                         pos = (loff_t)ns->regs.row * ns->geom.pgszoob + ns->regs.column + ns->regs.off;
1444                         tx = read_file(ns, ns->cfile, ns->buf.byte, num, &pos);
1445                         if (tx != num) {
1446                                 NS_ERR("read_page: read error for page %d ret %ld\n", ns->regs.row, (long)tx);
1447                                 return;
1448                         }
1449                         do_bit_flips(ns, num);
1450                 }
1451                 return;
1452         }
1453
1454         mypage = NS_GET_PAGE(ns);
1455         if (mypage->byte == NULL) {
1456                 NS_DBG("read_page: page %d not allocated\n", ns->regs.row);
1457                 memset(ns->buf.byte, 0xFF, num);
1458         } else {
1459                 NS_DBG("read_page: page %d allocated, reading from %d\n",
1460                         ns->regs.row, ns->regs.column + ns->regs.off);
1461                 if (do_read_error(ns, num))
1462                         return;
1463                 memcpy(ns->buf.byte, NS_PAGE_BYTE_OFF(ns), num);
1464                 do_bit_flips(ns, num);
1465         }
1466 }
1467
1468 /*
1469  * Erase all pages in the specified sector.
1470  */
1471 static void erase_sector(struct nandsim *ns)
1472 {
1473         union ns_mem *mypage;
1474         int i;
1475
1476         if (ns->cfile) {
1477                 for (i = 0; i < ns->geom.pgsec; i++)
1478                         if (ns->pages_written[ns->regs.row + i]) {
1479                                 NS_DBG("erase_sector: freeing page %d\n", ns->regs.row + i);
1480                                 ns->pages_written[ns->regs.row + i] = 0;
1481                         }
1482                 return;
1483         }
1484
1485         mypage = NS_GET_PAGE(ns);
1486         for (i = 0; i < ns->geom.pgsec; i++) {
1487                 if (mypage->byte != NULL) {
1488                         NS_DBG("erase_sector: freeing page %d\n", ns->regs.row+i);
1489                         kmem_cache_free(ns->nand_pages_slab, mypage->byte);
1490                         mypage->byte = NULL;
1491                 }
1492                 mypage++;
1493         }
1494 }
1495
1496 /*
1497  * Program the specified page with the contents from the NAND buffer.
1498  */
1499 static int prog_page(struct nandsim *ns, int num)
1500 {
1501         int i;
1502         union ns_mem *mypage;
1503         u_char *pg_off;
1504
1505         if (ns->cfile) {
1506                 loff_t off, pos;
1507                 ssize_t tx;
1508                 int all;
1509
1510                 NS_DBG("prog_page: writing page %d\n", ns->regs.row);
1511                 pg_off = ns->file_buf + ns->regs.column + ns->regs.off;
1512                 off = (loff_t)ns->regs.row * ns->geom.pgszoob + ns->regs.column + ns->regs.off;
1513                 if (!ns->pages_written[ns->regs.row]) {
1514                         all = 1;
1515                         memset(ns->file_buf, 0xff, ns->geom.pgszoob);
1516                 } else {
1517                         all = 0;
1518                         pos = off;
1519                         tx = read_file(ns, ns->cfile, pg_off, num, &pos);
1520                         if (tx != num) {
1521                                 NS_ERR("prog_page: read error for page %d ret %ld\n", ns->regs.row, (long)tx);
1522                                 return -1;
1523                         }
1524                 }
1525                 for (i = 0; i < num; i++)
1526                         pg_off[i] &= ns->buf.byte[i];
1527                 if (all) {
1528                         pos = (loff_t)ns->regs.row * ns->geom.pgszoob;
1529                         tx = write_file(ns, ns->cfile, ns->file_buf, ns->geom.pgszoob, &pos);
1530                         if (tx != ns->geom.pgszoob) {
1531                                 NS_ERR("prog_page: write error for page %d ret %ld\n", ns->regs.row, (long)tx);
1532                                 return -1;
1533                         }
1534                         ns->pages_written[ns->regs.row] = 1;
1535                 } else {
1536                         pos = off;
1537                         tx = write_file(ns, ns->cfile, pg_off, num, &pos);
1538                         if (tx != num) {
1539                                 NS_ERR("prog_page: write error for page %d ret %ld\n", ns->regs.row, (long)tx);
1540                                 return -1;
1541                         }
1542                 }
1543                 return 0;
1544         }
1545
1546         mypage = NS_GET_PAGE(ns);
1547         if (mypage->byte == NULL) {
1548                 NS_DBG("prog_page: allocating page %d\n", ns->regs.row);
1549                 /*
1550                  * We allocate memory with GFP_NOFS because a flash FS may
1551                  * utilize this. If it is holding an FS lock, then gets here,
1552                  * then kernel memory alloc runs writeback which goes to the FS
1553                  * again and deadlocks. This was seen in practice.
1554                  */
1555                 mypage->byte = kmem_cache_alloc(ns->nand_pages_slab, GFP_NOFS);
1556                 if (mypage->byte == NULL) {
1557                         NS_ERR("prog_page: error allocating memory for page %d\n", ns->regs.row);
1558                         return -1;
1559                 }
1560                 memset(mypage->byte, 0xFF, ns->geom.pgszoob);
1561         }
1562
1563         pg_off = NS_PAGE_BYTE_OFF(ns);
1564         for (i = 0; i < num; i++)
1565                 pg_off[i] &= ns->buf.byte[i];
1566
1567         return 0;
1568 }
1569
1570 /*
1571  * If state has any action bit, perform this action.
1572  *
1573  * RETURNS: 0 if success, -1 if error.
1574  */
1575 static int do_state_action(struct nandsim *ns, uint32_t action)
1576 {
1577         int num;
1578         int busdiv = ns->busw == 8 ? 1 : 2;
1579         unsigned int erase_block_no, page_no;
1580
1581         action &= ACTION_MASK;
1582
1583         /* Check that page address input is correct */
1584         if (action != ACTION_SECERASE && ns->regs.row >= ns->geom.pgnum) {
1585                 NS_WARN("do_state_action: wrong page number (%#x)\n", ns->regs.row);
1586                 return -1;
1587         }
1588
1589         switch (action) {
1590
1591         case ACTION_CPY:
1592                 /*
1593                  * Copy page data to the internal buffer.
1594                  */
1595
1596                 /* Column shouldn't be very large */
1597                 if (ns->regs.column >= (ns->geom.pgszoob - ns->regs.off)) {
1598                         NS_ERR("do_state_action: column number is too large\n");
1599                         break;
1600                 }
1601                 num = ns->geom.pgszoob - ns->regs.off - ns->regs.column;
1602                 read_page(ns, num);
1603
1604                 NS_DBG("do_state_action: (ACTION_CPY:) copy %d bytes to int buf, raw offset %d\n",
1605                         num, NS_RAW_OFFSET(ns) + ns->regs.off);
1606
1607                 if (ns->regs.off == 0)
1608                         NS_LOG("read page %d\n", ns->regs.row);
1609                 else if (ns->regs.off < ns->geom.pgsz)
1610                         NS_LOG("read page %d (second half)\n", ns->regs.row);
1611                 else
1612                         NS_LOG("read OOB of page %d\n", ns->regs.row);
1613
1614                 NS_UDELAY(access_delay);
1615                 NS_UDELAY(input_cycle * ns->geom.pgsz / 1000 / busdiv);
1616
1617                 break;
1618
1619         case ACTION_SECERASE:
1620                 /*
1621                  * Erase sector.
1622                  */
1623
1624                 if (ns->lines.wp) {
1625                         NS_ERR("do_state_action: device is write-protected, ignore sector erase\n");
1626                         return -1;
1627                 }
1628
1629                 if (ns->regs.row >= ns->geom.pgnum - ns->geom.pgsec
1630                         || (ns->regs.row & ~(ns->geom.secsz - 1))) {
1631                         NS_ERR("do_state_action: wrong sector address (%#x)\n", ns->regs.row);
1632                         return -1;
1633                 }
1634
1635                 ns->regs.row = (ns->regs.row <<
1636                                 8 * (ns->geom.pgaddrbytes - ns->geom.secaddrbytes)) | ns->regs.column;
1637                 ns->regs.column = 0;
1638
1639                 erase_block_no = ns->regs.row >> (ns->geom.secshift - ns->geom.pgshift);
1640
1641                 NS_DBG("do_state_action: erase sector at address %#x, off = %d\n",
1642                                 ns->regs.row, NS_RAW_OFFSET(ns));
1643                 NS_LOG("erase sector %u\n", erase_block_no);
1644
1645                 erase_sector(ns);
1646
1647                 NS_MDELAY(erase_delay);
1648
1649                 if (erase_block_wear)
1650                         update_wear(erase_block_no);
1651
1652                 if (erase_error(erase_block_no)) {
1653                         NS_WARN("simulating erase failure in erase block %u\n", erase_block_no);
1654                         return -1;
1655                 }
1656
1657                 break;
1658
1659         case ACTION_PRGPAGE:
1660                 /*
1661                  * Program page - move internal buffer data to the page.
1662                  */
1663
1664                 if (ns->lines.wp) {
1665                         NS_WARN("do_state_action: device is write-protected, programm\n");
1666                         return -1;
1667                 }
1668
1669                 num = ns->geom.pgszoob - ns->regs.off - ns->regs.column;
1670                 if (num != ns->regs.count) {
1671                         NS_ERR("do_state_action: too few bytes were input (%d instead of %d)\n",
1672                                         ns->regs.count, num);
1673                         return -1;
1674                 }
1675
1676                 if (prog_page(ns, num) == -1)
1677                         return -1;
1678
1679                 page_no = ns->regs.row;
1680
1681                 NS_DBG("do_state_action: copy %d bytes from int buf to (%#x, %#x), raw off = %d\n",
1682                         num, ns->regs.row, ns->regs.column, NS_RAW_OFFSET(ns) + ns->regs.off);
1683                 NS_LOG("programm page %d\n", ns->regs.row);
1684
1685                 NS_UDELAY(programm_delay);
1686                 NS_UDELAY(output_cycle * ns->geom.pgsz / 1000 / busdiv);
1687
1688                 if (write_error(page_no)) {
1689                         NS_WARN("simulating write failure in page %u\n", page_no);
1690                         return -1;
1691                 }
1692
1693                 break;
1694
1695         case ACTION_ZEROOFF:
1696                 NS_DBG("do_state_action: set internal offset to 0\n");
1697                 ns->regs.off = 0;
1698                 break;
1699
1700         case ACTION_HALFOFF:
1701                 if (!(ns->options & OPT_PAGE512_8BIT)) {
1702                         NS_ERR("do_state_action: BUG! can't skip half of page for non-512"
1703                                 "byte page size 8x chips\n");
1704                         return -1;
1705                 }
1706                 NS_DBG("do_state_action: set internal offset to %d\n", ns->geom.pgsz/2);
1707                 ns->regs.off = ns->geom.pgsz/2;
1708                 break;
1709
1710         case ACTION_OOBOFF:
1711                 NS_DBG("do_state_action: set internal offset to %d\n", ns->geom.pgsz);
1712                 ns->regs.off = ns->geom.pgsz;
1713                 break;
1714
1715         default:
1716                 NS_DBG("do_state_action: BUG! unknown action\n");
1717         }
1718
1719         return 0;
1720 }
1721
1722 /*
1723  * Switch simulator's state.
1724  */
1725 static void switch_state(struct nandsim *ns)
1726 {
1727         if (ns->op) {
1728                 /*
1729                  * The current operation have already been identified.
1730                  * Just follow the states chain.
1731                  */
1732
1733                 ns->stateidx += 1;
1734                 ns->state = ns->nxstate;
1735                 ns->nxstate = ns->op[ns->stateidx + 1];
1736
1737                 NS_DBG("switch_state: operation is known, switch to the next state, "
1738                         "state: %s, nxstate: %s\n",
1739                         get_state_name(ns->state), get_state_name(ns->nxstate));
1740
1741                 /* See, whether we need to do some action */
1742                 if ((ns->state & ACTION_MASK) && do_state_action(ns, ns->state) < 0) {
1743                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
1744                         return;
1745                 }
1746
1747         } else {
1748                 /*
1749                  * We don't yet know which operation we perform.
1750                  * Try to identify it.
1751                  */
1752
1753                 /*
1754                  *  The only event causing the switch_state function to
1755                  *  be called with yet unknown operation is new command.
1756                  */
1757                 ns->state = get_state_by_command(ns->regs.command);
1758
1759                 NS_DBG("switch_state: operation is unknown, try to find it\n");
1760
1761                 if (find_operation(ns, 0) != 0)
1762                         return;
1763
1764                 if ((ns->state & ACTION_MASK) && do_state_action(ns, ns->state) < 0) {
1765                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
1766                         return;
1767                 }
1768         }
1769
1770         /* For 16x devices column means the page offset in words */
1771         if ((ns->nxstate & STATE_ADDR_MASK) && ns->busw == 16) {
1772                 NS_DBG("switch_state: double the column number for 16x device\n");
1773                 ns->regs.column <<= 1;
1774         }
1775
1776         if (NS_STATE(ns->nxstate) == STATE_READY) {
1777                 /*
1778                  * The current state is the last. Return to STATE_READY
1779                  */
1780
1781                 u_char status = NS_STATUS_OK(ns);
1782
1783                 /* In case of data states, see if all bytes were input/output */
1784                 if ((ns->state & (STATE_DATAIN_MASK | STATE_DATAOUT_MASK))
1785                         && ns->regs.count != ns->regs.num) {
1786                         NS_WARN("switch_state: not all bytes were processed, %d left\n",
1787                                         ns->regs.num - ns->regs.count);
1788                         status = NS_STATUS_FAILED(ns);
1789                 }
1790
1791                 NS_DBG("switch_state: operation complete, switch to STATE_READY state\n");
1792
1793                 switch_to_ready_state(ns, status);
1794
1795                 return;
1796         } else if (ns->nxstate & (STATE_DATAIN_MASK | STATE_DATAOUT_MASK)) {
1797                 /*
1798                  * If the next state is data input/output, switch to it now
1799                  */
1800
1801                 ns->state      = ns->nxstate;
1802                 ns->nxstate    = ns->op[++ns->stateidx + 1];
1803                 ns->regs.num   = ns->regs.count = 0;
1804
1805                 NS_DBG("switch_state: the next state is data I/O, switch, "
1806                         "state: %s, nxstate: %s\n",
1807                         get_state_name(ns->state), get_state_name(ns->nxstate));
1808
1809                 /*
1810                  * Set the internal register to the count of bytes which
1811                  * are expected to be input or output
1812                  */
1813                 switch (NS_STATE(ns->state)) {
1814                         case STATE_DATAIN:
1815                         case STATE_DATAOUT:
1816                                 ns->regs.num = ns->geom.pgszoob - ns->regs.off - ns->regs.column;
1817                                 break;
1818
1819                         case STATE_DATAOUT_ID:
1820                                 ns->regs.num = ns->geom.idbytes;
1821                                 break;
1822
1823                         case STATE_DATAOUT_STATUS:
1824                         case STATE_DATAOUT_STATUS_M:
1825                                 ns->regs.count = ns->regs.num = 0;
1826                                 break;
1827
1828                         default:
1829                                 NS_ERR("switch_state: BUG! unknown data state\n");
1830                 }
1831
1832         } else if (ns->nxstate & STATE_ADDR_MASK) {
1833                 /*
1834                  * If the next state is address input, set the internal
1835                  * register to the number of expected address bytes
1836                  */
1837
1838                 ns->regs.count = 0;
1839
1840                 switch (NS_STATE(ns->nxstate)) {
1841                         case STATE_ADDR_PAGE:
1842                                 ns->regs.num = ns->geom.pgaddrbytes;
1843
1844                                 break;
1845                         case STATE_ADDR_SEC:
1846                                 ns->regs.num = ns->geom.secaddrbytes;
1847                                 break;
1848
1849                         case STATE_ADDR_ZERO:
1850                                 ns->regs.num = 1;
1851                                 break;
1852
1853                         case STATE_ADDR_COLUMN:
1854                                 /* Column address is always 2 bytes */
1855                                 ns->regs.num = ns->geom.pgaddrbytes - ns->geom.secaddrbytes;
1856                                 break;
1857
1858                         default:
1859                                 NS_ERR("switch_state: BUG! unknown address state\n");
1860                 }
1861         } else {
1862                 /*
1863                  * Just reset internal counters.
1864                  */
1865
1866                 ns->regs.num = 0;
1867                 ns->regs.count = 0;
1868         }
1869 }
1870
1871 static u_char ns_nand_read_byte(struct mtd_info *mtd)
1872 {
1873         struct nandsim *ns = ((struct nand_chip *)mtd->priv)->priv;
1874         u_char outb = 0x00;
1875
1876         /* Sanity and correctness checks */
1877         if (!ns->lines.ce) {
1878                 NS_ERR("read_byte: chip is disabled, return %#x\n", (uint)outb);
1879                 return outb;
1880         }
1881         if (ns->lines.ale || ns->lines.cle) {
1882                 NS_ERR("read_byte: ALE or CLE pin is high, return %#x\n", (uint)outb);
1883                 return outb;
1884         }
1885         if (!(ns->state & STATE_DATAOUT_MASK)) {
1886                 NS_WARN("read_byte: unexpected data output cycle, state is %s "
1887                         "return %#x\n", get_state_name(ns->state), (uint)outb);
1888                 return outb;
1889         }
1890
1891         /* Status register may be read as many times as it is wanted */
1892         if (NS_STATE(ns->state) == STATE_DATAOUT_STATUS) {
1893                 NS_DBG("read_byte: return %#x status\n", ns->regs.status);
1894                 return ns->regs.status;
1895         }
1896
1897         /* Check if there is any data in the internal buffer which may be read */
1898         if (ns->regs.count == ns->regs.num) {
1899                 NS_WARN("read_byte: no more data to output, return %#x\n", (uint)outb);
1900                 return outb;
1901         }
1902
1903         switch (NS_STATE(ns->state)) {
1904                 case STATE_DATAOUT:
1905                         if (ns->busw == 8) {
1906                                 outb = ns->buf.byte[ns->regs.count];
1907                                 ns->regs.count += 1;
1908                         } else {
1909                                 outb = (u_char)cpu_to_le16(ns->buf.word[ns->regs.count >> 1]);
1910                                 ns->regs.count += 2;
1911                         }
1912                         break;
1913                 case STATE_DATAOUT_ID:
1914                         NS_DBG("read_byte: read ID byte %d, total = %d\n", ns->regs.count, ns->regs.num);
1915                         outb = ns->ids[ns->regs.count];
1916                         ns->regs.count += 1;
1917                         break;
1918                 default:
1919                         BUG();
1920         }
1921
1922         if (ns->regs.count == ns->regs.num) {
1923                 NS_DBG("read_byte: all bytes were read\n");
1924
1925                 if (NS_STATE(ns->nxstate) == STATE_READY)
1926                         switch_state(ns);
1927         }
1928
1929         return outb;
1930 }
1931
1932 static void ns_nand_write_byte(struct mtd_info *mtd, u_char byte)
1933 {
1934         struct nandsim *ns = ((struct nand_chip *)mtd->priv)->priv;
1935
1936         /* Sanity and correctness checks */
1937         if (!ns->lines.ce) {
1938                 NS_ERR("write_byte: chip is disabled, ignore write\n");
1939                 return;
1940         }
1941         if (ns->lines.ale && ns->lines.cle) {
1942                 NS_ERR("write_byte: ALE and CLE pins are high simultaneously, ignore write\n");
1943                 return;
1944         }
1945
1946         if (ns->lines.cle == 1) {
1947                 /*
1948                  * The byte written is a command.
1949                  */
1950
1951                 if (byte == NAND_CMD_RESET) {
1952                         NS_LOG("reset chip\n");
1953                         switch_to_ready_state(ns, NS_STATUS_OK(ns));
1954                         return;
1955                 }
1956
1957                 /* Check that the command byte is correct */
1958                 if (check_command(byte)) {
1959                         NS_ERR("write_byte: unknown command %#x\n", (uint)byte);
1960                         return;
1961                 }
1962
1963                 if (NS_STATE(ns->state) == STATE_DATAOUT_STATUS
1964                         || NS_STATE(ns->state) == STATE_DATAOUT_STATUS_M
1965                         || NS_STATE(ns->state) == STATE_DATAOUT) {
1966                         int row = ns->regs.row;
1967
1968                         switch_state(ns);
1969                         if (byte == NAND_CMD_RNDOUT)
1970                                 ns->regs.row = row;
1971                 }
1972
1973                 /* Check if chip is expecting command */
1974                 if (NS_STATE(ns->nxstate) != STATE_UNKNOWN && !(ns->nxstate & STATE_CMD_MASK)) {
1975                         /* Do not warn if only 2 id bytes are read */
1976                         if (!(ns->regs.command == NAND_CMD_READID &&
1977                             NS_STATE(ns->state) == STATE_DATAOUT_ID && ns->regs.count == 2)) {
1978                                 /*
1979                                  * We are in situation when something else (not command)
1980                                  * was expected but command was input. In this case ignore
1981                                  * previous command(s)/state(s) and accept the last one.
1982                                  */
1983                                 NS_WARN("write_byte: command (%#x) wasn't expected, expected state is %s, "
1984                                         "ignore previous states\n", (uint)byte, get_state_name(ns->nxstate));
1985                         }
1986                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
1987                 }
1988
1989                 NS_DBG("command byte corresponding to %s state accepted\n",
1990                         get_state_name(get_state_by_command(byte)));
1991                 ns->regs.command = byte;
1992                 switch_state(ns);
1993
1994         } else if (ns->lines.ale == 1) {
1995                 /*
1996                  * The byte written is an address.
1997                  */
1998
1999                 if (NS_STATE(ns->nxstate) == STATE_UNKNOWN) {
2000
2001                         NS_DBG("write_byte: operation isn't known yet, identify it\n");
2002
2003                         if (find_operation(ns, 1) < 0)
2004                                 return;
2005
2006                         if ((ns->state & ACTION_MASK) && do_state_action(ns, ns->state) < 0) {
2007                                 switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2008                                 return;
2009                         }
2010
2011                         ns->regs.count = 0;
2012                         switch (NS_STATE(ns->nxstate)) {
2013                                 case STATE_ADDR_PAGE:
2014                                         ns->regs.num = ns->geom.pgaddrbytes;
2015                                         break;
2016                                 case STATE_ADDR_SEC:
2017                                         ns->regs.num = ns->geom.secaddrbytes;
2018                                         break;
2019                                 case STATE_ADDR_ZERO:
2020                                         ns->regs.num = 1;
2021                                         break;
2022                                 default:
2023                                         BUG();
2024                         }
2025                 }
2026
2027                 /* Check that chip is expecting address */
2028                 if (!(ns->nxstate & STATE_ADDR_MASK)) {
2029                         NS_ERR("write_byte: address (%#x) isn't expected, expected state is %s, "
2030                                 "switch to STATE_READY\n", (uint)byte, get_state_name(ns->nxstate));
2031                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2032                         return;
2033                 }
2034
2035                 /* Check if this is expected byte */
2036                 if (ns->regs.count == ns->regs.num) {
2037                         NS_ERR("write_byte: no more address bytes expected\n");
2038                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2039                         return;
2040                 }
2041
2042                 accept_addr_byte(ns, byte);
2043
2044                 ns->regs.count += 1;
2045
2046                 NS_DBG("write_byte: address byte %#x was accepted (%d bytes input, %d expected)\n",
2047                                 (uint)byte, ns->regs.count, ns->regs.num);
2048
2049                 if (ns->regs.count == ns->regs.num) {
2050                         NS_DBG("address (%#x, %#x) is accepted\n", ns->regs.row, ns->regs.column);
2051                         switch_state(ns);
2052                 }
2053
2054         } else {
2055                 /*
2056                  * The byte written is an input data.
2057                  */
2058
2059                 /* Check that chip is expecting data input */
2060                 if (!(ns->state & STATE_DATAIN_MASK)) {
2061                         NS_ERR("write_byte: data input (%#x) isn't expected, state is %s, "
2062                                 "switch to %s\n", (uint)byte,
2063                                 get_state_name(ns->state), get_state_name(STATE_READY));
2064                         switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2065                         return;
2066                 }
2067
2068                 /* Check if this is expected byte */
2069                 if (ns->regs.count == ns->regs.num) {
2070                         NS_WARN("write_byte: %u input bytes has already been accepted, ignore write\n",
2071                                         ns->regs.num);
2072                         return;
2073                 }
2074
2075                 if (ns->busw == 8) {
2076                         ns->buf.byte[ns->regs.count] = byte;
2077                         ns->regs.count += 1;
2078                 } else {
2079                         ns->buf.word[ns->regs.count >> 1] = cpu_to_le16((uint16_t)byte);
2080                         ns->regs.count += 2;
2081                 }
2082         }
2083
2084         return;
2085 }
2086
2087 static void ns_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int bitmask)
2088 {
2089         struct nandsim *ns = ((struct nand_chip *)mtd->priv)->priv;
2090
2091         ns->lines.cle = bitmask & NAND_CLE ? 1 : 0;
2092         ns->lines.ale = bitmask & NAND_ALE ? 1 : 0;
2093         ns->lines.ce = bitmask & NAND_NCE ? 1 : 0;
2094
2095         if (cmd != NAND_CMD_NONE)
2096                 ns_nand_write_byte(mtd, cmd);
2097 }
2098
2099 static int ns_device_ready(struct mtd_info *mtd)
2100 {
2101         NS_DBG("device_ready\n");
2102         return 1;
2103 }
2104
2105 static uint16_t ns_nand_read_word(struct mtd_info *mtd)
2106 {
2107         struct nand_chip *chip = (struct nand_chip *)mtd->priv;
2108
2109         NS_DBG("read_word\n");
2110
2111         return chip->read_byte(mtd) | (chip->read_byte(mtd) << 8);
2112 }
2113
2114 static void ns_nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
2115 {
2116         struct nandsim *ns = ((struct nand_chip *)mtd->priv)->priv;
2117
2118         /* Check that chip is expecting data input */
2119         if (!(ns->state & STATE_DATAIN_MASK)) {
2120                 NS_ERR("write_buf: data input isn't expected, state is %s, "
2121                         "switch to STATE_READY\n", get_state_name(ns->state));
2122                 switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2123                 return;
2124         }
2125
2126         /* Check if these are expected bytes */
2127         if (ns->regs.count + len > ns->regs.num) {
2128                 NS_ERR("write_buf: too many input bytes\n");
2129                 switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2130                 return;
2131         }
2132
2133         memcpy(ns->buf.byte + ns->regs.count, buf, len);
2134         ns->regs.count += len;
2135
2136         if (ns->regs.count == ns->regs.num) {
2137                 NS_DBG("write_buf: %d bytes were written\n", ns->regs.count);
2138         }
2139 }
2140
2141 static void ns_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
2142 {
2143         struct nandsim *ns = ((struct nand_chip *)mtd->priv)->priv;
2144
2145         /* Sanity and correctness checks */
2146         if (!ns->lines.ce) {
2147                 NS_ERR("read_buf: chip is disabled\n");
2148                 return;
2149         }
2150         if (ns->lines.ale || ns->lines.cle) {
2151                 NS_ERR("read_buf: ALE or CLE pin is high\n");
2152                 return;
2153         }
2154         if (!(ns->state & STATE_DATAOUT_MASK)) {
2155                 NS_WARN("read_buf: unexpected data output cycle, current state is %s\n",
2156                         get_state_name(ns->state));
2157                 return;
2158         }
2159
2160         if (NS_STATE(ns->state) != STATE_DATAOUT) {
2161                 int i;
2162
2163                 for (i = 0; i < len; i++)
2164                         buf[i] = ((struct nand_chip *)mtd->priv)->read_byte(mtd);
2165
2166                 return;
2167         }
2168
2169         /* Check if these are expected bytes */
2170         if (ns->regs.count + len > ns->regs.num) {
2171                 NS_ERR("read_buf: too many bytes to read\n");
2172                 switch_to_ready_state(ns, NS_STATUS_FAILED(ns));
2173                 return;
2174         }
2175
2176         memcpy(buf, ns->buf.byte + ns->regs.count, len);
2177         ns->regs.count += len;
2178
2179         if (ns->regs.count == ns->regs.num) {
2180                 if (NS_STATE(ns->nxstate) == STATE_READY)
2181                         switch_state(ns);
2182         }
2183
2184         return;
2185 }
2186
2187 /*
2188  * Module initialization function
2189  */
2190 static int __init ns_init_module(void)
2191 {
2192         struct nand_chip *chip;
2193         struct nandsim *nand;
2194         int retval = -ENOMEM, i;
2195
2196         if (bus_width != 8 && bus_width != 16) {
2197                 NS_ERR("wrong bus width (%d), use only 8 or 16\n", bus_width);
2198                 return -EINVAL;
2199         }
2200
2201         /* Allocate and initialize mtd_info, nand_chip and nandsim structures */
2202         nsmtd = kzalloc(sizeof(struct mtd_info) + sizeof(struct nand_chip)
2203                                 + sizeof(struct nandsim), GFP_KERNEL);
2204         if (!nsmtd) {
2205                 NS_ERR("unable to allocate core structures.\n");
2206                 return -ENOMEM;
2207         }
2208         chip        = (struct nand_chip *)(nsmtd + 1);
2209         nsmtd->priv = (void *)chip;
2210         nand        = (struct nandsim *)(chip + 1);
2211         chip->priv  = (void *)nand;
2212
2213         /*
2214          * Register simulator's callbacks.
2215          */
2216         chip->cmd_ctrl   = ns_hwcontrol;
2217         chip->read_byte  = ns_nand_read_byte;
2218         chip->dev_ready  = ns_device_ready;
2219         chip->write_buf  = ns_nand_write_buf;
2220         chip->read_buf   = ns_nand_read_buf;
2221         chip->read_word  = ns_nand_read_word;
2222         chip->ecc.mode   = NAND_ECC_SOFT;
2223         /* The NAND_SKIP_BBTSCAN option is necessary for 'overridesize' */
2224         /* and 'badblocks' parameters to work */
2225         chip->options   |= NAND_SKIP_BBTSCAN;
2226
2227         switch (bbt) {
2228         case 2:
2229                  chip->bbt_options |= NAND_BBT_NO_OOB;
2230         case 1:
2231                  chip->bbt_options |= NAND_BBT_USE_FLASH;
2232         case 0:
2233                 break;
2234         default:
2235                 NS_ERR("bbt has to be 0..2\n");
2236                 retval = -EINVAL;
2237                 goto error;
2238         }
2239         /*
2240          * Perform minimum nandsim structure initialization to handle
2241          * the initial ID read command correctly
2242          */
2243         if (third_id_byte != 0xFF || fourth_id_byte != 0xFF)
2244                 nand->geom.idbytes = 4;
2245         else
2246                 nand->geom.idbytes = 2;
2247         nand->regs.status = NS_STATUS_OK(nand);
2248         nand->nxstate = STATE_UNKNOWN;
2249         nand->options |= OPT_PAGE256; /* temporary value */
2250         nand->ids[0] = first_id_byte;
2251         nand->ids[1] = second_id_byte;
2252         nand->ids[2] = third_id_byte;
2253         nand->ids[3] = fourth_id_byte;
2254         if (bus_width == 16) {
2255                 nand->busw = 16;
2256                 chip->options |= NAND_BUSWIDTH_16;
2257         }
2258
2259         nsmtd->owner = THIS_MODULE;
2260
2261         if ((retval = parse_weakblocks()) != 0)
2262                 goto error;
2263
2264         if ((retval = parse_weakpages()) != 0)
2265                 goto error;
2266
2267         if ((retval = parse_gravepages()) != 0)
2268                 goto error;
2269
2270         retval = nand_scan_ident(nsmtd, 1, NULL);
2271         if (retval) {
2272                 NS_ERR("cannot scan NAND Simulator device\n");
2273                 if (retval > 0)
2274                         retval = -ENXIO;
2275                 goto error;
2276         }
2277
2278         if (bch) {
2279                 unsigned int eccsteps, eccbytes;
2280                 if (!mtd_nand_has_bch()) {
2281                         NS_ERR("BCH ECC support is disabled\n");
2282                         retval = -EINVAL;
2283                         goto error;
2284                 }
2285                 /* use 512-byte ecc blocks */
2286                 eccsteps = nsmtd->writesize/512;
2287                 eccbytes = (bch*13+7)/8;
2288                 /* do not bother supporting small page devices */
2289                 if ((nsmtd->oobsize < 64) || !eccsteps) {
2290                         NS_ERR("bch not available on small page devices\n");
2291                         retval = -EINVAL;
2292                         goto error;
2293                 }
2294                 if ((eccbytes*eccsteps+2) > nsmtd->oobsize) {
2295                         NS_ERR("invalid bch value %u\n", bch);
2296                         retval = -EINVAL;
2297                         goto error;
2298                 }
2299                 chip->ecc.mode = NAND_ECC_SOFT_BCH;
2300                 chip->ecc.size = 512;
2301                 chip->ecc.bytes = eccbytes;
2302                 NS_INFO("using %u-bit/%u bytes BCH ECC\n", bch, chip->ecc.size);
2303         }
2304
2305         retval = nand_scan_tail(nsmtd);
2306         if (retval) {
2307                 NS_ERR("can't register NAND Simulator\n");
2308                 if (retval > 0)
2309                         retval = -ENXIO;
2310                 goto error;
2311         }
2312
2313         if (overridesize) {
2314                 uint64_t new_size = (uint64_t)nsmtd->erasesize << overridesize;
2315                 if (new_size >> overridesize != nsmtd->erasesize) {
2316                         NS_ERR("overridesize is too big\n");
2317                         retval = -EINVAL;
2318                         goto err_exit;
2319                 }
2320                 /* N.B. This relies on nand_scan not doing anything with the size before we change it */
2321                 nsmtd->size = new_size;
2322                 chip->chipsize = new_size;
2323                 chip->chip_shift = ffs(nsmtd->erasesize) + overridesize - 1;
2324                 chip->pagemask = (chip->chipsize >> chip->page_shift) - 1;
2325         }
2326
2327         if ((retval = setup_wear_reporting(nsmtd)) != 0)
2328                 goto err_exit;
2329
2330         if ((retval = init_nandsim(nsmtd)) != 0)
2331                 goto err_exit;
2332
2333         if ((retval = nand_default_bbt(nsmtd)) != 0)
2334                 goto err_exit;
2335
2336         if ((retval = parse_badblocks(nand, nsmtd)) != 0)
2337                 goto err_exit;
2338
2339         /* Register NAND partitions */
2340         retval = mtd_device_register(nsmtd, &nand->partitions[0],
2341                                      nand->nbparts);
2342         if (retval != 0)
2343                 goto err_exit;
2344
2345         return 0;
2346
2347 err_exit:
2348         free_nandsim(nand);
2349         nand_release(nsmtd);
2350         for (i = 0;i < ARRAY_SIZE(nand->partitions); ++i)
2351                 kfree(nand->partitions[i].name);
2352 error:
2353         kfree(nsmtd);
2354         free_lists();
2355
2356         return retval;
2357 }
2358
2359 module_init(ns_init_module);
2360
2361 /*
2362  * Module clean-up function
2363  */
2364 static void __exit ns_cleanup_module(void)
2365 {
2366         struct nandsim *ns = ((struct nand_chip *)nsmtd->priv)->priv;
2367         int i;
2368
2369         free_nandsim(ns);    /* Free nandsim private resources */
2370         nand_release(nsmtd); /* Unregister driver */
2371         for (i = 0;i < ARRAY_SIZE(ns->partitions); ++i)
2372                 kfree(ns->partitions[i].name);
2373         kfree(nsmtd);        /* Free other structures */
2374         free_lists();
2375 }
2376
2377 module_exit(ns_cleanup_module);
2378
2379 MODULE_LICENSE ("GPL");
2380 MODULE_AUTHOR ("Artem B. Bityuckiy");
2381 MODULE_DESCRIPTION ("The NAND flash simulator");