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