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 void (*_reboot) (struct mtd_info *mtd);
231
232
233
234
235 int (*_get_device) (struct mtd_info *mtd);
236 void (*_put_device) (struct mtd_info *mtd);
237
238
239
240
241 struct backing_dev_info *backing_dev_info;
242
243 struct notifier_block reboot_notifier;
244
245
246 struct mtd_ecc_stats ecc_stats;
247
248 int subpage_sft;
249
250 void *priv;
251
252 struct module *owner;
253 struct device dev;
254 int usecount;
255};
256
257int mtd_erase(struct mtd_info *mtd, struct erase_info *instr);
258int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
259 void **virt, resource_size_t *phys);
260int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len);
261unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len,
262 unsigned long offset, unsigned long flags);
263int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen,
264 u_char *buf);
265int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
266 const u_char *buf);
267int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen,
268 const u_char *buf);
269
270int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops);
271
272static inline int mtd_write_oob(struct mtd_info *mtd, loff_t to,
273 struct mtd_oob_ops *ops)
274{
275 ops->retlen = ops->oobretlen = 0;
276 if (!mtd->_write_oob)
277 return -EOPNOTSUPP;
278 if (!(mtd->flags & MTD_WRITEABLE))
279 return -EROFS;
280 return mtd->_write_oob(mtd, to, ops);
281}
282
283int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
284 struct otp_info *buf);
285int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
286 size_t *retlen, u_char *buf);
287int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen,
288 struct otp_info *buf);
289int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len,
290 size_t *retlen, u_char *buf);
291int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len,
292 size_t *retlen, u_char *buf);
293int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len);
294
295int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs,
296 unsigned long count, loff_t to, size_t *retlen);
297
298static inline void mtd_sync(struct mtd_info *mtd)
299{
300 if (mtd->_sync)
301 mtd->_sync(mtd);
302}
303
304int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
305int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len);
306int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len);
307int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs);
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_type_is_nand(const struct mtd_info *mtd)
358{
359 return mtd->type == MTD_NANDFLASH || mtd->type == MTD_MLCNANDFLASH;
360}
361
362static inline int mtd_can_have_bb(const struct mtd_info *mtd)
363{
364 return !!mtd->_block_isbad;
365}
366
367
368
369struct mtd_partition;
370struct mtd_part_parser_data;
371
372extern int mtd_device_parse_register(struct mtd_info *mtd,
373 const char * const *part_probe_types,
374 struct mtd_part_parser_data *parser_data,
375 const struct mtd_partition *defparts,
376 int defnr_parts);
377#define mtd_device_register(master, parts, nr_parts) \
378 mtd_device_parse_register(master, NULL, NULL, parts, nr_parts)
379extern int mtd_device_unregister(struct mtd_info *master);
380extern struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num);
381extern int __get_mtd_device(struct mtd_info *mtd);
382extern void __put_mtd_device(struct mtd_info *mtd);
383extern struct mtd_info *get_mtd_device_nm(const char *name);
384extern void put_mtd_device(struct mtd_info *mtd);
385
386
387struct mtd_notifier {
388 void (*add)(struct mtd_info *mtd);
389 void (*remove)(struct mtd_info *mtd);
390 struct list_head list;
391};
392
393
394extern void register_mtd_user (struct mtd_notifier *new);
395extern int unregister_mtd_user (struct mtd_notifier *old);
396void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size);
397
398void mtd_erase_callback(struct erase_info *instr);
399
400static inline int mtd_is_bitflip(int err) {
401 return err == -EUCLEAN;
402}
403
404static inline int mtd_is_eccerr(int err) {
405 return err == -EBADMSG;
406}
407
408static inline int mtd_is_bitflip_or_eccerr(int err) {
409 return mtd_is_bitflip(err) || mtd_is_eccerr(err);
410}
411
412unsigned mtd_mmap_capabilities(struct mtd_info *mtd);
413
414#endif
415