2 * Copyright © 1999-2010 David Woodhouse <dwmw2@infradead.org>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 #include <linux/device.h>
23 #include <linux/err.h>
24 #include <linux/init.h>
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/slab.h>
28 #include <linux/sched.h>
29 #include <linux/smp_lock.h>
30 #include <linux/backing-dev.h>
31 #include <linux/compat.h>
32 #include <linux/mount.h>
34 #include <linux/mtd/mtd.h>
35 #include <linux/mtd/map.h>
37 #include <asm/uaccess.h>
39 #define MTD_INODE_FS_MAGIC 0x11307854
40 static struct vfsmount *mtd_inode_mnt __read_mostly;
43 * Data structure to hold the pointer to the mtd device as well
44 * as mode information ofr various use cases.
46 struct mtd_file_info {
49 enum mtd_file_modes mode;
52 static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
54 struct mtd_file_info *mfi = file->private_data;
55 struct mtd_info *mtd = mfi->mtd;
61 offset += file->f_pos;
70 if (offset >= 0 && offset <= mtd->size)
71 return file->f_pos = offset;
78 static int mtd_open(struct inode *inode, struct file *file)
80 int minor = iminor(inode);
81 int devnum = minor >> 1;
84 struct mtd_file_info *mfi;
85 struct inode *mtd_ino;
87 DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
89 /* You can't open the RO devices RW */
90 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
94 mtd = get_mtd_device(NULL, devnum);
101 if (mtd->type == MTD_ABSENT) {
107 mtd_ino = iget_locked(mtd_inode_mnt->mnt_sb, devnum);
113 if (mtd_ino->i_state & I_NEW) {
114 mtd_ino->i_private = mtd;
115 mtd_ino->i_mode = S_IFCHR;
116 mtd_ino->i_data.backing_dev_info = mtd->backing_dev_info;
117 unlock_new_inode(mtd_ino);
119 file->f_mapping = mtd_ino->i_mapping;
121 /* You can't open it RW if it's not a writeable device */
122 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
129 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
138 file->private_data = mfi;
145 /*====================================================================*/
147 static int mtd_close(struct inode *inode, struct file *file)
149 struct mtd_file_info *mfi = file->private_data;
150 struct mtd_info *mtd = mfi->mtd;
152 DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
154 /* Only sync if opened RW */
155 if ((file->f_mode & FMODE_WRITE) && mtd->sync)
161 file->private_data = NULL;
167 /* FIXME: This _really_ needs to die. In 2.5, we should lock the
168 userspace buffer down and use it directly with readv/writev.
170 #define MAX_KMALLOC_SIZE 0x20000
172 static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
174 struct mtd_file_info *mfi = file->private_data;
175 struct mtd_info *mtd = mfi->mtd;
177 size_t total_retlen=0;
182 DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
184 if (*ppos + count > mtd->size)
185 count = mtd->size - *ppos;
190 /* FIXME: Use kiovec in 2.5 to lock down the user's buffers
191 and pass them directly to the MTD functions */
193 if (count > MAX_KMALLOC_SIZE)
194 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
196 kbuf=kmalloc(count, GFP_KERNEL);
203 if (count > MAX_KMALLOC_SIZE)
204 len = MAX_KMALLOC_SIZE;
209 case MTD_MODE_OTP_FACTORY:
210 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
212 case MTD_MODE_OTP_USER:
213 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
217 struct mtd_oob_ops ops;
219 ops.mode = MTD_OOB_RAW;
224 ret = mtd->read_oob(mtd, *ppos, &ops);
229 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
231 /* Nand returns -EBADMSG on ecc errors, but it returns
232 * the data. For our userspace tools it is important
233 * to dump areas with ecc errors !
234 * For kernel internal usage it also might return -EUCLEAN
235 * to signal the caller that a bitflip has occured and has
236 * been corrected by the ECC algorithm.
237 * Userspace software which accesses NAND this way
238 * must be aware of the fact that it deals with NAND
240 if (!ret || (ret == -EUCLEAN) || (ret == -EBADMSG)) {
242 if (copy_to_user(buf, kbuf, retlen)) {
247 total_retlen += retlen;
265 static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
267 struct mtd_file_info *mfi = file->private_data;
268 struct mtd_info *mtd = mfi->mtd;
271 size_t total_retlen=0;
275 DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
277 if (*ppos == mtd->size)
280 if (*ppos + count > mtd->size)
281 count = mtd->size - *ppos;
286 if (count > MAX_KMALLOC_SIZE)
287 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
289 kbuf=kmalloc(count, GFP_KERNEL);
296 if (count > MAX_KMALLOC_SIZE)
297 len = MAX_KMALLOC_SIZE;
301 if (copy_from_user(kbuf, buf, len)) {
307 case MTD_MODE_OTP_FACTORY:
310 case MTD_MODE_OTP_USER:
311 if (!mtd->write_user_prot_reg) {
315 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
320 struct mtd_oob_ops ops;
322 ops.mode = MTD_OOB_RAW;
327 ret = mtd->write_oob(mtd, *ppos, &ops);
333 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
337 total_retlen += retlen;
351 /*======================================================================
353 IOCTL calls for getting device parameters.
355 ======================================================================*/
356 static void mtdchar_erase_callback (struct erase_info *instr)
358 wake_up((wait_queue_head_t *)instr->priv);
361 #ifdef CONFIG_HAVE_MTD_OTP
362 static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
364 struct mtd_info *mtd = mfi->mtd;
368 case MTD_OTP_FACTORY:
369 if (!mtd->read_fact_prot_reg)
372 mfi->mode = MTD_MODE_OTP_FACTORY;
375 if (!mtd->read_fact_prot_reg)
378 mfi->mode = MTD_MODE_OTP_USER;
388 # define otp_select_filemode(f,m) -EOPNOTSUPP
391 static int mtd_do_writeoob(struct file *file, struct mtd_info *mtd,
392 uint64_t start, uint32_t length, void __user *ptr,
393 uint32_t __user *retp)
395 struct mtd_oob_ops ops;
399 if (!(file->f_mode & FMODE_WRITE))
408 ret = access_ok(VERIFY_READ, ptr, length) ? 0 : -EFAULT;
414 ops.ooboffs = start & (mtd->oobsize - 1);
416 ops.mode = MTD_OOB_PLACE;
418 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
421 ops.oobbuf = memdup_user(ptr, length);
422 if (IS_ERR(ops.oobbuf))
423 return PTR_ERR(ops.oobbuf);
425 start &= ~((uint64_t)mtd->oobsize - 1);
426 ret = mtd->write_oob(mtd, start, &ops);
428 if (ops.oobretlen > 0xFFFFFFFFU)
430 retlen = ops.oobretlen;
431 if (copy_to_user(retp, &retlen, sizeof(length)))
438 static int mtd_do_readoob(struct mtd_info *mtd, uint64_t start,
439 uint32_t length, void __user *ptr, uint32_t __user *retp)
441 struct mtd_oob_ops ops;
450 ret = access_ok(VERIFY_WRITE, ptr,
451 length) ? 0 : -EFAULT;
456 ops.ooboffs = start & (mtd->oobsize - 1);
458 ops.mode = MTD_OOB_PLACE;
460 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
463 ops.oobbuf = kmalloc(length, GFP_KERNEL);
467 start &= ~((uint64_t)mtd->oobsize - 1);
468 ret = mtd->read_oob(mtd, start, &ops);
470 if (put_user(ops.oobretlen, retp))
472 else if (ops.oobretlen && copy_to_user(ptr, ops.oobbuf,
480 static int mtd_ioctl(struct file *file, u_int cmd, u_long arg)
482 struct mtd_file_info *mfi = file->private_data;
483 struct mtd_info *mtd = mfi->mtd;
484 void __user *argp = (void __user *)arg;
487 struct mtd_info_user info;
489 DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
491 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
493 if (!access_ok(VERIFY_READ, argp, size))
497 if (!access_ok(VERIFY_WRITE, argp, size))
502 case MEMGETREGIONCOUNT:
503 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
507 case MEMGETREGIONINFO:
510 struct mtd_erase_region_info *kr;
511 struct region_info_user __user *ur = argp;
513 if (get_user(ur_idx, &(ur->regionindex)))
516 kr = &(mtd->eraseregions[ur_idx]);
518 if (put_user(kr->offset, &(ur->offset))
519 || put_user(kr->erasesize, &(ur->erasesize))
520 || put_user(kr->numblocks, &(ur->numblocks)))
527 info.type = mtd->type;
528 info.flags = mtd->flags;
529 info.size = mtd->size;
530 info.erasesize = mtd->erasesize;
531 info.writesize = mtd->writesize;
532 info.oobsize = mtd->oobsize;
533 /* The below fields are obsolete */
536 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
543 struct erase_info *erase;
545 if(!(file->f_mode & FMODE_WRITE))
548 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
552 wait_queue_head_t waitq;
553 DECLARE_WAITQUEUE(wait, current);
555 init_waitqueue_head(&waitq);
557 if (cmd == MEMERASE64) {
558 struct erase_info_user64 einfo64;
560 if (copy_from_user(&einfo64, argp,
561 sizeof(struct erase_info_user64))) {
565 erase->addr = einfo64.start;
566 erase->len = einfo64.length;
568 struct erase_info_user einfo32;
570 if (copy_from_user(&einfo32, argp,
571 sizeof(struct erase_info_user))) {
575 erase->addr = einfo32.start;
576 erase->len = einfo32.length;
579 erase->callback = mtdchar_erase_callback;
580 erase->priv = (unsigned long)&waitq;
583 FIXME: Allow INTERRUPTIBLE. Which means
584 not having the wait_queue head on the stack.
586 If the wq_head is on the stack, and we
587 leave because we got interrupted, then the
588 wq_head is no longer there when the
589 callback routine tries to wake us up.
591 ret = mtd->erase(mtd, erase);
593 set_current_state(TASK_UNINTERRUPTIBLE);
594 add_wait_queue(&waitq, &wait);
595 if (erase->state != MTD_ERASE_DONE &&
596 erase->state != MTD_ERASE_FAILED)
598 remove_wait_queue(&waitq, &wait);
599 set_current_state(TASK_RUNNING);
601 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
610 struct mtd_oob_buf buf;
611 struct mtd_oob_buf __user *buf_user = argp;
613 /* NOTE: writes return length to buf_user->length */
614 if (copy_from_user(&buf, argp, sizeof(buf)))
617 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
618 buf.ptr, &buf_user->length);
624 struct mtd_oob_buf buf;
625 struct mtd_oob_buf __user *buf_user = argp;
627 /* NOTE: writes return length to buf_user->start */
628 if (copy_from_user(&buf, argp, sizeof(buf)))
631 ret = mtd_do_readoob(mtd, buf.start, buf.length,
632 buf.ptr, &buf_user->start);
638 struct mtd_oob_buf64 buf;
639 struct mtd_oob_buf64 __user *buf_user = argp;
641 if (copy_from_user(&buf, argp, sizeof(buf)))
644 ret = mtd_do_writeoob(file, mtd, buf.start, buf.length,
645 (void __user *)(uintptr_t)buf.usr_ptr,
652 struct mtd_oob_buf64 buf;
653 struct mtd_oob_buf64 __user *buf_user = argp;
655 if (copy_from_user(&buf, argp, sizeof(buf)))
658 ret = mtd_do_readoob(mtd, buf.start, buf.length,
659 (void __user *)(uintptr_t)buf.usr_ptr,
666 struct erase_info_user einfo;
668 if (copy_from_user(&einfo, argp, sizeof(einfo)))
674 ret = mtd->lock(mtd, einfo.start, einfo.length);
680 struct erase_info_user einfo;
682 if (copy_from_user(&einfo, argp, sizeof(einfo)))
688 ret = mtd->unlock(mtd, einfo.start, einfo.length);
694 struct erase_info_user einfo;
696 if (copy_from_user(&einfo, argp, sizeof(einfo)))
702 ret = mtd->is_locked(mtd, einfo.start, einfo.length);
706 /* Legacy interface */
709 struct nand_oobinfo oi;
713 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
716 oi.useecc = MTD_NANDECC_AUTOPLACE;
717 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
718 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
720 oi.eccbytes = mtd->ecclayout->eccbytes;
722 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
731 if (copy_from_user(&offs, argp, sizeof(loff_t)))
733 if (!mtd->block_isbad)
736 return mtd->block_isbad(mtd, offs);
744 if (copy_from_user(&offs, argp, sizeof(loff_t)))
746 if (!mtd->block_markbad)
749 return mtd->block_markbad(mtd, offs);
753 #ifdef CONFIG_HAVE_MTD_OTP
757 if (copy_from_user(&mode, argp, sizeof(int)))
760 mfi->mode = MTD_MODE_NORMAL;
762 ret = otp_select_filemode(mfi, mode);
768 case OTPGETREGIONCOUNT:
769 case OTPGETREGIONINFO:
771 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
776 case MTD_MODE_OTP_FACTORY:
777 if (mtd->get_fact_prot_info)
778 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
780 case MTD_MODE_OTP_USER:
781 if (mtd->get_user_prot_info)
782 ret = mtd->get_user_prot_info(mtd, buf, 4096);
788 if (cmd == OTPGETREGIONCOUNT) {
789 int nbr = ret / sizeof(struct otp_info);
790 ret = copy_to_user(argp, &nbr, sizeof(int));
792 ret = copy_to_user(argp, buf, ret);
802 struct otp_info oinfo;
804 if (mfi->mode != MTD_MODE_OTP_USER)
806 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
808 if (!mtd->lock_user_prot_reg)
810 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
820 if (copy_to_user(argp, mtd->ecclayout,
821 sizeof(struct nand_ecclayout)))
828 if (copy_to_user(argp, &mtd->ecc_stats,
829 sizeof(struct mtd_ecc_stats)))
839 case MTD_MODE_OTP_FACTORY:
840 case MTD_MODE_OTP_USER:
841 ret = otp_select_filemode(mfi, arg);
845 if (!mtd->read_oob || !mtd->write_oob)
849 case MTD_MODE_NORMAL:
865 static long mtd_unlocked_ioctl(struct file *file, u_int cmd, u_long arg)
870 ret = mtd_ioctl(file, cmd, arg);
878 struct mtd_oob_buf32 {
881 compat_caddr_t ptr; /* unsigned char* */
884 #define MEMWRITEOOB32 _IOWR('M', 3, struct mtd_oob_buf32)
885 #define MEMREADOOB32 _IOWR('M', 4, struct mtd_oob_buf32)
887 static long mtd_compat_ioctl(struct file *file, unsigned int cmd,
890 struct mtd_file_info *mfi = file->private_data;
891 struct mtd_info *mtd = mfi->mtd;
892 void __user *argp = compat_ptr(arg);
900 struct mtd_oob_buf32 buf;
901 struct mtd_oob_buf32 __user *buf_user = argp;
903 if (copy_from_user(&buf, argp, sizeof(buf)))
906 ret = mtd_do_writeoob(file, mtd, buf.start,
907 buf.length, compat_ptr(buf.ptr),
914 struct mtd_oob_buf32 buf;
915 struct mtd_oob_buf32 __user *buf_user = argp;
917 /* NOTE: writes return length to buf->start */
918 if (copy_from_user(&buf, argp, sizeof(buf)))
921 ret = mtd_do_readoob(mtd, buf.start,
922 buf.length, compat_ptr(buf.ptr),
927 ret = mtd_ioctl(file, cmd, (unsigned long)argp);
935 #endif /* CONFIG_COMPAT */
938 * try to determine where a shared mapping can be made
939 * - only supported for NOMMU at the moment (MMU can't doesn't copy private
943 static unsigned long mtd_get_unmapped_area(struct file *file,
949 struct mtd_file_info *mfi = file->private_data;
950 struct mtd_info *mtd = mfi->mtd;
952 if (mtd->get_unmapped_area) {
953 unsigned long offset;
956 return (unsigned long) -EINVAL;
958 if (len > mtd->size || pgoff >= (mtd->size >> PAGE_SHIFT))
959 return (unsigned long) -EINVAL;
961 offset = pgoff << PAGE_SHIFT;
962 if (offset > mtd->size - len)
963 return (unsigned long) -EINVAL;
965 return mtd->get_unmapped_area(mtd, len, offset, flags);
968 /* can't map directly */
969 return (unsigned long) -ENOSYS;
974 * set up a mapping for shared memory segments
976 static int mtd_mmap(struct file *file, struct vm_area_struct *vma)
979 struct mtd_file_info *mfi = file->private_data;
980 struct mtd_info *mtd = mfi->mtd;
981 struct map_info *map = mtd->priv;
986 if (mtd->type == MTD_RAM || mtd->type == MTD_ROM) {
987 off = vma->vm_pgoff << PAGE_SHIFT;
989 len = PAGE_ALIGN((start & ~PAGE_MASK) + map->size);
991 if ((vma->vm_end - vma->vm_start + off) > len)
995 vma->vm_pgoff = off >> PAGE_SHIFT;
996 vma->vm_flags |= VM_IO | VM_RESERVED;
998 #ifdef pgprot_noncached
999 if (file->f_flags & O_DSYNC || off >= __pa(high_memory))
1000 vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
1002 if (io_remap_pfn_range(vma, vma->vm_start, off >> PAGE_SHIFT,
1003 vma->vm_end - vma->vm_start,
1011 return vma->vm_flags & VM_SHARED ? 0 : -ENOSYS;
1015 static const struct file_operations mtd_fops = {
1016 .owner = THIS_MODULE,
1017 .llseek = mtd_lseek,
1020 .unlocked_ioctl = mtd_unlocked_ioctl,
1021 #ifdef CONFIG_COMPAT
1022 .compat_ioctl = mtd_compat_ioctl,
1025 .release = mtd_close,
1028 .get_unmapped_area = mtd_get_unmapped_area,
1032 static int mtd_inodefs_get_sb(struct file_system_type *fs_type, int flags,
1033 const char *dev_name, void *data,
1034 struct vfsmount *mnt)
1036 return get_sb_pseudo(fs_type, "mtd_inode:", NULL, MTD_INODE_FS_MAGIC,
1040 static struct file_system_type mtd_inodefs_type = {
1041 .name = "mtd_inodefs",
1042 .get_sb = mtd_inodefs_get_sb,
1043 .kill_sb = kill_anon_super,
1046 static void mtdchar_notify_add(struct mtd_info *mtd)
1050 static void mtdchar_notify_remove(struct mtd_info *mtd)
1052 struct inode *mtd_ino = ilookup(mtd_inode_mnt->mnt_sb, mtd->index);
1055 /* Destroy the inode if it exists */
1056 mtd_ino->i_nlink = 0;
1061 static struct mtd_notifier mtdchar_notifier = {
1062 .add = mtdchar_notify_add,
1063 .remove = mtdchar_notify_remove,
1066 static int __init init_mtdchar(void)
1070 ret = __register_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS,
1073 pr_notice("Can't allocate major number %d for "
1074 "Memory Technology Devices.\n", MTD_CHAR_MAJOR);
1078 ret = register_filesystem(&mtd_inodefs_type);
1080 pr_notice("Can't register mtd_inodefs filesystem: %d\n", ret);
1081 goto err_unregister_chdev;
1084 mtd_inode_mnt = kern_mount(&mtd_inodefs_type);
1085 if (IS_ERR(mtd_inode_mnt)) {
1086 ret = PTR_ERR(mtd_inode_mnt);
1087 pr_notice("Error mounting mtd_inodefs filesystem: %d\n", ret);
1088 goto err_unregister_filesystem;
1090 register_mtd_user(&mtdchar_notifier);
1094 err_unregister_filesystem:
1095 unregister_filesystem(&mtd_inodefs_type);
1096 err_unregister_chdev:
1097 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1101 static void __exit cleanup_mtdchar(void)
1103 unregister_mtd_user(&mtdchar_notifier);
1104 mntput(mtd_inode_mnt);
1105 unregister_filesystem(&mtd_inodefs_type);
1106 __unregister_chrdev(MTD_CHAR_MAJOR, 0, 1 << MINORBITS, "mtd");
1109 module_init(init_mtdchar);
1110 module_exit(cleanup_mtdchar);
1112 MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);
1114 MODULE_LICENSE("GPL");
1115 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
1116 MODULE_DESCRIPTION("Direct character-device access to MTD devices");
1117 MODULE_ALIAS_CHARDEV_MAJOR(MTD_CHAR_MAJOR);