]>
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> | |
30631cb8 | 24 | #include <linux/mtd/flashchip.h> |
c62d81bc | 25 | #include <linux/mtd/bbm.h> |
1da177e4 LT |
26 | |
27 | struct mtd_info; | |
5e81e88a | 28 | struct nand_flash_dev; |
1da177e4 LT |
29 | /* Scan and identify a NAND device */ |
30 | extern int nand_scan (struct mtd_info *mtd, int max_chips); | |
3b85c321 DW |
31 | /* Separate phases of nand_scan(), allowing board driver to intervene |
32 | * and override command or ECC setup according to flash type */ | |
5e81e88a DW |
33 | extern int nand_scan_ident(struct mtd_info *mtd, int max_chips, |
34 | struct nand_flash_dev *table); | |
3b85c321 DW |
35 | extern int nand_scan_tail(struct mtd_info *mtd); |
36 | ||
1da177e4 LT |
37 | /* Free resources held by the NAND device */ |
38 | extern void nand_release (struct mtd_info *mtd); | |
39 | ||
b77d95c7 DW |
40 | /* Internal helper for board drivers which need to override command function */ |
41 | extern void nand_wait_ready(struct mtd_info *mtd); | |
42 | ||
7d70f334 VS |
43 | /* locks all blockes present in the device */ |
44 | extern int nand_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
45 | ||
46 | /* unlocks specified locked blockes */ | |
47 | extern int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
48 | ||
1da177e4 LT |
49 | /* The maximum number of NAND chips in an array */ |
50 | #define NAND_MAX_CHIPS 8 | |
51 | ||
52 | /* This constant declares the max. oobsize / page, which | |
53 | * is supported now. If you add a chip with bigger oobsize/page | |
54 | * adjust this accordingly. | |
55 | */ | |
81ec5364 TG |
56 | #define NAND_MAX_OOBSIZE 128 |
57 | #define NAND_MAX_PAGESIZE 4096 | |
1da177e4 LT |
58 | |
59 | /* | |
60 | * Constants for hardware specific CLE/ALE/NCE function | |
7abd3ef9 TG |
61 | * |
62 | * These are bits which can be or'ed to set/clear multiple | |
63 | * bits in one go. | |
64 | */ | |
1da177e4 | 65 | /* Select the chip by setting nCE to low */ |
7abd3ef9 | 66 | #define NAND_NCE 0x01 |
1da177e4 | 67 | /* Select the command latch by setting CLE to high */ |
7abd3ef9 | 68 | #define NAND_CLE 0x02 |
1da177e4 | 69 | /* Select the address latch by setting ALE to high */ |
7abd3ef9 TG |
70 | #define NAND_ALE 0x04 |
71 | ||
72 | #define NAND_CTRL_CLE (NAND_NCE | NAND_CLE) | |
73 | #define NAND_CTRL_ALE (NAND_NCE | NAND_ALE) | |
74 | #define NAND_CTRL_CHANGE 0x80 | |
1da177e4 LT |
75 | |
76 | /* | |
77 | * Standard NAND flash commands | |
78 | */ | |
79 | #define NAND_CMD_READ0 0 | |
80 | #define NAND_CMD_READ1 1 | |
7bc3312b | 81 | #define NAND_CMD_RNDOUT 5 |
1da177e4 LT |
82 | #define NAND_CMD_PAGEPROG 0x10 |
83 | #define NAND_CMD_READOOB 0x50 | |
84 | #define NAND_CMD_ERASE1 0x60 | |
85 | #define NAND_CMD_STATUS 0x70 | |
86 | #define NAND_CMD_STATUS_MULTI 0x71 | |
87 | #define NAND_CMD_SEQIN 0x80 | |
7bc3312b | 88 | #define NAND_CMD_RNDIN 0x85 |
1da177e4 LT |
89 | #define NAND_CMD_READID 0x90 |
90 | #define NAND_CMD_ERASE2 0xd0 | |
91 | #define NAND_CMD_RESET 0xff | |
92 | ||
7d70f334 VS |
93 | #define NAND_CMD_LOCK 0x2a |
94 | #define NAND_CMD_UNLOCK1 0x23 | |
95 | #define NAND_CMD_UNLOCK2 0x24 | |
96 | ||
1da177e4 LT |
97 | /* Extended commands for large page devices */ |
98 | #define NAND_CMD_READSTART 0x30 | |
7bc3312b | 99 | #define NAND_CMD_RNDOUTSTART 0xE0 |
1da177e4 LT |
100 | #define NAND_CMD_CACHEDPROG 0x15 |
101 | ||
28a48de7 | 102 | /* Extended commands for AG-AND device */ |
61ecfa87 TG |
103 | /* |
104 | * Note: the command for NAND_CMD_DEPLETE1 is really 0x00 but | |
28a48de7 DM |
105 | * there is no way to distinguish that from NAND_CMD_READ0 |
106 | * until the remaining sequence of commands has been completed | |
107 | * so add a high order bit and mask it off in the command. | |
108 | */ | |
109 | #define NAND_CMD_DEPLETE1 0x100 | |
110 | #define NAND_CMD_DEPLETE2 0x38 | |
111 | #define NAND_CMD_STATUS_MULTI 0x71 | |
112 | #define NAND_CMD_STATUS_ERROR 0x72 | |
113 | /* multi-bank error status (banks 0-3) */ | |
114 | #define NAND_CMD_STATUS_ERROR0 0x73 | |
115 | #define NAND_CMD_STATUS_ERROR1 0x74 | |
116 | #define NAND_CMD_STATUS_ERROR2 0x75 | |
117 | #define NAND_CMD_STATUS_ERROR3 0x76 | |
118 | #define NAND_CMD_STATUS_RESET 0x7f | |
119 | #define NAND_CMD_STATUS_CLEAR 0xff | |
120 | ||
7abd3ef9 TG |
121 | #define NAND_CMD_NONE -1 |
122 | ||
1da177e4 LT |
123 | /* Status bits */ |
124 | #define NAND_STATUS_FAIL 0x01 | |
125 | #define NAND_STATUS_FAIL_N1 0x02 | |
126 | #define NAND_STATUS_TRUE_READY 0x20 | |
127 | #define NAND_STATUS_READY 0x40 | |
128 | #define NAND_STATUS_WP 0x80 | |
129 | ||
61ecfa87 | 130 | /* |
1da177e4 LT |
131 | * Constants for ECC_MODES |
132 | */ | |
6dfc6d25 TG |
133 | typedef enum { |
134 | NAND_ECC_NONE, | |
135 | NAND_ECC_SOFT, | |
136 | NAND_ECC_HW, | |
137 | NAND_ECC_HW_SYNDROME, | |
6e0cb135 | 138 | NAND_ECC_HW_OOB_FIRST, |
6dfc6d25 | 139 | } nand_ecc_modes_t; |
1da177e4 LT |
140 | |
141 | /* | |
142 | * Constants for Hardware ECC | |
068e3c0a | 143 | */ |
1da177e4 LT |
144 | /* Reset Hardware ECC for read */ |
145 | #define NAND_ECC_READ 0 | |
146 | /* Reset Hardware ECC for write */ | |
147 | #define NAND_ECC_WRITE 1 | |
148 | /* Enable Hardware ECC before syndrom is read back from flash */ | |
149 | #define NAND_ECC_READSYN 2 | |
150 | ||
068e3c0a DM |
151 | /* Bit mask for flags passed to do_nand_read_ecc */ |
152 | #define NAND_GET_DEVICE 0x80 | |
153 | ||
154 | ||
1da177e4 LT |
155 | /* Option constants for bizarre disfunctionality and real |
156 | * features | |
157 | */ | |
158 | /* Chip can not auto increment pages */ | |
159 | #define NAND_NO_AUTOINCR 0x00000001 | |
160 | /* Buswitdh is 16 bit */ | |
161 | #define NAND_BUSWIDTH_16 0x00000002 | |
162 | /* Device supports partial programming without padding */ | |
163 | #define NAND_NO_PADDING 0x00000004 | |
164 | /* Chip has cache program function */ | |
165 | #define NAND_CACHEPRG 0x00000008 | |
166 | /* Chip has copy back function */ | |
167 | #define NAND_COPYBACK 0x00000010 | |
61ecfa87 | 168 | /* AND Chip which has 4 banks and a confusing page / block |
1da177e4 LT |
169 | * assignment. See Renesas datasheet for further information */ |
170 | #define NAND_IS_AND 0x00000020 | |
171 | /* Chip has a array of 4 pages which can be read without | |
172 | * additional ready /busy waits */ | |
61ecfa87 | 173 | #define NAND_4PAGE_ARRAY 0x00000040 |
28a48de7 DM |
174 | /* Chip requires that BBT is periodically rewritten to prevent |
175 | * bits from adjacent blocks from 'leaking' in altering data. | |
176 | * This happens with the Renesas AG-AND chips, possibly others. */ | |
177 | #define BBT_AUTO_REFRESH 0x00000080 | |
7a30601b TG |
178 | /* Chip does not require ready check on read. True |
179 | * for all large page devices, as they do not support | |
180 | * autoincrement.*/ | |
181 | #define NAND_NO_READRDY 0x00000100 | |
29072b96 TG |
182 | /* Chip does not allow subpage writes */ |
183 | #define NAND_NO_SUBPAGE_WRITE 0x00000200 | |
184 | ||
1da177e4 LT |
185 | /* Options valid for Samsung large page devices */ |
186 | #define NAND_SAMSUNG_LP_OPTIONS \ | |
187 | (NAND_NO_PADDING | NAND_CACHEPRG | NAND_COPYBACK) | |
188 | ||
189 | /* Macros to identify the above */ | |
190 | #define NAND_CANAUTOINCR(chip) (!(chip->options & NAND_NO_AUTOINCR)) | |
191 | #define NAND_MUST_PAD(chip) (!(chip->options & NAND_NO_PADDING)) | |
192 | #define NAND_HAS_CACHEPROG(chip) ((chip->options & NAND_CACHEPRG)) | |
193 | #define NAND_HAS_COPYBACK(chip) ((chip->options & NAND_COPYBACK)) | |
96d8b647 AK |
194 | /* Large page NAND with SOFT_ECC should support subpage reads */ |
195 | #define NAND_SUBPAGE_READ(chip) ((chip->ecc.mode == NAND_ECC_SOFT) \ | |
196 | && (chip->page_shift > 9)) | |
1da177e4 LT |
197 | |
198 | /* Mask to zero out the chip options, which come from the id table */ | |
199 | #define NAND_CHIPOPTIONS_MSK (0x0000ffff & ~NAND_NO_AUTOINCR) | |
200 | ||
201 | /* Non chip related options */ | |
202 | /* Use a flash based bad block table. This option is passed to the | |
203 | * default bad block table function. */ | |
204 | #define NAND_USE_FLASH_BBT 0x00010000 | |
0040bf38 | 205 | /* This option skips the bbt scan during initialization. */ |
f75e5097 | 206 | #define NAND_SKIP_BBTSCAN 0x00020000 |
4bf63fcb DW |
207 | /* This option is defined if the board driver allocates its own buffers |
208 | (e.g. because it needs them DMA-coherent */ | |
209 | #define NAND_OWN_BUFFERS 0x00040000 | |
b1c6e6db BD |
210 | /* Chip may not exist, so silence any errors in scan */ |
211 | #define NAND_SCAN_SILENT_NODEV 0x00080000 | |
212 | ||
1da177e4 | 213 | /* Options set by nand scan */ |
a36ed299 | 214 | /* Nand scan has allocated controller struct */ |
f75e5097 | 215 | #define NAND_CONTROLLER_ALLOC 0x80000000 |
1da177e4 | 216 | |
29072b96 TG |
217 | /* Cell info constants */ |
218 | #define NAND_CI_CHIPNR_MSK 0x03 | |
219 | #define NAND_CI_CELLTYPE_MSK 0x0C | |
1da177e4 | 220 | |
1da177e4 LT |
221 | /* Keep gcc happy */ |
222 | struct nand_chip; | |
223 | ||
224 | /** | |
844d3b42 | 225 | * struct nand_hw_control - Control structure for hardware controller (e.g ECC generator) shared among independent devices |
61ecfa87 | 226 | * @lock: protection lock |
1da177e4 | 227 | * @active: the mtd device which holds the controller currently |
0dfc6246 TG |
228 | * @wq: wait queue to sleep on if a NAND operation is in progress |
229 | * used instead of the per chip wait queue when a hw controller is available | |
1da177e4 LT |
230 | */ |
231 | struct nand_hw_control { | |
232 | spinlock_t lock; | |
233 | struct nand_chip *active; | |
0dfc6246 | 234 | wait_queue_head_t wq; |
1da177e4 LT |
235 | }; |
236 | ||
6dfc6d25 TG |
237 | /** |
238 | * struct nand_ecc_ctrl - Control structure for ecc | |
239 | * @mode: ecc mode | |
240 | * @steps: number of ecc steps per page | |
241 | * @size: data bytes per ecc step | |
242 | * @bytes: ecc bytes per step | |
9577f44a TG |
243 | * @total: total number of ecc bytes per page |
244 | * @prepad: padding information for syndrome based ecc generators | |
245 | * @postpad: padding information for syndrome based ecc generators | |
844d3b42 | 246 | * @layout: ECC layout control struct pointer |
6dfc6d25 TG |
247 | * @hwctl: function to control hardware ecc generator. Must only |
248 | * be provided if an hardware ECC is available | |
249 | * @calculate: function for ecc calculation or readback from ecc hardware | |
250 | * @correct: function for ecc correction, matching to ecc generator (sw/hw) | |
956e944c DW |
251 | * @read_page_raw: function to read a raw page without ECC |
252 | * @write_page_raw: function to write a raw page without ECC | |
f75e5097 | 253 | * @read_page: function to read a page according to the ecc generator requirements |
17c1d2be | 254 | * @read_subpage: function to read parts of the page covered by ECC. |
9577f44a | 255 | * @write_page: function to write a page according to the ecc generator requirements |
844d3b42 RD |
256 | * @read_oob: function to read chip OOB data |
257 | * @write_oob: function to write chip OOB data | |
6dfc6d25 TG |
258 | */ |
259 | struct nand_ecc_ctrl { | |
260 | nand_ecc_modes_t mode; | |
261 | int steps; | |
262 | int size; | |
263 | int bytes; | |
9577f44a TG |
264 | int total; |
265 | int prepad; | |
266 | int postpad; | |
5bd34c09 | 267 | struct nand_ecclayout *layout; |
9a57d470 | 268 | void (*hwctl)(struct mtd_info *mtd, int mode); |
6dfc6d25 TG |
269 | int (*calculate)(struct mtd_info *mtd, |
270 | const uint8_t *dat, | |
271 | uint8_t *ecc_code); | |
272 | int (*correct)(struct mtd_info *mtd, uint8_t *dat, | |
273 | uint8_t *read_ecc, | |
274 | uint8_t *calc_ecc); | |
956e944c DW |
275 | int (*read_page_raw)(struct mtd_info *mtd, |
276 | struct nand_chip *chip, | |
46a8cf2d | 277 | uint8_t *buf, int page); |
956e944c DW |
278 | void (*write_page_raw)(struct mtd_info *mtd, |
279 | struct nand_chip *chip, | |
280 | const uint8_t *buf); | |
9577f44a TG |
281 | int (*read_page)(struct mtd_info *mtd, |
282 | struct nand_chip *chip, | |
46a8cf2d | 283 | uint8_t *buf, int page); |
3d459559 AK |
284 | int (*read_subpage)(struct mtd_info *mtd, |
285 | struct nand_chip *chip, | |
286 | uint32_t offs, uint32_t len, | |
287 | uint8_t *buf); | |
f75e5097 | 288 | void (*write_page)(struct mtd_info *mtd, |
9577f44a | 289 | struct nand_chip *chip, |
f75e5097 | 290 | const uint8_t *buf); |
7bc3312b TG |
291 | int (*read_oob)(struct mtd_info *mtd, |
292 | struct nand_chip *chip, | |
293 | int page, | |
294 | int sndcmd); | |
295 | int (*write_oob)(struct mtd_info *mtd, | |
296 | struct nand_chip *chip, | |
297 | int page); | |
f75e5097 TG |
298 | }; |
299 | ||
300 | /** | |
301 | * struct nand_buffers - buffer structure for read/write | |
302 | * @ecccalc: buffer for calculated ecc | |
303 | * @ecccode: buffer for ecc read from flash | |
f75e5097 | 304 | * @databuf: buffer for data - dynamically sized |
f75e5097 TG |
305 | * |
306 | * Do not change the order of buffers. databuf and oobrbuf must be in | |
307 | * consecutive order. | |
308 | */ | |
309 | struct nand_buffers { | |
310 | uint8_t ecccalc[NAND_MAX_OOBSIZE]; | |
311 | uint8_t ecccode[NAND_MAX_OOBSIZE]; | |
7dcdcbef | 312 | uint8_t databuf[NAND_MAX_PAGESIZE + NAND_MAX_OOBSIZE]; |
6dfc6d25 TG |
313 | }; |
314 | ||
1da177e4 LT |
315 | /** |
316 | * struct nand_chip - NAND Private Flash Chip Data | |
61ecfa87 TG |
317 | * @IO_ADDR_R: [BOARDSPECIFIC] address to read the 8 I/O lines of the flash device |
318 | * @IO_ADDR_W: [BOARDSPECIFIC] address to write the 8 I/O lines of the flash device | |
1da177e4 | 319 | * @read_byte: [REPLACEABLE] read one byte from the chip |
1da177e4 | 320 | * @read_word: [REPLACEABLE] read one word from the chip |
1da177e4 LT |
321 | * @write_buf: [REPLACEABLE] write data from the buffer to the chip |
322 | * @read_buf: [REPLACEABLE] read data from the chip into the buffer | |
323 | * @verify_buf: [REPLACEABLE] verify buffer contents against the chip data | |
324 | * @select_chip: [REPLACEABLE] select chip nr | |
325 | * @block_bad: [REPLACEABLE] check, if the block is bad | |
326 | * @block_markbad: [REPLACEABLE] mark the block bad | |
7abd3ef9 TG |
327 | * @cmd_ctrl: [BOARDSPECIFIC] hardwarespecific funtion for controlling |
328 | * ALE/CLE/nCE. Also used to write command and address | |
1da177e4 LT |
329 | * @dev_ready: [BOARDSPECIFIC] hardwarespecific function for accesing device ready/busy line |
330 | * If set to NULL no access to ready/busy is available and the ready/busy information | |
331 | * is read from the chip status register | |
332 | * @cmdfunc: [REPLACEABLE] hardwarespecific function for writing commands to the chip | |
333 | * @waitfunc: [REPLACEABLE] hardwarespecific function for wait on ready | |
6dfc6d25 | 334 | * @ecc: [BOARDSPECIFIC] ecc control ctructure |
844d3b42 RD |
335 | * @buffers: buffer structure for read/write |
336 | * @hwcontrol: platform-specific hardware control structure | |
337 | * @ops: oob operation operands | |
1da177e4 LT |
338 | * @erase_cmd: [INTERN] erase command write function, selectable due to AND support |
339 | * @scan_bbt: [REPLACEABLE] function to scan bad block table | |
1da177e4 | 340 | * @chip_delay: [BOARDSPECIFIC] chip dependent delay for transfering data from array to read regs (tR) |
2c0a2bed | 341 | * @state: [INTERN] the current state of the NAND device |
844d3b42 | 342 | * @oob_poi: poison value buffer |
1da177e4 LT |
343 | * @page_shift: [INTERN] number of address bits in a page (column address bits) |
344 | * @phys_erase_shift: [INTERN] number of address bits in a physical eraseblock | |
345 | * @bbt_erase_shift: [INTERN] number of address bits in a bbt entry | |
346 | * @chip_shift: [INTERN] number of address bits in one chip | |
1da177e4 LT |
347 | * @options: [BOARDSPECIFIC] various chip options. They can partly be set to inform nand_scan about |
348 | * special functionality. See the defines for further explanation | |
349 | * @badblockpos: [INTERN] position of the bad block marker in the oob area | |
552a8278 | 350 | * @cellinfo: [INTERN] MLC/multichip data from chip ident |
1da177e4 LT |
351 | * @numchips: [INTERN] number of physical chips |
352 | * @chipsize: [INTERN] the size of one chip for multichip arrays | |
353 | * @pagemask: [INTERN] page number mask = number of (pages / chip) - 1 | |
354 | * @pagebuf: [INTERN] holds the pagenumber which is currently in data_buf | |
29072b96 | 355 | * @subpagesize: [INTERN] holds the subpagesize |
5bd34c09 | 356 | * @ecclayout: [REPLACEABLE] the default ecc placement scheme |
1da177e4 LT |
357 | * @bbt: [INTERN] bad block table pointer |
358 | * @bbt_td: [REPLACEABLE] bad block table descriptor for flash lookup | |
359 | * @bbt_md: [REPLACEABLE] bad block table mirror descriptor | |
61ecfa87 | 360 | * @badblock_pattern: [REPLACEABLE] bad block scan pattern used for initial bad block scan |
a36ed299 TG |
361 | * @controller: [REPLACEABLE] a pointer to a hardware controller structure |
362 | * which is shared among multiple independend devices | |
1da177e4 | 363 | * @priv: [OPTIONAL] pointer to private chip date |
61ecfa87 | 364 | * @errstat: [OPTIONAL] hardware specific function to perform additional error status checks |
068e3c0a | 365 | * (determine if errors are correctable) |
351edd24 | 366 | * @write_page: [REPLACEABLE] High-level page write function |
1da177e4 | 367 | */ |
61ecfa87 | 368 | |
1da177e4 LT |
369 | struct nand_chip { |
370 | void __iomem *IO_ADDR_R; | |
2c0a2bed | 371 | void __iomem *IO_ADDR_W; |
61ecfa87 | 372 | |
58dd8f2b | 373 | uint8_t (*read_byte)(struct mtd_info *mtd); |
1da177e4 | 374 | u16 (*read_word)(struct mtd_info *mtd); |
58dd8f2b TG |
375 | void (*write_buf)(struct mtd_info *mtd, const uint8_t *buf, int len); |
376 | void (*read_buf)(struct mtd_info *mtd, uint8_t *buf, int len); | |
377 | int (*verify_buf)(struct mtd_info *mtd, const uint8_t *buf, int len); | |
1da177e4 LT |
378 | void (*select_chip)(struct mtd_info *mtd, int chip); |
379 | int (*block_bad)(struct mtd_info *mtd, loff_t ofs, int getchip); | |
380 | int (*block_markbad)(struct mtd_info *mtd, loff_t ofs); | |
7abd3ef9 TG |
381 | void (*cmd_ctrl)(struct mtd_info *mtd, int dat, |
382 | unsigned int ctrl); | |
2c0a2bed TG |
383 | int (*dev_ready)(struct mtd_info *mtd); |
384 | void (*cmdfunc)(struct mtd_info *mtd, unsigned command, int column, int page_addr); | |
7bc3312b | 385 | int (*waitfunc)(struct mtd_info *mtd, struct nand_chip *this); |
1da177e4 LT |
386 | void (*erase_cmd)(struct mtd_info *mtd, int page); |
387 | int (*scan_bbt)(struct mtd_info *mtd); | |
f75e5097 | 388 | int (*errstat)(struct mtd_info *mtd, struct nand_chip *this, int state, int status, int page); |
956e944c DW |
389 | int (*write_page)(struct mtd_info *mtd, struct nand_chip *chip, |
390 | const uint8_t *buf, int page, int cached, int raw); | |
f75e5097 | 391 | |
2c0a2bed | 392 | int chip_delay; |
f75e5097 TG |
393 | unsigned int options; |
394 | ||
2c0a2bed | 395 | int page_shift; |
1da177e4 LT |
396 | int phys_erase_shift; |
397 | int bbt_erase_shift; | |
398 | int chip_shift; | |
1da177e4 | 399 | int numchips; |
69423d99 | 400 | uint64_t chipsize; |
1da177e4 LT |
401 | int pagemask; |
402 | int pagebuf; | |
29072b96 TG |
403 | int subpagesize; |
404 | uint8_t cellinfo; | |
f75e5097 | 405 | int badblockpos; |
e0b58d0a | 406 | int badblockbits; |
f75e5097 | 407 | |
30631cb8 | 408 | flstate_t state; |
f75e5097 TG |
409 | |
410 | uint8_t *oob_poi; | |
411 | struct nand_hw_control *controller; | |
5bd34c09 | 412 | struct nand_ecclayout *ecclayout; |
f75e5097 TG |
413 | |
414 | struct nand_ecc_ctrl ecc; | |
4bf63fcb | 415 | struct nand_buffers *buffers; |
f75e5097 TG |
416 | struct nand_hw_control hwcontrol; |
417 | ||
8593fbc6 TG |
418 | struct mtd_oob_ops ops; |
419 | ||
1da177e4 LT |
420 | uint8_t *bbt; |
421 | struct nand_bbt_descr *bbt_td; | |
422 | struct nand_bbt_descr *bbt_md; | |
f75e5097 | 423 | |
1da177e4 | 424 | struct nand_bbt_descr *badblock_pattern; |
f75e5097 | 425 | |
1da177e4 LT |
426 | void *priv; |
427 | }; | |
428 | ||
429 | /* | |
430 | * NAND Flash Manufacturer ID Codes | |
431 | */ | |
432 | #define NAND_MFR_TOSHIBA 0x98 | |
433 | #define NAND_MFR_SAMSUNG 0xec | |
434 | #define NAND_MFR_FUJITSU 0x04 | |
435 | #define NAND_MFR_NATIONAL 0x8f | |
436 | #define NAND_MFR_RENESAS 0x07 | |
437 | #define NAND_MFR_STMICRO 0x20 | |
2c0a2bed | 438 | #define NAND_MFR_HYNIX 0xad |
8c60e547 | 439 | #define NAND_MFR_MICRON 0x2c |
30eb0db0 | 440 | #define NAND_MFR_AMD 0x01 |
1da177e4 LT |
441 | |
442 | /** | |
443 | * struct nand_flash_dev - NAND Flash Device ID Structure | |
2c0a2bed TG |
444 | * @name: Identify the device type |
445 | * @id: device ID code | |
446 | * @pagesize: Pagesize in bytes. Either 256 or 512 or 0 | |
61ecfa87 | 447 | * If the pagesize is 0, then the real pagesize |
1da177e4 LT |
448 | * and the eraseize are determined from the |
449 | * extended id bytes in the chip | |
2c0a2bed TG |
450 | * @erasesize: Size of an erase block in the flash device. |
451 | * @chipsize: Total chipsize in Mega Bytes | |
1da177e4 LT |
452 | * @options: Bitfield to store chip relevant options |
453 | */ | |
454 | struct nand_flash_dev { | |
455 | char *name; | |
456 | int id; | |
457 | unsigned long pagesize; | |
458 | unsigned long chipsize; | |
459 | unsigned long erasesize; | |
460 | unsigned long options; | |
461 | }; | |
462 | ||
463 | /** | |
464 | * struct nand_manufacturers - NAND Flash Manufacturer ID Structure | |
465 | * @name: Manufacturer name | |
2c0a2bed | 466 | * @id: manufacturer ID code of device. |
1da177e4 LT |
467 | */ |
468 | struct nand_manufacturers { | |
469 | int id; | |
470 | char * name; | |
471 | }; | |
472 | ||
473 | extern struct nand_flash_dev nand_flash_ids[]; | |
474 | extern struct nand_manufacturers nand_manuf_ids[]; | |
475 | ||
f5bbdacc TG |
476 | extern int nand_scan_bbt(struct mtd_info *mtd, struct nand_bbt_descr *bd); |
477 | extern int nand_update_bbt(struct mtd_info *mtd, loff_t offs); | |
478 | extern int nand_default_bbt(struct mtd_info *mtd); | |
479 | extern int nand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt); | |
480 | extern int nand_erase_nand(struct mtd_info *mtd, struct erase_info *instr, | |
481 | int allowbbt); | |
482 | extern int nand_do_read(struct mtd_info *mtd, loff_t from, size_t len, | |
483 | size_t * retlen, uint8_t * buf); | |
1da177e4 | 484 | |
41796c2e TG |
485 | /** |
486 | * struct platform_nand_chip - chip level device structure | |
41796c2e | 487 | * @nr_chips: max. number of chips to scan for |
844d3b42 | 488 | * @chip_offset: chip number offset |
8be834f7 | 489 | * @nr_partitions: number of partitions pointed to by partitions (or zero) |
41796c2e TG |
490 | * @partitions: mtd partition list |
491 | * @chip_delay: R/B delay value in us | |
492 | * @options: Option flags, e.g. 16bit buswidth | |
5bd34c09 | 493 | * @ecclayout: ecc layout info structure |
972edcb7 | 494 | * @part_probe_types: NULL-terminated array of probe types |
f36e20c0 | 495 | * @set_parts: platform specific function to set partitions |
41796c2e TG |
496 | * @priv: hardware controller specific settings |
497 | */ | |
498 | struct platform_nand_chip { | |
499 | int nr_chips; | |
500 | int chip_offset; | |
501 | int nr_partitions; | |
502 | struct mtd_partition *partitions; | |
5bd34c09 | 503 | struct nand_ecclayout *ecclayout; |
2c0a2bed | 504 | int chip_delay; |
41796c2e | 505 | unsigned int options; |
972edcb7 | 506 | const char **part_probe_types; |
f36e20c0 HS |
507 | void (*set_parts)(uint64_t size, |
508 | struct platform_nand_chip *chip); | |
41796c2e TG |
509 | void *priv; |
510 | }; | |
511 | ||
bf95efd4 HS |
512 | /* Keep gcc happy */ |
513 | struct platform_device; | |
514 | ||
41796c2e TG |
515 | /** |
516 | * struct platform_nand_ctrl - controller level device structure | |
bf95efd4 HS |
517 | * @probe: platform specific function to probe/setup hardware |
518 | * @remove: platform specific function to remove/teardown hardware | |
41796c2e TG |
519 | * @hwcontrol: platform specific hardware control structure |
520 | * @dev_ready: platform specific function to read ready/busy pin | |
521 | * @select_chip: platform specific chip select function | |
972edcb7 VW |
522 | * @cmd_ctrl: platform specific function for controlling |
523 | * ALE/CLE/nCE. Also used to write command and address | |
d6fed9e9 AC |
524 | * @write_buf: platform specific function for write buffer |
525 | * @read_buf: platform specific function for read buffer | |
844d3b42 | 526 | * @priv: private data to transport driver specific settings |
41796c2e TG |
527 | * |
528 | * All fields are optional and depend on the hardware driver requirements | |
529 | */ | |
530 | struct platform_nand_ctrl { | |
bf95efd4 HS |
531 | int (*probe)(struct platform_device *pdev); |
532 | void (*remove)(struct platform_device *pdev); | |
2c0a2bed TG |
533 | void (*hwcontrol)(struct mtd_info *mtd, int cmd); |
534 | int (*dev_ready)(struct mtd_info *mtd); | |
41796c2e | 535 | void (*select_chip)(struct mtd_info *mtd, int chip); |
972edcb7 VW |
536 | void (*cmd_ctrl)(struct mtd_info *mtd, int dat, |
537 | unsigned int ctrl); | |
d6fed9e9 AC |
538 | void (*write_buf)(struct mtd_info *mtd, |
539 | const uint8_t *buf, int len); | |
540 | void (*read_buf)(struct mtd_info *mtd, | |
541 | uint8_t *buf, int len); | |
41796c2e TG |
542 | void *priv; |
543 | }; | |
544 | ||
972edcb7 VW |
545 | /** |
546 | * struct platform_nand_data - container structure for platform-specific data | |
547 | * @chip: chip level chip structure | |
548 | * @ctrl: controller level device structure | |
549 | */ | |
550 | struct platform_nand_data { | |
551 | struct platform_nand_chip chip; | |
552 | struct platform_nand_ctrl ctrl; | |
553 | }; | |
554 | ||
41796c2e TG |
555 | /* Some helpers to access the data structures */ |
556 | static inline | |
557 | struct platform_nand_chip *get_platform_nandchip(struct mtd_info *mtd) | |
558 | { | |
559 | struct nand_chip *chip = mtd->priv; | |
560 | ||
561 | return chip->priv; | |
562 | } | |
563 | ||
1da177e4 | 564 | #endif /* __LINUX_MTD_NAND_H */ |