2 * drivers/sbus/char/jsflash.c
4 * Copyright (C) 1991, 1992 Linus Torvalds (drivers/char/mem.c)
5 * Copyright (C) 1997 Eddie C. Dost (drivers/sbus/char/flash.c)
6 * Copyright (C) 1997-2000 Pavel Machek <pavel@ucw.cz> (drivers/block/nbd.c)
7 * Copyright (C) 1999-2000 Pete Zaitcev
9 * This driver is used to program OS into a Flash SIMM on
10 * Krups and Espresso platforms.
12 * TODO: do not allow erase/programming if file systems are mounted.
13 * TODO: Erase/program both banks of a 8MB SIMM.
15 * It is anticipated that programming an OS Flash will be a routine
16 * procedure. In the same time it is exceedingly dangerous because
17 * a user can program its OBP flash with OS image and effectively
20 * This driver uses an interface different from Eddie's flash.c
21 * as a silly safeguard.
23 * XXX The flash.c manipulates page caching characteristics in a certain
24 * dubious way; also it assumes that remap_pfn_range() can remap
25 * PCI bus locations, which may be false. ioremap() must be used
26 * instead. We should discuss this.
29 #include <linux/module.h>
30 #include <linux/mutex.h>
31 #include <linux/types.h>
32 #include <linux/errno.h>
33 #include <linux/miscdevice.h>
34 #include <linux/fcntl.h>
35 #include <linux/poll.h>
36 #include <linux/init.h>
37 #include <linux/string.h>
38 #include <linux/genhd.h>
39 #include <linux/blkdev.h>
40 #include <linux/uaccess.h>
41 #include <asm/pgtable.h>
44 #include <asm/oplib.h>
46 #include <asm/jsflash.h> /* ioctl arguments. <linux/> ?? */
47 #define JSFIDSZ (sizeof(struct jsflash_ident_arg))
48 #define JSFPRGSZ (sizeof(struct jsflash_program_arg))
51 * Our device numbers have no business in system headers.
52 * The only thing a user knows is the device name /dev/jsflash.
54 * Block devices are laid out like this:
55 * minor+0 - Bootstrap, for 8MB SIMM 0x20400000[0x800000]
56 * minor+1 - Filesystem to mount, normally 0x20400400[0x7ffc00]
57 * minor+2 - Whole flash area for any case... 0x20000000[0x01000000]
58 * Total 3 minors per flash device.
60 * It is easier to have static size vectors, so we define
61 * a total minor range JSF_MAX, which must cover all minors.
63 /* character device */
64 #define JSF_MINOR 178 /* 178 is registered with hpa */
66 #define JSF_MAX 3 /* 3 minors wasted total so far. */
67 #define JSF_NPART 3 /* 3 minors per flash device */
68 #define JSF_PART_BITS 2 /* 2 bits of minors to cover JSF_NPART */
69 #define JSF_PART_MASK 0x3 /* 2 bits mask */
71 static DEFINE_MUTEX(jsf_mutex);
75 * We could ioremap(), but it's easier this way.
77 static unsigned int jsf_inl(unsigned long addr)
81 __asm__ __volatile__("lda [%1] %2, %0\n\t" :
83 "r" (addr), "i" (ASI_M_BYPASS));
87 static void jsf_outl(unsigned long addr, __u32 data)
90 __asm__ __volatile__("sta %0, [%1] %2\n\t" : :
91 "r" (data), "r" (addr), "i" (ASI_M_BYPASS) :
107 unsigned long busy; /* In use? */
108 struct jsflash_ident_arg id;
109 /* int mbase; */ /* Minor base, typically zero */
110 struct jsfd_part dv[JSF_NPART];
114 * We do not map normal memory or obio as a safety precaution.
115 * But offsets are real, for ease of userland programming.
117 #define JSF_BASE_TOP 0x30000000
118 #define JSF_BASE_ALL 0x20000000
120 #define JSF_BASE_JK 0x20400000
124 static struct gendisk *jsfd_disk[JSF_MAX];
127 * Let's pretend we may have several of these...
129 static struct jsflash jsf0;
132 * Wait for AMD to finish its embedded algorithm.
133 * We use the Toggle bit DQ6 (0x40) because it does not
134 * depend on the data value as /DATA bit DQ7 does.
136 * XXX Do we need any timeout here? So far it never hanged, beware broken hw.
138 static void jsf_wait(unsigned long p) {
144 if ((x1 & 0x40404040) == (x2 & 0x40404040)) return;
149 * Programming will only work if Flash is clean,
150 * we leave it to the programmer application.
152 * AMD must be programmed one byte at a time;
153 * thus, Simple Tech SIMM must be written 4 bytes at a time.
155 * Write waits for the chip to become ready after the write
156 * was finished. This is done so that application would read
157 * consistent data after the write is done.
159 static void jsf_write4(unsigned long fa, u32 data) {
161 jsf_outl(fa, 0xAAAAAAAA); /* Unlock 1 Write 1 */
162 jsf_outl(fa, 0x55555555); /* Unlock 1 Write 2 */
163 jsf_outl(fa, 0xA0A0A0A0); /* Byte Program */
171 static void jsfd_read(char *buf, unsigned long p, size_t togo) {
186 static int jsfd_queue;
188 static struct request *jsfd_next_request(void)
190 struct request_queue *q;
192 int old_pos = jsfd_queue;
195 q = jsfd_disk[jsfd_queue]->queue;
196 if (++jsfd_queue == JSF_MAX)
199 rq = blk_fetch_request(q);
203 } while (jsfd_queue != old_pos);
208 static void jsfd_request(void)
212 req = jsfd_next_request();
214 struct jsfd_part *jdp = req->rq_disk->private_data;
215 unsigned long offset = blk_rq_pos(req) << 9;
216 size_t len = blk_rq_cur_bytes(req);
217 blk_status_t err = BLK_STS_IOERR;
219 if ((offset + len) > jdp->dsize)
222 if (rq_data_dir(req) != READ) {
223 printk(KERN_ERR "jsfd: write\n");
227 if ((jdp->dbase & 0xff000000) != 0x20000000) {
228 printk(KERN_ERR "jsfd: bad base %x\n", (int)jdp->dbase);
232 jsfd_read(bio_data(req->bio), jdp->dbase + offset, len);
235 if (!__blk_end_request_cur(req, err))
236 req = jsfd_next_request();
240 static void jsfd_do_request(struct request_queue *q)
246 * The memory devices use the full 32/64 bits of the offset, and so we cannot
247 * check against negative addresses: they are ok. The return value is weird,
248 * though, in that case (0).
250 * also note that seeking relative to the "end of file" isn't supported:
251 * it has no meaning, so it returns -EINVAL.
253 static loff_t jsf_lseek(struct file * file, loff_t offset, int orig)
257 mutex_lock(&jsf_mutex);
260 file->f_pos = offset;
264 file->f_pos += offset;
270 mutex_unlock(&jsf_mutex);
275 * OS SIMM Cannot be read in other size but a 32bits word.
277 static ssize_t jsf_read(struct file * file, char __user * buf,
278 size_t togo, loff_t *ppos)
280 unsigned long p = *ppos;
281 char __user *tmp = buf;
288 if (p < JSF_BASE_ALL || p >= JSF_BASE_TOP) {
292 if ((p + togo) < p /* wrap */
293 || (p + togo) >= JSF_BASE_TOP) {
294 togo = JSF_BASE_TOP - p;
297 if (p < JSF_BASE_ALL && togo != 0) {
298 #if 0 /* __bzero XXX */
299 size_t x = JSF_BASE_ALL - p;
300 if (x > togo) x = togo;
307 * Implementation of clear_user() calls __bzero
308 * without regard to modversions,
309 * so we cannot build a module.
318 if (copy_to_user(tmp, b.s, 4))
325 * XXX Small togo may remain if 1 byte is ordered.
326 * It would be nice if we did a word size read and unpacked it.
333 static ssize_t jsf_write(struct file * file, const char __user * buf,
334 size_t count, loff_t *ppos)
341 static int jsf_ioctl_erase(unsigned long arg)
345 /* p = jsf0.base; hits wrong bank */
348 jsf_outl(p, 0xAAAAAAAA); /* Unlock 1 Write 1 */
349 jsf_outl(p, 0x55555555); /* Unlock 1 Write 2 */
350 jsf_outl(p, 0x80808080); /* Erase setup */
351 jsf_outl(p, 0xAAAAAAAA); /* Unlock 2 Write 1 */
352 jsf_outl(p, 0x55555555); /* Unlock 2 Write 2 */
353 jsf_outl(p, 0x10101010); /* Chip erase */
357 * This code is ok, except that counter based timeout
358 * has no place in this world. Let's just drop timeouts...
363 for (i = 0; i < 1000000; i++) {
365 if ((x & 0x80808080) == 0x80808080) break;
367 if ((x & 0x80808080) != 0x80808080) {
368 printk("jsf0: erase timeout with 0x%08x\n", x);
370 printk("jsf0: erase done with 0x%08x\n", x);
381 * Program a block of flash.
382 * Very simple because we can do it byte by byte anyway.
384 static int jsf_ioctl_program(void __user *arg)
386 struct jsflash_program_arg abuf;
395 if (copy_from_user(&abuf, arg, JSFPRGSZ))
399 if ((togo & 3) || (p & 3)) return -EINVAL;
401 uptr = (char __user *) (unsigned long) abuf.data;
404 if (copy_from_user(&b.s[0], uptr, 4))
414 static long jsf_ioctl(struct file *f, unsigned int cmd, unsigned long arg)
416 mutex_lock(&jsf_mutex);
418 void __user *argp = (void __user *)arg;
420 if (!capable(CAP_SYS_ADMIN)) {
421 mutex_unlock(&jsf_mutex);
426 if (copy_to_user(argp, &jsf0.id, JSFIDSZ)) {
427 mutex_unlock(&jsf_mutex);
432 error = jsf_ioctl_erase(arg);
434 case JSFLASH_PROGRAM:
435 error = jsf_ioctl_program(argp);
439 mutex_unlock(&jsf_mutex);
443 static int jsf_mmap(struct file * file, struct vm_area_struct * vma)
448 static int jsf_open(struct inode * inode, struct file * filp)
450 mutex_lock(&jsf_mutex);
451 if (jsf0.base == 0) {
452 mutex_unlock(&jsf_mutex);
455 if (test_and_set_bit(0, (void *)&jsf0.busy) != 0) {
456 mutex_unlock(&jsf_mutex);
460 mutex_unlock(&jsf_mutex);
461 return 0; /* XXX What security? */
464 static int jsf_release(struct inode *inode, struct file *file)
470 static const struct file_operations jsf_fops = {
471 .owner = THIS_MODULE,
475 .unlocked_ioctl = jsf_ioctl,
478 .release = jsf_release,
481 static struct miscdevice jsf_dev = { JSF_MINOR, "jsflash", &jsf_fops };
483 static const struct block_device_operations jsfd_fops = {
484 .owner = THIS_MODULE,
487 static int jsflash_init(void)
493 struct linux_prom_registers reg0;
495 node = prom_getchild(prom_root_node);
496 node = prom_searchsiblings(node, "flash-memory");
497 if (node != 0 && (s32)node != -1) {
498 if (prom_getproperty(node, "reg",
499 (char *)®0, sizeof(reg0)) == -1) {
500 printk("jsflash: no \"reg\" property\n");
503 if (reg0.which_io != 0) {
504 printk("jsflash: bus number nonzero: 0x%x:%x\n",
505 reg0.which_io, reg0.phys_addr);
509 * Flash may be somewhere else, for instance on Ebus.
510 * So, don't do the following check for IIep flash space.
513 if ((reg0.phys_addr >> 24) != 0x20) {
514 printk("jsflash: suspicious address: 0x%x:%x\n",
515 reg0.which_io, reg0.phys_addr);
519 if ((int)reg0.reg_size <= 0) {
520 printk("jsflash: bad size 0x%x\n", (int)reg0.reg_size);
524 /* XXX Remove this code once PROLL ID12 got widespread */
525 printk("jsflash: no /flash-memory node, use PROLL >= 12\n");
526 prom_getproperty(prom_root_node, "banner-name", banner, 128);
527 if (strcmp (banner, "JavaStation-NC") != 0 &&
528 strcmp (banner, "JavaStation-E") != 0) {
532 reg0.phys_addr = 0x20400000;
533 reg0.reg_size = 0x00800000;
536 /* Let us be really paranoid for modifications to probing code. */
537 if (sparc_cpu_model != sun4m) {
538 /* We must be on sun4m because we use MMU Bypass ASI. */
542 if (jsf0.base == 0) {
545 jsf->base = reg0.phys_addr;
546 jsf->size = reg0.reg_size;
548 /* XXX Redo the userland interface. */
549 jsf->id.off = JSF_BASE_ALL;
550 jsf->id.size = 0x01000000; /* 16M - all segments */
551 strcpy(jsf->id.name, "Krups_all");
553 jsf->dv[0].dbase = jsf->base;
554 jsf->dv[0].dsize = jsf->size;
555 jsf->dv[1].dbase = jsf->base + 1024;
556 jsf->dv[1].dsize = jsf->size - 1024;
557 jsf->dv[2].dbase = JSF_BASE_ALL;
558 jsf->dv[2].dsize = 0x01000000;
560 printk("Espresso Flash @0x%lx [%d MB]\n", jsf->base,
561 (int) (jsf->size / (1024*1024)));
564 if ((rc = misc_register(&jsf_dev)) != 0) {
565 printk(KERN_ERR "jsf: unable to get misc minor %d\n",
574 static int jsfd_init(void)
576 static DEFINE_SPINLOCK(lock);
578 struct jsfd_part *jdp;
586 for (i = 0; i < JSF_MAX; i++) {
587 struct gendisk *disk = alloc_disk(1);
590 disk->queue = blk_init_queue(jsfd_do_request, &lock);
595 blk_queue_bounce_limit(disk->queue, BLK_BOUNCE_HIGH);
599 if (register_blkdev(JSFD_MAJOR, "jsfd")) {
604 for (i = 0; i < JSF_MAX; i++) {
605 struct gendisk *disk = jsfd_disk[i];
606 if ((i & JSF_PART_MASK) >= JSF_NPART) continue;
607 jsf = &jsf0; /* actually, &jsfv[i >> JSF_PART_BITS] */
608 jdp = &jsf->dv[i&JSF_PART_MASK];
610 disk->major = JSFD_MAJOR;
611 disk->first_minor = i;
612 sprintf(disk->disk_name, "jsfd%d", i);
613 disk->fops = &jsfd_fops;
614 set_capacity(disk, jdp->dsize >> 9);
615 disk->private_data = jdp;
617 set_disk_ro(disk, 1);
622 put_disk(jsfd_disk[i]);
626 MODULE_LICENSE("GPL");
628 static int __init jsflash_init_module(void) {
631 if ((rc = jsflash_init()) == 0) {
638 static void __exit jsflash_cleanup_module(void)
642 for (i = 0; i < JSF_MAX; i++) {
643 if ((i & JSF_PART_MASK) >= JSF_NPART) continue;
644 del_gendisk(jsfd_disk[i]);
645 blk_cleanup_queue(jsfd_disk[i]->queue);
646 put_disk(jsfd_disk[i]);
649 printk("jsf0: cleaning busy unit\n");
653 misc_deregister(&jsf_dev);
654 unregister_blkdev(JSFD_MAJOR, "jsfd");
657 module_init(jsflash_init_module);
658 module_exit(jsflash_cleanup_module);