2 * pdc_adma.c - Pacific Digital Corporation ADMA
4 * Maintained by: Mark Lord <mlord@pobox.com>
6 * Copyright 2005 Mark Lord
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; see the file COPYING. If not, write to
20 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 * libata documentation is available via 'make {ps|pdf}docs',
24 * as Documentation/DocBook/libata.*
27 * Supports ATA disks in single-packet ADMA mode.
28 * Uses PIO for everything else.
30 * TODO: Use ADMA transfers for ATAPI devices, when possible.
31 * This requires careful attention to a number of quirks of the chip.
35 #include <linux/kernel.h>
36 #include <linux/module.h>
37 #include <linux/pci.h>
38 #include <linux/init.h>
39 #include <linux/blkdev.h>
40 #include <linux/delay.h>
41 #include <linux/interrupt.h>
42 #include <linux/device.h>
43 #include <scsi/scsi_host.h>
44 #include <linux/libata.h>
46 #define DRV_NAME "pdc_adma"
47 #define DRV_VERSION "1.0"
49 /* macro to calculate base address for ATA regs */
50 #define ADMA_ATA_REGS(base,port_no) ((base) + ((port_no) * 0x40))
52 /* macro to calculate base address for ADMA regs */
53 #define ADMA_REGS(base,port_no) ((base) + 0x80 + ((port_no) * 0x20))
55 /* macro to obtain addresses from ata_port */
56 #define ADMA_PORT_REGS(ap) \
57 ADMA_REGS((ap)->host->iomap[ADMA_MMIO_BAR], ap->port_no)
64 ADMA_PRD_BYTES = LIBATA_MAX_PRD * 16,
65 ADMA_PKT_BYTES = ADMA_CPB_BYTES + ADMA_PRD_BYTES,
67 ADMA_DMA_BOUNDARY = 0xffffffff,
69 /* global register offsets */
70 ADMA_MODE_LOCK = 0x00c7,
72 /* per-channel register offsets */
73 ADMA_CONTROL = 0x0000, /* ADMA control */
74 ADMA_STATUS = 0x0002, /* ADMA status */
75 ADMA_CPB_COUNT = 0x0004, /* CPB count */
76 ADMA_CPB_CURRENT = 0x000c, /* current CPB address */
77 ADMA_CPB_NEXT = 0x000c, /* next CPB address */
78 ADMA_CPB_LOOKUP = 0x0010, /* CPB lookup table */
79 ADMA_FIFO_IN = 0x0014, /* input FIFO threshold */
80 ADMA_FIFO_OUT = 0x0016, /* output FIFO threshold */
82 /* ADMA_CONTROL register bits */
83 aNIEN = (1 << 8), /* irq mask: 1==masked */
84 aGO = (1 << 7), /* packet trigger ("Go!") */
85 aRSTADM = (1 << 5), /* ADMA logic reset */
86 aPIOMD4 = 0x0003, /* PIO mode 4 */
88 /* ADMA_STATUS register bits */
106 /* ATA register flags */
110 /* ATA register addresses */
111 ADMA_REGS_CONTROL = 0x0e,
112 ADMA_REGS_SECTOR_COUNT = 0x12,
113 ADMA_REGS_LBA_LOW = 0x13,
114 ADMA_REGS_LBA_MID = 0x14,
115 ADMA_REGS_LBA_HIGH = 0x15,
116 ADMA_REGS_DEVICE = 0x16,
117 ADMA_REGS_COMMAND = 0x17,
120 board_1841_idx = 0, /* ADMA 2-port controller */
123 typedef enum { adma_state_idle, adma_state_pkt, adma_state_mmio } adma_state_t;
125 struct adma_port_priv {
131 static int adma_ata_init_one (struct pci_dev *pdev,
132 const struct pci_device_id *ent);
133 static int adma_port_start(struct ata_port *ap);
134 static void adma_host_stop(struct ata_host *host);
135 static void adma_port_stop(struct ata_port *ap);
136 static void adma_qc_prep(struct ata_queued_cmd *qc);
137 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc);
138 static int adma_check_atapi_dma(struct ata_queued_cmd *qc);
139 static void adma_bmdma_stop(struct ata_queued_cmd *qc);
140 static u8 adma_bmdma_status(struct ata_port *ap);
141 static void adma_irq_clear(struct ata_port *ap);
142 static void adma_freeze(struct ata_port *ap);
143 static void adma_thaw(struct ata_port *ap);
144 static void adma_error_handler(struct ata_port *ap);
146 static struct scsi_host_template adma_ata_sht = {
147 .module = THIS_MODULE,
149 .ioctl = ata_scsi_ioctl,
150 .queuecommand = ata_scsi_queuecmd,
151 .slave_configure = ata_scsi_slave_config,
152 .slave_destroy = ata_scsi_slave_destroy,
153 .bios_param = ata_std_bios_param,
154 .proc_name = DRV_NAME,
155 .can_queue = ATA_DEF_QUEUE,
156 .this_id = ATA_SHT_THIS_ID,
157 .sg_tablesize = LIBATA_MAX_PRD,
158 .dma_boundary = ADMA_DMA_BOUNDARY,
159 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
160 .use_clustering = ENABLE_CLUSTERING,
161 .emulated = ATA_SHT_EMULATED,
164 static const struct ata_port_operations adma_ata_ops = {
165 .port_disable = ata_port_disable,
166 .tf_load = ata_tf_load,
167 .tf_read = ata_tf_read,
168 .exec_command = ata_exec_command,
169 .check_status = ata_check_status,
170 .dev_select = ata_std_dev_select,
171 .check_atapi_dma = adma_check_atapi_dma,
172 .data_xfer = ata_data_xfer,
173 .qc_prep = adma_qc_prep,
174 .qc_issue = adma_qc_issue,
175 .freeze = adma_freeze,
177 .error_handler = adma_error_handler,
178 .irq_clear = adma_irq_clear,
179 .irq_on = ata_irq_on,
180 .irq_ack = ata_irq_ack,
181 .port_start = adma_port_start,
182 .port_stop = adma_port_stop,
183 .host_stop = adma_host_stop,
184 .bmdma_stop = adma_bmdma_stop,
185 .bmdma_status = adma_bmdma_status,
188 static struct ata_port_info adma_port_info[] = {
191 .flags = ATA_FLAG_SLAVE_POSS |
192 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO |
193 ATA_FLAG_PIO_POLLING,
194 .pio_mask = 0x10, /* pio4 */
195 .udma_mask = ATA_UDMA4,
196 .port_ops = &adma_ata_ops,
200 static const struct pci_device_id adma_ata_pci_tbl[] = {
201 { PCI_VDEVICE(PDC, 0x1841), board_1841_idx },
203 { } /* terminate list */
206 static struct pci_driver adma_ata_pci_driver = {
208 .id_table = adma_ata_pci_tbl,
209 .probe = adma_ata_init_one,
210 .remove = ata_pci_remove_one,
213 static int adma_check_atapi_dma(struct ata_queued_cmd *qc)
215 return 1; /* ATAPI DMA not yet supported */
218 static void adma_bmdma_stop(struct ata_queued_cmd *qc)
223 static u8 adma_bmdma_status(struct ata_port *ap)
228 static void adma_irq_clear(struct ata_port *ap)
233 static void adma_reset_engine(struct ata_port *ap)
235 void __iomem *chan = ADMA_PORT_REGS(ap);
237 /* reset ADMA to idle state */
238 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
240 writew(aPIOMD4, chan + ADMA_CONTROL);
244 static void adma_reinit_engine(struct ata_port *ap)
246 struct adma_port_priv *pp = ap->private_data;
247 void __iomem *chan = ADMA_PORT_REGS(ap);
249 /* mask/clear ATA interrupts */
250 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
251 ata_check_status(ap);
253 /* reset the ADMA engine */
254 adma_reset_engine(ap);
256 /* set in-FIFO threshold to 0x100 */
257 writew(0x100, chan + ADMA_FIFO_IN);
259 /* set CPB pointer */
260 writel((u32)pp->pkt_dma, chan + ADMA_CPB_NEXT);
262 /* set out-FIFO threshold to 0x100 */
263 writew(0x100, chan + ADMA_FIFO_OUT);
266 writew(1, chan + ADMA_CPB_COUNT);
268 /* read/discard ADMA status */
269 readb(chan + ADMA_STATUS);
272 static inline void adma_enter_reg_mode(struct ata_port *ap)
274 void __iomem *chan = ADMA_PORT_REGS(ap);
276 writew(aPIOMD4, chan + ADMA_CONTROL);
277 readb(chan + ADMA_STATUS); /* flush */
280 static void adma_freeze(struct ata_port *ap)
282 void __iomem *chan = ADMA_PORT_REGS(ap);
284 /* mask/clear ATA interrupts */
285 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
286 ata_check_status(ap);
288 /* reset ADMA to idle state */
289 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
291 writew(aPIOMD4 | aNIEN, chan + ADMA_CONTROL);
295 static void adma_thaw(struct ata_port *ap)
297 adma_reinit_engine(ap);
300 static int adma_prereset(struct ata_port *ap, unsigned long deadline)
302 struct adma_port_priv *pp = ap->private_data;
304 if (pp->state != adma_state_idle) /* healthy paranoia */
305 pp->state = adma_state_mmio;
306 adma_reinit_engine(ap);
308 return ata_std_prereset(ap, deadline);
311 static void adma_error_handler(struct ata_port *ap)
313 ata_do_eh(ap, adma_prereset, ata_std_softreset, NULL,
317 static int adma_fill_sg(struct ata_queued_cmd *qc)
319 struct scatterlist *sg;
320 struct ata_port *ap = qc->ap;
321 struct adma_port_priv *pp = ap->private_data;
323 int i = (2 + buf[3]) * 8;
324 u8 pFLAGS = pORD | ((qc->tf.flags & ATA_TFLAG_WRITE) ? pDIRO : 0);
326 ata_for_each_sg(sg, qc) {
330 addr = (u32)sg_dma_address(sg);
331 *(__le32 *)(buf + i) = cpu_to_le32(addr);
334 len = sg_dma_len(sg) >> 3;
335 *(__le32 *)(buf + i) = cpu_to_le32(len);
338 if (ata_sg_is_last(sg, qc))
341 buf[i++] = qc->dev->dma_mode & 0xf;
342 buf[i++] = 0; /* pPKLW */
343 buf[i++] = 0; /* reserved */
346 = (pFLAGS & pEND) ? 0 : cpu_to_le32(pp->pkt_dma + i + 4);
349 VPRINTK("PRD[%u] = (0x%lX, 0x%X)\n", i/4,
350 (unsigned long)addr, len);
355 static void adma_qc_prep(struct ata_queued_cmd *qc)
357 struct adma_port_priv *pp = qc->ap->private_data;
359 u32 pkt_dma = (u32)pp->pkt_dma;
364 adma_enter_reg_mode(qc->ap);
365 if (qc->tf.protocol != ATA_PROT_DMA) {
370 buf[i++] = 0; /* Response flags */
371 buf[i++] = 0; /* reserved */
372 buf[i++] = cVLD | cDAT | cIEN;
373 i++; /* cLEN, gets filled in below */
375 *(__le32 *)(buf+i) = cpu_to_le32(pkt_dma); /* cNCPB */
377 i += 4; /* cPRD, gets filled in below */
379 buf[i++] = 0; /* reserved */
380 buf[i++] = 0; /* reserved */
381 buf[i++] = 0; /* reserved */
382 buf[i++] = 0; /* reserved */
384 /* ATA registers; must be a multiple of 4 */
385 buf[i++] = qc->tf.device;
386 buf[i++] = ADMA_REGS_DEVICE;
387 if ((qc->tf.flags & ATA_TFLAG_LBA48)) {
388 buf[i++] = qc->tf.hob_nsect;
389 buf[i++] = ADMA_REGS_SECTOR_COUNT;
390 buf[i++] = qc->tf.hob_lbal;
391 buf[i++] = ADMA_REGS_LBA_LOW;
392 buf[i++] = qc->tf.hob_lbam;
393 buf[i++] = ADMA_REGS_LBA_MID;
394 buf[i++] = qc->tf.hob_lbah;
395 buf[i++] = ADMA_REGS_LBA_HIGH;
397 buf[i++] = qc->tf.nsect;
398 buf[i++] = ADMA_REGS_SECTOR_COUNT;
399 buf[i++] = qc->tf.lbal;
400 buf[i++] = ADMA_REGS_LBA_LOW;
401 buf[i++] = qc->tf.lbam;
402 buf[i++] = ADMA_REGS_LBA_MID;
403 buf[i++] = qc->tf.lbah;
404 buf[i++] = ADMA_REGS_LBA_HIGH;
406 buf[i++] = ADMA_REGS_CONTROL;
409 buf[i++] = qc->tf.command;
410 buf[i++] = ADMA_REGS_COMMAND | rEND;
412 buf[3] = (i >> 3) - 2; /* cLEN */
413 *(__le32 *)(buf+8) = cpu_to_le32(pkt_dma + i); /* cPRD */
415 i = adma_fill_sg(qc);
416 wmb(); /* flush PRDs and pkt to memory */
418 /* dump out CPB + PRDs for debug */
421 static char obuf[2048];
422 for (j = 0; j < i; ++j) {
423 len += sprintf(obuf+len, "%02x ", buf[j]);
425 printk("%s\n", obuf);
430 printk("%s\n", obuf);
435 static inline void adma_packet_start(struct ata_queued_cmd *qc)
437 struct ata_port *ap = qc->ap;
438 void __iomem *chan = ADMA_PORT_REGS(ap);
440 VPRINTK("ENTER, ap %p\n", ap);
442 /* fire up the ADMA engine */
443 writew(aPIOMD4 | aGO, chan + ADMA_CONTROL);
446 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc)
448 struct adma_port_priv *pp = qc->ap->private_data;
450 switch (qc->tf.protocol) {
452 pp->state = adma_state_pkt;
453 adma_packet_start(qc);
456 case ATA_PROT_ATAPI_DMA:
464 pp->state = adma_state_mmio;
465 return ata_qc_issue_prot(qc);
468 static inline unsigned int adma_intr_pkt(struct ata_host *host)
470 unsigned int handled = 0, port_no;
472 for (port_no = 0; port_no < host->n_ports; ++port_no) {
473 struct ata_port *ap = host->ports[port_no];
474 struct adma_port_priv *pp;
475 struct ata_queued_cmd *qc;
476 void __iomem *chan = ADMA_PORT_REGS(ap);
477 u8 status = readb(chan + ADMA_STATUS);
482 adma_enter_reg_mode(ap);
483 if (ap->flags & ATA_FLAG_DISABLED)
485 pp = ap->private_data;
486 if (!pp || pp->state != adma_state_pkt)
488 qc = ata_qc_from_tag(ap, ap->link.active_tag);
489 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
491 qc->err_mask |= AC_ERR_HOST_BUS;
492 else if ((status & (aPSD | aUIRQ)))
493 qc->err_mask |= AC_ERR_OTHER;
495 if (pp->pkt[0] & cATERR)
496 qc->err_mask |= AC_ERR_DEV;
497 else if (pp->pkt[0] != cDONE)
498 qc->err_mask |= AC_ERR_OTHER;
503 struct ata_eh_info *ehi = &ap->link.eh_info;
504 ata_ehi_clear_desc(ehi);
505 ata_ehi_push_desc(ehi,
506 "ADMA-status 0x%02X", status);
507 ata_ehi_push_desc(ehi,
508 "pkt[0] 0x%02X", pp->pkt[0]);
510 if (qc->err_mask == AC_ERR_DEV)
520 static inline unsigned int adma_intr_mmio(struct ata_host *host)
522 unsigned int handled = 0, port_no;
524 for (port_no = 0; port_no < host->n_ports; ++port_no) {
526 ap = host->ports[port_no];
527 if (ap && (!(ap->flags & ATA_FLAG_DISABLED))) {
528 struct ata_queued_cmd *qc;
529 struct adma_port_priv *pp = ap->private_data;
530 if (!pp || pp->state != adma_state_mmio)
532 qc = ata_qc_from_tag(ap, ap->link.active_tag);
533 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
535 /* check main status, clearing INTRQ */
536 u8 status = ata_check_status(ap);
537 if ((status & ATA_BUSY))
539 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
540 ap->print_id, qc->tf.protocol, status);
542 /* complete taskfile transaction */
543 pp->state = adma_state_idle;
544 qc->err_mask |= ac_err_mask(status);
548 struct ata_eh_info *ehi =
550 ata_ehi_clear_desc(ehi);
551 ata_ehi_push_desc(ehi,
552 "status 0x%02X", status);
554 if (qc->err_mask == AC_ERR_DEV)
566 static irqreturn_t adma_intr(int irq, void *dev_instance)
568 struct ata_host *host = dev_instance;
569 unsigned int handled = 0;
573 spin_lock(&host->lock);
574 handled = adma_intr_pkt(host) | adma_intr_mmio(host);
575 spin_unlock(&host->lock);
579 return IRQ_RETVAL(handled);
582 static void adma_ata_setup_port(struct ata_ioports *port, void __iomem *base)
585 port->data_addr = base + 0x000;
587 port->feature_addr = base + 0x004;
588 port->nsect_addr = base + 0x008;
589 port->lbal_addr = base + 0x00c;
590 port->lbam_addr = base + 0x010;
591 port->lbah_addr = base + 0x014;
592 port->device_addr = base + 0x018;
594 port->command_addr = base + 0x01c;
595 port->altstatus_addr =
596 port->ctl_addr = base + 0x038;
599 static int adma_port_start(struct ata_port *ap)
601 struct device *dev = ap->host->dev;
602 struct adma_port_priv *pp;
605 rc = ata_port_start(ap);
608 adma_enter_reg_mode(ap);
609 pp = devm_kzalloc(dev, sizeof(*pp), GFP_KERNEL);
612 pp->pkt = dmam_alloc_coherent(dev, ADMA_PKT_BYTES, &pp->pkt_dma,
617 if ((pp->pkt_dma & 7) != 0) {
618 printk("bad alignment for pp->pkt_dma: %08x\n",
622 memset(pp->pkt, 0, ADMA_PKT_BYTES);
623 ap->private_data = pp;
624 adma_reinit_engine(ap);
628 static void adma_port_stop(struct ata_port *ap)
630 adma_reset_engine(ap);
633 static void adma_host_stop(struct ata_host *host)
635 unsigned int port_no;
637 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
638 adma_reset_engine(host->ports[port_no]);
641 static void adma_host_init(struct ata_host *host, unsigned int chip_id)
643 unsigned int port_no;
645 /* enable/lock aGO operation */
646 writeb(7, host->iomap[ADMA_MMIO_BAR] + ADMA_MODE_LOCK);
648 /* reset the ADMA logic */
649 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
650 adma_reset_engine(host->ports[port_no]);
653 static int adma_set_dma_masks(struct pci_dev *pdev, void __iomem *mmio_base)
657 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
659 dev_printk(KERN_ERR, &pdev->dev,
660 "32-bit DMA enable failed\n");
663 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
665 dev_printk(KERN_ERR, &pdev->dev,
666 "32-bit consistent DMA enable failed\n");
672 static int adma_ata_init_one(struct pci_dev *pdev,
673 const struct pci_device_id *ent)
675 static int printed_version;
676 unsigned int board_idx = (unsigned int) ent->driver_data;
677 const struct ata_port_info *ppi[] = { &adma_port_info[board_idx], NULL };
678 struct ata_host *host;
679 void __iomem *mmio_base;
682 if (!printed_version++)
683 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
686 host = ata_host_alloc_pinfo(&pdev->dev, ppi, ADMA_PORTS);
690 /* acquire resources and fill host */
691 rc = pcim_enable_device(pdev);
695 if ((pci_resource_flags(pdev, 4) & IORESOURCE_MEM) == 0)
698 rc = pcim_iomap_regions(pdev, 1 << ADMA_MMIO_BAR, DRV_NAME);
701 host->iomap = pcim_iomap_table(pdev);
702 mmio_base = host->iomap[ADMA_MMIO_BAR];
704 rc = adma_set_dma_masks(pdev, mmio_base);
708 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
709 adma_ata_setup_port(&host->ports[port_no]->ioaddr,
710 ADMA_ATA_REGS(mmio_base, port_no));
712 /* initialize adapter */
713 adma_host_init(host, board_idx);
715 pci_set_master(pdev);
716 return ata_host_activate(host, pdev->irq, adma_intr, IRQF_SHARED,
720 static int __init adma_ata_init(void)
722 return pci_register_driver(&adma_ata_pci_driver);
725 static void __exit adma_ata_exit(void)
727 pci_unregister_driver(&adma_ata_pci_driver);
730 MODULE_AUTHOR("Mark Lord");
731 MODULE_DESCRIPTION("Pacific Digital Corporation ADMA low-level driver");
732 MODULE_LICENSE("GPL");
733 MODULE_DEVICE_TABLE(pci, adma_ata_pci_tbl);
734 MODULE_VERSION(DRV_VERSION);
736 module_init(adma_ata_init);
737 module_exit(adma_ata_exit);