MOXA linux-2.6.x / linux-2.6.19-uc1 from UC-7110-LX-BOOTLOADER-1.9_VERSION-4.2.tgz
[linux-2.6.19-moxart.git] / drivers / mtd / mtdchar.c
blob540d47b51e893db73c3ed8364a5d06433e44cda4
1 /*
2 * $Id: mtdchar.c,v 1.76 2005/11/07 11:14:20 gleixner Exp $
4 * Character-device access to raw MTD devices.
6 */
8 #include <linux/device.h>
9 #include <linux/fs.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>
16 #include <linux/mtd/mtd.h>
17 #include <linux/mtd/compatmac.h>
19 #include <asm/semaphore.h>
20 #include <asm/uaccess.h>
22 static struct class *mtd_class;
24 static void mtd_notify_add(struct mtd_info* mtd)
26 if (!mtd)
27 return;
29 class_device_create(mtd_class, NULL, MKDEV(MTD_CHAR_MAJOR, mtd->index*2),
30 NULL, "mtd%d", mtd->index);
32 class_device_create(mtd_class, NULL,
33 MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1),
34 NULL, "mtd%dro", mtd->index);
37 static void mtd_notify_remove(struct mtd_info* mtd)
39 if (!mtd)
40 return;
42 class_device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2));
43 class_device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1));
46 static struct mtd_notifier notifier = {
47 .add = mtd_notify_add,
48 .remove = mtd_notify_remove,
52 * Data structure to hold the pointer to the mtd device as well
53 * as mode information ofr various use cases.
55 struct mtd_file_info {
56 struct mtd_info *mtd;
57 enum mtd_file_modes mode;
60 static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
62 struct mtd_file_info *mfi = file->private_data;
63 struct mtd_info *mtd = mfi->mtd;
65 switch (orig) {
66 case SEEK_SET:
67 break;
68 case SEEK_CUR:
69 offset += file->f_pos;
70 break;
71 case SEEK_END:
72 offset += mtd->size;
73 break;
74 default:
75 return -EINVAL;
78 if (offset >= 0 && offset <= mtd->size)
79 return file->f_pos = offset;
81 return -EINVAL;
86 static int mtd_open(struct inode *inode, struct file *file)
88 int minor = iminor(inode);
89 int devnum = minor >> 1;
90 struct mtd_info *mtd;
91 struct mtd_file_info *mfi;
93 DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
95 if (devnum >= MAX_MTD_DEVICES)
96 return -ENODEV;
98 /* You can't open the RO devices RW */
99 if ((file->f_mode & 2) && (minor & 1))
100 return -EACCES;
102 mtd = get_mtd_device(NULL, devnum);
104 if (!mtd)
105 return -ENODEV;
107 if (MTD_ABSENT == mtd->type) {
108 put_mtd_device(mtd);
109 return -ENODEV;
112 /* You can't open it RW if it's not a writeable device */
113 if ((file->f_mode & 2) && !(mtd->flags & MTD_WRITEABLE)) {
114 put_mtd_device(mtd);
115 return -EACCES;
118 mfi = kzalloc(sizeof(*mfi), GFP_KERNEL);
119 if (!mfi) {
120 put_mtd_device(mtd);
121 return -ENOMEM;
123 mfi->mtd = mtd;
124 file->private_data = mfi;
126 return 0;
127 } /* mtd_open */
129 /*====================================================================*/
131 static int mtd_close(struct inode *inode, struct file *file)
133 struct mtd_file_info *mfi = file->private_data;
134 struct mtd_info *mtd = mfi->mtd;
136 DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
138 if (mtd->sync)
139 mtd->sync(mtd);
141 put_mtd_device(mtd);
142 file->private_data = NULL;
143 kfree(mfi);
145 return 0;
146 } /* mtd_close */
148 /* FIXME: This _really_ needs to die. In 2.5, we should lock the
149 userspace buffer down and use it directly with readv/writev.
151 #define MAX_KMALLOC_SIZE 0x2000
153 static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
155 struct mtd_file_info *mfi = file->private_data;
156 struct mtd_info *mtd = mfi->mtd;
157 size_t retlen=0;
158 size_t total_retlen=0;
159 int ret=0;
160 int len;
161 char *kbuf;
163 DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
165 if (*ppos + count > mtd->size)
166 count = mtd->size - *ppos;
168 if (!count)
169 return 0;
171 /* FIXME: Use kiovec in 2.5 to lock down the user's buffers
172 and pass them directly to the MTD functions */
174 if (count > MAX_KMALLOC_SIZE)
175 kbuf=kmalloc(MAX_KMALLOC_SIZE, GFP_KERNEL);
176 else
177 kbuf=kmalloc(count, GFP_KERNEL);
179 if (!kbuf)
180 return -ENOMEM;
182 while (count) {
184 if (count > MAX_KMALLOC_SIZE)
185 len = MAX_KMALLOC_SIZE;
186 else
187 len = count;
189 switch (mfi->mode) {
190 case MTD_MODE_OTP_FACTORY:
191 ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
192 break;
193 case MTD_MODE_OTP_USER:
194 ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
195 break;
196 case MTD_MODE_RAW:
198 struct mtd_oob_ops ops;
200 ops.mode = MTD_OOB_RAW;
201 ops.datbuf = kbuf;
202 ops.oobbuf = NULL;
203 ops.len = len;
205 ret = mtd->read_oob(mtd, *ppos, &ops);
206 retlen = ops.retlen;
207 break;
209 default:
210 ret = mtd->read(mtd, *ppos, len, &retlen, kbuf);
212 /* Nand returns -EBADMSG on ecc errors, but it returns
213 * the data. For our userspace tools it is important
214 * to dump areas with ecc errors !
215 * For kernel internal usage it also might return -EUCLEAN
216 * to signal the caller that a bitflip has occured and has
217 * been corrected by the ECC algorithm.
218 * Userspace software which accesses NAND this way
219 * must be aware of the fact that it deals with NAND
221 if (!ret || (ret == -EUCLEAN) || (ret == -EBADMSG)) {
222 *ppos += retlen;
223 if (copy_to_user(buf, kbuf, retlen)) {
224 kfree(kbuf);
225 return -EFAULT;
227 else
228 total_retlen += retlen;
230 count -= retlen;
231 buf += retlen;
232 if (retlen == 0)
233 count = 0;
235 else {
236 kfree(kbuf);
237 return ret;
242 kfree(kbuf);
243 return total_retlen;
244 } /* mtd_read */
246 #define WRITE_KBUF_SIZE MAX_KMALLOC_SIZE
247 static DECLARE_MUTEX(write_kbuf_sem);
248 static char *write_kbuf;
250 static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
252 struct mtd_file_info *mfi = file->private_data;
253 struct mtd_info *mtd = mfi->mtd;
254 size_t retlen;
255 size_t total_retlen=0;
256 int ret=0;
257 int len;
259 DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
261 if (*ppos == mtd->size)
262 return -ENOSPC;
264 if (*ppos + count > mtd->size)
265 count = mtd->size - *ppos;
267 if (!count)
268 return 0;
270 down(&write_kbuf_sem);
272 while (count) {
274 if (count > WRITE_KBUF_SIZE)
275 len = WRITE_KBUF_SIZE;
276 else
277 len = count;
279 if (copy_from_user(write_kbuf, buf, len)) {
280 up(&write_kbuf_sem);
281 return -EFAULT;
284 switch (mfi->mode) {
285 case MTD_MODE_OTP_FACTORY:
286 ret = -EROFS;
287 break;
288 case MTD_MODE_OTP_USER:
289 if (!mtd->write_user_prot_reg) {
290 ret = -EOPNOTSUPP;
291 break;
293 ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, write_kbuf);
294 break;
296 case MTD_MODE_RAW:
298 struct mtd_oob_ops ops;
300 ops.mode = MTD_OOB_RAW;
301 ops.datbuf = write_kbuf;
302 ops.oobbuf = NULL;
303 ops.len = len;
305 ret = mtd->write_oob(mtd, *ppos, &ops);
306 retlen = ops.retlen;
307 break;
310 default:
311 ret = (*(mtd->write))(mtd, *ppos, len, &retlen, write_kbuf);
313 if (!ret) {
314 *ppos += retlen;
315 total_retlen += retlen;
316 count -= retlen;
317 buf += retlen;
319 else {
320 up(&write_kbuf_sem);
321 return ret;
325 up(&write_kbuf_sem);
326 return total_retlen;
327 } /* mtd_write */
329 /*======================================================================
331 IOCTL calls for getting device parameters.
333 ======================================================================*/
334 static void mtdchar_erase_callback (struct erase_info *instr)
336 wake_up((wait_queue_head_t *)instr->priv);
339 #if defined(CONFIG_MTD_OTP) || defined(CONFIG_MTD_ONENAND_OTP)
340 static int otp_select_filemode(struct mtd_file_info *mfi, int mode)
342 struct mtd_info *mtd = mfi->mtd;
343 int ret = 0;
345 switch (mode) {
346 case MTD_OTP_FACTORY:
347 if (!mtd->read_fact_prot_reg)
348 ret = -EOPNOTSUPP;
349 else
350 mfi->mode = MTD_MODE_OTP_FACTORY;
351 break;
352 case MTD_OTP_USER:
353 if (!mtd->read_fact_prot_reg)
354 ret = -EOPNOTSUPP;
355 else
356 mfi->mode = MTD_MODE_OTP_USER;
357 break;
358 default:
359 ret = -EINVAL;
360 case MTD_OTP_OFF:
361 break;
363 return ret;
365 #else
366 # define otp_select_filemode(f,m) -EOPNOTSUPP
367 #endif
369 static int mtd_ioctl(struct inode *inode, struct file *file,
370 u_int cmd, u_long arg)
372 struct mtd_file_info *mfi = file->private_data;
373 struct mtd_info *mtd = mfi->mtd;
374 void __user *argp = (void __user *)arg;
375 int ret = 0;
376 u_long size;
377 struct mtd_info_user info;
379 DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
381 size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
382 if (cmd & IOC_IN) {
383 if (!access_ok(VERIFY_READ, argp, size))
384 return -EFAULT;
386 if (cmd & IOC_OUT) {
387 if (!access_ok(VERIFY_WRITE, argp, size))
388 return -EFAULT;
391 switch (cmd) {
392 case MEMGETREGIONCOUNT:
393 if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
394 return -EFAULT;
395 break;
397 case MEMGETREGIONINFO:
399 struct region_info_user ur;
401 if (copy_from_user(&ur, argp, sizeof(struct region_info_user)))
402 return -EFAULT;
404 if (ur.regionindex >= mtd->numeraseregions)
405 return -EINVAL;
406 if (copy_to_user(argp, &(mtd->eraseregions[ur.regionindex]),
407 sizeof(struct mtd_erase_region_info)))
408 return -EFAULT;
409 break;
412 case MEMGETINFO:
413 info.type = mtd->type;
414 info.flags = mtd->flags;
415 info.size = mtd->size;
416 info.erasesize = mtd->erasesize;
417 info.writesize = mtd->writesize;
418 info.oobsize = mtd->oobsize;
419 info.ecctype = mtd->ecctype;
420 info.eccsize = mtd->eccsize;
421 if (copy_to_user(argp, &info, sizeof(struct mtd_info_user)))
422 return -EFAULT;
423 break;
425 case MEMERASE:
427 struct erase_info *erase;
429 if(!(file->f_mode & 2))
430 return -EPERM;
432 erase=kmalloc(sizeof(struct erase_info),GFP_KERNEL);
433 if (!erase)
434 ret = -ENOMEM;
435 else {
436 wait_queue_head_t waitq;
437 DECLARE_WAITQUEUE(wait, current);
439 init_waitqueue_head(&waitq);
441 memset (erase,0,sizeof(struct erase_info));
442 if (copy_from_user(&erase->addr, argp,
443 sizeof(struct erase_info_user))) {
444 kfree(erase);
445 return -EFAULT;
447 erase->mtd = mtd;
448 erase->callback = mtdchar_erase_callback;
449 erase->priv = (unsigned long)&waitq;
452 FIXME: Allow INTERRUPTIBLE. Which means
453 not having the wait_queue head on the stack.
455 If the wq_head is on the stack, and we
456 leave because we got interrupted, then the
457 wq_head is no longer there when the
458 callback routine tries to wake us up.
460 ret = mtd->erase(mtd, erase);
461 if (!ret) {
462 set_current_state(TASK_UNINTERRUPTIBLE);
463 add_wait_queue(&waitq, &wait);
464 if (erase->state != MTD_ERASE_DONE &&
465 erase->state != MTD_ERASE_FAILED)
466 schedule();
467 remove_wait_queue(&waitq, &wait);
468 set_current_state(TASK_RUNNING);
470 ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
472 kfree(erase);
474 break;
477 case MEMWRITEOOB:
479 struct mtd_oob_buf buf;
480 struct mtd_oob_ops ops;
482 if(!(file->f_mode & 2))
483 return -EPERM;
485 if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
486 return -EFAULT;
488 if (buf.length > 4096)
489 return -EINVAL;
491 if (!mtd->write_oob)
492 ret = -EOPNOTSUPP;
493 else
494 ret = access_ok(VERIFY_READ, buf.ptr,
495 buf.length) ? 0 : EFAULT;
497 if (ret)
498 return ret;
500 ops.len = buf.length;
501 ops.ooblen = buf.length;
502 ops.ooboffs = buf.start & (mtd->oobsize - 1);
503 ops.datbuf = NULL;
504 ops.mode = MTD_OOB_PLACE;
506 if (ops.ooboffs && ops.len > (mtd->oobsize - ops.ooboffs))
507 return -EINVAL;
509 ops.oobbuf = kmalloc(buf.length, GFP_KERNEL);
510 if (!ops.oobbuf)
511 return -ENOMEM;
513 if (copy_from_user(ops.oobbuf, buf.ptr, buf.length)) {
514 kfree(ops.oobbuf);
515 return -EFAULT;
518 buf.start &= ~(mtd->oobsize - 1);
519 ret = mtd->write_oob(mtd, buf.start, &ops);
521 if (copy_to_user(argp + sizeof(uint32_t), &ops.retlen,
522 sizeof(uint32_t)))
523 ret = -EFAULT;
525 kfree(ops.oobbuf);
526 break;
530 case MEMREADOOB:
532 struct mtd_oob_buf buf;
533 struct mtd_oob_ops ops;
535 if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
536 return -EFAULT;
538 if (buf.length > 4096)
539 return -EINVAL;
541 if (!mtd->read_oob)
542 ret = -EOPNOTSUPP;
543 else
544 ret = access_ok(VERIFY_WRITE, buf.ptr,
545 buf.length) ? 0 : -EFAULT;
546 if (ret)
547 return ret;
549 ops.len = buf.length;
550 ops.ooblen = buf.length;
551 ops.ooboffs = buf.start & (mtd->oobsize - 1);
552 ops.datbuf = NULL;
553 ops.mode = MTD_OOB_PLACE;
555 if (ops.ooboffs && ops.len > (mtd->oobsize - ops.ooboffs))
556 return -EINVAL;
558 ops.oobbuf = kmalloc(buf.length, GFP_KERNEL);
559 if (!ops.oobbuf)
560 return -ENOMEM;
562 buf.start &= ~(mtd->oobsize - 1);
563 ret = mtd->read_oob(mtd, buf.start, &ops);
565 if (put_user(ops.retlen, (uint32_t __user *)argp))
566 ret = -EFAULT;
567 else if (ops.retlen && copy_to_user(buf.ptr, ops.oobbuf,
568 ops.retlen))
569 ret = -EFAULT;
571 kfree(ops.oobbuf);
572 break;
575 case MEMLOCK:
577 struct erase_info_user info;
579 if (copy_from_user(&info, argp, sizeof(info)))
580 return -EFAULT;
582 if (!mtd->lock)
583 ret = -EOPNOTSUPP;
584 else
585 ret = mtd->lock(mtd, info.start, info.length);
586 break;
589 case MEMUNLOCK:
591 struct erase_info_user info;
593 if (copy_from_user(&info, argp, sizeof(info)))
594 return -EFAULT;
596 if (!mtd->unlock)
597 ret = -EOPNOTSUPP;
598 else
599 ret = mtd->unlock(mtd, info.start, info.length);
600 break;
603 /* Legacy interface */
604 case MEMGETOOBSEL:
606 struct nand_oobinfo oi;
608 if (!mtd->ecclayout)
609 return -EOPNOTSUPP;
610 if (mtd->ecclayout->eccbytes > ARRAY_SIZE(oi.eccpos))
611 return -EINVAL;
613 oi.useecc = MTD_NANDECC_AUTOPLACE;
614 memcpy(&oi.eccpos, mtd->ecclayout->eccpos, sizeof(oi.eccpos));
615 memcpy(&oi.oobfree, mtd->ecclayout->oobfree,
616 sizeof(oi.oobfree));
618 if (copy_to_user(argp, &oi, sizeof(struct nand_oobinfo)))
619 return -EFAULT;
620 break;
623 case MEMGETBADBLOCK:
625 loff_t offs;
627 if (copy_from_user(&offs, argp, sizeof(loff_t)))
628 return -EFAULT;
629 if (!mtd->block_isbad)
630 ret = -EOPNOTSUPP;
631 else
632 return mtd->block_isbad(mtd, offs);
633 break;
636 case MEMSETBADBLOCK:
638 loff_t offs;
640 if (copy_from_user(&offs, argp, sizeof(loff_t)))
641 return -EFAULT;
642 if (!mtd->block_markbad)
643 ret = -EOPNOTSUPP;
644 else
645 return mtd->block_markbad(mtd, offs);
646 break;
649 #if defined(CONFIG_MTD_OTP) || defined(CONFIG_MTD_ONENAND_OTP)
650 case OTPSELECT:
652 int mode;
653 if (copy_from_user(&mode, argp, sizeof(int)))
654 return -EFAULT;
656 mfi->mode = MTD_MODE_NORMAL;
658 ret = otp_select_filemode(mfi, mode);
660 file->f_pos = 0;
661 break;
664 case OTPGETREGIONCOUNT:
665 case OTPGETREGIONINFO:
667 struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
668 if (!buf)
669 return -ENOMEM;
670 ret = -EOPNOTSUPP;
671 switch (mfi->mode) {
672 case MTD_MODE_OTP_FACTORY:
673 if (mtd->get_fact_prot_info)
674 ret = mtd->get_fact_prot_info(mtd, buf, 4096);
675 break;
676 case MTD_MODE_OTP_USER:
677 if (mtd->get_user_prot_info)
678 ret = mtd->get_user_prot_info(mtd, buf, 4096);
679 break;
680 default:
681 break;
683 if (ret >= 0) {
684 if (cmd == OTPGETREGIONCOUNT) {
685 int nbr = ret / sizeof(struct otp_info);
686 ret = copy_to_user(argp, &nbr, sizeof(int));
687 } else
688 ret = copy_to_user(argp, buf, ret);
689 if (ret)
690 ret = -EFAULT;
692 kfree(buf);
693 break;
696 case OTPLOCK:
698 struct otp_info info;
700 if (mfi->mode != MTD_MODE_OTP_USER)
701 return -EINVAL;
702 if (copy_from_user(&info, argp, sizeof(info)))
703 return -EFAULT;
704 if (!mtd->lock_user_prot_reg)
705 return -EOPNOTSUPP;
706 ret = mtd->lock_user_prot_reg(mtd, info.start, info.length);
707 break;
709 #endif
711 case ECCGETLAYOUT:
713 if (!mtd->ecclayout)
714 return -EOPNOTSUPP;
716 if (copy_to_user(argp, &mtd->ecclayout,
717 sizeof(struct nand_ecclayout)))
718 return -EFAULT;
719 break;
722 case ECCGETSTATS:
724 if (copy_to_user(argp, &mtd->ecc_stats,
725 sizeof(struct mtd_ecc_stats)))
726 return -EFAULT;
727 break;
730 case MTDFILEMODE:
732 mfi->mode = 0;
734 switch(arg) {
735 case MTD_MODE_OTP_FACTORY:
736 case MTD_MODE_OTP_USER:
737 ret = otp_select_filemode(mfi, arg);
738 break;
740 case MTD_MODE_RAW:
741 if (!mtd->read_oob || !mtd->write_oob)
742 return -EOPNOTSUPP;
743 mfi->mode = arg;
745 case MTD_MODE_NORMAL:
746 break;
747 default:
748 ret = -EINVAL;
750 file->f_pos = 0;
751 break;
754 default:
755 ret = -ENOTTY;
758 return ret;
759 } /* memory_ioctl */
761 static struct file_operations mtd_fops = {
762 .owner = THIS_MODULE,
763 .llseek = mtd_lseek,
764 .read = mtd_read,
765 .write = mtd_write,
766 .ioctl = mtd_ioctl,
767 .open = mtd_open,
768 .release = mtd_close,
771 static int __init init_mtdchar(void)
773 if (register_chrdev(MTD_CHAR_MAJOR, "mtd", &mtd_fops)) {
774 printk(KERN_NOTICE "Can't allocate major number %d for Memory Technology Devices.\n",
775 MTD_CHAR_MAJOR);
776 return -EAGAIN;
779 mtd_class = class_create(THIS_MODULE, "mtd");
781 if (IS_ERR(mtd_class)) {
782 printk(KERN_ERR "Error creating mtd class.\n");
783 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
784 return PTR_ERR(mtd_class);
787 /* Allocate write buffer. */
788 down(&write_kbuf_sem);
789 write_kbuf = kmalloc(WRITE_KBUF_SIZE, GFP_KERNEL);
790 if (write_kbuf == NULL) {
791 up(&write_kbuf_sem);
792 class_destroy(mtd_class);
793 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
794 return -ENOMEM;
796 up(&write_kbuf_sem);
798 register_mtd_user(&notifier);
799 return 0;
802 static void __exit cleanup_mtdchar(void)
804 unregister_mtd_user(&notifier);
805 class_destroy(mtd_class);
806 unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
809 module_init(init_mtdchar);
810 module_exit(cleanup_mtdchar);
813 MODULE_LICENSE("GPL");
814 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
815 MODULE_DESCRIPTION("Direct character-device access to MTD devices");