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 */
69 board_20771 = 3, /* FastTrak TX2300 */
71 PDC_HAS_PATA = (1 << 1), /* PDC20375 has PATA */
73 PDC_RESET = (1 << 11), /* HDMA reset */
75 PDC_COMMON_FLAGS = ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST |
76 ATA_FLAG_MMIO | ATA_FLAG_NO_ATAPI |
81 struct pdc_port_priv {
86 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg);
87 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
88 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
89 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
90 static void pdc_eng_timeout(struct ata_port *ap);
91 static int pdc_port_start(struct ata_port *ap);
92 static void pdc_port_stop(struct ata_port *ap);
93 static void pdc_pata_phy_reset(struct ata_port *ap);
94 static void pdc_sata_phy_reset(struct ata_port *ap);
95 static void pdc_qc_prep(struct ata_queued_cmd *qc);
96 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
97 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf);
98 static void pdc_irq_clear(struct ata_port *ap);
99 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc);
102 static struct scsi_host_template pdc_ata_sht = {
103 .module = THIS_MODULE,
105 .ioctl = ata_scsi_ioctl,
106 .queuecommand = ata_scsi_queuecmd,
107 .eh_strategy_handler = ata_scsi_error,
108 .can_queue = ATA_DEF_QUEUE,
109 .this_id = ATA_SHT_THIS_ID,
110 .sg_tablesize = LIBATA_MAX_PRD,
111 .max_sectors = ATA_MAX_SECTORS,
112 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
113 .emulated = ATA_SHT_EMULATED,
114 .use_clustering = ATA_SHT_USE_CLUSTERING,
115 .proc_name = DRV_NAME,
116 .dma_boundary = ATA_DMA_BOUNDARY,
117 .slave_configure = ata_scsi_slave_config,
118 .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,
199 .host_flags = PDC_COMMON_FLAGS | ATA_FLAG_SATA,
200 .pio_mask = 0x1f, /* pio0-4 */
201 .mwdma_mask = 0x07, /* mwdma0-2 */
202 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
203 .port_ops = &pdc_sata_ops,
207 static const struct pci_device_id pdc_ata_pci_tbl[] = {
208 { PCI_VENDOR_ID_PROMISE, 0x3371, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
210 { PCI_VENDOR_ID_PROMISE, 0x3570, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
212 { PCI_VENDOR_ID_PROMISE, 0x3571, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
214 { PCI_VENDOR_ID_PROMISE, 0x3373, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
216 { PCI_VENDOR_ID_PROMISE, 0x3375, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
218 { PCI_VENDOR_ID_PROMISE, 0x3376, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
220 { PCI_VENDOR_ID_PROMISE, 0x3574, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
222 { PCI_VENDOR_ID_PROMISE, 0x3d75, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
224 { PCI_VENDOR_ID_PROMISE, 0x3d73, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
227 { PCI_VENDOR_ID_PROMISE, 0x3318, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
229 { PCI_VENDOR_ID_PROMISE, 0x3319, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
231 { PCI_VENDOR_ID_PROMISE, 0x3519, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
233 { PCI_VENDOR_ID_PROMISE, 0x3d17, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
235 { PCI_VENDOR_ID_PROMISE, 0x3d18, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
238 { PCI_VENDOR_ID_PROMISE, 0x6629, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
241 { PCI_VENDOR_ID_PROMISE, 0x3570, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
243 { } /* terminate list */
247 static struct pci_driver pdc_ata_pci_driver = {
249 .id_table = pdc_ata_pci_tbl,
250 .probe = pdc_ata_init_one,
251 .remove = ata_pci_remove_one,
255 static int pdc_port_start(struct ata_port *ap)
257 struct device *dev = ap->host_set->dev;
258 struct pdc_port_priv *pp;
261 rc = ata_port_start(ap);
265 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
270 memset(pp, 0, sizeof(*pp));
272 pp->pkt = dma_alloc_coherent(dev, 128, &pp->pkt_dma, GFP_KERNEL);
278 ap->private_data = pp;
290 static void pdc_port_stop(struct ata_port *ap)
292 struct device *dev = ap->host_set->dev;
293 struct pdc_port_priv *pp = ap->private_data;
295 ap->private_data = NULL;
296 dma_free_coherent(dev, 128, pp->pkt, pp->pkt_dma);
302 static void pdc_reset_port(struct ata_port *ap)
304 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_CTLSTAT;
308 for (i = 11; i > 0; i--) {
321 readl(mmio); /* flush */
324 static void pdc_sata_phy_reset(struct ata_port *ap)
330 static void pdc_pata_phy_reset(struct ata_port *ap)
332 /* FIXME: add cable detect. Don't assume 40-pin cable */
333 ap->cbl = ATA_CBL_PATA40;
334 ap->udma_mask &= ATA_UDMA_MASK_40C;
341 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
343 if (sc_reg > SCR_CONTROL)
345 return readl((void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
349 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
352 if (sc_reg > SCR_CONTROL)
354 writel(val, (void __iomem *) ap->ioaddr.scr_addr + (sc_reg * 4));
357 static void pdc_qc_prep(struct ata_queued_cmd *qc)
359 struct pdc_port_priv *pp = qc->ap->private_data;
364 switch (qc->tf.protocol) {
369 case ATA_PROT_NODATA:
370 i = pdc_pkt_header(&qc->tf, qc->ap->prd_dma,
371 qc->dev->devno, pp->pkt);
373 if (qc->tf.flags & ATA_TFLAG_LBA48)
374 i = pdc_prep_lba48(&qc->tf, pp->pkt, i);
376 i = pdc_prep_lba28(&qc->tf, pp->pkt, i);
378 pdc_pkt_footer(&qc->tf, pp->pkt, i);
386 static void pdc_eng_timeout(struct ata_port *ap)
388 struct ata_host_set *host_set = ap->host_set;
390 struct ata_queued_cmd *qc;
395 spin_lock_irqsave(&host_set->lock, flags);
397 qc = ata_qc_from_tag(ap, ap->active_tag);
399 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
404 /* hack alert! We cannot use the supplied completion
405 * function from inside the ->eh_strategy_handler() thread.
406 * libata is the only user of ->eh_strategy_handler() in
407 * any kernel, so the default scsi_done() assumes it is
408 * not being called from the SCSI EH.
410 qc->scsidone = scsi_finish_command;
412 switch (qc->tf.protocol) {
414 case ATA_PROT_NODATA:
415 printk(KERN_ERR "ata%u: command timeout\n", ap->id);
416 drv_stat = ata_wait_idle(ap);
417 qc->err_mask |= __ac_err_mask(drv_stat);
422 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
424 printk(KERN_ERR "ata%u: unknown timeout, cmd 0x%x stat 0x%x\n",
425 ap->id, qc->tf.command, drv_stat);
427 qc->err_mask |= ac_err_mask(drv_stat);
433 spin_unlock_irqrestore(&host_set->lock, flags);
437 static inline unsigned int pdc_host_intr( struct ata_port *ap,
438 struct ata_queued_cmd *qc)
440 unsigned int handled = 0;
442 void __iomem *mmio = (void __iomem *) ap->ioaddr.cmd_addr + PDC_GLOBAL_CTL;
445 if (tmp & PDC_ERR_MASK) {
446 qc->err_mask |= AC_ERR_DEV;
450 switch (qc->tf.protocol) {
452 case ATA_PROT_NODATA:
453 qc->err_mask |= ac_err_mask(ata_wait_idle(ap));
459 ap->stats.idle_irq++;
466 static void pdc_irq_clear(struct ata_port *ap)
468 struct ata_host_set *host_set = ap->host_set;
469 void __iomem *mmio = host_set->mmio_base;
471 readl(mmio + PDC_INT_SEQMASK);
474 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
476 struct ata_host_set *host_set = dev_instance;
480 unsigned int handled = 0;
481 void __iomem *mmio_base;
485 if (!host_set || !host_set->mmio_base) {
486 VPRINTK("QUICK EXIT\n");
490 mmio_base = host_set->mmio_base;
492 /* reading should also clear interrupts */
493 mask = readl(mmio_base + PDC_INT_SEQMASK);
495 if (mask == 0xffffffff) {
496 VPRINTK("QUICK EXIT 2\n");
499 mask &= 0xffff; /* only 16 tags possible */
501 VPRINTK("QUICK EXIT 3\n");
505 spin_lock(&host_set->lock);
507 writel(mask, mmio_base + PDC_INT_SEQMASK);
509 for (i = 0; i < host_set->n_ports; i++) {
510 VPRINTK("port %u\n", i);
511 ap = host_set->ports[i];
512 tmp = mask & (1 << (i + 1));
514 !(ap->flags & ATA_FLAG_PORT_DISABLED)) {
515 struct ata_queued_cmd *qc;
517 qc = ata_qc_from_tag(ap, ap->active_tag);
518 if (qc && (!(qc->tf.flags & ATA_TFLAG_POLLING)))
519 handled += pdc_host_intr(ap, qc);
523 spin_unlock(&host_set->lock);
527 return IRQ_RETVAL(handled);
530 static inline void pdc_packet_start(struct ata_queued_cmd *qc)
532 struct ata_port *ap = qc->ap;
533 struct pdc_port_priv *pp = ap->private_data;
534 unsigned int port_no = ap->port_no;
535 u8 seq = (u8) (port_no + 1);
537 VPRINTK("ENTER, ap %p\n", ap);
539 writel(0x00000001, ap->host_set->mmio_base + (seq * 4));
540 readl(ap->host_set->mmio_base + (seq * 4)); /* flush */
543 wmb(); /* flush PRD, pkt writes */
544 writel(pp->pkt_dma, (void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT);
545 readl((void __iomem *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT); /* flush */
548 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc)
550 switch (qc->tf.protocol) {
552 case ATA_PROT_NODATA:
553 pdc_packet_start(qc);
556 case ATA_PROT_ATAPI_DMA:
564 return ata_qc_issue_prot(qc);
567 static void pdc_tf_load_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
569 WARN_ON (tf->protocol == ATA_PROT_DMA ||
570 tf->protocol == ATA_PROT_NODATA);
575 static void pdc_exec_command_mmio(struct ata_port *ap, const struct ata_taskfile *tf)
577 WARN_ON (tf->protocol == ATA_PROT_DMA ||
578 tf->protocol == ATA_PROT_NODATA);
579 ata_exec_command(ap, tf);
583 static void pdc_ata_setup_port(struct ata_ioports *port, unsigned long base)
585 port->cmd_addr = base;
586 port->data_addr = base;
588 port->error_addr = base + 0x4;
589 port->nsect_addr = base + 0x8;
590 port->lbal_addr = base + 0xc;
591 port->lbam_addr = base + 0x10;
592 port->lbah_addr = base + 0x14;
593 port->device_addr = base + 0x18;
595 port->status_addr = base + 0x1c;
596 port->altstatus_addr =
597 port->ctl_addr = base + 0x38;
601 static void pdc_host_init(unsigned int chip_id, struct ata_probe_ent *pe)
603 void __iomem *mmio = pe->mmio_base;
607 * Except for the hotplug stuff, this is voodoo from the
608 * Promise driver. Label this entire section
609 * "TODO: figure out why we do this"
612 /* change FIFO_SHD to 8 dwords, enable BMR_BURST */
613 tmp = readl(mmio + PDC_FLASH_CTL);
614 tmp |= 0x12000; /* bit 16 (fifo 8 dw) and 13 (bmr burst?) */
615 writel(tmp, mmio + PDC_FLASH_CTL);
617 /* clear plug/unplug flags for all ports */
618 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
619 writel(tmp | 0xff, mmio + PDC_SATA_PLUG_CSR);
621 /* mask plug/unplug ints */
622 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
623 writel(tmp | 0xff0000, mmio + PDC_SATA_PLUG_CSR);
625 /* reduce TBG clock to 133 Mhz. */
626 tmp = readl(mmio + PDC_TBG_MODE);
627 tmp &= ~0x30000; /* clear bit 17, 16*/
628 tmp |= 0x10000; /* set bit 17:16 = 0:1 */
629 writel(tmp, mmio + PDC_TBG_MODE);
631 readl(mmio + PDC_TBG_MODE); /* flush */
634 /* adjust slew rate control register. */
635 tmp = readl(mmio + PDC_SLEW_CTL);
636 tmp &= 0xFFFFF03F; /* clear bit 11 ~ 6 */
637 tmp |= 0x00000900; /* set bit 11-9 = 100b , bit 8-6 = 100 */
638 writel(tmp, mmio + PDC_SLEW_CTL);
641 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
643 static int printed_version;
644 struct ata_probe_ent *probe_ent = NULL;
646 void __iomem *mmio_base;
647 unsigned int board_idx = (unsigned int) ent->driver_data;
648 int pci_dev_busy = 0;
651 if (!printed_version++)
652 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
655 * If this driver happens to only be useful on Apple's K2, then
656 * we should check that here as it has a normal Serverworks ID
658 rc = pci_enable_device(pdev);
662 rc = pci_request_regions(pdev, DRV_NAME);
668 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
670 goto err_out_regions;
671 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
673 goto err_out_regions;
675 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
676 if (probe_ent == NULL) {
678 goto err_out_regions;
681 memset(probe_ent, 0, sizeof(*probe_ent));
682 probe_ent->dev = pci_dev_to_dev(pdev);
683 INIT_LIST_HEAD(&probe_ent->node);
685 mmio_base = pci_iomap(pdev, 3, 0);
686 if (mmio_base == NULL) {
688 goto err_out_free_ent;
690 base = (unsigned long) mmio_base;
692 probe_ent->sht = pdc_port_info[board_idx].sht;
693 probe_ent->host_flags = pdc_port_info[board_idx].host_flags;
694 probe_ent->pio_mask = pdc_port_info[board_idx].pio_mask;
695 probe_ent->mwdma_mask = pdc_port_info[board_idx].mwdma_mask;
696 probe_ent->udma_mask = pdc_port_info[board_idx].udma_mask;
697 probe_ent->port_ops = pdc_port_info[board_idx].port_ops;
699 probe_ent->irq = pdev->irq;
700 probe_ent->irq_flags = SA_SHIRQ;
701 probe_ent->mmio_base = mmio_base;
703 pdc_ata_setup_port(&probe_ent->port[0], base + 0x200);
704 pdc_ata_setup_port(&probe_ent->port[1], base + 0x280);
706 probe_ent->port[0].scr_addr = base + 0x400;
707 probe_ent->port[1].scr_addr = base + 0x500;
709 /* notice 4-port boards */
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;
721 probe_ent->n_ports = 2;
724 probe_ent->n_ports = 2;
727 probe_ent->n_ports = 4;
729 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
730 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
732 probe_ent->port[2].scr_addr = base + 0x600;
733 probe_ent->port[3].scr_addr = base + 0x700;
740 pci_set_master(pdev);
742 /* initialize adapter */
743 pdc_host_init(board_idx, probe_ent);
745 /* FIXME: check ata_device_add return value */
746 ata_device_add(probe_ent);
754 pci_release_regions(pdev);
757 pci_disable_device(pdev);
762 static int __init pdc_ata_init(void)
764 return pci_module_init(&pdc_ata_pci_driver);
768 static void __exit pdc_ata_exit(void)
770 pci_unregister_driver(&pdc_ata_pci_driver);
774 MODULE_AUTHOR("Jeff Garzik");
775 MODULE_DESCRIPTION("Promise ATA TX2/TX4/TX4000 low-level driver");
776 MODULE_LICENSE("GPL");
777 MODULE_DEVICE_TABLE(pci, pdc_ata_pci_tbl);
778 MODULE_VERSION(DRV_VERSION);
780 module_init(pdc_ata_init);
781 module_exit(pdc_ata_exit);