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 | |
d062d4ed MD |
160 | /* |
161 | * read ops return -EUCLEAN if max number of bitflips corrected on any | |
162 | * one region comprising an ecc step equals or exceeds this value. | |
163 | * Settable by driver, else defaults to ecc_strength. User can override | |
164 | * in sysfs. N.B. The meaning of the -EUCLEAN return code has changed; | |
165 | * see Documentation/ABI/testing/sysfs-class-mtd for more detail. | |
166 | */ | |
167 | unsigned int bitflip_threshold; | |
168 | ||
1da177e4 | 169 | // Kernel-only stuff starts here. |
eadcf0d7 | 170 | const char *name; |
1da177e4 LT |
171 | int index; |
172 | ||
7854d3f7 | 173 | /* ECC layout structure pointer - read only! */ |
5bd34c09 | 174 | struct nand_ecclayout *ecclayout; |
1da177e4 | 175 | |
86c2072b | 176 | /* max number of correctible bit errors per ecc step */ |
1d0b95b0 MD |
177 | unsigned int ecc_strength; |
178 | ||
1da177e4 | 179 | /* Data for variable erase regions. If numeraseregions is zero, |
61ecfa87 | 180 | * it means that the whole device has erasesize as given above. |
1da177e4 LT |
181 | */ |
182 | int numeraseregions; | |
61ecfa87 | 183 | struct mtd_erase_region_info *eraseregions; |
1da177e4 | 184 | |
b38178ee | 185 | /* |
7e1f0dc0 AB |
186 | * Do not call via these pointers, use corresponding mtd_*() |
187 | * wrappers instead. | |
b38178ee | 188 | */ |
3c3c10bb AB |
189 | int (*_erase) (struct mtd_info *mtd, struct erase_info *instr); |
190 | int (*_point) (struct mtd_info *mtd, loff_t from, size_t len, | |
191 | size_t *retlen, void **virt, resource_size_t *phys); | |
5e4e6e3f | 192 | int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len); |
3c3c10bb AB |
193 | unsigned long (*_get_unmapped_area) (struct mtd_info *mtd, |
194 | unsigned long len, | |
195 | unsigned long offset, | |
196 | unsigned long flags); | |
197 | int (*_read) (struct mtd_info *mtd, loff_t from, size_t len, | |
198 | size_t *retlen, u_char *buf); | |
199 | int (*_write) (struct mtd_info *mtd, loff_t to, size_t len, | |
200 | size_t *retlen, const u_char *buf); | |
201 | int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len, | |
202 | size_t *retlen, const u_char *buf); | |
203 | int (*_read_oob) (struct mtd_info *mtd, loff_t from, | |
a2cc5ba0 | 204 | struct mtd_oob_ops *ops); |
3c3c10bb AB |
205 | int (*_write_oob) (struct mtd_info *mtd, loff_t to, |
206 | struct mtd_oob_ops *ops); | |
207 | int (*_get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf, | |
208 | size_t len); | |
209 | int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from, | |
210 | size_t len, size_t *retlen, u_char *buf); | |
211 | int (*_get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf, | |
212 | size_t len); | |
213 | int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from, | |
214 | size_t len, size_t *retlen, u_char *buf); | |
215 | int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to, | |
216 | size_t len, size_t *retlen, u_char *buf); | |
217 | int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from, | |
218 | size_t len); | |
219 | int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs, | |
b0a31f7b | 220 | unsigned long count, loff_t to, size_t *retlen); |
3c3c10bb AB |
221 | void (*_sync) (struct mtd_info *mtd); |
222 | int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
223 | int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
224 | int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
225 | int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs); | |
226 | int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs); | |
227 | int (*_suspend) (struct mtd_info *mtd); | |
228 | void (*_resume) (struct mtd_info *mtd); | |
a88d2dc6 AB |
229 | /* |
230 | * If the driver is something smart, like UBI, it may need to maintain | |
231 | * its own reference counting. The below functions are only for driver. | |
232 | */ | |
3c3c10bb AB |
233 | int (*_get_device) (struct mtd_info *mtd); |
234 | void (*_put_device) (struct mtd_info *mtd); | |
402d3265 DH |
235 | |
236 | /* Backing device capabilities for this device | |
237 | * - provides mmap capabilities | |
238 | */ | |
239 | struct backing_dev_info *backing_dev_info; | |
240 | ||
963a6fb0 NP |
241 | struct notifier_block reboot_notifier; /* default mode before reboot */ |
242 | ||
7fac4648 TG |
243 | /* ECC status information */ |
244 | struct mtd_ecc_stats ecc_stats; | |
29072b96 TG |
245 | /* Subpage shift (NAND) */ |
246 | int subpage_sft; | |
7fac4648 | 247 | |
1da177e4 LT |
248 | void *priv; |
249 | ||
250 | struct module *owner; | |
1f24b5a8 | 251 | struct device dev; |
1da177e4 LT |
252 | int usecount; |
253 | }; | |
254 | ||
8273a0c9 AB |
255 | int mtd_erase(struct mtd_info *mtd, struct erase_info *instr); |
256 | int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
257 | void **virt, resource_size_t *phys); | |
258 | int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len); | |
259 | unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len, | |
260 | unsigned long offset, unsigned long flags); | |
261 | int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
262 | u_char *buf); | |
263 | int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
264 | const u_char *buf); | |
265 | int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
266 | const u_char *buf); | |
7ae79d7f | 267 | |
fd2819bb AB |
268 | static inline int mtd_read_oob(struct mtd_info *mtd, loff_t from, |
269 | struct mtd_oob_ops *ops) | |
270 | { | |
9cf075f8 | 271 | ops->retlen = ops->oobretlen = 0; |
3c3c10bb | 272 | if (!mtd->_read_oob) |
dac2639f | 273 | return -EOPNOTSUPP; |
3c3c10bb | 274 | return mtd->_read_oob(mtd, from, ops); |
fd2819bb AB |
275 | } |
276 | ||
a2cc5ba0 AB |
277 | static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to, |
278 | struct mtd_oob_ops *ops) | |
279 | { | |
9cf075f8 | 280 | ops->retlen = ops->oobretlen = 0; |
3c3c10bb | 281 | if (!mtd->_write_oob) |
dac2639f | 282 | return -EOPNOTSUPP; |
664addc2 AB |
283 | if (!(mtd->flags & MTD_WRITEABLE)) |
284 | return -EROFS; | |
3c3c10bb | 285 | return mtd->_write_oob(mtd, to, ops); |
a2cc5ba0 AB |
286 | } |
287 | ||
de3cac93 AB |
288 | int mtd_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf, |
289 | size_t len); | |
290 | int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
291 | size_t *retlen, u_char *buf); | |
292 | int mtd_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf, | |
293 | size_t len); | |
294 | int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
295 | size_t *retlen, u_char *buf); | |
296 | int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, | |
297 | size_t *retlen, u_char *buf); | |
298 | int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len); | |
4403dbfb | 299 | |
1dbebd32 AB |
300 | int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, |
301 | unsigned long count, loff_t to, size_t *retlen); | |
b0a31f7b | 302 | |
85f2f2a8 AB |
303 | static inline void mtd_sync(struct mtd_info *mtd) |
304 | { | |
3c3c10bb AB |
305 | if (mtd->_sync) |
306 | mtd->_sync(mtd); | |
85f2f2a8 AB |
307 | } |
308 | ||
8273a0c9 AB |
309 | int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len); |
310 | int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
311 | int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len); | |
312 | int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs); | |
313 | int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs); | |
e95e9786 | 314 | |
3fe4bae8 AB |
315 | static inline int mtd_suspend(struct mtd_info *mtd) |
316 | { | |
3c3c10bb | 317 | return mtd->_suspend ? mtd->_suspend(mtd) : 0; |
3fe4bae8 AB |
318 | } |
319 | ||
ead995f8 AB |
320 | static inline void mtd_resume(struct mtd_info *mtd) |
321 | { | |
3c3c10bb AB |
322 | if (mtd->_resume) |
323 | mtd->_resume(mtd); | |
ead995f8 AB |
324 | } |
325 | ||
26cdb67c | 326 | static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
327 | { |
328 | if (mtd->erasesize_shift) | |
329 | return sz >> mtd->erasesize_shift; | |
330 | do_div(sz, mtd->erasesize); | |
331 | return sz; | |
332 | } | |
333 | ||
26cdb67c | 334 | static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
335 | { |
336 | if (mtd->erasesize_shift) | |
337 | return sz & mtd->erasesize_mask; | |
338 | return do_div(sz, mtd->erasesize); | |
339 | } | |
340 | ||
26cdb67c | 341 | static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
342 | { |
343 | if (mtd->writesize_shift) | |
344 | return sz >> mtd->writesize_shift; | |
345 | do_div(sz, mtd->writesize); | |
346 | return sz; | |
347 | } | |
348 | ||
26cdb67c | 349 | static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd) |
69423d99 AH |
350 | { |
351 | if (mtd->writesize_shift) | |
352 | return sz & mtd->writesize_mask; | |
353 | return do_div(sz, mtd->writesize); | |
354 | } | |
1da177e4 | 355 | |
fc002e3c AB |
356 | static inline int mtd_has_oob(const struct mtd_info *mtd) |
357 | { | |
3c3c10bb | 358 | return mtd->_read_oob && mtd->_write_oob; |
fc002e3c AB |
359 | } |
360 | ||
8f461a73 AB |
361 | static inline int mtd_can_have_bb(const struct mtd_info *mtd) |
362 | { | |
3c3c10bb | 363 | return !!mtd->_block_isbad; |
8f461a73 AB |
364 | } |
365 | ||
1da177e4 LT |
366 | /* Kernel-side ioctl definitions */ |
367 | ||
f5671ab3 | 368 | struct mtd_partition; |
c7975330 | 369 | struct mtd_part_parser_data; |
f5671ab3 | 370 | |
1c4c215c DES |
371 | extern int mtd_device_parse_register(struct mtd_info *mtd, |
372 | const char **part_probe_types, | |
c7975330 | 373 | struct mtd_part_parser_data *parser_data, |
1c4c215c DES |
374 | const struct mtd_partition *defparts, |
375 | int defnr_parts); | |
15c60a50 DES |
376 | #define mtd_device_register(master, parts, nr_parts) \ |
377 | mtd_device_parse_register(master, NULL, NULL, parts, nr_parts) | |
f5671ab3 | 378 | extern int mtd_device_unregister(struct mtd_info *master); |
1da177e4 | 379 | extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num); |
3bd45657 ML |
380 | extern int __get_mtd_device(struct mtd_info *mtd); |
381 | extern void __put_mtd_device(struct mtd_info *mtd); | |
7799308f | 382 | extern struct mtd_info *get_mtd_device_nm(const char *name); |
1da177e4 LT |
383 | extern void put_mtd_device(struct mtd_info *mtd); |
384 | ||
385 | ||
386 | struct mtd_notifier { | |
387 | void (*add)(struct mtd_info *mtd); | |
388 | void (*remove)(struct mtd_info *mtd); | |
389 | struct list_head list; | |
390 | }; | |
391 | ||
392 | ||
393 | extern void register_mtd_user (struct mtd_notifier *new); | |
394 | extern int unregister_mtd_user (struct mtd_notifier *old); | |
33b53716 GE |
395 | void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size); |
396 | ||
1da177e4 | 397 | void mtd_erase_callback(struct erase_info *instr); |
1da177e4 | 398 | |
7387ce77 BN |
399 | static inline int mtd_is_bitflip(int err) { |
400 | return err == -EUCLEAN; | |
401 | } | |
402 | ||
403 | static inline int mtd_is_eccerr(int err) { | |
404 | return err == -EBADMSG; | |
405 | } | |
406 | ||
407 | static inline int mtd_is_bitflip_or_eccerr(int err) { | |
408 | return mtd_is_bitflip(err) || mtd_is_eccerr(err); | |
409 | } | |
1da177e4 LT |
410 | |
411 | #endif /* __MTD_MTD_H__ */ |