2 * linux/include/linux/mtd/nand.h
4 * Copyright (c) 2000 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>
26 /* Scan and identify a NAND device */
27 extern int nand_scan (struct mtd_info *mtd, int max_chips);
28 /* Separate phases of nand_scan(), allowing board driver to intervene
29 * and override command or ECC setup according to flash type */
30 extern int nand_scan_ident(struct mtd_info *mtd, int max_chips);
31 extern int nand_scan_tail(struct mtd_info *mtd);
33 /* Free resources held by the NAND device */
34 extern void nand_release (struct mtd_info *mtd);
36 /* Internal helper for board drivers which need to override command function */
37 extern void nand_wait_ready(struct mtd_info *mtd);
39 /* The maximum number of NAND chips in an array */
40 #define NAND_MAX_CHIPS 8
42 /* This constant declares the max. oobsize / page, which
43 * is supported now. If you add a chip with bigger oobsize/page
44 * adjust this accordingly.
46 #define NAND_MAX_OOBSIZE 64
47 #define NAND_MAX_PAGESIZE 2048
50 * Constants for hardware specific CLE/ALE/NCE function
52 * These are bits which can be or'ed to set/clear multiple
55 /* Select the chip by setting nCE to low */
57 /* Select the command latch by setting CLE to high */
59 /* Select the address latch by setting ALE to high */
62 #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE)
63 #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE)
64 #define NAND_CTRL_CHANGE 0x80
67 * Standard NAND flash commands
69 #define NAND_CMD_READ0 0
70 #define NAND_CMD_READ1 1
71 #define NAND_CMD_RNDOUT 5
72 #define NAND_CMD_PAGEPROG 0x10
73 #define NAND_CMD_READOOB 0x50
74 #define NAND_CMD_ERASE1 0x60
75 #define NAND_CMD_STATUS 0x70
76 #define NAND_CMD_STATUS_MULTI 0x71
77 #define NAND_CMD_SEQIN 0x80
78 #define NAND_CMD_RNDIN 0x85
79 #define NAND_CMD_READID 0x90
80 #define NAND_CMD_ERASE2 0xd0
81 #define NAND_CMD_RESET 0xff
83 /* Extended commands for large page devices */
84 #define NAND_CMD_READSTART 0x30
85 #define NAND_CMD_RNDOUTSTART 0xE0
86 #define NAND_CMD_CACHEDPROG 0x15
88 /* Extended commands for AG-AND device */
90 * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
91 * there is no way to distinguish that from NAND_CMD_READ0
92 * until the remaining sequence of commands has been completed
93 * so add a high order bit and mask it off in the command.
95 #define NAND_CMD_DEPLETE1 0x100
96 #define NAND_CMD_DEPLETE2 0x38
97 #define NAND_CMD_STATUS_MULTI 0x71
98 #define NAND_CMD_STATUS_ERROR 0x72
99 /* multi-bank error status (banks 0-3) */
100 #define NAND_CMD_STATUS_ERROR0 0x73
101 #define NAND_CMD_STATUS_ERROR1 0x74
102 #define NAND_CMD_STATUS_ERROR2 0x75
103 #define NAND_CMD_STATUS_ERROR3 0x76
104 #define NAND_CMD_STATUS_RESET 0x7f
105 #define NAND_CMD_STATUS_CLEAR 0xff
107 #define NAND_CMD_NONE -1
110 #define NAND_STATUS_FAIL 0x01
111 #define NAND_STATUS_FAIL_N1 0x02
112 #define NAND_STATUS_TRUE_READY 0x20
113 #define NAND_STATUS_READY 0x40
114 #define NAND_STATUS_WP 0x80
117 * Constants for ECC_MODES
123 NAND_ECC_HW_SYNDROME,
127 * Constants for Hardware ECC
129 /* Reset Hardware ECC for read */
130 #define NAND_ECC_READ 0
131 /* Reset Hardware ECC for write */
132 #define NAND_ECC_WRITE 1
133 /* Enable Hardware ECC before syndrom is read back from flash */
134 #define NAND_ECC_READSYN 2
136 /* Bit mask for flags passed to do_nand_read_ecc */
137 #define NAND_GET_DEVICE 0x80
140 /* Option constants for bizarre disfunctionality and real
143 /* Chip can not auto increment pages */
144 #define NAND_NO_AUTOINCR 0x00000001
145 /* Buswitdh is 16 bit */
146 #define NAND_BUSWIDTH_16 0x00000002
147 /* Device supports partial programming without padding */
148 #define NAND_NO_PADDING 0x00000004
149 /* Chip has cache program function */
150 #define NAND_CACHEPRG 0x00000008
151 /* Chip has copy back function */
152 #define NAND_COPYBACK 0x00000010
153 /* AND Chip which has 4 banks and a confusing page / block
154 * assignment. See Renesas datasheet for further information */
155 #define NAND_IS_AND 0x00000020
156 /* Chip has a array of 4 pages which can be read without
157 * additional ready /busy waits */
158 #define NAND_4PAGE_ARRAY 0x00000040
159 /* Chip requires that BBT is periodically rewritten to prevent
160 * bits from adjacent blocks from 'leaking' in altering data.
161 * This happens with the Renesas AG-AND chips, possibly others. */
162 #define BBT_AUTO_REFRESH 0x00000080
163 /* Chip does not require ready check on read. True
164 * for all large page devices, as they do not support
166 #define NAND_NO_READRDY 0x00000100
167 /* Chip does not allow subpage writes */
168 #define NAND_NO_SUBPAGE_WRITE 0x00000200
171 /* Options valid for Samsung large page devices */
172 #define NAND_SAMSUNG_LP_OPTIONS \
173 (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
175 /* Macros to identify the above */
176 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
177 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
178 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
179 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
181 /* Mask to zero out the chip options, which come from the id table */
182 #define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR)
184 /* Non chip related options */
185 /* Use a flash based bad block table. This option is passed to the
186 * default bad block table function. */
187 #define NAND_USE_FLASH_BBT 0x00010000
188 /* This option skips the bbt scan during initialization. */
189 #define NAND_SKIP_BBTSCAN 0x00020000
190 /* This option is defined if the board driver allocates its own buffers
191 (e.g. because it needs them DMA-coherent */
192 #define NAND_OWN_BUFFERS 0x00040000
193 /* Options set by nand scan */
194 /* Nand scan has allocated controller struct */
195 #define NAND_CONTROLLER_ALLOC 0x80000000
197 /* Cell info constants */
198 #define NAND_CI_CHIPNR_MSK 0x03
199 #define NAND_CI_CELLTYPE_MSK 0x0C
202 * nand_state_t - chip states
203 * Enumeration for NAND flash chip state
219 * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices
220 * @lock: protection lock
221 * @active: the mtd device which holds the controller currently
222 * @wq: wait queue to sleep on if a NAND operation is in progress
223 * used instead of the per chip wait queue when a hw controller is available
225 struct nand_hw_control {
227 struct nand_chip *active;
228 wait_queue_head_t wq;
232 * struct nand_ecc_ctrl - Control structure for ecc
234 * @steps: number of ecc steps per page
235 * @size: data bytes per ecc step
236 * @bytes: ecc bytes per step
237 * @total: total number of ecc bytes per page
238 * @prepad: padding information for syndrome based ecc generators
239 * @postpad: padding information for syndrome based ecc generators
240 * @layout: ECC layout control struct pointer
241 * @hwctl: function to control hardware ecc generator. Must only
242 * be provided if an hardware ECC is available
243 * @calculate: function for ecc calculation or readback from ecc hardware
244 * @correct: function for ecc correction, matching to ecc generator (sw/hw)
245 * @read_page_raw: function to read a raw page without ECC
246 * @write_page_raw: function to write a raw page without ECC
247 * @read_page: function to read a page according to the ecc generator requirements
248 * @write_page: function to write a page according to the ecc generator requirements
249 * @read_oob: function to read chip OOB data
250 * @write_oob: function to write chip OOB data
252 struct nand_ecc_ctrl {
253 nand_ecc_modes_t mode;
260 struct nand_ecclayout *layout;
261 void (*hwctl)(struct mtd_info *mtd, int mode);
262 int (*calculate)(struct mtd_info *mtd,
265 int (*correct)(struct mtd_info *mtd, uint8_t *dat,
268 int (*read_page_raw)(struct mtd_info *mtd,
269 struct nand_chip *chip,
271 void (*write_page_raw)(struct mtd_info *mtd,
272 struct nand_chip *chip,
274 int (*read_page)(struct mtd_info *mtd,
275 struct nand_chip *chip,
277 void (*write_page)(struct mtd_info *mtd,
278 struct nand_chip *chip,
280 int (*read_oob)(struct mtd_info *mtd,
281 struct nand_chip *chip,
284 int (*write_oob)(struct mtd_info *mtd,
285 struct nand_chip *chip,
290 * struct nand_buffers - buffer structure for read/write
291 * @ecccalc: buffer for calculated ecc
292 * @ecccode: buffer for ecc read from flash
293 * @databuf: buffer for data - dynamically sized
295 * Do not change the order of buffers. databuf and oobrbuf must be in
298 struct nand_buffers {
299 uint8_t ecccalc[NAND_MAX_OOBSIZE];
300 uint8_t ecccode[NAND_MAX_OOBSIZE];
301 uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE];
305 * struct nand_chip - NAND Private Flash Chip Data
306 * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
307 * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
308 * @read_byte: [REPLACEABLE] read one byte from the chip
309 * @read_word: [REPLACEABLE] read one word from the chip
310 * @write_buf: [REPLACEABLE] write data from the buffer to the chip
311 * @read_buf: [REPLACEABLE] read data from the chip into the buffer
312 * @verify_buf: [REPLACEABLE] verify buffer contents against the chip data
313 * @select_chip: [REPLACEABLE] select chip nr
314 * @block_bad: [REPLACEABLE] check, if the block is bad
315 * @block_markbad: [REPLACEABLE] mark the block bad
316 * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific funtion for controlling
317 * ALE/CLE/nCE. Also used to write command and address
318 * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
319 * If set to NULL no access to ready/busy is available and the ready/busy information
320 * is read from the chip status register
321 * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing commands to the chip
322 * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on ready
323 * @ecc: [BOARDSPECIFIC] ecc control ctructure
324 * @buffers: buffer structure for read/write
325 * @hwcontrol: platform-specific hardware control structure
326 * @ops: oob operation operands
327 * @erase_cmd: [INTERN] erase command write function, selectable due to AND support
328 * @scan_bbt: [REPLACEABLE] function to scan bad block table
329 * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
330 * @wq: [INTERN] wait queue to sleep on if a NAND operation is in progress
331 * @state: [INTERN] the current state of the NAND device
332 * @oob_poi: poison value buffer
333 * @page_shift: [INTERN] number of address bits in a page (column address bits)
334 * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock
335 * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry
336 * @chip_shift: [INTERN] number of address bits in one chip
337 * @datbuf: [INTERN] internal buffer for one page + oob
338 * @oobbuf: [INTERN] oob buffer for one eraseblock
339 * @oobdirty: [INTERN] indicates that oob_buf must be reinitialized
340 * @data_poi: [INTERN] pointer to a data buffer
341 * @options: [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
342 * special functionality. See the defines for further explanation
343 * @badblockpos: [INTERN] position of the bad block marker in the oob area
344 * @cellinfo: [INTERN] MLC/multichip data from chip ident
345 * @numchips: [INTERN] number of physical chips
346 * @chipsize: [INTERN] the size of one chip for multichip arrays
347 * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1
348 * @pagebuf: [INTERN] holds the pagenumber which is currently in data_buf
349 * @subpagesize: [INTERN] holds the subpagesize
350 * @ecclayout: [REPLACEABLE] the default ecc placement scheme
351 * @bbt: [INTERN] bad block table pointer
352 * @bbt_td: [REPLACEABLE] bad block table descriptor for flash lookup
353 * @bbt_md: [REPLACEABLE] bad block table mirror descriptor
354 * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial bad block scan
355 * @controller: [REPLACEABLE] a pointer to a hardware controller structure
356 * which is shared among multiple independend devices
357 * @priv: [OPTIONAL] pointer to private chip date
358 * @errstat: [OPTIONAL] hardware specific function to perform additional error status checks
359 * (determine if errors are correctable)
360 * @write_page: [REPLACEABLE] High-level page write function
364 void __iomem *IO_ADDR_R;
365 void __iomem *IO_ADDR_W;
367 uint8_t (*read_byte)(struct mtd_info *mtd);
368 u16 (*read_word)(struct mtd_info *mtd);
369 void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
370 void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
371 int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
372 void (*select_chip)(struct mtd_info *mtd, int chip);
373 int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
374 int (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
375 void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
377 int (*dev_ready)(struct mtd_info *mtd);
378 void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
379 int (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this);
380 void (*erase_cmd)(struct mtd_info *mtd, int page);
381 int (*scan_bbt)(struct mtd_info *mtd);
382 int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
383 int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip,
384 const uint8_t *buf, int page, int cached, int raw);
387 unsigned int options;
390 int phys_erase_shift;
394 unsigned long chipsize;
404 struct nand_hw_control *controller;
405 struct nand_ecclayout *ecclayout;
407 struct nand_ecc_ctrl ecc;
408 struct nand_buffers *buffers;
409 struct nand_hw_control hwcontrol;
411 struct mtd_oob_ops ops;
414 struct nand_bbt_descr *bbt_td;
415 struct nand_bbt_descr *bbt_md;
417 struct nand_bbt_descr *badblock_pattern;
423 * NAND Flash Manufacturer ID Codes
425 #define NAND_MFR_TOSHIBA 0x98
426 #define NAND_MFR_SAMSUNG 0xec
427 #define NAND_MFR_FUJITSU 0x04
428 #define NAND_MFR_NATIONAL 0x8f
429 #define NAND_MFR_RENESAS 0x07
430 #define NAND_MFR_STMICRO 0x20
431 #define NAND_MFR_HYNIX 0xad
432 #define NAND_MFR_MICRON 0x2c
433 #define NAND_MFR_AMD 0x01
436 * struct nand_flash_dev - NAND Flash Device ID Structure
437 * @name: Identify the device type
438 * @id: device ID code
439 * @pagesize: Pagesize in bytes. Either 256 or 512 or 0
440 * If the pagesize is 0, then the real pagesize
441 * and the eraseize are determined from the
442 * extended id bytes in the chip
443 * @erasesize: Size of an erase block in the flash device.
444 * @chipsize: Total chipsize in Mega Bytes
445 * @options: Bitfield to store chip relevant options
447 struct nand_flash_dev {
450 unsigned long pagesize;
451 unsigned long chipsize;
452 unsigned long erasesize;
453 unsigned long options;
457 * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
458 * @name: Manufacturer name
459 * @id: manufacturer ID code of device.
461 struct nand_manufacturers {
466 extern struct nand_flash_dev nand_flash_ids[];
467 extern struct nand_manufacturers nand_manuf_ids[];
470 * struct nand_bbt_descr - bad block table descriptor
471 * @options: options for this descriptor
472 * @pages: the page(s) where we find the bbt, used with option BBT_ABSPAGE
473 * when bbt is searched, then we store the found bbts pages here.
474 * Its an array and supports up to 8 chips now
475 * @offs: offset of the pattern in the oob area of the page
476 * @veroffs: offset of the bbt version counter in the oob are of the page
477 * @version: version read from the bbt page during scan
478 * @len: length of the pattern, if 0 no pattern check is performed
479 * @maxblocks: maximum number of blocks to search for a bbt. This number of
480 * blocks is reserved at the end of the device where the tables are
482 * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
483 * bad) block in the stored bbt
484 * @pattern: pattern to identify bad block table or factory marked good /
485 * bad blocks, can be NULL, if len = 0
487 * Descriptor for the bad block table marker and the descriptor for the
488 * pattern which identifies good and bad blocks. The assumption is made
489 * that the pattern and the version count are always located in the oob area
490 * of the first block.
492 struct nand_bbt_descr {
494 int pages[NAND_MAX_CHIPS];
497 uint8_t version[NAND_MAX_CHIPS];
500 int reserved_block_code;
504 /* Options for the bad block table descriptors */
506 /* The number of bits used per block in the bbt on the device */
507 #define NAND_BBT_NRBITS_MSK 0x0000000F
508 #define NAND_BBT_1BIT 0x00000001
509 #define NAND_BBT_2BIT 0x00000002
510 #define NAND_BBT_4BIT 0x00000004
511 #define NAND_BBT_8BIT 0x00000008
512 /* The bad block table is in the last good block of the device */
513 #define NAND_BBT_LASTBLOCK 0x00000010
514 /* The bbt is at the given page, else we must scan for the bbt */
515 #define NAND_BBT_ABSPAGE 0x00000020
516 /* The bbt is at the given page, else we must scan for the bbt */
517 #define NAND_BBT_SEARCH 0x00000040
518 /* bbt is stored per chip on multichip devices */
519 #define NAND_BBT_PERCHIP 0x00000080
520 /* bbt has a version counter at offset veroffs */
521 #define NAND_BBT_VERSION 0x00000100
522 /* Create a bbt if none axists */
523 #define NAND_BBT_CREATE 0x00000200
524 /* Search good / bad pattern through all pages of a block */
525 #define NAND_BBT_SCANALLPAGES 0x00000400
526 /* Scan block empty during good / bad block scan */
527 #define NAND_BBT_SCANEMPTY 0x00000800
528 /* Write bbt if neccecary */
529 #define NAND_BBT_WRITE 0x00001000
530 /* Read and write back block contents when writing bbt */
531 #define NAND_BBT_SAVECONTENT 0x00002000
532 /* Search good / bad pattern on the first and the second page */
533 #define NAND_BBT_SCAN2NDPAGE 0x00004000
535 /* The maximum number of blocks to scan for a bbt */
536 #define NAND_BBT_SCAN_MAXBLOCKS 4
538 extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd);
539 extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs);
540 extern int nand_default_bbt(struct mtd_info *mtd);
541 extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt);
542 extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr,
544 extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len,
545 size_t * retlen, uint8_t * buf);
548 * Constants for oob configuration
550 #define NAND_SMALL_BADBLOCK_POS 5
551 #define NAND_LARGE_BADBLOCK_POS 0
554 * struct platform_nand_chip - chip level device structure
555 * @nr_chips: max. number of chips to scan for
556 * @chip_offset: chip number offset
557 * @nr_partitions: number of partitions pointed to by partitions (or zero)
558 * @partitions: mtd partition list
559 * @chip_delay: R/B delay value in us
560 * @options: Option flags, e.g. 16bit buswidth
561 * @ecclayout: ecc layout info structure
562 * @part_probe_types: NULL-terminated array of probe types
563 * @priv: hardware controller specific settings
565 struct platform_nand_chip {
569 struct mtd_partition *partitions;
570 struct nand_ecclayout *ecclayout;
572 unsigned int options;
573 const char **part_probe_types;
578 * struct platform_nand_ctrl - controller level device structure
579 * @hwcontrol: platform specific hardware control structure
580 * @dev_ready: platform specific function to read ready/busy pin
581 * @select_chip: platform specific chip select function
582 * @cmd_ctrl: platform specific function for controlling
583 * ALE/CLE/nCE. Also used to write command and address
584 * @priv: private data to transport driver specific settings
586 * All fields are optional and depend on the hardware driver requirements
588 struct platform_nand_ctrl {
589 void (*hwcontrol)(struct mtd_info *mtd, int cmd);
590 int (*dev_ready)(struct mtd_info *mtd);
591 void (*select_chip)(struct mtd_info *mtd, int chip);
592 void (*cmd_ctrl)(struct mtd_info *mtd, int dat,
598 * struct platform_nand_data - container structure for platform-specific data
599 * @chip: chip level chip structure
600 * @ctrl: controller level device structure
602 struct platform_nand_data {
603 struct platform_nand_chip chip;
604 struct platform_nand_ctrl ctrl;
607 /* Some helpers to access the data structures */
609 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
611 struct nand_chip *chip = mtd->priv;
616 #endif /* __LINUX_MTD_NAND_H */