1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * pdc_adma.c - Pacific Digital Corporation ADMA
5 * Maintained by: Tejun Heo <tj@kernel.org>
7 * Copyright 2005 Mark Lord
9 * libata documentation is available via 'make {ps|pdf}docs',
10 * as Documentation/driver-api/libata.rst
12 * Supports ATA disks in single-packet ADMA mode.
13 * Uses PIO for everything else.
15 * TODO: Use ADMA transfers for ATAPI devices, when possible.
16 * This requires careful attention to a number of quirks of the chip.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/gfp.h>
22 #include <linux/pci.h>
23 #include <linux/blkdev.h>
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/device.h>
27 #include <scsi/scsi_host.h>
28 #include <linux/libata.h>
30 #define DRV_NAME "pdc_adma"
31 #define DRV_VERSION "1.0"
33 /* macro to calculate base address for ATA regs */
34 #define ADMA_ATA_REGS(base, port_no) ((base) + ((port_no) * 0x40))
36 /* macro to calculate base address for ADMA regs */
37 #define ADMA_REGS(base, port_no) ((base) + 0x80 + ((port_no) * 0x20))
39 /* macro to obtain addresses from ata_port */
40 #define ADMA_PORT_REGS(ap) \
41 ADMA_REGS((ap)->host->iomap[ADMA_MMIO_BAR], ap->port_no)
48 ADMA_PRD_BYTES = LIBATA_MAX_PRD * 16,
49 ADMA_PKT_BYTES = ADMA_CPB_BYTES + ADMA_PRD_BYTES,
51 ADMA_DMA_BOUNDARY = 0xffffffff,
53 /* global register offsets */
54 ADMA_MODE_LOCK = 0x00c7,
56 /* per-channel register offsets */
57 ADMA_CONTROL = 0x0000, /* ADMA control */
58 ADMA_STATUS = 0x0002, /* ADMA status */
59 ADMA_CPB_COUNT = 0x0004, /* CPB count */
60 ADMA_CPB_CURRENT = 0x000c, /* current CPB address */
61 ADMA_CPB_NEXT = 0x000c, /* next CPB address */
62 ADMA_CPB_LOOKUP = 0x0010, /* CPB lookup table */
63 ADMA_FIFO_IN = 0x0014, /* input FIFO threshold */
64 ADMA_FIFO_OUT = 0x0016, /* output FIFO threshold */
66 /* ADMA_CONTROL register bits */
67 aNIEN = (1 << 8), /* irq mask: 1==masked */
68 aGO = (1 << 7), /* packet trigger ("Go!") */
69 aRSTADM = (1 << 5), /* ADMA logic reset */
70 aPIOMD4 = 0x0003, /* PIO mode 4 */
72 /* ADMA_STATUS register bits */
90 /* ATA register flags */
94 /* ATA register addresses */
95 ADMA_REGS_CONTROL = 0x0e,
96 ADMA_REGS_SECTOR_COUNT = 0x12,
97 ADMA_REGS_LBA_LOW = 0x13,
98 ADMA_REGS_LBA_MID = 0x14,
99 ADMA_REGS_LBA_HIGH = 0x15,
100 ADMA_REGS_DEVICE = 0x16,
101 ADMA_REGS_COMMAND = 0x17,
104 board_1841_idx = 0, /* ADMA 2-port controller */
107 typedef enum { adma_state_idle, adma_state_pkt, adma_state_mmio } adma_state_t;
109 struct adma_port_priv {
115 static int adma_ata_init_one(struct pci_dev *pdev,
116 const struct pci_device_id *ent);
117 static int adma_port_start(struct ata_port *ap);
118 static void adma_port_stop(struct ata_port *ap);
119 static void adma_qc_prep(struct ata_queued_cmd *qc);
120 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc);
121 static int adma_check_atapi_dma(struct ata_queued_cmd *qc);
122 static void adma_freeze(struct ata_port *ap);
123 static void adma_thaw(struct ata_port *ap);
124 static int adma_prereset(struct ata_link *link, unsigned long deadline);
126 static struct scsi_host_template adma_ata_sht = {
127 ATA_BASE_SHT(DRV_NAME),
128 .sg_tablesize = LIBATA_MAX_PRD,
129 .dma_boundary = ADMA_DMA_BOUNDARY,
132 static struct ata_port_operations adma_ata_ops = {
133 .inherits = &ata_sff_port_ops,
135 .lost_interrupt = ATA_OP_NULL,
137 .check_atapi_dma = adma_check_atapi_dma,
138 .qc_prep = adma_qc_prep,
139 .qc_issue = adma_qc_issue,
141 .freeze = adma_freeze,
143 .prereset = adma_prereset,
145 .port_start = adma_port_start,
146 .port_stop = adma_port_stop,
149 static struct ata_port_info adma_port_info[] = {
152 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_POLLING,
153 .pio_mask = ATA_PIO4_ONLY,
154 .udma_mask = ATA_UDMA4,
155 .port_ops = &adma_ata_ops,
159 static const struct pci_device_id adma_ata_pci_tbl[] = {
160 { PCI_VDEVICE(PDC, 0x1841), board_1841_idx },
162 { } /* terminate list */
165 static struct pci_driver adma_ata_pci_driver = {
167 .id_table = adma_ata_pci_tbl,
168 .probe = adma_ata_init_one,
169 .remove = ata_pci_remove_one,
172 static int adma_check_atapi_dma(struct ata_queued_cmd *qc)
174 return 1; /* ATAPI DMA not yet supported */
177 static void adma_reset_engine(struct ata_port *ap)
179 void __iomem *chan = ADMA_PORT_REGS(ap);
181 /* reset ADMA to idle state */
182 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
184 writew(aPIOMD4, chan + ADMA_CONTROL);
188 static void adma_reinit_engine(struct ata_port *ap)
190 struct adma_port_priv *pp = ap->private_data;
191 void __iomem *chan = ADMA_PORT_REGS(ap);
193 /* mask/clear ATA interrupts */
194 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
195 ata_sff_check_status(ap);
197 /* reset the ADMA engine */
198 adma_reset_engine(ap);
200 /* set in-FIFO threshold to 0x100 */
201 writew(0x100, chan + ADMA_FIFO_IN);
203 /* set CPB pointer */
204 writel((u32)pp->pkt_dma, chan + ADMA_CPB_NEXT);
206 /* set out-FIFO threshold to 0x100 */
207 writew(0x100, chan + ADMA_FIFO_OUT);
210 writew(1, chan + ADMA_CPB_COUNT);
212 /* read/discard ADMA status */
213 readb(chan + ADMA_STATUS);
216 static inline void adma_enter_reg_mode(struct ata_port *ap)
218 void __iomem *chan = ADMA_PORT_REGS(ap);
220 writew(aPIOMD4, chan + ADMA_CONTROL);
221 readb(chan + ADMA_STATUS); /* flush */
224 static void adma_freeze(struct ata_port *ap)
226 void __iomem *chan = ADMA_PORT_REGS(ap);
228 /* mask/clear ATA interrupts */
229 writeb(ATA_NIEN, ap->ioaddr.ctl_addr);
230 ata_sff_check_status(ap);
232 /* reset ADMA to idle state */
233 writew(aPIOMD4 | aNIEN | aRSTADM, chan + ADMA_CONTROL);
235 writew(aPIOMD4 | aNIEN, chan + ADMA_CONTROL);
239 static void adma_thaw(struct ata_port *ap)
241 adma_reinit_engine(ap);
244 static int adma_prereset(struct ata_link *link, unsigned long deadline)
246 struct ata_port *ap = link->ap;
247 struct adma_port_priv *pp = ap->private_data;
249 if (pp->state != adma_state_idle) /* healthy paranoia */
250 pp->state = adma_state_mmio;
251 adma_reinit_engine(ap);
253 return ata_sff_prereset(link, deadline);
256 static int adma_fill_sg(struct ata_queued_cmd *qc)
258 struct scatterlist *sg;
259 struct ata_port *ap = qc->ap;
260 struct adma_port_priv *pp = ap->private_data;
261 u8 *buf = pp->pkt, *last_buf = NULL;
262 int i = (2 + buf[3]) * 8;
263 u8 pFLAGS = pORD | ((qc->tf.flags & ATA_TFLAG_WRITE) ? pDIRO : 0);
266 for_each_sg(qc->sg, sg, qc->n_elem, si) {
270 addr = (u32)sg_dma_address(sg);
271 *(__le32 *)(buf + i) = cpu_to_le32(addr);
274 len = sg_dma_len(sg) >> 3;
275 *(__le32 *)(buf + i) = cpu_to_le32(len);
280 buf[i++] = qc->dev->dma_mode & 0xf;
281 buf[i++] = 0; /* pPKLW */
282 buf[i++] = 0; /* reserved */
284 *(__le32 *)(buf + i) =
285 (pFLAGS & pEND) ? 0 : cpu_to_le32(pp->pkt_dma + i + 4);
288 VPRINTK("PRD[%u] = (0x%lX, 0x%X)\n", i/4,
289 (unsigned long)addr, len);
292 if (likely(last_buf))
298 static void adma_qc_prep(struct ata_queued_cmd *qc)
300 struct adma_port_priv *pp = qc->ap->private_data;
302 u32 pkt_dma = (u32)pp->pkt_dma;
307 adma_enter_reg_mode(qc->ap);
308 if (qc->tf.protocol != ATA_PROT_DMA)
311 buf[i++] = 0; /* Response flags */
312 buf[i++] = 0; /* reserved */
313 buf[i++] = cVLD | cDAT | cIEN;
314 i++; /* cLEN, gets filled in below */
316 *(__le32 *)(buf+i) = cpu_to_le32(pkt_dma); /* cNCPB */
318 i += 4; /* cPRD, gets filled in below */
320 buf[i++] = 0; /* reserved */
321 buf[i++] = 0; /* reserved */
322 buf[i++] = 0; /* reserved */
323 buf[i++] = 0; /* reserved */
325 /* ATA registers; must be a multiple of 4 */
326 buf[i++] = qc->tf.device;
327 buf[i++] = ADMA_REGS_DEVICE;
328 if ((qc->tf.flags & ATA_TFLAG_LBA48)) {
329 buf[i++] = qc->tf.hob_nsect;
330 buf[i++] = ADMA_REGS_SECTOR_COUNT;
331 buf[i++] = qc->tf.hob_lbal;
332 buf[i++] = ADMA_REGS_LBA_LOW;
333 buf[i++] = qc->tf.hob_lbam;
334 buf[i++] = ADMA_REGS_LBA_MID;
335 buf[i++] = qc->tf.hob_lbah;
336 buf[i++] = ADMA_REGS_LBA_HIGH;
338 buf[i++] = qc->tf.nsect;
339 buf[i++] = ADMA_REGS_SECTOR_COUNT;
340 buf[i++] = qc->tf.lbal;
341 buf[i++] = ADMA_REGS_LBA_LOW;
342 buf[i++] = qc->tf.lbam;
343 buf[i++] = ADMA_REGS_LBA_MID;
344 buf[i++] = qc->tf.lbah;
345 buf[i++] = ADMA_REGS_LBA_HIGH;
347 buf[i++] = ADMA_REGS_CONTROL;
350 buf[i++] = qc->tf.command;
351 buf[i++] = ADMA_REGS_COMMAND | rEND;
353 buf[3] = (i >> 3) - 2; /* cLEN */
354 *(__le32 *)(buf+8) = cpu_to_le32(pkt_dma + i); /* cPRD */
356 i = adma_fill_sg(qc);
357 wmb(); /* flush PRDs and pkt to memory */
359 /* dump out CPB + PRDs for debug */
362 static char obuf[2048];
363 for (j = 0; j < i; ++j) {
364 len += sprintf(obuf+len, "%02x ", buf[j]);
366 printk("%s\n", obuf);
371 printk("%s\n", obuf);
376 static inline void adma_packet_start(struct ata_queued_cmd *qc)
378 struct ata_port *ap = qc->ap;
379 void __iomem *chan = ADMA_PORT_REGS(ap);
381 VPRINTK("ENTER, ap %p\n", ap);
383 /* fire up the ADMA engine */
384 writew(aPIOMD4 | aGO, chan + ADMA_CONTROL);
387 static unsigned int adma_qc_issue(struct ata_queued_cmd *qc)
389 struct adma_port_priv *pp = qc->ap->private_data;
391 switch (qc->tf.protocol) {
393 pp->state = adma_state_pkt;
394 adma_packet_start(qc);
405 pp->state = adma_state_mmio;
406 return ata_sff_qc_issue(qc);
409 static inline unsigned int adma_intr_pkt(struct ata_host *host)
411 unsigned int handled = 0, port_no;
413 for (port_no = 0; port_no < host->n_ports; ++port_no) {
414 struct ata_port *ap = host->ports[port_no];
415 struct adma_port_priv *pp;
416 struct ata_queued_cmd *qc;
417 void __iomem *chan = ADMA_PORT_REGS(ap);
418 u8 status = readb(chan + ADMA_STATUS);
423 adma_enter_reg_mode(ap);
424 pp = ap->private_data;
425 if (!pp || pp->state != adma_state_pkt)
427 qc = ata_qc_from_tag(ap, ap->link.active_tag);
428 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
430 qc->err_mask |= AC_ERR_HOST_BUS;
431 else if ((status & (aPSD | aUIRQ)))
432 qc->err_mask |= AC_ERR_OTHER;
434 if (pp->pkt[0] & cATERR)
435 qc->err_mask |= AC_ERR_DEV;
436 else if (pp->pkt[0] != cDONE)
437 qc->err_mask |= AC_ERR_OTHER;
442 struct ata_eh_info *ehi = &ap->link.eh_info;
443 ata_ehi_clear_desc(ehi);
444 ata_ehi_push_desc(ehi,
445 "ADMA-status 0x%02X", status);
446 ata_ehi_push_desc(ehi,
447 "pkt[0] 0x%02X", pp->pkt[0]);
449 if (qc->err_mask == AC_ERR_DEV)
459 static inline unsigned int adma_intr_mmio(struct ata_host *host)
461 unsigned int handled = 0, port_no;
463 for (port_no = 0; port_no < host->n_ports; ++port_no) {
464 struct ata_port *ap = host->ports[port_no];
465 struct adma_port_priv *pp = ap->private_data;
466 struct ata_queued_cmd *qc;
468 if (!pp || pp->state != adma_state_mmio)
470 qc = ata_qc_from_tag(ap, ap->link.active_tag);
471 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING))) {
473 /* check main status, clearing INTRQ */
474 u8 status = ata_sff_check_status(ap);
475 if ((status & ATA_BUSY))
477 DPRINTK("ata%u: protocol %d (dev_stat 0x%X)\n",
478 ap->print_id, qc->tf.protocol, status);
480 /* complete taskfile transaction */
481 pp->state = adma_state_idle;
482 qc->err_mask |= ac_err_mask(status);
486 struct ata_eh_info *ehi = &ap->link.eh_info;
487 ata_ehi_clear_desc(ehi);
488 ata_ehi_push_desc(ehi, "status 0x%02X", status);
490 if (qc->err_mask == AC_ERR_DEV)
501 static irqreturn_t adma_intr(int irq, void *dev_instance)
503 struct ata_host *host = dev_instance;
504 unsigned int handled = 0;
508 spin_lock(&host->lock);
509 handled = adma_intr_pkt(host) | adma_intr_mmio(host);
510 spin_unlock(&host->lock);
514 return IRQ_RETVAL(handled);
517 static void adma_ata_setup_port(struct ata_ioports *port, void __iomem *base)
520 port->data_addr = base + 0x000;
522 port->feature_addr = base + 0x004;
523 port->nsect_addr = base + 0x008;
524 port->lbal_addr = base + 0x00c;
525 port->lbam_addr = base + 0x010;
526 port->lbah_addr = base + 0x014;
527 port->device_addr = base + 0x018;
529 port->command_addr = base + 0x01c;
530 port->altstatus_addr =
531 port->ctl_addr = base + 0x038;
534 static int adma_port_start(struct ata_port *ap)
536 struct device *dev = ap->host->dev;
537 struct adma_port_priv *pp;
539 adma_enter_reg_mode(ap);
540 pp = devm_kzalloc(dev, sizeof(*pp), GFP_KERNEL);
543 pp->pkt = dmam_alloc_coherent(dev, ADMA_PKT_BYTES, &pp->pkt_dma,
548 if ((pp->pkt_dma & 7) != 0) {
549 printk(KERN_ERR "bad alignment for pp->pkt_dma: %08x\n",
553 ap->private_data = pp;
554 adma_reinit_engine(ap);
558 static void adma_port_stop(struct ata_port *ap)
560 adma_reset_engine(ap);
563 static void adma_host_init(struct ata_host *host, unsigned int chip_id)
565 unsigned int port_no;
567 /* enable/lock aGO operation */
568 writeb(7, host->iomap[ADMA_MMIO_BAR] + ADMA_MODE_LOCK);
570 /* reset the ADMA logic */
571 for (port_no = 0; port_no < ADMA_PORTS; ++port_no)
572 adma_reset_engine(host->ports[port_no]);
575 static int adma_ata_init_one(struct pci_dev *pdev,
576 const struct pci_device_id *ent)
578 unsigned int board_idx = (unsigned int) ent->driver_data;
579 const struct ata_port_info *ppi[] = { &adma_port_info[board_idx], NULL };
580 struct ata_host *host;
581 void __iomem *mmio_base;
584 ata_print_version_once(&pdev->dev, DRV_VERSION);
587 host = ata_host_alloc_pinfo(&pdev->dev, ppi, ADMA_PORTS);
591 /* acquire resources and fill host */
592 rc = pcim_enable_device(pdev);
596 if ((pci_resource_flags(pdev, 4) & IORESOURCE_MEM) == 0)
599 rc = pcim_iomap_regions(pdev, 1 << ADMA_MMIO_BAR, DRV_NAME);
602 host->iomap = pcim_iomap_table(pdev);
603 mmio_base = host->iomap[ADMA_MMIO_BAR];
605 rc = dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
607 dev_err(&pdev->dev, "32-bit DMA enable failed\n");
611 for (port_no = 0; port_no < ADMA_PORTS; ++port_no) {
612 struct ata_port *ap = host->ports[port_no];
613 void __iomem *port_base = ADMA_ATA_REGS(mmio_base, port_no);
614 unsigned int offset = port_base - mmio_base;
616 adma_ata_setup_port(&ap->ioaddr, port_base);
618 ata_port_pbar_desc(ap, ADMA_MMIO_BAR, -1, "mmio");
619 ata_port_pbar_desc(ap, ADMA_MMIO_BAR, offset, "port");
622 /* initialize adapter */
623 adma_host_init(host, board_idx);
625 pci_set_master(pdev);
626 return ata_host_activate(host, pdev->irq, adma_intr, IRQF_SHARED,
630 module_pci_driver(adma_ata_pci_driver);
632 MODULE_AUTHOR("Mark Lord");
633 MODULE_DESCRIPTION("Pacific Digital Corporation ADMA low-level driver");
634 MODULE_LICENSE("GPL");
635 MODULE_DEVICE_TABLE(pci, adma_ata_pci_tbl);
636 MODULE_VERSION(DRV_VERSION);