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 blocks present in the device */
  46 extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  47
  48 /* unlocks specified locked blocks */
  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        640
  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_SEQIN          0x80
  90 #define NAND_CMD_RNDIN          0x85
  91 #define NAND_CMD_READID         0x90
  92 #define NAND_CMD_ERASE2         0xd0
  93 #define NAND_CMD_PARAM          0xec
  94 #define NAND_CMD_GET_FEATURES   0xee
  95 #define NAND_CMD_SET_FEATURES   0xef
  96 #define NAND_CMD_RESET          0xff
  97
  98 #define NAND_CMD_LOCK           0x2a
  99 #define NAND_CMD_UNLOCK1        0x23
 100 #define NAND_CMD_UNLOCK2        0x24
 101
 102 /* Extended commands for large page devices */
 103 #define NAND_CMD_READSTART      0x30
 104 #define NAND_CMD_RNDOUTSTART    0xE0
 105 #define NAND_CMD_CACHEDPROG     0x15
 106
 107 #define NAND_CMD_NONE           -1
 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_HW_OOB_FIRST,
 125         NAND_ECC_SOFT_BCH,
 126 } nand_ecc_modes_t;
 127
 128 /*
 129  * Constants for Hardware ECC
 130  */
 131 /* Reset Hardware ECC for read */
 132 #define NAND_ECC_READ           0
 133 /* Reset Hardware ECC for write */
 134 #define NAND_ECC_WRITE          1
 135 /* Enable Hardware ECC before syndrome is read back from flash */
 136 #define NAND_ECC_READSYN        2
 137
 138 /* Bit mask for flags passed to do_nand_read_ecc */
 139 #define NAND_GET_DEVICE         0x80
 140
 141
 142 /*
 143  * Option constants for bizarre disfunctionality and real
 144  * features.
 145  */
 146 /* Buswidth is 16 bit */
 147 #define NAND_BUSWIDTH_16        0x00000002
 148 /* Chip has cache program function */
 149 #define NAND_CACHEPRG           0x00000008
 150 /*
 151  * Chip requires ready check on read (for auto-incremented sequential read).
 152  * True only for small page devices; large page devices do not support
 153  * autoincrement.
 154  */
 155 #define NAND_NEED_READRDY       0x00000100
 156
 157 /* Chip does not allow subpage writes */
 158 #define NAND_NO_SUBPAGE_WRITE   0x00000200
 159
 160 /* Device is one of 'new' xD cards that expose fake nand command set */
 161 #define NAND_BROKEN_XD          0x00000400
 162
 163 /* Device behaves just like nand, but is readonly */
 164 #define NAND_ROM                0x00000800
 165
 166 /* Device supports subpage reads */
 167 #define NAND_SUBPAGE_READ       0x00001000
 168
 169 /* Options valid for Samsung large page devices */
 170 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
 171
 172 /* Macros to identify the above */
 173 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 174 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
 175
 176 /* Non chip related options */
 177 /* This option skips the bbt scan during initialization. */
 178 #define NAND_SKIP_BBTSCAN       0x00010000
 179 /*
 180  * This option is defined if the board driver allocates its own buffers
 181  * (e.g. because it needs them DMA-coherent).
 182  */
 183 #define NAND_OWN_BUFFERS        0x00020000
 184 /* Chip may not exist, so silence any errors in scan */
 185 #define NAND_SCAN_SILENT_NODEV  0x00040000
 186 /*
 187  * Autodetect nand buswidth with readid/onfi.
 188  * This suppose the driver will configure the hardware in 8 bits mode
 189  * when calling nand_scan_ident, and update its configuration
 190  * before calling nand_scan_tail.
 191  */
 192 #define NAND_BUSWIDTH_AUTO      0x00080000
 193
 194 /* Options set by nand scan */
 195 /* Nand scan has allocated controller struct */
 196 #define NAND_CONTROLLER_ALLOC   0x80000000
 197
 198 /* Cell info constants */
 199 #define NAND_CI_CHIPNR_MSK      0x03
 200 #define NAND_CI_CELLTYPE_MSK    0x0C
 201
 202 /* Keep gcc happy */
 203 struct nand_chip;
 204
 205 /* ONFI timing mode, used in both asynchronous and synchronous mode */
 206 #define ONFI_TIMING_MODE_0              (1 << 0)
 207 #define ONFI_TIMING_MODE_1              (1 << 1)
 208 #define ONFI_TIMING_MODE_2              (1 << 2)
 209 #define ONFI_TIMING_MODE_3              (1 << 3)
 210 #define ONFI_TIMING_MODE_4              (1 << 4)
 211 #define ONFI_TIMING_MODE_5              (1 << 5)
 212 #define ONFI_TIMING_MODE_UNKNOWN        (1 << 6)
 213
 214 /* ONFI feature address */
 215 #define ONFI_FEATURE_ADDR_TIMING_MODE   0x1
 216
 217 /* ONFI subfeature parameters length */
 218 #define ONFI_SUBFEATURE_PARAM_LEN       4
 219
 220 struct nand_onfi_params {
 221         /* rev info and features block */
 222         /* 'O' 'N' 'F' 'I'  */
 223         u8 sig[4];
 224         __le16 revision;
 225         __le16 features;
 226         __le16 opt_cmd;
 227         u8 reserved[22];
 228
 229         /* manufacturer information block */
 230         char manufacturer[12];
 231         char model[20];
 232         u8 jedec_id;
 233         __le16 date_code;
 234         u8 reserved2[13];
 235
 236         /* memory organization block */
 237         __le32 byte_per_page;
 238         __le16 spare_bytes_per_page;
 239         __le32 data_bytes_per_ppage;
 240         __le16 spare_bytes_per_ppage;
 241         __le32 pages_per_block;
 242         __le32 blocks_per_lun;
 243         u8 lun_count;
 244         u8 addr_cycles;
 245         u8 bits_per_cell;
 246         __le16 bb_per_lun;
 247         __le16 block_endurance;
 248         u8 guaranteed_good_blocks;
 249         __le16 guaranteed_block_endurance;
 250         u8 programs_per_page;
 251         u8 ppage_attr;
 252         u8 ecc_bits;
 253         u8 interleaved_bits;
 254         u8 interleaved_ops;
 255         u8 reserved3[13];
 256
 257         /* electrical parameter block */
 258         u8 io_pin_capacitance_max;
 259         __le16 async_timing_mode;
 260         __le16 program_cache_timing_mode;
 261         __le16 t_prog;
 262         __le16 t_bers;
 263         __le16 t_r;
 264         __le16 t_ccs;
 265         __le16 src_sync_timing_mode;
 266         __le16 src_ssync_features;
 267         __le16 clk_pin_capacitance_typ;
 268         __le16 io_pin_capacitance_typ;
 269         __le16 input_pin_capacitance_typ;
 270         u8 input_pin_capacitance_max;
 271         u8 driver_strenght_support;
 272         __le16 t_int_r;
 273         __le16 t_ald;
 274         u8 reserved4[7];
 275
 276         /* vendor */
 277         u8 reserved5[90];
 278
 279         __le16 crc;
 280 } __attribute__((packed));
 281
 282 #define ONFI_CRC_BASE   0x4F4E
 283
 284 /**
 285  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
 286  * @lock:               protection lock
 287  * @active:             the mtd device which holds the controller currently
 288  * @wq:                 wait queue to sleep on if a NAND operation is in
 289  *                      progress used instead of the per chip wait queue
 290  *                      when a hw controller is available.
 291  */
 292 struct nand_hw_control {
 293         spinlock_t lock;
 294         struct nand_chip *active;
 295         wait_queue_head_t wq;
 296 };
 297
 298 /**
 299  * struct nand_ecc_ctrl - Control structure for ECC
 300  * @mode:       ECC mode
 301  * @steps:      number of ECC steps per page
 302  * @size:       data bytes per ECC step
 303  * @bytes:      ECC bytes per step
 304  * @strength:   max number of correctible bits per ECC step
 305  * @total:      total number of ECC bytes per page
 306  * @prepad:     padding information for syndrome based ECC generators
 307  * @postpad:    padding information for syndrome based ECC generators
 308  * @layout:     ECC layout control struct pointer
 309  * @priv:       pointer to private ECC control data
 310  * @hwctl:      function to control hardware ECC generator. Must only
 311  *              be provided if an hardware ECC is available
 312  * @calculate:  function for ECC calculation or readback from ECC hardware
 313  * @correct:    function for ECC correction, matching to ECC generator (sw/hw)
 314  * @read_page_raw:      function to read a raw page without ECC
 315  * @write_page_raw:     function to write a raw page without ECC
 316  * @read_page:  function to read a page according to the ECC generator
 317  *              requirements; returns maximum number of bitflips corrected in
 318  *              any single ECC step, 0 if bitflips uncorrectable, -EIO hw error
 319  * @read_subpage:       function to read parts of the page covered by ECC;
 320  *                      returns same as read_page()
 321  * @write_page: function to write a page according to the ECC generator
 322  *              requirements.
 323  * @write_oob_raw:      function to write chip OOB data without ECC
 324  * @read_oob_raw:       function to read chip OOB data without ECC
 325  * @read_oob:   function to read chip OOB data
 326  * @write_oob:  function to write chip OOB data
 327  */
 328 struct nand_ecc_ctrl {
 329         nand_ecc_modes_t mode;
 330         int steps;
 331         int size;
 332         int bytes;
 333         int total;
 334         int strength;
 335         int prepad;
 336         int postpad;
 337         struct nand_ecclayout   *layout;
 338         void *priv;
 339         void (*hwctl)(struct mtd_info *mtd, int mode);
 340         int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
 341                         uint8_t *ecc_code);
 342         int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
 343                         uint8_t *calc_ecc);
 344         int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 345                         uint8_t *buf, int oob_required, int page);
 346         int (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 347                         const uint8_t *buf, int oob_required);
 348         int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
 349                         uint8_t *buf, int oob_required, int page);
 350         int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 351                         uint32_t offs, uint32_t len, uint8_t *buf);
 352         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 353                         const uint8_t *buf, int oob_required);
 354         int (*write_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 355                         int page);
 356         int (*read_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 357                         int page);
 358         int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page);
 359         int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
 360                         int page);
 361 };
 362
 363 /**
 364  * struct nand_buffers - buffer structure for read/write
 365  * @ecccalc:    buffer for calculated ECC
 366  * @ecccode:    buffer for ECC read from flash
 367  * @databuf:    buffer for data - dynamically sized
 368  *
 369  * Do not change the order of buffers. databuf and oobrbuf must be in
 370  * consecutive order.
 371  */
 372 struct nand_buffers {
 373         uint8_t ecccalc[NAND_MAX_OOBSIZE];
 374         uint8_t ecccode[NAND_MAX_OOBSIZE];
 375         uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
 376 };
 377
 378 /**
 379  * struct nand_chip - NAND Private Flash Chip Data
 380  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the
 381  *                      flash device
 382  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the
 383  *                      flash device.
 384  * @read_byte:          [REPLACEABLE] read one byte from the chip
 385  * @read_word:          [REPLACEABLE] read one word from the chip
 386  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 387  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 388  * @select_chip:        [REPLACEABLE] select chip nr
 389  * @block_bad:          [REPLACEABLE] check, if the block is bad
 390  * @block_markbad:      [REPLACEABLE] mark the block bad
 391  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific function for controlling
 392  *                      ALE/CLE/nCE. Also used to write command and address
 393  * @init_size:          [BOARDSPECIFIC] hardwarespecific function for setting
 394  *                      mtd->oobsize, mtd->writesize and so on.
 395  *                      @id_data contains the 8 bytes values of NAND_CMD_READID.
 396  *                      Return with the bus width.
 397  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accessing
 398  *                      device ready/busy line. If set to NULL no access to
 399  *                      ready/busy is available and the ready/busy information
 400  *                      is read from the chip status register.
 401  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing
 402  *                      commands to the chip.
 403  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on
 404  *                      ready.
 405  * @ecc:                [BOARDSPECIFIC] ECC control structure
 406  * @buffers:            buffer structure for read/write
 407  * @hwcontrol:          platform-specific hardware control structure
 408  * @erase_cmd:          [INTERN] erase command write function, selectable due
 409  *                      to AND support.
 410  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 411  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transferring
 412  *                      data from array to read regs (tR).
 413  * @state:              [INTERN] the current state of the NAND device
 414  * @oob_poi:            "poison value buffer," used for laying out OOB data
 415  *                      before writing
 416  * @page_shift:         [INTERN] number of address bits in a page (column
 417  *                      address bits).
 418  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 419  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 420  * @chip_shift:         [INTERN] number of address bits in one chip
 421  * @options:            [BOARDSPECIFIC] various chip options. They can partly
 422  *                      be set to inform nand_scan about special functionality.
 423  *                      See the defines for further explanation.
 424  * @bbt_options:        [INTERN] bad block specific options. All options used
 425  *                      here must come from bbm.h. By default, these options
 426  *                      will be copied to the appropriate nand_bbt_descr's.
 427  * @badblockpos:        [INTERN] position of the bad block marker in the oob
 428  *                      area.
 429  * @badblockbits:       [INTERN] minimum number of set bits in a good block's
 430  *                      bad block marker position; i.e., BBM == 11110111b is
 431  *                      not bad when badblockbits == 7
 432  * @cellinfo:           [INTERN] MLC/multichip data from chip ident
 433  * @numchips:           [INTERN] number of physical chips
 434  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 435  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 436  * @pagebuf:            [INTERN] holds the pagenumber which is currently in
 437  *                      data_buf.
 438  * @pagebuf_bitflips:   [INTERN] holds the bitflip count for the page which is
 439  *                      currently in data_buf.
 440  * @subpagesize:        [INTERN] holds the subpagesize
 441  * @onfi_version:       [INTERN] holds the chip ONFI version (BCD encoded),
 442  *                      non 0 if ONFI supported.
 443  * @onfi_params:        [INTERN] holds the ONFI page parameter when ONFI is
 444  *                      supported, 0 otherwise.
 445  * @onfi_set_features:  [REPLACEABLE] set the features for ONFI nand
 446  * @onfi_get_features:  [REPLACEABLE] get the features for ONFI nand
 447  * @ecclayout:          [REPLACEABLE] the default ECC placement scheme
 448  * @bbt:                [INTERN] bad block table pointer
 449  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash
 450  *                      lookup.
 451  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 452  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial
 453  *                      bad block scan.
 454  * @controller:         [REPLACEABLE] a pointer to a hardware controller
 455  *                      structure which is shared among multiple independent
 456  *                      devices.
 457  * @priv:               [OPTIONAL] pointer to private chip data
 458  * @errstat:            [OPTIONAL] hardware specific function to perform
 459  *                      additional error status checks (determine if errors are
 460  *                      correctable).
 461  * @write_page:         [REPLACEABLE] High-level page write function
 462  */
 463
 464 struct nand_chip {
 465         void __iomem *IO_ADDR_R;
 466         void __iomem *IO_ADDR_W;
 467
 468         uint8_t (*read_byte)(struct mtd_info *mtd);
 469         u16 (*read_word)(struct mtd_info *mtd);
 470         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 471         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 472         void (*select_chip)(struct mtd_info *mtd, int chip);
 473         int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
 474         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 475         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 476         int (*init_size)(struct mtd_info *mtd, struct nand_chip *this,
 477                         u8 *id_data);
 478         int (*dev_ready)(struct mtd_info *mtd);
 479         void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
 480                         int page_addr);
 481         int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
 482         void (*erase_cmd)(struct mtd_info *mtd, int page);
 483         int (*scan_bbt)(struct mtd_info *mtd);
 484         int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
 485                         int status, int page);
 486         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 487                         const uint8_t *buf, int oob_required, int page,
 488                         int cached, int raw);
 489         int (*onfi_set_features)(struct mtd_info *mtd, struct nand_chip *chip,
 490                         int feature_addr, uint8_t *subfeature_para);
 491         int (*onfi_get_features)(struct mtd_info *mtd, struct nand_chip *chip,
 492                         int feature_addr, uint8_t *subfeature_para);
 493
 494         int chip_delay;
 495         unsigned int options;
 496         unsigned int bbt_options;
 497
 498         int page_shift;
 499         int phys_erase_shift;
 500         int bbt_erase_shift;
 501         int chip_shift;
 502         int numchips;
 503         uint64_t chipsize;
 504         int pagemask;
 505         int pagebuf;
 506         unsigned int pagebuf_bitflips;
 507         int subpagesize;
 508         uint8_t cellinfo;
 509         int badblockpos;
 510         int badblockbits;
 511
 512         int onfi_version;
 513         struct nand_onfi_params onfi_params;
 514
 515         flstate_t state;
 516
 517         uint8_t *oob_poi;
 518         struct nand_hw_control *controller;
 519         struct nand_ecclayout *ecclayout;
 520
 521         struct nand_ecc_ctrl ecc;
 522         struct nand_buffers *buffers;
 523         struct nand_hw_control hwcontrol;
 524
 525         uint8_t *bbt;
 526         struct nand_bbt_descr *bbt_td;
 527         struct nand_bbt_descr *bbt_md;
 528
 529         struct nand_bbt_descr *badblock_pattern;
 530
 531         void *priv;
 532 };
 533
 534 /*
 535  * NAND Flash Manufacturer ID Codes
 536  */
 537 #define NAND_MFR_TOSHIBA        0x98
 538 #define NAND_MFR_SAMSUNG        0xec
 539 #define NAND_MFR_FUJITSU        0x04
 540 #define NAND_MFR_NATIONAL       0x8f
 541 #define NAND_MFR_RENESAS        0x07
 542 #define NAND_MFR_STMICRO        0x20
 543 #define NAND_MFR_HYNIX          0xad
 544 #define NAND_MFR_MICRON         0x2c
 545 #define NAND_MFR_AMD            0x01
 546 #define NAND_MFR_MACRONIX       0xc2
 547 #define NAND_MFR_EON            0x92
 548
 549 /*
 550  * A helper for defining older NAND chips where the second ID byte fully
 551  * defined the chip, including the geometry (chip size, eraseblock size, page
 552  * size).
 553  */
 554 #define LEGACY_ID_NAND(nm, devid, pagesz, chipsz, erasesz, opts)       \
 555         { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = (pagesz), \
 556           .chipsize = (chipsz), .erasesize = (erasesz),                \
 557           .options = (opts) }
 558
 559 /*
 560  * A helper for defining newer chips which report their page size and
 561  * eraseblock size via the extended ID bytes.
 562  *
 563  * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
 564  * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
 565  * device ID now only represented a particular total chip size (and voltage,
 566  * buswidth), and the page size, eraseblock size, and OOB size could vary while
 567  * using the same device ID.
 568  */
 569 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts)                      \
 570         { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
 571           .options = (opts) }
 572
 573 /**
 574  * struct nand_flash_dev - NAND Flash Device ID Structure
 575  * @name: a human-readable name of the NAND chip
 576  * @dev_id: the device ID (the second byte of the full chip ID array)
 577  * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
 578  *          memory address as @id[0])
 579  * @dev_id: device ID part of the full chip ID array (refers the same memory
 580  *          address as @id[1])
 581  * @id: full device ID array
 582  * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
 583  *            well as the eraseblock size) is determined from the extended NAND
 584  *            chip ID array)
 585  * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
 586  * @chipsize: total chip size in MiB
 587  * @options: stores various chip bit options
 588  */
 589 struct nand_flash_dev {
 590         char *name;
 591         union {
 592                 struct {
 593                         uint8_t mfr_id;
 594                         uint8_t dev_id;
 595                 };
 596                 uint8_t id[8];
 597         };
 598         unsigned long pagesize;
 599         unsigned long chipsize;
 600         unsigned long erasesize;
 601         unsigned long options;
 602 };
 603
 604 /**
 605  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 606  * @name:       Manufacturer name
 607  * @id:         manufacturer ID code of device.
 608 */
 609 struct nand_manufacturers {
 610         int id;
 611         char *name;
 612 };
 613
 614 extern struct nand_flash_dev nand_flash_ids[];
 615 extern struct nand_manufacturers nand_manuf_ids[];
 616
 617 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
 618 extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
 619 extern int nand_default_bbt(struct mtd_info *mtd);
 620 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
 621 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
 622                            int allowbbt);
 623 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
 624                         size_t *retlen, uint8_t *buf);
 625
 626 /**
 627  * struct platform_nand_chip - chip level device structure
 628  * @nr_chips:           max. number of chips to scan for
 629  * @chip_offset:        chip number offset
 630  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
 631  * @partitions:         mtd partition list
 632  * @chip_delay:         R/B delay value in us
 633  * @options:            Option flags, e.g. 16bit buswidth
 634  * @bbt_options:        BBT option flags, e.g. NAND_BBT_USE_FLASH
 635  * @ecclayout:          ECC layout info structure
 636  * @part_probe_types:   NULL-terminated array of probe types
 637  */
 638 struct platform_nand_chip {
 639         int nr_chips;
 640         int chip_offset;
 641         int nr_partitions;
 642         struct mtd_partition *partitions;
 643         struct nand_ecclayout *ecclayout;
 644         int chip_delay;
 645         unsigned int options;
 646         unsigned int bbt_options;
 647         const char **part_probe_types;
 648 };
 649
 650 /* Keep gcc happy */
 651 struct platform_device;
 652
 653 /**
 654  * struct platform_nand_ctrl - controller level device structure
 655  * @probe:              platform specific function to probe/setup hardware
 656  * @remove:             platform specific function to remove/teardown hardware
 657  * @hwcontrol:          platform specific hardware control structure
 658  * @dev_ready:          platform specific function to read ready/busy pin
 659  * @select_chip:        platform specific chip select function
 660  * @cmd_ctrl:           platform specific function for controlling
 661  *                      ALE/CLE/nCE. Also used to write command and address
 662  * @write_buf:          platform specific function for write buffer
 663  * @read_buf:           platform specific function for read buffer
 664  * @read_byte:          platform specific function to read one byte from chip
 665  * @priv:               private data to transport driver specific settings
 666  *
 667  * All fields are optional and depend on the hardware driver requirements
 668  */
 669 struct platform_nand_ctrl {
 670         int (*probe)(struct platform_device *pdev);
 671         void (*remove)(struct platform_device *pdev);
 672         void (*hwcontrol)(struct mtd_info *mtd, int cmd);
 673         int (*dev_ready)(struct mtd_info *mtd);
 674         void (*select_chip)(struct mtd_info *mtd, int chip);
 675         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 676         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 677         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 678         unsigned char (*read_byte)(struct mtd_info *mtd);
 679         void *priv;
 680 };
 681
 682 /**
 683  * struct platform_nand_data - container structure for platform-specific data
 684  * @chip:               chip level chip structure
 685  * @ctrl:               controller level device structure
 686  */
 687 struct platform_nand_data {
 688         struct platform_nand_chip chip;
 689         struct platform_nand_ctrl ctrl;
 690 };
 691
 692 /* Some helpers to access the data structures */
 693 static inline
 694 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
 695 {
 696         struct nand_chip *chip = mtd->priv;
 697
 698         return chip->priv;
 699 }
 700
 701 /* return the supported asynchronous timing mode. */
 702 static inline int onfi_get_async_timing_mode(struct nand_chip *chip)
 703 {
 704         if (!chip->onfi_version)
 705                 return ONFI_TIMING_MODE_UNKNOWN;
 706         return le16_to_cpu(chip->onfi_params.async_timing_mode);
 707 }
 708
 709 /* return the supported synchronous timing mode. */
 710 static inline int onfi_get_sync_timing_mode(struct nand_chip *chip)
 711 {
 712         if (!chip->onfi_version)
 713                 return ONFI_TIMING_MODE_UNKNOWN;
 714         return le16_to_cpu(chip->onfi_params.src_sync_timing_mode);
 715 }
 716
 717 #endif /* __LINUX_MTD_NAND_H */