2 * Flash memory interface rev.5 driver for the Intel
3 * Flash chips used on the NetWinder.
5 * 20/08/2000 RMK use __ioremap to map flash into virtual memory
6 * make a few more places use "volatile"
7 * 22/05/2001 RMK - Lock read against write
8 * - merge printk level changes (with mods) from Alan Cox.
9 * - use *ppos as the file position, not file->f_pos.
10 * - fix check for out of range pos and r/w size
12 * Please note that we are tampering with the only flash chip in the
13 * machine, which contains the bootup code. We therefore have the
14 * power to convert these machines into doorstops...
17 #include <linux/module.h>
18 #include <linux/types.h>
20 #include <linux/errno.h>
22 #include <linux/delay.h>
23 #include <linux/proc_fs.h>
24 #include <linux/miscdevice.h>
25 #include <linux/spinlock.h>
26 #include <linux/rwsem.h>
27 #include <linux/init.h>
28 #include <linux/smp_lock.h>
29 #include <linux/mutex.h>
31 #include <asm/hardware/dec21285.h>
34 #include <asm/mach-types.h>
35 #include <asm/system.h>
36 #include <asm/uaccess.h>
38 /*****************************************************************************/
39 #include <asm/nwflash.h>
41 #define NWFLASH_VERSION "6.4"
43 static void kick_open(void);
44 static int get_flash_id(void);
45 static int erase_block(int nBlock);
46 static int write_block(unsigned long p, const char __user *buf, int count);
48 #define KFLASH_SIZE 1024*1024 //1 Meg
49 #define KFLASH_SIZE4 4*1024*1024 //4 Meg
50 #define KFLASH_ID 0x89A6 //Intel flash
51 #define KFLASH_ID4 0xB0D4 //Intel flash 4Meg
53 static int flashdebug; //if set - we will display progress msgs
55 static int gbWriteEnable;
56 static int gbWriteBase64Enable;
57 static volatile unsigned char *FLASH_BASE;
58 static int gbFlashSize = KFLASH_SIZE;
59 static DEFINE_MUTEX(nwflash_mutex);
61 static int get_flash_id(void)
63 volatile unsigned int c1, c2;
66 * try to get flash chip ID
70 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0x90;
72 c1 = *(volatile unsigned char *) FLASH_BASE;
76 * on 4 Meg flash the second byte is actually at offset 2...
79 c2 = *(volatile unsigned char *) (FLASH_BASE + 2);
81 c2 = *(volatile unsigned char *) (FLASH_BASE + 1);
86 * set it back to read mode
88 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0xFF;
91 gbFlashSize = KFLASH_SIZE4;
96 static int flash_ioctl(struct inode *inodep, struct file *filep, unsigned int cmd, unsigned long arg)
99 case CMD_WRITE_DISABLE:
100 gbWriteBase64Enable = 0;
104 case CMD_WRITE_ENABLE:
108 case CMD_WRITE_BASE64K_ENABLE:
109 gbWriteBase64Enable = 1;
113 gbWriteBase64Enable = 0;
120 static ssize_t flash_read(struct file *file, char __user *buf, size_t size,
126 printk(KERN_DEBUG "flash_read: flash_read: offset=0x%llx, "
127 "buffer=%p, count=0x%zx.\n", *ppos, buf, size);
129 * We now lock against reads and writes. --rmk
131 if (mutex_lock_interruptible(&nwflash_mutex))
134 ret = simple_read_from_buffer(buf, size, ppos, (void *)FLASH_BASE, gbFlashSize);
135 mutex_unlock(&nwflash_mutex);
140 static ssize_t flash_write(struct file *file, const char __user *buf,
141 size_t size, loff_t * ppos)
143 unsigned long p = *ppos;
144 unsigned int count = size;
146 int nBlock, temp, rc;
150 printk("flash_write: offset=0x%lX, buffer=0x%p, count=0x%X.\n",
156 if (p < 64 * 1024 && (!gbWriteBase64Enable))
160 * check for out of range pos or count
162 if (p >= gbFlashSize)
163 return count ? -ENXIO : 0;
165 if (count > gbFlashSize - p)
166 count = gbFlashSize - p;
168 if (!access_ok(VERIFY_READ, buf, count))
172 * We now lock against reads and writes. --rmk
174 if (mutex_lock_interruptible(&nwflash_mutex))
179 leds_event(led_claim);
180 leds_event(led_green_on);
182 nBlock = (int) p >> 16; //block # of 64K bytes
185 * # of 64K blocks to erase and write
187 temp = ((int) (p + count) >> 16) - nBlock + 1;
190 * write ends at exactly 64k boundary?
192 if (((int) (p + count) & 0xFFFF) == 0)
196 printk(KERN_DEBUG "flash_write: writing %d block(s) "
197 "starting at %d.\n", temp, nBlock);
199 for (; temp; temp--, nBlock++) {
201 printk(KERN_DEBUG "flash_write: erasing block %d.\n", nBlock);
204 * first we have to erase the block(s), where we will write...
210 rc = erase_block(nBlock);
212 } while (rc && i < 10);
215 printk(KERN_ERR "flash_write: erase error %x\n", rc);
219 printk(KERN_DEBUG "flash_write: writing offset %lX, "
220 "from buf %p, bytes left %X.\n", p, buf,
224 * write_block will limit write to space left in this block
226 rc = write_block(p, buf, count - written);
230 * if somehow write verify failed? Can't happen??
234 * retry up to 10 times
240 * else quit with error...
246 printk(KERN_ERR "flash_write: write error %X\n", rc);
255 printk(KERN_DEBUG "flash_write: written 0x%X bytes OK.\n", written);
259 * restore reg on exit
261 leds_event(led_release);
263 mutex_unlock(&nwflash_mutex);
270 * The memory devices use the full 32/64 bits of the offset, and so we cannot
271 * check against negative addresses: they are ok. The return value is weird,
272 * though, in that case (0).
274 * also note that seeking relative to the "end of file" isn't supported:
275 * it has no meaning, so it returns -EINVAL.
277 static loff_t flash_llseek(struct file *file, loff_t offset, int orig)
283 printk(KERN_DEBUG "flash_llseek: offset=0x%X, orig=0x%X.\n",
284 (unsigned int) offset, orig);
293 if ((unsigned int) offset > gbFlashSize) {
298 file->f_pos = (unsigned int) offset;
302 if ((file->f_pos + offset) > gbFlashSize) {
306 if ((file->f_pos + offset) < 0) {
310 file->f_pos += offset;
322 * assume that main Write routine did the parameter checking...
323 * so just go ahead and erase, what requested!
326 static int erase_block(int nBlock)
328 volatile unsigned int c1;
329 volatile unsigned char *pWritePtr;
330 unsigned long timeout;
334 * orange LED == erase
336 leds_event(led_amber_on);
339 * reset footbridge to the correct offset 0 (...0..3)
341 *CSR_ROMWRITEREG = 0;
346 c1 = *(volatile unsigned char *) (FLASH_BASE + 0x8000);
350 * reset status if old errors
352 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0x50;
356 * aim at the middle of a current block...
358 pWritePtr = (unsigned char *) ((unsigned int) (FLASH_BASE + 0x8000 + (nBlock << 16)));
368 *(volatile unsigned char *) pWritePtr = 0x20;
373 *(volatile unsigned char *) pWritePtr = 0xD0;
381 * wait while erasing in process (up to 10 sec)
383 timeout = jiffies + 10 * HZ;
385 while (!(c1 & 0x80) && time_before(jiffies, timeout)) {
390 c1 = *(volatile unsigned char *) (pWritePtr);
391 // printk("Flash_erase: status=%X.\n",c1);
395 * set flash for normal read access
398 // *(volatile unsigned char*)(FLASH_BASE+0x8000) = 0xFF;
399 *(volatile unsigned char *) pWritePtr = 0xFF; //back to normal operation
402 * check if erase errors were reported
405 printk(KERN_ERR "flash_erase: err at %p\n", pWritePtr);
410 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0x50;
415 * just to make sure - verify if erased OK...
419 pWritePtr = (unsigned char *) ((unsigned int) (FLASH_BASE + (nBlock << 16)));
421 for (temp = 0; temp < 16 * 1024; temp++, pWritePtr += 4) {
422 if ((temp1 = *(volatile unsigned int *) pWritePtr) != 0xFFFFFFFF) {
423 printk(KERN_ERR "flash_erase: verify err at %p = %X\n",
434 * write_block will limit number of bytes written to the space in this block
436 static int write_block(unsigned long p, const char __user *buf, int count)
438 volatile unsigned int c1;
439 volatile unsigned int c2;
440 unsigned char *pWritePtr;
441 unsigned int uAddress;
443 unsigned long timeout;
444 unsigned long timeout1;
449 leds_event(led_amber_off);
450 leds_event(led_red_on);
452 pWritePtr = (unsigned char *) ((unsigned int) (FLASH_BASE + p));
455 * check if write will end in this block....
459 if (offset + count > 0x10000)
460 count = 0x10000 - offset;
463 * wait up to 30 sec for this block
465 timeout = jiffies + 30 * HZ;
467 for (offset = 0; offset < count; offset++, pWritePtr++) {
468 uAddress = (unsigned int) pWritePtr;
469 uAddress &= 0xFFFFFFFC;
470 if (__get_user(c2, buf + offset))
477 c1 = *(volatile unsigned char *) (FLASH_BASE + 0x8000);
480 * kick open the write gate
485 * program footbridge to the correct offset...0..3
487 *CSR_ROMWRITEREG = (unsigned int) pWritePtr & 3;
492 *(volatile unsigned char *) (uAddress) = 0x40;
497 *(volatile unsigned char *) (uAddress) = c2;
502 *(volatile unsigned char *) (FLASH_BASE + 0x10000) = 0x70;
507 * wait up to 1 sec for this byte
509 timeout1 = jiffies + 1 * HZ;
514 while (!(c1 & 0x80) && time_before(jiffies, timeout1))
515 c1 = *(volatile unsigned char *) (FLASH_BASE + 0x8000);
518 * if timeout getting status
520 if (time_after_eq(jiffies, timeout1)) {
525 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0x50;
530 * switch on read access, as a default flash operation mode
536 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0xFF;
539 * if hardware reports an error writing, and not timeout -
540 * reset the chip and retry
547 *(volatile unsigned char *) (FLASH_BASE + 0x8000) = 0x50;
552 if (time_before(jiffies, timeout)) {
554 printk(KERN_DEBUG "write_block: Retrying write at 0x%X)n",
555 pWritePtr - FLASH_BASE);
560 leds_event(led_amber_off);
568 leds_event(led_red_on);
572 printk(KERN_ERR "write_block: timeout at 0x%X\n",
573 pWritePtr - FLASH_BASE);
584 * green LED == read/verify
586 leds_event(led_amber_off);
587 leds_event(led_green_on);
591 pWritePtr = (unsigned char *) ((unsigned int) (FLASH_BASE + p));
593 for (offset = 0; offset < count; offset++) {
595 if (__get_user(c, buf))
598 if ((c1 = *pWritePtr++) != c) {
599 printk(KERN_ERR "write_block: verify error at 0x%X (%02X!=%02X)\n",
600 pWritePtr - FLASH_BASE, c1, c);
609 static void kick_open(void)
614 * we want to write a bit pattern XXX1 to Xilinx to enable
615 * the write gate, which will be open for about the next 2ms.
617 spin_lock_irqsave(&nw_gpio_lock, flags);
618 nw_cpld_modify(CPLD_FLASH_WR_ENABLE, CPLD_FLASH_WR_ENABLE);
619 spin_unlock_irqrestore(&nw_gpio_lock, flags);
622 * let the ISA bus to catch on...
627 static const struct file_operations flash_fops =
629 .owner = THIS_MODULE,
630 .llseek = flash_llseek,
632 .write = flash_write,
633 .ioctl = flash_ioctl,
636 static struct miscdevice flash_miscdev =
643 static int __init nwflash_init(void)
647 if (machine_is_netwinder()) {
650 FLASH_BASE = ioremap(DC21285_FLASH, KFLASH_SIZE4);
655 if ((id != KFLASH_ID) && (id != KFLASH_ID4)) {
657 iounmap((void *)FLASH_BASE);
658 printk("Flash: incorrect ID 0x%04X.\n", id);
662 printk("Flash ROM driver v.%s, flash device ID 0x%04X, size %d Mb.\n",
663 NWFLASH_VERSION, id, gbFlashSize / (1024 * 1024));
665 ret = misc_register(&flash_miscdev);
667 iounmap((void *)FLASH_BASE);
674 static void __exit nwflash_exit(void)
676 misc_deregister(&flash_miscdev);
677 iounmap((void *)FLASH_BASE);
680 MODULE_LICENSE("GPL");
682 module_param(flashdebug, bool, 0644);
684 module_init(nwflash_init);
685 module_exit(nwflash_exit);