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