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