]>
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> |
727dc612 | 42 | #include <linux/kconfig.h> |
1da177e4 LT |
43 | |
44 | #include <linux/mtd/mtd.h> | |
f5671ab3 | 45 | #include <linux/mtd/partitions.h> |
1da177e4 | 46 | |
356d70f1 | 47 | #include "mtdcore.h" |
660685d9 | 48 | |
b4caecd4 | 49 | static struct backing_dev_info mtd_bdi = { |
a33eb6b9 | 50 | }; |
356d70f1 | 51 | |
57b8045d LPC |
52 | #ifdef CONFIG_PM_SLEEP |
53 | ||
54 | static int mtd_cls_suspend(struct device *dev) | |
55 | { | |
56 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
57 | ||
58 | return mtd ? mtd_suspend(mtd) : 0; | |
59 | } | |
60 | ||
61 | static int mtd_cls_resume(struct device *dev) | |
62 | { | |
63 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
64 | ||
65 | if (mtd) | |
66 | mtd_resume(mtd); | |
67 | return 0; | |
68 | } | |
69 | ||
70 | static SIMPLE_DEV_PM_OPS(mtd_cls_pm_ops, mtd_cls_suspend, mtd_cls_resume); | |
71 | #define MTD_CLS_PM_OPS (&mtd_cls_pm_ops) | |
72 | #else | |
73 | #define MTD_CLS_PM_OPS NULL | |
74 | #endif | |
15bce40c DW |
75 | |
76 | static struct class mtd_class = { | |
77 | .name = "mtd", | |
78 | .owner = THIS_MODULE, | |
57b8045d | 79 | .pm = MTD_CLS_PM_OPS, |
15bce40c | 80 | }; |
1f24b5a8 | 81 | |
b520e412 BH |
82 | static DEFINE_IDR(mtd_idr); |
83 | ||
97894cda | 84 | /* These are exported solely for the purpose of mtd_blkdevs.c. You |
1da177e4 | 85 | should not use them for _anything_ else */ |
48b19268 | 86 | DEFINE_MUTEX(mtd_table_mutex); |
1da177e4 | 87 | EXPORT_SYMBOL_GPL(mtd_table_mutex); |
b520e412 BH |
88 | |
89 | struct mtd_info *__mtd_next_device(int i) | |
90 | { | |
91 | return idr_get_next(&mtd_idr, &i); | |
92 | } | |
93 | EXPORT_SYMBOL_GPL(__mtd_next_device); | |
1da177e4 LT |
94 | |
95 | static LIST_HEAD(mtd_notifiers); | |
96 | ||
1f24b5a8 | 97 | |
1f24b5a8 | 98 | #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2) |
1f24b5a8 DB |
99 | |
100 | /* REVISIT once MTD uses the driver model better, whoever allocates | |
101 | * the mtd_info will probably want to use the release() hook... | |
102 | */ | |
103 | static void mtd_release(struct device *dev) | |
104 | { | |
5e472128 | 105 | struct mtd_info *mtd = dev_get_drvdata(dev); |
d5de20a9 | 106 | dev_t index = MTD_DEVT(mtd->index); |
1f24b5a8 | 107 | |
5e472128 BN |
108 | /* remove /dev/mtdXro node */ |
109 | device_destroy(&mtd_class, index + 1); | |
15bce40c DW |
110 | } |
111 | ||
1f24b5a8 DB |
112 | static ssize_t mtd_type_show(struct device *dev, |
113 | struct device_attribute *attr, char *buf) | |
114 | { | |
d5de20a9 | 115 | struct mtd_info *mtd = dev_get_drvdata(dev); |
1f24b5a8 DB |
116 | char *type; |
117 | ||
118 | switch (mtd->type) { | |
119 | case MTD_ABSENT: | |
120 | type = "absent"; | |
121 | break; | |
122 | case MTD_RAM: | |
123 | type = "ram"; | |
124 | break; | |
125 | case MTD_ROM: | |
126 | type = "rom"; | |
127 | break; | |
128 | case MTD_NORFLASH: | |
129 | type = "nor"; | |
130 | break; | |
131 | case MTD_NANDFLASH: | |
132 | type = "nand"; | |
133 | break; | |
134 | case MTD_DATAFLASH: | |
135 | type = "dataflash"; | |
136 | break; | |
137 | case MTD_UBIVOLUME: | |
138 | type = "ubi"; | |
139 | break; | |
f4837246 HS |
140 | case MTD_MLCNANDFLASH: |
141 | type = "mlc-nand"; | |
142 | break; | |
1f24b5a8 DB |
143 | default: |
144 | type = "unknown"; | |
145 | } | |
146 | ||
147 | return snprintf(buf, PAGE_SIZE, "%s\n", type); | |
148 | } | |
694bb7fc KC |
149 | static DEVICE_ATTR(type, S_IRUGO, mtd_type_show, NULL); |
150 | ||
151 | static ssize_t mtd_flags_show(struct device *dev, | |
152 | struct device_attribute *attr, char *buf) | |
153 | { | |
d5de20a9 | 154 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
155 | |
156 | return snprintf(buf, PAGE_SIZE, "0x%lx\n", (unsigned long)mtd->flags); | |
157 | ||
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); | |
168 | ||
169 | } | |
170 | static DEVICE_ATTR(size, S_IRUGO, mtd_size_show, NULL); | |
171 | ||
172 | static ssize_t mtd_erasesize_show(struct device *dev, | |
173 | struct device_attribute *attr, char *buf) | |
174 | { | |
d5de20a9 | 175 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
176 | |
177 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->erasesize); | |
178 | ||
179 | } | |
180 | static DEVICE_ATTR(erasesize, S_IRUGO, mtd_erasesize_show, NULL); | |
181 | ||
182 | static ssize_t mtd_writesize_show(struct device *dev, | |
183 | struct device_attribute *attr, char *buf) | |
184 | { | |
d5de20a9 | 185 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
186 | |
187 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->writesize); | |
188 | ||
189 | } | |
190 | static DEVICE_ATTR(writesize, S_IRUGO, mtd_writesize_show, NULL); | |
191 | ||
e7693548 AB |
192 | static ssize_t mtd_subpagesize_show(struct device *dev, |
193 | struct device_attribute *attr, char *buf) | |
194 | { | |
d5de20a9 | 195 | struct mtd_info *mtd = dev_get_drvdata(dev); |
e7693548 AB |
196 | unsigned int subpagesize = mtd->writesize >> mtd->subpage_sft; |
197 | ||
198 | return snprintf(buf, PAGE_SIZE, "%u\n", subpagesize); | |
199 | ||
200 | } | |
201 | static DEVICE_ATTR(subpagesize, S_IRUGO, mtd_subpagesize_show, NULL); | |
202 | ||
694bb7fc KC |
203 | static ssize_t mtd_oobsize_show(struct device *dev, |
204 | struct device_attribute *attr, char *buf) | |
205 | { | |
d5de20a9 | 206 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
207 | |
208 | return snprintf(buf, PAGE_SIZE, "%lu\n", (unsigned long)mtd->oobsize); | |
209 | ||
210 | } | |
211 | static DEVICE_ATTR(oobsize, S_IRUGO, mtd_oobsize_show, NULL); | |
212 | ||
213 | static ssize_t mtd_numeraseregions_show(struct device *dev, | |
214 | struct device_attribute *attr, char *buf) | |
215 | { | |
d5de20a9 | 216 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
217 | |
218 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->numeraseregions); | |
219 | ||
220 | } | |
221 | static DEVICE_ATTR(numeraseregions, S_IRUGO, mtd_numeraseregions_show, | |
222 | NULL); | |
223 | ||
224 | static ssize_t mtd_name_show(struct device *dev, | |
225 | struct device_attribute *attr, char *buf) | |
226 | { | |
d5de20a9 | 227 | struct mtd_info *mtd = dev_get_drvdata(dev); |
694bb7fc KC |
228 | |
229 | return snprintf(buf, PAGE_SIZE, "%s\n", mtd->name); | |
230 | ||
231 | } | |
232 | static DEVICE_ATTR(name, S_IRUGO, mtd_name_show, NULL); | |
1f24b5a8 | 233 | |
a9b672e8 MD |
234 | static ssize_t mtd_ecc_strength_show(struct device *dev, |
235 | struct device_attribute *attr, char *buf) | |
236 | { | |
237 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
238 | ||
239 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_strength); | |
240 | } | |
241 | static DEVICE_ATTR(ecc_strength, S_IRUGO, mtd_ecc_strength_show, NULL); | |
242 | ||
d062d4ed MD |
243 | static ssize_t mtd_bitflip_threshold_show(struct device *dev, |
244 | struct device_attribute *attr, | |
245 | char *buf) | |
246 | { | |
247 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
248 | ||
249 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->bitflip_threshold); | |
250 | } | |
251 | ||
252 | static ssize_t mtd_bitflip_threshold_store(struct device *dev, | |
253 | struct device_attribute *attr, | |
254 | const char *buf, size_t count) | |
255 | { | |
256 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
257 | unsigned int bitflip_threshold; | |
258 | int retval; | |
259 | ||
260 | retval = kstrtouint(buf, 0, &bitflip_threshold); | |
261 | if (retval) | |
262 | return retval; | |
263 | ||
264 | mtd->bitflip_threshold = bitflip_threshold; | |
265 | return count; | |
266 | } | |
267 | static DEVICE_ATTR(bitflip_threshold, S_IRUGO | S_IWUSR, | |
268 | mtd_bitflip_threshold_show, | |
269 | mtd_bitflip_threshold_store); | |
270 | ||
bf977e3f HS |
271 | static ssize_t mtd_ecc_step_size_show(struct device *dev, |
272 | struct device_attribute *attr, char *buf) | |
273 | { | |
274 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
275 | ||
276 | return snprintf(buf, PAGE_SIZE, "%u\n", mtd->ecc_step_size); | |
277 | ||
278 | } | |
279 | static DEVICE_ATTR(ecc_step_size, S_IRUGO, mtd_ecc_step_size_show, NULL); | |
280 | ||
990a3af0 EG |
281 | static ssize_t mtd_ecc_stats_corrected_show(struct device *dev, |
282 | struct device_attribute *attr, char *buf) | |
283 | { | |
284 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
285 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
286 | ||
287 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->corrected); | |
288 | } | |
289 | static DEVICE_ATTR(corrected_bits, S_IRUGO, | |
290 | mtd_ecc_stats_corrected_show, NULL); | |
291 | ||
292 | static ssize_t mtd_ecc_stats_errors_show(struct device *dev, | |
293 | struct device_attribute *attr, char *buf) | |
294 | { | |
295 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
296 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
297 | ||
298 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->failed); | |
299 | } | |
300 | static DEVICE_ATTR(ecc_failures, S_IRUGO, mtd_ecc_stats_errors_show, NULL); | |
301 | ||
302 | static ssize_t mtd_badblocks_show(struct device *dev, | |
303 | struct device_attribute *attr, char *buf) | |
304 | { | |
305 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
306 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
307 | ||
308 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->badblocks); | |
309 | } | |
310 | static DEVICE_ATTR(bad_blocks, S_IRUGO, mtd_badblocks_show, NULL); | |
311 | ||
312 | static ssize_t mtd_bbtblocks_show(struct device *dev, | |
313 | struct device_attribute *attr, char *buf) | |
314 | { | |
315 | struct mtd_info *mtd = dev_get_drvdata(dev); | |
316 | struct mtd_ecc_stats *ecc_stats = &mtd->ecc_stats; | |
317 | ||
318 | return snprintf(buf, PAGE_SIZE, "%u\n", ecc_stats->bbtblocks); | |
319 | } | |
320 | static DEVICE_ATTR(bbt_blocks, S_IRUGO, mtd_bbtblocks_show, NULL); | |
321 | ||
1f24b5a8 | 322 | static struct attribute *mtd_attrs[] = { |
694bb7fc KC |
323 | &dev_attr_type.attr, |
324 | &dev_attr_flags.attr, | |
325 | &dev_attr_size.attr, | |
326 | &dev_attr_erasesize.attr, | |
327 | &dev_attr_writesize.attr, | |
e7693548 | 328 | &dev_attr_subpagesize.attr, |
694bb7fc KC |
329 | &dev_attr_oobsize.attr, |
330 | &dev_attr_numeraseregions.attr, | |
331 | &dev_attr_name.attr, | |
a9b672e8 | 332 | &dev_attr_ecc_strength.attr, |
bf977e3f | 333 | &dev_attr_ecc_step_size.attr, |
990a3af0 EG |
334 | &dev_attr_corrected_bits.attr, |
335 | &dev_attr_ecc_failures.attr, | |
336 | &dev_attr_bad_blocks.attr, | |
337 | &dev_attr_bbt_blocks.attr, | |
d062d4ed | 338 | &dev_attr_bitflip_threshold.attr, |
1f24b5a8 DB |
339 | NULL, |
340 | }; | |
54c738f6 | 341 | ATTRIBUTE_GROUPS(mtd); |
1f24b5a8 DB |
342 | |
343 | static struct device_type mtd_devtype = { | |
344 | .name = "mtd", | |
345 | .groups = mtd_groups, | |
346 | .release = mtd_release, | |
347 | }; | |
348 | ||
b4caecd4 CH |
349 | #ifndef CONFIG_MMU |
350 | unsigned mtd_mmap_capabilities(struct mtd_info *mtd) | |
351 | { | |
352 | switch (mtd->type) { | |
353 | case MTD_RAM: | |
354 | return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC | | |
355 | NOMMU_MAP_READ | NOMMU_MAP_WRITE; | |
356 | case MTD_ROM: | |
357 | return NOMMU_MAP_COPY | NOMMU_MAP_DIRECT | NOMMU_MAP_EXEC | | |
358 | NOMMU_MAP_READ; | |
359 | default: | |
360 | return NOMMU_MAP_COPY; | |
361 | } | |
362 | } | |
706a4e5a | 363 | EXPORT_SYMBOL_GPL(mtd_mmap_capabilities); |
b4caecd4 CH |
364 | #endif |
365 | ||
3efe41be BN |
366 | static int mtd_reboot_notifier(struct notifier_block *n, unsigned long state, |
367 | void *cmd) | |
368 | { | |
369 | struct mtd_info *mtd; | |
370 | ||
371 | mtd = container_of(n, struct mtd_info, reboot_notifier); | |
372 | mtd->_reboot(mtd); | |
373 | ||
374 | return NOTIFY_DONE; | |
375 | } | |
376 | ||
1da177e4 LT |
377 | /** |
378 | * add_mtd_device - register an MTD device | |
379 | * @mtd: pointer to new MTD device info structure | |
380 | * | |
381 | * Add a device to the list of MTD devices present in the system, and | |
382 | * notify each currently active MTD 'user' of its arrival. Returns | |
57dd990c | 383 | * zero on success or non-zero on failure. |
1da177e4 LT |
384 | */ |
385 | ||
386 | int add_mtd_device(struct mtd_info *mtd) | |
387 | { | |
b520e412 BH |
388 | struct mtd_notifier *not; |
389 | int i, error; | |
1da177e4 | 390 | |
be0dbff8 BN |
391 | /* |
392 | * May occur, for instance, on buggy drivers which call | |
393 | * mtd_device_parse_register() multiple times on the same master MTD, | |
394 | * especially with CONFIG_MTD_PARTITIONED_MASTER=y. | |
395 | */ | |
396 | if (WARN_ONCE(mtd->backing_dev_info, "MTD already registered\n")) | |
397 | return -EEXIST; | |
398 | ||
b4caecd4 | 399 | mtd->backing_dev_info = &mtd_bdi; |
402d3265 | 400 | |
783ed81f | 401 | BUG_ON(mtd->writesize == 0); |
48b19268 | 402 | mutex_lock(&mtd_table_mutex); |
1da177e4 | 403 | |
589e9c4d | 404 | i = idr_alloc(&mtd_idr, mtd, 0, 0, GFP_KERNEL); |
57dd990c BN |
405 | if (i < 0) { |
406 | error = i; | |
b520e412 | 407 | goto fail_locked; |
57dd990c | 408 | } |
1f24b5a8 | 409 | |
b520e412 BH |
410 | mtd->index = i; |
411 | mtd->usecount = 0; | |
412 | ||
d062d4ed MD |
413 | /* default value if not set by driver */ |
414 | if (mtd->bitflip_threshold == 0) | |
415 | mtd->bitflip_threshold = mtd->ecc_strength; | |
416 | ||
b520e412 BH |
417 | if (is_power_of_2(mtd->erasesize)) |
418 | mtd->erasesize_shift = ffs(mtd->erasesize) - 1; | |
419 | else | |
420 | mtd->erasesize_shift = 0; | |
421 | ||
422 | if (is_power_of_2(mtd->writesize)) | |
423 | mtd->writesize_shift = ffs(mtd->writesize) - 1; | |
424 | else | |
425 | mtd->writesize_shift = 0; | |
426 | ||
427 | mtd->erasesize_mask = (1 << mtd->erasesize_shift) - 1; | |
428 | mtd->writesize_mask = (1 << mtd->writesize_shift) - 1; | |
429 | ||
807f16d4 FK |
430 | if (mtd->dev.parent) { |
431 | if (!mtd->owner && mtd->dev.parent->driver) | |
432 | mtd->owner = mtd->dev.parent->driver->owner; | |
433 | if (!mtd->name) | |
434 | mtd->name = dev_name(mtd->dev.parent); | |
435 | } else { | |
436 | pr_debug("mtd device won't show a device symlink in sysfs\n"); | |
437 | } | |
438 | ||
b520e412 | 439 | /* Some chips always power up locked. Unlock them now */ |
38134565 AB |
440 | if ((mtd->flags & MTD_WRITEABLE) && (mtd->flags & MTD_POWERUP_LOCK)) { |
441 | error = mtd_unlock(mtd, 0, mtd->size); | |
442 | if (error && error != -EOPNOTSUPP) | |
b520e412 BH |
443 | printk(KERN_WARNING |
444 | "%s: unlock failed, writes may not work\n", | |
445 | mtd->name); | |
57dd990c BN |
446 | /* Ignore unlock failures? */ |
447 | error = 0; | |
b520e412 BH |
448 | } |
449 | ||
450 | /* Caller should have set dev.parent to match the | |
260e89a6 | 451 | * physical device, if appropriate. |
b520e412 BH |
452 | */ |
453 | mtd->dev.type = &mtd_devtype; | |
454 | mtd->dev.class = &mtd_class; | |
455 | mtd->dev.devt = MTD_DEVT(i); | |
456 | dev_set_name(&mtd->dev, "mtd%d", i); | |
457 | dev_set_drvdata(&mtd->dev, mtd); | |
215a02fd | 458 | of_node_get(mtd_get_of_node(mtd)); |
57dd990c BN |
459 | error = device_register(&mtd->dev); |
460 | if (error) | |
b520e412 BH |
461 | goto fail_added; |
462 | ||
5e472128 BN |
463 | device_create(&mtd_class, mtd->dev.parent, MTD_DEVT(i) + 1, NULL, |
464 | "mtd%dro", i); | |
b520e412 | 465 | |
289c0522 | 466 | pr_debug("mtd: Giving out device %d to %s\n", i, mtd->name); |
b520e412 BH |
467 | /* No need to get a refcount on the module containing |
468 | the notifier, since we hold the mtd_table_mutex */ | |
469 | list_for_each_entry(not, &mtd_notifiers, list) | |
470 | not->add(mtd); | |
471 | ||
472 | mutex_unlock(&mtd_table_mutex); | |
473 | /* We _know_ we aren't being removed, because | |
474 | our caller is still holding us here. So none | |
475 | of this try_ nonsense, and no bitching about it | |
476 | either. :) */ | |
477 | __module_get(THIS_MODULE); | |
478 | return 0; | |
97894cda | 479 | |
b520e412 | 480 | fail_added: |
215a02fd | 481 | of_node_put(mtd_get_of_node(mtd)); |
b520e412 BH |
482 | idr_remove(&mtd_idr, i); |
483 | fail_locked: | |
48b19268 | 484 | mutex_unlock(&mtd_table_mutex); |
57dd990c | 485 | return error; |
1da177e4 LT |
486 | } |
487 | ||
488 | /** | |
489 | * del_mtd_device - unregister an MTD device | |
490 | * @mtd: pointer to MTD device info structure | |
491 | * | |
492 | * Remove a device from the list of MTD devices present in the system, | |
493 | * and notify each currently active MTD 'user' of its departure. | |
494 | * Returns zero on success or 1 on failure, which currently will happen | |
495 | * if the requested device does not appear to be present in the list. | |
496 | */ | |
497 | ||
eea72d5f | 498 | int del_mtd_device(struct mtd_info *mtd) |
1da177e4 LT |
499 | { |
500 | int ret; | |
75c0b84d | 501 | struct mtd_notifier *not; |
97894cda | 502 | |
48b19268 | 503 | mutex_lock(&mtd_table_mutex); |
1da177e4 | 504 | |
b520e412 | 505 | if (idr_find(&mtd_idr, mtd->index) != mtd) { |
1da177e4 | 506 | ret = -ENODEV; |
75c0b84d ML |
507 | goto out_error; |
508 | } | |
509 | ||
510 | /* No need to get a refcount on the module containing | |
511 | the notifier, since we hold the mtd_table_mutex */ | |
512 | list_for_each_entry(not, &mtd_notifiers, list) | |
513 | not->remove(mtd); | |
514 | ||
515 | if (mtd->usecount) { | |
97894cda | 516 | printk(KERN_NOTICE "Removing MTD device #%d (%s) with use count %d\n", |
1da177e4 LT |
517 | mtd->index, mtd->name, mtd->usecount); |
518 | ret = -EBUSY; | |
519 | } else { | |
694bb7fc KC |
520 | device_unregister(&mtd->dev); |
521 | ||
b520e412 | 522 | idr_remove(&mtd_idr, mtd->index); |
215a02fd | 523 | of_node_put(mtd_get_of_node(mtd)); |
1da177e4 LT |
524 | |
525 | module_put(THIS_MODULE); | |
526 | ret = 0; | |
527 | } | |
528 | ||
75c0b84d | 529 | out_error: |
48b19268 | 530 | mutex_unlock(&mtd_table_mutex); |
1da177e4 LT |
531 | return ret; |
532 | } | |
533 | ||
727dc612 DE |
534 | static int mtd_add_device_partitions(struct mtd_info *mtd, |
535 | struct mtd_partition *real_parts, | |
536 | int nbparts) | |
537 | { | |
538 | int ret; | |
539 | ||
540 | if (nbparts == 0 || IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER)) { | |
541 | ret = add_mtd_device(mtd); | |
57dd990c BN |
542 | if (ret) |
543 | return ret; | |
727dc612 DE |
544 | } |
545 | ||
546 | if (nbparts > 0) { | |
547 | ret = add_mtd_partitions(mtd, real_parts, nbparts); | |
548 | if (ret && IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER)) | |
549 | del_mtd_device(mtd); | |
550 | return ret; | |
551 | } | |
552 | ||
553 | return 0; | |
554 | } | |
555 | ||
556 | ||
1c4c215c DES |
557 | /** |
558 | * mtd_device_parse_register - parse partitions and register an MTD device. | |
559 | * | |
560 | * @mtd: the MTD device to register | |
561 | * @types: the list of MTD partition probes to try, see | |
562 | * 'parse_mtd_partitions()' for more information | |
c7975330 | 563 | * @parser_data: MTD partition parser-specific data |
1c4c215c DES |
564 | * @parts: fallback partition information to register, if parsing fails; |
565 | * only valid if %nr_parts > %0 | |
566 | * @nr_parts: the number of partitions in parts, if zero then the full | |
567 | * MTD device is registered if no partition info is found | |
568 | * | |
569 | * This function aggregates MTD partitions parsing (done by | |
570 | * 'parse_mtd_partitions()') and MTD device and partitions registering. It | |
571 | * basically follows the most common pattern found in many MTD drivers: | |
572 | * | |
573 | * * It first tries to probe partitions on MTD device @mtd using parsers | |
574 | * specified in @types (if @types is %NULL, then the default list of parsers | |
575 | * is used, see 'parse_mtd_partitions()' for more information). If none are | |
576 | * found this functions tries to fallback to information specified in | |
577 | * @parts/@nr_parts. | |
92394b5c | 578 | * * If any partitioning info was found, this function registers the found |
727dc612 DE |
579 | * partitions. If the MTD_PARTITIONED_MASTER option is set, then the device |
580 | * as a whole is registered first. | |
1c4c215c DES |
581 | * * If no partitions were found this function just registers the MTD device |
582 | * @mtd and exits. | |
583 | * | |
584 | * Returns zero in case of success and a negative error code in case of failure. | |
585 | */ | |
26a47346 | 586 | int mtd_device_parse_register(struct mtd_info *mtd, const char * const *types, |
c7975330 | 587 | struct mtd_part_parser_data *parser_data, |
1c4c215c DES |
588 | const struct mtd_partition *parts, |
589 | int nr_parts) | |
590 | { | |
727dc612 DE |
591 | int ret; |
592 | struct mtd_partition *real_parts = NULL; | |
1c4c215c | 593 | |
727dc612 DE |
594 | ret = parse_mtd_partitions(mtd, types, &real_parts, parser_data); |
595 | if (ret <= 0 && nr_parts && parts) { | |
1c4c215c DES |
596 | real_parts = kmemdup(parts, sizeof(*parts) * nr_parts, |
597 | GFP_KERNEL); | |
4d523b60 | 598 | if (!real_parts) |
727dc612 | 599 | ret = -ENOMEM; |
4d523b60 | 600 | else |
727dc612 | 601 | ret = nr_parts; |
1c4c215c | 602 | } |
3e00ed0e BN |
603 | /* Didn't come up with either parsed OR fallback partitions */ |
604 | if (ret < 0) { | |
5a2415b0 BN |
605 | pr_info("mtd: failed to find partitions; one or more parsers reports errors (%d)\n", |
606 | ret); | |
607 | /* Don't abort on errors; we can still use unpartitioned MTD */ | |
608 | ret = 0; | |
3e00ed0e | 609 | } |
1c4c215c | 610 | |
3e00ed0e BN |
611 | ret = mtd_add_device_partitions(mtd, real_parts, ret); |
612 | if (ret) | |
613 | goto out; | |
1c4c215c | 614 | |
e1dd8641 NC |
615 | /* |
616 | * FIXME: some drivers unfortunately call this function more than once. | |
617 | * So we have to check if we've already assigned the reboot notifier. | |
618 | * | |
619 | * Generally, we can make multiple calls work for most cases, but it | |
620 | * does cause problems with parse_mtd_partitions() above (e.g., | |
621 | * cmdlineparts will register partitions more than once). | |
622 | */ | |
f8479dd6 BN |
623 | WARN_ONCE(mtd->_reboot && mtd->reboot_notifier.notifier_call, |
624 | "MTD already registered\n"); | |
e1dd8641 | 625 | if (mtd->_reboot && !mtd->reboot_notifier.notifier_call) { |
3efe41be BN |
626 | mtd->reboot_notifier.notifier_call = mtd_reboot_notifier; |
627 | register_reboot_notifier(&mtd->reboot_notifier); | |
628 | } | |
629 | ||
3e00ed0e | 630 | out: |
727dc612 DE |
631 | kfree(real_parts); |
632 | return ret; | |
1c4c215c DES |
633 | } |
634 | EXPORT_SYMBOL_GPL(mtd_device_parse_register); | |
635 | ||
f5671ab3 JI |
636 | /** |
637 | * mtd_device_unregister - unregister an existing MTD device. | |
638 | * | |
639 | * @master: the MTD device to unregister. This will unregister both the master | |
640 | * and any partitions if registered. | |
641 | */ | |
642 | int mtd_device_unregister(struct mtd_info *master) | |
643 | { | |
644 | int err; | |
645 | ||
3efe41be BN |
646 | if (master->_reboot) |
647 | unregister_reboot_notifier(&master->reboot_notifier); | |
648 | ||
f5671ab3 JI |
649 | err = del_mtd_partitions(master); |
650 | if (err) | |
651 | return err; | |
652 | ||
653 | if (!device_is_registered(&master->dev)) | |
654 | return 0; | |
655 | ||
656 | return del_mtd_device(master); | |
657 | } | |
658 | EXPORT_SYMBOL_GPL(mtd_device_unregister); | |
659 | ||
1da177e4 LT |
660 | /** |
661 | * register_mtd_user - register a 'user' of MTD devices. | |
662 | * @new: pointer to notifier info structure | |
663 | * | |
664 | * Registers a pair of callbacks function to be called upon addition | |
665 | * or removal of MTD devices. Causes the 'add' callback to be immediately | |
666 | * invoked for each MTD device currently present in the system. | |
667 | */ | |
1da177e4 LT |
668 | void register_mtd_user (struct mtd_notifier *new) |
669 | { | |
f1332ba2 | 670 | struct mtd_info *mtd; |
1da177e4 | 671 | |
48b19268 | 672 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
673 | |
674 | list_add(&new->list, &mtd_notifiers); | |
675 | ||
d5ca5129 | 676 | __module_get(THIS_MODULE); |
97894cda | 677 | |
f1332ba2 BH |
678 | mtd_for_each_device(mtd) |
679 | new->add(mtd); | |
1da177e4 | 680 | |
48b19268 | 681 | mutex_unlock(&mtd_table_mutex); |
1da177e4 | 682 | } |
33c87b4a | 683 | EXPORT_SYMBOL_GPL(register_mtd_user); |
1da177e4 LT |
684 | |
685 | /** | |
49450795 AB |
686 | * unregister_mtd_user - unregister a 'user' of MTD devices. |
687 | * @old: pointer to notifier info structure | |
1da177e4 LT |
688 | * |
689 | * Removes a callback function pair from the list of 'users' to be | |
690 | * notified upon addition or removal of MTD devices. Causes the | |
691 | * 'remove' callback to be immediately invoked for each MTD device | |
692 | * currently present in the system. | |
693 | */ | |
1da177e4 LT |
694 | int unregister_mtd_user (struct mtd_notifier *old) |
695 | { | |
f1332ba2 | 696 | struct mtd_info *mtd; |
1da177e4 | 697 | |
48b19268 | 698 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
699 | |
700 | module_put(THIS_MODULE); | |
701 | ||
f1332ba2 BH |
702 | mtd_for_each_device(mtd) |
703 | old->remove(mtd); | |
97894cda | 704 | |
1da177e4 | 705 | list_del(&old->list); |
48b19268 | 706 | mutex_unlock(&mtd_table_mutex); |
1da177e4 LT |
707 | return 0; |
708 | } | |
33c87b4a | 709 | EXPORT_SYMBOL_GPL(unregister_mtd_user); |
1da177e4 LT |
710 | |
711 | /** | |
712 | * get_mtd_device - obtain a validated handle for an MTD device | |
713 | * @mtd: last known address of the required MTD device | |
714 | * @num: internal device number of the required MTD device | |
715 | * | |
716 | * Given a number and NULL address, return the num'th entry in the device | |
717 | * table, if any. Given an address and num == -1, search the device table | |
718 | * for a device with that address and return if it's still present. Given | |
9c74034f AB |
719 | * both, return the num'th driver only if its address matches. Return |
720 | * error code if not. | |
1da177e4 | 721 | */ |
1da177e4 LT |
722 | struct mtd_info *get_mtd_device(struct mtd_info *mtd, int num) |
723 | { | |
f1332ba2 BH |
724 | struct mtd_info *ret = NULL, *other; |
725 | int err = -ENODEV; | |
1da177e4 | 726 | |
48b19268 | 727 | mutex_lock(&mtd_table_mutex); |
1da177e4 LT |
728 | |
729 | if (num == -1) { | |
f1332ba2 BH |
730 | mtd_for_each_device(other) { |
731 | if (other == mtd) { | |
732 | ret = mtd; | |
733 | break; | |
734 | } | |
735 | } | |
b520e412 BH |
736 | } else if (num >= 0) { |
737 | ret = idr_find(&mtd_idr, num); | |
1da177e4 LT |
738 | if (mtd && mtd != ret) |
739 | ret = NULL; | |
740 | } | |
741 | ||
3bd45657 ML |
742 | if (!ret) { |
743 | ret = ERR_PTR(err); | |
744 | goto out; | |
9fe912ce | 745 | } |
1da177e4 | 746 | |
3bd45657 ML |
747 | err = __get_mtd_device(ret); |
748 | if (err) | |
749 | ret = ERR_PTR(err); | |
750 | out: | |
9c74034f AB |
751 | mutex_unlock(&mtd_table_mutex); |
752 | return ret; | |
3bd45657 | 753 | } |
33c87b4a | 754 | EXPORT_SYMBOL_GPL(get_mtd_device); |
1da177e4 | 755 | |
3bd45657 ML |
756 | |
757 | int __get_mtd_device(struct mtd_info *mtd) | |
758 | { | |
759 | int err; | |
760 | ||
761 | if (!try_module_get(mtd->owner)) | |
762 | return -ENODEV; | |
763 | ||
3c3c10bb AB |
764 | if (mtd->_get_device) { |
765 | err = mtd->_get_device(mtd); | |
3bd45657 ML |
766 | |
767 | if (err) { | |
768 | module_put(mtd->owner); | |
769 | return err; | |
770 | } | |
771 | } | |
772 | mtd->usecount++; | |
773 | return 0; | |
1da177e4 | 774 | } |
33c87b4a | 775 | EXPORT_SYMBOL_GPL(__get_mtd_device); |
1da177e4 | 776 | |
7799308f AB |
777 | /** |
778 | * get_mtd_device_nm - obtain a validated handle for an MTD device by | |
779 | * device name | |
780 | * @name: MTD device name to open | |
781 | * | |
782 | * This function returns MTD device description structure in case of | |
783 | * success and an error code in case of failure. | |
784 | */ | |
7799308f AB |
785 | struct mtd_info *get_mtd_device_nm(const char *name) |
786 | { | |
f1332ba2 BH |
787 | int err = -ENODEV; |
788 | struct mtd_info *mtd = NULL, *other; | |
7799308f AB |
789 | |
790 | mutex_lock(&mtd_table_mutex); | |
791 | ||
f1332ba2 BH |
792 | mtd_for_each_device(other) { |
793 | if (!strcmp(name, other->name)) { | |
794 | mtd = other; | |
7799308f AB |
795 | break; |
796 | } | |
797 | } | |
798 | ||
9fe912ce | 799 | if (!mtd) |
7799308f AB |
800 | goto out_unlock; |
801 | ||
52534f2d WG |
802 | err = __get_mtd_device(mtd); |
803 | if (err) | |
7799308f AB |
804 | goto out_unlock; |
805 | ||
9fe912ce AB |
806 | mutex_unlock(&mtd_table_mutex); |
807 | return mtd; | |
7799308f AB |
808 | |
809 | out_unlock: | |
810 | mutex_unlock(&mtd_table_mutex); | |
9fe912ce | 811 | return ERR_PTR(err); |
7799308f | 812 | } |
33c87b4a | 813 | EXPORT_SYMBOL_GPL(get_mtd_device_nm); |
7799308f | 814 | |
1da177e4 LT |
815 | void put_mtd_device(struct mtd_info *mtd) |
816 | { | |
48b19268 | 817 | mutex_lock(&mtd_table_mutex); |
3bd45657 ML |
818 | __put_mtd_device(mtd); |
819 | mutex_unlock(&mtd_table_mutex); | |
820 | ||
821 | } | |
33c87b4a | 822 | EXPORT_SYMBOL_GPL(put_mtd_device); |
3bd45657 ML |
823 | |
824 | void __put_mtd_device(struct mtd_info *mtd) | |
825 | { | |
826 | --mtd->usecount; | |
827 | BUG_ON(mtd->usecount < 0); | |
828 | ||
3c3c10bb AB |
829 | if (mtd->_put_device) |
830 | mtd->_put_device(mtd); | |
1da177e4 LT |
831 | |
832 | module_put(mtd->owner); | |
833 | } | |
33c87b4a | 834 | EXPORT_SYMBOL_GPL(__put_mtd_device); |
1da177e4 | 835 | |
8273a0c9 AB |
836 | /* |
837 | * Erase is an asynchronous operation. Device drivers are supposed | |
838 | * to call instr->callback() whenever the operation completes, even | |
839 | * if it completes with a failure. | |
840 | * Callers are supposed to pass a callback function and wait for it | |
841 | * to be called before writing to the block. | |
842 | */ | |
843 | int mtd_erase(struct mtd_info *mtd, struct erase_info *instr) | |
844 | { | |
0c2b4e21 | 845 | if (instr->addr >= mtd->size || instr->len > mtd->size - instr->addr) |
8273a0c9 | 846 | return -EINVAL; |
664addc2 AB |
847 | if (!(mtd->flags & MTD_WRITEABLE)) |
848 | return -EROFS; | |
3b27dac0 | 849 | instr->fail_addr = MTD_FAIL_ADDR_UNKNOWN; |
bcb1d238 AB |
850 | if (!instr->len) { |
851 | instr->state = MTD_ERASE_DONE; | |
852 | mtd_erase_callback(instr); | |
853 | return 0; | |
854 | } | |
8273a0c9 AB |
855 | return mtd->_erase(mtd, instr); |
856 | } | |
857 | EXPORT_SYMBOL_GPL(mtd_erase); | |
858 | ||
859 | /* | |
860 | * This stuff for eXecute-In-Place. phys is optional and may be set to NULL. | |
861 | */ | |
862 | int mtd_point(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
863 | void **virt, resource_size_t *phys) | |
864 | { | |
865 | *retlen = 0; | |
0dd5235f AB |
866 | *virt = NULL; |
867 | if (phys) | |
868 | *phys = 0; | |
8273a0c9 AB |
869 | if (!mtd->_point) |
870 | return -EOPNOTSUPP; | |
0c2b4e21 | 871 | if (from < 0 || from >= mtd->size || len > mtd->size - from) |
8273a0c9 | 872 | return -EINVAL; |
bcb1d238 AB |
873 | if (!len) |
874 | return 0; | |
8273a0c9 AB |
875 | return mtd->_point(mtd, from, len, retlen, virt, phys); |
876 | } | |
877 | EXPORT_SYMBOL_GPL(mtd_point); | |
878 | ||
879 | /* We probably shouldn't allow XIP if the unpoint isn't a NULL */ | |
880 | int mtd_unpoint(struct mtd_info *mtd, loff_t from, size_t len) | |
881 | { | |
882 | if (!mtd->_point) | |
883 | return -EOPNOTSUPP; | |
0c2b4e21 | 884 | if (from < 0 || from >= mtd->size || len > mtd->size - from) |
8273a0c9 | 885 | return -EINVAL; |
bcb1d238 AB |
886 | if (!len) |
887 | return 0; | |
8273a0c9 AB |
888 | return mtd->_unpoint(mtd, from, len); |
889 | } | |
890 | EXPORT_SYMBOL_GPL(mtd_unpoint); | |
891 | ||
892 | /* | |
893 | * Allow NOMMU mmap() to directly map the device (if not NULL) | |
894 | * - return the address to which the offset maps | |
895 | * - return -ENOSYS to indicate refusal to do the mapping | |
896 | */ | |
897 | unsigned long mtd_get_unmapped_area(struct mtd_info *mtd, unsigned long len, | |
898 | unsigned long offset, unsigned long flags) | |
899 | { | |
900 | if (!mtd->_get_unmapped_area) | |
901 | return -EOPNOTSUPP; | |
0c2b4e21 | 902 | if (offset >= mtd->size || len > mtd->size - offset) |
8273a0c9 AB |
903 | return -EINVAL; |
904 | return mtd->_get_unmapped_area(mtd, len, offset, flags); | |
905 | } | |
906 | EXPORT_SYMBOL_GPL(mtd_get_unmapped_area); | |
907 | ||
908 | int mtd_read(struct mtd_info *mtd, loff_t from, size_t len, size_t *retlen, | |
909 | u_char *buf) | |
910 | { | |
edbc4540 | 911 | int ret_code; |
834247ec | 912 | *retlen = 0; |
0c2b4e21 | 913 | if (from < 0 || from >= mtd->size || len > mtd->size - from) |
8273a0c9 | 914 | return -EINVAL; |
bcb1d238 AB |
915 | if (!len) |
916 | return 0; | |
edbc4540 MD |
917 | |
918 | /* | |
919 | * In the absence of an error, drivers return a non-negative integer | |
920 | * representing the maximum number of bitflips that were corrected on | |
921 | * any one ecc region (if applicable; zero otherwise). | |
922 | */ | |
923 | ret_code = mtd->_read(mtd, from, len, retlen, buf); | |
924 | if (unlikely(ret_code < 0)) | |
925 | return ret_code; | |
926 | if (mtd->ecc_strength == 0) | |
927 | return 0; /* device lacks ecc */ | |
928 | return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0; | |
8273a0c9 AB |
929 | } |
930 | EXPORT_SYMBOL_GPL(mtd_read); | |
931 | ||
932 | int mtd_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
933 | const u_char *buf) | |
934 | { | |
935 | *retlen = 0; | |
0c2b4e21 | 936 | if (to < 0 || to >= mtd->size || len > mtd->size - to) |
8273a0c9 | 937 | return -EINVAL; |
664addc2 AB |
938 | if (!mtd->_write || !(mtd->flags & MTD_WRITEABLE)) |
939 | return -EROFS; | |
bcb1d238 AB |
940 | if (!len) |
941 | return 0; | |
8273a0c9 AB |
942 | return mtd->_write(mtd, to, len, retlen, buf); |
943 | } | |
944 | EXPORT_SYMBOL_GPL(mtd_write); | |
945 | ||
946 | /* | |
947 | * In blackbox flight recorder like scenarios we want to make successful writes | |
948 | * in interrupt context. panic_write() is only intended to be called when its | |
949 | * known the kernel is about to panic and we need the write to succeed. Since | |
950 | * the kernel is not going to be running for much longer, this function can | |
951 | * break locks and delay to ensure the write succeeds (but not sleep). | |
952 | */ | |
953 | int mtd_panic_write(struct mtd_info *mtd, loff_t to, size_t len, size_t *retlen, | |
954 | const u_char *buf) | |
955 | { | |
956 | *retlen = 0; | |
957 | if (!mtd->_panic_write) | |
958 | return -EOPNOTSUPP; | |
0c2b4e21 | 959 | if (to < 0 || to >= mtd->size || len > mtd->size - to) |
8273a0c9 | 960 | return -EINVAL; |
664addc2 AB |
961 | if (!(mtd->flags & MTD_WRITEABLE)) |
962 | return -EROFS; | |
bcb1d238 AB |
963 | if (!len) |
964 | return 0; | |
8273a0c9 AB |
965 | return mtd->_panic_write(mtd, to, len, retlen, buf); |
966 | } | |
967 | EXPORT_SYMBOL_GPL(mtd_panic_write); | |
968 | ||
d2d48480 BN |
969 | int mtd_read_oob(struct mtd_info *mtd, loff_t from, struct mtd_oob_ops *ops) |
970 | { | |
e47f6858 | 971 | int ret_code; |
d2d48480 BN |
972 | ops->retlen = ops->oobretlen = 0; |
973 | if (!mtd->_read_oob) | |
974 | return -EOPNOTSUPP; | |
e47f6858 BN |
975 | /* |
976 | * In cases where ops->datbuf != NULL, mtd->_read_oob() has semantics | |
977 | * similar to mtd->_read(), returning a non-negative integer | |
978 | * representing max bitflips. In other cases, mtd->_read_oob() may | |
979 | * return -EUCLEAN. In all cases, perform similar logic to mtd_read(). | |
980 | */ | |
981 | ret_code = mtd->_read_oob(mtd, from, ops); | |
982 | if (unlikely(ret_code < 0)) | |
983 | return ret_code; | |
984 | if (mtd->ecc_strength == 0) | |
985 | return 0; /* device lacks ecc */ | |
986 | return ret_code >= mtd->bitflip_threshold ? -EUCLEAN : 0; | |
d2d48480 BN |
987 | } |
988 | EXPORT_SYMBOL_GPL(mtd_read_oob); | |
989 | ||
de3cac93 AB |
990 | /* |
991 | * Method to access the protection register area, present in some flash | |
992 | * devices. The user data is one time programmable but the factory data is read | |
993 | * only. | |
994 | */ | |
4b78fc42 CR |
995 | int mtd_get_fact_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, |
996 | struct otp_info *buf) | |
de3cac93 AB |
997 | { |
998 | if (!mtd->_get_fact_prot_info) | |
999 | return -EOPNOTSUPP; | |
1000 | if (!len) | |
1001 | return 0; | |
4b78fc42 | 1002 | return mtd->_get_fact_prot_info(mtd, len, retlen, buf); |
de3cac93 AB |
1003 | } |
1004 | EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info); | |
1005 | ||
1006 | int mtd_read_fact_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
1007 | size_t *retlen, u_char *buf) | |
1008 | { | |
1009 | *retlen = 0; | |
1010 | if (!mtd->_read_fact_prot_reg) | |
1011 | return -EOPNOTSUPP; | |
1012 | if (!len) | |
1013 | return 0; | |
1014 | return mtd->_read_fact_prot_reg(mtd, from, len, retlen, buf); | |
1015 | } | |
1016 | EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg); | |
1017 | ||
4b78fc42 CR |
1018 | int mtd_get_user_prot_info(struct mtd_info *mtd, size_t len, size_t *retlen, |
1019 | struct otp_info *buf) | |
de3cac93 AB |
1020 | { |
1021 | if (!mtd->_get_user_prot_info) | |
1022 | return -EOPNOTSUPP; | |
1023 | if (!len) | |
1024 | return 0; | |
4b78fc42 | 1025 | return mtd->_get_user_prot_info(mtd, len, retlen, buf); |
de3cac93 AB |
1026 | } |
1027 | EXPORT_SYMBOL_GPL(mtd_get_user_prot_info); | |
1028 | ||
1029 | int mtd_read_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len, | |
1030 | size_t *retlen, u_char *buf) | |
1031 | { | |
1032 | *retlen = 0; | |
1033 | if (!mtd->_read_user_prot_reg) | |
1034 | return -EOPNOTSUPP; | |
1035 | if (!len) | |
1036 | return 0; | |
1037 | return mtd->_read_user_prot_reg(mtd, from, len, retlen, buf); | |
1038 | } | |
1039 | EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg); | |
1040 | ||
1041 | int mtd_write_user_prot_reg(struct mtd_info *mtd, loff_t to, size_t len, | |
1042 | size_t *retlen, u_char *buf) | |
1043 | { | |
9a78bc83 CR |
1044 | int ret; |
1045 | ||
de3cac93 AB |
1046 | *retlen = 0; |
1047 | if (!mtd->_write_user_prot_reg) | |
1048 | return -EOPNOTSUPP; | |
1049 | if (!len) | |
1050 | return 0; | |
9a78bc83 CR |
1051 | ret = mtd->_write_user_prot_reg(mtd, to, len, retlen, buf); |
1052 | if (ret) | |
1053 | return ret; | |
1054 | ||
1055 | /* | |
1056 | * If no data could be written at all, we are out of memory and | |
1057 | * must return -ENOSPC. | |
1058 | */ | |
1059 | return (*retlen) ? 0 : -ENOSPC; | |
de3cac93 AB |
1060 | } |
1061 | EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg); | |
1062 | ||
1063 | int mtd_lock_user_prot_reg(struct mtd_info *mtd, loff_t from, size_t len) | |
1064 | { | |
1065 | if (!mtd->_lock_user_prot_reg) | |
1066 | return -EOPNOTSUPP; | |
1067 | if (!len) | |
1068 | return 0; | |
1069 | return mtd->_lock_user_prot_reg(mtd, from, len); | |
1070 | } | |
1071 | EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg); | |
1072 | ||
8273a0c9 AB |
1073 | /* Chip-supported device locking */ |
1074 | int mtd_lock(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1075 | { | |
1076 | if (!mtd->_lock) | |
1077 | return -EOPNOTSUPP; | |
0c2b4e21 | 1078 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1079 | return -EINVAL; |
bcb1d238 AB |
1080 | if (!len) |
1081 | return 0; | |
8273a0c9 AB |
1082 | return mtd->_lock(mtd, ofs, len); |
1083 | } | |
1084 | EXPORT_SYMBOL_GPL(mtd_lock); | |
1085 | ||
1086 | int mtd_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1087 | { | |
1088 | if (!mtd->_unlock) | |
1089 | return -EOPNOTSUPP; | |
0c2b4e21 | 1090 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1091 | return -EINVAL; |
bcb1d238 AB |
1092 | if (!len) |
1093 | return 0; | |
8273a0c9 AB |
1094 | return mtd->_unlock(mtd, ofs, len); |
1095 | } | |
1096 | EXPORT_SYMBOL_GPL(mtd_unlock); | |
1097 | ||
1098 | int mtd_is_locked(struct mtd_info *mtd, loff_t ofs, uint64_t len) | |
1099 | { | |
1100 | if (!mtd->_is_locked) | |
1101 | return -EOPNOTSUPP; | |
0c2b4e21 | 1102 | if (ofs < 0 || ofs >= mtd->size || len > mtd->size - ofs) |
8273a0c9 | 1103 | return -EINVAL; |
bcb1d238 AB |
1104 | if (!len) |
1105 | return 0; | |
8273a0c9 AB |
1106 | return mtd->_is_locked(mtd, ofs, len); |
1107 | } | |
1108 | EXPORT_SYMBOL_GPL(mtd_is_locked); | |
1109 | ||
8471bb73 | 1110 | int mtd_block_isreserved(struct mtd_info *mtd, loff_t ofs) |
8273a0c9 | 1111 | { |
0c2b4e21 | 1112 | if (ofs < 0 || ofs >= mtd->size) |
8471bb73 EG |
1113 | return -EINVAL; |
1114 | if (!mtd->_block_isreserved) | |
8273a0c9 | 1115 | return 0; |
8471bb73 EG |
1116 | return mtd->_block_isreserved(mtd, ofs); |
1117 | } | |
1118 | EXPORT_SYMBOL_GPL(mtd_block_isreserved); | |
1119 | ||
1120 | int mtd_block_isbad(struct mtd_info *mtd, loff_t ofs) | |
1121 | { | |
0c2b4e21 | 1122 | if (ofs < 0 || ofs >= mtd->size) |
8273a0c9 | 1123 | return -EINVAL; |
8471bb73 EG |
1124 | if (!mtd->_block_isbad) |
1125 | return 0; | |
8273a0c9 AB |
1126 | return mtd->_block_isbad(mtd, ofs); |
1127 | } | |
1128 | EXPORT_SYMBOL_GPL(mtd_block_isbad); | |
1129 | ||
1130 | int mtd_block_markbad(struct mtd_info *mtd, loff_t ofs) | |
1131 | { | |
1132 | if (!mtd->_block_markbad) | |
1133 | return -EOPNOTSUPP; | |
0c2b4e21 | 1134 | if (ofs < 0 || ofs >= mtd->size) |
8273a0c9 | 1135 | return -EINVAL; |
664addc2 AB |
1136 | if (!(mtd->flags & MTD_WRITEABLE)) |
1137 | return -EROFS; | |
8273a0c9 AB |
1138 | return mtd->_block_markbad(mtd, ofs); |
1139 | } | |
1140 | EXPORT_SYMBOL_GPL(mtd_block_markbad); | |
1141 | ||
52b02031 AB |
1142 | /* |
1143 | * default_mtd_writev - the default writev method | |
1144 | * @mtd: mtd device description object pointer | |
1145 | * @vecs: the vectors to write | |
1146 | * @count: count of vectors in @vecs | |
1147 | * @to: the MTD device offset to write to | |
1148 | * @retlen: on exit contains the count of bytes written to the MTD device. | |
1149 | * | |
1150 | * This function returns zero in case of success and a negative error code in | |
1151 | * case of failure. | |
1da177e4 | 1152 | */ |
1dbebd32 AB |
1153 | static int default_mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, |
1154 | unsigned long count, loff_t to, size_t *retlen) | |
1da177e4 LT |
1155 | { |
1156 | unsigned long i; | |
1157 | size_t totlen = 0, thislen; | |
1158 | int ret = 0; | |
1159 | ||
52b02031 AB |
1160 | for (i = 0; i < count; i++) { |
1161 | if (!vecs[i].iov_len) | |
1162 | continue; | |
1163 | ret = mtd_write(mtd, to, vecs[i].iov_len, &thislen, | |
1164 | vecs[i].iov_base); | |
1165 | totlen += thislen; | |
1166 | if (ret || thislen != vecs[i].iov_len) | |
1167 | break; | |
1168 | to += vecs[i].iov_len; | |
1da177e4 | 1169 | } |
52b02031 | 1170 | *retlen = totlen; |
1da177e4 LT |
1171 | return ret; |
1172 | } | |
1dbebd32 AB |
1173 | |
1174 | /* | |
1175 | * mtd_writev - the vector-based MTD write method | |
1176 | * @mtd: mtd device description object pointer | |
1177 | * @vecs: the vectors to write | |
1178 | * @count: count of vectors in @vecs | |
1179 | * @to: the MTD device offset to write to | |
1180 | * @retlen: on exit contains the count of bytes written to the MTD device. | |
1181 | * | |
1182 | * This function returns zero in case of success and a negative error code in | |
1183 | * case of failure. | |
1184 | */ | |
1185 | int mtd_writev(struct mtd_info *mtd, const struct kvec *vecs, | |
1186 | unsigned long count, loff_t to, size_t *retlen) | |
1187 | { | |
1188 | *retlen = 0; | |
664addc2 AB |
1189 | if (!(mtd->flags & MTD_WRITEABLE)) |
1190 | return -EROFS; | |
3c3c10bb | 1191 | if (!mtd->_writev) |
1dbebd32 | 1192 | return default_mtd_writev(mtd, vecs, count, to, retlen); |
3c3c10bb | 1193 | return mtd->_writev(mtd, vecs, count, to, retlen); |
1dbebd32 AB |
1194 | } |
1195 | EXPORT_SYMBOL_GPL(mtd_writev); | |
1da177e4 | 1196 | |
33b53716 GE |
1197 | /** |
1198 | * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size | |
52b02031 AB |
1199 | * @mtd: mtd device description object pointer |
1200 | * @size: a pointer to the ideal or maximum size of the allocation, points | |
33b53716 GE |
1201 | * to the actual allocation size on success. |
1202 | * | |
1203 | * This routine attempts to allocate a contiguous kernel buffer up to | |
1204 | * the specified size, backing off the size of the request exponentially | |
1205 | * until the request succeeds or until the allocation size falls below | |
1206 | * the system page size. This attempts to make sure it does not adversely | |
1207 | * impact system performance, so when allocating more than one page, we | |
caf49191 LT |
1208 | * ask the memory allocator to avoid re-trying, swapping, writing back |
1209 | * or performing I/O. | |
33b53716 GE |
1210 | * |
1211 | * Note, this function also makes sure that the allocated buffer is aligned to | |
1212 | * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value. | |
1213 | * | |
1214 | * This is called, for example by mtd_{read,write} and jffs2_scan_medium, | |
1215 | * to handle smaller (i.e. degraded) buffer allocations under low- or | |
1216 | * fragmented-memory situations where such reduced allocations, from a | |
1217 | * requested ideal, are allowed. | |
1218 | * | |
1219 | * Returns a pointer to the allocated buffer on success; otherwise, NULL. | |
1220 | */ | |
1221 | void *mtd_kmalloc_up_to(const struct mtd_info *mtd, size_t *size) | |
1222 | { | |
d0164adc | 1223 | gfp_t flags = __GFP_NOWARN | __GFP_DIRECT_RECLAIM | __GFP_NORETRY; |
33b53716 GE |
1224 | size_t min_alloc = max_t(size_t, mtd->writesize, PAGE_SIZE); |
1225 | void *kbuf; | |
1226 | ||
1227 | *size = min_t(size_t, *size, KMALLOC_MAX_SIZE); | |
1228 | ||
1229 | while (*size > min_alloc) { | |
1230 | kbuf = kmalloc(*size, flags); | |
1231 | if (kbuf) | |
1232 | return kbuf; | |
1233 | ||
1234 | *size >>= 1; | |
1235 | *size = ALIGN(*size, mtd->writesize); | |
1236 | } | |
1237 | ||
1238 | /* | |
1239 | * For the last resort allocation allow 'kmalloc()' to do all sorts of | |
1240 | * things (write-back, dropping caches, etc) by using GFP_KERNEL. | |
1241 | */ | |
1242 | return kmalloc(*size, GFP_KERNEL); | |
1243 | } | |
33b53716 | 1244 | EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to); |
1da177e4 | 1245 | |
2d2dce0e PM |
1246 | #ifdef CONFIG_PROC_FS |
1247 | ||
1da177e4 LT |
1248 | /*====================================================================*/ |
1249 | /* Support for /proc/mtd */ | |
1250 | ||
447d9bd8 | 1251 | static int mtd_proc_show(struct seq_file *m, void *v) |
1da177e4 | 1252 | { |
f1332ba2 | 1253 | struct mtd_info *mtd; |
1da177e4 | 1254 | |
447d9bd8 | 1255 | seq_puts(m, "dev: size erasesize name\n"); |
48b19268 | 1256 | mutex_lock(&mtd_table_mutex); |
f1332ba2 | 1257 | mtd_for_each_device(mtd) { |
447d9bd8 AD |
1258 | seq_printf(m, "mtd%d: %8.8llx %8.8x \"%s\"\n", |
1259 | mtd->index, (unsigned long long)mtd->size, | |
1260 | mtd->erasesize, mtd->name); | |
d5ca5129 | 1261 | } |
48b19268 | 1262 | mutex_unlock(&mtd_table_mutex); |
d5ca5129 | 1263 | return 0; |
1da177e4 LT |
1264 | } |
1265 | ||
447d9bd8 AD |
1266 | static int mtd_proc_open(struct inode *inode, struct file *file) |
1267 | { | |
1268 | return single_open(file, mtd_proc_show, NULL); | |
1269 | } | |
1270 | ||
1271 | static const struct file_operations mtd_proc_ops = { | |
1272 | .open = mtd_proc_open, | |
1273 | .read = seq_read, | |
1274 | .llseek = seq_lseek, | |
1275 | .release = single_release, | |
1276 | }; | |
45b09076 KC |
1277 | #endif /* CONFIG_PROC_FS */ |
1278 | ||
1da177e4 LT |
1279 | /*====================================================================*/ |
1280 | /* Init code */ | |
1281 | ||
0661b1ac JA |
1282 | static int __init mtd_bdi_init(struct backing_dev_info *bdi, const char *name) |
1283 | { | |
1284 | int ret; | |
1285 | ||
1286 | ret = bdi_init(bdi); | |
1287 | if (!ret) | |
02aa2a37 | 1288 | ret = bdi_register(bdi, NULL, "%s", name); |
0661b1ac JA |
1289 | |
1290 | if (ret) | |
1291 | bdi_destroy(bdi); | |
1292 | ||
1293 | return ret; | |
1294 | } | |
1295 | ||
93e56214 AB |
1296 | static struct proc_dir_entry *proc_mtd; |
1297 | ||
1da177e4 LT |
1298 | static int __init init_mtd(void) |
1299 | { | |
15bce40c | 1300 | int ret; |
0661b1ac | 1301 | |
15bce40c | 1302 | ret = class_register(&mtd_class); |
0661b1ac JA |
1303 | if (ret) |
1304 | goto err_reg; | |
1305 | ||
b4caecd4 | 1306 | ret = mtd_bdi_init(&mtd_bdi, "mtd"); |
0661b1ac | 1307 | if (ret) |
b4caecd4 | 1308 | goto err_bdi; |
694bb7fc | 1309 | |
447d9bd8 | 1310 | proc_mtd = proc_create("mtd", 0, NULL, &mtd_proc_ops); |
93e56214 | 1311 | |
660685d9 AB |
1312 | ret = init_mtdchar(); |
1313 | if (ret) | |
1314 | goto out_procfs; | |
1315 | ||
1da177e4 | 1316 | return 0; |
0661b1ac | 1317 | |
660685d9 AB |
1318 | out_procfs: |
1319 | if (proc_mtd) | |
1320 | remove_proc_entry("mtd", NULL); | |
b4caecd4 | 1321 | err_bdi: |
0661b1ac JA |
1322 | class_unregister(&mtd_class); |
1323 | err_reg: | |
1324 | pr_err("Error registering mtd class or bdi: %d\n", ret); | |
1325 | return ret; | |
1da177e4 LT |
1326 | } |
1327 | ||
1328 | static void __exit cleanup_mtd(void) | |
1329 | { | |
660685d9 | 1330 | cleanup_mtdchar(); |
d5ca5129 | 1331 | if (proc_mtd) |
93e56214 | 1332 | remove_proc_entry("mtd", NULL); |
15bce40c | 1333 | class_unregister(&mtd_class); |
b4caecd4 | 1334 | bdi_destroy(&mtd_bdi); |
35667b99 | 1335 | idr_destroy(&mtd_idr); |
1da177e4 LT |
1336 | } |
1337 | ||
1338 | module_init(init_mtd); | |
1339 | module_exit(cleanup_mtd); | |
1340 | ||
1da177e4 LT |
1341 | MODULE_LICENSE("GPL"); |
1342 | MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>"); | |
1343 | MODULE_DESCRIPTION("Core MTD registration and access routines"); |