2 * linux/drivers/ide/arm/icside.c
4 * Copyright (c) 1996-2004 Russell King.
6 * Please note that this platform does not support 32-bit IDE IO.
9 #include <linux/string.h>
10 #include <linux/module.h>
11 #include <linux/ioport.h>
12 #include <linux/slab.h>
13 #include <linux/blkdev.h>
14 #include <linux/errno.h>
15 #include <linux/hdreg.h>
16 #include <linux/ide.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/device.h>
19 #include <linux/init.h>
20 #include <linux/scatterlist.h>
24 #include <asm/ecard.h>
26 #define ICS_IDENT_OFFSET 0x2280
28 #define ICS_ARCIN_V5_INTRSTAT 0x0000
29 #define ICS_ARCIN_V5_INTROFFSET 0x0004
30 #define ICS_ARCIN_V5_IDEOFFSET 0x2800
31 #define ICS_ARCIN_V5_IDEALTOFFSET 0x2b80
32 #define ICS_ARCIN_V5_IDESTEPPING 6
34 #define ICS_ARCIN_V6_IDEOFFSET_1 0x2000
35 #define ICS_ARCIN_V6_INTROFFSET_1 0x2200
36 #define ICS_ARCIN_V6_INTRSTAT_1 0x2290
37 #define ICS_ARCIN_V6_IDEALTOFFSET_1 0x2380
38 #define ICS_ARCIN_V6_IDEOFFSET_2 0x3000
39 #define ICS_ARCIN_V6_INTROFFSET_2 0x3200
40 #define ICS_ARCIN_V6_INTRSTAT_2 0x3290
41 #define ICS_ARCIN_V6_IDEALTOFFSET_2 0x3380
42 #define ICS_ARCIN_V6_IDESTEPPING 6
45 unsigned int dataoffset;
46 unsigned int ctrloffset;
47 unsigned int stepping;
50 static struct cardinfo icside_cardinfo_v5 = {
51 .dataoffset = ICS_ARCIN_V5_IDEOFFSET,
52 .ctrloffset = ICS_ARCIN_V5_IDEALTOFFSET,
53 .stepping = ICS_ARCIN_V5_IDESTEPPING,
56 static struct cardinfo icside_cardinfo_v6_1 = {
57 .dataoffset = ICS_ARCIN_V6_IDEOFFSET_1,
58 .ctrloffset = ICS_ARCIN_V6_IDEALTOFFSET_1,
59 .stepping = ICS_ARCIN_V6_IDESTEPPING,
62 static struct cardinfo icside_cardinfo_v6_2 = {
63 .dataoffset = ICS_ARCIN_V6_IDEOFFSET_2,
64 .ctrloffset = ICS_ARCIN_V6_IDEALTOFFSET_2,
65 .stepping = ICS_ARCIN_V6_IDESTEPPING,
71 void __iomem *irq_port;
72 void __iomem *ioc_base;
74 /* parent device... until the IDE core gets one of its own */
79 #define ICS_TYPE_A3IN 0
80 #define ICS_TYPE_A3USER 1
82 #define ICS_TYPE_V5 15
83 #define ICS_TYPE_NOTYPE ((unsigned int)-1)
85 /* ---------------- Version 5 PCB Support Functions --------------------- */
86 /* Prototype: icside_irqenable_arcin_v5 (struct expansion_card *ec, int irqnr)
87 * Purpose : enable interrupts from card
89 static void icside_irqenable_arcin_v5 (struct expansion_card *ec, int irqnr)
91 struct icside_state *state = ec->irq_data;
93 writeb(0, state->irq_port + ICS_ARCIN_V5_INTROFFSET);
96 /* Prototype: icside_irqdisable_arcin_v5 (struct expansion_card *ec, int irqnr)
97 * Purpose : disable interrupts from card
99 static void icside_irqdisable_arcin_v5 (struct expansion_card *ec, int irqnr)
101 struct icside_state *state = ec->irq_data;
103 readb(state->irq_port + ICS_ARCIN_V5_INTROFFSET);
106 static const expansioncard_ops_t icside_ops_arcin_v5 = {
107 .irqenable = icside_irqenable_arcin_v5,
108 .irqdisable = icside_irqdisable_arcin_v5,
112 /* ---------------- Version 6 PCB Support Functions --------------------- */
113 /* Prototype: icside_irqenable_arcin_v6 (struct expansion_card *ec, int irqnr)
114 * Purpose : enable interrupts from card
116 static void icside_irqenable_arcin_v6 (struct expansion_card *ec, int irqnr)
118 struct icside_state *state = ec->irq_data;
119 void __iomem *base = state->irq_port;
123 switch (state->channel) {
125 writeb(0, base + ICS_ARCIN_V6_INTROFFSET_1);
126 readb(base + ICS_ARCIN_V6_INTROFFSET_2);
129 writeb(0, base + ICS_ARCIN_V6_INTROFFSET_2);
130 readb(base + ICS_ARCIN_V6_INTROFFSET_1);
135 /* Prototype: icside_irqdisable_arcin_v6 (struct expansion_card *ec, int irqnr)
136 * Purpose : disable interrupts from card
138 static void icside_irqdisable_arcin_v6 (struct expansion_card *ec, int irqnr)
140 struct icside_state *state = ec->irq_data;
144 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_1);
145 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_2);
148 /* Prototype: icside_irqprobe(struct expansion_card *ec)
149 * Purpose : detect an active interrupt from card
151 static int icside_irqpending_arcin_v6(struct expansion_card *ec)
153 struct icside_state *state = ec->irq_data;
155 return readb(state->irq_port + ICS_ARCIN_V6_INTRSTAT_1) & 1 ||
156 readb(state->irq_port + ICS_ARCIN_V6_INTRSTAT_2) & 1;
159 static const expansioncard_ops_t icside_ops_arcin_v6 = {
160 .irqenable = icside_irqenable_arcin_v6,
161 .irqdisable = icside_irqdisable_arcin_v6,
162 .irqpending = icside_irqpending_arcin_v6,
166 * Handle routing of interrupts. This is called before
167 * we write the command to the drive.
169 static void icside_maskproc(ide_drive_t *drive, int mask)
171 ide_hwif_t *hwif = HWIF(drive);
172 struct icside_state *state = hwif->hwif_data;
175 local_irq_save(flags);
177 state->channel = hwif->channel;
179 if (state->enabled && !mask) {
180 switch (hwif->channel) {
182 writeb(0, state->irq_port + ICS_ARCIN_V6_INTROFFSET_1);
183 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_2);
186 writeb(0, state->irq_port + ICS_ARCIN_V6_INTROFFSET_2);
187 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_1);
191 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_2);
192 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_1);
195 local_irq_restore(flags);
198 #ifdef CONFIG_BLK_DEV_IDEDMA_ICS
202 * Similar to the BM-DMA, but we use the RiscPCs IOMD DMA controllers.
203 * There is only one DMA controller per card, which means that only
204 * one drive can be accessed at one time. NOTE! We do not enforce that
205 * here, but we rely on the main IDE driver spotting that both
206 * interfaces use the same IRQ, which should guarantee this.
209 static void icside_build_sglist(ide_drive_t *drive, struct request *rq)
211 ide_hwif_t *hwif = drive->hwif;
212 struct icside_state *state = hwif->hwif_data;
213 struct scatterlist *sg = hwif->sg_table;
215 ide_map_sg(drive, rq);
217 if (rq_data_dir(rq) == READ)
218 hwif->sg_dma_direction = DMA_FROM_DEVICE;
220 hwif->sg_dma_direction = DMA_TO_DEVICE;
222 hwif->sg_nents = dma_map_sg(state->dev, sg, hwif->sg_nents,
223 hwif->sg_dma_direction);
227 * Configure the IOMD to give the appropriate timings for the transfer
228 * mode being requested. We take the advice of the ATA standards, and
229 * calculate the cycle time based on the transfer mode, and the EIDE
230 * MW DMA specs that the drive provides in the IDENTIFY command.
232 * We have the following IOMD DMA modes to choose from:
234 * Type Active Recovery Cycle
235 * A 250 (250) 312 (550) 562 (800)
237 * C 125 (125) 125 (375) 250 (500)
240 * (figures in brackets are actual measured timings)
242 * However, we also need to take care of the read/write active and
246 * Mode Active -- Recovery -- Cycle IOMD type
247 * MW0 215 50 215 480 A
251 static int icside_set_speed(ide_drive_t *drive, u8 xfer_mode)
253 int on = 0, cycle_time = 0, use_dma_info = 0;
256 * Limit the transfer speed to MW_DMA_2.
258 xfer_mode = ide_rate_filter(drive, xfer_mode);
283 * If we're going to be doing MW_DMA_1 or MW_DMA_2, we should
284 * take care to note the values in the ID...
286 if (use_dma_info && drive->id->eide_dma_time > cycle_time)
287 cycle_time = drive->id->eide_dma_time;
289 drive->drive_data = cycle_time;
291 if (cycle_time && ide_config_drive_speed(drive, xfer_mode) == 0)
294 drive->drive_data = 480;
296 printk("%s: %s selected (peak %dMB/s)\n", drive->name,
297 ide_xfer_verbose(xfer_mode), 2000 / drive->drive_data);
299 drive->current_speed = xfer_mode;
304 static void icside_dma_host_off(ide_drive_t *drive)
308 static void icside_dma_off_quietly(ide_drive_t *drive)
310 drive->using_dma = 0;
313 static void icside_dma_host_on(ide_drive_t *drive)
317 static int icside_dma_on(ide_drive_t *drive)
319 drive->using_dma = 1;
324 static int icside_dma_check(ide_drive_t *drive)
326 struct hd_driveid *id = drive->id;
327 ide_hwif_t *hwif = HWIF(drive);
328 int xfer_mode = XFER_PIO_2;
331 if (!(id->capability & 1) || !hwif->autodma)
335 * Consult the list of known "bad" drives
337 if (__ide_dma_bad_drive(drive))
341 * Enable DMA on any drive that has multiword DMA
343 if (id->field_valid & 2) {
344 xfer_mode = ide_max_dma_mode(drive);
349 * Consult the list of known "good" drives
351 if (__ide_dma_good_drive(drive)) {
352 if (id->eide_dma_time > 150)
354 xfer_mode = XFER_MW_DMA_1;
358 on = icside_set_speed(drive, xfer_mode);
363 static int icside_dma_end(ide_drive_t *drive)
365 ide_hwif_t *hwif = HWIF(drive);
366 struct icside_state *state = hwif->hwif_data;
368 drive->waiting_for_dma = 0;
370 disable_dma(hwif->hw.dma);
372 /* Teardown mappings after DMA has completed. */
373 dma_unmap_sg(state->dev, hwif->sg_table, hwif->sg_nents,
374 hwif->sg_dma_direction);
376 return get_dma_residue(hwif->hw.dma) != 0;
379 static void icside_dma_start(ide_drive_t *drive)
381 ide_hwif_t *hwif = HWIF(drive);
383 /* We can not enable DMA on both channels simultaneously. */
384 BUG_ON(dma_channel_active(hwif->hw.dma));
385 enable_dma(hwif->hw.dma);
388 static int icside_dma_setup(ide_drive_t *drive)
390 ide_hwif_t *hwif = HWIF(drive);
391 struct request *rq = hwif->hwgroup->rq;
392 unsigned int dma_mode;
395 dma_mode = DMA_MODE_WRITE;
397 dma_mode = DMA_MODE_READ;
400 * We can not enable DMA on both channels.
402 BUG_ON(dma_channel_active(hwif->hw.dma));
404 icside_build_sglist(drive, rq);
407 * Ensure that we have the right interrupt routed.
409 icside_maskproc(drive, 0);
412 * Route the DMA signals to the correct interface.
414 writeb(hwif->select_data, hwif->config_data);
417 * Select the correct timing for this drive.
419 set_dma_speed(hwif->hw.dma, drive->drive_data);
422 * Tell the DMA engine about the SG table and
425 set_dma_sg(hwif->hw.dma, hwif->sg_table, hwif->sg_nents);
426 set_dma_mode(hwif->hw.dma, dma_mode);
428 drive->waiting_for_dma = 1;
433 static void icside_dma_exec_cmd(ide_drive_t *drive, u8 cmd)
435 /* issue cmd to drive */
436 ide_execute_command(drive, cmd, ide_dma_intr, 2 * WAIT_CMD, NULL);
439 static int icside_dma_test_irq(ide_drive_t *drive)
441 ide_hwif_t *hwif = HWIF(drive);
442 struct icside_state *state = hwif->hwif_data;
444 return readb(state->irq_port +
446 ICS_ARCIN_V6_INTRSTAT_2 :
447 ICS_ARCIN_V6_INTRSTAT_1)) & 1;
450 static void icside_dma_timeout(ide_drive_t *drive)
452 printk(KERN_ERR "%s: DMA timeout occurred: ", drive->name);
454 if (icside_dma_test_irq(drive))
457 ide_dump_status(drive, "DMA timeout", HWIF(drive)->INB(IDE_STATUS_REG));
459 icside_dma_end(drive);
462 static void icside_dma_lost_irq(ide_drive_t *drive)
464 printk(KERN_ERR "%s: IRQ lost\n", drive->name);
467 static void icside_dma_init(ide_hwif_t *hwif)
469 printk(" %s: SG-DMA", hwif->name);
472 hwif->mwdma_mask = 7; /* MW0..2 */
473 hwif->swdma_mask = 7; /* SW0..2 */
475 hwif->dmatable_cpu = NULL;
476 hwif->dmatable_dma = 0;
477 hwif->speedproc = icside_set_speed;
480 hwif->ide_dma_check = icside_dma_check;
481 hwif->dma_host_off = icside_dma_host_off;
482 hwif->dma_off_quietly = icside_dma_off_quietly;
483 hwif->dma_host_on = icside_dma_host_on;
484 hwif->ide_dma_on = icside_dma_on;
485 hwif->dma_setup = icside_dma_setup;
486 hwif->dma_exec_cmd = icside_dma_exec_cmd;
487 hwif->dma_start = icside_dma_start;
488 hwif->ide_dma_end = icside_dma_end;
489 hwif->ide_dma_test_irq = icside_dma_test_irq;
490 hwif->dma_timeout = icside_dma_timeout;
491 hwif->dma_lost_irq = icside_dma_lost_irq;
493 hwif->drives[0].autodma = hwif->autodma;
494 hwif->drives[1].autodma = hwif->autodma;
496 printk(" capable%s\n", hwif->autodma ? ", auto-enable" : "");
499 #define icside_dma_init(hwif) (0)
502 static ide_hwif_t *icside_find_hwif(unsigned long dataport)
507 for (index = 0; index < MAX_HWIFS; ++index) {
508 hwif = &ide_hwifs[index];
509 if (hwif->io_ports[IDE_DATA_OFFSET] == dataport)
513 for (index = 0; index < MAX_HWIFS; ++index) {
514 hwif = &ide_hwifs[index];
515 if (!hwif->io_ports[IDE_DATA_OFFSET])
525 icside_setup(void __iomem *base, struct cardinfo *info, struct expansion_card *ec)
527 unsigned long port = (unsigned long)base + info->dataoffset;
530 hwif = icside_find_hwif(port);
534 memset(&hwif->hw, 0, sizeof(hw_regs_t));
537 * Ensure we're using MMIO
539 default_hwif_mmiops(hwif);
542 for (i = IDE_DATA_OFFSET; i <= IDE_STATUS_OFFSET; i++) {
543 hwif->hw.io_ports[i] = port;
544 hwif->io_ports[i] = port;
545 port += 1 << info->stepping;
547 hwif->hw.io_ports[IDE_CONTROL_OFFSET] = (unsigned long)base + info->ctrloffset;
548 hwif->io_ports[IDE_CONTROL_OFFSET] = (unsigned long)base + info->ctrloffset;
549 hwif->hw.irq = ec->irq;
552 hwif->chipset = ide_acorn;
553 hwif->gendev.parent = &ec->dev;
560 icside_register_v5(struct icside_state *state, struct expansion_card *ec)
565 base = ecardm_iomap(ec, ECARD_RES_MEMC, 0, 0);
569 state->irq_port = base;
571 ec->irqaddr = base + ICS_ARCIN_V5_INTRSTAT;
574 ecard_setirq(ec, &icside_ops_arcin_v5, state);
577 * Be on the safe side - disable interrupts
579 icside_irqdisable_arcin_v5(ec, 0);
581 hwif = icside_setup(base, &icside_cardinfo_v5, ec);
585 state->hwif[0] = hwif;
587 probe_hwif_init(hwif);
589 ide_proc_register_port(hwif);
595 icside_register_v6(struct icside_state *state, struct expansion_card *ec)
597 ide_hwif_t *hwif, *mate;
598 void __iomem *ioc_base, *easi_base;
599 unsigned int sel = 0;
602 ioc_base = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, 0);
608 easi_base = ioc_base;
610 if (ecard_resource_flags(ec, ECARD_RES_EASI)) {
611 easi_base = ecardm_iomap(ec, ECARD_RES_EASI, 0, 0);
618 * Enable access to the EASI region.
623 writeb(sel, ioc_base);
625 ecard_setirq(ec, &icside_ops_arcin_v6, state);
627 state->irq_port = easi_base;
628 state->ioc_base = ioc_base;
631 * Be on the safe side - disable interrupts
633 icside_irqdisable_arcin_v6(ec, 0);
636 * Find and register the interfaces.
638 hwif = icside_setup(easi_base, &icside_cardinfo_v6_1, ec);
639 mate = icside_setup(easi_base, &icside_cardinfo_v6_2, ec);
641 if (!hwif || !mate) {
646 state->hwif[0] = hwif;
647 state->hwif[1] = mate;
649 hwif->maskproc = icside_maskproc;
651 hwif->hwif_data = state;
653 hwif->serialized = 1;
654 hwif->config_data = (unsigned long)ioc_base;
655 hwif->select_data = sel;
656 hwif->hw.dma = ec->dma;
658 mate->maskproc = icside_maskproc;
660 mate->hwif_data = state;
662 mate->serialized = 1;
663 mate->config_data = (unsigned long)ioc_base;
664 mate->select_data = sel | 1;
665 mate->hw.dma = ec->dma;
667 if (ec->dma != NO_DMA && !request_dma(ec->dma, hwif->name)) {
668 icside_dma_init(hwif);
669 icside_dma_init(mate);
672 probe_hwif_init(hwif);
673 probe_hwif_init(mate);
675 ide_proc_register_port(hwif);
676 ide_proc_register_port(mate);
685 icside_probe(struct expansion_card *ec, const struct ecard_id *id)
687 struct icside_state *state;
691 ret = ecard_request_resources(ec);
695 state = kzalloc(sizeof(struct icside_state), GFP_KERNEL);
701 state->type = ICS_TYPE_NOTYPE;
702 state->dev = &ec->dev;
704 idmem = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, 0);
708 type = readb(idmem + ICS_IDENT_OFFSET) & 1;
709 type |= (readb(idmem + ICS_IDENT_OFFSET + 4) & 1) << 1;
710 type |= (readb(idmem + ICS_IDENT_OFFSET + 8) & 1) << 2;
711 type |= (readb(idmem + ICS_IDENT_OFFSET + 12) & 1) << 3;
712 ecardm_iounmap(ec, idmem);
717 switch (state->type) {
719 dev_warn(&ec->dev, "A3IN unsupported\n");
723 case ICS_TYPE_A3USER:
724 dev_warn(&ec->dev, "A3USER unsupported\n");
729 ret = icside_register_v5(state, ec);
733 ret = icside_register_v6(state, ec);
737 dev_warn(&ec->dev, "unknown interface type\n");
743 ecard_set_drvdata(ec, state);
749 ecard_release_resources(ec);
754 static void __devexit icside_remove(struct expansion_card *ec)
756 struct icside_state *state = ecard_get_drvdata(ec);
758 switch (state->type) {
760 /* FIXME: tell IDE to stop using the interface */
762 /* Disable interrupts */
763 icside_irqdisable_arcin_v5(ec, 0);
767 /* FIXME: tell IDE to stop using the interface */
768 if (ec->dma != NO_DMA)
771 /* Disable interrupts */
772 icside_irqdisable_arcin_v6(ec, 0);
774 /* Reset the ROM pointer/EASI selection */
775 writeb(0, state->ioc_base);
779 ecard_set_drvdata(ec, NULL);
782 ecard_release_resources(ec);
785 static void icside_shutdown(struct expansion_card *ec)
787 struct icside_state *state = ecard_get_drvdata(ec);
791 * Disable interrupts from this card. We need to do
792 * this before disabling EASI since we may be accessing
793 * this register via that region.
795 local_irq_save(flags);
796 ec->ops->irqdisable(ec, 0);
797 local_irq_restore(flags);
800 * Reset the ROM pointer so that we can read the ROM
801 * after a soft reboot. This also disables access to
802 * the IDE taskfile via the EASI region.
805 writeb(0, state->ioc_base);
808 static const struct ecard_id icside_ids[] = {
809 { MANU_ICS, PROD_ICS_IDE },
810 { MANU_ICS2, PROD_ICS2_IDE },
814 static struct ecard_driver icside_driver = {
815 .probe = icside_probe,
816 .remove = __devexit_p(icside_remove),
817 .shutdown = icside_shutdown,
818 .id_table = icside_ids,
824 static int __init icside_init(void)
826 return ecard_register_driver(&icside_driver);
829 MODULE_AUTHOR("Russell King <rmk@arm.linux.org.uk>");
830 MODULE_LICENSE("GPL");
831 MODULE_DESCRIPTION("ICS IDE driver");
833 module_init(icside_init);