2 * $Id: mtdchar.c,v 1.76 2005/11/07 11:14:20 gleixner Exp $
4 * Character-device access to raw MTD devices.
8 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/slab.h>
16 #include <linux/sched.h>
18 #include <linux/mtd/mtd.h>
19 #include <linux/mtd/compatmac.h>
21 #include <asm/uaccess.h>
23 static struct class *mtd_class
;
25 static void mtd_notify_add(struct mtd_info
* mtd
)
30 device_create(mtd_class
, NULL
, MKDEV(MTD_CHAR_MAJOR
, mtd
->index
*2), "mtd%d", mtd
->index
);
32 device_create(mtd_class
, NULL
,
33 MKDEV(MTD_CHAR_MAJOR
, mtd
->index
*2+1), "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;
90 struct mtd_file_info
*mfi
;
92 DEBUG(MTD_DEBUG_LEVEL0
, "MTD_open\n");
94 if (devnum
>= MAX_MTD_DEVICES
)
97 /* You can't open the RO devices RW */
98 if ((file
->f_mode
& 2) && (minor
& 1))
101 mtd
= get_mtd_device(NULL
, devnum
);
106 if (MTD_ABSENT
== mtd
->type
) {
111 /* You can't open it RW if it's not a writeable device */
112 if ((file
->f_mode
& 2) && !(mtd
->flags
& MTD_WRITEABLE
)) {
117 mfi
= kzalloc(sizeof(*mfi
), GFP_KERNEL
);
123 file
->private_data
= mfi
;
128 /*====================================================================*/
130 static int mtd_close(struct inode
*inode
, struct file
*file
)
132 struct mtd_file_info
*mfi
= file
->private_data
;
133 struct mtd_info
*mtd
= mfi
->mtd
;
135 DEBUG(MTD_DEBUG_LEVEL0
, "MTD_close\n");
137 /* Only sync if opened RW */
138 if ((file
->f_mode
& 2) && mtd
->sync
)
142 file
->private_data
= NULL
;
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 0x20000
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
;
158 size_t total_retlen
=0;
163 DEBUG(MTD_DEBUG_LEVEL0
,"MTD_read\n");
165 if (*ppos
+ count
> mtd
->size
)
166 count
= mtd
->size
- *ppos
;
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
);
177 kbuf
=kmalloc(count
, GFP_KERNEL
);
184 if (count
> MAX_KMALLOC_SIZE
)
185 len
= MAX_KMALLOC_SIZE
;
190 case MTD_MODE_OTP_FACTORY
:
191 ret
= mtd
->read_fact_prot_reg(mtd
, *ppos
, len
, &retlen
, kbuf
);
193 case MTD_MODE_OTP_USER
:
194 ret
= mtd
->read_user_prot_reg(mtd
, *ppos
, len
, &retlen
, kbuf
);
198 struct mtd_oob_ops ops
;
200 ops
.mode
= MTD_OOB_RAW
;
205 ret
= mtd
->read_oob(mtd
, *ppos
, &ops
);
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
)) {
223 if (copy_to_user(buf
, kbuf
, retlen
)) {
228 total_retlen
+= retlen
;
246 static ssize_t
mtd_write(struct file
*file
, const char __user
*buf
, size_t count
,loff_t
*ppos
)
248 struct mtd_file_info
*mfi
= file
->private_data
;
249 struct mtd_info
*mtd
= mfi
->mtd
;
252 size_t total_retlen
=0;
256 DEBUG(MTD_DEBUG_LEVEL0
,"MTD_write\n");
258 if (*ppos
== mtd
->size
)
261 if (*ppos
+ count
> mtd
->size
)
262 count
= mtd
->size
- *ppos
;
267 if (count
> MAX_KMALLOC_SIZE
)
268 kbuf
=kmalloc(MAX_KMALLOC_SIZE
, GFP_KERNEL
);
270 kbuf
=kmalloc(count
, GFP_KERNEL
);
277 if (count
> MAX_KMALLOC_SIZE
)
278 len
= MAX_KMALLOC_SIZE
;
282 if (copy_from_user(kbuf
, buf
, len
)) {
288 case MTD_MODE_OTP_FACTORY
:
291 case MTD_MODE_OTP_USER
:
292 if (!mtd
->write_user_prot_reg
) {
296 ret
= mtd
->write_user_prot_reg(mtd
, *ppos
, len
, &retlen
, kbuf
);
301 struct mtd_oob_ops ops
;
303 ops
.mode
= MTD_OOB_RAW
;
308 ret
= mtd
->write_oob(mtd
, *ppos
, &ops
);
314 ret
= (*(mtd
->write
))(mtd
, *ppos
, len
, &retlen
, kbuf
);
318 total_retlen
+= retlen
;
332 /*======================================================================
334 IOCTL calls for getting device parameters.
336 ======================================================================*/
337 static void mtdchar_erase_callback (struct erase_info
*instr
)
339 wake_up((wait_queue_head_t
*)instr
->priv
);
342 #if defined(CONFIG_MTD_OTP) || defined(CONFIG_MTD_ONENAND_OTP)
343 static int otp_select_filemode(struct mtd_file_info
*mfi
, int mode
)
345 struct mtd_info
*mtd
= mfi
->mtd
;
349 case MTD_OTP_FACTORY
:
350 if (!mtd
->read_fact_prot_reg
)
353 mfi
->mode
= MTD_MODE_OTP_FACTORY
;
356 if (!mtd
->read_fact_prot_reg
)
359 mfi
->mode
= MTD_MODE_OTP_USER
;
369 # define otp_select_filemode(f,m) -EOPNOTSUPP
372 static int mtd_ioctl(struct inode
*inode
, struct file
*file
,
373 u_int cmd
, u_long arg
)
375 struct mtd_file_info
*mfi
= file
->private_data
;
376 struct mtd_info
*mtd
= mfi
->mtd
;
377 void __user
*argp
= (void __user
*)arg
;
380 struct mtd_info_user info
;
382 DEBUG(MTD_DEBUG_LEVEL0
, "MTD_ioctl\n");
384 size
= (cmd
& IOCSIZE_MASK
) >> IOCSIZE_SHIFT
;
386 if (!access_ok(VERIFY_READ
, argp
, size
))
390 if (!access_ok(VERIFY_WRITE
, argp
, size
))
395 case MEMGETREGIONCOUNT
:
396 if (copy_to_user(argp
, &(mtd
->numeraseregions
), sizeof(int)))
400 case MEMGETREGIONINFO
:
402 struct region_info_user ur
;
404 if (copy_from_user(&ur
, argp
, sizeof(struct region_info_user
)))
407 if (ur
.regionindex
>= mtd
->numeraseregions
)
409 if (copy_to_user(argp
, &(mtd
->eraseregions
[ur
.regionindex
]),
410 sizeof(struct mtd_erase_region_info
)))
416 info
.type
= mtd
->type
;
417 info
.flags
= mtd
->flags
;
418 info
.size
= mtd
->size
;
419 info
.erasesize
= mtd
->erasesize
;
420 info
.writesize
= mtd
->writesize
;
421 info
.oobsize
= mtd
->oobsize
;
422 /* The below fields are obsolete */
425 if (copy_to_user(argp
, &info
, sizeof(struct mtd_info_user
)))
431 struct erase_info
*erase
;
433 if(!(file
->f_mode
& 2))
436 erase
=kzalloc(sizeof(struct erase_info
),GFP_KERNEL
);
440 wait_queue_head_t waitq
;
441 DECLARE_WAITQUEUE(wait
, current
);
443 init_waitqueue_head(&waitq
);
445 if (copy_from_user(&erase
->addr
, argp
,
446 sizeof(struct erase_info_user
))) {
451 erase
->callback
= mtdchar_erase_callback
;
452 erase
->priv
= (unsigned long)&waitq
;
455 FIXME: Allow INTERRUPTIBLE. Which means
456 not having the wait_queue head on the stack.
458 If the wq_head is on the stack, and we
459 leave because we got interrupted, then the
460 wq_head is no longer there when the
461 callback routine tries to wake us up.
463 ret
= mtd
->erase(mtd
, erase
);
465 set_current_state(TASK_UNINTERRUPTIBLE
);
466 add_wait_queue(&waitq
, &wait
);
467 if (erase
->state
!= MTD_ERASE_DONE
&&
468 erase
->state
!= MTD_ERASE_FAILED
)
470 remove_wait_queue(&waitq
, &wait
);
471 set_current_state(TASK_RUNNING
);
473 ret
= (erase
->state
== MTD_ERASE_FAILED
)?-EIO
:0;
482 struct mtd_oob_buf buf
;
483 struct mtd_oob_ops ops
;
486 if(!(file
->f_mode
& 2))
489 if (copy_from_user(&buf
, argp
, sizeof(struct mtd_oob_buf
)))
492 if (buf
.length
> 4096)
498 ret
= access_ok(VERIFY_READ
, buf
.ptr
,
499 buf
.length
) ? 0 : EFAULT
;
504 ops
.ooblen
= buf
.length
;
505 ops
.ooboffs
= buf
.start
& (mtd
->oobsize
- 1);
507 ops
.mode
= MTD_OOB_PLACE
;
509 if (ops
.ooboffs
&& ops
.ooblen
> (mtd
->oobsize
- ops
.ooboffs
))
512 ops
.oobbuf
= kmalloc(buf
.length
, GFP_KERNEL
);
516 if (copy_from_user(ops
.oobbuf
, buf
.ptr
, buf
.length
)) {
521 buf
.start
&= ~(mtd
->oobsize
- 1);
522 ret
= mtd
->write_oob(mtd
, buf
.start
, &ops
);
524 if (ops
.oobretlen
> 0xFFFFFFFFU
)
526 retlen
= ops
.oobretlen
;
527 if (copy_to_user(&((struct mtd_oob_buf
*)argp
)->length
,
528 &retlen
, sizeof(buf
.length
)))
538 struct mtd_oob_buf buf
;
539 struct mtd_oob_ops ops
;
541 if (copy_from_user(&buf
, argp
, sizeof(struct mtd_oob_buf
)))
544 if (buf
.length
> 4096)
550 ret
= access_ok(VERIFY_WRITE
, buf
.ptr
,
551 buf
.length
) ? 0 : -EFAULT
;
555 ops
.ooblen
= buf
.length
;
556 ops
.ooboffs
= buf
.start
& (mtd
->oobsize
- 1);
558 ops
.mode
= MTD_OOB_PLACE
;
560 if (ops
.ooboffs
&& ops
.ooblen
> (mtd
->oobsize
- ops
.ooboffs
))
563 ops
.oobbuf
= kmalloc(buf
.length
, GFP_KERNEL
);
567 buf
.start
&= ~(mtd
->oobsize
- 1);
568 ret
= mtd
->read_oob(mtd
, buf
.start
, &ops
);
570 if (put_user(ops
.oobretlen
, (uint32_t __user
*)argp
))
572 else if (ops
.oobretlen
&& copy_to_user(buf
.ptr
, ops
.oobbuf
,
582 struct erase_info_user info
;
584 if (copy_from_user(&info
, argp
, sizeof(info
)))
590 ret
= mtd
->lock(mtd
, info
.start
, info
.length
);
596 struct erase_info_user info
;
598 if (copy_from_user(&info
, argp
, sizeof(info
)))
604 ret
= mtd
->unlock(mtd
, info
.start
, info
.length
);
608 /* Legacy interface */
611 struct nand_oobinfo oi
;
615 if (mtd
->ecclayout
->eccbytes
> ARRAY_SIZE(oi
.eccpos
))
618 oi
.useecc
= MTD_NANDECC_AUTOPLACE
;
619 memcpy(&oi
.eccpos
, mtd
->ecclayout
->eccpos
, sizeof(oi
.eccpos
));
620 memcpy(&oi
.oobfree
, mtd
->ecclayout
->oobfree
,
622 oi
.eccbytes
= mtd
->ecclayout
->eccbytes
;
624 if (copy_to_user(argp
, &oi
, sizeof(struct nand_oobinfo
)))
633 if (copy_from_user(&offs
, argp
, sizeof(loff_t
)))
635 if (!mtd
->block_isbad
)
638 return mtd
->block_isbad(mtd
, offs
);
646 if (copy_from_user(&offs
, argp
, sizeof(loff_t
)))
648 if (!mtd
->block_markbad
)
651 return mtd
->block_markbad(mtd
, offs
);
655 #if defined(CONFIG_MTD_OTP) || defined(CONFIG_MTD_ONENAND_OTP)
659 if (copy_from_user(&mode
, argp
, sizeof(int)))
662 mfi
->mode
= MTD_MODE_NORMAL
;
664 ret
= otp_select_filemode(mfi
, mode
);
670 case OTPGETREGIONCOUNT
:
671 case OTPGETREGIONINFO
:
673 struct otp_info
*buf
= kmalloc(4096, GFP_KERNEL
);
678 case MTD_MODE_OTP_FACTORY
:
679 if (mtd
->get_fact_prot_info
)
680 ret
= mtd
->get_fact_prot_info(mtd
, buf
, 4096);
682 case MTD_MODE_OTP_USER
:
683 if (mtd
->get_user_prot_info
)
684 ret
= mtd
->get_user_prot_info(mtd
, buf
, 4096);
690 if (cmd
== OTPGETREGIONCOUNT
) {
691 int nbr
= ret
/ sizeof(struct otp_info
);
692 ret
= copy_to_user(argp
, &nbr
, sizeof(int));
694 ret
= copy_to_user(argp
, buf
, ret
);
704 struct otp_info info
;
706 if (mfi
->mode
!= MTD_MODE_OTP_USER
)
708 if (copy_from_user(&info
, argp
, sizeof(info
)))
710 if (!mtd
->lock_user_prot_reg
)
712 ret
= mtd
->lock_user_prot_reg(mtd
, info
.start
, info
.length
);
722 if (copy_to_user(argp
, mtd
->ecclayout
,
723 sizeof(struct nand_ecclayout
)))
730 if (copy_to_user(argp
, &mtd
->ecc_stats
,
731 sizeof(struct mtd_ecc_stats
)))
741 case MTD_MODE_OTP_FACTORY
:
742 case MTD_MODE_OTP_USER
:
743 ret
= otp_select_filemode(mfi
, arg
);
747 if (!mtd
->read_oob
|| !mtd
->write_oob
)
751 case MTD_MODE_NORMAL
:
767 static const struct file_operations mtd_fops
= {
768 .owner
= THIS_MODULE
,
774 .release
= mtd_close
,
777 static int __init
init_mtdchar(void)
779 if (register_chrdev(MTD_CHAR_MAJOR
, "mtd", &mtd_fops
)) {
780 printk(KERN_NOTICE
"Can't allocate major number %d for Memory Technology Devices.\n",
785 mtd_class
= class_create(THIS_MODULE
, "mtd");
787 if (IS_ERR(mtd_class
)) {
788 printk(KERN_ERR
"Error creating mtd class.\n");
789 unregister_chrdev(MTD_CHAR_MAJOR
, "mtd");
790 return PTR_ERR(mtd_class
);
793 register_mtd_user(¬ifier
);
797 static void __exit
cleanup_mtdchar(void)
799 unregister_mtd_user(¬ifier
);
800 class_destroy(mtd_class
);
801 unregister_chrdev(MTD_CHAR_MAJOR
, "mtd");
804 module_init(init_mtdchar
);
805 module_exit(cleanup_mtdchar
);
808 MODULE_LICENSE("GPL");
809 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
810 MODULE_DESCRIPTION("Direct character-device access to MTD devices");