]> err.no Git - linux-2.6/blob - include/linux/mtd/nand.h
[MTD] Refactor NAND hwcontrol to cmd_ctrl
[linux-2.6] / include / linux / mtd / nand.h
1 /*
2  *  linux/include/linux/mtd/nand.h
3  *
4  *  Copyright (c) 2000 David Woodhouse <dwmw2@mvhi.com>
5  *                     Steven J. Hill <sjhill@realitydiluted.com>
6  *                     Thomas Gleixner <tglx@linutronix.de>
7  *
8  * $Id: nand.h,v 1.74 2005/09/15 13:58:50 vwool Exp $
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  *
14  * Info:
15  *      Contains standard defines and IDs for NAND flash devices
16  *
17  * Changelog:
18  *      See git changelog.
19  */
20 #ifndef __LINUX_MTD_NAND_H
21 #define __LINUX_MTD_NAND_H
22
23 #include <linux/config.h>
24 #include <linux/wait.h>
25 #include <linux/spinlock.h>
26 #include <linux/mtd/mtd.h>
27
28 struct mtd_info;
29 /* Scan and identify a NAND device */
30 extern int nand_scan (struct mtd_info *mtd, int max_chips);
31 /* Free resources held by the NAND device */
32 extern void nand_release (struct mtd_info *mtd);
33
34 /* Read raw data from the device without ECC */
35 extern int nand_read_raw (struct mtd_info *mtd, uint8_t *buf, loff_t from,
36                           size_t len, size_t ooblen);
37
38
39 extern int nand_write_raw(struct mtd_info *mtd, loff_t to, size_t len,
40                           size_t *retlen, uint8_t *buf, uint8_t *oob);
41
42 /* The maximum number of NAND chips in an array */
43 #define NAND_MAX_CHIPS          8
44
45 /* This constant declares the max. oobsize / page, which
46  * is supported now. If you add a chip with bigger oobsize/page
47  * adjust this accordingly.
48  */
49 #define NAND_MAX_OOBSIZE        64
50
51 /*
52  * Constants for hardware specific CLE/ALE/NCE function
53  *
54  * These are bits which can be or'ed to set/clear multiple
55  * bits in one go.
56  */
57 /* Select the chip by setting nCE to low */
58 #define NAND_NCE                0x01
59 /* Select the command latch by setting CLE to high */
60 #define NAND_CLE                0x02
61 /* Select the address latch by setting ALE to high */
62 #define NAND_ALE                0x04
63
64 #define NAND_CTRL_CLE           (NAND_NCE | NAND_CLE)
65 #define NAND_CTRL_ALE           (NAND_NCE | NAND_ALE)
66 #define NAND_CTRL_CHANGE        0x80
67
68 /*
69  * Standard NAND flash commands
70  */
71 #define NAND_CMD_READ0          0
72 #define NAND_CMD_READ1          1
73 #define NAND_CMD_PAGEPROG       0x10
74 #define NAND_CMD_READOOB        0x50
75 #define NAND_CMD_ERASE1         0x60
76 #define NAND_CMD_STATUS         0x70
77 #define NAND_CMD_STATUS_MULTI   0x71
78 #define NAND_CMD_SEQIN          0x80
79 #define NAND_CMD_READID         0x90
80 #define NAND_CMD_ERASE2         0xd0
81 #define NAND_CMD_RESET          0xff
82
83 /* Extended commands for large page devices */
84 #define NAND_CMD_READSTART      0x30
85 #define NAND_CMD_CACHEDPROG     0x15
86
87 /* Extended commands for AG-AND device */
88 /*
89  * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but
90  *       there is no way to distinguish that from NAND_CMD_READ0
91  *       until the remaining sequence of commands has been completed
92  *       so add a high order bit and mask it off in the command.
93  */
94 #define NAND_CMD_DEPLETE1       0x100
95 #define NAND_CMD_DEPLETE2       0x38
96 #define NAND_CMD_STATUS_MULTI   0x71
97 #define NAND_CMD_STATUS_ERROR   0x72
98 /* multi-bank error status (banks 0-3) */
99 #define NAND_CMD_STATUS_ERROR0  0x73
100 #define NAND_CMD_STATUS_ERROR1  0x74
101 #define NAND_CMD_STATUS_ERROR2  0x75
102 #define NAND_CMD_STATUS_ERROR3  0x76
103 #define NAND_CMD_STATUS_RESET   0x7f
104 #define NAND_CMD_STATUS_CLEAR   0xff
105
106 #define NAND_CMD_NONE           -1
107
108 /* Status bits */
109 #define NAND_STATUS_FAIL        0x01
110 #define NAND_STATUS_FAIL_N1     0x02
111 #define NAND_STATUS_TRUE_READY  0x20
112 #define NAND_STATUS_READY       0x40
113 #define NAND_STATUS_WP          0x80
114
115 /*
116  * Constants for ECC_MODES
117  */
118 typedef enum {
119         NAND_ECC_NONE,
120         NAND_ECC_SOFT,
121         NAND_ECC_HW,
122         NAND_ECC_HW_SYNDROME,
123 } nand_ecc_modes_t;
124
125 /*
126  * Constants for Hardware ECC
127  */
128 /* Reset Hardware ECC for read */
129 #define NAND_ECC_READ           0
130 /* Reset Hardware ECC for write */
131 #define NAND_ECC_WRITE          1
132 /* Enable Hardware ECC before syndrom is read back from flash */
133 #define NAND_ECC_READSYN        2
134
135 /* Bit mask for flags passed to do_nand_read_ecc */
136 #define NAND_GET_DEVICE         0x80
137
138
139 /* Option constants for bizarre disfunctionality and real
140 *  features
141 */
142 /* Chip can not auto increment pages */
143 #define NAND_NO_AUTOINCR        0x00000001
144 /* Buswitdh is 16 bit */
145 #define NAND_BUSWIDTH_16        0x00000002
146 /* Device supports partial programming without padding */
147 #define NAND_NO_PADDING         0x00000004
148 /* Chip has cache program function */
149 #define NAND_CACHEPRG           0x00000008
150 /* Chip has copy back function */
151 #define NAND_COPYBACK           0x00000010
152 /* AND Chip which has 4 banks and a confusing page / block
153  * assignment. See Renesas datasheet for further information */
154 #define NAND_IS_AND             0x00000020
155 /* Chip has a array of 4 pages which can be read without
156  * additional ready /busy waits */
157 #define NAND_4PAGE_ARRAY        0x00000040
158 /* Chip requires that BBT is periodically rewritten to prevent
159  * bits from adjacent blocks from 'leaking' in altering data.
160  * This happens with the Renesas AG-AND chips, possibly others.  */
161 #define BBT_AUTO_REFRESH        0x00000080
162
163 /* Options valid for Samsung large page devices */
164 #define NAND_SAMSUNG_LP_OPTIONS \
165         (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK)
166
167 /* Macros to identify the above */
168 #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR))
169 #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING))
170 #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG))
171 #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK))
172
173 /* Mask to zero out the chip options, which come from the id table */
174 #define NAND_CHIPOPTIONS_MSK    (0x0000ffff & ~NAND_NO_AUTOINCR)
175
176 /* Non chip related options */
177 /* Use a flash based bad block table. This option is passed to the
178  * default bad block table function. */
179 #define NAND_USE_FLASH_BBT      0x00010000
180 /* The hw ecc generator provides a syndrome instead a ecc value on read
181  * This can only work if we have the ecc bytes directly behind the
182  * data bytes. Applies for DOC and AG-AND Renesas HW Reed Solomon generators */
183 #define NAND_HWECC_SYNDROME     0x00020000
184 /* This option skips the bbt scan during initialization. */
185 #define NAND_SKIP_BBTSCAN       0x00040000
186
187 /* Options set by nand scan */
188 /* Nand scan has allocated controller struct */
189 #define NAND_CONTROLLER_ALLOC   0x20000000
190 /* Nand scan has allocated oob_buf */
191 #define NAND_OOBBUF_ALLOC       0x40000000
192 /* Nand scan has allocated data_buf */
193 #define NAND_DATABUF_ALLOC      0x80000000
194
195
196 /*
197  * nand_state_t - chip states
198  * Enumeration for NAND flash chip state
199  */
200 typedef enum {
201         FL_READY,
202         FL_READING,
203         FL_WRITING,
204         FL_ERASING,
205         FL_SYNCING,
206         FL_CACHEDPRG,
207         FL_PM_SUSPENDED,
208 } nand_state_t;
209
210 /* Keep gcc happy */
211 struct nand_chip;
212
213 /**
214  * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independend devices
215  * @lock:               protection lock
216  * @active:             the mtd device which holds the controller currently
217  * @wq:                 wait queue to sleep on if a NAND operation is in progress
218  *                      used instead of the per chip wait queue when a hw controller is available
219  */
220 struct nand_hw_control {
221         spinlock_t       lock;
222         struct nand_chip *active;
223         wait_queue_head_t wq;
224 };
225
226 /**
227  * struct nand_ecc_ctrl - Control structure for ecc
228  * @mode:       ecc mode
229  * @steps:      number of ecc steps per page
230  * @size:       data bytes per ecc step
231  * @bytes:      ecc bytes per step
232  * @hwctl:      function to control hardware ecc generator. Must only
233  *              be provided if an hardware ECC is available
234  * @calculate:  function for ecc calculation or readback from ecc hardware
235  * @correct:    function for ecc correction, matching to ecc generator (sw/hw)
236  */
237 struct nand_ecc_ctrl {
238         nand_ecc_modes_t        mode;
239         int                     steps;
240         int                     size;
241         int                     bytes;
242         void                    (*hwctl)(struct mtd_info *mtd, int mode);
243         int                     (*calculate)(struct mtd_info *mtd,
244                                              const uint8_t *dat,
245                                              uint8_t *ecc_code);
246         int                     (*correct)(struct mtd_info *mtd, uint8_t *dat,
247                                            uint8_t *read_ecc,
248                                            uint8_t *calc_ecc);
249 };
250
251 /**
252  * struct nand_chip - NAND Private Flash Chip Data
253  * @IO_ADDR_R:          [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device
254  * @IO_ADDR_W:          [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device
255  * @read_byte:          [REPLACEABLE] read one byte from the chip
256  * @write_byte:         [REPLACEABLE] write one byte to the chip
257  * @read_word:          [REPLACEABLE] read one word from the chip
258  * @write_word:         [REPLACEABLE] write one word to the chip
259  * @write_buf:          [REPLACEABLE] write data from the buffer to the chip
260  * @read_buf:           [REPLACEABLE] read data from the chip into the buffer
261  * @verify_buf:         [REPLACEABLE] verify buffer contents against the chip data
262  * @select_chip:        [REPLACEABLE] select chip nr
263  * @block_bad:          [REPLACEABLE] check, if the block is bad
264  * @block_markbad:      [REPLACEABLE] mark the block bad
265  * @cmd_ctrl:           [BOARDSPECIFIC] hardwarespecific funtion for controlling
266  *                      ALE/CLE/nCE. Also used to write command and address
267  * @dev_ready:          [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line
268  *                      If set to NULL no access to ready/busy is available and the ready/busy information
269  *                      is read from the chip status register
270  * @cmdfunc:            [REPLACEABLE] hardwarespecific function for writing commands to the chip
271  * @waitfunc:           [REPLACEABLE] hardwarespecific function for wait on ready
272  * @ecc:                [BOARDSPECIFIC] ecc control ctructure
273  * @erase_cmd:          [INTERN] erase command write function, selectable due to AND support
274  * @scan_bbt:           [REPLACEABLE] function to scan bad block table
275  * @chip_delay:         [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR)
276  * @wq:                 [INTERN] wait queue to sleep on if a NAND operation is in progress
277  * @state:              [INTERN] the current state of the NAND device
278  * @page_shift:         [INTERN] number of address bits in a page (column address bits)
279  * @phys_erase_shift:   [INTERN] number of address bits in a physical eraseblock
280  * @bbt_erase_shift:    [INTERN] number of address bits in a bbt entry
281  * @chip_shift:         [INTERN] number of address bits in one chip
282  * @data_buf:           [INTERN] internal buffer for one page + oob
283  * @oob_buf:            [INTERN] oob buffer for one eraseblock
284  * @oobdirty:           [INTERN] indicates that oob_buf must be reinitialized
285  * @data_poi:           [INTERN] pointer to a data buffer
286  * @options:            [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about
287  *                      special functionality. See the defines for further explanation
288  * @badblockpos:        [INTERN] position of the bad block marker in the oob area
289  * @numchips:           [INTERN] number of physical chips
290  * @chipsize:           [INTERN] the size of one chip for multichip arrays
291  * @pagemask:           [INTERN] page number mask = number of (pages / chip) - 1
292  * @pagebuf:            [INTERN] holds the pagenumber which is currently in data_buf
293  * @autooob:            [REPLACEABLE] the default (auto)placement scheme
294  * @bbt:                [INTERN] bad block table pointer
295  * @bbt_td:             [REPLACEABLE] bad block table descriptor for flash lookup
296  * @bbt_md:             [REPLACEABLE] bad block table mirror descriptor
297  * @badblock_pattern:   [REPLACEABLE] bad block scan pattern used for initial bad block scan
298  * @controller:         [REPLACEABLE] a pointer to a hardware controller structure
299  *                      which is shared among multiple independend devices
300  * @priv:               [OPTIONAL] pointer to private chip date
301  * @errstat:            [OPTIONAL] hardware specific function to perform additional error status checks
302  *                      (determine if errors are correctable)
303  */
304
305 struct nand_chip {
306         void  __iomem   *IO_ADDR_R;
307         void  __iomem   *IO_ADDR_W;
308
309         uint8_t         (*read_byte)(struct mtd_info *mtd);
310         void            (*write_byte)(struct mtd_info *mtd, uint8_t byte);
311         u16             (*read_word)(struct mtd_info *mtd);
312         void            (*write_word)(struct mtd_info *mtd, u16 word);
313
314         void            (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
315         void            (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len);
316         int             (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len);
317         void            (*select_chip)(struct mtd_info *mtd, int chip);
318         int             (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip);
319         int             (*block_markbad)(struct mtd_info *mtd, loff_t ofs);
320         void            (*cmd_ctrl)(struct mtd_info *mtd, int dat,
321                                     unsigned int ctrl);
322         int             (*dev_ready)(struct mtd_info *mtd);
323         void            (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr);
324         int             (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this, int state);
325         void            (*erase_cmd)(struct mtd_info *mtd, int page);
326         int             (*scan_bbt)(struct mtd_info *mtd);
327         struct nand_ecc_ctrl ecc;
328         int             chip_delay;
329         wait_queue_head_t wq;
330         nand_state_t    state;
331         int             page_shift;
332         int             phys_erase_shift;
333         int             bbt_erase_shift;
334         int             chip_shift;
335         uint8_t         *data_buf;
336         uint8_t         *oob_buf;
337         int             oobdirty;
338         uint8_t         *data_poi;
339         unsigned int    options;
340         int             badblockpos;
341         int             numchips;
342         unsigned long   chipsize;
343         int             pagemask;
344         int             pagebuf;
345         struct nand_oobinfo     *autooob;
346         uint8_t         *bbt;
347         struct nand_bbt_descr   *bbt_td;
348         struct nand_bbt_descr   *bbt_md;
349         struct nand_bbt_descr   *badblock_pattern;
350         struct nand_hw_control  *controller;
351         void            *priv;
352         int             (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page);
353 };
354
355 /*
356  * NAND Flash Manufacturer ID Codes
357  */
358 #define NAND_MFR_TOSHIBA        0x98
359 #define NAND_MFR_SAMSUNG        0xec
360 #define NAND_MFR_FUJITSU        0x04
361 #define NAND_MFR_NATIONAL       0x8f
362 #define NAND_MFR_RENESAS        0x07
363 #define NAND_MFR_STMICRO        0x20
364 #define NAND_MFR_HYNIX          0xad
365
366 /**
367  * struct nand_flash_dev - NAND Flash Device ID Structure
368  *
369  * @name:       Identify the device type
370  * @id:         device ID code
371  * @pagesize:   Pagesize in bytes. Either 256 or 512 or 0
372  *              If the pagesize is 0, then the real pagesize
373  *              and the eraseize are determined from the
374  *              extended id bytes in the chip
375  * @erasesize:  Size of an erase block in the flash device.
376  * @chipsize:   Total chipsize in Mega Bytes
377  * @options:    Bitfield to store chip relevant options
378  */
379 struct nand_flash_dev {
380         char *name;
381         int id;
382         unsigned long pagesize;
383         unsigned long chipsize;
384         unsigned long erasesize;
385         unsigned long options;
386 };
387
388 /**
389  * struct nand_manufacturers - NAND Flash Manufacturer ID Structure
390  * @name:       Manufacturer name
391  * @id:         manufacturer ID code of device.
392 */
393 struct nand_manufacturers {
394         int id;
395         char * name;
396 };
397
398 extern struct nand_flash_dev nand_flash_ids[];
399 extern struct nand_manufacturers nand_manuf_ids[];
400
401 /**
402  * struct nand_bbt_descr - bad block table descriptor
403  * @options:    options for this descriptor
404  * @pages:      the page(s) where we find the bbt, used with option BBT_ABSPAGE
405  *              when bbt is searched, then we store the found bbts pages here.
406  *              Its an array and supports up to 8 chips now
407  * @offs:       offset of the pattern in the oob area of the page
408  * @veroffs:    offset of the bbt version counter in the oob are of the page
409  * @version:    version read from the bbt page during scan
410  * @len:        length of the pattern, if 0 no pattern check is performed
411  * @maxblocks:  maximum number of blocks to search for a bbt. This number of
412  *              blocks is reserved at the end of the device where the tables are
413  *              written.
414  * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than
415  *              bad) block in the stored bbt
416  * @pattern:    pattern to identify bad block table or factory marked good /
417  *              bad blocks, can be NULL, if len = 0
418  *
419  * Descriptor for the bad block table marker and the descriptor for the
420  * pattern which identifies good and bad blocks. The assumption is made
421  * that the pattern and the version count are always located in the oob area
422  * of the first block.
423  */
424 struct nand_bbt_descr {
425         int     options;
426         int     pages[NAND_MAX_CHIPS];
427         int     offs;
428         int     veroffs;
429         uint8_t version[NAND_MAX_CHIPS];
430         int     len;
431         int     maxblocks;
432         int     reserved_block_code;
433         uint8_t *pattern;
434 };
435
436 /* Options for the bad block table descriptors */
437
438 /* The number of bits used per block in the bbt on the device */
439 #define NAND_BBT_NRBITS_MSK     0x0000000F
440 #define NAND_BBT_1BIT           0x00000001
441 #define NAND_BBT_2BIT           0x00000002
442 #define NAND_BBT_4BIT           0x00000004
443 #define NAND_BBT_8BIT           0x00000008
444 /* The bad block table is in the last good block of the device */
445 #define NAND_BBT_LASTBLOCK      0x00000010
446 /* The bbt is at the given page, else we must scan for the bbt */
447 #define NAND_BBT_ABSPAGE        0x00000020
448 /* The bbt is at the given page, else we must scan for the bbt */
449 #define NAND_BBT_SEARCH         0x00000040
450 /* bbt is stored per chip on multichip devices */
451 #define NAND_BBT_PERCHIP        0x00000080
452 /* bbt has a version counter at offset veroffs */
453 #define NAND_BBT_VERSION        0x00000100
454 /* Create a bbt if none axists */
455 #define NAND_BBT_CREATE         0x00000200
456 /* Search good / bad pattern through all pages of a block */
457 #define NAND_BBT_SCANALLPAGES   0x00000400
458 /* Scan block empty during good / bad block scan */
459 #define NAND_BBT_SCANEMPTY      0x00000800
460 /* Write bbt if neccecary */
461 #define NAND_BBT_WRITE          0x00001000
462 /* Read and write back block contents when writing bbt */
463 #define NAND_BBT_SAVECONTENT    0x00002000
464 /* Search good / bad pattern on the first and the second page */
465 #define NAND_BBT_SCAN2NDPAGE    0x00004000
466
467 /* The maximum number of blocks to scan for a bbt */
468 #define NAND_BBT_SCAN_MAXBLOCKS 4
469
470 extern int nand_scan_bbt (struct mtd_info *mtd, struct nand_bbt_descr *bd);
471 extern int nand_update_bbt (struct mtd_info *mtd, loff_t offs);
472 extern int nand_default_bbt (struct mtd_info *mtd);
473 extern int nand_isbad_bbt (struct mtd_info *mtd, loff_t offs, int allowbbt);
474 extern int nand_erase_nand (struct mtd_info *mtd, struct erase_info *instr, int allowbbt);
475 extern int nand_do_read_ecc (struct mtd_info *mtd, loff_t from, size_t len,
476                              size_t * retlen, uint8_t * buf, uint8_t * oob_buf,
477                              struct nand_oobinfo *oobsel, int flags);
478
479 /*
480 * Constants for oob configuration
481 */
482 #define NAND_SMALL_BADBLOCK_POS         5
483 #define NAND_LARGE_BADBLOCK_POS         0
484
485 /**
486  * struct platform_nand_chip - chip level device structure
487  *
488  * @nr_chips:           max. number of chips to scan for
489  * @chip_offs:          chip number offset
490  * @nr_partitions:      number of partitions pointed to be partitoons (or zero)
491  * @partitions:         mtd partition list
492  * @chip_delay:         R/B delay value in us
493  * @options:            Option flags, e.g. 16bit buswidth
494  * @priv:               hardware controller specific settings
495  */
496 struct platform_nand_chip {
497         int                     nr_chips;
498         int                     chip_offset;
499         int                     nr_partitions;
500         struct mtd_partition    *partitions;
501         int                     chip_delay;
502         unsigned int            options;
503         void                    *priv;
504 };
505
506 /**
507  * struct platform_nand_ctrl - controller level device structure
508  *
509  * @hwcontrol:          platform specific hardware control structure
510  * @dev_ready:          platform specific function to read ready/busy pin
511  * @select_chip:        platform specific chip select function
512  * @priv_data:          private data to transport driver specific settings
513  *
514  * All fields are optional and depend on the hardware driver requirements
515  */
516 struct platform_nand_ctrl {
517         void            (*hwcontrol)(struct mtd_info *mtd, int cmd);
518         int             (*dev_ready)(struct mtd_info *mtd);
519         void            (*select_chip)(struct mtd_info *mtd, int chip);
520         void            *priv;
521 };
522
523 /* Some helpers to access the data structures */
524 static inline
525 struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd)
526 {
527         struct nand_chip *chip = mtd->priv;
528
529         return chip->priv;
530 }
531
532 #endif /* __LINUX_MTD_NAND_H */