include/linux/mtd/nand.h

   1 /*
   2  *  linux/include/linux/mtd/nand.h
   3  *
   4  *  Copyright © 2000-2010 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 #include <linux/mtd/flashchip.h>
  25 #include <linux/mtd/bbm.h>
  26
  27 struct mtd_info;
  28 struct nand_flash_dev;
  29 /* Scan and identify a NAND device */
  30 extern int nand_scan(struct mtd_info *mtd, int max_chips);
  31 /*
  32  * Separate phases of nand_scan(), allowing board driver to intervene
  33  * and override command or ECC setup according to flash type.
  34  */
  35 extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
  36                            struct nand_flash_dev *table);
  37 extern int nand_scan_tail(struct mtd_info *mtd);
  38
  39 /* Free resources held by the NAND device */
  40 extern void nand_release(struct mtd_info *mtd);
  41
  42 /* Internal helper for board drivers which need to override command function */
  43 extern void nand_wait_ready(struct mtd_info *mtd);
  44
  45 /* locks all blockes present in the device */
  46 extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  47
  48 /* unlocks specified locked blockes */
  49 extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  50
  51 /* The maximum number of NAND chips in an array */
  52 #define NAND_MAX_CHIPS          8
  53
  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        576
  60 #define NAND_MAX_PAGESIZE       8192
  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_PARAM          0xec
  95 #define NAND_CMD_RESET          0xff
  96
  97 #define NAND_CMD_LOCK           0x2a
  98 #define NAND_CMD_UNLOCK1        0x23
  99 #define NAND_CMD_UNLOCK2        0x24
 100
 101 /* Extended commands for large page devices */
 102 #define NAND_CMD_READSTART      0x30
 103 #define NAND_CMD_RNDOUTSTART    0xE0
 104 #define NAND_CMD_CACHEDPROG     0x15
 105
 106 /* Extended commands for AG-AND device */
 107 /*
 108  * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
 109  *       there is no way to distinguish that from NAND_CMD_READ0
 110  *       until the remaining sequence of commands has been completed
 111  *       so add a high order bit and mask it off in the command.
 112  */
 113 #define NAND_CMD_DEPLETE1       0x100
 114 #define NAND_CMD_DEPLETE2       0x38
 115 #define NAND_CMD_STATUS_MULTI   0x71
 116 #define NAND_CMD_STATUS_ERROR   0x72
 117 /* multi-bank error status (banks 0-3) */
 118 #define NAND_CMD_STATUS_ERROR0  0x73
 119 #define NAND_CMD_STATUS_ERROR1  0x74
 120 #define NAND_CMD_STATUS_ERROR2  0x75
 121 #define NAND_CMD_STATUS_ERROR3  0x76
 122 #define NAND_CMD_STATUS_RESET   0x7f
 123 #define NAND_CMD_STATUS_CLEAR   0xff
 124
 125 #define NAND_CMD_NONE           -1
 126
 127 /* Status bits */
 128 #define NAND_STATUS_FAIL        0x01
 129 #define NAND_STATUS_FAIL_N1     0x02
 130 #define NAND_STATUS_TRUE_READY  0x20
 131 #define NAND_STATUS_READY       0x40
 132 #define NAND_STATUS_WP          0x80
 133
 134 /*
 135  * Constants for ECC_MODES
 136  */
 137 typedef enum {
 138         NAND_ECC_NONE,
 139         NAND_ECC_SOFT,
 140         NAND_ECC_HW,
 141         NAND_ECC_HW_SYNDROME,
 142         NAND_ECC_HW_OOB_FIRST,
 143         NAND_ECC_SOFT_BCH,
 144 } nand_ecc_modes_t;
 145
 146 /*
 147  * Constants for Hardware ECC
 148  */
 149 /* Reset Hardware ECC for read */
 150 #define NAND_ECC_READ           0
 151 /* Reset Hardware ECC for write */
 152 #define NAND_ECC_WRITE          1
 153 /* Enable Hardware ECC before syndrom is read back from flash */
 154 #define NAND_ECC_READSYN        2
 155
 156 /* Bit mask for flags passed to do_nand_read_ecc */
 157 #define NAND_GET_DEVICE         0x80
 158
 159
 160 /*
 161  * Option constants for bizarre disfunctionality and real
 162  * features.
 163  */
 164 /* Chip can not auto increment pages */
 165 #define NAND_NO_AUTOINCR        0x00000001
 166 /* Buswitdh is 16 bit */
 167 #define NAND_BUSWIDTH_16        0x00000002
 168 /* Device supports partial programming without padding */
 169 #define NAND_NO_PADDING         0x00000004
 170 /* Chip has cache program function */
 171 #define NAND_CACHEPRG           0x00000008
 172 /* Chip has copy back function */
 173 #define NAND_COPYBACK           0x00000010
 174 /*
 175  * AND Chip which has 4 banks and a confusing page / block
 176  * assignment. See Renesas datasheet for further information.
 177  */
 178 #define NAND_IS_AND             0x00000020
 179 /*
 180  * Chip has a array of 4 pages which can be read without
 181  * additional ready /busy waits.
 182  */
 183 #define NAND_4PAGE_ARRAY        0x00000040
 184 /*
 185  * Chip requires that BBT is periodically rewritten to prevent
 186  * bits from adjacent blocks from 'leaking' in altering data.
 187  * This happens with the Renesas AG-AND chips, possibly others.
 188  */
 189 #define BBT_AUTO_REFRESH        0x00000080
 190 /*
 191  * Chip does not require ready check on read. True
 192  * for all large page devices, as they do not support
 193  * autoincrement.
 194  */
 195 #define NAND_NO_READRDY         0x00000100
 196 /* Chip does not allow subpage writes */
 197 #define NAND_NO_SUBPAGE_WRITE   0x00000200
 198
 199 /* Device is one of 'new' xD cards that expose fake nand command set */
 200 #define NAND_BROKEN_XD          0x00000400
 201
 202 /* Device behaves just like nand, but is readonly */
 203 #define NAND_ROM                0x00000800
 204
 205 /* Options valid for Samsung large page devices */
 206 #define NAND_SAMSUNG_LP_OPTIONS \
 207         (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
 208
 209 /* Macros to identify the above */
 210 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
 211 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
 212 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 213 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
 214 /* Large page NAND with SOFT_ECC should support subpage reads */
 215 #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
 216                                         && (chip->page_shift > 9))
 217
 218 /* Mask to zero out the chip options, which come from the id table */
 219 #define NAND_CHIPOPTIONS_MSK    (0x0000ffff & ~NAND_NO_AUTOINCR)
 220
 221 /* Non chip related options */
 222 /* This option skips the bbt scan during initialization. */
 223 #define NAND_SKIP_BBTSCAN       0x00020000
 224 /*
 225  * This option is defined if the board driver allocates its own buffers
 226  * (e.g. because it needs them DMA-coherent).
 227  */
 228 #define NAND_OWN_BUFFERS        0x00040000
 229 /* Chip may not exist, so silence any errors in scan */
 230 #define NAND_SCAN_SILENT_NODEV  0x00080000
 231 /* Create an empty BBT with no vendor information if the BBT is available */
 232 #define NAND_CREATE_EMPTY_BBT           0x01000000
 233
 234 /* Options set by nand scan */
 235 /* Nand scan has allocated controller struct */
 236 #define NAND_CONTROLLER_ALLOC   0x80000000
 237
 238 /* Cell info constants */
 239 #define NAND_CI_CHIPNR_MSK      0x03
 240 #define NAND_CI_CELLTYPE_MSK    0x0C
 241
 242 /* Keep gcc happy */
 243 struct nand_chip;
 244
 245 struct nand_onfi_params {
 246         /* rev info and features block */
 247         /* 'O' 'N' 'F' 'I'  */
 248         u8 sig[4];
 249         __le16 revision;
 250         __le16 features;
 251         __le16 opt_cmd;
 252         u8 reserved[22];
 253
 254         /* manufacturer information block */
 255         char manufacturer[12];
 256         char model[20];
 257         u8 jedec_id;
 258         __le16 date_code;
 259         u8 reserved2[13];
 260
 261         /* memory organization block */
 262         __le32 byte_per_page;
 263         __le16 spare_bytes_per_page;
 264         __le32 data_bytes_per_ppage;
 265         __le16 spare_bytes_per_ppage;
 266         __le32 pages_per_block;
 267         __le32 blocks_per_lun;
 268         u8 lun_count;
 269         u8 addr_cycles;
 270         u8 bits_per_cell;
 271         __le16 bb_per_lun;
 272         __le16 block_endurance;
 273         u8 guaranteed_good_blocks;
 274         __le16 guaranteed_block_endurance;
 275         u8 programs_per_page;
 276         u8 ppage_attr;
 277         u8 ecc_bits;
 278         u8 interleaved_bits;
 279         u8 interleaved_ops;
 280         u8 reserved3[13];
 281
 282         /* electrical parameter block */
 283         u8 io_pin_capacitance_max;
 284         __le16 async_timing_mode;
 285         __le16 program_cache_timing_mode;
 286         __le16 t_prog;
 287         __le16 t_bers;
 288         __le16 t_r;
 289         __le16 t_ccs;
 290         __le16 src_sync_timing_mode;
 291         __le16 src_ssync_features;
 292         __le16 clk_pin_capacitance_typ;
 293         __le16 io_pin_capacitance_typ;
 294         __le16 input_pin_capacitance_typ;
 295         u8 input_pin_capacitance_max;
 296         u8 driver_strenght_support;
 297         __le16 t_int_r;
 298         __le16 t_ald;
 299         u8 reserved4[7];
 300
 301         /* vendor */
 302         u8 reserved5[90];
 303
 304         __le16 crc;
 305 } __attribute__((packed));
 306
 307 #define ONFI_CRC_BASE   0x4F4E
 308
 309 /**
 310  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
 311  * @lock:               protection lock
 312  * @active:             the mtd device which holds the controller currently
 313  * @wq:                 wait queue to sleep on if a NAND operation is in
 314  *                      progress used instead of the per chip wait queue
 315  *                      when a hw controller is available.
 316  */
 317 struct nand_hw_control {
 318         spinlock_t lock;
 319         struct nand_chip *active;
 320         wait_queue_head_t wq;
 321 };
 322
 323 /**
 324  * struct nand_ecc_ctrl - Control structure for ecc
 325  * @mode:       ecc mode
 326  * @steps:      number of ecc steps per page
 327  * @size:       data bytes per ecc step
 328  * @bytes:      ecc bytes per step
 329  * @total:      total number of ecc bytes per page
 330  * @prepad:     padding information for syndrome based ecc generators
 331  * @postpad:    padding information for syndrome based ecc generators
 332  * @layout:     ECC layout control struct pointer
 333  * @priv:       pointer to private ecc control data
 334  * @hwctl:      function to control hardware ecc generator. Must only
 335  *              be provided if an hardware ECC is available
 336  * @calculate:  function for ecc calculation or readback from ecc hardware
 337  * @correct:    function for ecc correction, matching to ecc generator (sw/hw)
 338  * @read_page_raw:      function to read a raw page without ECC
 339  * @write_page_raw:     function to write a raw page without ECC
 340  * @read_page:  function to read a page according to the ecc generator
 341  *              requirements.
 342  * @read_subpage:       function to read parts of the page covered by ECC.
 343  * @write_page: function to write a page according to the ecc generator
 344  *              requirements.
 345  * @read_oob:   function to read chip OOB data
 346  * @write_oob:  function to write chip OOB data
 347  */
 348 struct nand_ecc_ctrl {
 349         nand_ecc_modes_t mode;
 350         int steps;
 351         int size;
 352         int bytes;
 353         int total;
 354         int prepad;
 355         int postpad;
 356         struct nand_ecclayout   *layout;
 357         void *priv;
 358         void (*hwctl)(struct mtd_info *mtd, int mode);
 359         int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
 360                         uint8_t *ecc_code);
 361         int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
 362                         uint8_t *calc_ecc);
 363         int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 364                         uint8_t *buf, int page);
 365         void (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 366                         const uint8_t *buf);
 367         int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
 368                         uint8_t *buf, int page);
 369         int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 370                         uint32_t offs, uint32_t len, uint8_t *buf);
 371         void (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 372                         const uint8_t *buf);
 373         int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page,
 374                         int sndcmd);
 375         int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
 376                         int page);
 377 };
 378
 379 /**
 380  * struct nand_buffers - buffer structure for read/write
 381  * @ecccalc:    buffer for calculated ecc
 382  * @ecccode:    buffer for ecc read from flash
 383  * @databuf:    buffer for data - dynamically sized
 384  *
 385  * Do not change the order of buffers. databuf and oobrbuf must be in
 386  * consecutive order.
 387  */
 388 struct nand_buffers {
 389         uint8_t ecccalc[NAND_MAX_OOBSIZE];
 390         uint8_t ecccode[NAND_MAX_OOBSIZE];
 391         uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
 392 };
 393
 394 /**
 395  * struct nand_chip - NAND Private Flash Chip Data
 396  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the
 397  *                      flash device
 398  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the
 399  *                      flash device.
 400  * @read_byte:          [REPLACEABLE] read one byte from the chip
 401  * @read_word:          [REPLACEABLE] read one word from the chip
 402  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 403  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 404  * @verify_buf:         [REPLACEABLE] verify buffer contents against the chip
 405  *                      data.
 406  * @select_chip:        [REPLACEABLE] select chip nr
 407  * @block_bad:          [REPLACEABLE] check, if the block is bad
 408  * @block_markbad:      [REPLACEABLE] mark the block bad
 409  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific function for controlling
 410  *                      ALE/CLE/nCE. Also used to write command and address
 411  * @init_size:          [BOARDSPECIFIC] hardwarespecific function for setting
 412  *                      mtd->oobsize, mtd->writesize and so on.
 413  *                      @id_data contains the 8 bytes values of NAND_CMD_READID.
 414  *                      Return with the bus width.
 415  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accesing
 416  *                      device ready/busy line. If set to NULL no access to
 417  *                      ready/busy is available and the ready/busy information
 418  *                      is read from the chip status register.
 419  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing
 420  *                      commands to the chip.
 421  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on
 422  *                      ready.
 423  * @ecc:                [BOARDSPECIFIC] ecc control ctructure
 424  * @buffers:            buffer structure for read/write
 425  * @hwcontrol:          platform-specific hardware control structure
 426  * @ops:                oob operation operands
 427  * @erase_cmd:          [INTERN] erase command write function, selectable due
 428  *                      to AND support.
 429  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 430  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transferring
 431  *                      data from array to read regs (tR).
 432  * @state:              [INTERN] the current state of the NAND device
 433  * @oob_poi:            poison value buffer
 434  * @page_shift:         [INTERN] number of address bits in a page (column
 435  *                      address bits).
 436  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 437  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 438  * @chip_shift:         [INTERN] number of address bits in one chip
 439  * @options:            [BOARDSPECIFIC] various chip options. They can partly
 440  *                      be set to inform nand_scan about special functionality.
 441  *                      See the defines for further explanation.
 442  * @bbt_options:        [INTERN] bad block specific options. All options used
 443  *                      here must come from bbm.h. By default, these options
 444  *                      will be copied to the appropriate nand_bbt_descr's.
 445  * @badblockpos:        [INTERN] position of the bad block marker in the oob
 446  *                      area.
 447  * @badblockbits:       [INTERN] number of bits to left-shift the bad block
 448  *                      number
 449  * @cellinfo:           [INTERN] MLC/multichip data from chip ident
 450  * @numchips:           [INTERN] number of physical chips
 451  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 452  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 453  * @pagebuf:            [INTERN] holds the pagenumber which is currently in
 454  *                      data_buf.
 455  * @subpagesize:        [INTERN] holds the subpagesize
 456  * @onfi_version:       [INTERN] holds the chip ONFI version (BCD encoded),
 457  *                      non 0 if ONFI supported.
 458  * @onfi_params:        [INTERN] holds the ONFI page parameter when ONFI is
 459  *                      supported, 0 otherwise.
 460  * @ecclayout:          [REPLACEABLE] the default ecc placement scheme
 461  * @bbt:                [INTERN] bad block table pointer
 462  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash
 463  *                      lookup.
 464  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 465  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial
 466  *                      bad block scan.
 467  * @controller:         [REPLACEABLE] a pointer to a hardware controller
 468  *                      structure which is shared among multiple independend
 469  *                      devices.
 470  * @priv:               [OPTIONAL] pointer to private chip date
 471  * @errstat:            [OPTIONAL] hardware specific function to perform
 472  *                      additional error status checks (determine if errors are
 473  *                      correctable).
 474  * @write_page:         [REPLACEABLE] High-level page write function
 475  */
 476
 477 struct nand_chip {
 478         void __iomem *IO_ADDR_R;
 479         void __iomem *IO_ADDR_W;
 480
 481         uint8_t (*read_byte)(struct mtd_info *mtd);
 482         u16 (*read_word)(struct mtd_info *mtd);
 483         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 484         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 485         int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 486         void (*select_chip)(struct mtd_info *mtd, int chip);
 487         int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
 488         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 489         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 490         int (*init_size)(struct mtd_info *mtd, struct nand_chip *this,
 491                         u8 *id_data);
 492         int (*dev_ready)(struct mtd_info *mtd);
 493         void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
 494                         int page_addr);
 495         int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
 496         void (*erase_cmd)(struct mtd_info *mtd, int page);
 497         int (*scan_bbt)(struct mtd_info *mtd);
 498         int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
 499                         int status, int page);
 500         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 501                         const uint8_t *buf, int page, int cached, int raw);
 502
 503         int chip_delay;
 504         unsigned int options;
 505         unsigned int bbt_options;
 506
 507         int page_shift;
 508         int phys_erase_shift;
 509         int bbt_erase_shift;
 510         int chip_shift;
 511         int numchips;
 512         uint64_t chipsize;
 513         int pagemask;
 514         int pagebuf;
 515         int subpagesize;
 516         uint8_t cellinfo;
 517         int badblockpos;
 518         int badblockbits;
 519
 520         int onfi_version;
 521         struct nand_onfi_params onfi_params;
 522
 523         flstate_t state;
 524
 525         uint8_t *oob_poi;
 526         struct nand_hw_control *controller;
 527         struct nand_ecclayout *ecclayout;
 528
 529         struct nand_ecc_ctrl ecc;
 530         struct nand_buffers *buffers;
 531         struct nand_hw_control hwcontrol;
 532
 533         struct mtd_oob_ops ops;
 534
 535         uint8_t *bbt;
 536         struct nand_bbt_descr *bbt_td;
 537         struct nand_bbt_descr *bbt_md;
 538
 539         struct nand_bbt_descr *badblock_pattern;
 540
 541         void *priv;
 542 };
 543
 544 /*
 545  * NAND Flash Manufacturer ID Codes
 546  */
 547 #define NAND_MFR_TOSHIBA        0x98
 548 #define NAND_MFR_SAMSUNG        0xec
 549 #define NAND_MFR_FUJITSU        0x04
 550 #define NAND_MFR_NATIONAL       0x8f
 551 #define NAND_MFR_RENESAS        0x07
 552 #define NAND_MFR_STMICRO        0x20
 553 #define NAND_MFR_HYNIX          0xad
 554 #define NAND_MFR_MICRON         0x2c
 555 #define NAND_MFR_AMD            0x01
 556
 557 /**
 558  * struct nand_flash_dev - NAND Flash Device ID Structure
 559  * @name:       Identify the device type
 560  * @id:         device ID code
 561  * @pagesize:   Pagesize in bytes. Either 256 or 512 or 0
 562  *              If the pagesize is 0, then the real pagesize
 563  *              and the eraseize are determined from the
 564  *              extended id bytes in the chip
 565  * @erasesize:  Size of an erase block in the flash device.
 566  * @chipsize:   Total chipsize in Mega Bytes
 567  * @options:    Bitfield to store chip relevant options
 568  */
 569 struct nand_flash_dev {
 570         char *name;
 571         int id;
 572         unsigned long pagesize;
 573         unsigned long chipsize;
 574         unsigned long erasesize;
 575         unsigned long options;
 576 };
 577
 578 /**
 579  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 580  * @name:       Manufacturer name
 581  * @id:         manufacturer ID code of device.
 582 */
 583 struct nand_manufacturers {
 584         int id;
 585         char *name;
 586 };
 587
 588 extern struct nand_flash_dev nand_flash_ids[];
 589 extern struct nand_manufacturers nand_manuf_ids[];
 590
 591 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
 592 extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
 593 extern int nand_default_bbt(struct mtd_info *mtd);
 594 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
 595 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
 596                            int allowbbt);
 597 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
 598                         size_t *retlen, uint8_t *buf);
 599
 600 /**
 601  * struct platform_nand_chip - chip level device structure
 602  * @nr_chips:           max. number of chips to scan for
 603  * @chip_offset:        chip number offset
 604  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
 605  * @partitions:         mtd partition list
 606  * @chip_delay:         R/B delay value in us
 607  * @options:            Option flags, e.g. 16bit buswidth
 608  * @bbt_options:        BBT option flags, e.g. NAND_BBT_USE_FLASH
 609  * @ecclayout:          ecc layout info structure
 610  * @part_probe_types:   NULL-terminated array of probe types
 611  * @set_parts:          platform specific function to set partitions
 612  * @priv:               hardware controller specific settings
 613  */
 614 struct platform_nand_chip {
 615         int nr_chips;
 616         int chip_offset;
 617         int nr_partitions;
 618         struct mtd_partition *partitions;
 619         struct nand_ecclayout *ecclayout;
 620         int chip_delay;
 621         unsigned int options;
 622         unsigned int bbt_options;
 623         const char **part_probe_types;
 624         void (*set_parts)(uint64_t size, struct platform_nand_chip *chip);
 625         void *priv;
 626 };
 627
 628 /* Keep gcc happy */
 629 struct platform_device;
 630
 631 /**
 632  * struct platform_nand_ctrl - controller level device structure
 633  * @probe:              platform specific function to probe/setup hardware
 634  * @remove:             platform specific function to remove/teardown hardware
 635  * @hwcontrol:          platform specific hardware control structure
 636  * @dev_ready:          platform specific function to read ready/busy pin
 637  * @select_chip:        platform specific chip select function
 638  * @cmd_ctrl:           platform specific function for controlling
 639  *                      ALE/CLE/nCE. Also used to write command and address
 640  * @write_buf:          platform specific function for write buffer
 641  * @read_buf:           platform specific function for read buffer
 642  * @priv:               private data to transport driver specific settings
 643  *
 644  * All fields are optional and depend on the hardware driver requirements
 645  */
 646 struct platform_nand_ctrl {
 647         int (*probe)(struct platform_device *pdev);
 648         void (*remove)(struct platform_device *pdev);
 649         void (*hwcontrol)(struct mtd_info *mtd, int cmd);
 650         int (*dev_ready)(struct mtd_info *mtd);
 651         void (*select_chip)(struct mtd_info *mtd, int chip);
 652         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 653         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 654         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 655         void *priv;
 656 };
 657
 658 /**
 659  * struct platform_nand_data - container structure for platform-specific data
 660  * @chip:               chip level chip structure
 661  * @ctrl:               controller level device structure
 662  */
 663 struct platform_nand_data {
 664         struct platform_nand_chip chip;
 665         struct platform_nand_ctrl ctrl;
 666 };
 667
 668 /* Some helpers to access the data structures */
 669 static inline
 670 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
 671 {
 672         struct nand_chip *chip = mtd->priv;
 673
 674         return chip->priv;
 675 }
 676
 677 #endif /* __LINUX_MTD_NAND_H */