[deliverable/linux.git] / drivers / mtd / devices / mtdram.c

/*
 * mtdram - a test mtd device
 * Author: Alexander Larsson <alex@cendio.se>
 *
 * Copyright (c) 1999 Alexander Larsson <alex@cendio.se>
 * Copyright (c) 2005 Joern Engel <joern@wh.fh-wedel.de>
 *
 * This code is GPL
 *
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/ioport.h>
#include <linux/vmalloc.h>
#include <linux/init.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/mtdram.h>

static unsigned long total_size = CONFIG_MTDRAM_TOTAL_SIZE;
static unsigned long erase_size = CONFIG_MTDRAM_ERASE_SIZE;
static unsigned long writebuf_size = 64;
#define MTDRAM_TOTAL_SIZE (total_size * 1024)
#define MTDRAM_ERASE_SIZE (erase_size * 1024)

#ifdef MODULE
module_param(total_size, ulong, 0);
MODULE_PARM_DESC(total_size, "Total device size in KiB");
module_param(erase_size, ulong, 0);
MODULE_PARM_DESC(erase_size, "Device erase block size in KiB");
module_param(writebuf_size, ulong, 0);
MODULE_PARM_DESC(writebuf_size, "Device write buf size in Bytes (Default: 64)");
#endif

// We could store these in the mtd structure, but we only support 1 device..
static struct mtd_info *mtd_info;

static int check_offs_len(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
	int ret = 0;

	/* Start address must align on block boundary */
	if (mtd_mod_by_eb(ofs, mtd)) {
		pr_debug("%s: unaligned address\n", __func__);
		ret = -EINVAL;
	}

	/* Length must align on block boundary */
	if (mtd_mod_by_eb(len, mtd)) {
		pr_debug("%s: length not block aligned\n", __func__);
		ret = -EINVAL;
	}

	return ret;
}

static int ram_erase(struct mtd_info *mtd, struct erase_info *instr)
{
	if (check_offs_len(mtd, instr->addr, instr->len))
		return -EINVAL;
	memset((char *)mtd->priv + instr->addr, 0xff, instr->len);
	instr->state = MTD_ERASE_DONE;
	mtd_erase_callback(instr);
	return 0;
}

static int ram_point(struct mtd_info *mtd, loff_t from, size_t len,
		size_t *retlen, void **virt, resource_size_t *phys)
{
	*virt = mtd->priv + from;
	*retlen = len;
	return 0;
}

static int ram_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
{
	return 0;
}

/*
 * Allow NOMMU mmap() to directly map the device (if not NULL)
 * - return the address to which the offset maps
 * - return -ENOSYS to indicate refusal to do the mapping
 */
static unsigned long ram_get_unmapped_area(struct mtd_info *mtd,
					   unsigned long len,
					   unsigned long offset,
					   unsigned long flags)
{
	return (unsigned long) mtd->priv + offset;
}

static int ram_read(struct mtd_info *mtd, loff_t from, size_t len,
		size_t *retlen, u_char *buf)
{
	memcpy(buf, mtd->priv + from, len);
	*retlen = len;
	return 0;
}

static int ram_write(struct mtd_info *mtd, loff_t to, size_t len,
		size_t *retlen, const u_char *buf)
{
	memcpy((char *)mtd->priv + to, buf, len);
	*retlen = len;
	return 0;
}

static void __exit cleanup_mtdram(void)
{
	if (mtd_info) {
		mtd_device_unregister(mtd_info);
		vfree(mtd_info->priv);
		kfree(mtd_info);
	}
}

int mtdram_init_device(struct mtd_info *mtd, void *mapped_address,
		unsigned long size, const char *name)
{
	memset(mtd, 0, sizeof(*mtd));

	/* Setup the MTD structure */
	mtd->name = name;
	mtd->type = MTD_RAM;
	mtd->flags = MTD_CAP_RAM;
	mtd->size = size;
	mtd->writesize = 1;
	mtd->writebufsize = writebuf_size;
	mtd->erasesize = MTDRAM_ERASE_SIZE;
	mtd->priv = mapped_address;

	mtd->owner = THIS_MODULE;
	mtd->_erase = ram_erase;
	mtd->_point = ram_point;
	mtd->_unpoint = ram_unpoint;
	mtd->_get_unmapped_area = ram_get_unmapped_area;
	mtd->_read = ram_read;
	mtd->_write = ram_write;

	if (mtd_device_register(mtd, NULL, 0))
		return -EIO;

	return 0;
}

static int __init init_mtdram(void)
{
	void *addr;
	int err;

	if (!total_size)
		return -EINVAL;

	/* Allocate some memory */
	mtd_info = kmalloc(sizeof(struct mtd_info), GFP_KERNEL);
	if (!mtd_info)
		return -ENOMEM;

	addr = vmalloc(MTDRAM_TOTAL_SIZE);
	if (!addr) {
		kfree(mtd_info);
		mtd_info = NULL;
		return -ENOMEM;
	}
	err = mtdram_init_device(mtd_info, addr, MTDRAM_TOTAL_SIZE, "mtdram test device");
	if (err) {
		vfree(addr);
		kfree(mtd_info);
		mtd_info = NULL;
		return err;
	}
	memset(mtd_info->priv, 0xff, MTDRAM_TOTAL_SIZE);
	return err;
}

module_init(init_mtdram);
module_exit(cleanup_mtdram);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Alexander Larsson <alexl@redhat.com>");
MODULE_DESCRIPTION("Simulated MTD driver for testing");
Commit	Line	Data
1da177e4 LT	1	/*
1da177e4 LT	2	* mtdram - a test mtd device
1da177e4 LT	3	* Author: Alexander Larsson <alex@cendio.se>
	4	*
	5	* Copyright (c) 1999 Alexander Larsson <alex@cendio.se>
c13cbf3b	6	* Copyright (c) 2005 Joern Engel <joern@wh.fh-wedel.de>
1da177e4 LT	7	*
	8	* This code is GPL
	9	*
	10	*/
	11
1da177e4 LT	12	#include <linux/module.h>
	13	#include <linux/slab.h>
	14	#include <linux/ioport.h>
	15	#include <linux/vmalloc.h>
	16	#include <linux/init.h>
1da177e4	17	#include <linux/mtd/mtd.h>
456d9fc9	18	#include <linux/mtd/mtdram.h>
1da177e4	19
1da177e4 LT	20	static unsigned long total_size = CONFIG_MTDRAM_TOTAL_SIZE;
1da177e4 LT	21	static unsigned long erase_size = CONFIG_MTDRAM_ERASE_SIZE;
c67682c5	22	static unsigned long writebuf_size = 64;
1da177e4 LT	23	#define MTDRAM_TOTAL_SIZE (total_size * 1024)
1da177e4 LT	24	#define MTDRAM_ERASE_SIZE (erase_size * 1024)
1da177e4	25
c13cbf3b JE	26	#ifdef MODULE
	27	module_param(total_size, ulong, 0);
	28	MODULE_PARM_DESC(total_size, "Total device size in KiB");
	29	module_param(erase_size, ulong, 0);
	30	MODULE_PARM_DESC(erase_size, "Device erase block size in KiB");
c67682c5 AS	31	module_param(writebuf_size, ulong, 0);
c67682c5 AS	32	MODULE_PARM_DESC(writebuf_size, "Device write buf size in Bytes (Default: 64)");
c13cbf3b	33	#endif
1da177e4 LT	34
	35	// We could store these in the mtd structure, but we only support 1 device..
	36	static struct mtd_info *mtd_info;
	37
ab84fce5 DY	38	static int check_offs_len(struct mtd_info *mtd, loff_t ofs, uint64_t len)
	39	{
	40	int ret = 0;
	41
	42	/* Start address must align on block boundary */
	43	if (mtd_mod_by_eb(ofs, mtd)) {
	44	pr_debug("%s: unaligned address\n", __func__);
	45	ret = -EINVAL;
	46	}
	47
	48	/* Length must align on block boundary */
	49	if (mtd_mod_by_eb(len, mtd)) {
	50	pr_debug("%s: length not block aligned\n", __func__);
	51	ret = -EINVAL;
	52	}
	53
	54	return ret;
	55	}
	56
c13cbf3b	57	static int ram_erase(struct mtd_info mtd, struct erase_info instr)
1da177e4	58	{
ab84fce5 DY	59	if (check_offs_len(mtd, instr->addr, instr->len))
ab84fce5 DY	60	return -EINVAL;
c13cbf3b	61	memset((char *)mtd->priv + instr->addr, 0xff, instr->len);
c13cbf3b JE	62	instr->state = MTD_ERASE_DONE;
c13cbf3b JE	63	mtd_erase_callback(instr);
c13cbf3b	64	return 0;
1da177e4 LT	65	}
1da177e4 LT	66
c13cbf3b	67	static int ram_point(struct mtd_info *mtd, loff_t from, size_t len,
a98889f3	68	size_t retlen, void virt, resource_size_t phys)
1da177e4	69	{
a98889f3	70	*virt = mtd->priv + from;
c13cbf3b JE	71	*retlen = len;
c13cbf3b JE	72	return 0;
1da177e4 LT	73	}
1da177e4 LT	74
5e4e6e3f	75	static int ram_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
1da177e4	76	{
5e4e6e3f	77	return 0;
1da177e4 LT	78	}
1da177e4 LT	79
402d3265 DH	80	/*
	81	* Allow NOMMU mmap() to directly map the device (if not NULL)
	82	* - return the address to which the offset maps
	83	* - return -ENOSYS to indicate refusal to do the mapping
	84	*/
	85	static unsigned long ram_get_unmapped_area(struct mtd_info *mtd,
	86	unsigned long len,
	87	unsigned long offset,
	88	unsigned long flags)
	89	{
	90	return (unsigned long) mtd->priv + offset;
	91	}
	92
1da177e4	93	static int ram_read(struct mtd_info *mtd, loff_t from, size_t len,
c13cbf3b	94	size_t retlen, u_char buf)
1da177e4	95	{
c13cbf3b	96	memcpy(buf, mtd->priv + from, len);
c13cbf3b JE	97	*retlen = len;
c13cbf3b JE	98	return 0;
1da177e4 LT	99	}
	100
	101	static int ram_write(struct mtd_info *mtd, loff_t to, size_t len,
c13cbf3b	102	size_t retlen, const u_char buf)
1da177e4	103	{
c13cbf3b	104	memcpy((char *)mtd->priv + to, buf, len);
c13cbf3b JE	105	*retlen = len;
c13cbf3b JE	106	return 0;
1da177e4 LT	107	}
	108
	109	static void __exit cleanup_mtdram(void)
	110	{
c13cbf3b	111	if (mtd_info) {
ee0e87b1	112	mtd_device_unregister(mtd_info);
f9101210	113	vfree(mtd_info->priv);
c13cbf3b JE	114	kfree(mtd_info);
c13cbf3b JE	115	}
1da177e4 LT	116	}
1da177e4 LT	117
c13cbf3b	118	int mtdram_init_device(struct mtd_info mtd, void mapped_address,
0a8899b3	119	unsigned long size, const char *name)
1da177e4	120	{
c13cbf3b JE	121	memset(mtd, 0, sizeof(*mtd));
	122
	123	/* Setup the MTD structure */
	124	mtd->name = name;
21c8db9e	125	mtd->type = MTD_RAM;
c13cbf3b JE	126	mtd->flags = MTD_CAP_RAM;
c13cbf3b JE	127	mtd->size = size;
783ed81f	128	mtd->writesize = 1;
c67682c5	129	mtd->writebufsize = writebuf_size;
c13cbf3b JE	130	mtd->erasesize = MTDRAM_ERASE_SIZE;
	131	mtd->priv = mapped_address;
	132
	133	mtd->owner = THIS_MODULE;
3c3c10bb AB	134	mtd->_erase = ram_erase;
	135	mtd->_point = ram_point;
	136	mtd->_unpoint = ram_unpoint;
	137	mtd->_get_unmapped_area = ram_get_unmapped_area;
	138	mtd->_read = ram_read;
	139	mtd->_write = ram_write;
c13cbf3b	140
ee0e87b1	141	if (mtd_device_register(mtd, NULL, 0))
c13cbf3b	142	return -EIO;
c13cbf3b JE	143
c13cbf3b JE	144	return 0;
1da177e4	145	}
1da177e4 LT	146
	147	static int __init init_mtdram(void)
	148	{
c13cbf3b JE	149	void *addr;
	150	int err;
	151
	152	if (!total_size)
	153	return -EINVAL;
	154
	155	/* Allocate some memory */
	156	mtd_info = kmalloc(sizeof(struct mtd_info), GFP_KERNEL);
	157	if (!mtd_info)
	158	return -ENOMEM;
	159
	160	addr = vmalloc(MTDRAM_TOTAL_SIZE);
	161	if (!addr) {
	162	kfree(mtd_info);
	163	mtd_info = NULL;
	164	return -ENOMEM;
	165	}
	166	err = mtdram_init_device(mtd_info, addr, MTDRAM_TOTAL_SIZE, "mtdram test device");
	167	if (err) {
	168	vfree(addr);
	169	kfree(mtd_info);
	170	mtd_info = NULL;
	171	return err;
	172	}
	173	memset(mtd_info->priv, 0xff, MTDRAM_TOTAL_SIZE);
	174	return err;
1da177e4	175	}
1da177e4 LT	176
	177	module_init(init_mtdram);
	178	module_exit(cleanup_mtdram);
	179
	180	MODULE_LICENSE("GPL");
	181	MODULE_AUTHOR("Alexander Larsson <alexl@redhat.com>");
	182	MODULE_DESCRIPTION("Simulated MTD driver for testing");