?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Linux 4.19.133
[linux/fpc-iii.git] / drivers / scsi / mac_esp.c
blob71879f2207e0e92fc9c686c26c89f14fab5ea701
1 /* mac_esp.c: ESP front-end for Macintosh Quadra systems.
2 *
3 * Adapted from jazz_esp.c and the old mac_esp.c.
4 *
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.
7 *
8 * Copyright (C) 2007-2008 Finn Thain
9 */
10
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>
20 #include <linux/io.h>
21 #include <linux/nubus.h>
22 #include <linux/slab.h>
23
24 #include <asm/irq.h>
25 #include <asm/dma.h>
26 #include <asm/macints.h>
27 #include <asm/macintosh.h>
28 #include <asm/mac_via.h>
29
30 #include <scsi/scsi_host.h>
31
32 #include "esp_scsi.h"
33
34 #define DRV_MODULE_NAME "mac_esp"
35 #define PFX DRV_MODULE_NAME ": "
36 #define DRV_VERSION "1.000"
37 #define DRV_MODULE_RELDATE "Sept 15, 2007"
38
39 #define MAC_ESP_IO_BASE 0x50F00000
40 #define MAC_ESP_REGS_QUADRA (MAC_ESP_IO_BASE + 0x10000)
41 #define MAC_ESP_REGS_QUADRA2 (MAC_ESP_IO_BASE + 0xF000)
42 #define MAC_ESP_REGS_QUADRA3 (MAC_ESP_IO_BASE + 0x18000)
43 #define MAC_ESP_REGS_SPACING 0x402
44 #define MAC_ESP_PDMA_REG 0xF9800024
45 #define MAC_ESP_PDMA_REG_SPACING 0x4
46 #define MAC_ESP_PDMA_IO_OFFSET 0x100
47
48 #define esp_read8(REG) mac_esp_read8(esp, REG)
49 #define esp_write8(VAL, REG) mac_esp_write8(esp, VAL, REG)
50
51 struct mac_esp_priv {
52 struct esp *esp;
53 void __iomem *pdma_regs;
54 void __iomem *pdma_io;
55 int error;
56 };
57 static struct esp *esp_chips[2];
58 static DEFINE_SPINLOCK(esp_chips_lock);
59
60 #define MAC_ESP_GET_PRIV(esp) ((struct mac_esp_priv *) \
61 platform_get_drvdata((struct platform_device *) \
62 (esp->dev)))
63
64 static inline void mac_esp_write8(struct esp *esp, u8 val, unsigned long reg)
65 {
66 nubus_writeb(val, esp->regs + reg * 16);
67 }
68
69 static inline u8 mac_esp_read8(struct esp *esp, unsigned long reg)
70 {
71 return nubus_readb(esp->regs + reg * 16);
72 }
73
74 /* For pseudo DMA and PIO we need the virtual address
75 * so this address mapping is the identity mapping.
76 */
77
78 static dma_addr_t mac_esp_map_single(struct esp *esp, void *buf,
79 size_t sz, int dir)
80 {
81 return (dma_addr_t)buf;
82 }
83
84 static int mac_esp_map_sg(struct esp *esp, struct scatterlist *sg,
85 int num_sg, int dir)
86 {
87 int i;
88
89 for (i = 0; i < num_sg; i++)
90 sg[i].dma_address = (u32)sg_virt(&sg[i]);
91 return num_sg;
92 }
93
94 static void mac_esp_unmap_single(struct esp *esp, dma_addr_t addr,
95 size_t sz, int dir)
96 {
97 /* Nothing to do. */
98 }
99
100 static void mac_esp_unmap_sg(struct esp *esp, struct scatterlist *sg,
101 int num_sg, int dir)
102 {
103 /* Nothing to do. */
104 }
105
106 static void mac_esp_reset_dma(struct esp *esp)
107 {
108 /* Nothing to do. */
109 }
110
111 static void mac_esp_dma_drain(struct esp *esp)
112 {
113 /* Nothing to do. */
114 }
115
116 static void mac_esp_dma_invalidate(struct esp *esp)
117 {
118 /* Nothing to do. */
119 }
120
121 static int mac_esp_dma_error(struct esp *esp)
122 {
123 return MAC_ESP_GET_PRIV(esp)->error;
124 }
125
126 static inline int mac_esp_wait_for_empty_fifo(struct esp *esp)
127 {
128 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
129 int i = 500000;
130
131 do {
132 if (!(esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES))
133 return 0;
134
135 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
136 return 1;
137
138 udelay(2);
139 } while (--i);
140
141 printk(KERN_ERR PFX "FIFO is not empty (sreg %02x)\n",
142 esp_read8(ESP_STATUS));
143 mep->error = 1;
144 return 1;
145 }
146
147 static inline int mac_esp_wait_for_dreq(struct esp *esp)
148 {
149 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
150 int i = 500000;
151
152 do {
153 if (mep->pdma_regs == NULL) {
154 if (via2_scsi_drq_pending())
155 return 0;
156 } else {
157 if (nubus_readl(mep->pdma_regs) & 0x200)
158 return 0;
159 }
160
161 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
162 return 1;
163
164 udelay(2);
165 } while (--i);
166
167 printk(KERN_ERR PFX "PDMA timeout (sreg %02x)\n",
168 esp_read8(ESP_STATUS));
169 mep->error = 1;
170 return 1;
171 }
172
173 #define MAC_ESP_PDMA_LOOP(operands) \
174 asm volatile ( \
175 " tstw %1 \n" \
176 " jbeq 20f \n" \
177 "1: movew " operands " \n" \
178 "2: movew " operands " \n" \
179 "3: movew " operands " \n" \
180 "4: movew " operands " \n" \
181 "5: movew " operands " \n" \
182 "6: movew " operands " \n" \
183 "7: movew " operands " \n" \
184 "8: movew " operands " \n" \
185 "9: movew " operands " \n" \
186 "10: movew " operands " \n" \
187 "11: movew " operands " \n" \
188 "12: movew " operands " \n" \
189 "13: movew " operands " \n" \
190 "14: movew " operands " \n" \
191 "15: movew " operands " \n" \
192 "16: movew " operands " \n" \
193 " subqw #1,%1 \n" \
194 " jbne 1b \n" \
195 "20: tstw %2 \n" \
196 " jbeq 30f \n" \
197 "21: movew " operands " \n" \
198 " subqw #1,%2 \n" \
199 " jbne 21b \n" \
200 "30: tstw %3 \n" \
201 " jbeq 40f \n" \
202 "31: moveb " operands " \n" \
203 "32: nop \n" \
204 "40: \n" \
205 " \n" \
206 " .section __ex_table,\"a\" \n" \
207 " .align 4 \n" \
208 " .long 1b,40b \n" \
209 " .long 2b,40b \n" \
210 " .long 3b,40b \n" \
211 " .long 4b,40b \n" \
212 " .long 5b,40b \n" \
213 " .long 6b,40b \n" \
214 " .long 7b,40b \n" \
215 " .long 8b,40b \n" \
216 " .long 9b,40b \n" \
217 " .long 10b,40b \n" \
218 " .long 11b,40b \n" \
219 " .long 12b,40b \n" \
220 " .long 13b,40b \n" \
221 " .long 14b,40b \n" \
222 " .long 15b,40b \n" \
223 " .long 16b,40b \n" \
224 " .long 21b,40b \n" \
225 " .long 31b,40b \n" \
226 " .long 32b,40b \n" \
227 " .previous \n" \
228 : "+a" (addr), "+r" (count32), "+r" (count2) \
229 : "g" (count1), "a" (mep->pdma_io))
230
231 static void mac_esp_send_pdma_cmd(struct esp *esp, u32 addr, u32 esp_count,
232 u32 dma_count, int write, u8 cmd)
233 {
234 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
235
236 mep->error = 0;
237
238 if (!write)
239 scsi_esp_cmd(esp, ESP_CMD_FLUSH);
240
241 esp_write8((esp_count >> 0) & 0xFF, ESP_TCLOW);
242 esp_write8((esp_count >> 8) & 0xFF, ESP_TCMED);
243
244 scsi_esp_cmd(esp, cmd);
245
246 do {
247 unsigned int count32 = esp_count >> 5;
248 unsigned int count2 = (esp_count & 0x1F) >> 1;
249 unsigned int count1 = esp_count & 1;
250 unsigned int start_addr = addr;
251
252 if (mac_esp_wait_for_dreq(esp))
253 break;
254
255 if (write) {
256 MAC_ESP_PDMA_LOOP("%4@,%0@+");
257
258 esp_count -= addr - start_addr;
259 } else {
260 unsigned int n;
261
262 MAC_ESP_PDMA_LOOP("%0@+,%4@");
263
264 if (mac_esp_wait_for_empty_fifo(esp))
265 break;
266
267 n = (esp_read8(ESP_TCMED) << 8) + esp_read8(ESP_TCLOW);
268 addr = start_addr + esp_count - n;
269 esp_count = n;
270 }
271 } while (esp_count);
272 }
273
274 /*
275 * Programmed IO routines follow.
276 */
277
278 static inline unsigned int mac_esp_wait_for_fifo(struct esp *esp)
279 {
280 int i = 500000;
281
282 do {
283 unsigned int fbytes = esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES;
284
285 if (fbytes)
286 return fbytes;
287
288 udelay(2);
289 } while (--i);
290
291 printk(KERN_ERR PFX "FIFO is empty (sreg %02x)\n",
292 esp_read8(ESP_STATUS));
293 return 0;
294 }
295
296 static inline int mac_esp_wait_for_intr(struct esp *esp)
297 {
298 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
299 int i = 500000;
300
301 do {
302 esp->sreg = esp_read8(ESP_STATUS);
303 if (esp->sreg & ESP_STAT_INTR)
304 return 0;
305
306 udelay(2);
307 } while (--i);
308
309 printk(KERN_ERR PFX "IRQ timeout (sreg %02x)\n", esp->sreg);
310 mep->error = 1;
311 return 1;
312 }
313
314 #define MAC_ESP_PIO_LOOP(operands, reg1) \
315 asm volatile ( \
316 "1: moveb " operands " \n" \
317 " subqw #1,%1 \n" \
318 " jbne 1b \n" \
319 : "+a" (addr), "+r" (reg1) \
320 : "a" (fifo))
321
322 #define MAC_ESP_PIO_FILL(operands, reg1) \
323 asm volatile ( \
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" \
340 " subqw #8,%1 \n" \
341 " subqw #8,%1 \n" \
342 : "+a" (addr), "+r" (reg1) \
343 : "a" (fifo))
344
345 #define MAC_ESP_FIFO_SIZE 16
346
347 static void mac_esp_send_pio_cmd(struct esp *esp, u32 addr, u32 esp_count,
348 u32 dma_count, int write, u8 cmd)
349 {
350 struct mac_esp_priv *mep = MAC_ESP_GET_PRIV(esp);
351 u8 __iomem *fifo = esp->regs + ESP_FDATA * 16;
352 u8 phase = esp->sreg & ESP_STAT_PMASK;
353
354 cmd &= ~ESP_CMD_DMA;
355 mep->error = 0;
356
357 if (write) {
358 u8 *dst = (u8 *)addr;
359 u8 mask = ~(phase == ESP_MIP ? ESP_INTR_FDONE : ESP_INTR_BSERV);
360
361 scsi_esp_cmd(esp, cmd);
362
363 while (1) {
364 if (!mac_esp_wait_for_fifo(esp))
365 break;
366
367 *dst++ = esp_read8(ESP_FDATA);
368 --esp_count;
369
370 if (!esp_count)
371 break;
372
373 if (mac_esp_wait_for_intr(esp))
374 break;
375
376 if ((esp->sreg & ESP_STAT_PMASK) != phase)
377 break;
378
379 esp->ireg = esp_read8(ESP_INTRPT);
380 if (esp->ireg & mask) {
381 mep->error = 1;
382 break;
383 }
384
385 if (phase == ESP_MIP)
386 scsi_esp_cmd(esp, ESP_CMD_MOK);
387
388 scsi_esp_cmd(esp, ESP_CMD_TI);
389 }
390 } else {
391 scsi_esp_cmd(esp, ESP_CMD_FLUSH);
392
393 if (esp_count >= MAC_ESP_FIFO_SIZE)
394 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count);
395 else
396 MAC_ESP_PIO_LOOP("%0@+,%2@", esp_count);
397
398 scsi_esp_cmd(esp, cmd);
399
400 while (esp_count) {
401 unsigned int n;
402
403 if (mac_esp_wait_for_intr(esp))
404 break;
405
406 if ((esp->sreg & ESP_STAT_PMASK) != phase)
407 break;
408
409 esp->ireg = esp_read8(ESP_INTRPT);
410 if (esp->ireg & ~ESP_INTR_BSERV) {
411 mep->error = 1;
412 break;
413 }
414
415 n = MAC_ESP_FIFO_SIZE -
416 (esp_read8(ESP_FFLAGS) & ESP_FF_FBYTES);
417 if (n > esp_count)
418 n = esp_count;
419
420 if (n == MAC_ESP_FIFO_SIZE) {
421 MAC_ESP_PIO_FILL("%0@+,%2@", esp_count);
422 } else {
423 esp_count -= n;
424 MAC_ESP_PIO_LOOP("%0@+,%2@", n);
425 }
426
427 scsi_esp_cmd(esp, ESP_CMD_TI);
428 }
429 }
430
431 esp->send_cmd_residual = esp_count;
432 }
433
434 static int mac_esp_irq_pending(struct esp *esp)
435 {
436 if (esp_read8(ESP_STATUS) & ESP_STAT_INTR)
437 return 1;
438 return 0;
439 }
440
441 static u32 mac_esp_dma_length_limit(struct esp *esp, u32 dma_addr, u32 dma_len)
442 {
443 return dma_len > 0xFFFF ? 0xFFFF : dma_len;
444 }
445
446 static irqreturn_t mac_scsi_esp_intr(int irq, void *dev_id)
447 {
448 int got_intr;
449
450 /*
451 * This is an edge triggered IRQ, so we have to be careful to
452 * avoid missing a transition when it is shared by two ESP devices.
453 */
454
455 do {
456 got_intr = 0;
457 if (esp_chips[0] &&
458 (mac_esp_read8(esp_chips[0], ESP_STATUS) & ESP_STAT_INTR)) {
459 (void)scsi_esp_intr(irq, esp_chips[0]);
460 got_intr = 1;
461 }
462 if (esp_chips[1] &&
463 (mac_esp_read8(esp_chips[1], ESP_STATUS) & ESP_STAT_INTR)) {
464 (void)scsi_esp_intr(irq, esp_chips[1]);
465 got_intr = 1;
466 }
467 } while (got_intr);
468
469 return IRQ_HANDLED;
470 }
471
472 static struct esp_driver_ops mac_esp_ops = {
473 .esp_write8 = mac_esp_write8,
474 .esp_read8 = mac_esp_read8,
475 .map_single = mac_esp_map_single,
476 .map_sg = mac_esp_map_sg,
477 .unmap_single = mac_esp_unmap_single,
478 .unmap_sg = mac_esp_unmap_sg,
479 .irq_pending = mac_esp_irq_pending,
480 .dma_length_limit = mac_esp_dma_length_limit,
481 .reset_dma = mac_esp_reset_dma,
482 .dma_drain = mac_esp_dma_drain,
483 .dma_invalidate = mac_esp_dma_invalidate,
484 .send_dma_cmd = mac_esp_send_pdma_cmd,
485 .dma_error = mac_esp_dma_error,
486 };
487
488 static int esp_mac_probe(struct platform_device *dev)
489 {
490 struct scsi_host_template *tpnt = &scsi_esp_template;
491 struct Scsi_Host *host;
492 struct esp *esp;
493 int err;
494 struct mac_esp_priv *mep;
495
496 if (!MACH_IS_MAC)
497 return -ENODEV;
498
499 if (dev->id > 1)
500 return -ENODEV;
501
502 host = scsi_host_alloc(tpnt, sizeof(struct esp));
503
504 err = -ENOMEM;
505 if (!host)
506 goto fail;
507
508 host->max_id = 8;
509 host->use_clustering = DISABLE_CLUSTERING;
510 esp = shost_priv(host);
511
512 esp->host = host;
513 esp->dev = dev;
514
515 esp->command_block = kzalloc(16, GFP_KERNEL);
516 if (!esp->command_block)
517 goto fail_unlink;
518 esp->command_block_dma = (dma_addr_t)esp->command_block;
519
520 esp->scsi_id = 7;
521 host->this_id = esp->scsi_id;
522 esp->scsi_id_mask = 1 << esp->scsi_id;
523
524 mep = kzalloc(sizeof(struct mac_esp_priv), GFP_KERNEL);
525 if (!mep)
526 goto fail_free_command_block;
527 mep->esp = esp;
528 platform_set_drvdata(dev, mep);
529
530 switch (macintosh_config->scsi_type) {
531 case MAC_SCSI_QUADRA:
532 esp->cfreq = 16500000;
533 esp->regs = (void __iomem *)MAC_ESP_REGS_QUADRA;
534 mep->pdma_io = esp->regs + MAC_ESP_PDMA_IO_OFFSET;
535 mep->pdma_regs = NULL;
536 break;
537 case MAC_SCSI_QUADRA2:
538 esp->cfreq = 25000000;
539 esp->regs = (void __iomem *)(MAC_ESP_REGS_QUADRA2 +
540 dev->id * MAC_ESP_REGS_SPACING);
541 mep->pdma_io = esp->regs + MAC_ESP_PDMA_IO_OFFSET;
542 mep->pdma_regs = (void __iomem *)(MAC_ESP_PDMA_REG +
543 dev->id * MAC_ESP_PDMA_REG_SPACING);
544 nubus_writel(0x1d1, mep->pdma_regs);
545 break;
546 case MAC_SCSI_QUADRA3:
547 /* These quadras have a real DMA controller (the PSC) but we
548 * don't know how to drive it so we must use PIO instead.
549 */
550 esp->cfreq = 25000000;
551 esp->regs = (void __iomem *)MAC_ESP_REGS_QUADRA3;
552 mep->pdma_io = NULL;
553 mep->pdma_regs = NULL;
554 break;
555 }
556
557 esp->ops = &mac_esp_ops;
558 if (mep->pdma_io == NULL) {
559 printk(KERN_INFO PFX "using PIO for controller %d\n", dev->id);
560 esp_write8(0, ESP_TCLOW);
561 esp_write8(0, ESP_TCMED);
562 esp->flags = ESP_FLAG_DISABLE_SYNC;
563 mac_esp_ops.send_dma_cmd = mac_esp_send_pio_cmd;
564 } else {
565 printk(KERN_INFO PFX "using PDMA for controller %d\n", dev->id);
566 }
567
568 host->irq = IRQ_MAC_SCSI;
569
570 /* The request_irq() call is intended to succeed for the first device
571 * and fail for the second device.
572 */
573 err = request_irq(host->irq, mac_scsi_esp_intr, 0, "ESP", NULL);
574 spin_lock(&esp_chips_lock);
575 if (err < 0 && esp_chips[!dev->id] == NULL) {
576 spin_unlock(&esp_chips_lock);
577 goto fail_free_priv;
578 }
579 esp_chips[dev->id] = esp;
580 spin_unlock(&esp_chips_lock);
581
582 err = scsi_esp_register(esp, &dev->dev);
583 if (err)
584 goto fail_free_irq;
585
586 return 0;
587
588 fail_free_irq:
589 spin_lock(&esp_chips_lock);
590 esp_chips[dev->id] = NULL;
591 if (esp_chips[!dev->id] == NULL) {
592 spin_unlock(&esp_chips_lock);
593 free_irq(host->irq, NULL);
594 } else
595 spin_unlock(&esp_chips_lock);
596 fail_free_priv:
597 kfree(mep);
598 fail_free_command_block:
599 kfree(esp->command_block);
600 fail_unlink:
601 scsi_host_put(host);
602 fail:
603 return err;
604 }
605
606 static int esp_mac_remove(struct platform_device *dev)
607 {
608 struct mac_esp_priv *mep = platform_get_drvdata(dev);
609 struct esp *esp = mep->esp;
610 unsigned int irq = esp->host->irq;
611
612 scsi_esp_unregister(esp);
613
614 spin_lock(&esp_chips_lock);
615 esp_chips[dev->id] = NULL;
616 if (esp_chips[!dev->id] == NULL) {
617 spin_unlock(&esp_chips_lock);
618 free_irq(irq, NULL);
619 } else
620 spin_unlock(&esp_chips_lock);
621
622 kfree(mep);
623
624 kfree(esp->command_block);
625
626 scsi_host_put(esp->host);
627
628 return 0;
629 }
630
631 static struct platform_driver esp_mac_driver = {
632 .probe = esp_mac_probe,
633 .remove = esp_mac_remove,
634 .driver = {
635 .name = DRV_MODULE_NAME,
636 },
637 };
638
639 static int __init mac_esp_init(void)
640 {
641 return platform_driver_register(&esp_mac_driver);
642 }
643
644 static void __exit mac_esp_exit(void)
645 {
646 platform_driver_unregister(&esp_mac_driver);
647 }
648
649 MODULE_DESCRIPTION("Mac ESP SCSI driver");
650 MODULE_AUTHOR("Finn Thain");
651 MODULE_LICENSE("GPL v2");
652 MODULE_VERSION(DRV_VERSION);
653 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
654
655 module_init(mac_esp_init);
656 module_exit(mac_esp_exit);
Linux with added FPC-III support