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/module.h>
28 #include <linux/kernel.h>
29 #include <linux/types.h>
30 #include <linux/sched.h>
31 #include <linux/interrupt.h>
32 #include <linux/reboot.h>
34 #include <linux/slab.h>
35 #include <linux/proc_fs.h>
36 #include <linux/device.h>
37 #include <linux/init.h>
40 #include <asm/ecard.h>
41 #include <asm/hardware.h>
44 #include <asm/mmu_context.h>
45 #include <asm/irqchip.h>
46 #include <asm/tlbflush.h>
53 struct ecard_request
{
58 unsigned int use_loader
;
62 struct expcard_blacklist
{
63 unsigned short manufacturer
;
64 unsigned short product
;
68 static ecard_t
*cards
;
69 static ecard_t
*slot_to_expcard
[MAX_ECARDS
];
70 static unsigned int ectcr
;
72 /* List of descriptions of cards which don't have an extended
73 * identification, or chunk directories containing a description.
75 static struct expcard_blacklist __initdata blacklist
[] = {
76 { MANU_ACORN
, PROD_ACORN_ETHER1
, "Acorn Ether1" }
80 ecard_loader_reset(volatile unsigned char *pa
, loader_t loader
);
82 ecard_loader_read(int off
, volatile unsigned char *pa
, loader_t loader
);
84 static const struct ecard_id
*
85 ecard_match_device(const struct ecard_id
*ids
, struct expansion_card
*ec
);
87 static inline unsigned short
88 ecard_getu16(unsigned char *v
)
90 return v
[0] | v
[1] << 8;
93 static inline signed long
94 ecard_gets24(unsigned char *v
)
96 return v
[0] | v
[1] << 8 | v
[2] << 16 | ((v
[2] & 0x80) ? 0xff000000 : 0);
99 static inline ecard_t
*
100 slot_to_ecard(unsigned int slot
)
102 return slot
< MAX_ECARDS
? slot_to_expcard
[slot
] : NULL
;
105 /* ===================== Expansion card daemon ======================== */
107 * Since the loader programs on the expansion cards need to be run
108 * in a specific environment, create a separate task with this
109 * environment up, and pass requests to this task as and when we
112 * This should allow 99% of loaders to be called from Linux.
114 * From a security standpoint, we trust the card vendors. This
115 * may be a misplaced trust.
117 #define BUS_ADDR(x) ((((unsigned long)(x)) << 2) + IO_BASE)
118 #define POD_INT_ADDR(x) ((volatile unsigned char *)\
119 ((BUS_ADDR((x)) - IO_BASE) + IO_START))
121 static inline void ecard_task_reset(struct ecard_request
*req
)
123 struct expansion_card
*ec
= req
->ec
;
125 ecard_loader_reset(POD_INT_ADDR(ec
->podaddr
), ec
->loader
);
129 ecard_task_readbytes(struct ecard_request
*req
)
131 unsigned char *buf
= (unsigned char *)req
->buffer
;
132 volatile unsigned char *base_addr
=
133 (volatile unsigned char *)POD_INT_ADDR(req
->ec
->podaddr
);
134 unsigned int len
= req
->length
;
135 unsigned int off
= req
->address
;
137 if (!req
->use_loader
|| !req
->ec
->loader
) {
140 *buf
++ = base_addr
[off
];
146 * The following is required by some
147 * expansion card loader programs.
149 *(unsigned long *)0x108 = 0;
150 *buf
++ = ecard_loader_read(off
++, base_addr
,
156 static void ecard_do_request(struct ecard_request
*req
)
160 ecard_task_readbytes(req
);
164 ecard_task_reset(req
);
170 * On 26-bit processors, we don't need the kcardd thread to access the
171 * expansion card loaders. We do it directly.
173 #define ecard_call(req) ecard_do_request(req)
175 /* ======================= Mid-level card control ===================== */
178 ecard_readbytes(void *addr
, ecard_t
*ec
, int off
, int len
, int useld
)
180 struct ecard_request req
;
182 req
.req
= req_readbytes
;
186 req
.use_loader
= useld
;
192 int ecard_readchunk(struct in_chunk_dir
*cd
, ecard_t
*ec
, int id
, int num
)
194 struct ex_chunk_dir excd
;
202 ecard_readbytes(&excd
, ec
, index
, 8, useld
);
204 if (c_id(&excd
) == 0) {
205 if (!useld
&& ec
->loader
) {
212 if (c_id(&excd
) == 0xf0) { /* link */
213 index
= c_start(&excd
);
216 if (c_id(&excd
) == 0x80) { /* loader */
218 ec
->loader
= (loader_t
)kmalloc(c_len(&excd
),
221 ecard_readbytes(ec
->loader
, ec
,
223 c_len(&excd
), useld
);
229 if (c_id(&excd
) == id
&& num
-- == 0)
233 if (c_id(&excd
) & 0x80) {
234 switch (c_id(&excd
) & 0x70) {
236 ecard_readbytes((unsigned char *)excd
.d
.string
, ec
,
237 (int)c_start(&excd
), c_len(&excd
),
244 cd
->start_offset
= c_start(&excd
);
245 memcpy(cd
->d
.string
, excd
.d
.string
, 256);
249 /* ======================= Interrupt control ============================ */
251 static void ecard_def_irq_enable(ecard_t
*ec
, int irqnr
)
255 static void ecard_def_irq_disable(ecard_t
*ec
, int irqnr
)
259 static int ecard_def_irq_pending(ecard_t
*ec
)
261 return !ec
->irqmask
|| ec
->irqaddr
[0] & ec
->irqmask
;
264 static void ecard_def_fiq_enable(ecard_t
*ec
, int fiqnr
)
266 panic("ecard_def_fiq_enable called - impossible");
269 static void ecard_def_fiq_disable(ecard_t
*ec
, int fiqnr
)
271 panic("ecard_def_fiq_disable called - impossible");
274 static int ecard_def_fiq_pending(ecard_t
*ec
)
276 return !ec
->fiqmask
|| ec
->fiqaddr
[0] & ec
->fiqmask
;
279 static expansioncard_ops_t ecard_default_ops
= {
280 ecard_def_irq_enable
,
281 ecard_def_irq_disable
,
282 ecard_def_irq_pending
,
283 ecard_def_fiq_enable
,
284 ecard_def_fiq_disable
,
285 ecard_def_fiq_pending
289 * Enable and disable interrupts from expansion cards.
290 * (interrupts are disabled for these functions).
292 * They are not meant to be called directly, but via enable/disable_irq.
294 static void ecard_irq_unmask(unsigned int irqnr
)
296 ecard_t
*ec
= slot_to_ecard(irqnr
- 32);
300 ec
->ops
= &ecard_default_ops
;
302 if (ec
->claimed
&& ec
->ops
->irqenable
)
303 ec
->ops
->irqenable(ec
, irqnr
);
305 printk(KERN_ERR
"ecard: rejecting request to "
306 "enable IRQs for %d\n", irqnr
);
310 static void ecard_irq_mask(unsigned int irqnr
)
312 ecard_t
*ec
= slot_to_ecard(irqnr
- 32);
316 ec
->ops
= &ecard_default_ops
;
318 if (ec
->ops
&& ec
->ops
->irqdisable
)
319 ec
->ops
->irqdisable(ec
, irqnr
);
323 static struct irqchip ecard_chip
= {
324 .ack
= ecard_irq_mask
,
325 .mask
= ecard_irq_mask
,
326 .unmask
= ecard_irq_unmask
,
329 void ecard_enablefiq(unsigned int fiqnr
)
331 ecard_t
*ec
= slot_to_ecard(fiqnr
);
335 ec
->ops
= &ecard_default_ops
;
337 if (ec
->claimed
&& ec
->ops
->fiqenable
)
338 ec
->ops
->fiqenable(ec
, fiqnr
);
340 printk(KERN_ERR
"ecard: rejecting request to "
341 "enable FIQs for %d\n", fiqnr
);
345 void ecard_disablefiq(unsigned int fiqnr
)
347 ecard_t
*ec
= slot_to_ecard(fiqnr
);
351 ec
->ops
= &ecard_default_ops
;
353 if (ec
->ops
->fiqdisable
)
354 ec
->ops
->fiqdisable(ec
, fiqnr
);
359 ecard_dump_irq_state(ecard_t
*ec
)
361 printk(" %d: %sclaimed, ",
363 ec
->claimed
? "" : "not ");
365 if (ec
->ops
&& ec
->ops
->irqpending
&&
366 ec
->ops
!= &ecard_default_ops
)
367 printk("irq %spending\n",
368 ec
->ops
->irqpending(ec
) ? "" : "not ");
370 printk("irqaddr %p, mask = %02X, status = %02X\n",
371 ec
->irqaddr
, ec
->irqmask
, *ec
->irqaddr
);
374 static void ecard_check_lockup(struct irqdesc
*desc
)
376 static int last
, lockup
;
380 * If the timer interrupt has not run since the last million
381 * unrecognised expansion card interrupts, then there is
382 * something seriously wrong. Disable the expansion card
383 * interrupts so at least we can continue.
385 * Maybe we ought to start a timer to re-enable them some time
388 if (last
== jiffies
) {
390 if (lockup
> 1000000) {
391 printk(KERN_ERR
"\nInterrupt lockup detected - "
392 "disabling all expansion card interrupts\n");
394 desc
->chip
->mask(IRQ_EXPANSIONCARD
);
396 printk("Expansion card IRQ state:\n");
398 for (ec
= cards
; ec
; ec
= ec
->next
)
399 ecard_dump_irq_state(ec
);
405 * If we did not recognise the source of this interrupt,
406 * warn the user, but don't flood the user with these messages.
408 if (!last
|| time_after(jiffies
, (unsigned long)(last
+ 5*HZ
))) {
410 printk(KERN_WARNING
"Unrecognised interrupt from backplane\n");
415 ecard_irq_handler(unsigned int irq
, struct irqdesc
*desc
, struct pt_regs
*regs
)
420 desc
->chip
->mask(irq
);
421 for (ec
= cards
; ec
; ec
= ec
->next
) {
424 if (!ec
->claimed
|| ec
->irq
== NO_IRQ
)
427 if (ec
->ops
&& ec
->ops
->irqpending
)
428 pending
= ec
->ops
->irqpending(ec
);
430 pending
= ecard_default_ops
.irqpending(ec
);
433 struct irqdesc
*d
= irq_desc
+ ec
->irq
;
434 d
->handle(ec
->irq
, d
, regs
);
438 desc
->chip
->unmask(irq
);
441 ecard_check_lockup(desc
);
444 #define ecard_irqexp_handler NULL
445 #define ecard_probeirqhw() (0)
447 unsigned int ecard_address(ecard_t
*ec
, card_type_t type
, card_speed_t speed
)
449 unsigned long address
= 0;
450 int slot
= ec
->slot_no
;
452 ectcr
&= ~(1 << slot
);
456 address
= IO_EC_MEMC_BASE
+ (slot
<< 12);
460 address
= IO_EC_IOC_BASE
+ (slot
<< 12) + (speed
<< 17);
470 static int ecard_prints(char *buffer
, ecard_t
*ec
)
472 char *start
= buffer
;
474 buffer
+= sprintf(buffer
, " %d: ", ec
->slot_no
);
476 if (ec
->cid
.id
== 0) {
477 struct in_chunk_dir incd
;
479 buffer
+= sprintf(buffer
, "[%04X:%04X] ",
480 ec
->cid
.manufacturer
, ec
->cid
.product
);
482 if (!ec
->card_desc
&& ec
->cid
.cd
&&
483 ecard_readchunk(&incd
, ec
, 0xf5, 0)) {
484 ec
->card_desc
= kmalloc(strlen(incd
.d
.string
)+1, GFP_KERNEL
);
487 strcpy((char *)ec
->card_desc
, incd
.d
.string
);
490 buffer
+= sprintf(buffer
, "%s\n", ec
->card_desc
? ec
->card_desc
: "*unknown*");
492 buffer
+= sprintf(buffer
, "Simple card %d\n", ec
->cid
.id
);
494 return buffer
- start
;
497 static int get_ecard_dev_info(char *buf
, char **start
, off_t pos
, int count
)
504 while (ec
&& count
> cnt
) {
505 len
= ecard_prints(buf
, ec
);
509 *start
= buf
+ (pos
- (at
- len
));
517 return (count
> cnt
) ? cnt
: count
;
520 static struct proc_dir_entry
*proc_bus_ecard_dir
= NULL
;
522 static void ecard_proc_init(void)
524 proc_bus_ecard_dir
= proc_mkdir("ecard", proc_bus
);
525 create_proc_info_entry("devices", 0, proc_bus_ecard_dir
,
529 #define ec_set_resource(ec,nr,st,sz,flg) \
531 (ec)->resource[nr].name = ec->dev.bus_id; \
532 (ec)->resource[nr].start = st; \
533 (ec)->resource[nr].end = (st) + (sz) - 1; \
534 (ec)->resource[nr].flags = flg; \
537 static void __init
ecard_init_resources(struct expansion_card
*ec
)
539 unsigned long base
= PODSLOT_IOC0_BASE
;
540 unsigned int slot
= ec
->slot_no
;
543 ec_set_resource(ec
, ECARD_RES_MEMC
,
544 PODSLOT_MEMC_BASE
+ (slot
<< 14),
545 PODSLOT_MEMC_SIZE
, IORESOURCE_MEM
);
547 for (i
= 0; i
< ECARD_RES_IOCSYNC
- ECARD_RES_IOCSLOW
; i
++) {
548 ec_set_resource(ec
, i
+ ECARD_RES_IOCSLOW
,
549 base
+ (slot
<< 14) + (i
<< 19),
550 PODSLOT_IOC_SIZE
, IORESOURCE_MEM
);
553 for (i
= 0; i
< ECARD_NUM_RESOURCES
; i
++) {
554 if (ec
->resource
[i
].start
&&
555 request_resource(&iomem_resource
, &ec
->resource
[i
])) {
556 printk(KERN_ERR
"%s: resource(s) not available\n",
558 ec
->resource
[i
].end
-= ec
->resource
[i
].start
;
559 ec
->resource
[i
].start
= 0;
564 static ssize_t
ecard_show_irq(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
566 struct expansion_card
*ec
= ECARD_DEV(dev
);
567 return sprintf(buf
, "%u\n", ec
->irq
);
570 static ssize_t
ecard_show_vendor(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
572 struct expansion_card
*ec
= ECARD_DEV(dev
);
573 return sprintf(buf
, "%u\n", ec
->cid
.manufacturer
);
576 static ssize_t
ecard_show_device(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
578 struct expansion_card
*ec
= ECARD_DEV(dev
);
579 return sprintf(buf
, "%u\n", ec
->cid
.product
);
582 static ssize_t
ecard_show_dma(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
584 struct expansion_card
*ec
= ECARD_DEV(dev
);
585 return sprintf(buf
, "%u\n", ec
->dma
);
588 static ssize_t
ecard_show_resources(struct device
*dev
, struct device_attribute
*attr
, char *buf
)
590 struct expansion_card
*ec
= ECARD_DEV(dev
);
594 for (i
= 0; i
< ECARD_NUM_RESOURCES
; i
++)
595 str
+= sprintf(str
, "%08lx %08lx %08lx\n",
596 ec
->resource
[i
].start
,
598 ec
->resource
[i
].flags
);
603 static DEVICE_ATTR(irq
, S_IRUGO
, ecard_show_irq
, NULL
);
604 static DEVICE_ATTR(vendor
, S_IRUGO
, ecard_show_vendor
, NULL
);
605 static DEVICE_ATTR(device
, S_IRUGO
, ecard_show_device
, NULL
);
606 static DEVICE_ATTR(dma
, S_IRUGO
, ecard_show_dma
, NULL
);
607 static DEVICE_ATTR(resource
, S_IRUGO
, ecard_show_resources
, NULL
);
610 * Probe for an expansion card.
612 * If bit 1 of the first byte of the card is set, then the
613 * card does not exist.
616 ecard_probe(int slot
, card_type_t type
)
623 ec
= kmalloc(sizeof(ecard_t
), GFP_KERNEL
);
627 memset(ec
, 0, sizeof(ecard_t
));
634 ec
->card_desc
= NULL
;
635 ec
->ops
= &ecard_default_ops
;
638 if ((ec
->podaddr
= ecard_address(ec
, type
, ECARD_SYNC
)) == 0)
642 ecard_readbytes(&cid
, ec
, 0, 16, 0);
646 ec
->cid
.id
= cid
.r_id
;
647 ec
->cid
.cd
= cid
.r_cd
;
648 ec
->cid
.is
= cid
.r_is
;
650 ec
->cid
.manufacturer
= ecard_getu16(cid
.r_manu
);
651 ec
->cid
.product
= ecard_getu16(cid
.r_prod
);
652 ec
->cid
.country
= cid
.r_country
;
653 ec
->cid
.irqmask
= cid
.r_irqmask
;
654 ec
->cid
.irqoff
= ecard_gets24(cid
.r_irqoff
);
655 ec
->cid
.fiqmask
= cid
.r_fiqmask
;
656 ec
->cid
.fiqoff
= ecard_gets24(cid
.r_fiqoff
);
658 ec
->irqaddr
= (unsigned char *)ioaddr(ec
->podaddr
);
661 ec
->irqmask
= ec
->cid
.irqmask
;
662 ec
->irqaddr
+= ec
->cid
.irqoff
;
663 ec
->fiqmask
= ec
->cid
.fiqmask
;
664 ec
->fiqaddr
+= ec
->cid
.fiqoff
;
670 for (i
= 0; i
< sizeof(blacklist
) / sizeof(*blacklist
); i
++)
671 if (blacklist
[i
].manufacturer
== ec
->cid
.manufacturer
&&
672 blacklist
[i
].product
== ec
->cid
.product
) {
673 ec
->card_desc
= blacklist
[i
].type
;
677 snprintf(ec
->dev
.bus_id
, sizeof(ec
->dev
.bus_id
), "ecard%d", slot
);
678 ec
->dev
.parent
= NULL
;
679 ec
->dev
.bus
= &ecard_bus_type
;
680 ec
->dev
.dma_mask
= &ec
->dma_mask
;
681 ec
->dma_mask
= (u64
)0xffffffff;
683 ecard_init_resources(ec
);
686 * hook the interrupt handlers
689 set_irq_chip(ec
->irq
, &ecard_chip
);
690 set_irq_handler(ec
->irq
, do_level_IRQ
);
691 set_irq_flags(ec
->irq
, IRQF_VALID
);
693 for (ecp
= &cards
; *ecp
; ecp
= &(*ecp
)->next
);
696 slot_to_expcard
[slot
] = ec
;
698 device_register(&ec
->dev
);
699 device_create_file(&ec
->dev
, &dev_attr_dma
);
700 device_create_file(&ec
->dev
, &dev_attr_irq
);
701 device_create_file(&ec
->dev
, &dev_attr_resource
);
702 device_create_file(&ec
->dev
, &dev_attr_vendor
);
703 device_create_file(&ec
->dev
, &dev_attr_device
);
714 * Initialise the expansion card system.
715 * Locate all hardware - interrupt management and
718 static int __init
ecard_init(void)
722 printk("Probing expansion cards\n");
724 for (slot
= 0; slot
< MAX_ECARDS
; slot
++) {
725 ecard_probe(slot
, ECARD_IOC
);
728 irqhw
= ecard_probeirqhw();
730 set_irq_chained_handler(IRQ_EXPANSIONCARD
,
731 irqhw
? ecard_irqexp_handler
: ecard_irq_handler
);
738 subsys_initcall(ecard_init
);
743 static const struct ecard_id
*
744 ecard_match_device(const struct ecard_id
*ids
, struct expansion_card
*ec
)
748 for (i
= 0; ids
[i
].manufacturer
!= 65535; i
++)
749 if (ec
->cid
.manufacturer
== ids
[i
].manufacturer
&&
750 ec
->cid
.product
== ids
[i
].product
)
756 static int ecard_drv_probe(struct device
*dev
)
758 struct expansion_card
*ec
= ECARD_DEV(dev
);
759 struct ecard_driver
*drv
= ECARD_DRV(dev
->driver
);
760 const struct ecard_id
*id
;
763 id
= ecard_match_device(drv
->id_table
, ec
);
766 ret
= drv
->probe(ec
, id
);
772 static int ecard_drv_remove(struct device
*dev
)
774 struct expansion_card
*ec
= ECARD_DEV(dev
);
775 struct ecard_driver
*drv
= ECARD_DRV(dev
->driver
);
784 * Before rebooting, we must make sure that the expansion card is in a
785 * sensible state, so it can be re-detected. This means that the first
786 * page of the ROM must be visible. We call the expansion cards reset
789 static void ecard_drv_shutdown(struct device
*dev
)
791 struct expansion_card
*ec
= ECARD_DEV(dev
);
792 struct ecard_driver
*drv
= ECARD_DRV(dev
->driver
);
793 struct ecard_request req
;
803 int ecard_register_driver(struct ecard_driver
*drv
)
805 drv
->drv
.bus
= &ecard_bus_type
;
806 drv
->drv
.probe
= ecard_drv_probe
;
807 drv
->drv
.remove
= ecard_drv_remove
;
808 drv
->drv
.shutdown
= ecard_drv_shutdown
;
810 return driver_register(&drv
->drv
);
813 void ecard_remove_driver(struct ecard_driver
*drv
)
815 driver_unregister(&drv
->drv
);
818 static int ecard_match(struct device
*_dev
, struct device_driver
*_drv
)
820 struct expansion_card
*ec
= ECARD_DEV(_dev
);
821 struct ecard_driver
*drv
= ECARD_DRV(_drv
);
825 ret
= ecard_match_device(drv
->id_table
, ec
) != NULL
;
827 ret
= ec
->cid
.id
== drv
->id
;
833 struct bus_type ecard_bus_type
= {
835 .match
= ecard_match
,
838 static int ecard_bus_init(void)
840 return bus_register(&ecard_bus_type
);
843 postcore_initcall(ecard_bus_init
);
845 EXPORT_SYMBOL(ecard_readchunk
);
846 EXPORT_SYMBOL(ecard_address
);
847 EXPORT_SYMBOL(ecard_register_driver
);
848 EXPORT_SYMBOL(ecard_remove_driver
);
849 EXPORT_SYMBOL(ecard_bus_type
);