Linux 5.1.15
[linux/fpc-iii.git] / drivers / scsi / sym53c8xx_2 / sym_glue.c
blob57f6d63e4c40a8b956834e42e8680097df246f7b
1 /*
2 * Device driver for the SYMBIOS/LSILOGIC 53C8XX and 53C1010 family
3 * of PCI-SCSI IO processors.
5 * Copyright (C) 1999-2001 Gerard Roudier <groudier@free.fr>
6 * Copyright (c) 2003-2005 Matthew Wilcox <matthew@wil.cx>
8 * This driver is derived from the Linux sym53c8xx driver.
9 * Copyright (C) 1998-2000 Gerard Roudier
11 * The sym53c8xx driver is derived from the ncr53c8xx driver that had been
12 * a port of the FreeBSD ncr driver to Linux-1.2.13.
14 * The original ncr driver has been written for 386bsd and FreeBSD by
15 * Wolfgang Stanglmeier <wolf@cologne.de>
16 * Stefan Esser <se@mi.Uni-Koeln.de>
17 * Copyright (C) 1994 Wolfgang Stanglmeier
19 * Other major contributions:
21 * NVRAM detection and reading.
22 * Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
24 *-----------------------------------------------------------------------------
26 * This program is free software; you can redistribute it and/or modify
27 * it under the terms of the GNU General Public License as published by
28 * the Free Software Foundation; either version 2 of the License, or
29 * (at your option) any later version.
31 * This program is distributed in the hope that it will be useful,
32 * but WITHOUT ANY WARRANTY; without even the implied warranty of
33 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
34 * GNU General Public License for more details.
36 * You should have received a copy of the GNU General Public License
37 * along with this program; if not, write to the Free Software
38 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
40 #include <linux/ctype.h>
41 #include <linux/init.h>
42 #include <linux/module.h>
43 #include <linux/moduleparam.h>
44 #include <linux/spinlock.h>
45 #include <scsi/scsi.h>
46 #include <scsi/scsi_tcq.h>
47 #include <scsi/scsi_device.h>
48 #include <scsi/scsi_transport.h>
50 #include "sym_glue.h"
51 #include "sym_nvram.h"
53 #define NAME53C "sym53c"
54 #define NAME53C8XX "sym53c8xx"
56 struct sym_driver_setup sym_driver_setup = SYM_LINUX_DRIVER_SETUP;
57 unsigned int sym_debug_flags = 0;
59 static char *excl_string;
60 static char *safe_string;
61 module_param_named(cmd_per_lun, sym_driver_setup.max_tag, ushort, 0);
62 module_param_named(burst, sym_driver_setup.burst_order, byte, 0);
63 module_param_named(led, sym_driver_setup.scsi_led, byte, 0);
64 module_param_named(diff, sym_driver_setup.scsi_diff, byte, 0);
65 module_param_named(irqm, sym_driver_setup.irq_mode, byte, 0);
66 module_param_named(buschk, sym_driver_setup.scsi_bus_check, byte, 0);
67 module_param_named(hostid, sym_driver_setup.host_id, byte, 0);
68 module_param_named(verb, sym_driver_setup.verbose, byte, 0);
69 module_param_named(debug, sym_debug_flags, uint, 0);
70 module_param_named(settle, sym_driver_setup.settle_delay, byte, 0);
71 module_param_named(nvram, sym_driver_setup.use_nvram, byte, 0);
72 module_param_named(excl, excl_string, charp, 0);
73 module_param_named(safe, safe_string, charp, 0);
75 MODULE_PARM_DESC(cmd_per_lun, "The maximum number of tags to use by default");
76 MODULE_PARM_DESC(burst, "Maximum burst. 0 to disable, 255 to read from registers");
77 MODULE_PARM_DESC(led, "Set to 1 to enable LED support");
78 MODULE_PARM_DESC(diff, "0 for no differential mode, 1 for BIOS, 2 for always, 3 for not GPIO3");
79 MODULE_PARM_DESC(irqm, "0 for open drain, 1 to leave alone, 2 for totem pole");
80 MODULE_PARM_DESC(buschk, "0 to not check, 1 for detach on error, 2 for warn on error");
81 MODULE_PARM_DESC(hostid, "The SCSI ID to use for the host adapters");
82 MODULE_PARM_DESC(verb, "0 for minimal verbosity, 1 for normal, 2 for excessive");
83 MODULE_PARM_DESC(debug, "Set bits to enable debugging");
84 MODULE_PARM_DESC(settle, "Settle delay in seconds. Default 3");
85 MODULE_PARM_DESC(nvram, "Option currently not used");
86 MODULE_PARM_DESC(excl, "List ioport addresses here to prevent controllers from being attached");
87 MODULE_PARM_DESC(safe, "Set other settings to a \"safe mode\"");
89 MODULE_LICENSE("GPL");
90 MODULE_VERSION(SYM_VERSION);
91 MODULE_AUTHOR("Matthew Wilcox <matthew@wil.cx>");
92 MODULE_DESCRIPTION("NCR, Symbios and LSI 8xx and 1010 PCI SCSI adapters");
94 static void sym2_setup_params(void)
96 char *p = excl_string;
97 int xi = 0;
99 while (p && (xi < 8)) {
100 char *next_p;
101 int val = (int) simple_strtoul(p, &next_p, 0);
102 sym_driver_setup.excludes[xi++] = val;
103 p = next_p;
106 if (safe_string) {
107 if (*safe_string == 'y') {
108 sym_driver_setup.max_tag = 0;
109 sym_driver_setup.burst_order = 0;
110 sym_driver_setup.scsi_led = 0;
111 sym_driver_setup.scsi_diff = 1;
112 sym_driver_setup.irq_mode = 0;
113 sym_driver_setup.scsi_bus_check = 2;
114 sym_driver_setup.host_id = 7;
115 sym_driver_setup.verbose = 2;
116 sym_driver_setup.settle_delay = 10;
117 sym_driver_setup.use_nvram = 1;
118 } else if (*safe_string != 'n') {
119 printk(KERN_WARNING NAME53C8XX "Ignoring parameter %s"
120 " passed to safe option", safe_string);
125 static struct scsi_transport_template *sym2_transport_template = NULL;
128 * Driver private area in the SCSI command structure.
130 struct sym_ucmd { /* Override the SCSI pointer structure */
131 struct completion *eh_done; /* SCSI error handling */
134 #define SYM_UCMD_PTR(cmd) ((struct sym_ucmd *)(&(cmd)->SCp))
135 #define SYM_SOFTC_PTR(cmd) sym_get_hcb(cmd->device->host)
138 * Complete a pending CAM CCB.
140 void sym_xpt_done(struct sym_hcb *np, struct scsi_cmnd *cmd)
142 struct sym_ucmd *ucmd = SYM_UCMD_PTR(cmd);
143 BUILD_BUG_ON(sizeof(struct scsi_pointer) < sizeof(struct sym_ucmd));
145 if (ucmd->eh_done)
146 complete(ucmd->eh_done);
148 scsi_dma_unmap(cmd);
149 cmd->scsi_done(cmd);
153 * Tell the SCSI layer about a BUS RESET.
155 void sym_xpt_async_bus_reset(struct sym_hcb *np)
157 printf_notice("%s: SCSI BUS has been reset.\n", sym_name(np));
158 np->s.settle_time = jiffies + sym_driver_setup.settle_delay * HZ;
159 np->s.settle_time_valid = 1;
160 if (sym_verbose >= 2)
161 printf_info("%s: command processing suspended for %d seconds\n",
162 sym_name(np), sym_driver_setup.settle_delay);
166 * Choose the more appropriate CAM status if
167 * the IO encountered an extended error.
169 static int sym_xerr_cam_status(int cam_status, int x_status)
171 if (x_status) {
172 if (x_status & XE_PARITY_ERR)
173 cam_status = DID_PARITY;
174 else if (x_status &(XE_EXTRA_DATA|XE_SODL_UNRUN|XE_SWIDE_OVRUN))
175 cam_status = DID_ERROR;
176 else if (x_status & XE_BAD_PHASE)
177 cam_status = DID_ERROR;
178 else
179 cam_status = DID_ERROR;
181 return cam_status;
185 * Build CAM result for a failed or auto-sensed IO.
187 void sym_set_cam_result_error(struct sym_hcb *np, struct sym_ccb *cp, int resid)
189 struct scsi_cmnd *cmd = cp->cmd;
190 u_int cam_status, scsi_status, drv_status;
192 drv_status = 0;
193 cam_status = DID_OK;
194 scsi_status = cp->ssss_status;
196 if (cp->host_flags & HF_SENSE) {
197 scsi_status = cp->sv_scsi_status;
198 resid = cp->sv_resid;
199 if (sym_verbose && cp->sv_xerr_status)
200 sym_print_xerr(cmd, cp->sv_xerr_status);
201 if (cp->host_status == HS_COMPLETE &&
202 cp->ssss_status == S_GOOD &&
203 cp->xerr_status == 0) {
204 cam_status = sym_xerr_cam_status(DID_OK,
205 cp->sv_xerr_status);
206 drv_status = DRIVER_SENSE;
208 * Bounce back the sense data to user.
210 memset(cmd->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
211 memcpy(cmd->sense_buffer, cp->sns_bbuf,
212 min(SCSI_SENSE_BUFFERSIZE, SYM_SNS_BBUF_LEN));
213 #if 0
215 * If the device reports a UNIT ATTENTION condition
216 * due to a RESET condition, we should consider all
217 * disconnect CCBs for this unit as aborted.
219 if (1) {
220 u_char *p;
221 p = (u_char *) cmd->sense_data;
222 if (p[0]==0x70 && p[2]==0x6 && p[12]==0x29)
223 sym_clear_tasks(np, DID_ABORT,
224 cp->target,cp->lun, -1);
226 #endif
227 } else {
229 * Error return from our internal request sense. This
230 * is bad: we must clear the contingent allegiance
231 * condition otherwise the device will always return
232 * BUSY. Use a big stick.
234 sym_reset_scsi_target(np, cmd->device->id);
235 cam_status = DID_ERROR;
237 } else if (cp->host_status == HS_COMPLETE) /* Bad SCSI status */
238 cam_status = DID_OK;
239 else if (cp->host_status == HS_SEL_TIMEOUT) /* Selection timeout */
240 cam_status = DID_NO_CONNECT;
241 else if (cp->host_status == HS_UNEXPECTED) /* Unexpected BUS FREE*/
242 cam_status = DID_ERROR;
243 else { /* Extended error */
244 if (sym_verbose) {
245 sym_print_addr(cmd, "COMMAND FAILED (%x %x %x).\n",
246 cp->host_status, cp->ssss_status,
247 cp->xerr_status);
250 * Set the most appropriate value for CAM status.
252 cam_status = sym_xerr_cam_status(DID_ERROR, cp->xerr_status);
254 scsi_set_resid(cmd, resid);
255 cmd->result = (drv_status << 24) | (cam_status << 16) | scsi_status;
258 static int sym_scatter(struct sym_hcb *np, struct sym_ccb *cp, struct scsi_cmnd *cmd)
260 int segment;
261 int use_sg;
263 cp->data_len = 0;
265 use_sg = scsi_dma_map(cmd);
266 if (use_sg > 0) {
267 struct scatterlist *sg;
268 struct sym_tcb *tp = &np->target[cp->target];
269 struct sym_tblmove *data;
271 if (use_sg > SYM_CONF_MAX_SG) {
272 scsi_dma_unmap(cmd);
273 return -1;
276 data = &cp->phys.data[SYM_CONF_MAX_SG - use_sg];
278 scsi_for_each_sg(cmd, sg, use_sg, segment) {
279 dma_addr_t baddr = sg_dma_address(sg);
280 unsigned int len = sg_dma_len(sg);
282 if ((len & 1) && (tp->head.wval & EWS)) {
283 len++;
284 cp->odd_byte_adjustment++;
287 sym_build_sge(np, &data[segment], baddr, len);
288 cp->data_len += len;
290 } else {
291 segment = -2;
294 return segment;
298 * Queue a SCSI command.
300 static int sym_queue_command(struct sym_hcb *np, struct scsi_cmnd *cmd)
302 struct scsi_device *sdev = cmd->device;
303 struct sym_tcb *tp;
304 struct sym_lcb *lp;
305 struct sym_ccb *cp;
306 int order;
309 * Retrieve the target descriptor.
311 tp = &np->target[sdev->id];
314 * Select tagged/untagged.
316 lp = sym_lp(tp, sdev->lun);
317 order = (lp && lp->s.reqtags) ? M_SIMPLE_TAG : 0;
320 * Queue the SCSI IO.
322 cp = sym_get_ccb(np, cmd, order);
323 if (!cp)
324 return 1; /* Means resource shortage */
325 sym_queue_scsiio(np, cmd, cp);
326 return 0;
330 * Setup buffers and pointers that address the CDB.
332 static inline int sym_setup_cdb(struct sym_hcb *np, struct scsi_cmnd *cmd, struct sym_ccb *cp)
334 memcpy(cp->cdb_buf, cmd->cmnd, cmd->cmd_len);
336 cp->phys.cmd.addr = CCB_BA(cp, cdb_buf[0]);
337 cp->phys.cmd.size = cpu_to_scr(cmd->cmd_len);
339 return 0;
343 * Setup pointers that address the data and start the I/O.
345 int sym_setup_data_and_start(struct sym_hcb *np, struct scsi_cmnd *cmd, struct sym_ccb *cp)
347 u32 lastp, goalp;
348 int dir;
351 * Build the CDB.
353 if (sym_setup_cdb(np, cmd, cp))
354 goto out_abort;
357 * No direction means no data.
359 dir = cmd->sc_data_direction;
360 if (dir != DMA_NONE) {
361 cp->segments = sym_scatter(np, cp, cmd);
362 if (cp->segments < 0) {
363 sym_set_cam_status(cmd, DID_ERROR);
364 goto out_abort;
368 * No segments means no data.
370 if (!cp->segments)
371 dir = DMA_NONE;
372 } else {
373 cp->data_len = 0;
374 cp->segments = 0;
378 * Set the data pointer.
380 switch (dir) {
381 case DMA_BIDIRECTIONAL:
382 scmd_printk(KERN_INFO, cmd, "got DMA_BIDIRECTIONAL command");
383 sym_set_cam_status(cmd, DID_ERROR);
384 goto out_abort;
385 case DMA_TO_DEVICE:
386 goalp = SCRIPTA_BA(np, data_out2) + 8;
387 lastp = goalp - 8 - (cp->segments * (2*4));
388 break;
389 case DMA_FROM_DEVICE:
390 cp->host_flags |= HF_DATA_IN;
391 goalp = SCRIPTA_BA(np, data_in2) + 8;
392 lastp = goalp - 8 - (cp->segments * (2*4));
393 break;
394 case DMA_NONE:
395 default:
396 lastp = goalp = SCRIPTB_BA(np, no_data);
397 break;
401 * Set all pointers values needed by SCRIPTS.
403 cp->phys.head.lastp = cpu_to_scr(lastp);
404 cp->phys.head.savep = cpu_to_scr(lastp);
405 cp->startp = cp->phys.head.savep;
406 cp->goalp = cpu_to_scr(goalp);
409 * When `#ifed 1', the code below makes the driver
410 * panic on the first attempt to write to a SCSI device.
411 * It is the first test we want to do after a driver
412 * change that does not seem obviously safe. :)
414 #if 0
415 switch (cp->cdb_buf[0]) {
416 case 0x0A: case 0x2A: case 0xAA:
417 panic("XXXXXXXXXXXXX WRITE NOT YET ALLOWED XXXXXXXXXXXXXX\n");
418 break;
419 default:
420 break;
422 #endif
425 * activate this job.
427 sym_put_start_queue(np, cp);
428 return 0;
430 out_abort:
431 sym_free_ccb(np, cp);
432 sym_xpt_done(np, cmd);
433 return 0;
438 * timer daemon.
440 * Misused to keep the driver running when
441 * interrupts are not configured correctly.
443 static void sym_timer(struct sym_hcb *np)
445 unsigned long thistime = jiffies;
448 * Restart the timer.
450 np->s.timer.expires = thistime + SYM_CONF_TIMER_INTERVAL;
451 add_timer(&np->s.timer);
454 * If we are resetting the ncr, wait for settle_time before
455 * clearing it. Then command processing will be resumed.
457 if (np->s.settle_time_valid) {
458 if (time_before_eq(np->s.settle_time, thistime)) {
459 if (sym_verbose >= 2 )
460 printk("%s: command processing resumed\n",
461 sym_name(np));
462 np->s.settle_time_valid = 0;
464 return;
468 * Nothing to do for now, but that may come.
470 if (np->s.lasttime + 4*HZ < thistime) {
471 np->s.lasttime = thistime;
474 #ifdef SYM_CONF_PCIQ_MAY_MISS_COMPLETIONS
476 * Some way-broken PCI bridges may lead to
477 * completions being lost when the clearing
478 * of the INTFLY flag by the CPU occurs
479 * concurrently with the chip raising this flag.
480 * If this ever happen, lost completions will
481 * be reaped here.
483 sym_wakeup_done(np);
484 #endif
489 * PCI BUS error handler.
491 void sym_log_bus_error(struct Scsi_Host *shost)
493 struct sym_data *sym_data = shost_priv(shost);
494 struct pci_dev *pdev = sym_data->pdev;
495 unsigned short pci_sts;
496 pci_read_config_word(pdev, PCI_STATUS, &pci_sts);
497 if (pci_sts & 0xf900) {
498 pci_write_config_word(pdev, PCI_STATUS, pci_sts);
499 shost_printk(KERN_WARNING, shost,
500 "PCI bus error: status = 0x%04x\n", pci_sts & 0xf900);
505 * queuecommand method. Entered with the host adapter lock held and
506 * interrupts disabled.
508 static int sym53c8xx_queue_command_lck(struct scsi_cmnd *cmd,
509 void (*done)(struct scsi_cmnd *))
511 struct sym_hcb *np = SYM_SOFTC_PTR(cmd);
512 struct sym_ucmd *ucp = SYM_UCMD_PTR(cmd);
513 int sts = 0;
515 cmd->scsi_done = done;
516 memset(ucp, 0, sizeof(*ucp));
519 * Shorten our settle_time if needed for
520 * this command not to time out.
522 if (np->s.settle_time_valid && cmd->request->timeout) {
523 unsigned long tlimit = jiffies + cmd->request->timeout;
524 tlimit -= SYM_CONF_TIMER_INTERVAL*2;
525 if (time_after(np->s.settle_time, tlimit)) {
526 np->s.settle_time = tlimit;
530 if (np->s.settle_time_valid)
531 return SCSI_MLQUEUE_HOST_BUSY;
533 sts = sym_queue_command(np, cmd);
534 if (sts)
535 return SCSI_MLQUEUE_HOST_BUSY;
536 return 0;
539 static DEF_SCSI_QCMD(sym53c8xx_queue_command)
542 * Linux entry point of the interrupt handler.
544 static irqreturn_t sym53c8xx_intr(int irq, void *dev_id)
546 struct Scsi_Host *shost = dev_id;
547 struct sym_data *sym_data = shost_priv(shost);
548 irqreturn_t result;
550 /* Avoid spinloop trying to handle interrupts on frozen device */
551 if (pci_channel_offline(sym_data->pdev))
552 return IRQ_NONE;
554 if (DEBUG_FLAGS & DEBUG_TINY) printf_debug ("[");
556 spin_lock(shost->host_lock);
557 result = sym_interrupt(shost);
558 spin_unlock(shost->host_lock);
560 if (DEBUG_FLAGS & DEBUG_TINY) printf_debug ("]\n");
562 return result;
566 * Linux entry point of the timer handler
568 static void sym53c8xx_timer(struct timer_list *t)
570 struct sym_hcb *np = from_timer(np, t, s.timer);
571 unsigned long flags;
573 spin_lock_irqsave(np->s.host->host_lock, flags);
574 sym_timer(np);
575 spin_unlock_irqrestore(np->s.host->host_lock, flags);
580 * What the eh thread wants us to perform.
582 #define SYM_EH_ABORT 0
583 #define SYM_EH_DEVICE_RESET 1
584 #define SYM_EH_BUS_RESET 2
585 #define SYM_EH_HOST_RESET 3
588 * Generic method for our eh processing.
589 * The 'op' argument tells what we have to do.
591 static int sym_eh_handler(int op, char *opname, struct scsi_cmnd *cmd)
593 struct sym_ucmd *ucmd = SYM_UCMD_PTR(cmd);
594 struct Scsi_Host *shost = cmd->device->host;
595 struct sym_data *sym_data = shost_priv(shost);
596 struct pci_dev *pdev = sym_data->pdev;
597 struct sym_hcb *np = sym_data->ncb;
598 SYM_QUEHEAD *qp;
599 int cmd_queued = 0;
600 int sts = -1;
601 struct completion eh_done;
603 scmd_printk(KERN_WARNING, cmd, "%s operation started\n", opname);
605 /* We may be in an error condition because the PCI bus
606 * went down. In this case, we need to wait until the
607 * PCI bus is reset, the card is reset, and only then
608 * proceed with the scsi error recovery. There's no
609 * point in hurrying; take a leisurely wait.
611 #define WAIT_FOR_PCI_RECOVERY 35
612 if (pci_channel_offline(pdev)) {
613 int finished_reset = 0;
614 init_completion(&eh_done);
615 spin_lock_irq(shost->host_lock);
616 /* Make sure we didn't race */
617 if (pci_channel_offline(pdev)) {
618 BUG_ON(sym_data->io_reset);
619 sym_data->io_reset = &eh_done;
620 } else {
621 finished_reset = 1;
623 spin_unlock_irq(shost->host_lock);
624 if (!finished_reset)
625 finished_reset = wait_for_completion_timeout
626 (sym_data->io_reset,
627 WAIT_FOR_PCI_RECOVERY*HZ);
628 spin_lock_irq(shost->host_lock);
629 sym_data->io_reset = NULL;
630 spin_unlock_irq(shost->host_lock);
631 if (!finished_reset)
632 return SCSI_FAILED;
635 spin_lock_irq(shost->host_lock);
636 /* This one is queued in some place -> to wait for completion */
637 FOR_EACH_QUEUED_ELEMENT(&np->busy_ccbq, qp) {
638 struct sym_ccb *cp = sym_que_entry(qp, struct sym_ccb, link_ccbq);
639 if (cp->cmd == cmd) {
640 cmd_queued = 1;
641 break;
645 /* Try to proceed the operation we have been asked for */
646 sts = -1;
647 switch(op) {
648 case SYM_EH_ABORT:
649 sts = sym_abort_scsiio(np, cmd, 1);
650 break;
651 case SYM_EH_DEVICE_RESET:
652 sts = sym_reset_scsi_target(np, cmd->device->id);
653 break;
654 case SYM_EH_BUS_RESET:
655 sym_reset_scsi_bus(np, 1);
656 sts = 0;
657 break;
658 case SYM_EH_HOST_RESET:
659 sym_reset_scsi_bus(np, 0);
660 sym_start_up(shost, 1);
661 sts = 0;
662 break;
663 default:
664 break;
667 /* On error, restore everything and cross fingers :) */
668 if (sts)
669 cmd_queued = 0;
671 if (cmd_queued) {
672 init_completion(&eh_done);
673 ucmd->eh_done = &eh_done;
674 spin_unlock_irq(shost->host_lock);
675 if (!wait_for_completion_timeout(&eh_done, 5*HZ)) {
676 ucmd->eh_done = NULL;
677 sts = -2;
679 } else {
680 spin_unlock_irq(shost->host_lock);
683 dev_warn(&cmd->device->sdev_gendev, "%s operation %s.\n", opname,
684 sts==0 ? "complete" :sts==-2 ? "timed-out" : "failed");
685 return sts ? SCSI_FAILED : SCSI_SUCCESS;
690 * Error handlers called from the eh thread (one thread per HBA).
692 static int sym53c8xx_eh_abort_handler(struct scsi_cmnd *cmd)
694 return sym_eh_handler(SYM_EH_ABORT, "ABORT", cmd);
697 static int sym53c8xx_eh_device_reset_handler(struct scsi_cmnd *cmd)
699 return sym_eh_handler(SYM_EH_DEVICE_RESET, "DEVICE RESET", cmd);
702 static int sym53c8xx_eh_bus_reset_handler(struct scsi_cmnd *cmd)
704 return sym_eh_handler(SYM_EH_BUS_RESET, "BUS RESET", cmd);
707 static int sym53c8xx_eh_host_reset_handler(struct scsi_cmnd *cmd)
709 return sym_eh_handler(SYM_EH_HOST_RESET, "HOST RESET", cmd);
713 * Tune device queuing depth, according to various limits.
715 static void sym_tune_dev_queuing(struct sym_tcb *tp, int lun, u_short reqtags)
717 struct sym_lcb *lp = sym_lp(tp, lun);
718 u_short oldtags;
720 if (!lp)
721 return;
723 oldtags = lp->s.reqtags;
725 if (reqtags > lp->s.scdev_depth)
726 reqtags = lp->s.scdev_depth;
728 lp->s.reqtags = reqtags;
730 if (reqtags != oldtags) {
731 dev_info(&tp->starget->dev,
732 "tagged command queuing %s, command queue depth %d.\n",
733 lp->s.reqtags ? "enabled" : "disabled", reqtags);
737 static int sym53c8xx_slave_alloc(struct scsi_device *sdev)
739 struct sym_hcb *np = sym_get_hcb(sdev->host);
740 struct sym_tcb *tp = &np->target[sdev->id];
741 struct sym_lcb *lp;
742 unsigned long flags;
743 int error;
745 if (sdev->id >= SYM_CONF_MAX_TARGET || sdev->lun >= SYM_CONF_MAX_LUN)
746 return -ENXIO;
748 spin_lock_irqsave(np->s.host->host_lock, flags);
751 * Fail the device init if the device is flagged NOSCAN at BOOT in
752 * the NVRAM. This may speed up boot and maintain coherency with
753 * BIOS device numbering. Clearing the flag allows the user to
754 * rescan skipped devices later. We also return an error for
755 * devices not flagged for SCAN LUNS in the NVRAM since some single
756 * lun devices behave badly when asked for a non zero LUN.
759 if (tp->usrflags & SYM_SCAN_BOOT_DISABLED) {
760 tp->usrflags &= ~SYM_SCAN_BOOT_DISABLED;
761 starget_printk(KERN_INFO, sdev->sdev_target,
762 "Scan at boot disabled in NVRAM\n");
763 error = -ENXIO;
764 goto out;
767 if (tp->usrflags & SYM_SCAN_LUNS_DISABLED) {
768 if (sdev->lun != 0) {
769 error = -ENXIO;
770 goto out;
772 starget_printk(KERN_INFO, sdev->sdev_target,
773 "Multiple LUNs disabled in NVRAM\n");
776 lp = sym_alloc_lcb(np, sdev->id, sdev->lun);
777 if (!lp) {
778 error = -ENOMEM;
779 goto out;
781 if (tp->nlcb == 1)
782 tp->starget = sdev->sdev_target;
784 spi_min_period(tp->starget) = tp->usr_period;
785 spi_max_width(tp->starget) = tp->usr_width;
787 error = 0;
788 out:
789 spin_unlock_irqrestore(np->s.host->host_lock, flags);
791 return error;
795 * Linux entry point for device queue sizing.
797 static int sym53c8xx_slave_configure(struct scsi_device *sdev)
799 struct sym_hcb *np = sym_get_hcb(sdev->host);
800 struct sym_tcb *tp = &np->target[sdev->id];
801 struct sym_lcb *lp = sym_lp(tp, sdev->lun);
802 int reqtags, depth_to_use;
805 * Get user flags.
807 lp->curr_flags = lp->user_flags;
810 * Select queue depth from driver setup.
811 * Do not use more than configured by user.
812 * Use at least 1.
813 * Do not use more than our maximum.
815 reqtags = sym_driver_setup.max_tag;
816 if (reqtags > tp->usrtags)
817 reqtags = tp->usrtags;
818 if (!sdev->tagged_supported)
819 reqtags = 0;
820 if (reqtags > SYM_CONF_MAX_TAG)
821 reqtags = SYM_CONF_MAX_TAG;
822 depth_to_use = reqtags ? reqtags : 1;
823 scsi_change_queue_depth(sdev, depth_to_use);
824 lp->s.scdev_depth = depth_to_use;
825 sym_tune_dev_queuing(tp, sdev->lun, reqtags);
827 if (!spi_initial_dv(sdev->sdev_target))
828 spi_dv_device(sdev);
830 return 0;
833 static void sym53c8xx_slave_destroy(struct scsi_device *sdev)
835 struct sym_hcb *np = sym_get_hcb(sdev->host);
836 struct sym_tcb *tp = &np->target[sdev->id];
837 struct sym_lcb *lp = sym_lp(tp, sdev->lun);
838 unsigned long flags;
840 /* if slave_alloc returned before allocating a sym_lcb, return */
841 if (!lp)
842 return;
844 spin_lock_irqsave(np->s.host->host_lock, flags);
846 if (lp->busy_itlq || lp->busy_itl) {
848 * This really shouldn't happen, but we can't return an error
849 * so let's try to stop all on-going I/O.
851 starget_printk(KERN_WARNING, tp->starget,
852 "Removing busy LCB (%d)\n", (u8)sdev->lun);
853 sym_reset_scsi_bus(np, 1);
856 if (sym_free_lcb(np, sdev->id, sdev->lun) == 0) {
858 * It was the last unit for this target.
860 tp->head.sval = 0;
861 tp->head.wval = np->rv_scntl3;
862 tp->head.uval = 0;
863 tp->tgoal.check_nego = 1;
864 tp->starget = NULL;
867 spin_unlock_irqrestore(np->s.host->host_lock, flags);
871 * Linux entry point for info() function
873 static const char *sym53c8xx_info (struct Scsi_Host *host)
875 return SYM_DRIVER_NAME;
879 #ifdef SYM_LINUX_PROC_INFO_SUPPORT
881 * Proc file system stuff
883 * A read operation returns adapter information.
884 * A write operation is a control command.
885 * The string is parsed in the driver code and the command is passed
886 * to the sym_usercmd() function.
889 #ifdef SYM_LINUX_USER_COMMAND_SUPPORT
891 struct sym_usrcmd {
892 u_long target;
893 u_long lun;
894 u_long data;
895 u_long cmd;
898 #define UC_SETSYNC 10
899 #define UC_SETTAGS 11
900 #define UC_SETDEBUG 12
901 #define UC_SETWIDE 14
902 #define UC_SETFLAG 15
903 #define UC_SETVERBOSE 17
904 #define UC_RESETDEV 18
905 #define UC_CLEARDEV 19
907 static void sym_exec_user_command (struct sym_hcb *np, struct sym_usrcmd *uc)
909 struct sym_tcb *tp;
910 int t, l;
912 switch (uc->cmd) {
913 case 0: return;
915 #ifdef SYM_LINUX_DEBUG_CONTROL_SUPPORT
916 case UC_SETDEBUG:
917 sym_debug_flags = uc->data;
918 break;
919 #endif
920 case UC_SETVERBOSE:
921 np->verbose = uc->data;
922 break;
923 default:
925 * We assume that other commands apply to targets.
926 * This should always be the case and avoid the below
927 * 4 lines to be repeated 6 times.
929 for (t = 0; t < SYM_CONF_MAX_TARGET; t++) {
930 if (!((uc->target >> t) & 1))
931 continue;
932 tp = &np->target[t];
933 if (!tp->nlcb)
934 continue;
936 switch (uc->cmd) {
938 case UC_SETSYNC:
939 if (!uc->data || uc->data >= 255) {
940 tp->tgoal.iu = tp->tgoal.dt =
941 tp->tgoal.qas = 0;
942 tp->tgoal.offset = 0;
943 } else if (uc->data <= 9 && np->minsync_dt) {
944 if (uc->data < np->minsync_dt)
945 uc->data = np->minsync_dt;
946 tp->tgoal.iu = tp->tgoal.dt =
947 tp->tgoal.qas = 1;
948 tp->tgoal.width = 1;
949 tp->tgoal.period = uc->data;
950 tp->tgoal.offset = np->maxoffs_dt;
951 } else {
952 if (uc->data < np->minsync)
953 uc->data = np->minsync;
954 tp->tgoal.iu = tp->tgoal.dt =
955 tp->tgoal.qas = 0;
956 tp->tgoal.period = uc->data;
957 tp->tgoal.offset = np->maxoffs;
959 tp->tgoal.check_nego = 1;
960 break;
961 case UC_SETWIDE:
962 tp->tgoal.width = uc->data ? 1 : 0;
963 tp->tgoal.check_nego = 1;
964 break;
965 case UC_SETTAGS:
966 for (l = 0; l < SYM_CONF_MAX_LUN; l++)
967 sym_tune_dev_queuing(tp, l, uc->data);
968 break;
969 case UC_RESETDEV:
970 tp->to_reset = 1;
971 np->istat_sem = SEM;
972 OUTB(np, nc_istat, SIGP|SEM);
973 break;
974 case UC_CLEARDEV:
975 for (l = 0; l < SYM_CONF_MAX_LUN; l++) {
976 struct sym_lcb *lp = sym_lp(tp, l);
977 if (lp) lp->to_clear = 1;
979 np->istat_sem = SEM;
980 OUTB(np, nc_istat, SIGP|SEM);
981 break;
982 case UC_SETFLAG:
983 tp->usrflags = uc->data;
984 break;
987 break;
991 static int sym_skip_spaces(char *ptr, int len)
993 int cnt, c;
995 for (cnt = len; cnt > 0 && (c = *ptr++) && isspace(c); cnt--);
997 return (len - cnt);
1000 static int get_int_arg(char *ptr, int len, u_long *pv)
1002 char *end;
1004 *pv = simple_strtoul(ptr, &end, 10);
1005 return (end - ptr);
1008 static int is_keyword(char *ptr, int len, char *verb)
1010 int verb_len = strlen(verb);
1012 if (len >= verb_len && !memcmp(verb, ptr, verb_len))
1013 return verb_len;
1014 else
1015 return 0;
1018 #define SKIP_SPACES(ptr, len) \
1019 if ((arg_len = sym_skip_spaces(ptr, len)) < 1) \
1020 return -EINVAL; \
1021 ptr += arg_len; len -= arg_len;
1023 #define GET_INT_ARG(ptr, len, v) \
1024 if (!(arg_len = get_int_arg(ptr, len, &(v)))) \
1025 return -EINVAL; \
1026 ptr += arg_len; len -= arg_len;
1030 * Parse a control command
1033 static int sym_user_command(struct Scsi_Host *shost, char *buffer, int length)
1035 struct sym_hcb *np = sym_get_hcb(shost);
1036 char *ptr = buffer;
1037 int len = length;
1038 struct sym_usrcmd cmd, *uc = &cmd;
1039 int arg_len;
1040 u_long target;
1042 memset(uc, 0, sizeof(*uc));
1044 if (len > 0 && ptr[len-1] == '\n')
1045 --len;
1047 if ((arg_len = is_keyword(ptr, len, "setsync")) != 0)
1048 uc->cmd = UC_SETSYNC;
1049 else if ((arg_len = is_keyword(ptr, len, "settags")) != 0)
1050 uc->cmd = UC_SETTAGS;
1051 else if ((arg_len = is_keyword(ptr, len, "setverbose")) != 0)
1052 uc->cmd = UC_SETVERBOSE;
1053 else if ((arg_len = is_keyword(ptr, len, "setwide")) != 0)
1054 uc->cmd = UC_SETWIDE;
1055 #ifdef SYM_LINUX_DEBUG_CONTROL_SUPPORT
1056 else if ((arg_len = is_keyword(ptr, len, "setdebug")) != 0)
1057 uc->cmd = UC_SETDEBUG;
1058 #endif
1059 else if ((arg_len = is_keyword(ptr, len, "setflag")) != 0)
1060 uc->cmd = UC_SETFLAG;
1061 else if ((arg_len = is_keyword(ptr, len, "resetdev")) != 0)
1062 uc->cmd = UC_RESETDEV;
1063 else if ((arg_len = is_keyword(ptr, len, "cleardev")) != 0)
1064 uc->cmd = UC_CLEARDEV;
1065 else
1066 arg_len = 0;
1068 #ifdef DEBUG_PROC_INFO
1069 printk("sym_user_command: arg_len=%d, cmd=%ld\n", arg_len, uc->cmd);
1070 #endif
1072 if (!arg_len)
1073 return -EINVAL;
1074 ptr += arg_len; len -= arg_len;
1076 switch(uc->cmd) {
1077 case UC_SETSYNC:
1078 case UC_SETTAGS:
1079 case UC_SETWIDE:
1080 case UC_SETFLAG:
1081 case UC_RESETDEV:
1082 case UC_CLEARDEV:
1083 SKIP_SPACES(ptr, len);
1084 if ((arg_len = is_keyword(ptr, len, "all")) != 0) {
1085 ptr += arg_len; len -= arg_len;
1086 uc->target = ~0;
1087 } else {
1088 GET_INT_ARG(ptr, len, target);
1089 uc->target = (1<<target);
1090 #ifdef DEBUG_PROC_INFO
1091 printk("sym_user_command: target=%ld\n", target);
1092 #endif
1094 break;
1097 switch(uc->cmd) {
1098 case UC_SETVERBOSE:
1099 case UC_SETSYNC:
1100 case UC_SETTAGS:
1101 case UC_SETWIDE:
1102 SKIP_SPACES(ptr, len);
1103 GET_INT_ARG(ptr, len, uc->data);
1104 #ifdef DEBUG_PROC_INFO
1105 printk("sym_user_command: data=%ld\n", uc->data);
1106 #endif
1107 break;
1108 #ifdef SYM_LINUX_DEBUG_CONTROL_SUPPORT
1109 case UC_SETDEBUG:
1110 while (len > 0) {
1111 SKIP_SPACES(ptr, len);
1112 if ((arg_len = is_keyword(ptr, len, "alloc")))
1113 uc->data |= DEBUG_ALLOC;
1114 else if ((arg_len = is_keyword(ptr, len, "phase")))
1115 uc->data |= DEBUG_PHASE;
1116 else if ((arg_len = is_keyword(ptr, len, "queue")))
1117 uc->data |= DEBUG_QUEUE;
1118 else if ((arg_len = is_keyword(ptr, len, "result")))
1119 uc->data |= DEBUG_RESULT;
1120 else if ((arg_len = is_keyword(ptr, len, "scatter")))
1121 uc->data |= DEBUG_SCATTER;
1122 else if ((arg_len = is_keyword(ptr, len, "script")))
1123 uc->data |= DEBUG_SCRIPT;
1124 else if ((arg_len = is_keyword(ptr, len, "tiny")))
1125 uc->data |= DEBUG_TINY;
1126 else if ((arg_len = is_keyword(ptr, len, "timing")))
1127 uc->data |= DEBUG_TIMING;
1128 else if ((arg_len = is_keyword(ptr, len, "nego")))
1129 uc->data |= DEBUG_NEGO;
1130 else if ((arg_len = is_keyword(ptr, len, "tags")))
1131 uc->data |= DEBUG_TAGS;
1132 else if ((arg_len = is_keyword(ptr, len, "pointer")))
1133 uc->data |= DEBUG_POINTER;
1134 else
1135 return -EINVAL;
1136 ptr += arg_len; len -= arg_len;
1138 #ifdef DEBUG_PROC_INFO
1139 printk("sym_user_command: data=%ld\n", uc->data);
1140 #endif
1141 break;
1142 #endif /* SYM_LINUX_DEBUG_CONTROL_SUPPORT */
1143 case UC_SETFLAG:
1144 while (len > 0) {
1145 SKIP_SPACES(ptr, len);
1146 if ((arg_len = is_keyword(ptr, len, "no_disc")))
1147 uc->data &= ~SYM_DISC_ENABLED;
1148 else
1149 return -EINVAL;
1150 ptr += arg_len; len -= arg_len;
1152 break;
1153 default:
1154 break;
1157 if (len)
1158 return -EINVAL;
1159 else {
1160 unsigned long flags;
1162 spin_lock_irqsave(shost->host_lock, flags);
1163 sym_exec_user_command(np, uc);
1164 spin_unlock_irqrestore(shost->host_lock, flags);
1166 return length;
1169 #endif /* SYM_LINUX_USER_COMMAND_SUPPORT */
1173 * Copy formatted information into the input buffer.
1175 static int sym_show_info(struct seq_file *m, struct Scsi_Host *shost)
1177 #ifdef SYM_LINUX_USER_INFO_SUPPORT
1178 struct sym_data *sym_data = shost_priv(shost);
1179 struct pci_dev *pdev = sym_data->pdev;
1180 struct sym_hcb *np = sym_data->ncb;
1182 seq_printf(m, "Chip " NAME53C "%s, device id 0x%x, "
1183 "revision id 0x%x\n", np->s.chip_name,
1184 pdev->device, pdev->revision);
1185 seq_printf(m, "At PCI address %s, IRQ %u\n",
1186 pci_name(pdev), pdev->irq);
1187 seq_printf(m, "Min. period factor %d, %s SCSI BUS%s\n",
1188 (int) (np->minsync_dt ? np->minsync_dt : np->minsync),
1189 np->maxwide ? "Wide" : "Narrow",
1190 np->minsync_dt ? ", DT capable" : "");
1192 seq_printf(m, "Max. started commands %d, "
1193 "max. commands per LUN %d\n",
1194 SYM_CONF_MAX_START, SYM_CONF_MAX_TAG);
1196 return 0;
1197 #else
1198 return -EINVAL;
1199 #endif /* SYM_LINUX_USER_INFO_SUPPORT */
1202 #endif /* SYM_LINUX_PROC_INFO_SUPPORT */
1205 * Free resources claimed by sym_iomap_device(). Note that
1206 * sym_free_resources() should be used instead of this function after calling
1207 * sym_attach().
1209 static void sym_iounmap_device(struct sym_device *device)
1211 if (device->s.ioaddr)
1212 pci_iounmap(device->pdev, device->s.ioaddr);
1213 if (device->s.ramaddr)
1214 pci_iounmap(device->pdev, device->s.ramaddr);
1218 * Free controller resources.
1220 static void sym_free_resources(struct sym_hcb *np, struct pci_dev *pdev,
1221 int do_free_irq)
1224 * Free O/S specific resources.
1226 if (do_free_irq)
1227 free_irq(pdev->irq, np->s.host);
1228 if (np->s.ioaddr)
1229 pci_iounmap(pdev, np->s.ioaddr);
1230 if (np->s.ramaddr)
1231 pci_iounmap(pdev, np->s.ramaddr);
1233 * Free O/S independent resources.
1235 sym_hcb_free(np);
1237 sym_mfree_dma(np, sizeof(*np), "HCB");
1241 * Host attach and initialisations.
1243 * Allocate host data and ncb structure.
1244 * Remap MMIO region.
1245 * Do chip initialization.
1246 * If all is OK, install interrupt handling and
1247 * start the timer daemon.
1249 static struct Scsi_Host *sym_attach(struct scsi_host_template *tpnt, int unit,
1250 struct sym_device *dev)
1252 struct sym_data *sym_data;
1253 struct sym_hcb *np = NULL;
1254 struct Scsi_Host *shost = NULL;
1255 struct pci_dev *pdev = dev->pdev;
1256 unsigned long flags;
1257 struct sym_fw *fw;
1258 int do_free_irq = 0;
1260 printk(KERN_INFO "sym%d: <%s> rev 0x%x at pci %s irq %u\n",
1261 unit, dev->chip.name, pdev->revision, pci_name(pdev),
1262 pdev->irq);
1265 * Get the firmware for this chip.
1267 fw = sym_find_firmware(&dev->chip);
1268 if (!fw)
1269 goto attach_failed;
1271 shost = scsi_host_alloc(tpnt, sizeof(*sym_data));
1272 if (!shost)
1273 goto attach_failed;
1274 sym_data = shost_priv(shost);
1277 * Allocate immediately the host control block,
1278 * since we are only expecting to succeed. :)
1279 * We keep track in the HCB of all the resources that
1280 * are to be released on error.
1282 np = __sym_calloc_dma(&pdev->dev, sizeof(*np), "HCB");
1283 if (!np)
1284 goto attach_failed;
1285 np->bus_dmat = &pdev->dev; /* Result in 1 DMA pool per HBA */
1286 sym_data->ncb = np;
1287 sym_data->pdev = pdev;
1288 np->s.host = shost;
1290 pci_set_drvdata(pdev, shost);
1293 * Copy some useful infos to the HCB.
1295 np->hcb_ba = vtobus(np);
1296 np->verbose = sym_driver_setup.verbose;
1297 np->s.unit = unit;
1298 np->features = dev->chip.features;
1299 np->clock_divn = dev->chip.nr_divisor;
1300 np->maxoffs = dev->chip.offset_max;
1301 np->maxburst = dev->chip.burst_max;
1302 np->myaddr = dev->host_id;
1303 np->mmio_ba = (u32)dev->mmio_base;
1304 np->ram_ba = (u32)dev->ram_base;
1305 np->s.ioaddr = dev->s.ioaddr;
1306 np->s.ramaddr = dev->s.ramaddr;
1309 * Edit its name.
1311 strlcpy(np->s.chip_name, dev->chip.name, sizeof(np->s.chip_name));
1312 sprintf(np->s.inst_name, "sym%d", np->s.unit);
1314 if ((SYM_CONF_DMA_ADDRESSING_MODE > 0) && (np->features & FE_DAC) &&
1315 !dma_set_mask(&pdev->dev, DMA_DAC_MASK)) {
1316 set_dac(np);
1317 } else if (dma_set_mask(&pdev->dev, DMA_BIT_MASK(32))) {
1318 printf_warning("%s: No suitable DMA available\n", sym_name(np));
1319 goto attach_failed;
1322 if (sym_hcb_attach(shost, fw, dev->nvram))
1323 goto attach_failed;
1326 * Install the interrupt handler.
1327 * If we synchonize the C code with SCRIPTS on interrupt,
1328 * we do not want to share the INTR line at all.
1330 if (request_irq(pdev->irq, sym53c8xx_intr, IRQF_SHARED, NAME53C8XX,
1331 shost)) {
1332 printf_err("%s: request irq %u failure\n",
1333 sym_name(np), pdev->irq);
1334 goto attach_failed;
1336 do_free_irq = 1;
1339 * After SCSI devices have been opened, we cannot
1340 * reset the bus safely, so we do it here.
1342 spin_lock_irqsave(shost->host_lock, flags);
1343 if (sym_reset_scsi_bus(np, 0))
1344 goto reset_failed;
1347 * Start the SCRIPTS.
1349 sym_start_up(shost, 1);
1352 * Start the timer daemon
1354 timer_setup(&np->s.timer, sym53c8xx_timer, 0);
1355 np->s.lasttime=0;
1356 sym_timer (np);
1359 * Fill Linux host instance structure
1360 * and return success.
1362 shost->max_channel = 0;
1363 shost->this_id = np->myaddr;
1364 shost->max_id = np->maxwide ? 16 : 8;
1365 shost->max_lun = SYM_CONF_MAX_LUN;
1366 shost->unique_id = pci_resource_start(pdev, 0);
1367 shost->cmd_per_lun = SYM_CONF_MAX_TAG;
1368 shost->can_queue = (SYM_CONF_MAX_START-2);
1369 shost->sg_tablesize = SYM_CONF_MAX_SG;
1370 shost->max_cmd_len = 16;
1371 BUG_ON(sym2_transport_template == NULL);
1372 shost->transportt = sym2_transport_template;
1374 /* 53c896 rev 1 errata: DMA may not cross 16MB boundary */
1375 if (pdev->device == PCI_DEVICE_ID_NCR_53C896 && pdev->revision < 2)
1376 shost->dma_boundary = 0xFFFFFF;
1378 spin_unlock_irqrestore(shost->host_lock, flags);
1380 return shost;
1382 reset_failed:
1383 printf_err("%s: FATAL ERROR: CHECK SCSI BUS - CABLES, "
1384 "TERMINATION, DEVICE POWER etc.!\n", sym_name(np));
1385 spin_unlock_irqrestore(shost->host_lock, flags);
1386 attach_failed:
1387 printf_info("sym%d: giving up ...\n", unit);
1388 if (np)
1389 sym_free_resources(np, pdev, do_free_irq);
1390 else
1391 sym_iounmap_device(dev);
1392 if (shost)
1393 scsi_host_put(shost);
1395 return NULL;
1400 * Detect and try to read SYMBIOS and TEKRAM NVRAM.
1402 #if SYM_CONF_NVRAM_SUPPORT
1403 static void sym_get_nvram(struct sym_device *devp, struct sym_nvram *nvp)
1405 devp->nvram = nvp;
1406 nvp->type = 0;
1408 sym_read_nvram(devp, nvp);
1410 #else
1411 static inline void sym_get_nvram(struct sym_device *devp, struct sym_nvram *nvp)
1414 #endif /* SYM_CONF_NVRAM_SUPPORT */
1416 static int sym_check_supported(struct sym_device *device)
1418 struct sym_chip *chip;
1419 struct pci_dev *pdev = device->pdev;
1420 unsigned long io_port = pci_resource_start(pdev, 0);
1421 int i;
1424 * If user excluded this chip, do not initialize it.
1425 * I hate this code so much. Must kill it.
1427 if (io_port) {
1428 for (i = 0 ; i < 8 ; i++) {
1429 if (sym_driver_setup.excludes[i] == io_port)
1430 return -ENODEV;
1435 * Check if the chip is supported. Then copy the chip description
1436 * to our device structure so we can make it match the actual device
1437 * and options.
1439 chip = sym_lookup_chip_table(pdev->device, pdev->revision);
1440 if (!chip) {
1441 dev_info(&pdev->dev, "device not supported\n");
1442 return -ENODEV;
1444 memcpy(&device->chip, chip, sizeof(device->chip));
1446 return 0;
1450 * Ignore Symbios chips controlled by various RAID controllers.
1451 * These controllers set value 0x52414944 at RAM end - 16.
1453 static int sym_check_raid(struct sym_device *device)
1455 unsigned int ram_size, ram_val;
1457 if (!device->s.ramaddr)
1458 return 0;
1460 if (device->chip.features & FE_RAM8K)
1461 ram_size = 8192;
1462 else
1463 ram_size = 4096;
1465 ram_val = readl(device->s.ramaddr + ram_size - 16);
1466 if (ram_val != 0x52414944)
1467 return 0;
1469 dev_info(&device->pdev->dev,
1470 "not initializing, driven by RAID controller.\n");
1471 return -ENODEV;
1474 static int sym_set_workarounds(struct sym_device *device)
1476 struct sym_chip *chip = &device->chip;
1477 struct pci_dev *pdev = device->pdev;
1478 u_short status_reg;
1481 * (ITEM 12 of a DEL about the 896 I haven't yet).
1482 * We must ensure the chip will use WRITE AND INVALIDATE.
1483 * The revision number limit is for now arbitrary.
1485 if (pdev->device == PCI_DEVICE_ID_NCR_53C896 && pdev->revision < 0x4) {
1486 chip->features |= (FE_WRIE | FE_CLSE);
1489 /* If the chip can do Memory Write Invalidate, enable it */
1490 if (chip->features & FE_WRIE) {
1491 if (pci_set_mwi(pdev))
1492 return -ENODEV;
1496 * Work around for errant bit in 895A. The 66Mhz
1497 * capable bit is set erroneously. Clear this bit.
1498 * (Item 1 DEL 533)
1500 * Make sure Config space and Features agree.
1502 * Recall: writes are not normal to status register -
1503 * write a 1 to clear and a 0 to leave unchanged.
1504 * Can only reset bits.
1506 pci_read_config_word(pdev, PCI_STATUS, &status_reg);
1507 if (chip->features & FE_66MHZ) {
1508 if (!(status_reg & PCI_STATUS_66MHZ))
1509 chip->features &= ~FE_66MHZ;
1510 } else {
1511 if (status_reg & PCI_STATUS_66MHZ) {
1512 status_reg = PCI_STATUS_66MHZ;
1513 pci_write_config_word(pdev, PCI_STATUS, status_reg);
1514 pci_read_config_word(pdev, PCI_STATUS, &status_reg);
1518 return 0;
1522 * Map HBA registers and on-chip SRAM (if present).
1524 static int sym_iomap_device(struct sym_device *device)
1526 struct pci_dev *pdev = device->pdev;
1527 struct pci_bus_region bus_addr;
1528 int i = 2;
1530 pcibios_resource_to_bus(pdev->bus, &bus_addr, &pdev->resource[1]);
1531 device->mmio_base = bus_addr.start;
1533 if (device->chip.features & FE_RAM) {
1535 * If the BAR is 64-bit, resource 2 will be occupied by the
1536 * upper 32 bits
1538 if (!pdev->resource[i].flags)
1539 i++;
1540 pcibios_resource_to_bus(pdev->bus, &bus_addr,
1541 &pdev->resource[i]);
1542 device->ram_base = bus_addr.start;
1545 #ifdef CONFIG_SCSI_SYM53C8XX_MMIO
1546 if (device->mmio_base)
1547 device->s.ioaddr = pci_iomap(pdev, 1,
1548 pci_resource_len(pdev, 1));
1549 #endif
1550 if (!device->s.ioaddr)
1551 device->s.ioaddr = pci_iomap(pdev, 0,
1552 pci_resource_len(pdev, 0));
1553 if (!device->s.ioaddr) {
1554 dev_err(&pdev->dev, "could not map registers; giving up.\n");
1555 return -EIO;
1557 if (device->ram_base) {
1558 device->s.ramaddr = pci_iomap(pdev, i,
1559 pci_resource_len(pdev, i));
1560 if (!device->s.ramaddr) {
1561 dev_warn(&pdev->dev,
1562 "could not map SRAM; continuing anyway.\n");
1563 device->ram_base = 0;
1567 return 0;
1571 * The NCR PQS and PDS cards are constructed as a DEC bridge
1572 * behind which sits a proprietary NCR memory controller and
1573 * either four or two 53c875s as separate devices. We can tell
1574 * if an 875 is part of a PQS/PDS or not since if it is, it will
1575 * be on the same bus as the memory controller. In its usual
1576 * mode of operation, the 875s are slaved to the memory
1577 * controller for all transfers. To operate with the Linux
1578 * driver, the memory controller is disabled and the 875s
1579 * freed to function independently. The only wrinkle is that
1580 * the preset SCSI ID (which may be zero) must be read in from
1581 * a special configuration space register of the 875.
1583 static void sym_config_pqs(struct pci_dev *pdev, struct sym_device *sym_dev)
1585 int slot;
1586 u8 tmp;
1588 for (slot = 0; slot < 256; slot++) {
1589 struct pci_dev *memc = pci_get_slot(pdev->bus, slot);
1591 if (!memc || memc->vendor != 0x101a || memc->device == 0x0009) {
1592 pci_dev_put(memc);
1593 continue;
1596 /* bit 1: allow individual 875 configuration */
1597 pci_read_config_byte(memc, 0x44, &tmp);
1598 if ((tmp & 0x2) == 0) {
1599 tmp |= 0x2;
1600 pci_write_config_byte(memc, 0x44, tmp);
1603 /* bit 2: drive individual 875 interrupts to the bus */
1604 pci_read_config_byte(memc, 0x45, &tmp);
1605 if ((tmp & 0x4) == 0) {
1606 tmp |= 0x4;
1607 pci_write_config_byte(memc, 0x45, tmp);
1610 pci_dev_put(memc);
1611 break;
1614 pci_read_config_byte(pdev, 0x84, &tmp);
1615 sym_dev->host_id = tmp;
1619 * Called before unloading the module.
1620 * Detach the host.
1621 * We have to free resources and halt the NCR chip.
1623 static int sym_detach(struct Scsi_Host *shost, struct pci_dev *pdev)
1625 struct sym_hcb *np = sym_get_hcb(shost);
1626 printk("%s: detaching ...\n", sym_name(np));
1628 del_timer_sync(&np->s.timer);
1631 * Reset NCR chip.
1632 * We should use sym_soft_reset(), but we don't want to do
1633 * so, since we may not be safe if interrupts occur.
1635 printk("%s: resetting chip\n", sym_name(np));
1636 OUTB(np, nc_istat, SRST);
1637 INB(np, nc_mbox1);
1638 udelay(10);
1639 OUTB(np, nc_istat, 0);
1641 sym_free_resources(np, pdev, 1);
1642 scsi_host_put(shost);
1644 return 1;
1648 * Driver host template.
1650 static struct scsi_host_template sym2_template = {
1651 .module = THIS_MODULE,
1652 .name = "sym53c8xx",
1653 .info = sym53c8xx_info,
1654 .queuecommand = sym53c8xx_queue_command,
1655 .slave_alloc = sym53c8xx_slave_alloc,
1656 .slave_configure = sym53c8xx_slave_configure,
1657 .slave_destroy = sym53c8xx_slave_destroy,
1658 .eh_abort_handler = sym53c8xx_eh_abort_handler,
1659 .eh_device_reset_handler = sym53c8xx_eh_device_reset_handler,
1660 .eh_bus_reset_handler = sym53c8xx_eh_bus_reset_handler,
1661 .eh_host_reset_handler = sym53c8xx_eh_host_reset_handler,
1662 .this_id = 7,
1663 .max_sectors = 0xFFFF,
1664 #ifdef SYM_LINUX_PROC_INFO_SUPPORT
1665 .show_info = sym_show_info,
1666 #ifdef SYM_LINUX_USER_COMMAND_SUPPORT
1667 .write_info = sym_user_command,
1668 #endif
1669 .proc_name = NAME53C8XX,
1670 #endif
1673 static int attach_count;
1675 static int sym2_probe(struct pci_dev *pdev, const struct pci_device_id *ent)
1677 struct sym_device sym_dev;
1678 struct sym_nvram nvram;
1679 struct Scsi_Host *shost;
1680 int do_iounmap = 0;
1681 int do_disable_device = 1;
1683 memset(&sym_dev, 0, sizeof(sym_dev));
1684 memset(&nvram, 0, sizeof(nvram));
1685 sym_dev.pdev = pdev;
1686 sym_dev.host_id = SYM_SETUP_HOST_ID;
1688 if (pci_enable_device(pdev))
1689 goto leave;
1691 pci_set_master(pdev);
1693 if (pci_request_regions(pdev, NAME53C8XX))
1694 goto disable;
1696 if (sym_check_supported(&sym_dev))
1697 goto free;
1699 if (sym_iomap_device(&sym_dev))
1700 goto free;
1701 do_iounmap = 1;
1703 if (sym_check_raid(&sym_dev)) {
1704 do_disable_device = 0; /* Don't disable the device */
1705 goto free;
1708 if (sym_set_workarounds(&sym_dev))
1709 goto free;
1711 sym_config_pqs(pdev, &sym_dev);
1713 sym_get_nvram(&sym_dev, &nvram);
1715 do_iounmap = 0; /* Don't sym_iounmap_device() after sym_attach(). */
1716 shost = sym_attach(&sym2_template, attach_count, &sym_dev);
1717 if (!shost)
1718 goto free;
1720 if (scsi_add_host(shost, &pdev->dev))
1721 goto detach;
1722 scsi_scan_host(shost);
1724 attach_count++;
1726 return 0;
1728 detach:
1729 sym_detach(pci_get_drvdata(pdev), pdev);
1730 free:
1731 if (do_iounmap)
1732 sym_iounmap_device(&sym_dev);
1733 pci_release_regions(pdev);
1734 disable:
1735 if (do_disable_device)
1736 pci_disable_device(pdev);
1737 leave:
1738 return -ENODEV;
1741 static void sym2_remove(struct pci_dev *pdev)
1743 struct Scsi_Host *shost = pci_get_drvdata(pdev);
1745 scsi_remove_host(shost);
1746 sym_detach(shost, pdev);
1747 pci_release_regions(pdev);
1748 pci_disable_device(pdev);
1750 attach_count--;
1754 * sym2_io_error_detected() - called when PCI error is detected
1755 * @pdev: pointer to PCI device
1756 * @state: current state of the PCI slot
1758 static pci_ers_result_t sym2_io_error_detected(struct pci_dev *pdev,
1759 enum pci_channel_state state)
1761 /* If slot is permanently frozen, turn everything off */
1762 if (state == pci_channel_io_perm_failure) {
1763 sym2_remove(pdev);
1764 return PCI_ERS_RESULT_DISCONNECT;
1767 disable_irq(pdev->irq);
1768 pci_disable_device(pdev);
1770 /* Request that MMIO be enabled, so register dump can be taken. */
1771 return PCI_ERS_RESULT_CAN_RECOVER;
1775 * sym2_io_slot_dump - Enable MMIO and dump debug registers
1776 * @pdev: pointer to PCI device
1778 static pci_ers_result_t sym2_io_slot_dump(struct pci_dev *pdev)
1780 struct Scsi_Host *shost = pci_get_drvdata(pdev);
1782 sym_dump_registers(shost);
1784 /* Request a slot reset. */
1785 return PCI_ERS_RESULT_NEED_RESET;
1789 * sym2_reset_workarounds - hardware-specific work-arounds
1791 * This routine is similar to sym_set_workarounds(), except
1792 * that, at this point, we already know that the device was
1793 * successfully initialized at least once before, and so most
1794 * of the steps taken there are un-needed here.
1796 static void sym2_reset_workarounds(struct pci_dev *pdev)
1798 u_short status_reg;
1799 struct sym_chip *chip;
1801 chip = sym_lookup_chip_table(pdev->device, pdev->revision);
1803 /* Work around for errant bit in 895A, in a fashion
1804 * similar to what is done in sym_set_workarounds().
1806 pci_read_config_word(pdev, PCI_STATUS, &status_reg);
1807 if (!(chip->features & FE_66MHZ) && (status_reg & PCI_STATUS_66MHZ)) {
1808 status_reg = PCI_STATUS_66MHZ;
1809 pci_write_config_word(pdev, PCI_STATUS, status_reg);
1810 pci_read_config_word(pdev, PCI_STATUS, &status_reg);
1815 * sym2_io_slot_reset() - called when the pci bus has been reset.
1816 * @pdev: pointer to PCI device
1818 * Restart the card from scratch.
1820 static pci_ers_result_t sym2_io_slot_reset(struct pci_dev *pdev)
1822 struct Scsi_Host *shost = pci_get_drvdata(pdev);
1823 struct sym_hcb *np = sym_get_hcb(shost);
1825 printk(KERN_INFO "%s: recovering from a PCI slot reset\n",
1826 sym_name(np));
1828 if (pci_enable_device(pdev)) {
1829 printk(KERN_ERR "%s: Unable to enable after PCI reset\n",
1830 sym_name(np));
1831 return PCI_ERS_RESULT_DISCONNECT;
1834 pci_set_master(pdev);
1835 enable_irq(pdev->irq);
1837 /* If the chip can do Memory Write Invalidate, enable it */
1838 if (np->features & FE_WRIE) {
1839 if (pci_set_mwi(pdev))
1840 return PCI_ERS_RESULT_DISCONNECT;
1843 /* Perform work-arounds, analogous to sym_set_workarounds() */
1844 sym2_reset_workarounds(pdev);
1846 /* Perform host reset only on one instance of the card */
1847 if (PCI_FUNC(pdev->devfn) == 0) {
1848 if (sym_reset_scsi_bus(np, 0)) {
1849 printk(KERN_ERR "%s: Unable to reset scsi host\n",
1850 sym_name(np));
1851 return PCI_ERS_RESULT_DISCONNECT;
1853 sym_start_up(shost, 1);
1856 return PCI_ERS_RESULT_RECOVERED;
1860 * sym2_io_resume() - resume normal ops after PCI reset
1861 * @pdev: pointer to PCI device
1863 * Called when the error recovery driver tells us that its
1864 * OK to resume normal operation. Use completion to allow
1865 * halted scsi ops to resume.
1867 static void sym2_io_resume(struct pci_dev *pdev)
1869 struct Scsi_Host *shost = pci_get_drvdata(pdev);
1870 struct sym_data *sym_data = shost_priv(shost);
1872 spin_lock_irq(shost->host_lock);
1873 if (sym_data->io_reset)
1874 complete(sym_data->io_reset);
1875 spin_unlock_irq(shost->host_lock);
1878 static void sym2_get_signalling(struct Scsi_Host *shost)
1880 struct sym_hcb *np = sym_get_hcb(shost);
1881 enum spi_signal_type type;
1883 switch (np->scsi_mode) {
1884 case SMODE_SE:
1885 type = SPI_SIGNAL_SE;
1886 break;
1887 case SMODE_LVD:
1888 type = SPI_SIGNAL_LVD;
1889 break;
1890 case SMODE_HVD:
1891 type = SPI_SIGNAL_HVD;
1892 break;
1893 default:
1894 type = SPI_SIGNAL_UNKNOWN;
1895 break;
1897 spi_signalling(shost) = type;
1900 static void sym2_set_offset(struct scsi_target *starget, int offset)
1902 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1903 struct sym_hcb *np = sym_get_hcb(shost);
1904 struct sym_tcb *tp = &np->target[starget->id];
1906 tp->tgoal.offset = offset;
1907 tp->tgoal.check_nego = 1;
1910 static void sym2_set_period(struct scsi_target *starget, int period)
1912 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1913 struct sym_hcb *np = sym_get_hcb(shost);
1914 struct sym_tcb *tp = &np->target[starget->id];
1916 /* have to have DT for these transfers, but DT will also
1917 * set width, so check that this is allowed */
1918 if (period <= np->minsync && spi_width(starget))
1919 tp->tgoal.dt = 1;
1921 tp->tgoal.period = period;
1922 tp->tgoal.check_nego = 1;
1925 static void sym2_set_width(struct scsi_target *starget, int width)
1927 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1928 struct sym_hcb *np = sym_get_hcb(shost);
1929 struct sym_tcb *tp = &np->target[starget->id];
1931 /* It is illegal to have DT set on narrow transfers. If DT is
1932 * clear, we must also clear IU and QAS. */
1933 if (width == 0)
1934 tp->tgoal.iu = tp->tgoal.dt = tp->tgoal.qas = 0;
1936 tp->tgoal.width = width;
1937 tp->tgoal.check_nego = 1;
1940 static void sym2_set_dt(struct scsi_target *starget, int dt)
1942 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1943 struct sym_hcb *np = sym_get_hcb(shost);
1944 struct sym_tcb *tp = &np->target[starget->id];
1946 /* We must clear QAS and IU if DT is clear */
1947 if (dt)
1948 tp->tgoal.dt = 1;
1949 else
1950 tp->tgoal.iu = tp->tgoal.dt = tp->tgoal.qas = 0;
1951 tp->tgoal.check_nego = 1;
1954 #if 0
1955 static void sym2_set_iu(struct scsi_target *starget, int iu)
1957 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1958 struct sym_hcb *np = sym_get_hcb(shost);
1959 struct sym_tcb *tp = &np->target[starget->id];
1961 if (iu)
1962 tp->tgoal.iu = tp->tgoal.dt = 1;
1963 else
1964 tp->tgoal.iu = 0;
1965 tp->tgoal.check_nego = 1;
1968 static void sym2_set_qas(struct scsi_target *starget, int qas)
1970 struct Scsi_Host *shost = dev_to_shost(starget->dev.parent);
1971 struct sym_hcb *np = sym_get_hcb(shost);
1972 struct sym_tcb *tp = &np->target[starget->id];
1974 if (qas)
1975 tp->tgoal.dt = tp->tgoal.qas = 1;
1976 else
1977 tp->tgoal.qas = 0;
1978 tp->tgoal.check_nego = 1;
1980 #endif
1982 static struct spi_function_template sym2_transport_functions = {
1983 .set_offset = sym2_set_offset,
1984 .show_offset = 1,
1985 .set_period = sym2_set_period,
1986 .show_period = 1,
1987 .set_width = sym2_set_width,
1988 .show_width = 1,
1989 .set_dt = sym2_set_dt,
1990 .show_dt = 1,
1991 #if 0
1992 .set_iu = sym2_set_iu,
1993 .show_iu = 1,
1994 .set_qas = sym2_set_qas,
1995 .show_qas = 1,
1996 #endif
1997 .get_signalling = sym2_get_signalling,
2000 static struct pci_device_id sym2_id_table[] = {
2001 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C810,
2002 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2003 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C820,
2004 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL }, /* new */
2005 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C825,
2006 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2007 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C815,
2008 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2009 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C810AP,
2010 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL }, /* new */
2011 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C860,
2012 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2013 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C1510,
2014 PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_SCSI<<8, 0xffff00, 0UL },
2015 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C896,
2016 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2017 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C895,
2018 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2019 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C885,
2020 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2021 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C875,
2022 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2023 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C1510,
2024 PCI_ANY_ID, PCI_ANY_ID, PCI_CLASS_STORAGE_SCSI<<8, 0xffff00, 0UL }, /* new */
2025 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C895A,
2026 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2027 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C875A,
2028 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2029 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C1010_33,
2030 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2031 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_LSI_53C1010_66,
2032 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2033 { PCI_VENDOR_ID_LSI_LOGIC, PCI_DEVICE_ID_NCR_53C875J,
2034 PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0UL },
2035 { 0, }
2038 MODULE_DEVICE_TABLE(pci, sym2_id_table);
2040 static const struct pci_error_handlers sym2_err_handler = {
2041 .error_detected = sym2_io_error_detected,
2042 .mmio_enabled = sym2_io_slot_dump,
2043 .slot_reset = sym2_io_slot_reset,
2044 .resume = sym2_io_resume,
2047 static struct pci_driver sym2_driver = {
2048 .name = NAME53C8XX,
2049 .id_table = sym2_id_table,
2050 .probe = sym2_probe,
2051 .remove = sym2_remove,
2052 .err_handler = &sym2_err_handler,
2055 static int __init sym2_init(void)
2057 int error;
2059 sym2_setup_params();
2060 sym2_transport_template = spi_attach_transport(&sym2_transport_functions);
2061 if (!sym2_transport_template)
2062 return -ENODEV;
2064 error = pci_register_driver(&sym2_driver);
2065 if (error)
2066 spi_release_transport(sym2_transport_template);
2067 return error;
2070 static void __exit sym2_exit(void)
2072 pci_unregister_driver(&sym2_driver);
2073 spi_release_transport(sym2_transport_template);
2076 module_init(sym2_init);
2077 module_exit(sym2_exit);