2 * libata-bmdma.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/config.h>
36 #include <linux/kernel.h>
37 #include <linux/pci.h>
38 #include <linux/libata.h>
43 * ata_tf_load_pio - send taskfile registers to host controller
44 * @ap: Port to which output is sent
45 * @tf: ATA taskfile register set
47 * Outputs ATA taskfile to standard ATA host controller.
50 * Inherited from caller.
53 static void ata_tf_load_pio(struct ata_port *ap, const struct ata_taskfile *tf)
55 struct ata_ioports *ioaddr = &ap->ioaddr;
56 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
58 if (tf->ctl != ap->last_ctl) {
59 outb(tf->ctl, ioaddr->ctl_addr);
60 ap->last_ctl = tf->ctl;
64 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
65 outb(tf->hob_feature, ioaddr->feature_addr);
66 outb(tf->hob_nsect, ioaddr->nsect_addr);
67 outb(tf->hob_lbal, ioaddr->lbal_addr);
68 outb(tf->hob_lbam, ioaddr->lbam_addr);
69 outb(tf->hob_lbah, ioaddr->lbah_addr);
70 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
79 outb(tf->feature, ioaddr->feature_addr);
80 outb(tf->nsect, ioaddr->nsect_addr);
81 outb(tf->lbal, ioaddr->lbal_addr);
82 outb(tf->lbam, ioaddr->lbam_addr);
83 outb(tf->lbah, ioaddr->lbah_addr);
84 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
92 if (tf->flags & ATA_TFLAG_DEVICE) {
93 outb(tf->device, ioaddr->device_addr);
94 VPRINTK("device 0x%X\n", tf->device);
101 * ata_tf_load_mmio - send taskfile registers to host controller
102 * @ap: Port to which output is sent
103 * @tf: ATA taskfile register set
105 * Outputs ATA taskfile to standard ATA host controller using MMIO.
108 * Inherited from caller.
111 static void ata_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
113 struct ata_ioports *ioaddr = &ap->ioaddr;
114 unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
116 if (tf->ctl != ap->last_ctl) {
117 writeb(tf->ctl, (void __iomem *) ap->ioaddr.ctl_addr);
118 ap->last_ctl = tf->ctl;
122 if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
123 writeb(tf->hob_feature, (void __iomem *) ioaddr->feature_addr);
124 writeb(tf->hob_nsect, (void __iomem *) ioaddr->nsect_addr);
125 writeb(tf->hob_lbal, (void __iomem *) ioaddr->lbal_addr);
126 writeb(tf->hob_lbam, (void __iomem *) ioaddr->lbam_addr);
127 writeb(tf->hob_lbah, (void __iomem *) ioaddr->lbah_addr);
128 VPRINTK("hob: feat 0x%X nsect 0x%X, lba 0x%X 0x%X 0x%X\n",
137 writeb(tf->feature, (void __iomem *) ioaddr->feature_addr);
138 writeb(tf->nsect, (void __iomem *) ioaddr->nsect_addr);
139 writeb(tf->lbal, (void __iomem *) ioaddr->lbal_addr);
140 writeb(tf->lbam, (void __iomem *) ioaddr->lbam_addr);
141 writeb(tf->lbah, (void __iomem *) ioaddr->lbah_addr);
142 VPRINTK("feat 0x%X nsect 0x%X lba 0x%X 0x%X 0x%X\n",
150 if (tf->flags & ATA_TFLAG_DEVICE) {
151 writeb(tf->device, (void __iomem *) ioaddr->device_addr);
152 VPRINTK("device 0x%X\n", tf->device);
160 * ata_tf_load - send taskfile registers to host controller
161 * @ap: Port to which output is sent
162 * @tf: ATA taskfile register set
164 * Outputs ATA taskfile to standard ATA host controller using MMIO
165 * or PIO as indicated by the ATA_FLAG_MMIO flag.
166 * Writes the control, feature, nsect, lbal, lbam, and lbah registers.
167 * Optionally (ATA_TFLAG_LBA48) writes hob_feature, hob_nsect,
168 * hob_lbal, hob_lbam, and hob_lbah.
170 * This function waits for idle (!BUSY and !DRQ) after writing
171 * registers. If the control register has a new value, this
172 * function also waits for idle after writing control and before
173 * writing the remaining registers.
175 * May be used as the tf_load() entry in ata_port_operations.
178 * Inherited from caller.
180 void ata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
182 if (ap->flags & ATA_FLAG_MMIO)
183 ata_tf_load_mmio(ap, tf);
185 ata_tf_load_pio(ap, tf);
189 * ata_exec_command_pio - issue ATA command to host controller
190 * @ap: port to which command is being issued
191 * @tf: ATA taskfile register set
193 * Issues PIO write to ATA command register, with proper
194 * synchronization with interrupt handler / other threads.
197 * spin_lock_irqsave(host_set lock)
200 static void ata_exec_command_pio(struct ata_port *ap, const struct ata_taskfile *tf)
202 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
204 outb(tf->command, ap->ioaddr.command_addr);
210 * ata_exec_command_mmio - issue ATA command to host controller
211 * @ap: port to which command is being issued
212 * @tf: ATA taskfile register set
214 * Issues MMIO write to ATA command register, with proper
215 * synchronization with interrupt handler / other threads.
217 * FIXME: missing write posting for 400nS delay enforcement
220 * spin_lock_irqsave(host_set lock)
223 static void ata_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
225 DPRINTK("ata%u: cmd 0x%X\n", ap->id, tf->command);
227 writeb(tf->command, (void __iomem *) ap->ioaddr.command_addr);
233 * ata_exec_command - issue ATA command to host controller
234 * @ap: port to which command is being issued
235 * @tf: ATA taskfile register set
237 * Issues PIO/MMIO write to ATA command register, with proper
238 * synchronization with interrupt handler / other threads.
241 * spin_lock_irqsave(host_set lock)
243 void ata_exec_command(struct ata_port *ap, const struct ata_taskfile *tf)
245 if (ap->flags & ATA_FLAG_MMIO)
246 ata_exec_command_mmio(ap, tf);
248 ata_exec_command_pio(ap, tf);
252 * ata_tf_read_pio - input device's ATA taskfile shadow registers
253 * @ap: Port from which input is read
254 * @tf: ATA taskfile register set for storing input
256 * Reads ATA taskfile registers for currently-selected device
260 * Inherited from caller.
263 static void ata_tf_read_pio(struct ata_port *ap, struct ata_taskfile *tf)
265 struct ata_ioports *ioaddr = &ap->ioaddr;
267 tf->command = ata_check_status(ap);
268 tf->feature = inb(ioaddr->error_addr);
269 tf->nsect = inb(ioaddr->nsect_addr);
270 tf->lbal = inb(ioaddr->lbal_addr);
271 tf->lbam = inb(ioaddr->lbam_addr);
272 tf->lbah = inb(ioaddr->lbah_addr);
273 tf->device = inb(ioaddr->device_addr);
275 if (tf->flags & ATA_TFLAG_LBA48) {
276 outb(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
277 tf->hob_feature = inb(ioaddr->error_addr);
278 tf->hob_nsect = inb(ioaddr->nsect_addr);
279 tf->hob_lbal = inb(ioaddr->lbal_addr);
280 tf->hob_lbam = inb(ioaddr->lbam_addr);
281 tf->hob_lbah = inb(ioaddr->lbah_addr);
286 * ata_tf_read_mmio - input device's ATA taskfile shadow registers
287 * @ap: Port from which input is read
288 * @tf: ATA taskfile register set for storing input
290 * Reads ATA taskfile registers for currently-selected device
294 * Inherited from caller.
297 static void ata_tf_read_mmio(struct ata_port *ap, struct ata_taskfile *tf)
299 struct ata_ioports *ioaddr = &ap->ioaddr;
301 tf->command = ata_check_status(ap);
302 tf->feature = readb((void __iomem *)ioaddr->error_addr);
303 tf->nsect = readb((void __iomem *)ioaddr->nsect_addr);
304 tf->lbal = readb((void __iomem *)ioaddr->lbal_addr);
305 tf->lbam = readb((void __iomem *)ioaddr->lbam_addr);
306 tf->lbah = readb((void __iomem *)ioaddr->lbah_addr);
307 tf->device = readb((void __iomem *)ioaddr->device_addr);
309 if (tf->flags & ATA_TFLAG_LBA48) {
310 writeb(tf->ctl | ATA_HOB, (void __iomem *) ap->ioaddr.ctl_addr);
311 tf->hob_feature = readb((void __iomem *)ioaddr->error_addr);
312 tf->hob_nsect = readb((void __iomem *)ioaddr->nsect_addr);
313 tf->hob_lbal = readb((void __iomem *)ioaddr->lbal_addr);
314 tf->hob_lbam = readb((void __iomem *)ioaddr->lbam_addr);
315 tf->hob_lbah = readb((void __iomem *)ioaddr->lbah_addr);
321 * ata_tf_read - input device's ATA taskfile shadow registers
322 * @ap: Port from which input is read
323 * @tf: ATA taskfile register set for storing input
325 * Reads ATA taskfile registers for currently-selected device
328 * Reads nsect, lbal, lbam, lbah, and device. If ATA_TFLAG_LBA48
329 * is set, also reads the hob registers.
331 * May be used as the tf_read() entry in ata_port_operations.
334 * Inherited from caller.
336 void ata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
338 if (ap->flags & ATA_FLAG_MMIO)
339 ata_tf_read_mmio(ap, tf);
341 ata_tf_read_pio(ap, tf);
345 * ata_check_status_pio - Read device status reg & clear interrupt
346 * @ap: port where the device is
348 * Reads ATA taskfile status register for currently-selected device
349 * and return its value. This also clears pending interrupts
353 * Inherited from caller.
355 static u8 ata_check_status_pio(struct ata_port *ap)
357 return inb(ap->ioaddr.status_addr);
361 * ata_check_status_mmio - Read device status reg & clear interrupt
362 * @ap: port where the device is
364 * Reads ATA taskfile status register for currently-selected device
365 * via MMIO and return its value. This also clears pending interrupts
369 * Inherited from caller.
371 static u8 ata_check_status_mmio(struct ata_port *ap)
373 return readb((void __iomem *) ap->ioaddr.status_addr);
378 * ata_check_status - Read device status reg & clear interrupt
379 * @ap: port where the device is
381 * Reads ATA taskfile status register for currently-selected device
382 * and return its value. This also clears pending interrupts
385 * May be used as the check_status() entry in ata_port_operations.
388 * Inherited from caller.
390 u8 ata_check_status(struct ata_port *ap)
392 if (ap->flags & ATA_FLAG_MMIO)
393 return ata_check_status_mmio(ap);
394 return ata_check_status_pio(ap);
399 * ata_altstatus - Read device alternate status reg
400 * @ap: port where the device is
402 * Reads ATA taskfile alternate status register for
403 * currently-selected device and return its value.
405 * Note: may NOT be used as the check_altstatus() entry in
406 * ata_port_operations.
409 * Inherited from caller.
411 u8 ata_altstatus(struct ata_port *ap)
413 if (ap->ops->check_altstatus)
414 return ap->ops->check_altstatus(ap);
416 if (ap->flags & ATA_FLAG_MMIO)
417 return readb((void __iomem *)ap->ioaddr.altstatus_addr);
418 return inb(ap->ioaddr.altstatus_addr);
422 static struct ata_probe_ent *
423 ata_probe_ent_alloc(struct device *dev, const struct ata_port_info *port)
425 struct ata_probe_ent *probe_ent;
427 probe_ent = kzalloc(sizeof(*probe_ent), GFP_KERNEL);
429 printk(KERN_ERR DRV_NAME "(%s): out of memory\n",
430 kobject_name(&(dev->kobj)));
434 INIT_LIST_HEAD(&probe_ent->node);
435 probe_ent->dev = dev;
437 probe_ent->sht = port->sht;
438 probe_ent->host_flags = port->host_flags;
439 probe_ent->pio_mask = port->pio_mask;
440 probe_ent->mwdma_mask = port->mwdma_mask;
441 probe_ent->udma_mask = port->udma_mask;
442 probe_ent->port_ops = port->port_ops;
449 * ata_pci_init_native_mode - Initialize native-mode driver
450 * @pdev: pci device to be initialized
451 * @port: array[2] of pointers to port info structures.
452 * @ports: bitmap of ports present
454 * Utility function which allocates and initializes an
455 * ata_probe_ent structure for a standard dual-port
456 * PIO-based IDE controller. The returned ata_probe_ent
457 * structure can be passed to ata_device_add(). The returned
458 * ata_probe_ent structure should then be freed with kfree().
460 * The caller need only pass the address of the primary port, the
461 * secondary will be deduced automatically. If the device has non
462 * standard secondary port mappings this function can be called twice,
463 * once for each interface.
466 struct ata_probe_ent *
467 ata_pci_init_native_mode(struct pci_dev *pdev, struct ata_port_info **port, int ports)
469 struct ata_probe_ent *probe_ent =
470 ata_probe_ent_alloc(pci_dev_to_dev(pdev), port[0]);
476 probe_ent->irq = pdev->irq;
477 probe_ent->irq_flags = SA_SHIRQ;
478 probe_ent->private_data = port[0]->private_data;
480 if (ports & ATA_PORT_PRIMARY) {
481 probe_ent->port[p].cmd_addr = pci_resource_start(pdev, 0);
482 probe_ent->port[p].altstatus_addr =
483 probe_ent->port[p].ctl_addr =
484 pci_resource_start(pdev, 1) | ATA_PCI_CTL_OFS;
485 probe_ent->port[p].bmdma_addr = pci_resource_start(pdev, 4);
486 ata_std_ports(&probe_ent->port[p]);
490 if (ports & ATA_PORT_SECONDARY) {
491 probe_ent->port[p].cmd_addr = pci_resource_start(pdev, 2);
492 probe_ent->port[p].altstatus_addr =
493 probe_ent->port[p].ctl_addr =
494 pci_resource_start(pdev, 3) | ATA_PCI_CTL_OFS;
495 probe_ent->port[p].bmdma_addr = pci_resource_start(pdev, 4) + 8;
496 ata_std_ports(&probe_ent->port[p]);
500 probe_ent->n_ports = p;
505 static struct ata_probe_ent *ata_pci_init_legacy_port(struct pci_dev *pdev,
506 struct ata_port_info *port, int port_num)
508 struct ata_probe_ent *probe_ent;
510 probe_ent = ata_probe_ent_alloc(pci_dev_to_dev(pdev), port);
514 probe_ent->legacy_mode = 1;
515 probe_ent->n_ports = 1;
516 probe_ent->hard_port_no = port_num;
517 probe_ent->private_data = port->private_data;
523 probe_ent->port[0].cmd_addr = 0x1f0;
524 probe_ent->port[0].altstatus_addr =
525 probe_ent->port[0].ctl_addr = 0x3f6;
529 probe_ent->port[0].cmd_addr = 0x170;
530 probe_ent->port[0].altstatus_addr =
531 probe_ent->port[0].ctl_addr = 0x376;
535 probe_ent->port[0].bmdma_addr =
536 pci_resource_start(pdev, 4) + 8 * port_num;
537 ata_std_ports(&probe_ent->port[0]);
544 * ata_pci_init_one - Initialize/register PCI IDE host controller
545 * @pdev: Controller to be initialized
546 * @port_info: Information from low-level host driver
547 * @n_ports: Number of ports attached to host controller
549 * This is a helper function which can be called from a driver's
550 * xxx_init_one() probe function if the hardware uses traditional
551 * IDE taskfile registers.
553 * This function calls pci_enable_device(), reserves its register
554 * regions, sets the dma mask, enables bus master mode, and calls
558 * Inherited from PCI layer (may sleep).
561 * Zero on success, negative on errno-based value on error.
564 int ata_pci_init_one (struct pci_dev *pdev, struct ata_port_info **port_info,
565 unsigned int n_ports)
567 struct ata_probe_ent *probe_ent = NULL, *probe_ent2 = NULL;
568 struct ata_port_info *port[2];
570 unsigned int legacy_mode = 0;
571 int disable_dev_on_err = 1;
576 port[0] = port_info[0];
578 port[1] = port_info[1];
582 if ((port[0]->host_flags & ATA_FLAG_NO_LEGACY) == 0
583 && (pdev->class >> 8) == PCI_CLASS_STORAGE_IDE) {
584 /* TODO: What if one channel is in native mode ... */
585 pci_read_config_byte(pdev, PCI_CLASS_PROG, &tmp8);
586 mask = (1 << 2) | (1 << 0);
587 if ((tmp8 & mask) != mask)
588 legacy_mode = (1 << 3);
592 if ((!legacy_mode) && (n_ports > 2)) {
593 printk(KERN_ERR "ata: BUG: native mode, n_ports > 2\n");
598 /* FIXME: Really for ATA it isn't safe because the device may be
599 multi-purpose and we want to leave it alone if it was already
600 enabled. Secondly for shared use as Arjan says we want refcounting
602 Checking dev->is_enabled is insufficient as this is not set at
603 boot for the primary video which is BIOS enabled
606 rc = pci_enable_device(pdev);
610 rc = pci_request_regions(pdev, DRV_NAME);
612 disable_dev_on_err = 0;
616 /* FIXME: Should use platform specific mappers for legacy port ranges */
618 if (!request_region(0x1f0, 8, "libata")) {
619 struct resource *conflict, res;
621 res.end = 0x1f0 + 8 - 1;
622 conflict = ____request_resource(&ioport_resource, &res);
623 if (!strcmp(conflict->name, "libata"))
624 legacy_mode |= (1 << 0);
626 disable_dev_on_err = 0;
627 printk(KERN_WARNING "ata: 0x1f0 IDE port busy\n");
630 legacy_mode |= (1 << 0);
632 if (!request_region(0x170, 8, "libata")) {
633 struct resource *conflict, res;
635 res.end = 0x170 + 8 - 1;
636 conflict = ____request_resource(&ioport_resource, &res);
637 if (!strcmp(conflict->name, "libata"))
638 legacy_mode |= (1 << 1);
640 disable_dev_on_err = 0;
641 printk(KERN_WARNING "ata: 0x170 IDE port busy\n");
644 legacy_mode |= (1 << 1);
647 /* we have legacy mode, but all ports are unavailable */
648 if (legacy_mode == (1 << 3)) {
650 goto err_out_regions;
653 /* FIXME: If we get no DMA mask we should fall back to PIO */
654 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
656 goto err_out_regions;
657 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
659 goto err_out_regions;
662 if (legacy_mode & (1 << 0))
663 probe_ent = ata_pci_init_legacy_port(pdev, port[0], 0);
664 if (legacy_mode & (1 << 1))
665 probe_ent2 = ata_pci_init_legacy_port(pdev, port[1], 1);
668 probe_ent = ata_pci_init_native_mode(pdev, port, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
670 probe_ent = ata_pci_init_native_mode(pdev, port, ATA_PORT_PRIMARY);
672 if (!probe_ent && !probe_ent2) {
674 goto err_out_regions;
677 pci_set_master(pdev);
679 /* FIXME: check ata_device_add return */
681 if (legacy_mode & (1 << 0))
682 ata_device_add(probe_ent);
683 if (legacy_mode & (1 << 1))
684 ata_device_add(probe_ent2);
686 ata_device_add(probe_ent);
694 if (legacy_mode & (1 << 0))
695 release_region(0x1f0, 8);
696 if (legacy_mode & (1 << 1))
697 release_region(0x170, 8);
698 pci_release_regions(pdev);
700 if (disable_dev_on_err)
701 pci_disable_device(pdev);
706 * ata_pci_clear_simplex - attempt to kick device out of simplex
709 * Some PCI ATA devices report simplex mode but in fact can be told to
710 * enter non simplex mode. This implements the neccessary logic to
711 * perform the task on such devices. Calling it on other devices will
712 * have -undefined- behaviour.
715 int ata_pci_clear_simplex(struct pci_dev *pdev)
717 unsigned long bmdma = pci_resource_start(pdev, 4);
723 simplex = inb(bmdma + 0x02);
724 outb(simplex & 0x60, bmdma + 0x02);
725 simplex = inb(bmdma + 0x02);
731 unsigned long ata_pci_default_filter(const struct ata_port *ap, struct ata_device *adev, unsigned long xfer_mask)
733 /* Filter out DMA modes if the device has been configured by
734 the BIOS as PIO only */
736 if (ap->ioaddr.bmdma_addr == 0)
737 xfer_mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
741 #endif /* CONFIG_PCI */