]>
Commit | Line | Data |
---|---|---|
1da177e4 | 1 | /* |
1da177e4 LT |
2 | * Core registration and callback routines for MTD |
3 | * drivers and users. | |
4 | * | |
a1452a37 DW |
5 | * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org> |
6 | * Copyright © 2006 Red Hat UK Limited | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | * | |
13 | * This program is distributed in the hope that it will be useful, | |
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 | * GNU General Public License for more details. | |
17 | * | |
18 | * You should have received a copy of the GNU General Public License | |
19 | * along with this program; if not, write to the Free Software | |
20 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA | |
21 | * | |
1da177e4 LT |
22 | */ |
23 | ||
1da177e4 LT |
24 | #include <linux/module.h> |
25 | #include <linux/kernel.h> | |
1da177e4 | 26 | #include <linux/ptrace.h> |
447d9bd8 | 27 | #include <linux/seq_file.h> |
1da177e4 LT |
28 | #include <linux/string.h> |
29 | #include <linux/timer.h> | |
30 | #include <linux/major.h> | |
31 | #include <linux/fs.h> | |
7799308f | 32 | #include <linux/err.h> |
1da177e4 LT |
33 | #include <linux/ioctl.h> |
34 | #include <linux/init.h> | |
215a02fd | 35 | #include <linux/of.h> |
1da177e4 | 36 | #include <linux/proc_fs.h> |
b520e412 | 37 | #include <linux/idr.h> |
a33eb6b9 | 38 | #include <linux/backing-dev.h> |
05d71b46 | 39 | #include <linux/gfp.h> |
0d01ff25 | 40 | #include <linux/slab.h> |
3efe41be | 41 | #include <linux/reboot.h> |
fea728c0 | 42 | #include <linux/leds.h> |
e8e3edb9 | 43 | #include <linux/debugfs.h> |
c4dfa25a | 44 | #include <linux/nvmem-provider.h> |
1da177e4 LT |
45 | |
46 | #include <linux/mtd/mtd.h> | |
f5671ab3 | 47 | #include <linux/mtd/partitions.h> |
1da177e4 | 48 | |
356d70f1 | 49 | #include "mtdcore.h" |
660685d9 | 50 | |
fa06052d | 51 | struct backing_dev_info *mtd_bdi; |
356d70f1 | 52 | |
57b8045d LPC |
53 | #ifdef CONFIG_PM_SLEEP |
54 | ||
55 | static int mtd_cls_suspend(struct device *dev) | |
56 | { | |
57 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
58 | ||
59 | return mtd ? mtd_suspend(mtd) : 0; | |
60 | } | |
61 | ||
62 | static int mtd_cls_resume(struct device *dev) | |
63 | { | |
64 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
65 | ||
66 | if (mtd) | |
67 | mtd_resume(mtd); | |
68 | return 0; | |
69 | } | |
70 | ||
71 | static SIMPLE_DEV_PM_OPS(mtd_cls_pm_ops, mtd_cls_suspend, mtd_cls_resume); | |
72 | #define MTD_CLS_PM_OPS (&mtd_cls_pm_ops) | |
73 | #else | |
74 | #define MTD_CLS_PM_OPS NULL | |
75 | #endif | |
15bce40c DW |
76 | |
77 | static struct class mtd_class = { | |
78 | .name = "mtd", | |
79 | .owner = THIS_MODULE, | |
57b8045d | 80 | .pm = MTD_CLS_PM_OPS, |
15bce40c | 81 | }; |
1f24b5a8 | 82 | |
b520e412 BH |
83 | static DEFINE_IDR(mtd_idr); |
84 | ||
97894cda | 85 | /* These are exported solely for the purpose of mtd_blkdevs.c. You |
1da177e4 | 86 | should not use them for _anything_ else */ |
48b19268 | 87 | DEFINE_MUTEX(mtd_table_mutex); |
1da177e4 | 88 | EXPORT_SYMBOL_GPL(mtd_table_mutex); |
b520e412 BH |
89 | |
90 | struct mtd_info *__mtd_next_device(int i) | |
91 | { | |
92 | return idr_get_next(&mtd_idr, &i); | |
93 | } | |
94 | EXPORT_SYMBOL_GPL(__mtd_next_device); | |
1da177e4 LT |
95 | |
96 | static LIST_HEAD(mtd_notifiers); | |
97 | ||
1f24b5a8 | 98 | |
1f24b5a8 | 99 | #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2) |
1f24b5a8 DB |
100 | |
101 | /* REVISIT once MTD uses the driver model better, whoever allocates | |
102 | * the mtd_info will probably want to use the release() hook... | |
103 | */ | |
104 | static void mtd_release(struct device *dev) | |
105 | { | |
5e472128 | 106 | struct mtd_info *mtd = dev_get_drvdata(dev); |
d5de20a9 | 107 | dev_t index = MTD_DEVT(mtd->index); |
1f24b5a8 | 108 | |
5e472128 BN |
109 | /* remove /dev/mtdXro node */ |
110 | device_destroy(&mtd_class, index + 1); | |
15bce40c DW |
111 | } |
112 | ||
1f24b5a8 DB |
113 | static ssize_t mtd_type_show(struct device *dev, |
114 | struct device_attribute *attr, char *buf) | |
115 | { | |
d5de20a9 | 116 | struct mtd_info *mtd = dev_get_drvdata(dev); |
1f24b5a8 DB |
117 | char *type; |
118 | ||
119 | switch (mtd->type) { | |
120 | case MTD_ABSENT: | |
121 | type = "absent"; | |
122 | break; | |
123 | case MTD_RAM: | |
124 | type = "ram"; | |
125 | break; | |
126 | case MTD_ROM: | |
127 | type = "rom"; | |
128 | break; | |
129 | case MTD_NORFLASH: | |
130 | type = "nor"; | |
131 | break; | |
132 | case MTD_NANDFLASH: | |
133 | type = "nand"; | |
134 | break; | |
135 | case MTD_DATAFLASH: | |
136 | type = "dataflash"; | |
137 | break; | |
138 | case MTD_UBIVOLUME: | |
139 | type = "ubi"; | |
140 | break; | |
f4837246 HS |
141 | case MTD_MLCNANDFLASH: |
142 | type = "mlc-nand"; | |
143 | break; | |
1f24b5a8 DB |
144 | default: |
145 | type = "unknown"; | |
146 | } | |
147 | ||
148 | return snprintf(buf, PAGE_SIZE, "%s\n", type); | |
149 | } | |
694bb7fc KC |
150 | static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL); |
151 | ||
152 | static ssize_t mtd_flags_show(struct device *dev, | |
153 | struct device_attribute *attr, char *buf) | |
154 | { | |
d5de20a9 | 155 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
156 | |
157 | return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags); | |
694bb7fc KC |
158 | } |
159 | static DEVICE_ATTR(flags, S_IRUGO, mtd_flags_show, NULL); | |
160 | ||
161 | static ssize_t mtd_size_show(struct device *dev, | |
162 | struct device_attribute *attr, char *buf) | |
163 | { | |
d5de20a9 | 164 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
165 | |
166 | return snprintf(buf, PAGE_SIZE, "%llu\n", | |
167 | (unsigned long long)mtd->size); | |
694bb7fc KC |
168 | } |
169 | static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL); | |
170 | ||
171 | static ssize_t mtd_erasesize_show(struct device *dev, | |
172 | struct device_attribute *attr, char *buf) | |
173 | { | |
d5de20a9 | 174 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
175 | |
176 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize); | |
694bb7fc KC |
177 | } |
178 | static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL); | |
179 | ||
180 | static ssize_t mtd_writesize_show(struct device *dev, | |
181 | struct device_attribute *attr, char *buf) | |
182 | { | |
d5de20a9 | 183 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
184 | |
185 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize); | |
694bb7fc KC |
186 | } |
187 | static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL); | |
188 | ||
e7693548 AB |
189 | static ssize_t mtd_subpagesize_show(struct device *dev, |
190 | struct device_attribute *attr, char *buf) | |
191 | { | |
d5de20a9 | 192 | struct mtd_info *mtd = dev_get_drvdata(dev); |
e7693548 AB |
193 | unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft; |
194 | ||
195 | return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize); | |
e7693548 AB |
196 | } |
197 | static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL); | |
198 | ||
694bb7fc KC |
199 | static ssize_t mtd_oobsize_show(struct device *dev, |
200 | struct device_attribute *attr, char *buf) | |
201 | { | |
d5de20a9 | 202 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
203 | |
204 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize); | |
694bb7fc KC |
205 | } |
206 | static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL); | |
207 | ||
7cc9aa66 XL |
208 | static ssize_t mtd_oobavail_show(struct device *dev, |
209 | struct device_attribute *attr, char *buf) | |
210 | { | |
211 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
212 | ||
213 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->oobavail); | |
214 | } | |
215 | static DEVICE_ATTR(oobavail, S_IRUGO, mtd_oobavail_show, NULL); | |
216 | ||
694bb7fc KC |
217 | static ssize_t mtd_numeraseregions_show(struct device *dev, |
218 | struct device_attribute *attr, char *buf) | |
219 | { | |
d5de20a9 | 220 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
221 | |
222 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions); | |
694bb7fc KC |
223 | } |
224 | static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show, | |
225 | NULL); | |
226 | ||
227 | static ssize_t mtd_name_show(struct device *dev, | |
228 | struct device_attribute *attr, char *buf) | |
229 | { | |
d5de20a9 | 230 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
231 | |
232 | return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name); | |
694bb7fc KC |
233 | } |
234 | static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL); | |
1f24b5a8 | 235 | |
a9b672e8 MD |
236 | static ssize_t mtd_ecc_strength_show(struct device *dev, |
237 | struct device_attribute *attr, char *buf) | |
238 | { | |
239 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
240 | ||
241 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_strength); | |
242 | } | |
243 | static DEVICE_ATTR(ecc_strength, S_IRUGO, mtd_ecc_strength_show, NULL); | |
244 | ||
d062d4ed MD |
245 | static ssize_t mtd_bitflip_threshold_show(struct device *dev, |
246 | struct device_attribute *attr, | |
247 | char *buf) | |
248 | { | |
249 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
250 | ||
251 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->bitflip_threshold); | |
252 | } | |
253 | ||
254 | static ssize_t mtd_bitflip_threshold_store(struct device *dev, | |
255 | struct device_attribute *attr, | |
256 | const char *buf, size_t count) | |
257 | { | |
258 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
259 | unsigned int bitflip_threshold; | |
260 | int retval; | |
261 | ||
262 | retval = kstrtouint(buf, 0, &bitflip_threshold); | |
263 | if (retval) | |
264 | return retval; | |
265 | ||
266 | mtd->bitflip_threshold = bitflip_threshold; | |
267 | return count; | |
268 | } | |
269 | static DEVICE_ATTR(bitflip_threshold, S_IRUGO | S_IWUSR, | |
270 | mtd_bitflip_threshold_show, | |
271 | mtd_bitflip_threshold_store); | |
272 | ||
bf977e3f HS |
273 | static ssize_t mtd_ecc_step_size_show(struct device *dev, |
274 | struct device_attribute *attr, char *buf) | |
275 | { | |
276 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
277 | ||
278 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_step_size); | |
279 | ||
280 | } | |
281 | static DEVICE_ATTR(ecc_step_size, S_IRUGO, mtd_ecc_step_size_show, NULL); | |
282 | ||
990a3af0 EG |
283 | static ssize_t mtd_ecc_stats_corrected_show(struct device *dev, |
284 | struct device_attribute *attr, char *buf) | |
285 | { | |
286 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
287 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
288 | ||
289 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->corrected); | |
290 | } | |
291 | static DEVICE_ATTR(corrected_bits, S_IRUGO, | |
292 | mtd_ecc_stats_corrected_show, NULL); | |
293 | ||
294 | static ssize_t mtd_ecc_stats_errors_show(struct device *dev, | |
295 | struct device_attribute *attr, char *buf) | |
296 | { | |
297 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
298 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
299 | ||
300 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->failed); | |
301 | } | |
302 | static DEVICE_ATTR(ecc_failures, S_IRUGO, mtd_ecc_stats_errors_show, NULL); | |
303 | ||
304 | static ssize_t mtd_badblocks_show(struct device *dev, | |
305 | struct device_attribute *attr, char *buf) | |
306 | { | |
307 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
308 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
309 | ||
310 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->badblocks); | |
311 | } | |
312 | static DEVICE_ATTR(bad_blocks, S_IRUGO, mtd_badblocks_show, NULL); | |
313 | ||
314 | static ssize_t mtd_bbtblocks_show(struct device *dev, | |
315 | struct device_attribute *attr, char *buf) | |
316 | { | |
317 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
318 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
319 | ||
320 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->bbtblocks); | |
321 | } | |
322 | static DEVICE_ATTR(bbt_blocks, S_IRUGO, mtd_bbtblocks_show, NULL); | |
323 | ||
1f24b5a8 | 324 | static struct attribute *mtd_attrs[] = { |
694bb7fc KC |
325 | &dev_attr_type.attr, |
326 | &dev_attr_flags.attr, | |
327 | &dev_attr_size.attr, | |
328 | &dev_attr_erasesize.attr, | |
329 | &dev_attr_writesize.attr, | |
e7693548 | 330 | &dev_attr_subpagesize.attr, |
694bb7fc | 331 | &dev_attr_oobsize.attr, |
7cc9aa66 | 332 | &dev_attr_oobavail.attr, |
694bb7fc KC |
333 | &dev_attr_numeraseregions.attr, |
334 | &dev_attr_name.attr, | |
a9b672e8 | 335 | &dev_attr_ecc_strength.attr, |
bf977e3f | 336 | &dev_attr_ecc_step_size.attr, |
990a3af0 EG |
337 | &dev_attr_corrected_bits.attr, |
338 | &dev_attr_ecc_failures.attr, | |
339 | &dev_attr_bad_blocks.attr, | |
340 | &dev_attr_bbt_blocks.attr, | |
d062d4ed | 341 | &dev_attr_bitflip_threshold.attr, |
1f24b5a8 DB |
342 | NULL, |
343 | }; | |
54c738f6 | 344 | ATTRIBUTE_GROUPS(mtd); |
1f24b5a8 | 345 | |
75864b30 | 346 | static const struct device_type mtd_devtype = { |
1f24b5a8 DB |
347 | .name = "mtd", |
348 | .groups = mtd_groups, | |
349 | .release = mtd_release, | |
350 | }; | |
351 | ||
b4caecd4 CH |
352 | #ifndef CONFIG_MMU |
353 | unsigned mtd_mmap_capabilities(struct mtd_info *mtd) | |
354 | { | |
355 | switch (mtd->type) { | |
356 | case MTD_RAM: | |
357 | return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC | | |
358 | NOMMU_MAP_READ | NOMMU_MAP_WRITE; | |
359 | case MTD_ROM: | |
360 | return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC | | |
361 | NOMMU_MAP_READ; | |
362 | default: | |
363 | return NOMMU_MAP_COPY; | |
364 | } | |
365 | } | |
706a4e5a | 366 | EXPORT_SYMBOL_GPL(mtd_mmap_capabilities); |
b4caecd4 CH |
367 | #endif |
368 | ||
3efe41be BN |
369 | static int mtd_reboot_notifier(struct notifier_block *n, unsigned long state, |
370 | void *cmd) | |
371 | { | |
372 | struct mtd_info *mtd; | |
373 | ||
374 | mtd = container_of(n, struct mtd_info, reboot_notifier); | |
375 | mtd->_reboot(mtd); | |
376 | ||
377 | return NOTIFY_DONE; | |
378 | } | |
379 | ||
477b0229 BB |
380 | /** |
381 | * mtd_wunit_to_pairing_info - get pairing information of a wunit | |
382 | * @mtd: pointer to new MTD device info structure | |
383 | * @wunit: write unit we are interested in | |
384 | * @info: returned pairing information | |
385 | * | |
386 | * Retrieve pairing information associated to the wunit. | |
387 | * This is mainly useful when dealing with MLC/TLC NANDs where pages can be | |
388 | * paired together, and where programming a page may influence the page it is | |
389 | * paired with. | |
390 | * The notion of page is replaced by the term wunit (write-unit) to stay | |
391 | * consistent with the ->writesize field. | |
392 | * | |
393 | * The @wunit argument can be extracted from an absolute offset using | |
394 | * mtd_offset_to_wunit(). @info is filled with the pairing information attached | |
395 | * to @wunit. | |
396 | * | |
397 | * From the pairing info the MTD user can find all the wunits paired with | |
398 | * @wunit using the following loop: | |
399 | * | |
400 | * for (i = 0; i < mtd_pairing_groups(mtd); i++) { | |
401 | * info.pair = i; | |
402 | * mtd_pairing_info_to_wunit(mtd, &info); | |
403 | * ... | |
404 | * } | |
405 | */ | |
406 | int mtd_wunit_to_pairing_info(struct mtd_info *mtd, int wunit, | |
407 | struct mtd_pairing_info *info) | |
408 | { | |
409 | int npairs = mtd_wunit_per_eb(mtd) / mtd_pairing_groups(mtd); | |
410 | ||
411 | if (wunit < 0 || wunit >= npairs) | |
412 | return -EINVAL; | |
413 | ||
414 | if (mtd->pairing && mtd->pairing->get_info) | |
415 | return mtd->pairing->get_info(mtd, wunit, info); | |
416 | ||
417 | info->group = 0; | |
418 | info->pair = wunit; | |
419 | ||
420 | return 0; | |
421 | } | |
422 | EXPORT_SYMBOL_GPL(mtd_wunit_to_pairing_info); | |
423 | ||
424 | /** | |
c77a9312 | 425 | * mtd_pairing_info_to_wunit - get wunit from pairing information |
477b0229 BB |
426 | * @mtd: pointer to new MTD device info structure |
427 | * @info: pairing information struct | |
428 | * | |
429 | * Returns a positive number representing the wunit associated to the info | |
430 | * struct, or a negative error code. | |
431 | * | |
432 | * This is the reverse of mtd_wunit_to_pairing_info(), and can help one to | |
433 | * iterate over all wunits of a given pair (see mtd_wunit_to_pairing_info() | |
434 | * doc). | |
435 | * | |
436 | * It can also be used to only program the first page of each pair (i.e. | |
437 | * page attached to group 0), which allows one to use an MLC NAND in | |
438 | * software-emulated SLC mode: | |
439 | * | |
440 | * info.group = 0; | |
441 | * npairs = mtd_wunit_per_eb(mtd) / mtd_pairing_groups(mtd); | |
442 | * for (info.pair = 0; info.pair < npairs; info.pair++) { | |
443 | * wunit = mtd_pairing_info_to_wunit(mtd, &info); | |
444 | * mtd_write(mtd, mtd_wunit_to_offset(mtd, blkoffs, wunit), | |
445 | * mtd->writesize, &retlen, buf + (i * mtd->writesize)); | |
446 | * } | |
447 | */ | |
448 | int mtd_pairing_info_to_wunit(struct mtd_info *mtd, | |
449 | const struct mtd_pairing_info *info) | |
450 | { | |
451 | int ngroups = mtd_pairing_groups(mtd); | |
452 | int npairs = mtd_wunit_per_eb(mtd) / ngroups; | |
453 | ||
454 | if (!info || info->pair < 0 || info->pair >= npairs || | |
455 | info->group < 0 || info->group >= ngroups) | |
456 | return -EINVAL; | |
457 | ||
458 | if (mtd->pairing && mtd->pairing->get_wunit) | |
459 | return mtd->pairing->get_wunit(mtd, info); | |
460 | ||
461 | return info->pair; | |
462 | } | |
463 | EXPORT_SYMBOL_GPL(mtd_pairing_info_to_wunit); | |
464 | ||
465 | /** | |
466 | * mtd_pairing_groups - get the number of pairing groups | |
467 | * @mtd: pointer to new MTD device info structure | |
468 | * | |
469 | * Returns the number of pairing groups. | |
470 | * | |
471 | * This number is usually equal to the number of bits exposed by a single | |
472 | * cell, and can be used in conjunction with mtd_pairing_info_to_wunit() | |
473 | * to iterate over all pages of a given pair. | |
474 | */ | |
475 | int mtd_pairing_groups(struct mtd_info *mtd) | |
476 | { | |
477 | if (!mtd->pairing || !mtd->pairing->ngroups) | |
478 | return 1; | |
479 | ||
480 | return mtd->pairing->ngroups; | |
481 | } | |
482 | EXPORT_SYMBOL_GPL(mtd_pairing_groups); | |
483 | ||
c4dfa25a AB |
484 | static int mtd_nvmem_reg_read(void *priv, unsigned int offset, |
485 | void *val, size_t bytes) | |
486 | { | |
487 | struct mtd_info *mtd = priv; | |
488 | size_t retlen; | |
489 | int err; | |
490 | ||
491 | err = mtd_read(mtd, offset, bytes, &retlen, val); | |
492 | if (err && err != -EUCLEAN) | |
493 | return err; | |
494 | ||
495 | return retlen == bytes ? 0 : -EIO; | |
496 | } | |
497 | ||
498 | static int mtd_nvmem_add(struct mtd_info *mtd) | |
499 | { | |
500 | struct nvmem_config config = {}; | |
501 | ||
6e952685 | 502 | config.id = -1; |
c4dfa25a AB |
503 | config.dev = &mtd->dev; |
504 | config.name = mtd->name; | |
505 | config.owner = THIS_MODULE; | |
506 | config.reg_read = mtd_nvmem_reg_read; | |
507 | config.size = mtd->size; | |
508 | config.word_size = 1; | |
509 | config.stride = 1; | |
510 | config.read_only = true; | |
511 | config.root_only = true; | |
512 | config.no_of_node = true; | |
513 | config.priv = mtd; | |
514 | ||
515 | mtd->nvmem = nvmem_register(&config); | |
516 | if (IS_ERR(mtd->nvmem)) { | |
517 | /* Just ignore if there is no NVMEM support in the kernel */ | |
19e16fb4 | 518 | if (PTR_ERR(mtd->nvmem) == -EOPNOTSUPP) { |
c4dfa25a AB |
519 | mtd->nvmem = NULL; |
520 | } else { | |
521 | dev_err(&mtd->dev, "Failed to register NVMEM device\n"); | |
522 | return PTR_ERR(mtd->nvmem); | |
523 | } | |
524 | } | |
525 | ||
526 | return 0; | |
527 | } | |
528 | ||
e8e3edb9 MR |
529 | static struct dentry *dfs_dir_mtd; |
530 | ||
1da177e4 LT |
531 | /** |
532 | * add_mtd_device - register an MTD device | |
533 | * @mtd: pointer to new MTD device info structure | |
534 | * | |
535 | * Add a device to the list of MTD devices present in the system, and | |
536 | * notify each currently active MTD 'user' of its arrival. Returns | |
57dd990c | 537 | * zero on success or non-zero on failure. |
1da177e4 LT |
538 | */ |
539 | ||
540 | int add_mtd_device(struct mtd_info *mtd) | |
541 | { | |
b520e412 BH |
542 | struct mtd_notifier *not; |
543 | int i, error; | |
1da177e4 | 544 | |
be0dbff8 BN |
545 | /* |
546 | * May occur, for instance, on buggy drivers which call | |
547 | * mtd_device_parse_register() multiple times on the same master MTD, | |
548 | * especially with CONFIG_MTD_PARTITIONED_MASTER=y. | |
549 | */ | |
fa06052d | 550 | if (WARN_ONCE(mtd->dev.type, "MTD already registered\n")) |
be0dbff8 BN |
551 | return -EEXIST; |
552 | ||
783ed81f | 553 | BUG_ON(mtd->writesize == 0); |
33f45c44 | 554 | |
2431c4f5 BB |
555 | /* |
556 | * MTD drivers should implement ->_{write,read}() or | |
557 | * ->_{write,read}_oob(), but not both. | |
558 | */ | |
559 | if (WARN_ON((mtd->_write && mtd->_write_oob) || | |
560 | (mtd->_read && mtd->_read_oob))) | |
561 | return -EINVAL; | |
562 | ||
33f45c44 BB |
563 | if (WARN_ON((!mtd->erasesize || !mtd->_erase) && |
564 | !(mtd->flags & MTD_NO_ERASE))) | |
565 | return -EINVAL; | |
566 | ||
48b19268 | 567 | mutex_lock(&mtd_table_mutex); |
1da177e4 | 568 | |
589e9c4d | 569 | i = idr_alloc(&mtd_idr, mtd, 0, 0, GFP_KERNEL); |
57dd990c BN |
570 | if (i < 0) { |
571 | error = i; | |
b520e412 | 572 | goto fail_locked; |
57dd990c | 573 | } |
1f24b5a8 | 574 | |
b520e412 BH |
575 | mtd->index = i; |
576 | mtd->usecount = 0; | |
577 | ||
d062d4ed MD |
578 | /* default value if not set by driver */ |
579 | if (mtd->bitflip_threshold == 0) | |
580 | mtd->bitflip_threshold = mtd->ecc_strength; | |
581 | ||
b520e412 BH |
582 | if (is_power_of_2(mtd->erasesize)) |
583 | mtd->erasesize_shift = ffs(mtd->erasesize) - 1; | |
584 | else | |
585 | mtd->erasesize_shift = 0; | |
586 | ||
587 | if (is_power_of_2(mtd->writesize)) | |
588 | mtd->writesize_shift = ffs(mtd->writesize) - 1; | |
589 | else | |
590 | mtd->writesize_shift = 0; | |
591 | ||
592 | mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1; | |
593 | mtd->writesize_mask = (1 << mtd->writesize_shift) - 1; | |
594 | ||
595 | /* Some chips always power up locked. Unlock them now */ | |
38134565 AB |
596 | if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) { |
597 | error = mtd_unlock(mtd, 0, mtd->size); | |
598 | if (error && error != -EOPNOTSUPP) | |
b520e412 BH |
599 | printk(KERN_WARNING |
600 | "%s: unlock failed, writes may not work\n", | |
601 | mtd->name); | |
57dd990c BN |
602 | /* Ignore unlock failures? */ |
603 | error = 0; | |
b520e412 BH |
604 | } |
605 | ||
606 | /* Caller should have set dev.parent to match the | |
260e89a6 | 607 | * physical device, if appropriate. |
b520e412 BH |
608 | */ |
609 | mtd->dev.type = &mtd_devtype; | |
610 | mtd->dev.class = &mtd_class; | |
611 | mtd->dev.devt = MTD_DEVT(i); | |
612 | dev_set_name(&mtd->dev, "mtd%d", i); | |
613 | dev_set_drvdata(&mtd->dev, mtd); | |
215a02fd | 614 | of_node_get(mtd_get_of_node(mtd)); |
57dd990c BN |
615 | error = device_register(&mtd->dev); |
616 | if (error) | |
b520e412 BH |
617 | goto fail_added; |
618 | ||
c4dfa25a AB |
619 | /* Add the nvmem provider */ |
620 | error = mtd_nvmem_add(mtd); | |
621 | if (error) | |
622 | goto fail_nvmem_add; | |
623 | ||
e8e3edb9 MR |
624 | if (!IS_ERR_OR_NULL(dfs_dir_mtd)) { |
625 | mtd->dbg.dfs_dir = debugfs_create_dir(dev_name(&mtd->dev), dfs_dir_mtd); | |
626 | if (IS_ERR_OR_NULL(mtd->dbg.dfs_dir)) { | |
627 | pr_debug("mtd device %s won't show data in debugfs\n", | |
628 | dev_name(&mtd->dev)); | |
629 | } | |
630 | } | |
631 | ||
5e472128 BN |
632 | device_create(&mtd_class, mtd->dev.parent, MTD_DEVT(i) + 1, NULL, |
633 | "mtd%dro", i); | |
b520e412 | 634 | |
289c0522 | 635 | pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name); |
b520e412 BH |
636 | /* No need to get a refcount on the module containing |
637 | the notifier, since we hold the mtd_table_mutex */ | |
638 | list_for_each_entry(not, &mtd_notifiers, list) | |
639 | not->add(mtd); | |
640 | ||
641 | mutex_unlock(&mtd_table_mutex); | |
642 | /* We _know_ we aren't being removed, because | |
643 | our caller is still holding us here. So none | |
644 | of this try_ nonsense, and no bitching about it | |
645 | either. :) */ | |
646 | __module_get(THIS_MODULE); | |
647 | return 0; | |
97894cda | 648 | |
c4dfa25a AB |
649 | fail_nvmem_add: |
650 | device_unregister(&mtd->dev); | |
b520e412 | 651 | fail_added: |
215a02fd | 652 | of_node_put(mtd_get_of_node(mtd)); |
b520e412 BH |
653 | idr_remove(&mtd_idr, i); |
654 | fail_locked: | |
48b19268 | 655 | mutex_unlock(&mtd_table_mutex); |
57dd990c | 656 | return error; |
1da177e4 LT |
657 | } |
658 | ||
659 | /** | |
660 | * del_mtd_device - unregister an MTD device | |
661 | * @mtd: pointer to MTD device info structure | |
662 | * | |
663 | * Remove a device from the list of MTD devices present in the system, | |
664 | * and notify each currently active MTD 'user' of its departure. | |
665 | * Returns zero on success or 1 on failure, which currently will happen | |
666 | * if the requested device does not appear to be present in the list. | |
667 | */ | |
668 | ||
eea72d5f | 669 | int del_mtd_device(struct mtd_info *mtd) |
1da177e4 LT |
670 | { |
671 | int ret; | |
75c0b84d | 672 | struct mtd_notifier *not; |
97894cda | 673 | |
48b19268 | 674 | mutex_lock(&mtd_table_mutex); |
1da177e4 | 675 | |
e8e3edb9 MR |
676 | debugfs_remove_recursive(mtd->dbg.dfs_dir); |
677 | ||
b520e412 | 678 | if (idr_find(&mtd_idr, mtd->index) != mtd) { |
1da177e4 | 679 | ret = -ENODEV; |
75c0b84d ML |
680 | goto out_error; |
681 | } | |
682 | ||
683 | /* No need to get a refcount on the module containing | |
684 | the notifier, since we hold the mtd_table_mutex */ | |
685 | list_for_each_entry(not, &mtd_notifiers, list) | |
686 | not->remove(mtd); | |
687 | ||
688 | if (mtd->usecount) { | |
97894cda | 689 | printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n", |
1da177e4 LT |
690 | mtd->index, mtd->name, mtd->usecount); |
691 | ret = -EBUSY; | |
692 | } else { | |
c4dfa25a AB |
693 | /* Try to remove the NVMEM provider */ |
694 | if (mtd->nvmem) | |
695 | nvmem_unregister(mtd->nvmem); | |
696 | ||
694bb7fc KC |
697 | device_unregister(&mtd->dev); |
698 | ||
b520e412 | 699 | idr_remove(&mtd_idr, mtd->index); |
215a02fd | 700 | of_node_put(mtd_get_of_node(mtd)); |
1da177e4 LT |
701 | |
702 | module_put(THIS_MODULE); | |
703 | ret = 0; | |
704 | } | |
705 | ||
75c0b84d | 706 | out_error: |
48b19268 | 707 | mutex_unlock(&mtd_table_mutex); |
1da177e4 LT |
708 | return ret; |
709 | } | |
710 | ||
472b444e BN |
711 | /* |
712 | * Set a few defaults based on the parent devices, if not provided by the | |
713 | * driver | |
714 | */ | |
715 | static void mtd_set_dev_defaults(struct mtd_info *mtd) | |
716 | { | |
717 | if (mtd->dev.parent) { | |
718 | if (!mtd->owner && mtd->dev.parent->driver) | |
719 | mtd->owner = mtd->dev.parent->driver->owner; | |
720 | if (!mtd->name) | |
721 | mtd->name = dev_name(mtd->dev.parent); | |
722 | } else { | |
723 | pr_debug("mtd device won't show a device symlink in sysfs\n"); | |
724 | } | |
1186af45 RM |
725 | |
726 | mtd->orig_flags = mtd->flags; | |
472b444e | 727 | } |
727dc612 | 728 | |
1c4c215c DB |
729 | /** |
730 | * mtd_device_parse_register - parse partitions and register an MTD device. | |
731 | * | |
732 | * @mtd: the MTD device to register | |
733 | * @types: the list of MTD partition probes to try, see | |
734 | * 'parse_mtd_partitions()' for more information | |
c7975330 | 735 | * @parser_data: MTD partition parser-specific data |
1c4c215c DB |
736 | * @parts: fallback partition information to register, if parsing fails; |
737 | * only valid if %nr_parts > %0 | |
738 | * @nr_parts: the number of partitions in parts, if zero then the full | |
739 | * MTD device is registered if no partition info is found | |
740 | * | |
741 | * This function aggregates MTD partitions parsing (done by | |
742 | * 'parse_mtd_partitions()') and MTD device and partitions registering. It | |
743 | * basically follows the most common pattern found in many MTD drivers: | |
744 | * | |
55a999a0 RM |
745 | * * If the MTD_PARTITIONED_MASTER option is set, then the device as a whole is |
746 | * registered first. | |
747 | * * Then It tries to probe partitions on MTD device @mtd using parsers | |
1c4c215c DB |
748 | * specified in @types (if @types is %NULL, then the default list of parsers |
749 | * is used, see 'parse_mtd_partitions()' for more information). If none are | |
750 | * found this functions tries to fallback to information specified in | |
751 | * @parts/@nr_parts. | |
1c4c215c DB |
752 | * * If no partitions were found this function just registers the MTD device |
753 | * @mtd and exits. | |
754 | * | |
755 | * Returns zero in case of success and a negative error code in case of failure. | |
756 | */ | |
26a47346 | 757 | int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types, |
c7975330 | 758 | struct mtd_part_parser_data *parser_data, |
1c4c215c DB |
759 | const struct mtd_partition *parts, |
760 | int nr_parts) | |
761 | { | |
727dc612 | 762 | int ret; |
1c4c215c | 763 | |
472b444e BN |
764 | mtd_set_dev_defaults(mtd); |
765 | ||
2c77c57d RM |
766 | if (IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER)) { |
767 | ret = add_mtd_device(mtd); | |
768 | if (ret) | |
769 | return ret; | |
770 | } | |
771 | ||
0dbe4ea7 | 772 | /* Prefer parsed partitions over driver-provided fallback */ |
5ac67ce3 RM |
773 | ret = parse_mtd_partitions(mtd, types, parser_data); |
774 | if (ret > 0) | |
775 | ret = 0; | |
776 | else if (nr_parts) | |
0dbe4ea7 RM |
777 | ret = add_mtd_partitions(mtd, parts, nr_parts); |
778 | else if (!device_is_registered(&mtd->dev)) | |
779 | ret = add_mtd_device(mtd); | |
780 | else | |
781 | ret = 0; | |
782 | ||
3e00ed0e BN |
783 | if (ret) |
784 | goto out; | |
1c4c215c | 785 | |
e1dd8641 NC |
786 | /* |
787 | * FIXME: some drivers unfortunately call this function more than once. | |
788 | * So we have to check if we've already assigned the reboot notifier. | |
789 | * | |
790 | * Generally, we can make multiple calls work for most cases, but it | |
791 | * does cause problems with parse_mtd_partitions() above (e.g., | |
792 | * cmdlineparts will register partitions more than once). | |
793 | */ | |
f8479dd6 BN |
794 | WARN_ONCE(mtd->_reboot && mtd->reboot_notifier.notifier_call, |
795 | "MTD already registered\n"); | |
e1dd8641 | 796 | if (mtd->_reboot && !mtd->reboot_notifier.notifier_call) { |
3efe41be BN |
797 | mtd->reboot_notifier.notifier_call = mtd_reboot_notifier; |
798 | register_reboot_notifier(&mtd->reboot_notifier); | |
799 | } | |
800 | ||
3e00ed0e | 801 | out: |
2c77c57d RM |
802 | if (ret && device_is_registered(&mtd->dev)) |
803 | del_mtd_device(mtd); | |
804 | ||
727dc612 | 805 | return ret; |
1c4c215c DB |
806 | } |
807 | EXPORT_SYMBOL_GPL(mtd_device_parse_register); | |
808 | ||
f5671ab3 JI |
809 | /** |
810 | * mtd_device_unregister - unregister an existing MTD device. | |
811 | * | |
812 | * @master: the MTD device to unregister. This will unregister both the master | |
813 | * and any partitions if registered. | |
814 | */ | |
815 | int mtd_device_unregister(struct mtd_info *master) | |
816 | { | |
817 | int err; | |
818 | ||
3efe41be BN |
819 | if (master->_reboot) |
820 | unregister_reboot_notifier(&master->reboot_notifier); | |
821 | ||
f5671ab3 JI |
822 | err = del_mtd_partitions(master); |
823 | if (err) | |
824 | return err; | |
825 | ||
826 | if (!device_is_registered(&master->dev)) | |
827 | return 0; | |
828 | ||
829 | return del_mtd_device(master); | |
830 | } | |
831 | EXPORT_SYMBOL_GPL(mtd_device_unregister); | |
832 | ||
1da177e4 LT |
833 | /** |
834 | * register_mtd_user - register a 'user' of MTD devices. | |
835 | * @new: pointer to notifier info structure | |
836 | * | |
837 | * Registers a pair of callbacks function to be called upon addition | |
838 | * or removal of MTD devices. Causes the 'add' callback to be immediately | |
839 | * invoked for each MTD device currently present in the system. | |
840 | */ | |
1da177e4 LT |
841 | void register_mtd_user (struct mtd_notifier *new) |
842 | { | |
f1332ba2 | 843 | struct mtd_info *mtd; |
1da177e4 | 844 | |
48b19268 | 845 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
846 | |
847 | list_add(&new->list, &mtd_notifiers); | |
848 | ||
d5ca5129 | 849 | __module_get(THIS_MODULE); |
97894cda | 850 | |
f1332ba2 BH |
851 | mtd_for_each_device(mtd) |
852 | new->add(mtd); | |
1da177e4 | 853 | |
48b19268 | 854 | mutex_unlock(&mtd_table_mutex); |
1da177e4 | 855 | } |
33c87b4a | 856 | EXPORT_SYMBOL_GPL(register_mtd_user); |
1da177e4 LT |
857 | |
858 | /** | |
49450795 AB |
859 | * unregister_mtd_user - unregister a 'user' of MTD devices. |
860 | * @old: pointer to notifier info structure | |
1da177e4 LT |
861 | * |
862 | * Removes a callback function pair from the list of 'users' to be | |
863 | * notified upon addition or removal of MTD devices. Causes the | |
864 | * 'remove' callback to be immediately invoked for each MTD device | |
865 | * currently present in the system. | |
866 | */ | |
1da177e4 LT |
867 | int unregister_mtd_user (struct mtd_notifier *old) |
868 | { | |
f1332ba2 | 869 | struct mtd_info *mtd; |
1da177e4 | 870 | |
48b19268 | 871 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
872 | |
873 | module_put(THIS_MODULE); | |
874 | ||
f1332ba2 BH |
875 | mtd_for_each_device(mtd) |
876 | old->remove(mtd); | |
97894cda | 877 | |
1da177e4 | 878 | list_del(&old->list); |
48b19268 | 879 | mutex_unlock(&mtd_table_mutex); |
1da177e4 LT |
880 | return 0; |
881 | } | |
33c87b4a | 882 | EXPORT_SYMBOL_GPL(unregister_mtd_user); |
1da177e4 LT |
883 | |
884 | /** | |
885 | * get_mtd_device - obtain a validated handle for an MTD device | |
886 | * @mtd: last known address of the required MTD device | |
887 | * @num: internal device number of the required MTD device | |
888 | * | |
889 | * Given a number and NULL address, return the num'th entry in the device | |
890 | * table, if any. Given an address and num == -1, search the device table | |
891 | * for a device with that address and return if it's still present. Given | |
9c74034f AB |
892 | * both, return the num'th driver only if its address matches. Return |
893 | * error code if not. | |
1da177e4 | 894 | */ |
1da177e4 LT |
895 | struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num) |
896 | { | |
f1332ba2 BH |
897 | struct mtd_info *ret = NULL, *other; |
898 | int err = -ENODEV; | |
1da177e4 | 899 | |
48b19268 | 900 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
901 | |
902 | if (num == -1) { | |
f1332ba2 BH |
903 | mtd_for_each_device(other) { |
904 | if (other == mtd) { | |
905 | ret = mtd; | |
906 | break; | |
907 | } | |
908 | } | |
b520e412 BH |
909 | } else if (num >= 0) { |
910 | ret = idr_find(&mtd_idr, num); | |
1da177e4 LT |
911 | if (mtd && mtd != ret) |
912 | ret = NULL; | |
913 | } | |
914 | ||
3bd45657 ML |
915 | if (!ret) { |
916 | ret = ERR_PTR(err); | |
917 | goto out; | |
9fe912ce | 918 | } |
1da177e4 | 919 | |
3bd45657 ML |
920 | err = __get_mtd_device(ret); |
921 | if (err) | |
922 | ret = ERR_PTR(err); | |
923 | out: | |
9c74034f AB |
924 | mutex_unlock(&mtd_table_mutex); |
925 | return ret; | |
3bd45657 | 926 | } |
33c87b4a | 927 | EXPORT_SYMBOL_GPL(get_mtd_device); |
1da177e4 | 928 | |
3bd45657 ML |
929 | |
930 | int __get_mtd_device(struct mtd_info *mtd) | |
931 | { | |
932 | int err; | |
933 | ||
934 | if (!try_module_get(mtd->owner)) | |
935 | return -ENODEV; | |
936 | ||
3c3c10bb AB |
937 | if (mtd->_get_device) { |
938 | err = mtd->_get_device(mtd); | |
3bd45657 ML |
939 | |
940 | if (err) { | |
941 | module_put(mtd->owner); | |
942 | return err; | |
943 | } | |
944 | } | |
945 | mtd->usecount++; | |
946 | return 0; | |
1da177e4 | 947 | } |
33c87b4a | 948 | EXPORT_SYMBOL_GPL(__get_mtd_device); |
1da177e4 | 949 | |
7799308f AB |
950 | /** |
951 | * get_mtd_device_nm - obtain a validated handle for an MTD device by | |
952 | * device name | |
953 | * @name: MTD device name to open | |
954 | * | |
955 | * This function returns MTD device description structure in case of | |
956 | * success and an error code in case of failure. | |
957 | */ | |
7799308f AB |
958 | struct mtd_info *get_mtd_device_nm(const char *name) |
959 | { | |
f1332ba2 BH |
960 | int err = -ENODEV; |
961 | struct mtd_info *mtd = NULL, *other; | |
7799308f AB |
962 | |
963 | mutex_lock(&mtd_table_mutex); | |
964 | ||
f1332ba2 BH |
965 | mtd_for_each_device(other) { |
966 | if (!strcmp(name, other->name)) { | |
967 | mtd = other; | |
7799308f AB |
968 | break; |
969 | } | |
970 | } | |
971 | ||
9fe912ce | 972 | if (!mtd) |
7799308f AB |
973 | goto out_unlock; |
974 | ||
52534f2d WG |
975 | err = __get_mtd_device(mtd); |
976 | if (err) | |
7799308f AB |
977 | goto out_unlock; |
978 | ||
9fe912ce AB |
979 | mutex_unlock(&mtd_table_mutex); |
980 | return mtd; | |
7799308f AB |
981 | |
982 | out_unlock: | |
983 | mutex_unlock(&mtd_table_mutex); | |
9fe912ce | 984 | return ERR_PTR(err); |
7799308f | 985 | } |
33c87b4a | 986 | EXPORT_SYMBOL_GPL(get_mtd_device_nm); |
7799308f | 987 | |
1da177e4 LT |
988 | void put_mtd_device(struct mtd_info *mtd) |
989 | { | |
48b19268 | 990 | mutex_lock(&mtd_table_mutex); |
3bd45657 ML |
991 | __put_mtd_device(mtd); |
992 | mutex_unlock(&mtd_table_mutex); | |
993 | ||
994 | } | |
33c87b4a | 995 | EXPORT_SYMBOL_GPL(put_mtd_device); |
3bd45657 ML |
996 | |
997 | void __put_mtd_device(struct mtd_info *mtd) | |
998 | { | |
999 | --mtd->usecount; | |
1000 | BUG_ON(mtd->usecount < 0); | |
1001 | ||
3c3c10bb AB |
1002 | if (mtd->_put_device) |
1003 | mtd->_put_device(mtd); | |
1da177e4 LT |
1004 | |
1005 | module_put(mtd->owner); | |
1006 | } | |
33c87b4a | 1007 | EXPORT_SYMBOL_GPL(__put_mtd_device); |
1da177e4 | 1008 | |
8273a0c9 | 1009 | /* |
884cfd90 BB |
1010 | * Erase is an synchronous operation. Device drivers are epected to return a |
1011 | * negative error code if the operation failed and update instr->fail_addr | |
1012 | * to point the portion that was not properly erased. | |
8273a0c9 AB |
1013 | */ |
1014 | int mtd_erase(struct mtd_info *mtd, struct erase_info *instr) | |
1015 | { | |
c585da9f BB |
1016 | instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN; |
1017 | ||
e6e620f0 BB |
1018 | if (!mtd->erasesize || !mtd->_erase) |
1019 | return -ENOTSUPP; | |
1020 | ||
0c2b4e21 | 1021 | if (instr->addr >= mtd->size || instr->len > mtd->size - instr->addr) |
8273a0c9 | 1022 | return -EINVAL; |
664addc2 AB |
1023 | if (!(mtd->flags & MTD_WRITEABLE)) |
1024 | return -EROFS; | |
e6e620f0 | 1025 | |
e7bfb3fd | 1026 | if (!instr->len) |
bcb1d238 | 1027 | return 0; |
e7bfb3fd | 1028 | |
fea728c0 | 1029 | ledtrig_mtd_activity(); |
8273a0c9 AB |
1030 | return mtd->_erase(mtd, instr); |
1031 | } | |
1032 | EXPORT_SYMBOL_GPL(mtd_erase); | |
1033 | ||
1034 | /* | |
1035 | * This stuff for eXecute-In-Place. phys is optional and may be set to NULL. | |
1036 | */ | |
1037 | int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
1038 | void **virt, resource_size_t *phys) | |
1039 | { | |
1040 | *retlen = 0; | |
0dd5235f AB |
1041 | *virt = NULL; |
1042 | if (phys) | |
1043 | *phys = 0; | |
8273a0c9 AB |
1044 | if (!mtd->_point) |
1045 | return -EOPNOTSUPP; | |
0c2b4e21 | 1046 | if (from < 0 || from >= mtd->size || len > mtd->size - from) |
8273a0c9 | 1047 | return -EINVAL; |
bcb1d238 AB |
1048 | if (!len) |
1049 | return 0; | |
8273a0c9 AB |
1050 | return mtd->_point(mtd, from, len, retlen, virt, phys); |
1051 | } | |
1052 | EXPORT_SYMBOL_GPL(mtd_point); | |
1053 | ||
1054 | /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ | |
1055 | int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len) | |
1056 | { | |
b9504247 | 1057 | if (!mtd->_unpoint) |
8273a0c9 | 1058 | return -EOPNOTSUPP; |
0c2b4e21 | 1059 | if (from < 0 || from >= mtd->size || len > mtd->size - from) |
8273a0c9 | 1060 | return -EINVAL; |
bcb1d238 AB |
1061 | if (!len) |
1062 | return 0; | |
8273a0c9 AB |
1063 | return mtd->_unpoint(mtd, from, len); |
1064 | } | |
1065 | EXPORT_SYMBOL_GPL(mtd_unpoint); | |
1066 | ||
1067 | /* | |
1068 | * Allow NOMMU mmap() to directly map the device (if not NULL) | |
1069 | * - return the address to which the offset maps | |
1070 | * - return -ENOSYS to indicate refusal to do the mapping | |
1071 | */ | |
1072 | unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len, | |
1073 | unsigned long offset, unsigned long flags) | |
1074 | { | |
9eaa903c NP |
1075 | size_t retlen; |
1076 | void *virt; | |
1077 | int ret; | |
1078 | ||
1079 | ret = mtd_point(mtd, offset, len, &retlen, &virt, NULL); | |
1080 | if (ret) | |
1081 | return ret; | |
1082 | if (retlen != len) { | |
1083 | mtd_unpoint(mtd, offset, retlen); | |
1084 | return -ENOSYS; | |
1085 | } | |
1086 | return (unsigned long)virt; | |
8273a0c9 AB |
1087 | } |
1088 | EXPORT_SYMBOL_GPL(mtd_get_unmapped_area); | |
1089 | ||
1090 | int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
1091 | u_char *buf) | |
1092 | { | |
2431c4f5 BB |
1093 | struct mtd_oob_ops ops = { |
1094 | .len = len, | |
1095 | .datbuf = buf, | |
1096 | }; | |
1097 | int ret; | |
edbc4540 | 1098 | |
2431c4f5 BB |
1099 | ret = mtd_read_oob(mtd, from, &ops); |
1100 | *retlen = ops.retlen; | |
24ff1292 | 1101 | |
2431c4f5 | 1102 | return ret; |
8273a0c9 AB |
1103 | } |
1104 | EXPORT_SYMBOL_GPL(mtd_read); | |
1105 | ||
1106 | int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
1107 | const u_char *buf) | |
1108 | { | |
2431c4f5 BB |
1109 | struct mtd_oob_ops ops = { |
1110 | .len = len, | |
1111 | .datbuf = (u8 *)buf, | |
1112 | }; | |
1113 | int ret; | |
24ff1292 | 1114 | |
2431c4f5 BB |
1115 | ret = mtd_write_oob(mtd, to, &ops); |
1116 | *retlen = ops.retlen; | |
24ff1292 | 1117 | |
2431c4f5 | 1118 | return ret; |
8273a0c9 AB |
1119 | } |
1120 | EXPORT_SYMBOL_GPL(mtd_write); | |
1121 | ||
1122 | /* | |
1123 | * In blackbox flight recorder like scenarios we want to make successful writes | |
1124 | * in interrupt context. panic_write() is only intended to be called when its | |
1125 | * known the kernel is about to panic and we need the write to succeed. Since | |
1126 | * the kernel is not going to be running for much longer, this function can | |
1127 | * break locks and delay to ensure the write succeeds (but not sleep). | |
1128 | */ | |
1129 | int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
1130 | const u_char *buf) | |
1131 | { | |
1132 | *retlen = 0; | |
1133 | if (!mtd->_panic_write) | |
1134 | return -EOPNOTSUPP; | |
0c2b4e21 | 1135 | if (to < 0 || to >= mtd->size || len > mtd->size - to) |
8273a0c9 | 1136 | return -EINVAL; |
664addc2 AB |
1137 | if (!(mtd->flags & MTD_WRITEABLE)) |
1138 | return -EROFS; | |
bcb1d238 AB |
1139 | if (!len) |
1140 | return 0; | |
8273a0c9 AB |
1141 | return mtd->_panic_write(mtd, to, len, retlen, buf); |
1142 | } | |
1143 | EXPORT_SYMBOL_GPL(mtd_panic_write); | |
1144 | ||
5cdd929d BB |
1145 | static int mtd_check_oob_ops(struct mtd_info *mtd, loff_t offs, |
1146 | struct mtd_oob_ops *ops) | |
1147 | { | |
1148 | /* | |
1149 | * Some users are setting ->datbuf or ->oobbuf to NULL, but are leaving | |
1150 | * ->len or ->ooblen uninitialized. Force ->len and ->ooblen to 0 in | |
1151 | * this case. | |
1152 | */ | |
1153 | if (!ops->datbuf) | |
1154 | ops->len = 0; | |
1155 | ||
1156 | if (!ops->oobbuf) | |
1157 | ops->ooblen = 0; | |
1158 | ||
d82c3682 | 1159 | if (offs < 0 || offs + ops->len > mtd->size) |
5cdd929d BB |
1160 | return -EINVAL; |
1161 | ||
1162 | if (ops->ooblen) { | |
89f706db | 1163 | size_t maxooblen; |
5cdd929d BB |
1164 | |
1165 | if (ops->ooboffs >= mtd_oobavail(mtd, ops)) | |
1166 | return -EINVAL; | |
1167 | ||
89f706db MR |
1168 | maxooblen = ((size_t)(mtd_div_by_ws(mtd->size, mtd) - |
1169 | mtd_div_by_ws(offs, mtd)) * | |
5cdd929d BB |
1170 | mtd_oobavail(mtd, ops)) - ops->ooboffs; |
1171 | if (ops->ooblen > maxooblen) | |
1172 | return -EINVAL; | |
1173 | } | |
1174 | ||
1175 | return 0; | |
1176 | } | |
1177 | ||
d2d48480 BN |
1178 | int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops) |
1179 | { | |
e47f6858 | 1180 | int ret_code; |
d2d48480 | 1181 | ops->retlen = ops->oobretlen = 0; |
fea728c0 | 1182 | |
5cdd929d BB |
1183 | ret_code = mtd_check_oob_ops(mtd, from, ops); |
1184 | if (ret_code) | |
1185 | return ret_code; | |
1186 | ||
fea728c0 | 1187 | ledtrig_mtd_activity(); |
89fd23ef MR |
1188 | |
1189 | /* Check the validity of a potential fallback on mtd->_read */ | |
1190 | if (!mtd->_read_oob && (!mtd->_read || ops->oobbuf)) | |
1191 | return -EOPNOTSUPP; | |
1192 | ||
1193 | if (mtd->_read_oob) | |
1194 | ret_code = mtd->_read_oob(mtd, from, ops); | |
1195 | else | |
1196 | ret_code = mtd->_read(mtd, from, ops->len, &ops->retlen, | |
1197 | ops->datbuf); | |
1198 | ||
e47f6858 BN |
1199 | /* |
1200 | * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics | |
1201 | * similar to mtd->_read(), returning a non-negative integer | |
1202 | * representing max bitflips. In other cases, mtd->_read_oob() may | |
1203 | * return -EUCLEAN. In all cases, perform similar logic to mtd_read(). | |
1204 | */ | |
e47f6858 BN |
1205 | if (unlikely(ret_code < 0)) |
1206 | return ret_code; | |
1207 | if (mtd->ecc_strength == 0) | |
1208 | return 0; /* device lacks ecc */ | |
1209 | return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0; | |
d2d48480 BN |
1210 | } |
1211 | EXPORT_SYMBOL_GPL(mtd_read_oob); | |
1212 | ||
0c034fe3 EG |
1213 | int mtd_write_oob(struct mtd_info *mtd, loff_t to, |
1214 | struct mtd_oob_ops *ops) | |
1215 | { | |
5cdd929d BB |
1216 | int ret; |
1217 | ||
0c034fe3 | 1218 | ops->retlen = ops->oobretlen = 0; |
89fd23ef | 1219 | |
0c034fe3 EG |
1220 | if (!(mtd->flags & MTD_WRITEABLE)) |
1221 | return -EROFS; | |
5cdd929d BB |
1222 | |
1223 | ret = mtd_check_oob_ops(mtd, to, ops); | |
1224 | if (ret) | |
1225 | return ret; | |
1226 | ||
fea728c0 | 1227 | ledtrig_mtd_activity(); |
89fd23ef MR |
1228 | |
1229 | /* Check the validity of a potential fallback on mtd->_write */ | |
1230 | if (!mtd->_write_oob && (!mtd->_write || ops->oobbuf)) | |
1231 | return -EOPNOTSUPP; | |
1232 | ||
1233 | if (mtd->_write_oob) | |
1234 | return mtd->_write_oob(mtd, to, ops); | |
1235 | else | |
1236 | return mtd->_write(mtd, to, ops->len, &ops->retlen, | |
1237 | ops->datbuf); | |
0c034fe3 EG |
1238 | } |
1239 | EXPORT_SYMBOL_GPL(mtd_write_oob); | |
1240 | ||
75eb2cec BB |
1241 | /** |
1242 | * mtd_ooblayout_ecc - Get the OOB region definition of a specific ECC section | |
1243 | * @mtd: MTD device structure | |
1244 | * @section: ECC section. Depending on the layout you may have all the ECC | |
1245 | * bytes stored in a single contiguous section, or one section | |
1246 | * per ECC chunk (and sometime several sections for a single ECC | |
1247 | * ECC chunk) | |
1248 | * @oobecc: OOB region struct filled with the appropriate ECC position | |
1249 | * information | |
1250 | * | |
7da0fffb | 1251 | * This function returns ECC section information in the OOB area. If you want |
75eb2cec BB |
1252 | * to get all the ECC bytes information, then you should call |
1253 | * mtd_ooblayout_ecc(mtd, section++, oobecc) until it returns -ERANGE. | |
1254 | * | |
1255 | * Returns zero on success, a negative error code otherwise. | |
1256 | */ | |
1257 | int mtd_ooblayout_ecc(struct mtd_info *mtd, int section, | |
1258 | struct mtd_oob_region *oobecc) | |
1259 | { | |
75eb2cec BB |
1260 | memset(oobecc, 0, sizeof(*oobecc)); |
1261 | ||
1262 | if (!mtd || section < 0) | |
1263 | return -EINVAL; | |
1264 | ||
adbbc3bc | 1265 | if (!mtd->ooblayout || !mtd->ooblayout->ecc) |
75eb2cec BB |
1266 | return -ENOTSUPP; |
1267 | ||
adbbc3bc | 1268 | return mtd->ooblayout->ecc(mtd, section, oobecc); |
75eb2cec BB |
1269 | } |
1270 | EXPORT_SYMBOL_GPL(mtd_ooblayout_ecc); | |
1271 | ||
1272 | /** | |
1273 | * mtd_ooblayout_free - Get the OOB region definition of a specific free | |
1274 | * section | |
1275 | * @mtd: MTD device structure | |
1276 | * @section: Free section you are interested in. Depending on the layout | |
1277 | * you may have all the free bytes stored in a single contiguous | |
1278 | * section, or one section per ECC chunk plus an extra section | |
1279 | * for the remaining bytes (or other funky layout). | |
1280 | * @oobfree: OOB region struct filled with the appropriate free position | |
1281 | * information | |
1282 | * | |
7da0fffb | 1283 | * This function returns free bytes position in the OOB area. If you want |
75eb2cec BB |
1284 | * to get all the free bytes information, then you should call |
1285 | * mtd_ooblayout_free(mtd, section++, oobfree) until it returns -ERANGE. | |
1286 | * | |
1287 | * Returns zero on success, a negative error code otherwise. | |
1288 | */ | |
1289 | int mtd_ooblayout_free(struct mtd_info *mtd, int section, | |
1290 | struct mtd_oob_region *oobfree) | |
1291 | { | |
1292 | memset(oobfree, 0, sizeof(*oobfree)); | |
1293 | ||
1294 | if (!mtd || section < 0) | |
1295 | return -EINVAL; | |
1296 | ||
adbbc3bc | 1297 | if (!mtd->ooblayout || !mtd->ooblayout->free) |
75eb2cec BB |
1298 | return -ENOTSUPP; |
1299 | ||
adbbc3bc | 1300 | return mtd->ooblayout->free(mtd, section, oobfree); |
75eb2cec BB |
1301 | } |
1302 | EXPORT_SYMBOL_GPL(mtd_ooblayout_free); | |
1303 | ||
1304 | /** | |
1305 | * mtd_ooblayout_find_region - Find the region attached to a specific byte | |
1306 | * @mtd: mtd info structure | |
1307 | * @byte: the byte we are searching for | |
1308 | * @sectionp: pointer where the section id will be stored | |
1309 | * @oobregion: used to retrieve the ECC position | |
1310 | * @iter: iterator function. Should be either mtd_ooblayout_free or | |
1311 | * mtd_ooblayout_ecc depending on the region type you're searching for | |
1312 | * | |
7da0fffb | 1313 | * This function returns the section id and oobregion information of a |
75eb2cec BB |
1314 | * specific byte. For example, say you want to know where the 4th ECC byte is |
1315 | * stored, you'll use: | |
1316 | * | |
1317 | * mtd_ooblayout_find_region(mtd, 3, §ion, &oobregion, mtd_ooblayout_ecc); | |
1318 | * | |
1319 | * Returns zero on success, a negative error code otherwise. | |
1320 | */ | |
1321 | static int mtd_ooblayout_find_region(struct mtd_info *mtd, int byte, | |
1322 | int *sectionp, struct mtd_oob_region *oobregion, | |
1323 | int (*iter)(struct mtd_info *, | |
1324 | int section, | |
1325 | struct mtd_oob_region *oobregion)) | |
1326 | { | |
1327 | int pos = 0, ret, section = 0; | |
1328 | ||
1329 | memset(oobregion, 0, sizeof(*oobregion)); | |
1330 | ||
1331 | while (1) { | |
1332 | ret = iter(mtd, section, oobregion); | |
1333 | if (ret) | |
1334 | return ret; | |
1335 | ||
1336 | if (pos + oobregion->length > byte) | |
1337 | break; | |
1338 | ||
1339 | pos += oobregion->length; | |
1340 | section++; | |
1341 | } | |
1342 | ||
1343 | /* | |
1344 | * Adjust region info to make it start at the beginning at the | |
1345 | * 'start' ECC byte. | |
1346 | */ | |
1347 | oobregion->offset += byte - pos; | |
1348 | oobregion->length -= byte - pos; | |
1349 | *sectionp = section; | |
1350 | ||
1351 | return 0; | |
1352 | } | |
1353 | ||
1354 | /** | |
1355 | * mtd_ooblayout_find_eccregion - Find the ECC region attached to a specific | |
1356 | * ECC byte | |
1357 | * @mtd: mtd info structure | |
1358 | * @eccbyte: the byte we are searching for | |
1359 | * @sectionp: pointer where the section id will be stored | |
1360 | * @oobregion: OOB region information | |
1361 | * | |
1362 | * Works like mtd_ooblayout_find_region() except it searches for a specific ECC | |
1363 | * byte. | |
1364 | * | |
1365 | * Returns zero on success, a negative error code otherwise. | |
1366 | */ | |
1367 | int mtd_ooblayout_find_eccregion(struct mtd_info *mtd, int eccbyte, | |
1368 | int *section, | |
1369 | struct mtd_oob_region *oobregion) | |
1370 | { | |
1371 | return mtd_ooblayout_find_region(mtd, eccbyte, section, oobregion, | |
1372 | mtd_ooblayout_ecc); | |
1373 | } | |
1374 | EXPORT_SYMBOL_GPL(mtd_ooblayout_find_eccregion); | |
1375 | ||
1376 | /** | |
1377 | * mtd_ooblayout_get_bytes - Extract OOB bytes from the oob buffer | |
1378 | * @mtd: mtd info structure | |
1379 | * @buf: destination buffer to store OOB bytes | |
1380 | * @oobbuf: OOB buffer | |
1381 | * @start: first byte to retrieve | |
1382 | * @nbytes: number of bytes to retrieve | |
1383 | * @iter: section iterator | |
1384 | * | |
1385 | * Extract bytes attached to a specific category (ECC or free) | |
1386 | * from the OOB buffer and copy them into buf. | |
1387 | * | |
1388 | * Returns zero on success, a negative error code otherwise. | |
1389 | */ | |
1390 | static int mtd_ooblayout_get_bytes(struct mtd_info *mtd, u8 *buf, | |
1391 | const u8 *oobbuf, int start, int nbytes, | |
1392 | int (*iter)(struct mtd_info *, | |
1393 | int section, | |
1394 | struct mtd_oob_region *oobregion)) | |
1395 | { | |
8e8fd4d1 MY |
1396 | struct mtd_oob_region oobregion; |
1397 | int section, ret; | |
75eb2cec BB |
1398 | |
1399 | ret = mtd_ooblayout_find_region(mtd, start, §ion, | |
1400 | &oobregion, iter); | |
1401 | ||
1402 | while (!ret) { | |
1403 | int cnt; | |
1404 | ||
7c295ef9 | 1405 | cnt = min_t(int, nbytes, oobregion.length); |
75eb2cec BB |
1406 | memcpy(buf, oobbuf + oobregion.offset, cnt); |
1407 | buf += cnt; | |
1408 | nbytes -= cnt; | |
1409 | ||
1410 | if (!nbytes) | |
1411 | break; | |
1412 | ||
1413 | ret = iter(mtd, ++section, &oobregion); | |
1414 | } | |
1415 | ||
1416 | return ret; | |
1417 | } | |
1418 | ||
1419 | /** | |
1420 | * mtd_ooblayout_set_bytes - put OOB bytes into the oob buffer | |
1421 | * @mtd: mtd info structure | |
1422 | * @buf: source buffer to get OOB bytes from | |
1423 | * @oobbuf: OOB buffer | |
1424 | * @start: first OOB byte to set | |
1425 | * @nbytes: number of OOB bytes to set | |
1426 | * @iter: section iterator | |
1427 | * | |
1428 | * Fill the OOB buffer with data provided in buf. The category (ECC or free) | |
1429 | * is selected by passing the appropriate iterator. | |
1430 | * | |
1431 | * Returns zero on success, a negative error code otherwise. | |
1432 | */ | |
1433 | static int mtd_ooblayout_set_bytes(struct mtd_info *mtd, const u8 *buf, | |
1434 | u8 *oobbuf, int start, int nbytes, | |
1435 | int (*iter)(struct mtd_info *, | |
1436 | int section, | |
1437 | struct mtd_oob_region *oobregion)) | |
1438 | { | |
8e8fd4d1 MY |
1439 | struct mtd_oob_region oobregion; |
1440 | int section, ret; | |
75eb2cec BB |
1441 | |
1442 | ret = mtd_ooblayout_find_region(mtd, start, §ion, | |
1443 | &oobregion, iter); | |
1444 | ||
1445 | while (!ret) { | |
1446 | int cnt; | |
1447 | ||
7c295ef9 | 1448 | cnt = min_t(int, nbytes, oobregion.length); |
75eb2cec BB |
1449 | memcpy(oobbuf + oobregion.offset, buf, cnt); |
1450 | buf += cnt; | |
1451 | nbytes -= cnt; | |
1452 | ||
1453 | if (!nbytes) | |
1454 | break; | |
1455 | ||
1456 | ret = iter(mtd, ++section, &oobregion); | |
1457 | } | |
1458 | ||
1459 | return ret; | |
1460 | } | |
1461 | ||
1462 | /** | |
1463 | * mtd_ooblayout_count_bytes - count the number of bytes in a OOB category | |
1464 | * @mtd: mtd info structure | |
1465 | * @iter: category iterator | |
1466 | * | |
1467 | * Count the number of bytes in a given category. | |
1468 | * | |
1469 | * Returns a positive value on success, a negative error code otherwise. | |
1470 | */ | |
1471 | static int mtd_ooblayout_count_bytes(struct mtd_info *mtd, | |
1472 | int (*iter)(struct mtd_info *, | |
1473 | int section, | |
1474 | struct mtd_oob_region *oobregion)) | |
1475 | { | |
4d6aecfb | 1476 | struct mtd_oob_region oobregion; |
75eb2cec BB |
1477 | int section = 0, ret, nbytes = 0; |
1478 | ||
1479 | while (1) { | |
1480 | ret = iter(mtd, section++, &oobregion); | |
1481 | if (ret) { | |
1482 | if (ret == -ERANGE) | |
1483 | ret = nbytes; | |
1484 | break; | |
1485 | } | |
1486 | ||
1487 | nbytes += oobregion.length; | |
1488 | } | |
1489 | ||
1490 | return ret; | |
1491 | } | |
1492 | ||
1493 | /** | |
1494 | * mtd_ooblayout_get_eccbytes - extract ECC bytes from the oob buffer | |
1495 | * @mtd: mtd info structure | |
1496 | * @eccbuf: destination buffer to store ECC bytes | |
1497 | * @oobbuf: OOB buffer | |
1498 | * @start: first ECC byte to retrieve | |
1499 | * @nbytes: number of ECC bytes to retrieve | |
1500 | * | |
1501 | * Works like mtd_ooblayout_get_bytes(), except it acts on ECC bytes. | |
1502 | * | |
1503 | * Returns zero on success, a negative error code otherwise. | |
1504 | */ | |
1505 | int mtd_ooblayout_get_eccbytes(struct mtd_info *mtd, u8 *eccbuf, | |
1506 | const u8 *oobbuf, int start, int nbytes) | |
1507 | { | |
1508 | return mtd_ooblayout_get_bytes(mtd, eccbuf, oobbuf, start, nbytes, | |
1509 | mtd_ooblayout_ecc); | |
1510 | } | |
1511 | EXPORT_SYMBOL_GPL(mtd_ooblayout_get_eccbytes); | |
1512 | ||
1513 | /** | |
1514 | * mtd_ooblayout_set_eccbytes - set ECC bytes into the oob buffer | |
1515 | * @mtd: mtd info structure | |
1516 | * @eccbuf: source buffer to get ECC bytes from | |
1517 | * @oobbuf: OOB buffer | |
1518 | * @start: first ECC byte to set | |
1519 | * @nbytes: number of ECC bytes to set | |
1520 | * | |
1521 | * Works like mtd_ooblayout_set_bytes(), except it acts on ECC bytes. | |
1522 | * | |
1523 | * Returns zero on success, a negative error code otherwise. | |
1524 | */ | |
1525 | int mtd_ooblayout_set_eccbytes(struct mtd_info *mtd, const u8 *eccbuf, | |
1526 | u8 *oobbuf, int start, int nbytes) | |
1527 | { | |
1528 | return mtd_ooblayout_set_bytes(mtd, eccbuf, oobbuf, start, nbytes, | |
1529 | mtd_ooblayout_ecc); | |
1530 | } | |
1531 | EXPORT_SYMBOL_GPL(mtd_ooblayout_set_eccbytes); | |
1532 | ||
1533 | /** | |
1534 | * mtd_ooblayout_get_databytes - extract data bytes from the oob buffer | |
1535 | * @mtd: mtd info structure | |
1536 | * @databuf: destination buffer to store ECC bytes | |
1537 | * @oobbuf: OOB buffer | |
1538 | * @start: first ECC byte to retrieve | |
1539 | * @nbytes: number of ECC bytes to retrieve | |
1540 | * | |
1541 | * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes. | |
1542 | * | |
1543 | * Returns zero on success, a negative error code otherwise. | |
1544 | */ | |
1545 | int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf, | |
1546 | const u8 *oobbuf, int start, int nbytes) | |
1547 | { | |
1548 | return mtd_ooblayout_get_bytes(mtd, databuf, oobbuf, start, nbytes, | |
1549 | mtd_ooblayout_free); | |
1550 | } | |
1551 | EXPORT_SYMBOL_GPL(mtd_ooblayout_get_databytes); | |
1552 | ||
1553 | /** | |
c77a9312 | 1554 | * mtd_ooblayout_set_databytes - set data bytes into the oob buffer |
75eb2cec | 1555 | * @mtd: mtd info structure |
c77a9312 | 1556 | * @databuf: source buffer to get data bytes from |
75eb2cec BB |
1557 | * @oobbuf: OOB buffer |
1558 | * @start: first ECC byte to set | |
1559 | * @nbytes: number of ECC bytes to set | |
1560 | * | |
1561 | * Works like mtd_ooblayout_get_bytes(), except it acts on free bytes. | |
1562 | * | |
1563 | * Returns zero on success, a negative error code otherwise. | |
1564 | */ | |
1565 | int mtd_ooblayout_set_databytes(struct mtd_info *mtd, const u8 *databuf, | |
1566 | u8 *oobbuf, int start, int nbytes) | |
1567 | { | |
1568 | return mtd_ooblayout_set_bytes(mtd, databuf, oobbuf, start, nbytes, | |
1569 | mtd_ooblayout_free); | |
1570 | } | |
1571 | EXPORT_SYMBOL_GPL(mtd_ooblayout_set_databytes); | |
1572 | ||
1573 | /** | |
1574 | * mtd_ooblayout_count_freebytes - count the number of free bytes in OOB | |
1575 | * @mtd: mtd info structure | |
1576 | * | |
1577 | * Works like mtd_ooblayout_count_bytes(), except it count free bytes. | |
1578 | * | |
1579 | * Returns zero on success, a negative error code otherwise. | |
1580 | */ | |
1581 | int mtd_ooblayout_count_freebytes(struct mtd_info *mtd) | |
1582 | { | |
1583 | return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_free); | |
1584 | } | |
1585 | EXPORT_SYMBOL_GPL(mtd_ooblayout_count_freebytes); | |
1586 | ||
1587 | /** | |
c77a9312 | 1588 | * mtd_ooblayout_count_eccbytes - count the number of ECC bytes in OOB |
75eb2cec BB |
1589 | * @mtd: mtd info structure |
1590 | * | |
1591 | * Works like mtd_ooblayout_count_bytes(), except it count ECC bytes. | |
1592 | * | |
1593 | * Returns zero on success, a negative error code otherwise. | |
1594 | */ | |
1595 | int mtd_ooblayout_count_eccbytes(struct mtd_info *mtd) | |
1596 | { | |
1597 | return mtd_ooblayout_count_bytes(mtd, mtd_ooblayout_ecc); | |
1598 | } | |
1599 | EXPORT_SYMBOL_GPL(mtd_ooblayout_count_eccbytes); | |
1600 | ||
de3cac93 AB |
1601 | /* |
1602 | * Method to access the protection register area, present in some flash | |
1603 | * devices. The user data is one time programmable but the factory data is read | |
1604 | * only. | |
1605 | */ | |
4b78fc42 CR |
1606 | int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, |
1607 | struct otp_info *buf) | |
de3cac93 AB |
1608 | { |
1609 | if (!mtd->_get_fact_prot_info) | |
1610 | return -EOPNOTSUPP; | |
1611 | if (!len) | |
1612 | return 0; | |
4b78fc42 | 1613 | return mtd->_get_fact_prot_info(mtd, len, retlen, buf); |
de3cac93 AB |
1614 | } |
1615 | EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info); | |
1616 | ||
1617 | int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
1618 | size_t *retlen, u_char *buf) | |
1619 | { | |
1620 | *retlen = 0; | |
1621 | if (!mtd->_read_fact_prot_reg) | |
1622 | return -EOPNOTSUPP; | |
1623 | if (!len) | |
1624 | return 0; | |
1625 | return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf); | |
1626 | } | |
1627 | EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg); | |
1628 | ||
4b78fc42 CR |
1629 | int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, |
1630 | struct otp_info *buf) | |
de3cac93 AB |
1631 | { |
1632 | if (!mtd->_get_user_prot_info) | |
1633 | return -EOPNOTSUPP; | |
1634 | if (!len) | |
1635 | return 0; | |
4b78fc42 | 1636 | return mtd->_get_user_prot_info(mtd, len, retlen, buf); |
de3cac93 AB |
1637 | } |
1638 | EXPORT_SYMBOL_GPL(mtd_get_user_prot_info); | |
1639 | ||
1640 | int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
1641 | size_t *retlen, u_char *buf) | |
1642 | { | |
1643 | *retlen = 0; | |
1644 | if (!mtd->_read_user_prot_reg) | |
1645 | return -EOPNOTSUPP; | |
1646 | if (!len) | |
1647 | return 0; | |
1648 | return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf); | |
1649 | } | |
1650 | EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg); | |
1651 | ||
1652 | int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, | |
1653 | size_t *retlen, u_char *buf) | |
1654 | { | |
9a78bc83 CR |
1655 | int ret; |
1656 | ||
de3cac93 AB |
1657 | *retlen = 0; |
1658 | if (!mtd->_write_user_prot_reg) | |
1659 | return -EOPNOTSUPP; | |
1660 | if (!len) | |
1661 | return 0; | |
9a78bc83 CR |
1662 | ret = mtd->_write_user_prot_reg(mtd, to, len, retlen, buf); |
1663 | if (ret) | |
1664 | return ret; | |
1665 | ||
1666 | /* | |
1667 | * If no data could be written at all, we are out of memory and | |
1668 | * must return -ENOSPC. | |
1669 | */ | |
1670 | return (*retlen) ? 0 : -ENOSPC; | |
de3cac93 AB |
1671 | } |
1672 | EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg); | |
1673 | ||
1674 | int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len) | |
1675 | { | |
1676 | if (!mtd->_lock_user_prot_reg) | |
1677 | return -EOPNOTSUPP; | |
1678 | if (!len) | |
1679 | return 0; | |
1680 | return mtd->_lock_user_prot_reg(mtd, from, len); | |
1681 | } | |
1682 | EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg); | |
1683 | ||
8273a0c9 AB |
1684 | /* Chip-supported device locking */ |
1685 | int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1686 | { | |
1687 | if (!mtd->_lock) | |
1688 | return -EOPNOTSUPP; | |
0c2b4e21 | 1689 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1690 | return -EINVAL; |
bcb1d238 AB |
1691 | if (!len) |
1692 | return 0; | |
8273a0c9 AB |
1693 | return mtd->_lock(mtd, ofs, len); |
1694 | } | |
1695 | EXPORT_SYMBOL_GPL(mtd_lock); | |
1696 | ||
1697 | int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1698 | { | |
1699 | if (!mtd->_unlock) | |
1700 | return -EOPNOTSUPP; | |
0c2b4e21 | 1701 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1702 | return -EINVAL; |
bcb1d238 AB |
1703 | if (!len) |
1704 | return 0; | |
8273a0c9 AB |
1705 | return mtd->_unlock(mtd, ofs, len); |
1706 | } | |
1707 | EXPORT_SYMBOL_GPL(mtd_unlock); | |
1708 | ||
1709 | int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1710 | { | |
1711 | if (!mtd->_is_locked) | |
1712 | return -EOPNOTSUPP; | |
0c2b4e21 | 1713 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1714 | return -EINVAL; |
bcb1d238 AB |
1715 | if (!len) |
1716 | return 0; | |
8273a0c9 AB |
1717 | return mtd->_is_locked(mtd, ofs, len); |
1718 | } | |
1719 | EXPORT_SYMBOL_GPL(mtd_is_locked); | |
1720 | ||
8471bb73 | 1721 | int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs) |
8273a0c9 | 1722 | { |
0c2b4e21 | 1723 | if (ofs < 0 || ofs >= mtd->size) |
8471bb73 EG |
1724 | return -EINVAL; |
1725 | if (!mtd->_block_isreserved) | |
8273a0c9 | 1726 | return 0; |
8471bb73 EG |
1727 | return mtd->_block_isreserved(mtd, ofs); |
1728 | } | |
1729 | EXPORT_SYMBOL_GPL(mtd_block_isreserved); | |
1730 | ||
1731 | int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs) | |
1732 | { | |
0c2b4e21 | 1733 | if (ofs < 0 || ofs >= mtd->size) |
8273a0c9 | 1734 | return -EINVAL; |
8471bb73 EG |
1735 | if (!mtd->_block_isbad) |
1736 | return 0; | |
8273a0c9 AB |
1737 | return mtd->_block_isbad(mtd, ofs); |
1738 | } | |
1739 | EXPORT_SYMBOL_GPL(mtd_block_isbad); | |
1740 | ||
1741 | int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs) | |
1742 | { | |
1743 | if (!mtd->_block_markbad) | |
1744 | return -EOPNOTSUPP; | |
0c2b4e21 | 1745 | if (ofs < 0 || ofs >= mtd->size) |
8273a0c9 | 1746 | return -EINVAL; |
664addc2 AB |
1747 | if (!(mtd->flags & MTD_WRITEABLE)) |
1748 | return -EROFS; | |
8273a0c9 AB |
1749 | return mtd->_block_markbad(mtd, ofs); |
1750 | } | |
1751 | EXPORT_SYMBOL_GPL(mtd_block_markbad); | |
1752 | ||
52b02031 AB |
1753 | /* |
1754 | * default_mtd_writev - the default writev method | |
1755 | * @mtd: mtd device description object pointer | |
1756 | * @vecs: the vectors to write | |
1757 | * @count: count of vectors in @vecs | |
1758 | * @to: the MTD device offset to write to | |
1759 | * @retlen: on exit contains the count of bytes written to the MTD device. | |
1760 | * | |
1761 | * This function returns zero in case of success and a negative error code in | |
1762 | * case of failure. | |
1da177e4 | 1763 | */ |
1dbebd32 AB |
1764 | static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, |
1765 | unsigned long count, loff_t to, size_t *retlen) | |
1da177e4 LT |
1766 | { |
1767 | unsigned long i; | |
1768 | size_t totlen = 0, thislen; | |
1769 | int ret = 0; | |
1770 | ||
52b02031 AB |
1771 | for (i = 0; i < count; i++) { |
1772 | if (!vecs[i].iov_len) | |
1773 | continue; | |
1774 | ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen, | |
1775 | vecs[i].iov_base); | |
1776 | totlen += thislen; | |
1777 | if (ret || thislen != vecs[i].iov_len) | |
1778 | break; | |
1779 | to += vecs[i].iov_len; | |
1da177e4 | 1780 | } |
52b02031 | 1781 | *retlen = totlen; |
1da177e4 LT |
1782 | return ret; |
1783 | } | |
1dbebd32 AB |
1784 | |
1785 | /* | |
1786 | * mtd_writev - the vector-based MTD write method | |
1787 | * @mtd: mtd device description object pointer | |
1788 | * @vecs: the vectors to write | |
1789 | * @count: count of vectors in @vecs | |
1790 | * @to: the MTD device offset to write to | |
1791 | * @retlen: on exit contains the count of bytes written to the MTD device. | |
1792 | * | |
1793 | * This function returns zero in case of success and a negative error code in | |
1794 | * case of failure. | |
1795 | */ | |
1796 | int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, | |
1797 | unsigned long count, loff_t to, size_t *retlen) | |
1798 | { | |
1799 | *retlen = 0; | |
664addc2 AB |
1800 | if (!(mtd->flags & MTD_WRITEABLE)) |
1801 | return -EROFS; | |
3c3c10bb | 1802 | if (!mtd->_writev) |
1dbebd32 | 1803 | return default_mtd_writev(mtd, vecs, count, to, retlen); |
3c3c10bb | 1804 | return mtd->_writev(mtd, vecs, count, to, retlen); |
1dbebd32 AB |
1805 | } |
1806 | EXPORT_SYMBOL_GPL(mtd_writev); | |
1da177e4 | 1807 | |
33b53716 GE |
1808 | /** |
1809 | * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size | |
52b02031 AB |
1810 | * @mtd: mtd device description object pointer |
1811 | * @size: a pointer to the ideal or maximum size of the allocation, points | |
33b53716 GE |
1812 | * to the actual allocation size on success. |
1813 | * | |
1814 | * This routine attempts to allocate a contiguous kernel buffer up to | |
1815 | * the specified size, backing off the size of the request exponentially | |
1816 | * until the request succeeds or until the allocation size falls below | |
1817 | * the system page size. This attempts to make sure it does not adversely | |
1818 | * impact system performance, so when allocating more than one page, we | |
caf49191 LT |
1819 | * ask the memory allocator to avoid re-trying, swapping, writing back |
1820 | * or performing I/O. | |
33b53716 GE |
1821 | * |
1822 | * Note, this function also makes sure that the allocated buffer is aligned to | |
1823 | * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value. | |
1824 | * | |
1825 | * This is called, for example by mtd_{read,write} and jffs2_scan_medium, | |
1826 | * to handle smaller (i.e. degraded) buffer allocations under low- or | |
1827 | * fragmented-memory situations where such reduced allocations, from a | |
1828 | * requested ideal, are allowed. | |
1829 | * | |
1830 | * Returns a pointer to the allocated buffer on success; otherwise, NULL. | |
1831 | */ | |
1832 | void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size) | |
1833 | { | |
d0164adc | 1834 | gfp_t flags = __GFP_NOWARN | __GFP_DIRECT_RECLAIM | __GFP_NORETRY; |
33b53716 GE |
1835 | size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE); |
1836 | void *kbuf; | |
1837 | ||
1838 | *size = min_t(size_t, *size, KMALLOC_MAX_SIZE); | |
1839 | ||
1840 | while (*size > min_alloc) { | |
1841 | kbuf = kmalloc(*size, flags); | |
1842 | if (kbuf) | |
1843 | return kbuf; | |
1844 | ||
1845 | *size >>= 1; | |
1846 | *size = ALIGN(*size, mtd->writesize); | |
1847 | } | |
1848 | ||
1849 | /* | |
1850 | * For the last resort allocation allow 'kmalloc()' to do all sorts of | |
1851 | * things (write-back, dropping caches, etc) by using GFP_KERNEL. | |
1852 | */ | |
1853 | return kmalloc(*size, GFP_KERNEL); | |
1854 | } | |
33b53716 | 1855 | EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to); |
1da177e4 | 1856 | |
2d2dce0e PM |
1857 | #ifdef CONFIG_PROC_FS |
1858 | ||
1da177e4 LT |
1859 | /*====================================================================*/ |
1860 | /* Support for /proc/mtd */ | |
1861 | ||
447d9bd8 | 1862 | static int mtd_proc_show(struct seq_file *m, void *v) |
1da177e4 | 1863 | { |
f1332ba2 | 1864 | struct mtd_info *mtd; |
1da177e4 | 1865 | |
447d9bd8 | 1866 | seq_puts(m, "dev: size erasesize name\n"); |
48b19268 | 1867 | mutex_lock(&mtd_table_mutex); |
f1332ba2 | 1868 | mtd_for_each_device(mtd) { |
447d9bd8 AD |
1869 | seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n", |
1870 | mtd->index, (unsigned long long)mtd->size, | |
1871 | mtd->erasesize, mtd->name); | |
d5ca5129 | 1872 | } |
48b19268 | 1873 | mutex_unlock(&mtd_table_mutex); |
d5ca5129 | 1874 | return 0; |
1da177e4 | 1875 | } |
45b09076 KC |
1876 | #endif /* CONFIG_PROC_FS */ |
1877 | ||
1da177e4 LT |
1878 | /*====================================================================*/ |
1879 | /* Init code */ | |
1880 | ||
445caaa2 | 1881 | static struct backing_dev_info * __init mtd_bdi_init(char *name) |
0661b1ac | 1882 | { |
445caaa2 | 1883 | struct backing_dev_info *bdi; |
0661b1ac JA |
1884 | int ret; |
1885 | ||
fa06052d | 1886 | bdi = bdi_alloc(GFP_KERNEL); |
445caaa2 SL |
1887 | if (!bdi) |
1888 | return ERR_PTR(-ENOMEM); | |
0661b1ac | 1889 | |
fa06052d JK |
1890 | bdi->name = name; |
1891 | /* | |
1892 | * We put '-0' suffix to the name to get the same name format as we | |
1893 | * used to get. Since this is called only once, we get a unique name. | |
1894 | */ | |
7c4cc300 | 1895 | ret = bdi_register(bdi, "%.28s-0", name); |
0661b1ac | 1896 | if (ret) |
fa06052d | 1897 | bdi_put(bdi); |
0661b1ac | 1898 | |
445caaa2 | 1899 | return ret ? ERR_PTR(ret) : bdi; |
0661b1ac JA |
1900 | } |
1901 | ||
93e56214 AB |
1902 | static struct proc_dir_entry *proc_mtd; |
1903 | ||
1da177e4 LT |
1904 | static int __init init_mtd(void) |
1905 | { | |
15bce40c | 1906 | int ret; |
0661b1ac | 1907 | |
15bce40c | 1908 | ret = class_register(&mtd_class); |
0661b1ac JA |
1909 | if (ret) |
1910 | goto err_reg; | |
1911 | ||
445caaa2 SL |
1912 | mtd_bdi = mtd_bdi_init("mtd"); |
1913 | if (IS_ERR(mtd_bdi)) { | |
1914 | ret = PTR_ERR(mtd_bdi); | |
b4caecd4 | 1915 | goto err_bdi; |
445caaa2 | 1916 | } |
694bb7fc | 1917 | |
3f3942ac | 1918 | proc_mtd = proc_create_single("mtd", 0, NULL, mtd_proc_show); |
93e56214 | 1919 | |
660685d9 AB |
1920 | ret = init_mtdchar(); |
1921 | if (ret) | |
1922 | goto out_procfs; | |
1923 | ||
e8e3edb9 MR |
1924 | dfs_dir_mtd = debugfs_create_dir("mtd", NULL); |
1925 | ||
1da177e4 | 1926 | return 0; |
0661b1ac | 1927 | |
660685d9 AB |
1928 | out_procfs: |
1929 | if (proc_mtd) | |
1930 | remove_proc_entry("mtd", NULL); | |
fa06052d | 1931 | bdi_put(mtd_bdi); |
b4caecd4 | 1932 | err_bdi: |
0661b1ac JA |
1933 | class_unregister(&mtd_class); |
1934 | err_reg: | |
1935 | pr_err("Error registering mtd class or bdi: %d\n", ret); | |
1936 | return ret; | |
1da177e4 LT |
1937 | } |
1938 | ||
1939 | static void __exit cleanup_mtd(void) | |
1940 | { | |
e8e3edb9 | 1941 | debugfs_remove_recursive(dfs_dir_mtd); |
660685d9 | 1942 | cleanup_mtdchar(); |
d5ca5129 | 1943 | if (proc_mtd) |
93e56214 | 1944 | remove_proc_entry("mtd", NULL); |
15bce40c | 1945 | class_unregister(&mtd_class); |
fa06052d | 1946 | bdi_put(mtd_bdi); |
35667b99 | 1947 | idr_destroy(&mtd_idr); |
1da177e4 LT |
1948 | } |
1949 | ||
1950 | module_init(init_mtd); | |
1951 | module_exit(cleanup_mtd); | |
1952 | ||
1da177e4 LT |
1953 | MODULE_LICENSE("GPL"); |
1954 | MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>"); | |
1955 | MODULE_DESCRIPTION("Core MTD registration and access routines"); |