include/linux/mtd/nand.h

   1 /*
   2  *  linux/include/linux/mtd/nand.h
   3  *
   4  *  Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
   5  *                        Steven J. Hill <sjhill@realitydiluted.com>
   6  *                        Thomas Gleixner <tglx@linutronix.de>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  *
  12  * Info:
  13  *      Contains standard defines and IDs for NAND flash devices
  14  *
  15  * Changelog:
  16  *      See git changelog.
  17  */
  18 #ifndef __LINUX_MTD_NAND_H
  19 #define __LINUX_MTD_NAND_H
  20
  21 #include <linux/wait.h>
  22 #include <linux/spinlock.h>
  23 #include <linux/mtd/mtd.h>
  24 #include <linux/mtd/flashchip.h>
  25 #include <linux/mtd/bbm.h>
  26
  27 struct mtd_info;
  28 struct nand_flash_dev;
  29 /* Scan and identify a NAND device */
  30 extern int nand_scan(struct mtd_info *mtd, int max_chips);
  31 /*
  32  * Separate phases of nand_scan(), allowing board driver to intervene
  33  * and override command or ECC setup according to flash type.
  34  */
  35 extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
  36                            struct nand_flash_dev *table);
  37 extern int nand_scan_tail(struct mtd_info *mtd);
  38
  39 /* Free resources held by the NAND device */
  40 extern void nand_release(struct mtd_info *mtd);
  41
  42 /* Internal helper for board drivers which need to override command function */
  43 extern void nand_wait_ready(struct mtd_info *mtd);
  44
  45 /* locks all blocks present in the device */
  46 extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  47
  48 /* unlocks specified locked blocks */
  49 extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
  50
  51 /* The maximum number of NAND chips in an array */
  52 #define NAND_MAX_CHIPS          8
  53
  54 /*
  55  * Constants for hardware specific CLE/ALE/NCE function
  56  *
  57  * These are bits which can be or'ed to set/clear multiple
  58  * bits in one go.
  59  */
  60 /* Select the chip by setting nCE to low */
  61 #define NAND_NCE                0x01
  62 /* Select the command latch by setting CLE to high */
  63 #define NAND_CLE                0x02
  64 /* Select the address latch by setting ALE to high */
  65 #define NAND_ALE                0x04
  66
  67 #define NAND_CTRL_CLE           (NAND_NCE | NAND_CLE)
  68 #define NAND_CTRL_ALE           (NAND_NCE | NAND_ALE)
  69 #define NAND_CTRL_CHANGE        0x80
  70
  71 /*
  72  * Standard NAND flash commands
  73  */
  74 #define NAND_CMD_READ0          0
  75 #define NAND_CMD_READ1          1
  76 #define NAND_CMD_RNDOUT         5
  77 #define NAND_CMD_PAGEPROG       0x10
  78 #define NAND_CMD_READOOB        0x50
  79 #define NAND_CMD_ERASE1         0x60
  80 #define NAND_CMD_STATUS         0x70
  81 #define NAND_CMD_SEQIN          0x80
  82 #define NAND_CMD_RNDIN          0x85
  83 #define NAND_CMD_READID         0x90
  84 #define NAND_CMD_ERASE2         0xd0
  85 #define NAND_CMD_PARAM          0xec
  86 #define NAND_CMD_GET_FEATURES   0xee
  87 #define NAND_CMD_SET_FEATURES   0xef
  88 #define NAND_CMD_RESET          0xff
  89
  90 #define NAND_CMD_LOCK           0x2a
  91 #define NAND_CMD_UNLOCK1        0x23
  92 #define NAND_CMD_UNLOCK2        0x24
  93
  94 /* Extended commands for large page devices */
  95 #define NAND_CMD_READSTART      0x30
  96 #define NAND_CMD_RNDOUTSTART    0xE0
  97 #define NAND_CMD_CACHEDPROG     0x15
  98
  99 #define NAND_CMD_NONE           -1
 100
 101 /* Status bits */
 102 #define NAND_STATUS_FAIL        0x01
 103 #define NAND_STATUS_FAIL_N1     0x02
 104 #define NAND_STATUS_TRUE_READY  0x20
 105 #define NAND_STATUS_READY       0x40
 106 #define NAND_STATUS_WP          0x80
 107
 108 /*
 109  * Constants for ECC_MODES
 110  */
 111 typedef enum {
 112         NAND_ECC_NONE,
 113         NAND_ECC_SOFT,
 114         NAND_ECC_HW,
 115         NAND_ECC_HW_SYNDROME,
 116         NAND_ECC_HW_OOB_FIRST,
 117         NAND_ECC_SOFT_BCH,
 118 } nand_ecc_modes_t;
 119
 120 /*
 121  * Constants for Hardware ECC
 122  */
 123 /* Reset Hardware ECC for read */
 124 #define NAND_ECC_READ           0
 125 /* Reset Hardware ECC for write */
 126 #define NAND_ECC_WRITE          1
 127 /* Enable Hardware ECC before syndrome is read back from flash */
 128 #define NAND_ECC_READSYN        2
 129
 130 /* Bit mask for flags passed to do_nand_read_ecc */
 131 #define NAND_GET_DEVICE         0x80
 132
 133
 134 /*
 135  * Option constants for bizarre disfunctionality and real
 136  * features.
 137  */
 138 /* Buswidth is 16 bit */
 139 #define NAND_BUSWIDTH_16        0x00000002
 140 /* Chip has cache program function */
 141 #define NAND_CACHEPRG           0x00000008
 142 /*
 143  * Chip requires ready check on read (for auto-incremented sequential read).
 144  * True only for small page devices; large page devices do not support
 145  * autoincrement.
 146  */
 147 #define NAND_NEED_READRDY       0x00000100
 148
 149 /* Chip does not allow subpage writes */
 150 #define NAND_NO_SUBPAGE_WRITE   0x00000200
 151
 152 /* Device is one of 'new' xD cards that expose fake nand command set */
 153 #define NAND_BROKEN_XD          0x00000400
 154
 155 /* Device behaves just like nand, but is readonly */
 156 #define NAND_ROM                0x00000800
 157
 158 /* Device supports subpage reads */
 159 #define NAND_SUBPAGE_READ       0x00001000
 160
 161 /* Options valid for Samsung large page devices */
 162 #define NAND_SAMSUNG_LP_OPTIONS NAND_CACHEPRG
 163
 164 /* Macros to identify the above */
 165 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
 166 #define NAND_HAS_SUBPAGE_READ(chip) ((chip->options & NAND_SUBPAGE_READ))
 167
 168 /* Non chip related options */
 169 /* This option skips the bbt scan during initialization. */
 170 #define NAND_SKIP_BBTSCAN       0x00010000
 171 /*
 172  * This option is defined if the board driver allocates its own buffers
 173  * (e.g. because it needs them DMA-coherent).
 174  */
 175 #define NAND_OWN_BUFFERS        0x00020000
 176 /* Chip may not exist, so silence any errors in scan */
 177 #define NAND_SCAN_SILENT_NODEV  0x00040000
 178 /*
 179  * Autodetect nand buswidth with readid/onfi.
 180  * This suppose the driver will configure the hardware in 8 bits mode
 181  * when calling nand_scan_ident, and update its configuration
 182  * before calling nand_scan_tail.
 183  */
 184 #define NAND_BUSWIDTH_AUTO      0x00080000
 185
 186 /* Options set by nand scan */
 187 /* Nand scan has allocated controller struct */
 188 #define NAND_CONTROLLER_ALLOC   0x80000000
 189
 190 /* Cell info constants */
 191 #define NAND_CI_CHIPNR_MSK      0x03
 192 #define NAND_CI_CELLTYPE_MSK    0x0C
 193 #define NAND_CI_CELLTYPE_SHIFT  2
 194
 195 /* Keep gcc happy */
 196 struct nand_chip;
 197
 198 /* ONFI features */
 199 #define ONFI_FEATURE_16_BIT_BUS         (1 << 0)
 200 #define ONFI_FEATURE_EXT_PARAM_PAGE     (1 << 7)
 201
 202 /* ONFI timing mode, used in both asynchronous and synchronous mode */
 203 #define ONFI_TIMING_MODE_0              (1 << 0)
 204 #define ONFI_TIMING_MODE_1              (1 << 1)
 205 #define ONFI_TIMING_MODE_2              (1 << 2)
 206 #define ONFI_TIMING_MODE_3              (1 << 3)
 207 #define ONFI_TIMING_MODE_4              (1 << 4)
 208 #define ONFI_TIMING_MODE_5              (1 << 5)
 209 #define ONFI_TIMING_MODE_UNKNOWN        (1 << 6)
 210
 211 /* ONFI feature address */
 212 #define ONFI_FEATURE_ADDR_TIMING_MODE   0x1
 213
 214 /* Vendor-specific feature address (Micron) */
 215 #define ONFI_FEATURE_ADDR_READ_RETRY    0x89
 216
 217 /* ONFI subfeature parameters length */
 218 #define ONFI_SUBFEATURE_PARAM_LEN       4
 219
 220 /* ONFI optional commands SET/GET FEATURES supported? */
 221 #define ONFI_OPT_CMD_SET_GET_FEATURES   (1 << 2)
 222
 223 struct nand_onfi_params {
 224         /* rev info and features block */
 225         /* 'O' 'N' 'F' 'I'  */
 226         u8 sig[4];
 227         __le16 revision;
 228         __le16 features;
 229         __le16 opt_cmd;
 230         u8 reserved0[2];
 231         __le16 ext_param_page_length; /* since ONFI 2.1 */
 232         u8 num_of_param_pages;        /* since ONFI 2.1 */
 233         u8 reserved1[17];
 234
 235         /* manufacturer information block */
 236         char manufacturer[12];
 237         char model[20];
 238         u8 jedec_id;
 239         __le16 date_code;
 240         u8 reserved2[13];
 241
 242         /* memory organization block */
 243         __le32 byte_per_page;
 244         __le16 spare_bytes_per_page;
 245         __le32 data_bytes_per_ppage;
 246         __le16 spare_bytes_per_ppage;
 247         __le32 pages_per_block;
 248         __le32 blocks_per_lun;
 249         u8 lun_count;
 250         u8 addr_cycles;
 251         u8 bits_per_cell;
 252         __le16 bb_per_lun;
 253         __le16 block_endurance;
 254         u8 guaranteed_good_blocks;
 255         __le16 guaranteed_block_endurance;
 256         u8 programs_per_page;
 257         u8 ppage_attr;
 258         u8 ecc_bits;
 259         u8 interleaved_bits;
 260         u8 interleaved_ops;
 261         u8 reserved3[13];
 262
 263         /* electrical parameter block */
 264         u8 io_pin_capacitance_max;
 265         __le16 async_timing_mode;
 266         __le16 program_cache_timing_mode;
 267         __le16 t_prog;
 268         __le16 t_bers;
 269         __le16 t_r;
 270         __le16 t_ccs;
 271         __le16 src_sync_timing_mode;
 272         __le16 src_ssync_features;
 273         __le16 clk_pin_capacitance_typ;
 274         __le16 io_pin_capacitance_typ;
 275         __le16 input_pin_capacitance_typ;
 276         u8 input_pin_capacitance_max;
 277         u8 driver_strength_support;
 278         __le16 t_int_r;
 279         __le16 t_ald;
 280         u8 reserved4[7];
 281
 282         /* vendor */
 283         __le16 vendor_revision;
 284         u8 vendor[88];
 285
 286         __le16 crc;
 287 } __packed;
 288
 289 #define ONFI_CRC_BASE   0x4F4E
 290
 291 /* Extended ECC information Block Definition (since ONFI 2.1) */
 292 struct onfi_ext_ecc_info {
 293         u8 ecc_bits;
 294         u8 codeword_size;
 295         __le16 bb_per_lun;
 296         __le16 block_endurance;
 297         u8 reserved[2];
 298 } __packed;
 299
 300 #define ONFI_SECTION_TYPE_0     0       /* Unused section. */
 301 #define ONFI_SECTION_TYPE_1     1       /* for additional sections. */
 302 #define ONFI_SECTION_TYPE_2     2       /* for ECC information. */
 303 struct onfi_ext_section {
 304         u8 type;
 305         u8 length;
 306 } __packed;
 307
 308 #define ONFI_EXT_SECTION_MAX 8
 309
 310 /* Extended Parameter Page Definition (since ONFI 2.1) */
 311 struct onfi_ext_param_page {
 312         __le16 crc;
 313         u8 sig[4];             /* 'E' 'P' 'P' 'S' */
 314         u8 reserved0[10];
 315         struct onfi_ext_section sections[ONFI_EXT_SECTION_MAX];
 316
 317         /*
 318          * The actual size of the Extended Parameter Page is in
 319          * @ext_param_page_length of nand_onfi_params{}.
 320          * The following are the variable length sections.
 321          * So we do not add any fields below. Please see the ONFI spec.
 322          */
 323 } __packed;
 324
 325 struct nand_onfi_vendor_micron {
 326         u8 two_plane_read;
 327         u8 read_cache;
 328         u8 read_unique_id;
 329         u8 dq_imped;
 330         u8 dq_imped_num_settings;
 331         u8 dq_imped_feat_addr;
 332         u8 rb_pulldown_strength;
 333         u8 rb_pulldown_strength_feat_addr;
 334         u8 rb_pulldown_strength_num_settings;
 335         u8 otp_mode;
 336         u8 otp_page_start;
 337         u8 otp_data_prot_addr;
 338         u8 otp_num_pages;
 339         u8 otp_feat_addr;
 340         u8 read_retry_options;
 341         u8 reserved[72];
 342         u8 param_revision;
 343 } __packed;
 344
 345 struct jedec_ecc_info {
 346         u8 ecc_bits;
 347         u8 codeword_size;
 348         __le16 bb_per_lun;
 349         __le16 block_endurance;
 350         u8 reserved[2];
 351 } __packed;
 352
 353 /* JEDEC features */
 354 #define JEDEC_FEATURE_16_BIT_BUS        (1 << 0)
 355
 356 struct nand_jedec_params {
 357         /* rev info and features block */
 358         /* 'J' 'E' 'S' 'D'  */
 359         u8 sig[4];
 360         __le16 revision;
 361         __le16 features;
 362         u8 opt_cmd[3];
 363         __le16 sec_cmd;
 364         u8 num_of_param_pages;
 365         u8 reserved0[18];
 366
 367         /* manufacturer information block */
 368         char manufacturer[12];
 369         char model[20];
 370         u8 jedec_id[6];
 371         u8 reserved1[10];
 372
 373         /* memory organization block */
 374         __le32 byte_per_page;
 375         __le16 spare_bytes_per_page;
 376         u8 reserved2[6];
 377         __le32 pages_per_block;
 378         __le32 blocks_per_lun;
 379         u8 lun_count;
 380         u8 addr_cycles;
 381         u8 bits_per_cell;
 382         u8 programs_per_page;
 383         u8 multi_plane_addr;
 384         u8 multi_plane_op_attr;
 385         u8 reserved3[38];
 386
 387         /* electrical parameter block */
 388         __le16 async_sdr_speed_grade;
 389         __le16 toggle_ddr_speed_grade;
 390         __le16 sync_ddr_speed_grade;
 391         u8 async_sdr_features;
 392         u8 toggle_ddr_features;
 393         u8 sync_ddr_features;
 394         __le16 t_prog;
 395         __le16 t_bers;
 396         __le16 t_r;
 397         __le16 t_r_multi_plane;
 398         __le16 t_ccs;
 399         __le16 io_pin_capacitance_typ;
 400         __le16 input_pin_capacitance_typ;
 401         __le16 clk_pin_capacitance_typ;
 402         u8 driver_strength_support;
 403         __le16 t_ald;
 404         u8 reserved4[36];
 405
 406         /* ECC and endurance block */
 407         u8 guaranteed_good_blocks;
 408         __le16 guaranteed_block_endurance;
 409         struct jedec_ecc_info ecc_info[4];
 410         u8 reserved5[29];
 411
 412         /* reserved */
 413         u8 reserved6[148];
 414
 415         /* vendor */
 416         __le16 vendor_rev_num;
 417         u8 reserved7[88];
 418
 419         /* CRC for Parameter Page */
 420         __le16 crc;
 421 } __packed;
 422
 423 /**
 424  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
 425  * @lock:               protection lock
 426  * @active:             the mtd device which holds the controller currently
 427  * @wq:                 wait queue to sleep on if a NAND operation is in
 428  *                      progress used instead of the per chip wait queue
 429  *                      when a hw controller is available.
 430  */
 431 struct nand_hw_control {
 432         spinlock_t lock;
 433         struct nand_chip *active;
 434         wait_queue_head_t wq;
 435 };
 436
 437 /**
 438  * struct nand_ecc_ctrl - Control structure for ECC
 439  * @mode:       ECC mode
 440  * @steps:      number of ECC steps per page
 441  * @size:       data bytes per ECC step
 442  * @bytes:      ECC bytes per step
 443  * @strength:   max number of correctible bits per ECC step
 444  * @total:      total number of ECC bytes per page
 445  * @prepad:     padding information for syndrome based ECC generators
 446  * @postpad:    padding information for syndrome based ECC generators
 447  * @layout:     ECC layout control struct pointer
 448  * @priv:       pointer to private ECC control data
 449  * @hwctl:      function to control hardware ECC generator. Must only
 450  *              be provided if an hardware ECC is available
 451  * @calculate:  function for ECC calculation or readback from ECC hardware
 452  * @correct:    function for ECC correction, matching to ECC generator (sw/hw)
 453  * @read_page_raw:      function to read a raw page without ECC
 454  * @write_page_raw:     function to write a raw page without ECC
 455  * @read_page:  function to read a page according to the ECC generator
 456  *              requirements; returns maximum number of bitflips corrected in
 457  *              any single ECC step, 0 if bitflips uncorrectable, -EIO hw error
 458  * @read_subpage:       function to read parts of the page covered by ECC;
 459  *                      returns same as read_page()
 460  * @write_subpage:      function to write parts of the page covered by ECC.
 461  * @write_page: function to write a page according to the ECC generator
 462  *              requirements.
 463  * @write_oob_raw:      function to write chip OOB data without ECC
 464  * @read_oob_raw:       function to read chip OOB data without ECC
 465  * @read_oob:   function to read chip OOB data
 466  * @write_oob:  function to write chip OOB data
 467  */
 468 struct nand_ecc_ctrl {
 469         nand_ecc_modes_t mode;
 470         int steps;
 471         int size;
 472         int bytes;
 473         int total;
 474         int strength;
 475         int prepad;
 476         int postpad;
 477         struct nand_ecclayout   *layout;
 478         void *priv;
 479         void (*hwctl)(struct mtd_info *mtd, int mode);
 480         int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
 481                         uint8_t *ecc_code);
 482         int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
 483                         uint8_t *calc_ecc);
 484         int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 485                         uint8_t *buf, int oob_required, int page);
 486         int (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 487                         const uint8_t *buf, int oob_required);
 488         int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
 489                         uint8_t *buf, int oob_required, int page);
 490         int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 491                         uint32_t offs, uint32_t len, uint8_t *buf, int page);
 492         int (*write_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
 493                         uint32_t offset, uint32_t data_len,
 494                         const uint8_t *data_buf, int oob_required);
 495         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 496                         const uint8_t *buf, int oob_required);
 497         int (*write_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 498                         int page);
 499         int (*read_oob_raw)(struct mtd_info *mtd, struct nand_chip *chip,
 500                         int page);
 501         int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page);
 502         int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
 503                         int page);
 504 };
 505
 506 /**
 507  * struct nand_buffers - buffer structure for read/write
 508  * @ecccalc:    buffer pointer for calculated ECC, size is oobsize.
 509  * @ecccode:    buffer pointer for ECC read from flash, size is oobsize.
 510  * @databuf:    buffer pointer for data, size is (page size + oobsize).
 511  *
 512  * Do not change the order of buffers. databuf and oobrbuf must be in
 513  * consecutive order.
 514  */
 515 struct nand_buffers {
 516         uint8_t *ecccalc;
 517         uint8_t *ecccode;
 518         uint8_t *databuf;
 519 };
 520
 521 /**
 522  * struct nand_chip - NAND Private Flash Chip Data
 523  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the
 524  *                      flash device
 525  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the
 526  *                      flash device.
 527  * @read_byte:          [REPLACEABLE] read one byte from the chip
 528  * @read_word:          [REPLACEABLE] read one word from the chip
 529  * @write_byte:         [REPLACEABLE] write a single byte to the chip on the
 530  *                      low 8 I/O lines
 531  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
 532  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
 533  * @select_chip:        [REPLACEABLE] select chip nr
 534  * @block_bad:          [REPLACEABLE] check if a block is bad, using OOB markers
 535  * @block_markbad:      [REPLACEABLE] mark a block bad
 536  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific function for controlling
 537  *                      ALE/CLE/nCE. Also used to write command and address
 538  * @init_size:          [BOARDSPECIFIC] hardwarespecific function for setting
 539  *                      mtd->oobsize, mtd->writesize and so on.
 540  *                      @id_data contains the 8 bytes values of NAND_CMD_READID.
 541  *                      Return with the bus width.
 542  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accessing
 543  *                      device ready/busy line. If set to NULL no access to
 544  *                      ready/busy is available and the ready/busy information
 545  *                      is read from the chip status register.
 546  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing
 547  *                      commands to the chip.
 548  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on
 549  *                      ready.
 550  * @setup_read_retry:   [FLASHSPECIFIC] flash (vendor) specific function for
 551  *                      setting the read-retry mode. Mostly needed for MLC NAND.
 552  * @ecc:                [BOARDSPECIFIC] ECC control structure
 553  * @buffers:            buffer structure for read/write
 554  * @hwcontrol:          platform-specific hardware control structure
 555  * @erase_cmd:          [INTERN] erase command write function, selectable due
 556  *                      to AND support.
 557  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
 558  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transferring
 559  *                      data from array to read regs (tR).
 560  * @state:              [INTERN] the current state of the NAND device
 561  * @oob_poi:            "poison value buffer," used for laying out OOB data
 562  *                      before writing
 563  * @page_shift:         [INTERN] number of address bits in a page (column
 564  *                      address bits).
 565  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
 566  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
 567  * @chip_shift:         [INTERN] number of address bits in one chip
 568  * @options:            [BOARDSPECIFIC] various chip options. They can partly
 569  *                      be set to inform nand_scan about special functionality.
 570  *                      See the defines for further explanation.
 571  * @bbt_options:        [INTERN] bad block specific options. All options used
 572  *                      here must come from bbm.h. By default, these options
 573  *                      will be copied to the appropriate nand_bbt_descr's.
 574  * @badblockpos:        [INTERN] position of the bad block marker in the oob
 575  *                      area.
 576  * @badblockbits:       [INTERN] minimum number of set bits in a good block's
 577  *                      bad block marker position; i.e., BBM == 11110111b is
 578  *                      not bad when badblockbits == 7
 579  * @bits_per_cell:      [INTERN] number of bits per cell. i.e., 1 means SLC.
 580  * @ecc_strength_ds:    [INTERN] ECC correctability from the datasheet.
 581  *                      Minimum amount of bit errors per @ecc_step_ds guaranteed
 582  *                      to be correctable. If unknown, set to zero.
 583  * @ecc_step_ds:        [INTERN] ECC step required by the @ecc_strength_ds,
 584  *                      also from the datasheet. It is the recommended ECC step
 585  *                      size, if known; if unknown, set to zero.
 586  * @numchips:           [INTERN] number of physical chips
 587  * @chipsize:           [INTERN] the size of one chip for multichip arrays
 588  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
 589  * @pagebuf:            [INTERN] holds the pagenumber which is currently in
 590  *                      data_buf.
 591  * @pagebuf_bitflips:   [INTERN] holds the bitflip count for the page which is
 592  *                      currently in data_buf.
 593  * @subpagesize:        [INTERN] holds the subpagesize
 594  * @onfi_version:       [INTERN] holds the chip ONFI version (BCD encoded),
 595  *                      non 0 if ONFI supported.
 596  * @jedec_version:      [INTERN] holds the chip JEDEC version (BCD encoded),
 597  *                      non 0 if JEDEC supported.
 598  * @onfi_params:        [INTERN] holds the ONFI page parameter when ONFI is
 599  *                      supported, 0 otherwise.
 600  * @jedec_params:       [INTERN] holds the JEDEC parameter page when JEDEC is
 601  *                      supported, 0 otherwise.
 602  * @read_retries:       [INTERN] the number of read retry modes supported
 603  * @onfi_set_features:  [REPLACEABLE] set the features for ONFI nand
 604  * @onfi_get_features:  [REPLACEABLE] get the features for ONFI nand
 605  * @bbt:                [INTERN] bad block table pointer
 606  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash
 607  *                      lookup.
 608  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
 609  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial
 610  *                      bad block scan.
 611  * @controller:         [REPLACEABLE] a pointer to a hardware controller
 612  *                      structure which is shared among multiple independent
 613  *                      devices.
 614  * @priv:               [OPTIONAL] pointer to private chip data
 615  * @errstat:            [OPTIONAL] hardware specific function to perform
 616  *                      additional error status checks (determine if errors are
 617  *                      correctable).
 618  * @write_page:         [REPLACEABLE] High-level page write function
 619  */
 620
 621 struct nand_chip {
 622         void __iomem *IO_ADDR_R;
 623         void __iomem *IO_ADDR_W;
 624
 625         uint8_t (*read_byte)(struct mtd_info *mtd);
 626         u16 (*read_word)(struct mtd_info *mtd);
 627         void (*write_byte)(struct mtd_info *mtd, uint8_t byte);
 628         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 629         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 630         void (*select_chip)(struct mtd_info *mtd, int chip);
 631         int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
 632         int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
 633         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 634         int (*init_size)(struct mtd_info *mtd, struct nand_chip *this,
 635                         u8 *id_data);
 636         int (*dev_ready)(struct mtd_info *mtd);
 637         void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
 638                         int page_addr);
 639         int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
 640         void (*erase_cmd)(struct mtd_info *mtd, int page);
 641         int (*scan_bbt)(struct mtd_info *mtd);
 642         int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
 643                         int status, int page);
 644         int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
 645                         uint32_t offset, int data_len, const uint8_t *buf,
 646                         int oob_required, int page, int cached, int raw);
 647         int (*onfi_set_features)(struct mtd_info *mtd, struct nand_chip *chip,
 648                         int feature_addr, uint8_t *subfeature_para);
 649         int (*onfi_get_features)(struct mtd_info *mtd, struct nand_chip *chip,
 650                         int feature_addr, uint8_t *subfeature_para);
 651         int (*setup_read_retry)(struct mtd_info *mtd, int retry_mode);
 652
 653         int chip_delay;
 654         unsigned int options;
 655         unsigned int bbt_options;
 656
 657         int page_shift;
 658         int phys_erase_shift;
 659         int bbt_erase_shift;
 660         int chip_shift;
 661         int numchips;
 662         uint64_t chipsize;
 663         int pagemask;
 664         int pagebuf;
 665         unsigned int pagebuf_bitflips;
 666         int subpagesize;
 667         uint8_t bits_per_cell;
 668         uint16_t ecc_strength_ds;
 669         uint16_t ecc_step_ds;
 670         int badblockpos;
 671         int badblockbits;
 672
 673         int onfi_version;
 674         int jedec_version;
 675         union {
 676                 struct nand_onfi_params onfi_params;
 677                 struct nand_jedec_params jedec_params;
 678         };
 679
 680         int read_retries;
 681
 682         flstate_t state;
 683
 684         uint8_t *oob_poi;
 685         struct nand_hw_control *controller;
 686
 687         struct nand_ecc_ctrl ecc;
 688         struct nand_buffers *buffers;
 689         struct nand_hw_control hwcontrol;
 690
 691         uint8_t *bbt;
 692         struct nand_bbt_descr *bbt_td;
 693         struct nand_bbt_descr *bbt_md;
 694
 695         struct nand_bbt_descr *badblock_pattern;
 696
 697         void *priv;
 698 };
 699
 700 /*
 701  * NAND Flash Manufacturer ID Codes
 702  */
 703 #define NAND_MFR_TOSHIBA        0x98
 704 #define NAND_MFR_SAMSUNG        0xec
 705 #define NAND_MFR_FUJITSU        0x04
 706 #define NAND_MFR_NATIONAL       0x8f
 707 #define NAND_MFR_RENESAS        0x07
 708 #define NAND_MFR_STMICRO        0x20
 709 #define NAND_MFR_HYNIX          0xad
 710 #define NAND_MFR_MICRON         0x2c
 711 #define NAND_MFR_AMD            0x01
 712 #define NAND_MFR_MACRONIX       0xc2
 713 #define NAND_MFR_EON            0x92
 714 #define NAND_MFR_SANDISK        0x45
 715 #define NAND_MFR_INTEL          0x89
 716
 717 /* The maximum expected count of bytes in the NAND ID sequence */
 718 #define NAND_MAX_ID_LEN 8
 719
 720 /*
 721  * A helper for defining older NAND chips where the second ID byte fully
 722  * defined the chip, including the geometry (chip size, eraseblock size, page
 723  * size). All these chips have 512 bytes NAND page size.
 724  */
 725 #define LEGACY_ID_NAND(nm, devid, chipsz, erasesz, opts)          \
 726         { .name = (nm), {{ .dev_id = (devid) }}, .pagesize = 512, \
 727           .chipsize = (chipsz), .erasesize = (erasesz), .options = (opts) }
 728
 729 /*
 730  * A helper for defining newer chips which report their page size and
 731  * eraseblock size via the extended ID bytes.
 732  *
 733  * The real difference between LEGACY_ID_NAND and EXTENDED_ID_NAND is that with
 734  * EXTENDED_ID_NAND, manufacturers overloaded the same device ID so that the
 735  * device ID now only represented a particular total chip size (and voltage,
 736  * buswidth), and the page size, eraseblock size, and OOB size could vary while
 737  * using the same device ID.
 738  */
 739 #define EXTENDED_ID_NAND(nm, devid, chipsz, opts)                      \
 740         { .name = (nm), {{ .dev_id = (devid) }}, .chipsize = (chipsz), \
 741           .options = (opts) }
 742
 743 #define NAND_ECC_INFO(_strength, _step) \
 744                         { .strength_ds = (_strength), .step_ds = (_step) }
 745 #define NAND_ECC_STRENGTH(type)         ((type)->ecc.strength_ds)
 746 #define NAND_ECC_STEP(type)             ((type)->ecc.step_ds)
 747
 748 /**
 749  * struct nand_flash_dev - NAND Flash Device ID Structure
 750  * @name: a human-readable name of the NAND chip
 751  * @dev_id: the device ID (the second byte of the full chip ID array)
 752  * @mfr_id: manufecturer ID part of the full chip ID array (refers the same
 753  *          memory address as @id[0])
 754  * @dev_id: device ID part of the full chip ID array (refers the same memory
 755  *          address as @id[1])
 756  * @id: full device ID array
 757  * @pagesize: size of the NAND page in bytes; if 0, then the real page size (as
 758  *            well as the eraseblock size) is determined from the extended NAND
 759  *            chip ID array)
 760  * @chipsize: total chip size in MiB
 761  * @erasesize: eraseblock size in bytes (determined from the extended ID if 0)
 762  * @options: stores various chip bit options
 763  * @id_len: The valid length of the @id.
 764  * @oobsize: OOB size
 765  * @ecc.strength_ds: The ECC correctability from the datasheet, same as the
 766  *                   @ecc_strength_ds in nand_chip{}.
 767  * @ecc.step_ds: The ECC step required by the @ecc.strength_ds, same as the
 768  *               @ecc_step_ds in nand_chip{}, also from the datasheet.
 769  *               For example, the "4bit ECC for each 512Byte" can be set with
 770  *               NAND_ECC_INFO(4, 512).
 771  */
 772 struct nand_flash_dev {
 773         char *name;
 774         union {
 775                 struct {
 776                         uint8_t mfr_id;
 777                         uint8_t dev_id;
 778                 };
 779                 uint8_t id[NAND_MAX_ID_LEN];
 780         };
 781         unsigned int pagesize;
 782         unsigned int chipsize;
 783         unsigned int erasesize;
 784         unsigned int options;
 785         uint16_t id_len;
 786         uint16_t oobsize;
 787         struct {
 788                 uint16_t strength_ds;
 789                 uint16_t step_ds;
 790         } ecc;
 791 };
 792
 793 /**
 794  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
 795  * @name:       Manufacturer name
 796  * @id:         manufacturer ID code of device.
 797 */
 798 struct nand_manufacturers {
 799         int id;
 800         char *name;
 801 };
 802
 803 extern struct nand_flash_dev nand_flash_ids[];
 804 extern struct nand_manufacturers nand_manuf_ids[];
 805
 806 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
 807 extern int nand_default_bbt(struct mtd_info *mtd);
 808 extern int nand_markbad_bbt(struct mtd_info *mtd, loff_t offs);
 809 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
 810 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
 811                            int allowbbt);
 812 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
 813                         size_t *retlen, uint8_t *buf);
 814
 815 /**
 816  * struct platform_nand_chip - chip level device structure
 817  * @nr_chips:           max. number of chips to scan for
 818  * @chip_offset:        chip number offset
 819  * @nr_partitions:      number of partitions pointed to by partitions (or zero)
 820  * @partitions:         mtd partition list
 821  * @chip_delay:         R/B delay value in us
 822  * @options:            Option flags, e.g. 16bit buswidth
 823  * @bbt_options:        BBT option flags, e.g. NAND_BBT_USE_FLASH
 824  * @ecclayout:          ECC layout info structure
 825  * @part_probe_types:   NULL-terminated array of probe types
 826  */
 827 struct platform_nand_chip {
 828         int nr_chips;
 829         int chip_offset;
 830         int nr_partitions;
 831         struct mtd_partition *partitions;
 832         struct nand_ecclayout *ecclayout;
 833         int chip_delay;
 834         unsigned int options;
 835         unsigned int bbt_options;
 836         const char **part_probe_types;
 837 };
 838
 839 /* Keep gcc happy */
 840 struct platform_device;
 841
 842 /**
 843  * struct platform_nand_ctrl - controller level device structure
 844  * @probe:              platform specific function to probe/setup hardware
 845  * @remove:             platform specific function to remove/teardown hardware
 846  * @hwcontrol:          platform specific hardware control structure
 847  * @dev_ready:          platform specific function to read ready/busy pin
 848  * @select_chip:        platform specific chip select function
 849  * @cmd_ctrl:           platform specific function for controlling
 850  *                      ALE/CLE/nCE. Also used to write command and address
 851  * @write_buf:          platform specific function for write buffer
 852  * @read_buf:           platform specific function for read buffer
 853  * @read_byte:          platform specific function to read one byte from chip
 854  * @priv:               private data to transport driver specific settings
 855  *
 856  * All fields are optional and depend on the hardware driver requirements
 857  */
 858 struct platform_nand_ctrl {
 859         int (*probe)(struct platform_device *pdev);
 860         void (*remove)(struct platform_device *pdev);
 861         void (*hwcontrol)(struct mtd_info *mtd, int cmd);
 862         int (*dev_ready)(struct mtd_info *mtd);
 863         void (*select_chip)(struct mtd_info *mtd, int chip);
 864         void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
 865         void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
 866         void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
 867         unsigned char (*read_byte)(struct mtd_info *mtd);
 868         void *priv;
 869 };
 870
 871 /**
 872  * struct platform_nand_data - container structure for platform-specific data
 873  * @chip:               chip level chip structure
 874  * @ctrl:               controller level device structure
 875  */
 876 struct platform_nand_data {
 877         struct platform_nand_chip chip;
 878         struct platform_nand_ctrl ctrl;
 879 };
 880
 881 /* Some helpers to access the data structures */
 882 static inline
 883 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
 884 {
 885         struct nand_chip *chip = mtd->priv;
 886
 887         return chip->priv;
 888 }
 889
 890 /* return the supported features. */
 891 static inline int onfi_feature(struct nand_chip *chip)
 892 {
 893         return chip->onfi_version ? le16_to_cpu(chip->onfi_params.features) : 0;
 894 }
 895
 896 /* return the supported asynchronous timing mode. */
 897 static inline int onfi_get_async_timing_mode(struct nand_chip *chip)
 898 {
 899         if (!chip->onfi_version)
 900                 return ONFI_TIMING_MODE_UNKNOWN;
 901         return le16_to_cpu(chip->onfi_params.async_timing_mode);
 902 }
 903
 904 /* return the supported synchronous timing mode. */
 905 static inline int onfi_get_sync_timing_mode(struct nand_chip *chip)
 906 {
 907         if (!chip->onfi_version)
 908                 return ONFI_TIMING_MODE_UNKNOWN;
 909         return le16_to_cpu(chip->onfi_params.src_sync_timing_mode);
 910 }
 911
 912 /*
 913  * Check if it is a SLC nand.
 914  * The !nand_is_slc() can be used to check the MLC/TLC nand chips.
 915  * We do not distinguish the MLC and TLC now.
 916  */
 917 static inline bool nand_is_slc(struct nand_chip *chip)
 918 {
 919         return chip->bits_per_cell == 1;
 920 }
 921
 922 /**
 923  * Check if the opcode's address should be sent only on the lower 8 bits
 924  * @command: opcode to check
 925  */
 926 static inline int nand_opcode_8bits(unsigned int command)
 927 {
 928         switch (command) {
 929         case NAND_CMD_READID:
 930         case NAND_CMD_PARAM:
 931         case NAND_CMD_GET_FEATURES:
 932         case NAND_CMD_SET_FEATURES:
 933                 return 1;
 934         default:
 935                 break;
 936         }
 937         return 0;
 938 }
 939
 940 /* return the supported JEDEC features. */
 941 static inline int jedec_feature(struct nand_chip *chip)
 942 {
 943         return chip->jedec_version ? le16_to_cpu(chip->jedec_params.features)
 944                 : 0;
 945 }
 946 #endif /* __LINUX_MTD_NAND_H */