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 640
99
100
101
102
103
104
105struct nand_ecclayout {
106 __u32 eccbytes;
107 __u32 eccpos[MTD_MAX_ECCPOS_ENTRIES_LARGE];
108 __u32 oobavail;
109 struct nand_oobfree oobfree[MTD_MAX_OOBFREE_ENTRIES_LARGE];
110};
111
112struct module;
113
114struct mtd_info {
115 u_char type;
116 uint32_t flags;
117 uint64_t size;
118
119
120
121
122
123 uint32_t erasesize;
124
125
126
127
128
129
130
131 uint32_t writesize;
132
133
134
135
136
137
138
139
140
141
142 uint32_t writebufsize;
143
144 uint32_t oobsize;
145 uint32_t oobavail;
146
147
148
149
150
151 unsigned int erasesize_shift;
152 unsigned int writesize_shift;
153
154 unsigned int erasesize_mask;
155 unsigned int writesize_mask;
156
157
158
159
160
161
162
163
164 unsigned int bitflip_threshold;
165
166
167 const char *name;
168 int index;
169
170
171 struct nand_ecclayout *ecclayout;
172
173
174 unsigned int ecc_step_size;
175
176
177 unsigned int ecc_strength;
178
179
180
181
182 int numeraseregions;
183 struct mtd_erase_region_info *eraseregions;
184
185
186
187
188
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);
192 int (*_unpoint) (struct mtd_info *mtd, loff_t from, size_t len);
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,
204 struct mtd_oob_ops *ops);
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, size_t len,
208 size_t *retlen, struct otp_info *buf);
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, size_t len,
212 size_t *retlen, struct otp_info *buf);
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,
220 unsigned long count, loff_t to, size_t *retlen);
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_isreserved) (struct mtd_info *mtd, loff_t ofs);
226 int (*_block_isbad) (struct mtd_info *mtd, loff_t ofs);
227 int (*_block_markbad) (struct mtd_info *mtd, loff_t ofs);
228 int (*_suspend) (struct mtd_info *mtd);
229 void (*_resume) (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
256int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
257int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
258 void **virt, resource_size_t *phys);
259int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
260unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
261 unsigned long offset, unsigned long flags);
262int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
263 u_char *buf);
264int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
265 const u_char *buf);
266int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
267 const u_char *buf);
268
269int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
270
271static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
272 struct mtd_oob_ops *ops)
273{
274 ops->retlen = ops->oobretlen = 0;
275 if (!mtd->_write_oob)
276 return -EOPNOTSUPP;
277 if (!(mtd->flags & MTD_WRITEABLE))
278 return -EROFS;
279 return mtd->_write_oob(mtd, to, ops);
280}
281
282int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
283 struct otp_info *buf);
284int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
285 size_t *retlen, u_char *buf);
286int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
287 struct otp_info *buf);
288int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
289 size_t *retlen, u_char *buf);
290int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
291 size_t *retlen, u_char *buf);
292int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
293
294int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
295 unsigned long count, loff_t to, size_t *retlen);
296
297static inline void mtd_sync(struct mtd_info *mtd)
298{
299 if (mtd->_sync)
300 mtd->_sync(mtd);
301}
302
303int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
304int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
305int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
306int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
307int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs);
308int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs);
309
310static inline int mtd_suspend(struct mtd_info *mtd)
311{
312 return mtd->_suspend ? mtd->_suspend(mtd) : 0;
313}
314
315static inline void mtd_resume(struct mtd_info *mtd)
316{
317 if (mtd->_resume)
318 mtd->_resume(mtd);
319}
320
321static inline uint32_t mtd_div_by_eb(uint64_t sz, struct mtd_info *mtd)
322{
323 if (mtd->erasesize_shift)
324 return sz >> mtd->erasesize_shift;
325 do_div(sz, mtd->erasesize);
326 return sz;
327}
328
329static inline uint32_t mtd_mod_by_eb(uint64_t sz, struct mtd_info *mtd)
330{
331 if (mtd->erasesize_shift)
332 return sz & mtd->erasesize_mask;
333 return do_div(sz, mtd->erasesize);
334}
335
336static inline uint32_t mtd_div_by_ws(uint64_t sz, struct mtd_info *mtd)
337{
338 if (mtd->writesize_shift)
339 return sz >> mtd->writesize_shift;
340 do_div(sz, mtd->writesize);
341 return sz;
342}
343
344static inline uint32_t mtd_mod_by_ws(uint64_t sz, struct mtd_info *mtd)
345{
346 if (mtd->writesize_shift)
347 return sz & mtd->writesize_mask;
348 return do_div(sz, mtd->writesize);
349}
350
351static inline int mtd_has_oob(const struct mtd_info *mtd)
352{
353 return mtd->_read_oob && mtd->_write_oob;
354}
355
356static inline int mtd_type_is_nand(const struct mtd_info *mtd)
357{
358 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
359}
360
361static inline int mtd_can_have_bb(const struct mtd_info *mtd)
362{
363 return !!mtd->_block_isbad;
364}
365
366
367
368struct mtd_partition;
369struct mtd_part_parser_data;
370
371extern int mtd_device_parse_register(struct mtd_info *mtd,
372 const char * const *part_probe_types,
373 struct mtd_part_parser_data *parser_data,
374 const struct mtd_partition *defparts,
375 int defnr_parts);
376#define mtd_device_register(master, parts, nr_parts) \
377 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
378extern int mtd_device_unregister(struct mtd_info *master);
379extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
380extern int __get_mtd_device(struct mtd_info *mtd);
381extern void __put_mtd_device(struct mtd_info *mtd);
382extern struct mtd_info *get_mtd_device_nm(const char *name);
383extern void put_mtd_device(struct mtd_info *mtd);
384
385
386struct mtd_notifier {
387 void (*add)(struct mtd_info *mtd);
388 void (*remove)(struct mtd_info *mtd);
389 struct list_head list;
390};
391
392
393extern void register_mtd_user (struct mtd_notifier *new);
394extern int unregister_mtd_user (struct mtd_notifier *old);
395void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
396
397void mtd_erase_callback(struct erase_info *instr);
398
399static inline int mtd_is_bitflip(int err) {
400 return err == -EUCLEAN;
401}
402
403static inline int mtd_is_eccerr(int err) {
404 return err == -EBADMSG;
405}
406
407static inline int mtd_is_bitflip_or_eccerr(int err) {
408 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
409}
410
411#endif
412