xref: /linux/drivers/mtd/devices/pmc551.c (revision f24e9f586b377749dff37554696cf3a105540c94)
1 /*
2  * $Id: pmc551.c,v 1.32 2005/11/07 11:14:25 gleixner Exp $
3  *
4  * PMC551 PCI Mezzanine Ram Device
5  *
6  * Author:
7  *	Mark Ferrell <mferrell@mvista.com>
8  *	Copyright 1999,2000 Nortel Networks
9  *
10  * License:
11  *	As part of this driver was derived from the slram.c driver it
12  *	falls under the same license, which is GNU General Public
13  *	License v2
14  *
15  * Description:
16  *	This driver is intended to support the PMC551 PCI Ram device
17  *	from Ramix Inc.  The PMC551 is a PMC Mezzanine module for
18  *	cPCI embedded systems.  The device contains a single SROM
19  *	that initially programs the V370PDC chipset onboard the
20  *	device, and various banks of DRAM/SDRAM onboard.  This driver
21  *	implements this PCI Ram device as an MTD (Memory Technology
22  *	Device) so that it can be used to hold a file system, or for
23  *	added swap space in embedded systems.  Since the memory on
24  *	this board isn't as fast as main memory we do not try to hook
25  *	it into main memory as that would simply reduce performance
26  *	on the system.  Using it as a block device allows us to use
27  *	it as high speed swap or for a high speed disk device of some
28  *	sort.  Which becomes very useful on diskless systems in the
29  *	embedded market I might add.
30  *
31  * Notes:
32  *	Due to what I assume is more buggy SROM, the 64M PMC551 I
33  *	have available claims that all 4 of it's DRAM banks have 64M
34  *	of ram configured (making a grand total of 256M onboard).
35  *	This is slightly annoying since the BAR0 size reflects the
36  *	aperture size, not the dram size, and the V370PDC supplies no
37  *	other method for memory size discovery.  This problem is
38  *	mostly only relevant when compiled as a module, as the
39  *	unloading of the module with an aperture size smaller then
40  *	the ram will cause the driver to detect the onboard memory
41  *	size to be equal to the aperture size when the module is
42  *	reloaded.  Soooo, to help, the module supports an msize
43  *	option to allow the specification of the onboard memory, and
44  *	an asize option, to allow the specification of the aperture
45  *	size.  The aperture must be equal to or less then the memory
46  *	size, the driver will correct this if you screw it up.  This
47  *	problem is not relevant for compiled in drivers as compiled
48  *	in drivers only init once.
49  *
50  * Credits:
51  *	Saeed Karamooz <saeed@ramix.com> of Ramix INC. for the
52  *	initial example code of how to initialize this device and for
53  *	help with questions I had concerning operation of the device.
54  *
55  *	Most of the MTD code for this driver was originally written
56  *	for the slram.o module in the MTD drivers package which
57  *	allows the mapping of system memory into an MTD device.
58  *	Since the PMC551 memory module is accessed in the same
59  *	fashion as system memory, the slram.c code became a very nice
60  *	fit to the needs of this driver.  All we added was PCI
61  *	detection/initialization to the driver and automatically figure
62  *	out the size via the PCI detection.o, later changes by Corey
63  *	Minyard set up the card to utilize a 1M sliding apature.
64  *
65  *	Corey Minyard <minyard@nortelnetworks.com>
66  *	* Modified driver to utilize a sliding aperture instead of
67  *	 mapping all memory into kernel space which turned out to
68  *	 be very wasteful.
69  *	* Located a bug in the SROM's initialization sequence that
70  *	 made the memory unusable, added a fix to code to touch up
71  *	 the DRAM some.
72  *
73  * Bugs/FIXME's:
74  *	* MUST fix the init function to not spin on a register
75  *	waiting for it to set .. this does not safely handle busted
76  *	devices that never reset the register correctly which will
77  *	cause the system to hang w/ a reboot being the only chance at
78  *	recover. [sort of fixed, could be better]
79  *	* Add I2C handling of the SROM so we can read the SROM's information
80  *	about the aperture size.  This should always accurately reflect the
81  *	onboard memory size.
82  *	* Comb the init routine.  It's still a bit cludgy on a few things.
83  */
84 
85 #include <linux/kernel.h>
86 #include <linux/module.h>
87 #include <asm/uaccess.h>
88 #include <linux/types.h>
89 #include <linux/sched.h>
90 #include <linux/init.h>
91 #include <linux/ptrace.h>
92 #include <linux/slab.h>
93 #include <linux/string.h>
94 #include <linux/timer.h>
95 #include <linux/major.h>
96 #include <linux/fs.h>
97 #include <linux/ioctl.h>
98 #include <asm/io.h>
99 #include <asm/system.h>
100 #include <linux/pci.h>
101 
102 #include <linux/mtd/mtd.h>
103 #include <linux/mtd/pmc551.h>
104 #include <linux/mtd/compatmac.h>
105 
106 static struct mtd_info *pmc551list;
107 
108 static int pmc551_erase(struct mtd_info *mtd, struct erase_info *instr)
109 {
110 	struct mypriv *priv = mtd->priv;
111 	u32 soff_hi, soff_lo;	/* start address offset hi/lo */
112 	u32 eoff_hi, eoff_lo;	/* end address offset hi/lo */
113 	unsigned long end;
114 	u_char *ptr;
115 	size_t retlen;
116 
117 #ifdef CONFIG_MTD_PMC551_DEBUG
118 	printk(KERN_DEBUG "pmc551_erase(pos:%ld, len:%ld)\n", (long)instr->addr,
119 		(long)instr->len);
120 #endif
121 
122 	end = instr->addr + instr->len - 1;
123 
124 	/* Is it past the end? */
125 	if (end > mtd->size) {
126 #ifdef CONFIG_MTD_PMC551_DEBUG
127 		printk(KERN_DEBUG "pmc551_erase() out of bounds (%ld > %ld)\n",
128 			(long)end, (long)mtd->size);
129 #endif
130 		return -EINVAL;
131 	}
132 
133 	eoff_hi = end & ~(priv->asize - 1);
134 	soff_hi = instr->addr & ~(priv->asize - 1);
135 	eoff_lo = end & (priv->asize - 1);
136 	soff_lo = instr->addr & (priv->asize - 1);
137 
138 	pmc551_point(mtd, instr->addr, instr->len, &retlen, &ptr);
139 
140 	if (soff_hi == eoff_hi || mtd->size == priv->asize) {
141 		/* The whole thing fits within one access, so just one shot
142 		   will do it. */
143 		memset(ptr, 0xff, instr->len);
144 	} else {
145 		/* We have to do multiple writes to get all the data
146 		   written. */
147 		while (soff_hi != eoff_hi) {
148 #ifdef CONFIG_MTD_PMC551_DEBUG
149 			printk(KERN_DEBUG "pmc551_erase() soff_hi: %ld, "
150 				"eoff_hi: %ld\n", (long)soff_hi, (long)eoff_hi);
151 #endif
152 			memset(ptr, 0xff, priv->asize);
153 			if (soff_hi + priv->asize >= mtd->size) {
154 				goto out;
155 			}
156 			soff_hi += priv->asize;
157 			pmc551_point(mtd, (priv->base_map0 | soff_hi),
158 				     priv->asize, &retlen, &ptr);
159 		}
160 		memset(ptr, 0xff, eoff_lo);
161 	}
162 
163       out:
164 	instr->state = MTD_ERASE_DONE;
165 #ifdef CONFIG_MTD_PMC551_DEBUG
166 	printk(KERN_DEBUG "pmc551_erase() done\n");
167 #endif
168 
169 	mtd_erase_callback(instr);
170 	return 0;
171 }
172 
173 static int pmc551_point(struct mtd_info *mtd, loff_t from, size_t len,
174 			size_t * retlen, u_char ** mtdbuf)
175 {
176 	struct mypriv *priv = mtd->priv;
177 	u32 soff_hi;
178 	u32 soff_lo;
179 
180 #ifdef CONFIG_MTD_PMC551_DEBUG
181 	printk(KERN_DEBUG "pmc551_point(%ld, %ld)\n", (long)from, (long)len);
182 #endif
183 
184 	if (from + len > mtd->size) {
185 #ifdef CONFIG_MTD_PMC551_DEBUG
186 		printk(KERN_DEBUG "pmc551_point() out of bounds (%ld > %ld)\n",
187 			(long)from + len, (long)mtd->size);
188 #endif
189 		return -EINVAL;
190 	}
191 
192 	soff_hi = from & ~(priv->asize - 1);
193 	soff_lo = from & (priv->asize - 1);
194 
195 	/* Cheap hack optimization */
196 	if (priv->curr_map0 != from) {
197 		pci_write_config_dword(priv->dev, PMC551_PCI_MEM_MAP0,
198 					(priv->base_map0 | soff_hi));
199 		priv->curr_map0 = soff_hi;
200 	}
201 
202 	*mtdbuf = priv->start + soff_lo;
203 	*retlen = len;
204 	return 0;
205 }
206 
207 static void pmc551_unpoint(struct mtd_info *mtd, u_char * addr, loff_t from,
208 			   size_t len)
209 {
210 #ifdef CONFIG_MTD_PMC551_DEBUG
211 	printk(KERN_DEBUG "pmc551_unpoint()\n");
212 #endif
213 }
214 
215 static int pmc551_read(struct mtd_info *mtd, loff_t from, size_t len,
216 			size_t * retlen, u_char * buf)
217 {
218 	struct mypriv *priv = mtd->priv;
219 	u32 soff_hi, soff_lo;	/* start address offset hi/lo */
220 	u32 eoff_hi, eoff_lo;	/* end address offset hi/lo */
221 	unsigned long end;
222 	u_char *ptr;
223 	u_char *copyto = buf;
224 
225 #ifdef CONFIG_MTD_PMC551_DEBUG
226 	printk(KERN_DEBUG "pmc551_read(pos:%ld, len:%ld) asize: %ld\n",
227 		(long)from, (long)len, (long)priv->asize);
228 #endif
229 
230 	end = from + len - 1;
231 
232 	/* Is it past the end? */
233 	if (end > mtd->size) {
234 #ifdef CONFIG_MTD_PMC551_DEBUG
235 		printk(KERN_DEBUG "pmc551_read() out of bounds (%ld > %ld)\n",
236 			(long)end, (long)mtd->size);
237 #endif
238 		return -EINVAL;
239 	}
240 
241 	soff_hi = from & ~(priv->asize - 1);
242 	eoff_hi = end & ~(priv->asize - 1);
243 	soff_lo = from & (priv->asize - 1);
244 	eoff_lo = end & (priv->asize - 1);
245 
246 	pmc551_point(mtd, from, len, retlen, &ptr);
247 
248 	if (soff_hi == eoff_hi) {
249 		/* The whole thing fits within one access, so just one shot
250 		   will do it. */
251 		memcpy(copyto, ptr, len);
252 		copyto += len;
253 	} else {
254 		/* We have to do multiple writes to get all the data
255 		   written. */
256 		while (soff_hi != eoff_hi) {
257 #ifdef CONFIG_MTD_PMC551_DEBUG
258 			printk(KERN_DEBUG "pmc551_read() soff_hi: %ld, "
259 				"eoff_hi: %ld\n", (long)soff_hi, (long)eoff_hi);
260 #endif
261 			memcpy(copyto, ptr, priv->asize);
262 			copyto += priv->asize;
263 			if (soff_hi + priv->asize >= mtd->size) {
264 				goto out;
265 			}
266 			soff_hi += priv->asize;
267 			pmc551_point(mtd, soff_hi, priv->asize, retlen, &ptr);
268 		}
269 		memcpy(copyto, ptr, eoff_lo);
270 		copyto += eoff_lo;
271 	}
272 
273       out:
274 #ifdef CONFIG_MTD_PMC551_DEBUG
275 	printk(KERN_DEBUG "pmc551_read() done\n");
276 #endif
277 	*retlen = copyto - buf;
278 	return 0;
279 }
280 
281 static int pmc551_write(struct mtd_info *mtd, loff_t to, size_t len,
282 			size_t * retlen, const u_char * buf)
283 {
284 	struct mypriv *priv = mtd->priv;
285 	u32 soff_hi, soff_lo;	/* start address offset hi/lo */
286 	u32 eoff_hi, eoff_lo;	/* end address offset hi/lo */
287 	unsigned long end;
288 	u_char *ptr;
289 	const u_char *copyfrom = buf;
290 
291 #ifdef CONFIG_MTD_PMC551_DEBUG
292 	printk(KERN_DEBUG "pmc551_write(pos:%ld, len:%ld) asize:%ld\n",
293 		(long)to, (long)len, (long)priv->asize);
294 #endif
295 
296 	end = to + len - 1;
297 	/* Is it past the end?  or did the u32 wrap? */
298 	if (end > mtd->size) {
299 #ifdef CONFIG_MTD_PMC551_DEBUG
300 		printk(KERN_DEBUG "pmc551_write() out of bounds (end: %ld, "
301 			"size: %ld, to: %ld)\n", (long)end, (long)mtd->size,
302 			(long)to);
303 #endif
304 		return -EINVAL;
305 	}
306 
307 	soff_hi = to & ~(priv->asize - 1);
308 	eoff_hi = end & ~(priv->asize - 1);
309 	soff_lo = to & (priv->asize - 1);
310 	eoff_lo = end & (priv->asize - 1);
311 
312 	pmc551_point(mtd, to, len, retlen, &ptr);
313 
314 	if (soff_hi == eoff_hi) {
315 		/* The whole thing fits within one access, so just one shot
316 		   will do it. */
317 		memcpy(ptr, copyfrom, len);
318 		copyfrom += len;
319 	} else {
320 		/* We have to do multiple writes to get all the data
321 		   written. */
322 		while (soff_hi != eoff_hi) {
323 #ifdef CONFIG_MTD_PMC551_DEBUG
324 			printk(KERN_DEBUG "pmc551_write() soff_hi: %ld, "
325 				"eoff_hi: %ld\n", (long)soff_hi, (long)eoff_hi);
326 #endif
327 			memcpy(ptr, copyfrom, priv->asize);
328 			copyfrom += priv->asize;
329 			if (soff_hi >= mtd->size) {
330 				goto out;
331 			}
332 			soff_hi += priv->asize;
333 			pmc551_point(mtd, soff_hi, priv->asize, retlen, &ptr);
334 		}
335 		memcpy(ptr, copyfrom, eoff_lo);
336 		copyfrom += eoff_lo;
337 	}
338 
339       out:
340 #ifdef CONFIG_MTD_PMC551_DEBUG
341 	printk(KERN_DEBUG "pmc551_write() done\n");
342 #endif
343 	*retlen = copyfrom - buf;
344 	return 0;
345 }
346 
347 /*
348  * Fixup routines for the V370PDC
349  * PCI device ID 0x020011b0
350  *
351  * This function basicly kick starts the DRAM oboard the card and gets it
352  * ready to be used.  Before this is done the device reads VERY erratic, so
353  * much that it can crash the Linux 2.2.x series kernels when a user cat's
354  * /proc/pci .. though that is mainly a kernel bug in handling the PCI DEVSEL
355  * register.  FIXME: stop spinning on registers .. must implement a timeout
356  * mechanism
357  * returns the size of the memory region found.
358  */
359 static u32 fixup_pmc551(struct pci_dev *dev)
360 {
361 #ifdef CONFIG_MTD_PMC551_BUGFIX
362 	u32 dram_data;
363 #endif
364 	u32 size, dcmd, cfg, dtmp;
365 	u16 cmd, tmp, i;
366 	u8 bcmd, counter;
367 
368 	/* Sanity Check */
369 	if (!dev) {
370 		return -ENODEV;
371 	}
372 
373 	/*
374 	 * Attempt to reset the card
375 	 * FIXME: Stop Spinning registers
376 	 */
377 	counter = 0;
378 	/* unlock registers */
379 	pci_write_config_byte(dev, PMC551_SYS_CTRL_REG, 0xA5);
380 	/* read in old data */
381 	pci_read_config_byte(dev, PMC551_SYS_CTRL_REG, &bcmd);
382 	/* bang the reset line up and down for a few */
383 	for (i = 0; i < 10; i++) {
384 		counter = 0;
385 		bcmd &= ~0x80;
386 		while (counter++ < 100) {
387 			pci_write_config_byte(dev, PMC551_SYS_CTRL_REG, bcmd);
388 		}
389 		counter = 0;
390 		bcmd |= 0x80;
391 		while (counter++ < 100) {
392 			pci_write_config_byte(dev, PMC551_SYS_CTRL_REG, bcmd);
393 		}
394 	}
395 	bcmd |= (0x40 | 0x20);
396 	pci_write_config_byte(dev, PMC551_SYS_CTRL_REG, bcmd);
397 
398 	/*
399 	 * Take care and turn off the memory on the device while we
400 	 * tweak the configurations
401 	 */
402 	pci_read_config_word(dev, PCI_COMMAND, &cmd);
403 	tmp = cmd & ~(PCI_COMMAND_IO | PCI_COMMAND_MEMORY);
404 	pci_write_config_word(dev, PCI_COMMAND, tmp);
405 
406 	/*
407 	 * Disable existing aperture before probing memory size
408 	 */
409 	pci_read_config_dword(dev, PMC551_PCI_MEM_MAP0, &dcmd);
410 	dtmp = (dcmd | PMC551_PCI_MEM_MAP_ENABLE | PMC551_PCI_MEM_MAP_REG_EN);
411 	pci_write_config_dword(dev, PMC551_PCI_MEM_MAP0, dtmp);
412 	/*
413 	 * Grab old BAR0 config so that we can figure out memory size
414 	 * This is another bit of kludge going on.  The reason for the
415 	 * redundancy is I am hoping to retain the original configuration
416 	 * previously assigned to the card by the BIOS or some previous
417 	 * fixup routine in the kernel.  So we read the old config into cfg,
418 	 * then write all 1's to the memory space, read back the result into
419 	 * "size", and then write back all the old config.
420 	 */
421 	pci_read_config_dword(dev, PCI_BASE_ADDRESS_0, &cfg);
422 #ifndef CONFIG_MTD_PMC551_BUGFIX
423 	pci_write_config_dword(dev, PCI_BASE_ADDRESS_0, ~0);
424 	pci_read_config_dword(dev, PCI_BASE_ADDRESS_0, &size);
425 	size = (size & PCI_BASE_ADDRESS_MEM_MASK);
426 	size &= ~(size - 1);
427 	pci_write_config_dword(dev, PCI_BASE_ADDRESS_0, cfg);
428 #else
429 	/*
430 	 * Get the size of the memory by reading all the DRAM size values
431 	 * and adding them up.
432 	 *
433 	 * KLUDGE ALERT: the boards we are using have invalid column and
434 	 * row mux values.  We fix them here, but this will break other
435 	 * memory configurations.
436 	 */
437 	pci_read_config_dword(dev, PMC551_DRAM_BLK0, &dram_data);
438 	size = PMC551_DRAM_BLK_GET_SIZE(dram_data);
439 	dram_data = PMC551_DRAM_BLK_SET_COL_MUX(dram_data, 0x5);
440 	dram_data = PMC551_DRAM_BLK_SET_ROW_MUX(dram_data, 0x9);
441 	pci_write_config_dword(dev, PMC551_DRAM_BLK0, dram_data);
442 
443 	pci_read_config_dword(dev, PMC551_DRAM_BLK1, &dram_data);
444 	size += PMC551_DRAM_BLK_GET_SIZE(dram_data);
445 	dram_data = PMC551_DRAM_BLK_SET_COL_MUX(dram_data, 0x5);
446 	dram_data = PMC551_DRAM_BLK_SET_ROW_MUX(dram_data, 0x9);
447 	pci_write_config_dword(dev, PMC551_DRAM_BLK1, dram_data);
448 
449 	pci_read_config_dword(dev, PMC551_DRAM_BLK2, &dram_data);
450 	size += PMC551_DRAM_BLK_GET_SIZE(dram_data);
451 	dram_data = PMC551_DRAM_BLK_SET_COL_MUX(dram_data, 0x5);
452 	dram_data = PMC551_DRAM_BLK_SET_ROW_MUX(dram_data, 0x9);
453 	pci_write_config_dword(dev, PMC551_DRAM_BLK2, dram_data);
454 
455 	pci_read_config_dword(dev, PMC551_DRAM_BLK3, &dram_data);
456 	size += PMC551_DRAM_BLK_GET_SIZE(dram_data);
457 	dram_data = PMC551_DRAM_BLK_SET_COL_MUX(dram_data, 0x5);
458 	dram_data = PMC551_DRAM_BLK_SET_ROW_MUX(dram_data, 0x9);
459 	pci_write_config_dword(dev, PMC551_DRAM_BLK3, dram_data);
460 
461 	/*
462 	 * Oops .. something went wrong
463 	 */
464 	if ((size &= PCI_BASE_ADDRESS_MEM_MASK) == 0) {
465 		return -ENODEV;
466 	}
467 #endif				/* CONFIG_MTD_PMC551_BUGFIX */
468 
469 	if ((cfg & PCI_BASE_ADDRESS_SPACE) != PCI_BASE_ADDRESS_SPACE_MEMORY) {
470 		return -ENODEV;
471 	}
472 
473 	/*
474 	 * Precharge Dram
475 	 */
476 	pci_write_config_word(dev, PMC551_SDRAM_MA, 0x0400);
477 	pci_write_config_word(dev, PMC551_SDRAM_CMD, 0x00bf);
478 
479 	/*
480 	 * Wait until command has gone through
481 	 * FIXME: register spinning issue
482 	 */
483 	do {
484 		pci_read_config_word(dev, PMC551_SDRAM_CMD, &cmd);
485 		if (counter++ > 100)
486 			break;
487 	} while ((PCI_COMMAND_IO) & cmd);
488 
489 	/*
490 	 * Turn on auto refresh
491 	 * The loop is taken directly from Ramix's example code.  I assume that
492 	 * this must be held high for some duration of time, but I can find no
493 	 * documentation refrencing the reasons why.
494 	 */
495 	for (i = 1; i <= 8; i++) {
496 		pci_write_config_word(dev, PMC551_SDRAM_CMD, 0x0df);
497 
498 		/*
499 		 * Make certain command has gone through
500 		 * FIXME: register spinning issue
501 		 */
502 		counter = 0;
503 		do {
504 			pci_read_config_word(dev, PMC551_SDRAM_CMD, &cmd);
505 			if (counter++ > 100)
506 				break;
507 		} while ((PCI_COMMAND_IO) & cmd);
508 	}
509 
510 	pci_write_config_word(dev, PMC551_SDRAM_MA, 0x0020);
511 	pci_write_config_word(dev, PMC551_SDRAM_CMD, 0x0ff);
512 
513 	/*
514 	 * Wait until command completes
515 	 * FIXME: register spinning issue
516 	 */
517 	counter = 0;
518 	do {
519 		pci_read_config_word(dev, PMC551_SDRAM_CMD, &cmd);
520 		if (counter++ > 100)
521 			break;
522 	} while ((PCI_COMMAND_IO) & cmd);
523 
524 	pci_read_config_dword(dev, PMC551_DRAM_CFG, &dcmd);
525 	dcmd |= 0x02000000;
526 	pci_write_config_dword(dev, PMC551_DRAM_CFG, dcmd);
527 
528 	/*
529 	 * Check to make certain fast back-to-back, if not
530 	 * then set it so
531 	 */
532 	pci_read_config_word(dev, PCI_STATUS, &cmd);
533 	if ((cmd & PCI_COMMAND_FAST_BACK) == 0) {
534 		cmd |= PCI_COMMAND_FAST_BACK;
535 		pci_write_config_word(dev, PCI_STATUS, cmd);
536 	}
537 
538 	/*
539 	 * Check to make certain the DEVSEL is set correctly, this device
540 	 * has a tendancy to assert DEVSEL and TRDY when a write is performed
541 	 * to the memory when memory is read-only
542 	 */
543 	if ((cmd & PCI_STATUS_DEVSEL_MASK) != 0x0) {
544 		cmd &= ~PCI_STATUS_DEVSEL_MASK;
545 		pci_write_config_word(dev, PCI_STATUS, cmd);
546 	}
547 	/*
548 	 * Set to be prefetchable and put everything back based on old cfg.
549 	 * it's possible that the reset of the V370PDC nuked the original
550 	 * setup
551 	 */
552 	/*
553 	   cfg |= PCI_BASE_ADDRESS_MEM_PREFETCH;
554 	   pci_write_config_dword( dev, PCI_BASE_ADDRESS_0, cfg );
555 	 */
556 
557 	/*
558 	 * Turn PCI memory and I/O bus access back on
559 	 */
560 	pci_write_config_word(dev, PCI_COMMAND,
561 			      PCI_COMMAND_MEMORY | PCI_COMMAND_IO);
562 #ifdef CONFIG_MTD_PMC551_DEBUG
563 	/*
564 	 * Some screen fun
565 	 */
566 	printk(KERN_DEBUG "pmc551: %d%c (0x%x) of %sprefetchable memory at "
567 		"0x%llx\n", (size < 1024) ? size : (size < 1048576) ?
568 		size >> 10 : size >> 20,
569 		(size < 1024) ? 'B' : (size < 1048576) ? 'K' : 'M', size,
570 		((dcmd & (0x1 << 3)) == 0) ? "non-" : "",
571 		(unsigned long long)pci_resource_start(dev, 0));
572 
573 	/*
574 	 * Check to see the state of the memory
575 	 */
576 	pci_read_config_dword(dev, PMC551_DRAM_BLK0, &dcmd);
577 	printk(KERN_DEBUG "pmc551: DRAM_BLK0 Flags: %s,%s\n"
578 		"pmc551: DRAM_BLK0 Size: %d at %d\n"
579 		"pmc551: DRAM_BLK0 Row MUX: %d, Col MUX: %d\n",
580 		(((0x1 << 1) & dcmd) == 0) ? "RW" : "RO",
581 		(((0x1 << 0) & dcmd) == 0) ? "Off" : "On",
582 		PMC551_DRAM_BLK_GET_SIZE(dcmd),
583 		((dcmd >> 20) & 0x7FF), ((dcmd >> 13) & 0x7),
584 		((dcmd >> 9) & 0xF));
585 
586 	pci_read_config_dword(dev, PMC551_DRAM_BLK1, &dcmd);
587 	printk(KERN_DEBUG "pmc551: DRAM_BLK1 Flags: %s,%s\n"
588 		"pmc551: DRAM_BLK1 Size: %d at %d\n"
589 		"pmc551: DRAM_BLK1 Row MUX: %d, Col MUX: %d\n",
590 		(((0x1 << 1) & dcmd) == 0) ? "RW" : "RO",
591 		(((0x1 << 0) & dcmd) == 0) ? "Off" : "On",
592 		PMC551_DRAM_BLK_GET_SIZE(dcmd),
593 		((dcmd >> 20) & 0x7FF), ((dcmd >> 13) & 0x7),
594 		((dcmd >> 9) & 0xF));
595 
596 	pci_read_config_dword(dev, PMC551_DRAM_BLK2, &dcmd);
597 	printk(KERN_DEBUG "pmc551: DRAM_BLK2 Flags: %s,%s\n"
598 		"pmc551: DRAM_BLK2 Size: %d at %d\n"
599 		"pmc551: DRAM_BLK2 Row MUX: %d, Col MUX: %d\n",
600 		(((0x1 << 1) & dcmd) == 0) ? "RW" : "RO",
601 		(((0x1 << 0) & dcmd) == 0) ? "Off" : "On",
602 		PMC551_DRAM_BLK_GET_SIZE(dcmd),
603 		((dcmd >> 20) & 0x7FF), ((dcmd >> 13) & 0x7),
604 		((dcmd >> 9) & 0xF));
605 
606 	pci_read_config_dword(dev, PMC551_DRAM_BLK3, &dcmd);
607 	printk(KERN_DEBUG "pmc551: DRAM_BLK3 Flags: %s,%s\n"
608 		"pmc551: DRAM_BLK3 Size: %d at %d\n"
609 		"pmc551: DRAM_BLK3 Row MUX: %d, Col MUX: %d\n",
610 		(((0x1 << 1) & dcmd) == 0) ? "RW" : "RO",
611 		(((0x1 << 0) & dcmd) == 0) ? "Off" : "On",
612 		PMC551_DRAM_BLK_GET_SIZE(dcmd),
613 		((dcmd >> 20) & 0x7FF), ((dcmd >> 13) & 0x7),
614 		((dcmd >> 9) & 0xF));
615 
616 	pci_read_config_word(dev, PCI_COMMAND, &cmd);
617 	printk(KERN_DEBUG "pmc551: Memory Access %s\n",
618 		(((0x1 << 1) & cmd) == 0) ? "off" : "on");
619 	printk(KERN_DEBUG "pmc551: I/O Access %s\n",
620 		(((0x1 << 0) & cmd) == 0) ? "off" : "on");
621 
622 	pci_read_config_word(dev, PCI_STATUS, &cmd);
623 	printk(KERN_DEBUG "pmc551: Devsel %s\n",
624 		((PCI_STATUS_DEVSEL_MASK & cmd) == 0x000) ? "Fast" :
625 		((PCI_STATUS_DEVSEL_MASK & cmd) == 0x200) ? "Medium" :
626 		((PCI_STATUS_DEVSEL_MASK & cmd) == 0x400) ? "Slow" : "Invalid");
627 
628 	printk(KERN_DEBUG "pmc551: %sFast Back-to-Back\n",
629 		((PCI_COMMAND_FAST_BACK & cmd) == 0) ? "Not " : "");
630 
631 	pci_read_config_byte(dev, PMC551_SYS_CTRL_REG, &bcmd);
632 	printk(KERN_DEBUG "pmc551: EEPROM is under %s control\n"
633 		"pmc551: System Control Register is %slocked to PCI access\n"
634 		"pmc551: System Control Register is %slocked to EEPROM access\n",
635 		(bcmd & 0x1) ? "software" : "hardware",
636 		(bcmd & 0x20) ? "" : "un", (bcmd & 0x40) ? "" : "un");
637 #endif
638 	return size;
639 }
640 
641 /*
642  * Kernel version specific module stuffages
643  */
644 
645 MODULE_LICENSE("GPL");
646 MODULE_AUTHOR("Mark Ferrell <mferrell@mvista.com>");
647 MODULE_DESCRIPTION(PMC551_VERSION);
648 
649 /*
650  * Stuff these outside the ifdef so as to not bust compiled in driver support
651  */
652 static int msize = 0;
653 #if defined(CONFIG_MTD_PMC551_APERTURE_SIZE)
654 static int asize = CONFIG_MTD_PMC551_APERTURE_SIZE
655 #else
656 static int asize = 0;
657 #endif
658 
659 module_param(msize, int, 0);
660 MODULE_PARM_DESC(msize, "memory size in Megabytes [1 - 1024]");
661 module_param(asize, int, 0);
662 MODULE_PARM_DESC(asize, "aperture size, must be <= memsize [1-1024]");
663 
664 /*
665  * PMC551 Card Initialization
666  */
667 static int __init init_pmc551(void)
668 {
669 	struct pci_dev *PCI_Device = NULL;
670 	struct mypriv *priv;
671 	int count, found = 0;
672 	struct mtd_info *mtd;
673 	u32 length = 0;
674 
675 	if (msize) {
676 		msize = (1 << (ffs(msize) - 1)) << 20;
677 		if (msize > (1 << 30)) {
678 			printk(KERN_NOTICE "pmc551: Invalid memory size [%d]\n",
679 				msize);
680 			return -EINVAL;
681 		}
682 	}
683 
684 	if (asize) {
685 		asize = (1 << (ffs(asize) - 1)) << 20;
686 		if (asize > (1 << 30)) {
687 			printk(KERN_NOTICE "pmc551: Invalid aperture size "
688 				"[%d]\n", asize);
689 			return -EINVAL;
690 		}
691 	}
692 
693 	printk(KERN_INFO PMC551_VERSION);
694 
695 	/*
696 	 * PCU-bus chipset probe.
697 	 */
698 	for (count = 0; count < MAX_MTD_DEVICES; count++) {
699 
700 		if ((PCI_Device = pci_get_device(PCI_VENDOR_ID_V3_SEMI,
701 						  PCI_DEVICE_ID_V3_SEMI_V370PDC,
702 						  PCI_Device)) == NULL) {
703 			break;
704 		}
705 
706 		printk(KERN_NOTICE "pmc551: Found PCI V370PDC at 0x%llx\n",
707 			(unsigned long long)pci_resource_start(PCI_Device, 0));
708 
709 		/*
710 		 * The PMC551 device acts VERY weird if you don't init it
711 		 * first.  i.e. it will not correctly report devsel.  If for
712 		 * some reason the sdram is in a wrote-protected state the
713 		 * device will DEVSEL when it is written to causing problems
714 		 * with the oldproc.c driver in
715 		 * some kernels (2.2.*)
716 		 */
717 		if ((length = fixup_pmc551(PCI_Device)) <= 0) {
718 			printk(KERN_NOTICE "pmc551: Cannot init SDRAM\n");
719 			break;
720 		}
721 
722 		/*
723 		 * This is needed until the driver is capable of reading the
724 		 * onboard I2C SROM to discover the "real" memory size.
725 		 */
726 		if (msize) {
727 			length = msize;
728 			printk(KERN_NOTICE "pmc551: Using specified memory "
729 				"size 0x%x\n", length);
730 		} else {
731 			msize = length;
732 		}
733 
734 		mtd = kzalloc(sizeof(struct mtd_info), GFP_KERNEL);
735 		if (!mtd) {
736 			printk(KERN_NOTICE "pmc551: Cannot allocate new MTD "
737 				"device.\n");
738 			break;
739 		}
740 
741 		priv = kzalloc(sizeof(struct mypriv), GFP_KERNEL);
742 		if (!priv) {
743 			printk(KERN_NOTICE "pmc551: Cannot allocate new MTD "
744 				"device.\n");
745 			kfree(mtd);
746 			break;
747 		}
748 		mtd->priv = priv;
749 		priv->dev = PCI_Device;
750 
751 		if (asize > length) {
752 			printk(KERN_NOTICE "pmc551: reducing aperture size to "
753 				"fit %dM\n", length >> 20);
754 			priv->asize = asize = length;
755 		} else if (asize == 0 || asize == length) {
756 			printk(KERN_NOTICE "pmc551: Using existing aperture "
757 				"size %dM\n", length >> 20);
758 			priv->asize = asize = length;
759 		} else {
760 			printk(KERN_NOTICE "pmc551: Using specified aperture "
761 				"size %dM\n", asize >> 20);
762 			priv->asize = asize;
763 		}
764 		priv->start = pci_iomap(PCI_Device, 0, priv->asize);
765 
766 		if (!priv->start) {
767 			printk(KERN_NOTICE "pmc551: Unable to map IO space\n");
768 			kfree(mtd->priv);
769 			kfree(mtd);
770 			break;
771 		}
772 #ifdef CONFIG_MTD_PMC551_DEBUG
773 		printk(KERN_DEBUG "pmc551: setting aperture to %d\n",
774 			ffs(priv->asize >> 20) - 1);
775 #endif
776 
777 		priv->base_map0 = (PMC551_PCI_MEM_MAP_REG_EN
778 				   | PMC551_PCI_MEM_MAP_ENABLE
779 				   | (ffs(priv->asize >> 20) - 1) << 4);
780 		priv->curr_map0 = priv->base_map0;
781 		pci_write_config_dword(priv->dev, PMC551_PCI_MEM_MAP0,
782 					priv->curr_map0);
783 
784 #ifdef CONFIG_MTD_PMC551_DEBUG
785 		printk(KERN_DEBUG "pmc551: aperture set to %d\n",
786 			(priv->base_map0 & 0xF0) >> 4);
787 #endif
788 
789 		mtd->size = msize;
790 		mtd->flags = MTD_CAP_RAM;
791 		mtd->erase = pmc551_erase;
792 		mtd->read = pmc551_read;
793 		mtd->write = pmc551_write;
794 		mtd->point = pmc551_point;
795 		mtd->unpoint = pmc551_unpoint;
796 		mtd->type = MTD_RAM;
797 		mtd->name = "PMC551 RAM board";
798 		mtd->erasesize = 0x10000;
799 		mtd->writesize = 1;
800 		mtd->owner = THIS_MODULE;
801 
802 		if (add_mtd_device(mtd)) {
803 			printk(KERN_NOTICE "pmc551: Failed to register new "
804 				"device\n");
805 			pci_iounmap(PCI_Device, priv->start);
806 			kfree(mtd->priv);
807 			kfree(mtd);
808 			break;
809 		}
810 
811 		/* Keep a reference as the add_mtd_device worked */
812 		pci_dev_get(PCI_Device);
813 
814 		printk(KERN_NOTICE "Registered pmc551 memory device.\n");
815 		printk(KERN_NOTICE "Mapped %dM of memory from 0x%p to 0x%p\n",
816 			priv->asize >> 20,
817 			priv->start, priv->start + priv->asize);
818 		printk(KERN_NOTICE "Total memory is %d%c\n",
819 			(length < 1024) ? length :
820 			(length < 1048576) ? length >> 10 : length >> 20,
821 			(length < 1024) ? 'B' : (length < 1048576) ? 'K' : 'M');
822 		priv->nextpmc551 = pmc551list;
823 		pmc551list = mtd;
824 		found++;
825 	}
826 
827 	/* Exited early, reference left over */
828 	if (PCI_Device)
829 		pci_dev_put(PCI_Device);
830 
831 	if (!pmc551list) {
832 		printk(KERN_NOTICE "pmc551: not detected\n");
833 		return -ENODEV;
834 	} else {
835 		printk(KERN_NOTICE "pmc551: %d pmc551 devices loaded\n", found);
836 		return 0;
837 	}
838 }
839 
840 /*
841  * PMC551 Card Cleanup
842  */
843 static void __exit cleanup_pmc551(void)
844 {
845 	int found = 0;
846 	struct mtd_info *mtd;
847 	struct mypriv *priv;
848 
849 	while ((mtd = pmc551list)) {
850 		priv = mtd->priv;
851 		pmc551list = priv->nextpmc551;
852 
853 		if (priv->start) {
854 			printk(KERN_DEBUG "pmc551: unmapping %dM starting at "
855 				"0x%p\n", priv->asize >> 20, priv->start);
856 			pci_iounmap(priv->dev, priv->start);
857 		}
858 		pci_dev_put(priv->dev);
859 
860 		kfree(mtd->priv);
861 		del_mtd_device(mtd);
862 		kfree(mtd);
863 		found++;
864 	}
865 
866 	printk(KERN_NOTICE "pmc551: %d pmc551 devices unloaded\n", found);
867 }
868 
869 module_init(init_pmc551);
870 module_exit(cleanup_pmc551);
871