2 * Core registration and callback routines for MTD
5 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
6 * Copyright © 2006 Red Hat UK Limited
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.
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.
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
24 #include <linux/module.h>
25 #include <linux/kernel.h>
26 #include <linux/ptrace.h>
27 #include <linux/seq_file.h>
28 #include <linux/string.h>
29 #include <linux/timer.h>
30 #include <linux/major.h>
32 #include <linux/err.h>
33 #include <linux/ioctl.h>
34 #include <linux/init.h>
35 #include <linux/proc_fs.h>
36 #include <linux/idr.h>
37 #include <linux/backing-dev.h>
38 #include <linux/gfp.h>
40 #include <linux/mtd/mtd.h>
41 #include <linux/mtd/partitions.h>
45 * backing device capabilities for non-mappable devices (such as NAND flash)
46 * - permits private mappings, copies are taken of the data
48 static struct backing_dev_info mtd_bdi_unmappable
= {
49 .capabilities
= BDI_CAP_MAP_COPY
,
53 * backing device capabilities for R/O mappable devices (such as ROM)
54 * - permits private mappings, copies are taken of the data
55 * - permits non-writable shared mappings
57 static struct backing_dev_info mtd_bdi_ro_mappable
= {
58 .capabilities
= (BDI_CAP_MAP_COPY
| BDI_CAP_MAP_DIRECT
|
59 BDI_CAP_EXEC_MAP
| BDI_CAP_READ_MAP
),
63 * backing device capabilities for writable mappable devices (such as RAM)
64 * - permits private mappings, copies are taken of the data
65 * - permits non-writable shared mappings
67 static struct backing_dev_info mtd_bdi_rw_mappable
= {
68 .capabilities
= (BDI_CAP_MAP_COPY
| BDI_CAP_MAP_DIRECT
|
69 BDI_CAP_EXEC_MAP
| BDI_CAP_READ_MAP
|
73 static int mtd_cls_suspend(struct device
*dev
, pm_message_t state
);
74 static int mtd_cls_resume(struct device
*dev
);
76 static struct class mtd_class
= {
79 .suspend
= mtd_cls_suspend
,
80 .resume
= mtd_cls_resume
,
83 static DEFINE_IDR(mtd_idr
);
85 /* These are exported solely for the purpose of mtd_blkdevs.c. You
86 should not use them for _anything_ else */
87 DEFINE_MUTEX(mtd_table_mutex
);
88 EXPORT_SYMBOL_GPL(mtd_table_mutex
);
90 struct mtd_info
*__mtd_next_device(int i
)
92 return idr_get_next(&mtd_idr
, &i
);
94 EXPORT_SYMBOL_GPL(__mtd_next_device
);
96 static LIST_HEAD(mtd_notifiers
);
99 #if defined(CONFIG_MTD_CHAR) || defined(CONFIG_MTD_CHAR_MODULE)
100 #define MTD_DEVT(index) MKDEV(MTD_CHAR_MAJOR, (index)*2)
102 #define MTD_DEVT(index) 0
105 /* REVISIT once MTD uses the driver model better, whoever allocates
106 * the mtd_info will probably want to use the release() hook...
108 static void mtd_release(struct device
*dev
)
110 struct mtd_info __maybe_unused
*mtd
= dev_get_drvdata(dev
);
111 dev_t index
= MTD_DEVT(mtd
->index
);
113 /* remove /dev/mtdXro node if needed */
115 device_destroy(&mtd_class
, index
+ 1);
118 static int mtd_cls_suspend(struct device
*dev
, pm_message_t state
)
120 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
122 return mtd
? mtd_suspend(mtd
) : 0;
125 static int mtd_cls_resume(struct device
*dev
)
127 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
134 static ssize_t
mtd_type_show(struct device
*dev
,
135 struct device_attribute
*attr
, char *buf
)
137 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
166 return snprintf(buf
, PAGE_SIZE
, "%s\n", type
);
168 static DEVICE_ATTR(type
, S_IRUGO
, mtd_type_show
, NULL
);
170 static ssize_t
mtd_flags_show(struct device
*dev
,
171 struct device_attribute
*attr
, char *buf
)
173 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
175 return snprintf(buf
, PAGE_SIZE
, "0x%lx\n", (unsigned long)mtd
->flags
);
178 static DEVICE_ATTR(flags
, S_IRUGO
, mtd_flags_show
, NULL
);
180 static ssize_t
mtd_size_show(struct device
*dev
,
181 struct device_attribute
*attr
, char *buf
)
183 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
185 return snprintf(buf
, PAGE_SIZE
, "%llu\n",
186 (unsigned long long)mtd
->size
);
189 static DEVICE_ATTR(size
, S_IRUGO
, mtd_size_show
, NULL
);
191 static ssize_t
mtd_erasesize_show(struct device
*dev
,
192 struct device_attribute
*attr
, char *buf
)
194 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
196 return snprintf(buf
, PAGE_SIZE
, "%lu\n", (unsigned long)mtd
->erasesize
);
199 static DEVICE_ATTR(erasesize
, S_IRUGO
, mtd_erasesize_show
, NULL
);
201 static ssize_t
mtd_writesize_show(struct device
*dev
,
202 struct device_attribute
*attr
, char *buf
)
204 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
206 return snprintf(buf
, PAGE_SIZE
, "%lu\n", (unsigned long)mtd
->writesize
);
209 static DEVICE_ATTR(writesize
, S_IRUGO
, mtd_writesize_show
, NULL
);
211 static ssize_t
mtd_subpagesize_show(struct device
*dev
,
212 struct device_attribute
*attr
, char *buf
)
214 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
215 unsigned int subpagesize
= mtd
->writesize
>> mtd
->subpage_sft
;
217 return snprintf(buf
, PAGE_SIZE
, "%u\n", subpagesize
);
220 static DEVICE_ATTR(subpagesize
, S_IRUGO
, mtd_subpagesize_show
, NULL
);
222 static ssize_t
mtd_oobsize_show(struct device
*dev
,
223 struct device_attribute
*attr
, char *buf
)
225 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
227 return snprintf(buf
, PAGE_SIZE
, "%lu\n", (unsigned long)mtd
->oobsize
);
230 static DEVICE_ATTR(oobsize
, S_IRUGO
, mtd_oobsize_show
, NULL
);
232 static ssize_t
mtd_numeraseregions_show(struct device
*dev
,
233 struct device_attribute
*attr
, char *buf
)
235 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
237 return snprintf(buf
, PAGE_SIZE
, "%u\n", mtd
->numeraseregions
);
240 static DEVICE_ATTR(numeraseregions
, S_IRUGO
, mtd_numeraseregions_show
,
243 static ssize_t
mtd_name_show(struct device
*dev
,
244 struct device_attribute
*attr
, char *buf
)
246 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
248 return snprintf(buf
, PAGE_SIZE
, "%s\n", mtd
->name
);
251 static DEVICE_ATTR(name
, S_IRUGO
, mtd_name_show
, NULL
);
253 static ssize_t
mtd_ecc_strength_show(struct device
*dev
,
254 struct device_attribute
*attr
, char *buf
)
256 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
258 return snprintf(buf
, PAGE_SIZE
, "%u\n", mtd
->ecc_strength
);
260 static DEVICE_ATTR(ecc_strength
, S_IRUGO
, mtd_ecc_strength_show
, NULL
);
262 static ssize_t
mtd_bitflip_threshold_show(struct device
*dev
,
263 struct device_attribute
*attr
,
266 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
268 return snprintf(buf
, PAGE_SIZE
, "%u\n", mtd
->bitflip_threshold
);
271 static ssize_t
mtd_bitflip_threshold_store(struct device
*dev
,
272 struct device_attribute
*attr
,
273 const char *buf
, size_t count
)
275 struct mtd_info
*mtd
= dev_get_drvdata(dev
);
276 unsigned int bitflip_threshold
;
279 retval
= kstrtouint(buf
, 0, &bitflip_threshold
);
283 mtd
->bitflip_threshold
= bitflip_threshold
;
286 static DEVICE_ATTR(bitflip_threshold
, S_IRUGO
| S_IWUSR
,
287 mtd_bitflip_threshold_show
,
288 mtd_bitflip_threshold_store
);
290 static struct attribute
*mtd_attrs
[] = {
292 &dev_attr_flags
.attr
,
294 &dev_attr_erasesize
.attr
,
295 &dev_attr_writesize
.attr
,
296 &dev_attr_subpagesize
.attr
,
297 &dev_attr_oobsize
.attr
,
298 &dev_attr_numeraseregions
.attr
,
300 &dev_attr_ecc_strength
.attr
,
301 &dev_attr_bitflip_threshold
.attr
,
305 static struct attribute_group mtd_group
= {
309 static const struct attribute_group
*mtd_groups
[] = {
314 static struct device_type mtd_devtype
= {
316 .groups
= mtd_groups
,
317 .release
= mtd_release
,
321 * add_mtd_device - register an MTD device
322 * @mtd: pointer to new MTD device info structure
324 * Add a device to the list of MTD devices present in the system, and
325 * notify each currently active MTD 'user' of its arrival. Returns
326 * zero on success or 1 on failure, which currently will only happen
327 * if there is insufficient memory or a sysfs error.
330 int add_mtd_device(struct mtd_info
*mtd
)
332 struct mtd_notifier
*not;
335 if (!mtd
->backing_dev_info
) {
338 mtd
->backing_dev_info
= &mtd_bdi_rw_mappable
;
341 mtd
->backing_dev_info
= &mtd_bdi_ro_mappable
;
344 mtd
->backing_dev_info
= &mtd_bdi_unmappable
;
349 BUG_ON(mtd
->writesize
== 0);
350 mutex_lock(&mtd_table_mutex
);
353 if (!idr_pre_get(&mtd_idr
, GFP_KERNEL
))
355 error
= idr_get_new(&mtd_idr
, mtd
, &i
);
356 } while (error
== -EAGAIN
);
364 /* default value if not set by driver */
365 if (mtd
->bitflip_threshold
== 0)
366 mtd
->bitflip_threshold
= mtd
->ecc_strength
;
368 if (is_power_of_2(mtd
->erasesize
))
369 mtd
->erasesize_shift
= ffs(mtd
->erasesize
) - 1;
371 mtd
->erasesize_shift
= 0;
373 if (is_power_of_2(mtd
->writesize
))
374 mtd
->writesize_shift
= ffs(mtd
->writesize
) - 1;
376 mtd
->writesize_shift
= 0;
378 mtd
->erasesize_mask
= (1 << mtd
->erasesize_shift
) - 1;
379 mtd
->writesize_mask
= (1 << mtd
->writesize_shift
) - 1;
381 /* Some chips always power up locked. Unlock them now */
382 if ((mtd
->flags
& MTD_WRITEABLE
) && (mtd
->flags
& MTD_POWERUP_LOCK
)) {
383 error
= mtd_unlock(mtd
, 0, mtd
->size
);
384 if (error
&& error
!= -EOPNOTSUPP
)
386 "%s: unlock failed, writes may not work\n",
390 /* Caller should have set dev.parent to match the
393 mtd
->dev
.type
= &mtd_devtype
;
394 mtd
->dev
.class = &mtd_class
;
395 mtd
->dev
.devt
= MTD_DEVT(i
);
396 dev_set_name(&mtd
->dev
, "mtd%d", i
);
397 dev_set_drvdata(&mtd
->dev
, mtd
);
398 if (device_register(&mtd
->dev
) != 0)
402 device_create(&mtd_class
, mtd
->dev
.parent
,
406 pr_debug("mtd: Giving out device %d to %s\n", i
, mtd
->name
);
407 /* No need to get a refcount on the module containing
408 the notifier, since we hold the mtd_table_mutex */
409 list_for_each_entry(not, &mtd_notifiers
, list
)
412 mutex_unlock(&mtd_table_mutex
);
413 /* We _know_ we aren't being removed, because
414 our caller is still holding us here. So none
415 of this try_ nonsense, and no bitching about it
417 __module_get(THIS_MODULE
);
421 idr_remove(&mtd_idr
, i
);
423 mutex_unlock(&mtd_table_mutex
);
428 * del_mtd_device - unregister an MTD device
429 * @mtd: pointer to MTD device info structure
431 * Remove a device from the list of MTD devices present in the system,
432 * and notify each currently active MTD 'user' of its departure.
433 * Returns zero on success or 1 on failure, which currently will happen
434 * if the requested device does not appear to be present in the list.
437 int del_mtd_device(struct mtd_info
*mtd
)
440 struct mtd_notifier
*not;
442 mutex_lock(&mtd_table_mutex
);
444 if (idr_find(&mtd_idr
, mtd
->index
) != mtd
) {
449 /* No need to get a refcount on the module containing
450 the notifier, since we hold the mtd_table_mutex */
451 list_for_each_entry(not, &mtd_notifiers
, list
)
455 printk(KERN_NOTICE
"Removing MTD device #%d (%s) with use count %d\n",
456 mtd
->index
, mtd
->name
, mtd
->usecount
);
459 device_unregister(&mtd
->dev
);
461 idr_remove(&mtd_idr
, mtd
->index
);
463 module_put(THIS_MODULE
);
468 mutex_unlock(&mtd_table_mutex
);
473 * mtd_device_parse_register - parse partitions and register an MTD device.
475 * @mtd: the MTD device to register
476 * @types: the list of MTD partition probes to try, see
477 * 'parse_mtd_partitions()' for more information
478 * @parser_data: MTD partition parser-specific data
479 * @parts: fallback partition information to register, if parsing fails;
480 * only valid if %nr_parts > %0
481 * @nr_parts: the number of partitions in parts, if zero then the full
482 * MTD device is registered if no partition info is found
484 * This function aggregates MTD partitions parsing (done by
485 * 'parse_mtd_partitions()') and MTD device and partitions registering. It
486 * basically follows the most common pattern found in many MTD drivers:
488 * * It first tries to probe partitions on MTD device @mtd using parsers
489 * specified in @types (if @types is %NULL, then the default list of parsers
490 * is used, see 'parse_mtd_partitions()' for more information). If none are
491 * found this functions tries to fallback to information specified in
493 * * If any partitioning info was found, this function registers the found
495 * * If no partitions were found this function just registers the MTD device
498 * Returns zero in case of success and a negative error code in case of failure.
500 int mtd_device_parse_register(struct mtd_info
*mtd
, const char **types
,
501 struct mtd_part_parser_data
*parser_data
,
502 const struct mtd_partition
*parts
,
506 struct mtd_partition
*real_parts
;
508 err
= parse_mtd_partitions(mtd
, types
, &real_parts
, parser_data
);
509 if (err
<= 0 && nr_parts
&& parts
) {
510 real_parts
= kmemdup(parts
, sizeof(*parts
) * nr_parts
,
519 err
= add_mtd_partitions(mtd
, real_parts
, err
);
521 } else if (err
== 0) {
522 err
= add_mtd_device(mtd
);
529 EXPORT_SYMBOL_GPL(mtd_device_parse_register
);
532 * mtd_device_unregister - unregister an existing MTD device.
534 * @master: the MTD device to unregister. This will unregister both the master
535 * and any partitions if registered.
537 int mtd_device_unregister(struct mtd_info
*master
)
541 err
= del_mtd_partitions(master
);
545 if (!device_is_registered(&master
->dev
))
548 return del_mtd_device(master
);
550 EXPORT_SYMBOL_GPL(mtd_device_unregister
);
553 * register_mtd_user - register a 'user' of MTD devices.
554 * @new: pointer to notifier info structure
556 * Registers a pair of callbacks function to be called upon addition
557 * or removal of MTD devices. Causes the 'add' callback to be immediately
558 * invoked for each MTD device currently present in the system.
560 void register_mtd_user (struct mtd_notifier
*new)
562 struct mtd_info
*mtd
;
564 mutex_lock(&mtd_table_mutex
);
566 list_add(&new->list
, &mtd_notifiers
);
568 __module_get(THIS_MODULE
);
570 mtd_for_each_device(mtd
)
573 mutex_unlock(&mtd_table_mutex
);
575 EXPORT_SYMBOL_GPL(register_mtd_user
);
578 * unregister_mtd_user - unregister a 'user' of MTD devices.
579 * @old: pointer to notifier info structure
581 * Removes a callback function pair from the list of 'users' to be
582 * notified upon addition or removal of MTD devices. Causes the
583 * 'remove' callback to be immediately invoked for each MTD device
584 * currently present in the system.
586 int unregister_mtd_user (struct mtd_notifier
*old
)
588 struct mtd_info
*mtd
;
590 mutex_lock(&mtd_table_mutex
);
592 module_put(THIS_MODULE
);
594 mtd_for_each_device(mtd
)
597 list_del(&old
->list
);
598 mutex_unlock(&mtd_table_mutex
);
601 EXPORT_SYMBOL_GPL(unregister_mtd_user
);
604 * get_mtd_device - obtain a validated handle for an MTD device
605 * @mtd: last known address of the required MTD device
606 * @num: internal device number of the required MTD device
608 * Given a number and NULL address, return the num'th entry in the device
609 * table, if any. Given an address and num == -1, search the device table
610 * for a device with that address and return if it's still present. Given
611 * both, return the num'th driver only if its address matches. Return
614 struct mtd_info
*get_mtd_device(struct mtd_info
*mtd
, int num
)
616 struct mtd_info
*ret
= NULL
, *other
;
619 mutex_lock(&mtd_table_mutex
);
622 mtd_for_each_device(other
) {
628 } else if (num
>= 0) {
629 ret
= idr_find(&mtd_idr
, num
);
630 if (mtd
&& mtd
!= ret
)
639 err
= __get_mtd_device(ret
);
643 mutex_unlock(&mtd_table_mutex
);
646 EXPORT_SYMBOL_GPL(get_mtd_device
);
649 int __get_mtd_device(struct mtd_info
*mtd
)
653 if (!try_module_get(mtd
->owner
))
656 if (mtd
->_get_device
) {
657 err
= mtd
->_get_device(mtd
);
660 module_put(mtd
->owner
);
667 EXPORT_SYMBOL_GPL(__get_mtd_device
);
670 * get_mtd_device_nm - obtain a validated handle for an MTD device by
672 * @name: MTD device name to open
674 * This function returns MTD device description structure in case of
675 * success and an error code in case of failure.
677 struct mtd_info
*get_mtd_device_nm(const char *name
)
680 struct mtd_info
*mtd
= NULL
, *other
;
682 mutex_lock(&mtd_table_mutex
);
684 mtd_for_each_device(other
) {
685 if (!strcmp(name
, other
->name
)) {
694 err
= __get_mtd_device(mtd
);
698 mutex_unlock(&mtd_table_mutex
);
702 mutex_unlock(&mtd_table_mutex
);
705 EXPORT_SYMBOL_GPL(get_mtd_device_nm
);
707 void put_mtd_device(struct mtd_info
*mtd
)
709 mutex_lock(&mtd_table_mutex
);
710 __put_mtd_device(mtd
);
711 mutex_unlock(&mtd_table_mutex
);
714 EXPORT_SYMBOL_GPL(put_mtd_device
);
716 void __put_mtd_device(struct mtd_info
*mtd
)
719 BUG_ON(mtd
->usecount
< 0);
721 if (mtd
->_put_device
)
722 mtd
->_put_device(mtd
);
724 module_put(mtd
->owner
);
726 EXPORT_SYMBOL_GPL(__put_mtd_device
);
729 * Erase is an asynchronous operation. Device drivers are supposed
730 * to call instr->callback() whenever the operation completes, even
731 * if it completes with a failure.
732 * Callers are supposed to pass a callback function and wait for it
733 * to be called before writing to the block.
735 int mtd_erase(struct mtd_info
*mtd
, struct erase_info
*instr
)
737 if (instr
->addr
> mtd
->size
|| instr
->len
> mtd
->size
- instr
->addr
)
739 if (!(mtd
->flags
& MTD_WRITEABLE
))
741 instr
->fail_addr
= MTD_FAIL_ADDR_UNKNOWN
;
743 instr
->state
= MTD_ERASE_DONE
;
744 mtd_erase_callback(instr
);
747 return mtd
->_erase(mtd
, instr
);
749 EXPORT_SYMBOL_GPL(mtd_erase
);
752 * This stuff for eXecute-In-Place. phys is optional and may be set to NULL.
754 int mtd_point(struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
,
755 void **virt
, resource_size_t
*phys
)
763 if (from
< 0 || from
> mtd
->size
|| len
> mtd
->size
- from
)
767 return mtd
->_point(mtd
, from
, len
, retlen
, virt
, phys
);
769 EXPORT_SYMBOL_GPL(mtd_point
);
771 /* We probably shouldn't allow XIP if the unpoint isn't a NULL */
772 int mtd_unpoint(struct mtd_info
*mtd
, loff_t from
, size_t len
)
776 if (from
< 0 || from
> mtd
->size
|| len
> mtd
->size
- from
)
780 return mtd
->_unpoint(mtd
, from
, len
);
782 EXPORT_SYMBOL_GPL(mtd_unpoint
);
785 * Allow NOMMU mmap() to directly map the device (if not NULL)
786 * - return the address to which the offset maps
787 * - return -ENOSYS to indicate refusal to do the mapping
789 unsigned long mtd_get_unmapped_area(struct mtd_info
*mtd
, unsigned long len
,
790 unsigned long offset
, unsigned long flags
)
792 if (!mtd
->_get_unmapped_area
)
794 if (offset
> mtd
->size
|| len
> mtd
->size
- offset
)
796 return mtd
->_get_unmapped_area(mtd
, len
, offset
, flags
);
798 EXPORT_SYMBOL_GPL(mtd_get_unmapped_area
);
800 int mtd_read(struct mtd_info
*mtd
, loff_t from
, size_t len
, size_t *retlen
,
805 if (from
< 0 || from
> mtd
->size
|| len
> mtd
->size
- from
)
811 * In the absence of an error, drivers return a non-negative integer
812 * representing the maximum number of bitflips that were corrected on
813 * any one ecc region (if applicable; zero otherwise).
815 ret_code
= mtd
->_read(mtd
, from
, len
, retlen
, buf
);
816 if (unlikely(ret_code
< 0))
818 if (mtd
->ecc_strength
== 0)
819 return 0; /* device lacks ecc */
820 return ret_code
>= mtd
->bitflip_threshold
? -EUCLEAN
: 0;
822 EXPORT_SYMBOL_GPL(mtd_read
);
824 int mtd_write(struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
,
828 if (to
< 0 || to
> mtd
->size
|| len
> mtd
->size
- to
)
830 if (!mtd
->_write
|| !(mtd
->flags
& MTD_WRITEABLE
))
834 return mtd
->_write(mtd
, to
, len
, retlen
, buf
);
836 EXPORT_SYMBOL_GPL(mtd_write
);
839 * In blackbox flight recorder like scenarios we want to make successful writes
840 * in interrupt context. panic_write() is only intended to be called when its
841 * known the kernel is about to panic and we need the write to succeed. Since
842 * the kernel is not going to be running for much longer, this function can
843 * break locks and delay to ensure the write succeeds (but not sleep).
845 int mtd_panic_write(struct mtd_info
*mtd
, loff_t to
, size_t len
, size_t *retlen
,
849 if (!mtd
->_panic_write
)
851 if (to
< 0 || to
> mtd
->size
|| len
> mtd
->size
- to
)
853 if (!(mtd
->flags
& MTD_WRITEABLE
))
857 return mtd
->_panic_write(mtd
, to
, len
, retlen
, buf
);
859 EXPORT_SYMBOL_GPL(mtd_panic_write
);
862 * Method to access the protection register area, present in some flash
863 * devices. The user data is one time programmable but the factory data is read
866 int mtd_get_fact_prot_info(struct mtd_info
*mtd
, struct otp_info
*buf
,
869 if (!mtd
->_get_fact_prot_info
)
873 return mtd
->_get_fact_prot_info(mtd
, buf
, len
);
875 EXPORT_SYMBOL_GPL(mtd_get_fact_prot_info
);
877 int mtd_read_fact_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
,
878 size_t *retlen
, u_char
*buf
)
881 if (!mtd
->_read_fact_prot_reg
)
885 return mtd
->_read_fact_prot_reg(mtd
, from
, len
, retlen
, buf
);
887 EXPORT_SYMBOL_GPL(mtd_read_fact_prot_reg
);
889 int mtd_get_user_prot_info(struct mtd_info
*mtd
, struct otp_info
*buf
,
892 if (!mtd
->_get_user_prot_info
)
896 return mtd
->_get_user_prot_info(mtd
, buf
, len
);
898 EXPORT_SYMBOL_GPL(mtd_get_user_prot_info
);
900 int mtd_read_user_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
,
901 size_t *retlen
, u_char
*buf
)
904 if (!mtd
->_read_user_prot_reg
)
908 return mtd
->_read_user_prot_reg(mtd
, from
, len
, retlen
, buf
);
910 EXPORT_SYMBOL_GPL(mtd_read_user_prot_reg
);
912 int mtd_write_user_prot_reg(struct mtd_info
*mtd
, loff_t to
, size_t len
,
913 size_t *retlen
, u_char
*buf
)
916 if (!mtd
->_write_user_prot_reg
)
920 return mtd
->_write_user_prot_reg(mtd
, to
, len
, retlen
, buf
);
922 EXPORT_SYMBOL_GPL(mtd_write_user_prot_reg
);
924 int mtd_lock_user_prot_reg(struct mtd_info
*mtd
, loff_t from
, size_t len
)
926 if (!mtd
->_lock_user_prot_reg
)
930 return mtd
->_lock_user_prot_reg(mtd
, from
, len
);
932 EXPORT_SYMBOL_GPL(mtd_lock_user_prot_reg
);
934 /* Chip-supported device locking */
935 int mtd_lock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
939 if (ofs
< 0 || ofs
> mtd
->size
|| len
> mtd
->size
- ofs
)
943 return mtd
->_lock(mtd
, ofs
, len
);
945 EXPORT_SYMBOL_GPL(mtd_lock
);
947 int mtd_unlock(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
951 if (ofs
< 0 || ofs
> mtd
->size
|| len
> mtd
->size
- ofs
)
955 return mtd
->_unlock(mtd
, ofs
, len
);
957 EXPORT_SYMBOL_GPL(mtd_unlock
);
959 int mtd_is_locked(struct mtd_info
*mtd
, loff_t ofs
, uint64_t len
)
961 if (!mtd
->_is_locked
)
963 if (ofs
< 0 || ofs
> mtd
->size
|| len
> mtd
->size
- ofs
)
967 return mtd
->_is_locked(mtd
, ofs
, len
);
969 EXPORT_SYMBOL_GPL(mtd_is_locked
);
971 int mtd_block_isbad(struct mtd_info
*mtd
, loff_t ofs
)
973 if (!mtd
->_block_isbad
)
975 if (ofs
< 0 || ofs
> mtd
->size
)
977 return mtd
->_block_isbad(mtd
, ofs
);
979 EXPORT_SYMBOL_GPL(mtd_block_isbad
);
981 int mtd_block_markbad(struct mtd_info
*mtd
, loff_t ofs
)
983 if (!mtd
->_block_markbad
)
985 if (ofs
< 0 || ofs
> mtd
->size
)
987 if (!(mtd
->flags
& MTD_WRITEABLE
))
989 return mtd
->_block_markbad(mtd
, ofs
);
991 EXPORT_SYMBOL_GPL(mtd_block_markbad
);
994 * default_mtd_writev - the default writev method
995 * @mtd: mtd device description object pointer
996 * @vecs: the vectors to write
997 * @count: count of vectors in @vecs
998 * @to: the MTD device offset to write to
999 * @retlen: on exit contains the count of bytes written to the MTD device.
1001 * This function returns zero in case of success and a negative error code in
1004 static int default_mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
1005 unsigned long count
, loff_t to
, size_t *retlen
)
1008 size_t totlen
= 0, thislen
;
1011 for (i
= 0; i
< count
; i
++) {
1012 if (!vecs
[i
].iov_len
)
1014 ret
= mtd_write(mtd
, to
, vecs
[i
].iov_len
, &thislen
,
1017 if (ret
|| thislen
!= vecs
[i
].iov_len
)
1019 to
+= vecs
[i
].iov_len
;
1026 * mtd_writev - the vector-based MTD write method
1027 * @mtd: mtd device description object pointer
1028 * @vecs: the vectors to write
1029 * @count: count of vectors in @vecs
1030 * @to: the MTD device offset to write to
1031 * @retlen: on exit contains the count of bytes written to the MTD device.
1033 * This function returns zero in case of success and a negative error code in
1036 int mtd_writev(struct mtd_info
*mtd
, const struct kvec
*vecs
,
1037 unsigned long count
, loff_t to
, size_t *retlen
)
1040 if (!(mtd
->flags
& MTD_WRITEABLE
))
1043 return default_mtd_writev(mtd
, vecs
, count
, to
, retlen
);
1044 return mtd
->_writev(mtd
, vecs
, count
, to
, retlen
);
1046 EXPORT_SYMBOL_GPL(mtd_writev
);
1049 * mtd_kmalloc_up_to - allocate a contiguous buffer up to the specified size
1050 * @mtd: mtd device description object pointer
1051 * @size: a pointer to the ideal or maximum size of the allocation, points
1052 * to the actual allocation size on success.
1054 * This routine attempts to allocate a contiguous kernel buffer up to
1055 * the specified size, backing off the size of the request exponentially
1056 * until the request succeeds or until the allocation size falls below
1057 * the system page size. This attempts to make sure it does not adversely
1058 * impact system performance, so when allocating more than one page, we
1059 * ask the memory allocator to avoid re-trying, swapping, writing back
1060 * or performing I/O.
1062 * Note, this function also makes sure that the allocated buffer is aligned to
1063 * the MTD device's min. I/O unit, i.e. the "mtd->writesize" value.
1065 * This is called, for example by mtd_{read,write} and jffs2_scan_medium,
1066 * to handle smaller (i.e. degraded) buffer allocations under low- or
1067 * fragmented-memory situations where such reduced allocations, from a
1068 * requested ideal, are allowed.
1070 * Returns a pointer to the allocated buffer on success; otherwise, NULL.
1072 void *mtd_kmalloc_up_to(const struct mtd_info
*mtd
, size_t *size
)
1074 gfp_t flags
= __GFP_NOWARN
| __GFP_WAIT
|
1075 __GFP_NORETRY
| __GFP_NO_KSWAPD
;
1076 size_t min_alloc
= max_t(size_t, mtd
->writesize
, PAGE_SIZE
);
1079 *size
= min_t(size_t, *size
, KMALLOC_MAX_SIZE
);
1081 while (*size
> min_alloc
) {
1082 kbuf
= kmalloc(*size
, flags
);
1087 *size
= ALIGN(*size
, mtd
->writesize
);
1091 * For the last resort allocation allow 'kmalloc()' to do all sorts of
1092 * things (write-back, dropping caches, etc) by using GFP_KERNEL.
1094 return kmalloc(*size
, GFP_KERNEL
);
1096 EXPORT_SYMBOL_GPL(mtd_kmalloc_up_to
);
1098 #ifdef CONFIG_PROC_FS
1100 /*====================================================================*/
1101 /* Support for /proc/mtd */
1103 static struct proc_dir_entry
*proc_mtd
;
1105 static int mtd_proc_show(struct seq_file
*m
, void *v
)
1107 struct mtd_info
*mtd
;
1109 seq_puts(m
, "dev: size erasesize name\n");
1110 mutex_lock(&mtd_table_mutex
);
1111 mtd_for_each_device(mtd
) {
1112 seq_printf(m
, "mtd%d: %8.8llx %8.8x \"%s\"\n",
1113 mtd
->index
, (unsigned long long)mtd
->size
,
1114 mtd
->erasesize
, mtd
->name
);
1116 mutex_unlock(&mtd_table_mutex
);
1120 static int mtd_proc_open(struct inode
*inode
, struct file
*file
)
1122 return single_open(file
, mtd_proc_show
, NULL
);
1125 static const struct file_operations mtd_proc_ops
= {
1126 .open
= mtd_proc_open
,
1128 .llseek
= seq_lseek
,
1129 .release
= single_release
,
1131 #endif /* CONFIG_PROC_FS */
1133 /*====================================================================*/
1136 static int __init
mtd_bdi_init(struct backing_dev_info
*bdi
, const char *name
)
1140 ret
= bdi_init(bdi
);
1142 ret
= bdi_register(bdi
, NULL
, name
);
1150 static int __init
init_mtd(void)
1154 ret
= class_register(&mtd_class
);
1158 ret
= mtd_bdi_init(&mtd_bdi_unmappable
, "mtd-unmap");
1162 ret
= mtd_bdi_init(&mtd_bdi_ro_mappable
, "mtd-romap");
1166 ret
= mtd_bdi_init(&mtd_bdi_rw_mappable
, "mtd-rwmap");
1170 #ifdef CONFIG_PROC_FS
1171 proc_mtd
= proc_create("mtd", 0, NULL
, &mtd_proc_ops
);
1172 #endif /* CONFIG_PROC_FS */
1176 bdi_destroy(&mtd_bdi_ro_mappable
);
1178 bdi_destroy(&mtd_bdi_unmappable
);
1180 class_unregister(&mtd_class
);
1182 pr_err("Error registering mtd class or bdi: %d\n", ret
);
1186 static void __exit
cleanup_mtd(void)
1188 #ifdef CONFIG_PROC_FS
1190 remove_proc_entry( "mtd", NULL
);
1191 #endif /* CONFIG_PROC_FS */
1192 class_unregister(&mtd_class
);
1193 bdi_destroy(&mtd_bdi_unmappable
);
1194 bdi_destroy(&mtd_bdi_ro_mappable
);
1195 bdi_destroy(&mtd_bdi_rw_mappable
);
1198 module_init(init_mtd
);
1199 module_exit(cleanup_mtd
);
1201 MODULE_LICENSE("GPL");
1202 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1203 MODULE_DESCRIPTION("Core MTD registration and access routines");