[linux-2.6-block.git] / drivers / mtd / maps / plat-ram.c

/* drivers/mtd/maps/plat-ram.c
 *
 * (c) 2004-2005 Simtec Electronics
 *	http://www.simtec.co.uk/products/SWLINUX/
 *	Ben Dooks <ben@simtec.co.uk>
 *
 * Generic platfrom device based RAM map
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/ioport.h>
#include <linux/device.h>
#include <linux/slab.h>
#include <linux/platform_device.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>
#include <linux/mtd/plat-ram.h>

#include <asm/io.h>

/* private structure for each mtd platform ram device created */

struct platram_info {
	struct device		*dev;
	struct mtd_info		*mtd;
	struct map_info		 map;
	struct mtd_partition	*partitions;
	bool			free_partitions;
	struct resource		*area;
	struct platdata_mtd_ram	*pdata;
};

/* to_platram_info()
 *
 * device private data to struct platram_info conversion
*/

static inline struct platram_info *to_platram_info(struct platform_device *dev)
{
	return (struct platram_info *)platform_get_drvdata(dev);
}

/* platram_setrw
 *
 * call the platform device's set rw/ro control
 *
 * to = 0 => read-only
 *    = 1 => read-write
*/

static inline void platram_setrw(struct platram_info *info, int to)
{
	if (info->pdata == NULL)
		return;

	if (info->pdata->set_rw != NULL)
		(info->pdata->set_rw)(info->dev, to);
}

/* platram_remove
 *
 * called to remove the device from the driver's control
*/

static int platram_remove(struct platform_device *pdev)
{
	struct platram_info *info = to_platram_info(pdev);

	platform_set_drvdata(pdev, NULL);

	dev_dbg(&pdev->dev, "removing device\n");

	if (info == NULL)
		return 0;

	if (info->mtd) {
#ifdef CONFIG_MTD_PARTITIONS
		if (info->partitions) {
			del_mtd_partitions(info->mtd);
			if (info->free_partitions)
				kfree(info->partitions);
		}
#endif
		del_mtd_device(info->mtd);
		map_destroy(info->mtd);
	}

	/* ensure ram is left read-only */

	platram_setrw(info, PLATRAM_RO);

	/* release resources */

	if (info->area) {
		release_resource(info->area);
		kfree(info->area);
	}

	if (info->map.virt != NULL)
		iounmap(info->map.virt);

	kfree(info);

	return 0;
}

/* platram_probe
 *
 * called from device drive system when a device matching our
 * driver is found.
*/

static int platram_probe(struct platform_device *pdev)
{
	struct platdata_mtd_ram	*pdata;
	struct platram_info *info;
	struct resource *res;
	int err = 0;

	dev_dbg(&pdev->dev, "probe entered\n");

	if (pdev->dev.platform_data == NULL) {
		dev_err(&pdev->dev, "no platform data supplied\n");
		err = -ENOENT;
		goto exit_error;
	}

	pdata = pdev->dev.platform_data;

	info = kzalloc(sizeof(*info), GFP_KERNEL);
	if (info == NULL) {
		dev_err(&pdev->dev, "no memory for flash info\n");
		err = -ENOMEM;
		goto exit_error;
	}

	platform_set_drvdata(pdev, info);

	info->dev = &pdev->dev;
	info->pdata = pdata;

	/* get the resource for the memory mapping */

	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);

	if (res == NULL) {
		dev_err(&pdev->dev, "no memory resource specified\n");
		err = -ENOENT;
		goto exit_free;
	}

	dev_dbg(&pdev->dev, "got platform resource %p (0x%llx)\n", res,
		(unsigned long long)res->start);

	/* setup map parameters */

	info->map.phys = res->start;
	info->map.size = resource_size(res);
	info->map.name = pdata->mapname != NULL ?
			(char *)pdata->mapname : (char *)pdev->name;
	info->map.bankwidth = pdata->bankwidth;

	/* register our usage of the memory area */

	info->area = request_mem_region(res->start, info->map.size, pdev->name);
	if (info->area == NULL) {
		dev_err(&pdev->dev, "failed to request memory region\n");
		err = -EIO;
		goto exit_free;
	}

	/* remap the memory area */

	info->map.virt = ioremap(res->start, info->map.size);
	dev_dbg(&pdev->dev, "virt %p, %lu bytes\n", info->map.virt, info->map.size);

	if (info->map.virt == NULL) {
		dev_err(&pdev->dev, "failed to ioremap() region\n");
		err = -EIO;
		goto exit_free;
	}

	simple_map_init(&info->map);

	dev_dbg(&pdev->dev, "initialised map, probing for mtd\n");

	/* probe for the right mtd map driver
	 * supplied by the platform_data struct */

	if (pdata->map_probes) {
		const char **map_probes = pdata->map_probes;

		for ( ; !info->mtd && *map_probes; map_probes++)
			info->mtd = do_map_probe(*map_probes , &info->map);
	}
	/* fallback to map_ram */
	else
		info->mtd = do_map_probe("map_ram", &info->map);

	if (info->mtd == NULL) {
		dev_err(&pdev->dev, "failed to probe for map_ram\n");
		err = -ENOMEM;
		goto exit_free;
	}

	info->mtd->owner = THIS_MODULE;
	info->mtd->dev.parent = &pdev->dev;

	platram_setrw(info, PLATRAM_RW);

	/* check to see if there are any available partitions, or wether
	 * to add this device whole */

#ifdef CONFIG_MTD_PARTITIONS
	if (!pdata->nr_partitions) {
		/* try to probe using the supplied probe type */
		if (pdata->probes) {
			err = parse_mtd_partitions(info->mtd, pdata->probes,
					   &info->partitions, 0);
			info->free_partitions = 1;
			if (err > 0)
				err = add_mtd_partitions(info->mtd,
					info->partitions, err);
		}
	}
	/* use the static mapping */
	else
		err = add_mtd_partitions(info->mtd, pdata->partitions,
				pdata->nr_partitions);
#endif /* CONFIG_MTD_PARTITIONS */

	if (add_mtd_device(info->mtd)) {
		dev_err(&pdev->dev, "add_mtd_device() failed\n");
		err = -ENOMEM;
	}

	if (!err)
		dev_info(&pdev->dev, "registered mtd device\n");

	return err;

 exit_free:
	platram_remove(pdev);
 exit_error:
	return err;
}

/* device driver info */

/* work with hotplug and coldplug */
MODULE_ALIAS("platform:mtd-ram");

static struct platform_driver platram_driver = {
	.probe		= platram_probe,
	.remove		= platram_remove,
	.driver		= {
		.name	= "mtd-ram",
		.owner	= THIS_MODULE,
	},
};

/* module init/exit */

static int __init platram_init(void)
{
	printk("Generic platform RAM MTD, (c) 2004 Simtec Electronics\n");
	return platform_driver_register(&platram_driver);
}

static void __exit platram_exit(void)
{
	platform_driver_unregister(&platram_driver);
}

module_init(platram_init);
module_exit(platram_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
MODULE_DESCRIPTION("MTD platform RAM map driver");
Commit	Line	Data
99f2a8ae BD	1	/* drivers/mtd/maps/plat-ram.c
	2	*
	3	* (c) 2004-2005 Simtec Electronics
	4	* http://www.simtec.co.uk/products/SWLINUX/
	5	* Ben Dooks <ben@simtec.co.uk>
	6	*
	7	* Generic platfrom device based RAM map
	8	*
99f2a8ae BD	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License as published by
	11	* the Free Software Foundation; either version 2 of the License, or
	12	* (at your option) any later version.
	13	*
	14	* This program is distributed in the hope that it will be useful,
	15	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	* GNU General Public License for more details.
	18	*
	19	* You should have received a copy of the GNU General Public License
	20	* along with this program; if not, write to the Free Software
	21	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	22	*/
	23
99f2a8ae BD	24	#include <linux/module.h>
	25	#include <linux/types.h>
	26	#include <linux/init.h>
	27	#include <linux/kernel.h>
	28	#include <linux/string.h>
	29	#include <linux/ioport.h>
	30	#include <linux/device.h>
4e57b681	31	#include <linux/slab.h>
d052d1be	32	#include <linux/platform_device.h>
99f2a8ae BD	33
	34	#include <linux/mtd/mtd.h>
	35	#include <linux/mtd/map.h>
	36	#include <linux/mtd/partitions.h>
	37	#include <linux/mtd/plat-ram.h>
	38
	39	#include <asm/io.h>
	40
	41	/* private structure for each mtd platform ram device created */
	42
	43	struct platram_info {
	44	struct device *dev;
	45	struct mtd_info *mtd;
	46	struct map_info map;
	47	struct mtd_partition *partitions;
75757006	48	bool free_partitions;
99f2a8ae BD	49	struct resource *area;
	50	struct platdata_mtd_ram *pdata;
	51	};
	52
	53	/* to_platram_info()
	54	*
	55	* device private data to struct platram_info conversion
	56	*/
	57
3ae5eaec	58	static inline struct platram_info to_platram_info(struct platform_device dev)
99f2a8ae	59	{
3ae5eaec	60	return (struct platram_info *)platform_get_drvdata(dev);
99f2a8ae BD	61	}
	62
	63	/* platram_setrw
	64	*
	65	* call the platform device's set rw/ro control
	66	*
	67	* to = 0 => read-only
	68	* = 1 => read-write
	69	*/
	70
	71	static inline void platram_setrw(struct platram_info *info, int to)
	72	{
	73	if (info->pdata == NULL)
	74	return;
	75
	76	if (info->pdata->set_rw != NULL)
	77	(info->pdata->set_rw)(info->dev, to);
	78	}
	79
	80	/* platram_remove
	81	*
	82	* called to remove the device from the driver's control
	83	*/
	84
3ae5eaec	85	static int platram_remove(struct platform_device *pdev)
99f2a8ae	86	{
3ae5eaec	87	struct platram_info *info = to_platram_info(pdev);
99f2a8ae	88
3ae5eaec	89	platform_set_drvdata(pdev, NULL);
99f2a8ae	90
3ae5eaec	91	dev_dbg(&pdev->dev, "removing device\n");
99f2a8ae	92
69f34c98	93	if (info == NULL)
99f2a8ae BD	94	return 0;
	95
	96	if (info->mtd) {
	97	#ifdef CONFIG_MTD_PARTITIONS
	98	if (info->partitions) {
	99	del_mtd_partitions(info->mtd);
75757006 FF	100	if (info->free_partitions)
75757006 FF	101	kfree(info->partitions);
99f2a8ae BD	102	}
	103	#endif
	104	del_mtd_device(info->mtd);
	105	map_destroy(info->mtd);
	106	}
	107
	108	/* ensure ram is left read-only */
	109
	110	platram_setrw(info, PLATRAM_RO);
	111
	112	/* release resources */
	113
	114	if (info->area) {
	115	release_resource(info->area);
	116	kfree(info->area);
	117	}
	118
	119	if (info->map.virt != NULL)
	120	iounmap(info->map.virt);
69f34c98	121
99f2a8ae BD	122	kfree(info);
	123
	124	return 0;
	125	}
	126
	127	/* platram_probe
	128	*
	129	* called from device drive system when a device matching our
	130	* driver is found.
	131	*/
	132
3ae5eaec	133	static int platram_probe(struct platform_device *pdev)
99f2a8ae	134	{
99f2a8ae BD	135	struct platdata_mtd_ram *pdata;
	136	struct platram_info *info;
	137	struct resource *res;
	138	int err = 0;
	139
3ae5eaec	140	dev_dbg(&pdev->dev, "probe entered\n");
69f34c98	141
3ae5eaec RK	142	if (pdev->dev.platform_data == NULL) {
3ae5eaec RK	143	dev_err(&pdev->dev, "no platform data supplied\n");
99f2a8ae BD	144	err = -ENOENT;
	145	goto exit_error;
	146	}
	147
3ae5eaec	148	pdata = pdev->dev.platform_data;
99f2a8ae	149
95b93a0c	150	info = kzalloc(sizeof(*info), GFP_KERNEL);
99f2a8ae	151	if (info == NULL) {
3ae5eaec	152	dev_err(&pdev->dev, "no memory for flash info\n");
99f2a8ae BD	153	err = -ENOMEM;
	154	goto exit_error;
	155	}
	156
3ae5eaec	157	platform_set_drvdata(pdev, info);
99f2a8ae	158
3ae5eaec	159	info->dev = &pdev->dev;
99f2a8ae BD	160	info->pdata = pdata;
	161
	162	/* get the resource for the memory mapping */
	163
3ae5eaec	164	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
99f2a8ae BD	165
99f2a8ae BD	166	if (res == NULL) {
3ae5eaec	167	dev_err(&pdev->dev, "no memory resource specified\n");
99f2a8ae BD	168	err = -ENOENT;
	169	goto exit_free;
	170	}
	171
06d63cc5 RD	172	dev_dbg(&pdev->dev, "got platform resource %p (0x%llx)\n", res,
06d63cc5 RD	173	(unsigned long long)res->start);
99f2a8ae BD	174
	175	/* setup map parameters */
	176
	177	info->map.phys = res->start;
76d6a479	178	info->map.size = resource_size(res);
75757006 FF	179	info->map.name = pdata->mapname != NULL ?
75757006 FF	180	(char )pdata->mapname : (char )pdev->name;
99f2a8ae BD	181	info->map.bankwidth = pdata->bankwidth;
	182
	183	/* register our usage of the memory area */
	184
3ae5eaec	185	info->area = request_mem_region(res->start, info->map.size, pdev->name);
99f2a8ae	186	if (info->area == NULL) {
3ae5eaec	187	dev_err(&pdev->dev, "failed to request memory region\n");
99f2a8ae BD	188	err = -EIO;
	189	goto exit_free;
	190	}
	191
	192	/* remap the memory area */
	193
	194	info->map.virt = ioremap(res->start, info->map.size);
3ae5eaec	195	dev_dbg(&pdev->dev, "virt %p, %lu bytes\n", info->map.virt, info->map.size);
99f2a8ae BD	196
99f2a8ae BD	197	if (info->map.virt == NULL) {
3ae5eaec	198	dev_err(&pdev->dev, "failed to ioremap() region\n");
99f2a8ae BD	199	err = -EIO;
	200	goto exit_free;
	201	}
	202
99f2a8ae BD	203	simple_map_init(&info->map);
99f2a8ae BD	204
3ae5eaec	205	dev_dbg(&pdev->dev, "initialised map, probing for mtd\n");
99f2a8ae	206
75757006 FF	207	/* probe for the right mtd map driver
	208	* supplied by the platform_data struct */
	209
a01e035e	210	if (pdata->map_probes) {
75757006 FF	211	const char **map_probes = pdata->map_probes;
	212
	213	for ( ; !info->mtd && *map_probes; map_probes++)
	214	info->mtd = do_map_probe(*map_probes , &info->map);
	215	}
	216	/* fallback to map_ram */
	217	else
	218	info->mtd = do_map_probe("map_ram", &info->map);
99f2a8ae	219
99f2a8ae	220	if (info->mtd == NULL) {
3ae5eaec	221	dev_err(&pdev->dev, "failed to probe for map_ram\n");
99f2a8ae BD	222	err = -ENOMEM;
	223	goto exit_free;
	224	}
	225
	226	info->mtd->owner = THIS_MODULE;
87f39f04	227	info->mtd->dev.parent = &pdev->dev;
99f2a8ae BD	228
	229	platram_setrw(info, PLATRAM_RW);
	230
	231	/* check to see if there are any available partitions, or wether
	232	* to add this device whole */
	233
	234	#ifdef CONFIG_MTD_PARTITIONS
75757006 FF	235	if (!pdata->nr_partitions) {
	236	/* try to probe using the supplied probe type */
	237	if (pdata->probes) {
	238	err = parse_mtd_partitions(info->mtd, pdata->probes,
99f2a8ae	239	&info->partitions, 0);
75757006 FF	240	info->free_partitions = 1;
	241	if (err > 0)
	242	err = add_mtd_partitions(info->mtd,
	243	info->partitions, err);
99f2a8ae BD	244	}
99f2a8ae BD	245	}
75757006 FF	246	/* use the static mapping */
	247	else
	248	err = add_mtd_partitions(info->mtd, pdata->partitions,
	249	pdata->nr_partitions);
99f2a8ae BD	250	#endif /* CONFIG_MTD_PARTITIONS */
	251
	252	if (add_mtd_device(info->mtd)) {
3ae5eaec	253	dev_err(&pdev->dev, "add_mtd_device() failed\n");
99f2a8ae BD	254	err = -ENOMEM;
99f2a8ae BD	255	}
69f34c98	256
75757006 FF	257	if (!err)
	258	dev_info(&pdev->dev, "registered mtd device\n");
	259
99f2a8ae BD	260	return err;
	261
	262	exit_free:
3ae5eaec	263	platram_remove(pdev);
99f2a8ae BD	264	exit_error:
	265	return err;
	266	}
	267
	268	/* device driver info */
	269
41d867c9 KS	270	/* work with hotplug and coldplug */
	271	MODULE_ALIAS("platform:mtd-ram");
	272
3ae5eaec	273	static struct platform_driver platram_driver = {
99f2a8ae BD	274	.probe = platram_probe,
99f2a8ae BD	275	.remove = platram_remove,
3ae5eaec RK	276	.driver = {
	277	.name = "mtd-ram",
	278	.owner = THIS_MODULE,
	279	},
99f2a8ae BD	280	};
	281
	282	/* module init/exit */
	283
	284	static int __init platram_init(void)
	285	{
	286	printk("Generic platform RAM MTD, (c) 2004 Simtec Electronics\n");
3ae5eaec	287	return platform_driver_register(&platram_driver);
99f2a8ae BD	288	}
	289
	290	static void __exit platram_exit(void)
	291	{
3ae5eaec	292	platform_driver_unregister(&platram_driver);
99f2a8ae BD	293	}
	294
	295	module_init(platram_init);
	296	module_exit(platram_exit);
	297
	298	MODULE_LICENSE("GPL");
	299	MODULE_AUTHOR("Ben Dooks <ben@simtec.co.uk>");
	300	MODULE_DESCRIPTION("MTD platform RAM map driver");