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>
42 #include <scsi/scsi_host.h>
43 #include <linux/libata.h>
45 #include "sata_promise.h"
47 #define DRV_NAME "sata_promise"
48 #define DRV_VERSION "1.02"
52 PDC_PKT_SUBMIT = 0x40, /* Command packet pointer addr */
53 PDC_INT_SEQMASK = 0x40, /* Mask of asserted SEQ INTs */
54 PDC_TBG_MODE = 0x41, /* TBG mode */
55 PDC_FLASH_CTL = 0x44, /* Flash control register */
56 PDC_PCI_CTL = 0x48, /* PCI control and status register */
57 PDC_GLOBAL_CTL = 0x48, /* Global control/status (per port) */
58 PDC_CTLSTAT = 0x60, /* IDE control and status (per port) */
59 PDC_SATA_PLUG_CSR = 0x6C, /* SATA Plug control/status reg */
60 PDC_SLEW_CTL = 0x470, /* slew rate control reg */
62 PDC_ERR_MASK = (1<<19) | (1<<20) | (1<<21) | (1<<22) |
63 (1<<8) | (1<<9) | (1<<10),
65 board_2037x = 0, /* FastTrak S150 TX2plus */
66 board_20319 = 1, /* FastTrak S150 TX4 */
67 board_20619 = 2, /* FastTrak TX4000 */
69 PDC_HAS_PATA = (1 << 1), /* PDC20375 has PATA */
71 PDC_RESET = (1 << 11), /* HDMA reset */
75 struct pdc_port_priv {
80 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg);
81 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
82 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
83 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs);
84 static void pdc_eng_timeout(struct ata_port *ap);
85 static int pdc_port_start(struct ata_port *ap);
86 static void pdc_port_stop(struct ata_port *ap);
87 static void pdc_pata_phy_reset(struct ata_port *ap);
88 static void pdc_sata_phy_reset(struct ata_port *ap);
89 static void pdc_qc_prep(struct ata_queued_cmd *qc);
90 static void pdc_tf_load_mmio(struct ata_port *ap, struct ata_taskfile *tf);
91 static void pdc_exec_command_mmio(struct ata_port *ap, struct ata_taskfile *tf);
92 static void pdc_irq_clear(struct ata_port *ap);
93 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc);
95 static Scsi_Host_Template pdc_ata_sht = {
96 .module = THIS_MODULE,
98 .ioctl = ata_scsi_ioctl,
99 .queuecommand = ata_scsi_queuecmd,
100 .eh_strategy_handler = ata_scsi_error,
101 .can_queue = ATA_DEF_QUEUE,
102 .this_id = ATA_SHT_THIS_ID,
103 .sg_tablesize = LIBATA_MAX_PRD,
104 .max_sectors = ATA_MAX_SECTORS,
105 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
106 .emulated = ATA_SHT_EMULATED,
107 .use_clustering = ATA_SHT_USE_CLUSTERING,
108 .proc_name = DRV_NAME,
109 .dma_boundary = ATA_DMA_BOUNDARY,
110 .slave_configure = ata_scsi_slave_config,
111 .bios_param = ata_std_bios_param,
115 static struct ata_port_operations pdc_sata_ops = {
116 .port_disable = ata_port_disable,
117 .tf_load = pdc_tf_load_mmio,
118 .tf_read = ata_tf_read,
119 .check_status = ata_check_status,
120 .exec_command = pdc_exec_command_mmio,
121 .dev_select = ata_std_dev_select,
123 .phy_reset = pdc_sata_phy_reset,
125 .qc_prep = pdc_qc_prep,
126 .qc_issue = pdc_qc_issue_prot,
127 .eng_timeout = pdc_eng_timeout,
128 .irq_handler = pdc_interrupt,
129 .irq_clear = pdc_irq_clear,
131 .scr_read = pdc_sata_scr_read,
132 .scr_write = pdc_sata_scr_write,
133 .port_start = pdc_port_start,
134 .port_stop = pdc_port_stop,
135 .host_stop = ata_host_stop,
138 static struct ata_port_operations pdc_pata_ops = {
139 .port_disable = ata_port_disable,
140 .tf_load = pdc_tf_load_mmio,
141 .tf_read = ata_tf_read,
142 .check_status = ata_check_status,
143 .exec_command = pdc_exec_command_mmio,
144 .dev_select = ata_std_dev_select,
146 .phy_reset = pdc_pata_phy_reset,
148 .qc_prep = pdc_qc_prep,
149 .qc_issue = pdc_qc_issue_prot,
150 .eng_timeout = pdc_eng_timeout,
151 .irq_handler = pdc_interrupt,
152 .irq_clear = pdc_irq_clear,
154 .port_start = pdc_port_start,
155 .port_stop = pdc_port_stop,
156 .host_stop = ata_host_stop,
159 static struct ata_port_info pdc_port_info[] = {
163 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
164 ATA_FLAG_SRST | ATA_FLAG_MMIO,
165 .pio_mask = 0x1f, /* pio0-4 */
166 .mwdma_mask = 0x07, /* mwdma0-2 */
167 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
168 .port_ops = &pdc_sata_ops,
174 .host_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
175 ATA_FLAG_SRST | ATA_FLAG_MMIO,
176 .pio_mask = 0x1f, /* pio0-4 */
177 .mwdma_mask = 0x07, /* mwdma0-2 */
178 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
179 .port_ops = &pdc_sata_ops,
185 .host_flags = ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST |
186 ATA_FLAG_MMIO | ATA_FLAG_SLAVE_POSS,
187 .pio_mask = 0x1f, /* pio0-4 */
188 .mwdma_mask = 0x07, /* mwdma0-2 */
189 .udma_mask = 0x7f, /* udma0-6 ; FIXME */
190 .port_ops = &pdc_pata_ops,
194 static struct pci_device_id pdc_ata_pci_tbl[] = {
195 { PCI_VENDOR_ID_PROMISE, 0x3371, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
197 { PCI_VENDOR_ID_PROMISE, 0x3571, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
199 { PCI_VENDOR_ID_PROMISE, 0x3373, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
201 { PCI_VENDOR_ID_PROMISE, 0x3375, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
203 { PCI_VENDOR_ID_PROMISE, 0x3376, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
205 { PCI_VENDOR_ID_PROMISE, 0x3574, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
207 { PCI_VENDOR_ID_PROMISE, 0x3d75, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
210 { PCI_VENDOR_ID_PROMISE, 0x3318, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
212 { PCI_VENDOR_ID_PROMISE, 0x3319, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
214 { PCI_VENDOR_ID_PROMISE, 0x3519, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
216 { PCI_VENDOR_ID_PROMISE, 0x3d17, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
218 { PCI_VENDOR_ID_PROMISE, 0x3d18, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
221 { PCI_VENDOR_ID_PROMISE, 0x6629, PCI_ANY_ID, PCI_ANY_ID, 0, 0,
224 { } /* terminate list */
228 static struct pci_driver pdc_ata_pci_driver = {
230 .id_table = pdc_ata_pci_tbl,
231 .probe = pdc_ata_init_one,
232 .remove = ata_pci_remove_one,
236 static int pdc_port_start(struct ata_port *ap)
238 struct device *dev = ap->host_set->dev;
239 struct pdc_port_priv *pp;
242 rc = ata_port_start(ap);
246 pp = kmalloc(sizeof(*pp), GFP_KERNEL);
251 memset(pp, 0, sizeof(*pp));
253 pp->pkt = dma_alloc_coherent(dev, 128, &pp->pkt_dma, GFP_KERNEL);
259 ap->private_data = pp;
271 static void pdc_port_stop(struct ata_port *ap)
273 struct device *dev = ap->host_set->dev;
274 struct pdc_port_priv *pp = ap->private_data;
276 ap->private_data = NULL;
277 dma_free_coherent(dev, 128, pp->pkt, pp->pkt_dma);
283 static void pdc_reset_port(struct ata_port *ap)
285 void *mmio = (void *) ap->ioaddr.cmd_addr + PDC_CTLSTAT;
289 for (i = 11; i > 0; i--) {
302 readl(mmio); /* flush */
305 static void pdc_sata_phy_reset(struct ata_port *ap)
311 static void pdc_pata_phy_reset(struct ata_port *ap)
313 /* FIXME: add cable detect. Don't assume 40-pin cable */
314 ap->cbl = ATA_CBL_PATA40;
315 ap->udma_mask &= ATA_UDMA_MASK_40C;
322 static u32 pdc_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
324 if (sc_reg > SCR_CONTROL)
326 return readl((void *) ap->ioaddr.scr_addr + (sc_reg * 4));
330 static void pdc_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
333 if (sc_reg > SCR_CONTROL)
335 writel(val, (void *) ap->ioaddr.scr_addr + (sc_reg * 4));
338 static void pdc_qc_prep(struct ata_queued_cmd *qc)
340 struct pdc_port_priv *pp = qc->ap->private_data;
345 switch (qc->tf.protocol) {
350 case ATA_PROT_NODATA:
351 i = pdc_pkt_header(&qc->tf, qc->ap->prd_dma,
352 qc->dev->devno, pp->pkt);
354 if (qc->tf.flags & ATA_TFLAG_LBA48)
355 i = pdc_prep_lba48(&qc->tf, pp->pkt, i);
357 i = pdc_prep_lba28(&qc->tf, pp->pkt, i);
359 pdc_pkt_footer(&qc->tf, pp->pkt, i);
367 static void pdc_eng_timeout(struct ata_port *ap)
369 struct ata_host_set *host_set = ap->host_set;
371 struct ata_queued_cmd *qc;
376 spin_lock_irqsave(&host_set->lock, flags);
378 qc = ata_qc_from_tag(ap, ap->active_tag);
380 printk(KERN_ERR "ata%u: BUG: timeout without command\n",
385 /* hack alert! We cannot use the supplied completion
386 * function from inside the ->eh_strategy_handler() thread.
387 * libata is the only user of ->eh_strategy_handler() in
388 * any kernel, so the default scsi_done() assumes it is
389 * not being called from the SCSI EH.
391 qc->scsidone = scsi_finish_command;
393 switch (qc->tf.protocol) {
395 case ATA_PROT_NODATA:
396 printk(KERN_ERR "ata%u: command timeout\n", ap->id);
397 ata_qc_complete(qc, ata_wait_idle(ap) | ATA_ERR);
401 drv_stat = ata_busy_wait(ap, ATA_BUSY | ATA_DRQ, 1000);
403 printk(KERN_ERR "ata%u: unknown timeout, cmd 0x%x stat 0x%x\n",
404 ap->id, qc->tf.command, drv_stat);
406 ata_qc_complete(qc, drv_stat);
411 spin_unlock_irqrestore(&host_set->lock, flags);
415 static inline unsigned int pdc_host_intr( struct ata_port *ap,
416 struct ata_queued_cmd *qc)
419 unsigned int handled = 0, have_err = 0;
421 void *mmio = (void *) ap->ioaddr.cmd_addr + PDC_GLOBAL_CTL;
424 if (tmp & PDC_ERR_MASK) {
429 switch (qc->tf.protocol) {
431 case ATA_PROT_NODATA:
432 status = ata_wait_idle(ap);
435 ata_qc_complete(qc, status);
440 ap->stats.idle_irq++;
447 static void pdc_irq_clear(struct ata_port *ap)
449 struct ata_host_set *host_set = ap->host_set;
450 void *mmio = host_set->mmio_base;
452 readl(mmio + PDC_INT_SEQMASK);
455 static irqreturn_t pdc_interrupt (int irq, void *dev_instance, struct pt_regs *regs)
457 struct ata_host_set *host_set = dev_instance;
461 unsigned int handled = 0;
466 if (!host_set || !host_set->mmio_base) {
467 VPRINTK("QUICK EXIT\n");
471 mmio_base = host_set->mmio_base;
473 /* reading should also clear interrupts */
474 mask = readl(mmio_base + PDC_INT_SEQMASK);
476 if (mask == 0xffffffff) {
477 VPRINTK("QUICK EXIT 2\n");
480 mask &= 0xffff; /* only 16 tags possible */
482 VPRINTK("QUICK EXIT 3\n");
486 spin_lock(&host_set->lock);
488 writel(mask, mmio_base + PDC_INT_SEQMASK);
490 for (i = 0; i < host_set->n_ports; i++) {
491 VPRINTK("port %u\n", i);
492 ap = host_set->ports[i];
493 tmp = mask & (1 << (i + 1));
495 !(ap->flags & (ATA_FLAG_PORT_DISABLED | ATA_FLAG_NOINTR))) {
496 struct ata_queued_cmd *qc;
498 qc = ata_qc_from_tag(ap, ap->active_tag);
499 if (qc && (!(qc->tf.ctl & ATA_NIEN)))
500 handled += pdc_host_intr(ap, qc);
504 spin_unlock(&host_set->lock);
508 return IRQ_RETVAL(handled);
511 static inline void pdc_packet_start(struct ata_queued_cmd *qc)
513 struct ata_port *ap = qc->ap;
514 struct pdc_port_priv *pp = ap->private_data;
515 unsigned int port_no = ap->port_no;
516 u8 seq = (u8) (port_no + 1);
518 VPRINTK("ENTER, ap %p\n", ap);
520 writel(0x00000001, ap->host_set->mmio_base + (seq * 4));
521 readl(ap->host_set->mmio_base + (seq * 4)); /* flush */
524 wmb(); /* flush PRD, pkt writes */
525 writel(pp->pkt_dma, (void *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT);
526 readl((void *) ap->ioaddr.cmd_addr + PDC_PKT_SUBMIT); /* flush */
529 static int pdc_qc_issue_prot(struct ata_queued_cmd *qc)
531 switch (qc->tf.protocol) {
533 case ATA_PROT_NODATA:
534 pdc_packet_start(qc);
537 case ATA_PROT_ATAPI_DMA:
545 return ata_qc_issue_prot(qc);
548 static void pdc_tf_load_mmio(struct ata_port *ap, struct ata_taskfile *tf)
550 WARN_ON (tf->protocol == ATA_PROT_DMA ||
551 tf->protocol == ATA_PROT_NODATA);
556 static void pdc_exec_command_mmio(struct ata_port *ap, struct ata_taskfile *tf)
558 WARN_ON (tf->protocol == ATA_PROT_DMA ||
559 tf->protocol == ATA_PROT_NODATA);
560 ata_exec_command(ap, tf);
564 static void pdc_ata_setup_port(struct ata_ioports *port, unsigned long base)
566 port->cmd_addr = base;
567 port->data_addr = base;
569 port->error_addr = base + 0x4;
570 port->nsect_addr = base + 0x8;
571 port->lbal_addr = base + 0xc;
572 port->lbam_addr = base + 0x10;
573 port->lbah_addr = base + 0x14;
574 port->device_addr = base + 0x18;
576 port->status_addr = base + 0x1c;
577 port->altstatus_addr =
578 port->ctl_addr = base + 0x38;
582 static void pdc_host_init(unsigned int chip_id, struct ata_probe_ent *pe)
584 void *mmio = pe->mmio_base;
588 * Except for the hotplug stuff, this is voodoo from the
589 * Promise driver. Label this entire section
590 * "TODO: figure out why we do this"
593 /* change FIFO_SHD to 8 dwords, enable BMR_BURST */
594 tmp = readl(mmio + PDC_FLASH_CTL);
595 tmp |= 0x12000; /* bit 16 (fifo 8 dw) and 13 (bmr burst?) */
596 writel(tmp, mmio + PDC_FLASH_CTL);
598 /* clear plug/unplug flags for all ports */
599 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
600 writel(tmp | 0xff, mmio + PDC_SATA_PLUG_CSR);
602 /* mask plug/unplug ints */
603 tmp = readl(mmio + PDC_SATA_PLUG_CSR);
604 writel(tmp | 0xff0000, mmio + PDC_SATA_PLUG_CSR);
606 /* reduce TBG clock to 133 Mhz. */
607 tmp = readl(mmio + PDC_TBG_MODE);
608 tmp &= ~0x30000; /* clear bit 17, 16*/
609 tmp |= 0x10000; /* set bit 17:16 = 0:1 */
610 writel(tmp, mmio + PDC_TBG_MODE);
612 readl(mmio + PDC_TBG_MODE); /* flush */
615 /* adjust slew rate control register. */
616 tmp = readl(mmio + PDC_SLEW_CTL);
617 tmp &= 0xFFFFF03F; /* clear bit 11 ~ 6 */
618 tmp |= 0x00000900; /* set bit 11-9 = 100b , bit 8-6 = 100 */
619 writel(tmp, mmio + PDC_SLEW_CTL);
622 static int pdc_ata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
624 static int printed_version;
625 struct ata_probe_ent *probe_ent = NULL;
628 unsigned int board_idx = (unsigned int) ent->driver_data;
629 int pci_dev_busy = 0;
632 if (!printed_version++)
633 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
636 * If this driver happens to only be useful on Apple's K2, then
637 * we should check that here as it has a normal Serverworks ID
639 rc = pci_enable_device(pdev);
643 rc = pci_request_regions(pdev, DRV_NAME);
649 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
651 goto err_out_regions;
652 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
654 goto err_out_regions;
656 probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
657 if (probe_ent == NULL) {
659 goto err_out_regions;
662 memset(probe_ent, 0, sizeof(*probe_ent));
663 probe_ent->dev = pci_dev_to_dev(pdev);
664 INIT_LIST_HEAD(&probe_ent->node);
666 mmio_base = ioremap(pci_resource_start(pdev, 3),
667 pci_resource_len(pdev, 3));
668 if (mmio_base == NULL) {
670 goto err_out_free_ent;
672 base = (unsigned long) mmio_base;
674 probe_ent->sht = pdc_port_info[board_idx].sht;
675 probe_ent->host_flags = pdc_port_info[board_idx].host_flags;
676 probe_ent->pio_mask = pdc_port_info[board_idx].pio_mask;
677 probe_ent->mwdma_mask = pdc_port_info[board_idx].mwdma_mask;
678 probe_ent->udma_mask = pdc_port_info[board_idx].udma_mask;
679 probe_ent->port_ops = pdc_port_info[board_idx].port_ops;
681 probe_ent->irq = pdev->irq;
682 probe_ent->irq_flags = SA_SHIRQ;
683 probe_ent->mmio_base = mmio_base;
685 pdc_ata_setup_port(&probe_ent->port[0], base + 0x200);
686 pdc_ata_setup_port(&probe_ent->port[1], base + 0x280);
688 probe_ent->port[0].scr_addr = base + 0x400;
689 probe_ent->port[1].scr_addr = base + 0x500;
691 /* notice 4-port boards */
694 probe_ent->n_ports = 4;
696 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
697 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
699 probe_ent->port[2].scr_addr = base + 0x600;
700 probe_ent->port[3].scr_addr = base + 0x700;
703 probe_ent->n_ports = 2;
706 probe_ent->n_ports = 4;
708 pdc_ata_setup_port(&probe_ent->port[2], base + 0x300);
709 pdc_ata_setup_port(&probe_ent->port[3], base + 0x380);
711 probe_ent->port[2].scr_addr = base + 0x600;
712 probe_ent->port[3].scr_addr = base + 0x700;
719 pci_set_master(pdev);
721 /* initialize adapter */
722 pdc_host_init(board_idx, probe_ent);
724 /* FIXME: check ata_device_add return value */
725 ata_device_add(probe_ent);
733 pci_release_regions(pdev);
736 pci_disable_device(pdev);
741 static int __init pdc_ata_init(void)
743 return pci_module_init(&pdc_ata_pci_driver);
747 static void __exit pdc_ata_exit(void)
749 pci_unregister_driver(&pdc_ata_pci_driver);
753 MODULE_AUTHOR("Jeff Garzik");
754 MODULE_DESCRIPTION("Promise ATA TX2/TX4/TX4000 low-level driver");
755 MODULE_LICENSE("GPL");
756 MODULE_DEVICE_TABLE(pci, pdc_ata_pci_tbl);
757 MODULE_VERSION(DRV_VERSION);
759 module_init(pdc_ata_init);
760 module_exit(pdc_ata_exit);