1/*----------------------------------------------------------------*/ 2/* 3 Qlogic linux driver - work in progress. No Warranty express or implied. 4 Use at your own risk. Support Tort Reform so you won't have to read all 5 these silly disclaimers. 6 7 Copyright 1994, Tom Zerucha. 8 tz@execpc.com 9 10 Additional Code, and much appreciated help by 11 Michael A. Griffith 12 grif@cs.ucr.edu 13 14 Thanks to Eric Youngdale and Dave Hinds for loadable module and PCMCIA 15 help respectively, and for suffering through my foolishness during the 16 debugging process. 17 18 Reference Qlogic FAS408 Technical Manual, 53408-510-00A, May 10, 1994 19 (you can reference it, but it is incomplete and inaccurate in places) 20 21 Version 0.46 1/30/97 - kernel 1.2.0+ 22 23 Functions as standalone, loadable, and PCMCIA driver, the latter from 24 Dave Hinds' PCMCIA package. 25 26 Cleaned up 26/10/2002 by Alan Cox <alan@lxorguk.ukuu.org.uk> as part of the 2.5 27 SCSI driver cleanup and audit. This driver still needs work on the 28 following 29 - Non terminating hardware waits 30 - Some layering violations with its pcmcia stub 31 32 Redistributable under terms of the GNU General Public License 33 34 For the avoidance of doubt the "preferred form" of this code is one which 35 is in an open non patent encumbered format. Where cryptographic key signing 36 forms part of the process of creating an executable the information 37 including keys needed to generate an equivalently functional executable 38 are deemed to be part of the source code. 39 40*/ 41 42#include <linux/module.h> 43#include <linux/blkdev.h> /* to get disk capacity */ 44#include <linux/kernel.h> 45#include <linux/string.h> 46#include <linux/init.h> 47#include <linux/interrupt.h> 48#include <linux/ioport.h> 49#include <linux/proc_fs.h> 50#include <linux/unistd.h> 51#include <linux/spinlock.h> 52#include <linux/stat.h> 53 54#include <asm/io.h> 55#include <asm/irq.h> 56#include <asm/dma.h> 57 58#include "scsi.h" 59#include <scsi/scsi_host.h> 60#include "qlogicfas408.h" 61 62/*----------------------------------------------------------------*/ 63static int qlcfg5 = (XTALFREQ << 5); /* 15625/512 */ 64static int qlcfg6 = SYNCXFRPD; 65static int qlcfg7 = SYNCOFFST; 66static int qlcfg8 = (SLOWCABLE << 7) | (QL_ENABLE_PARITY << 4); 67static int qlcfg9 = ((XTALFREQ + 4) / 5); 68static int qlcfgc = (FASTCLK << 3) | (FASTSCSI << 4); 69 70/*----------------------------------------------------------------*/ 71 72/*----------------------------------------------------------------*/ 73/* local functions */ 74/*----------------------------------------------------------------*/ 75 76/* error recovery - reset everything */ 77 78static void ql_zap(struct qlogicfas408_priv *priv) 79{ 80 int x; 81 int qbase = priv->qbase; 82 int int_type = priv->int_type; 83 84 x = inb(qbase + 0xd); 85 REG0; 86 outb(3, qbase + 3); /* reset SCSI */ 87 outb(2, qbase + 3); /* reset chip */ 88 if (x & 0x80) 89 REG1; 90} 91 92/* 93 * Do a pseudo-dma tranfer 94 */ 95 96static int ql_pdma(struct qlogicfas408_priv *priv, int phase, char *request, int reqlen) 97{ 98 int j; 99 int qbase = priv->qbase; 100 j = 0; 101 if (phase & 1) { /* in */ 102#if QL_TURBO_PDMA 103 rtrc(4) 104 /* empty fifo in large chunks */ 105 if (reqlen >= 128 && (inb(qbase + 8) & 2)) { /* full */ 106 insl(qbase + 4, request, 32); 107 reqlen -= 128; 108 request += 128; 109 } 110 while (reqlen >= 84 && !(j & 0xc0)) /* 2/3 */ 111 if ((j = inb(qbase + 8)) & 4) 112 { 113 insl(qbase + 4, request, 21); 114 reqlen -= 84; 115 request += 84; 116 } 117 if (reqlen >= 44 && (inb(qbase + 8) & 8)) { /* 1/3 */ 118 insl(qbase + 4, request, 11); 119 reqlen -= 44; 120 request += 44; 121 } 122#endif 123 /* until both empty and int (or until reclen is 0) */ 124 rtrc(7) 125 j = 0; 126 while (reqlen && !((j & 0x10) && (j & 0xc0))) 127 { 128 /* while bytes to receive and not empty */ 129 j &= 0xc0; 130 while (reqlen && !((j = inb(qbase + 8)) & 0x10)) 131 { 132 *request++ = inb(qbase + 4); 133 reqlen--; 134 } 135 if (j & 0x10) 136 j = inb(qbase + 8); 137 138 } 139 } else { /* out */ 140#if QL_TURBO_PDMA 141 rtrc(4) 142 if (reqlen >= 128 && inb(qbase + 8) & 0x10) { /* empty */ 143 outsl(qbase + 4, request, 32); 144 reqlen -= 128; 145 request += 128; 146 } 147 while (reqlen >= 84 && !(j & 0xc0)) /* 1/3 */ 148 if (!((j = inb(qbase + 8)) & 8)) { 149 outsl(qbase + 4, request, 21); 150 reqlen -= 84; 151 request += 84; 152 } 153 if (reqlen >= 40 && !(inb(qbase + 8) & 4)) { /* 2/3 */ 154 outsl(qbase + 4, request, 10); 155 reqlen -= 40; 156 request += 40; 157 } 158#endif 159 /* until full and int (or until reclen is 0) */ 160 rtrc(7) 161 j = 0; 162 while (reqlen && !((j & 2) && (j & 0xc0))) { 163 /* while bytes to send and not full */ 164 while (reqlen && !((j = inb(qbase + 8)) & 2)) 165 { 166 outb(*request++, qbase + 4); 167 reqlen--; 168 } 169 if (j & 2) 170 j = inb(qbase + 8); 171 } 172 } 173 /* maybe return reqlen */ 174 return inb(qbase + 8) & 0xc0; 175} 176 177/* 178 * Wait for interrupt flag (polled - not real hardware interrupt) 179 */ 180 181static int ql_wai(struct qlogicfas408_priv *priv) 182{ 183 int k; 184 int qbase = priv->qbase; 185 unsigned long i; 186 187 k = 0; 188 i = jiffies + WATCHDOG; 189 while (time_before(jiffies, i) && !priv->qabort && 190 !((k = inb(qbase + 4)) & 0xe0)) { 191 barrier(); 192 cpu_relax(); 193 } 194 if (time_after_eq(jiffies, i)) 195 return (DID_TIME_OUT); 196 if (priv->qabort) 197 return (priv->qabort == 1 ? DID_ABORT : DID_RESET); 198 if (k & 0x60) 199 ql_zap(priv); 200 if (k & 0x20) 201 return (DID_PARITY); 202 if (k & 0x40) 203 return (DID_ERROR); 204 return 0; 205} 206 207/* 208 * Initiate scsi command - queueing handler 209 * caller must hold host lock 210 */ 211 212static void ql_icmd(struct scsi_cmnd *cmd) 213{ 214 struct qlogicfas408_priv *priv = get_priv_by_cmd(cmd); 215 int qbase = priv->qbase; 216 int int_type = priv->int_type; 217 unsigned int i; 218 219 priv->qabort = 0; 220 221 REG0; 222 /* clearing of interrupts and the fifo is needed */ 223 224 inb(qbase + 5); /* clear interrupts */ 225 if (inb(qbase + 5)) /* if still interrupting */ 226 outb(2, qbase + 3); /* reset chip */ 227 else if (inb(qbase + 7) & 0x1f) 228 outb(1, qbase + 3); /* clear fifo */ 229 while (inb(qbase + 5)); /* clear ints */ 230 REG1; 231 outb(1, qbase + 8); /* set for PIO pseudo DMA */ 232 outb(0, qbase + 0xb); /* disable ints */ 233 inb(qbase + 8); /* clear int bits */ 234 REG0; 235 outb(0x40, qbase + 0xb); /* enable features */ 236 237 /* configurables */ 238 outb(qlcfgc, qbase + 0xc); 239 /* config: no reset interrupt, (initiator) bus id */ 240 outb(0x40 | qlcfg8 | priv->qinitid, qbase + 8); 241 outb(qlcfg7, qbase + 7); 242 outb(qlcfg6, qbase + 6); 243 /**/ outb(qlcfg5, qbase + 5); /* select timer */ 244 outb(qlcfg9 & 7, qbase + 9); /* prescaler */ 245/* outb(0x99, qbase + 5); */ 246 outb(scmd_id(cmd), qbase + 4); 247 248 for (i = 0; i < cmd->cmd_len; i++) 249 outb(cmd->cmnd[i], qbase + 2); 250 251 priv->qlcmd = cmd; 252 outb(0x41, qbase + 3); /* select and send command */ 253} 254 255/* 256 * Process scsi command - usually after interrupt 257 */ 258 259static unsigned int ql_pcmd(struct scsi_cmnd *cmd) 260{ 261 unsigned int i, j; 262 unsigned long k; 263 unsigned int result; /* ultimate return result */ 264 unsigned int status; /* scsi returned status */ 265 unsigned int message; /* scsi returned message */ 266 unsigned int phase; /* recorded scsi phase */ 267 unsigned int reqlen; /* total length of transfer */ 268 char *buf; 269 struct qlogicfas408_priv *priv = get_priv_by_cmd(cmd); 270 int qbase = priv->qbase; 271 int int_type = priv->int_type; 272 273 rtrc(1) 274 j = inb(qbase + 6); 275 i = inb(qbase + 5); 276 if (i == 0x20) { 277 return (DID_NO_CONNECT << 16); 278 } 279 i |= inb(qbase + 5); /* the 0x10 bit can be set after the 0x08 */ 280 if (i != 0x18) { 281 printk(KERN_ERR "Ql:Bad Interrupt status:%02x\n", i); 282 ql_zap(priv); 283 return (DID_BAD_INTR << 16); 284 } 285 j &= 7; /* j = inb( qbase + 7 ) >> 5; */ 286 287 /* correct status is supposed to be step 4 */ 288 /* it sometimes returns step 3 but with 0 bytes left to send */ 289 /* We can try stuffing the FIFO with the max each time, but we will get a 290 sequence of 3 if any bytes are left (but we do flush the FIFO anyway */ 291 292 if (j != 3 && j != 4) { 293 printk(KERN_ERR "Ql:Bad sequence for command %d, int %02X, cmdleft = %d\n", 294 j, i, inb(qbase + 7) & 0x1f); 295 ql_zap(priv); 296 return (DID_ERROR << 16); 297 } 298 result = DID_OK; 299 if (inb(qbase + 7) & 0x1f) /* if some bytes in fifo */ 300 outb(1, qbase + 3); /* clear fifo */ 301 /* note that request_bufflen is the total xfer size when sg is used */ 302 reqlen = scsi_bufflen(cmd); 303 /* note that it won't work if transfers > 16M are requested */ 304 if (reqlen && !((phase = inb(qbase + 4)) & 6)) { /* data phase */ 305 struct scatterlist *sg; 306 rtrc(2) 307 outb(reqlen, qbase); /* low-mid xfer cnt */ 308 outb(reqlen >> 8, qbase + 1); /* low-mid xfer cnt */ 309 outb(reqlen >> 16, qbase + 0xe); /* high xfer cnt */ 310 outb(0x90, qbase + 3); /* command do xfer */ 311 /* PIO pseudo DMA to buffer or sglist */ 312 REG1; 313 314 scsi_for_each_sg(cmd, sg, scsi_sg_count(cmd), i) { 315 if (priv->qabort) { 316 REG0; 317 return ((priv->qabort == 1 ? 318 DID_ABORT : DID_RESET) << 16); 319 } 320 buf = sg_virt(sg); 321 if (ql_pdma(priv, phase, buf, sg->length)) 322 break; 323 } 324 REG0; 325 rtrc(2) 326 /* 327 * Wait for irq (split into second state of irq handler 328 * if this can take time) 329 */ 330 if ((k = ql_wai(priv))) 331 return (k << 16); 332 k = inb(qbase + 5); /* should be 0x10, bus service */ 333 } 334 335 /* 336 * Enter Status (and Message In) Phase 337 */ 338 339 k = jiffies + WATCHDOG; 340 341 while (time_before(jiffies, k) && !priv->qabort && 342 !(inb(qbase + 4) & 6)) 343 cpu_relax(); /* wait for status phase */ 344 345 if (time_after_eq(jiffies, k)) { 346 ql_zap(priv); 347 return (DID_TIME_OUT << 16); 348 } 349 350 while (inb(qbase + 5)) 351 cpu_relax(); /* clear pending ints */ 352 353 if (priv->qabort) 354 return ((priv->qabort == 1 ? DID_ABORT : DID_RESET) << 16); 355 356 outb(0x11, qbase + 3); /* get status and message */ 357 if ((k = ql_wai(priv))) 358 return (k << 16); 359 i = inb(qbase + 5); /* get chip irq stat */ 360 j = inb(qbase + 7) & 0x1f; /* and bytes rec'd */ 361 status = inb(qbase + 2); 362 message = inb(qbase + 2); 363 364 /* 365 * Should get function complete int if Status and message, else 366 * bus serv if only status 367 */ 368 if (!((i == 8 && j == 2) || (i == 0x10 && j == 1))) { 369 printk(KERN_ERR "Ql:Error during status phase, int=%02X, %d bytes recd\n", i, j); 370 result = DID_ERROR; 371 } 372 outb(0x12, qbase + 3); /* done, disconnect */ 373 rtrc(1) 374 if ((k = ql_wai(priv))) 375 return (k << 16); 376 377 /* 378 * Should get bus service interrupt and disconnect interrupt 379 */ 380 381 i = inb(qbase + 5); /* should be bus service */ 382 while (!priv->qabort && ((i & 0x20) != 0x20)) { 383 barrier(); 384 cpu_relax(); 385 i |= inb(qbase + 5); 386 } 387 rtrc(0) 388 389 if (priv->qabort) 390 return ((priv->qabort == 1 ? DID_ABORT : DID_RESET) << 16); 391 392 return (result << 16) | (message << 8) | (status & STATUS_MASK); 393} 394 395/* 396 * Interrupt handler 397 */ 398 399static void ql_ihandl(void *dev_id) 400{ 401 struct scsi_cmnd *icmd; 402 struct Scsi_Host *host = dev_id; 403 struct qlogicfas408_priv *priv = get_priv_by_host(host); 404 int qbase = priv->qbase; 405 REG0; 406 407 if (!(inb(qbase + 4) & 0x80)) /* false alarm? */ 408 return; 409 410 if (priv->qlcmd == NULL) { /* no command to process? */ 411 int i; 412 i = 16; 413 while (i-- && inb(qbase + 5)); /* maybe also ql_zap() */ 414 return; 415 } 416 icmd = priv->qlcmd; 417 icmd->result = ql_pcmd(icmd); 418 priv->qlcmd = NULL; 419 /* 420 * If result is CHECK CONDITION done calls qcommand to request 421 * sense 422 */ 423 (icmd->scsi_done) (icmd); 424} 425 426irqreturn_t qlogicfas408_ihandl(int irq, void *dev_id) 427{ 428 unsigned long flags; 429 struct Scsi_Host *host = dev_id; 430 431 spin_lock_irqsave(host->host_lock, flags); 432 ql_ihandl(dev_id); 433 spin_unlock_irqrestore(host->host_lock, flags); 434 return IRQ_HANDLED; 435} 436 437/* 438 * Queued command 439 */ 440 441int qlogicfas408_queuecommand(struct scsi_cmnd *cmd, 442 void (*done) (struct scsi_cmnd *)) 443{ 444 struct qlogicfas408_priv *priv = get_priv_by_cmd(cmd); 445 if (scmd_id(cmd) == priv->qinitid) { 446 cmd->result = DID_BAD_TARGET << 16; 447 done(cmd); 448 return 0; 449 } 450 451 cmd->scsi_done = done; 452 /* wait for the last command's interrupt to finish */ 453 while (priv->qlcmd != NULL) { 454 barrier(); 455 cpu_relax(); 456 } 457 ql_icmd(cmd); 458 return 0; 459} 460 461/* 462 * Return bios parameters 463 */ 464 465int qlogicfas408_biosparam(struct scsi_device *disk, struct block_device *dev, 466 sector_t capacity, int ip[]) 467{ 468/* This should mimic the DOS Qlogic driver's behavior exactly */ 469 ip[0] = 0x40; 470 ip[1] = 0x20; 471 ip[2] = (unsigned long) capacity / (ip[0] * ip[1]); 472 if (ip[2] > 1024) { 473 ip[0] = 0xff; 474 ip[1] = 0x3f; 475 ip[2] = (unsigned long) capacity / (ip[0] * ip[1]); 476 } 477 return 0; 478} 479 480/* 481 * Abort a command in progress 482 */ 483 484int qlogicfas408_abort(struct scsi_cmnd *cmd) 485{ 486 struct qlogicfas408_priv *priv = get_priv_by_cmd(cmd); 487 priv->qabort = 1; 488 ql_zap(priv); 489 return SUCCESS; 490} 491 492 493int qlogicfas408_bus_reset(struct scsi_cmnd *cmd) 494{ 495 struct qlogicfas408_priv *priv = get_priv_by_cmd(cmd); 496 unsigned long flags; 497 498 priv->qabort = 2; 499 500 spin_lock_irqsave(cmd->device->host->host_lock, flags); 501 ql_zap(priv); 502 spin_unlock_irqrestore(cmd->device->host->host_lock, flags); 503 504 return SUCCESS; 505} 506 507/* 508 * Return info string 509 */ 510 511const char *qlogicfas408_info(struct Scsi_Host *host) 512{ 513 struct qlogicfas408_priv *priv = get_priv_by_host(host); 514 return priv->qinfo; 515} 516 517/* 518 * Get type of chip 519 */ 520 521int qlogicfas408_get_chip_type(int qbase, int int_type) 522{ 523 REG1; 524 return inb(qbase + 0xe) & 0xf8; 525} 526 527/* 528 * Perform initialization tasks 529 */ 530 531void qlogicfas408_setup(int qbase, int id, int int_type) 532{ 533 outb(1, qbase + 8); /* set for PIO pseudo DMA */ 534 REG0; 535 outb(0x40 | qlcfg8 | id, qbase + 8); /* (ini) bus id, disable scsi rst */ 536 outb(qlcfg5, qbase + 5); /* select timer */ 537 outb(qlcfg9, qbase + 9); /* prescaler */ 538 539#if QL_RESET_AT_START 540 outb(3, qbase + 3); 541 542 REG1; 543 while (inb(qbase + 0xf) & 4) 544 cpu_relax(); 545 546 REG0; 547#endif 548} 549 550/* 551 * Checks if this is a QLogic FAS 408 552 */ 553 554int qlogicfas408_detect(int qbase, int int_type) 555{ 556 REG1; 557 return (((inb(qbase + 0xe) ^ inb(qbase + 0xe)) == 7) && 558 ((inb(qbase + 0xe) ^ inb(qbase + 0xe)) == 7)); 559} 560 561/* 562 * Disable interrupts 563 */ 564 565void qlogicfas408_disable_ints(struct qlogicfas408_priv *priv) 566{ 567 int qbase = priv->qbase; 568 int int_type = priv->int_type; 569 570 REG1; 571 outb(0, qbase + 0xb); /* disable ints */ 572} 573 574/* 575 * Init and exit functions 576 */ 577 578static int __init qlogicfas408_init(void) 579{ 580 return 0; 581} 582 583static void __exit qlogicfas408_exit(void) 584{ 585 586} 587 588MODULE_AUTHOR("Tom Zerucha, Michael Griffith"); 589MODULE_DESCRIPTION("Driver for the Qlogic FAS SCSI controllers"); 590MODULE_LICENSE("GPL"); 591module_init(qlogicfas408_init); 592module_exit(qlogicfas408_exit); 593 594EXPORT_SYMBOL(qlogicfas408_info); 595EXPORT_SYMBOL(qlogicfas408_queuecommand); 596EXPORT_SYMBOL(qlogicfas408_abort); 597EXPORT_SYMBOL(qlogicfas408_bus_reset); 598EXPORT_SYMBOL(qlogicfas408_biosparam); 599EXPORT_SYMBOL(qlogicfas408_ihandl); 600EXPORT_SYMBOL(qlogicfas408_get_chip_type); 601EXPORT_SYMBOL(qlogicfas408_setup); 602EXPORT_SYMBOL(qlogicfas408_detect); 603EXPORT_SYMBOL(qlogicfas408_disable_ints); 604