blob: 92d2c8379abf529989afd58f10976aedb901d325 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Generic Macintosh NCR5380 driver
3 *
4 * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
5 *
6 * derived in part from:
7 */
8/*
9 * Generic Generic NCR5380 driver
10 *
11 * Copyright 1995, Russell King
12 *
13 * ALPHA RELEASE 1.
14 *
15 * For more information, please consult
16 *
17 * NCR 5380 Family
18 * SCSI Protocol Controller
19 * Databook
20 *
21 * NCR Microelectronics
22 * 1635 Aeroplaza Drive
23 * Colorado Springs, CO 80916
24 * 1+ (719) 578-3400
25 * 1+ (800) 334-5454
26 */
27
28/*
29 * $Log: mac_NCR5380.c,v $
30 */
31
32#include <linux/types.h>
33#include <linux/stddef.h>
34#include <linux/ctype.h>
35#include <linux/delay.h>
36
37#include <linux/module.h>
38#include <linux/signal.h>
39#include <linux/sched.h>
40#include <linux/ioport.h>
41#include <linux/init.h>
42#include <linux/blkdev.h>
43#include <linux/interrupt.h>
44
45#include <asm/io.h>
46#include <asm/irq.h>
47#include <asm/system.h>
48
49#include <asm/macintosh.h>
50#include <asm/macints.h>
51#include <asm/machw.h>
52#include <asm/mac_via.h>
53
54#include "scsi.h"
55#include <scsi/scsi_host.h>
56#include "mac_scsi.h"
57#include "NCR5380.h"
58
59#if 0
60#define NDEBUG (NDEBUG_INTR | NDEBUG_PSEUDO_DMA | NDEBUG_ARBITRATION | NDEBUG_SELECTION | NDEBUG_RESELECTION)
61#else
62#define NDEBUG (NDEBUG_ABORT)
63#endif
64
65#define RESET_BOOT
66#define DRIVER_SETUP
67
68#define ENABLE_IRQ() mac_enable_irq( IRQ_MAC_SCSI );
69#define DISABLE_IRQ() mac_disable_irq( IRQ_MAC_SCSI );
70
71extern void via_scsi_clear(void);
72
73#ifdef RESET_BOOT
74static void mac_scsi_reset_boot(struct Scsi_Host *instance);
75#endif
76
77static int setup_called = 0;
78static int setup_can_queue = -1;
79static int setup_cmd_per_lun = -1;
80static int setup_sg_tablesize = -1;
81static int setup_use_pdma = -1;
82#ifdef SUPPORT_TAGS
83static int setup_use_tagged_queuing = -1;
84#endif
85static int setup_hostid = -1;
86
87/* Time (in jiffies) to wait after a reset; the SCSI standard calls for 250ms,
88 * we usually do 0.5s to be on the safe side. But Toshiba CD-ROMs once more
89 * need ten times the standard value... */
90#define TOSHIBA_DELAY
91
92#ifdef TOSHIBA_DELAY
93#define AFTER_RESET_DELAY (5*HZ/2)
94#else
95#define AFTER_RESET_DELAY (HZ/2)
96#endif
97
98static volatile unsigned char *mac_scsi_regp = NULL;
99static volatile unsigned char *mac_scsi_drq = NULL;
100static volatile unsigned char *mac_scsi_nodrq = NULL;
101
102
103/*
104 * NCR 5380 register access functions
105 */
106
107#if 0
108/* Debug versions */
109#define CTRL(p,v) (*ctrl = (v))
110
111static char macscsi_read(struct Scsi_Host *instance, int reg)
112{
113 int iobase = instance->io_port;
114 int i;
115 int *ctrl = &((struct NCR5380_hostdata *)instance->hostdata)->ctrl;
116
117 CTRL(iobase, 0);
118 i = in_8(iobase + (reg<<4));
119 CTRL(iobase, 0x40);
120
121 return i;
122}
123
124static void macscsi_write(struct Scsi_Host *instance, int reg, int value)
125{
126 int iobase = instance->io_port;
127 int *ctrl = &((struct NCR5380_hostdata *)instance->hostdata)->ctrl;
128
129 CTRL(iobase, 0);
130 out_8(iobase + (reg<<4), value);
131 CTRL(iobase, 0x40);
132}
133#else
134
135/* Fast versions */
136static __inline__ char macscsi_read(struct Scsi_Host *instance, int reg)
137{
138 return in_8(instance->io_port + (reg<<4));
139}
140
141static __inline__ void macscsi_write(struct Scsi_Host *instance, int reg, int value)
142{
143 out_8(instance->io_port + (reg<<4), value);
144}
145#endif
146
147
148/*
149 * Function : mac_scsi_setup(char *str)
150 *
151 * Purpose : booter command line initialization of the overrides array,
152 *
153 * Inputs : str - comma delimited list of options
154 *
155 */
156
157static int __init mac_scsi_setup(char *str) {
158#ifdef DRIVER_SETUP
159 int ints[7];
160
161 (void)get_options( str, ARRAY_SIZE(ints), ints);
162
163 if (setup_called++ || ints[0] < 1 || ints[0] > 6) {
164 printk(KERN_WARNING "scsi: <mac5380>"
165 " Usage: mac5380=<can_queue>[,<cmd_per_lun>,<sg_tablesize>,<hostid>,<use_tags>,<use_pdma>]\n");
166 printk(KERN_ALERT "scsi: <mac5380> Bad Penguin parameters?\n");
167 return 0;
168 }
169
170 if (ints[0] >= 1) {
171 if (ints[1] > 0)
172 /* no limits on this, just > 0 */
173 setup_can_queue = ints[1];
174 }
175 if (ints[0] >= 2) {
176 if (ints[2] > 0)
177 setup_cmd_per_lun = ints[2];
178 }
179 if (ints[0] >= 3) {
180 if (ints[3] >= 0) {
181 setup_sg_tablesize = ints[3];
182 /* Must be <= SG_ALL (255) */
183 if (setup_sg_tablesize > SG_ALL)
184 setup_sg_tablesize = SG_ALL;
185 }
186 }
187 if (ints[0] >= 4) {
188 /* Must be between 0 and 7 */
189 if (ints[4] >= 0 && ints[4] <= 7)
190 setup_hostid = ints[4];
191 else if (ints[4] > 7)
192 printk(KERN_WARNING "mac_scsi_setup: invalid host ID %d !\n", ints[4] );
193 }
194#ifdef SUPPORT_TAGS
195 if (ints[0] >= 5) {
196 if (ints[5] >= 0)
197 setup_use_tagged_queuing = !!ints[5];
198 }
199
200 if (ints[0] == 6) {
201 if (ints[6] >= 0)
202 setup_use_pdma = ints[6];
203 }
204#else
205 if (ints[0] == 5) {
206 if (ints[5] >= 0)
207 setup_use_pdma = ints[5];
208 }
209#endif /* SUPPORT_TAGS */
210
211#endif /* DRIVER_SETUP */
212 return 1;
213}
214
215__setup("mac5380=", mac_scsi_setup);
216
217/*
218 * If you want to find the instance with (k)gdb ...
219 */
220#if NDEBUG
221static struct Scsi_Host *default_instance;
222#endif
223
224/*
225 * Function : int macscsi_detect(Scsi_Host_Template * tpnt)
226 *
227 * Purpose : initializes mac NCR5380 driver based on the
228 * command line / compile time port and irq definitions.
229 *
230 * Inputs : tpnt - template for this SCSI adapter.
231 *
232 * Returns : 1 if a host adapter was found, 0 if not.
233 *
234 */
235
236int macscsi_detect(Scsi_Host_Template * tpnt)
237{
238 static int called = 0;
239 int flags = 0;
240 struct Scsi_Host *instance;
241
242 if (!MACH_IS_MAC || called)
243 return( 0 );
244
245 if (macintosh_config->scsi_type != MAC_SCSI_OLD)
246 return( 0 );
247
248 /* setup variables */
249 tpnt->can_queue =
250 (setup_can_queue > 0) ? setup_can_queue : CAN_QUEUE;
251 tpnt->cmd_per_lun =
252 (setup_cmd_per_lun > 0) ? setup_cmd_per_lun : CMD_PER_LUN;
253 tpnt->sg_tablesize =
254 (setup_sg_tablesize >= 0) ? setup_sg_tablesize : SG_TABLESIZE;
255
256 if (setup_hostid >= 0)
257 tpnt->this_id = setup_hostid;
258 else {
259 /* use 7 as default */
260 tpnt->this_id = 7;
261 }
262
263#ifdef SUPPORT_TAGS
264 if (setup_use_tagged_queuing < 0)
265 setup_use_tagged_queuing = USE_TAGGED_QUEUING;
266#endif
267
268 /* Once we support multiple 5380s (e.g. DuoDock) we'll do
269 something different here */
270 instance = scsi_register (tpnt, sizeof(struct NCR5380_hostdata));
271#if NDEBUG
272 default_instance = instance;
273#endif
274
275 if (macintosh_config->ident == MAC_MODEL_IIFX) {
276 mac_scsi_regp = via1+0x8000;
277 mac_scsi_drq = via1+0xE000;
278 mac_scsi_nodrq = via1+0xC000;
279 /* The IIFX should be able to do true DMA, but pseudo-dma doesn't work */
280 flags = FLAG_NO_PSEUDO_DMA;
281 } else {
282 mac_scsi_regp = via1+0x10000;
283 mac_scsi_drq = via1+0x6000;
284 mac_scsi_nodrq = via1+0x12000;
285 }
286
287 if (! setup_use_pdma)
288 flags = FLAG_NO_PSEUDO_DMA;
289
290 instance->io_port = (unsigned long) mac_scsi_regp;
291 instance->irq = IRQ_MAC_SCSI;
292
293#ifdef RESET_BOOT
294 mac_scsi_reset_boot(instance);
295#endif
296
297 NCR5380_init(instance, flags);
298
299 instance->n_io_port = 255;
300
301 ((struct NCR5380_hostdata *)instance->hostdata)->ctrl = 0;
302
303 if (instance->irq != SCSI_IRQ_NONE)
304 if (request_irq(instance->irq, NCR5380_intr, IRQ_FLG_SLOW,
305 "ncr5380", instance)) {
306 printk(KERN_WARNING "scsi%d: IRQ%d not free, interrupts disabled\n",
307 instance->host_no, instance->irq);
308 instance->irq = SCSI_IRQ_NONE;
309 }
310
311 printk(KERN_INFO "scsi%d: generic 5380 at port %lX irq", instance->host_no, instance->io_port);
312 if (instance->irq == SCSI_IRQ_NONE)
313 printk (KERN_INFO "s disabled");
314 else
315 printk (KERN_INFO " %d", instance->irq);
316 printk(KERN_INFO " options CAN_QUEUE=%d CMD_PER_LUN=%d release=%d",
317 instance->can_queue, instance->cmd_per_lun, MACSCSI_PUBLIC_RELEASE);
318 printk(KERN_INFO "\nscsi%d:", instance->host_no);
319 NCR5380_print_options(instance);
320 printk("\n");
321 called = 1;
322 return 1;
323}
324
325int macscsi_release (struct Scsi_Host *shpnt)
326{
327 if (shpnt->irq != SCSI_IRQ_NONE)
328 free_irq (shpnt->irq, NCR5380_intr);
329 NCR5380_exit(shpnt);
330
331 return 0;
332}
333
334#ifdef RESET_BOOT
335/*
336 * Our 'bus reset on boot' function
337 */
338
339static void mac_scsi_reset_boot(struct Scsi_Host *instance)
340{
341 unsigned long end;
342
343 NCR5380_local_declare();
344 NCR5380_setup(instance);
345
346 /*
347 * Do a SCSI reset to clean up the bus during initialization. No messing
348 * with the queues, interrupts, or locks necessary here.
349 */
350
351 printk(KERN_INFO "Macintosh SCSI: resetting the SCSI bus..." );
352
353 /* switch off SCSI IRQ - catch an interrupt without IRQ bit set else */
354 mac_disable_irq(IRQ_MAC_SCSI);
355
356 /* get in phase */
357 NCR5380_write( TARGET_COMMAND_REG,
358 PHASE_SR_TO_TCR( NCR5380_read(STATUS_REG) ));
359
360 /* assert RST */
361 NCR5380_write( INITIATOR_COMMAND_REG, ICR_BASE | ICR_ASSERT_RST );
362 /* The min. reset hold time is 25us, so 40us should be enough */
363 udelay( 50 );
364 /* reset RST and interrupt */
365 NCR5380_write( INITIATOR_COMMAND_REG, ICR_BASE );
366 NCR5380_read( RESET_PARITY_INTERRUPT_REG );
367
368 for( end = jiffies + AFTER_RESET_DELAY; time_before(jiffies, end); )
369 barrier();
370
371 /* switch on SCSI IRQ again */
372 mac_enable_irq(IRQ_MAC_SCSI);
373
374 printk(KERN_INFO " done\n" );
375}
376#endif
377
378const char * macscsi_info (struct Scsi_Host *spnt) {
379 return "";
380}
381
382/*
383 Pseudo-DMA: (Ove Edlund)
384 The code attempts to catch bus errors that occur if one for example
385 "trips over the cable".
386 XXX: Since bus errors in the PDMA routines never happen on my
387 computer, the bus error code is untested.
388 If the code works as intended, a bus error results in Pseudo-DMA
389 beeing disabled, meaning that the driver switches to slow handshake.
390 If bus errors are NOT extremely rare, this has to be changed.
391*/
392
393#define CP_IO_TO_MEM(s,d,len) \
394__asm__ __volatile__ \
395 (" cmp.w #4,%2\n" \
396 " bls 8f\n" \
397 " move.w %1,%%d0\n" \
398 " neg.b %%d0\n" \
399 " and.w #3,%%d0\n" \
400 " sub.w %%d0,%2\n" \
401 " bra 2f\n" \
402 " 1: move.b (%0),(%1)+\n" \
403 " 2: dbf %%d0,1b\n" \
404 " move.w %2,%%d0\n" \
405 " lsr.w #5,%%d0\n" \
406 " bra 4f\n" \
407 " 3: move.l (%0),(%1)+\n" \
408 "31: move.l (%0),(%1)+\n" \
409 "32: move.l (%0),(%1)+\n" \
410 "33: move.l (%0),(%1)+\n" \
411 "34: move.l (%0),(%1)+\n" \
412 "35: move.l (%0),(%1)+\n" \
413 "36: move.l (%0),(%1)+\n" \
414 "37: move.l (%0),(%1)+\n" \
415 " 4: dbf %%d0,3b\n" \
416 " move.w %2,%%d0\n" \
417 " lsr.w #2,%%d0\n" \
418 " and.w #7,%%d0\n" \
419 " bra 6f\n" \
420 " 5: move.l (%0),(%1)+\n" \
421 " 6: dbf %%d0,5b\n" \
422 " and.w #3,%2\n" \
423 " bra 8f\n" \
424 " 7: move.b (%0),(%1)+\n" \
425 " 8: dbf %2,7b\n" \
426 " moveq.l #0, %2\n" \
427 " 9: \n" \
428 ".section .fixup,\"ax\"\n" \
429 " .even\n" \
430 "90: moveq.l #1, %2\n" \
431 " jra 9b\n" \
432 ".previous\n" \
433 ".section __ex_table,\"a\"\n" \
434 " .align 4\n" \
435 " .long 1b,90b\n" \
436 " .long 3b,90b\n" \
437 " .long 31b,90b\n" \
438 " .long 32b,90b\n" \
439 " .long 33b,90b\n" \
440 " .long 34b,90b\n" \
441 " .long 35b,90b\n" \
442 " .long 36b,90b\n" \
443 " .long 37b,90b\n" \
444 " .long 5b,90b\n" \
445 " .long 7b,90b\n" \
446 ".previous" \
447 : "=a"(s), "=a"(d), "=d"(len) \
448 : "0"(s), "1"(d), "2"(len) \
449 : "d0")
450
451
452static int macscsi_pread (struct Scsi_Host *instance,
453 unsigned char *dst, int len)
454{
455 unsigned char *d;
456 volatile unsigned char *s;
457
458 NCR5380_local_declare();
459 NCR5380_setup(instance);
460
461 s = mac_scsi_drq+0x60;
462 d = dst;
463
464/* These conditions are derived from MacOS */
465
466 while (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ)
467 && !(NCR5380_read(STATUS_REG) & SR_REQ))
468 ;
469 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ)
470 && (NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH)) {
471 printk(KERN_ERR "Error in macscsi_pread\n");
472 return -1;
473 }
474
475 CP_IO_TO_MEM(s, d, len);
476
477 if (len != 0) {
478 printk(KERN_NOTICE "Bus error in macscsi_pread\n");
479 return -1;
480 }
481
482 return 0;
483}
484
485
486#define CP_MEM_TO_IO(s,d,len) \
487__asm__ __volatile__ \
488 (" cmp.w #4,%2\n" \
489 " bls 8f\n" \
490 " move.w %0,%%d0\n" \
491 " neg.b %%d0\n" \
492 " and.w #3,%%d0\n" \
493 " sub.w %%d0,%2\n" \
494 " bra 2f\n" \
495 " 1: move.b (%0)+,(%1)\n" \
496 " 2: dbf %%d0,1b\n" \
497 " move.w %2,%%d0\n" \
498 " lsr.w #5,%%d0\n" \
499 " bra 4f\n" \
500 " 3: move.l (%0)+,(%1)\n" \
501 "31: move.l (%0)+,(%1)\n" \
502 "32: move.l (%0)+,(%1)\n" \
503 "33: move.l (%0)+,(%1)\n" \
504 "34: move.l (%0)+,(%1)\n" \
505 "35: move.l (%0)+,(%1)\n" \
506 "36: move.l (%0)+,(%1)\n" \
507 "37: move.l (%0)+,(%1)\n" \
508 " 4: dbf %%d0,3b\n" \
509 " move.w %2,%%d0\n" \
510 " lsr.w #2,%%d0\n" \
511 " and.w #7,%%d0\n" \
512 " bra 6f\n" \
513 " 5: move.l (%0)+,(%1)\n" \
514 " 6: dbf %%d0,5b\n" \
515 " and.w #3,%2\n" \
516 " bra 8f\n" \
517 " 7: move.b (%0)+,(%1)\n" \
518 " 8: dbf %2,7b\n" \
519 " moveq.l #0, %2\n" \
520 " 9: \n" \
521 ".section .fixup,\"ax\"\n" \
522 " .even\n" \
523 "90: moveq.l #1, %2\n" \
524 " jra 9b\n" \
525 ".previous\n" \
526 ".section __ex_table,\"a\"\n" \
527 " .align 4\n" \
528 " .long 1b,90b\n" \
529 " .long 3b,90b\n" \
530 " .long 31b,90b\n" \
531 " .long 32b,90b\n" \
532 " .long 33b,90b\n" \
533 " .long 34b,90b\n" \
534 " .long 35b,90b\n" \
535 " .long 36b,90b\n" \
536 " .long 37b,90b\n" \
537 " .long 5b,90b\n" \
538 " .long 7b,90b\n" \
539 ".previous" \
540 : "=a"(s), "=a"(d), "=d"(len) \
541 : "0"(s), "1"(d), "2"(len) \
542 : "d0")
543
544static int macscsi_pwrite (struct Scsi_Host *instance,
545 unsigned char *src, int len)
546{
547 unsigned char *s;
548 volatile unsigned char *d;
549
550 NCR5380_local_declare();
551 NCR5380_setup(instance);
552
553 s = src;
554 d = mac_scsi_drq;
555
556/* These conditions are derived from MacOS */
557
558 while (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ)
559 && (!(NCR5380_read(STATUS_REG) & SR_REQ)
560 || (NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH)))
561 ;
562 if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_DRQ)) {
563 printk(KERN_ERR "Error in macscsi_pwrite\n");
564 return -1;
565 }
566
567 CP_MEM_TO_IO(s, d, len);
568
569 if (len != 0) {
570 printk(KERN_NOTICE "Bus error in macscsi_pwrite\n");
571 return -1;
572 }
573
574 return 0;
575}
576
577
578/* These control the behaviour of the generic 5380 core */
579#define AUTOSENSE
580#define PSEUDO_DMA
581
582#include "NCR5380.c"
583
584static Scsi_Host_Template driver_template = {
585 .proc_name = "Mac5380",
586 .proc_info = macscsi_proc_info,
587 .name = "Macintosh NCR5380 SCSI",
588 .detect = macscsi_detect,
589 .release = macscsi_release,
590 .info = macscsi_info,
591 .queuecommand = macscsi_queue_command,
592 .eh_abort_handler = macscsi_abort,
593 .eh_bus_reset_handler = macscsi_bus_reset,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 .can_queue = CAN_QUEUE,
595 .this_id = 7,
596 .sg_tablesize = SG_ALL,
597 .cmd_per_lun = CMD_PER_LUN,
598 .unchecked_isa_dma = 0,
599 .use_clustering = DISABLE_CLUSTERING
600};
601
602
603#include "scsi_module.c"