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/sched.h>
43 #include <linux/device.h>
44 #include <scsi/scsi_host.h>
46 #include <linux/libata.h>
48 #define DRV_NAME "pdc_adma"
49 #define DRV_VERSION "0.04"
51 /* macro to calculate base address for ATA regs */
52 #define ADMA_ATA_REGS(base,port_no) ((base) + ((port_no) * 0x40))
54 /* macro to calculate base address for ADMA regs */
55 #define ADMA_REGS(base,port_no) ((base) + 0x80 + ((port_no) * 0x20))
60 ADMA_PRD_BYTES = LIBATA_MAX_PRD * 16,
61 ADMA_PKT_BYTES = ADMA_CPB_BYTES + ADMA_PRD_BYTES,
63 ADMA_DMA_BOUNDARY = 0xffffffff,
65 /* global register offsets */
66 ADMA_MODE_LOCK = 0x00c7,
68 /* per-channel register offsets */
69 ADMA_CONTROL = 0x0000, /* ADMA control */
70 ADMA_STATUS = 0x0002, /* ADMA status */
71 ADMA_CPB_COUNT = 0x0004, /* CPB count */
72 ADMA_CPB_CURRENT = 0x000c, /* current CPB address */
73 ADMA_CPB_NEXT = 0x000c, /* next CPB address */
74 ADMA_CPB_LOOKUP = 0x0010, /* CPB lookup table */
75 ADMA_FIFO_IN = 0x0014, /* input FIFO threshold */
76 ADMA_FIFO_OUT = 0x0016, /* output FIFO threshold */
78 /* ADMA_CONTROL register bits */
79 aNIEN = (1 << 8), /* irq mask: 1==masked */
80 aGO = (1 << 7), /* packet trigger ("Go!") */
81 aRSTADM = (1 << 5), /* ADMA logic reset */
82 aPIOMD4 = 0x0003, /* PIO mode 4 */
84 /* ADMA_STATUS register bits */
100 /* ATA register flags */
104 /* ATA register addresses */
105 ADMA_REGS_CONTROL = 0x0e,
106 ADMA_REGS_SECTOR_COUNT = 0x12,
107 ADMA_REGS_LBA_LOW = 0x13,
108 ADMA_REGS_LBA_MID = 0x14,
109 ADMA_REGS_LBA_HIGH = 0x15,
110 ADMA_REGS_DEVICE = 0x16,
111 ADMA_REGS_COMMAND = 0x17,
114 board_1841_idx = 0, /* ADMA 2-port controller */
117 typedef enum { adma_state_idle, adma_state_pkt, adma_state_mmio } adma_state_t;
119 struct adma_port_priv {
125 static int adma_ata_init_one (struct pci_dev *pdev,
126 const struct pci_device_id *ent);
127 static irqreturn_t adma_intr (int irq, void *dev_instance);
128 static int adma_port_start(struct ata_port *ap);
129 static void adma_host_stop(struct ata_host *host);
130 static void adma_port_stop(struct ata_port *ap);
131 static void adma_phy_reset(struct ata_port *ap);
132 static void adma_qc_prep(struct ata_queued_cmd *qc);
133 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc);
134 static int adma_check_atapi_dma(struct ata_queued_cmd *qc);
135 static void adma_bmdma_stop(struct ata_queued_cmd *qc);
136 static u8 adma_bmdma_status(struct ata_port *ap);
137 static void adma_irq_clear(struct ata_port *ap);
138 static void adma_eng_timeout(struct ata_port *ap);
140 static struct scsi_host_template adma_ata_sht = {
141 .module = THIS_MODULE,
143 .ioctl = ata_scsi_ioctl,
144 .queuecommand = ata_scsi_queuecmd,
145 .can_queue = ATA_DEF_QUEUE,
146 .this_id = ATA_SHT_THIS_ID,
147 .sg_tablesize = LIBATA_MAX_PRD,
148 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
149 .emulated = ATA_SHT_EMULATED,
150 .use_clustering = ENABLE_CLUSTERING,
151 .proc_name = DRV_NAME,
152 .dma_boundary = ADMA_DMA_BOUNDARY,
153 .slave_configure = ata_scsi_slave_config,
154 .slave_destroy = ata_scsi_slave_destroy,
155 .bios_param = ata_std_bios_param,
158 static const struct ata_port_operations adma_ata_ops = {
159 .port_disable = ata_port_disable,
160 .tf_load = ata_tf_load,
161 .tf_read = ata_tf_read,
162 .check_status = ata_check_status,
163 .check_atapi_dma = adma_check_atapi_dma,
164 .exec_command = ata_exec_command,
165 .dev_select = ata_std_dev_select,
166 .phy_reset = adma_phy_reset,
167 .qc_prep = adma_qc_prep,
168 .qc_issue = adma_qc_issue,
169 .eng_timeout = adma_eng_timeout,
170 .data_xfer = ata_mmio_data_xfer,
171 .irq_handler = adma_intr,
172 .irq_clear = adma_irq_clear,
173 .port_start = adma_port_start,
174 .port_stop = adma_port_stop,
175 .host_stop = adma_host_stop,
176 .bmdma_stop = adma_bmdma_stop,
177 .bmdma_status = adma_bmdma_status,
180 static struct ata_port_info adma_port_info[] = {
183 .sht = &adma_ata_sht,
184 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST |
185 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO |
186 ATA_FLAG_PIO_POLLING,
187 .pio_mask = 0x10, /* pio4 */
188 .udma_mask = 0x1f, /* udma0-4 */
189 .port_ops = &adma_ata_ops,
193 static const struct pci_device_id adma_ata_pci_tbl[] = {
194 { PCI_VDEVICE(PDC, 0x1841), board_1841_idx },
196 { } /* terminate list */
199 static struct pci_driver adma_ata_pci_driver = {
201 .id_table = adma_ata_pci_tbl,
202 .probe = adma_ata_init_one,
203 .remove = ata_pci_remove_one,
206 static int adma_check_atapi_dma(struct ata_queued_cmd *qc)
208 return 1; /* ATAPI DMA not yet supported */
211 static void adma_bmdma_stop(struct ata_queued_cmd *qc)
216 static u8 adma_bmdma_status(struct ata_port *ap)
221 static void adma_irq_clear(struct ata_port *ap)
226 static void adma_reset_engine(void __iomem *chan)
228 /* reset ADMA to idle state */
229 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
231 writew(aPIOMD4, chan + ADMA_CONTROL);
235 static void adma_reinit_engine(struct ata_port *ap)
237 struct adma_port_priv *pp = ap->private_data;
238 void __iomem *mmio_base = ap->host->mmio_base;
239 void __iomem *chan = ADMA_REGS(mmio_base, ap->port_no);
241 /* mask/clear ATA interrupts */
242 writeb(ATA_NIEN, (void __iomem *)ap->ioaddr.ctl_addr);
243 ata_check_status(ap);
245 /* reset the ADMA engine */
246 adma_reset_engine(chan);
248 /* set in-FIFO threshold to 0x100 */
249 writew(0x100, chan + ADMA_FIFO_IN);
251 /* set CPB pointer */
252 writel((u32)pp->pkt_dma, chan + ADMA_CPB_NEXT);
254 /* set out-FIFO threshold to 0x100 */
255 writew(0x100, chan + ADMA_FIFO_OUT);
258 writew(1, chan + ADMA_CPB_COUNT);
260 /* read/discard ADMA status */
261 readb(chan + ADMA_STATUS);
264 static inline void adma_enter_reg_mode(struct ata_port *ap)
266 void __iomem *chan = ADMA_REGS(ap->host->mmio_base, ap->port_no);
268 writew(aPIOMD4, chan + ADMA_CONTROL);
269 readb(chan + ADMA_STATUS); /* flush */
272 static void adma_phy_reset(struct ata_port *ap)
274 struct adma_port_priv *pp = ap->private_data;
276 pp->state = adma_state_idle;
277 adma_reinit_engine(ap);
282 static void adma_eng_timeout(struct ata_port *ap)
284 struct adma_port_priv *pp = ap->private_data;
286 if (pp->state != adma_state_idle) /* healthy paranoia */
287 pp->state = adma_state_mmio;
288 adma_reinit_engine(ap);
292 static int adma_fill_sg(struct ata_queued_cmd *qc)
294 struct scatterlist *sg;
295 struct ata_port *ap = qc->ap;
296 struct adma_port_priv *pp = ap->private_data;
298 int i = (2 + buf[3]) * 8;
299 u8 pFLAGS = pORD | ((qc->tf.flags & ATA_TFLAG_WRITE) ? pDIRO : 0);
301 ata_for_each_sg(sg, qc) {
305 addr = (u32)sg_dma_address(sg);
306 *(__le32 *)(buf + i) = cpu_to_le32(addr);
309 len = sg_dma_len(sg) >> 3;
310 *(__le32 *)(buf + i) = cpu_to_le32(len);
313 if (ata_sg_is_last(sg, qc))
316 buf[i++] = qc->dev->dma_mode & 0xf;
317 buf[i++] = 0; /* pPKLW */
318 buf[i++] = 0; /* reserved */
321 = (pFLAGS & pEND) ? 0 : cpu_to_le32(pp->pkt_dma + i + 4);
324 VPRINTK("PRD[%u] = (0x%lX, 0x%X)\n", i/4,
325 (unsigned long)addr, len);
330 static void adma_qc_prep(struct ata_queued_cmd *qc)
332 struct adma_port_priv *pp = qc->ap->private_data;
334 u32 pkt_dma = (u32)pp->pkt_dma;
339 adma_enter_reg_mode(qc->ap);
340 if (qc->tf.protocol != ATA_PROT_DMA) {
345 buf[i++] = 0; /* Response flags */
346 buf[i++] = 0; /* reserved */
347 buf[i++] = cVLD | cDAT | cIEN;
348 i++; /* cLEN, gets filled in below */
350 *(__le32 *)(buf+i) = cpu_to_le32(pkt_dma); /* cNCPB */
352 i += 4; /* cPRD, gets filled in below */
354 buf[i++] = 0; /* reserved */
355 buf[i++] = 0; /* reserved */
356 buf[i++] = 0; /* reserved */
357 buf[i++] = 0; /* reserved */
359 /* ATA registers; must be a multiple of 4 */
360 buf[i++] = qc->tf.device;
361 buf[i++] = ADMA_REGS_DEVICE;
362 if ((qc->tf.flags & ATA_TFLAG_LBA48)) {
363 buf[i++] = qc->tf.hob_nsect;
364 buf[i++] = ADMA_REGS_SECTOR_COUNT;
365 buf[i++] = qc->tf.hob_lbal;
366 buf[i++] = ADMA_REGS_LBA_LOW;
367 buf[i++] = qc->tf.hob_lbam;
368 buf[i++] = ADMA_REGS_LBA_MID;
369 buf[i++] = qc->tf.hob_lbah;
370 buf[i++] = ADMA_REGS_LBA_HIGH;
372 buf[i++] = qc->tf.nsect;
373 buf[i++] = ADMA_REGS_SECTOR_COUNT;
374 buf[i++] = qc->tf.lbal;
375 buf[i++] = ADMA_REGS_LBA_LOW;
376 buf[i++] = qc->tf.lbam;
377 buf[i++] = ADMA_REGS_LBA_MID;
378 buf[i++] = qc->tf.lbah;
379 buf[i++] = ADMA_REGS_LBA_HIGH;
381 buf[i++] = ADMA_REGS_CONTROL;
384 buf[i++] = qc->tf.command;
385 buf[i++] = ADMA_REGS_COMMAND | rEND;
387 buf[3] = (i >> 3) - 2; /* cLEN */
388 *(__le32 *)(buf+8) = cpu_to_le32(pkt_dma + i); /* cPRD */
390 i = adma_fill_sg(qc);
391 wmb(); /* flush PRDs and pkt to memory */
393 /* dump out CPB + PRDs for debug */
396 static char obuf[2048];
397 for (j = 0; j < i; ++j) {
398 len += sprintf(obuf+len, "%02x ", buf[j]);
400 printk("%s\n", obuf);
405 printk("%s\n", obuf);
410 static inline void adma_packet_start(struct ata_queued_cmd *qc)
412 struct ata_port *ap = qc->ap;
413 void __iomem *chan = ADMA_REGS(ap->host->mmio_base, ap->port_no);
415 VPRINTK("ENTER, ap %p\n", ap);
417 /* fire up the ADMA engine */
418 writew(aPIOMD4 | aGO, chan + ADMA_CONTROL);
421 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc)
423 struct adma_port_priv *pp = qc->ap->private_data;
425 switch (qc->tf.protocol) {
427 pp->state = adma_state_pkt;
428 adma_packet_start(qc);
431 case ATA_PROT_ATAPI_DMA:
439 pp->state = adma_state_mmio;
440 return ata_qc_issue_prot(qc);
443 static inline unsigned int adma_intr_pkt(struct ata_host *host)
445 unsigned int handled = 0, port_no;
446 u8 __iomem *mmio_base = host->mmio_base;
448 for (port_no = 0; port_no < host->n_ports; ++port_no) {
449 struct ata_port *ap = host->ports[port_no];
450 struct adma_port_priv *pp;
451 struct ata_queued_cmd *qc;
452 void __iomem *chan = ADMA_REGS(mmio_base, port_no);
453 u8 status = readb(chan + ADMA_STATUS);
458 adma_enter_reg_mode(ap);
459 if (ap->flags & ATA_FLAG_DISABLED)
461 pp = ap->private_data;
462 if (!pp || pp->state != adma_state_pkt)
464 qc = ata_qc_from_tag(ap, ap->active_tag);
465 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
466 if ((status & (aPERR | aPSD | aUIRQ)))
467 qc->err_mask |= AC_ERR_OTHER;
468 else if (pp->pkt[0] != cDONE)
469 qc->err_mask |= AC_ERR_OTHER;
477 static inline unsigned int adma_intr_mmio(struct ata_host *host)
479 unsigned int handled = 0, port_no;
481 for (port_no = 0; port_no < host->n_ports; ++port_no) {
483 ap = host->ports[port_no];
484 if (ap && (!(ap->flags & ATA_FLAG_DISABLED))) {
485 struct ata_queued_cmd *qc;
486 struct adma_port_priv *pp = ap->private_data;
487 if (!pp || pp->state != adma_state_mmio)
489 qc = ata_qc_from_tag(ap, ap->active_tag);
490 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
492 /* check main status, clearing INTRQ */
493 u8 status = ata_check_status(ap);
494 if ((status & ATA_BUSY))
496 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
497 ap->id, qc->tf.protocol, status);
499 /* complete taskfile transaction */
500 pp->state = adma_state_idle;
501 qc->err_mask |= ac_err_mask(status);
510 static irqreturn_t adma_intr(int irq, void *dev_instance)
512 struct ata_host *host = dev_instance;
513 unsigned int handled = 0;
517 spin_lock(&host->lock);
518 handled = adma_intr_pkt(host) | adma_intr_mmio(host);
519 spin_unlock(&host->lock);
523 return IRQ_RETVAL(handled);
526 static void adma_ata_setup_port(struct ata_ioports *port, unsigned long base)
529 port->data_addr = base + 0x000;
531 port->feature_addr = base + 0x004;
532 port->nsect_addr = base + 0x008;
533 port->lbal_addr = base + 0x00c;
534 port->lbam_addr = base + 0x010;
535 port->lbah_addr = base + 0x014;
536 port->device_addr = base + 0x018;
538 port->command_addr = base + 0x01c;
539 port->altstatus_addr =
540 port->ctl_addr = base + 0x038;
543 static int adma_port_start(struct ata_port *ap)
545 struct device *dev = ap->host->dev;
546 struct adma_port_priv *pp;
549 rc = ata_port_start(ap);
552 adma_enter_reg_mode(ap);
554 pp = kcalloc(1, sizeof(*pp), GFP_KERNEL);
557 pp->pkt = dma_alloc_coherent(dev, ADMA_PKT_BYTES, &pp->pkt_dma,
562 if ((pp->pkt_dma & 7) != 0) {
563 printk("bad alignment for pp->pkt_dma: %08x\n",
565 dma_free_coherent(dev, ADMA_PKT_BYTES,
566 pp->pkt, pp->pkt_dma);
569 memset(pp->pkt, 0, ADMA_PKT_BYTES);
570 ap->private_data = pp;
571 adma_reinit_engine(ap);
581 static void adma_port_stop(struct ata_port *ap)
583 struct device *dev = ap->host->dev;
584 struct adma_port_priv *pp = ap->private_data;
586 adma_reset_engine(ADMA_REGS(ap->host->mmio_base, ap->port_no));
588 ap->private_data = NULL;
590 dma_free_coherent(dev, ADMA_PKT_BYTES,
591 pp->pkt, pp->pkt_dma);
597 static void adma_host_stop(struct ata_host *host)
599 unsigned int port_no;
601 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
602 adma_reset_engine(ADMA_REGS(host->mmio_base, port_no));
604 ata_pci_host_stop(host);
607 static void adma_host_init(unsigned int chip_id,
608 struct ata_probe_ent *probe_ent)
610 unsigned int port_no;
611 void __iomem *mmio_base = probe_ent->mmio_base;
613 /* enable/lock aGO operation */
614 writeb(7, mmio_base + ADMA_MODE_LOCK);
616 /* reset the ADMA logic */
617 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
618 adma_reset_engine(ADMA_REGS(mmio_base, port_no));
621 static int adma_set_dma_masks(struct pci_dev *pdev, void __iomem *mmio_base)
625 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
627 dev_printk(KERN_ERR, &pdev->dev,
628 "32-bit DMA enable failed\n");
631 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
633 dev_printk(KERN_ERR, &pdev->dev,
634 "32-bit consistent DMA enable failed\n");
640 static int adma_ata_init_one(struct pci_dev *pdev,
641 const struct pci_device_id *ent)
643 static int printed_version;
644 struct ata_probe_ent *probe_ent = NULL;
645 void __iomem *mmio_base;
646 unsigned int board_idx = (unsigned int) ent->driver_data;
649 if (!printed_version++)
650 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
652 rc = pci_enable_device(pdev);
656 rc = pci_request_regions(pdev, DRV_NAME);
660 if ((pci_resource_flags(pdev, 4) & IORESOURCE_MEM) == 0) {
662 goto err_out_regions;
665 mmio_base = pci_iomap(pdev, 4, 0);
666 if (mmio_base == NULL) {
668 goto err_out_regions;
671 rc = adma_set_dma_masks(pdev, mmio_base);
673 goto err_out_iounmap;
675 probe_ent = kcalloc(1, sizeof(*probe_ent), GFP_KERNEL);
676 if (probe_ent == NULL) {
678 goto err_out_iounmap;
681 probe_ent->dev = pci_dev_to_dev(pdev);
682 INIT_LIST_HEAD(&probe_ent->node);
684 probe_ent->sht = adma_port_info[board_idx].sht;
685 probe_ent->port_flags = adma_port_info[board_idx].flags;
686 probe_ent->pio_mask = adma_port_info[board_idx].pio_mask;
687 probe_ent->mwdma_mask = adma_port_info[board_idx].mwdma_mask;
688 probe_ent->udma_mask = adma_port_info[board_idx].udma_mask;
689 probe_ent->port_ops = adma_port_info[board_idx].port_ops;
691 probe_ent->irq = pdev->irq;
692 probe_ent->irq_flags = IRQF_SHARED;
693 probe_ent->mmio_base = mmio_base;
694 probe_ent->n_ports = ADMA_PORTS;
696 for (port_no = 0; port_no < probe_ent->n_ports; ++port_no) {
697 adma_ata_setup_port(&probe_ent->port[port_no],
698 ADMA_ATA_REGS((unsigned long)mmio_base, port_no));
701 pci_set_master(pdev);
703 /* initialize adapter */
704 adma_host_init(board_idx, probe_ent);
706 rc = ata_device_add(probe_ent);
708 if (rc != ADMA_PORTS)
709 goto err_out_iounmap;
713 pci_iounmap(pdev, mmio_base);
715 pci_release_regions(pdev);
717 pci_disable_device(pdev);
721 static int __init adma_ata_init(void)
723 return pci_register_driver(&adma_ata_pci_driver);
726 static void __exit adma_ata_exit(void)
728 pci_unregister_driver(&adma_ata_pci_driver);
731 MODULE_AUTHOR("Mark Lord");
732 MODULE_DESCRIPTION("Pacific Digital Corporation ADMA low-level driver");
733 MODULE_LICENSE("GPL");
734 MODULE_DEVICE_TABLE(pci, adma_ata_pci_tbl);
735 MODULE_VERSION(DRV_VERSION);
737 module_init(adma_ata_init);
738 module_exit(adma_ata_exit);