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

/**
 * Copyright (c) ????		Jochen Schäuble <psionic@psionic.de>
 * Copyright (c) 2003-2004	Joern Engel <joern@wh.fh-wedel.de>
 *
 * Usage:
 *
 * one commend line parameter per device, each in the form:
 *   phram=<name>,<start>,<len>
 * <name> may be up to 63 characters.
 * <start> and <len> can be octal, decimal or hexadecimal.  If followed
 * by "ki", "Mi" or "Gi", the numbers will be interpreted as kilo, mega or
 * gigabytes.
 *
 * Example:
 *	phram=swap,64Mi,128Mi phram=test,900Mi,1Mi
 */

#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

#include <asm/io.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/slab.h>
#include <linux/mtd/mtd.h>

struct phram_mtd_list {
	struct mtd_info mtd;
	struct list_head list;
};

static LIST_HEAD(phram_list);

static int phram_erase(struct mtd_info *mtd, struct erase_info *instr)
{
	u_char *start = mtd->priv;

	memset(start + instr->addr, 0xff, instr->len);

	/*
	 * This'll catch a few races. Free the thing before returning :)
	 * I don't feel at all ashamed. This kind of thing is possible anyway
	 * with flash, but unlikely.
	 */
	instr->state = MTD_ERASE_DONE;
	mtd_erase_callback(instr);
	return 0;
}

static int phram_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 phram_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
{
	return 0;
}

static int phram_read(struct mtd_info *mtd, loff_t from, size_t len,
		size_t *retlen, u_char *buf)
{
	u_char *start = mtd->priv;

	memcpy(buf, start + from, len);
	*retlen = len;
	return 0;
}

static int phram_write(struct mtd_info *mtd, loff_t to, size_t len,
		size_t *retlen, const u_char *buf)
{
	u_char *start = mtd->priv;

	memcpy(start + to, buf, len);
	*retlen = len;
	return 0;
}

static void unregister_devices(void)
{
	struct phram_mtd_list *this, *safe;

	list_for_each_entry_safe(this, safe, &phram_list, list) {
		mtd_device_unregister(&this->mtd);
		iounmap(this->mtd.priv);
		kfree(this->mtd.name);
		kfree(this);
	}
}

static int register_device(char *name, phys_addr_t start, size_t len)
{
	struct phram_mtd_list *new;
	int ret = -ENOMEM;

	new = kzalloc(sizeof(*new), GFP_KERNEL);
	if (!new)
		goto out0;

	ret = -EIO;
	new->mtd.priv = ioremap(start, len);
	if (!new->mtd.priv) {
		pr_err("ioremap failed\n");
		goto out1;
	}


	new->mtd.name = name;
	new->mtd.size = len;
	new->mtd.flags = MTD_CAP_RAM;
	new->mtd._erase = phram_erase;
	new->mtd._point = phram_point;
	new->mtd._unpoint = phram_unpoint;
	new->mtd._read = phram_read;
	new->mtd._write = phram_write;
	new->mtd.owner = THIS_MODULE;
	new->mtd.type = MTD_RAM;
	new->mtd.erasesize = PAGE_SIZE;
	new->mtd.writesize = 1;

	ret = -EAGAIN;
	if (mtd_device_register(&new->mtd, NULL, 0)) {
		pr_err("Failed to register new device\n");
		goto out2;
	}

	list_add_tail(&new->list, &phram_list);
	return 0;

out2:
	iounmap(new->mtd.priv);
out1:
	kfree(new);
out0:
	return ret;
}

static int parse_num64(uint64_t *num64, char *token)
{
	size_t len;
	int shift = 0;
	int ret;

	len = strlen(token);
	/* By dwmw2 editorial decree, "ki", "Mi" or "Gi" are to be used. */
	if (len > 2) {
		if (token[len - 1] == 'i') {
			switch (token[len - 2]) {
			case 'G':
				shift += 10;
			case 'M':
				shift += 10;
			case 'k':
				shift += 10;
				token[len - 2] = 0;
				break;
			default:
				return -EINVAL;
			}
		}
	}

	ret = kstrtou64(token, 0, num64);
	*num64 <<= shift;

	return ret;
}

static int parse_name(char **pname, const char *token)
{
	size_t len;
	char *name;

	len = strlen(token) + 1;
	if (len > 64)
		return -ENOSPC;

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

	strcpy(name, token);

	*pname = name;
	return 0;
}


static inline void kill_final_newline(char *str)
{
	char *newline = strrchr(str, '\n');
	if (newline && !newline[1])
		*newline = 0;
}


#define parse_err(fmt, args...) do {	\
	pr_err(fmt , ## args);	\
	return 1;		\
} while (0)

#ifndef MODULE
static int phram_init_called;
/*
 * This shall contain the module parameter if any. It is of the form:
 * - phram=<device>,<address>,<size> for module case
 * - phram.phram=<device>,<address>,<size> for built-in case
 * We leave 64 bytes for the device name, 20 for the address and 20 for the
 * size.
 * Example: phram.phram=rootfs,0xa0000000,512Mi
 */
static char phram_paramline[64 + 20 + 20];
#endif

static int phram_setup(const char *val)
{
	char buf[64 + 20 + 20], *str = buf;
	char *token[3];
	char *name;
	uint64_t start;
	uint64_t len;
	int i, ret;

	if (strnlen(val, sizeof(buf)) >= sizeof(buf))
		parse_err("parameter too long\n");

	strcpy(str, val);
	kill_final_newline(str);

	for (i=0; i<3; i++)
		token[i] = strsep(&str, ",");

	if (str)
		parse_err("too many arguments\n");

	if (!token[2])
		parse_err("not enough arguments\n");

	ret = parse_name(&name, token[0]);
	if (ret)
		return ret;

	ret = parse_num64(&start, token[1]);
	if (ret) {
		kfree(name);
		parse_err("illegal start address\n");
	}

	ret = parse_num64(&len, token[2]);
	if (ret) {
		kfree(name);
		parse_err("illegal device length\n");
	}

	ret = register_device(name, start, len);
	if (!ret)
		pr_info("%s device: %#llx at %#llx\n", name, len, start);
	else
		kfree(name);

	return ret;
}

static int phram_param_call(const char *val, struct kernel_param *kp)
{
#ifdef MODULE
	return phram_setup(val);
#else
	/*
	 * If more parameters are later passed in via
	 * /sys/module/phram/parameters/phram
	 * and init_phram() has already been called,
	 * we can parse the argument now.
	 */

	if (phram_init_called)
		return phram_setup(val);

	/*
	 * During early boot stage, we only save the parameters
	 * here. We must parse them later: if the param passed
	 * from kernel boot command line, phram_param_call() is
	 * called so early that it is not possible to resolve
	 * the device (even kmalloc() fails). Defer that work to
	 * phram_setup().
	 */

	if (strlen(val) >= sizeof(phram_paramline))
		return -ENOSPC;
	strcpy(phram_paramline, val);

	return 0;
#endif
}

module_param_call(phram, phram_param_call, NULL, NULL, 000);
MODULE_PARM_DESC(phram, "Memory region to map. \"phram=<name>,<start>,<length>\"");


static int __init init_phram(void)
{
	int ret = 0;

#ifndef MODULE
	if (phram_paramline[0])
		ret = phram_setup(phram_paramline);
	phram_init_called = 1;
#endif

	return ret;
}

static void __exit cleanup_phram(void)
{
	unregister_devices();
}

module_init(init_phram);
module_exit(cleanup_phram);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Joern Engel <joern@wh.fh-wedel.de>");
MODULE_DESCRIPTION("MTD driver for physical RAM");
Commit	Line	Data
1da177e4	1	/**
151e7659	2	* Copyright (c) ???? Jochen Schäuble <psionic@psionic.de>
2b54aaef	3	* Copyright (c) 2003-2004 Joern Engel <joern@wh.fh-wedel.de>
1da177e4 LT	4	*
	5	* Usage:
	6	*
	7	* one commend line parameter per device, each in the form:
	8	* phram=<name>,<start>,<len>
	9	* <name> may be up to 63 characters.
	10	* <start> and <len> can be octal, decimal or hexadecimal. If followed
	11	* by "ki", "Mi" or "Gi", the numbers will be interpreted as kilo, mega or
	12	* gigabytes.
	13	*
	14	* Example:
	15	* phram=swap,64Mi,128Mi phram=test,900Mi,1Mi
1da177e4	16	*/
64da392a	17
1cd844fe	18	#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
64da392a	19
1da177e4 LT	20	#include <asm/io.h>
	21	#include <linux/init.h>
	22	#include <linux/kernel.h>
	23	#include <linux/list.h>
	24	#include <linux/module.h>
	25	#include <linux/moduleparam.h>
4e57b681	26	#include <linux/slab.h>
1da177e4 LT	27	#include <linux/mtd/mtd.h>
1da177e4 LT	28
1da177e4 LT	29	struct phram_mtd_list {
	30	struct mtd_info mtd;
	31	struct list_head list;
	32	};
	33
	34	static LIST_HEAD(phram_list);
	35
1da177e4 LT	36	static int phram_erase(struct mtd_info mtd, struct erase_info instr)
	37	{
	38	u_char *start = mtd->priv;
	39
1da177e4 LT	40	memset(start + instr->addr, 0xff, instr->len);
1da177e4 LT	41
b2a2a84d HF	42	/*
b2a2a84d HF	43	* This'll catch a few races. Free the thing before returning :)
1da177e4 LT	44	* I don't feel at all ashamed. This kind of thing is possible anyway
	45	* with flash, but unlikely.
	46	*/
1da177e4	47	instr->state = MTD_ERASE_DONE;
1da177e4	48	mtd_erase_callback(instr);
1da177e4 LT	49	return 0;
	50	}
	51
	52	static int phram_point(struct mtd_info *mtd, loff_t from, size_t len,
a98889f3	53	size_t retlen, void virt, resource_size_t phys)
1da177e4	54	{
a98889f3	55	*virt = mtd->priv + from;
1da177e4 LT	56	*retlen = len;
	57	return 0;
	58	}
	59
5e4e6e3f	60	static int phram_unpoint(struct mtd_info *mtd, loff_t from, size_t len)
1da177e4	61	{
5e4e6e3f	62	return 0;
1da177e4 LT	63	}
	64
	65	static int phram_read(struct mtd_info *mtd, loff_t from, size_t len,
	66	size_t retlen, u_char buf)
	67	{
	68	u_char *start = mtd->priv;
	69
1da177e4	70	memcpy(buf, start + from, len);
1da177e4 LT	71	*retlen = len;
	72	return 0;
	73	}
	74
	75	static int phram_write(struct mtd_info *mtd, loff_t to, size_t len,
	76	size_t retlen, const u_char buf)
	77	{
	78	u_char *start = mtd->priv;
	79
1da177e4	80	memcpy(start + to, buf, len);
1da177e4 LT	81	*retlen = len;
	82	return 0;
	83	}
	84
1da177e4 LT	85	static void unregister_devices(void)
1da177e4 LT	86	{
d30f11d2	87	struct phram_mtd_list this, safe;
1da177e4	88
d30f11d2	89	list_for_each_entry_safe(this, safe, &phram_list, list) {
ee0e87b1	90	mtd_device_unregister(&this->mtd);
1da177e4	91	iounmap(this->mtd.priv);
f17f12ce	92	kfree(this->mtd.name);
1da177e4 LT	93	kfree(this);
	94	}
	95	}
	96
2a46f835	97	static int register_device(char *name, phys_addr_t start, size_t len)
1da177e4 LT	98	{
	99	struct phram_mtd_list *new;
	100	int ret = -ENOMEM;
	101
95b93a0c	102	new = kzalloc(sizeof(*new), GFP_KERNEL);
1da177e4 LT	103	if (!new)
	104	goto out0;
	105
1da177e4 LT	106	ret = -EIO;
	107	new->mtd.priv = ioremap(start, len);
	108	if (!new->mtd.priv) {
64da392a	109	pr_err("ioremap failed\n");
1da177e4 LT	110	goto out1;
	111	}
	112
	113
	114	new->mtd.name = name;
	115	new->mtd.size = len;
a6c591ed	116	new->mtd.flags = MTD_CAP_RAM;
3c3c10bb AB	117	new->mtd._erase = phram_erase;
	118	new->mtd._point = phram_point;
	119	new->mtd._unpoint = phram_unpoint;
	120	new->mtd._read = phram_read;
	121	new->mtd._write = phram_write;
1da177e4	122	new->mtd.owner = THIS_MODULE;
21c8db9e	123	new->mtd.type = MTD_RAM;
663259a4	124	new->mtd.erasesize = PAGE_SIZE;
17ffc7ba	125	new->mtd.writesize = 1;
1da177e4 LT	126
1da177e4 LT	127	ret = -EAGAIN;
ee0e87b1	128	if (mtd_device_register(&new->mtd, NULL, 0)) {
64da392a	129	pr_err("Failed to register new device\n");
1da177e4 LT	130	goto out2;
	131	}
	132
	133	list_add_tail(&new->list, &phram_list);
e5580fbe	134	return 0;
1da177e4 LT	135
	136	out2:
	137	iounmap(new->mtd.priv);
	138	out1:
	139	kfree(new);
	140	out0:
	141	return ret;
	142	}
	143
2a46f835	144	static int parse_num64(uint64_t num64, char token)
1da177e4	145	{
2a46f835 AS	146	size_t len;
	147	int shift = 0;
	148	int ret;
	149
	150	len = strlen(token);
1da177e4	151	/* By dwmw2 editorial decree, "ki", "Mi" or "Gi" are to be used. */
2a46f835 AS	152	if (len > 2) {
	153	if (token[len - 1] == 'i') {
	154	switch (token[len - 2]) {
	155	case 'G':
	156	shift += 10;
	157	case 'M':
	158	shift += 10;
	159	case 'k':
	160	shift += 10;
	161	token[len - 2] = 0;
	162	break;
	163	default:
	164	return -EINVAL;
	165	}
	166	}
1da177e4	167	}
1da177e4	168
2a46f835 AS	169	ret = kstrtou64(token, 0, num64);
2a46f835 AS	170	*num64 <<= shift;
1da177e4	171
2a46f835	172	return ret;
1da177e4 LT	173	}
	174
	175	static int parse_name(char *pname, const char token)
	176	{
	177	size_t len;
	178	char *name;
	179
	180	len = strlen(token) + 1;
	181	if (len > 64)
	182	return -ENOSPC;
	183
	184	name = kmalloc(len, GFP_KERNEL);
	185	if (!name)
	186	return -ENOMEM;
	187
	188	strcpy(name, token);
	189
	190	*pname = name;
	191	return 0;
	192	}
	193
663259a4 JE	194
	195	static inline void kill_final_newline(char *str)
	196	{
	197	char *newline = strrchr(str, '\n');
	198	if (newline && !newline[1])
	199	*newline = 0;
	200	}
	201
	202
1da177e4	203	#define parse_err(fmt, args...) do { \
64da392a MF	204	pr_err(fmt , ## args); \
64da392a MF	205	return 1; \
1da177e4 LT	206	} while (0)
1da177e4 LT	207
6f6b9fee AS	208	#ifndef MODULE
6f6b9fee AS	209	static int phram_init_called;
b2a2a84d HF	210	/*
	211	* This shall contain the module parameter if any. It is of the form:
	212	* - phram=<device>,<address>,<size> for module case
	213	* - phram.phram=<device>,<address>,<size> for built-in case
2a46f835	214	* We leave 64 bytes for the device name, 20 for the address and 20 for the
b2a2a84d HF	215	* size.
	216	* Example: phram.phram=rootfs,0xa0000000,512Mi
	217	*/
6f6b9fee AS	218	static char phram_paramline[64 + 20 + 20];
6f6b9fee AS	219	#endif
b2a2a84d	220
6f6b9fee	221	static int phram_setup(const char *val)
1da177e4	222	{
2a46f835	223	char buf[64 + 20 + 20], *str = buf;
1da177e4 LT	224	char *token[3];
1da177e4 LT	225	char *name;
2a46f835 AS	226	uint64_t start;
2a46f835 AS	227	uint64_t len;
1da177e4 LT	228	int i, ret;
	229
	230	if (strnlen(val, sizeof(buf)) >= sizeof(buf))
	231	parse_err("parameter too long\n");
	232
	233	strcpy(str, val);
663259a4	234	kill_final_newline(str);
1da177e4 LT	235
	236	for (i=0; i<3; i++)
	237	token[i] = strsep(&str, ",");
	238
	239	if (str)
	240	parse_err("too many arguments\n");
	241
	242	if (!token[2])
	243	parse_err("not enough arguments\n");
	244
	245	ret = parse_name(&name, token[0]);
1da177e4	246	if (ret)
64da392a	247	return ret;
1da177e4	248
2a46f835	249	ret = parse_num64(&start, token[1]);
4f678a58 JJ	250	if (ret) {
4f678a58 JJ	251	kfree(name);
1da177e4	252	parse_err("illegal start address\n");
4f678a58	253	}
1da177e4	254
2a46f835	255	ret = parse_num64(&len, token[2]);
4f678a58 JJ	256	if (ret) {
4f678a58 JJ	257	kfree(name);
1da177e4	258	parse_err("illegal device length\n");
4f678a58	259	}
1da177e4	260
64da392a MF	261	ret = register_device(name, start, len);
64da392a MF	262	if (!ret)
2a46f835	263	pr_info("%s device: %#llx at %#llx\n", name, len, start);
f17f12ce MK	264	else
f17f12ce MK	265	kfree(name);
1da177e4	266
64da392a	267	return ret;
1da177e4 LT	268	}
1da177e4 LT	269
6f6b9fee	270	static int phram_param_call(const char val, struct kernel_param kp)
b2a2a84d	271	{
6f6b9fee AS	272	#ifdef MODULE
	273	return phram_setup(val);
	274	#else
b2a2a84d	275	/*
6f6b9fee AS	276	* If more parameters are later passed in via
	277	* /sys/module/phram/parameters/phram
	278	* and init_phram() has already been called,
	279	* we can parse the argument now.
b2a2a84d	280	*/
6f6b9fee AS	281
	282	if (phram_init_called)
	283	return phram_setup(val);
	284
	285	/*
	286	* During early boot stage, we only save the parameters
	287	* here. We must parse them later: if the param passed
	288	* from kernel boot command line, phram_param_call() is
	289	* called so early that it is not possible to resolve
	290	* the device (even kmalloc() fails). Defer that work to
	291	* phram_setup().
	292	*/
	293
b2a2a84d HF	294	if (strlen(val) >= sizeof(phram_paramline))
	295	return -ENOSPC;
	296	strcpy(phram_paramline, val);
	297
	298	return 0;
6f6b9fee	299	#endif
b2a2a84d HF	300	}
	301
	302	module_param_call(phram, phram_param_call, NULL, NULL, 000);
f72561cf	303	MODULE_PARM_DESC(phram, "Memory region to map. \"phram=<name>,<start>,<length>\"");
1da177e4 LT	304
	305
	306	static int __init init_phram(void)
	307	{
6f6b9fee AS	308	int ret = 0;
	309
	310	#ifndef MODULE
b2a2a84d	311	if (phram_paramline[0])
6f6b9fee AS	312	ret = phram_setup(phram_paramline);
	313	phram_init_called = 1;
	314	#endif
b2a2a84d	315
6f6b9fee	316	return ret;
1da177e4 LT	317	}
	318
	319	static void __exit cleanup_phram(void)
	320	{
	321	unregister_devices();
	322	}
	323
	324	module_init(init_phram);
	325	module_exit(cleanup_phram);
	326
	327	MODULE_LICENSE("GPL");
2b54aaef	328	MODULE_AUTHOR("Joern Engel <joern@wh.fh-wedel.de>");
1da177e4	329	MODULE_DESCRIPTION("MTD driver for physical RAM");