2 * linux/include/linux/mtd/nand.h
4 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org>
5 * Steven J. Hill <sjhill@realitydiluted.com>
6 * Thomas Gleixner <tglx@linutronix.de>
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.
13 * Contains standard defines and IDs for NAND flash devices
18 #ifndef __LINUX_MTD_NAND_H
19 #define __LINUX_MTD_NAND_H
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>
28 struct nand_flash_dev;
29 /* Scan and identify a NAND device */
30 extern int nand_scan(struct mtd_info *mtd, int max_chips);
32 * Separate phases of nand_scan(), allowing board driver to intervene
33 * and override command or ECC setup according to flash type.
35 extern int nand_scan_ident(struct mtd_info *mtd, int max_chips,
36 struct nand_flash_dev *table);
37 extern int nand_scan_tail(struct mtd_info *mtd);
39 /* Free resources held by the NAND device */
40 extern void nand_release(struct mtd_info *mtd);
42 /* Internal helper for board drivers which need to override command function */
43 extern void nand_wait_ready(struct mtd_info *mtd);
45 /* locks all blocks present in the device */
46 extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
48 /* unlocks specified locked blocks */
49 extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
51 /* The maximum number of NAND chips in an array */
52 #define NAND_MAX_CHIPS 8
55 * This constant declares the max. oobsize / page, which
56 * is supported now. If you add a chip with bigger oobsize/page
57 * adjust this accordingly.
59 #define NAND_MAX_OOBSIZE 576
60 #define NAND_MAX_PAGESIZE 8192
63 * Constants for hardware specific CLE/ALE/NCE function
65 * These are bits which can be or'ed to set/clear multiple
68 /* Select the chip by setting nCE to low */
70 /* Select the command latch by setting CLE to high */
72 /* Select the address latch by setting ALE to high */
75 #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
76 #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
77 #define NAND_CTRL_CHANGE 0x80
80 * Standard NAND flash commands
82 #define NAND_CMD_READ0 0
83 #define NAND_CMD_READ1 1
84 #define NAND_CMD_RNDOUT 5
85 #define NAND_CMD_PAGEPROG 0x10
86 #define NAND_CMD_READOOB 0x50
87 #define NAND_CMD_ERASE1 0x60
88 #define NAND_CMD_STATUS 0x70
89 #define NAND_CMD_STATUS_MULTI 0x71
90 #define NAND_CMD_SEQIN 0x80
91 #define NAND_CMD_RNDIN 0x85
92 #define NAND_CMD_READID 0x90
93 #define NAND_CMD_ERASE2 0xd0
94 #define NAND_CMD_PARAM 0xec
95 #define NAND_CMD_RESET 0xff
97 #define NAND_CMD_LOCK 0x2a
98 #define NAND_CMD_UNLOCK1 0x23
99 #define NAND_CMD_UNLOCK2 0x24
101 /* Extended commands for large page devices */
102 #define NAND_CMD_READSTART 0x30
103 #define NAND_CMD_RNDOUTSTART 0xE0
104 #define NAND_CMD_CACHEDPROG 0x15
106 /* Extended commands for AG-AND device */
108 * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
109 * there is no way to distinguish that from NAND_CMD_READ0
110 * until the remaining sequence of commands has been completed
111 * so add a high order bit and mask it off in the command.
113 #define NAND_CMD_DEPLETE1 0x100
114 #define NAND_CMD_DEPLETE2 0x38
115 #define NAND_CMD_STATUS_MULTI 0x71
116 #define NAND_CMD_STATUS_ERROR 0x72
117 /* multi-bank error status (banks 0-3) */
118 #define NAND_CMD_STATUS_ERROR0 0x73
119 #define NAND_CMD_STATUS_ERROR1 0x74
120 #define NAND_CMD_STATUS_ERROR2 0x75
121 #define NAND_CMD_STATUS_ERROR3 0x76
122 #define NAND_CMD_STATUS_RESET 0x7f
123 #define NAND_CMD_STATUS_CLEAR 0xff
125 #define NAND_CMD_NONE -1
128 #define NAND_STATUS_FAIL 0x01
129 #define NAND_STATUS_FAIL_N1 0x02
130 #define NAND_STATUS_TRUE_READY 0x20
131 #define NAND_STATUS_READY 0x40
132 #define NAND_STATUS_WP 0x80
135 * Constants for ECC_MODES
141 NAND_ECC_HW_SYNDROME,
142 NAND_ECC_HW_OOB_FIRST,
147 * Constants for Hardware ECC
149 /* Reset Hardware ECC for read */
150 #define NAND_ECC_READ 0
151 /* Reset Hardware ECC for write */
152 #define NAND_ECC_WRITE 1
153 /* Enable Hardware ECC before syndrome is read back from flash */
154 #define NAND_ECC_READSYN 2
156 /* Bit mask for flags passed to do_nand_read_ecc */
157 #define NAND_GET_DEVICE 0x80
161 * Option constants for bizarre disfunctionality and real
164 /* Chip can not auto increment pages */
165 #define NAND_NO_AUTOINCR 0x00000001
166 /* Buswidth is 16 bit */
167 #define NAND_BUSWIDTH_16 0x00000002
168 /* Device supports partial programming without padding */
169 #define NAND_NO_PADDING 0x00000004
170 /* Chip has cache program function */
171 #define NAND_CACHEPRG 0x00000008
172 /* Chip has copy back function */
173 #define NAND_COPYBACK 0x00000010
175 * AND Chip which has 4 banks and a confusing page / block
176 * assignment. See Renesas datasheet for further information.
178 #define NAND_IS_AND 0x00000020
180 * Chip has a array of 4 pages which can be read without
181 * additional ready /busy waits.
183 #define NAND_4PAGE_ARRAY 0x00000040
185 * Chip requires that BBT is periodically rewritten to prevent
186 * bits from adjacent blocks from 'leaking' in altering data.
187 * This happens with the Renesas AG-AND chips, possibly others.
189 #define BBT_AUTO_REFRESH 0x00000080
191 * Chip does not require ready check on read. True
192 * for all large page devices, as they do not support
195 #define NAND_NO_READRDY 0x00000100
196 /* Chip does not allow subpage writes */
197 #define NAND_NO_SUBPAGE_WRITE 0x00000200
199 /* Device is one of 'new' xD cards that expose fake nand command set */
200 #define NAND_BROKEN_XD 0x00000400
202 /* Device behaves just like nand, but is readonly */
203 #define NAND_ROM 0x00000800
205 /* Options valid for Samsung large page devices */
206 #define NAND_SAMSUNG_LP_OPTIONS \
207 (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
209 /* Macros to identify the above */
210 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
211 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
212 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
213 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
214 /* Large page NAND with SOFT_ECC should support subpage reads */
215 #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \
216 && (chip->page_shift > 9))
218 /* Mask to zero out the chip options, which come from the id table */
219 #define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR)
221 /* Non chip related options */
222 /* This option skips the bbt scan during initialization. */
223 #define NAND_SKIP_BBTSCAN 0x00010000
225 * This option is defined if the board driver allocates its own buffers
226 * (e.g. because it needs them DMA-coherent).
228 #define NAND_OWN_BUFFERS 0x00020000
229 /* Chip may not exist, so silence any errors in scan */
230 #define NAND_SCAN_SILENT_NODEV 0x00040000
232 /* Options set by nand scan */
233 /* Nand scan has allocated controller struct */
234 #define NAND_CONTROLLER_ALLOC 0x80000000
236 /* Cell info constants */
237 #define NAND_CI_CHIPNR_MSK 0x03
238 #define NAND_CI_CELLTYPE_MSK 0x0C
243 struct nand_onfi_params {
244 /* rev info and features block */
245 /* 'O' 'N' 'F' 'I' */
252 /* manufacturer information block */
253 char manufacturer[12];
259 /* memory organization block */
260 __le32 byte_per_page;
261 __le16 spare_bytes_per_page;
262 __le32 data_bytes_per_ppage;
263 __le16 spare_bytes_per_ppage;
264 __le32 pages_per_block;
265 __le32 blocks_per_lun;
270 __le16 block_endurance;
271 u8 guaranteed_good_blocks;
272 __le16 guaranteed_block_endurance;
273 u8 programs_per_page;
280 /* electrical parameter block */
281 u8 io_pin_capacitance_max;
282 __le16 async_timing_mode;
283 __le16 program_cache_timing_mode;
288 __le16 src_sync_timing_mode;
289 __le16 src_ssync_features;
290 __le16 clk_pin_capacitance_typ;
291 __le16 io_pin_capacitance_typ;
292 __le16 input_pin_capacitance_typ;
293 u8 input_pin_capacitance_max;
294 u8 driver_strenght_support;
303 } __attribute__((packed));
305 #define ONFI_CRC_BASE 0x4F4E
308 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
309 * @lock: protection lock
310 * @active: the mtd device which holds the controller currently
311 * @wq: wait queue to sleep on if a NAND operation is in
312 * progress used instead of the per chip wait queue
313 * when a hw controller is available.
315 struct nand_hw_control {
317 struct nand_chip *active;
318 wait_queue_head_t wq;
322 * struct nand_ecc_ctrl - Control structure for ECC
324 * @steps: number of ECC steps per page
325 * @size: data bytes per ECC step
326 * @bytes: ECC bytes per step
327 * @total: total number of ECC bytes per page
328 * @prepad: padding information for syndrome based ECC generators
329 * @postpad: padding information for syndrome based ECC generators
330 * @layout: ECC layout control struct pointer
331 * @priv: pointer to private ECC control data
332 * @hwctl: function to control hardware ECC generator. Must only
333 * be provided if an hardware ECC is available
334 * @calculate: function for ECC calculation or readback from ECC hardware
335 * @correct: function for ECC correction, matching to ECC generator (sw/hw)
336 * @read_page_raw: function to read a raw page without ECC
337 * @write_page_raw: function to write a raw page without ECC
338 * @read_page: function to read a page according to the ECC generator
340 * @read_subpage: function to read parts of the page covered by ECC.
341 * @write_page: function to write a page according to the ECC generator
343 * @read_oob: function to read chip OOB data
344 * @write_oob: function to write chip OOB data
346 struct nand_ecc_ctrl {
347 nand_ecc_modes_t mode;
354 struct nand_ecclayout *layout;
356 void (*hwctl)(struct mtd_info *mtd, int mode);
357 int (*calculate)(struct mtd_info *mtd, const uint8_t *dat,
359 int (*correct)(struct mtd_info *mtd, uint8_t *dat, uint8_t *read_ecc,
361 int (*read_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
362 uint8_t *buf, int page);
363 void (*write_page_raw)(struct mtd_info *mtd, struct nand_chip *chip,
365 int (*read_page)(struct mtd_info *mtd, struct nand_chip *chip,
366 uint8_t *buf, int page);
367 int (*read_subpage)(struct mtd_info *mtd, struct nand_chip *chip,
368 uint32_t offs, uint32_t len, uint8_t *buf);
369 void (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
371 int (*read_oob)(struct mtd_info *mtd, struct nand_chip *chip, int page,
373 int (*write_oob)(struct mtd_info *mtd, struct nand_chip *chip,
378 * struct nand_buffers - buffer structure for read/write
379 * @ecccalc: buffer for calculated ECC
380 * @ecccode: buffer for ECC read from flash
381 * @databuf: buffer for data - dynamically sized
383 * Do not change the order of buffers. databuf and oobrbuf must be in
386 struct nand_buffers {
387 uint8_t ecccalc[NAND_MAX_OOBSIZE];
388 uint8_t ecccode[NAND_MAX_OOBSIZE];
389 uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
393 * struct nand_chip - NAND Private Flash Chip Data
394 * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the
396 * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the
398 * @read_byte: [REPLACEABLE] read one byte from the chip
399 * @read_word: [REPLACEABLE] read one word from the chip
400 * @write_buf: [REPLACEABLE] write data from the buffer to the chip
401 * @read_buf: [REPLACEABLE] read data from the chip into the buffer
402 * @verify_buf: [REPLACEABLE] verify buffer contents against the chip
404 * @select_chip: [REPLACEABLE] select chip nr
405 * @block_bad: [REPLACEABLE] check, if the block is bad
406 * @block_markbad: [REPLACEABLE] mark the block bad
407 * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific function for controlling
408 * ALE/CLE/nCE. Also used to write command and address
409 * @init_size: [BOARDSPECIFIC] hardwarespecific function for setting
410 * mtd->oobsize, mtd->writesize and so on.
411 * @id_data contains the 8 bytes values of NAND_CMD_READID.
412 * Return with the bus width.
413 * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accessing
414 * device ready/busy line. If set to NULL no access to
415 * ready/busy is available and the ready/busy information
416 * is read from the chip status register.
417 * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing
418 * commands to the chip.
419 * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on
421 * @ecc: [BOARDSPECIFIC] ECC control structure
422 * @buffers: buffer structure for read/write
423 * @hwcontrol: platform-specific hardware control structure
424 * @ops: oob operation operands
425 * @erase_cmd: [INTERN] erase command write function, selectable due
427 * @scan_bbt: [REPLACEABLE] function to scan bad block table
428 * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transferring
429 * data from array to read regs (tR).
430 * @state: [INTERN] the current state of the NAND device
431 * @oob_poi: poison value buffer
432 * @page_shift: [INTERN] number of address bits in a page (column
434 * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock
435 * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
436 * @chip_shift: [INTERN] number of address bits in one chip
437 * @options: [BOARDSPECIFIC] various chip options. They can partly
438 * be set to inform nand_scan about special functionality.
439 * See the defines for further explanation.
440 * @bbt_options: [INTERN] bad block specific options. All options used
441 * here must come from bbm.h. By default, these options
442 * will be copied to the appropriate nand_bbt_descr's.
443 * @badblockpos: [INTERN] position of the bad block marker in the oob
445 * @badblockbits: [INTERN] number of bits to left-shift the bad block
447 * @cellinfo: [INTERN] MLC/multichip data from chip ident
448 * @numchips: [INTERN] number of physical chips
449 * @chipsize: [INTERN] the size of one chip for multichip arrays
450 * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1
451 * @pagebuf: [INTERN] holds the pagenumber which is currently in
453 * @subpagesize: [INTERN] holds the subpagesize
454 * @onfi_version: [INTERN] holds the chip ONFI version (BCD encoded),
455 * non 0 if ONFI supported.
456 * @onfi_params: [INTERN] holds the ONFI page parameter when ONFI is
457 * supported, 0 otherwise.
458 * @ecclayout: [REPLACEABLE] the default ECC placement scheme
459 * @bbt: [INTERN] bad block table pointer
460 * @bbt_td: [REPLACEABLE] bad block table descriptor for flash
462 * @bbt_md: [REPLACEABLE] bad block table mirror descriptor
463 * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial
465 * @controller: [REPLACEABLE] a pointer to a hardware controller
466 * structure which is shared among multiple independent
468 * @priv: [OPTIONAL] pointer to private chip data
469 * @errstat: [OPTIONAL] hardware specific function to perform
470 * additional error status checks (determine if errors are
472 * @write_page: [REPLACEABLE] High-level page write function
476 void __iomem *IO_ADDR_R;
477 void __iomem *IO_ADDR_W;
479 uint8_t (*read_byte)(struct mtd_info *mtd);
480 u16 (*read_word)(struct mtd_info *mtd);
481 void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
482 void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
483 int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
484 void (*select_chip)(struct mtd_info *mtd, int chip);
485 int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
486 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
487 void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
488 int (*init_size)(struct mtd_info *mtd, struct nand_chip *this,
490 int (*dev_ready)(struct mtd_info *mtd);
491 void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column,
493 int(*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
494 void (*erase_cmd)(struct mtd_info *mtd, int page);
495 int (*scan_bbt)(struct mtd_info *mtd);
496 int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state,
497 int status, int page);
498 int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
499 const uint8_t *buf, int page, int cached, int raw);
502 unsigned int options;
503 unsigned int bbt_options;
506 int phys_erase_shift;
519 struct nand_onfi_params onfi_params;
524 struct nand_hw_control *controller;
525 struct nand_ecclayout *ecclayout;
527 struct nand_ecc_ctrl ecc;
528 struct nand_buffers *buffers;
529 struct nand_hw_control hwcontrol;
531 struct mtd_oob_ops ops;
534 struct nand_bbt_descr *bbt_td;
535 struct nand_bbt_descr *bbt_md;
537 struct nand_bbt_descr *badblock_pattern;
543 * NAND Flash Manufacturer ID Codes
545 #define NAND_MFR_TOSHIBA 0x98
546 #define NAND_MFR_SAMSUNG 0xec
547 #define NAND_MFR_FUJITSU 0x04
548 #define NAND_MFR_NATIONAL 0x8f
549 #define NAND_MFR_RENESAS 0x07
550 #define NAND_MFR_STMICRO 0x20
551 #define NAND_MFR_HYNIX 0xad
552 #define NAND_MFR_MICRON 0x2c
553 #define NAND_MFR_AMD 0x01
556 * struct nand_flash_dev - NAND Flash Device ID Structure
557 * @name: Identify the device type
558 * @id: device ID code
559 * @pagesize: Pagesize in bytes. Either 256 or 512 or 0
560 * If the pagesize is 0, then the real pagesize
561 * and the eraseize are determined from the
562 * extended id bytes in the chip
563 * @erasesize: Size of an erase block in the flash device.
564 * @chipsize: Total chipsize in Mega Bytes
565 * @options: Bitfield to store chip relevant options
567 struct nand_flash_dev {
570 unsigned long pagesize;
571 unsigned long chipsize;
572 unsigned long erasesize;
573 unsigned long options;
577 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
578 * @name: Manufacturer name
579 * @id: manufacturer ID code of device.
581 struct nand_manufacturers {
586 extern struct nand_flash_dev nand_flash_ids[];
587 extern struct nand_manufacturers nand_manuf_ids[];
589 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
590 extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
591 extern int nand_default_bbt(struct mtd_info *mtd);
592 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
593 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
595 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
596 size_t *retlen, uint8_t *buf);
599 * struct platform_nand_chip - chip level device structure
600 * @nr_chips: max. number of chips to scan for
601 * @chip_offset: chip number offset
602 * @nr_partitions: number of partitions pointed to by partitions (or zero)
603 * @partitions: mtd partition list
604 * @chip_delay: R/B delay value in us
605 * @options: Option flags, e.g. 16bit buswidth
606 * @bbt_options: BBT option flags, e.g. NAND_BBT_USE_FLASH
607 * @ecclayout: ECC layout info structure
608 * @part_probe_types: NULL-terminated array of probe types
610 struct platform_nand_chip {
614 struct mtd_partition *partitions;
615 struct nand_ecclayout *ecclayout;
617 unsigned int options;
618 unsigned int bbt_options;
619 const char **part_probe_types;
623 struct platform_device;
626 * struct platform_nand_ctrl - controller level device structure
627 * @probe: platform specific function to probe/setup hardware
628 * @remove: platform specific function to remove/teardown hardware
629 * @hwcontrol: platform specific hardware control structure
630 * @dev_ready: platform specific function to read ready/busy pin
631 * @select_chip: platform specific chip select function
632 * @cmd_ctrl: platform specific function for controlling
633 * ALE/CLE/nCE. Also used to write command and address
634 * @write_buf: platform specific function for write buffer
635 * @read_buf: platform specific function for read buffer
636 * @priv: private data to transport driver specific settings
638 * All fields are optional and depend on the hardware driver requirements
640 struct platform_nand_ctrl {
641 int (*probe)(struct platform_device *pdev);
642 void (*remove)(struct platform_device *pdev);
643 void (*hwcontrol)(struct mtd_info *mtd, int cmd);
644 int (*dev_ready)(struct mtd_info *mtd);
645 void (*select_chip)(struct mtd_info *mtd, int chip);
646 void (*cmd_ctrl)(struct mtd_info *mtd, int dat, unsigned int ctrl);
647 void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
648 void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
653 * struct platform_nand_data - container structure for platform-specific data
654 * @chip: chip level chip structure
655 * @ctrl: controller level device structure
657 struct platform_nand_data {
658 struct platform_nand_chip chip;
659 struct platform_nand_ctrl ctrl;
662 /* Some helpers to access the data structures */
664 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
666 struct nand_chip *chip = mtd->priv;
671 #endif /* __LINUX_MTD_NAND_H */