1/* imm.c -- low level driver for the IOMEGA MatchMaker 2 * parallel port SCSI host adapter. 3 * 4 * (The IMM is the embedded controller in the ZIP Plus drive.) 5 * 6 * My unoffical company acronym list is 21 pages long: 7 * FLA: Four letter acronym with built in facility for 8 * future expansion to five letters. 9 */ 10 11#include <linux/init.h> 12#include <linux/kernel.h> 13#include <linux/module.h> 14#include <linux/blkdev.h> 15#include <linux/parport.h> 16#include <linux/workqueue.h> 17#include <linux/delay.h> 18#include <linux/slab.h> 19#include <asm/io.h> 20 21#include <scsi/scsi.h> 22#include <scsi/scsi_cmnd.h> 23#include <scsi/scsi_device.h> 24#include <scsi/scsi_host.h> 25 26/* The following #define is to avoid a clash with hosts.c */ 27#define IMM_PROBE_SPP 0x0001 28#define IMM_PROBE_PS2 0x0002 29#define IMM_PROBE_ECR 0x0010 30#define IMM_PROBE_EPP17 0x0100 31#define IMM_PROBE_EPP19 0x0200 32 33 34typedef struct { 35 struct pardevice *dev; /* Parport device entry */ 36 int base; /* Actual port address */ 37 int base_hi; /* Hi Base address for ECP-ISA chipset */ 38 int mode; /* Transfer mode */ 39 struct scsi_cmnd *cur_cmd; /* Current queued command */ 40 struct delayed_work imm_tq; /* Polling interrupt stuff */ 41 unsigned long jstart; /* Jiffies at start */ 42 unsigned failed:1; /* Failure flag */ 43 unsigned dp:1; /* Data phase present */ 44 unsigned rd:1; /* Read data in data phase */ 45 unsigned wanted:1; /* Parport sharing busy flag */ 46 wait_queue_head_t *waiting; 47 struct Scsi_Host *host; 48 struct list_head list; 49} imm_struct; 50 51static void imm_reset_pulse(unsigned int base); 52static int device_check(imm_struct *dev); 53 54#include "imm.h" 55 56static inline imm_struct *imm_dev(struct Scsi_Host *host) 57{ 58 return *(imm_struct **)&host->hostdata; 59} 60 61static DEFINE_SPINLOCK(arbitration_lock); 62 63static void got_it(imm_struct *dev) 64{ 65 dev->base = dev->dev->port->base; 66 if (dev->cur_cmd) 67 dev->cur_cmd->SCp.phase = 1; 68 else 69 wake_up(dev->waiting); 70} 71 72static void imm_wakeup(void *ref) 73{ 74 imm_struct *dev = (imm_struct *) ref; 75 unsigned long flags; 76 77 spin_lock_irqsave(&arbitration_lock, flags); 78 if (dev->wanted) { 79 parport_claim(dev->dev); 80 got_it(dev); 81 dev->wanted = 0; 82 } 83 spin_unlock_irqrestore(&arbitration_lock, flags); 84} 85 86static int imm_pb_claim(imm_struct *dev) 87{ 88 unsigned long flags; 89 int res = 1; 90 spin_lock_irqsave(&arbitration_lock, flags); 91 if (parport_claim(dev->dev) == 0) { 92 got_it(dev); 93 res = 0; 94 } 95 dev->wanted = res; 96 spin_unlock_irqrestore(&arbitration_lock, flags); 97 return res; 98} 99 100static void imm_pb_dismiss(imm_struct *dev) 101{ 102 unsigned long flags; 103 int wanted; 104 spin_lock_irqsave(&arbitration_lock, flags); 105 wanted = dev->wanted; 106 dev->wanted = 0; 107 spin_unlock_irqrestore(&arbitration_lock, flags); 108 if (!wanted) 109 parport_release(dev->dev); 110} 111 112static inline void imm_pb_release(imm_struct *dev) 113{ 114 parport_release(dev->dev); 115} 116 117/* This is to give the imm driver a way to modify the timings (and other 118 * parameters) by writing to the /proc/scsi/imm/0 file. 119 * Very simple method really... (Too simple, no error checking :( ) 120 * Reason: Kernel hackers HATE having to unload and reload modules for 121 * testing... 122 * Also gives a method to use a script to obtain optimum timings (TODO) 123 */ 124static inline int imm_proc_write(imm_struct *dev, char *buffer, int length) 125{ 126 unsigned long x; 127 128 if ((length > 5) && (strncmp(buffer, "mode=", 5) == 0)) { 129 x = simple_strtoul(buffer + 5, NULL, 0); 130 dev->mode = x; 131 return length; 132 } 133 printk("imm /proc: invalid variable\n"); 134 return (-EINVAL); 135} 136 137static int imm_proc_info(struct Scsi_Host *host, char *buffer, char **start, 138 off_t offset, int length, int inout) 139{ 140 imm_struct *dev = imm_dev(host); 141 int len = 0; 142 143 if (inout) 144 return imm_proc_write(dev, buffer, length); 145 146 len += sprintf(buffer + len, "Version : %s\n", IMM_VERSION); 147 len += 148 sprintf(buffer + len, "Parport : %s\n", 149 dev->dev->port->name); 150 len += 151 sprintf(buffer + len, "Mode : %s\n", 152 IMM_MODE_STRING[dev->mode]); 153 154 /* Request for beyond end of buffer */ 155 if (offset > len) 156 return 0; 157 158 *start = buffer + offset; 159 len -= offset; 160 if (len > length) 161 len = length; 162 return len; 163} 164 165#if IMM_DEBUG > 0 166#define imm_fail(x,y) printk("imm: imm_fail(%i) from %s at line %d\n",\ 167 y, __func__, __LINE__); imm_fail_func(x,y); 168static inline void 169imm_fail_func(imm_struct *dev, int error_code) 170#else 171static inline void 172imm_fail(imm_struct *dev, int error_code) 173#endif 174{ 175 /* If we fail a device then we trash status / message bytes */ 176 if (dev->cur_cmd) { 177 dev->cur_cmd->result = error_code << 16; 178 dev->failed = 1; 179 } 180} 181 182/* 183 * Wait for the high bit to be set. 184 * 185 * In principle, this could be tied to an interrupt, but the adapter 186 * doesn't appear to be designed to support interrupts. We spin on 187 * the 0x80 ready bit. 188 */ 189static unsigned char imm_wait(imm_struct *dev) 190{ 191 int k; 192 unsigned short ppb = dev->base; 193 unsigned char r; 194 195 w_ctr(ppb, 0x0c); 196 197 k = IMM_SPIN_TMO; 198 do { 199 r = r_str(ppb); 200 k--; 201 udelay(1); 202 } 203 while (!(r & 0x80) && (k)); 204 205 /* 206 * STR register (LPT base+1) to SCSI mapping: 207 * 208 * STR imm imm 209 * =================================== 210 * 0x80 S_REQ S_REQ 211 * 0x40 !S_BSY (????) 212 * 0x20 !S_CD !S_CD 213 * 0x10 !S_IO !S_IO 214 * 0x08 (????) !S_BSY 215 * 216 * imm imm meaning 217 * ================================== 218 * 0xf0 0xb8 Bit mask 219 * 0xc0 0x88 ZIP wants more data 220 * 0xd0 0x98 ZIP wants to send more data 221 * 0xe0 0xa8 ZIP is expecting SCSI command data 222 * 0xf0 0xb8 end of transfer, ZIP is sending status 223 */ 224 w_ctr(ppb, 0x04); 225 if (k) 226 return (r & 0xb8); 227 228 /* Counter expired - Time out occurred */ 229 imm_fail(dev, DID_TIME_OUT); 230 printk("imm timeout in imm_wait\n"); 231 return 0; /* command timed out */ 232} 233 234static int imm_negotiate(imm_struct * tmp) 235{ 236 /* 237 * The following is supposedly the IEEE 1284-1994 negotiate 238 * sequence. I have yet to obtain a copy of the above standard 239 * so this is a bit of a guess... 240 * 241 * A fair chunk of this is based on the Linux parport implementation 242 * of IEEE 1284. 243 * 244 * Return 0 if data available 245 * 1 if no data available 246 */ 247 248 unsigned short base = tmp->base; 249 unsigned char a, mode; 250 251 switch (tmp->mode) { 252 case IMM_NIBBLE: 253 mode = 0x00; 254 break; 255 case IMM_PS2: 256 mode = 0x01; 257 break; 258 default: 259 return 0; 260 } 261 262 w_ctr(base, 0x04); 263 udelay(5); 264 w_dtr(base, mode); 265 udelay(100); 266 w_ctr(base, 0x06); 267 udelay(5); 268 a = (r_str(base) & 0x20) ? 0 : 1; 269 udelay(5); 270 w_ctr(base, 0x07); 271 udelay(5); 272 w_ctr(base, 0x06); 273 274 if (a) { 275 printk 276 ("IMM: IEEE1284 negotiate indicates no data available.\n"); 277 imm_fail(tmp, DID_ERROR); 278 } 279 return a; 280} 281 282/* 283 * Clear EPP timeout bit. 284 */ 285static inline void epp_reset(unsigned short ppb) 286{ 287 int i; 288 289 i = r_str(ppb); 290 w_str(ppb, i); 291 w_str(ppb, i & 0xfe); 292} 293 294/* 295 * Wait for empty ECP fifo (if we are in ECP fifo mode only) 296 */ 297static inline void ecp_sync(imm_struct *dev) 298{ 299 int i, ppb_hi = dev->base_hi; 300 301 if (ppb_hi == 0) 302 return; 303 304 if ((r_ecr(ppb_hi) & 0xe0) == 0x60) { /* mode 011 == ECP fifo mode */ 305 for (i = 0; i < 100; i++) { 306 if (r_ecr(ppb_hi) & 0x01) 307 return; 308 udelay(5); 309 } 310 printk("imm: ECP sync failed as data still present in FIFO.\n"); 311 } 312} 313 314static int imm_byte_out(unsigned short base, const char *buffer, int len) 315{ 316 int i; 317 318 w_ctr(base, 0x4); /* apparently a sane mode */ 319 for (i = len >> 1; i; i--) { 320 w_dtr(base, *buffer++); 321 w_ctr(base, 0x5); /* Drop STROBE low */ 322 w_dtr(base, *buffer++); 323 w_ctr(base, 0x0); /* STROBE high + INIT low */ 324 } 325 w_ctr(base, 0x4); /* apparently a sane mode */ 326 return 1; /* All went well - we hope! */ 327} 328 329static int imm_nibble_in(unsigned short base, char *buffer, int len) 330{ 331 unsigned char l; 332 int i; 333 334 /* 335 * The following is based on documented timing signals 336 */ 337 w_ctr(base, 0x4); 338 for (i = len; i; i--) { 339 w_ctr(base, 0x6); 340 l = (r_str(base) & 0xf0) >> 4; 341 w_ctr(base, 0x5); 342 *buffer++ = (r_str(base) & 0xf0) | l; 343 w_ctr(base, 0x4); 344 } 345 return 1; /* All went well - we hope! */ 346} 347 348static int imm_byte_in(unsigned short base, char *buffer, int len) 349{ 350 int i; 351 352 /* 353 * The following is based on documented timing signals 354 */ 355 w_ctr(base, 0x4); 356 for (i = len; i; i--) { 357 w_ctr(base, 0x26); 358 *buffer++ = r_dtr(base); 359 w_ctr(base, 0x25); 360 } 361 return 1; /* All went well - we hope! */ 362} 363 364static int imm_out(imm_struct *dev, char *buffer, int len) 365{ 366 unsigned short ppb = dev->base; 367 int r = imm_wait(dev); 368 369 /* 370 * Make sure that: 371 * a) the SCSI bus is BUSY (device still listening) 372 * b) the device is listening 373 */ 374 if ((r & 0x18) != 0x08) { 375 imm_fail(dev, DID_ERROR); 376 printk("IMM: returned SCSI status %2x\n", r); 377 return 0; 378 } 379 switch (dev->mode) { 380 case IMM_EPP_32: 381 case IMM_EPP_16: 382 case IMM_EPP_8: 383 epp_reset(ppb); 384 w_ctr(ppb, 0x4); 385#ifdef CONFIG_SCSI_IZIP_EPP16 386 if (!(((long) buffer | len) & 0x01)) 387 outsw(ppb + 4, buffer, len >> 1); 388#else 389 if (!(((long) buffer | len) & 0x03)) 390 outsl(ppb + 4, buffer, len >> 2); 391#endif 392 else 393 outsb(ppb + 4, buffer, len); 394 w_ctr(ppb, 0xc); 395 r = !(r_str(ppb) & 0x01); 396 w_ctr(ppb, 0xc); 397 ecp_sync(dev); 398 break; 399 400 case IMM_NIBBLE: 401 case IMM_PS2: 402 /* 8 bit output, with a loop */ 403 r = imm_byte_out(ppb, buffer, len); 404 break; 405 406 default: 407 printk("IMM: bug in imm_out()\n"); 408 r = 0; 409 } 410 return r; 411} 412 413static int imm_in(imm_struct *dev, char *buffer, int len) 414{ 415 unsigned short ppb = dev->base; 416 int r = imm_wait(dev); 417 418 /* 419 * Make sure that: 420 * a) the SCSI bus is BUSY (device still listening) 421 * b) the device is sending data 422 */ 423 if ((r & 0x18) != 0x18) { 424 imm_fail(dev, DID_ERROR); 425 return 0; 426 } 427 switch (dev->mode) { 428 case IMM_NIBBLE: 429 /* 4 bit input, with a loop */ 430 r = imm_nibble_in(ppb, buffer, len); 431 w_ctr(ppb, 0xc); 432 break; 433 434 case IMM_PS2: 435 /* 8 bit input, with a loop */ 436 r = imm_byte_in(ppb, buffer, len); 437 w_ctr(ppb, 0xc); 438 break; 439 440 case IMM_EPP_32: 441 case IMM_EPP_16: 442 case IMM_EPP_8: 443 epp_reset(ppb); 444 w_ctr(ppb, 0x24); 445#ifdef CONFIG_SCSI_IZIP_EPP16 446 if (!(((long) buffer | len) & 0x01)) 447 insw(ppb + 4, buffer, len >> 1); 448#else 449 if (!(((long) buffer | len) & 0x03)) 450 insl(ppb + 4, buffer, len >> 2); 451#endif 452 else 453 insb(ppb + 4, buffer, len); 454 w_ctr(ppb, 0x2c); 455 r = !(r_str(ppb) & 0x01); 456 w_ctr(ppb, 0x2c); 457 ecp_sync(dev); 458 break; 459 460 default: 461 printk("IMM: bug in imm_ins()\n"); 462 r = 0; 463 break; 464 } 465 return r; 466} 467 468static int imm_cpp(unsigned short ppb, unsigned char b) 469{ 470 /* 471 * Comments on udelay values refer to the 472 * Command Packet Protocol (CPP) timing diagram. 473 */ 474 475 unsigned char s1, s2, s3; 476 w_ctr(ppb, 0x0c); 477 udelay(2); /* 1 usec - infinite */ 478 w_dtr(ppb, 0xaa); 479 udelay(10); /* 7 usec - infinite */ 480 w_dtr(ppb, 0x55); 481 udelay(10); /* 7 usec - infinite */ 482 w_dtr(ppb, 0x00); 483 udelay(10); /* 7 usec - infinite */ 484 w_dtr(ppb, 0xff); 485 udelay(10); /* 7 usec - infinite */ 486 s1 = r_str(ppb) & 0xb8; 487 w_dtr(ppb, 0x87); 488 udelay(10); /* 7 usec - infinite */ 489 s2 = r_str(ppb) & 0xb8; 490 w_dtr(ppb, 0x78); 491 udelay(10); /* 7 usec - infinite */ 492 s3 = r_str(ppb) & 0x38; 493 w_dtr(ppb, b); 494 udelay(2); /* 1 usec - infinite */ 495 w_ctr(ppb, 0x0c); 496 udelay(10); /* 7 usec - infinite */ 497 w_ctr(ppb, 0x0d); 498 udelay(2); /* 1 usec - infinite */ 499 w_ctr(ppb, 0x0c); 500 udelay(10); /* 7 usec - infinite */ 501 w_dtr(ppb, 0xff); 502 udelay(10); /* 7 usec - infinite */ 503 504 /* 505 * The following table is electrical pin values. 506 * (BSY is inverted at the CTR register) 507 * 508 * BSY ACK POut SEL Fault 509 * S1 0 X 1 1 1 510 * S2 1 X 0 1 1 511 * S3 L X 1 1 S 512 * 513 * L => Last device in chain 514 * S => Selected 515 * 516 * Observered values for S1,S2,S3 are: 517 * Disconnect => f8/58/78 518 * Connect => f8/58/70 519 */ 520 if ((s1 == 0xb8) && (s2 == 0x18) && (s3 == 0x30)) 521 return 1; /* Connected */ 522 if ((s1 == 0xb8) && (s2 == 0x18) && (s3 == 0x38)) 523 return 0; /* Disconnected */ 524 525 return -1; /* No device present */ 526} 527 528static inline int imm_connect(imm_struct *dev, int flag) 529{ 530 unsigned short ppb = dev->base; 531 532 imm_cpp(ppb, 0xe0); /* Select device 0 in compatible mode */ 533 imm_cpp(ppb, 0x30); /* Disconnect all devices */ 534 535 if ((dev->mode == IMM_EPP_8) || 536 (dev->mode == IMM_EPP_16) || 537 (dev->mode == IMM_EPP_32)) 538 return imm_cpp(ppb, 0x28); /* Select device 0 in EPP mode */ 539 return imm_cpp(ppb, 0xe0); /* Select device 0 in compatible mode */ 540} 541 542static void imm_disconnect(imm_struct *dev) 543{ 544 imm_cpp(dev->base, 0x30); /* Disconnect all devices */ 545} 546 547static int imm_select(imm_struct *dev, int target) 548{ 549 int k; 550 unsigned short ppb = dev->base; 551 552 /* 553 * Firstly we want to make sure there is nothing 554 * holding onto the SCSI bus. 555 */ 556 w_ctr(ppb, 0xc); 557 558 k = IMM_SELECT_TMO; 559 do { 560 k--; 561 } while ((r_str(ppb) & 0x08) && (k)); 562 563 if (!k) 564 return 0; 565 566 /* 567 * Now assert the SCSI ID (HOST and TARGET) on the data bus 568 */ 569 w_ctr(ppb, 0x4); 570 w_dtr(ppb, 0x80 | (1 << target)); 571 udelay(1); 572 573 /* 574 * Deassert SELIN first followed by STROBE 575 */ 576 w_ctr(ppb, 0xc); 577 w_ctr(ppb, 0xd); 578 579 /* 580 * ACK should drop low while SELIN is deasserted. 581 * FAULT should drop low when the SCSI device latches the bus. 582 */ 583 k = IMM_SELECT_TMO; 584 do { 585 k--; 586 } 587 while (!(r_str(ppb) & 0x08) && (k)); 588 589 /* 590 * Place the interface back into a sane state (status mode) 591 */ 592 w_ctr(ppb, 0xc); 593 return (k) ? 1 : 0; 594} 595 596static int imm_init(imm_struct *dev) 597{ 598 if (imm_connect(dev, 0) != 1) 599 return -EIO; 600 imm_reset_pulse(dev->base); 601 mdelay(1); /* Delay to allow devices to settle */ 602 imm_disconnect(dev); 603 mdelay(1); /* Another delay to allow devices to settle */ 604 return device_check(dev); 605} 606 607static inline int imm_send_command(struct scsi_cmnd *cmd) 608{ 609 imm_struct *dev = imm_dev(cmd->device->host); 610 int k; 611 612 /* NOTE: IMM uses byte pairs */ 613 for (k = 0; k < cmd->cmd_len; k += 2) 614 if (!imm_out(dev, &cmd->cmnd[k], 2)) 615 return 0; 616 return 1; 617} 618 619/* 620 * The bulk flag enables some optimisations in the data transfer loops, 621 * it should be true for any command that transfers data in integral 622 * numbers of sectors. 623 * 624 * The driver appears to remain stable if we speed up the parallel port 625 * i/o in this function, but not elsewhere. 626 */ 627static int imm_completion(struct scsi_cmnd *cmd) 628{ 629 /* Return codes: 630 * -1 Error 631 * 0 Told to schedule 632 * 1 Finished data transfer 633 */ 634 imm_struct *dev = imm_dev(cmd->device->host); 635 unsigned short ppb = dev->base; 636 unsigned long start_jiffies = jiffies; 637 638 unsigned char r, v; 639 int fast, bulk, status; 640 641 v = cmd->cmnd[0]; 642 bulk = ((v == READ_6) || 643 (v == READ_10) || (v == WRITE_6) || (v == WRITE_10)); 644 645 /* 646 * We only get here if the drive is ready to comunicate, 647 * hence no need for a full imm_wait. 648 */ 649 w_ctr(ppb, 0x0c); 650 r = (r_str(ppb) & 0xb8); 651 652 /* 653 * while (device is not ready to send status byte) 654 * loop; 655 */ 656 while (r != (unsigned char) 0xb8) { 657 /* 658 * If we have been running for more than a full timer tick 659 * then take a rest. 660 */ 661 if (time_after(jiffies, start_jiffies + 1)) 662 return 0; 663 664 /* 665 * FAIL if: 666 * a) Drive status is screwy (!ready && !present) 667 * b) Drive is requesting/sending more data than expected 668 */ 669 if (((r & 0x88) != 0x88) || (cmd->SCp.this_residual <= 0)) { 670 imm_fail(dev, DID_ERROR); 671 return -1; /* ERROR_RETURN */ 672 } 673 /* determine if we should use burst I/O */ 674 if (dev->rd == 0) { 675 fast = (bulk 676 && (cmd->SCp.this_residual >= 677 IMM_BURST_SIZE)) ? IMM_BURST_SIZE : 2; 678 status = imm_out(dev, cmd->SCp.ptr, fast); 679 } else { 680 fast = (bulk 681 && (cmd->SCp.this_residual >= 682 IMM_BURST_SIZE)) ? IMM_BURST_SIZE : 1; 683 status = imm_in(dev, cmd->SCp.ptr, fast); 684 } 685 686 cmd->SCp.ptr += fast; 687 cmd->SCp.this_residual -= fast; 688 689 if (!status) { 690 imm_fail(dev, DID_BUS_BUSY); 691 return -1; /* ERROR_RETURN */ 692 } 693 if (cmd->SCp.buffer && !cmd->SCp.this_residual) { 694 /* if scatter/gather, advance to the next segment */ 695 if (cmd->SCp.buffers_residual--) { 696 cmd->SCp.buffer++; 697 cmd->SCp.this_residual = 698 cmd->SCp.buffer->length; 699 cmd->SCp.ptr = sg_virt(cmd->SCp.buffer); 700 701 /* 702 * Make sure that we transfer even number of bytes 703 * otherwise it makes imm_byte_out() messy. 704 */ 705 if (cmd->SCp.this_residual & 0x01) 706 cmd->SCp.this_residual++; 707 } 708 } 709 /* Now check to see if the drive is ready to comunicate */ 710 w_ctr(ppb, 0x0c); 711 r = (r_str(ppb) & 0xb8); 712 713 /* If not, drop back down to the scheduler and wait a timer tick */ 714 if (!(r & 0x80)) 715 return 0; 716 } 717 return 1; /* FINISH_RETURN */ 718} 719 720/* 721 * Since the IMM itself doesn't generate interrupts, we use 722 * the scheduler's task queue to generate a stream of call-backs and 723 * complete the request when the drive is ready. 724 */ 725static void imm_interrupt(struct work_struct *work) 726{ 727 imm_struct *dev = container_of(work, imm_struct, imm_tq.work); 728 struct scsi_cmnd *cmd = dev->cur_cmd; 729 struct Scsi_Host *host = cmd->device->host; 730 unsigned long flags; 731 732 if (imm_engine(dev, cmd)) { 733 schedule_delayed_work(&dev->imm_tq, 1); 734 return; 735 } 736 /* Command must of completed hence it is safe to let go... */ 737#if IMM_DEBUG > 0 738 switch ((cmd->result >> 16) & 0xff) { 739 case DID_OK: 740 break; 741 case DID_NO_CONNECT: 742 printk("imm: no device at SCSI ID %i\n", cmd->device->id); 743 break; 744 case DID_BUS_BUSY: 745 printk("imm: BUS BUSY - EPP timeout detected\n"); 746 break; 747 case DID_TIME_OUT: 748 printk("imm: unknown timeout\n"); 749 break; 750 case DID_ABORT: 751 printk("imm: told to abort\n"); 752 break; 753 case DID_PARITY: 754 printk("imm: parity error (???)\n"); 755 break; 756 case DID_ERROR: 757 printk("imm: internal driver error\n"); 758 break; 759 case DID_RESET: 760 printk("imm: told to reset device\n"); 761 break; 762 case DID_BAD_INTR: 763 printk("imm: bad interrupt (???)\n"); 764 break; 765 default: 766 printk("imm: bad return code (%02x)\n", 767 (cmd->result >> 16) & 0xff); 768 } 769#endif 770 771 if (cmd->SCp.phase > 1) 772 imm_disconnect(dev); 773 774 imm_pb_dismiss(dev); 775 776 spin_lock_irqsave(host->host_lock, flags); 777 dev->cur_cmd = NULL; 778 cmd->scsi_done(cmd); 779 spin_unlock_irqrestore(host->host_lock, flags); 780 return; 781} 782 783static int imm_engine(imm_struct *dev, struct scsi_cmnd *cmd) 784{ 785 unsigned short ppb = dev->base; 786 unsigned char l = 0, h = 0; 787 int retv, x; 788 789 /* First check for any errors that may have occurred 790 * Here we check for internal errors 791 */ 792 if (dev->failed) 793 return 0; 794 795 switch (cmd->SCp.phase) { 796 case 0: /* Phase 0 - Waiting for parport */ 797 if (time_after(jiffies, dev->jstart + HZ)) { 798 /* 799 * We waited more than a second 800 * for parport to call us 801 */ 802 imm_fail(dev, DID_BUS_BUSY); 803 return 0; 804 } 805 return 1; /* wait until imm_wakeup claims parport */ 806 /* Phase 1 - Connected */ 807 case 1: 808 imm_connect(dev, CONNECT_EPP_MAYBE); 809 cmd->SCp.phase++; 810 811 /* Phase 2 - We are now talking to the scsi bus */ 812 case 2: 813 if (!imm_select(dev, scmd_id(cmd))) { 814 imm_fail(dev, DID_NO_CONNECT); 815 return 0; 816 } 817 cmd->SCp.phase++; 818 819 /* Phase 3 - Ready to accept a command */ 820 case 3: 821 w_ctr(ppb, 0x0c); 822 if (!(r_str(ppb) & 0x80)) 823 return 1; 824 825 if (!imm_send_command(cmd)) 826 return 0; 827 cmd->SCp.phase++; 828 829 /* Phase 4 - Setup scatter/gather buffers */ 830 case 4: 831 if (scsi_bufflen(cmd)) { 832 cmd->SCp.buffer = scsi_sglist(cmd); 833 cmd->SCp.this_residual = cmd->SCp.buffer->length; 834 cmd->SCp.ptr = sg_virt(cmd->SCp.buffer); 835 } else { 836 cmd->SCp.buffer = NULL; 837 cmd->SCp.this_residual = 0; 838 cmd->SCp.ptr = NULL; 839 } 840 cmd->SCp.buffers_residual = scsi_sg_count(cmd) - 1; 841 cmd->SCp.phase++; 842 if (cmd->SCp.this_residual & 0x01) 843 cmd->SCp.this_residual++; 844 /* Phase 5 - Pre-Data transfer stage */ 845 case 5: 846 /* Spin lock for BUSY */ 847 w_ctr(ppb, 0x0c); 848 if (!(r_str(ppb) & 0x80)) 849 return 1; 850 851 /* Require negotiation for read requests */ 852 x = (r_str(ppb) & 0xb8); 853 dev->rd = (x & 0x10) ? 1 : 0; 854 dev->dp = (x & 0x20) ? 0 : 1; 855 856 if ((dev->dp) && (dev->rd)) 857 if (imm_negotiate(dev)) 858 return 0; 859 cmd->SCp.phase++; 860 861 /* Phase 6 - Data transfer stage */ 862 case 6: 863 /* Spin lock for BUSY */ 864 w_ctr(ppb, 0x0c); 865 if (!(r_str(ppb) & 0x80)) 866 return 1; 867 868 if (dev->dp) { 869 retv = imm_completion(cmd); 870 if (retv == -1) 871 return 0; 872 if (retv == 0) 873 return 1; 874 } 875 cmd->SCp.phase++; 876 877 /* Phase 7 - Post data transfer stage */ 878 case 7: 879 if ((dev->dp) && (dev->rd)) { 880 if ((dev->mode == IMM_NIBBLE) || (dev->mode == IMM_PS2)) { 881 w_ctr(ppb, 0x4); 882 w_ctr(ppb, 0xc); 883 w_ctr(ppb, 0xe); 884 w_ctr(ppb, 0x4); 885 } 886 } 887 cmd->SCp.phase++; 888 889 /* Phase 8 - Read status/message */ 890 case 8: 891 /* Check for data overrun */ 892 if (imm_wait(dev) != (unsigned char) 0xb8) { 893 imm_fail(dev, DID_ERROR); 894 return 0; 895 } 896 if (imm_negotiate(dev)) 897 return 0; 898 if (imm_in(dev, &l, 1)) { /* read status byte */ 899 /* Check for optional message byte */ 900 if (imm_wait(dev) == (unsigned char) 0xb8) 901 imm_in(dev, &h, 1); 902 cmd->result = (DID_OK << 16) + (l & STATUS_MASK); 903 } 904 if ((dev->mode == IMM_NIBBLE) || (dev->mode == IMM_PS2)) { 905 w_ctr(ppb, 0x4); 906 w_ctr(ppb, 0xc); 907 w_ctr(ppb, 0xe); 908 w_ctr(ppb, 0x4); 909 } 910 return 0; /* Finished */ 911 break; 912 913 default: 914 printk("imm: Invalid scsi phase\n"); 915 } 916 return 0; 917} 918 919static int imm_queuecommand(struct scsi_cmnd *cmd, 920 void (*done)(struct scsi_cmnd *)) 921{ 922 imm_struct *dev = imm_dev(cmd->device->host); 923 924 if (dev->cur_cmd) { 925 printk("IMM: bug in imm_queuecommand\n"); 926 return 0; 927 } 928 dev->failed = 0; 929 dev->jstart = jiffies; 930 dev->cur_cmd = cmd; 931 cmd->scsi_done = done; 932 cmd->result = DID_ERROR << 16; /* default return code */ 933 cmd->SCp.phase = 0; /* bus free */ 934 935 schedule_delayed_work(&dev->imm_tq, 0); 936 937 imm_pb_claim(dev); 938 939 return 0; 940} 941 942/* 943 * Apparently the disk->capacity attribute is off by 1 sector 944 * for all disk drives. We add the one here, but it should really 945 * be done in sd.c. Even if it gets fixed there, this will still 946 * work. 947 */ 948static int imm_biosparam(struct scsi_device *sdev, struct block_device *dev, 949 sector_t capacity, int ip[]) 950{ 951 ip[0] = 0x40; 952 ip[1] = 0x20; 953 ip[2] = ((unsigned long) capacity + 1) / (ip[0] * ip[1]); 954 if (ip[2] > 1024) { 955 ip[0] = 0xff; 956 ip[1] = 0x3f; 957 ip[2] = ((unsigned long) capacity + 1) / (ip[0] * ip[1]); 958 } 959 return 0; 960} 961 962static int imm_abort(struct scsi_cmnd *cmd) 963{ 964 imm_struct *dev = imm_dev(cmd->device->host); 965 /* 966 * There is no method for aborting commands since Iomega 967 * have tied the SCSI_MESSAGE line high in the interface 968 */ 969 970 switch (cmd->SCp.phase) { 971 case 0: /* Do not have access to parport */ 972 case 1: /* Have not connected to interface */ 973 dev->cur_cmd = NULL; /* Forget the problem */ 974 return SUCCESS; 975 break; 976 default: /* SCSI command sent, can not abort */ 977 return FAILED; 978 break; 979 } 980} 981 982static void imm_reset_pulse(unsigned int base) 983{ 984 w_ctr(base, 0x04); 985 w_dtr(base, 0x40); 986 udelay(1); 987 w_ctr(base, 0x0c); 988 w_ctr(base, 0x0d); 989 udelay(50); 990 w_ctr(base, 0x0c); 991 w_ctr(base, 0x04); 992} 993 994static int imm_reset(struct scsi_cmnd *cmd) 995{ 996 imm_struct *dev = imm_dev(cmd->device->host); 997 998 if (cmd->SCp.phase) 999 imm_disconnect(dev); 1000 dev->cur_cmd = NULL; /* Forget the problem */ 1001 1002 imm_connect(dev, CONNECT_NORMAL); 1003 imm_reset_pulse(dev->base); 1004 mdelay(1); /* device settle delay */ 1005 imm_disconnect(dev); 1006 mdelay(1); /* device settle delay */ 1007 return SUCCESS; 1008} 1009 1010static int device_check(imm_struct *dev) 1011{ 1012 /* This routine looks for a device and then attempts to use EPP 1013 to send a command. If all goes as planned then EPP is available. */ 1014 1015 static char cmd[6] = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }; 1016 int loop, old_mode, status, k, ppb = dev->base; 1017 unsigned char l; 1018 1019 old_mode = dev->mode; 1020 for (loop = 0; loop < 8; loop++) { 1021 /* Attempt to use EPP for Test Unit Ready */ 1022 if ((ppb & 0x0007) == 0x0000) 1023 dev->mode = IMM_EPP_32; 1024 1025 second_pass: 1026 imm_connect(dev, CONNECT_EPP_MAYBE); 1027 /* Select SCSI device */ 1028 if (!imm_select(dev, loop)) { 1029 imm_disconnect(dev); 1030 continue; 1031 } 1032 printk("imm: Found device at ID %i, Attempting to use %s\n", 1033 loop, IMM_MODE_STRING[dev->mode]); 1034 1035 /* Send SCSI command */ 1036 status = 1; 1037 w_ctr(ppb, 0x0c); 1038 for (l = 0; (l < 3) && (status); l++) 1039 status = imm_out(dev, &cmd[l << 1], 2); 1040 1041 if (!status) { 1042 imm_disconnect(dev); 1043 imm_connect(dev, CONNECT_EPP_MAYBE); 1044 imm_reset_pulse(dev->base); 1045 udelay(1000); 1046 imm_disconnect(dev); 1047 udelay(1000); 1048 if (dev->mode == IMM_EPP_32) { 1049 dev->mode = old_mode; 1050 goto second_pass; 1051 } 1052 printk("imm: Unable to establish communication\n"); 1053 return -EIO; 1054 } 1055 w_ctr(ppb, 0x0c); 1056 1057 k = 1000000; /* 1 Second */ 1058 do { 1059 l = r_str(ppb); 1060 k--; 1061 udelay(1); 1062 } while (!(l & 0x80) && (k)); 1063 1064 l &= 0xb8; 1065 1066 if (l != 0xb8) { 1067 imm_disconnect(dev); 1068 imm_connect(dev, CONNECT_EPP_MAYBE); 1069 imm_reset_pulse(dev->base); 1070 udelay(1000); 1071 imm_disconnect(dev); 1072 udelay(1000); 1073 if (dev->mode == IMM_EPP_32) { 1074 dev->mode = old_mode; 1075 goto second_pass; 1076 } 1077 printk 1078 ("imm: Unable to establish communication\n"); 1079 return -EIO; 1080 } 1081 imm_disconnect(dev); 1082 printk 1083 ("imm: Communication established at 0x%x with ID %i using %s\n", 1084 ppb, loop, IMM_MODE_STRING[dev->mode]); 1085 imm_connect(dev, CONNECT_EPP_MAYBE); 1086 imm_reset_pulse(dev->base); 1087 udelay(1000); 1088 imm_disconnect(dev); 1089 udelay(1000); 1090 return 0; 1091 } 1092 printk("imm: No devices found\n"); 1093 return -ENODEV; 1094} 1095 1096/* 1097 * imm cannot deal with highmem, so this causes all IO pages for this host 1098 * to reside in low memory (hence mapped) 1099 */ 1100static int imm_adjust_queue(struct scsi_device *device) 1101{ 1102 blk_queue_bounce_limit(device->request_queue, BLK_BOUNCE_HIGH); 1103 return 0; 1104} 1105 1106static struct scsi_host_template imm_template = { 1107 .module = THIS_MODULE, 1108 .proc_name = "imm", 1109 .proc_info = imm_proc_info, 1110 .name = "Iomega VPI2 (imm) interface", 1111 .queuecommand = imm_queuecommand, 1112 .eh_abort_handler = imm_abort, 1113 .eh_bus_reset_handler = imm_reset, 1114 .eh_host_reset_handler = imm_reset, 1115 .bios_param = imm_biosparam, 1116 .this_id = 7, 1117 .sg_tablesize = SG_ALL, 1118 .cmd_per_lun = 1, 1119 .use_clustering = ENABLE_CLUSTERING, 1120 .can_queue = 1, 1121 .slave_alloc = imm_adjust_queue, 1122}; 1123 1124/*************************************************************************** 1125 * Parallel port probing routines * 1126 ***************************************************************************/ 1127 1128static LIST_HEAD(imm_hosts); 1129 1130static int __imm_attach(struct parport *pb) 1131{ 1132 struct Scsi_Host *host; 1133 imm_struct *dev; 1134 DECLARE_WAIT_QUEUE_HEAD_ONSTACK(waiting); 1135 DEFINE_WAIT(wait); 1136 int ports; 1137 int modes, ppb; 1138 int err = -ENOMEM; 1139 1140 init_waitqueue_head(&waiting); 1141 1142 dev = kzalloc(sizeof(imm_struct), GFP_KERNEL); 1143 if (!dev) 1144 return -ENOMEM; 1145 1146 1147 dev->base = -1; 1148 dev->mode = IMM_AUTODETECT; 1149 INIT_LIST_HEAD(&dev->list); 1150 1151 dev->dev = parport_register_device(pb, "imm", NULL, imm_wakeup, 1152 NULL, 0, dev); 1153 1154 if (!dev->dev) 1155 goto out; 1156 1157 1158 /* Claim the bus so it remembers what we do to the control 1159 * registers. [ CTR and ECP ] 1160 */ 1161 err = -EBUSY; 1162 dev->waiting = &waiting; 1163 prepare_to_wait(&waiting, &wait, TASK_UNINTERRUPTIBLE); 1164 if (imm_pb_claim(dev)) 1165 schedule_timeout(3 * HZ); 1166 if (dev->wanted) { 1167 printk(KERN_ERR "imm%d: failed to claim parport because " 1168 "a pardevice is owning the port for too long " 1169 "time!\n", pb->number); 1170 imm_pb_dismiss(dev); 1171 dev->waiting = NULL; 1172 finish_wait(&waiting, &wait); 1173 goto out1; 1174 } 1175 dev->waiting = NULL; 1176 finish_wait(&waiting, &wait); 1177 ppb = dev->base = dev->dev->port->base; 1178 dev->base_hi = dev->dev->port->base_hi; 1179 w_ctr(ppb, 0x0c); 1180 modes = dev->dev->port->modes; 1181 1182 /* Mode detection works up the chain of speed 1183 * This avoids a nasty if-then-else-if-... tree 1184 */ 1185 dev->mode = IMM_NIBBLE; 1186 1187 if (modes & PARPORT_MODE_TRISTATE) 1188 dev->mode = IMM_PS2; 1189 1190 /* Done configuration */ 1191 1192 err = imm_init(dev); 1193 1194 imm_pb_release(dev); 1195 1196 if (err) 1197 goto out1; 1198 1199 /* now the glue ... */ 1200 if (dev->mode == IMM_NIBBLE || dev->mode == IMM_PS2) 1201 ports = 3; 1202 else 1203 ports = 8; 1204 1205 INIT_DELAYED_WORK(&dev->imm_tq, imm_interrupt); 1206 1207 err = -ENOMEM; 1208 host = scsi_host_alloc(&imm_template, sizeof(imm_struct *)); 1209 if (!host) 1210 goto out1; 1211 host->io_port = pb->base; 1212 host->n_io_port = ports; 1213 host->dma_channel = -1; 1214 host->unique_id = pb->number; 1215 *(imm_struct **)&host->hostdata = dev; 1216 dev->host = host; 1217 list_add_tail(&dev->list, &imm_hosts); 1218 err = scsi_add_host(host, NULL); 1219 if (err) 1220 goto out2; 1221 scsi_scan_host(host); 1222 return 0; 1223 1224out2: 1225 list_del_init(&dev->list); 1226 scsi_host_put(host); 1227out1: 1228 parport_unregister_device(dev->dev); 1229out: 1230 kfree(dev); 1231 return err; 1232} 1233 1234static void imm_attach(struct parport *pb) 1235{ 1236 __imm_attach(pb); 1237} 1238 1239static void imm_detach(struct parport *pb) 1240{ 1241 imm_struct *dev; 1242 list_for_each_entry(dev, &imm_hosts, list) { 1243 if (dev->dev->port == pb) { 1244 list_del_init(&dev->list); 1245 scsi_remove_host(dev->host); 1246 scsi_host_put(dev->host); 1247 parport_unregister_device(dev->dev); 1248 kfree(dev); 1249 break; 1250 } 1251 } 1252} 1253 1254static struct parport_driver imm_driver = { 1255 .name = "imm", 1256 .attach = imm_attach, 1257 .detach = imm_detach, 1258}; 1259 1260static int __init imm_driver_init(void) 1261{ 1262 printk("imm: Version %s\n", IMM_VERSION); 1263 return parport_register_driver(&imm_driver); 1264} 1265 1266static void __exit imm_driver_exit(void) 1267{ 1268 parport_unregister_driver(&imm_driver); 1269} 1270 1271module_init(imm_driver_init); 1272module_exit(imm_driver_exit); 1273 1274MODULE_LICENSE("GPL"); 1275