[deliverable/linux.git] / drivers / mtd / maps / physmap.c

/*
 * Normal mappings of chips in physical memory
 *
 * Copyright (C) 2003 MontaVista Software Inc.
 * Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
 *
 * 031022 - [jsun] add run-time configure and partition setup
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/slab.h>
#include <linux/device.h>
#include <linux/platform_device.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>
#include <linux/mtd/physmap.h>
#include <linux/mtd/concat.h>
#include <asm/io.h>

#define MAX_RESOURCES		4

struct physmap_flash_info {
	struct mtd_info		*mtd[MAX_RESOURCES];
	struct mtd_info		*cmtd;
	struct map_info		map[MAX_RESOURCES];
	struct resource		*res;
#ifdef CONFIG_MTD_PARTITIONS
	int			nr_parts;
	struct mtd_partition	*parts;
#endif
};

static int physmap_flash_remove(struct platform_device *dev)
{
	struct physmap_flash_info *info;
	struct physmap_flash_data *physmap_data;
	int i;

	info = platform_get_drvdata(dev);
	if (info == NULL)
		return 0;
	platform_set_drvdata(dev, NULL);

	physmap_data = dev->dev.platform_data;

#ifdef CONFIG_MTD_CONCAT
	if (info->cmtd != info->mtd[0]) {
		del_mtd_device(info->cmtd);
		mtd_concat_destroy(info->cmtd);
	}
#endif

	for (i = 0; i < MAX_RESOURCES; i++) {
		if (info->mtd[i] != NULL) {
#ifdef CONFIG_MTD_PARTITIONS
			if (info->nr_parts) {
				del_mtd_partitions(info->mtd[i]);
				kfree(info->parts);
			} else if (physmap_data->nr_parts) {
				del_mtd_partitions(info->mtd[i]);
			} else {
				del_mtd_device(info->mtd[i]);
			}
#else
			del_mtd_device(info->mtd[i]);
#endif
			map_destroy(info->mtd[i]);
		}

		if (info->map[i].virt != NULL)
			iounmap(info->map[i].virt);
	}

	if (info->res != NULL) {
		release_resource(info->res);
		kfree(info->res);
	}

	return 0;
}

static const char *rom_probe_types[] = { "cfi_probe", "jedec_probe", "map_rom", NULL };
#ifdef CONFIG_MTD_PARTITIONS
static const char *part_probe_types[] = { "cmdlinepart", "RedBoot", NULL };
#endif

static int physmap_flash_probe(struct platform_device *dev)
{
	struct physmap_flash_data *physmap_data;
	struct physmap_flash_info *info;
	const char **probe_type;
	int err = 0;
	int i;
	int devices_found = 0;

	physmap_data = dev->dev.platform_data;
	if (physmap_data == NULL)
		return -ENODEV;

	info = kzalloc(sizeof(struct physmap_flash_info), GFP_KERNEL);
	if (info == NULL) {
		err = -ENOMEM;
		goto err_out;
	}

	platform_set_drvdata(dev, info);

	for (i = 0; i < dev->num_resources; i++) {
		printk(KERN_NOTICE "physmap platform flash device: %.8llx at %.8llx\n",
		       (unsigned long long)(dev->resource[i].end - dev->resource[i].start + 1),
		       (unsigned long long)dev->resource[i].start);

		info->res = request_mem_region(dev->resource[i].start,
					       dev->resource[i].end - dev->resource[i].start + 1,
					       dev->dev.bus_id);
		if (info->res == NULL) {
			dev_err(&dev->dev, "Could not reserve memory region\n");
			err = -ENOMEM;
			goto err_out;
		}

		info->map[i].name = dev->dev.bus_id;
		info->map[i].phys = dev->resource[i].start;
		info->map[i].size = dev->resource[i].end - dev->resource[i].start + 1;
		info->map[i].bankwidth = physmap_data->width;
		info->map[i].set_vpp = physmap_data->set_vpp;

		info->map[i].virt = ioremap(info->map[i].phys, info->map[i].size);
		if (info->map[i].virt == NULL) {
			dev_err(&dev->dev, "Failed to ioremap flash region\n");
			err = EIO;
			goto err_out;
		}

		simple_map_init(&info->map[i]);

		probe_type = rom_probe_types;
		for (; info->mtd[i] == NULL && *probe_type != NULL; probe_type++)
			info->mtd[i] = do_map_probe(*probe_type, &info->map[i]);
		if (info->mtd[i] == NULL) {
			dev_err(&dev->dev, "map_probe failed\n");
			err = -ENXIO;
			goto err_out;
		} else {
			devices_found++;
		}
		info->mtd[i]->owner = THIS_MODULE;
	}

	if (devices_found == 1) {
		info->cmtd = info->mtd[0];
	} else if (devices_found > 1) {
		/*
		 * We detected multiple devices. Concatenate them together.
		 */
#ifdef CONFIG_MTD_CONCAT
		info->cmtd = mtd_concat_create(info->mtd, devices_found, dev->dev.bus_id);
		if (info->cmtd == NULL)
			err = -ENXIO;
#else
		printk(KERN_ERR "physmap-flash: multiple devices "
		       "found but MTD concat support disabled.\n");
		err = -ENXIO;
#endif
	}
	if (err)
		goto err_out;

#ifdef CONFIG_MTD_PARTITIONS
	err = parse_mtd_partitions(info->cmtd, part_probe_types, &info->parts, 0);
	if (err > 0) {
		add_mtd_partitions(info->cmtd, info->parts, err);
		return 0;
	}

	if (physmap_data->nr_parts) {
		printk(KERN_NOTICE "Using physmap partition information\n");
		add_mtd_partitions(info->cmtd, physmap_data->parts,
				   physmap_data->nr_parts);
		return 0;
	}
#endif

	add_mtd_device(info->cmtd);
	return 0;

err_out:
	physmap_flash_remove(dev);
	return err;
}

#ifdef CONFIG_PM
static int physmap_flash_suspend(struct platform_device *dev, pm_message_t state)
{
	struct physmap_flash_info *info = platform_get_drvdata(dev);
	int ret = 0;
	int i;

	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
		if (info->mtd[i]->suspend) {
			ret = info->mtd[i]->suspend(info->mtd[i]);
			if (ret)
				goto fail;
		}

	return 0;
fail:
	for (--i; i >= 0; --i)
		if (info->mtd[i]->suspend) {
			BUG_ON(!info->mtd[i]->resume);
			info->mtd[i]->resume(info->mtd[i]);
		}

	return ret;
}

static int physmap_flash_resume(struct platform_device *dev)
{
	struct physmap_flash_info *info = platform_get_drvdata(dev);
	int i;

	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
		if (info->mtd[i]->resume)
			info->mtd[i]->resume(info->mtd[i]);

	return 0;
}

static void physmap_flash_shutdown(struct platform_device *dev)
{
	struct physmap_flash_info *info = platform_get_drvdata(dev);
	int i;

	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
		if (info->mtd[i]->suspend && info->mtd[i]->resume)
			if (info->mtd[i]->suspend(info->mtd[i]) == 0)
				info->mtd[i]->resume(info->mtd[i]);
}
#else
#define physmap_flash_suspend NULL
#define physmap_flash_resume NULL
#define physmap_flash_shutdown NULL
#endif

static struct platform_driver physmap_flash_driver = {
	.probe		= physmap_flash_probe,
	.remove		= physmap_flash_remove,
	.suspend	= physmap_flash_suspend,
	.resume		= physmap_flash_resume,
	.shutdown	= physmap_flash_shutdown,
	.driver		= {
		.name	= "physmap-flash",
		.owner	= THIS_MODULE,
	},
};


#ifdef CONFIG_MTD_PHYSMAP_LEN
#if CONFIG_MTD_PHYSMAP_LEN != 0
#warning using PHYSMAP compat code
#define PHYSMAP_COMPAT
#endif
#endif

#ifdef PHYSMAP_COMPAT
static struct physmap_flash_data physmap_flash_data = {
	.width		= CONFIG_MTD_PHYSMAP_BANKWIDTH,
};

static struct resource physmap_flash_resource = {
	.start		= CONFIG_MTD_PHYSMAP_START,
	.end		= CONFIG_MTD_PHYSMAP_START + CONFIG_MTD_PHYSMAP_LEN - 1,
	.flags		= IORESOURCE_MEM,
};

static struct platform_device physmap_flash = {
	.name		= "physmap-flash",
	.id		= 0,
	.dev		= {
		.platform_data	= &physmap_flash_data,
	},
	.num_resources	= 1,
	.resource	= &physmap_flash_resource,
};

void physmap_configure(unsigned long addr, unsigned long size,
		int bankwidth, void (*set_vpp)(struct map_info *, int))
{
	physmap_flash_resource.start = addr;
	physmap_flash_resource.end = addr + size - 1;
	physmap_flash_data.width = bankwidth;
	physmap_flash_data.set_vpp = set_vpp;
}

#ifdef CONFIG_MTD_PARTITIONS
void physmap_set_partitions(struct mtd_partition *parts, int num_parts)
{
	physmap_flash_data.nr_parts = num_parts;
	physmap_flash_data.parts = parts;
}
#endif
#endif

static int __init physmap_init(void)
{
	int err;

	err = platform_driver_register(&physmap_flash_driver);
#ifdef PHYSMAP_COMPAT
	if (err == 0)
		platform_device_register(&physmap_flash);
#endif

	return err;
}

static void __exit physmap_exit(void)
{
#ifdef PHYSMAP_COMPAT
	platform_device_unregister(&physmap_flash);
#endif
	platform_driver_unregister(&physmap_flash_driver);
}

module_init(physmap_init);
module_exit(physmap_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
MODULE_DESCRIPTION("Generic configurable MTD map driver");

/* legacy platform drivers can't hotplug or coldplg */
#ifndef PHYSMAP_COMPAT
/* work with hotplug and coldplug */
MODULE_ALIAS("platform:physmap-flash");
#endif
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	2	* Normal mappings of chips in physical memory
	3	*
	4	* Copyright (C) 2003 MontaVista Software Inc.
	5	* Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
	6	*
	7	* 031022 - [jsun] add run-time configure and partition setup
	8	*/
	9
	10	#include <linux/module.h>
	11	#include <linux/types.h>
	12	#include <linux/kernel.h>
	13	#include <linux/init.h>
	14	#include <linux/slab.h>
73566edf LB	15	#include <linux/device.h>
73566edf LB	16	#include <linux/platform_device.h>
1da177e4 LT	17	#include <linux/mtd/mtd.h>
1da177e4 LT	18	#include <linux/mtd/map.h>
1da177e4	19	#include <linux/mtd/partitions.h>
2b9175c1	20	#include <linux/mtd/physmap.h>
df66e716	21	#include <linux/mtd/concat.h>
73566edf	22	#include <asm/io.h>
1da177e4	23
df66e716 SR	24	#define MAX_RESOURCES 4
df66e716 SR	25
73566edf	26	struct physmap_flash_info {
df66e716 SR	27	struct mtd_info *mtd[MAX_RESOURCES];
	28	struct mtd_info *cmtd;
	29	struct map_info map[MAX_RESOURCES];
73566edf LB	30	struct resource *res;
	31	#ifdef CONFIG_MTD_PARTITIONS
	32	int nr_parts;
	33	struct mtd_partition *parts;
	34	#endif
1da177e4 LT	35	};
1da177e4 LT	36
73566edf LB	37	static int physmap_flash_remove(struct platform_device *dev)
	38	{
	39	struct physmap_flash_info *info;
	40	struct physmap_flash_data *physmap_data;
df66e716	41	int i;
73566edf LB	42
	43	info = platform_get_drvdata(dev);
	44	if (info == NULL)
	45	return 0;
	46	platform_set_drvdata(dev, NULL);
	47
	48	physmap_data = dev->dev.platform_data;
	49
df66e716 SR	50	#ifdef CONFIG_MTD_CONCAT
	51	if (info->cmtd != info->mtd[0]) {
	52	del_mtd_device(info->cmtd);
	53	mtd_concat_destroy(info->cmtd);
	54	}
	55	#endif
	56
	57	for (i = 0; i < MAX_RESOURCES; i++) {
	58	if (info->mtd[i] != NULL) {
1da177e4	59	#ifdef CONFIG_MTD_PARTITIONS
df66e716 SR	60	if (info->nr_parts) {
	61	del_mtd_partitions(info->mtd[i]);
	62	kfree(info->parts);
	63	} else if (physmap_data->nr_parts) {
	64	del_mtd_partitions(info->mtd[i]);
	65	} else {
	66	del_mtd_device(info->mtd[i]);
	67	}
73566edf	68	#else
df66e716	69	del_mtd_device(info->mtd[i]);
73566edf	70	#endif
df66e716 SR	71	map_destroy(info->mtd[i]);
df66e716 SR	72	}
1da177e4	73
df66e716 SR	74	if (info->map[i].virt != NULL)
	75	iounmap(info->map[i].virt);
	76	}
1da177e4	77
73566edf LB	78	if (info->res != NULL) {
	79	release_resource(info->res);
	80	kfree(info->res);
	81	}
1da177e4	82
73566edf	83	return 0;
1da177e4	84	}
1da177e4	85
73566edf LB	86	static const char *rom_probe_types[] = { "cfi_probe", "jedec_probe", "map_rom", NULL };
	87	#ifdef CONFIG_MTD_PARTITIONS
	88	static const char *part_probe_types[] = { "cmdlinepart", "RedBoot", NULL };
	89	#endif
	90
	91	static int physmap_flash_probe(struct platform_device *dev)
1da177e4	92	{
73566edf LB	93	struct physmap_flash_data *physmap_data;
	94	struct physmap_flash_info *info;
	95	const char **probe_type;
df66e716 SR	96	int err = 0;
	97	int i;
	98	int devices_found = 0;
73566edf LB	99
	100	physmap_data = dev->dev.platform_data;
	101	if (physmap_data == NULL)
	102	return -ENODEV;
	103
95b93a0c	104	info = kzalloc(sizeof(struct physmap_flash_info), GFP_KERNEL);
73566edf LB	105	if (info == NULL) {
	106	err = -ENOMEM;
	107	goto err_out;
	108	}
1da177e4	109
73566edf	110	platform_set_drvdata(dev, info);
1da177e4	111
df66e716 SR	112	for (i = 0; i < dev->num_resources; i++) {
	113	printk(KERN_NOTICE "physmap platform flash device: %.8llx at %.8llx\n",
	114	(unsigned long long)(dev->resource[i].end - dev->resource[i].start + 1),
	115	(unsigned long long)dev->resource[i].start);
	116
	117	info->res = request_mem_region(dev->resource[i].start,
	118	dev->resource[i].end - dev->resource[i].start + 1,
	119	dev->dev.bus_id);
	120	if (info->res == NULL) {
	121	dev_err(&dev->dev, "Could not reserve memory region\n");
	122	err = -ENOMEM;
	123	goto err_out;
	124	}
1da177e4	125
df66e716 SR	126	info->map[i].name = dev->dev.bus_id;
	127	info->map[i].phys = dev->resource[i].start;
	128	info->map[i].size = dev->resource[i].end - dev->resource[i].start + 1;
	129	info->map[i].bankwidth = physmap_data->width;
	130	info->map[i].set_vpp = physmap_data->set_vpp;
	131
	132	info->map[i].virt = ioremap(info->map[i].phys, info->map[i].size);
	133	if (info->map[i].virt == NULL) {
	134	dev_err(&dev->dev, "Failed to ioremap flash region\n");
	135	err = EIO;
	136	goto err_out;
	137	}
73566edf	138
df66e716	139	simple_map_init(&info->map[i]);
1da177e4	140
df66e716 SR	141	probe_type = rom_probe_types;
	142	for (; info->mtd[i] == NULL && *probe_type != NULL; probe_type++)
	143	info->mtd[i] = do_map_probe(*probe_type, &info->map[i]);
	144	if (info->mtd[i] == NULL) {
	145	dev_err(&dev->dev, "map_probe failed\n");
	146	err = -ENXIO;
	147	goto err_out;
	148	} else {
	149	devices_found++;
	150	}
	151	info->mtd[i]->owner = THIS_MODULE;
	152	}
73566edf	153
df66e716 SR	154	if (devices_found == 1) {
	155	info->cmtd = info->mtd[0];
	156	} else if (devices_found > 1) {
	157	/*
	158	* We detected multiple devices. Concatenate them together.
	159	*/
	160	#ifdef CONFIG_MTD_CONCAT
	161	info->cmtd = mtd_concat_create(info->mtd, devices_found, dev->dev.bus_id);
	162	if (info->cmtd == NULL)
	163	err = -ENXIO;
	164	#else
	165	printk(KERN_ERR "physmap-flash: multiple devices "
	166	"found but MTD concat support disabled.\n");
73566edf	167	err = -ENXIO;
df66e716	168	#endif
1da177e4	169	}
df66e716 SR	170	if (err)
df66e716 SR	171	goto err_out;
1da177e4 LT	172
1da177e4 LT	173	#ifdef CONFIG_MTD_PARTITIONS
df66e716	174	err = parse_mtd_partitions(info->cmtd, part_probe_types, &info->parts, 0);
73566edf	175	if (err > 0) {
df66e716	176	add_mtd_partitions(info->cmtd, info->parts, err);
73566edf LB	177	return 0;
73566edf LB	178	}
1da177e4	179
73566edf LB	180	if (physmap_data->nr_parts) {
73566edf LB	181	printk(KERN_NOTICE "Using physmap partition information\n");
df66e716 SR	182	add_mtd_partitions(info->cmtd, physmap_data->parts,
df66e716 SR	183	physmap_data->nr_parts);
73566edf LB	184	return 0;
	185	}
	186	#endif
	187
df66e716	188	add_mtd_device(info->cmtd);
73566edf LB	189	return 0;
	190
	191	err_out:
	192	physmap_flash_remove(dev);
	193	return err;
	194	}
	195
17c2dae3 LB	196	#ifdef CONFIG_PM
	197	static int physmap_flash_suspend(struct platform_device *dev, pm_message_t state)
	198	{
	199	struct physmap_flash_info *info = platform_get_drvdata(dev);
	200	int ret = 0;
df66e716	201	int i;
17c2dae3	202
4a5691c0	203	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
4b5e33a7 UKK	204	if (info->mtd[i]->suspend) {
	205	ret = info->mtd[i]->suspend(info->mtd[i]);
	206	if (ret)
	207	goto fail;
	208	}
	209
	210	return 0;
	211	fail:
	212	for (--i; i >= 0; --i)
	213	if (info->mtd[i]->suspend) {
	214	BUG_ON(!info->mtd[i]->resume);
	215	info->mtd[i]->resume(info->mtd[i]);
	216	}
17c2dae3 LB	217
	218	return ret;
	219	}
	220
	221	static int physmap_flash_resume(struct platform_device *dev)
	222	{
	223	struct physmap_flash_info *info = platform_get_drvdata(dev);
df66e716 SR	224	int i;
df66e716 SR	225
4a5691c0	226	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
7b249191 RJ	227	if (info->mtd[i]->resume)
7b249191 RJ	228	info->mtd[i]->resume(info->mtd[i]);
4a5691c0	229
17c2dae3 LB	230	return 0;
	231	}
	232
	233	static void physmap_flash_shutdown(struct platform_device *dev)
	234	{
	235	struct physmap_flash_info *info = platform_get_drvdata(dev);
df66e716 SR	236	int i;
df66e716 SR	237
4a5691c0	238	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
7b249191 RJ	239	if (info->mtd[i]->suspend && info->mtd[i]->resume)
	240	if (info->mtd[i]->suspend(info->mtd[i]) == 0)
	241	info->mtd[i]->resume(info->mtd[i]);
17c2dae3	242	}
d5476689	243	#else
	244	#define physmap_flash_suspend NULL
	245	#define physmap_flash_resume NULL
	246	#define physmap_flash_shutdown NULL
17c2dae3 LB	247	#endif
17c2dae3 LB	248
73566edf LB	249	static struct platform_driver physmap_flash_driver = {
	250	.probe = physmap_flash_probe,
	251	.remove = physmap_flash_remove,
17c2dae3 LB	252	.suspend = physmap_flash_suspend,
	253	.resume = physmap_flash_resume,
	254	.shutdown = physmap_flash_shutdown,
73566edf LB	255	.driver = {
73566edf LB	256	.name = "physmap-flash",
41d867c9	257	.owner = THIS_MODULE,
73566edf LB	258	},
73566edf LB	259	};
1da177e4	260
1da177e4	261
73566edf LB	262	#ifdef CONFIG_MTD_PHYSMAP_LEN
	263	#if CONFIG_MTD_PHYSMAP_LEN != 0
	264	#warning using PHYSMAP compat code
	265	#define PHYSMAP_COMPAT
	266	#endif
1da177e4	267	#endif
1da177e4	268
73566edf LB	269	#ifdef PHYSMAP_COMPAT
	270	static struct physmap_flash_data physmap_flash_data = {
	271	.width = CONFIG_MTD_PHYSMAP_BANKWIDTH,
	272	};
1da177e4	273
73566edf LB	274	static struct resource physmap_flash_resource = {
73566edf LB	275	.start = CONFIG_MTD_PHYSMAP_START,
6d4f8224	276	.end = CONFIG_MTD_PHYSMAP_START + CONFIG_MTD_PHYSMAP_LEN - 1,
73566edf LB	277	.flags = IORESOURCE_MEM,
73566edf LB	278	};
1da177e4	279
73566edf LB	280	static struct platform_device physmap_flash = {
	281	.name = "physmap-flash",
	282	.id = 0,
	283	.dev = {
	284	.platform_data = &physmap_flash_data,
	285	},
	286	.num_resources = 1,
	287	.resource = &physmap_flash_resource,
	288	};
	289
	290	void physmap_configure(unsigned long addr, unsigned long size,
	291	int bankwidth, void (set_vpp)(struct map_info , int))
1da177e4	292	{
73566edf LB	293	physmap_flash_resource.start = addr;
	294	physmap_flash_resource.end = addr + size - 1;
	295	physmap_flash_data.width = bankwidth;
	296	physmap_flash_data.set_vpp = set_vpp;
	297	}
	298
1da177e4	299	#ifdef CONFIG_MTD_PARTITIONS
73566edf LB	300	void physmap_set_partitions(struct mtd_partition *parts, int num_parts)
	301	{
	302	physmap_flash_data.nr_parts = num_parts;
	303	physmap_flash_data.parts = parts;
	304	}
	305	#endif
1da177e4	306	#endif
1da177e4	307
73566edf LB	308	static int __init physmap_init(void)
	309	{
	310	int err;
	311
	312	err = platform_driver_register(&physmap_flash_driver);
	313	#ifdef PHYSMAP_COMPAT
	314	if (err == 0)
	315	platform_device_register(&physmap_flash);
	316	#endif
	317
	318	return err;
1da177e4 LT	319	}
1da177e4 LT	320
73566edf LB	321	static void __exit physmap_exit(void)
	322	{
	323	#ifdef PHYSMAP_COMPAT
	324	platform_device_unregister(&physmap_flash);
	325	#endif
	326	platform_driver_unregister(&physmap_flash_driver);
	327	}
1da177e4	328
73566edf LB	329	module_init(physmap_init);
73566edf LB	330	module_exit(physmap_exit);
1da177e4 LT	331
	332	MODULE_LICENSE("GPL");
	333	MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
	334	MODULE_DESCRIPTION("Generic configurable MTD map driver");
41d867c9 KS	335
	336	/* legacy platform drivers can't hotplug or coldplg */
	337	#ifndef PHYSMAP_COMPAT
	338	/* work with hotplug and coldplug */
	339	MODULE_ALIAS("platform:physmap-flash");
	340	#endif
	341