1 /*
2  *  drivers/mtd/nand/edb7312.c
3  *
4  *  Copyright (C) 2002 Marius Gr�ger (mag@sysgo.de)
5  *
6  *  Derived from drivers/mtd/nand/autcpu12.c
7  *       Copyright (c) 2001 Thomas Gleixner (gleixner@autronix.de)
8  *
9  * $Id: edb7312.c,v 1.3 2002/06/06 12:58:16 mag Exp $
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License version 2 as
13  * published by the Free Software Foundation.
14  *
15  *  Overview:
16  *   This is a device driver for the NAND flash device found on the
17  *   CLEP7312 board which utilizes the Toshiba TC58V64AFT part. This is
18  *   a 64Mibit (8MiB x 8 bits) NAND flash device.
19  */
20 
21 #include <linux/slab.h>
22 #include <linux/module.h>
23 #include <linux/mtd/mtd.h>
24 #include <linux/mtd/nand.h>
25 #include <linux/mtd/partitions.h>
26 #include <asm/io.h>
27 #include <asm/arch/hardware.h> /* for CLPS7111_VIRT_BASE */
28 #include <asm/sizes.h>
29 #include <asm/hardware/clps7111.h>
30 
31 /*
32  * MTD structure for EDB7312 board
33  */
34 static struct mtd_info *ep7312_mtd = NULL;
35 
36 /*
37  * Values specific to the EDB7312 board (used with EP7312 processor)
38  */
39 #define EP7312_FIO_PBASE 0x10000000	/* Phys address of flash */
40 #define EP7312_PXDR	0x0001	/*
41 				 * IO offset to Port B data register
42 				 * where the CLE, ALE and NCE pins
43 				 * are wired to.
44 				 */
45 #define EP7312_PXDDR	0x0041	/*
46 				 * IO offset to Port B data direction
47 				 * register so we can control the IO
48 				 * lines.
49 				 */
50 
51 /*
52  * Module stuff
53  */
54 
55 static int ep7312_fio_pbase = EP7312_FIO_PBASE;
56 static int ep7312_pxdr = EP7312_PXDR;
57 static int ep7312_pxddr = EP7312_PXDDR;
58 
59 #ifdef MODULE
60 MODULE_PARM(ep7312_fio_pbase, "i");
61 MODULE_PARM(ep7312_pxdr, "i");
62 MODULE_PARM(ep7312_pxddr, "i");
63 
64 __setup("ep7312_fio_pbase=",ep7312_fio_pbase);
65 __setup("ep7312_pxdr=",ep7312_pxdr);
66 __setup("ep7312_pxddr=",ep7312_pxddr);
67 #endif
68 
69 #ifdef CONFIG_MTD_PARTITIONS
70 /*
71  * Define static partitions for flash device
72  */
73 static struct mtd_partition partition_info[] = {
74 	{ name: "EP7312 Nand Flash",
75 		  offset: 0,
76 		  size: 8*1024*1024 }
77 };
78 #define NUM_PARTITIONS 1
79 
80 extern int parse_cmdline_partitions(struct mtd_info *master,
81 				    struct mtd_partition **pparts,
82 				    const char *mtd_id);
83 #endif
84 
85 
86 /*
87  *	hardware specific access to control-lines
88  */
ep7312_hwcontrol(int cmd)89 static void ep7312_hwcontrol(int cmd)
90 {
91 	switch(cmd) {
92 
93 	case NAND_CTL_SETCLE:
94 		clps_writeb(clps_readb(ep7312_pxdr) | 0x10, ep7312_pxdr);
95 		break;
96 	case NAND_CTL_CLRCLE:
97 		clps_writeb(clps_readb(ep7312_pxdr) & ~0x10, ep7312_pxdr);
98 		break;
99 
100 	case NAND_CTL_SETALE:
101 		clps_writeb(clps_readb(ep7312_pxdr) | 0x20, ep7312_pxdr);
102 		break;
103 	case NAND_CTL_CLRALE:
104 		clps_writeb(clps_readb(ep7312_pxdr) & ~0x20, ep7312_pxdr);
105 		break;
106 
107 	case NAND_CTL_SETNCE:
108 		clps_writeb((clps_readb(ep7312_pxdr) | 0x80) & ~0x40, ep7312_pxdr);
109 		break;
110 	case NAND_CTL_CLRNCE:
111 		clps_writeb((clps_readb(ep7312_pxdr) | 0x80) | 0x40, ep7312_pxdr);
112 		break;
113 	}
114 }
115 
116 /*
117  *	read device ready pin
118  */
ep7312_device_ready(void)119 static int ep7312_device_ready(void)
120 {
121 	return 1;
122 }
123 
124 /*
125  * Main initialization routine
126  */
ep7312_init(void)127 static int __init ep7312_init (void)
128 {
129 	struct nand_chip *this;
130 	const char *part_type = 0;
131 	int mtd_parts_nb = 0;
132 	struct mtd_partition *mtd_parts = 0;
133 	int ep7312_fio_base;
134 
135 	/* Allocate memory for MTD device structure and private data */
136 	ep7312_mtd = kmalloc(sizeof(struct mtd_info) +
137 			     sizeof(struct nand_chip),
138 			     GFP_KERNEL);
139 	if (!ep7312_mtd) {
140 		printk("Unable to allocate EDB7312 NAND MTD device structure.\n");
141 		return -ENOMEM;
142 	}
143 
144 	/* map physical adress */
145 	ep7312_fio_base = (unsigned long)ioremap(ep7312_fio_pbase, SZ_1K);
146 	if(!ep7312_fio_base) {
147 		printk("ioremap EDB7312 NAND flash failed\n");
148 		kfree(ep7312_mtd);
149 		return -EIO;
150 	}
151 
152 	/* Get pointer to private data */
153 	this = (struct nand_chip *) (&ep7312_mtd[1]);
154 
155 	/* Initialize structures */
156 	memset((char *) ep7312_mtd, 0, sizeof(struct mtd_info));
157 	memset((char *) this, 0, sizeof(struct nand_chip));
158 
159 	/* Link the private data with the MTD structure */
160 	ep7312_mtd->priv = this;
161 
162 	/*
163 	 * Set GPIO Port B control register so that the pins are configured
164 	 * to be outputs for controlling the NAND flash.
165 	 */
166 	clps_writeb(0xf0, ep7312_pxddr);
167 
168 	/* insert callbacks */
169 	this->IO_ADDR_R = ep7312_fio_base;
170 	this->IO_ADDR_W = ep7312_fio_base;
171 	this->hwcontrol = ep7312_hwcontrol;
172 	this->dev_ready = ep7312_device_ready;
173 	/* 15 us command delay time */
174 	this->chip_delay = 15;
175 
176 	/* Scan to find existence of the device */
177 	if (nand_scan (ep7312_mtd)) {
178 		iounmap((void *)ep7312_fio_base);
179 		kfree (ep7312_mtd);
180 		return -ENXIO;
181 	}
182 
183 	/* Allocate memory for internal data buffer */
184 	this->data_buf = kmalloc (sizeof(u_char) * (ep7312_mtd->oobblock + ep7312_mtd->oobsize), GFP_KERNEL);
185 	if (!this->data_buf) {
186 		printk("Unable to allocate NAND data buffer for EDB7312.\n");
187 		iounmap((void *)ep7312_fio_base);
188 		kfree (ep7312_mtd);
189 		return -ENOMEM;
190 	}
191 
192 	/* Allocate memory for internal data buffer */
193 	this->data_cache = kmalloc (sizeof(u_char) * (ep7312_mtd->oobblock + ep7312_mtd->oobsize), GFP_KERNEL);
194 	if (!this->data_cache) {
195 		printk("Unable to allocate NAND data cache for EDB7312.\n");
196 		kfree (this->data_buf);
197 		iounmap((void *)ep7312_fio_base);
198 		kfree (ep7312_mtd);
199 		return -ENOMEM;
200 	}
201 	this->cache_page = -1;
202 
203 #ifdef CONFIG_MTD_CMDLINE_PARTS
204 	mtd_parts_nb = parse_cmdline_partitions(ep7312_mtd, &mtd_parts,
205 						"edb7312-nand");
206 	if (mtd_parts_nb > 0)
207 	  part_type = "command line";
208 	else
209 	  mtd_parts_nb = 0;
210 #endif
211 	if (mtd_parts_nb == 0)
212 	{
213 		mtd_parts = partition_info;
214 		mtd_parts_nb = NUM_PARTITIONS;
215 		part_type = "static";
216 	}
217 
218 	/* Register the partitions */
219 	printk(KERN_NOTICE "Using %s partition definition\n", part_type);
220 	add_mtd_partitions(ep7312_mtd, mtd_parts, mtd_parts_nb);
221 
222 	/* Return happy */
223 	return 0;
224 }
225 module_init(ep7312_init);
226 
227 /*
228  * Clean up routine
229  */
ep7312_cleanup(void)230 static void __exit ep7312_cleanup (void)
231 {
232 	struct nand_chip *this = (struct nand_chip *) &ep7312_mtd[1];
233 
234 	/* Unregister the device */
235 	del_mtd_device (ep7312_mtd);
236 
237 	/* Free internal data buffer */
238 	kfree (this->data_buf);
239 	kfree (this->data_cache);
240 
241 	/* Free the MTD device structure */
242 	kfree (ep7312_mtd);
243 }
244 module_exit(ep7312_cleanup);
245 
246 MODULE_LICENSE("GPL");
247 MODULE_AUTHOR("Marius Groeger <mag@sysgo.de>");
248 MODULE_DESCRIPTION("MTD map driver for Cogent EDB7312 board");
249