Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* |
2 | * linux/include/linux/mtd/nand.h | |
3 | * | |
44d1b980 | 4 | * Copyright (c) 2000 David Woodhouse <dwmw2@infradead.org> |
1da177e4 LT |
5 | * Steven J. Hill <sjhill@realitydiluted.com> |
6 | * Thomas Gleixner <tglx@linutronix.de> | |
7 | * | |
1da177e4 LT |
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 | * | |
2c0a2bed TG |
12 | * Info: |
13 | * Contains standard defines and IDs for NAND flash devices | |
1da177e4 | 14 | * |
2c0a2bed TG |
15 | * Changelog: |
16 | * See git changelog. | |
1da177e4 LT |
17 | */ |
18 | #ifndef __LINUX_MTD_NAND_H | |
19 | #define __LINUX_MTD_NAND_H | |
20 | ||
1da177e4 LT |
21 | #include <linux/wait.h> |
22 | #include <linux/spinlock.h> | |
23 | #include <linux/mtd/mtd.h> | |
24 | ||
25 | struct mtd_info; | |
26 | /* Scan and identify a NAND device */ | |
27 | extern int nand_scan (struct mtd_info *mtd, int max_chips); | |
3b85c321 DW |
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); | |
32 | ||
1da177e4 LT |
33 | /* Free resources held by the NAND device */ |
34 | extern void nand_release (struct mtd_info *mtd); | |
35 | ||
b77d95c7 DW |
36 | /* Internal helper for board drivers which need to override command function */ |
37 | extern void nand_wait_ready(struct mtd_info *mtd); | |
38 | ||
1da177e4 LT |
39 | /* The maximum number of NAND chips in an array */ |
40 | #define NAND_MAX_CHIPS 8 | |
41 | ||
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. | |
45 | */ | |
81ec5364 TG |
46 | #define NAND_MAX_OOBSIZE 128 |
47 | #define NAND_MAX_PAGESIZE 4096 | |
1da177e4 LT |
48 | |
49 | /* | |
50 | * Constants for hardware specific CLE/ALE/NCE function | |
7abd3ef9 TG |
51 | * |
52 | * These are bits which can be or'ed to set/clear multiple | |
53 | * bits in one go. | |
54 | */ | |
1da177e4 | 55 | /* Select the chip by setting nCE to low */ |
7abd3ef9 | 56 | #define NAND_NCE 0x01 |
1da177e4 | 57 | /* Select the command latch by setting CLE to high */ |
7abd3ef9 | 58 | #define NAND_CLE 0x02 |
1da177e4 | 59 | /* Select the address latch by setting ALE to high */ |
7abd3ef9 TG |
60 | #define NAND_ALE 0x04 |
61 | ||
62 | #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE) | |
63 | #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE) | |
64 | #define NAND_CTRL_CHANGE 0x80 | |
1da177e4 LT |
65 | |
66 | /* | |
67 | * Standard NAND flash commands | |
68 | */ | |
69 | #define NAND_CMD_READ0 0 | |
70 | #define NAND_CMD_READ1 1 | |
7bc3312b | 71 | #define NAND_CMD_RNDOUT 5 |
1da177e4 LT |
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 | |
7bc3312b | 78 | #define NAND_CMD_RNDIN 0x85 |
1da177e4 LT |
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 | |
7bc3312b | 85 | #define NAND_CMD_RNDOUTSTART 0xE0 |
1da177e4 LT |
86 | #define NAND_CMD_CACHEDPROG 0x15 |
87 | ||
28a48de7 | 88 | /* Extended commands for AG-AND device */ |
61ecfa87 TG |
89 | /* |
90 | * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but | |
28a48de7 DM |
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. | |
94 | */ | |
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 | |
106 | ||
7abd3ef9 TG |
107 | #define NAND_CMD_NONE -1 |
108 | ||
1da177e4 LT |
109 | /* Status bits */ |
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 | |
115 | ||
61ecfa87 | 116 | /* |
1da177e4 LT |
117 | * Constants for ECC_MODES |
118 | */ | |
6dfc6d25 TG |
119 | typedef enum { |
120 | NAND_ECC_NONE, | |
121 | NAND_ECC_SOFT, | |
122 | NAND_ECC_HW, | |
123 | NAND_ECC_HW_SYNDROME, | |
6e0cb135 | 124 | NAND_ECC_HW_OOB_FIRST, |
6dfc6d25 | 125 | } nand_ecc_modes_t; |
1da177e4 LT |
126 | |
127 | /* | |
128 | * Constants for Hardware ECC | |
068e3c0a | 129 | */ |
1da177e4 LT |
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 syndrom is read back from flash */ | |
135 | #define NAND_ECC_READSYN 2 | |
136 | ||
068e3c0a DM |
137 | /* Bit mask for flags passed to do_nand_read_ecc */ |
138 | #define NAND_GET_DEVICE 0x80 | |
139 | ||
140 | ||
1da177e4 LT |
141 | /* Option constants for bizarre disfunctionality and real |
142 | * features | |
143 | */ | |
144 | /* Chip can not auto increment pages */ | |
145 | #define NAND_NO_AUTOINCR 0x00000001 | |
146 | /* Buswitdh is 16 bit */ | |
147 | #define NAND_BUSWIDTH_16 0x00000002 | |
148 | /* Device supports partial programming without padding */ | |
149 | #define NAND_NO_PADDING 0x00000004 | |
150 | /* Chip has cache program function */ | |
151 | #define NAND_CACHEPRG 0x00000008 | |
152 | /* Chip has copy back function */ | |
153 | #define NAND_COPYBACK 0x00000010 | |
61ecfa87 | 154 | /* AND Chip which has 4 banks and a confusing page / block |
1da177e4 LT |
155 | * assignment. See Renesas datasheet for further information */ |
156 | #define NAND_IS_AND 0x00000020 | |
157 | /* Chip has a array of 4 pages which can be read without | |
158 | * additional ready /busy waits */ | |
61ecfa87 | 159 | #define NAND_4PAGE_ARRAY 0x00000040 |
28a48de7 DM |
160 | /* Chip requires that BBT is periodically rewritten to prevent |
161 | * bits from adjacent blocks from 'leaking' in altering data. | |
162 | * This happens with the Renesas AG-AND chips, possibly others. */ | |
163 | #define BBT_AUTO_REFRESH 0x00000080 | |
7a30601b TG |
164 | /* Chip does not require ready check on read. True |
165 | * for all large page devices, as they do not support | |
166 | * autoincrement.*/ | |
167 | #define NAND_NO_READRDY 0x00000100 | |
29072b96 TG |
168 | /* Chip does not allow subpage writes */ |
169 | #define NAND_NO_SUBPAGE_WRITE 0x00000200 | |
170 | ||
1da177e4 LT |
171 | |
172 | /* Options valid for Samsung large page devices */ | |
173 | #define NAND_SAMSUNG_LP_OPTIONS \ | |
174 | (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK) | |
175 | ||
176 | /* Macros to identify the above */ | |
177 | #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR)) | |
178 | #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING)) | |
179 | #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG)) | |
180 | #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK)) | |
96d8b647 AK |
181 | /* Large page NAND with SOFT_ECC should support subpage reads */ |
182 | #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \ | |
183 | && (chip->page_shift > 9)) | |
1da177e4 LT |
184 | |
185 | /* Mask to zero out the chip options, which come from the id table */ | |
186 | #define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR) | |
187 | ||
188 | /* Non chip related options */ | |
189 | /* Use a flash based bad block table. This option is passed to the | |
190 | * default bad block table function. */ | |
191 | #define NAND_USE_FLASH_BBT 0x00010000 | |
0040bf38 | 192 | /* This option skips the bbt scan during initialization. */ |
f75e5097 | 193 | #define NAND_SKIP_BBTSCAN 0x00020000 |
4bf63fcb DW |
194 | /* This option is defined if the board driver allocates its own buffers |
195 | (e.g. because it needs them DMA-coherent */ | |
196 | #define NAND_OWN_BUFFERS 0x00040000 | |
1da177e4 | 197 | /* Options set by nand scan */ |
a36ed299 | 198 | /* Nand scan has allocated controller struct */ |
f75e5097 | 199 | #define NAND_CONTROLLER_ALLOC 0x80000000 |
1da177e4 | 200 | |
29072b96 TG |
201 | /* Cell info constants */ |
202 | #define NAND_CI_CHIPNR_MSK 0x03 | |
203 | #define NAND_CI_CELLTYPE_MSK 0x0C | |
1da177e4 LT |
204 | |
205 | /* | |
206 | * nand_state_t - chip states | |
207 | * Enumeration for NAND flash chip state | |
208 | */ | |
209 | typedef enum { | |
210 | FL_READY, | |
211 | FL_READING, | |
212 | FL_WRITING, | |
213 | FL_ERASING, | |
214 | FL_SYNCING, | |
215 | FL_CACHEDPRG, | |
962034f4 | 216 | FL_PM_SUSPENDED, |
1da177e4 LT |
217 | } nand_state_t; |
218 | ||
219 | /* Keep gcc happy */ | |
220 | struct nand_chip; | |
221 | ||
222 | /** | |
844d3b42 | 223 | * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices |
61ecfa87 | 224 | * @lock: protection lock |
1da177e4 | 225 | * @active: the mtd device which holds the controller currently |
0dfc6246 TG |
226 | * @wq: wait queue to sleep on if a NAND operation is in progress |
227 | * used instead of the per chip wait queue when a hw controller is available | |
1da177e4 LT |
228 | */ |
229 | struct nand_hw_control { | |
230 | spinlock_t lock; | |
231 | struct nand_chip *active; | |
0dfc6246 | 232 | wait_queue_head_t wq; |
1da177e4 LT |
233 | }; |
234 | ||
6dfc6d25 TG |
235 | /** |
236 | * struct nand_ecc_ctrl - Control structure for ecc | |
237 | * @mode: ecc mode | |
238 | * @steps: number of ecc steps per page | |
239 | * @size: data bytes per ecc step | |
240 | * @bytes: ecc bytes per step | |
9577f44a TG |
241 | * @total: total number of ecc bytes per page |
242 | * @prepad: padding information for syndrome based ecc generators | |
243 | * @postpad: padding information for syndrome based ecc generators | |
844d3b42 | 244 | * @layout: ECC layout control struct pointer |
6dfc6d25 TG |
245 | * @hwctl: function to control hardware ecc generator. Must only |
246 | * be provided if an hardware ECC is available | |
247 | * @calculate: function for ecc calculation or readback from ecc hardware | |
248 | * @correct: function for ecc correction, matching to ecc generator (sw/hw) | |
956e944c DW |
249 | * @read_page_raw: function to read a raw page without ECC |
250 | * @write_page_raw: function to write a raw page without ECC | |
f75e5097 | 251 | * @read_page: function to read a page according to the ecc generator requirements |
17c1d2be | 252 | * @read_subpage: function to read parts of the page covered by ECC. |
9577f44a | 253 | * @write_page: function to write a page according to the ecc generator requirements |
844d3b42 RD |
254 | * @read_oob: function to read chip OOB data |
255 | * @write_oob: function to write chip OOB data | |
6dfc6d25 TG |
256 | */ |
257 | struct nand_ecc_ctrl { | |
258 | nand_ecc_modes_t mode; | |
259 | int steps; | |
260 | int size; | |
261 | int bytes; | |
9577f44a TG |
262 | int total; |
263 | int prepad; | |
264 | int postpad; | |
5bd34c09 | 265 | struct nand_ecclayout *layout; |
9a57d470 | 266 | void (*hwctl)(struct mtd_info *mtd, int mode); |
6dfc6d25 TG |
267 | int (*calculate)(struct mtd_info *mtd, |
268 | const uint8_t *dat, | |
269 | uint8_t *ecc_code); | |
270 | int (*correct)(struct mtd_info *mtd, uint8_t *dat, | |
271 | uint8_t *read_ecc, | |
272 | uint8_t *calc_ecc); | |
956e944c DW |
273 | int (*read_page_raw)(struct mtd_info *mtd, |
274 | struct nand_chip *chip, | |
46a8cf2d | 275 | uint8_t *buf, int page); |
956e944c DW |
276 | void (*write_page_raw)(struct mtd_info *mtd, |
277 | struct nand_chip *chip, | |
278 | const uint8_t *buf); | |
9577f44a TG |
279 | int (*read_page)(struct mtd_info *mtd, |
280 | struct nand_chip *chip, | |
46a8cf2d | 281 | uint8_t *buf, int page); |
3d459559 AK |
282 | int (*read_subpage)(struct mtd_info *mtd, |
283 | struct nand_chip *chip, | |
284 | uint32_t offs, uint32_t len, | |
285 | uint8_t *buf); | |
f75e5097 | 286 | void (*write_page)(struct mtd_info *mtd, |
9577f44a | 287 | struct nand_chip *chip, |
f75e5097 | 288 | const uint8_t *buf); |
7bc3312b TG |
289 | int (*read_oob)(struct mtd_info *mtd, |
290 | struct nand_chip *chip, | |
291 | int page, | |
292 | int sndcmd); | |
293 | int (*write_oob)(struct mtd_info *mtd, | |
294 | struct nand_chip *chip, | |
295 | int page); | |
f75e5097 TG |
296 | }; |
297 | ||
298 | /** | |
299 | * struct nand_buffers - buffer structure for read/write | |
300 | * @ecccalc: buffer for calculated ecc | |
301 | * @ecccode: buffer for ecc read from flash | |
f75e5097 | 302 | * @databuf: buffer for data - dynamically sized |
f75e5097 TG |
303 | * |
304 | * Do not change the order of buffers. databuf and oobrbuf must be in | |
305 | * consecutive order. | |
306 | */ | |
307 | struct nand_buffers { | |
308 | uint8_t ecccalc[NAND_MAX_OOBSIZE]; | |
309 | uint8_t ecccode[NAND_MAX_OOBSIZE]; | |
7dcdcbef | 310 | uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE]; |
6dfc6d25 TG |
311 | }; |
312 | ||
1da177e4 LT |
313 | /** |
314 | * struct nand_chip - NAND Private Flash Chip Data | |
61ecfa87 TG |
315 | * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device |
316 | * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device | |
1da177e4 | 317 | * @read_byte: [REPLACEABLE] read one byte from the chip |
1da177e4 | 318 | * @read_word: [REPLACEABLE] read one word from the chip |
1da177e4 LT |
319 | * @write_buf: [REPLACEABLE] write data from the buffer to the chip |
320 | * @read_buf: [REPLACEABLE] read data from the chip into the buffer | |
321 | * @verify_buf: [REPLACEABLE] verify buffer contents against the chip data | |
322 | * @select_chip: [REPLACEABLE] select chip nr | |
323 | * @block_bad: [REPLACEABLE] check, if the block is bad | |
324 | * @block_markbad: [REPLACEABLE] mark the block bad | |
7abd3ef9 TG |
325 | * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific funtion for controlling |
326 | * ALE/CLE/nCE. Also used to write command and address | |
1da177e4 LT |
327 | * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line |
328 | * If set to NULL no access to ready/busy is available and the ready/busy information | |
329 | * is read from the chip status register | |
330 | * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing commands to the chip | |
331 | * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on ready | |
6dfc6d25 | 332 | * @ecc: [BOARDSPECIFIC] ecc control ctructure |
844d3b42 RD |
333 | * @buffers: buffer structure for read/write |
334 | * @hwcontrol: platform-specific hardware control structure | |
335 | * @ops: oob operation operands | |
1da177e4 LT |
336 | * @erase_cmd: [INTERN] erase command write function, selectable due to AND support |
337 | * @scan_bbt: [REPLACEABLE] function to scan bad block table | |
1da177e4 | 338 | * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR) |
2c0a2bed | 339 | * @state: [INTERN] the current state of the NAND device |
844d3b42 | 340 | * @oob_poi: poison value buffer |
1da177e4 LT |
341 | * @page_shift: [INTERN] number of address bits in a page (column address bits) |
342 | * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock | |
343 | * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry | |
344 | * @chip_shift: [INTERN] number of address bits in one chip | |
1da177e4 LT |
345 | * @options: [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about |
346 | * special functionality. See the defines for further explanation | |
347 | * @badblockpos: [INTERN] position of the bad block marker in the oob area | |
552a8278 | 348 | * @cellinfo: [INTERN] MLC/multichip data from chip ident |
1da177e4 LT |
349 | * @numchips: [INTERN] number of physical chips |
350 | * @chipsize: [INTERN] the size of one chip for multichip arrays | |
351 | * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1 | |
352 | * @pagebuf: [INTERN] holds the pagenumber which is currently in data_buf | |
29072b96 | 353 | * @subpagesize: [INTERN] holds the subpagesize |
5bd34c09 | 354 | * @ecclayout: [REPLACEABLE] the default ecc placement scheme |
1da177e4 LT |
355 | * @bbt: [INTERN] bad block table pointer |
356 | * @bbt_td: [REPLACEABLE] bad block table descriptor for flash lookup | |
357 | * @bbt_md: [REPLACEABLE] bad block table mirror descriptor | |
61ecfa87 | 358 | * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial bad block scan |
a36ed299 TG |
359 | * @controller: [REPLACEABLE] a pointer to a hardware controller structure |
360 | * which is shared among multiple independend devices | |
1da177e4 | 361 | * @priv: [OPTIONAL] pointer to private chip date |
61ecfa87 | 362 | * @errstat: [OPTIONAL] hardware specific function to perform additional error status checks |
068e3c0a | 363 | * (determine if errors are correctable) |
351edd24 | 364 | * @write_page: [REPLACEABLE] High-level page write function |
1da177e4 | 365 | */ |
61ecfa87 | 366 | |
1da177e4 LT |
367 | struct nand_chip { |
368 | void __iomem *IO_ADDR_R; | |
2c0a2bed | 369 | void __iomem *IO_ADDR_W; |
61ecfa87 | 370 | |
58dd8f2b | 371 | uint8_t (*read_byte)(struct mtd_info *mtd); |
1da177e4 | 372 | u16 (*read_word)(struct mtd_info *mtd); |
58dd8f2b TG |
373 | void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len); |
374 | void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len); | |
375 | int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len); | |
1da177e4 LT |
376 | void (*select_chip)(struct mtd_info *mtd, int chip); |
377 | int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip); | |
378 | int (*block_markbad)(struct mtd_info *mtd, loff_t ofs); | |
7abd3ef9 TG |
379 | void (*cmd_ctrl)(struct mtd_info *mtd, int dat, |
380 | unsigned int ctrl); | |
2c0a2bed TG |
381 | int (*dev_ready)(struct mtd_info *mtd); |
382 | void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr); | |
7bc3312b | 383 | int (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this); |
1da177e4 LT |
384 | void (*erase_cmd)(struct mtd_info *mtd, int page); |
385 | int (*scan_bbt)(struct mtd_info *mtd); | |
f75e5097 | 386 | int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page); |
956e944c DW |
387 | int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip, |
388 | const uint8_t *buf, int page, int cached, int raw); | |
f75e5097 | 389 | |
2c0a2bed | 390 | int chip_delay; |
f75e5097 TG |
391 | unsigned int options; |
392 | ||
2c0a2bed | 393 | int page_shift; |
1da177e4 LT |
394 | int phys_erase_shift; |
395 | int bbt_erase_shift; | |
396 | int chip_shift; | |
1da177e4 | 397 | int numchips; |
69423d99 | 398 | uint64_t chipsize; |
1da177e4 LT |
399 | int pagemask; |
400 | int pagebuf; | |
29072b96 TG |
401 | int subpagesize; |
402 | uint8_t cellinfo; | |
f75e5097 TG |
403 | int badblockpos; |
404 | ||
405 | nand_state_t state; | |
406 | ||
407 | uint8_t *oob_poi; | |
408 | struct nand_hw_control *controller; | |
5bd34c09 | 409 | struct nand_ecclayout *ecclayout; |
f75e5097 TG |
410 | |
411 | struct nand_ecc_ctrl ecc; | |
4bf63fcb | 412 | struct nand_buffers *buffers; |
f75e5097 TG |
413 | struct nand_hw_control hwcontrol; |
414 | ||
8593fbc6 TG |
415 | struct mtd_oob_ops ops; |
416 | ||
1da177e4 LT |
417 | uint8_t *bbt; |
418 | struct nand_bbt_descr *bbt_td; | |
419 | struct nand_bbt_descr *bbt_md; | |
f75e5097 | 420 | |
1da177e4 | 421 | struct nand_bbt_descr *badblock_pattern; |
f75e5097 | 422 | |
1da177e4 LT |
423 | void *priv; |
424 | }; | |
425 | ||
426 | /* | |
427 | * NAND Flash Manufacturer ID Codes | |
428 | */ | |
429 | #define NAND_MFR_TOSHIBA 0x98 | |
430 | #define NAND_MFR_SAMSUNG 0xec | |
431 | #define NAND_MFR_FUJITSU 0x04 | |
432 | #define NAND_MFR_NATIONAL 0x8f | |
433 | #define NAND_MFR_RENESAS 0x07 | |
434 | #define NAND_MFR_STMICRO 0x20 | |
2c0a2bed | 435 | #define NAND_MFR_HYNIX 0xad |
8c60e547 | 436 | #define NAND_MFR_MICRON 0x2c |
30eb0db0 | 437 | #define NAND_MFR_AMD 0x01 |
1da177e4 LT |
438 | |
439 | /** | |
440 | * struct nand_flash_dev - NAND Flash Device ID Structure | |
2c0a2bed TG |
441 | * @name: Identify the device type |
442 | * @id: device ID code | |
443 | * @pagesize: Pagesize in bytes. Either 256 or 512 or 0 | |
61ecfa87 | 444 | * If the pagesize is 0, then the real pagesize |
1da177e4 LT |
445 | * and the eraseize are determined from the |
446 | * extended id bytes in the chip | |
2c0a2bed TG |
447 | * @erasesize: Size of an erase block in the flash device. |
448 | * @chipsize: Total chipsize in Mega Bytes | |
1da177e4 LT |
449 | * @options: Bitfield to store chip relevant options |
450 | */ | |
451 | struct nand_flash_dev { | |
452 | char *name; | |
453 | int id; | |
454 | unsigned long pagesize; | |
455 | unsigned long chipsize; | |
456 | unsigned long erasesize; | |
457 | unsigned long options; | |
458 | }; | |
459 | ||
460 | /** | |
461 | * struct nand_manufacturers - NAND Flash Manufacturer ID Structure | |
462 | * @name: Manufacturer name | |
2c0a2bed | 463 | * @id: manufacturer ID code of device. |
1da177e4 LT |
464 | */ |
465 | struct nand_manufacturers { | |
466 | int id; | |
467 | char * name; | |
468 | }; | |
469 | ||
470 | extern struct nand_flash_dev nand_flash_ids[]; | |
471 | extern struct nand_manufacturers nand_manuf_ids[]; | |
472 | ||
61ecfa87 | 473 | /** |
1da177e4 LT |
474 | * struct nand_bbt_descr - bad block table descriptor |
475 | * @options: options for this descriptor | |
476 | * @pages: the page(s) where we find the bbt, used with option BBT_ABSPAGE | |
477 | * when bbt is searched, then we store the found bbts pages here. | |
478 | * Its an array and supports up to 8 chips now | |
479 | * @offs: offset of the pattern in the oob area of the page | |
480 | * @veroffs: offset of the bbt version counter in the oob are of the page | |
481 | * @version: version read from the bbt page during scan | |
482 | * @len: length of the pattern, if 0 no pattern check is performed | |
483 | * @maxblocks: maximum number of blocks to search for a bbt. This number of | |
61ecfa87 | 484 | * blocks is reserved at the end of the device where the tables are |
1da177e4 LT |
485 | * written. |
486 | * @reserved_block_code: if non-0, this pattern denotes a reserved (rather than | |
487 | * bad) block in the stored bbt | |
61ecfa87 | 488 | * @pattern: pattern to identify bad block table or factory marked good / |
1da177e4 LT |
489 | * bad blocks, can be NULL, if len = 0 |
490 | * | |
61ecfa87 | 491 | * Descriptor for the bad block table marker and the descriptor for the |
1da177e4 LT |
492 | * pattern which identifies good and bad blocks. The assumption is made |
493 | * that the pattern and the version count are always located in the oob area | |
494 | * of the first block. | |
495 | */ | |
496 | struct nand_bbt_descr { | |
497 | int options; | |
498 | int pages[NAND_MAX_CHIPS]; | |
499 | int offs; | |
500 | int veroffs; | |
501 | uint8_t version[NAND_MAX_CHIPS]; | |
502 | int len; | |
2c0a2bed | 503 | int maxblocks; |
1da177e4 LT |
504 | int reserved_block_code; |
505 | uint8_t *pattern; | |
506 | }; | |
507 | ||
508 | /* Options for the bad block table descriptors */ | |
509 | ||
510 | /* The number of bits used per block in the bbt on the device */ | |
511 | #define NAND_BBT_NRBITS_MSK 0x0000000F | |
512 | #define NAND_BBT_1BIT 0x00000001 | |
513 | #define NAND_BBT_2BIT 0x00000002 | |
514 | #define NAND_BBT_4BIT 0x00000004 | |
515 | #define NAND_BBT_8BIT 0x00000008 | |
516 | /* The bad block table is in the last good block of the device */ | |
517 | #define NAND_BBT_LASTBLOCK 0x00000010 | |
518 | /* The bbt is at the given page, else we must scan for the bbt */ | |
519 | #define NAND_BBT_ABSPAGE 0x00000020 | |
520 | /* The bbt is at the given page, else we must scan for the bbt */ | |
521 | #define NAND_BBT_SEARCH 0x00000040 | |
522 | /* bbt is stored per chip on multichip devices */ | |
523 | #define NAND_BBT_PERCHIP 0x00000080 | |
524 | /* bbt has a version counter at offset veroffs */ | |
525 | #define NAND_BBT_VERSION 0x00000100 | |
526 | /* Create a bbt if none axists */ | |
527 | #define NAND_BBT_CREATE 0x00000200 | |
528 | /* Search good / bad pattern through all pages of a block */ | |
529 | #define NAND_BBT_SCANALLPAGES 0x00000400 | |
530 | /* Scan block empty during good / bad block scan */ | |
531 | #define NAND_BBT_SCANEMPTY 0x00000800 | |
532 | /* Write bbt if neccecary */ | |
533 | #define NAND_BBT_WRITE 0x00001000 | |
534 | /* Read and write back block contents when writing bbt */ | |
535 | #define NAND_BBT_SAVECONTENT 0x00002000 | |
536 | /* Search good / bad pattern on the first and the second page */ | |
537 | #define NAND_BBT_SCAN2NDPAGE 0x00004000 | |
538 | ||
539 | /* The maximum number of blocks to scan for a bbt */ | |
540 | #define NAND_BBT_SCAN_MAXBLOCKS 4 | |
541 | ||
f5bbdacc TG |
542 | extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd); |
543 | extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs); | |
544 | extern int nand_default_bbt(struct mtd_info *mtd); | |
545 | extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt); | |
546 | extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr, | |
547 | int allowbbt); | |
548 | extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len, | |
549 | size_t * retlen, uint8_t * buf); | |
1da177e4 LT |
550 | |
551 | /* | |
552 | * Constants for oob configuration | |
553 | */ | |
554 | #define NAND_SMALL_BADBLOCK_POS 5 | |
555 | #define NAND_LARGE_BADBLOCK_POS 0 | |
556 | ||
41796c2e TG |
557 | /** |
558 | * struct platform_nand_chip - chip level device structure | |
41796c2e | 559 | * @nr_chips: max. number of chips to scan for |
844d3b42 | 560 | * @chip_offset: chip number offset |
8be834f7 | 561 | * @nr_partitions: number of partitions pointed to by partitions (or zero) |
41796c2e TG |
562 | * @partitions: mtd partition list |
563 | * @chip_delay: R/B delay value in us | |
564 | * @options: Option flags, e.g. 16bit buswidth | |
5bd34c09 | 565 | * @ecclayout: ecc layout info structure |
972edcb7 | 566 | * @part_probe_types: NULL-terminated array of probe types |
f36e20c0 | 567 | * @set_parts: platform specific function to set partitions |
41796c2e TG |
568 | * @priv: hardware controller specific settings |
569 | */ | |
570 | struct platform_nand_chip { | |
571 | int nr_chips; | |
572 | int chip_offset; | |
573 | int nr_partitions; | |
574 | struct mtd_partition *partitions; | |
5bd34c09 | 575 | struct nand_ecclayout *ecclayout; |
2c0a2bed | 576 | int chip_delay; |
41796c2e | 577 | unsigned int options; |
972edcb7 | 578 | const char **part_probe_types; |
f36e20c0 HS |
579 | void (*set_parts)(uint64_t size, |
580 | struct platform_nand_chip *chip); | |
41796c2e TG |
581 | void *priv; |
582 | }; | |
583 | ||
bf95efd4 HS |
584 | /* Keep gcc happy */ |
585 | struct platform_device; | |
586 | ||
41796c2e TG |
587 | /** |
588 | * struct platform_nand_ctrl - controller level device structure | |
bf95efd4 HS |
589 | * @probe: platform specific function to probe/setup hardware |
590 | * @remove: platform specific function to remove/teardown hardware | |
41796c2e TG |
591 | * @hwcontrol: platform specific hardware control structure |
592 | * @dev_ready: platform specific function to read ready/busy pin | |
593 | * @select_chip: platform specific chip select function | |
972edcb7 VW |
594 | * @cmd_ctrl: platform specific function for controlling |
595 | * ALE/CLE/nCE. Also used to write command and address | |
d6fed9e9 AC |
596 | * @write_buf: platform specific function for write buffer |
597 | * @read_buf: platform specific function for read buffer | |
844d3b42 | 598 | * @priv: private data to transport driver specific settings |
41796c2e TG |
599 | * |
600 | * All fields are optional and depend on the hardware driver requirements | |
601 | */ | |
602 | struct platform_nand_ctrl { | |
bf95efd4 HS |
603 | int (*probe)(struct platform_device *pdev); |
604 | void (*remove)(struct platform_device *pdev); | |
2c0a2bed TG |
605 | void (*hwcontrol)(struct mtd_info *mtd, int cmd); |
606 | int (*dev_ready)(struct mtd_info *mtd); | |
41796c2e | 607 | void (*select_chip)(struct mtd_info *mtd, int chip); |
972edcb7 VW |
608 | void (*cmd_ctrl)(struct mtd_info *mtd, int dat, |
609 | unsigned int ctrl); | |
d6fed9e9 AC |
610 | void (*write_buf)(struct mtd_info *mtd, |
611 | const uint8_t *buf, int len); | |
612 | void (*read_buf)(struct mtd_info *mtd, | |
613 | uint8_t *buf, int len); | |
41796c2e TG |
614 | void *priv; |
615 | }; | |
616 | ||
972edcb7 VW |
617 | /** |
618 | * struct platform_nand_data - container structure for platform-specific data | |
619 | * @chip: chip level chip structure | |
620 | * @ctrl: controller level device structure | |
621 | */ | |
622 | struct platform_nand_data { | |
623 | struct platform_nand_chip chip; | |
624 | struct platform_nand_ctrl ctrl; | |
625 | }; | |
626 | ||
41796c2e TG |
627 | /* Some helpers to access the data structures */ |
628 | static inline | |
629 | struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd) | |
630 | { | |
631 | struct nand_chip *chip = mtd->priv; | |
632 | ||
633 | return chip->priv; | |
634 | } | |
635 | ||
1da177e4 | 636 | #endif /* __LINUX_MTD_NAND_H */ |