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

/*
 * $Id: ixp2000.c,v 1.6 2005/03/18 14:07:46 gleixner Exp $
 *
 * drivers/mtd/maps/ixp2000.c
 *
 * Mapping for the Intel XScale IXP2000 based systems
 *
 * Copyright (C) 2002 Intel Corp.
 * Copyright (C) 2003-2004 MontaVista Software, Inc.
 *
 * Original Author: Naeem M Afzal <naeem.m.afzal@intel.com>
 * Maintainer: Deepak Saxena <dsaxena@plexity.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 * 
 */

#include <linux/module.h>
#include <linux/types.h>
#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>
#include <linux/ioport.h>
#include <linux/platform_device.h>

#include <asm/io.h>
#include <asm/hardware.h>
#include <asm/mach/flash.h>

#include <linux/reboot.h>

struct ixp2000_flash_info {
	struct		mtd_info *mtd;
	struct		map_info map;
	struct		mtd_partition *partitions;
	struct		resource *res;
	int		nr_banks;
};

static inline unsigned long flash_bank_setup(struct map_info *map, unsigned long ofs)
{	
	unsigned long (*set_bank)(unsigned long) = 
		(unsigned long(*)(unsigned long))map->map_priv_2;

	return (set_bank ? set_bank(ofs) : ofs);
}

#ifdef __ARMEB__
/*
 * Rev A0 and A1 of IXP2400 silicon have a broken addressing unit which 
 * causes the lower address bits to be XORed with 0x11 on 8 bit accesses 
 * and XORed with 0x10 on 16 bit accesses. See the spec update, erratum 44.
 */
static int erratum44_workaround = 0;

static inline unsigned long address_fix8_write(unsigned long addr)
{
	if (erratum44_workaround) {
		return (addr ^ 3);
	}
	return addr;
}
#else

#define address_fix8_write(x)	(x)
#endif

static map_word ixp2000_flash_read8(struct map_info *map, unsigned long ofs)
{
	map_word val;

	val.x[0] =  *((u8 *)(map->map_priv_1 + flash_bank_setup(map, ofs)));
	return val;
}

/*
 * We can't use the standard memcpy due to the broken SlowPort
 * address translation on rev A0 and A1 silicon and the fact that
 * we have banked flash.
 */
static void ixp2000_flash_copy_from(struct map_info *map, void *to,
			      unsigned long from, ssize_t len)
{
	from = flash_bank_setup(map, from);
	while(len--) 
		*(__u8 *) to++ = *(__u8 *)(map->map_priv_1 + from++);
}

static void ixp2000_flash_write8(struct map_info *map, map_word d, unsigned long ofs)
{
	*(__u8 *) (address_fix8_write(map->map_priv_1 +
				      flash_bank_setup(map, ofs))) = d.x[0];
}

static void ixp2000_flash_copy_to(struct map_info *map, unsigned long to,
			    const void *from, ssize_t len)
{
	to = flash_bank_setup(map, to);
	while(len--) {
		unsigned long tmp = address_fix8_write(map->map_priv_1 + to++);
		*(__u8 *)(tmp) = *(__u8 *)(from++);
	}
}


static int ixp2000_flash_remove(struct device *_dev)
{
	struct platform_device *dev = to_platform_device(_dev);
	struct flash_platform_data *plat = dev->dev.platform_data;
	struct ixp2000_flash_info *info = dev_get_drvdata(&dev->dev);

	dev_set_drvdata(&dev->dev, NULL);

	if(!info)
		return 0;

	if (info->mtd) {
		del_mtd_partitions(info->mtd);
		map_destroy(info->mtd);
	}
	if (info->map.map_priv_1)
		iounmap((void *) info->map.map_priv_1);

	if (info->partitions) {
		kfree(info->partitions); }

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

	if (plat->exit)
		plat->exit();

	return 0;
}


static int ixp2000_flash_probe(struct device *_dev)
{
	static const char *probes[] = { "RedBoot", "cmdlinepart", NULL };
	struct platform_device *dev = to_platform_device(_dev);
	struct ixp2000_flash_data *ixp_data = dev->dev.platform_data;
	struct flash_platform_data *plat; 
	struct ixp2000_flash_info *info;
	unsigned long window_size;
	int err = -1;
	
	if (!ixp_data)
		return -ENODEV;

	plat = ixp_data->platform_data;
	if (!plat)
		return -ENODEV;

	window_size = dev->resource->end - dev->resource->start + 1;
	dev_info(_dev, "Probe of IXP2000 flash(%d banks x %dMiB)\n", 
			ixp_data->nr_banks, ((u32)window_size >> 20));

	if (plat->width != 1) {
		dev_err(_dev, "IXP2000 MTD map only supports 8-bit mode, asking for %d\n",
				plat->width * 8);
		return -EIO;
	}

	info = kmalloc(sizeof(struct ixp2000_flash_info), GFP_KERNEL);
	if(!info) {
		err = -ENOMEM;
		goto Error;
	}	
	memzero(info, sizeof(struct ixp2000_flash_info));

	dev_set_drvdata(&dev->dev, info);

	/*
	 * Tell the MTD layer we're not 1:1 mapped so that it does
	 * not attempt to do a direct access on us.
	 */
	info->map.phys = NO_XIP;
	
	info->nr_banks = ixp_data->nr_banks;
	info->map.size = ixp_data->nr_banks * window_size;
	info->map.bankwidth = 1;

	/*
 	 * map_priv_2 is used to store a ptr to to the bank_setup routine
 	 */
	info->map.map_priv_2 = (void __iomem *) ixp_data->bank_setup;

	info->map.name = dev->dev.bus_id;
	info->map.read = ixp2000_flash_read8;
	info->map.write = ixp2000_flash_write8;
	info->map.copy_from = ixp2000_flash_copy_from;
	info->map.copy_to = ixp2000_flash_copy_to;

	info->res = request_mem_region(dev->resource->start, 
			dev->resource->end - dev->resource->start + 1, 
			dev->dev.bus_id);
	if (!info->res) {
		dev_err(_dev, "Could not reserve memory region\n");
		err = -ENOMEM;
		goto Error;
	}

	info->map.map_priv_1 = ioremap(dev->resource->start, 
			    	dev->resource->end - dev->resource->start + 1);
	if (!info->map.map_priv_1) {
		dev_err(_dev, "Failed to ioremap flash region\n");
		err = -EIO;
		goto Error;
	}

#if defined(__ARMEB__)
	/*
	 * Enable erratum 44 workaround for NPUs with broken slowport
	 */

	erratum44_workaround = ixp2000_has_broken_slowport();
	dev_info(_dev, "Erratum 44 workaround %s\n",
	       erratum44_workaround ? "enabled" : "disabled");
#endif

	info->mtd = do_map_probe(plat->map_name, &info->map);
	if (!info->mtd) {
		dev_err(_dev, "map_probe failed\n");
		err = -ENXIO;
		goto Error;
	}
	info->mtd->owner = THIS_MODULE;

	err = parse_mtd_partitions(info->mtd, probes, &info->partitions, 0);
	if (err > 0) {
		err = add_mtd_partitions(info->mtd, info->partitions, err);
		if(err)
			dev_err(_dev, "Could not parse partitions\n");
	}

	if (err)
		goto Error;

	return 0;

Error:
	ixp2000_flash_remove(_dev);
	return err;
}

static struct device_driver ixp2000_flash_driver = {
	.name		= "IXP2000-Flash",
	.bus		= &platform_bus_type,
	.probe		= &ixp2000_flash_probe,
	.remove		= &ixp2000_flash_remove
};

static int __init ixp2000_flash_init(void)
{
	return driver_register(&ixp2000_flash_driver);
}

static void __exit ixp2000_flash_exit(void)
{
	driver_unregister(&ixp2000_flash_driver);
}

module_init(ixp2000_flash_init);
module_exit(ixp2000_flash_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Deepak Saxena <dsaxena@plexity.net>");
Commit	Line	Data
1da177e4	1	/*
167e1770	2	* $Id: ixp2000.c,v 1.6 2005/03/18 14:07:46 gleixner Exp $
1da177e4 LT	3	*
	4	* drivers/mtd/maps/ixp2000.c
	5	*
	6	* Mapping for the Intel XScale IXP2000 based systems
	7	*
	8	* Copyright (C) 2002 Intel Corp.
	9	* Copyright (C) 2003-2004 MontaVista Software, Inc.
	10	*
	11	* Original Author: Naeem M Afzal <naeem.m.afzal@intel.com>
	12	* Maintainer: Deepak Saxena <dsaxena@plexity.net>
	13	*
	14	* This program is free software; you can redistribute it and/or modify
	15	* it under the terms of the GNU General Public License version 2 as
	16	* published by the Free Software Foundation.
	17	*
	18	*/
	19
	20	#include <linux/module.h>
	21	#include <linux/types.h>
	22	#include <linux/init.h>
	23	#include <linux/kernel.h>
	24	#include <linux/string.h>
	25	#include <linux/mtd/mtd.h>
	26	#include <linux/mtd/map.h>
	27	#include <linux/mtd/partitions.h>
	28	#include <linux/ioport.h>
d052d1be	29	#include <linux/platform_device.h>
1da177e4 LT	30
	31	#include <asm/io.h>
	32	#include <asm/hardware.h>
1da177e4 LT	33	#include <asm/mach/flash.h>
	34
	35	#include <linux/reboot.h>
	36
	37	struct ixp2000_flash_info {
	38	struct mtd_info *mtd;
	39	struct map_info map;
	40	struct mtd_partition *partitions;
	41	struct resource *res;
	42	int nr_banks;
	43	};
	44
	45	static inline unsigned long flash_bank_setup(struct map_info *map, unsigned long ofs)
	46	{
	47	unsigned long (*set_bank)(unsigned long) =
	48	(unsigned long(*)(unsigned long))map->map_priv_2;
	49
	50	return (set_bank ? set_bank(ofs) : ofs);
	51	}
	52
	53	#ifdef __ARMEB__
	54	/*
	55	* Rev A0 and A1 of IXP2400 silicon have a broken addressing unit which
	56	* causes the lower address bits to be XORed with 0x11 on 8 bit accesses
	57	* and XORed with 0x10 on 16 bit accesses. See the spec update, erratum 44.
	58	*/
	59	static int erratum44_workaround = 0;
	60
	61	static inline unsigned long address_fix8_write(unsigned long addr)
	62	{
	63	if (erratum44_workaround) {
	64	return (addr ^ 3);
	65	}
	66	return addr;
	67	}
	68	#else
	69
	70	#define address_fix8_write(x) (x)
	71	#endif
	72
	73	static map_word ixp2000_flash_read8(struct map_info *map, unsigned long ofs)
	74	{
	75	map_word val;
	76
	77	val.x[0] = ((u8 )(map->map_priv_1 + flash_bank_setup(map, ofs)));
	78	return val;
	79	}
	80
	81	/*
	82	* We can't use the standard memcpy due to the broken SlowPort
	83	* address translation on rev A0 and A1 silicon and the fact that
	84	* we have banked flash.
	85	*/
	86	static void ixp2000_flash_copy_from(struct map_info map, void to,
	87	unsigned long from, ssize_t len)
	88	{
	89	from = flash_bank_setup(map, from);
	90	while(len--)
	91	(__u8 ) to++ = (__u8 )(map->map_priv_1 + from++);
	92	}
	93
	94	static void ixp2000_flash_write8(struct map_info *map, map_word d, unsigned long ofs)
	95	{
	96	(__u8 ) (address_fix8_write(map->map_priv_1 +
97	flash_bank_setup(map, ofs))) = d.x[0];
98	}
99
100	static void ixp2000_flash_copy_to(struct map_info *map, unsigned long to,
101	const void *from, ssize_t len)
102	{
103	to = flash_bank_setup(map, to);
104	while(len--) {
105	unsigned long tmp = address_fix8_write(map->map_priv_1 + to++);
106	(__u8 )(tmp) = (__u8 )(from++);
107	}
108	}
109
110
111	static int ixp2000_flash_remove(struct device *_dev)
112	{
113	struct platform_device *dev = to_platform_device(_dev);
114	struct flash_platform_data *plat = dev->dev.platform_data;
115	struct ixp2000_flash_info *info = dev_get_drvdata(&dev->dev);
116
117	dev_set_drvdata(&dev->dev, NULL);
118
119	if(!info)
120	return 0;
121
122	if (info->mtd) {
123	del_mtd_partitions(info->mtd);
124	map_destroy(info->mtd);
125	}
126	if (info->map.map_priv_1)
127	iounmap((void *) info->map.map_priv_1);
128
129	if (info->partitions) {
130	kfree(info->partitions); }
131
132	if (info->res) {
133	release_resource(info->res);
134	kfree(info->res);
135	}
136
137	if (plat->exit)
138	plat->exit();
139
140	return 0;
141	}
142
143
144	static int ixp2000_flash_probe(struct device *_dev)
145	{
146	static const char *probes[] = { "RedBoot", "cmdlinepart", NULL };
147	struct platform_device *dev = to_platform_device(_dev);
148	struct ixp2000_flash_data *ixp_data = dev->dev.platform_data;
149	struct flash_platform_data *plat;
150	struct ixp2000_flash_info *info;
151	unsigned long window_size;
152	int err = -1;
153
154	if (!ixp_data)
155	return -ENODEV;
156
157	plat = ixp_data->platform_data;
158	if (!plat)
159	return -ENODEV;
160
161	window_size = dev->resource->end - dev->resource->start + 1;
162	dev_info(_dev, "Probe of IXP2000 flash(%d banks x %dMiB)\n",
163	ixp_data->nr_banks, ((u32)window_size >> 20));
164
165	if (plat->width != 1) {
166	dev_err(_dev, "IXP2000 MTD map only supports 8-bit mode, asking for %d\n",
167	plat->width * 8);
168	return -EIO;
169	}
170
171	info = kmalloc(sizeof(struct ixp2000_flash_info), GFP_KERNEL);
172	if(!info) {
173	err = -ENOMEM;
174	goto Error;
175	}
176	memzero(info, sizeof(struct ixp2000_flash_info));
177
178	dev_set_drvdata(&dev->dev, info);
179
180	/*
181	* Tell the MTD layer we're not 1:1 mapped so that it does
182	* not attempt to do a direct access on us.
183	*/
184	info->map.phys = NO_XIP;
185
186	info->nr_banks = ixp_data->nr_banks;
187	info->map.size = ixp_data->nr_banks * window_size;
188	info->map.bankwidth = 1;
189
190	/*
191	* map_priv_2 is used to store a ptr to to the bank_setup routine
192	*/
193	info->map.map_priv_2 = (void __iomem *) ixp_data->bank_setup;
194
195	info->map.name = dev->dev.bus_id;
196	info->map.read = ixp2000_flash_read8;
197	info->map.write = ixp2000_flash_write8;
198	info->map.copy_from = ixp2000_flash_copy_from;
199	info->map.copy_to = ixp2000_flash_copy_to;
200
201	info->res = request_mem_region(dev->resource->start,
202	dev->resource->end - dev->resource->start + 1,
203	dev->dev.bus_id);
204	if (!info->res) {
205	dev_err(_dev, "Could not reserve memory region\n");
206	err = -ENOMEM;
207	goto Error;
208	}
209
210	info->map.map_priv_1 = ioremap(dev->resource->start,
211	dev->resource->end - dev->resource->start + 1);
212	if (!info->map.map_priv_1) {
213	dev_err(_dev, "Failed to ioremap flash region\n");
214	err = -EIO;
215	goto Error;
216	}
217
1da177e4 LT	218	#if defined(__ARMEB__)
	219	/*
	220	* Enable erratum 44 workaround for NPUs with broken slowport
	221	*/
	222
	223	erratum44_workaround = ixp2000_has_broken_slowport();
	224	dev_info(_dev, "Erratum 44 workaround %s\n",
	225	erratum44_workaround ? "enabled" : "disabled");
	226	#endif
	227
	228	info->mtd = do_map_probe(plat->map_name, &info->map);
	229	if (!info->mtd) {
	230	dev_err(_dev, "map_probe failed\n");
	231	err = -ENXIO;
	232	goto Error;
	233	}
	234	info->mtd->owner = THIS_MODULE;
	235
	236	err = parse_mtd_partitions(info->mtd, probes, &info->partitions, 0);
	237	if (err > 0) {
	238	err = add_mtd_partitions(info->mtd, info->partitions, err);
	239	if(err)
	240	dev_err(_dev, "Could not parse partitions\n");
	241	}
	242
	243	if (err)
	244	goto Error;
	245
	246	return 0;
	247
	248	Error:
	249	ixp2000_flash_remove(_dev);
	250	return err;
	251	}
	252
	253	static struct device_driver ixp2000_flash_driver = {
	254	.name = "IXP2000-Flash",
	255	.bus = &platform_bus_type,
	256	.probe = &ixp2000_flash_probe,
	257	.remove = &ixp2000_flash_remove
	258	};
	259
	260	static int __init ixp2000_flash_init(void)
	261	{
	262	return driver_register(&ixp2000_flash_driver);
	263	}
	264
	265	static void __exit ixp2000_flash_exit(void)
	266	{
	267	driver_unregister(&ixp2000_flash_driver);
	268	}
	269
	270	module_init(ixp2000_flash_init);
	271	module_exit(ixp2000_flash_exit);
	272	MODULE_LICENSE("GPL");
	273	MODULE_AUTHOR("Deepak Saxena <dsaxena@plexity.net>");
	274