1 // SPDX-License-Identifier: GPL-2.0-only
2 #include <linux/kernel.h>
3 #include <linux/module.h>
4 #include <linux/init.h>
5 #include <linux/blkdev.h>
7 #include <scsi/scsi_host.h>
9 #include <linux/libata.h>
12 #include <asm/ecard.h>
14 #define DRV_NAME "pata_icside"
16 #define ICS_IDENT_OFFSET 0x2280
18 #define ICS_ARCIN_V5_INTRSTAT 0x0000
19 #define ICS_ARCIN_V5_INTROFFSET 0x0004
21 #define ICS_ARCIN_V6_INTROFFSET_1 0x2200
22 #define ICS_ARCIN_V6_INTRSTAT_1 0x2290
23 #define ICS_ARCIN_V6_INTROFFSET_2 0x3200
24 #define ICS_ARCIN_V6_INTRSTAT_2 0x3290
27 unsigned int dataoffset
;
28 unsigned int ctrloffset
;
29 unsigned int stepping
;
32 static const struct portinfo pata_icside_portinfo_v5
= {
38 static const struct portinfo pata_icside_portinfo_v6_1
= {
44 static const struct portinfo pata_icside_portinfo_v6_2
= {
50 struct pata_icside_state
{
51 void __iomem
*irq_port
;
52 void __iomem
*ioc_base
;
58 unsigned int speed
[ATA_MAX_DEVICES
];
62 struct pata_icside_info
{
63 struct pata_icside_state
*state
;
64 struct expansion_card
*ec
;
66 void __iomem
*irqaddr
;
68 const expansioncard_ops_t
*irqops
;
69 unsigned int mwdma_mask
;
70 unsigned int nr_ports
;
71 const struct portinfo
*port
[2];
72 unsigned long raw_base
;
73 unsigned long raw_ioc_base
;
76 #define ICS_TYPE_A3IN 0
77 #define ICS_TYPE_A3USER 1
79 #define ICS_TYPE_V5 15
80 #define ICS_TYPE_NOTYPE ((unsigned int)-1)
82 /* ---------------- Version 5 PCB Support Functions --------------------- */
83 /* Prototype: pata_icside_irqenable_arcin_v5 (struct expansion_card *ec, int irqnr)
84 * Purpose : enable interrupts from card
86 static void pata_icside_irqenable_arcin_v5 (struct expansion_card
*ec
, int irqnr
)
88 struct pata_icside_state
*state
= ec
->irq_data
;
90 writeb(0, state
->irq_port
+ ICS_ARCIN_V5_INTROFFSET
);
93 /* Prototype: pata_icside_irqdisable_arcin_v5 (struct expansion_card *ec, int irqnr)
94 * Purpose : disable interrupts from card
96 static void pata_icside_irqdisable_arcin_v5 (struct expansion_card
*ec
, int irqnr
)
98 struct pata_icside_state
*state
= ec
->irq_data
;
100 readb(state
->irq_port
+ ICS_ARCIN_V5_INTROFFSET
);
103 static const expansioncard_ops_t pata_icside_ops_arcin_v5
= {
104 .irqenable
= pata_icside_irqenable_arcin_v5
,
105 .irqdisable
= pata_icside_irqdisable_arcin_v5
,
109 /* ---------------- Version 6 PCB Support Functions --------------------- */
110 /* Prototype: pata_icside_irqenable_arcin_v6 (struct expansion_card *ec, int irqnr)
111 * Purpose : enable interrupts from card
113 static void pata_icside_irqenable_arcin_v6 (struct expansion_card
*ec
, int irqnr
)
115 struct pata_icside_state
*state
= ec
->irq_data
;
116 void __iomem
*base
= state
->irq_port
;
118 if (!state
->port
[0].disabled
)
119 writeb(0, base
+ ICS_ARCIN_V6_INTROFFSET_1
);
120 if (!state
->port
[1].disabled
)
121 writeb(0, base
+ ICS_ARCIN_V6_INTROFFSET_2
);
124 /* Prototype: pata_icside_irqdisable_arcin_v6 (struct expansion_card *ec, int irqnr)
125 * Purpose : disable interrupts from card
127 static void pata_icside_irqdisable_arcin_v6 (struct expansion_card
*ec
, int irqnr
)
129 struct pata_icside_state
*state
= ec
->irq_data
;
131 readb(state
->irq_port
+ ICS_ARCIN_V6_INTROFFSET_1
);
132 readb(state
->irq_port
+ ICS_ARCIN_V6_INTROFFSET_2
);
135 /* Prototype: pata_icside_irqprobe(struct expansion_card *ec)
136 * Purpose : detect an active interrupt from card
138 static int pata_icside_irqpending_arcin_v6(struct expansion_card
*ec
)
140 struct pata_icside_state
*state
= ec
->irq_data
;
142 return readb(state
->irq_port
+ ICS_ARCIN_V6_INTRSTAT_1
) & 1 ||
143 readb(state
->irq_port
+ ICS_ARCIN_V6_INTRSTAT_2
) & 1;
146 static const expansioncard_ops_t pata_icside_ops_arcin_v6
= {
147 .irqenable
= pata_icside_irqenable_arcin_v6
,
148 .irqdisable
= pata_icside_irqdisable_arcin_v6
,
149 .irqpending
= pata_icside_irqpending_arcin_v6
,
156 * Similar to the BM-DMA, but we use the RiscPCs IOMD DMA controllers.
157 * There is only one DMA controller per card, which means that only
158 * one drive can be accessed at one time. NOTE! We do not enforce that
159 * here, but we rely on the main IDE driver spotting that both
160 * interfaces use the same IRQ, which should guarantee this.
164 * Configure the IOMD to give the appropriate timings for the transfer
165 * mode being requested. We take the advice of the ATA standards, and
166 * calculate the cycle time based on the transfer mode, and the EIDE
167 * MW DMA specs that the drive provides in the IDENTIFY command.
169 * We have the following IOMD DMA modes to choose from:
171 * Type Active Recovery Cycle
172 * A 250 (250) 312 (550) 562 (800)
173 * B 187 (200) 250 (550) 437 (750)
174 * C 125 (125) 125 (375) 250 (500)
175 * D 62 (50) 125 (375) 187 (425)
177 * (figures in brackets are actual measured timings on DIOR/DIOW)
179 * However, we also need to take care of the read/write active and
183 * Mode Active -- Recovery -- Cycle IOMD type
184 * MW0 215 50 215 480 A
188 static void pata_icside_set_dmamode(struct ata_port
*ap
, struct ata_device
*adev
)
190 struct pata_icside_state
*state
= ap
->host
->private_data
;
196 * DMA is based on a 16MHz clock
198 if (ata_timing_compute(adev
, adev
->dma_mode
, &t
, 1000, 1))
202 * Choose the IOMD cycle timing which ensure that the interface
203 * satisfies the measured active, recovery and cycle times.
205 if (t
.active
<= 50 && t
.recover
<= 375 && t
.cycle
<= 425)
206 iomd_type
= 'D', cycle
= 187;
207 else if (t
.active
<= 125 && t
.recover
<= 375 && t
.cycle
<= 500)
208 iomd_type
= 'C', cycle
= 250;
209 else if (t
.active
<= 200 && t
.recover
<= 550 && t
.cycle
<= 750)
210 iomd_type
= 'B', cycle
= 437;
212 iomd_type
= 'A', cycle
= 562;
214 ata_dev_info(adev
, "timings: act %dns rec %dns cyc %dns (%c)\n",
215 t
.active
, t
.recover
, t
.cycle
, iomd_type
);
217 state
->port
[ap
->port_no
].speed
[adev
->devno
] = cycle
;
220 static void pata_icside_bmdma_setup(struct ata_queued_cmd
*qc
)
222 struct ata_port
*ap
= qc
->ap
;
223 struct pata_icside_state
*state
= ap
->host
->private_data
;
224 unsigned int write
= qc
->tf
.flags
& ATA_TFLAG_WRITE
;
227 * We are simplex; BUG if we try to fiddle with DMA
230 BUG_ON(dma_channel_active(state
->dma
));
233 * Route the DMA signals to the correct interface
235 writeb(state
->port
[ap
->port_no
].port_sel
, state
->ioc_base
);
237 set_dma_speed(state
->dma
, state
->port
[ap
->port_no
].speed
[qc
->dev
->devno
]);
238 set_dma_sg(state
->dma
, qc
->sg
, qc
->n_elem
);
239 set_dma_mode(state
->dma
, write
? DMA_MODE_WRITE
: DMA_MODE_READ
);
241 /* issue r/w command */
242 ap
->ops
->sff_exec_command(ap
, &qc
->tf
);
245 static void pata_icside_bmdma_start(struct ata_queued_cmd
*qc
)
247 struct ata_port
*ap
= qc
->ap
;
248 struct pata_icside_state
*state
= ap
->host
->private_data
;
250 BUG_ON(dma_channel_active(state
->dma
));
251 enable_dma(state
->dma
);
254 static void pata_icside_bmdma_stop(struct ata_queued_cmd
*qc
)
256 struct ata_port
*ap
= qc
->ap
;
257 struct pata_icside_state
*state
= ap
->host
->private_data
;
259 disable_dma(state
->dma
);
261 /* see ata_bmdma_stop */
262 ata_sff_dma_pause(ap
);
265 static u8
pata_icside_bmdma_status(struct ata_port
*ap
)
267 struct pata_icside_state
*state
= ap
->host
->private_data
;
268 void __iomem
*irq_port
;
270 irq_port
= state
->irq_port
+ (ap
->port_no
? ICS_ARCIN_V6_INTRSTAT_2
:
271 ICS_ARCIN_V6_INTRSTAT_1
);
273 return readb(irq_port
) & 1 ? ATA_DMA_INTR
: 0;
276 static int icside_dma_init(struct pata_icside_info
*info
)
278 struct pata_icside_state
*state
= info
->state
;
279 struct expansion_card
*ec
= info
->ec
;
282 for (i
= 0; i
< ATA_MAX_DEVICES
; i
++) {
283 state
->port
[0].speed
[i
] = 480;
284 state
->port
[1].speed
[i
] = 480;
287 if (ec
->dma
!= NO_DMA
&& !request_dma(ec
->dma
, DRV_NAME
)) {
288 state
->dma
= ec
->dma
;
289 info
->mwdma_mask
= ATA_MWDMA2
;
296 static struct scsi_host_template pata_icside_sht
= {
297 ATA_BASE_SHT(DRV_NAME
),
298 .sg_tablesize
= SG_MAX_SEGMENTS
,
299 .dma_boundary
= IOMD_DMA_BOUNDARY
,
302 static void pata_icside_postreset(struct ata_link
*link
, unsigned int *classes
)
304 struct ata_port
*ap
= link
->ap
;
305 struct pata_icside_state
*state
= ap
->host
->private_data
;
307 if (classes
[0] != ATA_DEV_NONE
|| classes
[1] != ATA_DEV_NONE
)
308 return ata_sff_postreset(link
, classes
);
310 state
->port
[ap
->port_no
].disabled
= 1;
312 if (state
->type
== ICS_TYPE_V6
) {
314 * Disable interrupts from this port, otherwise we
315 * receive spurious interrupts from the floating
318 void __iomem
*irq_port
= state
->irq_port
+
319 (ap
->port_no
? ICS_ARCIN_V6_INTROFFSET_2
: ICS_ARCIN_V6_INTROFFSET_1
);
324 static struct ata_port_operations pata_icside_port_ops
= {
325 .inherits
= &ata_bmdma_port_ops
,
326 /* no need to build any PRD tables for DMA */
327 .qc_prep
= ata_noop_qc_prep
,
328 .sff_data_xfer
= ata_sff_data_xfer32
,
329 .bmdma_setup
= pata_icside_bmdma_setup
,
330 .bmdma_start
= pata_icside_bmdma_start
,
331 .bmdma_stop
= pata_icside_bmdma_stop
,
332 .bmdma_status
= pata_icside_bmdma_status
,
334 .cable_detect
= ata_cable_40wire
,
335 .set_dmamode
= pata_icside_set_dmamode
,
336 .postreset
= pata_icside_postreset
,
338 .port_start
= ATA_OP_NULL
, /* don't need PRD table */
341 static void pata_icside_setup_ioaddr(struct ata_port
*ap
, void __iomem
*base
,
342 struct pata_icside_info
*info
,
343 const struct portinfo
*port
)
345 struct ata_ioports
*ioaddr
= &ap
->ioaddr
;
346 void __iomem
*cmd
= base
+ port
->dataoffset
;
348 ioaddr
->cmd_addr
= cmd
;
349 ioaddr
->data_addr
= cmd
+ (ATA_REG_DATA
<< port
->stepping
);
350 ioaddr
->error_addr
= cmd
+ (ATA_REG_ERR
<< port
->stepping
);
351 ioaddr
->feature_addr
= cmd
+ (ATA_REG_FEATURE
<< port
->stepping
);
352 ioaddr
->nsect_addr
= cmd
+ (ATA_REG_NSECT
<< port
->stepping
);
353 ioaddr
->lbal_addr
= cmd
+ (ATA_REG_LBAL
<< port
->stepping
);
354 ioaddr
->lbam_addr
= cmd
+ (ATA_REG_LBAM
<< port
->stepping
);
355 ioaddr
->lbah_addr
= cmd
+ (ATA_REG_LBAH
<< port
->stepping
);
356 ioaddr
->device_addr
= cmd
+ (ATA_REG_DEVICE
<< port
->stepping
);
357 ioaddr
->status_addr
= cmd
+ (ATA_REG_STATUS
<< port
->stepping
);
358 ioaddr
->command_addr
= cmd
+ (ATA_REG_CMD
<< port
->stepping
);
360 ioaddr
->ctl_addr
= base
+ port
->ctrloffset
;
361 ioaddr
->altstatus_addr
= ioaddr
->ctl_addr
;
363 ata_port_desc(ap
, "cmd 0x%lx ctl 0x%lx",
364 info
->raw_base
+ port
->dataoffset
,
365 info
->raw_base
+ port
->ctrloffset
);
367 if (info
->raw_ioc_base
)
368 ata_port_desc(ap
, "iocbase 0x%lx", info
->raw_ioc_base
);
371 static int pata_icside_register_v5(struct pata_icside_info
*info
)
373 struct pata_icside_state
*state
= info
->state
;
376 base
= ecardm_iomap(info
->ec
, ECARD_RES_MEMC
, 0, 0);
380 state
->irq_port
= base
;
383 info
->irqaddr
= base
+ ICS_ARCIN_V5_INTRSTAT
;
385 info
->irqops
= &pata_icside_ops_arcin_v5
;
387 info
->port
[0] = &pata_icside_portinfo_v5
;
389 info
->raw_base
= ecard_resource_start(info
->ec
, ECARD_RES_MEMC
);
394 static int pata_icside_register_v6(struct pata_icside_info
*info
)
396 struct pata_icside_state
*state
= info
->state
;
397 struct expansion_card
*ec
= info
->ec
;
398 void __iomem
*ioc_base
, *easi_base
;
399 unsigned int sel
= 0;
401 ioc_base
= ecardm_iomap(ec
, ECARD_RES_IOCFAST
, 0, 0);
405 easi_base
= ioc_base
;
407 if (ecard_resource_flags(ec
, ECARD_RES_EASI
)) {
408 easi_base
= ecardm_iomap(ec
, ECARD_RES_EASI
, 0, 0);
413 * Enable access to the EASI region.
418 writeb(sel
, ioc_base
);
420 state
->irq_port
= easi_base
;
421 state
->ioc_base
= ioc_base
;
422 state
->port
[0].port_sel
= sel
;
423 state
->port
[1].port_sel
= sel
| 1;
425 info
->base
= easi_base
;
426 info
->irqops
= &pata_icside_ops_arcin_v6
;
428 info
->port
[0] = &pata_icside_portinfo_v6_1
;
429 info
->port
[1] = &pata_icside_portinfo_v6_2
;
431 info
->raw_base
= ecard_resource_start(ec
, ECARD_RES_EASI
);
432 info
->raw_ioc_base
= ecard_resource_start(ec
, ECARD_RES_IOCFAST
);
434 return icside_dma_init(info
);
437 static int pata_icside_add_ports(struct pata_icside_info
*info
)
439 struct expansion_card
*ec
= info
->ec
;
440 struct ata_host
*host
;
444 ec
->irqaddr
= info
->irqaddr
;
445 ec
->irqmask
= info
->irqmask
;
448 ecard_setirq(ec
, info
->irqops
, info
->state
);
451 * Be on the safe side - disable interrupts
453 ec
->ops
->irqdisable(ec
, ec
->irq
);
455 host
= ata_host_alloc(&ec
->dev
, info
->nr_ports
);
459 host
->private_data
= info
->state
;
460 host
->flags
= ATA_HOST_SIMPLEX
;
462 for (i
= 0; i
< info
->nr_ports
; i
++) {
463 struct ata_port
*ap
= host
->ports
[i
];
465 ap
->pio_mask
= ATA_PIO4
;
466 ap
->mwdma_mask
= info
->mwdma_mask
;
467 ap
->flags
|= ATA_FLAG_SLAVE_POSS
;
468 ap
->ops
= &pata_icside_port_ops
;
470 pata_icside_setup_ioaddr(ap
, info
->base
, info
, info
->port
[i
]);
473 return ata_host_activate(host
, ec
->irq
, ata_bmdma_interrupt
, 0,
477 static int pata_icside_probe(struct expansion_card
*ec
,
478 const struct ecard_id
*id
)
480 struct pata_icside_state
*state
;
481 struct pata_icside_info info
;
485 ret
= ecard_request_resources(ec
);
489 state
= devm_kzalloc(&ec
->dev
, sizeof(*state
), GFP_KERNEL
);
495 state
->type
= ICS_TYPE_NOTYPE
;
498 idmem
= ecardm_iomap(ec
, ECARD_RES_IOCFAST
, 0, 0);
502 type
= readb(idmem
+ ICS_IDENT_OFFSET
) & 1;
503 type
|= (readb(idmem
+ ICS_IDENT_OFFSET
+ 4) & 1) << 1;
504 type
|= (readb(idmem
+ ICS_IDENT_OFFSET
+ 8) & 1) << 2;
505 type
|= (readb(idmem
+ ICS_IDENT_OFFSET
+ 12) & 1) << 3;
506 ecardm_iounmap(ec
, idmem
);
511 memset(&info
, 0, sizeof(info
));
515 switch (state
->type
) {
517 dev_warn(&ec
->dev
, "A3IN unsupported\n");
521 case ICS_TYPE_A3USER
:
522 dev_warn(&ec
->dev
, "A3USER unsupported\n");
527 ret
= pata_icside_register_v5(&info
);
531 ret
= pata_icside_register_v6(&info
);
535 dev_warn(&ec
->dev
, "unknown interface type\n");
541 ret
= pata_icside_add_ports(&info
);
547 ecard_release_resources(ec
);
552 static void pata_icside_shutdown(struct expansion_card
*ec
)
554 struct ata_host
*host
= ecard_get_drvdata(ec
);
558 * Disable interrupts from this card. We need to do
559 * this before disabling EASI since we may be accessing
560 * this register via that region.
562 local_irq_save(flags
);
563 ec
->ops
->irqdisable(ec
, ec
->irq
);
564 local_irq_restore(flags
);
567 * Reset the ROM pointer so that we can read the ROM
568 * after a soft reboot. This also disables access to
569 * the IDE taskfile via the EASI region.
572 struct pata_icside_state
*state
= host
->private_data
;
574 writeb(0, state
->ioc_base
);
578 static void pata_icside_remove(struct expansion_card
*ec
)
580 struct ata_host
*host
= ecard_get_drvdata(ec
);
581 struct pata_icside_state
*state
= host
->private_data
;
583 ata_host_detach(host
);
585 pata_icside_shutdown(ec
);
588 * don't NULL out the drvdata - devres/libata wants it
589 * to free the ata_host structure.
591 if (state
->dma
!= NO_DMA
)
592 free_dma(state
->dma
);
594 ecard_release_resources(ec
);
597 static const struct ecard_id pata_icside_ids
[] = {
598 { MANU_ICS
, PROD_ICS_IDE
},
599 { MANU_ICS2
, PROD_ICS2_IDE
},
603 static struct ecard_driver pata_icside_driver
= {
604 .probe
= pata_icside_probe
,
605 .remove
= pata_icside_remove
,
606 .shutdown
= pata_icside_shutdown
,
607 .id_table
= pata_icside_ids
,
613 static int __init
pata_icside_init(void)
615 return ecard_register_driver(&pata_icside_driver
);
618 static void __exit
pata_icside_exit(void)
620 ecard_remove_driver(&pata_icside_driver
);
623 MODULE_AUTHOR("Russell King <rmk@arm.linux.org.uk>");
624 MODULE_LICENSE("GPL");
625 MODULE_DESCRIPTION("ICS PATA driver");
627 module_init(pata_icside_init
);
628 module_exit(pata_icside_exit
);