3 * linux/kernel/aha1740.c
5 * Based loosely on aha1542.c which is
6 * Copyright (C) 1992 Tommy Thorn and
7 * Modified by Eric Youngdale
9 * This file is aha1740.c, written and
10 * Copyright (C) 1992,1993 Brad McLean
11 * brad@saturn.gaylord.com or brad@bradpc.gaylord.com.
13 * Modifications to makecode and queuecommand
14 * for proper handling of multiple devices courteously
15 * provided by Michael Weller, March, 1993
17 * Multiple adapter support, extended translation detection,
18 * update to current scsi subsystem changes, proc fs support,
19 * working (!) module support based on patches from Andreas Arens,
20 * by Andreas Degert <ad@papyrus.hamburg.com>, 2/1997
22 * aha1740_makecode may still need even more work
23 * if it doesn't work for your devices, take a look.
25 * Reworked for new_eh and new locking by Alan Cox <alan@lxorguk.ukuu.org.uk>
27 * Converted to EISA and generic DMA APIs by Marc Zyngier
28 * <maz@wild-wind.fr.eu.org>, 4/2003.
30 * Shared interrupt support added by Rask Ingemann Lambertsen
31 * <rask@sygehus.dk>, 10/2003
33 * For the avoidance of doubt the "preferred form" of this code is one which
34 * is in an open non patent encumbered format. Where cryptographic key signing
35 * forms part of the process of creating an executable the information
36 * including keys needed to generate an equivalently functional executable
37 * are deemed to be part of the source code.
40 #include <linux/blkdev.h>
41 #include <linux/interrupt.h>
42 #include <linux/module.h>
43 #include <linux/kernel.h>
44 #include <linux/types.h>
45 #include <linux/string.h>
46 #include <linux/ioport.h>
47 #include <linux/proc_fs.h>
48 #include <linux/stat.h>
49 #include <linux/init.h>
50 #include <linux/device.h>
51 #include <linux/eisa.h>
52 #include <linux/dma-mapping.h>
53 #include <linux/gfp.h>
59 #include <scsi/scsi_host.h>
62 /* IF YOU ARE HAVING PROBLEMS WITH THIS DRIVER, AND WANT TO WATCH
72 struct aha1740_hostdata
{
73 struct eisa_device
*edev
;
74 unsigned int translation
;
75 unsigned int last_ecb_used
;
76 dma_addr_t ecb_dma_addr
;
77 struct ecb ecb
[AHA1740_ECBS
];
81 struct aha1740_chain sg_chain
[AHA1740_SCATTER
];
82 dma_addr_t sg_dma_addr
;
83 dma_addr_t buf_dma_addr
;
86 #define HOSTDATA(host) ((struct aha1740_hostdata *) &host->hostdata)
88 static inline struct ecb
*ecb_dma_to_cpu (struct Scsi_Host
*host
,
91 struct aha1740_hostdata
*hdata
= HOSTDATA (host
);
94 offset
= dma
- hdata
->ecb_dma_addr
;
96 return (struct ecb
*)(((char *) hdata
->ecb
) + (unsigned int) offset
);
99 static inline dma_addr_t
ecb_cpu_to_dma (struct Scsi_Host
*host
, void *cpu
)
101 struct aha1740_hostdata
*hdata
= HOSTDATA (host
);
104 offset
= (char *) cpu
- (char *) hdata
->ecb
;
106 return hdata
->ecb_dma_addr
+ offset
;
109 static int aha1740_show_info(struct seq_file
*m
, struct Scsi_Host
*shpnt
)
111 struct aha1740_hostdata
*host
= HOSTDATA(shpnt
);
112 seq_printf(m
, "aha174x at IO:%lx, IRQ %d, SLOT %d.\n"
113 "Extended translation %sabled.\n",
114 shpnt
->io_port
, shpnt
->irq
, host
->edev
->slot
,
115 host
->translation
? "en" : "dis");
119 static int aha1740_makecode(unchar
*sense
, unchar
*status
)
123 ushort don
:1, /* Command Done - No Error */
124 du
:1, /* Data underrun */
125 :1, qf
:1, /* Queue full */
126 sc
:1, /* Specification Check */
127 dor
:1, /* Data overrun */
128 ch
:1, /* Chaining Halted */
129 intr
:1, /* Interrupt issued */
130 asa
:1, /* Additional Status Available */
131 sns
:1, /* Sense information Stored */
132 :1, ini
:1, /* Initialization Required */
133 me
:1, /* Major error or exception */
134 :1, eca
:1, /* Extended Contingent alliance */
139 status_word
= * (struct statusword
*) status
;
141 printk("makecode from %x,%x,%x,%x %x,%x,%x,%x",
142 status
[0], status
[1], status
[2], status
[3],
143 sense
[0], sense
[1], sense
[2], sense
[3]);
145 if (!status_word
.don
) { /* Anything abnormal was detected */
146 if ( (status
[1]&0x18) || status_word
.sc
) {
147 /*Additional info available*/
148 /* Use the supplied info for further diagnostics */
149 switch ( status
[2] ) {
151 if ( status_word
.dor
)
152 retval
=DID_ERROR
; /* It's an Overrun */
153 /* If not overrun, assume underrun and
156 case 0x00: /* No info, assume no error, should
164 retval
=DID_BAD_TARGET
;
169 /* Either by this driver or the
173 retval
=DID_ERROR
; /* No further
178 /* Michael suggests, and Brad concurs: */
179 if ( status_word
.qf
) {
180 retval
= DID_TIME_OUT
; /* forces a redo */
181 /* I think this specific one should
182 * not happen -Brad */
183 printk("aha1740.c: WARNING: AHA1740 queue overflow!\n");
185 if ( status
[0]&0x60 ) {
186 /* Didn't find a better error */
189 /* In any other case return DID_OK so for example
190 CONDITION_CHECKS make it through to the appropriate
194 /* Under all circumstances supply the target status -Michael */
195 return status
[3] | retval
<< 16;
198 static int aha1740_test_port(unsigned int base
)
200 if ( inb(PORTADR(base
)) & PORTADDR_ENH
)
201 return 1; /* Okay, we're all set */
203 printk("aha174x: Board detected, but not in enhanced mode, so disabled it.\n");
207 /* A "high" level interrupt handler */
208 static irqreturn_t
aha1740_intr_handle(int irq
, void *dev_id
)
210 struct Scsi_Host
*host
= (struct Scsi_Host
*) dev_id
;
211 void (*my_done
)(struct scsi_cmnd
*);
212 int errstatus
, adapstat
;
215 struct scsi_cmnd
*SCtmp
;
219 struct aha1740_sg
*sgptr
;
220 struct eisa_device
*edev
;
223 panic("aha1740.c: Irq from unknown host!\n");
224 spin_lock_irqsave(host
->host_lock
, flags
);
225 base
= host
->io_port
;
227 edev
= HOSTDATA(host
)->edev
;
229 while(inb(G2STAT(base
)) & G2STAT_INTPEND
) {
231 DEB(printk("aha1740_intr top of loop.\n"));
232 adapstat
= inb(G2INTST(base
));
233 ecbptr
= ecb_dma_to_cpu (host
, inl(MBOXIN0(base
)));
234 outb(G2CNTRL_IRST
,G2CNTRL(base
)); /* interrupt reset */
236 switch ( adapstat
& G2INTST_MASK
) {
237 case G2INTST_CCBRETRY
:
238 case G2INTST_CCBERROR
:
239 case G2INTST_CCBGOOD
:
240 /* Host Ready -> Mailbox in complete */
241 outb(G2CNTRL_HRDY
,G2CNTRL(base
));
243 printk("Aha1740 null ecbptr in interrupt (%x,%x,%x,%d)\n",
244 inb(G2STAT(base
)),adapstat
,
245 inb(G2INTST(base
)), number_serviced
++);
248 SCtmp
= ecbptr
->SCpnt
;
250 printk("Aha1740 null SCtmp in interrupt (%x,%x,%x,%d)\n",
251 inb(G2STAT(base
)),adapstat
,
252 inb(G2INTST(base
)), number_serviced
++);
255 sgptr
= (struct aha1740_sg
*) SCtmp
->host_scribble
;
256 scsi_dma_unmap(SCtmp
);
258 /* Free the sg block */
259 dma_free_coherent (&edev
->dev
,
260 sizeof (struct aha1740_sg
),
261 SCtmp
->host_scribble
,
264 /* Fetch the sense data, and tuck it away, in
265 the required slot. The Adaptec
266 automatically fetches it, and there is no
267 guarantee that we will still have it in the
268 cdb when we come back */
269 if ( (adapstat
& G2INTST_MASK
) == G2INTST_CCBERROR
) {
270 memcpy(SCtmp
->sense_buffer
, ecbptr
->sense
,
271 SCSI_SENSE_BUFFERSIZE
);
272 errstatus
= aha1740_makecode(ecbptr
->sense
,ecbptr
->status
);
276 printk("aha1740_intr_handle: returning %6x\n",
278 SCtmp
->result
= errstatus
;
279 my_done
= ecbptr
->done
;
280 memset(ecbptr
,0,sizeof(struct ecb
));
285 case G2INTST_HARDFAIL
:
286 printk(KERN_ALERT
"aha1740 hardware failure!\n");
287 panic("aha1740.c"); /* Goodbye */
289 case G2INTST_ASNEVENT
:
290 printk("aha1740 asynchronous event: %02x %02x %02x %02x %02x\n",
295 inb(MBOXIN3(base
))); /* Say What? */
296 /* Host Ready -> Mailbox in complete */
297 outb(G2CNTRL_HRDY
,G2CNTRL(base
));
300 case G2INTST_CMDGOOD
:
301 /* set immediate command success flag here: */
304 case G2INTST_CMDERROR
:
305 /* Set immediate command failure flag here: */
311 spin_unlock_irqrestore(host
->host_lock
, flags
);
312 return IRQ_RETVAL(handled
);
315 static int aha1740_queuecommand_lck(struct scsi_cmnd
* SCpnt
,
316 void (*done
)(struct scsi_cmnd
*))
319 unchar
*cmd
= (unchar
*) SCpnt
->cmnd
;
320 unchar target
= scmd_id(SCpnt
);
321 struct aha1740_hostdata
*host
= HOSTDATA(SCpnt
->device
->host
);
324 struct aha1740_sg
*sgptr
;
328 if(*cmd
== REQUEST_SENSE
) {
335 if (*cmd
== READ_10
|| *cmd
== WRITE_10
)
336 i
= xscsi2int(cmd
+2);
337 else if (*cmd
== READ_6
|| *cmd
== WRITE_6
)
341 printk("aha1740_queuecommand: dev %d cmd %02x pos %d len %d ",
342 target
, *cmd
, i
, bufflen
);
344 for (i
= 0; i
< SCpnt
->cmd_len
; i
++) printk("%02x ", cmd
[i
]);
348 /* locate an available ecb */
349 spin_lock_irqsave(SCpnt
->device
->host
->host_lock
, flags
);
350 ecbno
= host
->last_ecb_used
+ 1; /* An optimization */
351 if (ecbno
>= AHA1740_ECBS
)
354 if (!host
->ecb
[ecbno
].cmdw
)
357 if (ecbno
>= AHA1740_ECBS
)
359 } while (ecbno
!= host
->last_ecb_used
);
361 if (host
->ecb
[ecbno
].cmdw
)
362 panic("Unable to find empty ecb for aha1740.\n");
364 host
->ecb
[ecbno
].cmdw
= AHA1740CMD_INIT
; /* SCSI Initiator Command
365 doubles as reserved flag */
367 host
->last_ecb_used
= ecbno
;
368 spin_unlock_irqrestore(SCpnt
->device
->host
->host_lock
, flags
);
371 printk("Sending command (%d %x)...", ecbno
, done
);
374 host
->ecb
[ecbno
].cdblen
= SCpnt
->cmd_len
; /* SCSI Command
379 if (*cmd
== READ_10
|| *cmd
== READ_6
)
381 else if (*cmd
== WRITE_10
|| *cmd
== WRITE_6
)
384 memcpy(host
->ecb
[ecbno
].cdb
, cmd
, SCpnt
->cmd_len
);
386 SCpnt
->host_scribble
= dma_alloc_coherent (&host
->edev
->dev
,
387 sizeof (struct aha1740_sg
),
388 &sg_dma
, GFP_ATOMIC
);
389 if(SCpnt
->host_scribble
== NULL
) {
390 printk(KERN_WARNING
"aha1740: out of memory in queuecommand!\n");
393 sgptr
= (struct aha1740_sg
*) SCpnt
->host_scribble
;
394 sgptr
->sg_dma_addr
= sg_dma
;
396 nseg
= scsi_dma_map(SCpnt
);
399 struct scatterlist
*sg
;
400 struct aha1740_chain
* cptr
;
402 DEB(unsigned char * ptr
);
404 host
->ecb
[ecbno
].sg
= 1; /* SCSI Initiator Command
406 cptr
= sgptr
->sg_chain
;
407 scsi_for_each_sg(SCpnt
, sg
, nseg
, i
) {
408 cptr
[i
].datalen
= sg_dma_len (sg
);
409 cptr
[i
].dataptr
= sg_dma_address (sg
);
411 host
->ecb
[ecbno
].datalen
= nseg
* sizeof(struct aha1740_chain
);
412 host
->ecb
[ecbno
].dataptr
= sg_dma
;
414 printk("cptr %x: ",cptr
);
415 ptr
= (unsigned char *) cptr
;
416 for(i
=0;i
<24;i
++) printk("%02x ", ptr
[i
]);
419 host
->ecb
[ecbno
].datalen
= 0;
420 host
->ecb
[ecbno
].dataptr
= 0;
422 host
->ecb
[ecbno
].lun
= SCpnt
->device
->lun
;
423 host
->ecb
[ecbno
].ses
= 1; /* Suppress underrun errors */
424 host
->ecb
[ecbno
].dir
= direction
;
425 host
->ecb
[ecbno
].ars
= 1; /* Yes, get the sense on an error */
426 host
->ecb
[ecbno
].senselen
= 12;
427 host
->ecb
[ecbno
].senseptr
= ecb_cpu_to_dma (SCpnt
->device
->host
,
428 host
->ecb
[ecbno
].sense
);
429 host
->ecb
[ecbno
].statusptr
= ecb_cpu_to_dma (SCpnt
->device
->host
,
430 host
->ecb
[ecbno
].status
);
431 host
->ecb
[ecbno
].done
= done
;
432 host
->ecb
[ecbno
].SCpnt
= SCpnt
;
436 printk("aha1740_command: sending.. ");
437 for (i
= 0; i
< sizeof(host
->ecb
[ecbno
]) - 10; i
++)
438 printk("%02x ", ((unchar
*)&host
->ecb
[ecbno
])[i
]);
443 /* The Adaptec Spec says the card is so fast that the loops
444 will only be executed once in the code below. Even if this
445 was true with the fastest processors when the spec was
446 written, it doesn't seem to be true with today's fast
447 processors. We print a warning if the code is executed more
448 often than LOOPCNT_WARN. If this happens, it should be
449 investigated. If the count reaches LOOPCNT_MAX, we assume
450 something is broken; since there is no way to return an
451 error (the return value is ignored by the mid-level scsi
452 layer) we have to panic (and maybe that's the best thing we
453 can do then anyhow). */
455 #define LOOPCNT_WARN 10 /* excessive mbxout wait -> syslog-msg */
456 #define LOOPCNT_MAX 1000000 /* mbxout deadlock -> panic() after ~ 2 sec. */
458 unsigned int base
= SCpnt
->device
->host
->io_port
;
459 DEB(printk("aha1740[%d] critical section\n",ecbno
));
461 spin_lock_irqsave(SCpnt
->device
->host
->host_lock
, flags
);
462 for (loopcnt
= 0; ; loopcnt
++) {
463 if (inb(G2STAT(base
)) & G2STAT_MBXOUT
) break;
464 if (loopcnt
== LOOPCNT_WARN
) {
465 printk("aha1740[%d]_mbxout wait!\n",ecbno
);
467 if (loopcnt
== LOOPCNT_MAX
)
468 panic("aha1740.c: mbxout busy!\n");
470 outl (ecb_cpu_to_dma (SCpnt
->device
->host
, host
->ecb
+ ecbno
),
472 for (loopcnt
= 0; ; loopcnt
++) {
473 if (! (inb(G2STAT(base
)) & G2STAT_BUSY
)) break;
474 if (loopcnt
== LOOPCNT_WARN
) {
475 printk("aha1740[%d]_attn wait!\n",ecbno
);
477 if (loopcnt
== LOOPCNT_MAX
)
478 panic("aha1740.c: attn wait failed!\n");
480 outb(ATTN_START
| (target
& 7), ATTN(base
)); /* Start it up */
481 spin_unlock_irqrestore(SCpnt
->device
->host
->host_lock
, flags
);
482 DEB(printk("aha1740[%d] request queued.\n",ecbno
));
484 printk(KERN_ALERT
"aha1740_queuecommand: done can't be NULL\n");
488 static DEF_SCSI_QCMD(aha1740_queuecommand
)
490 /* Query the board for its irq_level and irq_type. Nothing else matters
491 in enhanced mode on an EISA bus. */
493 static void aha1740_getconfig(unsigned int base
, unsigned int *irq_level
,
494 unsigned int *irq_type
,
495 unsigned int *translation
)
497 static int intab
[] = { 9, 10, 11, 12, 0, 14, 15, 0 };
499 *irq_level
= intab
[inb(INTDEF(base
)) & 0x7];
500 *irq_type
= (inb(INTDEF(base
)) & 0x8) >> 3;
501 *translation
= inb(RESV1(base
)) & 0x1;
502 outb(inb(INTDEF(base
)) | 0x10, INTDEF(base
));
505 static int aha1740_biosparam(struct scsi_device
*sdev
,
506 struct block_device
*dev
,
507 sector_t capacity
, int* ip
)
510 int extended
= HOSTDATA(sdev
->host
)->translation
;
512 DEB(printk("aha1740_biosparam\n"));
513 if (extended
&& (ip
[2] > 1024)) {
516 ip
[2] = size
/ (255 * 63);
525 static int aha1740_eh_abort_handler (struct scsi_cmnd
*dummy
)
529 * The AHA1740 has firmware handled abort/reset handling. The "head in
530 * sand" kernel code is correct for once 8)
532 * So we define a dummy handler just to keep the kernel SCSI code as
533 * quiet as possible...
539 static struct scsi_host_template aha1740_template
= {
540 .module
= THIS_MODULE
,
541 .proc_name
= "aha1740",
542 .show_info
= aha1740_show_info
,
543 .name
= "Adaptec 174x (EISA)",
544 .queuecommand
= aha1740_queuecommand
,
545 .bios_param
= aha1740_biosparam
,
546 .can_queue
= AHA1740_ECBS
,
548 .sg_tablesize
= AHA1740_SCATTER
,
549 .eh_abort_handler
= aha1740_eh_abort_handler
,
552 static int aha1740_probe (struct device
*dev
)
555 unsigned int irq_level
, irq_type
, translation
;
556 struct Scsi_Host
*shpnt
;
557 struct aha1740_hostdata
*host
;
558 struct eisa_device
*edev
= to_eisa_device (dev
);
560 DEB(printk("aha1740_probe: \n"));
562 slotbase
= edev
->base_addr
+ EISA_VENDOR_ID_OFFSET
;
563 if (!request_region(slotbase
, SLOTSIZE
, "aha1740")) /* See if in use */
565 if (!aha1740_test_port(slotbase
))
566 goto err_release_region
;
567 aha1740_getconfig(slotbase
,&irq_level
,&irq_type
,&translation
);
568 if ((inb(G2STAT(slotbase
)) &
569 (G2STAT_MBXOUT
|G2STAT_BUSY
)) != G2STAT_MBXOUT
) {
570 /* If the card isn't ready, hard reset it */
571 outb(G2CNTRL_HRST
, G2CNTRL(slotbase
));
572 outb(0, G2CNTRL(slotbase
));
574 printk(KERN_INFO
"Configuring slot %d at IO:%x, IRQ %u (%s)\n",
575 edev
->slot
, slotbase
, irq_level
, irq_type
? "edge" : "level");
576 printk(KERN_INFO
"aha174x: Extended translation %sabled.\n",
577 translation
? "en" : "dis");
578 shpnt
= scsi_host_alloc(&aha1740_template
,
579 sizeof(struct aha1740_hostdata
));
581 goto err_release_region
;
584 shpnt
->io_port
= slotbase
;
585 shpnt
->n_io_port
= SLOTSIZE
;
586 shpnt
->irq
= irq_level
;
587 shpnt
->dma_channel
= 0xff;
588 host
= HOSTDATA(shpnt
);
590 host
->translation
= translation
;
591 host
->ecb_dma_addr
= dma_map_single (&edev
->dev
, host
->ecb
,
594 if (!host
->ecb_dma_addr
) {
595 printk (KERN_ERR
"aha1740_probe: Couldn't map ECB, giving up\n");
599 DEB(printk("aha1740_probe: enable interrupt channel %d\n",irq_level
));
600 if (request_irq(irq_level
,aha1740_intr_handle
,irq_type
? 0 : IRQF_SHARED
,
602 printk(KERN_ERR
"aha1740_probe: Unable to allocate IRQ %d.\n",
607 eisa_set_drvdata (edev
, shpnt
);
609 rc
= scsi_add_host (shpnt
, dev
);
613 scsi_scan_host (shpnt
);
617 free_irq(irq_level
, shpnt
);
619 dma_unmap_single (&edev
->dev
, host
->ecb_dma_addr
,
620 sizeof (host
->ecb
), DMA_BIDIRECTIONAL
);
622 scsi_host_put (shpnt
);
624 release_region(slotbase
, SLOTSIZE
);
629 static int aha1740_remove (struct device
*dev
)
631 struct Scsi_Host
*shpnt
= dev_get_drvdata(dev
);
632 struct aha1740_hostdata
*host
= HOSTDATA (shpnt
);
634 scsi_remove_host(shpnt
);
636 free_irq (shpnt
->irq
, shpnt
);
637 dma_unmap_single (dev
, host
->ecb_dma_addr
,
638 sizeof (host
->ecb
), DMA_BIDIRECTIONAL
);
639 release_region (shpnt
->io_port
, SLOTSIZE
);
641 scsi_host_put (shpnt
);
646 static struct eisa_device_id aha1740_ids
[] = {
647 { "ADP0000" }, /* 1740 */
648 { "ADP0001" }, /* 1740A */
649 { "ADP0002" }, /* 1742A */
650 { "ADP0400" }, /* 1744 */
653 MODULE_DEVICE_TABLE(eisa
, aha1740_ids
);
655 static struct eisa_driver aha1740_driver
= {
656 .id_table
= aha1740_ids
,
659 .probe
= aha1740_probe
,
660 .remove
= aha1740_remove
,
664 static __init
int aha1740_init (void)
666 return eisa_driver_register (&aha1740_driver
);
669 static __exit
void aha1740_exit (void)
671 eisa_driver_unregister (&aha1740_driver
);
674 module_init (aha1740_init
);
675 module_exit (aha1740_exit
);
677 MODULE_LICENSE("GPL");