include/linux/mtd/rawnand.h

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