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_freeze(struct ata_port *ap);
142 static void adma_thaw(struct ata_port *ap);
143 static void adma_error_handler(struct ata_port *ap);
145 static struct scsi_host_template adma_ata_sht = {
146 .module = THIS_MODULE,
148 .ioctl = ata_scsi_ioctl,
149 .queuecommand = ata_scsi_queuecmd,
150 .slave_configure = ata_scsi_slave_config,
151 .slave_destroy = ata_scsi_slave_destroy,
152 .bios_param = ata_std_bios_param,
153 .proc_name = DRV_NAME,
154 .can_queue = ATA_DEF_QUEUE,
155 .this_id = ATA_SHT_THIS_ID,
156 .sg_tablesize = LIBATA_MAX_PRD,
157 .dma_boundary = ADMA_DMA_BOUNDARY,
158 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
159 .use_clustering = ENABLE_CLUSTERING,
160 .emulated = ATA_SHT_EMULATED,
163 static const struct ata_port_operations adma_ata_ops = {
164 .tf_load = ata_tf_load,
165 .tf_read = ata_tf_read,
166 .exec_command = ata_exec_command,
167 .check_status = ata_check_status,
168 .dev_select = ata_std_dev_select,
169 .check_atapi_dma = adma_check_atapi_dma,
170 .data_xfer = ata_data_xfer,
171 .qc_prep = adma_qc_prep,
172 .qc_issue = adma_qc_issue,
173 .freeze = adma_freeze,
175 .error_handler = adma_error_handler,
176 .irq_clear = ata_noop_irq_clear,
177 .irq_on = ata_irq_on,
178 .port_start = adma_port_start,
179 .port_stop = adma_port_stop,
180 .host_stop = adma_host_stop,
181 .bmdma_stop = adma_bmdma_stop,
182 .bmdma_status = adma_bmdma_status,
185 static struct ata_port_info adma_port_info[] = {
188 .flags = ATA_FLAG_SLAVE_POSS |
189 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO |
190 ATA_FLAG_PIO_POLLING,
191 .pio_mask = 0x10, /* pio4 */
192 .udma_mask = ATA_UDMA4,
193 .port_ops = &adma_ata_ops,
197 static const struct pci_device_id adma_ata_pci_tbl[] = {
198 { PCI_VDEVICE(PDC, 0x1841), board_1841_idx },
200 { } /* terminate list */
203 static struct pci_driver adma_ata_pci_driver = {
205 .id_table = adma_ata_pci_tbl,
206 .probe = adma_ata_init_one,
207 .remove = ata_pci_remove_one,
210 static int adma_check_atapi_dma(struct ata_queued_cmd *qc)
212 return 1; /* ATAPI DMA not yet supported */
215 static void adma_bmdma_stop(struct ata_queued_cmd *qc)
220 static u8 adma_bmdma_status(struct ata_port *ap)
225 static void adma_reset_engine(struct ata_port *ap)
227 void __iomem *chan = ADMA_PORT_REGS(ap);
229 /* reset ADMA to idle state */
230 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
232 writew(aPIOMD4, chan + ADMA_CONTROL);
236 static void adma_reinit_engine(struct ata_port *ap)
238 struct adma_port_priv *pp = ap->private_data;
239 void __iomem *chan = ADMA_PORT_REGS(ap);
241 /* mask/clear ATA interrupts */
242 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
243 ata_check_status(ap);
245 /* reset the ADMA engine */
246 adma_reset_engine(ap);
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_PORT_REGS(ap);
268 writew(aPIOMD4, chan + ADMA_CONTROL);
269 readb(chan + ADMA_STATUS); /* flush */
272 static void adma_freeze(struct ata_port *ap)
274 void __iomem *chan = ADMA_PORT_REGS(ap);
276 /* mask/clear ATA interrupts */
277 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
278 ata_check_status(ap);
280 /* reset ADMA to idle state */
281 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
283 writew(aPIOMD4 | aNIEN, chan + ADMA_CONTROL);
287 static void adma_thaw(struct ata_port *ap)
289 adma_reinit_engine(ap);
292 static int adma_prereset(struct ata_link *link, unsigned long deadline)
294 struct ata_port *ap = link->ap;
295 struct adma_port_priv *pp = ap->private_data;
297 if (pp->state != adma_state_idle) /* healthy paranoia */
298 pp->state = adma_state_mmio;
299 adma_reinit_engine(ap);
301 return ata_std_prereset(link, deadline);
304 static void adma_error_handler(struct ata_port *ap)
306 ata_do_eh(ap, adma_prereset, ata_std_softreset, NULL,
310 static int adma_fill_sg(struct ata_queued_cmd *qc)
312 struct scatterlist *sg;
313 struct ata_port *ap = qc->ap;
314 struct adma_port_priv *pp = ap->private_data;
315 u8 *buf = pp->pkt, *last_buf = NULL;
316 int i = (2 + buf[3]) * 8;
317 u8 pFLAGS = pORD | ((qc->tf.flags & ATA_TFLAG_WRITE) ? pDIRO : 0);
320 for_each_sg(qc->sg, sg, qc->n_elem, si) {
324 addr = (u32)sg_dma_address(sg);
325 *(__le32 *)(buf + i) = cpu_to_le32(addr);
328 len = sg_dma_len(sg) >> 3;
329 *(__le32 *)(buf + i) = cpu_to_le32(len);
334 buf[i++] = qc->dev->dma_mode & 0xf;
335 buf[i++] = 0; /* pPKLW */
336 buf[i++] = 0; /* reserved */
338 *(__le32 *)(buf + i) =
339 (pFLAGS & pEND) ? 0 : cpu_to_le32(pp->pkt_dma + i + 4);
342 VPRINTK("PRD[%u] = (0x%lX, 0x%X)\n", i/4,
343 (unsigned long)addr, len);
346 if (likely(last_buf))
352 static void adma_qc_prep(struct ata_queued_cmd *qc)
354 struct adma_port_priv *pp = qc->ap->private_data;
356 u32 pkt_dma = (u32)pp->pkt_dma;
361 adma_enter_reg_mode(qc->ap);
362 if (qc->tf.protocol != ATA_PROT_DMA) {
367 buf[i++] = 0; /* Response flags */
368 buf[i++] = 0; /* reserved */
369 buf[i++] = cVLD | cDAT | cIEN;
370 i++; /* cLEN, gets filled in below */
372 *(__le32 *)(buf+i) = cpu_to_le32(pkt_dma); /* cNCPB */
374 i += 4; /* cPRD, gets filled in below */
376 buf[i++] = 0; /* reserved */
377 buf[i++] = 0; /* reserved */
378 buf[i++] = 0; /* reserved */
379 buf[i++] = 0; /* reserved */
381 /* ATA registers; must be a multiple of 4 */
382 buf[i++] = qc->tf.device;
383 buf[i++] = ADMA_REGS_DEVICE;
384 if ((qc->tf.flags & ATA_TFLAG_LBA48)) {
385 buf[i++] = qc->tf.hob_nsect;
386 buf[i++] = ADMA_REGS_SECTOR_COUNT;
387 buf[i++] = qc->tf.hob_lbal;
388 buf[i++] = ADMA_REGS_LBA_LOW;
389 buf[i++] = qc->tf.hob_lbam;
390 buf[i++] = ADMA_REGS_LBA_MID;
391 buf[i++] = qc->tf.hob_lbah;
392 buf[i++] = ADMA_REGS_LBA_HIGH;
394 buf[i++] = qc->tf.nsect;
395 buf[i++] = ADMA_REGS_SECTOR_COUNT;
396 buf[i++] = qc->tf.lbal;
397 buf[i++] = ADMA_REGS_LBA_LOW;
398 buf[i++] = qc->tf.lbam;
399 buf[i++] = ADMA_REGS_LBA_MID;
400 buf[i++] = qc->tf.lbah;
401 buf[i++] = ADMA_REGS_LBA_HIGH;
403 buf[i++] = ADMA_REGS_CONTROL;
406 buf[i++] = qc->tf.command;
407 buf[i++] = ADMA_REGS_COMMAND | rEND;
409 buf[3] = (i >> 3) - 2; /* cLEN */
410 *(__le32 *)(buf+8) = cpu_to_le32(pkt_dma + i); /* cPRD */
412 i = adma_fill_sg(qc);
413 wmb(); /* flush PRDs and pkt to memory */
415 /* dump out CPB + PRDs for debug */
418 static char obuf[2048];
419 for (j = 0; j < i; ++j) {
420 len += sprintf(obuf+len, "%02x ", buf[j]);
422 printk("%s\n", obuf);
427 printk("%s\n", obuf);
432 static inline void adma_packet_start(struct ata_queued_cmd *qc)
434 struct ata_port *ap = qc->ap;
435 void __iomem *chan = ADMA_PORT_REGS(ap);
437 VPRINTK("ENTER, ap %p\n", ap);
439 /* fire up the ADMA engine */
440 writew(aPIOMD4 | aGO, chan + ADMA_CONTROL);
443 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc)
445 struct adma_port_priv *pp = qc->ap->private_data;
447 switch (qc->tf.protocol) {
449 pp->state = adma_state_pkt;
450 adma_packet_start(qc);
461 pp->state = adma_state_mmio;
462 return ata_qc_issue_prot(qc);
465 static inline unsigned int adma_intr_pkt(struct ata_host *host)
467 unsigned int handled = 0, port_no;
469 for (port_no = 0; port_no < host->n_ports; ++port_no) {
470 struct ata_port *ap = host->ports[port_no];
471 struct adma_port_priv *pp;
472 struct ata_queued_cmd *qc;
473 void __iomem *chan = ADMA_PORT_REGS(ap);
474 u8 status = readb(chan + ADMA_STATUS);
479 adma_enter_reg_mode(ap);
480 if (ap->flags & ATA_FLAG_DISABLED)
482 pp = ap->private_data;
483 if (!pp || pp->state != adma_state_pkt)
485 qc = ata_qc_from_tag(ap, ap->link.active_tag);
486 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
488 qc->err_mask |= AC_ERR_HOST_BUS;
489 else if ((status & (aPSD | aUIRQ)))
490 qc->err_mask |= AC_ERR_OTHER;
492 if (pp->pkt[0] & cATERR)
493 qc->err_mask |= AC_ERR_DEV;
494 else if (pp->pkt[0] != cDONE)
495 qc->err_mask |= AC_ERR_OTHER;
500 struct ata_eh_info *ehi = &ap->link.eh_info;
501 ata_ehi_clear_desc(ehi);
502 ata_ehi_push_desc(ehi,
503 "ADMA-status 0x%02X", status);
504 ata_ehi_push_desc(ehi,
505 "pkt[0] 0x%02X", pp->pkt[0]);
507 if (qc->err_mask == AC_ERR_DEV)
517 static inline unsigned int adma_intr_mmio(struct ata_host *host)
519 unsigned int handled = 0, port_no;
521 for (port_no = 0; port_no < host->n_ports; ++port_no) {
523 ap = host->ports[port_no];
524 if (ap && (!(ap->flags & ATA_FLAG_DISABLED))) {
525 struct ata_queued_cmd *qc;
526 struct adma_port_priv *pp = ap->private_data;
527 if (!pp || pp->state != adma_state_mmio)
529 qc = ata_qc_from_tag(ap, ap->link.active_tag);
530 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
532 /* check main status, clearing INTRQ */
533 u8 status = ata_check_status(ap);
534 if ((status & ATA_BUSY))
536 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
537 ap->print_id, qc->tf.protocol, status);
539 /* complete taskfile transaction */
540 pp->state = adma_state_idle;
541 qc->err_mask |= ac_err_mask(status);
545 struct ata_eh_info *ehi =
547 ata_ehi_clear_desc(ehi);
548 ata_ehi_push_desc(ehi,
549 "status 0x%02X", status);
551 if (qc->err_mask == AC_ERR_DEV)
563 static irqreturn_t adma_intr(int irq, void *dev_instance)
565 struct ata_host *host = dev_instance;
566 unsigned int handled = 0;
570 spin_lock(&host->lock);
571 handled = adma_intr_pkt(host) | adma_intr_mmio(host);
572 spin_unlock(&host->lock);
576 return IRQ_RETVAL(handled);
579 static void adma_ata_setup_port(struct ata_ioports *port, void __iomem *base)
582 port->data_addr = base + 0x000;
584 port->feature_addr = base + 0x004;
585 port->nsect_addr = base + 0x008;
586 port->lbal_addr = base + 0x00c;
587 port->lbam_addr = base + 0x010;
588 port->lbah_addr = base + 0x014;
589 port->device_addr = base + 0x018;
591 port->command_addr = base + 0x01c;
592 port->altstatus_addr =
593 port->ctl_addr = base + 0x038;
596 static int adma_port_start(struct ata_port *ap)
598 struct device *dev = ap->host->dev;
599 struct adma_port_priv *pp;
602 rc = ata_port_start(ap);
605 adma_enter_reg_mode(ap);
606 pp = devm_kzalloc(dev, sizeof(*pp), GFP_KERNEL);
609 pp->pkt = dmam_alloc_coherent(dev, ADMA_PKT_BYTES, &pp->pkt_dma,
614 if ((pp->pkt_dma & 7) != 0) {
615 printk(KERN_ERR "bad alignment for pp->pkt_dma: %08x\n",
619 memset(pp->pkt, 0, ADMA_PKT_BYTES);
620 ap->private_data = pp;
621 adma_reinit_engine(ap);
625 static void adma_port_stop(struct ata_port *ap)
627 adma_reset_engine(ap);
630 static void adma_host_stop(struct ata_host *host)
632 unsigned int port_no;
634 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
635 adma_reset_engine(host->ports[port_no]);
638 static void adma_host_init(struct ata_host *host, unsigned int chip_id)
640 unsigned int port_no;
642 /* enable/lock aGO operation */
643 writeb(7, host->iomap[ADMA_MMIO_BAR] + ADMA_MODE_LOCK);
645 /* reset the ADMA logic */
646 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
647 adma_reset_engine(host->ports[port_no]);
650 static int adma_set_dma_masks(struct pci_dev *pdev, void __iomem *mmio_base)
654 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
656 dev_printk(KERN_ERR, &pdev->dev,
657 "32-bit DMA enable failed\n");
660 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
662 dev_printk(KERN_ERR, &pdev->dev,
663 "32-bit consistent DMA enable failed\n");
669 static int adma_ata_init_one(struct pci_dev *pdev,
670 const struct pci_device_id *ent)
672 static int printed_version;
673 unsigned int board_idx = (unsigned int) ent->driver_data;
674 const struct ata_port_info *ppi[] = { &adma_port_info[board_idx], NULL };
675 struct ata_host *host;
676 void __iomem *mmio_base;
679 if (!printed_version++)
680 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
683 host = ata_host_alloc_pinfo(&pdev->dev, ppi, ADMA_PORTS);
687 /* acquire resources and fill host */
688 rc = pcim_enable_device(pdev);
692 if ((pci_resource_flags(pdev, 4) & IORESOURCE_MEM) == 0)
695 rc = pcim_iomap_regions(pdev, 1 << ADMA_MMIO_BAR, DRV_NAME);
698 host->iomap = pcim_iomap_table(pdev);
699 mmio_base = host->iomap[ADMA_MMIO_BAR];
701 rc = adma_set_dma_masks(pdev, mmio_base);
705 for (port_no = 0; port_no < ADMA_PORTS; ++port_no) {
706 struct ata_port *ap = host->ports[port_no];
707 void __iomem *port_base = ADMA_ATA_REGS(mmio_base, port_no);
708 unsigned int offset = port_base - mmio_base;
710 adma_ata_setup_port(&ap->ioaddr, port_base);
712 ata_port_pbar_desc(ap, ADMA_MMIO_BAR, -1, "mmio");
713 ata_port_pbar_desc(ap, ADMA_MMIO_BAR, offset, "port");
716 /* initialize adapter */
717 adma_host_init(host, board_idx);
719 pci_set_master(pdev);
720 return ata_host_activate(host, pdev->irq, adma_intr, IRQF_SHARED,
724 static int __init adma_ata_init(void)
726 return pci_register_driver(&adma_ata_pci_driver);
729 static void __exit adma_ata_exit(void)
731 pci_unregister_driver(&adma_ata_pci_driver);
734 MODULE_AUTHOR("Mark Lord");
735 MODULE_DESCRIPTION("Pacific Digital Corporation ADMA low-level driver");
736 MODULE_LICENSE("GPL");
737 MODULE_DEVICE_TABLE(pci, adma_ata_pci_tbl);
738 MODULE_VERSION(DRV_VERSION);
740 module_init(adma_ata_init);
741 module_exit(adma_ata_exit);