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_CHAR_MAJOR 90
33#define MTD_BLOCK_MAJOR 31
34
35#define MTD_ERASE_PENDING 0x01
36#define MTD_ERASING 0x02
37#define MTD_ERASE_SUSPEND 0x04
38#define MTD_ERASE_DONE 0x08
39#define MTD_ERASE_FAILED 0x10
40
41#define MTD_FAIL_ADDR_UNKNOWN -1LL
42
43
44
45
46
47
48struct erase_info {
49 struct mtd_info *mtd;
50 uint64_t addr;
51 uint64_t len;
52 uint64_t fail_addr;
53 u_long time;
54 u_long retries;
55 unsigned dev;
56 unsigned cell;
57 void (*callback) (struct erase_info *self);
58 u_long priv;
59 u_char state;
60 struct erase_info *next;
61};
62
63struct mtd_erase_region_info {
64 uint64_t offset;
65 uint32_t erasesize;
66 uint32_t numblocks;
67 unsigned long *lockmap;
68};
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89struct mtd_oob_ops {
90 unsigned int mode;
91 size_t len;
92 size_t retlen;
93 size_t ooblen;
94 size_t oobretlen;
95 uint32_t ooboffs;
96 uint8_t *datbuf;
97 uint8_t *oobbuf;
98};
99
100#define MTD_MAX_OOBFREE_ENTRIES_LARGE 32
101#define MTD_MAX_ECCPOS_ENTRIES_LARGE 640
102
103
104
105
106
107
108struct 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
115struct module;
116
117struct mtd_info {
118 u_char type;
119 uint32_t flags;
120 uint64_t size;
121
122
123
124
125
126 uint32_t erasesize;
127
128
129
130
131
132
133
134 uint32_t writesize;
135
136
137
138
139
140
141
142
143
144
145 uint32_t writebufsize;
146
147 uint32_t oobsize;
148 uint32_t oobavail;
149
150
151
152
153
154 unsigned int erasesize_shift;
155 unsigned int writesize_shift;
156
157 unsigned int erasesize_mask;
158 unsigned int writesize_mask;
159
160
161
162
163
164
165
166
167 unsigned int bitflip_threshold;
168
169
170 const char *name;
171 int index;
172
173
174 struct nand_ecclayout *ecclayout;
175
176
177 unsigned int ecc_step_size;
178
179
180 unsigned int ecc_strength;
181
182
183
184
185 int numeraseregions;
186 struct mtd_erase_region_info *eraseregions;
187
188
189
190
191
192 int (*_erase) (struct mtd_info *mtd, struct erase_info *instr);
193 int (*_point) (struct mtd_info *mtd, loff_t from, size_t len,
194 size_t *retlen, void **virt, resource_size_t *phys);
195 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
196 unsigned long (*_get_unmapped_area) (struct mtd_info *mtd,
197 unsigned long len,
198 unsigned long offset,
199 unsigned long flags);
200 int (*_read) (struct mtd_info *mtd, loff_t from, size_t len,
201 size_t *retlen, u_char *buf);
202 int (*_write) (struct mtd_info *mtd, loff_t to, size_t len,
203 size_t *retlen, const u_char *buf);
204 int (*_panic_write) (struct mtd_info *mtd, loff_t to, size_t len,
205 size_t *retlen, const u_char *buf);
206 int (*_read_oob) (struct mtd_info *mtd, loff_t from,
207 struct mtd_oob_ops *ops);
208 int (*_write_oob) (struct mtd_info *mtd, loff_t to,
209 struct mtd_oob_ops *ops);
210 int (*_get_fact_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
211 size_t len);
212 int (*_read_fact_prot_reg) (struct mtd_info *mtd, loff_t from,
213 size_t len, size_t *retlen, u_char *buf);
214 int (*_get_user_prot_info) (struct mtd_info *mtd, struct otp_info *buf,
215 size_t len);
216 int (*_read_user_prot_reg) (struct mtd_info *mtd, loff_t from,
217 size_t len, size_t *retlen, u_char *buf);
218 int (*_write_user_prot_reg) (struct mtd_info *mtd, loff_t to,
219 size_t len, size_t *retlen, u_char *buf);
220 int (*_lock_user_prot_reg) (struct mtd_info *mtd, loff_t from,
221 size_t len);
222 int (*_writev) (struct mtd_info *mtd, const struct kvec *vecs,
223 unsigned long count, loff_t to, size_t *retlen);
224 void (*_sync) (struct mtd_info *mtd);
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);
227 int (*_is_locked) (struct mtd_info *mtd, loff_t ofs, uint64_t len);
228 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
229 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
230 int (*_suspend) (struct mtd_info *mtd);
231 void (*_resume) (struct mtd_info *mtd);
232
233
234
235
236 int (*_get_device) (struct mtd_info *mtd);
237 void (*_put_device) (struct mtd_info *mtd);
238
239
240
241
242 struct backing_dev_info *backing_dev_info;
243
244 struct notifier_block reboot_notifier;
245
246
247 struct mtd_ecc_stats ecc_stats;
248
249 int subpage_sft;
250
251 void *priv;
252
253 struct module *owner;
254 struct device dev;
255 int usecount;
256};
257
258int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
259int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
260 void **virt, resource_size_t *phys);
261int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
262unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
263 unsigned long offset, unsigned long flags);
264int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
265 u_char *buf);
266int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
267 const u_char *buf);
268int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
269 const u_char *buf);
270
271int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
272
273static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
274 struct mtd_oob_ops *ops)
275{
276 ops->retlen = ops->oobretlen = 0;
277 if (!mtd->_write_oob)
278 return -EOPNOTSUPP;
279 if (!(mtd->flags & MTD_WRITEABLE))
280 return -EROFS;
281 return mtd->_write_oob(mtd, to, ops);
282}
283
284int mtd_get_fact_prot_info(struct mtd_info *mtd, struct otp_info *buf,
285 size_t len);
286int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
287 size_t *retlen, u_char *buf);
288int mtd_get_user_prot_info(struct mtd_info *mtd, struct otp_info *buf,
289 size_t len);
290int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
291 size_t *retlen, u_char *buf);
292int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
293 size_t *retlen, u_char *buf);
294int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
295
296int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
297 unsigned long count, loff_t to, size_t *retlen);
298
299static inline void mtd_sync(struct mtd_info *mtd)
300{
301 if (mtd->_sync)
302 mtd->_sync(mtd);
303}
304
305int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
306int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
307int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
308int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
309int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
310
311static inline int mtd_suspend(struct mtd_info *mtd)
312{
313 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
314}
315
316static inline void mtd_resume(struct mtd_info *mtd)
317{
318 if (mtd->_resume)
319 mtd->_resume(mtd);
320}
321
322static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
323{
324 if (mtd->erasesize_shift)
325 return sz >> mtd->erasesize_shift;
326 do_div(sz, mtd->erasesize);
327 return sz;
328}
329
330static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
331{
332 if (mtd->erasesize_shift)
333 return sz & mtd->erasesize_mask;
334 return do_div(sz, mtd->erasesize);
335}
336
337static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
338{
339 if (mtd->writesize_shift)
340 return sz >> mtd->writesize_shift;
341 do_div(sz, mtd->writesize);
342 return sz;
343}
344
345static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
346{
347 if (mtd->writesize_shift)
348 return sz & mtd->writesize_mask;
349 return do_div(sz, mtd->writesize);
350}
351
352static inline int mtd_has_oob(const struct mtd_info *mtd)
353{
354 return mtd->_read_oob && mtd->_write_oob;
355}
356
357static inline int mtd_can_have_bb(const struct mtd_info *mtd)
358{
359 return !!mtd->_block_isbad;
360}
361
362
363
364struct mtd_partition;
365struct mtd_part_parser_data;
366
367extern int mtd_device_parse_register(struct mtd_info *mtd,
368 const char * const *part_probe_types,
369 struct mtd_part_parser_data *parser_data,
370 const struct mtd_partition *defparts,
371 int defnr_parts);
372#define mtd_device_register(master, parts, nr_parts) \
373 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
374extern int mtd_device_unregister(struct mtd_info *master);
375extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
376extern int __get_mtd_device(struct mtd_info *mtd);
377extern void __put_mtd_device(struct mtd_info *mtd);
378extern struct mtd_info *get_mtd_device_nm(const char *name);
379extern void put_mtd_device(struct mtd_info *mtd);
380
381
382struct mtd_notifier {
383 void (*add)(struct mtd_info *mtd);
384 void (*remove)(struct mtd_info *mtd);
385 struct list_head list;
386};
387
388
389extern void register_mtd_user (struct mtd_notifier *new);
390extern int unregister_mtd_user (struct mtd_notifier *old);
391void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
392
393void mtd_erase_callback(struct erase_info *instr);
394
395static inline int mtd_is_bitflip(int err) {
396 return err == -EUCLEAN;
397}
398
399static inline int mtd_is_eccerr(int err) {
400 return err == -EBADMSG;
401}
402
403static inline int mtd_is_bitflip_or_eccerr(int err) {
404 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
405}
406
407#endif
408