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