2 * Character-device access to raw MTD devices.
6 #include <linux/device.h>
10 #include <linux/init.h>
11 #include <linux/kernel.h>
12 #include <linux/module.h>
13 #include <linux/slab.h>
14 #include <linux/sched.h>
15 #include <linux/smp_lock.h>
16 #include <linux/backing-dev.h>
17 #include <linux/compat.h>
18 #include <linux/mount.h>
20 #include <linux/mtd/mtd.h>
21 #include <linux/mtd/compatmac.h>
23 #include <asm/uaccess.h>
25 #define MTD_INODE_FS_MAGIC 0x11307854
26 static struct vfsmount *mtd_inode_mnt __read_mostly;
29 * Data structure to hold the pointer to the mtd device as well
30 * as mode information ofr various use cases.
32 struct mtd_file_info {
35 enum mtd_file_modes mode;
38 static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
40 struct mtd_file_info *mfi = file->private_data;
41 struct mtd_info *mtd = mfi->mtd;
47 offset += file->f_pos;
56 if (offset >= 0 && offset <= mtd->size)
57 return file->f_pos = offset;
64 static int mtd_open(struct inode *inode, struct file *file)
66 int minor = iminor(inode);
67 int devnum = minor >> 1;
70 struct mtd_file_info *mfi;
71 struct inode *mtd_ino;
73 DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
75 /* You can't open the RO devices RW */
76 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
80 mtd = get_mtd_device(NULL, devnum);
87 if (mtd->type == MTD_ABSENT) {
93 mtd_ino = iget_locked(mtd_inode_mnt->mnt_sb, devnum);
99 if (mtd_ino->i_state & I_NEW) {
100 mtd_ino->i_private = mtd;
101 mtd_ino->i_mode = S_IFCHR;
102 mtd_ino->i_data.backing_dev_info = mtd->backing_dev_info;
103 unlock_new_inode(mtd_ino);
105 file->f_mapping = mtd_ino->i_mapping;
107 /* You can't open it RW if it's not a writeable device */
108 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
115 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
124 file->private_data = mfi;
131 /*====================================================================*/
133 static int mtd_close(struct inode *inode, struct file *file)
135 struct mtd_file_info *mfi = file->private_data;
136 struct mtd_info *mtd = mfi->mtd;
138 DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
140 /* Only sync if opened RW */
141 if ((file->f_mode & FMODE_WRITE) && mtd->sync)
147 file->private_data = NULL;
153 /* FIXME: This _really_ needs to die. In 2.5, we should lock the
154 userspace buffer down and use it directly with readv/writev.
156 #define MAX_KMALLOC_SIZE 0x20000
158 static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
160 struct mtd_file_info *mfi = file->private_data;
161 struct mtd_info *mtd = mfi->mtd;
163 size_t total_retlen=0;
168 DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
170 if (*ppos + count > mtd->size)
171 count = mtd->size - *ppos;
176 /* FIXME: Use kiovec in 2.5 to lock down the user's buffers
177 and pass them directly to the MTD functions */
179 if (count > MAX_KMALLOC_SIZE)
180 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
182 kbuf=kmalloc(count, GFP_KERNEL);
189 if (count > MAX_KMALLOC_SIZE)
190 len = MAX_KMALLOC_SIZE;
195 case MTD_MODE_OTP_FACTORY:
196 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
198 case MTD_MODE_OTP_USER:
199 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
203 struct mtd_oob_ops ops;
205 ops.mode = MTD_OOB_RAW;
210 ret = mtd->read_oob(mtd, *ppos, &ops);
215 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
217 /* Nand returns -EBADMSG on ecc errors, but it returns
218 * the data. For our userspace tools it is important
219 * to dump areas with ecc errors !
220 * For kernel internal usage it also might return -EUCLEAN
221 * to signal the caller that a bitflip has occured and has
222 * been corrected by the ECC algorithm.
223 * Userspace software which accesses NAND this way
224 * must be aware of the fact that it deals with NAND
226 if (!ret || (ret == -EUCLEAN) || (ret == -EBADMSG)) {
228 if (copy_to_user(buf, kbuf, retlen)) {
233 total_retlen += retlen;
251 static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
253 struct mtd_file_info *mfi = file->private_data;
254 struct mtd_info *mtd = mfi->mtd;
257 size_t total_retlen=0;
261 DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
263 if (*ppos == mtd->size)
266 if (*ppos + count > mtd->size)
267 count = mtd->size - *ppos;
272 if (count > MAX_KMALLOC_SIZE)
273 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
275 kbuf=kmalloc(count, GFP_KERNEL);
282 if (count > MAX_KMALLOC_SIZE)
283 len = MAX_KMALLOC_SIZE;
287 if (copy_from_user(kbuf, buf, len)) {
293 case MTD_MODE_OTP_FACTORY:
296 case MTD_MODE_OTP_USER:
297 if (!mtd->write_user_prot_reg) {
301 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
306 struct mtd_oob_ops ops;
308 ops.mode = MTD_OOB_RAW;
313 ret = mtd->write_oob(mtd, *ppos, &ops);
319 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
323 total_retlen += retlen;
337 /*======================================================================
339 IOCTL calls for getting device parameters.
341 ======================================================================*/
342 static void mtdchar_erase_callback (struct erase_info *instr)
344 wake_up((wait_queue_head_t *)instr->priv);
347 #ifdef CONFIG_HAVE_MTD_OTP
348 static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
350 struct mtd_info *mtd = mfi->mtd;
354 case MTD_OTP_FACTORY:
355 if (!mtd->read_fact_prot_reg)
358 mfi->mode = MTD_MODE_OTP_FACTORY;
361 if (!mtd->read_fact_prot_reg)
364 mfi->mode = MTD_MODE_OTP_USER;
374 # define otp_select_filemode(f,m) -EOPNOTSUPP
377 static int mtd_do_writeoob(struct file *file, struct mtd_info *mtd,
378 uint64_t start, uint32_t length, void __user *ptr,
379 uint32_t __user *retp)
381 struct mtd_oob_ops ops;
385 if (!(file->f_mode & FMODE_WRITE))
394 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
400 ops.ooboffs = start & (mtd->oobsize - 1);
402 ops.mode = MTD_OOB_PLACE;
404 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
407 ops.oobbuf = kmalloc(length, GFP_KERNEL);
411 if (copy_from_user(ops.oobbuf, ptr, length)) {
416 start &= ~((uint64_t)mtd->oobsize - 1);
417 ret = mtd->write_oob(mtd, start, &ops);
419 if (ops.oobretlen > 0xFFFFFFFFU)
421 retlen = ops.oobretlen;
422 if (copy_to_user(retp, &retlen, sizeof(length)))
429 static int mtd_do_readoob(struct mtd_info *mtd, uint64_t start,
430 uint32_t length, void __user *ptr, uint32_t __user *retp)
432 struct mtd_oob_ops ops;
441 ret = access_ok(VERIFY_WRITE, ptr,
442 length) ? 0 : -EFAULT;
447 ops.ooboffs = start & (mtd->oobsize - 1);
449 ops.mode = MTD_OOB_PLACE;
451 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
454 ops.oobbuf = kmalloc(length, GFP_KERNEL);
458 start &= ~((uint64_t)mtd->oobsize - 1);
459 ret = mtd->read_oob(mtd, start, &ops);
461 if (put_user(ops.oobretlen, retp))
463 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
471 static int mtd_ioctl(struct inode *inode, struct file *file,
472 u_int cmd, u_long arg)
474 struct mtd_file_info *mfi = file->private_data;
475 struct mtd_info *mtd = mfi->mtd;
476 void __user *argp = (void __user *)arg;
479 struct mtd_info_user info;
481 DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
483 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
485 if (!access_ok(VERIFY_READ, argp, size))
489 if (!access_ok(VERIFY_WRITE, argp, size))
494 case MEMGETREGIONCOUNT:
495 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
499 case MEMGETREGIONINFO:
502 struct mtd_erase_region_info *kr;
503 struct region_info_user __user *ur = argp;
505 if (get_user(ur_idx, &(ur->regionindex)))
508 kr = &(mtd->eraseregions[ur_idx]);
510 if (put_user(kr->offset, &(ur->offset))
511 || put_user(kr->erasesize, &(ur->erasesize))
512 || put_user(kr->numblocks, &(ur->numblocks)))
519 info.type = mtd->type;
520 info.flags = mtd->flags;
521 info.size = mtd->size;
522 info.erasesize = mtd->erasesize;
523 info.writesize = mtd->writesize;
524 info.oobsize = mtd->oobsize;
525 /* The below fields are obsolete */
528 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
535 struct erase_info *erase;
537 if(!(file->f_mode & FMODE_WRITE))
540 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
544 wait_queue_head_t waitq;
545 DECLARE_WAITQUEUE(wait, current);
547 init_waitqueue_head(&waitq);
549 if (cmd == MEMERASE64) {
550 struct erase_info_user64 einfo64;
552 if (copy_from_user(&einfo64, argp,
553 sizeof(struct erase_info_user64))) {
557 erase->addr = einfo64.start;
558 erase->len = einfo64.length;
560 struct erase_info_user einfo32;
562 if (copy_from_user(&einfo32, argp,
563 sizeof(struct erase_info_user))) {
567 erase->addr = einfo32.start;
568 erase->len = einfo32.length;
571 erase->callback = mtdchar_erase_callback;
572 erase->priv = (unsigned long)&waitq;
575 FIXME: Allow INTERRUPTIBLE. Which means
576 not having the wait_queue head on the stack.
578 If the wq_head is on the stack, and we
579 leave because we got interrupted, then the
580 wq_head is no longer there when the
581 callback routine tries to wake us up.
583 ret = mtd->erase(mtd, erase);
585 set_current_state(TASK_UNINTERRUPTIBLE);
586 add_wait_queue(&waitq, &wait);
587 if (erase->state != MTD_ERASE_DONE &&
588 erase->state != MTD_ERASE_FAILED)
590 remove_wait_queue(&waitq, &wait);
591 set_current_state(TASK_RUNNING);
593 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
602 struct mtd_oob_buf buf;
603 struct mtd_oob_buf __user *buf_user = argp;
605 /* NOTE: writes return length to buf_user->length */
606 if (copy_from_user(&buf, argp, sizeof(buf)))
609 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
610 buf.ptr, &buf_user->length);
616 struct mtd_oob_buf buf;
617 struct mtd_oob_buf __user *buf_user = argp;
619 /* NOTE: writes return length to buf_user->start */
620 if (copy_from_user(&buf, argp, sizeof(buf)))
623 ret = mtd_do_readoob(mtd, buf.start, buf.length,
624 buf.ptr, &buf_user->start);
630 struct mtd_oob_buf64 buf;
631 struct mtd_oob_buf64 __user *buf_user = argp;
633 if (copy_from_user(&buf, argp, sizeof(buf)))
636 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
637 (void __user *)(uintptr_t)buf.usr_ptr,
644 struct mtd_oob_buf64 buf;
645 struct mtd_oob_buf64 __user *buf_user = argp;
647 if (copy_from_user(&buf, argp, sizeof(buf)))
650 ret = mtd_do_readoob(mtd, buf.start, buf.length,
651 (void __user *)(uintptr_t)buf.usr_ptr,
658 struct erase_info_user einfo;
660 if (copy_from_user(&einfo, argp, sizeof(einfo)))
666 ret = mtd->lock(mtd, einfo.start, einfo.length);
672 struct erase_info_user einfo;
674 if (copy_from_user(&einfo, argp, sizeof(einfo)))
680 ret = mtd->unlock(mtd, einfo.start, einfo.length);
684 /* Legacy interface */
687 struct nand_oobinfo oi;
691 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
694 oi.useecc = MTD_NANDECC_AUTOPLACE;
695 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
696 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
698 oi.eccbytes = mtd->ecclayout->eccbytes;
700 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
709 if (copy_from_user(&offs, argp, sizeof(loff_t)))
711 if (!mtd->block_isbad)
714 return mtd->block_isbad(mtd, offs);
722 if (copy_from_user(&offs, argp, sizeof(loff_t)))
724 if (!mtd->block_markbad)
727 return mtd->block_markbad(mtd, offs);
731 #ifdef CONFIG_HAVE_MTD_OTP
735 if (copy_from_user(&mode, argp, sizeof(int)))
738 mfi->mode = MTD_MODE_NORMAL;
740 ret = otp_select_filemode(mfi, mode);
746 case OTPGETREGIONCOUNT:
747 case OTPGETREGIONINFO:
749 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
754 case MTD_MODE_OTP_FACTORY:
755 if (mtd->get_fact_prot_info)
756 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
758 case MTD_MODE_OTP_USER:
759 if (mtd->get_user_prot_info)
760 ret = mtd->get_user_prot_info(mtd, buf, 4096);
766 if (cmd == OTPGETREGIONCOUNT) {
767 int nbr = ret / sizeof(struct otp_info);
768 ret = copy_to_user(argp, &nbr, sizeof(int));
770 ret = copy_to_user(argp, buf, ret);
780 struct otp_info oinfo;
782 if (mfi->mode != MTD_MODE_OTP_USER)
784 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
786 if (!mtd->lock_user_prot_reg)
788 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
798 if (copy_to_user(argp, mtd->ecclayout,
799 sizeof(struct nand_ecclayout)))
806 if (copy_to_user(argp, &mtd->ecc_stats,
807 sizeof(struct mtd_ecc_stats)))
817 case MTD_MODE_OTP_FACTORY:
818 case MTD_MODE_OTP_USER:
819 ret = otp_select_filemode(mfi, arg);
823 if (!mtd->read_oob || !mtd->write_oob)
827 case MTD_MODE_NORMAL:
845 struct mtd_oob_buf32 {
848 compat_caddr_t ptr; /* unsigned char* */
851 #define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
852 #define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
854 static long mtd_compat_ioctl(struct file *file, unsigned int cmd,
857 struct inode *inode = file->f_path.dentry->d_inode;
858 struct mtd_file_info *mfi = file->private_data;
859 struct mtd_info *mtd = mfi->mtd;
860 void __user *argp = compat_ptr(arg);
868 struct mtd_oob_buf32 buf;
869 struct mtd_oob_buf32 __user *buf_user = argp;
871 if (copy_from_user(&buf, argp, sizeof(buf)))
874 ret = mtd_do_writeoob(file, mtd, buf.start,
875 buf.length, compat_ptr(buf.ptr),
882 struct mtd_oob_buf32 buf;
883 struct mtd_oob_buf32 __user *buf_user = argp;
885 /* NOTE: writes return length to buf->start */
886 if (copy_from_user(&buf, argp, sizeof(buf)))
889 ret = mtd_do_readoob(mtd, buf.start,
890 buf.length, compat_ptr(buf.ptr),
895 ret = mtd_ioctl(inode, file, cmd, (unsigned long)argp);
903 #endif /* CONFIG_COMPAT */
906 * try to determine where a shared mapping can be made
907 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
911 static unsigned long mtd_get_unmapped_area(struct file *file,
917 struct mtd_file_info *mfi = file->private_data;
918 struct mtd_info *mtd = mfi->mtd;
920 if (mtd->get_unmapped_area) {
921 unsigned long offset;
924 return (unsigned long) -EINVAL;
926 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
927 return (unsigned long) -EINVAL;
929 offset = pgoff << PAGE_SHIFT;
930 if (offset > mtd->size - len)
931 return (unsigned long) -EINVAL;
933 return mtd->get_unmapped_area(mtd, len, offset, flags);
936 /* can't map directly */
937 return (unsigned long) -ENOSYS;
942 * set up a mapping for shared memory segments
944 static int mtd_mmap(struct file *file, struct vm_area_struct *vma)
947 struct mtd_file_info *mfi = file->private_data;
948 struct mtd_info *mtd = mfi->mtd;
950 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM)
954 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
958 static const struct file_operations mtd_fops = {
959 .owner = THIS_MODULE,
965 .compat_ioctl = mtd_compat_ioctl,
968 .release = mtd_close,
971 .get_unmapped_area = mtd_get_unmapped_area,
975 static int mtd_inodefs_get_sb(struct file_system_type *fs_type, int flags,
976 const char *dev_name, void *data,
977 struct vfsmount *mnt)
979 return get_sb_pseudo(fs_type, "mtd_inode:", NULL, MTD_INODE_FS_MAGIC,
983 static struct file_system_type mtd_inodefs_type = {
984 .name = "mtd_inodefs",
985 .get_sb = mtd_inodefs_get_sb,
986 .kill_sb = kill_anon_super,
989 static void mtdchar_notify_add(struct mtd_info *mtd)
993 static void mtdchar_notify_remove(struct mtd_info *mtd)
995 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
998 /* Destroy the inode if it exists */
999 mtd_ino->i_nlink = 0;
1004 static struct mtd_notifier mtdchar_notifier = {
1005 .add = mtdchar_notify_add,
1006 .remove = mtdchar_notify_remove,
1009 static int __init init_mtdchar(void)
1013 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
1016 pr_notice("Can't allocate major number %d for "
1017 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1021 ret = register_filesystem(&mtd_inodefs_type);
1023 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1024 goto err_unregister_chdev;
1027 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1028 if (IS_ERR(mtd_inode_mnt)) {
1029 ret = PTR_ERR(mtd_inode_mnt);
1030 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1031 goto err_unregister_filesystem;
1033 register_mtd_user(&mtdchar_notifier);
1037 err_unregister_filesystem:
1038 unregister_filesystem(&mtd_inodefs_type);
1039 err_unregister_chdev:
1040 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1044 static void __exit cleanup_mtdchar(void)
1046 unregister_mtd_user(&mtdchar_notifier);
1047 mntput(mtd_inode_mnt);
1048 unregister_filesystem(&mtd_inodefs_type);
1049 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1052 module_init(init_mtdchar);
1053 module_exit(cleanup_mtdchar);
1055 MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
1057 MODULE_LICENSE("GPL");
1058 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1059 MODULE_DESCRIPTION("Direct character-device access to MTD devices");
1060 MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);