2 * Copyright (c) 1996-2004 Russell King.
4 * Please note that this platform does not support 32-bit IDE IO.
7 #include <linux/string.h>
8 #include <linux/module.h>
9 #include <linux/ioport.h>
10 #include <linux/slab.h>
11 #include <linux/blkdev.h>
12 #include <linux/errno.h>
13 #include <linux/hdreg.h>
14 #include <linux/ide.h>
15 #include <linux/dma-mapping.h>
16 #include <linux/device.h>
17 #include <linux/init.h>
18 #include <linux/scatterlist.h>
22 #include <asm/ecard.h>
24 #define DRV_NAME "icside"
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;
78 #define ICS_TYPE_A3IN 0
79 #define ICS_TYPE_A3USER 1
81 #define ICS_TYPE_V5 15
82 #define ICS_TYPE_NOTYPE ((unsigned int)-1)
84 /* ---------------- Version 5 PCB Support Functions --------------------- */
85 /* Prototype: icside_irqenable_arcin_v5 (struct expansion_card *ec, int irqnr)
86 * Purpose : enable interrupts from card
88 static void icside_irqenable_arcin_v5 (struct expansion_card *ec, int irqnr)
90 struct icside_state *state = ec->irq_data;
92 writeb(0, state->irq_port + ICS_ARCIN_V5_INTROFFSET);
95 /* Prototype: icside_irqdisable_arcin_v5 (struct expansion_card *ec, int irqnr)
96 * Purpose : disable interrupts from card
98 static void icside_irqdisable_arcin_v5 (struct expansion_card *ec, int irqnr)
100 struct icside_state *state = ec->irq_data;
102 readb(state->irq_port + ICS_ARCIN_V5_INTROFFSET);
105 static const expansioncard_ops_t icside_ops_arcin_v5 = {
106 .irqenable = icside_irqenable_arcin_v5,
107 .irqdisable = icside_irqdisable_arcin_v5,
111 /* ---------------- Version 6 PCB Support Functions --------------------- */
112 /* Prototype: icside_irqenable_arcin_v6 (struct expansion_card *ec, int irqnr)
113 * Purpose : enable interrupts from card
115 static void icside_irqenable_arcin_v6 (struct expansion_card *ec, int irqnr)
117 struct icside_state *state = ec->irq_data;
118 void __iomem *base = state->irq_port;
122 switch (state->channel) {
124 writeb(0, base + ICS_ARCIN_V6_INTROFFSET_1);
125 readb(base + ICS_ARCIN_V6_INTROFFSET_2);
128 writeb(0, base + ICS_ARCIN_V6_INTROFFSET_2);
129 readb(base + ICS_ARCIN_V6_INTROFFSET_1);
134 /* Prototype: icside_irqdisable_arcin_v6 (struct expansion_card *ec, int irqnr)
135 * Purpose : disable interrupts from card
137 static void icside_irqdisable_arcin_v6 (struct expansion_card *ec, int irqnr)
139 struct icside_state *state = ec->irq_data;
143 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_1);
144 readb(state->irq_port + ICS_ARCIN_V6_INTROFFSET_2);
147 /* Prototype: icside_irqprobe(struct expansion_card *ec)
148 * Purpose : detect an active interrupt from card
150 static int icside_irqpending_arcin_v6(struct expansion_card *ec)
152 struct icside_state *state = ec->irq_data;
154 return readb(state->irq_port + ICS_ARCIN_V6_INTRSTAT_1) & 1 ||
155 readb(state->irq_port + ICS_ARCIN_V6_INTRSTAT_2) & 1;
158 static const expansioncard_ops_t icside_ops_arcin_v6 = {
159 .irqenable = icside_irqenable_arcin_v6,
160 .irqdisable = icside_irqdisable_arcin_v6,
161 .irqpending = icside_irqpending_arcin_v6,
165 * Handle routing of interrupts. This is called before
166 * we write the command to the drive.
168 static void icside_maskproc(ide_drive_t *drive, int mask)
170 ide_hwif_t *hwif = HWIF(drive);
171 struct expansion_card *ec = ECARD_DEV(hwif->dev);
172 struct icside_state *state = ecard_get_drvdata(ec);
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 static const struct ide_port_ops icside_v6_no_dma_port_ops = {
199 .maskproc = icside_maskproc,
202 #ifdef CONFIG_BLK_DEV_IDEDMA_ICS
206 * Similar to the BM-DMA, but we use the RiscPCs IOMD DMA controllers.
207 * There is only one DMA controller per card, which means that only
208 * one drive can be accessed at one time. NOTE! We do not enforce that
209 * here, but we rely on the main IDE driver spotting that both
210 * interfaces use the same IRQ, which should guarantee this.
214 * Configure the IOMD to give the appropriate timings for the transfer
215 * mode being requested. We take the advice of the ATA standards, and
216 * calculate the cycle time based on the transfer mode, and the EIDE
217 * MW DMA specs that the drive provides in the IDENTIFY command.
219 * We have the following IOMD DMA modes to choose from:
221 * Type Active Recovery Cycle
222 * A 250 (250) 312 (550) 562 (800)
224 * C 125 (125) 125 (375) 250 (500)
227 * (figures in brackets are actual measured timings)
229 * However, we also need to take care of the read/write active and
233 * Mode Active -- Recovery -- Cycle IOMD type
234 * MW0 215 50 215 480 A
238 static void icside_set_dma_mode(ide_drive_t *drive, const u8 xfer_mode)
240 int cycle_time, use_dma_info = 0;
265 * If we're going to be doing MW_DMA_1 or MW_DMA_2, we should
266 * take care to note the values in the ID...
268 if (use_dma_info && drive->id->eide_dma_time > cycle_time)
269 cycle_time = drive->id->eide_dma_time;
271 drive->drive_data = cycle_time;
273 printk("%s: %s selected (peak %dMB/s)\n", drive->name,
274 ide_xfer_verbose(xfer_mode), 2000 / drive->drive_data);
277 static const struct ide_port_ops icside_v6_port_ops = {
278 .set_dma_mode = icside_set_dma_mode,
279 .maskproc = icside_maskproc,
282 static void icside_dma_host_set(ide_drive_t *drive, int on)
286 static int icside_dma_end(ide_drive_t *drive)
288 ide_hwif_t *hwif = HWIF(drive);
289 struct expansion_card *ec = ECARD_DEV(hwif->dev);
291 drive->waiting_for_dma = 0;
293 disable_dma(ec->dma);
295 /* Teardown mappings after DMA has completed. */
296 ide_destroy_dmatable(drive);
298 return get_dma_residue(ec->dma) != 0;
301 static void icside_dma_start(ide_drive_t *drive)
303 ide_hwif_t *hwif = HWIF(drive);
304 struct expansion_card *ec = ECARD_DEV(hwif->dev);
306 /* We can not enable DMA on both channels simultaneously. */
307 BUG_ON(dma_channel_active(ec->dma));
311 static int icside_dma_setup(ide_drive_t *drive)
313 ide_hwif_t *hwif = HWIF(drive);
314 struct expansion_card *ec = ECARD_DEV(hwif->dev);
315 struct icside_state *state = ecard_get_drvdata(ec);
316 struct request *rq = hwif->hwgroup->rq;
317 unsigned int dma_mode;
320 dma_mode = DMA_MODE_WRITE;
322 dma_mode = DMA_MODE_READ;
325 * We can not enable DMA on both channels.
327 BUG_ON(dma_channel_active(ec->dma));
329 hwif->sg_nents = ide_build_sglist(drive, rq);
332 * Ensure that we have the right interrupt routed.
334 icside_maskproc(drive, 0);
337 * Route the DMA signals to the correct interface.
339 writeb(state->sel | hwif->channel, state->ioc_base);
342 * Select the correct timing for this drive.
344 set_dma_speed(ec->dma, drive->drive_data);
347 * Tell the DMA engine about the SG table and
350 set_dma_sg(ec->dma, hwif->sg_table, hwif->sg_nents);
351 set_dma_mode(ec->dma, dma_mode);
353 drive->waiting_for_dma = 1;
358 static void icside_dma_exec_cmd(ide_drive_t *drive, u8 cmd)
360 /* issue cmd to drive */
361 ide_execute_command(drive, cmd, ide_dma_intr, 2 * WAIT_CMD, NULL);
364 static int icside_dma_test_irq(ide_drive_t *drive)
366 ide_hwif_t *hwif = HWIF(drive);
367 struct expansion_card *ec = ECARD_DEV(hwif->dev);
368 struct icside_state *state = ecard_get_drvdata(ec);
370 return readb(state->irq_port +
372 ICS_ARCIN_V6_INTRSTAT_2 :
373 ICS_ARCIN_V6_INTRSTAT_1)) & 1;
376 static void icside_dma_timeout(ide_drive_t *drive)
378 printk(KERN_ERR "%s: DMA timeout occurred: ", drive->name);
380 if (icside_dma_test_irq(drive))
383 ide_dump_status(drive, "DMA timeout", ide_read_status(drive));
385 icside_dma_end(drive);
388 static void icside_dma_lost_irq(ide_drive_t *drive)
390 printk(KERN_ERR "%s: IRQ lost\n", drive->name);
393 static int icside_dma_init(ide_hwif_t *hwif, const struct ide_port_info *d)
395 hwif->dmatable_cpu = NULL;
396 hwif->dmatable_dma = 0;
401 static const struct ide_dma_ops icside_v6_dma_ops = {
402 .dma_host_set = icside_dma_host_set,
403 .dma_setup = icside_dma_setup,
404 .dma_exec_cmd = icside_dma_exec_cmd,
405 .dma_start = icside_dma_start,
406 .dma_end = icside_dma_end,
407 .dma_test_irq = icside_dma_test_irq,
408 .dma_timeout = icside_dma_timeout,
409 .dma_lost_irq = icside_dma_lost_irq,
412 #define icside_v6_dma_ops NULL
415 static int icside_dma_off_init(ide_hwif_t *hwif, const struct ide_port_info *d)
420 static void icside_setup_ports(hw_regs_t *hw, void __iomem *base,
421 struct cardinfo *info, struct expansion_card *ec)
423 unsigned long port = (unsigned long)base + info->dataoffset;
425 hw->io_ports.data_addr = port;
426 hw->io_ports.error_addr = port + (1 << info->stepping);
427 hw->io_ports.nsect_addr = port + (2 << info->stepping);
428 hw->io_ports.lbal_addr = port + (3 << info->stepping);
429 hw->io_ports.lbam_addr = port + (4 << info->stepping);
430 hw->io_ports.lbah_addr = port + (5 << info->stepping);
431 hw->io_ports.device_addr = port + (6 << info->stepping);
432 hw->io_ports.status_addr = port + (7 << info->stepping);
433 hw->io_ports.ctl_addr = (unsigned long)base + info->ctrloffset;
437 hw->chipset = ide_acorn;
441 icside_register_v5(struct icside_state *state, struct expansion_card *ec)
445 u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
448 base = ecardm_iomap(ec, ECARD_RES_MEMC, 0, 0);
452 state->irq_port = base;
454 ec->irqaddr = base + ICS_ARCIN_V5_INTRSTAT;
457 ecard_setirq(ec, &icside_ops_arcin_v5, state);
460 * Be on the safe side - disable interrupts
462 icside_irqdisable_arcin_v5(ec, 0);
464 icside_setup_ports(&hw, base, &icside_cardinfo_v5, ec);
466 hwif = ide_find_port();
470 ide_init_port_hw(hwif, &hw);
471 default_hwif_mmiops(hwif);
473 state->hwif[0] = hwif;
475 ecard_set_drvdata(ec, state);
477 idx[0] = hwif->index;
479 ide_device_add(idx, NULL);
484 static const struct ide_port_info icside_v6_port_info __initdata = {
485 .init_dma = icside_dma_off_init,
486 .port_ops = &icside_v6_no_dma_port_ops,
487 .dma_ops = &icside_v6_dma_ops,
488 .host_flags = IDE_HFLAG_SERIALIZE | IDE_HFLAG_MMIO,
489 .mwdma_mask = ATA_MWDMA2,
490 .swdma_mask = ATA_SWDMA2,
494 icside_register_v6(struct icside_state *state, struct expansion_card *ec)
496 ide_hwif_t *hwif, *mate;
497 void __iomem *ioc_base, *easi_base;
498 unsigned int sel = 0;
500 u8 idx[4] = { 0xff, 0xff, 0xff, 0xff };
501 struct ide_port_info d = icside_v6_port_info;
504 ioc_base = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, 0);
510 easi_base = ioc_base;
512 if (ecard_resource_flags(ec, ECARD_RES_EASI)) {
513 easi_base = ecardm_iomap(ec, ECARD_RES_EASI, 0, 0);
520 * Enable access to the EASI region.
525 writeb(sel, ioc_base);
527 ecard_setirq(ec, &icside_ops_arcin_v6, state);
529 state->irq_port = easi_base;
530 state->ioc_base = ioc_base;
534 * Be on the safe side - disable interrupts
536 icside_irqdisable_arcin_v6(ec, 0);
538 icside_setup_ports(&hw[0], easi_base, &icside_cardinfo_v6_1, ec);
539 icside_setup_ports(&hw[1], easi_base, &icside_cardinfo_v6_2, ec);
542 * Find and register the interfaces.
544 hwif = ide_find_port();
548 ide_init_port_hw(hwif, &hw[0]);
549 default_hwif_mmiops(hwif);
551 idx[0] = hwif->index;
553 mate = ide_find_port();
555 ide_init_port_hw(mate, &hw[1]);
556 default_hwif_mmiops(mate);
558 idx[1] = mate->index;
561 state->hwif[0] = hwif;
562 state->hwif[1] = mate;
564 ecard_set_drvdata(ec, state);
566 if (ec->dma != NO_DMA && !request_dma(ec->dma, DRV_NAME)) {
567 d.init_dma = icside_dma_init;
568 d.port_ops = &icside_v6_port_ops;
572 ide_device_add(idx, &d);
581 icside_probe(struct expansion_card *ec, const struct ecard_id *id)
583 struct icside_state *state;
587 ret = ecard_request_resources(ec);
591 state = kzalloc(sizeof(struct icside_state), GFP_KERNEL);
597 state->type = ICS_TYPE_NOTYPE;
599 idmem = ecardm_iomap(ec, ECARD_RES_IOCFAST, 0, 0);
603 type = readb(idmem + ICS_IDENT_OFFSET) & 1;
604 type |= (readb(idmem + ICS_IDENT_OFFSET + 4) & 1) << 1;
605 type |= (readb(idmem + ICS_IDENT_OFFSET + 8) & 1) << 2;
606 type |= (readb(idmem + ICS_IDENT_OFFSET + 12) & 1) << 3;
607 ecardm_iounmap(ec, idmem);
612 switch (state->type) {
614 dev_warn(&ec->dev, "A3IN unsupported\n");
618 case ICS_TYPE_A3USER:
619 dev_warn(&ec->dev, "A3USER unsupported\n");
624 ret = icside_register_v5(state, ec);
628 ret = icside_register_v6(state, ec);
632 dev_warn(&ec->dev, "unknown interface type\n");
642 ecard_release_resources(ec);
647 static void __devexit icside_remove(struct expansion_card *ec)
649 struct icside_state *state = ecard_get_drvdata(ec);
651 switch (state->type) {
653 /* FIXME: tell IDE to stop using the interface */
655 /* Disable interrupts */
656 icside_irqdisable_arcin_v5(ec, 0);
660 /* FIXME: tell IDE to stop using the interface */
661 if (ec->dma != NO_DMA)
664 /* Disable interrupts */
665 icside_irqdisable_arcin_v6(ec, 0);
667 /* Reset the ROM pointer/EASI selection */
668 writeb(0, state->ioc_base);
672 ecard_set_drvdata(ec, NULL);
675 ecard_release_resources(ec);
678 static void icside_shutdown(struct expansion_card *ec)
680 struct icside_state *state = ecard_get_drvdata(ec);
684 * Disable interrupts from this card. We need to do
685 * this before disabling EASI since we may be accessing
686 * this register via that region.
688 local_irq_save(flags);
689 ec->ops->irqdisable(ec, 0);
690 local_irq_restore(flags);
693 * Reset the ROM pointer so that we can read the ROM
694 * after a soft reboot. This also disables access to
695 * the IDE taskfile via the EASI region.
698 writeb(0, state->ioc_base);
701 static const struct ecard_id icside_ids[] = {
702 { MANU_ICS, PROD_ICS_IDE },
703 { MANU_ICS2, PROD_ICS2_IDE },
707 static struct ecard_driver icside_driver = {
708 .probe = icside_probe,
709 .remove = __devexit_p(icside_remove),
710 .shutdown = icside_shutdown,
711 .id_table = icside_ids,
717 static int __init icside_init(void)
719 return ecard_register_driver(&icside_driver);
722 MODULE_AUTHOR("Russell King <rmk@arm.linux.org.uk>");
723 MODULE_LICENSE("GPL");
724 MODULE_DESCRIPTION("ICS IDE driver");
726 module_init(icside_init);