Commit | Line | Data |
---|---|---|
61ecfa87 | 1 | /* |
a1452a37 DW |
2 | * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> et al. |
3 | * | |
4 | * This program is free software; you can redistribute it and/or modify | |
5 | * it under the terms of the GNU General Public License as published by | |
6 | * the Free Software Foundation; either version 2 of the License, or | |
7 | * (at your option) any later version. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software | |
16 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
1da177e4 | 17 | * |
1da177e4 LT |
18 | */ |
19 | ||
20 | #ifndef __MTD_MTD_H__ | |
21 | #define __MTD_MTD_H__ | |
22 | ||
1da177e4 | 23 | #include <linux/types.h> |
1da177e4 | 24 | #include <linux/uio.h> |
963a6fb0 | 25 | #include <linux/notifier.h> |
1f24b5a8 | 26 | #include <linux/device.h> |
1da177e4 | 27 | |
1da177e4 LT |
28 | #include <mtd/mtd-abi.h> |
29 | ||
69423d99 AH |
30 | #include <asm/div64.h> |
31 | ||
1da177e4 LT |
32 | #define MTD_CHAR_MAJOR 90 |
33 | #define MTD_BLOCK_MAJOR 31 | |
1da177e4 | 34 | |
e2e24e8e | 35 | #define MTD_ERASE_PENDING 0x01 |
1da177e4 LT |
36 | #define MTD_ERASING 0x02 |
37 | #define MTD_ERASE_SUSPEND 0x04 | |
e2e24e8e BN |
38 | #define MTD_ERASE_DONE 0x08 |
39 | #define MTD_ERASE_FAILED 0x10 | |
1da177e4 | 40 | |
69423d99 | 41 | #define MTD_FAIL_ADDR_UNKNOWN -1LL |
bb0eb217 | 42 | |
e2e24e8e BN |
43 | /* |
44 | * If the erase fails, fail_addr might indicate exactly which block failed. If | |
45 | * fail_addr = MTD_FAIL_ADDR_UNKNOWN, the failure was not at the device level | |
46 | * or was not specific to any particular block. | |
47 | */ | |
1da177e4 LT |
48 | struct erase_info { |
49 | struct mtd_info *mtd; | |
69423d99 AH |
50 | uint64_t addr; |
51 | uint64_t len; | |
52 | uint64_t fail_addr; | |
1da177e4 LT |
53 | u_long time; |
54 | u_long retries; | |
26cdb67c DW |
55 | unsigned dev; |
56 | unsigned cell; | |
1da177e4 LT |
57 | void (*callback) (struct erase_info *self); |
58 | u_long priv; | |
59 | u_char state; | |
60 | struct erase_info *next; | |
61 | }; | |
62 | ||
63 | struct mtd_erase_region_info { | |
e2e24e8e | 64 | uint64_t offset; /* At which this region starts, from the beginning of the MTD */ |
26cdb67c DW |
65 | uint32_t erasesize; /* For this region */ |
66 | uint32_t numblocks; /* Number of blocks of erasesize in this region */ | |
0ecbc81a | 67 | unsigned long *lockmap; /* If keeping bitmap of locks */ |
1da177e4 LT |
68 | }; |
69 | ||
8593fbc6 TG |
70 | /** |
71 | * struct mtd_oob_ops - oob operation operands | |
72 | * @mode: operation mode | |
73 | * | |
7014568b | 74 | * @len: number of data bytes to write/read |
8593fbc6 | 75 | * |
7014568b | 76 | * @retlen: number of data bytes written/read |
8593fbc6 | 77 | * |
7014568b VW |
78 | * @ooblen: number of oob bytes to write/read |
79 | * @oobretlen: number of oob bytes written/read | |
8593fbc6 | 80 | * @ooboffs: offset of oob data in the oob area (only relevant when |
4180f24a | 81 | * mode = MTD_OPS_PLACE_OOB or MTD_OPS_RAW) |
8593fbc6 TG |
82 | * @datbuf: data buffer - if NULL only oob data are read/written |
83 | * @oobbuf: oob data buffer | |
73a4421c | 84 | * |
025dfdaf | 85 | * Note, it is allowed to read more than one OOB area at one go, but not write. |
73a4421c AB |
86 | * The interface assumes that the OOB write requests program only one page's |
87 | * OOB area. | |
8593fbc6 TG |
88 | */ |
89 | struct mtd_oob_ops { | |
905c6bcd | 90 | unsigned int mode; |
8593fbc6 TG |
91 | size_t len; |
92 | size_t retlen; | |
93 | size_t ooblen; | |
7014568b | 94 | size_t oobretlen; |
8593fbc6 TG |
95 | uint32_t ooboffs; |
96 | uint8_t *datbuf; | |
97 | uint8_t *oobbuf; | |
98 | }; | |
99 | ||
cc26c3cd BN |
100 | #define MTD_MAX_OOBFREE_ENTRIES_LARGE 32 |
101 | #define MTD_MAX_ECCPOS_ENTRIES_LARGE 448 | |
cc26c3cd | 102 | /* |
0ceacf36 BN |
103 | * Internal ECC layout control structure. For historical reasons, there is a |
104 | * similar, smaller struct nand_ecclayout_user (in mtd-abi.h) that is retained | |
105 | * for export to user-space via the ECCGETLAYOUT ioctl. | |
106 | * nand_ecclayout should be expandable in the future simply by the above macros. | |
cc26c3cd BN |
107 | */ |
108 | struct nand_ecclayout { | |
109 | __u32 eccbytes; | |
110 | __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE]; | |
111 | __u32 oobavail; | |
112 | struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE]; | |
113 | }; | |
114 | ||
de477254 PG |
115 | struct module; /* only needed for owner field in mtd_info */ |
116 | ||
1da177e4 LT |
117 | struct mtd_info { |
118 | u_char type; | |
26cdb67c | 119 | uint32_t flags; |
69423d99 | 120 | uint64_t size; // Total size of the MTD |
1da177e4 | 121 | |
151e7659 | 122 | /* "Major" erase size for the device. Naïve users may take this |
1da177e4 LT |
123 | * to be the only erase size available, or may use the more detailed |
124 | * information below if they desire | |
125 | */ | |
26cdb67c | 126 | uint32_t erasesize; |
783ed81f AB |
127 | /* Minimal writable flash unit size. In case of NOR flash it is 1 (even |
128 | * though individual bits can be cleared), in case of NAND flash it is | |
129 | * one NAND page (or half, or one-fourths of it), in case of ECC-ed NOR | |
130 | * it is of ECC block size, etc. It is illegal to have writesize = 0. | |
131 | * Any driver registering a struct mtd_info must ensure a writesize of | |
132 | * 1 or larger. | |
28318776 | 133 | */ |
26cdb67c | 134 | uint32_t writesize; |
1da177e4 | 135 | |
0e4ca7e5 AG |
136 | /* |
137 | * Size of the write buffer used by the MTD. MTD devices having a write | |
138 | * buffer can write multiple writesize chunks at a time. E.g. while | |
139 | * writing 4 * writesize bytes to a device with 2 * writesize bytes | |
140 | * buffer the MTD driver can (but doesn't have to) do 2 writesize | |
141 | * operations, but not 4. Currently, all NANDs have writebufsize | |
142 | * equivalent to writesize (NAND page size). Some NOR flashes do have | |
143 | * writebufsize greater than writesize. | |
144 | */ | |
145 | uint32_t writebufsize; | |
146 | ||
26cdb67c DW |
147 | uint32_t oobsize; // Amount of OOB data per block (e.g. 16) |
148 | uint32_t oobavail; // Available OOB bytes per block | |
1da177e4 | 149 | |
69423d99 AH |
150 | /* |
151 | * If erasesize is a power of 2 then the shift is stored in | |
152 | * erasesize_shift otherwise erasesize_shift is zero. Ditto writesize. | |
153 | */ | |
154 | unsigned int erasesize_shift; | |
155 | unsigned int writesize_shift; | |
156 | /* Masks based on erasesize_shift and writesize_shift */ | |
157 | unsigned int erasesize_mask; | |
158 | unsigned int writesize_mask; | |
638d9838 | 159 | |
1da177e4 | 160 | // Kernel-only stuff starts here. |
eadcf0d7 | 161 | const char *name; |
1da177e4 LT |
162 | int index; |
163 | ||
7854d3f7 | 164 | /* ECC layout structure pointer - read only! */ |
5bd34c09 | 165 | struct nand_ecclayout *ecclayout; |
1da177e4 LT |
166 | |
167 | /* Data for variable erase regions. If numeraseregions is zero, | |
61ecfa87 | 168 | * it means that the whole device has erasesize as given above. |
1da177e4 LT |
169 | */ |
170 | int numeraseregions; | |
61ecfa87 | 171 | struct mtd_erase_region_info *eraseregions; |
1da177e4 | 172 | |
b38178ee | 173 | /* |
7e1f0dc0 AB |
174 | * Do not call via these pointers, use corresponding mtd_*() |
175 | * wrappers instead. | |
b38178ee | 176 | */ |
1da177e4 | 177 | int (*erase) (struct mtd_info *mtd, struct erase_info *instr); |
a98889f3 | 178 | int (*point) (struct mtd_info *mtd, loff_t from, size_t len, |
d35ea200 | 179 | size_t *retlen, void **virt, resource_size_t *phys); |
a98889f3 | 180 | void (*unpoint) (struct mtd_info *mtd, loff_t from, size_t len); |
402d3265 DH |
181 | unsigned long (*get_unmapped_area) (struct mtd_info *mtd, |
182 | unsigned long len, | |
183 | unsigned long offset, | |
184 | unsigned long flags); | |
329ad399 AB |
185 | int (*read) (struct mtd_info *mtd, loff_t from, size_t len, |
186 | size_t *retlen, u_char *buf); | |
eda95cbf AB |
187 | int (*write) (struct mtd_info *mtd, loff_t to, size_t len, |
188 | size_t *retlen, const u_char *buf); | |
7ae79d7f AB |
189 | int (*panic_write) (struct mtd_info *mtd, loff_t to, size_t len, |
190 | size_t *retlen, const u_char *buf); | |
402d3265 DH |
191 | |
192 | /* Backing device capabilities for this device | |
193 | * - provides mmap capabilities | |
194 | */ | |
195 | struct backing_dev_info *backing_dev_info; | |
196 | ||
1da177e4 | 197 | |
8593fbc6 TG |
198 | int (*read_oob) (struct mtd_info *mtd, loff_t from, |
199 | struct mtd_oob_ops *ops); | |
200 | int (*write_oob) (struct mtd_info *mtd, loff_t to, | |
201 | struct mtd_oob_ops *ops); | |
1da177e4 | 202 | |
61ecfa87 TG |
203 | /* |
204 | * Methods to access the protection register area, present in some | |
1da177e4 | 205 | * flash devices. The user data is one time programmable but the |
61ecfa87 | 206 | * factory data is read only. |
1da177e4 | 207 | */ |
f77814dd | 208 | int (*get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
1da177e4 | 209 | int (*read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
f77814dd NP |
210 | int (*get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, size_t len); |
211 | int (*read_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); | |
1da177e4 | 212 | int (*write_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, u_char *buf); |
f77814dd | 213 | int (*lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, size_t len); |
1da177e4 | 214 | |
2528e8cd | 215 | /* kvec-based read/write methods. |
61ecfa87 | 216 | NB: The 'count' parameter is the number of _vectors_, each of |
1da177e4 LT |
217 | which contains an (ofs, len) tuple. |
218 | */ | |
1da177e4 | 219 | int (*writev) (struct mtd_info *mtd, const struct kvec *vecs, unsigned long count, loff_t to, size_t *retlen); |
1da177e4 LT |
220 | |
221 | /* Sync */ | |
222 | void (*sync) (struct mtd_info *mtd); | |
223 | ||
224 | /* Chip-supported device locking */ | |
69423d99 AH |
225 | int (*lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); |
226 | int (*unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
9938424f | 227 | int (*is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len); |
1da177e4 LT |
228 | |
229 | /* Power Management functions */ | |
230 | int (*suspend) (struct mtd_info *mtd); | |
231 | void (*resume) (struct mtd_info *mtd); | |
232 | ||
233 | /* Bad block management functions */ | |
234 | int (*block_isbad) (struct mtd_info *mtd, loff_t ofs); | |
235 | int (*block_markbad) (struct mtd_info *mtd, loff_t ofs); | |
236 | ||
963a6fb0 NP |
237 | struct notifier_block reboot_notifier; /* default mode before reboot */ |
238 | ||
7fac4648 TG |
239 | /* ECC status information */ |
240 | struct mtd_ecc_stats ecc_stats; | |
29072b96 TG |
241 | /* Subpage shift (NAND) */ |
242 | int subpage_sft; | |
7fac4648 | 243 | |
1da177e4 LT |
244 | void *priv; |
245 | ||
246 | struct module *owner; | |
1f24b5a8 | 247 | struct device dev; |
1da177e4 | 248 | int usecount; |
9fe912ce AB |
249 | |
250 | /* If the driver is something smart, like UBI, it may need to maintain | |
251 | * its own reference counting. The below functions are only for driver. | |
252 | * The driver may register its callbacks. These callbacks are not | |
253 | * supposed to be called by MTD users */ | |
254 | int (*get_device) (struct mtd_info *mtd); | |
255 | void (*put_device) (struct mtd_info *mtd); | |
1da177e4 LT |
256 | }; |
257 | ||
7e1f0dc0 AB |
258 | /* |
259 | * Erase is an asynchronous operation. Device drivers are supposed | |
260 | * to call instr->callback() whenever the operation completes, even | |
261 | * if it completes with a failure. | |
262 | * Callers are supposed to pass a callback function and wait for it | |
263 | * to be called before writing to the block. | |
264 | */ | |
265 | static inline int mtd_erase(struct mtd_info *mtd, struct erase_info *instr) | |
266 | { | |
267 | return mtd->erase(mtd, instr); | |
268 | } | |
269 | ||
d35ea200 AB |
270 | /* |
271 | * This stuff for eXecute-In-Place. phys is optional and may be set to NULL. | |
272 | */ | |
273 | static inline int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, | |
274 | size_t *retlen, void **virt, resource_size_t *phys) | |
275 | { | |
276 | return mtd->point(mtd, from, len, retlen, virt, phys); | |
277 | } | |
278 | ||
7219778a AB |
279 | /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ |
280 | static inline void mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len) | |
281 | { | |
282 | return mtd->unpoint(mtd, from, len); | |
283 | } | |
284 | ||
04c601bf AB |
285 | /* |
286 | * Allow NOMMU mmap() to directly map the device (if not NULL) | |
287 | * - return the address to which the offset maps | |
288 | * - return -ENOSYS to indicate refusal to do the mapping | |
289 | */ | |
290 | static inline unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, | |
291 | unsigned long len, | |
292 | unsigned long offset, | |
293 | unsigned long flags) | |
294 | { | |
295 | return mtd->get_unmapped_area(mtd, len, offset, flags); | |
296 | } | |
297 | ||
329ad399 AB |
298 | static inline int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, |
299 | size_t *retlen, u_char *buf) | |
300 | { | |
301 | return mtd->read(mtd, from, len, retlen, buf); | |
302 | } | |
303 | ||
eda95cbf AB |
304 | static inline int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, |
305 | size_t *retlen, const u_char *buf) | |
306 | { | |
307 | return mtd->write(mtd, to, len, retlen, buf); | |
308 | } | |
309 | ||
7ae79d7f AB |
310 | /* |
311 | * In blackbox flight recorder like scenarios we want to make successful writes | |
312 | * in interrupt context. panic_write() is only intended to be called when its | |
313 | * known the kernel is about to panic and we need the write to succeed. Since | |
314 | * the kernel is not going to be running for much longer, this function can | |
315 | * break locks and delay to ensure the write succeeds (but not sleep). | |
316 | */ | |
317 | static inline int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, | |
318 | size_t *retlen, const u_char *buf) | |
319 | { | |
320 | return mtd->panic_write(mtd, to, len, retlen, buf); | |
321 | } | |
322 | ||
1f24b5a8 DB |
323 | static inline struct mtd_info *dev_to_mtd(struct device *dev) |
324 | { | |
6afc4fdb | 325 | return dev ? dev_get_drvdata(dev) : NULL; |
1f24b5a8 DB |
326 | } |
327 | ||
26cdb67c | 328 | static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
329 | { |
330 | if (mtd->erasesize_shift) | |
331 | return sz >> mtd->erasesize_shift; | |
332 | do_div(sz, mtd->erasesize); | |
333 | return sz; | |
334 | } | |
335 | ||
26cdb67c | 336 | static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
337 | { |
338 | if (mtd->erasesize_shift) | |
339 | return sz & mtd->erasesize_mask; | |
340 | return do_div(sz, mtd->erasesize); | |
341 | } | |
342 | ||
26cdb67c | 343 | static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
344 | { |
345 | if (mtd->writesize_shift) | |
346 | return sz >> mtd->writesize_shift; | |
347 | do_div(sz, mtd->writesize); | |
348 | return sz; | |
349 | } | |
350 | ||
26cdb67c | 351 | static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
352 | { |
353 | if (mtd->writesize_shift) | |
354 | return sz & mtd->writesize_mask; | |
355 | return do_div(sz, mtd->writesize); | |
356 | } | |
1da177e4 LT |
357 | |
358 | /* Kernel-side ioctl definitions */ | |
359 | ||
f5671ab3 | 360 | struct mtd_partition; |
c7975330 | 361 | struct mtd_part_parser_data; |
f5671ab3 | 362 | |
1c4c215c DES |
363 | extern int mtd_device_parse_register(struct mtd_info *mtd, |
364 | const char **part_probe_types, | |
c7975330 | 365 | struct mtd_part_parser_data *parser_data, |
1c4c215c DES |
366 | const struct mtd_partition *defparts, |
367 | int defnr_parts); | |
15c60a50 DES |
368 | #define mtd_device_register(master, parts, nr_parts) \ |
369 | mtd_device_parse_register(master, NULL, NULL, parts, nr_parts) | |
f5671ab3 | 370 | extern int mtd_device_unregister(struct mtd_info *master); |
1da177e4 | 371 | extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); |
3bd45657 ML |
372 | extern int __get_mtd_device(struct mtd_info *mtd); |
373 | extern void __put_mtd_device(struct mtd_info *mtd); | |
7799308f | 374 | extern struct mtd_info *get_mtd_device_nm(const char *name); |
1da177e4 LT |
375 | extern void put_mtd_device(struct mtd_info *mtd); |
376 | ||
377 | ||
378 | struct mtd_notifier { | |
379 | void (*add)(struct mtd_info *mtd); | |
380 | void (*remove)(struct mtd_info *mtd); | |
381 | struct list_head list; | |
382 | }; | |
383 | ||
384 | ||
385 | extern void register_mtd_user (struct mtd_notifier *new); | |
386 | extern int unregister_mtd_user (struct mtd_notifier *old); | |
387 | ||
388 | int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, | |
389 | unsigned long count, loff_t to, size_t *retlen); | |
390 | ||
391 | int default_mtd_readv(struct mtd_info *mtd, struct kvec *vecs, | |
392 | unsigned long count, loff_t from, size_t *retlen); | |
393 | ||
33b53716 GE |
394 | void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size); |
395 | ||
1da177e4 | 396 | void mtd_erase_callback(struct erase_info *instr); |
1da177e4 | 397 | |
7387ce77 BN |
398 | static inline int mtd_is_bitflip(int err) { |
399 | return err == -EUCLEAN; | |
400 | } | |
401 | ||
402 | static inline int mtd_is_eccerr(int err) { | |
403 | return err == -EBADMSG; | |
404 | } | |
405 | ||
406 | static inline int mtd_is_bitflip_or_eccerr(int err) { | |
407 | return mtd_is_bitflip(err) || mtd_is_eccerr(err); | |
408 | } | |
1da177e4 LT |
409 | |
410 | #endif /* __MTD_MTD_H__ */ |