include/linux/mtd/nand.h

   1 /*
   2  *  linux/include/linux/mtd/nand.h
   3  *
   4  *  Copyright (c) 2000 David Woodhouse <dwmw2@infradead.org>
   5  *                     Steven J. Hill <sjhill@realitydiluted.com>
   6  *                     Thomas Gleixner <tglx@linutronix.de>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Info:
  13  *      Contains standard defines and IDs for NAND flash devices
  14  *
  15  * Changelog:
  16  *      See git changelog.
  17  */
  18 #ifndef __LINUX_MTD_NAND_H
  19 #define __LINUX_MTD_NAND_H
  20
  21 #include <linux/wait.h>
  22 #include <linux/spinlock.h>
  23 #include <linux/mtd/mtd.h>
  24
  25 struct mtd_info;
  26 /* Scan and identify a NAND device */
  27 extern int nand_scan (struct mtd_info *mtd, int max_chips);
  28 /* Separate phases of nand_scan(), allowing board driver to intervene
  29  * and override command or ECC setup according to flash type */
  30 extern int nand_scan_ident(struct mtd_info *mtd, int max_chips);
  31 extern int nand_scan_tail(struct mtd_info *mtd);
  32
  33 /* Free resources held by the NAND device */
  34 extern void nand_release (struct mtd_info *mtd);
  35
  36 /* Internal helper for board drivers which need to override command function */
  37 extern void nand_wait_ready(struct mtd_info *mtd);
  38
  39 /* The maximum number of NAND chips in an array */
  40 #define NAND_MAX_CHIPS          8
  41
  42 /* This constant declares the max. oobsize / page, which
  43  * is supported now. If you add a chip with bigger oobsize/page
  44  * adjust this accordingly.
  45  */
  46 #define NAND_MAX_OOBSIZE        64
  47 #define NAND_MAX_PAGESIZE       2048
  48
  49 /*
  50  * Constants for hardware specific CLE/ALE/NCE function
  51  *
  52  * These are bits which can be or'ed to set/clear multiple
  53  * bits in one go.
  54  */
  55 /* Select the chip by setting nCE to low */
  56 #define NAND_NCE                0x01
  57 /* Select the command latch by setting CLE to high */
  58 #define NAND_CLE                0x02
  59 /* Select the address latch by setting ALE to high */
  60 #define NAND_ALE                0x04
  61
  62 #define NAND_CTRL_CLE           (NAND_NCE | NAND_CLE)
  63 #define NAND_CTRL_ALE           (NAND_NCE | NAND_ALE)
  64 #define NAND_CTRL_CHANGE        0x80
  65
  66 /*
  67  * Standard NAND flash commands
  68  */
  69 #define NAND_CMD_READ0          0
  70 #define NAND_CMD_READ1          1
  71 #define NAND_CMD_RNDOUT         5
  72 #define NAND_CMD_PAGEPROG       0x10
  73 #define NAND_CMD_READOOB        0x50
  74 #define NAND_CMD_ERASE1         0x60
  75 #define NAND_CMD_STATUS         0x70
  76 #define NAND_CMD_STATUS_MULTI   0x71
  77 #define NAND_CMD_SEQIN          0x80
  78 #define NAND_CMD_RNDIN          0x85
  79 #define NAND_CMD_READID         0x90
  80 #define NAND_CMD_ERASE2         0xd0
  81 #define NAND_CMD_RESET          0xff
  82
  83 /* Extended commands for large page devices */
  84 #define NAND_CMD_READSTART      0x30
  85 #define NAND_CMD_RNDOUTSTART    0xE0
  86 #define NAND_CMD_CACHEDPROG     0x15
  87
  88 /* Extended commands for AG-AND device */
  89 /*
  90  * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
  91  *       there is no way to distinguish that from NAND_CMD_READ0
  92  *       until the remaining sequence of commands has been completed
  93  *       so add a high order bit and mask it off in the command.
  94  */
  95 #define NAND_CMD_DEPLETE1       0x100
  96 #define NAND_CMD_DEPLETE2       0x38
  97 #define NAND_CMD_STATUS_MULTI   0x71
  98 #define NAND_CMD_STATUS_ERROR   0x72
  99 /* multi-bank error status (banks 0-3) */
 100 #define NAND_CMD_STATUS_ERROR0  0x73
 101 #define NAND_CMD_STATUS_ERROR1  0x74
 102 #define NAND_CMD_STATUS_ERROR2  0x75
 103 #define NAND_CMD_STATUS_ERROR3  0x76
 104 #define NAND_CMD_STATUS_RESET   0x7f
 105 #define NAND_CMD_STATUS_CLEAR   0xff
 106
 107 #define NAND_CMD_NONE           -1
 108
 109 /* Status bits */
 110 #define NAND_STATUS_FAIL        0x01
 111 #define NAND_STATUS_FAIL_N1     0x02
 112 #define NAND_STATUS_TRUE_READY  0x20
 113 #define NAND_STATUS_READY       0x40
 114 #define NAND_STATUS_WP          0x80
 115
 116 /*
 117  * Constants for ECC_MODES
 118  */
 119 typedef enum {
 120         NAND_ECC_NONE,
 121         NAND_ECC_SOFT,
 122         NAND_ECC_HW,
 123         NAND_ECC_HW_SYNDROME,
 124 } nand_ecc_modes_t;
 125
 126 /*
 127  * Constants for Hardware ECC
 128  */
 129 /* Reset Hardware ECC for read */
 130 #define NAND_ECC_READ           0
 131 /* Reset Hardware ECC for write */
 132 #define NAND_ECC_WRITE          1
 133 /* Enable Hardware ECC before syndrom is read back from flash */
 134 #define NAND_ECC_READSYN        2
 135
 136 /* Bit mask for flags passed to do_nand_read_ecc */
 137 #define NAND_GET_DEVICE         0x80
 138
 139
 140 /* Option constants for bizarre disfunctionality and real
 141 *  features
 142 */
 143 /* Chip can not auto increment pages */
 144 #define NAND_NO_AUTOINCR        0x00000001
 145 /* Buswitdh is 16 bit */
 146 #define NAND_BUSWIDTH_16        0x00000002
 147 /* Device supports partial programming without padding */
 148 #define NAND_NO_PADDING         0x00000004
 149 /* Chip has cache program function */
 150 #define NAND_CACHEPRG           0x00000008
 151 /* Chip has copy back function */
 152 #define NAND_COPYBACK           0x00000010
 153 /* AND Chip which has 4 banks and a confusing page / block
 154  * assignment. See Renesas datasheet for further information */
 155 #define NAND_IS_AND             0x00000020
 156 /* Chip has a array of 4 pages which can be read without
 157  * additional ready /busy waits */
 158 #define NAND_4PAGE_ARRAY        0x00000040
 159 /* Chip requires that BBT is periodically rewritten to prevent
 160  * bits from adjacent blocks from 'leaking' in altering data.
 161  * This happens with the Renesas AG-AND chips, possibly others.  */
 162 #define BBT_AUTO_REFRESH        0x00000080
 163 /* Chip does not require ready check on read. True
 164  * for all large page devices, as they do not support
 165  * autoincrement.*/
 166 #define NAND_NO_READRDY         0x00000100
 167 /* Chip does not allow subpage writes */
 168 #define NAND_NO_SUBPAGE_WRITE   0x00000200
 169
 170
 171 /* Options valid for Samsung large page devices */
 172 #define NAND_SAMSUNG_LP_OPTIONS \
 173         (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
 174
 175 /* Macros to identify the above */
 176 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
 177 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
 178 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 179 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
 180 /* Large page NAND with SOFT_ECC should support subpage reads */
 181 #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
 182                                         && (chip->page_shift > 9))
 183
 184 /* Mask to zero out the chip options, which come from the id table */
 185 #define NAND_CHIPOPTIONS_MSK    (0x0000ffff & ~NAND_NO_AUTOINCR)
 186
 187 /* Non chip related options */
 188 /* Use a flash based bad block table. This option is passed to the
 189  * default bad block table function. */
 190 #define NAND_USE_FLASH_BBT      0x00010000
 191 /* This option skips the bbt scan during initialization. */
 192 #define NAND_SKIP_BBTSCAN       0x00020000
 193 /* This option is defined if the board driver allocates its own buffers
 194    (e.g. because it needs them DMA-coherent */
 195 #define NAND_OWN_BUFFERS        0x00040000
 196 /* Options set by nand scan */
 197 /* Nand scan has allocated controller struct */
 198 #define NAND_CONTROLLER_ALLOC   0x80000000
 199
 200 /* Cell info constants */
 201 #define NAND_CI_CHIPNR_MSK      0x03
 202 #define NAND_CI_CELLTYPE_MSK    0x0C
 203
 204 /*
 205  * nand_state_t - chip states
 206  * Enumeration for NAND flash chip state
 207  */
 208 typedef enum {
 209         FL_READY,
 210         FL_READING,
 211         FL_WRITING,
 212         FL_ERASING,
 213         FL_SYNCING,
 214         FL_CACHEDPRG,
 215         FL_PM_SUSPENDED,
 216 } nand_state_t;
 217
 218 /* Keep gcc happy */
 219 struct nand_chip;
 220
 221 /**
 222  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
 223  * @lock:               protection lock
 224  * @active:             the mtd device which holds the controller currently
 225  * @wq:                 wait queue to sleep on if a NAND operation is in progress
 226  *                      used instead of the per chip wait queue when a hw controller is available
 227  */
 228 struct nand_hw_control {
 229         spinlock_t       lock;
 230         struct nand_chip *active;
 231         wait_queue_head_t wq;
 232 };
 233
 234 /**
 235  * struct nand_ecc_ctrl - Control structure for ecc
 236  * @mode:       ecc mode
 237  * @steps:      number of ecc steps per page
 238  * @size:       data bytes per ecc step
 239  * @bytes:      ecc bytes per step
 240  * @total:      total number of ecc bytes per page
 241  * @prepad:     padding information for syndrome based ecc generators
 242  * @postpad:    padding information for syndrome based ecc generators
 243  * @layout:     ECC layout control struct pointer
 244  * @hwctl:      function to control hardware ecc generator. Must only
 245  *              be provided if an hardware ECC is available
 246  * @calculate:  function for ecc calculation or readback from ecc hardware
 247  * @correct:    function for ecc correction, matching to ecc generator (sw/hw)
 248  * @read_page_raw:      function to read a raw page without ECC
 249  * @write_page_raw:     function to write a raw page without ECC
 250  * @read_page:  function to read a page according to the ecc generator requirements
 251  * @read_subpage:       function to read parts of the page covered by ECC.
 252  * @write_page: function to write a page according to the ecc generator requirements
 253  * @read_oob:   function to read chip OOB data
 254  * @write_oob:  function to write chip OOB data
 255  */
 256 struct nand_ecc_ctrl {
 257         nand_ecc_modes_t        mode;
 258         int                     steps;
 259         int                     size;
 260         int                     bytes;
 261         int                     total;
 262         int                     prepad;
 263         int                     postpad;
 264         struct nand_ecclayout   *layout;
 265         void                    (*hwctl)(struct mtd_info *mtd, int mode);
 266         int                     (*calculate)(struct mtd_info *mtd,
 267                                              const uint8_t *dat,
 268                                              uint8_t *ecc_code);
 269         int                     (*correct)(struct mtd_info *mtd, uint8_t *dat,
 270                                            uint8_t *read_ecc,
 271                                            uint8_t *calc_ecc);
 272         int                     (*read_page_raw)(struct mtd_info *mtd,
 273                                                  struct nand_chip *chip,
 274                                                  uint8_t *buf);
 275         void                    (*write_page_raw)(struct mtd_info *mtd,
 276                                                   struct nand_chip *chip,
 277                                                   const uint8_t *buf);
 278         int                     (*read_page)(struct mtd_info *mtd,
 279                                              struct nand_chip *chip,
 280                                              uint8_t *buf);
 281         int                     (*read_subpage)(struct mtd_info *mtd,
 282                                              struct nand_chip *chip,
 283                                              uint32_t offs, uint32_t len,
 284                                              uint8_t *buf);
 285         void                    (*write_page)(struct mtd_info *mtd,
 286                                               struct nand_chip *chip,
 287                                               const uint8_t *buf);
 288         int                     (*read_oob)(struct mtd_info *mtd,
 289                                             struct nand_chip *chip,
 290                                             int page,
 291                                             int sndcmd);
 292         int                     (*write_oob)(struct mtd_info *mtd,
 293                                              struct nand_chip *chip,
 294                                              int page);
 295 };
 296
 297 /**
 298  * struct nand_buffers - buffer structure for read/write
 299  * @ecccalc:    buffer for calculated ecc
 300  * @ecccode:    buffer for ecc read from flash
 301  * @databuf:    buffer for data - dynamically sized
 302  *
 303  * Do not change the order of buffers. databuf and oobrbuf must be in
 304  * consecutive order.
 305  */
 306 struct nand_buffers {
 307         uint8_t ecccalc[NAND_MAX_OOBSIZE];
 308         uint8_t ecccode[NAND_MAX_OOBSIZE];
 309         uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
 310 };
 311
 312 /**
 313  * struct nand_chip - NAND Private Flash Chip Data
 314  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
 315  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
 316  * @read_byte:          [REPLACEABLE] read one byte from the chip
 317  * @read_word:          [REPLACEABLE] read one word from the chip
 318  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 319  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 320  * @verify_buf:         [REPLACEABLE] verify buffer contents against the chip data
 321  * @select_chip:        [REPLACEABLE] select chip nr
 322  * @block_bad:          [REPLACEABLE] check, if the block is bad
 323  * @block_markbad:      [REPLACEABLE] mark the block bad
 324  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific funtion for controlling
 325  *                      ALE/CLE/nCE. Also used to write command and address
 326  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
 327  *                      If set to NULL no access to ready/busy is available and the ready/busy information
 328  *                      is read from the chip status register
 329  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing commands to the chip
 330  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on ready
 331  * @ecc:                [BOARDSPECIFIC] ecc control ctructure
 332  * @buffers:            buffer structure for read/write
 333  * @hwcontrol:          platform-specific hardware control structure
 334  * @ops:                oob operation operands
 335  * @erase_cmd:          [INTERN] erase command write function, selectable due to AND support
 336  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 337  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
 338  * @wq:                 [INTERN] wait queue to sleep on if a NAND operation is in progress
 339  * @state:              [INTERN] the current state of the NAND device
 340  * @oob_poi:            poison value buffer
 341  * @page_shift:         [INTERN] number of address bits in a page (column address bits)
 342  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 343  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 344  * @chip_shift:         [INTERN] number of address bits in one chip
 345  * @datbuf:             [INTERN] internal buffer for one page + oob
 346  * @oobbuf:             [INTERN] oob buffer for one eraseblock
 347  * @oobdirty:           [INTERN] indicates that oob_buf must be reinitialized
 348  * @data_poi:           [INTERN] pointer to a data buffer
 349  * @options:            [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
 350  *                      special functionality. See the defines for further explanation
 351  * @badblockpos:        [INTERN] position of the bad block marker in the oob area
 352  * @cellinfo:           [INTERN] MLC/multichip data from chip ident
 353  * @numchips:           [INTERN] number of physical chips
 354  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 355  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 356  * @pagebuf:            [INTERN] holds the pagenumber which is currently in data_buf
 357  * @subpagesize:        [INTERN] holds the subpagesize
 358  * @ecclayout:          [REPLACEABLE] the default ecc placement scheme
 359  * @bbt:                [INTERN] bad block table pointer
 360  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash lookup
 361  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 362  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial bad block scan
 363  * @controller:         [REPLACEABLE] a pointer to a hardware controller structure
 364  *                      which is shared among multiple independend devices
 365  * @priv:               [OPTIONAL] pointer to private chip date
 366  * @errstat:            [OPTIONAL] hardware specific function to perform additional error status checks
 367  *                      (determine if errors are correctable)
 368  * @write_page:         [REPLACEABLE] High-level page write function
 369  */
 370
 371 struct nand_chip {
 372         void  __iomem   *IO_ADDR_R;
 373         void  __iomem   *IO_ADDR_W;
 374
 375         uint8_t         (*read_byte)(struct mtd_info *mtd);
 376         u16             (*read_word)(struct mtd_info *mtd);
 377         void            (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 378         void            (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 379         int             (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 380         void            (*select_chip)(struct mtd_info *mtd, int chip);
 381         int             (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
 382         int             (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 383         void            (*cmd_ctrl)(struct mtd_info *mtd, int dat,
 384                                     unsigned int ctrl);
 385         int             (*dev_ready)(struct mtd_info *mtd);
 386         void            (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
 387         int             (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
 388         void            (*erase_cmd)(struct mtd_info *mtd, int page);
 389         int             (*scan_bbt)(struct mtd_info *mtd);
 390         int             (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
 391         int             (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 392                                       const uint8_t *buf, int page, int cached, int raw);
 393
 394         int             chip_delay;
 395         unsigned int    options;
 396
 397         int             page_shift;
 398         int             phys_erase_shift;
 399         int             bbt_erase_shift;
 400         int             chip_shift;
 401         int             numchips;
 402         uint64_t        chipsize;
 403         int             pagemask;
 404         int             pagebuf;
 405         int             subpagesize;
 406         uint8_t         cellinfo;
 407         int             badblockpos;
 408
 409         nand_state_t    state;
 410
 411         uint8_t         *oob_poi;
 412         struct nand_hw_control  *controller;
 413         struct nand_ecclayout   *ecclayout;
 414
 415         struct nand_ecc_ctrl ecc;
 416         struct nand_buffers *buffers;
 417         struct nand_hw_control hwcontrol;
 418
 419         struct mtd_oob_ops ops;
 420
 421         uint8_t         *bbt;
 422         struct nand_bbt_descr   *bbt_td;
 423         struct nand_bbt_descr   *bbt_md;
 424
 425         struct nand_bbt_descr   *badblock_pattern;
 426
 427         void            *priv;
 428 };
 429
 430 /*
 431  * NAND Flash Manufacturer ID Codes
 432  */
 433 #define NAND_MFR_TOSHIBA        0x98
 434 #define NAND_MFR_SAMSUNG        0xec
 435 #define NAND_MFR_FUJITSU        0x04
 436 #define NAND_MFR_NATIONAL       0x8f
 437 #define NAND_MFR_RENESAS        0x07
 438 #define NAND_MFR_STMICRO        0x20
 439 #define NAND_MFR_HYNIX          0xad
 440 #define NAND_MFR_MICRON         0x2c
 441 #define NAND_MFR_AMD            0x01
 442
 443 /**
 444  * struct nand_flash_dev - NAND Flash Device ID Structure
 445  * @name:       Identify the device type
 446  * @id:         device ID code
 447  * @pagesize:   Pagesize in bytes. Either 256 or 512 or 0
 448  *              If the pagesize is 0, then the real pagesize
 449  *              and the eraseize are determined from the
 450  *              extended id bytes in the chip
 451  * @erasesize:  Size of an erase block in the flash device.
 452  * @chipsize:   Total chipsize in Mega Bytes
 453  * @options:    Bitfield to store chip relevant options
 454  */
 455 struct nand_flash_dev {
 456         char *name;
 457         int id;
 458         unsigned long pagesize;
 459         unsigned long chipsize;
 460         unsigned long erasesize;
 461         unsigned long options;
 462 };
 463
 464 /**
 465  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 466  * @name:       Manufacturer name
 467  * @id:         manufacturer ID code of device.
 468 */
 469 struct nand_manufacturers {
 470         int id;
 471         char * name;
 472 };
 473
 474 extern struct nand_flash_dev nand_flash_ids[];
 475 extern struct nand_manufacturers nand_manuf_ids[];
 476
 477 /**
 478  * struct nand_bbt_descr - bad block table descriptor
 479  * @options:    options for this descriptor
 480  * @pages:      the page(s) where we find the bbt, used with option BBT_ABSPAGE
 481  *              when bbt is searched, then we store the found bbts pages here.
 482  *              Its an array and supports up to 8 chips now
 483  * @offs:       offset of the pattern in the oob area of the page
 484  * @veroffs:    offset of the bbt version counter in the oob are of the page
 485  * @version:    version read from the bbt page during scan
 486  * @len:        length of the pattern, if 0 no pattern check is performed
 487  * @maxblocks:  maximum number of blocks to search for a bbt. This number of
 488  *              blocks is reserved at the end of the device where the tables are
 489  *              written.
 490  * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
 491  *              bad) block in the stored bbt
 492  * @pattern:    pattern to identify bad block table or factory marked good /
 493  *              bad blocks, can be NULL, if len = 0
 494  *
 495  * Descriptor for the bad block table marker and the descriptor for the
 496  * pattern which identifies good and bad blocks. The assumption is made
 497  * that the pattern and the version count are always located in the oob area
 498  * of the first block.
 499  */
 500 struct nand_bbt_descr {
 501         int     options;
 502         int     pages[NAND_MAX_CHIPS];
 503         int     offs;
 504         int     veroffs;
 505         uint8_t version[NAND_MAX_CHIPS];
 506         int     len;
 507         int     maxblocks;
 508         int     reserved_block_code;
 509         uint8_t *pattern;
 510 };
 511
 512 /* Options for the bad block table descriptors */
 513
 514 /* The number of bits used per block in the bbt on the device */
 515 #define NAND_BBT_NRBITS_MSK     0x0000000F
 516 #define NAND_BBT_1BIT           0x00000001
 517 #define NAND_BBT_2BIT           0x00000002
 518 #define NAND_BBT_4BIT           0x00000004
 519 #define NAND_BBT_8BIT           0x00000008
 520 /* The bad block table is in the last good block of the device */
 521 #define NAND_BBT_LASTBLOCK      0x00000010
 522 /* The bbt is at the given page, else we must scan for the bbt */
 523 #define NAND_BBT_ABSPAGE        0x00000020
 524 /* The bbt is at the given page, else we must scan for the bbt */
 525 #define NAND_BBT_SEARCH         0x00000040
 526 /* bbt is stored per chip on multichip devices */
 527 #define NAND_BBT_PERCHIP        0x00000080
 528 /* bbt has a version counter at offset veroffs */
 529 #define NAND_BBT_VERSION        0x00000100
 530 /* Create a bbt if none axists */
 531 #define NAND_BBT_CREATE         0x00000200
 532 /* Search good / bad pattern through all pages of a block */
 533 #define NAND_BBT_SCANALLPAGES   0x00000400
 534 /* Scan block empty during good / bad block scan */
 535 #define NAND_BBT_SCANEMPTY      0x00000800
 536 /* Write bbt if neccecary */
 537 #define NAND_BBT_WRITE          0x00001000
 538 /* Read and write back block contents when writing bbt */
 539 #define NAND_BBT_SAVECONTENT    0x00002000
 540 /* Search good / bad pattern on the first and the second page */
 541 #define NAND_BBT_SCAN2NDPAGE    0x00004000
 542
 543 /* The maximum number of blocks to scan for a bbt */
 544 #define NAND_BBT_SCAN_MAXBLOCKS 4
 545
 546 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
 547 extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
 548 extern int nand_default_bbt(struct mtd_info *mtd);
 549 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
 550 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
 551                            int allowbbt);
 552 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
 553                         size_t * retlen, uint8_t * buf);
 554
 555 /*
 556 * Constants for oob configuration
 557 */
 558 #define NAND_SMALL_BADBLOCK_POS         5
 559 #define NAND_LARGE_BADBLOCK_POS         0
 560
 561 /**
 562  * struct platform_nand_chip - chip level device structure
 563  * @nr_chips:           max. number of chips to scan for
 564  * @chip_offset:        chip number offset
 565  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
 566  * @partitions:         mtd partition list
 567  * @chip_delay:         R/B delay value in us
 568  * @options:            Option flags, e.g. 16bit buswidth
 569  * @ecclayout:          ecc layout info structure
 570  * @part_probe_types:   NULL-terminated array of probe types
 571  * @priv:               hardware controller specific settings
 572  */
 573 struct platform_nand_chip {
 574         int                     nr_chips;
 575         int                     chip_offset;
 576         int                     nr_partitions;
 577         struct mtd_partition    *partitions;
 578         struct nand_ecclayout   *ecclayout;
 579         int                     chip_delay;
 580         unsigned int            options;
 581         const char              **part_probe_types;
 582         void                    *priv;
 583 };
 584
 585 /**
 586  * struct platform_nand_ctrl - controller level device structure
 587  * @hwcontrol:          platform specific hardware control structure
 588  * @dev_ready:          platform specific function to read ready/busy pin
 589  * @select_chip:        platform specific chip select function
 590  * @cmd_ctrl:           platform specific function for controlling
 591  *                      ALE/CLE/nCE. Also used to write command and address
 592  * @priv:               private data to transport driver specific settings
 593  *
 594  * All fields are optional and depend on the hardware driver requirements
 595  */
 596 struct platform_nand_ctrl {
 597         void            (*hwcontrol)(struct mtd_info *mtd, int cmd);
 598         int             (*dev_ready)(struct mtd_info *mtd);
 599         void            (*select_chip)(struct mtd_info *mtd, int chip);
 600         void            (*cmd_ctrl)(struct mtd_info *mtd, int dat,
 601                                     unsigned int ctrl);
 602         void            *priv;
 603 };
 604
 605 /**
 606  * struct platform_nand_data - container structure for platform-specific data
 607  * @chip:               chip level chip structure
 608  * @ctrl:               controller level device structure
 609  */
 610 struct platform_nand_data {
 611         struct platform_nand_chip       chip;
 612         struct platform_nand_ctrl       ctrl;
 613 };
 614
 615 /* Some helpers to access the data structures */
 616 static inline
 617 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
 618 {
 619         struct nand_chip *chip = mtd->priv;
 620
 621         return chip->priv;
 622 }
 623
 624 #endif /* __LINUX_MTD_NAND_H */