include/linux/mtd/nand.h

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