[net-next-2.6.git] / drivers / mtd / maps / tqm8xxl.c

/*
 * Handle mapping of the flash memory access routines 
 * on TQM8xxL based devices.
 *
 * $Id: tqm8xxl.c,v 1.13 2004/10/20 22:21:53 dwmw2 Exp $
 *
 * based on rpxlite.c
 *
 * Copyright(C) 2001 Kirk Lee <kirk@hpc.ee.ntu.edu.tw>
 *
 * This code is GPLed
 * 
 */

/*
 * According to TQM8xxL hardware manual, TQM8xxL series have
 * following flash memory organisations:
 *	| capacity |	| chip type |	| bank0 |	| bank1 |
 *	    2MiB	   512Kx16	  2MiB		   0
 *	    4MiB	   1Mx16	  4MiB		   0
 *	    8MiB	   1Mx16	  4MiB		   4MiB
 * Thus, we choose CONFIG_MTD_CFI_I2 & CONFIG_MTD_CFI_B4 at 
 * kernel configuration.
 */
#include <linux/config.h>
#include <linux/module.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/slab.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>

#include <asm/io.h>

#define FLASH_ADDR 0x40000000
#define FLASH_SIZE 0x00800000
#define FLASH_BANK_MAX 4

// trivial struct to describe partition information
struct mtd_part_def
{
	int nums;
	unsigned char *type;
	struct mtd_partition* mtd_part;
};

//static struct mtd_info *mymtd;
static struct mtd_info* mtd_banks[FLASH_BANK_MAX];
static struct map_info* map_banks[FLASH_BANK_MAX];
static struct mtd_part_def part_banks[FLASH_BANK_MAX];
static unsigned long num_banks;
static void __iomem *start_scan_addr;

/*
 * Here are partition information for all known TQM8xxL series devices.
 * See include/linux/mtd/partitions.h for definition of the mtd_partition
 * structure.
 * 
 * The *_max_flash_size is the maximum possible mapped flash size which
 * is not necessarily the actual flash size.  It must correspond to the 
 * value specified in the mapping definition defined by the
 * "struct map_desc *_io_desc" for the corresponding machine.
 */

#ifdef CONFIG_MTD_PARTITIONS
/* Currently, TQM8xxL has upto 8MiB flash */
static unsigned long tqm8xxl_max_flash_size = 0x00800000;

/* partition definition for first flash bank
 * (cf. "drivers/char/flash_config.c")
 */
static struct mtd_partition tqm8xxl_partitions[] = {
	{
	  .name = "ppcboot",
	  .offset = 0x00000000,
	  .size = 0x00020000,           /* 128KB           */
	  .mask_flags = MTD_WRITEABLE,  /* force read-only */
	},
	{
	  .name = "kernel",             /* default kernel image */
	  .offset = 0x00020000,
	  .size = 0x000e0000,
	  .mask_flags = MTD_WRITEABLE,  /* force read-only */
	},
	{
	  .name = "user",
	  .offset = 0x00100000,
	  .size = 0x00100000,
	},
	{
	  .name = "initrd",
	  .offset = 0x00200000,
	  .size = 0x00200000,
	}
};
/* partition definition for second flash bank */
static struct mtd_partition tqm8xxl_fs_partitions[] = {
	{
	  .name = "cramfs",
	  .offset = 0x00000000,
	  .size = 0x00200000,
	},
	{
	  .name = "jffs",
	  .offset = 0x00200000,
	  .size = 0x00200000,
	  //.size = MTDPART_SIZ_FULL,
	}
};
#endif

int __init init_tqm_mtd(void)
{
	int idx = 0, ret = 0;
	unsigned long flash_addr, flash_size, mtd_size = 0;
	/* pointer to TQM8xxL board info data */
	bd_t *bd = (bd_t *)__res;

	flash_addr = bd->bi_flashstart;
	flash_size = bd->bi_flashsize;

	//request maximum flash size address space
	start_scan_addr = ioremap(flash_addr, flash_size);
	if (!start_scan_addr) {
		printk(KERN_WARNING "%s:Failed to ioremap address:0x%x\n", __FUNCTION__, flash_addr);
		return -EIO;
	}

	for (idx = 0 ; idx < FLASH_BANK_MAX ; idx++) {
		if(mtd_size >= flash_size)
			break;
		
		printk(KERN_INFO "%s: chip probing count %d\n", __FUNCTION__, idx);
		
		map_banks[idx] = (struct map_info *)kmalloc(sizeof(struct map_info), GFP_KERNEL);
		if(map_banks[idx] == NULL) {
			ret = -ENOMEM;
			/* FIXME: What if some MTD devices were probed already? */
			goto error_mem;
		}

		memset((void *)map_banks[idx], 0, sizeof(struct map_info));
		map_banks[idx]->name = (char *)kmalloc(16, GFP_KERNEL);

		if (!map_banks[idx]->name) {
			ret = -ENOMEM;
			/* FIXME: What if some MTD devices were probed already? */
			goto error_mem;
		}
		sprintf(map_banks[idx]->name, "TQM8xxL%d", idx);

		map_banks[idx]->size = flash_size;
		map_banks[idx]->bankwidth = 4;

		simple_map_init(map_banks[idx]);

		map_banks[idx]->virt = start_scan_addr;
		map_banks[idx]->phys = flash_addr;
		/* FIXME: This looks utterly bogus, but I'm trying to
		   preserve the behaviour of the original (shown here)...

		map_banks[idx]->map_priv_1 =
		start_scan_addr + ((idx > 0) ?
		(mtd_banks[idx-1] ? mtd_banks[idx-1]->size : 0) : 0);
		*/

		if (idx && mtd_banks[idx-1]) {
			map_banks[idx]->virt += mtd_banks[idx-1]->size;
			map_banks[idx]->phys += mtd_banks[idx-1]->size;
		}

		//start to probe flash chips
		mtd_banks[idx] = do_map_probe("cfi_probe", map_banks[idx]);

		if (mtd_banks[idx]) {
			mtd_banks[idx]->owner = THIS_MODULE;
			mtd_size += mtd_banks[idx]->size;
			num_banks++;

			printk(KERN_INFO "%s: bank%d, name:%s, size:%dbytes \n", __FUNCTION__, num_banks, 
			mtd_banks[idx]->name, mtd_banks[idx]->size);
		}
	}

	/* no supported flash chips found */
	if (!num_banks) {
		printk(KERN_NOTICE "TQM8xxL: No support flash chips found!\n");
		ret = -ENXIO;
		goto error_mem;
	}

#ifdef CONFIG_MTD_PARTITIONS
	/*
	 * Select Static partition definitions
	 */
	part_banks[0].mtd_part = tqm8xxl_partitions;
	part_banks[0].type = "Static image";
	part_banks[0].nums = ARRAY_SIZE(tqm8xxl_partitions);

	part_banks[1].mtd_part = tqm8xxl_fs_partitions;
	part_banks[1].type = "Static file system";
	part_banks[1].nums = ARRAY_SIZE(tqm8xxl_fs_partitions);

	for(idx = 0; idx < num_banks ; idx++) {
		if (part_banks[idx].nums == 0) {
			printk(KERN_NOTICE "TQM flash%d: no partition info available, registering whole flash at once\n", idx);
			add_mtd_device(mtd_banks[idx]);
		} else {
			printk(KERN_NOTICE "TQM flash%d: Using %s partition definition\n",
					idx, part_banks[idx].type);
			add_mtd_partitions(mtd_banks[idx], part_banks[idx].mtd_part, 
								part_banks[idx].nums);
		}
	}
#else
	printk(KERN_NOTICE "TQM flash: registering %d whole flash banks at once\n", num_banks);
	for(idx = 0 ; idx < num_banks ; idx++)
		add_mtd_device(mtd_banks[idx]);
#endif
	return 0;
error_mem:
	for(idx = 0 ; idx < FLASH_BANK_MAX ; idx++) {
		if(map_banks[idx] != NULL) {
			if(map_banks[idx]->name != NULL) {
				kfree(map_banks[idx]->name);
				map_banks[idx]->name = NULL;
			}
			kfree(map_banks[idx]);
			map_banks[idx] = NULL;
		}
	}
error:
	iounmap(start_scan_addr);
	return ret;
}

static void __exit cleanup_tqm_mtd(void)
{
	unsigned int idx = 0;
	for(idx = 0 ; idx < num_banks ; idx++) {
		/* destroy mtd_info previously allocated */
		if (mtd_banks[idx]) {
			del_mtd_partitions(mtd_banks[idx]);
			map_destroy(mtd_banks[idx]);
		}
		/* release map_info not used anymore */
		kfree(map_banks[idx]->name);
		kfree(map_banks[idx]);
	}

	if (start_scan_addr) {
		iounmap(start_scan_addr);
		start_scan_addr = 0;
	}
}

module_init(init_tqm_mtd);
module_exit(cleanup_tqm_mtd);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Kirk Lee <kirk@hpc.ee.ntu.edu.tw>");
MODULE_DESCRIPTION("MTD map driver for TQM8xxL boards");
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Handle mapping of the flash memory access routines
	3	* on TQM8xxL based devices.
	4	*
	5	* $Id: tqm8xxl.c,v 1.13 2004/10/20 22:21:53 dwmw2 Exp $
	6	*
	7	* based on rpxlite.c
	8	*
	9	* Copyright(C) 2001 Kirk Lee <kirk@hpc.ee.ntu.edu.tw>
	10	*
	11	* This code is GPLed
	12	*
	13	*/
	14
	15	/*
	16	* According to TQM8xxL hardware manual, TQM8xxL series have
	17	* following flash memory organisations:
	18	* \| capacity \| \| chip type \| \| bank0 \| \| bank1 \|
	19	* 2MiB 512Kx16 2MiB 0
	20	* 4MiB 1Mx16 4MiB 0
	21	* 8MiB 1Mx16 4MiB 4MiB
	22	* Thus, we choose CONFIG_MTD_CFI_I2 & CONFIG_MTD_CFI_B4 at
	23	* kernel configuration.
	24	*/
	25	#include <linux/config.h>
	26	#include <linux/module.h>
	27	#include <linux/types.h>
	28	#include <linux/kernel.h>
	29	#include <linux/init.h>
4e57b681	30	#include <linux/slab.h>
1da177e4 LT	31
	32	#include <linux/mtd/mtd.h>
	33	#include <linux/mtd/map.h>
	34	#include <linux/mtd/partitions.h>
	35
4e57b681 TS	36	#include <asm/io.h>
4e57b681 TS	37
1da177e4 LT	38	#define FLASH_ADDR 0x40000000
	39	#define FLASH_SIZE 0x00800000
	40	#define FLASH_BANK_MAX 4
	41
	42	// trivial struct to describe partition information
	43	struct mtd_part_def
	44	{
	45	int nums;
	46	unsigned char *type;
	47	struct mtd_partition* mtd_part;
	48	};
	49
	50	//static struct mtd_info *mymtd;
	51	static struct mtd_info* mtd_banks[FLASH_BANK_MAX];
	52	static struct map_info* map_banks[FLASH_BANK_MAX];
	53	static struct mtd_part_def part_banks[FLASH_BANK_MAX];
	54	static unsigned long num_banks;
	55	static void __iomem *start_scan_addr;
	56
	57	/*
	58	* Here are partition information for all known TQM8xxL series devices.
	59	* See include/linux/mtd/partitions.h for definition of the mtd_partition
	60	* structure.
	61	*
	62	* The *_max_flash_size is the maximum possible mapped flash size which
	63	* is not necessarily the actual flash size. It must correspond to the
	64	* value specified in the mapping definition defined by the
	65	* "struct map_desc *_io_desc" for the corresponding machine.
	66	*/
	67
	68	#ifdef CONFIG_MTD_PARTITIONS
	69	/* Currently, TQM8xxL has upto 8MiB flash */
	70	static unsigned long tqm8xxl_max_flash_size = 0x00800000;
	71
	72	/* partition definition for first flash bank
	73	* (cf. "drivers/char/flash_config.c")
	74	*/
	75	static struct mtd_partition tqm8xxl_partitions[] = {
	76	{
	77	.name = "ppcboot",
	78	.offset = 0x00000000,
	79	.size = 0x00020000, /* 128KB */
	80	.mask_flags = MTD_WRITEABLE, /* force read-only */
	81	},
	82	{
	83	.name = "kernel", /* default kernel image */
	84	.offset = 0x00020000,
	85	.size = 0x000e0000,
	86	.mask_flags = MTD_WRITEABLE, /* force read-only */
	87	},
	88	{
	89	.name = "user",
	90	.offset = 0x00100000,
	91	.size = 0x00100000,
	92	},
	93	{
	94	.name = "initrd",
	95	.offset = 0x00200000,
	96	.size = 0x00200000,
	97	}
	98	};
	99	/* partition definition for second flash bank */
	100	static struct mtd_partition tqm8xxl_fs_partitions[] = {
	101	{
102	.name = "cramfs",
103	.offset = 0x00000000,
104	.size = 0x00200000,
105	},
106	{
107	.name = "jffs",
108	.offset = 0x00200000,
109	.size = 0x00200000,
110	//.size = MTDPART_SIZ_FULL,
111	}
112	};
113	#endif
114
115	int __init init_tqm_mtd(void)
116	{
117	int idx = 0, ret = 0;
118	unsigned long flash_addr, flash_size, mtd_size = 0;
119	/* pointer to TQM8xxL board info data */
120	bd_t bd = (bd_t )__res;
121
122	flash_addr = bd->bi_flashstart;
123	flash_size = bd->bi_flashsize;
124
125	//request maximum flash size address space
126	start_scan_addr = ioremap(flash_addr, flash_size);
127	if (!start_scan_addr) {
128	printk(KERN_WARNING "%s:Failed to ioremap address:0x%x\n", __FUNCTION__, flash_addr);
129	return -EIO;
130	}
131
132	for (idx = 0 ; idx < FLASH_BANK_MAX ; idx++) {
133	if(mtd_size >= flash_size)
134	break;
135
136	printk(KERN_INFO "%s: chip probing count %d\n", __FUNCTION__, idx);
137
138	map_banks[idx] = (struct map_info *)kmalloc(sizeof(struct map_info), GFP_KERNEL);
139	if(map_banks[idx] == NULL) {
140	ret = -ENOMEM;
141	/* FIXME: What if some MTD devices were probed already? */
142	goto error_mem;
143	}
144
145	memset((void *)map_banks[idx], 0, sizeof(struct map_info));
146	map_banks[idx]->name = (char *)kmalloc(16, GFP_KERNEL);
147
148	if (!map_banks[idx]->name) {
149	ret = -ENOMEM;
150	/* FIXME: What if some MTD devices were probed already? */
151	goto error_mem;
152	}
153	sprintf(map_banks[idx]->name, "TQM8xxL%d", idx);
154
155	map_banks[idx]->size = flash_size;
156	map_banks[idx]->bankwidth = 4;
157
158	simple_map_init(map_banks[idx]);
159
160	map_banks[idx]->virt = start_scan_addr;
161	map_banks[idx]->phys = flash_addr;
162	/* FIXME: This looks utterly bogus, but I'm trying to
163	preserve the behaviour of the original (shown here)...
164
165	map_banks[idx]->map_priv_1 =
166	start_scan_addr + ((idx > 0) ?
167	(mtd_banks[idx-1] ? mtd_banks[idx-1]->size : 0) : 0);
168	*/
169
170	if (idx && mtd_banks[idx-1]) {
171	map_banks[idx]->virt += mtd_banks[idx-1]->size;
172	map_banks[idx]->phys += mtd_banks[idx-1]->size;
173	}
174
175	//start to probe flash chips
176	mtd_banks[idx] = do_map_probe("cfi_probe", map_banks[idx]);
177
178	if (mtd_banks[idx]) {
179	mtd_banks[idx]->owner = THIS_MODULE;
180	mtd_size += mtd_banks[idx]->size;
181	num_banks++;
182
183	printk(KERN_INFO "%s: bank%d, name:%s, size:%dbytes \n", __FUNCTION__, num_banks,
184	mtd_banks[idx]->name, mtd_banks[idx]->size);
185	}
186	}
187
188	/* no supported flash chips found */
189	if (!num_banks) {
190	printk(KERN_NOTICE "TQM8xxL: No support flash chips found!\n");
191	ret = -ENXIO;
192	goto error_mem;
193	}
194
195	#ifdef CONFIG_MTD_PARTITIONS
196	/*
197	* Select Static partition definitions
198	*/
199	part_banks[0].mtd_part = tqm8xxl_partitions;
200	part_banks[0].type = "Static image";
201	part_banks[0].nums = ARRAY_SIZE(tqm8xxl_partitions);
202
203	part_banks[1].mtd_part = tqm8xxl_fs_partitions;
204	part_banks[1].type = "Static file system";
205	part_banks[1].nums = ARRAY_SIZE(tqm8xxl_fs_partitions);
206
207	for(idx = 0; idx < num_banks ; idx++) {
208	if (part_banks[idx].nums == 0) {
209	printk(KERN_NOTICE "TQM flash%d: no partition info available, registering whole flash at once\n", idx);
210	add_mtd_device(mtd_banks[idx]);
211	} else {
212	printk(KERN_NOTICE "TQM flash%d: Using %s partition definition\n",
213	idx, part_banks[idx].type);
214	add_mtd_partitions(mtd_banks[idx], part_banks[idx].mtd_part,
215	part_banks[idx].nums);
216	}
217	}
218	#else
219	printk(KERN_NOTICE "TQM flash: registering %d whole flash banks at once\n", num_banks);
220	for(idx = 0 ; idx < num_banks ; idx++)
221	add_mtd_device(mtd_banks[idx]);
222	#endif
223	return 0;
224	error_mem:
225	for(idx = 0 ; idx < FLASH_BANK_MAX ; idx++) {
226	if(map_banks[idx] != NULL) {
227	if(map_banks[idx]->name != NULL) {
228	kfree(map_banks[idx]->name);
229	map_banks[idx]->name = NULL;
230	}
231	kfree(map_banks[idx]);
232	map_banks[idx] = NULL;
233	}
234	}
235	error:
236	iounmap(start_scan_addr);
237	return ret;
238	}
239
240	static void __exit cleanup_tqm_mtd(void)
241	{
242	unsigned int idx = 0;
243	for(idx = 0 ; idx < num_banks ; idx++) {
244	/* destroy mtd_info previously allocated */
245	if (mtd_banks[idx]) {
246	del_mtd_partitions(mtd_banks[idx]);
247	map_destroy(mtd_banks[idx]);
248	}
249	/* release map_info not used anymore */
250	kfree(map_banks[idx]->name);
251	kfree(map_banks[idx]);
252	}
253
254	if (start_scan_addr) {
255	iounmap(start_scan_addr);
256	start_scan_addr = 0;
257	}
258	}
259
260	module_init(init_tqm_mtd);
261	module_exit(cleanup_tqm_mtd);
262
263	MODULE_LICENSE("GPL");
264	MODULE_AUTHOR("Kirk Lee <kirk@hpc.ee.ntu.edu.tw>");
265	MODULE_DESCRIPTION("MTD map driver for TQM8xxL boards");