1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20#ifndef __MTD_MTD_H__
21#define __MTD_MTD_H__
22
23#include <linux/types.h>
24#include <linux/uio.h>
25#include <linux/notifier.h>
26#include <linux/device.h>
27
28#include <mtd/mtd-abi.h>
29
30#include <asm/div64.h>
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 void (*callback) (struct erase_info *self);
55 u_long priv;
56 u_char state;
57 struct erase_info *next;
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
82
83
84
85
86struct mtd_oob_ops {
87 unsigned int mode;
88 size_t len;
89 size_t retlen;
90 size_t ooblen;
91 size_t oobretlen;
92 uint32_t ooboffs;
93 uint8_t *datbuf;
94 uint8_t *oobbuf;
95};
96
97#define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
98#define MTD_MAX_ECCPOS_ENTRIES_LARGE 1260
99
100
101
102
103
104
105struct nand_ecclayout {
106 __u32 eccbytes;
107 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
108 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
109};
110
111struct module;
112
113struct mtd_info {
114 u_char type;
115 uint32_t flags;
116 uint64_t size;
117
118
119
120
121
122 uint32_t erasesize;
123
124
125
126
127
128
129
130 uint32_t writesize;
131
132
133
134
135
136
137
138
139
140
141 uint32_t writebufsize;
142
143 uint32_t oobsize;
144 uint32_t oobavail;
145
146
147
148
149
150 unsigned int erasesize_shift;
151 unsigned int writesize_shift;
152
153 unsigned int erasesize_mask;
154 unsigned int writesize_mask;
155
156
157
158
159
160
161
162
163 unsigned int bitflip_threshold;
164
165
166 const char *name;
167 int index;
168
169
170 struct nand_ecclayout *ecclayout;
171
172
173 unsigned int ecc_step_size;
174
175
176 unsigned int ecc_strength;
177
178
179
180
181 int numeraseregions;
182 struct mtd_erase_region_info *eraseregions;
183
184
185
186
187
188 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
189 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
190 size_t *retlen, void **virt, resource_size_t *phys);
191 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
192 unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
193 unsigned long len,
194 unsigned long offset,
195 unsigned long flags);
196 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
197 size_t *retlen, u_char *buf);
198 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
199 size_t *retlen, const u_char *buf);
200 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
201 size_t *retlen, const u_char *buf);
202 int (*_read_oob) (struct mtd_info *mtd, loff_t from,
203 struct mtd_oob_ops *ops);
204 int (*_write_oob) (struct mtd_info *mtd, loff_t to,
205 struct mtd_oob_ops *ops);
206 int (*_get_fact_prot_info) (struct mtd_info *mtd, size_t len,
207 size_t *retlen, struct otp_info *buf);
208 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
209 size_t len, size_t *retlen, u_char *buf);
210 int (*_get_user_prot_info) (struct mtd_info *mtd, size_t len,
211 size_t *retlen, struct otp_info *buf);
212 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
213 size_t len, size_t *retlen, u_char *buf);
214 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
215 size_t len, size_t *retlen, u_char *buf);
216 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
217 size_t len);
218 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
219 unsigned long count, loff_t to, size_t *retlen);
220 void (*_sync) (struct mtd_info *mtd);
221 int (*_lock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
222 int (*_unlock) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
223 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
224 int (*_block_isreserved) (struct mtd_info *mtd, loff_t ofs);
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);
229 void (*_reboot) (struct mtd_info *mtd);
230
231
232
233
234 int (*_get_device) (struct mtd_info *mtd);
235 void (*_put_device) (struct mtd_info *mtd);
236
237
238
239
240 struct backing_dev_info *backing_dev_info;
241
242 struct notifier_block reboot_notifier;
243
244
245 struct mtd_ecc_stats ecc_stats;
246
247 int subpage_sft;
248
249 void *priv;
250
251 struct module *owner;
252 struct device dev;
253 int usecount;
254};
255
256static inline void mtd_set_of_node(struct mtd_info *mtd,
257 struct device_node *np)
258{
259 mtd->dev.of_node = np;
260}
261
262static inline struct device_node *mtd_get_of_node(struct mtd_info *mtd)
263{
264 return mtd->dev.of_node;
265}
266
267static inline int mtd_oobavail(struct mtd_info *mtd, struct mtd_oob_ops *ops)
268{
269 return ops->mode == MTD_OPS_AUTO_OOB ? mtd->oobavail : mtd->oobsize;
270}
271
272int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
273int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
274 void **virt, resource_size_t *phys);
275int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
276unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
277 unsigned long offset, unsigned long flags);
278int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
279 u_char *buf);
280int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
281 const u_char *buf);
282int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
283 const u_char *buf);
284
285int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
286
287static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
288 struct mtd_oob_ops *ops)
289{
290 ops->retlen = ops->oobretlen = 0;
291 if (!mtd->_write_oob)
292 return -EOPNOTSUPP;
293 if (!(mtd->flags & MTD_WRITEABLE))
294 return -EROFS;
295 return mtd->_write_oob(mtd, to, ops);
296}
297
298int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
299 struct otp_info *buf);
300int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
301 size_t *retlen, u_char *buf);
302int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
303 struct otp_info *buf);
304int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
305 size_t *retlen, u_char *buf);
306int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
307 size_t *retlen, u_char *buf);
308int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
309
310int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
311 unsigned long count, loff_t to, size_t *retlen);
312
313static inline void mtd_sync(struct mtd_info *mtd)
314{
315 if (mtd->_sync)
316 mtd->_sync(mtd);
317}
318
319int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
320int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
321int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
322int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
323int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
324int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
325
326static inline int mtd_suspend(struct mtd_info *mtd)
327{
328 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
329}
330
331static inline void mtd_resume(struct mtd_info *mtd)
332{
333 if (mtd->_resume)
334 mtd->_resume(mtd);
335}
336
337static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
338{
339 if (mtd->erasesize_shift)
340 return sz >> mtd->erasesize_shift;
341 do_div(sz, mtd->erasesize);
342 return sz;
343}
344
345static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
346{
347 if (mtd->erasesize_shift)
348 return sz & mtd->erasesize_mask;
349 return do_div(sz, mtd->erasesize);
350}
351
352static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
353{
354 if (mtd->writesize_shift)
355 return sz >> mtd->writesize_shift;
356 do_div(sz, mtd->writesize);
357 return sz;
358}
359
360static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
361{
362 if (mtd->writesize_shift)
363 return sz & mtd->writesize_mask;
364 return do_div(sz, mtd->writesize);
365}
366
367static inline int mtd_has_oob(const struct mtd_info *mtd)
368{
369 return mtd->_read_oob && mtd->_write_oob;
370}
371
372static inline int mtd_type_is_nand(const struct mtd_info *mtd)
373{
374 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
375}
376
377static inline int mtd_can_have_bb(const struct mtd_info *mtd)
378{
379 return !!mtd->_block_isbad;
380}
381
382
383
384struct mtd_partition;
385struct mtd_part_parser_data;
386
387extern int mtd_device_parse_register(struct mtd_info *mtd,
388 const char * const *part_probe_types,
389 struct mtd_part_parser_data *parser_data,
390 const struct mtd_partition *defparts,
391 int defnr_parts);
392#define mtd_device_register(master, parts, nr_parts) \
393 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
394extern int mtd_device_unregister(struct mtd_info *master);
395extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
396extern int __get_mtd_device(struct mtd_info *mtd);
397extern void __put_mtd_device(struct mtd_info *mtd);
398extern struct mtd_info *get_mtd_device_nm(const char *name);
399extern void put_mtd_device(struct mtd_info *mtd);
400
401
402struct mtd_notifier {
403 void (*add)(struct mtd_info *mtd);
404 void (*remove)(struct mtd_info *mtd);
405 struct list_head list;
406};
407
408
409extern void register_mtd_user (struct mtd_notifier *new);
410extern int unregister_mtd_user (struct mtd_notifier *old);
411void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
412
413void mtd_erase_callback(struct erase_info *instr);
414
415static inline int mtd_is_bitflip(int err) {
416 return err == -EUCLEAN;
417}
418
419static inline int mtd_is_eccerr(int err) {
420 return err == -EBADMSG;
421}
422
423static inline int mtd_is_bitflip_or_eccerr(int err) {
424 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
425}
426
427unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
428
429#endif
430