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 struct device_node;
  30
  31 /* Scan and identify a NAND device */
  32 int nand_scan(struct mtd_info *mtd, int max_chips);
  33 /*
  34  * Separate phases of nand_scan(), allowing board driver to intervene
  35  * and override command or ECC setup according to flash type.
  36  */
  37 int nand_scan_ident(struct mtd_info *mtd, int max_chips,
  38                            struct nand_flash_dev *table);
  39 int nand_scan_tail(struct mtd_info *mtd);
  40
  41 /* Unregister the MTD device and free resources held by the NAND device */
  42 void nand_release(struct mtd_info *mtd);
  43
  44 /* Internal helper for board drivers which need to override command function */
  45 void nand_wait_ready(struct mtd_info *mtd);
  46
  47 /* locks all blocks present in the device */
  48 int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  49
  50 /* unlocks specified locked blocks */
  51 int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  52
  53 /* The maximum number of NAND chips in an array */
  54 #define NAND_MAX_CHIPS          8
  55
  56 /*
  57  * Constants for hardware specific CLE/ALE/NCE function
  58  *
  59  * These are bits which can be or'ed to set/clear multiple
  60  * bits in one go.
  61  */
  62 /* Select the chip by setting nCE to low */
  63 #define NAND_NCE                0x01
  64 /* Select the command latch by setting CLE to high */
  65 #define NAND_CLE                0x02
  66 /* Select the address latch by setting ALE to high */
  67 #define NAND_ALE                0x04
  68
  69 #define NAND_CTRL_CLE           (NAND_NCE | NAND_CLE)
  70 #define NAND_CTRL_ALE           (NAND_NCE | NAND_ALE)
  71 #define NAND_CTRL_CHANGE        0x80
  72
  73 /*
  74  * Standard NAND flash commands
  75  */
  76 #define NAND_CMD_READ0          0
  77 #define NAND_CMD_READ1          1
  78 #define NAND_CMD_RNDOUT         5
  79 #define NAND_CMD_PAGEPROG       0x10
  80 #define NAND_CMD_READOOB        0x50
  81 #define NAND_CMD_ERASE1         0x60
  82 #define NAND_CMD_STATUS         0x70
  83 #define NAND_CMD_SEQIN          0x80
  84 #define NAND_CMD_RNDIN          0x85
  85 #define NAND_CMD_READID         0x90
  86 #define NAND_CMD_ERASE2         0xd0
  87 #define NAND_CMD_PARAM          0xec
  88 #define NAND_CMD_GET_FEATURES   0xee
  89 #define NAND_CMD_SET_FEATURES   0xef
  90 #define NAND_CMD_RESET          0xff
  91
  92 #define NAND_CMD_LOCK           0x2a
  93 #define NAND_CMD_UNLOCK1        0x23
  94 #define NAND_CMD_UNLOCK2        0x24
  95
  96 /* Extended commands for large page devices */
  97 #define NAND_CMD_READSTART      0x30
  98 #define NAND_CMD_RNDOUTSTART    0xE0
  99 #define NAND_CMD_CACHEDPROG     0x15
 100
 101 #define NAND_CMD_NONE           -1
 102
 103 /* Status bits */
 104 #define NAND_STATUS_FAIL        0x01
 105 #define NAND_STATUS_FAIL_N1     0x02
 106 #define NAND_STATUS_TRUE_READY  0x20
 107 #define NAND_STATUS_READY       0x40
 108 #define NAND_STATUS_WP          0x80
 109
 110 #define NAND_DATA_IFACE_CHECK_ONLY      -1
 111
 112 /*
 113  * Constants for ECC_MODES
 114  */
 115 typedef enum {
 116         NAND_ECC_NONE,
 117         NAND_ECC_SOFT,
 118         NAND_ECC_HW,
 119         NAND_ECC_HW_SYNDROME,
 120         NAND_ECC_HW_OOB_FIRST,
 121         NAND_ECC_ON_DIE,
 122 } nand_ecc_modes_t;
 123
 124 enum nand_ecc_algo {
 125         NAND_ECC_UNKNOWN,
 126         NAND_ECC_HAMMING,
 127         NAND_ECC_BCH,
 128 };
 129
 130 /*
 131  * Constants for Hardware ECC
 132  */
 133 /* Reset Hardware ECC for read */
 134 #define NAND_ECC_READ           0
 135 /* Reset Hardware ECC for write */
 136 #define NAND_ECC_WRITE          1
 137 /* Enable Hardware ECC before syndrome is read back from flash */
 138 #define NAND_ECC_READSYN        2
 139
 140 /*
 141  * Enable generic NAND 'page erased' check. This check is only done when
 142  * ecc.correct() returns -EBADMSG.
 143  * Set this flag if your implementation does not fix bitflips in erased
 144  * pages and you want to rely on the default implementation.
 145  */
 146 #define NAND_ECC_GENERIC_ERASED_CHECK   BIT(0)
 147 #define NAND_ECC_MAXIMIZE               BIT(1)
 148 /*
 149  * If your controller already sends the required NAND commands when
 150  * reading or writing a page, then the framework is not supposed to
 151  * send READ0 and SEQIN/PAGEPROG respectively.
 152  */
 153 #define NAND_ECC_CUSTOM_PAGE_ACCESS     BIT(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 /* Buswidth is 16 bit */
 164 #define NAND_BUSWIDTH_16        0x00000002
 165 /* Chip has cache program function */
 166 #define NAND_CACHEPRG           0x00000008
 167 /*
 168  * Chip requires ready check on read (for auto-incremented sequential read).
 169  * True only for small page devices; large page devices do not support
 170  * autoincrement.
 171  */
 172 #define NAND_NEED_READRDY       0x00000100
 173
 174 /* Chip does not allow subpage writes */
 175 #define NAND_NO_SUBPAGE_WRITE   0x00000200
 176
 177 /* Device is one of 'new' xD cards that expose fake nand command set */
 178 #define NAND_BROKEN_XD          0x00000400
 179
 180 /* Device behaves just like nand, but is readonly */
 181 #define NAND_ROM                0x00000800
 182
 183 /* Device supports subpage reads */
 184 #define NAND_SUBPAGE_READ       0x00001000
 185
 186 /*
 187  * Some MLC NANDs need data scrambling to limit bitflips caused by repeated
 188  * patterns.
 189  */
 190 #define NAND_NEED_SCRAMBLING    0x00002000
 191
 192 /* Options valid for Samsung large page devices */
 193 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
 194
 195 /* Macros to identify the above */
 196 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 197 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
 198 #define NAND_HAS_SUBPAGE_WRITE(chip) !((chip)->options & NAND_NO_SUBPAGE_WRITE)
 199
 200 /* Non chip related options */
 201 /* This option skips the bbt scan during initialization. */
 202 #define NAND_SKIP_BBTSCAN       0x00010000
 203 /*
 204  * This option is defined if the board driver allocates its own buffers
 205  * (e.g. because it needs them DMA-coherent).
 206  */
 207 #define NAND_OWN_BUFFERS        0x00020000
 208 /* Chip may not exist, so silence any errors in scan */
 209 #define NAND_SCAN_SILENT_NODEV  0x00040000
 210 /*
 211  * Autodetect nand buswidth with readid/onfi.
 212  * This suppose the driver will configure the hardware in 8 bits mode
 213  * when calling nand_scan_ident, and update its configuration
 214  * before calling nand_scan_tail.
 215  */
 216 #define NAND_BUSWIDTH_AUTO      0x00080000
 217 /*
 218  * This option could be defined by controller drivers to protect against
 219  * kmap'ed, vmalloc'ed highmem buffers being passed from upper layers
 220  */
 221 #define NAND_USE_BOUNCE_BUFFER  0x00100000
 222
 223 /*
 224  * In case your controller is implementing ->cmd_ctrl() and is relying on the
 225  * default ->cmdfunc() implementation, you may want to let the core handle the
 226  * tCCS delay which is required when a column change (RNDIN or RNDOUT) is
 227  * requested.
 228  * If your controller already takes care of this delay, you don't need to set
 229  * this flag.
 230  */
 231 #define NAND_WAIT_TCCS          0x00200000
 232
 233 /* Options set by nand scan */
 234 /* Nand scan has allocated controller struct */
 235 #define NAND_CONTROLLER_ALLOC   0x80000000
 236
 237 /* Cell info constants */
 238 #define NAND_CI_CHIPNR_MSK      0x03
 239 #define NAND_CI_CELLTYPE_MSK    0x0C
 240 #define NAND_CI_CELLTYPE_SHIFT  2
 241
 242 /* Keep gcc happy */
 243 struct nand_chip;
 244
 245 /* ONFI features */
 246 #define ONFI_FEATURE_16_BIT_BUS         (1 << 0)
 247 #define ONFI_FEATURE_EXT_PARAM_PAGE     (1 << 7)
 248
 249 /* ONFI timing mode, used in both asynchronous and synchronous mode */
 250 #define ONFI_TIMING_MODE_0              (1 << 0)
 251 #define ONFI_TIMING_MODE_1              (1 << 1)
 252 #define ONFI_TIMING_MODE_2              (1 << 2)
 253 #define ONFI_TIMING_MODE_3              (1 << 3)
 254 #define ONFI_TIMING_MODE_4              (1 << 4)
 255 #define ONFI_TIMING_MODE_5              (1 << 5)
 256 #define ONFI_TIMING_MODE_UNKNOWN        (1 << 6)
 257
 258 /* ONFI feature address */
 259 #define ONFI_FEATURE_ADDR_TIMING_MODE   0x1
 260
 261 /* Vendor-specific feature address (Micron) */
 262 #define ONFI_FEATURE_ADDR_READ_RETRY    0x89
 263 #define ONFI_FEATURE_ON_DIE_ECC         0x90
 264 #define   ONFI_FEATURE_ON_DIE_ECC_EN    BIT(3)
 265
 266 /* ONFI subfeature parameters length */
 267 #define ONFI_SUBFEATURE_PARAM_LEN       4
 268
 269 /* ONFI optional commands SET/GET FEATURES supported? */
 270 #define ONFI_OPT_CMD_SET_GET_FEATURES   (1 << 2)
 271
 272 struct nand_onfi_params {
 273         /* rev info and features block */
 274         /* 'O' 'N' 'F' 'I'  */
 275         u8 sig[4];
 276         __le16 revision;
 277         __le16 features;
 278         __le16 opt_cmd;
 279         u8 reserved0[2];
 280         __le16 ext_param_page_length; /* since ONFI 2.1 */
 281         u8 num_of_param_pages;        /* since ONFI 2.1 */
 282         u8 reserved1[17];
 283
 284         /* manufacturer information block */
 285         char manufacturer[12];
 286         char model[20];
 287         u8 jedec_id;
 288         __le16 date_code;
 289         u8 reserved2[13];
 290
 291         /* memory organization block */
 292         __le32 byte_per_page;
 293         __le16 spare_bytes_per_page;
 294         __le32 data_bytes_per_ppage;
 295         __le16 spare_bytes_per_ppage;
 296         __le32 pages_per_block;
 297         __le32 blocks_per_lun;
 298         u8 lun_count;
 299         u8 addr_cycles;
 300         u8 bits_per_cell;
 301         __le16 bb_per_lun;
 302         __le16 block_endurance;
 303         u8 guaranteed_good_blocks;
 304         __le16 guaranteed_block_endurance;
 305         u8 programs_per_page;
 306         u8 ppage_attr;
 307         u8 ecc_bits;
 308         u8 interleaved_bits;
 309         u8 interleaved_ops;
 310         u8 reserved3[13];
 311
 312         /* electrical parameter block */
 313         u8 io_pin_capacitance_max;
 314         __le16 async_timing_mode;
 315         __le16 program_cache_timing_mode;
 316         __le16 t_prog;
 317         __le16 t_bers;
 318         __le16 t_r;
 319         __le16 t_ccs;
 320         __le16 src_sync_timing_mode;
 321         u8 src_ssync_features;
 322         __le16 clk_pin_capacitance_typ;
 323         __le16 io_pin_capacitance_typ;
 324         __le16 input_pin_capacitance_typ;
 325         u8 input_pin_capacitance_max;
 326         u8 driver_strength_support;
 327         __le16 t_int_r;
 328         __le16 t_adl;
 329         u8 reserved4[8];
 330
 331         /* vendor */
 332         __le16 vendor_revision;
 333         u8 vendor[88];
 334
 335         __le16 crc;
 336 } __packed;
 337
 338 #define ONFI_CRC_BASE   0x4F4E
 339
 340 /* Extended ECC information Block Definition (since ONFI 2.1) */
 341 struct onfi_ext_ecc_info {
 342         u8 ecc_bits;
 343         u8 codeword_size;
 344         __le16 bb_per_lun;
 345         __le16 block_endurance;
 346         u8 reserved[2];
 347 } __packed;
 348
 349 #define ONFI_SECTION_TYPE_0     0       /* Unused section. */
 350 #define ONFI_SECTION_TYPE_1     1       /* for additional sections. */
 351 #define ONFI_SECTION_TYPE_2     2       /* for ECC information. */
 352 struct onfi_ext_section {
 353         u8 type;
 354         u8 length;
 355 } __packed;
 356
 357 #define ONFI_EXT_SECTION_MAX 8
 358
 359 /* Extended Parameter Page Definition (since ONFI 2.1) */
 360 struct onfi_ext_param_page {
 361         __le16 crc;
 362         u8 sig[4];             /* 'E' 'P' 'P' 'S' */
 363         u8 reserved0[10];
 364         struct onfi_ext_section sections[ONFI_EXT_SECTION_MAX];
 365
 366         /*
 367          * The actual size of the Extended Parameter Page is in
 368          * @ext_param_page_length of nand_onfi_params{}.
 369          * The following are the variable length sections.
 370          * So we do not add any fields below. Please see the ONFI spec.
 371          */
 372 } __packed;
 373
 374 struct jedec_ecc_info {
 375         u8 ecc_bits;
 376         u8 codeword_size;
 377         __le16 bb_per_lun;
 378         __le16 block_endurance;
 379         u8 reserved[2];
 380 } __packed;
 381
 382 /* JEDEC features */
 383 #define JEDEC_FEATURE_16_BIT_BUS        (1 << 0)
 384
 385 struct nand_jedec_params {
 386         /* rev info and features block */
 387         /* 'J' 'E' 'S' 'D'  */
 388         u8 sig[4];
 389         __le16 revision;
 390         __le16 features;
 391         u8 opt_cmd[3];
 392         __le16 sec_cmd;
 393         u8 num_of_param_pages;
 394         u8 reserved0[18];
 395
 396         /* manufacturer information block */
 397         char manufacturer[12];
 398         char model[20];
 399         u8 jedec_id[6];
 400         u8 reserved1[10];
 401
 402         /* memory organization block */
 403         __le32 byte_per_page;
 404         __le16 spare_bytes_per_page;
 405         u8 reserved2[6];
 406         __le32 pages_per_block;
 407         __le32 blocks_per_lun;
 408         u8 lun_count;
 409         u8 addr_cycles;
 410         u8 bits_per_cell;
 411         u8 programs_per_page;
 412         u8 multi_plane_addr;
 413         u8 multi_plane_op_attr;
 414         u8 reserved3[38];
 415
 416         /* electrical parameter block */
 417         __le16 async_sdr_speed_grade;
 418         __le16 toggle_ddr_speed_grade;
 419         __le16 sync_ddr_speed_grade;
 420         u8 async_sdr_features;
 421         u8 toggle_ddr_features;
 422         u8 sync_ddr_features;
 423         __le16 t_prog;
 424         __le16 t_bers;
 425         __le16 t_r;
 426         __le16 t_r_multi_plane;
 427         __le16 t_ccs;
 428         __le16 io_pin_capacitance_typ;
 429         __le16 input_pin_capacitance_typ;
 430         __le16 clk_pin_capacitance_typ;
 431         u8 driver_strength_support;
 432         __le16 t_adl;
 433         u8 reserved4[36];
 434
 435         /* ECC and endurance block */
 436         u8 guaranteed_good_blocks;
 437         __le16 guaranteed_block_endurance;
 438         struct jedec_ecc_info ecc_info[4];
 439         u8 reserved5[29];
 440
 441         /* reserved */
 442         u8 reserved6[148];
 443
 444         /* vendor */
 445         __le16 vendor_rev_num;
 446         u8 reserved7[88];
 447
 448         /* CRC for Parameter Page */
 449         __le16 crc;
 450 } __packed;
 451
 452 /**
 453  * struct nand_id - NAND id structure
 454  * @data: buffer containing the id bytes. Currently 8 bytes large, but can
 455  *        be extended if required.
 456  * @len: ID length.
 457  */
 458 struct nand_id {
 459         u8 data[8];
 460         int len;
 461 };
 462
 463 /**
 464  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
 465  * @lock:               protection lock
 466  * @active:             the mtd device which holds the controller currently
 467  * @wq:                 wait queue to sleep on if a NAND operation is in
 468  *                      progress used instead of the per chip wait queue
 469  *                      when a hw controller is available.
 470  */
 471 struct nand_hw_control {
 472         spinlock_t lock;
 473         struct nand_chip *active;
 474         wait_queue_head_t wq;
 475 };
 476
 477 static inline void nand_hw_control_init(struct nand_hw_control *nfc)
 478 {
 479         nfc->active = NULL;
 480         spin_lock_init(&nfc->lock);
 481         init_waitqueue_head(&nfc->wq);
 482 }
 483
 484 /**
 485  * struct nand_ecc_ctrl - Control structure for ECC
 486  * @mode:       ECC mode
 487  * @algo:       ECC algorithm
 488  * @steps:      number of ECC steps per page
 489  * @size:       data bytes per ECC step
 490  * @bytes:      ECC bytes per step
 491  * @strength:   max number of correctible bits per ECC step
 492  * @total:      total number of ECC bytes per page
 493  * @prepad:     padding information for syndrome based ECC generators
 494  * @postpad:    padding information for syndrome based ECC generators
 495  * @options:    ECC specific options (see NAND_ECC_XXX flags defined above)
 496  * @priv:       pointer to private ECC control data
 497  * @hwctl:      function to control hardware ECC generator. Must only
 498  *              be provided if an hardware ECC is available
 499  * @calculate:  function for ECC calculation or readback from ECC hardware
 500  * @correct:    function for ECC correction, matching to ECC generator (sw/hw).
 501  *              Should return a positive number representing the number of
 502  *              corrected bitflips, -EBADMSG if the number of bitflips exceed
 503  *              ECC strength, or any other error code if the error is not
 504  *              directly related to correction.
 505  *              If -EBADMSG is returned the input buffers should be left
 506  *              untouched.
 507  * @read_page_raw:      function to read a raw page without ECC. This function
 508  *                      should hide the specific layout used by the ECC
 509  *                      controller and always return contiguous in-band and
 510  *                      out-of-band data even if they're not stored
 511  *                      contiguously on the NAND chip (e.g.
 512  *                      NAND_ECC_HW_SYNDROME interleaves in-band and
 513  *                      out-of-band data).
 514  * @write_page_raw:     function to write a raw page without ECC. This function
 515  *                      should hide the specific layout used by the ECC
 516  *                      controller and consider the passed data as contiguous
 517  *                      in-band and out-of-band data. ECC controller is
 518  *                      responsible for doing the appropriate transformations
 519  *                      to adapt to its specific layout (e.g.
 520  *                      NAND_ECC_HW_SYNDROME interleaves in-band and
 521  *                      out-of-band data).
 522  * @read_page:  function to read a page according to the ECC generator
 523  *              requirements; returns maximum number of bitflips corrected in
 524  *              any single ECC step, -EIO hw error
 525  * @read_subpage:       function to read parts of the page covered by ECC;
 526  *                      returns same as read_page()
 527  * @write_subpage:      function to write parts of the page covered by ECC.
 528  * @write_page: function to write a page according to the ECC generator
 529  *              requirements.
 530  * @write_oob_raw:      function to write chip OOB data without ECC
 531  * @read_oob_raw:       function to read chip OOB data without ECC
 532  * @read_oob:   function to read chip OOB data
 533  * @write_oob:  function to write chip OOB data
 534  */
 535 struct nand_ecc_ctrl {
 536         nand_ecc_modes_t mode;
 537         enum nand_ecc_algo algo;
 538         int steps;
 539         int size;
 540         int bytes;
 541         int total;
 542         int strength;
 543         int prepad;
 544         int postpad;
 545         unsigned int options;
 546         void *priv;
 547         void (*hwctl)(struct mtd_info *mtd, int mode);
 548         int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
 549                         uint8_t *ecc_code);
 550         int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
 551                         uint8_t *calc_ecc);
 552         int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 553                         uint8_t *buf, int oob_required, int page);
 554         int (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 555                         const uint8_t *buf, int oob_required, int page);
 556         int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
 557                         uint8_t *buf, int oob_required, int page);
 558         int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 559                         uint32_t offs, uint32_t len, uint8_t *buf, int page);
 560         int (*write_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 561                         uint32_t offset, uint32_t data_len,
 562                         const uint8_t *data_buf, int oob_required, int page);
 563         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 564                         const uint8_t *buf, int oob_required, int page);
 565         int (*write_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 566                         int page);
 567         int (*read_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 568                         int page);
 569         int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page);
 570         int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
 571                         int page);
 572 };
 573
 574 static inline int nand_standard_page_accessors(struct nand_ecc_ctrl *ecc)
 575 {
 576         return !(ecc->options & NAND_ECC_CUSTOM_PAGE_ACCESS);
 577 }
 578
 579 /**
 580  * struct nand_buffers - buffer structure for read/write
 581  * @ecccalc:    buffer pointer for calculated ECC, size is oobsize.
 582  * @ecccode:    buffer pointer for ECC read from flash, size is oobsize.
 583  * @databuf:    buffer pointer for data, size is (page size + oobsize).
 584  *
 585  * Do not change the order of buffers. databuf and oobrbuf must be in
 586  * consecutive order.
 587  */
 588 struct nand_buffers {
 589         uint8_t *ecccalc;
 590         uint8_t *ecccode;
 591         uint8_t *databuf;
 592 };
 593
 594 /**
 595  * struct nand_sdr_timings - SDR NAND chip timings
 596  *
 597  * This struct defines the timing requirements of a SDR NAND chip.
 598  * These information can be found in every NAND datasheets and the timings
 599  * meaning are described in the ONFI specifications:
 600  * www.onfi.org/~/media/ONFI/specs/onfi_3_1_spec.pdf (chapter 4.15 Timing
 601  * Parameters)
 602  *
 603  * All these timings are expressed in picoseconds.
 604  *
 605  * @tBERS_max: Block erase time
 606  * @tCCS_min: Change column setup time
 607  * @tPROG_max: Page program time
 608  * @tR_max: Page read time
 609  * @tALH_min: ALE hold time
 610  * @tADL_min: ALE to data loading time
 611  * @tALS_min: ALE setup time
 612  * @tAR_min: ALE to RE# delay
 613  * @tCEA_max: CE# access time
 614  * @tCEH_min: CE# high hold time
 615  * @tCH_min:  CE# hold time
 616  * @tCHZ_max: CE# high to output hi-Z
 617  * @tCLH_min: CLE hold time
 618  * @tCLR_min: CLE to RE# delay
 619  * @tCLS_min: CLE setup time
 620  * @tCOH_min: CE# high to output hold
 621  * @tCS_min: CE# setup time
 622  * @tDH_min: Data hold time
 623  * @tDS_min: Data setup time
 624  * @tFEAT_max: Busy time for Set Features and Get Features
 625  * @tIR_min: Output hi-Z to RE# low
 626  * @tITC_max: Interface and Timing Mode Change time
 627  * @tRC_min: RE# cycle time
 628  * @tREA_max: RE# access time
 629  * @tREH_min: RE# high hold time
 630  * @tRHOH_min: RE# high to output hold
 631  * @tRHW_min: RE# high to WE# low
 632  * @tRHZ_max: RE# high to output hi-Z
 633  * @tRLOH_min: RE# low to output hold
 634  * @tRP_min: RE# pulse width
 635  * @tRR_min: Ready to RE# low (data only)
 636  * @tRST_max: Device reset time, measured from the falling edge of R/B# to the
 637  *            rising edge of R/B#.
 638  * @tWB_max: WE# high to SR[6] low
 639  * @tWC_min: WE# cycle time
 640  * @tWH_min: WE# high hold time
 641  * @tWHR_min: WE# high to RE# low
 642  * @tWP_min: WE# pulse width
 643  * @tWW_min: WP# transition to WE# low
 644  */
 645 struct nand_sdr_timings {
 646         u32 tBERS_max;
 647         u32 tCCS_min;
 648         u32 tPROG_max;
 649         u32 tR_max;
 650         u32 tALH_min;
 651         u32 tADL_min;
 652         u32 tALS_min;
 653         u32 tAR_min;
 654         u32 tCEA_max;
 655         u32 tCEH_min;
 656         u32 tCH_min;
 657         u32 tCHZ_max;
 658         u32 tCLH_min;
 659         u32 tCLR_min;
 660         u32 tCLS_min;
 661         u32 tCOH_min;
 662         u32 tCS_min;
 663         u32 tDH_min;
 664         u32 tDS_min;
 665         u32 tFEAT_max;
 666         u32 tIR_min;
 667         u32 tITC_max;
 668         u32 tRC_min;
 669         u32 tREA_max;
 670         u32 tREH_min;
 671         u32 tRHOH_min;
 672         u32 tRHW_min;
 673         u32 tRHZ_max;
 674         u32 tRLOH_min;
 675         u32 tRP_min;
 676         u32 tRR_min;
 677         u64 tRST_max;
 678         u32 tWB_max;
 679         u32 tWC_min;
 680         u32 tWH_min;
 681         u32 tWHR_min;
 682         u32 tWP_min;
 683         u32 tWW_min;
 684 };
 685
 686 /**
 687  * enum nand_data_interface_type - NAND interface timing type
 688  * @NAND_SDR_IFACE:     Single Data Rate interface
 689  */
 690 enum nand_data_interface_type {
 691         NAND_SDR_IFACE,
 692 };
 693
 694 /**
 695  * struct nand_data_interface - NAND interface timing
 696  * @type:       type of the timing
 697  * @timings:    The timing, type according to @type
 698  */
 699 struct nand_data_interface {
 700         enum nand_data_interface_type type;
 701         union {
 702                 struct nand_sdr_timings sdr;
 703         } timings;
 704 };
 705
 706 /**
 707  * nand_get_sdr_timings - get SDR timing from data interface
 708  * @conf:       The data interface
 709  */
 710 static inline const struct nand_sdr_timings *
 711 nand_get_sdr_timings(const struct nand_data_interface *conf)
 712 {
 713         if (conf->type != NAND_SDR_IFACE)
 714                 return ERR_PTR(-EINVAL);
 715
 716         return &conf->timings.sdr;
 717 }
 718
 719 /**
 720  * struct nand_manufacturer_ops - NAND Manufacturer operations
 721  * @detect: detect the NAND memory organization and capabilities
 722  * @init: initialize all vendor specific fields (like the ->read_retry()
 723  *        implementation) if any.
 724  * @cleanup: the ->init() function may have allocated resources, ->cleanup()
 725  *           is here to let vendor specific code release those resources.
 726  */
 727 struct nand_manufacturer_ops {
 728         void (*detect)(struct nand_chip *chip);
 729         int (*init)(struct nand_chip *chip);
 730         void (*cleanup)(struct nand_chip *chip);
 731 };
 732
 733 /**
 734  * struct nand_chip - NAND Private Flash Chip Data
 735  * @mtd:                MTD device registered to the MTD framework
 736  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the
 737  *                      flash device
 738  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the
 739  *                      flash device.
 740  * @read_byte:          [REPLACEABLE] read one byte from the chip
 741  * @read_word:          [REPLACEABLE] read one word from the chip
 742  * @write_byte:         [REPLACEABLE] write a single byte to the chip on the
 743  *                      low 8 I/O lines
 744  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 745  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 746  * @select_chip:        [REPLACEABLE] select chip nr
 747  * @block_bad:          [REPLACEABLE] check if a block is bad, using OOB markers
 748  * @block_markbad:      [REPLACEABLE] mark a block bad
 749  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific function for controlling
 750  *                      ALE/CLE/nCE. Also used to write command and address
 751  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accessing
 752  *                      device ready/busy line. If set to NULL no access to
 753  *                      ready/busy is available and the ready/busy information
 754  *                      is read from the chip status register.
 755  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing
 756  *                      commands to the chip.
 757  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on
 758  *                      ready.
 759  * @setup_read_retry:   [FLASHSPECIFIC] flash (vendor) specific function for
 760  *                      setting the read-retry mode. Mostly needed for MLC NAND.
 761  * @ecc:                [BOARDSPECIFIC] ECC control structure
 762  * @buffers:            buffer structure for read/write
 763  * @buf_align:          minimum buffer alignment required by a platform
 764  * @hwcontrol:          platform-specific hardware control structure
 765  * @erase:              [REPLACEABLE] erase function
 766  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 767  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transferring
 768  *                      data from array to read regs (tR).
 769  * @state:              [INTERN] the current state of the NAND device
 770  * @oob_poi:            "poison value buffer," used for laying out OOB data
 771  *                      before writing
 772  * @page_shift:         [INTERN] number of address bits in a page (column
 773  *                      address bits).
 774  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 775  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 776  * @chip_shift:         [INTERN] number of address bits in one chip
 777  * @options:            [BOARDSPECIFIC] various chip options. They can partly
 778  *                      be set to inform nand_scan about special functionality.
 779  *                      See the defines for further explanation.
 780  * @bbt_options:        [INTERN] bad block specific options. All options used
 781  *                      here must come from bbm.h. By default, these options
 782  *                      will be copied to the appropriate nand_bbt_descr's.
 783  * @badblockpos:        [INTERN] position of the bad block marker in the oob
 784  *                      area.
 785  * @badblockbits:       [INTERN] minimum number of set bits in a good block's
 786  *                      bad block marker position; i.e., BBM == 11110111b is
 787  *                      not bad when badblockbits == 7
 788  * @bits_per_cell:      [INTERN] number of bits per cell. i.e., 1 means SLC.
 789  * @ecc_strength_ds:    [INTERN] ECC correctability from the datasheet.
 790  *                      Minimum amount of bit errors per @ecc_step_ds guaranteed
 791  *                      to be correctable. If unknown, set to zero.
 792  * @ecc_step_ds:        [INTERN] ECC step required by the @ecc_strength_ds,
 793  *                      also from the datasheet. It is the recommended ECC step
 794  *                      size, if known; if unknown, set to zero.
 795  * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is
 796  *                            set to the actually used ONFI mode if the chip is
 797  *                            ONFI compliant or deduced from the datasheet if
 798  *                            the NAND chip is not ONFI compliant.
 799  * @numchips:           [INTERN] number of physical chips
 800  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 801  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 802  * @pagebuf:            [INTERN] holds the pagenumber which is currently in
 803  *                      data_buf.
 804  * @pagebuf_bitflips:   [INTERN] holds the bitflip count for the page which is
 805  *                      currently in data_buf.
 806  * @subpagesize:        [INTERN] holds the subpagesize
 807  * @id:                 [INTERN] holds NAND ID
 808  * @onfi_version:       [INTERN] holds the chip ONFI version (BCD encoded),
 809  *                      non 0 if ONFI supported.
 810  * @jedec_version:      [INTERN] holds the chip JEDEC version (BCD encoded),
 811  *                      non 0 if JEDEC supported.
 812  * @onfi_params:        [INTERN] holds the ONFI page parameter when ONFI is
 813  *                      supported, 0 otherwise.
 814  * @jedec_params:       [INTERN] holds the JEDEC parameter page when JEDEC is
 815  *                      supported, 0 otherwise.
 816  * @max_bb_per_die:     [INTERN] the max number of bad blocks each die of a
 817  *                      this nand device will encounter their life times.
 818  * @blocks_per_die:     [INTERN] The number of PEBs in a die
 819  * @data_interface:     [INTERN] NAND interface timing information
 820  * @read_retries:       [INTERN] the number of read retry modes supported
 821  * @onfi_set_features:  [REPLACEABLE] set the features for ONFI nand
 822  * @onfi_get_features:  [REPLACEABLE] get the features for ONFI nand
 823  * @setup_data_interface: [OPTIONAL] setup the data interface and timing. If
 824  *                        chipnr is set to %NAND_DATA_IFACE_CHECK_ONLY this
 825  *                        means the configuration should not be applied but
 826  *                        only checked.
 827  * @bbt:                [INTERN] bad block table pointer
 828  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash
 829  *                      lookup.
 830  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 831  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial
 832  *                      bad block scan.
 833  * @controller:         [REPLACEABLE] a pointer to a hardware controller
 834  *                      structure which is shared among multiple independent
 835  *                      devices.
 836  * @priv:               [OPTIONAL] pointer to private chip data
 837  * @errstat:            [OPTIONAL] hardware specific function to perform
 838  *                      additional error status checks (determine if errors are
 839  *                      correctable).
 840  * @manufacturer:       [INTERN] Contains manufacturer information
 841  */
 842
 843 struct nand_chip {
 844         struct mtd_info mtd;
 845         void __iomem *IO_ADDR_R;
 846         void __iomem *IO_ADDR_W;
 847
 848         uint8_t (*read_byte)(struct mtd_info *mtd);
 849         u16 (*read_word)(struct mtd_info *mtd);
 850         void (*write_byte)(struct mtd_info *mtd, uint8_t byte);
 851         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 852         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 853         void (*select_chip)(struct mtd_info *mtd, int chip);
 854         int (*block_bad)(struct mtd_info *mtd, loff_t ofs);
 855         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 856         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 857         int (*dev_ready)(struct mtd_info *mtd);
 858         void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
 859                         int page_addr);
 860         int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
 861         int (*erase)(struct mtd_info *mtd, int page);
 862         int (*scan_bbt)(struct mtd_info *mtd);
 863         int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
 864                         int status, int page);
 865         int (*onfi_set_features)(struct mtd_info *mtd, struct nand_chip *chip,
 866                         int feature_addr, uint8_t *subfeature_para);
 867         int (*onfi_get_features)(struct mtd_info *mtd, struct nand_chip *chip,
 868                         int feature_addr, uint8_t *subfeature_para);
 869         int (*setup_read_retry)(struct mtd_info *mtd, int retry_mode);
 870         int (*setup_data_interface)(struct mtd_info *mtd, int chipnr,
 871                                     const struct nand_data_interface *conf);
 872
 873
 874         int chip_delay;
 875         unsigned int options;
 876         unsigned int bbt_options;
 877
 878         int page_shift;
 879         int phys_erase_shift;
 880         int bbt_erase_shift;
 881         int chip_shift;
 882         int numchips;
 883         uint64_t chipsize;
 884         int pagemask;
 885         int pagebuf;
 886         unsigned int pagebuf_bitflips;
 887         int subpagesize;
 888         uint8_t bits_per_cell;
 889         uint16_t ecc_strength_ds;
 890         uint16_t ecc_step_ds;
 891         int onfi_timing_mode_default;
 892         int badblockpos;
 893         int badblockbits;
 894
 895         struct nand_id id;
 896         int onfi_version;
 897         int jedec_version;
 898         union {
 899                 struct nand_onfi_params onfi_params;
 900                 struct nand_jedec_params jedec_params;
 901         };
 902         u16 max_bb_per_die;
 903         u32 blocks_per_die;
 904
 905         struct nand_data_interface *data_interface;
 906
 907         int read_retries;
 908
 909         flstate_t state;
 910
 911         uint8_t *oob_poi;
 912         struct nand_hw_control *controller;
 913
 914         struct nand_ecc_ctrl ecc;
 915         struct nand_buffers *buffers;
 916         unsigned long buf_align;
 917         struct nand_hw_control hwcontrol;
 918
 919         uint8_t *bbt;
 920         struct nand_bbt_descr *bbt_td;
 921         struct nand_bbt_descr *bbt_md;
 922
 923         struct nand_bbt_descr *badblock_pattern;
 924
 925         void *priv;
 926
 927         struct {
 928                 const struct nand_manufacturer *desc;
 929                 void *priv;
 930         } manufacturer;
 931 };
 932
 933 extern const struct mtd_ooblayout_ops nand_ooblayout_sp_ops;
 934 extern const struct mtd_ooblayout_ops nand_ooblayout_lp_ops;
 935
 936 static inline void nand_set_flash_node(struct nand_chip *chip,
 937                                        struct device_node *np)
 938 {
 939         mtd_set_of_node(&chip->mtd, np);
 940 }
 941
 942 static inline struct device_node *nand_get_flash_node(struct nand_chip *chip)
 943 {
 944         return mtd_get_of_node(&chip->mtd);
 945 }
 946
 947 static inline struct nand_chip *mtd_to_nand(struct mtd_info *mtd)
 948 {
 949         return container_of(mtd, struct nand_chip, mtd);
 950 }
 951
 952 static inline struct mtd_info *nand_to_mtd(struct nand_chip *chip)
 953 {
 954         return &chip->mtd;
 955 }
 956
 957 static inline void *nand_get_controller_data(struct nand_chip *chip)
 958 {
 959         return chip->priv;
 960 }
 961
 962 static inline void nand_set_controller_data(struct nand_chip *chip, void *priv)
 963 {
 964         chip->priv = priv;
 965 }
 966
 967 static inline void nand_set_manufacturer_data(struct nand_chip *chip,
 968                                               void *priv)
 969 {
 970         chip->manufacturer.priv = priv;
 971 }
 972
 973 static inline void *nand_get_manufacturer_data(struct nand_chip *chip)
 974 {
 975         return chip->manufacturer.priv;
 976 }
 977
 978 /*
 979  * NAND Flash Manufacturer ID Codes
 980  */
 981 #define NAND_MFR_TOSHIBA        0x98
 982 #define NAND_MFR_ESMT           0xc8
 983 #define NAND_MFR_SAMSUNG        0xec
 984 #define NAND_MFR_FUJITSU        0x04
 985 #define NAND_MFR_NATIONAL       0x8f
 986 #define NAND_MFR_RENESAS        0x07
 987 #define NAND_MFR_STMICRO        0x20
 988 #define NAND_MFR_HYNIX          0xad
 989 #define NAND_MFR_MICRON         0x2c
 990 #define NAND_MFR_AMD            0x01
 991 #define NAND_MFR_MACRONIX       0xc2
 992 #define NAND_MFR_EON            0x92
 993 #define NAND_MFR_SANDISK        0x45
 994 #define NAND_MFR_INTEL          0x89
 995 #define NAND_MFR_ATO            0x9b
 996 #define NAND_MFR_WINBOND        0xef
 997
 998 /* The maximum expected count of bytes in the NAND ID sequence */
 999 #define NAND_MAX_ID_LEN 8
1000
1001 /*
1002  * A helper for defining older NAND chips where the second ID byte fully
1003  * defined the chip, including the geometry (chip size, eraseblock size, page
1004  * size). All these chips have 512 bytes NAND page size.
1005  */
1006 #define LEGACY_ID_NAND(nm, devid, chipsz, erasesz, opts)          \
1007         { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = 512, \
1008           .chipsize = (chipsz), .erasesize = (erasesz), .options = (opts) }
1009
1010 /*
1011  * A helper for defining newer chips which report their page size and
1012  * eraseblock size via the extended ID bytes.
1013  *
1014  * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
1015  * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
1016  * device ID now only represented a particular total chip size (and voltage,
1017  * buswidth), and the page size, eraseblock size, and OOB size could vary while
1018  * using the same device ID.
1019  */
1020 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts)                      \
1021         { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
1022           .options = (opts) }
1023
1024 #define NAND_ECC_INFO(_strength, _step) \
1025                         { .strength_ds = (_strength), .step_ds = (_step) }
1026 #define NAND_ECC_STRENGTH(type)         ((type)->ecc.strength_ds)
1027 #define NAND_ECC_STEP(type)             ((type)->ecc.step_ds)
1028
1029 /**
1030  * struct nand_flash_dev - NAND Flash Device ID Structure
1031  * @name: a human-readable name of the NAND chip
1032  * @dev_id: the device ID (the second byte of the full chip ID array)
1033  * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
1034  *          memory address as @id[0])
1035  * @dev_id: device ID part of the full chip ID array (refers the same memory
1036  *          address as @id[1])
1037  * @id: full device ID array
1038  * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
1039  *            well as the eraseblock size) is determined from the extended NAND
1040  *            chip ID array)
1041  * @chipsize: total chip size in MiB
1042  * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
1043  * @options: stores various chip bit options
1044  * @id_len: The valid length of the @id.
1045  * @oobsize: OOB size
1046  * @ecc: ECC correctability and step information from the datasheet.
1047  * @ecc.strength_ds: The ECC correctability from the datasheet, same as the
1048  *                   @ecc_strength_ds in nand_chip{}.
1049  * @ecc.step_ds: The ECC step required by the @ecc.strength_ds, same as the
1050  *               @ecc_step_ds in nand_chip{}, also from the datasheet.
1051  *               For example, the "4bit ECC for each 512Byte" can be set with
1052  *               NAND_ECC_INFO(4, 512).
1053  * @onfi_timing_mode_default: the default ONFI timing mode entered after a NAND
1054  *                            reset. Should be deduced from timings described
1055  *                            in the datasheet.
1056  *
1057  */
1058 struct nand_flash_dev {
1059         char *name;
1060         union {
1061                 struct {
1062                         uint8_t mfr_id;
1063                         uint8_t dev_id;
1064                 };
1065                 uint8_t id[NAND_MAX_ID_LEN];
1066         };
1067         unsigned int pagesize;
1068         unsigned int chipsize;
1069         unsigned int erasesize;
1070         unsigned int options;
1071         uint16_t id_len;
1072         uint16_t oobsize;
1073         struct {
1074                 uint16_t strength_ds;
1075                 uint16_t step_ds;
1076         } ecc;
1077         int onfi_timing_mode_default;
1078 };
1079
1080 /**
1081  * struct nand_manufacturer - NAND Flash Manufacturer structure
1082  * @name:       Manufacturer name
1083  * @id:         manufacturer ID code of device.
1084  * @ops:        manufacturer operations
1085 */
1086 struct nand_manufacturer {
1087         int id;
1088         char *name;
1089         const struct nand_manufacturer_ops *ops;
1090 };
1091
1092 const struct nand_manufacturer *nand_get_manufacturer(u8 id);
1093
1094 static inline const char *
1095 nand_manufacturer_name(const struct nand_manufacturer *manufacturer)
1096 {
1097         return manufacturer ? manufacturer->name : "Unknown";
1098 }
1099
1100 extern struct nand_flash_dev nand_flash_ids[];
1101
1102 extern const struct nand_manufacturer_ops toshiba_nand_manuf_ops;
1103 extern const struct nand_manufacturer_ops samsung_nand_manuf_ops;
1104 extern const struct nand_manufacturer_ops hynix_nand_manuf_ops;
1105 extern const struct nand_manufacturer_ops micron_nand_manuf_ops;
1106 extern const struct nand_manufacturer_ops amd_nand_manuf_ops;
1107 extern const struct nand_manufacturer_ops macronix_nand_manuf_ops;
1108
1109 int nand_default_bbt(struct mtd_info *mtd);
1110 int nand_markbad_bbt(struct mtd_info *mtd, loff_t offs);
1111 int nand_isreserved_bbt(struct mtd_info *mtd, loff_t offs);
1112 int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
1113 int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
1114                     int allowbbt);
1115 int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
1116                  size_t *retlen, uint8_t *buf);
1117
1118 /**
1119  * struct platform_nand_chip - chip level device structure
1120  * @nr_chips:           max. number of chips to scan for
1121  * @chip_offset:        chip number offset
1122  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
1123  * @partitions:         mtd partition list
1124  * @chip_delay:         R/B delay value in us
1125  * @options:            Option flags, e.g. 16bit buswidth
1126  * @bbt_options:        BBT option flags, e.g. NAND_BBT_USE_FLASH
1127  * @part_probe_types:   NULL-terminated array of probe types
1128  */
1129 struct platform_nand_chip {
1130         int nr_chips;
1131         int chip_offset;
1132         int nr_partitions;
1133         struct mtd_partition *partitions;
1134         int chip_delay;
1135         unsigned int options;
1136         unsigned int bbt_options;
1137         const char **part_probe_types;
1138 };
1139
1140 /* Keep gcc happy */
1141 struct platform_device;
1142
1143 /**
1144  * struct platform_nand_ctrl - controller level device structure
1145  * @probe:              platform specific function to probe/setup hardware
1146  * @remove:             platform specific function to remove/teardown hardware
1147  * @hwcontrol:          platform specific hardware control structure
1148  * @dev_ready:          platform specific function to read ready/busy pin
1149  * @select_chip:        platform specific chip select function
1150  * @cmd_ctrl:           platform specific function for controlling
1151  *                      ALE/CLE/nCE. Also used to write command and address
1152  * @write_buf:          platform specific function for write buffer
1153  * @read_buf:           platform specific function for read buffer
1154  * @read_byte:          platform specific function to read one byte from chip
1155  * @priv:               private data to transport driver specific settings
1156  *
1157  * All fields are optional and depend on the hardware driver requirements
1158  */
1159 struct platform_nand_ctrl {
1160         int (*probe)(struct platform_device *pdev);
1161         void (*remove)(struct platform_device *pdev);
1162         void (*hwcontrol)(struct mtd_info *mtd, int cmd);
1163         int (*dev_ready)(struct mtd_info *mtd);
1164         void (*select_chip)(struct mtd_info *mtd, int chip);
1165         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
1166         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
1167         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
1168         unsigned char (*read_byte)(struct mtd_info *mtd);
1169         void *priv;
1170 };
1171
1172 /**
1173  * struct platform_nand_data - container structure for platform-specific data
1174  * @chip:               chip level chip structure
1175  * @ctrl:               controller level device structure
1176  */
1177 struct platform_nand_data {
1178         struct platform_nand_chip chip;
1179         struct platform_nand_ctrl ctrl;
1180 };
1181
1182 /* return the supported features. */
1183 static inline int onfi_feature(struct nand_chip *chip)
1184 {
1185         return chip->onfi_version ? le16_to_cpu(chip->onfi_params.features) : 0;
1186 }
1187
1188 /* return the supported asynchronous timing mode. */
1189 static inline int onfi_get_async_timing_mode(struct nand_chip *chip)
1190 {
1191         if (!chip->onfi_version)
1192                 return ONFI_TIMING_MODE_UNKNOWN;
1193         return le16_to_cpu(chip->onfi_params.async_timing_mode);
1194 }
1195
1196 /* return the supported synchronous timing mode. */
1197 static inline int onfi_get_sync_timing_mode(struct nand_chip *chip)
1198 {
1199         if (!chip->onfi_version)
1200                 return ONFI_TIMING_MODE_UNKNOWN;
1201         return le16_to_cpu(chip->onfi_params.src_sync_timing_mode);
1202 }
1203
1204 int onfi_init_data_interface(struct nand_chip *chip,
1205                              struct nand_data_interface *iface,
1206                              enum nand_data_interface_type type,
1207                              int timing_mode);
1208
1209 /*
1210  * Check if it is a SLC nand.
1211  * The !nand_is_slc() can be used to check the MLC/TLC nand chips.
1212  * We do not distinguish the MLC and TLC now.
1213  */
1214 static inline bool nand_is_slc(struct nand_chip *chip)
1215 {
1216         return chip->bits_per_cell == 1;
1217 }
1218
1219 /**
1220  * Check if the opcode's address should be sent only on the lower 8 bits
1221  * @command: opcode to check
1222  */
1223 static inline int nand_opcode_8bits(unsigned int command)
1224 {
1225         switch (command) {
1226         case NAND_CMD_READID:
1227         case NAND_CMD_PARAM:
1228         case NAND_CMD_GET_FEATURES:
1229         case NAND_CMD_SET_FEATURES:
1230                 return 1;
1231         default:
1232                 break;
1233         }
1234         return 0;
1235 }
1236
1237 /* return the supported JEDEC features. */
1238 static inline int jedec_feature(struct nand_chip *chip)
1239 {
1240         return chip->jedec_version ? le16_to_cpu(chip->jedec_params.features)
1241                 : 0;
1242 }
1243
1244 /* get timing characteristics from ONFI timing mode. */
1245 const struct nand_sdr_timings *onfi_async_timing_mode_to_sdr_timings(int mode);
1246 /* get data interface from ONFI timing mode 0, used after reset. */
1247 const struct nand_data_interface *nand_get_default_data_interface(void);
1248
1249 int nand_check_erased_ecc_chunk(void *data, int datalen,
1250                                 void *ecc, int ecclen,
1251                                 void *extraoob, int extraooblen,
1252                                 int threshold);
1253
1254 /* Default write_oob implementation */
1255 int nand_write_oob_std(struct mtd_info *mtd, struct nand_chip *chip, int page);
1256
1257 /* Default write_oob syndrome implementation */
1258 int nand_write_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1259                             int page);
1260
1261 /* Default read_oob implementation */
1262 int nand_read_oob_std(struct mtd_info *mtd, struct nand_chip *chip, int page);
1263
1264 /* Default read_oob syndrome implementation */
1265 int nand_read_oob_syndrome(struct mtd_info *mtd, struct nand_chip *chip,
1266                            int page);
1267
1268 /* Stub used by drivers that do not support GET/SET FEATURES operations */
1269 int nand_onfi_get_set_features_notsupp(struct mtd_info *mtd,
1270                                        struct nand_chip *chip, int addr,
1271                                        u8 *subfeature_param);
1272
1273 /* Default read_page_raw implementation */
1274 int nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1275                        uint8_t *buf, int oob_required, int page);
1276
1277 /* Default write_page_raw implementation */
1278 int nand_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
1279                         const uint8_t *buf, int oob_required, int page);
1280
1281 /* Reset and initialize a NAND device */
1282 int nand_reset(struct nand_chip *chip, int chipnr);
1283
1284 /* Free resources held by the NAND device */
1285 void nand_cleanup(struct nand_chip *chip);
1286
1287 /* Default extended ID decoding function */
1288 void nand_decode_ext_id(struct nand_chip *chip);
1289 #endif /* __LINUX_MTD_NAND_H */