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_esp, *external_esp;
58 #define MAC_ESP_GET_PRIV(esp) ((struct mac_esp_priv *) \
59 platform_get_drvdata((struct platform_device *) \
62 static inline void mac_esp_write8(struct esp *esp, u8 val, unsigned long reg)
64 nubus_writeb(val, esp->regs + reg * 16);
67 static inline u8 mac_esp_read8(struct esp *esp, unsigned long reg)
69 return nubus_readb(esp->regs + reg * 16);
72 /* For pseudo DMA and PIO we need the virtual address
73 * so this address mapping is the identity mapping.
76 static dma_addr_t mac_esp_map_single(struct esp *esp, void *buf,
79 return (dma_addr_t)buf;
82 static int mac_esp_map_sg(struct esp *esp, struct scatterlist *sg,
87 for (i = 0; i < num_sg; i++)
88 sg[i].dma_address = (u32)sg_virt(&sg[i]);
92 static void mac_esp_unmap_single(struct esp *esp, dma_addr_t addr,
98 static void mac_esp_unmap_sg(struct esp *esp, struct scatterlist *sg,
104 static void mac_esp_reset_dma(struct esp *esp)
109 static void mac_esp_dma_drain(struct esp *esp)
114 static void mac_esp_dma_invalidate(struct esp *esp)
119 static int mac_esp_dma_error(struct esp *esp)
121 return MAC_ESP_GET_PRIV(esp)->error;
124 static inline int mac_esp_wait_for_empty_fifo(struct esp *esp)
126 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
130 if (!(esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES))
133 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
139 printk(KERN_ERR PFX "FIFO is not empty (sreg %02x)\n",
140 esp_read8(ESP_STATUS));
145 static inline int mac_esp_wait_for_dreq(struct esp *esp)
147 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
151 if (mep->pdma_regs == NULL) {
152 if (mac_irq_pending(IRQ_MAC_SCSIDRQ))
155 if (nubus_readl(mep->pdma_regs) & 0x200)
159 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
165 printk(KERN_ERR PFX "PDMA timeout (sreg %02x)\n",
166 esp_read8(ESP_STATUS));
171 #define MAC_ESP_PDMA_LOOP(operands) \
175 "1: movew " operands " \n" \
176 "2: movew " operands " \n" \
177 "3: movew " operands " \n" \
178 "4: movew " operands " \n" \
179 "5: movew " operands " \n" \
180 "6: movew " operands " \n" \
181 "7: movew " operands " \n" \
182 "8: movew " operands " \n" \
183 "9: movew " operands " \n" \
184 "10: movew " operands " \n" \
185 "11: movew " operands " \n" \
186 "12: movew " operands " \n" \
187 "13: movew " operands " \n" \
188 "14: movew " operands " \n" \
189 "15: movew " operands " \n" \
190 "16: movew " operands " \n" \
195 "21: movew " operands " \n" \
200 "31: moveb " operands " \n" \
204 " .section __ex_table,\"a\" \n" \
215 " .long 10b,40b \n" \
216 " .long 11b,40b \n" \
217 " .long 12b,40b \n" \
218 " .long 13b,40b \n" \
219 " .long 14b,40b \n" \
220 " .long 15b,40b \n" \
221 " .long 16b,40b \n" \
222 " .long 21b,40b \n" \
223 " .long 31b,40b \n" \
224 " .long 32b,40b \n" \
227 : "a" (mep->pdma_io), "r" (count32), "r" (count2), "g" (esp_count))
229 static void mac_esp_send_pdma_cmd(struct esp *esp, u32 addr, u32 esp_count,
230 u32 dma_count, int write, u8 cmd)
232 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
235 local_irq_save(flags);
240 scsi_esp_cmd(esp, ESP_CMD_FLUSH);
242 esp_write8((esp_count >> 0) & 0xFF, ESP_TCLOW);
243 esp_write8((esp_count >> 8) & 0xFF, ESP_TCMED);
245 scsi_esp_cmd(esp, cmd);
248 unsigned int count32 = esp_count >> 5;
249 unsigned int count2 = (esp_count & 0x1F) >> 1;
250 unsigned int start_addr = addr;
252 if (mac_esp_wait_for_dreq(esp))
256 MAC_ESP_PDMA_LOOP("%1@,%0@+");
258 esp_count -= addr - start_addr;
262 MAC_ESP_PDMA_LOOP("%0@+,%1@");
264 if (mac_esp_wait_for_empty_fifo(esp))
267 n = (esp_read8(ESP_TCMED) << 8) + esp_read8(ESP_TCLOW);
268 addr = start_addr + esp_count - n;
273 local_irq_restore(flags);
277 * Programmed IO routines follow.
280 static inline int mac_esp_wait_for_fifo(struct esp *esp)
285 if (esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES)
291 printk(KERN_ERR PFX "FIFO is empty (sreg %02x)\n",
292 esp_read8(ESP_STATUS));
296 static inline int mac_esp_wait_for_intr(struct esp *esp)
301 esp->sreg = esp_read8(ESP_STATUS);
302 if (esp->sreg & ESP_STAT_INTR)
308 printk(KERN_ERR PFX "IRQ timeout (sreg %02x)\n", esp->sreg);
312 #define MAC_ESP_PIO_LOOP(operands, reg1) \
314 "1: moveb " operands " \n" \
317 : "+a" (addr), "+r" (reg1) \
320 #define MAC_ESP_PIO_FILL(operands, reg1) \
322 " moveb " operands " \n" \
323 " moveb " operands " \n" \
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" \
340 : "+a" (addr), "+r" (reg1) \
343 #define MAC_ESP_FIFO_SIZE 16
345 static void mac_esp_send_pio_cmd(struct esp *esp, u32 addr, u32 esp_count,
346 u32 dma_count, int write, u8 cmd)
349 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
350 u8 *fifo = esp->regs + ESP_FDATA * 16;
352 local_irq_save(flags);
358 scsi_esp_cmd(esp, cmd);
360 if (!mac_esp_wait_for_intr(esp)) {
361 if (mac_esp_wait_for_fifo(esp))
367 scsi_esp_cmd(esp, ESP_CMD_FLUSH);
369 if (esp_count >= MAC_ESP_FIFO_SIZE)
370 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count);
372 MAC_ESP_PIO_LOOP("%0@+,%2@", esp_count);
374 scsi_esp_cmd(esp, cmd);
380 if (mac_esp_wait_for_intr(esp)) {
385 if (esp->sreg & ESP_STAT_SPAM) {
386 printk(KERN_ERR PFX "gross error\n");
391 n = esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES;
398 MAC_ESP_PIO_LOOP("%2@,%0@+", n);
400 if ((esp->sreg & ESP_STAT_PMASK) == ESP_STATP)
404 esp->ireg = esp_read8(ESP_INTRPT);
405 if (esp->ireg & ESP_INTR_DC)
408 scsi_esp_cmd(esp, ESP_CMD_TI);
411 esp->ireg = esp_read8(ESP_INTRPT);
412 if (esp->ireg & ESP_INTR_DC)
415 n = MAC_ESP_FIFO_SIZE - n;
419 if (n == MAC_ESP_FIFO_SIZE) {
420 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count);
423 MAC_ESP_PIO_LOOP("%0@+,%2@", n);
426 scsi_esp_cmd(esp, ESP_CMD_TI);
430 local_irq_restore(flags);
433 static int mac_esp_irq_pending(struct esp *esp)
435 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
440 static u32 mac_esp_dma_length_limit(struct esp *esp, u32 dma_addr, u32 dma_len)
442 return dma_len > 0xFFFF ? 0xFFFF : dma_len;
445 static struct esp_driver_ops mac_esp_ops = {
446 .esp_write8 = mac_esp_write8,
447 .esp_read8 = mac_esp_read8,
448 .map_single = mac_esp_map_single,
449 .map_sg = mac_esp_map_sg,
450 .unmap_single = mac_esp_unmap_single,
451 .unmap_sg = mac_esp_unmap_sg,
452 .irq_pending = mac_esp_irq_pending,
453 .dma_length_limit = mac_esp_dma_length_limit,
454 .reset_dma = mac_esp_reset_dma,
455 .dma_drain = mac_esp_dma_drain,
456 .dma_invalidate = mac_esp_dma_invalidate,
457 .send_dma_cmd = mac_esp_send_pdma_cmd,
458 .dma_error = mac_esp_dma_error,
461 static int __devinit esp_mac_probe(struct platform_device *dev)
463 struct scsi_host_template *tpnt = &scsi_esp_template;
464 struct Scsi_Host *host;
468 struct mac_esp_priv *mep;
473 switch (macintosh_config->scsi_type) {
474 case MAC_SCSI_QUADRA:
475 case MAC_SCSI_QUADRA3:
478 case MAC_SCSI_QUADRA2:
479 if ((macintosh_config->ident == MAC_MODEL_Q900) ||
480 (macintosh_config->ident == MAC_MODEL_Q950))
489 if (dev->id + 1 > chips_present)
492 host = scsi_host_alloc(tpnt, sizeof(struct esp));
499 host->use_clustering = DISABLE_CLUSTERING;
500 esp = shost_priv(host);
505 esp->command_block = kzalloc(16, GFP_KERNEL);
506 if (!esp->command_block)
508 esp->command_block_dma = (dma_addr_t)esp->command_block;
511 host->this_id = esp->scsi_id;
512 esp->scsi_id_mask = 1 << esp->scsi_id;
514 mep = kzalloc(sizeof(struct mac_esp_priv), GFP_KERNEL);
516 goto fail_free_command_block;
518 platform_set_drvdata(dev, mep);
520 switch (macintosh_config->scsi_type) {
521 case MAC_SCSI_QUADRA:
522 esp->cfreq = 16500000;
523 esp->regs = (void __iomem *)MAC_ESP_REGS_QUADRA;
524 mep->pdma_io = esp->regs + MAC_ESP_PDMA_IO_OFFSET;
525 mep->pdma_regs = NULL;
527 case MAC_SCSI_QUADRA2:
528 esp->cfreq = 25000000;
529 esp->regs = (void __iomem *)(MAC_ESP_REGS_QUADRA2 +
530 dev->id * MAC_ESP_REGS_SPACING);
531 mep->pdma_io = esp->regs + MAC_ESP_PDMA_IO_OFFSET;
532 mep->pdma_regs = (void __iomem *)(MAC_ESP_PDMA_REG +
533 dev->id * MAC_ESP_PDMA_REG_SPACING);
534 nubus_writel(0x1d1, mep->pdma_regs);
536 case MAC_SCSI_QUADRA3:
537 /* These quadras have a real DMA controller (the PSC) but we
538 * don't know how to drive it so we must use PIO instead.
540 esp->cfreq = 25000000;
541 esp->regs = (void __iomem *)MAC_ESP_REGS_QUADRA3;
543 mep->pdma_regs = NULL;
547 esp->ops = &mac_esp_ops;
548 if (mep->pdma_io == NULL) {
549 printk(KERN_INFO PFX "using PIO for controller %d\n", dev->id);
550 esp_write8(0, ESP_TCLOW);
551 esp_write8(0, ESP_TCMED);
552 esp->flags = ESP_FLAG_DISABLE_SYNC;
553 mac_esp_ops.send_dma_cmd = mac_esp_send_pio_cmd;
555 printk(KERN_INFO PFX "using PDMA for controller %d\n", dev->id);
558 host->irq = IRQ_MAC_SCSI;
559 err = request_irq(host->irq, scsi_esp_intr, IRQF_SHARED, "Mac ESP",
564 err = scsi_esp_register(esp, &dev->dev);
571 free_irq(host->irq, esp);
574 fail_free_command_block:
575 kfree(esp->command_block);
582 static int __devexit esp_mac_remove(struct platform_device *dev)
584 struct mac_esp_priv *mep = platform_get_drvdata(dev);
585 struct esp *esp = mep->esp;
586 unsigned int irq = esp->host->irq;
588 scsi_esp_unregister(esp);
594 kfree(esp->command_block);
596 scsi_host_put(esp->host);
601 static struct platform_driver esp_mac_driver = {
602 .probe = esp_mac_probe,
603 .remove = __devexit_p(esp_mac_remove),
605 .name = DRV_MODULE_NAME,
609 static int __init mac_esp_init(void)
613 err = platform_driver_register(&esp_mac_driver);
617 internal_esp = platform_device_alloc(DRV_MODULE_NAME, 0);
618 if (internal_esp && platform_device_add(internal_esp)) {
619 platform_device_put(internal_esp);
623 external_esp = platform_device_alloc(DRV_MODULE_NAME, 1);
624 if (external_esp && platform_device_add(external_esp)) {
625 platform_device_put(external_esp);
629 if (internal_esp || external_esp) {
632 platform_driver_unregister(&esp_mac_driver);
637 static void __exit mac_esp_exit(void)
639 platform_driver_unregister(&esp_mac_driver);
642 platform_device_unregister(internal_esp);
646 platform_device_unregister(external_esp);
651 MODULE_DESCRIPTION("Mac ESP SCSI driver");
652 MODULE_AUTHOR("Finn Thain <fthain@telegraphics.com.au>");
653 MODULE_LICENSE("GPL v2");
654 MODULE_VERSION(DRV_VERSION);
656 module_init(mac_esp_init);
657 module_exit(mac_esp_exit);