[linux.git] / drivers / mtd / mtdchar.c

/*
 * $Id: mtdchar.c,v 1.76 2005/11/07 11:14:20 gleixner Exp $
 *
 * Character-device access to raw MTD devices.
 *
 */

#include <linux/config.h>
#include <linux/device.h>
#include <linux/fs.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/slab.h>
#include <linux/sched.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/compatmac.h>

#include <asm/uaccess.h>

static struct class *mtd_class;

static void mtd_notify_add(struct mtd_info* mtd)
{
	if (!mtd)
		return;

	class_device_create(mtd_class, NULL, MKDEV(MTD_CHAR_MAJOR, mtd->index*2),
			    NULL, "mtd%d", mtd->index);

	class_device_create(mtd_class, NULL,
			    MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1),
			    NULL, "mtd%dro", mtd->index);
}

static void mtd_notify_remove(struct mtd_info* mtd)
{
	if (!mtd)
		return;

	class_device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2));
	class_device_destroy(mtd_class, MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1));
}

static struct mtd_notifier notifier = {
	.add	= mtd_notify_add,
	.remove	= mtd_notify_remove,
};

/*
 * We use file->private_data to store a pointer to the MTDdevice.
 * Since alighment is at least 32 bits, we have 2 bits free for OTP
 * modes as well.
 */

#define TO_MTD(file) (struct mtd_info *)((long)((file)->private_data) & ~3L)

#define MTD_MODE_OTP_FACT	1
#define MTD_MODE_OTP_USER	2
#define MTD_MODE(file)		((long)((file)->private_data) & 3)

#define SET_MTD_MODE(file, mode) \
	do { long __p = (long)((file)->private_data); \
	     (file)->private_data = (void *)((__p & ~3L) | mode); } while (0)

static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
{
	struct mtd_info *mtd = TO_MTD(file);

	switch (orig) {
	case 0:
		/* SEEK_SET */
		break;
	case 1:
		/* SEEK_CUR */
		offset += file->f_pos;
		break;
	case 2:
		/* SEEK_END */
		offset += mtd->size;
		break;
	default:
		return -EINVAL;
	}

	if (offset >= 0 && offset < mtd->size)
		return file->f_pos = offset;

	return -EINVAL;
}


static int mtd_open(struct inode *inode, struct file *file)
{
	int minor = iminor(inode);
	int devnum = minor >> 1;
	struct mtd_info *mtd;

	DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");

	if (devnum >= MAX_MTD_DEVICES)
		return -ENODEV;

	/* You can't open the RO devices RW */
	if ((file->f_mode & 2) && (minor & 1))
		return -EACCES;

	mtd = get_mtd_device(NULL, devnum);

	if (!mtd)
		return -ENODEV;

	if (MTD_ABSENT == mtd->type) {
		put_mtd_device(mtd);
		return -ENODEV;
	}

	file->private_data = mtd;

	/* You can't open it RW if it's not a writeable device */
	if ((file->f_mode & 2) && !(mtd->flags & MTD_WRITEABLE)) {
		put_mtd_device(mtd);
		return -EACCES;
	}

	return 0;
} /* mtd_open */

/*====================================================================*/

static int mtd_close(struct inode *inode, struct file *file)
{
	struct mtd_info *mtd;

	DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");

	mtd = TO_MTD(file);

	if (mtd->sync)
		mtd->sync(mtd);

	put_mtd_device(mtd);

	return 0;
} /* mtd_close */

/* FIXME: This _really_ needs to die. In 2.5, we should lock the
   userspace buffer down and use it directly with readv/writev.
*/
#define MAX_KMALLOC_SIZE 0x20000

static ssize_t mtd_read(struct file *file, char __user *buf, size_t count,loff_t *ppos)
{
	struct mtd_info *mtd = TO_MTD(file);
	size_t retlen=0;
	size_t total_retlen=0;
	int ret=0;
	int len;
	char *kbuf;

	DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");

	if (*ppos + count > mtd->size)
		count = mtd->size - *ppos;

	if (!count)
		return 0;

	/* FIXME: Use kiovec in 2.5 to lock down the user's buffers
	   and pass them directly to the MTD functions */
	while (count) {
		if (count > MAX_KMALLOC_SIZE)
			len = MAX_KMALLOC_SIZE;
		else
			len = count;

		kbuf=kmalloc(len,GFP_KERNEL);
		if (!kbuf)
			return -ENOMEM;

		switch (MTD_MODE(file)) {
		case MTD_MODE_OTP_FACT:
			ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
			break;
		case MTD_MODE_OTP_USER:
			ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
			break;
		default:
			ret = MTD_READ(mtd, *ppos, len, &retlen, kbuf);
		}
		/* Nand returns -EBADMSG on ecc errors, but it returns
		 * the data. For our userspace tools it is important
		 * to dump areas with ecc errors !
		 * Userspace software which accesses NAND this way
		 * must be aware of the fact that it deals with NAND
		 */
		if (!ret || (ret == -EBADMSG)) {
			*ppos += retlen;
			if (copy_to_user(buf, kbuf, retlen)) {
			        kfree(kbuf);
				return -EFAULT;
			}
			else
				total_retlen += retlen;

			count -= retlen;
			buf += retlen;
			if (retlen == 0)
				count = 0;
		}
		else {
			kfree(kbuf);
			return ret;
		}

		kfree(kbuf);
	}

	return total_retlen;
} /* mtd_read */

static ssize_t mtd_write(struct file *file, const char __user *buf, size_t count,loff_t *ppos)
{
	struct mtd_info *mtd = TO_MTD(file);
	char *kbuf;
	size_t retlen;
	size_t total_retlen=0;
	int ret=0;
	int len;

	DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");

	if (*ppos == mtd->size)
		return -ENOSPC;

	if (*ppos + count > mtd->size)
		count = mtd->size - *ppos;

	if (!count)
		return 0;

	while (count) {
		if (count > MAX_KMALLOC_SIZE)
			len = MAX_KMALLOC_SIZE;
		else
			len = count;

		kbuf=kmalloc(len,GFP_KERNEL);
		if (!kbuf) {
			printk("kmalloc is null\n");
			return -ENOMEM;
		}

		if (copy_from_user(kbuf, buf, len)) {
			kfree(kbuf);
			return -EFAULT;
		}

		switch (MTD_MODE(file)) {
		case MTD_MODE_OTP_FACT:
			ret = -EROFS;
			break;
		case MTD_MODE_OTP_USER:
			if (!mtd->write_user_prot_reg) {
				ret = -EOPNOTSUPP;
				break;
			}
			ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
			break;
		default:
			ret = (*(mtd->write))(mtd, *ppos, len, &retlen, kbuf);
		}
		if (!ret) {
			*ppos += retlen;
			total_retlen += retlen;
			count -= retlen;
			buf += retlen;
		}
		else {
			kfree(kbuf);
			return ret;
		}

		kfree(kbuf);
	}

	return total_retlen;
} /* mtd_write */

/*======================================================================

    IOCTL calls for getting device parameters.

======================================================================*/
static void mtdchar_erase_callback (struct erase_info *instr)
{
	wake_up((wait_queue_head_t *)instr->priv);
}

static int mtd_ioctl(struct inode *inode, struct file *file,
		     u_int cmd, u_long arg)
{
	struct mtd_info *mtd = TO_MTD(file);
	void __user *argp = (void __user *)arg;
	int ret = 0;
	u_long size;

	DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");

	size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
	if (cmd & IOC_IN) {
		if (!access_ok(VERIFY_READ, argp, size))
			return -EFAULT;
	}
	if (cmd & IOC_OUT) {
		if (!access_ok(VERIFY_WRITE, argp, size))
			return -EFAULT;
	}

	switch (cmd) {
	case MEMGETREGIONCOUNT:
		if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
			return -EFAULT;
		break;

	case MEMGETREGIONINFO:
	{
		struct region_info_user ur;

		if (copy_from_user(&ur, argp, sizeof(struct region_info_user)))
			return -EFAULT;

		if (ur.regionindex >= mtd->numeraseregions)
			return -EINVAL;
		if (copy_to_user(argp, &(mtd->eraseregions[ur.regionindex]),
				sizeof(struct mtd_erase_region_info)))
			return -EFAULT;
		break;
	}

	case MEMGETINFO:
		if (copy_to_user(argp, mtd, sizeof(struct mtd_info_user)))
			return -EFAULT;
		break;

	case MEMERASE:
	{
		struct erase_info *erase;

		if(!(file->f_mode & 2))
			return -EPERM;

		erase=kmalloc(sizeof(struct erase_info),GFP_KERNEL);
		if (!erase)
			ret = -ENOMEM;
		else {
			wait_queue_head_t waitq;
			DECLARE_WAITQUEUE(wait, current);

			init_waitqueue_head(&waitq);

			memset (erase,0,sizeof(struct erase_info));
			if (copy_from_user(&erase->addr, argp,
				    sizeof(struct erase_info_user))) {
				kfree(erase);
				return -EFAULT;
			}
			erase->mtd = mtd;
			erase->callback = mtdchar_erase_callback;
			erase->priv = (unsigned long)&waitq;

			/*
			  FIXME: Allow INTERRUPTIBLE. Which means
			  not having the wait_queue head on the stack.

			  If the wq_head is on the stack, and we
			  leave because we got interrupted, then the
			  wq_head is no longer there when the
			  callback routine tries to wake us up.
			*/
			ret = mtd->erase(mtd, erase);
			if (!ret) {
				set_current_state(TASK_UNINTERRUPTIBLE);
				add_wait_queue(&waitq, &wait);
				if (erase->state != MTD_ERASE_DONE &&
				    erase->state != MTD_ERASE_FAILED)
					schedule();
				remove_wait_queue(&waitq, &wait);
				set_current_state(TASK_RUNNING);

				ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
			}
			kfree(erase);
		}
		break;
	}

	case MEMWRITEOOB:
	{
		struct mtd_oob_buf buf;
		void *databuf;
		ssize_t retlen;

		if(!(file->f_mode & 2))
			return -EPERM;

		if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
			return -EFAULT;

		if (buf.length > 0x4096)
			return -EINVAL;

		if (!mtd->write_oob)
			ret = -EOPNOTSUPP;
		else
			ret = access_ok(VERIFY_READ, buf.ptr,
					buf.length) ? 0 : EFAULT;

		if (ret)
			return ret;

		databuf = kmalloc(buf.length, GFP_KERNEL);
		if (!databuf)
			return -ENOMEM;

		if (copy_from_user(databuf, buf.ptr, buf.length)) {
			kfree(databuf);
			return -EFAULT;
		}

		ret = (mtd->write_oob)(mtd, buf.start, buf.length, &retlen, databuf);

		if (copy_to_user(argp + sizeof(uint32_t), &retlen, sizeof(uint32_t)))
			ret = -EFAULT;

		kfree(databuf);
		break;

	}

	case MEMREADOOB:
	{
		struct mtd_oob_buf buf;
		void *databuf;
		ssize_t retlen;

		if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
			return -EFAULT;

		if (buf.length > 0x4096)
			return -EINVAL;

		if (!mtd->read_oob)
			ret = -EOPNOTSUPP;
		else
			ret = access_ok(VERIFY_WRITE, buf.ptr,
					buf.length) ? 0 : -EFAULT;

		if (ret)
			return ret;

		databuf = kmalloc(buf.length, GFP_KERNEL);
		if (!databuf)
			return -ENOMEM;

		ret = (mtd->read_oob)(mtd, buf.start, buf.length, &retlen, databuf);

		if (put_user(retlen, (uint32_t __user *)argp))
			ret = -EFAULT;
		else if (retlen && copy_to_user(buf.ptr, databuf, retlen))
			ret = -EFAULT;

		kfree(databuf);
		break;
	}

	case MEMLOCK:
	{
		struct erase_info_user info;

		if (copy_from_user(&info, argp, sizeof(info)))
			return -EFAULT;

		if (!mtd->lock)
			ret = -EOPNOTSUPP;
		else
			ret = mtd->lock(mtd, info.start, info.length);
		break;
	}

	case MEMUNLOCK:
	{
		struct erase_info_user info;

		if (copy_from_user(&info, argp, sizeof(info)))
			return -EFAULT;

		if (!mtd->unlock)
			ret = -EOPNOTSUPP;
		else
			ret = mtd->unlock(mtd, info.start, info.length);
		break;
	}

	case MEMSETOOBSEL:
	{
		if (copy_from_user(&mtd->oobinfo, argp, sizeof(struct nand_oobinfo)))
			return -EFAULT;
		break;
	}

	case MEMGETOOBSEL:
	{
		if (copy_to_user(argp, &(mtd->oobinfo), sizeof(struct nand_oobinfo)))
			return -EFAULT;
		break;
	}

	case MEMGETBADBLOCK:
	{
		loff_t offs;

		if (copy_from_user(&offs, argp, sizeof(loff_t)))
			return -EFAULT;
		if (!mtd->block_isbad)
			ret = -EOPNOTSUPP;
		else
			return mtd->block_isbad(mtd, offs);
		break;
	}

	case MEMSETBADBLOCK:
	{
		loff_t offs;

		if (copy_from_user(&offs, argp, sizeof(loff_t)))
			return -EFAULT;
		if (!mtd->block_markbad)
			ret = -EOPNOTSUPP;
		else
			return mtd->block_markbad(mtd, offs);
		break;
	}

#ifdef CONFIG_MTD_OTP
	case OTPSELECT:
	{
		int mode;
		if (copy_from_user(&mode, argp, sizeof(int)))
			return -EFAULT;
		SET_MTD_MODE(file, 0);
		switch (mode) {
		case MTD_OTP_FACTORY:
			if (!mtd->read_fact_prot_reg)
				ret = -EOPNOTSUPP;
			else
				SET_MTD_MODE(file, MTD_MODE_OTP_FACT);
			break;
		case MTD_OTP_USER:
			if (!mtd->read_fact_prot_reg)
				ret = -EOPNOTSUPP;
			else
				SET_MTD_MODE(file, MTD_MODE_OTP_USER);
			break;
		default:
			ret = -EINVAL;
		case MTD_OTP_OFF:
			break;
		}
		file->f_pos = 0;
		break;
	}

	case OTPGETREGIONCOUNT:
	case OTPGETREGIONINFO:
	{
		struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
		if (!buf)
			return -ENOMEM;
		ret = -EOPNOTSUPP;
		switch (MTD_MODE(file)) {
		case MTD_MODE_OTP_FACT:
			if (mtd->get_fact_prot_info)
				ret = mtd->get_fact_prot_info(mtd, buf, 4096);
			break;
		case MTD_MODE_OTP_USER:
			if (mtd->get_user_prot_info)
				ret = mtd->get_user_prot_info(mtd, buf, 4096);
			break;
		}
		if (ret >= 0) {
			if (cmd == OTPGETREGIONCOUNT) {
				int nbr = ret / sizeof(struct otp_info);
				ret = copy_to_user(argp, &nbr, sizeof(int));
			} else
				ret = copy_to_user(argp, buf, ret);
			if (ret)
				ret = -EFAULT;
		}
		kfree(buf);
		break;
	}

	case OTPLOCK:
	{
		struct otp_info info;

		if (MTD_MODE(file) != MTD_MODE_OTP_USER)
			return -EINVAL;
		if (copy_from_user(&info, argp, sizeof(info)))
			return -EFAULT;
		if (!mtd->lock_user_prot_reg)
			return -EOPNOTSUPP;
		ret = mtd->lock_user_prot_reg(mtd, info.start, info.length);
		break;
	}
#endif

	default:
		ret = -ENOTTY;
	}

	return ret;
} /* memory_ioctl */

static struct file_operations mtd_fops = {
	.owner		= THIS_MODULE,
	.llseek		= mtd_lseek,
	.read		= mtd_read,
	.write		= mtd_write,
	.ioctl		= mtd_ioctl,
	.open		= mtd_open,
	.release	= mtd_close,
};

static int __init init_mtdchar(void)
{
	if (register_chrdev(MTD_CHAR_MAJOR, "mtd", &mtd_fops)) {
		printk(KERN_NOTICE "Can't allocate major number %d for Memory Technology Devices.\n",
		       MTD_CHAR_MAJOR);
		return -EAGAIN;
	}

	mtd_class = class_create(THIS_MODULE, "mtd");

	if (IS_ERR(mtd_class)) {
		printk(KERN_ERR "Error creating mtd class.\n");
		unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
		return PTR_ERR(mtd_class);
	}

	register_mtd_user(&notifier);
	return 0;
}

static void __exit cleanup_mtdchar(void)
{
	unregister_mtd_user(&notifier);
	class_destroy(mtd_class);
	unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
}

module_init(init_mtdchar);
module_exit(cleanup_mtdchar);


MODULE_LICENSE("GPL");
MODULE_AUTHOR("David Woodhouse <[email protected]>");
MODULE_DESCRIPTION("Direct character-device access to MTD devices");
Commit	Line	Data
1da177e4	1	/*
97894cda	2	* $Id: mtdchar.c,v 1.76 2005/11/07 11:14:20 gleixner Exp $
1da177e4 LT	3	*
	4	* Character-device access to raw MTD devices.
	5	*
	6	*/
	7
	8	#include <linux/config.h>
15fdc52f TG	9	#include <linux/device.h>
	10	#include <linux/fs.h>
	11	#include <linux/init.h>
1da177e4 LT	12	#include <linux/kernel.h>
1da177e4 LT	13	#include <linux/module.h>
15fdc52f TG	14	#include <linux/slab.h>
	15	#include <linux/sched.h>
	16
1da177e4 LT	17	#include <linux/mtd/mtd.h>
1da177e4 LT	18	#include <linux/mtd/compatmac.h>
1da177e4	19
15fdc52f	20	#include <asm/uaccess.h>
9bc7b387 TP	21
9bc7b387 TP	22	static struct class *mtd_class;
1da177e4 LT	23
	24	static void mtd_notify_add(struct mtd_info* mtd)
	25	{
	26	if (!mtd)
	27	return;
	28
53f46542	29	class_device_create(mtd_class, NULL, MKDEV(MTD_CHAR_MAJOR, mtd->index*2),
9bc7b387	30	NULL, "mtd%d", mtd->index);
97894cda	31
53f46542	32	class_device_create(mtd_class, NULL,
9bc7b387 TP	33	MKDEV(MTD_CHAR_MAJOR, mtd->index*2+1),
9bc7b387 TP	34	NULL, "mtd%dro", mtd->index);
1da177e4 LT	35	}
	36
	37	static void mtd_notify_remove(struct mtd_info* mtd)
	38	{
	39	if (!mtd)
	40	return;
9bc7b387 TP	41
	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));
1da177e4 LT	44	}
	45
	46	static struct mtd_notifier notifier = {
	47	.add = mtd_notify_add,
	48	.remove = mtd_notify_remove,
	49	};
	50
045e9a5d NP	51	/*
	52	* We use file->private_data to store a pointer to the MTDdevice.
	53	* Since alighment is at least 32 bits, we have 2 bits free for OTP
	54	* modes as well.
	55	*/
	56
	57	#define TO_MTD(file) (struct mtd_info *)((long)((file)->private_data) & ~3L)
31f4233b	58
045e9a5d NP	59	#define MTD_MODE_OTP_FACT 1
	60	#define MTD_MODE_OTP_USER 2
	61	#define MTD_MODE(file) ((long)((file)->private_data) & 3)
	62
	63	#define SET_MTD_MODE(file, mode) \
	64	do { long __p = (long)((file)->private_data); \
	65	(file)->private_data = (void *)((__p & ~3L) \| mode); } while (0)
31f4233b	66
1da177e4 LT	67	static loff_t mtd_lseek (struct file *file, loff_t offset, int orig)
1da177e4 LT	68	{
045e9a5d	69	struct mtd_info *mtd = TO_MTD(file);
1da177e4 LT	70
	71	switch (orig) {
	72	case 0:
	73	/* SEEK_SET */
1da177e4 LT	74	break;
	75	case 1:
	76	/* SEEK_CUR */
8b491d75	77	offset += file->f_pos;
1da177e4 LT	78	break;
	79	case 2:
	80	/* SEEK_END */
8b491d75	81	offset += mtd->size;
1da177e4 LT	82	break;
	83	default:
	84	return -EINVAL;
	85	}
	86
8b491d75 TP	87	if (offset >= 0 && offset < mtd->size)
8b491d75 TP	88	return file->f_pos = offset;
1da177e4	89
8b491d75	90	return -EINVAL;
1da177e4 LT	91	}
	92
	93
	94
	95	static int mtd_open(struct inode inode, struct file file)
	96	{
	97	int minor = iminor(inode);
	98	int devnum = minor >> 1;
	99	struct mtd_info *mtd;
	100
	101	DEBUG(MTD_DEBUG_LEVEL0, "MTD_open\n");
	102
	103	if (devnum >= MAX_MTD_DEVICES)
	104	return -ENODEV;
	105
	106	/* You can't open the RO devices RW */
	107	if ((file->f_mode & 2) && (minor & 1))
	108	return -EACCES;
	109
	110	mtd = get_mtd_device(NULL, devnum);
97894cda	111
1da177e4 LT	112	if (!mtd)
1da177e4 LT	113	return -ENODEV;
97894cda	114
1da177e4 LT	115	if (MTD_ABSENT == mtd->type) {
	116	put_mtd_device(mtd);
	117	return -ENODEV;
	118	}
	119
	120	file->private_data = mtd;
97894cda	121
1da177e4 LT	122	/* You can't open it RW if it's not a writeable device */
	123	if ((file->f_mode & 2) && !(mtd->flags & MTD_WRITEABLE)) {
	124	put_mtd_device(mtd);
	125	return -EACCES;
	126	}
97894cda	127
1da177e4 LT	128	return 0;
	129	} /* mtd_open */
	130
	131	/====================================================================/
	132
	133	static int mtd_close(struct inode inode, struct file file)
	134	{
	135	struct mtd_info *mtd;
	136
	137	DEBUG(MTD_DEBUG_LEVEL0, "MTD_close\n");
	138
045e9a5d	139	mtd = TO_MTD(file);
97894cda	140
1da177e4 LT	141	if (mtd->sync)
1da177e4 LT	142	mtd->sync(mtd);
97894cda	143
1da177e4 LT	144	put_mtd_device(mtd);
	145
	146	return 0;
	147	} /* mtd_close */
	148
	149	/* FIXME: This _really_ needs to die. In 2.5, we should lock the
	150	userspace buffer down and use it directly with readv/writev.
	151	*/
	152	#define MAX_KMALLOC_SIZE 0x20000
	153
	154	static ssize_t mtd_read(struct file file, char __user buf, size_t count,loff_t *ppos)
	155	{
045e9a5d	156	struct mtd_info *mtd = TO_MTD(file);
1da177e4 LT	157	size_t retlen=0;
	158	size_t total_retlen=0;
	159	int ret=0;
	160	int len;
	161	char *kbuf;
97894cda	162
1da177e4 LT	163	DEBUG(MTD_DEBUG_LEVEL0,"MTD_read\n");
	164
	165	if (*ppos + count > mtd->size)
	166	count = mtd->size - *ppos;
	167
	168	if (!count)
	169	return 0;
97894cda	170
1da177e4 LT	171	/* FIXME: Use kiovec in 2.5 to lock down the user's buffers
	172	and pass them directly to the MTD functions */
	173	while (count) {
97894cda	174	if (count > MAX_KMALLOC_SIZE)
1da177e4 LT	175	len = MAX_KMALLOC_SIZE;
	176	else
	177	len = count;
	178
	179	kbuf=kmalloc(len,GFP_KERNEL);
	180	if (!kbuf)
	181	return -ENOMEM;
97894cda	182
045e9a5d	183	switch (MTD_MODE(file)) {
31f4233b NP	184	case MTD_MODE_OTP_FACT:
	185	ret = mtd->read_fact_prot_reg(mtd, *ppos, len, &retlen, kbuf);
	186	break;
	187	case MTD_MODE_OTP_USER:
	188	ret = mtd->read_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
	189	break;
	190	default:
	191	ret = MTD_READ(mtd, *ppos, len, &retlen, kbuf);
	192	}
1da177e4 LT	193	/* Nand returns -EBADMSG on ecc errors, but it returns
1da177e4 LT	194	* the data. For our userspace tools it is important
97894cda	195	* to dump areas with ecc errors !
1da177e4 LT	196	* Userspace software which accesses NAND this way
	197	* must be aware of the fact that it deals with NAND
	198	*/
	199	if (!ret \|\| (ret == -EBADMSG)) {
	200	*ppos += retlen;
	201	if (copy_to_user(buf, kbuf, retlen)) {
	202	kfree(kbuf);
	203	return -EFAULT;
	204	}
	205	else
	206	total_retlen += retlen;
	207
	208	count -= retlen;
	209	buf += retlen;
31f4233b NP	210	if (retlen == 0)
31f4233b NP	211	count = 0;
1da177e4 LT	212	}
	213	else {
	214	kfree(kbuf);
	215	return ret;
	216	}
97894cda	217
1da177e4 LT	218	kfree(kbuf);
	219	}
	220
	221	return total_retlen;
	222	} /* mtd_read */
	223
	224	static ssize_t mtd_write(struct file file, const char __user buf, size_t count,loff_t *ppos)
	225	{
045e9a5d	226	struct mtd_info *mtd = TO_MTD(file);
1da177e4 LT	227	char *kbuf;
	228	size_t retlen;
	229	size_t total_retlen=0;
	230	int ret=0;
	231	int len;
	232
	233	DEBUG(MTD_DEBUG_LEVEL0,"MTD_write\n");
97894cda	234
1da177e4 LT	235	if (*ppos == mtd->size)
1da177e4 LT	236	return -ENOSPC;
97894cda	237
1da177e4 LT	238	if (*ppos + count > mtd->size)
	239	count = mtd->size - *ppos;
	240
	241	if (!count)
	242	return 0;
	243
	244	while (count) {
97894cda	245	if (count > MAX_KMALLOC_SIZE)
1da177e4 LT	246	len = MAX_KMALLOC_SIZE;
	247	else
	248	len = count;
	249
	250	kbuf=kmalloc(len,GFP_KERNEL);
	251	if (!kbuf) {
	252	printk("kmalloc is null\n");
	253	return -ENOMEM;
	254	}
	255
	256	if (copy_from_user(kbuf, buf, len)) {
	257	kfree(kbuf);
	258	return -EFAULT;
	259	}
97894cda	260
045e9a5d	261	switch (MTD_MODE(file)) {
31f4233b NP	262	case MTD_MODE_OTP_FACT:
	263	ret = -EROFS;
	264	break;
	265	case MTD_MODE_OTP_USER:
	266	if (!mtd->write_user_prot_reg) {
	267	ret = -EOPNOTSUPP;
	268	break;
	269	}
	270	ret = mtd->write_user_prot_reg(mtd, *ppos, len, &retlen, kbuf);
	271	break;
	272	default:
	273	ret = ((mtd->write))(mtd, ppos, len, &retlen, kbuf);
	274	}
1da177e4 LT	275	if (!ret) {
	276	*ppos += retlen;
	277	total_retlen += retlen;
	278	count -= retlen;
	279	buf += retlen;
	280	}
	281	else {
	282	kfree(kbuf);
	283	return ret;
	284	}
97894cda	285
1da177e4 LT	286	kfree(kbuf);
	287	}
	288
	289	return total_retlen;
	290	} /* mtd_write */
	291
	292	/*======================================================================
	293
	294	IOCTL calls for getting device parameters.
	295
	296	======================================================================*/
	297	static void mtdchar_erase_callback (struct erase_info *instr)
	298	{
	299	wake_up((wait_queue_head_t *)instr->priv);
	300	}
	301
	302	static int mtd_ioctl(struct inode inode, struct file file,
	303	u_int cmd, u_long arg)
	304	{
045e9a5d	305	struct mtd_info *mtd = TO_MTD(file);
1da177e4 LT	306	void __user argp = (void __user )arg;
	307	int ret = 0;
	308	u_long size;
97894cda	309
1da177e4 LT	310	DEBUG(MTD_DEBUG_LEVEL0, "MTD_ioctl\n");
	311
	312	size = (cmd & IOCSIZE_MASK) >> IOCSIZE_SHIFT;
	313	if (cmd & IOC_IN) {
	314	if (!access_ok(VERIFY_READ, argp, size))
	315	return -EFAULT;
	316	}
	317	if (cmd & IOC_OUT) {
	318	if (!access_ok(VERIFY_WRITE, argp, size))
	319	return -EFAULT;
	320	}
97894cda	321
1da177e4 LT	322	switch (cmd) {
	323	case MEMGETREGIONCOUNT:
	324	if (copy_to_user(argp, &(mtd->numeraseregions), sizeof(int)))
	325	return -EFAULT;
	326	break;
	327
	328	case MEMGETREGIONINFO:
	329	{
	330	struct region_info_user ur;
	331
	332	if (copy_from_user(&ur, argp, sizeof(struct region_info_user)))
	333	return -EFAULT;
	334
	335	if (ur.regionindex >= mtd->numeraseregions)
	336	return -EINVAL;
	337	if (copy_to_user(argp, &(mtd->eraseregions[ur.regionindex]),
	338	sizeof(struct mtd_erase_region_info)))
	339	return -EFAULT;
	340	break;
	341	}
	342
	343	case MEMGETINFO:
	344	if (copy_to_user(argp, mtd, sizeof(struct mtd_info_user)))
	345	return -EFAULT;
	346	break;
	347
	348	case MEMERASE:
	349	{
	350	struct erase_info *erase;
	351
	352	if(!(file->f_mode & 2))
	353	return -EPERM;
	354
	355	erase=kmalloc(sizeof(struct erase_info),GFP_KERNEL);
	356	if (!erase)
	357	ret = -ENOMEM;
	358	else {
	359	wait_queue_head_t waitq;
	360	DECLARE_WAITQUEUE(wait, current);
	361
	362	init_waitqueue_head(&waitq);
	363
	364	memset (erase,0,sizeof(struct erase_info));
	365	if (copy_from_user(&erase->addr, argp,
	366	sizeof(struct erase_info_user))) {
	367	kfree(erase);
	368	return -EFAULT;
	369	}
	370	erase->mtd = mtd;
	371	erase->callback = mtdchar_erase_callback;
	372	erase->priv = (unsigned long)&waitq;
97894cda	373
1da177e4 LT	374	/*
	375	FIXME: Allow INTERRUPTIBLE. Which means
	376	not having the wait_queue head on the stack.
97894cda	377
1da177e4 LT	378	If the wq_head is on the stack, and we
	379	leave because we got interrupted, then the
	380	wq_head is no longer there when the
	381	callback routine tries to wake us up.
	382	*/
	383	ret = mtd->erase(mtd, erase);
	384	if (!ret) {
	385	set_current_state(TASK_UNINTERRUPTIBLE);
	386	add_wait_queue(&waitq, &wait);
	387	if (erase->state != MTD_ERASE_DONE &&
	388	erase->state != MTD_ERASE_FAILED)
	389	schedule();
	390	remove_wait_queue(&waitq, &wait);
	391	set_current_state(TASK_RUNNING);
	392
	393	ret = (erase->state == MTD_ERASE_FAILED)?-EIO:0;
	394	}
	395	kfree(erase);
	396	}
	397	break;
	398	}
	399
	400	case MEMWRITEOOB:
	401	{
	402	struct mtd_oob_buf buf;
	403	void *databuf;
	404	ssize_t retlen;
97894cda	405
1da177e4 LT	406	if(!(file->f_mode & 2))
	407	return -EPERM;
	408
	409	if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
	410	return -EFAULT;
97894cda	411
1da177e4 LT	412	if (buf.length > 0x4096)
	413	return -EINVAL;
	414
	415	if (!mtd->write_oob)
	416	ret = -EOPNOTSUPP;
	417	else
	418	ret = access_ok(VERIFY_READ, buf.ptr,
	419	buf.length) ? 0 : EFAULT;
	420
	421	if (ret)
	422	return ret;
	423
	424	databuf = kmalloc(buf.length, GFP_KERNEL);
	425	if (!databuf)
	426	return -ENOMEM;
97894cda	427
1da177e4 LT	428	if (copy_from_user(databuf, buf.ptr, buf.length)) {
	429	kfree(databuf);
	430	return -EFAULT;
	431	}
	432
	433	ret = (mtd->write_oob)(mtd, buf.start, buf.length, &retlen, databuf);
	434
	435	if (copy_to_user(argp + sizeof(uint32_t), &retlen, sizeof(uint32_t)))
	436	ret = -EFAULT;
	437
	438	kfree(databuf);
	439	break;
	440
	441	}
	442
	443	case MEMREADOOB:
	444	{
	445	struct mtd_oob_buf buf;
	446	void *databuf;
	447	ssize_t retlen;
	448
	449	if (copy_from_user(&buf, argp, sizeof(struct mtd_oob_buf)))
	450	return -EFAULT;
97894cda	451
1da177e4 LT	452	if (buf.length > 0x4096)
	453	return -EINVAL;
	454
	455	if (!mtd->read_oob)
	456	ret = -EOPNOTSUPP;
	457	else
	458	ret = access_ok(VERIFY_WRITE, buf.ptr,
	459	buf.length) ? 0 : -EFAULT;
	460
	461	if (ret)
	462	return ret;
	463
	464	databuf = kmalloc(buf.length, GFP_KERNEL);
	465	if (!databuf)
	466	return -ENOMEM;
97894cda	467
1da177e4 LT	468	ret = (mtd->read_oob)(mtd, buf.start, buf.length, &retlen, databuf);
	469
	470	if (put_user(retlen, (uint32_t __user *)argp))
	471	ret = -EFAULT;
	472	else if (retlen && copy_to_user(buf.ptr, databuf, retlen))
	473	ret = -EFAULT;
97894cda	474
1da177e4 LT	475	kfree(databuf);
	476	break;
	477	}
	478
	479	case MEMLOCK:
	480	{
	481	struct erase_info_user info;
	482
	483	if (copy_from_user(&info, argp, sizeof(info)))
	484	return -EFAULT;
	485
	486	if (!mtd->lock)
	487	ret = -EOPNOTSUPP;
	488	else
	489	ret = mtd->lock(mtd, info.start, info.length);
	490	break;
	491	}
	492
	493	case MEMUNLOCK:
	494	{
	495	struct erase_info_user info;
	496
	497	if (copy_from_user(&info, argp, sizeof(info)))
	498	return -EFAULT;
	499
	500	if (!mtd->unlock)
	501	ret = -EOPNOTSUPP;
	502	else
	503	ret = mtd->unlock(mtd, info.start, info.length);
	504	break;
	505	}
	506
	507	case MEMSETOOBSEL:
	508	{
	509	if (copy_from_user(&mtd->oobinfo, argp, sizeof(struct nand_oobinfo)))
	510	return -EFAULT;
	511	break;
	512	}
	513
	514	case MEMGETOOBSEL:
	515	{
	516	if (copy_to_user(argp, &(mtd->oobinfo), sizeof(struct nand_oobinfo)))
	517	return -EFAULT;
	518	break;
	519	}
	520
	521	case MEMGETBADBLOCK:
	522	{
	523	loff_t offs;
97894cda	524
1da177e4 LT	525	if (copy_from_user(&offs, argp, sizeof(loff_t)))
	526	return -EFAULT;
	527	if (!mtd->block_isbad)
	528	ret = -EOPNOTSUPP;
	529	else
	530	return mtd->block_isbad(mtd, offs);
	531	break;
	532	}
	533
	534	case MEMSETBADBLOCK:
	535	{
	536	loff_t offs;
	537
	538	if (copy_from_user(&offs, argp, sizeof(loff_t)))
	539	return -EFAULT;
	540	if (!mtd->block_markbad)
	541	ret = -EOPNOTSUPP;
	542	else
	543	return mtd->block_markbad(mtd, offs);
	544	break;
	545	}
	546
31f4233b NP	547	#ifdef CONFIG_MTD_OTP
	548	case OTPSELECT:
	549	{
	550	int mode;
	551	if (copy_from_user(&mode, argp, sizeof(int)))
	552	return -EFAULT;
045e9a5d	553	SET_MTD_MODE(file, 0);
31f4233b NP	554	switch (mode) {
	555	case MTD_OTP_FACTORY:
	556	if (!mtd->read_fact_prot_reg)
	557	ret = -EOPNOTSUPP;
	558	else
045e9a5d	559	SET_MTD_MODE(file, MTD_MODE_OTP_FACT);
31f4233b NP	560	break;
	561	case MTD_OTP_USER:
	562	if (!mtd->read_fact_prot_reg)
	563	ret = -EOPNOTSUPP;
	564	else
045e9a5d	565	SET_MTD_MODE(file, MTD_MODE_OTP_USER);
31f4233b NP	566	break;
	567	default:
	568	ret = -EINVAL;
	569	case MTD_OTP_OFF:
	570	break;
	571	}
81dba488	572	file->f_pos = 0;
31f4233b NP	573	break;
	574	}
	575
	576	case OTPGETREGIONCOUNT:
	577	case OTPGETREGIONINFO:
	578	{
	579	struct otp_info *buf = kmalloc(4096, GFP_KERNEL);
	580	if (!buf)
	581	return -ENOMEM;
	582	ret = -EOPNOTSUPP;
045e9a5d	583	switch (MTD_MODE(file)) {
31f4233b NP	584	case MTD_MODE_OTP_FACT:
	585	if (mtd->get_fact_prot_info)
	586	ret = mtd->get_fact_prot_info(mtd, buf, 4096);
	587	break;
	588	case MTD_MODE_OTP_USER:
	589	if (mtd->get_user_prot_info)
	590	ret = mtd->get_user_prot_info(mtd, buf, 4096);
	591	break;
	592	}
	593	if (ret >= 0) {
	594	if (cmd == OTPGETREGIONCOUNT) {
	595	int nbr = ret / sizeof(struct otp_info);
	596	ret = copy_to_user(argp, &nbr, sizeof(int));
	597	} else
	598	ret = copy_to_user(argp, buf, ret);
	599	if (ret)
	600	ret = -EFAULT;
	601	}
	602	kfree(buf);
	603	break;
	604	}
	605
	606	case OTPLOCK:
	607	{
	608	struct otp_info info;
	609
045e9a5d	610	if (MTD_MODE(file) != MTD_MODE_OTP_USER)
31f4233b NP	611	return -EINVAL;
	612	if (copy_from_user(&info, argp, sizeof(info)))
	613	return -EFAULT;
	614	if (!mtd->lock_user_prot_reg)
	615	return -EOPNOTSUPP;
	616	ret = mtd->lock_user_prot_reg(mtd, info.start, info.length);
	617	break;
	618	}
	619	#endif
	620
1da177e4 LT	621	default:
	622	ret = -ENOTTY;
	623	}
	624
	625	return ret;
	626	} /* memory_ioctl */
	627
	628	static struct file_operations mtd_fops = {
	629	.owner = THIS_MODULE,
	630	.llseek = mtd_lseek,
	631	.read = mtd_read,
	632	.write = mtd_write,
	633	.ioctl = mtd_ioctl,
	634	.open = mtd_open,
	635	.release = mtd_close,
	636	};
	637
	638	static int __init init_mtdchar(void)
	639	{
	640	if (register_chrdev(MTD_CHAR_MAJOR, "mtd", &mtd_fops)) {
	641	printk(KERN_NOTICE "Can't allocate major number %d for Memory Technology Devices.\n",
	642	MTD_CHAR_MAJOR);
	643	return -EAGAIN;
	644	}
	645
9bc7b387 TP	646	mtd_class = class_create(THIS_MODULE, "mtd");
	647
	648	if (IS_ERR(mtd_class)) {
	649	printk(KERN_ERR "Error creating mtd class.\n");
	650	unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
3a7a8824	651	return PTR_ERR(mtd_class);
9bc7b387 TP	652	}
	653
	654	register_mtd_user(&notifier);
1da177e4 LT	655	return 0;
	656	}
	657
	658	static void __exit cleanup_mtdchar(void)
	659	{
9bc7b387 TP	660	unregister_mtd_user(&notifier);
9bc7b387 TP	661	class_destroy(mtd_class);
1da177e4 LT	662	unregister_chrdev(MTD_CHAR_MAJOR, "mtd");
	663	}
	664
	665	module_init(init_mtdchar);
	666	module_exit(cleanup_mtdchar);
	667
	668
	669	MODULE_LICENSE("GPL");
	670	MODULE_AUTHOR("David Woodhouse <[email protected]>");
	671	MODULE_DESCRIPTION("Direct character-device access to MTD devices");