1 /* mac_esp.c: ESP front-end for Macintosh Quadra systems.
3 * Adapted from jazz_esp.c and the old mac_esp.c.
5 * The pseudo DMA algorithm is based on the one used in NetBSD.
6 * See sys/arch/mac68k/obio/esp.c for some background information.
8 * Copyright (C) 2007-2008 Finn Thain
11 #include <linux/kernel.h>
12 #include <linux/types.h>
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/interrupt.h>
16 #include <linux/platform_device.h>
17 #include <linux/dma-mapping.h>
18 #include <linux/scatterlist.h>
19 #include <linux/delay.h>
21 #include <linux/nubus.h>
26 #include <asm/macints.h>
27 #include <asm/macintosh.h>
29 #include <scsi/scsi_host.h>
33 #define DRV_MODULE_NAME "mac_esp"
34 #define PFX DRV_MODULE_NAME ": "
35 #define DRV_VERSION "1.000"
36 #define DRV_MODULE_RELDATE "Sept 15, 2007"
38 #define MAC_ESP_IO_BASE 0x50F00000
39 #define MAC_ESP_REGS_QUADRA (MAC_ESP_IO_BASE + 0x10000)
40 #define MAC_ESP_REGS_QUADRA2 (MAC_ESP_IO_BASE + 0xF000)
41 #define MAC_ESP_REGS_QUADRA3 (MAC_ESP_IO_BASE + 0x18000)
42 #define MAC_ESP_REGS_SPACING 0x402
43 #define MAC_ESP_PDMA_REG 0xF9800024
44 #define MAC_ESP_PDMA_REG_SPACING 0x4
45 #define MAC_ESP_PDMA_IO_OFFSET 0x100
47 #define esp_read8(REG) mac_esp_read8(esp, REG)
48 #define esp_write8(VAL, REG) mac_esp_write8(esp, VAL, REG)
52 void __iomem
*pdma_regs
;
53 void __iomem
*pdma_io
;
56 static struct platform_device
*internal_pdev
, *external_pdev
;
57 static struct esp
*esp_chips
[2];
59 #define MAC_ESP_GET_PRIV(esp) ((struct mac_esp_priv *) \
60 platform_get_drvdata((struct platform_device *) \
63 static inline void mac_esp_write8(struct esp
*esp
, u8 val
, unsigned long reg
)
65 nubus_writeb(val
, esp
->regs
+ reg
* 16);
68 static inline u8
mac_esp_read8(struct esp
*esp
, unsigned long reg
)
70 return nubus_readb(esp
->regs
+ reg
* 16);
73 /* For pseudo DMA and PIO we need the virtual address
74 * so this address mapping is the identity mapping.
77 static dma_addr_t
mac_esp_map_single(struct esp
*esp
, void *buf
,
80 return (dma_addr_t
)buf
;
83 static int mac_esp_map_sg(struct esp
*esp
, struct scatterlist
*sg
,
88 for (i
= 0; i
< num_sg
; i
++)
89 sg
[i
].dma_address
= (u32
)sg_virt(&sg
[i
]);
93 static void mac_esp_unmap_single(struct esp
*esp
, dma_addr_t addr
,
99 static void mac_esp_unmap_sg(struct esp
*esp
, struct scatterlist
*sg
,
105 static void mac_esp_reset_dma(struct esp
*esp
)
110 static void mac_esp_dma_drain(struct esp
*esp
)
115 static void mac_esp_dma_invalidate(struct esp
*esp
)
120 static int mac_esp_dma_error(struct esp
*esp
)
122 return MAC_ESP_GET_PRIV(esp
)->error
;
125 static inline int mac_esp_wait_for_empty_fifo(struct esp
*esp
)
127 struct mac_esp_priv
*mep
= MAC_ESP_GET_PRIV(esp
);
131 if (!(esp_read8(ESP_FFLAGS
) & ESP_FF_FBYTES
))
134 if (esp_read8(ESP_STATUS
) & ESP_STAT_INTR
)
140 printk(KERN_ERR PFX
"FIFO is not empty (sreg %02x)\n",
141 esp_read8(ESP_STATUS
));
146 static inline int mac_esp_wait_for_dreq(struct esp
*esp
)
148 struct mac_esp_priv
*mep
= MAC_ESP_GET_PRIV(esp
);
152 if (mep
->pdma_regs
== NULL
) {
153 if (mac_irq_pending(IRQ_MAC_SCSIDRQ
))
156 if (nubus_readl(mep
->pdma_regs
) & 0x200)
160 if (esp_read8(ESP_STATUS
) & ESP_STAT_INTR
)
166 printk(KERN_ERR PFX
"PDMA timeout (sreg %02x)\n",
167 esp_read8(ESP_STATUS
));
172 #define MAC_ESP_PDMA_LOOP(operands) \
176 "1: movew " operands " \n" \
177 "2: movew " operands " \n" \
178 "3: movew " operands " \n" \
179 "4: movew " operands " \n" \
180 "5: movew " operands " \n" \
181 "6: movew " operands " \n" \
182 "7: movew " operands " \n" \
183 "8: movew " operands " \n" \
184 "9: movew " operands " \n" \
185 "10: movew " operands " \n" \
186 "11: movew " operands " \n" \
187 "12: movew " operands " \n" \
188 "13: movew " operands " \n" \
189 "14: movew " operands " \n" \
190 "15: movew " operands " \n" \
191 "16: movew " operands " \n" \
196 "21: movew " operands " \n" \
201 "31: moveb " operands " \n" \
205 " .section __ex_table,\"a\" \n" \
216 " .long 10b,40b \n" \
217 " .long 11b,40b \n" \
218 " .long 12b,40b \n" \
219 " .long 13b,40b \n" \
220 " .long 14b,40b \n" \
221 " .long 15b,40b \n" \
222 " .long 16b,40b \n" \
223 " .long 21b,40b \n" \
224 " .long 31b,40b \n" \
225 " .long 32b,40b \n" \
227 : "+a" (addr), "+r" (count32), "+r" (count2) \
228 : "g" (count1), "a" (mep->pdma_io))
230 static void mac_esp_send_pdma_cmd(struct esp
*esp
, u32 addr
, u32 esp_count
,
231 u32 dma_count
, int write
, u8 cmd
)
233 struct mac_esp_priv
*mep
= MAC_ESP_GET_PRIV(esp
);
236 local_irq_save(flags
);
241 scsi_esp_cmd(esp
, ESP_CMD_FLUSH
);
243 esp_write8((esp_count
>> 0) & 0xFF, ESP_TCLOW
);
244 esp_write8((esp_count
>> 8) & 0xFF, ESP_TCMED
);
246 scsi_esp_cmd(esp
, cmd
);
249 unsigned int count32
= esp_count
>> 5;
250 unsigned int count2
= (esp_count
& 0x1F) >> 1;
251 unsigned int count1
= esp_count
& 1;
252 unsigned int start_addr
= addr
;
254 if (mac_esp_wait_for_dreq(esp
))
258 MAC_ESP_PDMA_LOOP("%4@,%0@+");
260 esp_count
-= addr
- start_addr
;
264 MAC_ESP_PDMA_LOOP("%0@+,%4@");
266 if (mac_esp_wait_for_empty_fifo(esp
))
269 n
= (esp_read8(ESP_TCMED
) << 8) + esp_read8(ESP_TCLOW
);
270 addr
= start_addr
+ esp_count
- n
;
275 local_irq_restore(flags
);
279 * Programmed IO routines follow.
282 static inline int mac_esp_wait_for_fifo(struct esp
*esp
)
287 if (esp_read8(ESP_FFLAGS
) & ESP_FF_FBYTES
)
293 printk(KERN_ERR PFX
"FIFO is empty (sreg %02x)\n",
294 esp_read8(ESP_STATUS
));
298 static inline int mac_esp_wait_for_intr(struct esp
*esp
)
303 esp
->sreg
= esp_read8(ESP_STATUS
);
304 if (esp
->sreg
& ESP_STAT_INTR
)
310 printk(KERN_ERR PFX
"IRQ timeout (sreg %02x)\n", esp
->sreg
);
314 #define MAC_ESP_PIO_LOOP(operands, reg1) \
316 "1: moveb " operands " \n" \
319 : "+a" (addr), "+r" (reg1) \
322 #define MAC_ESP_PIO_FILL(operands, reg1) \
324 " moveb " operands " \n" \
325 " moveb " operands " \n" \
326 " moveb " operands " \n" \
327 " moveb " operands " \n" \
328 " moveb " operands " \n" \
329 " moveb " operands " \n" \
330 " moveb " operands " \n" \
331 " moveb " operands " \n" \
332 " moveb " operands " \n" \
333 " moveb " operands " \n" \
334 " moveb " operands " \n" \
335 " moveb " operands " \n" \
336 " moveb " operands " \n" \
337 " moveb " operands " \n" \
338 " moveb " operands " \n" \
339 " moveb " operands " \n" \
342 : "+a" (addr), "+r" (reg1) \
345 #define MAC_ESP_FIFO_SIZE 16
347 static void mac_esp_send_pio_cmd(struct esp
*esp
, u32 addr
, u32 esp_count
,
348 u32 dma_count
, int write
, u8 cmd
)
351 struct mac_esp_priv
*mep
= MAC_ESP_GET_PRIV(esp
);
352 u8
*fifo
= esp
->regs
+ ESP_FDATA
* 16;
354 local_irq_save(flags
);
360 scsi_esp_cmd(esp
, cmd
);
362 if (!mac_esp_wait_for_intr(esp
)) {
363 if (mac_esp_wait_for_fifo(esp
))
369 scsi_esp_cmd(esp
, ESP_CMD_FLUSH
);
371 if (esp_count
>= MAC_ESP_FIFO_SIZE
)
372 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count
);
374 MAC_ESP_PIO_LOOP("%0@+,%2@", esp_count
);
376 scsi_esp_cmd(esp
, cmd
);
382 if (mac_esp_wait_for_intr(esp
)) {
387 if (esp
->sreg
& ESP_STAT_SPAM
) {
388 printk(KERN_ERR PFX
"gross error\n");
393 n
= esp_read8(ESP_FFLAGS
) & ESP_FF_FBYTES
;
400 MAC_ESP_PIO_LOOP("%2@,%0@+", n
);
402 if ((esp
->sreg
& ESP_STAT_PMASK
) == ESP_STATP
)
406 esp
->ireg
= esp_read8(ESP_INTRPT
);
407 if (esp
->ireg
& ESP_INTR_DC
)
410 scsi_esp_cmd(esp
, ESP_CMD_TI
);
413 esp
->ireg
= esp_read8(ESP_INTRPT
);
414 if (esp
->ireg
& ESP_INTR_DC
)
417 n
= MAC_ESP_FIFO_SIZE
- n
;
421 if (n
== MAC_ESP_FIFO_SIZE
) {
422 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count
);
425 MAC_ESP_PIO_LOOP("%0@+,%2@", n
);
428 scsi_esp_cmd(esp
, ESP_CMD_TI
);
432 local_irq_restore(flags
);
435 static int mac_esp_irq_pending(struct esp
*esp
)
437 if (esp_read8(ESP_STATUS
) & ESP_STAT_INTR
)
442 static u32
mac_esp_dma_length_limit(struct esp
*esp
, u32 dma_addr
, u32 dma_len
)
444 return dma_len
> 0xFFFF ? 0xFFFF : dma_len
;
447 static irqreturn_t
mac_scsi_esp_intr(int irq
, void *dev_id
)
452 * This is an edge triggered IRQ, so we have to be careful to
453 * avoid missing a transition when it is shared by two ESP devices.
459 (mac_esp_read8(esp_chips
[0], ESP_STATUS
) & ESP_STAT_INTR
)) {
460 (void)scsi_esp_intr(irq
, esp_chips
[0]);
464 (mac_esp_read8(esp_chips
[1], ESP_STATUS
) & ESP_STAT_INTR
)) {
465 (void)scsi_esp_intr(irq
, esp_chips
[1]);
473 static struct esp_driver_ops mac_esp_ops
= {
474 .esp_write8
= mac_esp_write8
,
475 .esp_read8
= mac_esp_read8
,
476 .map_single
= mac_esp_map_single
,
477 .map_sg
= mac_esp_map_sg
,
478 .unmap_single
= mac_esp_unmap_single
,
479 .unmap_sg
= mac_esp_unmap_sg
,
480 .irq_pending
= mac_esp_irq_pending
,
481 .dma_length_limit
= mac_esp_dma_length_limit
,
482 .reset_dma
= mac_esp_reset_dma
,
483 .dma_drain
= mac_esp_dma_drain
,
484 .dma_invalidate
= mac_esp_dma_invalidate
,
485 .send_dma_cmd
= mac_esp_send_pdma_cmd
,
486 .dma_error
= mac_esp_dma_error
,
489 static int __devinit
esp_mac_probe(struct platform_device
*dev
)
491 struct scsi_host_template
*tpnt
= &scsi_esp_template
;
492 struct Scsi_Host
*host
;
496 struct mac_esp_priv
*mep
;
501 switch (macintosh_config
->scsi_type
) {
502 case MAC_SCSI_QUADRA
:
503 case MAC_SCSI_QUADRA3
:
506 case MAC_SCSI_QUADRA2
:
507 if ((macintosh_config
->ident
== MAC_MODEL_Q900
) ||
508 (macintosh_config
->ident
== MAC_MODEL_Q950
))
517 if (dev
->id
+ 1 > chips_present
)
520 host
= scsi_host_alloc(tpnt
, sizeof(struct esp
));
527 host
->use_clustering
= DISABLE_CLUSTERING
;
528 esp
= shost_priv(host
);
533 esp
->command_block
= kzalloc(16, GFP_KERNEL
);
534 if (!esp
->command_block
)
536 esp
->command_block_dma
= (dma_addr_t
)esp
->command_block
;
539 host
->this_id
= esp
->scsi_id
;
540 esp
->scsi_id_mask
= 1 << esp
->scsi_id
;
542 mep
= kzalloc(sizeof(struct mac_esp_priv
), GFP_KERNEL
);
544 goto fail_free_command_block
;
546 platform_set_drvdata(dev
, mep
);
548 switch (macintosh_config
->scsi_type
) {
549 case MAC_SCSI_QUADRA
:
550 esp
->cfreq
= 16500000;
551 esp
->regs
= (void __iomem
*)MAC_ESP_REGS_QUADRA
;
552 mep
->pdma_io
= esp
->regs
+ MAC_ESP_PDMA_IO_OFFSET
;
553 mep
->pdma_regs
= NULL
;
555 case MAC_SCSI_QUADRA2
:
556 esp
->cfreq
= 25000000;
557 esp
->regs
= (void __iomem
*)(MAC_ESP_REGS_QUADRA2
+
558 dev
->id
* MAC_ESP_REGS_SPACING
);
559 mep
->pdma_io
= esp
->regs
+ MAC_ESP_PDMA_IO_OFFSET
;
560 mep
->pdma_regs
= (void __iomem
*)(MAC_ESP_PDMA_REG
+
561 dev
->id
* MAC_ESP_PDMA_REG_SPACING
);
562 nubus_writel(0x1d1, mep
->pdma_regs
);
564 case MAC_SCSI_QUADRA3
:
565 /* These quadras have a real DMA controller (the PSC) but we
566 * don't know how to drive it so we must use PIO instead.
568 esp
->cfreq
= 25000000;
569 esp
->regs
= (void __iomem
*)MAC_ESP_REGS_QUADRA3
;
571 mep
->pdma_regs
= NULL
;
575 esp
->ops
= &mac_esp_ops
;
576 if (mep
->pdma_io
== NULL
) {
577 printk(KERN_INFO PFX
"using PIO for controller %d\n", dev
->id
);
578 esp_write8(0, ESP_TCLOW
);
579 esp_write8(0, ESP_TCMED
);
580 esp
->flags
= ESP_FLAG_DISABLE_SYNC
;
581 mac_esp_ops
.send_dma_cmd
= mac_esp_send_pio_cmd
;
583 printk(KERN_INFO PFX
"using PDMA for controller %d\n", dev
->id
);
586 host
->irq
= IRQ_MAC_SCSI
;
587 esp_chips
[dev
->id
] = esp
;
589 if (esp_chips
[!dev
->id
] == NULL
) {
590 err
= request_irq(host
->irq
, mac_scsi_esp_intr
, 0,
593 esp_chips
[dev
->id
] = NULL
;
598 err
= scsi_esp_register(esp
, &dev
->dev
);
605 if (esp_chips
[!dev
->id
] == NULL
)
606 free_irq(host
->irq
, esp
);
609 fail_free_command_block
:
610 kfree(esp
->command_block
);
617 static int __devexit
esp_mac_remove(struct platform_device
*dev
)
619 struct mac_esp_priv
*mep
= platform_get_drvdata(dev
);
620 struct esp
*esp
= mep
->esp
;
621 unsigned int irq
= esp
->host
->irq
;
623 scsi_esp_unregister(esp
);
625 esp_chips
[dev
->id
] = NULL
;
626 if (!(esp_chips
[0] || esp_chips
[1]))
631 kfree(esp
->command_block
);
633 scsi_host_put(esp
->host
);
638 static struct platform_driver esp_mac_driver
= {
639 .probe
= esp_mac_probe
,
640 .remove
= __devexit_p(esp_mac_remove
),
642 .name
= DRV_MODULE_NAME
,
646 static int __init
mac_esp_init(void)
650 err
= platform_driver_register(&esp_mac_driver
);
654 internal_pdev
= platform_device_alloc(DRV_MODULE_NAME
, 0);
655 if (internal_pdev
&& platform_device_add(internal_pdev
)) {
656 platform_device_put(internal_pdev
);
657 internal_pdev
= NULL
;
659 external_pdev
= platform_device_alloc(DRV_MODULE_NAME
, 1);
660 if (external_pdev
&& platform_device_add(external_pdev
)) {
661 platform_device_put(external_pdev
);
662 external_pdev
= NULL
;
665 if (internal_pdev
|| external_pdev
) {
668 platform_driver_unregister(&esp_mac_driver
);
673 static void __exit
mac_esp_exit(void)
675 platform_driver_unregister(&esp_mac_driver
);
678 platform_device_unregister(internal_pdev
);
679 internal_pdev
= NULL
;
682 platform_device_unregister(external_pdev
);
683 external_pdev
= NULL
;
687 MODULE_DESCRIPTION("Mac ESP SCSI driver");
688 MODULE_AUTHOR("Finn Thain <fthain@telegraphics.com.au>");
689 MODULE_LICENSE("GPL v2");
690 MODULE_VERSION(DRV_VERSION
);
692 module_init(mac_esp_init
);
693 module_exit(mac_esp_exit
);