[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 <linux/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];
#ifdef CONFIG_MTD_PARTITIONS
	int			nr_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 || 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]);
		}
	}
	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;
#ifdef CONFIG_MTD_PARTITIONS
	struct mtd_partition *parts;
#endif

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

	info = devm_kzalloc(&dev->dev, 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);

		if (!devm_request_mem_region(&dev->dev,
			dev->resource[i].start,
			dev->resource[i].end - dev->resource[i].start + 1,
			dev->dev.bus_id)) {
			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 = devm_ioremap(&dev->dev, 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, &parts, 0);
	if (err > 0) {
		add_mtd_partitions(info->cmtd, parts, err);
		kfree(parts);
		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_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 CONFIG_MTD_PHYSMAP_COMPAT
	if (err == 0)
		platform_device_register(&physmap_flash);
#endif

	return err;
}

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