1
2
3
4
5
6
7
8#ifndef __MTD_MTD_H__
9#define __MTD_MTD_H__
10
11#ifndef __UBOOT__
12#include <linux/types.h>
13#include <linux/uio.h>
14#include <linux/notifier.h>
15#include <linux/device.h>
16
17#include <mtd/mtd-abi.h>
18
19#include <asm/div64.h>
20#else
21#include <linux/compat.h>
22#include <mtd/mtd-abi.h>
23#include <asm/errno.h>
24#include <div64.h>
25
26#define MAX_MTD_DEVICES 32
27#endif
28
29#define MTD_ERASE_PENDING 0x01
30#define MTD_ERASING 0x02
31#define MTD_ERASE_SUSPEND 0x04
32#define MTD_ERASE_DONE 0x08
33#define MTD_ERASE_FAILED 0x10
34
35#define MTD_FAIL_ADDR_UNKNOWN -1LL
36
37
38
39
40
41
42struct erase_info {
43 struct mtd_info *mtd;
44 uint64_t addr;
45 uint64_t len;
46 uint64_t fail_addr;
47 u_long time;
48 u_long retries;
49 unsigned dev;
50 unsigned cell;
51 void (*callback) (struct erase_info *self);
52 u_long priv;
53 u_char state;
54 struct erase_info *next;
55 int scrub;
56};
57
58struct mtd_erase_region_info {
59 uint64_t offset;
60 uint32_t erasesize;
61 uint32_t numblocks;
62 unsigned long *lockmap;
63};
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84struct mtd_oob_ops {
85 unsigned int mode;
86 size_t len;
87 size_t retlen;
88 size_t ooblen;
89 size_t oobretlen;
90 uint32_t ooboffs;
91 uint8_t *datbuf;
92 uint8_t *oobbuf;
93};
94
95#ifdef CONFIG_SYS_NAND_MAX_OOBFREE
96#define MTD_MAX_OOBFREE_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_OOBFREE
97#else
98#define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
99#endif
100
101#ifdef CONFIG_SYS_NAND_MAX_ECCPOS
102#define MTD_MAX_ECCPOS_ENTRIES_LARGE CONFIG_SYS_NAND_MAX_ECCPOS
103#else
104#define MTD_MAX_ECCPOS_ENTRIES_LARGE 680
105#endif
106
107
108
109
110
111
112
113struct nand_ecclayout {
114 __u32 eccbytes;
115 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
116 __u32 oobavail;
117 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
118};
119
120struct module;
121
122struct mtd_info {
123 u_char type;
124 uint32_t flags;
125 uint64_t size;
126
127
128
129
130
131 uint32_t erasesize;
132
133
134
135
136
137
138
139 uint32_t writesize;
140
141
142
143
144
145
146
147
148
149
150 uint32_t writebufsize;
151
152 uint32_t oobsize;
153 uint32_t oobavail;
154
155
156
157
158
159 unsigned int erasesize_shift;
160 unsigned int writesize_shift;
161
162 unsigned int erasesize_mask;
163 unsigned int writesize_mask;
164
165
166
167
168
169
170
171
172 unsigned int bitflip_threshold;
173
174
175#ifndef __UBOOT__
176 const char *name;
177#else
178 char *name;
179#endif
180 int index;
181
182
183 struct nand_ecclayout *ecclayout;
184
185
186 unsigned int ecc_step_size;
187
188
189 unsigned int ecc_strength;
190
191
192
193
194 int numeraseregions;
195 struct mtd_erase_region_info *eraseregions;
196
197
198
199
200
201 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
202#ifndef __UBOOT__
203 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
204 size_t *retlen, void **virt, resource_size_t *phys);
205 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
206#endif
207 unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
208 unsigned long len,
209 unsigned long offset,
210 unsigned long flags);
211 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
212 size_t *retlen, u_char *buf);
213 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
214 size_t *retlen, const u_char *buf);
215 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
216 size_t *retlen, const u_char *buf);
217 int (*_read_oob) (struct mtd_info *mtd, loff_t from,
218 struct mtd_oob_ops *ops);
219 int (*_write_oob) (struct mtd_info *mtd, loff_t to,
220 struct mtd_oob_ops *ops);
221 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len,
222 size_t *retlen, struct otp_info *buf);
223 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
224 size_t len, size_t *retlen, u_char *buf);
225 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len,
226 size_t *retlen, struct otp_info *buf);
227 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
228 size_t len, size_t *retlen, u_char *buf);
229 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
230 size_t len, size_t *retlen, u_char *buf);
231 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
232 size_t len);
233#ifndef __UBOOT__
234 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
235 unsigned long count, loff_t to, size_t *retlen);
236#endif
237 void (*_sync) (struct mtd_info *mtd);
238 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
239 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
240 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
241 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs);
242 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
243 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
244#ifndef __UBOOT__
245 int (*_suspend) (struct mtd_info *mtd);
246 void (*_resume) (struct mtd_info *mtd);
247 void (*_reboot) (struct mtd_info *mtd);
248#endif
249
250
251
252
253 int (*_get_device) (struct mtd_info *mtd);
254 void (*_put_device) (struct mtd_info *mtd);
255
256#ifndef __UBOOT__
257
258
259
260 struct backing_dev_info *backing_dev_info;
261
262 struct notifier_block reboot_notifier;
263#endif
264
265
266 struct mtd_ecc_stats ecc_stats;
267
268 int subpage_sft;
269
270 void *priv;
271
272 struct module *owner;
273#ifndef __UBOOT__
274 struct device dev;
275#else
276 struct udevice *dev;
277#endif
278 int usecount;
279};
280
281static inline int mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops)
282{
283 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize;
284}
285
286int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
287#ifndef __UBOOT__
288int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
289 void **virt, resource_size_t *phys);
290int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
291#endif
292unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
293 unsigned long offset, unsigned long flags);
294int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
295 u_char *buf);
296int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
297 const u_char *buf);
298int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
299 const u_char *buf);
300
301int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
302
303static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
304 struct mtd_oob_ops *ops)
305{
306 ops->retlen = ops->oobretlen = 0;
307 if (!mtd->_write_oob)
308 return -EOPNOTSUPP;
309 if (!(mtd->flags & MTD_WRITEABLE))
310 return -EROFS;
311 return mtd->_write_oob(mtd, to, ops);
312}
313
314int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
315 struct otp_info *buf);
316int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
317 size_t *retlen, u_char *buf);
318int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
319 struct otp_info *buf);
320int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
321 size_t *retlen, u_char *buf);
322int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
323 size_t *retlen, u_char *buf);
324int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
325
326#ifndef __UBOOT__
327int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
328 unsigned long count, loff_t to, size_t *retlen);
329#endif
330
331static inline void mtd_sync(struct mtd_info *mtd)
332{
333 if (mtd->_sync)
334 mtd->_sync(mtd);
335}
336
337int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
338int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
339int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
340int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
341int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
342int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
343
344#ifndef __UBOOT__
345static inline int mtd_suspend(struct mtd_info *mtd)
346{
347 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
348}
349
350static inline void mtd_resume(struct mtd_info *mtd)
351{
352 if (mtd->_resume)
353 mtd->_resume(mtd);
354}
355#endif
356
357static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
358{
359 if (mtd->erasesize_shift)
360 return sz >> mtd->erasesize_shift;
361 do_div(sz, mtd->erasesize);
362 return sz;
363}
364
365static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
366{
367 if (mtd->erasesize_shift)
368 return sz & mtd->erasesize_mask;
369 return do_div(sz, mtd->erasesize);
370}
371
372static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
373{
374 if (mtd->writesize_shift)
375 return sz >> mtd->writesize_shift;
376 do_div(sz, mtd->writesize);
377 return sz;
378}
379
380static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
381{
382 if (mtd->writesize_shift)
383 return sz & mtd->writesize_mask;
384 return do_div(sz, mtd->writesize);
385}
386
387static inline int mtd_has_oob(const struct mtd_info *mtd)
388{
389 return mtd->_read_oob && mtd->_write_oob;
390}
391
392static inline int mtd_type_is_nand(const struct mtd_info *mtd)
393{
394 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
395}
396
397static inline int mtd_can_have_bb(const struct mtd_info *mtd)
398{
399 return !!mtd->_block_isbad;
400}
401
402
403
404struct mtd_partition;
405struct mtd_part_parser_data;
406
407extern int mtd_device_parse_register(struct mtd_info *mtd,
408 const char * const *part_probe_types,
409 struct mtd_part_parser_data *parser_data,
410 const struct mtd_partition *defparts,
411 int defnr_parts);
412#define mtd_device_register(master, parts, nr_parts) \
413 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
414extern int mtd_device_unregister(struct mtd_info *master);
415extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
416extern int __get_mtd_device(struct mtd_info *mtd);
417extern void __put_mtd_device(struct mtd_info *mtd);
418extern struct mtd_info *get_mtd_device_nm(const char *name);
419extern void put_mtd_device(struct mtd_info *mtd);
420
421
422#ifndef __UBOOT__
423struct mtd_notifier {
424 void (*add)(struct mtd_info *mtd);
425 void (*remove)(struct mtd_info *mtd);
426 struct list_head list;
427};
428
429
430extern void register_mtd_user (struct mtd_notifier *new);
431extern int unregister_mtd_user (struct mtd_notifier *old);
432#endif
433void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
434
435#ifdef CONFIG_MTD_PARTITIONS
436void mtd_erase_callback(struct erase_info *instr);
437#else
438static inline void mtd_erase_callback(struct erase_info *instr)
439{
440 if (instr->callback)
441 instr->callback(instr);
442}
443#endif
444
445#ifdef __UBOOT__
446
447
448
449#define MTD_DEBUG_LEVEL0 (0)
450#define MTD_DEBUG_LEVEL1 (1)
451#define MTD_DEBUG_LEVEL2 (2)
452#define MTD_DEBUG_LEVEL3 (3)
453
454#ifdef CONFIG_MTD_DEBUG
455#define pr_debug(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
456#define MTDDEBUG(n, args...) \
457 do { \
458 if (n <= CONFIG_MTD_DEBUG_VERBOSE) \
459 printk(KERN_INFO args); \
460 } while(0)
461#else
462#define pr_debug(args...)
463#define MTDDEBUG(n, args...) \
464 do { \
465 if (0) \
466 printk(KERN_INFO args); \
467 } while(0)
468#endif
469#define pr_info(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
470#define pr_warn(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
471#define pr_err(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
472#define pr_crit(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
473#define pr_cont(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
474#define pr_notice(args...) MTDDEBUG(MTD_DEBUG_LEVEL0, args)
475#endif
476
477static inline int mtd_is_bitflip(int err) {
478 return err == -EUCLEAN;
479}
480
481static inline int mtd_is_eccerr(int err) {
482 return err == -EBADMSG;
483}
484
485static inline int mtd_is_bitflip_or_eccerr(int err) {
486 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
487}
488
489unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
490
491#ifdef __UBOOT__
492
493int add_mtd_device(struct mtd_info *mtd);
494int del_mtd_device(struct mtd_info *mtd);
495int add_mtd_partitions(struct mtd_info *, const struct mtd_partition *, int);
496int del_mtd_partitions(struct mtd_info *);
497
498int mtd_arg_off(const char *arg, int *idx, loff_t *off, loff_t *size,
499 loff_t *maxsize, int devtype, uint64_t chipsize);
500int mtd_arg_off_size(int argc, char *const argv[], int *idx, loff_t *off,
501 loff_t *size, loff_t *maxsize, int devtype,
502 uint64_t chipsize);
503
504
505void mtd_get_len_incl_bad(struct mtd_info *mtd, uint64_t offset,
506 const uint64_t length, uint64_t *len_incl_bad,
507 int *truncated);
508#endif
509#endif
510