2 * sata_promise.c - Promise SATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc.
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2, or (at your option)
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; see the file COPYING. If not, write to
23 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 * libata documentation is available via 'make {ps|pdf}docs',
27 * as Documentation/DocBook/libata.*
29 * Hardware information only available under NDA.
33 #include <linux/kernel.h>
34 #include <linux/module.h>
35 #include <linux/pci.h>
36 #include <linux/init.h>
37 #include <linux/blkdev.h>
38 #include <linux/delay.h>
39 #include <linux/interrupt.h>
40 #include <linux/sched.h>
41 #include <linux/device.h>
42 #include <scsi/scsi_host.h>
43 #include <scsi/scsi_cmnd.h>
44 #include <linux/libata.h>
46 #include "sata_promise.h"
48 #define DRV_NAME "sata_promise"
49 #define DRV_VERSION "1.03"
53 PDC_PKT_SUBMIT = 0x40, /* Command packet pointer addr */
54 PDC_INT_SEQMASK = 0x40, /* Mask of asserted SEQ INTs */
55 PDC_TBG_MODE = 0x41, /* TBG mode */
56 PDC_FLASH_CTL = 0x44, /* Flash control register */
57 PDC_PCI_CTL = 0x48, /* PCI control and status register */
58 PDC_GLOBAL_CTL = 0x48, /* Global control/status (per port) */
59 PDC_CTLSTAT = 0x60, /* IDE control and status (per port) */
60 PDC_SATA_PLUG_CSR = 0x6C, /* SATA Plug control/status reg */
61 PDC_SLEW_CTL = 0x470, /* slew rate control reg */
63 PDC_ERR_MASK = (1<<19) | (1<<20) | (1<<21) | (1<<22) |
64 (1<<8) | (1<<9) | (1<<10),
66 board_2037x = 0, /* FastTrak S150 TX2plus */
67 board_20319 = 1, /* FastTrak S150 TX4 */
68 board_20619 = 2, /* FastTrak TX4000 */
70 PDC_HAS_PATA = (1 << 1), /* PDC20375 has PATA */
72 PDC_RESET = (1 << 11), /* HDMA reset */
74 PDC_COMMON_FLAGS = ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST |
75 ATA_FLAG_MMIO | ATA_FLAG_NO_ATAPI |
80 struct pdc_port_priv {
85 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg);
86 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
87 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
88 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
89 static void pdc_eng_timeout(struct ata_port *ap);
90 static int pdc_port_start(struct ata_port *ap);
91 static void pdc_port_stop(struct ata_port *ap);
92 static void pdc_pata_phy_reset(struct ata_port *ap);
93 static void pdc_sata_phy_reset(struct ata_port *ap);
94 static void pdc_qc_prep(struct ata_queued_cmd *qc);
95 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
96 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
97 static void pdc_irq_clear(struct ata_port *ap);
98 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc);
101 static struct scsi_host_template pdc_ata_sht = {
102 .module = THIS_MODULE,
104 .ioctl = ata_scsi_ioctl,
105 .queuecommand = ata_scsi_queuecmd,
106 .eh_strategy_handler = ata_scsi_error,
107 .can_queue = ATA_DEF_QUEUE,
108 .this_id = ATA_SHT_THIS_ID,
109 .sg_tablesize = LIBATA_MAX_PRD,
110 .max_sectors = ATA_MAX_SECTORS,
111 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
112 .emulated = ATA_SHT_EMULATED,
113 .use_clustering = ATA_SHT_USE_CLUSTERING,
114 .proc_name = DRV_NAME,
115 .dma_boundary = ATA_DMA_BOUNDARY,
116 .slave_configure = ata_scsi_slave_config,
117 .bios_param = ata_std_bios_param,
121 static const struct ata_port_operations pdc_sata_ops = {
122 .port_disable = ata_port_disable,
123 .tf_load = pdc_tf_load_mmio,
124 .tf_read = ata_tf_read,
125 .check_status = ata_check_status,
126 .exec_command = pdc_exec_command_mmio,
127 .dev_select = ata_std_dev_select,
129 .phy_reset = pdc_sata_phy_reset,
131 .qc_prep = pdc_qc_prep,
132 .qc_issue = pdc_qc_issue_prot,
133 .eng_timeout = pdc_eng_timeout,
134 .irq_handler = pdc_interrupt,
135 .irq_clear = pdc_irq_clear,
137 .scr_read = pdc_sata_scr_read,
138 .scr_write = pdc_sata_scr_write,
139 .port_start = pdc_port_start,
140 .port_stop = pdc_port_stop,
141 .host_stop = ata_pci_host_stop,
144 static const struct ata_port_operations pdc_pata_ops = {
145 .port_disable = ata_port_disable,
146 .tf_load = pdc_tf_load_mmio,
147 .tf_read = ata_tf_read,
148 .check_status = ata_check_status,
149 .exec_command = pdc_exec_command_mmio,
150 .dev_select = ata_std_dev_select,
152 .phy_reset = pdc_pata_phy_reset,
154 .qc_prep = pdc_qc_prep,
155 .qc_issue = pdc_qc_issue_prot,
156 .eng_timeout = pdc_eng_timeout,
157 .irq_handler = pdc_interrupt,
158 .irq_clear = pdc_irq_clear,
160 .port_start = pdc_port_start,
161 .port_stop = pdc_port_stop,
162 .host_stop = ata_pci_host_stop,
165 static const struct ata_port_info pdc_port_info[] = {
169 .host_flags = PDC_COMMON_FLAGS | ATA_FLAG_SATA,
170 .pio_mask = 0x1f, /* pio0-4 */
171 .mwdma_mask = 0x07, /* mwdma0-2 */
172 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
173 .port_ops = &pdc_sata_ops,
179 .host_flags = PDC_COMMON_FLAGS | ATA_FLAG_SATA,
180 .pio_mask = 0x1f, /* pio0-4 */
181 .mwdma_mask = 0x07, /* mwdma0-2 */
182 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
183 .port_ops = &pdc_sata_ops,
189 .host_flags = PDC_COMMON_FLAGS | ATA_FLAG_SLAVE_POSS,
190 .pio_mask = 0x1f, /* pio0-4 */
191 .mwdma_mask = 0x07, /* mwdma0-2 */
192 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
193 .port_ops = &pdc_pata_ops,
197 static const struct pci_device_id pdc_ata_pci_tbl[] = {
198 { PCI_VENDOR_ID_PROMISE, 0x3371, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
200 { PCI_VENDOR_ID_PROMISE, 0x3570, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
202 { PCI_VENDOR_ID_PROMISE, 0x3571, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
204 { PCI_VENDOR_ID_PROMISE, 0x3373, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
206 { PCI_VENDOR_ID_PROMISE, 0x3375, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
208 { PCI_VENDOR_ID_PROMISE, 0x3376, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
210 { PCI_VENDOR_ID_PROMISE, 0x3574, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
212 { PCI_VENDOR_ID_PROMISE, 0x3d75, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
214 { PCI_VENDOR_ID_PROMISE, 0x3d73, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
217 { PCI_VENDOR_ID_PROMISE, 0x3318, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
219 { PCI_VENDOR_ID_PROMISE, 0x3319, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
221 { PCI_VENDOR_ID_PROMISE, 0x3519, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
223 { PCI_VENDOR_ID_PROMISE, 0x3d17, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
225 { PCI_VENDOR_ID_PROMISE, 0x3d18, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
228 { PCI_VENDOR_ID_PROMISE, 0x6629, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
231 { } /* terminate list */
235 static struct pci_driver pdc_ata_pci_driver = {
237 .id_table = pdc_ata_pci_tbl,
238 .probe = pdc_ata_init_one,
239 .remove = ata_pci_remove_one,
243 static int pdc_port_start(struct ata_port *ap)
245 struct device *dev = ap->host_set->dev;
246 struct pdc_port_priv *pp;
249 rc = ata_port_start(ap);
253 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
258 memset(pp, 0, sizeof(*pp));
260 pp->pkt = dma_alloc_coherent(dev, 128, &pp->pkt_dma, GFP_KERNEL);
266 ap->private_data = pp;
278 static void pdc_port_stop(struct ata_port *ap)
280 struct device *dev = ap->host_set->dev;
281 struct pdc_port_priv *pp = ap->private_data;
283 ap->private_data = NULL;
284 dma_free_coherent(dev, 128, pp->pkt, pp->pkt_dma);
290 static void pdc_reset_port(struct ata_port *ap)
292 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_CTLSTAT;
296 for (i = 11; i > 0; i--) {
309 readl(mmio); /* flush */
312 static void pdc_sata_phy_reset(struct ata_port *ap)
318 static void pdc_pata_phy_reset(struct ata_port *ap)
320 /* FIXME: add cable detect. Don't assume 40-pin cable */
321 ap->cbl = ATA_CBL_PATA40;
322 ap->udma_mask &= ATA_UDMA_MASK_40C;
329 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
331 if (sc_reg > SCR_CONTROL)
333 return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
337 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
340 if (sc_reg > SCR_CONTROL)
342 writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
345 static void pdc_qc_prep(struct ata_queued_cmd *qc)
347 struct pdc_port_priv *pp = qc->ap->private_data;
352 switch (qc->tf.protocol) {
357 case ATA_PROT_NODATA:
358 i = pdc_pkt_header(&qc->tf, qc->ap->prd_dma,
359 qc->dev->devno, pp->pkt);
361 if (qc->tf.flags & ATA_TFLAG_LBA48)
362 i = pdc_prep_lba48(&qc->tf, pp->pkt, i);
364 i = pdc_prep_lba28(&qc->tf, pp->pkt, i);
366 pdc_pkt_footer(&qc->tf, pp->pkt, i);
374 static void pdc_eng_timeout(struct ata_port *ap)
376 struct ata_host_set *host_set = ap->host_set;
378 struct ata_queued_cmd *qc;
383 spin_lock_irqsave(&host_set->lock, flags);
385 qc = ata_qc_from_tag(ap, ap->active_tag);
387 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
392 /* hack alert! We cannot use the supplied completion
393 * function from inside the ->eh_strategy_handler() thread.
394 * libata is the only user of ->eh_strategy_handler() in
395 * any kernel, so the default scsi_done() assumes it is
396 * not being called from the SCSI EH.
398 qc->scsidone = scsi_finish_command;
400 switch (qc->tf.protocol) {
402 case ATA_PROT_NODATA:
403 printk(KERN_ERR "ata%u: command timeout\n", ap->id);
404 drv_stat = ata_wait_idle(ap);
405 qc->err_mask |= __ac_err_mask(drv_stat);
410 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
412 printk(KERN_ERR "ata%u: unknown timeout, cmd 0x%x stat 0x%x\n",
413 ap->id, qc->tf.command, drv_stat);
415 qc->err_mask |= ac_err_mask(drv_stat);
421 spin_unlock_irqrestore(&host_set->lock, flags);
425 static inline unsigned int pdc_host_intr( struct ata_port *ap,
426 struct ata_queued_cmd *qc)
428 unsigned int handled = 0;
430 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_GLOBAL_CTL;
433 if (tmp & PDC_ERR_MASK) {
434 qc->err_mask |= AC_ERR_DEV;
438 switch (qc->tf.protocol) {
440 case ATA_PROT_NODATA:
441 qc->err_mask |= ac_err_mask(ata_wait_idle(ap));
447 ap->stats.idle_irq++;
454 static void pdc_irq_clear(struct ata_port *ap)
456 struct ata_host_set *host_set = ap->host_set;
457 void __iomem *mmio = host_set->mmio_base;
459 readl(mmio + PDC_INT_SEQMASK);
462 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
464 struct ata_host_set *host_set = dev_instance;
468 unsigned int handled = 0;
469 void __iomem *mmio_base;
473 if (!host_set || !host_set->mmio_base) {
474 VPRINTK("QUICK EXIT\n");
478 mmio_base = host_set->mmio_base;
480 /* reading should also clear interrupts */
481 mask = readl(mmio_base + PDC_INT_SEQMASK);
483 if (mask == 0xffffffff) {
484 VPRINTK("QUICK EXIT 2\n");
487 mask &= 0xffff; /* only 16 tags possible */
489 VPRINTK("QUICK EXIT 3\n");
493 spin_lock(&host_set->lock);
495 writel(mask, mmio_base + PDC_INT_SEQMASK);
497 for (i = 0; i < host_set->n_ports; i++) {
498 VPRINTK("port %u\n", i);
499 ap = host_set->ports[i];
500 tmp = mask & (1 << (i + 1));
502 !(ap->flags & ATA_FLAG_PORT_DISABLED)) {
503 struct ata_queued_cmd *qc;
505 qc = ata_qc_from_tag(ap, ap->active_tag);
506 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING)))
507 handled += pdc_host_intr(ap, qc);
511 spin_unlock(&host_set->lock);
515 return IRQ_RETVAL(handled);
518 static inline void pdc_packet_start(struct ata_queued_cmd *qc)
520 struct ata_port *ap = qc->ap;
521 struct pdc_port_priv *pp = ap->private_data;
522 unsigned int port_no = ap->port_no;
523 u8 seq = (u8) (port_no + 1);
525 VPRINTK("ENTER, ap %p\n", ap);
527 writel(0x00000001, ap->host_set->mmio_base + (seq * 4));
528 readl(ap->host_set->mmio_base + (seq * 4)); /* flush */
531 wmb(); /* flush PRD, pkt writes */
532 writel(pp->pkt_dma, (void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT);
533 readl((void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT); /* flush */
536 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc)
538 switch (qc->tf.protocol) {
540 case ATA_PROT_NODATA:
541 pdc_packet_start(qc);
544 case ATA_PROT_ATAPI_DMA:
552 return ata_qc_issue_prot(qc);
555 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
557 WARN_ON (tf->protocol == ATA_PROT_DMA ||
558 tf->protocol == ATA_PROT_NODATA);
563 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
565 WARN_ON (tf->protocol == ATA_PROT_DMA ||
566 tf->protocol == ATA_PROT_NODATA);
567 ata_exec_command(ap, tf);
571 static void pdc_ata_setup_port(struct ata_ioports *port, unsigned long base)
573 port->cmd_addr = base;
574 port->data_addr = base;
576 port->error_addr = base + 0x4;
577 port->nsect_addr = base + 0x8;
578 port->lbal_addr = base + 0xc;
579 port->lbam_addr = base + 0x10;
580 port->lbah_addr = base + 0x14;
581 port->device_addr = base + 0x18;
583 port->status_addr = base + 0x1c;
584 port->altstatus_addr =
585 port->ctl_addr = base + 0x38;
589 static void pdc_host_init(unsigned int chip_id, struct ata_probe_ent *pe)
591 void __iomem *mmio = pe->mmio_base;
595 * Except for the hotplug stuff, this is voodoo from the
596 * Promise driver. Label this entire section
597 * "TODO: figure out why we do this"
600 /* change FIFO_SHD to 8 dwords, enable BMR_BURST */
601 tmp = readl(mmio + PDC_FLASH_CTL);
602 tmp |= 0x12000; /* bit 16 (fifo 8 dw) and 13 (bmr burst?) */
603 writel(tmp, mmio + PDC_FLASH_CTL);
605 /* clear plug/unplug flags for all ports */
606 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
607 writel(tmp | 0xff, mmio + PDC_SATA_PLUG_CSR);
609 /* mask plug/unplug ints */
610 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
611 writel(tmp | 0xff0000, mmio + PDC_SATA_PLUG_CSR);
613 /* reduce TBG clock to 133 Mhz. */
614 tmp = readl(mmio + PDC_TBG_MODE);
615 tmp &= ~0x30000; /* clear bit 17, 16*/
616 tmp |= 0x10000; /* set bit 17:16 = 0:1 */
617 writel(tmp, mmio + PDC_TBG_MODE);
619 readl(mmio + PDC_TBG_MODE); /* flush */
622 /* adjust slew rate control register. */
623 tmp = readl(mmio + PDC_SLEW_CTL);
624 tmp &= 0xFFFFF03F; /* clear bit 11 ~ 6 */
625 tmp |= 0x00000900; /* set bit 11-9 = 100b , bit 8-6 = 100 */
626 writel(tmp, mmio + PDC_SLEW_CTL);
629 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
631 static int printed_version;
632 struct ata_probe_ent *probe_ent = NULL;
634 void __iomem *mmio_base;
635 unsigned int board_idx = (unsigned int) ent->driver_data;
636 int pci_dev_busy = 0;
639 if (!printed_version++)
640 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
643 * If this driver happens to only be useful on Apple's K2, then
644 * we should check that here as it has a normal Serverworks ID
646 rc = pci_enable_device(pdev);
650 rc = pci_request_regions(pdev, DRV_NAME);
656 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
658 goto err_out_regions;
659 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
661 goto err_out_regions;
663 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
664 if (probe_ent == NULL) {
666 goto err_out_regions;
669 memset(probe_ent, 0, sizeof(*probe_ent));
670 probe_ent->dev = pci_dev_to_dev(pdev);
671 INIT_LIST_HEAD(&probe_ent->node);
673 mmio_base = pci_iomap(pdev, 3, 0);
674 if (mmio_base == NULL) {
676 goto err_out_free_ent;
678 base = (unsigned long) mmio_base;
680 probe_ent->sht = pdc_port_info[board_idx].sht;
681 probe_ent->host_flags = pdc_port_info[board_idx].host_flags;
682 probe_ent->pio_mask = pdc_port_info[board_idx].pio_mask;
683 probe_ent->mwdma_mask = pdc_port_info[board_idx].mwdma_mask;
684 probe_ent->udma_mask = pdc_port_info[board_idx].udma_mask;
685 probe_ent->port_ops = pdc_port_info[board_idx].port_ops;
687 probe_ent->irq = pdev->irq;
688 probe_ent->irq_flags = SA_SHIRQ;
689 probe_ent->mmio_base = mmio_base;
691 pdc_ata_setup_port(&probe_ent->port[0], base + 0x200);
692 pdc_ata_setup_port(&probe_ent->port[1], base + 0x280);
694 probe_ent->port[0].scr_addr = base + 0x400;
695 probe_ent->port[1].scr_addr = base + 0x500;
697 /* notice 4-port boards */
700 probe_ent->n_ports = 4;
702 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
703 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
705 probe_ent->port[2].scr_addr = base + 0x600;
706 probe_ent->port[3].scr_addr = base + 0x700;
709 probe_ent->n_ports = 2;
712 probe_ent->n_ports = 4;
714 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
715 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
717 probe_ent->port[2].scr_addr = base + 0x600;
718 probe_ent->port[3].scr_addr = base + 0x700;
725 pci_set_master(pdev);
727 /* initialize adapter */
728 pdc_host_init(board_idx, probe_ent);
730 /* FIXME: check ata_device_add return value */
731 ata_device_add(probe_ent);
739 pci_release_regions(pdev);
742 pci_disable_device(pdev);
747 static int __init pdc_ata_init(void)
749 return pci_module_init(&pdc_ata_pci_driver);
753 static void __exit pdc_ata_exit(void)
755 pci_unregister_driver(&pdc_ata_pci_driver);
759 MODULE_AUTHOR("Jeff Garzik");
760 MODULE_DESCRIPTION("Promise ATA TX2/TX4/TX4000 low-level driver");
761 MODULE_LICENSE("GPL");
762 MODULE_DEVICE_TABLE(pci, pdc_ata_pci_tbl);
763 MODULE_VERSION(DRV_VERSION);
765 module_init(pdc_ata_init);
766 module_exit(pdc_ata_exit);