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