2 * linux/arch/arm26/kernel/ecard.c
4 * Copyright 1995-2001 Russell King
5 * Copyright 2003 Ian Molton
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * Find all installed expansion cards, and handle interrupts from them.
13 * Created from information from Acorns RiscOS3 PRMs
14 * 15-Jun-2003 IM Modified from ARM32 (RiscPC capable) version
15 * 10-Jan-1999 RMK Run loaders in a simulated RISC OS environment.
16 * 06-May-1997 RMK Added blacklist for cards whose loader doesn't work.
17 * 12-Sep-1997 RMK Created new handling of interrupt enables/disables
18 * - cards can now register their own routine to control
19 * interrupts (recommended).
20 * 29-Sep-1997 RMK Expansion card interrupt hardware not being re-enabled
21 * on reset from Linux. (Caused cards not to respond
22 * under RiscOS without hard reset).
27 #include <linux/config.h>
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/types.h>
31 #include <linux/sched.h>
32 #include <linux/interrupt.h>
33 #include <linux/reboot.h>
35 #include <linux/slab.h>
36 #include <linux/proc_fs.h>
37 #include <linux/device.h>
38 #include <linux/init.h>
41 #include <asm/ecard.h>
42 #include <asm/hardware.h>
45 #include <asm/mmu_context.h>
46 #include <asm/irqchip.h>
47 #include <asm/tlbflush.h>
54 struct ecard_request {
59 unsigned int use_loader;
63 struct expcard_blacklist {
64 unsigned short manufacturer;
65 unsigned short product;
69 static ecard_t *cards;
70 static ecard_t *slot_to_expcard[MAX_ECARDS];
71 static unsigned int ectcr;
73 /* List of descriptions of cards which don't have an extended
74 * identification, or chunk directories containing a description.
76 static struct expcard_blacklist __initdata blacklist[] = {
77 { MANU_ACORN, PROD_ACORN_ETHER1, "Acorn Ether1" }
81 ecard_loader_reset(volatile unsigned char *pa, loader_t loader);
83 ecard_loader_read(int off, volatile unsigned char *pa, loader_t loader);
85 static const struct ecard_id *
86 ecard_match_device(const struct ecard_id *ids, struct expansion_card *ec);
88 static inline unsigned short
89 ecard_getu16(unsigned char *v)
91 return v[0] | v[1] << 8;
94 static inline signed long
95 ecard_gets24(unsigned char *v)
97 return v[0] | v[1] << 8 | v[2] << 16 | ((v[2] & 0x80) ? 0xff000000 : 0);
100 static inline ecard_t *
101 slot_to_ecard(unsigned int slot)
103 return slot < MAX_ECARDS ? slot_to_expcard[slot] : NULL;
106 /* ===================== Expansion card daemon ======================== */
108 * Since the loader programs on the expansion cards need to be run
109 * in a specific environment, create a separate task with this
110 * environment up, and pass requests to this task as and when we
113 * This should allow 99% of loaders to be called from Linux.
115 * From a security standpoint, we trust the card vendors. This
116 * may be a misplaced trust.
118 #define BUS_ADDR(x) ((((unsigned long)(x)) << 2) + IO_BASE)
119 #define POD_INT_ADDR(x) ((volatile unsigned char *)\
120 ((BUS_ADDR((x)) - IO_BASE) + IO_START))
122 static inline void ecard_task_reset(struct ecard_request *req)
124 struct expansion_card *ec = req->ec;
126 ecard_loader_reset(POD_INT_ADDR(ec->podaddr), ec->loader);
130 ecard_task_readbytes(struct ecard_request *req)
132 unsigned char *buf = (unsigned char *)req->buffer;
133 volatile unsigned char *base_addr =
134 (volatile unsigned char *)POD_INT_ADDR(req->ec->podaddr);
135 unsigned int len = req->length;
136 unsigned int off = req->address;
138 if (!req->use_loader || !req->ec->loader) {
141 *buf++ = base_addr[off];
147 * The following is required by some
148 * expansion card loader programs.
150 *(unsigned long *)0x108 = 0;
151 *buf++ = ecard_loader_read(off++, base_addr,
157 static void ecard_do_request(struct ecard_request *req)
161 ecard_task_readbytes(req);
165 ecard_task_reset(req);
171 * On 26-bit processors, we don't need the kcardd thread to access the
172 * expansion card loaders. We do it directly.
174 #define ecard_call(req) ecard_do_request(req)
176 /* ======================= Mid-level card control ===================== */
179 ecard_readbytes(void *addr, ecard_t *ec, int off, int len, int useld)
181 struct ecard_request req;
183 req.req = req_readbytes;
187 req.use_loader = useld;
193 int ecard_readchunk(struct in_chunk_dir *cd, ecard_t *ec, int id, int num)
195 struct ex_chunk_dir excd;
203 ecard_readbytes(&excd, ec, index, 8, useld);
205 if (c_id(&excd) == 0) {
206 if (!useld && ec->loader) {
213 if (c_id(&excd) == 0xf0) { /* link */
214 index = c_start(&excd);
217 if (c_id(&excd) == 0x80) { /* loader */
219 ec->loader = (loader_t)kmalloc(c_len(&excd),
222 ecard_readbytes(ec->loader, ec,
224 c_len(&excd), useld);
230 if (c_id(&excd) == id && num-- == 0)
234 if (c_id(&excd) & 0x80) {
235 switch (c_id(&excd) & 0x70) {
237 ecard_readbytes((unsigned char *)excd.d.string, ec,
238 (int)c_start(&excd), c_len(&excd),
245 cd->start_offset = c_start(&excd);
246 memcpy(cd->d.string, excd.d.string, 256);
250 /* ======================= Interrupt control ============================ */
252 static void ecard_def_irq_enable(ecard_t *ec, int irqnr)
256 static void ecard_def_irq_disable(ecard_t *ec, int irqnr)
260 static int ecard_def_irq_pending(ecard_t *ec)
262 return !ec->irqmask || ec->irqaddr[0] & ec->irqmask;
265 static void ecard_def_fiq_enable(ecard_t *ec, int fiqnr)
267 panic("ecard_def_fiq_enable called - impossible");
270 static void ecard_def_fiq_disable(ecard_t *ec, int fiqnr)
272 panic("ecard_def_fiq_disable called - impossible");
275 static int ecard_def_fiq_pending(ecard_t *ec)
277 return !ec->fiqmask || ec->fiqaddr[0] & ec->fiqmask;
280 static expansioncard_ops_t ecard_default_ops = {
281 ecard_def_irq_enable,
282 ecard_def_irq_disable,
283 ecard_def_irq_pending,
284 ecard_def_fiq_enable,
285 ecard_def_fiq_disable,
286 ecard_def_fiq_pending
290 * Enable and disable interrupts from expansion cards.
291 * (interrupts are disabled for these functions).
293 * They are not meant to be called directly, but via enable/disable_irq.
295 static void ecard_irq_unmask(unsigned int irqnr)
297 ecard_t *ec = slot_to_ecard(irqnr - 32);
301 ec->ops = &ecard_default_ops;
303 if (ec->claimed && ec->ops->irqenable)
304 ec->ops->irqenable(ec, irqnr);
306 printk(KERN_ERR "ecard: rejecting request to "
307 "enable IRQs for %d\n", irqnr);
311 static void ecard_irq_mask(unsigned int irqnr)
313 ecard_t *ec = slot_to_ecard(irqnr - 32);
317 ec->ops = &ecard_default_ops;
319 if (ec->ops && ec->ops->irqdisable)
320 ec->ops->irqdisable(ec, irqnr);
324 static struct irqchip ecard_chip = {
325 .ack = ecard_irq_mask,
326 .mask = ecard_irq_mask,
327 .unmask = ecard_irq_unmask,
330 void ecard_enablefiq(unsigned int fiqnr)
332 ecard_t *ec = slot_to_ecard(fiqnr);
336 ec->ops = &ecard_default_ops;
338 if (ec->claimed && ec->ops->fiqenable)
339 ec->ops->fiqenable(ec, fiqnr);
341 printk(KERN_ERR "ecard: rejecting request to "
342 "enable FIQs for %d\n", fiqnr);
346 void ecard_disablefiq(unsigned int fiqnr)
348 ecard_t *ec = slot_to_ecard(fiqnr);
352 ec->ops = &ecard_default_ops;
354 if (ec->ops->fiqdisable)
355 ec->ops->fiqdisable(ec, fiqnr);
360 ecard_dump_irq_state(ecard_t *ec)
362 printk(" %d: %sclaimed, ",
364 ec->claimed ? "" : "not ");
366 if (ec->ops && ec->ops->irqpending &&
367 ec->ops != &ecard_default_ops)
368 printk("irq %spending\n",
369 ec->ops->irqpending(ec) ? "" : "not ");
371 printk("irqaddr %p, mask = %02X, status = %02X\n",
372 ec->irqaddr, ec->irqmask, *ec->irqaddr);
375 static void ecard_check_lockup(struct irqdesc *desc)
377 static int last, lockup;
381 * If the timer interrupt has not run since the last million
382 * unrecognised expansion card interrupts, then there is
383 * something seriously wrong. Disable the expansion card
384 * interrupts so at least we can continue.
386 * Maybe we ought to start a timer to re-enable them some time
389 if (last == jiffies) {
391 if (lockup > 1000000) {
392 printk(KERN_ERR "\nInterrupt lockup detected - "
393 "disabling all expansion card interrupts\n");
395 desc->chip->mask(IRQ_EXPANSIONCARD);
397 printk("Expansion card IRQ state:\n");
399 for (ec = cards; ec; ec = ec->next)
400 ecard_dump_irq_state(ec);
406 * If we did not recognise the source of this interrupt,
407 * warn the user, but don't flood the user with these messages.
409 if (!last || time_after(jiffies, (unsigned long)(last + 5*HZ))) {
411 printk(KERN_WARNING "Unrecognised interrupt from backplane\n");
416 ecard_irq_handler(unsigned int irq, struct irqdesc *desc, struct pt_regs *regs)
421 desc->chip->mask(irq);
422 for (ec = cards; ec; ec = ec->next) {
425 if (!ec->claimed || ec->irq == NO_IRQ)
428 if (ec->ops && ec->ops->irqpending)
429 pending = ec->ops->irqpending(ec);
431 pending = ecard_default_ops.irqpending(ec);
434 struct irqdesc *d = irq_desc + ec->irq;
435 d->handle(ec->irq, d, regs);
439 desc->chip->unmask(irq);
442 ecard_check_lockup(desc);
445 #define ecard_irqexp_handler NULL
446 #define ecard_probeirqhw() (0)
448 unsigned int ecard_address(ecard_t *ec, card_type_t type, card_speed_t speed)
450 unsigned long address = 0;
451 int slot = ec->slot_no;
453 ectcr &= ~(1 << slot);
457 address = IO_EC_MEMC_BASE + (slot << 12);
461 address = IO_EC_IOC_BASE + (slot << 12) + (speed << 17);
471 static int ecard_prints(char *buffer, ecard_t *ec)
473 char *start = buffer;
475 buffer += sprintf(buffer, " %d: ", ec->slot_no);
477 if (ec->cid.id == 0) {
478 struct in_chunk_dir incd;
480 buffer += sprintf(buffer, "[%04X:%04X] ",
481 ec->cid.manufacturer, ec->cid.product);
483 if (!ec->card_desc && ec->cid.cd &&
484 ecard_readchunk(&incd, ec, 0xf5, 0)) {
485 ec->card_desc = kmalloc(strlen(incd.d.string)+1, GFP_KERNEL);
488 strcpy((char *)ec->card_desc, incd.d.string);
491 buffer += sprintf(buffer, "%s\n", ec->card_desc ? ec->card_desc : "*unknown*");
493 buffer += sprintf(buffer, "Simple card %d\n", ec->cid.id);
495 return buffer - start;
498 static int get_ecard_dev_info(char *buf, char **start, off_t pos, int count)
505 while (ec && count > cnt) {
506 len = ecard_prints(buf, ec);
510 *start = buf + (pos - (at - len));
518 return (count > cnt) ? cnt : count;
521 static struct proc_dir_entry *proc_bus_ecard_dir = NULL;
523 static void ecard_proc_init(void)
525 proc_bus_ecard_dir = proc_mkdir("ecard", proc_bus);
526 create_proc_info_entry("devices", 0, proc_bus_ecard_dir,
530 #define ec_set_resource(ec,nr,st,sz,flg) \
532 (ec)->resource[nr].name = ec->dev.bus_id; \
533 (ec)->resource[nr].start = st; \
534 (ec)->resource[nr].end = (st) + (sz) - 1; \
535 (ec)->resource[nr].flags = flg; \
538 static void __init ecard_init_resources(struct expansion_card *ec)
540 unsigned long base = PODSLOT_IOC0_BASE;
541 unsigned int slot = ec->slot_no;
544 ec_set_resource(ec, ECARD_RES_MEMC,
545 PODSLOT_MEMC_BASE + (slot << 14),
546 PODSLOT_MEMC_SIZE, IORESOURCE_MEM);
548 for (i = 0; i < ECARD_RES_IOCSYNC - ECARD_RES_IOCSLOW; i++) {
549 ec_set_resource(ec, i + ECARD_RES_IOCSLOW,
550 base + (slot << 14) + (i << 19),
551 PODSLOT_IOC_SIZE, IORESOURCE_MEM);
554 for (i = 0; i < ECARD_NUM_RESOURCES; i++) {
555 if (ec->resource[i].start &&
556 request_resource(&iomem_resource, &ec->resource[i])) {
557 printk(KERN_ERR "%s: resource(s) not available\n",
559 ec->resource[i].end -= ec->resource[i].start;
560 ec->resource[i].start = 0;
565 static ssize_t ecard_show_irq(struct device *dev, struct device_attribute *attr, char *buf)
567 struct expansion_card *ec = ECARD_DEV(dev);
568 return sprintf(buf, "%u\n", ec->irq);
571 static ssize_t ecard_show_vendor(struct device *dev, struct device_attribute *attr, char *buf)
573 struct expansion_card *ec = ECARD_DEV(dev);
574 return sprintf(buf, "%u\n", ec->cid.manufacturer);
577 static ssize_t ecard_show_device(struct device *dev, struct device_attribute *attr, char *buf)
579 struct expansion_card *ec = ECARD_DEV(dev);
580 return sprintf(buf, "%u\n", ec->cid.product);
583 static ssize_t ecard_show_dma(struct device *dev, struct device_attribute *attr, char *buf)
585 struct expansion_card *ec = ECARD_DEV(dev);
586 return sprintf(buf, "%u\n", ec->dma);
589 static ssize_t ecard_show_resources(struct device *dev, struct device_attribute *attr, char *buf)
591 struct expansion_card *ec = ECARD_DEV(dev);
595 for (i = 0; i < ECARD_NUM_RESOURCES; i++)
596 str += sprintf(str, "%08lx %08lx %08lx\n",
597 ec->resource[i].start,
599 ec->resource[i].flags);
604 static DEVICE_ATTR(irq, S_IRUGO, ecard_show_irq, NULL);
605 static DEVICE_ATTR(vendor, S_IRUGO, ecard_show_vendor, NULL);
606 static DEVICE_ATTR(device, S_IRUGO, ecard_show_device, NULL);
607 static DEVICE_ATTR(dma, S_IRUGO, ecard_show_dma, NULL);
608 static DEVICE_ATTR(resource, S_IRUGO, ecard_show_resources, NULL);
611 * Probe for an expansion card.
613 * If bit 1 of the first byte of the card is set, then the
614 * card does not exist.
617 ecard_probe(int slot, card_type_t type)
624 ec = kmalloc(sizeof(ecard_t), GFP_KERNEL);
628 memset(ec, 0, sizeof(ecard_t));
635 ec->card_desc = NULL;
636 ec->ops = &ecard_default_ops;
639 if ((ec->podaddr = ecard_address(ec, type, ECARD_SYNC)) == 0)
643 ecard_readbytes(&cid, ec, 0, 16, 0);
647 ec->cid.id = cid.r_id;
648 ec->cid.cd = cid.r_cd;
649 ec->cid.is = cid.r_is;
651 ec->cid.manufacturer = ecard_getu16(cid.r_manu);
652 ec->cid.product = ecard_getu16(cid.r_prod);
653 ec->cid.country = cid.r_country;
654 ec->cid.irqmask = cid.r_irqmask;
655 ec->cid.irqoff = ecard_gets24(cid.r_irqoff);
656 ec->cid.fiqmask = cid.r_fiqmask;
657 ec->cid.fiqoff = ecard_gets24(cid.r_fiqoff);
659 ec->irqaddr = (unsigned char *)ioaddr(ec->podaddr);
662 ec->irqmask = ec->cid.irqmask;
663 ec->irqaddr += ec->cid.irqoff;
664 ec->fiqmask = ec->cid.fiqmask;
665 ec->fiqaddr += ec->cid.fiqoff;
671 for (i = 0; i < sizeof(blacklist) / sizeof(*blacklist); i++)
672 if (blacklist[i].manufacturer == ec->cid.manufacturer &&
673 blacklist[i].product == ec->cid.product) {
674 ec->card_desc = blacklist[i].type;
678 snprintf(ec->dev.bus_id, sizeof(ec->dev.bus_id), "ecard%d", slot);
679 ec->dev.parent = NULL;
680 ec->dev.bus = &ecard_bus_type;
681 ec->dev.dma_mask = &ec->dma_mask;
682 ec->dma_mask = (u64)0xffffffff;
684 ecard_init_resources(ec);
687 * hook the interrupt handlers
690 set_irq_chip(ec->irq, &ecard_chip);
691 set_irq_handler(ec->irq, do_level_IRQ);
692 set_irq_flags(ec->irq, IRQF_VALID);
694 for (ecp = &cards; *ecp; ecp = &(*ecp)->next);
697 slot_to_expcard[slot] = ec;
699 device_register(&ec->dev);
700 device_create_file(&ec->dev, &dev_attr_dma);
701 device_create_file(&ec->dev, &dev_attr_irq);
702 device_create_file(&ec->dev, &dev_attr_resource);
703 device_create_file(&ec->dev, &dev_attr_vendor);
704 device_create_file(&ec->dev, &dev_attr_device);
715 * Initialise the expansion card system.
716 * Locate all hardware - interrupt management and
719 static int __init ecard_init(void)
723 printk("Probing expansion cards\n");
725 for (slot = 0; slot < MAX_ECARDS; slot ++) {
726 ecard_probe(slot, ECARD_IOC);
729 irqhw = ecard_probeirqhw();
731 set_irq_chained_handler(IRQ_EXPANSIONCARD,
732 irqhw ? ecard_irqexp_handler : ecard_irq_handler);
739 subsys_initcall(ecard_init);
744 static const struct ecard_id *
745 ecard_match_device(const struct ecard_id *ids, struct expansion_card *ec)
749 for (i = 0; ids[i].manufacturer != 65535; i++)
750 if (ec->cid.manufacturer == ids[i].manufacturer &&
751 ec->cid.product == ids[i].product)
757 static int ecard_drv_probe(struct device *dev)
759 struct expansion_card *ec = ECARD_DEV(dev);
760 struct ecard_driver *drv = ECARD_DRV(dev->driver);
761 const struct ecard_id *id;
764 id = ecard_match_device(drv->id_table, ec);
767 ret = drv->probe(ec, id);
773 static int ecard_drv_remove(struct device *dev)
775 struct expansion_card *ec = ECARD_DEV(dev);
776 struct ecard_driver *drv = ECARD_DRV(dev->driver);
785 * Before rebooting, we must make sure that the expansion card is in a
786 * sensible state, so it can be re-detected. This means that the first
787 * page of the ROM must be visible. We call the expansion cards reset
790 static void ecard_drv_shutdown(struct device *dev)
792 struct expansion_card *ec = ECARD_DEV(dev);
793 struct ecard_driver *drv = ECARD_DRV(dev->driver);
794 struct ecard_request req;
804 int ecard_register_driver(struct ecard_driver *drv)
806 drv->drv.bus = &ecard_bus_type;
807 drv->drv.probe = ecard_drv_probe;
808 drv->drv.remove = ecard_drv_remove;
809 drv->drv.shutdown = ecard_drv_shutdown;
811 return driver_register(&drv->drv);
814 void ecard_remove_driver(struct ecard_driver *drv)
816 driver_unregister(&drv->drv);
819 static int ecard_match(struct device *_dev, struct device_driver *_drv)
821 struct expansion_card *ec = ECARD_DEV(_dev);
822 struct ecard_driver *drv = ECARD_DRV(_drv);
826 ret = ecard_match_device(drv->id_table, ec) != NULL;
828 ret = ec->cid.id == drv->id;
834 struct bus_type ecard_bus_type = {
836 .match = ecard_match,
839 static int ecard_bus_init(void)
841 return bus_register(&ecard_bus_type);
844 postcore_initcall(ecard_bus_init);
846 EXPORT_SYMBOL(ecard_readchunk);
847 EXPORT_SYMBOL(ecard_address);
848 EXPORT_SYMBOL(ecard_register_driver);
849 EXPORT_SYMBOL(ecard_remove_driver);
850 EXPORT_SYMBOL(ecard_bus_type);