git.oblomov.eu Git - linux-2.6/blob - 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/config.h>
  24 #include <linux/wait.h>
  25 #include <linux/spinlock.h>
  26 #include <linux/mtd/mtd.h>
  27
  28 struct mtd_info;
  29 /* Scan and identify a NAND device */
  30 extern int nand_scan (struct mtd_info *mtd, int max_chips);
  31 /* Free resources held by the NAND device */
  32 extern void nand_release (struct mtd_info *mtd);
  33
  34 /* Read raw data from the device without ECC */
  35 extern int nand_read_raw (struct mtd_info *mtd, uint8_t *buf, loff_t from,
  36                           size_t len, size_t ooblen);
  37
  38
  39 extern int nand_write_raw(struct mtd_info *mtd, loff_t to, size_t len,
  40                           size_t *retlen, uint8_t *buf, uint8_t *oob);
  41
  42 /* The maximum number of NAND chips in an array */
  43 #define NAND_MAX_CHIPS          8
  44
  45 /* This constant declares the max. oobsize / page, which
  46  * is supported now. If you add a chip with bigger oobsize/page
  47  * adjust this accordingly.
  48  */
  49 #define NAND_MAX_OOBSIZE        64
  50
  51 /*
  52  * Constants for hardware specific CLE/ALE/NCE function
  53 */
  54 /* Select the chip by setting nCE to low */
  55 #define NAND_CTL_SETNCE         1
  56 /* Deselect the chip by setting nCE to high */
  57 #define NAND_CTL_CLRNCE         2
  58 /* Select the command latch by setting CLE to high */
  59 #define NAND_CTL_SETCLE         3
  60 /* Deselect the command latch by setting CLE to low */
  61 #define NAND_CTL_CLRCLE         4
  62 /* Select the address latch by setting ALE to high */
  63 #define NAND_CTL_SETALE         5
  64 /* Deselect the address latch by setting ALE to low */
  65 #define NAND_CTL_CLRALE         6
  66 /* Set write protection by setting WP to high. Not used! */
  67 #define NAND_CTL_SETWP          7
  68 /* Clear write protection by setting WP to low. Not used! */
  69 #define NAND_CTL_CLRWP          8
  70
  71 /*
  72  * Standard NAND flash commands
  73  */
  74 #define NAND_CMD_READ0          0
  75 #define NAND_CMD_READ1          1
  76 #define NAND_CMD_PAGEPROG       0x10
  77 #define NAND_CMD_READOOB        0x50
  78 #define NAND_CMD_ERASE1         0x60
  79 #define NAND_CMD_STATUS         0x70
  80 #define NAND_CMD_STATUS_MULTI   0x71
  81 #define NAND_CMD_SEQIN          0x80
  82 #define NAND_CMD_READID         0x90
  83 #define NAND_CMD_ERASE2         0xd0
  84 #define NAND_CMD_RESET          0xff
  85
  86 /* Extended commands for large page devices */
  87 #define NAND_CMD_READSTART      0x30
  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 /* 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
 164 /* Options valid for Samsung large page devices */
 165 #define NAND_SAMSUNG_LP_OPTIONS \
 166         (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
 167
 168 /* Macros to identify the above */
 169 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
 170 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
 171 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 172 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
 173
 174 /* Mask to zero out the chip options, which come from the id table */
 175 #define NAND_CHIPOPTIONS_MSK    (0x0000ffff & ~NAND_NO_AUTOINCR)
 176
 177 /* Non chip related options */
 178 /* Use a flash based bad block table. This option is passed to the
 179  * default bad block table function. */
 180 #define NAND_USE_FLASH_BBT      0x00010000
 181 /* The hw ecc generator provides a syndrome instead a ecc value on read
 182  * This can only work if we have the ecc bytes directly behind the
 183  * data bytes. Applies for DOC and AG-AND Renesas HW Reed Solomon generators */
 184 #define NAND_HWECC_SYNDROME     0x00020000
 185 /* This option skips the bbt scan during initialization. */
 186 #define NAND_SKIP_BBTSCAN       0x00040000
 187
 188 /* Options set by nand scan */
 189 /* Nand scan has allocated controller struct */
 190 #define NAND_CONTROLLER_ALLOC   0x20000000
 191 /* Nand scan has allocated oob_buf */
 192 #define NAND_OOBBUF_ALLOC       0x40000000
 193 /* Nand scan has allocated data_buf */
 194 #define NAND_DATABUF_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 independend 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  * @hwctl:      function to control hardware ecc generator. Must only
 234  *              be provided if an hardware ECC is available
 235  * @calculate:  function for ecc calculation or readback from ecc hardware
 236  * @correct:    function for ecc correction, matching to ecc generator (sw/hw)
 237  */
 238 struct nand_ecc_ctrl {
 239         nand_ecc_modes_t        mode;
 240         int                     steps;
 241         int                     size;
 242         int                     bytes;
 243         void                    (*hwctl)(struct mtd_info *mtd, int mode);
 244         int                     (*calculate)(struct mtd_info *mtd,
 245                                              const uint8_t *dat,
 246                                              uint8_t *ecc_code);
 247         int                     (*correct)(struct mtd_info *mtd, uint8_t *dat,
 248                                            uint8_t *read_ecc,
 249                                            uint8_t *calc_ecc);
 250 };
 251
 252 /**
 253  * struct nand_chip - NAND Private Flash Chip Data
 254  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
 255  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
 256  * @read_byte:          [REPLACEABLE] read one byte from the chip
 257  * @write_byte:         [REPLACEABLE] write one byte to the chip
 258  * @read_word:          [REPLACEABLE] read one word from the chip
 259  * @write_word:         [REPLACEABLE] write one word to the chip
 260  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 261  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 262  * @verify_buf:         [REPLACEABLE] verify buffer contents against the chip data
 263  * @select_chip:        [REPLACEABLE] select chip nr
 264  * @block_bad:          [REPLACEABLE] check, if the block is bad
 265  * @block_markbad:      [REPLACEABLE] mark the block bad
 266  * @hwcontrol:          [BOARDSPECIFIC] hardwarespecific function for accesing control-lines
 267  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
 268  *                      If set to NULL no access to ready/busy is available and the ready/busy information
 269  *                      is read from the chip status register
 270  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing commands to the chip
 271  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on ready
 272  * @ecc:                [BOARDSPECIFIC] ecc control ctructure
 273  * @erase_cmd:          [INTERN] erase command write function, selectable due to AND support
 274  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 275  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
 276  * @wq:                 [INTERN] wait queue to sleep on if a NAND operation is in progress
 277  * @state:              [INTERN] the current state of the NAND device
 278  * @page_shift:         [INTERN] number of address bits in a page (column address bits)
 279  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 280  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 281  * @chip_shift:         [INTERN] number of address bits in one chip
 282  * @data_buf:           [INTERN] internal buffer for one page + oob
 283  * @oob_buf:            [INTERN] oob buffer for one eraseblock
 284  * @oobdirty:           [INTERN] indicates that oob_buf must be reinitialized
 285  * @data_poi:           [INTERN] pointer to a data buffer
 286  * @options:            [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
 287  *                      special functionality. See the defines for further explanation
 288  * @badblockpos:        [INTERN] position of the bad block marker in the oob area
 289  * @numchips:           [INTERN] number of physical chips
 290  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 291  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 292  * @pagebuf:            [INTERN] holds the pagenumber which is currently in data_buf
 293  * @autooob:            [REPLACEABLE] the default (auto)placement scheme
 294  * @bbt:                [INTERN] bad block table pointer
 295  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash lookup
 296  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 297  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial bad block scan
 298  * @controller:         [REPLACEABLE] a pointer to a hardware controller structure
 299  *                      which is shared among multiple independend devices
 300  * @priv:               [OPTIONAL] pointer to private chip date
 301  * @errstat:            [OPTIONAL] hardware specific function to perform additional error status checks
 302  *                      (determine if errors are correctable)
 303  */
 304
 305 struct nand_chip {
 306         void  __iomem   *IO_ADDR_R;
 307         void  __iomem   *IO_ADDR_W;
 308
 309         uint8_t         (*read_byte)(struct mtd_info *mtd);
 310         void            (*write_byte)(struct mtd_info *mtd, uint8_t byte);
 311         u16             (*read_word)(struct mtd_info *mtd);
 312         void            (*write_word)(struct mtd_info *mtd, u16 word);
 313
 314         void            (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 315         void            (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 316         int             (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 317         void            (*select_chip)(struct mtd_info *mtd, int chip);
 318         int             (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
 319         int             (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 320         void            (*hwcontrol)(struct mtd_info *mtd, int cmd);
 321         int             (*dev_ready)(struct mtd_info *mtd);
 322         void            (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
 323         int             (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this, int state);
 324         void            (*erase_cmd)(struct mtd_info *mtd, int page);
 325         int             (*scan_bbt)(struct mtd_info *mtd);
 326         struct nand_ecc_ctrl ecc;
 327         int             chip_delay;
 328         wait_queue_head_t wq;
 329         nand_state_t    state;
 330         int             page_shift;
 331         int             phys_erase_shift;
 332         int             bbt_erase_shift;
 333         int             chip_shift;
 334         uint8_t         *data_buf;
 335         uint8_t         *oob_buf;
 336         int             oobdirty;
 337         uint8_t         *data_poi;
 338         unsigned int    options;
 339         int             badblockpos;
 340         int             numchips;
 341         unsigned long   chipsize;
 342         int             pagemask;
 343         int             pagebuf;
 344         struct nand_oobinfo     *autooob;
 345         uint8_t         *bbt;
 346         struct nand_bbt_descr   *bbt_td;
 347         struct nand_bbt_descr   *bbt_md;
 348         struct nand_bbt_descr   *badblock_pattern;
 349         struct nand_hw_control  *controller;
 350         void            *priv;
 351         int             (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
 352 };
 353
 354 /*
 355  * NAND Flash Manufacturer ID Codes
 356  */
 357 #define NAND_MFR_TOSHIBA        0x98
 358 #define NAND_MFR_SAMSUNG        0xec
 359 #define NAND_MFR_FUJITSU        0x04
 360 #define NAND_MFR_NATIONAL       0x8f
 361 #define NAND_MFR_RENESAS        0x07
 362 #define NAND_MFR_STMICRO        0x20
 363 #define NAND_MFR_HYNIX          0xad
 364
 365 /**
 366  * struct nand_flash_dev - NAND Flash Device ID Structure
 367  *
 368  * @name:       Identify the device type
 369  * @id:         device ID code
 370  * @pagesize:   Pagesize in bytes. Either 256 or 512 or 0
 371  *              If the pagesize is 0, then the real pagesize
 372  *              and the eraseize are determined from the
 373  *              extended id bytes in the chip
 374  * @erasesize:  Size of an erase block in the flash device.
 375  * @chipsize:   Total chipsize in Mega Bytes
 376  * @options:    Bitfield to store chip relevant options
 377  */
 378 struct nand_flash_dev {
 379         char *name;
 380         int id;
 381         unsigned long pagesize;
 382         unsigned long chipsize;
 383         unsigned long erasesize;
 384         unsigned long options;
 385 };
 386
 387 /**
 388  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 389  * @name:       Manufacturer name
 390  * @id:         manufacturer ID code of device.
 391 */
 392 struct nand_manufacturers {
 393         int id;
 394         char * name;
 395 };
 396
 397 extern struct nand_flash_dev nand_flash_ids[];
 398 extern struct nand_manufacturers nand_manuf_ids[];
 399
 400 /**
 401  * struct nand_bbt_descr - bad block table descriptor
 402  * @options:    options for this descriptor
 403  * @pages:      the page(s) where we find the bbt, used with option BBT_ABSPAGE
 404  *              when bbt is searched, then we store the found bbts pages here.
 405  *              Its an array and supports up to 8 chips now
 406  * @offs:       offset of the pattern in the oob area of the page
 407  * @veroffs:    offset of the bbt version counter in the oob are of the page
 408  * @version:    version read from the bbt page during scan
 409  * @len:        length of the pattern, if 0 no pattern check is performed
 410  * @maxblocks:  maximum number of blocks to search for a bbt. This number of
 411  *              blocks is reserved at the end of the device where the tables are
 412  *              written.
 413  * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
 414  *              bad) block in the stored bbt
 415  * @pattern:    pattern to identify bad block table or factory marked good /
 416  *              bad blocks, can be NULL, if len = 0
 417  *
 418  * Descriptor for the bad block table marker and the descriptor for the
 419  * pattern which identifies good and bad blocks. The assumption is made
 420  * that the pattern and the version count are always located in the oob area
 421  * of the first block.
 422  */
 423 struct nand_bbt_descr {
 424         int     options;
 425         int     pages[NAND_MAX_CHIPS];
 426         int     offs;
 427         int     veroffs;
 428         uint8_t version[NAND_MAX_CHIPS];
 429         int     len;
 430         int     maxblocks;
 431         int     reserved_block_code;
 432         uint8_t *pattern;
 433 };
 434
 435 /* Options for the bad block table descriptors */
 436
 437 /* The number of bits used per block in the bbt on the device */
 438 #define NAND_BBT_NRBITS_MSK     0x0000000F
 439 #define NAND_BBT_1BIT           0x00000001
 440 #define NAND_BBT_2BIT           0x00000002
 441 #define NAND_BBT_4BIT           0x00000004
 442 #define NAND_BBT_8BIT           0x00000008
 443 /* The bad block table is in the last good block of the device */
 444 #define NAND_BBT_LASTBLOCK      0x00000010
 445 /* The bbt is at the given page, else we must scan for the bbt */
 446 #define NAND_BBT_ABSPAGE        0x00000020
 447 /* The bbt is at the given page, else we must scan for the bbt */
 448 #define NAND_BBT_SEARCH         0x00000040
 449 /* bbt is stored per chip on multichip devices */
 450 #define NAND_BBT_PERCHIP        0x00000080
 451 /* bbt has a version counter at offset veroffs */
 452 #define NAND_BBT_VERSION        0x00000100
 453 /* Create a bbt if none axists */
 454 #define NAND_BBT_CREATE         0x00000200
 455 /* Search good / bad pattern through all pages of a block */
 456 #define NAND_BBT_SCANALLPAGES   0x00000400
 457 /* Scan block empty during good / bad block scan */
 458 #define NAND_BBT_SCANEMPTY      0x00000800
 459 /* Write bbt if neccecary */
 460 #define NAND_BBT_WRITE          0x00001000
 461 /* Read and write back block contents when writing bbt */
 462 #define NAND_BBT_SAVECONTENT    0x00002000
 463 /* Search good / bad pattern on the first and the second page */
 464 #define NAND_BBT_SCAN2NDPAGE    0x00004000
 465
 466 /* The maximum number of blocks to scan for a bbt */
 467 #define NAND_BBT_SCAN_MAXBLOCKS 4
 468
 469 extern int nand_scan_bbt (struct mtd_info *mtd, struct nand_bbt_descr *bd);
 470 extern int nand_update_bbt (struct mtd_info *mtd, loff_t offs);
 471 extern int nand_default_bbt (struct mtd_info *mtd);
 472 extern int nand_isbad_bbt (struct mtd_info *mtd, loff_t offs, int allowbbt);
 473 extern int nand_erase_nand (struct mtd_info *mtd, struct erase_info *instr, int allowbbt);
 474 extern int nand_do_read_ecc (struct mtd_info *mtd, loff_t from, size_t len,
 475                              size_t * retlen, uint8_t * buf, uint8_t * oob_buf,
 476                              struct nand_oobinfo *oobsel, int flags);
 477
 478 /*
 479 * Constants for oob configuration
 480 */
 481 #define NAND_SMALL_BADBLOCK_POS         5
 482 #define NAND_LARGE_BADBLOCK_POS         0
 483
 484 /**
 485  * struct platform_nand_chip - chip level device structure
 486  *
 487  * @nr_chips:           max. number of chips to scan for
 488  * @chip_offs:          chip number offset
 489  * @nr_partitions:      number of partitions pointed to be partitoons (or zero)
 490  * @partitions:         mtd partition list
 491  * @chip_delay:         R/B delay value in us
 492  * @options:            Option flags, e.g. 16bit buswidth
 493  * @priv:               hardware controller specific settings
 494  */
 495 struct platform_nand_chip {
 496         int                     nr_chips;
 497         int                     chip_offset;
 498         int                     nr_partitions;
 499         struct mtd_partition    *partitions;
 500         int                     chip_delay;
 501         unsigned int            options;
 502         void                    *priv;
 503 };
 504
 505 /**
 506  * struct platform_nand_ctrl - controller level device structure
 507  *
 508  * @hwcontrol:          platform specific hardware control structure
 509  * @dev_ready:          platform specific function to read ready/busy pin
 510  * @select_chip:        platform specific chip select function
 511  * @priv_data:          private data to transport driver specific settings
 512  *
 513  * All fields are optional and depend on the hardware driver requirements
 514  */
 515 struct platform_nand_ctrl {
 516         void            (*hwcontrol)(struct mtd_info *mtd, int cmd);
 517         int             (*dev_ready)(struct mtd_info *mtd);
 518         void            (*select_chip)(struct mtd_info *mtd, int chip);
 519         void            *priv;
 520 };
 521
 522 /* Some helpers to access the data structures */
 523 static inline
 524 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
 525 {
 526         struct nand_chip *chip = mtd->priv;
 527
 528         return chip->priv;
 529 }
 530
 531 #endif /* __LINUX_MTD_NAND_H */