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>
17 #include <linux/mtd/mtd.h>
18 #include <linux/mtd/compatmac.h>
20 #include <asm/uaccess.h>
22 static struct class *mtd_class;
24 static void mtd_notify_add(struct mtd_info* mtd)
29 device_create(mtd_class, NULL, MKDEV(MTD_CHAR_MAJOR, mtd->index*2),
30 NULL, "mtd%d", mtd->index);
32 device_create(mtd_class, NULL, MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1),
33 NULL, "mtd%dro", mtd->index);
36 static void mtd_notify_remove(struct mtd_info* mtd)
41 device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2));
42 device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1));
45 static struct mtd_notifier notifier = {
46 .add = mtd_notify_add,
47 .remove = mtd_notify_remove,
51 * Data structure to hold the pointer to the mtd device as well
52 * as mode information ofr various use cases.
54 struct mtd_file_info {
56 enum mtd_file_modes mode;
59 static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
61 struct mtd_file_info *mfi = file->private_data;
62 struct mtd_info *mtd = mfi->mtd;
68 offset += file->f_pos;
77 if (offset >= 0 && offset <= mtd->size)
78 return file->f_pos = offset;
85 static int mtd_open(struct inode *inode, struct file *file)
87 int minor = iminor(inode);
88 int devnum = minor >> 1;
91 struct mtd_file_info *mfi;
93 DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
95 if (devnum >= MAX_MTD_DEVICES)
98 /* You can't open the RO devices RW */
99 if ((file->f_mode & FMODE_WRITE) && (minor & 1))
103 mtd = get_mtd_device(NULL, devnum);
110 if (MTD_ABSENT == mtd->type) {
116 /* You can't open it RW if it's not a writeable device */
117 if ((file->f_mode & FMODE_WRITE) && !(mtd->flags & MTD_WRITEABLE)) {
123 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
130 file->private_data = mfi;
137 /*====================================================================*/
139 static int mtd_close(struct inode *inode, struct file *file)
141 struct mtd_file_info *mfi = file->private_data;
142 struct mtd_info *mtd = mfi->mtd;
144 DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
146 /* Only sync if opened RW */
147 if ((file->f_mode & FMODE_WRITE) && mtd->sync)
151 file->private_data = NULL;
157 /* FIXME: This _really_ needs to die. In 2.5, we should lock the
158 userspace buffer down and use it directly with readv/writev.
160 #define MAX_KMALLOC_SIZE 0x20000
162 static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
164 struct mtd_file_info *mfi = file->private_data;
165 struct mtd_info *mtd = mfi->mtd;
167 size_t total_retlen=0;
172 DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
174 if (*ppos + count > mtd->size)
175 count = mtd->size - *ppos;
180 /* FIXME: Use kiovec in 2.5 to lock down the user's buffers
181 and pass them directly to the MTD functions */
183 if (count > MAX_KMALLOC_SIZE)
184 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
186 kbuf=kmalloc(count, GFP_KERNEL);
193 if (count > MAX_KMALLOC_SIZE)
194 len = MAX_KMALLOC_SIZE;
199 case MTD_MODE_OTP_FACTORY:
200 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
202 case MTD_MODE_OTP_USER:
203 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
207 struct mtd_oob_ops ops;
209 ops.mode = MTD_OOB_RAW;
214 ret = mtd->read_oob(mtd, *ppos, &ops);
219 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
221 /* Nand returns -EBADMSG on ecc errors, but it returns
222 * the data. For our userspace tools it is important
223 * to dump areas with ecc errors !
224 * For kernel internal usage it also might return -EUCLEAN
225 * to signal the caller that a bitflip has occured and has
226 * been corrected by the ECC algorithm.
227 * Userspace software which accesses NAND this way
228 * must be aware of the fact that it deals with NAND
230 if (!ret || (ret == -EUCLEAN) || (ret == -EBADMSG)) {
232 if (copy_to_user(buf, kbuf, retlen)) {
237 total_retlen += retlen;
255 static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
257 struct mtd_file_info *mfi = file->private_data;
258 struct mtd_info *mtd = mfi->mtd;
261 size_t total_retlen=0;
265 DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
267 if (*ppos == mtd->size)
270 if (*ppos + count > mtd->size)
271 count = mtd->size - *ppos;
276 if (count > MAX_KMALLOC_SIZE)
277 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
279 kbuf=kmalloc(count, GFP_KERNEL);
286 if (count > MAX_KMALLOC_SIZE)
287 len = MAX_KMALLOC_SIZE;
291 if (copy_from_user(kbuf, buf, len)) {
297 case MTD_MODE_OTP_FACTORY:
300 case MTD_MODE_OTP_USER:
301 if (!mtd->write_user_prot_reg) {
305 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
310 struct mtd_oob_ops ops;
312 ops.mode = MTD_OOB_RAW;
317 ret = mtd->write_oob(mtd, *ppos, &ops);
323 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
327 total_retlen += retlen;
341 /*======================================================================
343 IOCTL calls for getting device parameters.
345 ======================================================================*/
346 static void mtdchar_erase_callback (struct erase_info *instr)
348 wake_up((wait_queue_head_t *)instr->priv);
351 #ifdef CONFIG_HAVE_MTD_OTP
352 static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
354 struct mtd_info *mtd = mfi->mtd;
358 case MTD_OTP_FACTORY:
359 if (!mtd->read_fact_prot_reg)
362 mfi->mode = MTD_MODE_OTP_FACTORY;
365 if (!mtd->read_fact_prot_reg)
368 mfi->mode = MTD_MODE_OTP_USER;
378 # define otp_select_filemode(f,m) -EOPNOTSUPP
381 static int mtd_ioctl(struct inode *inode, struct file *file,
382 u_int cmd, u_long arg)
384 struct mtd_file_info *mfi = file->private_data;
385 struct mtd_info *mtd = mfi->mtd;
386 void __user *argp = (void __user *)arg;
389 struct mtd_info_user info;
391 DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
393 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
395 if (!access_ok(VERIFY_READ, argp, size))
399 if (!access_ok(VERIFY_WRITE, argp, size))
404 case MEMGETREGIONCOUNT:
405 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
409 case MEMGETREGIONINFO:
412 struct mtd_erase_region_info *kr;
413 struct region_info_user *ur = (struct region_info_user *) argp;
415 if (get_user(ur_idx, &(ur->regionindex)))
418 kr = &(mtd->eraseregions[ur_idx]);
420 if (put_user(kr->offset, &(ur->offset))
421 || put_user(kr->erasesize, &(ur->erasesize))
422 || put_user(kr->numblocks, &(ur->numblocks)))
429 info.type = mtd->type;
430 info.flags = mtd->flags;
431 info.size = mtd->size;
432 info.erasesize = mtd->erasesize;
433 info.writesize = mtd->writesize;
434 info.oobsize = mtd->oobsize;
435 /* The below fields are obsolete */
438 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
444 struct erase_info *erase;
446 if(!(file->f_mode & FMODE_WRITE))
449 erase=kzalloc(sizeof(struct erase_info),GFP_KERNEL);
453 struct erase_info_user einfo;
455 wait_queue_head_t waitq;
456 DECLARE_WAITQUEUE(wait, current);
458 init_waitqueue_head(&waitq);
460 if (copy_from_user(&einfo, argp,
461 sizeof(struct erase_info_user))) {
465 erase->addr = einfo.start;
466 erase->len = einfo.length;
468 erase->callback = mtdchar_erase_callback;
469 erase->priv = (unsigned long)&waitq;
472 FIXME: Allow INTERRUPTIBLE. Which means
473 not having the wait_queue head on the stack.
475 If the wq_head is on the stack, and we
476 leave because we got interrupted, then the
477 wq_head is no longer there when the
478 callback routine tries to wake us up.
480 ret = mtd->erase(mtd, erase);
482 set_current_state(TASK_UNINTERRUPTIBLE);
483 add_wait_queue(&waitq, &wait);
484 if (erase->state != MTD_ERASE_DONE &&
485 erase->state != MTD_ERASE_FAILED)
487 remove_wait_queue(&waitq, &wait);
488 set_current_state(TASK_RUNNING);
490 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
499 struct mtd_oob_buf buf;
500 struct mtd_oob_ops ops;
501 struct mtd_oob_buf __user *user_buf = argp;
504 if(!(file->f_mode & FMODE_WRITE))
507 if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
510 if (buf.length > 4096)
516 ret = access_ok(VERIFY_READ, buf.ptr,
517 buf.length) ? 0 : EFAULT;
522 ops.ooblen = buf.length;
523 ops.ooboffs = buf.start & (mtd->oobsize - 1);
525 ops.mode = MTD_OOB_PLACE;
527 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
530 ops.oobbuf = kmalloc(buf.length, GFP_KERNEL);
534 if (copy_from_user(ops.oobbuf, buf.ptr, buf.length)) {
539 buf.start &= ~(mtd->oobsize - 1);
540 ret = mtd->write_oob(mtd, buf.start, &ops);
542 if (ops.oobretlen > 0xFFFFFFFFU)
544 retlen = ops.oobretlen;
545 if (copy_to_user(&user_buf->length, &retlen, sizeof(buf.length)))
555 struct mtd_oob_buf buf;
556 struct mtd_oob_ops ops;
558 if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
561 if (buf.length > 4096)
567 ret = access_ok(VERIFY_WRITE, buf.ptr,
568 buf.length) ? 0 : -EFAULT;
572 ops.ooblen = buf.length;
573 ops.ooboffs = buf.start & (mtd->oobsize - 1);
575 ops.mode = MTD_OOB_PLACE;
577 if (ops.ooboffs && ops.ooblen > (mtd->oobsize - ops.ooboffs))
580 ops.oobbuf = kmalloc(buf.length, GFP_KERNEL);
584 buf.start &= ~(mtd->oobsize - 1);
585 ret = mtd->read_oob(mtd, buf.start, &ops);
587 if (put_user(ops.oobretlen, (uint32_t __user *)argp))
589 else if (ops.oobretlen && copy_to_user(buf.ptr, ops.oobbuf,
599 struct erase_info_user einfo;
601 if (copy_from_user(&einfo, argp, sizeof(einfo)))
607 ret = mtd->lock(mtd, einfo.start, einfo.length);
613 struct erase_info_user einfo;
615 if (copy_from_user(&einfo, argp, sizeof(einfo)))
621 ret = mtd->unlock(mtd, einfo.start, einfo.length);
625 /* Legacy interface */
628 struct nand_oobinfo oi;
632 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
635 oi.useecc = MTD_NANDECC_AUTOPLACE;
636 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
637 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
639 oi.eccbytes = mtd->ecclayout->eccbytes;
641 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
650 if (copy_from_user(&offs, argp, sizeof(loff_t)))
652 if (!mtd->block_isbad)
655 return mtd->block_isbad(mtd, offs);
663 if (copy_from_user(&offs, argp, sizeof(loff_t)))
665 if (!mtd->block_markbad)
668 return mtd->block_markbad(mtd, offs);
672 #ifdef CONFIG_HAVE_MTD_OTP
676 if (copy_from_user(&mode, argp, sizeof(int)))
679 mfi->mode = MTD_MODE_NORMAL;
681 ret = otp_select_filemode(mfi, mode);
687 case OTPGETREGIONCOUNT:
688 case OTPGETREGIONINFO:
690 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
695 case MTD_MODE_OTP_FACTORY:
696 if (mtd->get_fact_prot_info)
697 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
699 case MTD_MODE_OTP_USER:
700 if (mtd->get_user_prot_info)
701 ret = mtd->get_user_prot_info(mtd, buf, 4096);
707 if (cmd == OTPGETREGIONCOUNT) {
708 int nbr = ret / sizeof(struct otp_info);
709 ret = copy_to_user(argp, &nbr, sizeof(int));
711 ret = copy_to_user(argp, buf, ret);
721 struct otp_info oinfo;
723 if (mfi->mode != MTD_MODE_OTP_USER)
725 if (copy_from_user(&oinfo, argp, sizeof(oinfo)))
727 if (!mtd->lock_user_prot_reg)
729 ret = mtd->lock_user_prot_reg(mtd, oinfo.start, oinfo.length);
739 if (copy_to_user(argp, mtd->ecclayout,
740 sizeof(struct nand_ecclayout)))
747 if (copy_to_user(argp, &mtd->ecc_stats,
748 sizeof(struct mtd_ecc_stats)))
758 case MTD_MODE_OTP_FACTORY:
759 case MTD_MODE_OTP_USER:
760 ret = otp_select_filemode(mfi, arg);
764 if (!mtd->read_oob || !mtd->write_oob)
768 case MTD_MODE_NORMAL:
784 static const struct file_operations mtd_fops = {
785 .owner = THIS_MODULE,
791 .release = mtd_close,
794 static int __init init_mtdchar(void)
796 if (register_chrdev(MTD_CHAR_MAJOR, "mtd", &mtd_fops)) {
797 printk(KERN_NOTICE "Can't allocate major number %d for Memory Technology Devices.\n",
802 mtd_class = class_create(THIS_MODULE, "mtd");
804 if (IS_ERR(mtd_class)) {
805 printk(KERN_ERR "Error creating mtd class.\n");
806 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
807 return PTR_ERR(mtd_class);
810 register_mtd_user(¬ifier);
814 static void __exit cleanup_mtdchar(void)
816 unregister_mtd_user(¬ifier);
817 class_destroy(mtd_class);
818 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
821 module_init(init_mtdchar);
822 module_exit(cleanup_mtdchar);
825 MODULE_LICENSE("GPL");
826 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
827 MODULE_DESCRIPTION("Direct character-device access to MTD devices");