2 * libata-sff.c - helper library for PCI IDE BMDMA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2006 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2006 Jeff Garzik
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2, or (at your option)
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; see the file COPYING. If not, write to
24 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 * libata documentation is available via 'make {ps|pdf}docs',
28 * as Documentation/DocBook/libata.*
30 * Hardware documentation available from http://www.t13.org/ and
31 * http://www.sata-io.org/
35 #include <linux/kernel.h>
36 #include <linux/pci.h>
37 #include <linux/libata.h>
42 * ata_irq_on - Enable interrupts on a port.
43 * @ap: Port on which interrupts are enabled.
45 * Enable interrupts on a legacy IDE device using MMIO or PIO,
46 * wait for idle, clear any pending interrupts.
49 * Inherited from caller.
51 u8 ata_irq_on(struct ata_port *ap)
53 struct ata_ioports *ioaddr = &ap->ioaddr;
57 ap->last_ctl = ap->ctl;
59 iowrite8(ap->ctl, ioaddr->ctl_addr);
60 tmp = ata_wait_idle(ap);
62 ap->ops->irq_clear(ap);
68 * ata_tf_load - send taskfile registers to host controller
69 * @ap: Port to which output is sent
70 * @tf: ATA taskfile register set
72 * Outputs ATA taskfile to standard ATA host controller.
75 * Inherited from caller.
78 void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
80 struct ata_ioports *ioaddr = &ap->ioaddr;
81 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
83 if (tf->ctl != ap->last_ctl) {
84 iowrite8(tf->ctl, ioaddr->ctl_addr);
85 ap->last_ctl = tf->ctl;
89 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
90 iowrite8(tf->hob_feature, ioaddr->feature_addr);
91 iowrite8(tf->hob_nsect, ioaddr->nsect_addr);
92 iowrite8(tf->hob_lbal, ioaddr->lbal_addr);
93 iowrite8(tf->hob_lbam, ioaddr->lbam_addr);
94 iowrite8(tf->hob_lbah, ioaddr->lbah_addr);
95 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
104 iowrite8(tf->feature, ioaddr->feature_addr);
105 iowrite8(tf->nsect, ioaddr->nsect_addr);
106 iowrite8(tf->lbal, ioaddr->lbal_addr);
107 iowrite8(tf->lbam, ioaddr->lbam_addr);
108 iowrite8(tf->lbah, ioaddr->lbah_addr);
109 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
117 if (tf->flags & ATA_TFLAG_DEVICE) {
118 iowrite8(tf->device, ioaddr->device_addr);
119 VPRINTK("device 0x%X\n", tf->device);
126 * ata_exec_command - issue ATA command to host controller
127 * @ap: port to which command is being issued
128 * @tf: ATA taskfile register set
130 * Issues ATA command, with proper synchronization with interrupt
131 * handler / other threads.
134 * spin_lock_irqsave(host lock)
136 void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf)
138 DPRINTK("ata%u: cmd 0x%X\n", ap->print_id, tf->command);
140 iowrite8(tf->command, ap->ioaddr.command_addr);
145 * ata_tf_read - input device's ATA taskfile shadow registers
146 * @ap: Port from which input is read
147 * @tf: ATA taskfile register set for storing input
149 * Reads ATA taskfile registers for currently-selected device
153 * Inherited from caller.
155 void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
157 struct ata_ioports *ioaddr = &ap->ioaddr;
159 tf->command = ata_check_status(ap);
160 tf->feature = ioread8(ioaddr->error_addr);
161 tf->nsect = ioread8(ioaddr->nsect_addr);
162 tf->lbal = ioread8(ioaddr->lbal_addr);
163 tf->lbam = ioread8(ioaddr->lbam_addr);
164 tf->lbah = ioread8(ioaddr->lbah_addr);
165 tf->device = ioread8(ioaddr->device_addr);
167 if (tf->flags & ATA_TFLAG_LBA48) {
168 iowrite8(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
169 tf->hob_feature = ioread8(ioaddr->error_addr);
170 tf->hob_nsect = ioread8(ioaddr->nsect_addr);
171 tf->hob_lbal = ioread8(ioaddr->lbal_addr);
172 tf->hob_lbam = ioread8(ioaddr->lbam_addr);
173 tf->hob_lbah = ioread8(ioaddr->lbah_addr);
174 iowrite8(tf->ctl, ioaddr->ctl_addr);
175 ap->last_ctl = tf->ctl;
180 * ata_check_status - Read device status reg & clear interrupt
181 * @ap: port where the device is
183 * Reads ATA taskfile status register for currently-selected device
184 * and return its value. This also clears pending interrupts
188 * Inherited from caller.
190 u8 ata_check_status(struct ata_port *ap)
192 return ioread8(ap->ioaddr.status_addr);
196 * ata_altstatus - Read device alternate status reg
197 * @ap: port where the device is
199 * Reads ATA taskfile alternate status register for
200 * currently-selected device and return its value.
202 * Note: may NOT be used as the check_altstatus() entry in
203 * ata_port_operations.
206 * Inherited from caller.
208 u8 ata_altstatus(struct ata_port *ap)
210 if (ap->ops->check_altstatus)
211 return ap->ops->check_altstatus(ap);
213 return ioread8(ap->ioaddr.altstatus_addr);
217 * ata_bmdma_setup - Set up PCI IDE BMDMA transaction
218 * @qc: Info associated with this ATA transaction.
221 * spin_lock_irqsave(host lock)
223 void ata_bmdma_setup(struct ata_queued_cmd *qc)
225 struct ata_port *ap = qc->ap;
226 unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
229 /* load PRD table addr. */
230 mb(); /* make sure PRD table writes are visible to controller */
231 iowrite32(ap->prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
233 /* specify data direction, triple-check start bit is clear */
234 dmactl = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
235 dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
237 dmactl |= ATA_DMA_WR;
238 iowrite8(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
240 /* issue r/w command */
241 ap->ops->exec_command(ap, &qc->tf);
245 * ata_bmdma_start - Start a PCI IDE BMDMA transaction
246 * @qc: Info associated with this ATA transaction.
249 * spin_lock_irqsave(host lock)
251 void ata_bmdma_start (struct ata_queued_cmd *qc)
253 struct ata_port *ap = qc->ap;
256 /* start host DMA transaction */
257 dmactl = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
258 iowrite8(dmactl | ATA_DMA_START, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
260 /* Strictly, one may wish to issue an ioread8() here, to
261 * flush the mmio write. However, control also passes
262 * to the hardware at this point, and it will interrupt
263 * us when we are to resume control. So, in effect,
264 * we don't care when the mmio write flushes.
265 * Further, a read of the DMA status register _immediately_
266 * following the write may not be what certain flaky hardware
267 * is expected, so I think it is best to not add a readb()
268 * without first all the MMIO ATA cards/mobos.
269 * Or maybe I'm just being paranoid.
271 * FIXME: The posting of this write means I/O starts are
272 * unneccessarily delayed for MMIO
277 * ata_bmdma_irq_clear - Clear PCI IDE BMDMA interrupt.
278 * @ap: Port associated with this ATA transaction.
280 * Clear interrupt and error flags in DMA status register.
282 * May be used as the irq_clear() entry in ata_port_operations.
285 * spin_lock_irqsave(host lock)
287 void ata_bmdma_irq_clear(struct ata_port *ap)
289 void __iomem *mmio = ap->ioaddr.bmdma_addr;
294 iowrite8(ioread8(mmio + ATA_DMA_STATUS), mmio + ATA_DMA_STATUS);
298 * ata_bmdma_status - Read PCI IDE BMDMA status
299 * @ap: Port associated with this ATA transaction.
301 * Read and return BMDMA status register.
303 * May be used as the bmdma_status() entry in ata_port_operations.
306 * spin_lock_irqsave(host lock)
308 u8 ata_bmdma_status(struct ata_port *ap)
310 return ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
314 * ata_bmdma_stop - Stop PCI IDE BMDMA transfer
315 * @qc: Command we are ending DMA for
317 * Clears the ATA_DMA_START flag in the dma control register
319 * May be used as the bmdma_stop() entry in ata_port_operations.
322 * spin_lock_irqsave(host lock)
324 void ata_bmdma_stop(struct ata_queued_cmd *qc)
326 struct ata_port *ap = qc->ap;
327 void __iomem *mmio = ap->ioaddr.bmdma_addr;
329 /* clear start/stop bit */
330 iowrite8(ioread8(mmio + ATA_DMA_CMD) & ~ATA_DMA_START,
333 /* one-PIO-cycle guaranteed wait, per spec, for HDMA1:0 transition */
334 ata_altstatus(ap); /* dummy read */
338 * ata_bmdma_freeze - Freeze BMDMA controller port
339 * @ap: port to freeze
341 * Freeze BMDMA controller port.
344 * Inherited from caller.
346 void ata_bmdma_freeze(struct ata_port *ap)
348 struct ata_ioports *ioaddr = &ap->ioaddr;
351 ap->last_ctl = ap->ctl;
353 iowrite8(ap->ctl, ioaddr->ctl_addr);
355 /* Under certain circumstances, some controllers raise IRQ on
356 * ATA_NIEN manipulation. Also, many controllers fail to mask
357 * previously pending IRQ on ATA_NIEN assertion. Clear it.
361 ap->ops->irq_clear(ap);
365 * ata_bmdma_thaw - Thaw BMDMA controller port
368 * Thaw BMDMA controller port.
371 * Inherited from caller.
373 void ata_bmdma_thaw(struct ata_port *ap)
375 /* clear & re-enable interrupts */
377 ap->ops->irq_clear(ap);
382 * ata_bmdma_drive_eh - Perform EH with given methods for BMDMA controller
383 * @ap: port to handle error for
384 * @prereset: prereset method (can be NULL)
385 * @softreset: softreset method (can be NULL)
386 * @hardreset: hardreset method (can be NULL)
387 * @postreset: postreset method (can be NULL)
389 * Handle error for ATA BMDMA controller. It can handle both
390 * PATA and SATA controllers. Many controllers should be able to
391 * use this EH as-is or with some added handling before and
394 * This function is intended to be used for constructing
395 * ->error_handler callback by low level drivers.
398 * Kernel thread context (may sleep)
400 void ata_bmdma_drive_eh(struct ata_port *ap, ata_prereset_fn_t prereset,
401 ata_reset_fn_t softreset, ata_reset_fn_t hardreset,
402 ata_postreset_fn_t postreset)
404 struct ata_queued_cmd *qc;
408 qc = __ata_qc_from_tag(ap, ap->link.active_tag);
409 if (qc && !(qc->flags & ATA_QCFLAG_FAILED))
412 /* reset PIO HSM and stop DMA engine */
413 spin_lock_irqsave(ap->lock, flags);
415 ap->hsm_task_state = HSM_ST_IDLE;
417 if (qc && (qc->tf.protocol == ATA_PROT_DMA ||
418 qc->tf.protocol == ATA_PROT_ATAPI_DMA)) {
421 host_stat = ap->ops->bmdma_status(ap);
423 /* BMDMA controllers indicate host bus error by
424 * setting DMA_ERR bit and timing out. As it wasn't
425 * really a timeout event, adjust error mask and
426 * cancel frozen state.
428 if (qc->err_mask == AC_ERR_TIMEOUT && (host_stat & ATA_DMA_ERR)) {
429 qc->err_mask = AC_ERR_HOST_BUS;
433 ap->ops->bmdma_stop(qc);
438 ap->ops->irq_clear(ap);
440 spin_unlock_irqrestore(ap->lock, flags);
443 ata_eh_thaw_port(ap);
445 /* PIO and DMA engines have been stopped, perform recovery */
446 ata_do_eh(ap, prereset, softreset, hardreset, postreset);
450 * ata_bmdma_error_handler - Stock error handler for BMDMA controller
451 * @ap: port to handle error for
453 * Stock error handler for BMDMA controller.
456 * Kernel thread context (may sleep)
458 void ata_bmdma_error_handler(struct ata_port *ap)
460 ata_reset_fn_t hardreset;
463 if (sata_scr_valid(&ap->link))
464 hardreset = sata_std_hardreset;
466 ata_bmdma_drive_eh(ap, ata_std_prereset, ata_std_softreset, hardreset,
471 * ata_bmdma_post_internal_cmd - Stock post_internal_cmd for
473 * @qc: internal command to clean up
476 * Kernel thread context (may sleep)
478 void ata_bmdma_post_internal_cmd(struct ata_queued_cmd *qc)
480 if (qc->ap->ioaddr.bmdma_addr)
485 * ata_sff_port_start - Set port up for dma.
486 * @ap: Port to initialize
488 * Called just after data structures for each port are
489 * initialized. Allocates space for PRD table if the device
490 * is DMA capable SFF.
492 * May be used as the port_start() entry in ata_port_operations.
495 * Inherited from caller.
498 int ata_sff_port_start(struct ata_port *ap)
500 if (ap->ioaddr.bmdma_addr)
501 return ata_port_start(ap);
507 static int ata_resources_present(struct pci_dev *pdev, int port)
511 /* Check the PCI resources for this channel are enabled */
513 for (i = 0; i < 2; i ++) {
514 if (pci_resource_start(pdev, port + i) == 0 ||
515 pci_resource_len(pdev, port + i) == 0)
522 * ata_pci_init_bmdma - acquire PCI BMDMA resources and init ATA host
523 * @host: target ATA host
525 * Acquire PCI BMDMA resources and initialize @host accordingly.
528 * Inherited from calling layer (may sleep).
531 * 0 on success, -errno otherwise.
533 int ata_pci_init_bmdma(struct ata_host *host)
535 struct device *gdev = host->dev;
536 struct pci_dev *pdev = to_pci_dev(gdev);
539 /* No BAR4 allocation: No DMA */
540 if (pci_resource_start(pdev, 4) == 0)
543 /* TODO: If we get no DMA mask we should fall back to PIO */
544 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
547 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
551 /* request and iomap DMA region */
552 rc = pcim_iomap_regions(pdev, 1 << 4, DRV_NAME);
554 dev_printk(KERN_ERR, gdev, "failed to request/iomap BAR4\n");
557 host->iomap = pcim_iomap_table(pdev);
559 for (i = 0; i < 2; i++) {
560 struct ata_port *ap = host->ports[i];
561 void __iomem *bmdma = host->iomap[4] + 8 * i;
563 if (ata_port_is_dummy(ap))
566 ap->ioaddr.bmdma_addr = bmdma;
567 if ((!(ap->flags & ATA_FLAG_IGN_SIMPLEX)) &&
568 (ioread8(bmdma + 2) & 0x80))
569 host->flags |= ATA_HOST_SIMPLEX;
571 ata_port_desc(ap, "bmdma 0x%llx",
572 (unsigned long long)pci_resource_start(pdev, 4) + 8 * i);
579 * ata_pci_init_sff_host - acquire native PCI ATA resources and init host
580 * @host: target ATA host
582 * Acquire native PCI ATA resources for @host and initialize the
583 * first two ports of @host accordingly. Ports marked dummy are
584 * skipped and allocation failure makes the port dummy.
586 * Note that native PCI resources are valid even for legacy hosts
587 * as we fix up pdev resources array early in boot, so this
588 * function can be used for both native and legacy SFF hosts.
591 * Inherited from calling layer (may sleep).
594 * 0 if at least one port is initialized, -ENODEV if no port is
597 int ata_pci_init_sff_host(struct ata_host *host)
599 struct device *gdev = host->dev;
600 struct pci_dev *pdev = to_pci_dev(gdev);
601 unsigned int mask = 0;
604 /* request, iomap BARs and init port addresses accordingly */
605 for (i = 0; i < 2; i++) {
606 struct ata_port *ap = host->ports[i];
608 void __iomem * const *iomap;
610 if (ata_port_is_dummy(ap))
613 /* Discard disabled ports. Some controllers show
614 * their unused channels this way. Disabled ports are
617 if (!ata_resources_present(pdev, i)) {
618 ap->ops = &ata_dummy_port_ops;
622 rc = pcim_iomap_regions(pdev, 0x3 << base, DRV_NAME);
624 dev_printk(KERN_WARNING, gdev,
625 "failed to request/iomap BARs for port %d "
626 "(errno=%d)\n", i, rc);
628 pcim_pin_device(pdev);
629 ap->ops = &ata_dummy_port_ops;
632 host->iomap = iomap = pcim_iomap_table(pdev);
634 ap->ioaddr.cmd_addr = iomap[base];
635 ap->ioaddr.altstatus_addr =
636 ap->ioaddr.ctl_addr = (void __iomem *)
637 ((unsigned long)iomap[base + 1] | ATA_PCI_CTL_OFS);
638 ata_std_ports(&ap->ioaddr);
640 ata_port_desc(ap, "cmd 0x%llx ctl 0x%llx",
641 (unsigned long long)pci_resource_start(pdev, base),
642 (unsigned long long)pci_resource_start(pdev, base + 1));
648 dev_printk(KERN_ERR, gdev, "no available native port\n");
656 * ata_pci_prepare_sff_host - helper to prepare native PCI ATA host
657 * @pdev: target PCI device
658 * @ppi: array of port_info, must be enough for two ports
659 * @r_host: out argument for the initialized ATA host
661 * Helper to allocate ATA host for @pdev, acquire all native PCI
662 * resources and initialize it accordingly in one go.
665 * Inherited from calling layer (may sleep).
668 * 0 on success, -errno otherwise.
670 int ata_pci_prepare_sff_host(struct pci_dev *pdev,
671 const struct ata_port_info * const * ppi,
672 struct ata_host **r_host)
674 struct ata_host *host;
677 if (!devres_open_group(&pdev->dev, NULL, GFP_KERNEL))
680 host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2);
682 dev_printk(KERN_ERR, &pdev->dev,
683 "failed to allocate ATA host\n");
688 rc = ata_pci_init_sff_host(host);
692 /* init DMA related stuff */
693 rc = ata_pci_init_bmdma(host);
697 devres_remove_group(&pdev->dev, NULL);
702 /* This is necessary because PCI and iomap resources are
703 * merged and releasing the top group won't release the
704 * acquired resources if some of those have been acquired
705 * before entering this function.
707 pcim_iounmap_regions(pdev, 0xf);
709 devres_release_group(&pdev->dev, NULL);
714 * ata_pci_init_one - Initialize/register PCI IDE host controller
715 * @pdev: Controller to be initialized
716 * @ppi: array of port_info, must be enough for two ports
718 * This is a helper function which can be called from a driver's
719 * xxx_init_one() probe function if the hardware uses traditional
720 * IDE taskfile registers.
722 * This function calls pci_enable_device(), reserves its register
723 * regions, sets the dma mask, enables bus master mode, and calls
727 * Nobody makes a single channel controller that appears solely as
728 * the secondary legacy port on PCI.
731 * Inherited from PCI layer (may sleep).
734 * Zero on success, negative on errno-based value on error.
736 int ata_pci_init_one(struct pci_dev *pdev,
737 const struct ata_port_info * const * ppi)
739 struct device *dev = &pdev->dev;
740 const struct ata_port_info *pi = NULL;
741 struct ata_host *host = NULL;
748 /* look up the first valid port_info */
749 for (i = 0; i < 2 && ppi[i]; i++) {
750 if (ppi[i]->port_ops != &ata_dummy_port_ops) {
757 dev_printk(KERN_ERR, &pdev->dev,
758 "no valid port_info specified\n");
762 if (!devres_open_group(dev, NULL, GFP_KERNEL))
765 /* FIXME: Really for ATA it isn't safe because the device may be
766 multi-purpose and we want to leave it alone if it was already
767 enabled. Secondly for shared use as Arjan says we want refcounting
769 Checking dev->is_enabled is insufficient as this is not set at
770 boot for the primary video which is BIOS enabled
773 rc = pcim_enable_device(pdev);
777 if ((pdev->class >> 8) == PCI_CLASS_STORAGE_IDE) {
780 /* TODO: What if one channel is in native mode ... */
781 pci_read_config_byte(pdev, PCI_CLASS_PROG, &tmp8);
782 mask = (1 << 2) | (1 << 0);
783 if ((tmp8 & mask) != mask)
785 #if defined(CONFIG_NO_ATA_LEGACY)
786 /* Some platforms with PCI limits cannot address compat
787 port space. In that case we punt if their firmware has
788 left a device in compatibility mode */
790 printk(KERN_ERR "ata: Compatibility mode ATA is not supported on this platform, skipping.\n");
798 rc = ata_pci_prepare_sff_host(pdev, ppi, &host);
802 pci_set_master(pdev);
804 /* start host and request IRQ */
805 rc = ata_host_start(host);
810 rc = devm_request_irq(dev, pdev->irq, pi->port_ops->irq_handler,
811 IRQF_SHARED, DRV_NAME, host);
815 ata_port_desc(host->ports[0], "irq %d", pdev->irq);
816 ata_port_desc(host->ports[1], "irq %d", pdev->irq);
818 if (!ata_port_is_dummy(host->ports[0])) {
819 rc = devm_request_irq(dev, ATA_PRIMARY_IRQ(pdev),
820 pi->port_ops->irq_handler,
821 IRQF_SHARED, DRV_NAME, host);
825 ata_port_desc(host->ports[0], "irq %d",
826 ATA_PRIMARY_IRQ(pdev));
829 if (!ata_port_is_dummy(host->ports[1])) {
830 rc = devm_request_irq(dev, ATA_SECONDARY_IRQ(pdev),
831 pi->port_ops->irq_handler,
832 IRQF_SHARED, DRV_NAME, host);
836 ata_port_desc(host->ports[1], "irq %d",
837 ATA_SECONDARY_IRQ(pdev));
842 rc = ata_host_register(host, pi->sht);
846 devres_remove_group(dev, NULL);
850 devres_release_group(dev, NULL);
855 * ata_pci_clear_simplex - attempt to kick device out of simplex
858 * Some PCI ATA devices report simplex mode but in fact can be told to
859 * enter non simplex mode. This implements the neccessary logic to
860 * perform the task on such devices. Calling it on other devices will
861 * have -undefined- behaviour.
864 int ata_pci_clear_simplex(struct pci_dev *pdev)
866 unsigned long bmdma = pci_resource_start(pdev, 4);
872 simplex = inb(bmdma + 0x02);
873 outb(simplex & 0x60, bmdma + 0x02);
874 simplex = inb(bmdma + 0x02);
880 unsigned long ata_pci_default_filter(struct ata_device *adev, unsigned long xfer_mask)
882 /* Filter out DMA modes if the device has been configured by
883 the BIOS as PIO only */
885 if (adev->link->ap->ioaddr.bmdma_addr == 0)
886 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
890 #endif /* CONFIG_PCI */