2 * sata_inic162x.c - Driver for Initio 162x SATA controllers
4 * Copyright 2006 SUSE Linux Products GmbH
5 * Copyright 2006 Tejun Heo <teheo@novell.com>
7 * This file is released under GPL v2.
9 * This controller is eccentric and easily locks up if something isn't
10 * right. Documentation is available at initio's website but it only
11 * documents registers (not programming model).
15 * - ATAPI read works but burning doesn't. This thing is really
16 * peculiar about ATAPI and I couldn't figure out how ATAPI PIO and
17 * ATAPI DMA WRITE should be programmed. If you've got a clue, be
19 * - Both STR and STD work.
22 #include <linux/kernel.h>
23 #include <linux/module.h>
24 #include <linux/pci.h>
25 #include <scsi/scsi_host.h>
26 #include <linux/libata.h>
27 #include <linux/blkdev.h>
28 #include <scsi/scsi_device.h>
30 #define DRV_NAME "sata_inic162x"
31 #define DRV_VERSION "0.3"
45 /* registers for ATA TF operation */
52 PORT_PRD_XFERLEN = 0x10,
60 HCTL_IRQOFF = (1 << 8), /* global IRQ off */
61 HCTL_PWRDWN = (1 << 13), /* power down PHYs */
62 HCTL_SOFTRST = (1 << 13), /* global reset (no phy reset) */
63 HCTL_RPGSEL = (1 << 15), /* register page select */
65 HCTL_KNOWN_BITS = HCTL_IRQOFF | HCTL_PWRDWN | HCTL_SOFTRST |
68 /* HOST_IRQ_(STAT|MASK) bits */
69 HIRQ_PORT0 = (1 << 0),
70 HIRQ_PORT1 = (1 << 1),
71 HIRQ_SOFT = (1 << 14),
72 HIRQ_GLOBAL = (1 << 15), /* STAT only */
74 /* PORT_IRQ_(STAT|MASK) bits */
75 PIRQ_OFFLINE = (1 << 0), /* device unplugged */
76 PIRQ_ONLINE = (1 << 1), /* device plugged */
77 PIRQ_COMPLETE = (1 << 2), /* completion interrupt */
78 PIRQ_FATAL = (1 << 3), /* fatal error */
79 PIRQ_ATA = (1 << 4), /* ATA interrupt */
80 PIRQ_REPLY = (1 << 5), /* reply FIFO not empty */
81 PIRQ_PENDING = (1 << 7), /* port IRQ pending (STAT only) */
83 PIRQ_ERR = PIRQ_OFFLINE | PIRQ_ONLINE | PIRQ_FATAL,
85 PIRQ_MASK_DMA_READ = PIRQ_REPLY | PIRQ_ATA,
86 PIRQ_MASK_OTHER = PIRQ_REPLY | PIRQ_COMPLETE,
87 PIRQ_MASK_FREEZE = 0xff,
89 /* PORT_PRD_CTL bits */
90 PRD_CTL_START = (1 << 0),
91 PRD_CTL_WR = (1 << 3),
92 PRD_CTL_DMAEN = (1 << 7), /* DMA enable */
94 /* PORT_IDMA_CTL bits */
95 IDMA_CTL_RST_ATA = (1 << 2), /* hardreset ATA bus */
96 IDMA_CTL_RST_IDMA = (1 << 5), /* reset IDMA machinary */
97 IDMA_CTL_GO = (1 << 7), /* IDMA mode go */
98 IDMA_CTL_ATA_NIEN = (1 << 8), /* ATA IRQ disable */
101 struct inic_host_priv {
105 struct inic_port_priv {
111 static int inic_slave_config(struct scsi_device *sdev)
113 /* This controller is braindamaged. dma_boundary is 0xffff
114 * like others but it will lock up the whole machine HARD if
115 * 65536 byte PRD entry is fed. Reduce maximum segment size.
117 blk_queue_max_segment_size(sdev->request_queue, 65536 - 512);
119 return ata_scsi_slave_config(sdev);
122 static struct scsi_host_template inic_sht = {
123 .module = THIS_MODULE,
125 .ioctl = ata_scsi_ioctl,
126 .queuecommand = ata_scsi_queuecmd,
127 .can_queue = ATA_DEF_QUEUE,
128 .this_id = ATA_SHT_THIS_ID,
129 .sg_tablesize = LIBATA_MAX_PRD,
130 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
131 .emulated = ATA_SHT_EMULATED,
132 .use_clustering = ATA_SHT_USE_CLUSTERING,
133 .proc_name = DRV_NAME,
134 .dma_boundary = ATA_DMA_BOUNDARY,
135 .slave_configure = inic_slave_config,
136 .slave_destroy = ata_scsi_slave_destroy,
137 .bios_param = ata_std_bios_param,
140 static const int scr_map[] = {
146 static void __iomem * inic_port_base(struct ata_port *ap)
148 return ap->host->iomap[MMIO_BAR] + ap->port_no * PORT_SIZE;
151 static void __inic_set_pirq_mask(struct ata_port *ap, u8 mask)
153 void __iomem *port_base = inic_port_base(ap);
154 struct inic_port_priv *pp = ap->private_data;
156 writeb(mask, port_base + PORT_IRQ_MASK);
157 pp->cached_pirq_mask = mask;
160 static void inic_set_pirq_mask(struct ata_port *ap, u8 mask)
162 struct inic_port_priv *pp = ap->private_data;
164 if (pp->cached_pirq_mask != mask)
165 __inic_set_pirq_mask(ap, mask);
168 static void inic_reset_port(void __iomem *port_base)
170 void __iomem *idma_ctl = port_base + PORT_IDMA_CTL;
173 ctl = readw(idma_ctl);
174 ctl &= ~(IDMA_CTL_RST_IDMA | IDMA_CTL_ATA_NIEN | IDMA_CTL_GO);
176 /* mask IRQ and assert reset */
177 writew(ctl | IDMA_CTL_RST_IDMA | IDMA_CTL_ATA_NIEN, idma_ctl);
178 readw(idma_ctl); /* flush */
180 /* give it some time */
184 writew(ctl | IDMA_CTL_ATA_NIEN, idma_ctl);
187 writeb(0xff, port_base + PORT_IRQ_STAT);
189 /* reenable ATA IRQ, turn off IDMA mode */
190 writew(ctl, idma_ctl);
193 static int inic_scr_read(struct ata_port *ap, unsigned sc_reg, u32 *val)
195 void __iomem *scr_addr = ap->ioaddr.scr_addr;
198 if (unlikely(sc_reg >= ARRAY_SIZE(scr_map)))
201 addr = scr_addr + scr_map[sc_reg] * 4;
202 *val = readl(scr_addr + scr_map[sc_reg] * 4);
204 /* this controller has stuck DIAG.N, ignore it */
205 if (sc_reg == SCR_ERROR)
206 *val &= ~SERR_PHYRDY_CHG;
210 static int inic_scr_write(struct ata_port *ap, unsigned sc_reg, u32 val)
212 void __iomem *scr_addr = ap->ioaddr.scr_addr;
215 if (unlikely(sc_reg >= ARRAY_SIZE(scr_map)))
218 addr = scr_addr + scr_map[sc_reg] * 4;
219 writel(val, scr_addr + scr_map[sc_reg] * 4);
224 * In TF mode, inic162x is very similar to SFF device. TF registers
225 * function the same. DMA engine behaves similary using the same PRD
226 * format as BMDMA but different command register, interrupt and event
227 * notification methods are used. The following inic_bmdma_*()
228 * functions do the impedance matching.
230 static void inic_bmdma_setup(struct ata_queued_cmd *qc)
232 struct ata_port *ap = qc->ap;
233 struct inic_port_priv *pp = ap->private_data;
234 void __iomem *port_base = inic_port_base(ap);
235 int rw = qc->tf.flags & ATA_TFLAG_WRITE;
237 /* make sure device sees PRD table writes */
240 /* load transfer length */
241 writel(qc->nbytes, port_base + PORT_PRD_XFERLEN);
243 /* turn on DMA and specify data direction */
244 pp->cached_prdctl = pp->dfl_prdctl | PRD_CTL_DMAEN;
246 pp->cached_prdctl |= PRD_CTL_WR;
247 writeb(pp->cached_prdctl, port_base + PORT_PRD_CTL);
249 /* issue r/w command */
250 ap->ops->exec_command(ap, &qc->tf);
253 static void inic_bmdma_start(struct ata_queued_cmd *qc)
255 struct ata_port *ap = qc->ap;
256 struct inic_port_priv *pp = ap->private_data;
257 void __iomem *port_base = inic_port_base(ap);
259 /* start host DMA transaction */
260 pp->cached_prdctl |= PRD_CTL_START;
261 writeb(pp->cached_prdctl, port_base + PORT_PRD_CTL);
264 static void inic_bmdma_stop(struct ata_queued_cmd *qc)
266 struct ata_port *ap = qc->ap;
267 struct inic_port_priv *pp = ap->private_data;
268 void __iomem *port_base = inic_port_base(ap);
270 /* stop DMA engine */
271 writeb(pp->dfl_prdctl, port_base + PORT_PRD_CTL);
274 static u8 inic_bmdma_status(struct ata_port *ap)
276 /* event is already verified by the interrupt handler */
280 static void inic_irq_clear(struct ata_port *ap)
285 static void inic_host_intr(struct ata_port *ap)
287 void __iomem *port_base = inic_port_base(ap);
288 struct ata_eh_info *ehi = &ap->eh_info;
291 /* fetch and clear irq */
292 irq_stat = readb(port_base + PORT_IRQ_STAT);
293 writeb(irq_stat, port_base + PORT_IRQ_STAT);
295 if (likely(!(irq_stat & PIRQ_ERR))) {
296 struct ata_queued_cmd *qc = ata_qc_from_tag(ap, ap->active_tag);
298 if (unlikely(!qc || (qc->tf.flags & ATA_TFLAG_POLLING))) {
299 ata_chk_status(ap); /* clear ATA interrupt */
303 if (likely(ata_host_intr(ap, qc)))
306 ata_chk_status(ap); /* clear ATA interrupt */
307 ata_port_printk(ap, KERN_WARNING, "unhandled "
308 "interrupt, irq_stat=%x\n", irq_stat);
313 ata_ehi_push_desc(ehi, "irq_stat=0x%x", irq_stat);
315 if (irq_stat & (PIRQ_OFFLINE | PIRQ_ONLINE)) {
316 ata_ehi_hotplugged(ehi);
322 static irqreturn_t inic_interrupt(int irq, void *dev_instance)
324 struct ata_host *host = dev_instance;
325 void __iomem *mmio_base = host->iomap[MMIO_BAR];
329 host_irq_stat = readw(mmio_base + HOST_IRQ_STAT);
331 if (unlikely(!(host_irq_stat & HIRQ_GLOBAL)))
334 spin_lock(&host->lock);
336 for (i = 0; i < NR_PORTS; i++) {
337 struct ata_port *ap = host->ports[i];
339 if (!(host_irq_stat & (HIRQ_PORT0 << i)))
342 if (likely(ap && !(ap->flags & ATA_FLAG_DISABLED))) {
347 dev_printk(KERN_ERR, host->dev, "interrupt "
348 "from disabled port %d (0x%x)\n",
353 spin_unlock(&host->lock);
356 return IRQ_RETVAL(handled);
359 static unsigned int inic_qc_issue(struct ata_queued_cmd *qc)
361 struct ata_port *ap = qc->ap;
363 /* ATA IRQ doesn't wait for DMA transfer completion and vice
364 * versa. Mask IRQ selectively to detect command completion.
365 * Without it, ATA DMA read command can cause data corruption.
367 * Something similar might be needed for ATAPI writes. I
368 * tried a lot of combinations but couldn't find the solution.
370 if (qc->tf.protocol == ATA_PROT_DMA &&
371 !(qc->tf.flags & ATA_TFLAG_WRITE))
372 inic_set_pirq_mask(ap, PIRQ_MASK_DMA_READ);
374 inic_set_pirq_mask(ap, PIRQ_MASK_OTHER);
376 /* Issuing a command to yet uninitialized port locks up the
377 * controller. Most of the time, this happens for the first
378 * command after reset which are ATA and ATAPI IDENTIFYs.
379 * Fast fail if stat is 0x7f or 0xff for those commands.
381 if (unlikely(qc->tf.command == ATA_CMD_ID_ATA ||
382 qc->tf.command == ATA_CMD_ID_ATAPI)) {
383 u8 stat = ata_chk_status(ap);
384 if (stat == 0x7f || stat == 0xff)
388 return ata_qc_issue_prot(qc);
391 static void inic_freeze(struct ata_port *ap)
393 void __iomem *port_base = inic_port_base(ap);
395 __inic_set_pirq_mask(ap, PIRQ_MASK_FREEZE);
398 writeb(0xff, port_base + PORT_IRQ_STAT);
400 readb(port_base + PORT_IRQ_STAT); /* flush */
403 static void inic_thaw(struct ata_port *ap)
405 void __iomem *port_base = inic_port_base(ap);
408 writeb(0xff, port_base + PORT_IRQ_STAT);
410 __inic_set_pirq_mask(ap, PIRQ_MASK_OTHER);
412 readb(port_base + PORT_IRQ_STAT); /* flush */
416 * SRST and SControl hardreset don't give valid signature on this
417 * controller. Only controller specific hardreset mechanism works.
419 static int inic_hardreset(struct ata_port *ap, unsigned int *class,
420 unsigned long deadline)
422 void __iomem *port_base = inic_port_base(ap);
423 void __iomem *idma_ctl = port_base + PORT_IDMA_CTL;
424 const unsigned long *timing = sata_ehc_deb_timing(&ap->eh_context);
428 /* hammer it into sane state */
429 inic_reset_port(port_base);
431 val = readw(idma_ctl);
432 writew(val | IDMA_CTL_RST_ATA, idma_ctl);
433 readw(idma_ctl); /* flush */
435 writew(val & ~IDMA_CTL_RST_ATA, idma_ctl);
437 rc = sata_phy_resume(ap, timing, deadline);
439 ata_port_printk(ap, KERN_WARNING, "failed to resume "
440 "link after reset (errno=%d)\n", rc);
444 *class = ATA_DEV_NONE;
445 if (ata_port_online(ap)) {
446 struct ata_taskfile tf;
448 /* wait a while before checking status */
451 rc = ata_wait_ready(ap, deadline);
452 /* link occupied, -ENODEV too is an error */
454 ata_port_printk(ap, KERN_WARNING, "device not ready "
455 "after hardreset (errno=%d)\n", rc);
459 ata_tf_read(ap, &tf);
460 *class = ata_dev_classify(&tf);
461 if (*class == ATA_DEV_UNKNOWN)
462 *class = ATA_DEV_NONE;
468 static void inic_error_handler(struct ata_port *ap)
470 void __iomem *port_base = inic_port_base(ap);
471 struct inic_port_priv *pp = ap->private_data;
474 /* reset PIO HSM and stop DMA engine */
475 inic_reset_port(port_base);
477 spin_lock_irqsave(ap->lock, flags);
478 ap->hsm_task_state = HSM_ST_IDLE;
479 writeb(pp->dfl_prdctl, port_base + PORT_PRD_CTL);
480 spin_unlock_irqrestore(ap->lock, flags);
482 /* PIO and DMA engines have been stopped, perform recovery */
483 ata_do_eh(ap, ata_std_prereset, NULL, inic_hardreset,
487 static void inic_post_internal_cmd(struct ata_queued_cmd *qc)
489 /* make DMA engine forget about the failed command */
490 if (qc->flags & ATA_QCFLAG_FAILED)
491 inic_reset_port(inic_port_base(qc->ap));
494 static void inic_dev_config(struct ata_device *dev)
496 /* inic can only handle upto LBA28 max sectors */
497 if (dev->max_sectors > ATA_MAX_SECTORS)
498 dev->max_sectors = ATA_MAX_SECTORS;
500 if (dev->n_sectors >= 1 << 28) {
501 ata_dev_printk(dev, KERN_ERR,
502 "ERROR: This driver doesn't support LBA48 yet and may cause\n"
503 " data corruption on such devices. Disabling.\n");
504 ata_dev_disable(dev);
508 static void init_port(struct ata_port *ap)
510 void __iomem *port_base = inic_port_base(ap);
512 /* Setup PRD address */
513 writel(ap->prd_dma, port_base + PORT_PRD_ADDR);
516 static int inic_port_resume(struct ata_port *ap)
522 static int inic_port_start(struct ata_port *ap)
524 void __iomem *port_base = inic_port_base(ap);
525 struct inic_port_priv *pp;
529 /* alloc and initialize private data */
530 pp = devm_kzalloc(ap->host->dev, sizeof(*pp), GFP_KERNEL);
533 ap->private_data = pp;
535 /* default PRD_CTL value, DMAEN, WR and START off */
536 tmp = readb(port_base + PORT_PRD_CTL);
537 tmp &= ~(PRD_CTL_DMAEN | PRD_CTL_WR | PRD_CTL_START);
538 pp->dfl_prdctl = tmp;
540 /* Alloc resources */
541 rc = ata_port_start(ap);
552 static struct ata_port_operations inic_port_ops = {
553 .port_disable = ata_port_disable,
554 .tf_load = ata_tf_load,
555 .tf_read = ata_tf_read,
556 .check_status = ata_check_status,
557 .exec_command = ata_exec_command,
558 .dev_select = ata_std_dev_select,
560 .scr_read = inic_scr_read,
561 .scr_write = inic_scr_write,
563 .bmdma_setup = inic_bmdma_setup,
564 .bmdma_start = inic_bmdma_start,
565 .bmdma_stop = inic_bmdma_stop,
566 .bmdma_status = inic_bmdma_status,
568 .irq_clear = inic_irq_clear,
569 .irq_on = ata_irq_on,
570 .irq_ack = ata_irq_ack,
572 .qc_prep = ata_qc_prep,
573 .qc_issue = inic_qc_issue,
574 .data_xfer = ata_data_xfer,
576 .freeze = inic_freeze,
578 .error_handler = inic_error_handler,
579 .post_internal_cmd = inic_post_internal_cmd,
580 .dev_config = inic_dev_config,
582 .port_resume = inic_port_resume,
584 .port_start = inic_port_start,
587 static struct ata_port_info inic_port_info = {
588 /* For some reason, ATA_PROT_ATAPI is broken on this
589 * controller, and no, PIO_POLLING does't fix it. It somehow
590 * manages to report the wrong ireason and ignoring ireason
591 * results in machine lock up. Tell libata to always prefer
594 .flags = ATA_FLAG_SATA | ATA_FLAG_PIO_DMA,
595 .pio_mask = 0x1f, /* pio0-4 */
596 .mwdma_mask = 0x07, /* mwdma0-2 */
597 .udma_mask = ATA_UDMA6,
598 .port_ops = &inic_port_ops
601 static int init_controller(void __iomem *mmio_base, u16 hctl)
606 hctl &= ~HCTL_KNOWN_BITS;
608 /* Soft reset whole controller. Spec says reset duration is 3
609 * PCI clocks, be generous and give it 10ms.
611 writew(hctl | HCTL_SOFTRST, mmio_base + HOST_CTL);
612 readw(mmio_base + HOST_CTL); /* flush */
614 for (i = 0; i < 10; i++) {
616 val = readw(mmio_base + HOST_CTL);
617 if (!(val & HCTL_SOFTRST))
621 if (val & HCTL_SOFTRST)
624 /* mask all interrupts and reset ports */
625 for (i = 0; i < NR_PORTS; i++) {
626 void __iomem *port_base = mmio_base + i * PORT_SIZE;
628 writeb(0xff, port_base + PORT_IRQ_MASK);
629 inic_reset_port(port_base);
632 /* port IRQ is masked now, unmask global IRQ */
633 writew(hctl & ~HCTL_IRQOFF, mmio_base + HOST_CTL);
634 val = readw(mmio_base + HOST_IRQ_MASK);
635 val &= ~(HIRQ_PORT0 | HIRQ_PORT1);
636 writew(val, mmio_base + HOST_IRQ_MASK);
642 static int inic_pci_device_resume(struct pci_dev *pdev)
644 struct ata_host *host = dev_get_drvdata(&pdev->dev);
645 struct inic_host_priv *hpriv = host->private_data;
646 void __iomem *mmio_base = host->iomap[MMIO_BAR];
649 rc = ata_pci_device_do_resume(pdev);
653 if (pdev->dev.power.power_state.event == PM_EVENT_SUSPEND) {
654 rc = init_controller(mmio_base, hpriv->cached_hctl);
659 ata_host_resume(host);
665 static int inic_init_one(struct pci_dev *pdev, const struct pci_device_id *ent)
667 static int printed_version;
668 const struct ata_port_info *ppi[] = { &inic_port_info, NULL };
669 struct ata_host *host;
670 struct inic_host_priv *hpriv;
671 void __iomem * const *iomap;
674 if (!printed_version++)
675 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
678 host = ata_host_alloc_pinfo(&pdev->dev, ppi, NR_PORTS);
679 hpriv = devm_kzalloc(&pdev->dev, sizeof(*hpriv), GFP_KERNEL);
683 host->private_data = hpriv;
685 /* acquire resources and fill host */
686 rc = pcim_enable_device(pdev);
690 rc = pcim_iomap_regions(pdev, 0x3f, DRV_NAME);
693 host->iomap = iomap = pcim_iomap_table(pdev);
695 for (i = 0; i < NR_PORTS; i++) {
696 struct ata_ioports *port = &host->ports[i]->ioaddr;
697 void __iomem *port_base = iomap[MMIO_BAR] + i * PORT_SIZE;
699 port->cmd_addr = iomap[2 * i];
700 port->altstatus_addr =
701 port->ctl_addr = (void __iomem *)
702 ((unsigned long)iomap[2 * i + 1] | ATA_PCI_CTL_OFS);
703 port->scr_addr = port_base + PORT_SCR;
708 hpriv->cached_hctl = readw(iomap[MMIO_BAR] + HOST_CTL);
710 /* Set dma_mask. This devices doesn't support 64bit addressing. */
711 rc = pci_set_dma_mask(pdev, DMA_32BIT_MASK);
713 dev_printk(KERN_ERR, &pdev->dev,
714 "32-bit DMA enable failed\n");
718 rc = pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK);
720 dev_printk(KERN_ERR, &pdev->dev,
721 "32-bit consistent DMA enable failed\n");
725 rc = init_controller(iomap[MMIO_BAR], hpriv->cached_hctl);
727 dev_printk(KERN_ERR, &pdev->dev,
728 "failed to initialize controller\n");
732 pci_set_master(pdev);
733 return ata_host_activate(host, pdev->irq, inic_interrupt, IRQF_SHARED,
737 static const struct pci_device_id inic_pci_tbl[] = {
738 { PCI_VDEVICE(INIT, 0x1622), },
742 static struct pci_driver inic_pci_driver = {
744 .id_table = inic_pci_tbl,
746 .suspend = ata_pci_device_suspend,
747 .resume = inic_pci_device_resume,
749 .probe = inic_init_one,
750 .remove = ata_pci_remove_one,
753 static int __init inic_init(void)
755 return pci_register_driver(&inic_pci_driver);
758 static void __exit inic_exit(void)
760 pci_unregister_driver(&inic_pci_driver);
763 MODULE_AUTHOR("Tejun Heo");
764 MODULE_DESCRIPTION("low-level driver for Initio 162x SATA");
765 MODULE_LICENSE("GPL v2");
766 MODULE_DEVICE_TABLE(pci, inic_pci_tbl);
767 MODULE_VERSION(DRV_VERSION);
769 module_init(inic_init);
770 module_exit(inic_exit);