xref: /linux/drivers/scsi/mac_scsi.c (revision 820682b1)
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 
14 #include <linux/types.h>
15 #include <linux/module.h>
16 #include <linux/ioport.h>
17 #include <linux/init.h>
18 #include <linux/blkdev.h>
19 #include <linux/interrupt.h>
20 #include <linux/platform_device.h>
21 
22 #include <asm/hwtest.h>
23 #include <asm/io.h>
24 #include <asm/macints.h>
25 #include <asm/setup.h>
26 
27 #include <scsi/scsi_host.h>
28 
29 /* Definitions for the core NCR5380 driver. */
30 
31 #define NCR5380_implementation_fields   int pdma_residual
32 
33 #define NCR5380_read(reg)               macscsi_read(instance, reg)
34 #define NCR5380_write(reg, value)       macscsi_write(instance, reg, value)
35 
36 #define NCR5380_dma_xfer_len(instance, cmd, phase) \
37         macscsi_dma_xfer_len(instance, cmd)
38 #define NCR5380_dma_recv_setup          macscsi_pread
39 #define NCR5380_dma_send_setup          macscsi_pwrite
40 #define NCR5380_dma_residual(instance)  (hostdata->pdma_residual)
41 
42 #define NCR5380_intr                    macscsi_intr
43 #define NCR5380_queue_command           macscsi_queue_command
44 #define NCR5380_abort                   macscsi_abort
45 #define NCR5380_bus_reset               macscsi_bus_reset
46 #define NCR5380_info                    macscsi_info
47 
48 #include "NCR5380.h"
49 
50 static int setup_can_queue = -1;
51 module_param(setup_can_queue, int, 0);
52 static int setup_cmd_per_lun = -1;
53 module_param(setup_cmd_per_lun, int, 0);
54 static int setup_sg_tablesize = -1;
55 module_param(setup_sg_tablesize, int, 0);
56 static int setup_use_pdma = -1;
57 module_param(setup_use_pdma, int, 0);
58 static int setup_hostid = -1;
59 module_param(setup_hostid, int, 0);
60 static int setup_toshiba_delay = -1;
61 module_param(setup_toshiba_delay, int, 0);
62 
63 /*
64  * NCR 5380 register access functions
65  */
66 
67 static inline char macscsi_read(struct Scsi_Host *instance, int reg)
68 {
69 	struct NCR5380_hostdata *hostdata = shost_priv(instance);
70 
71 	return in_8(hostdata->io + (reg << 4));
72 }
73 
74 static inline void macscsi_write(struct Scsi_Host *instance, int reg, int value)
75 {
76 	struct NCR5380_hostdata *hostdata = shost_priv(instance);
77 
78 	out_8(hostdata->io + (reg << 4), value);
79 }
80 
81 #ifndef MODULE
82 static int __init mac_scsi_setup(char *str)
83 {
84 	int ints[8];
85 
86 	(void)get_options(str, ARRAY_SIZE(ints), ints);
87 
88 	if (ints[0] < 1) {
89 		pr_err("Usage: mac5380=<can_queue>[,<cmd_per_lun>[,<sg_tablesize>[,<hostid>[,<use_tags>[,<use_pdma>[,<toshiba_delay>]]]]]]\n");
90 		return 0;
91 	}
92 	if (ints[0] >= 1)
93 		setup_can_queue = ints[1];
94 	if (ints[0] >= 2)
95 		setup_cmd_per_lun = ints[2];
96 	if (ints[0] >= 3)
97 		setup_sg_tablesize = ints[3];
98 	if (ints[0] >= 4)
99 		setup_hostid = ints[4];
100 	/* ints[5] (use_tagged_queuing) is ignored */
101 	if (ints[0] >= 6)
102 		setup_use_pdma = ints[6];
103 	if (ints[0] >= 7)
104 		setup_toshiba_delay = ints[7];
105 	return 1;
106 }
107 
108 __setup("mac5380=", mac_scsi_setup);
109 #endif /* !MODULE */
110 
111 /* Pseudo DMA asm originally by Ove Edlund */
112 
113 #define CP_IO_TO_MEM(s,d,n)				\
114 __asm__ __volatile__					\
115     ("    cmp.w  #4,%2\n"				\
116      "    bls    8f\n"					\
117      "    move.w %1,%%d0\n"				\
118      "    neg.b  %%d0\n"				\
119      "    and.w  #3,%%d0\n"				\
120      "    sub.w  %%d0,%2\n"				\
121      "    bra    2f\n"					\
122      " 1: move.b (%0),(%1)+\n"				\
123      " 2: dbf    %%d0,1b\n"				\
124      "    move.w %2,%%d0\n"				\
125      "    lsr.w  #5,%%d0\n"				\
126      "    bra    4f\n"					\
127      " 3: move.l (%0),(%1)+\n"				\
128      "31: move.l (%0),(%1)+\n"				\
129      "32: move.l (%0),(%1)+\n"				\
130      "33: move.l (%0),(%1)+\n"				\
131      "34: move.l (%0),(%1)+\n"				\
132      "35: move.l (%0),(%1)+\n"				\
133      "36: move.l (%0),(%1)+\n"				\
134      "37: move.l (%0),(%1)+\n"				\
135      " 4: dbf    %%d0,3b\n"				\
136      "    move.w %2,%%d0\n"				\
137      "    lsr.w  #2,%%d0\n"				\
138      "    and.w  #7,%%d0\n"				\
139      "    bra    6f\n"					\
140      " 5: move.l (%0),(%1)+\n"				\
141      " 6: dbf    %%d0,5b\n"				\
142      "    and.w  #3,%2\n"				\
143      "    bra    8f\n"					\
144      " 7: move.b (%0),(%1)+\n"				\
145      " 8: dbf    %2,7b\n"				\
146      "    moveq.l #0, %2\n"				\
147      " 9: \n"						\
148      ".section .fixup,\"ax\"\n"				\
149      "    .even\n"					\
150      "91: moveq.l #1, %2\n"				\
151      "    jra 9b\n"					\
152      "94: moveq.l #4, %2\n"				\
153      "    jra 9b\n"					\
154      ".previous\n"					\
155      ".section __ex_table,\"a\"\n"			\
156      "   .align 4\n"					\
157      "   .long  1b,91b\n"				\
158      "   .long  3b,94b\n"				\
159      "   .long 31b,94b\n"				\
160      "   .long 32b,94b\n"				\
161      "   .long 33b,94b\n"				\
162      "   .long 34b,94b\n"				\
163      "   .long 35b,94b\n"				\
164      "   .long 36b,94b\n"				\
165      "   .long 37b,94b\n"				\
166      "   .long  5b,94b\n"				\
167      "   .long  7b,91b\n"				\
168      ".previous"					\
169      : "=a"(s), "=a"(d), "=d"(n)			\
170      : "0"(s), "1"(d), "2"(n)				\
171      : "d0")
172 
173 static int macscsi_pread(struct Scsi_Host *instance,
174                          unsigned char *dst, int len)
175 {
176 	struct NCR5380_hostdata *hostdata = shost_priv(instance);
177 	unsigned char *s = hostdata->pdma_io + (INPUT_DATA_REG << 4);
178 	unsigned char *d = dst;
179 	int n = len;
180 	int transferred;
181 
182 	while (!NCR5380_poll_politely(instance, BUS_AND_STATUS_REG,
183 	                              BASR_DRQ | BASR_PHASE_MATCH,
184 	                              BASR_DRQ | BASR_PHASE_MATCH, HZ / 64)) {
185 		CP_IO_TO_MEM(s, d, n);
186 
187 		transferred = d - dst - n;
188 		hostdata->pdma_residual = len - transferred;
189 
190 		/* No bus error. */
191 		if (n == 0)
192 			return 0;
193 
194 		/* Target changed phase early? */
195 		if (NCR5380_poll_politely2(instance, STATUS_REG, SR_REQ, SR_REQ,
196 		                           BUS_AND_STATUS_REG, BASR_ACK, BASR_ACK, HZ / 64) < 0)
197 			scmd_printk(KERN_ERR, hostdata->connected,
198 			            "%s: !REQ and !ACK\n", __func__);
199 		if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
200 			return 0;
201 
202 		dsprintk(NDEBUG_PSEUDO_DMA, instance,
203 		         "%s: bus error (%d/%d)\n", __func__, transferred, len);
204 		NCR5380_dprint(NDEBUG_PSEUDO_DMA, instance);
205 		d = dst + transferred;
206 		n = len - transferred;
207 	}
208 
209 	scmd_printk(KERN_ERR, hostdata->connected,
210 	            "%s: phase mismatch or !DRQ\n", __func__);
211 	NCR5380_dprint(NDEBUG_PSEUDO_DMA, instance);
212 	return -1;
213 }
214 
215 
216 #define CP_MEM_TO_IO(s,d,n)				\
217 __asm__ __volatile__					\
218     ("    cmp.w  #4,%2\n"				\
219      "    bls    8f\n"					\
220      "    move.w %0,%%d0\n"				\
221      "    neg.b  %%d0\n"				\
222      "    and.w  #3,%%d0\n"				\
223      "    sub.w  %%d0,%2\n"				\
224      "    bra    2f\n"					\
225      " 1: move.b (%0)+,(%1)\n"				\
226      " 2: dbf    %%d0,1b\n"				\
227      "    move.w %2,%%d0\n"				\
228      "    lsr.w  #5,%%d0\n"				\
229      "    bra    4f\n"					\
230      " 3: move.l (%0)+,(%1)\n"				\
231      "31: move.l (%0)+,(%1)\n"				\
232      "32: move.l (%0)+,(%1)\n"				\
233      "33: move.l (%0)+,(%1)\n"				\
234      "34: move.l (%0)+,(%1)\n"				\
235      "35: move.l (%0)+,(%1)\n"				\
236      "36: move.l (%0)+,(%1)\n"				\
237      "37: move.l (%0)+,(%1)\n"				\
238      " 4: dbf    %%d0,3b\n"				\
239      "    move.w %2,%%d0\n"				\
240      "    lsr.w  #2,%%d0\n"				\
241      "    and.w  #7,%%d0\n"				\
242      "    bra    6f\n"					\
243      " 5: move.l (%0)+,(%1)\n"				\
244      " 6: dbf    %%d0,5b\n"				\
245      "    and.w  #3,%2\n"				\
246      "    bra    8f\n"					\
247      " 7: move.b (%0)+,(%1)\n"				\
248      " 8: dbf    %2,7b\n"				\
249      "    moveq.l #0, %2\n"				\
250      " 9: \n"						\
251      ".section .fixup,\"ax\"\n"				\
252      "    .even\n"					\
253      "91: moveq.l #1, %2\n"				\
254      "    jra 9b\n"					\
255      "94: moveq.l #4, %2\n"				\
256      "    jra 9b\n"					\
257      ".previous\n"					\
258      ".section __ex_table,\"a\"\n"			\
259      "   .align 4\n"					\
260      "   .long  1b,91b\n"				\
261      "   .long  3b,94b\n"				\
262      "   .long 31b,94b\n"				\
263      "   .long 32b,94b\n"				\
264      "   .long 33b,94b\n"				\
265      "   .long 34b,94b\n"				\
266      "   .long 35b,94b\n"				\
267      "   .long 36b,94b\n"				\
268      "   .long 37b,94b\n"				\
269      "   .long  5b,94b\n"				\
270      "   .long  7b,91b\n"				\
271      ".previous"					\
272      : "=a"(s), "=a"(d), "=d"(n)			\
273      : "0"(s), "1"(d), "2"(n)				\
274      : "d0")
275 
276 static int macscsi_pwrite(struct Scsi_Host *instance,
277                           unsigned char *src, int len)
278 {
279 	struct NCR5380_hostdata *hostdata = shost_priv(instance);
280 	unsigned char *s = src;
281 	unsigned char *d = hostdata->pdma_io + (OUTPUT_DATA_REG << 4);
282 	int n = len;
283 	int transferred;
284 
285 	while (!NCR5380_poll_politely(instance, BUS_AND_STATUS_REG,
286 	                              BASR_DRQ | BASR_PHASE_MATCH,
287 	                              BASR_DRQ | BASR_PHASE_MATCH, HZ / 64)) {
288 		CP_MEM_TO_IO(s, d, n);
289 
290 		transferred = s - src - n;
291 		hostdata->pdma_residual = len - transferred;
292 
293 		/* Target changed phase early? */
294 		if (NCR5380_poll_politely2(instance, STATUS_REG, SR_REQ, SR_REQ,
295 		                           BUS_AND_STATUS_REG, BASR_ACK, BASR_ACK, HZ / 64) < 0)
296 			scmd_printk(KERN_ERR, hostdata->connected,
297 			            "%s: !REQ and !ACK\n", __func__);
298 		if (!(NCR5380_read(BUS_AND_STATUS_REG) & BASR_PHASE_MATCH))
299 			return 0;
300 
301 		/* No bus error. */
302 		if (n == 0) {
303 			if (NCR5380_poll_politely(instance, TARGET_COMMAND_REG,
304 			                          TCR_LAST_BYTE_SENT,
305 			                          TCR_LAST_BYTE_SENT, HZ / 64) < 0)
306 				scmd_printk(KERN_ERR, hostdata->connected,
307 				            "%s: Last Byte Sent timeout\n", __func__);
308 			return 0;
309 		}
310 
311 		dsprintk(NDEBUG_PSEUDO_DMA, instance,
312 		         "%s: bus error (%d/%d)\n", __func__, transferred, len);
313 		NCR5380_dprint(NDEBUG_PSEUDO_DMA, instance);
314 		s = src + transferred;
315 		n = len - transferred;
316 	}
317 
318 	scmd_printk(KERN_ERR, hostdata->connected,
319 	            "%s: phase mismatch or !DRQ\n", __func__);
320 	NCR5380_dprint(NDEBUG_PSEUDO_DMA, instance);
321 
322 	return -1;
323 }
324 
325 static int macscsi_dma_xfer_len(struct Scsi_Host *instance,
326                                 struct scsi_cmnd *cmd)
327 {
328 	struct NCR5380_hostdata *hostdata = shost_priv(instance);
329 
330 	if (hostdata->flags & FLAG_NO_PSEUDO_DMA ||
331 	    cmd->SCp.this_residual < 16)
332 		return 0;
333 
334 	return cmd->SCp.this_residual;
335 }
336 
337 #include "NCR5380.c"
338 
339 #define DRV_MODULE_NAME         "mac_scsi"
340 #define PFX                     DRV_MODULE_NAME ": "
341 
342 static struct scsi_host_template mac_scsi_template = {
343 	.module			= THIS_MODULE,
344 	.proc_name		= DRV_MODULE_NAME,
345 	.name			= "Macintosh NCR5380 SCSI",
346 	.info			= macscsi_info,
347 	.queuecommand		= macscsi_queue_command,
348 	.eh_abort_handler	= macscsi_abort,
349 	.eh_bus_reset_handler	= macscsi_bus_reset,
350 	.can_queue		= 16,
351 	.this_id		= 7,
352 	.sg_tablesize		= 1,
353 	.cmd_per_lun		= 2,
354 	.use_clustering		= DISABLE_CLUSTERING,
355 	.cmd_size		= NCR5380_CMD_SIZE,
356 	.max_sectors		= 128,
357 };
358 
359 static int __init mac_scsi_probe(struct platform_device *pdev)
360 {
361 	struct Scsi_Host *instance;
362 	struct NCR5380_hostdata *hostdata;
363 	int error;
364 	int host_flags = 0;
365 	struct resource *irq, *pio_mem, *pdma_mem = NULL;
366 
367 	pio_mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
368 	if (!pio_mem)
369 		return -ENODEV;
370 
371 	pdma_mem = platform_get_resource(pdev, IORESOURCE_MEM, 1);
372 
373 	irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
374 
375 	if (!hwreg_present((unsigned char *)pio_mem->start +
376 	                   (STATUS_REG << 4))) {
377 		pr_info(PFX "no device detected at %pap\n", &pio_mem->start);
378 		return -ENODEV;
379 	}
380 
381 	if (setup_can_queue > 0)
382 		mac_scsi_template.can_queue = setup_can_queue;
383 	if (setup_cmd_per_lun > 0)
384 		mac_scsi_template.cmd_per_lun = setup_cmd_per_lun;
385 	if (setup_sg_tablesize >= 0)
386 		mac_scsi_template.sg_tablesize = setup_sg_tablesize;
387 	if (setup_hostid >= 0)
388 		mac_scsi_template.this_id = setup_hostid & 7;
389 
390 	instance = scsi_host_alloc(&mac_scsi_template,
391 	                           sizeof(struct NCR5380_hostdata));
392 	if (!instance)
393 		return -ENOMEM;
394 
395 	if (irq)
396 		instance->irq = irq->start;
397 	else
398 		instance->irq = NO_IRQ;
399 
400 	hostdata = shost_priv(instance);
401 	hostdata->base = pio_mem->start;
402 	hostdata->io = (void *)pio_mem->start;
403 
404 	if (pdma_mem && setup_use_pdma)
405 		hostdata->pdma_io = (void *)pdma_mem->start;
406 	else
407 		host_flags |= FLAG_NO_PSEUDO_DMA;
408 
409 	host_flags |= setup_toshiba_delay > 0 ? FLAG_TOSHIBA_DELAY : 0;
410 
411 	error = NCR5380_init(instance, host_flags | FLAG_LATE_DMA_SETUP);
412 	if (error)
413 		goto fail_init;
414 
415 	if (instance->irq != NO_IRQ) {
416 		error = request_irq(instance->irq, macscsi_intr, IRQF_SHARED,
417 		                    "NCR5380", instance);
418 		if (error)
419 			goto fail_irq;
420 	}
421 
422 	NCR5380_maybe_reset_bus(instance);
423 
424 	error = scsi_add_host(instance, NULL);
425 	if (error)
426 		goto fail_host;
427 
428 	platform_set_drvdata(pdev, instance);
429 
430 	scsi_scan_host(instance);
431 	return 0;
432 
433 fail_host:
434 	if (instance->irq != NO_IRQ)
435 		free_irq(instance->irq, instance);
436 fail_irq:
437 	NCR5380_exit(instance);
438 fail_init:
439 	scsi_host_put(instance);
440 	return error;
441 }
442 
443 static int __exit mac_scsi_remove(struct platform_device *pdev)
444 {
445 	struct Scsi_Host *instance = platform_get_drvdata(pdev);
446 
447 	scsi_remove_host(instance);
448 	if (instance->irq != NO_IRQ)
449 		free_irq(instance->irq, instance);
450 	NCR5380_exit(instance);
451 	scsi_host_put(instance);
452 	return 0;
453 }
454 
455 static struct platform_driver mac_scsi_driver = {
456 	.remove = __exit_p(mac_scsi_remove),
457 	.driver = {
458 		.name	= DRV_MODULE_NAME,
459 	},
460 };
461 
462 module_platform_driver_probe(mac_scsi_driver, mac_scsi_probe);
463 
464 MODULE_ALIAS("platform:" DRV_MODULE_NAME);
465 MODULE_LICENSE("GPL");
466