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