]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame_incremental - drivers/scsi/sun3_scsi.c
scsi: ncr5380: Expedite register polling
[mirror_ubuntu-jammy-kernel.git] / drivers / scsi / sun3_scsi.c
... / ...
CommitLineData
1/*
2 * Sun3 SCSI stuff by Erik Verbruggen (erik@bigmama.xtdnet.nl)
3 *
4 * Sun3 DMA routines added by Sam Creasey (sammy@sammy.net)
5 *
6 * VME support added by Sam Creasey
7 *
8 * TODO: modify this driver to support multiple Sun3 SCSI VME boards
9 *
10 * Adapted from mac_scsinew.c:
11 */
12/*
13 * Generic Macintosh NCR5380 driver
14 *
15 * Copyright 1998, Michael Schmitz <mschmitz@lbl.gov>
16 *
17 * derived in part from:
18 */
19/*
20 * Generic Generic NCR5380 driver
21 *
22 * Copyright 1995, Russell King
23 */
24
25#include <linux/types.h>
26#include <linux/delay.h>
27#include <linux/module.h>
28#include <linux/ioport.h>
29#include <linux/init.h>
30#include <linux/blkdev.h>
31#include <linux/platform_device.h>
32
33#include <asm/io.h>
34#include <asm/dvma.h>
35
36#include <scsi/scsi_host.h>
37#include "sun3_scsi.h"
38
39/* minimum number of bytes to do dma on */
40#define DMA_MIN_SIZE 129
41
42/* Definitions for the core NCR5380 driver. */
43
44#define NCR5380_implementation_fields /* none */
45
46#define NCR5380_read(reg) in_8(hostdata->io + (reg))
47#define NCR5380_write(reg, value) out_8(hostdata->io + (reg), value)
48
49#define NCR5380_queue_command sun3scsi_queue_command
50#define NCR5380_bus_reset sun3scsi_bus_reset
51#define NCR5380_abort sun3scsi_abort
52#define NCR5380_info sun3scsi_info
53
54#define NCR5380_dma_recv_setup(instance, data, count) (count)
55#define NCR5380_dma_send_setup(instance, data, count) (count)
56#define NCR5380_dma_residual(instance) \
57 sun3scsi_dma_residual(instance)
58#define NCR5380_dma_xfer_len(instance, cmd, phase) \
59 sun3scsi_dma_xfer_len(cmd->SCp.this_residual, cmd)
60
61#define NCR5380_acquire_dma_irq(instance) (1)
62#define NCR5380_release_dma_irq(instance)
63
64#include "NCR5380.h"
65
66
67extern int sun3_map_test(unsigned long, char *);
68
69static int setup_can_queue = -1;
70module_param(setup_can_queue, int, 0);
71static int setup_cmd_per_lun = -1;
72module_param(setup_cmd_per_lun, int, 0);
73static int setup_sg_tablesize = -1;
74module_param(setup_sg_tablesize, int, 0);
75static int setup_hostid = -1;
76module_param(setup_hostid, int, 0);
77
78/* ms to wait after hitting dma regs */
79#define SUN3_DMA_DELAY 10
80
81/* dvma buffer to allocate -- 32k should hopefully be more than sufficient */
82#define SUN3_DVMA_BUFSIZE 0xe000
83
84static struct scsi_cmnd *sun3_dma_setup_done;
85static volatile struct sun3_dma_regs *dregs;
86static struct sun3_udc_regs *udc_regs;
87static unsigned char *sun3_dma_orig_addr;
88static unsigned long sun3_dma_orig_count;
89static int sun3_dma_active;
90static unsigned long last_residual;
91
92#ifndef SUN3_SCSI_VME
93/* dma controller register access functions */
94
95static inline unsigned short sun3_udc_read(unsigned char reg)
96{
97 unsigned short ret;
98
99 dregs->udc_addr = UDC_CSR;
100 udelay(SUN3_DMA_DELAY);
101 ret = dregs->udc_data;
102 udelay(SUN3_DMA_DELAY);
103
104 return ret;
105}
106
107static inline void sun3_udc_write(unsigned short val, unsigned char reg)
108{
109 dregs->udc_addr = reg;
110 udelay(SUN3_DMA_DELAY);
111 dregs->udc_data = val;
112 udelay(SUN3_DMA_DELAY);
113}
114#endif
115
116// safe bits for the CSR
117#define CSR_GOOD 0x060f
118
119static irqreturn_t scsi_sun3_intr(int irq, void *dev)
120{
121 struct Scsi_Host *instance = dev;
122 unsigned short csr = dregs->csr;
123 int handled = 0;
124
125#ifdef SUN3_SCSI_VME
126 dregs->csr &= ~CSR_DMA_ENABLE;
127#endif
128
129 if(csr & ~CSR_GOOD) {
130 if (csr & CSR_DMA_BUSERR)
131 shost_printk(KERN_ERR, instance, "bus error in DMA\n");
132 if (csr & CSR_DMA_CONFLICT)
133 shost_printk(KERN_ERR, instance, "DMA conflict\n");
134 handled = 1;
135 }
136
137 if(csr & (CSR_SDB_INT | CSR_DMA_INT)) {
138 NCR5380_intr(irq, dev);
139 handled = 1;
140 }
141
142 return IRQ_RETVAL(handled);
143}
144
145/* sun3scsi_dma_setup() -- initialize the dma controller for a read/write */
146static unsigned long sun3scsi_dma_setup(struct Scsi_Host *instance,
147 void *data, unsigned long count, int write_flag)
148{
149 void *addr;
150
151 if(sun3_dma_orig_addr != NULL)
152 dvma_unmap(sun3_dma_orig_addr);
153
154#ifdef SUN3_SCSI_VME
155 addr = (void *)dvma_map_vme((unsigned long) data, count);
156#else
157 addr = (void *)dvma_map((unsigned long) data, count);
158#endif
159
160 sun3_dma_orig_addr = addr;
161 sun3_dma_orig_count = count;
162
163#ifndef SUN3_SCSI_VME
164 dregs->fifo_count = 0;
165 sun3_udc_write(UDC_RESET, UDC_CSR);
166
167 /* reset fifo */
168 dregs->csr &= ~CSR_FIFO;
169 dregs->csr |= CSR_FIFO;
170#endif
171
172 /* set direction */
173 if(write_flag)
174 dregs->csr |= CSR_SEND;
175 else
176 dregs->csr &= ~CSR_SEND;
177
178#ifdef SUN3_SCSI_VME
179 dregs->csr |= CSR_PACK_ENABLE;
180
181 dregs->dma_addr_hi = ((unsigned long)addr >> 16);
182 dregs->dma_addr_lo = ((unsigned long)addr & 0xffff);
183
184 dregs->dma_count_hi = 0;
185 dregs->dma_count_lo = 0;
186 dregs->fifo_count_hi = 0;
187 dregs->fifo_count = 0;
188#else
189 /* byte count for fifo */
190 dregs->fifo_count = count;
191
192 sun3_udc_write(UDC_RESET, UDC_CSR);
193
194 /* reset fifo */
195 dregs->csr &= ~CSR_FIFO;
196 dregs->csr |= CSR_FIFO;
197
198 if(dregs->fifo_count != count) {
199 shost_printk(KERN_ERR, instance, "FIFO mismatch %04x not %04x\n",
200 dregs->fifo_count, (unsigned int) count);
201 NCR5380_dprint(NDEBUG_DMA, instance);
202 }
203
204 /* setup udc */
205 udc_regs->addr_hi = (((unsigned long)(addr) & 0xff0000) >> 8);
206 udc_regs->addr_lo = ((unsigned long)(addr) & 0xffff);
207 udc_regs->count = count/2; /* count in words */
208 udc_regs->mode_hi = UDC_MODE_HIWORD;
209 if(write_flag) {
210 if(count & 1)
211 udc_regs->count++;
212 udc_regs->mode_lo = UDC_MODE_LSEND;
213 udc_regs->rsel = UDC_RSEL_SEND;
214 } else {
215 udc_regs->mode_lo = UDC_MODE_LRECV;
216 udc_regs->rsel = UDC_RSEL_RECV;
217 }
218
219 /* announce location of regs block */
220 sun3_udc_write(((dvma_vtob(udc_regs) & 0xff0000) >> 8),
221 UDC_CHN_HI);
222
223 sun3_udc_write((dvma_vtob(udc_regs) & 0xffff), UDC_CHN_LO);
224
225 /* set dma master on */
226 sun3_udc_write(0xd, UDC_MODE);
227
228 /* interrupt enable */
229 sun3_udc_write(UDC_INT_ENABLE, UDC_CSR);
230#endif
231
232 return count;
233
234}
235
236static inline unsigned long sun3scsi_dma_residual(struct Scsi_Host *instance)
237{
238 return last_residual;
239}
240
241static inline unsigned long sun3scsi_dma_xfer_len(unsigned long wanted_len,
242 struct scsi_cmnd *cmd)
243{
244 if (wanted_len < DMA_MIN_SIZE || cmd->request->cmd_type != REQ_TYPE_FS)
245 return 0;
246
247 return wanted_len;
248}
249
250static inline int sun3scsi_dma_start(unsigned long count, unsigned char *data)
251{
252#ifdef SUN3_SCSI_VME
253 unsigned short csr;
254
255 csr = dregs->csr;
256
257 dregs->dma_count_hi = (sun3_dma_orig_count >> 16);
258 dregs->dma_count_lo = (sun3_dma_orig_count & 0xffff);
259
260 dregs->fifo_count_hi = (sun3_dma_orig_count >> 16);
261 dregs->fifo_count = (sun3_dma_orig_count & 0xffff);
262
263/* if(!(csr & CSR_DMA_ENABLE))
264 * dregs->csr |= CSR_DMA_ENABLE;
265 */
266#else
267 sun3_udc_write(UDC_CHN_START, UDC_CSR);
268#endif
269
270 return 0;
271}
272
273/* clean up after our dma is done */
274static int sun3scsi_dma_finish(int write_flag)
275{
276 unsigned short __maybe_unused count;
277 unsigned short fifo;
278 int ret = 0;
279
280 sun3_dma_active = 0;
281
282#ifdef SUN3_SCSI_VME
283 dregs->csr &= ~CSR_DMA_ENABLE;
284
285 fifo = dregs->fifo_count;
286 if (write_flag) {
287 if ((fifo > 0) && (fifo < sun3_dma_orig_count))
288 fifo++;
289 }
290
291 last_residual = fifo;
292 /* empty bytes from the fifo which didn't make it */
293 if ((!write_flag) && (dregs->csr & CSR_LEFT)) {
294 unsigned char *vaddr;
295
296 vaddr = (unsigned char *)dvma_vmetov(sun3_dma_orig_addr);
297
298 vaddr += (sun3_dma_orig_count - fifo);
299 vaddr--;
300
301 switch (dregs->csr & CSR_LEFT) {
302 case CSR_LEFT_3:
303 *vaddr = (dregs->bpack_lo & 0xff00) >> 8;
304 vaddr--;
305
306 case CSR_LEFT_2:
307 *vaddr = (dregs->bpack_hi & 0x00ff);
308 vaddr--;
309
310 case CSR_LEFT_1:
311 *vaddr = (dregs->bpack_hi & 0xff00) >> 8;
312 break;
313 }
314 }
315#else
316 // check to empty the fifo on a read
317 if(!write_flag) {
318 int tmo = 20000; /* .2 sec */
319
320 while(1) {
321 if(dregs->csr & CSR_FIFO_EMPTY)
322 break;
323
324 if(--tmo <= 0) {
325 printk("sun3scsi: fifo failed to empty!\n");
326 return 1;
327 }
328 udelay(10);
329 }
330 }
331
332 dregs->udc_addr = 0x32;
333 udelay(SUN3_DMA_DELAY);
334 count = 2 * dregs->udc_data;
335 udelay(SUN3_DMA_DELAY);
336
337 fifo = dregs->fifo_count;
338 last_residual = fifo;
339
340 /* empty bytes from the fifo which didn't make it */
341 if((!write_flag) && (count - fifo) == 2) {
342 unsigned short data;
343 unsigned char *vaddr;
344
345 data = dregs->fifo_data;
346 vaddr = (unsigned char *)dvma_btov(sun3_dma_orig_addr);
347
348 vaddr += (sun3_dma_orig_count - fifo);
349
350 vaddr[-2] = (data & 0xff00) >> 8;
351 vaddr[-1] = (data & 0xff);
352 }
353#endif
354
355 dvma_unmap(sun3_dma_orig_addr);
356 sun3_dma_orig_addr = NULL;
357
358#ifdef SUN3_SCSI_VME
359 dregs->dma_addr_hi = 0;
360 dregs->dma_addr_lo = 0;
361 dregs->dma_count_hi = 0;
362 dregs->dma_count_lo = 0;
363
364 dregs->fifo_count = 0;
365 dregs->fifo_count_hi = 0;
366
367 dregs->csr &= ~CSR_SEND;
368/* dregs->csr |= CSR_DMA_ENABLE; */
369#else
370 sun3_udc_write(UDC_RESET, UDC_CSR);
371 dregs->fifo_count = 0;
372 dregs->csr &= ~CSR_SEND;
373
374 /* reset fifo */
375 dregs->csr &= ~CSR_FIFO;
376 dregs->csr |= CSR_FIFO;
377#endif
378
379 sun3_dma_setup_done = NULL;
380
381 return ret;
382
383}
384
385#include "NCR5380.c"
386
387#ifdef SUN3_SCSI_VME
388#define SUN3_SCSI_NAME "Sun3 NCR5380 VME SCSI"
389#define DRV_MODULE_NAME "sun3_scsi_vme"
390#else
391#define SUN3_SCSI_NAME "Sun3 NCR5380 SCSI"
392#define DRV_MODULE_NAME "sun3_scsi"
393#endif
394
395#define PFX DRV_MODULE_NAME ": "
396
397static struct scsi_host_template sun3_scsi_template = {
398 .module = THIS_MODULE,
399 .proc_name = DRV_MODULE_NAME,
400 .name = SUN3_SCSI_NAME,
401 .info = sun3scsi_info,
402 .queuecommand = sun3scsi_queue_command,
403 .eh_abort_handler = sun3scsi_abort,
404 .eh_bus_reset_handler = sun3scsi_bus_reset,
405 .can_queue = 16,
406 .this_id = 7,
407 .sg_tablesize = SG_NONE,
408 .cmd_per_lun = 2,
409 .use_clustering = DISABLE_CLUSTERING,
410 .cmd_size = NCR5380_CMD_SIZE,
411};
412
413static int __init sun3_scsi_probe(struct platform_device *pdev)
414{
415 struct Scsi_Host *instance;
416 struct NCR5380_hostdata *hostdata;
417 int error;
418 struct resource *irq, *mem;
419 void __iomem *ioaddr;
420 int host_flags = 0;
421#ifdef SUN3_SCSI_VME
422 int i;
423#endif
424
425 if (setup_can_queue > 0)
426 sun3_scsi_template.can_queue = setup_can_queue;
427 if (setup_cmd_per_lun > 0)
428 sun3_scsi_template.cmd_per_lun = setup_cmd_per_lun;
429 if (setup_sg_tablesize >= 0)
430 sun3_scsi_template.sg_tablesize = setup_sg_tablesize;
431 if (setup_hostid >= 0)
432 sun3_scsi_template.this_id = setup_hostid & 7;
433
434#ifdef SUN3_SCSI_VME
435 ioaddr = NULL;
436 for (i = 0; i < 2; i++) {
437 unsigned char x;
438
439 irq = platform_get_resource(pdev, IORESOURCE_IRQ, i);
440 mem = platform_get_resource(pdev, IORESOURCE_MEM, i);
441 if (!irq || !mem)
442 break;
443
444 ioaddr = sun3_ioremap(mem->start, resource_size(mem),
445 SUN3_PAGE_TYPE_VME16);
446 dregs = (struct sun3_dma_regs *)(ioaddr + 8);
447
448 if (sun3_map_test((unsigned long)dregs, &x)) {
449 unsigned short oldcsr;
450
451 oldcsr = dregs->csr;
452 dregs->csr = 0;
453 udelay(SUN3_DMA_DELAY);
454 if (dregs->csr == 0x1400)
455 break;
456
457 dregs->csr = oldcsr;
458 }
459
460 iounmap(ioaddr);
461 ioaddr = NULL;
462 }
463 if (!ioaddr)
464 return -ENODEV;
465#else
466 irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
467 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
468 if (!irq || !mem)
469 return -ENODEV;
470
471 ioaddr = ioremap(mem->start, resource_size(mem));
472 dregs = (struct sun3_dma_regs *)(ioaddr + 8);
473
474 udc_regs = dvma_malloc(sizeof(struct sun3_udc_regs));
475 if (!udc_regs) {
476 pr_err(PFX "couldn't allocate DVMA memory!\n");
477 iounmap(ioaddr);
478 return -ENOMEM;
479 }
480#endif
481
482 instance = scsi_host_alloc(&sun3_scsi_template,
483 sizeof(struct NCR5380_hostdata));
484 if (!instance) {
485 error = -ENOMEM;
486 goto fail_alloc;
487 }
488
489 instance->irq = irq->start;
490
491 hostdata = shost_priv(instance);
492 hostdata->base = mem->start;
493 hostdata->io = ioaddr;
494
495 error = NCR5380_init(instance, host_flags);
496 if (error)
497 goto fail_init;
498
499 error = request_irq(instance->irq, scsi_sun3_intr, 0,
500 "NCR5380", instance);
501 if (error) {
502 pr_err(PFX "scsi%d: IRQ %d not free, bailing out\n",
503 instance->host_no, instance->irq);
504 goto fail_irq;
505 }
506
507 dregs->csr = 0;
508 udelay(SUN3_DMA_DELAY);
509 dregs->csr = CSR_SCSI | CSR_FIFO | CSR_INTR;
510 udelay(SUN3_DMA_DELAY);
511 dregs->fifo_count = 0;
512#ifdef SUN3_SCSI_VME
513 dregs->fifo_count_hi = 0;
514 dregs->dma_addr_hi = 0;
515 dregs->dma_addr_lo = 0;
516 dregs->dma_count_hi = 0;
517 dregs->dma_count_lo = 0;
518
519 dregs->ivect = VME_DATA24 | (instance->irq & 0xff);
520#endif
521
522 NCR5380_maybe_reset_bus(instance);
523
524 error = scsi_add_host(instance, NULL);
525 if (error)
526 goto fail_host;
527
528 platform_set_drvdata(pdev, instance);
529
530 scsi_scan_host(instance);
531 return 0;
532
533fail_host:
534 free_irq(instance->irq, instance);
535fail_irq:
536 NCR5380_exit(instance);
537fail_init:
538 scsi_host_put(instance);
539fail_alloc:
540 if (udc_regs)
541 dvma_free(udc_regs);
542 iounmap(ioaddr);
543 return error;
544}
545
546static int __exit sun3_scsi_remove(struct platform_device *pdev)
547{
548 struct Scsi_Host *instance = platform_get_drvdata(pdev);
549 struct NCR5380_hostdata *hostdata = shost_priv(instance);
550 void __iomem *ioaddr = hostdata->io;
551
552 scsi_remove_host(instance);
553 free_irq(instance->irq, instance);
554 NCR5380_exit(instance);
555 scsi_host_put(instance);
556 if (udc_regs)
557 dvma_free(udc_regs);
558 iounmap(ioaddr);
559 return 0;
560}
561
562static struct platform_driver sun3_scsi_driver = {
563 .remove = __exit_p(sun3_scsi_remove),
564 .driver = {
565 .name = DRV_MODULE_NAME,
566 },
567};
568
569module_platform_driver_probe(sun3_scsi_driver, sun3_scsi_probe);
570
571MODULE_ALIAS("platform:" DRV_MODULE_NAME);
572MODULE_LICENSE("GPL");