1 // SPDX-License-Identifier: GPL-2.0
3 * Driver for Future Domain TMC-16x0 and TMC-3260 SCSI host adapters
4 * Copyright 2019 Ondrej Zary
7 * Rickard E. Faith, faith@cs.unc.edu
9 * Future Domain BIOS versions supported for autodetect:
10 * 2.0, 3.0, 3.2, 3.4 (1.0), 3.5 (2.0), 3.6, 3.61
12 * TMC-1800, TMC-18C50, TMC-18C30, TMC-36C70
14 * Future Domain TMC-1650, TMC-1660, TMC-1670, TMC-1680, TMC-1610M/MER/MEX
15 * Future Domain TMC-3260 (PCI)
16 * Quantum ISA-200S, ISA-250MG
17 * Adaptec AHA-2920A (PCI) [BUT *NOT* AHA-2920C -- use aic7xxx instead]
22 * The Adaptec AHA-2920C has an Adaptec AIC-7850 chip on it.
23 * Use the aic7xxx driver for this board.
25 * The Adaptec AHA-2920A has a Future Domain chip on it, so this is the right
26 * driver for that card. Unfortunately, the boxes will probably just say
27 * "2920", so you'll have to look on the card for a Future Domain logo, or a
28 * letter after the 2920.
30 * If you have a TMC-8xx or TMC-9xx board, then this is not the driver for
35 * This is the Linux low-level SCSI driver for Future Domain TMC-1660/1680
36 * TMC-1650/1670, and TMC-3260 SCSI host adapters. The 1650 and 1670 have a
37 * 25-pin external connector, whereas the 1660 and 1680 have a SCSI-2 50-pin
38 * high-density external connector. The 1670 and 1680 have floppy disk
39 * controllers built in. The TMC-3260 is a PCI bus card.
41 * Future Domain's older boards are based on the TMC-1800 chip, and this
42 * driver was originally written for a TMC-1680 board with the TMC-1800 chip.
43 * More recently, boards are being produced with the TMC-18C50 and TMC-18C30
46 * Please note that the drive ordering that Future Domain implemented in BIOS
47 * versions 3.4 and 3.5 is the opposite of the order (currently) used by the
48 * rest of the SCSI industry.
53 * "TMC-1800 SCSI Chip Specification (FDC-1800T)", Future Domain Corporation,
56 * "Technical Reference Manual: 18C50 SCSI Host Adapter Chip", Future Domain
57 * Corporation, January 1992.
59 * "LXT SCSI Products: Specifications and OEM Technical Manual (Revision
60 * B/September 1991)", Maxtor Corporation, 1991.
62 * "7213S product Manual (Revision P3)", Maxtor Corporation, 1992.
64 * "Draft Proposed American National Standard: Small Computer System
65 * Interface - 2 (SCSI-2)", Global Engineering Documents. (X3T9.2/86-109,
66 * revision 10h, October 17, 1991)
68 * Private communications, Drew Eckhardt (drew@cs.colorado.edu) and Eric
69 * Youngdale (ericy@cais.com), 1992.
71 * Private communication, Tuong Le (Future Domain Engineering department),
72 * 1994. (Disk geometry computations for Future Domain BIOS version 3.4, and
73 * TMC-18C30 detection.)
75 * Hogan, Thom. The Programmer's PC Sourcebook. Microsoft Press, 1988. Page
76 * 60 (2.39: Disk Partition Table Layout).
78 * "18C30 Technical Reference Manual", Future Domain Corporation, 1993, page
82 #include <linux/module.h>
83 #include <linux/interrupt.h>
84 #include <linux/delay.h>
85 #include <linux/pci.h>
86 #include <linux/workqueue.h>
87 #include <scsi/scsicam.h>
88 #include <scsi/scsi_cmnd.h>
89 #include <scsi/scsi_device.h>
90 #include <scsi/scsi_host.h>
94 * FIFO_COUNT: The host adapter has an 8K cache (host adapters based on the
95 * 18C30 chip have a 2k cache). When this many 512 byte blocks are filled by
96 * the SCSI device, an interrupt will be raised. Therefore, this could be as
97 * low as 0, or as high as 16. Note, however, that values which are too high
98 * or too low seem to prevent any interrupts from occurring, and thereby lock
101 #define FIFO_COUNT 2 /* Number of 512 byte blocks before INTR */
102 #define PARITY_MASK ACTL_PAREN /* Parity enabled, 0 = disabled */
113 struct scsi_cmnd *cur_cmd;
115 struct work_struct work;
118 static inline void fdomain_make_bus_idle(struct fdomain *fd)
120 outb(0, fd->base + REG_BCTL);
121 outb(0, fd->base + REG_MCTL);
122 if (fd->chip == tmc18c50 || fd->chip == tmc18c30)
123 /* Clear forced intr. */
124 outb(ACTL_RESET | ACTL_CLRFIRQ | PARITY_MASK,
125 fd->base + REG_ACTL);
127 outb(ACTL_RESET | PARITY_MASK, fd->base + REG_ACTL);
130 static enum chip_type fdomain_identify(int port)
132 u16 id = inb(port + REG_ID_LSB) | inb(port + REG_ID_MSB) << 8;
137 case 0x60e9: /* 18c50 or 18c30 */
143 /* Try to toggle 32-bit mode. This only works on an 18c30 chip. */
144 outb(CFG2_32BIT, port + REG_CFG2);
145 if ((inb(port + REG_CFG2) & CFG2_32BIT)) {
146 outb(0, port + REG_CFG2);
147 if ((inb(port + REG_CFG2) & CFG2_32BIT) == 0)
150 /* If that failed, we are an 18c50. */
154 static int fdomain_test_loopback(int base)
158 for (i = 0; i < 255; i++) {
159 outb(i, base + REG_LOOPBACK);
160 if (inb(base + REG_LOOPBACK) != i)
167 static void fdomain_reset(int base)
169 outb(BCTL_RST, base + REG_BCTL);
171 outb(0, base + REG_BCTL);
173 outb(0, base + REG_MCTL);
174 outb(PARITY_MASK, base + REG_ACTL);
177 static int fdomain_select(struct Scsi_Host *sh, int target)
180 unsigned long timeout;
181 struct fdomain *fd = shost_priv(sh);
183 outb(BCTL_BUSEN | BCTL_SEL, fd->base + REG_BCTL);
184 outb(BIT(sh->this_id) | BIT(target), fd->base + REG_SCSI_DATA_NOACK);
186 /* Stop arbitration and enable parity */
187 outb(PARITY_MASK, fd->base + REG_ACTL);
189 timeout = 350; /* 350 msec */
192 status = inb(fd->base + REG_BSTAT);
193 if (status & BSTAT_BSY) {
194 /* Enable SCSI Bus */
195 /* (on error, should make bus idle with 0) */
196 outb(BCTL_BUSEN, fd->base + REG_BCTL);
201 fdomain_make_bus_idle(fd);
205 static void fdomain_finish_cmd(struct fdomain *fd)
207 outb(0, fd->base + REG_ICTL);
208 fdomain_make_bus_idle(fd);
209 fd->cur_cmd->scsi_done(fd->cur_cmd);
213 static void fdomain_read_data(struct scsi_cmnd *cmd)
215 struct fdomain *fd = shost_priv(cmd->device->host);
216 unsigned char *virt, *ptr;
219 while ((len = inw(fd->base + REG_FIFO_COUNT)) > 0) {
220 offset = scsi_bufflen(cmd) - scsi_get_resid(cmd);
221 virt = scsi_kmap_atomic_sg(scsi_sglist(cmd), scsi_sg_count(cmd),
225 *ptr++ = inb(fd->base + REG_FIFO);
227 insw(fd->base + REG_FIFO, ptr, len >> 1);
228 scsi_set_resid(cmd, scsi_get_resid(cmd) - len);
229 scsi_kunmap_atomic_sg(virt);
233 static void fdomain_write_data(struct scsi_cmnd *cmd)
235 struct fdomain *fd = shost_priv(cmd->device->host);
236 /* 8k FIFO for pre-tmc18c30 chips, 2k FIFO for tmc18c30 */
237 int FIFO_Size = fd->chip == tmc18c30 ? 0x800 : 0x2000;
238 unsigned char *virt, *ptr;
241 while ((len = FIFO_Size - inw(fd->base + REG_FIFO_COUNT)) > 512) {
242 offset = scsi_bufflen(cmd) - scsi_get_resid(cmd);
243 if (len + offset > scsi_bufflen(cmd)) {
244 len = scsi_bufflen(cmd) - offset;
248 virt = scsi_kmap_atomic_sg(scsi_sglist(cmd), scsi_sg_count(cmd),
252 outb(*ptr++, fd->base + REG_FIFO);
254 outsw(fd->base + REG_FIFO, ptr, len >> 1);
255 scsi_set_resid(cmd, scsi_get_resid(cmd) - len);
256 scsi_kunmap_atomic_sg(virt);
260 static void fdomain_work(struct work_struct *work)
262 struct fdomain *fd = container_of(work, struct fdomain, work);
263 struct Scsi_Host *sh = container_of((void *)fd, struct Scsi_Host,
265 struct scsi_cmnd *cmd = fd->cur_cmd;
270 spin_lock_irqsave(sh->host_lock, flags);
272 if (cmd->SCp.phase & in_arbitration) {
273 status = inb(fd->base + REG_ASTAT);
274 if (!(status & ASTAT_ARB)) {
275 set_host_byte(cmd, DID_BUS_BUSY);
276 fdomain_finish_cmd(fd);
279 cmd->SCp.phase = in_selection;
281 outb(ICTL_SEL | FIFO_COUNT, fd->base + REG_ICTL);
282 outb(BCTL_BUSEN | BCTL_SEL, fd->base + REG_BCTL);
283 outb(BIT(cmd->device->host->this_id) | BIT(scmd_id(cmd)),
284 fd->base + REG_SCSI_DATA_NOACK);
285 /* Stop arbitration and enable parity */
286 outb(ACTL_IRQEN | PARITY_MASK, fd->base + REG_ACTL);
288 } else if (cmd->SCp.phase & in_selection) {
289 status = inb(fd->base + REG_BSTAT);
290 if (!(status & BSTAT_BSY)) {
291 /* Try again, for slow devices */
292 if (fdomain_select(cmd->device->host, scmd_id(cmd))) {
293 set_host_byte(cmd, DID_NO_CONNECT);
294 fdomain_finish_cmd(fd);
297 /* Stop arbitration and enable parity */
298 outb(ACTL_IRQEN | PARITY_MASK, fd->base + REG_ACTL);
300 cmd->SCp.phase = in_other;
301 outb(ICTL_FIFO | ICTL_REQ | FIFO_COUNT, fd->base + REG_ICTL);
302 outb(BCTL_BUSEN, fd->base + REG_BCTL);
306 /* cur_cmd->SCp.phase == in_other: this is the body of the routine */
307 status = inb(fd->base + REG_BSTAT);
309 if (status & BSTAT_REQ) {
310 switch (status & (BSTAT_MSG | BSTAT_CMD | BSTAT_IO)) {
311 case BSTAT_CMD: /* COMMAND OUT */
312 outb(cmd->cmnd[cmd->SCp.sent_command++],
313 fd->base + REG_SCSI_DATA);
315 case 0: /* DATA OUT -- tmc18c50/tmc18c30 only */
316 if (fd->chip != tmc1800 && !cmd->SCp.have_data_in) {
317 cmd->SCp.have_data_in = -1;
318 outb(ACTL_IRQEN | ACTL_FIFOWR | ACTL_FIFOEN |
319 PARITY_MASK, fd->base + REG_ACTL);
322 case BSTAT_IO: /* DATA IN -- tmc18c50/tmc18c30 only */
323 if (fd->chip != tmc1800 && !cmd->SCp.have_data_in) {
324 cmd->SCp.have_data_in = 1;
325 outb(ACTL_IRQEN | ACTL_FIFOEN | PARITY_MASK,
326 fd->base + REG_ACTL);
329 case BSTAT_CMD | BSTAT_IO: /* STATUS IN */
330 cmd->SCp.Status = inb(fd->base + REG_SCSI_DATA);
332 case BSTAT_MSG | BSTAT_CMD: /* MESSAGE OUT */
333 outb(MESSAGE_REJECT, fd->base + REG_SCSI_DATA);
335 case BSTAT_MSG | BSTAT_CMD | BSTAT_IO: /* MESSAGE IN */
336 cmd->SCp.Message = inb(fd->base + REG_SCSI_DATA);
337 if (cmd->SCp.Message == COMMAND_COMPLETE)
343 if (fd->chip == tmc1800 && !cmd->SCp.have_data_in &&
344 cmd->SCp.sent_command >= cmd->cmd_len) {
345 if (cmd->sc_data_direction == DMA_TO_DEVICE) {
346 cmd->SCp.have_data_in = -1;
347 outb(ACTL_IRQEN | ACTL_FIFOWR | ACTL_FIFOEN |
348 PARITY_MASK, fd->base + REG_ACTL);
350 cmd->SCp.have_data_in = 1;
351 outb(ACTL_IRQEN | ACTL_FIFOEN | PARITY_MASK,
352 fd->base + REG_ACTL);
356 if (cmd->SCp.have_data_in == -1) /* DATA OUT */
357 fdomain_write_data(cmd);
359 if (cmd->SCp.have_data_in == 1) /* DATA IN */
360 fdomain_read_data(cmd);
363 set_status_byte(cmd, cmd->SCp.Status);
364 set_host_byte(cmd, DID_OK);
365 scsi_msg_to_host_byte(cmd, cmd->SCp.Message);
366 fdomain_finish_cmd(fd);
368 if (cmd->SCp.phase & disconnect) {
369 outb(ICTL_FIFO | ICTL_SEL | ICTL_REQ | FIFO_COUNT,
370 fd->base + REG_ICTL);
371 outb(0, fd->base + REG_BCTL);
373 outb(ICTL_FIFO | ICTL_REQ | FIFO_COUNT,
374 fd->base + REG_ICTL);
377 spin_unlock_irqrestore(sh->host_lock, flags);
380 static irqreturn_t fdomain_irq(int irq, void *dev_id)
382 struct fdomain *fd = dev_id;
385 if ((inb(fd->base + REG_ASTAT) & ASTAT_IRQ) == 0)
388 outb(0, fd->base + REG_ICTL);
390 /* We usually have one spurious interrupt after each command. */
391 if (!fd->cur_cmd) /* Spurious interrupt */
394 schedule_work(&fd->work);
399 static int fdomain_queue(struct Scsi_Host *sh, struct scsi_cmnd *cmd)
401 struct fdomain *fd = shost_priv(cmd->device->host);
405 cmd->SCp.Message = 0;
406 cmd->SCp.have_data_in = 0;
407 cmd->SCp.sent_command = 0;
408 cmd->SCp.phase = in_arbitration;
409 scsi_set_resid(cmd, scsi_bufflen(cmd));
411 spin_lock_irqsave(sh->host_lock, flags);
415 fdomain_make_bus_idle(fd);
417 /* Start arbitration */
418 outb(0, fd->base + REG_ICTL);
419 outb(0, fd->base + REG_BCTL); /* Disable data drivers */
421 outb(BIT(cmd->device->host->this_id), fd->base + REG_SCSI_DATA_NOACK);
422 outb(ICTL_ARB, fd->base + REG_ICTL);
423 /* Start arbitration */
424 outb(ACTL_ARB | ACTL_IRQEN | PARITY_MASK, fd->base + REG_ACTL);
426 spin_unlock_irqrestore(sh->host_lock, flags);
431 static int fdomain_abort(struct scsi_cmnd *cmd)
433 struct Scsi_Host *sh = cmd->device->host;
434 struct fdomain *fd = shost_priv(sh);
440 spin_lock_irqsave(sh->host_lock, flags);
442 fdomain_make_bus_idle(fd);
443 fd->cur_cmd->SCp.phase |= aborted;
445 /* Aborts are not done well. . . */
446 set_host_byte(fd->cur_cmd, DID_ABORT);
447 fdomain_finish_cmd(fd);
448 spin_unlock_irqrestore(sh->host_lock, flags);
452 static int fdomain_host_reset(struct scsi_cmnd *cmd)
454 struct Scsi_Host *sh = cmd->device->host;
455 struct fdomain *fd = shost_priv(sh);
458 spin_lock_irqsave(sh->host_lock, flags);
459 fdomain_reset(fd->base);
460 spin_unlock_irqrestore(sh->host_lock, flags);
464 static int fdomain_biosparam(struct scsi_device *sdev,
465 struct block_device *bdev, sector_t capacity,
468 unsigned char *p = scsi_bios_ptable(bdev);
470 if (p && p[65] == 0xaa && p[64] == 0x55 /* Partition table valid */
471 && p[4]) { /* Partition type */
472 geom[0] = p[5] + 1; /* heads */
473 geom[1] = p[6] & 0x3f; /* sectors */
475 if (capacity >= 0x7e0000) {
476 geom[0] = 255; /* heads */
477 geom[1] = 63; /* sectors */
478 } else if (capacity >= 0x200000) {
479 geom[0] = 128; /* heads */
480 geom[1] = 63; /* sectors */
482 geom[0] = 64; /* heads */
483 geom[1] = 32; /* sectors */
486 geom[2] = sector_div(capacity, geom[0] * geom[1]);
492 static struct scsi_host_template fdomain_template = {
493 .module = THIS_MODULE,
494 .name = "Future Domain TMC-16x0",
495 .proc_name = "fdomain",
496 .queuecommand = fdomain_queue,
497 .eh_abort_handler = fdomain_abort,
498 .eh_host_reset_handler = fdomain_host_reset,
499 .bios_param = fdomain_biosparam,
503 .dma_boundary = PAGE_SIZE - 1,
506 struct Scsi_Host *fdomain_create(int base, int irq, int this_id,
509 struct Scsi_Host *sh;
512 static const char * const chip_names[] = {
513 "Unknown", "TMC-1800", "TMC-18C50", "TMC-18C30"
515 unsigned long irq_flags = 0;
517 chip = fdomain_identify(base);
523 if (fdomain_test_loopback(base))
527 dev_err(dev, "card has no IRQ assigned");
531 sh = scsi_host_alloc(&fdomain_template, sizeof(struct fdomain));
536 sh->this_id = this_id & 0x07;
540 sh->n_io_port = FDOMAIN_REGION_SIZE;
545 INIT_WORK(&fd->work, fdomain_work);
547 if (dev_is_pci(dev) || !strcmp(dev->bus->name, "pcmcia"))
548 irq_flags = IRQF_SHARED;
550 if (request_irq(irq, fdomain_irq, irq_flags, "fdomain", fd))
553 shost_printk(KERN_INFO, sh, "%s chip at 0x%x irq %d SCSI ID %d\n",
554 dev_is_pci(dev) ? "TMC-36C70 (PCI bus)" : chip_names[chip],
555 base, irq, sh->this_id);
557 if (scsi_add_host(sh, dev))
570 EXPORT_SYMBOL_GPL(fdomain_create);
572 int fdomain_destroy(struct Scsi_Host *sh)
574 struct fdomain *fd = shost_priv(sh);
576 cancel_work_sync(&fd->work);
577 scsi_remove_host(sh);
579 free_irq(sh->irq, fd);
583 EXPORT_SYMBOL_GPL(fdomain_destroy);
585 #ifdef CONFIG_PM_SLEEP
586 static int fdomain_resume(struct device *dev)
588 struct fdomain *fd = shost_priv(dev_get_drvdata(dev));
590 fdomain_reset(fd->base);
594 static SIMPLE_DEV_PM_OPS(fdomain_pm_ops, NULL, fdomain_resume);
595 #endif /* CONFIG_PM_SLEEP */
597 MODULE_AUTHOR("Ondrej Zary, Rickard E. Faith");
598 MODULE_DESCRIPTION("Future Domain TMC-16x0/TMC-3260 SCSI driver");
599 MODULE_LICENSE("GPL");