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