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