2 * sata_sil.c - Silicon Image SATA
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2005 Red Hat, Inc.
9 * Copyright 2003 Benjamin Herrenschmidt
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 * Documentation for SiI 3112:
31 * http://gkernel.sourceforge.net/specs/sii/3112A_SiI-DS-0095-B2.pdf.bz2
33 * Other errata and documentation available under NDA.
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/pci.h>
40 #include <linux/init.h>
41 #include <linux/blkdev.h>
42 #include <linux/delay.h>
43 #include <linux/interrupt.h>
44 #include <linux/device.h>
45 #include <scsi/scsi_host.h>
46 #include <linux/libata.h>
48 #define DRV_NAME "sata_sil"
49 #define DRV_VERSION "2.0"
55 SIL_FLAG_NO_SATA_IRQ = (1 << 28),
56 SIL_FLAG_RERR_ON_DMA_ACT = (1 << 29),
57 SIL_FLAG_MOD15WRITE = (1 << 30),
59 SIL_DFL_PORT_FLAGS = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
60 ATA_FLAG_MMIO | ATA_FLAG_HRST_TO_RESUME,
66 sil_3112_no_sata_irq = 1,
79 SIL_MASK_IDE0_INT = (1 << 22),
80 SIL_MASK_IDE1_INT = (1 << 23),
81 SIL_MASK_IDE2_INT = (1 << 24),
82 SIL_MASK_IDE3_INT = (1 << 25),
83 SIL_MASK_2PORT = SIL_MASK_IDE0_INT | SIL_MASK_IDE1_INT,
84 SIL_MASK_4PORT = SIL_MASK_2PORT |
85 SIL_MASK_IDE2_INT | SIL_MASK_IDE3_INT,
88 SIL_INTR_STEERING = (1 << 1),
90 SIL_DMA_ENABLE = (1 << 0), /* DMA run switch */
91 SIL_DMA_RDWR = (1 << 3), /* DMA Rd-Wr */
92 SIL_DMA_SATA_IRQ = (1 << 4), /* OR of all SATA IRQs */
93 SIL_DMA_ACTIVE = (1 << 16), /* DMA running */
94 SIL_DMA_ERROR = (1 << 17), /* PCI bus error */
95 SIL_DMA_COMPLETE = (1 << 18), /* cmd complete / IRQ pending */
96 SIL_DMA_N_SATA_IRQ = (1 << 6), /* SATA_IRQ for the next channel */
97 SIL_DMA_N_ACTIVE = (1 << 24), /* ACTIVE for the next channel */
98 SIL_DMA_N_ERROR = (1 << 25), /* ERROR for the next channel */
99 SIL_DMA_N_COMPLETE = (1 << 26), /* COMPLETE for the next channel */
102 SIL_SIEN_N = (1 << 16), /* triggered by SError.N */
107 SIL_QUIRK_MOD15WRITE = (1 << 0),
108 SIL_QUIRK_UDMA5MAX = (1 << 1),
111 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
113 static int sil_pci_device_resume(struct pci_dev *pdev);
115 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev);
116 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg);
117 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
118 static void sil_post_set_mode (struct ata_port *ap);
119 static irqreturn_t sil_interrupt(int irq, void *dev_instance);
120 static void sil_freeze(struct ata_port *ap);
121 static void sil_thaw(struct ata_port *ap);
124 static const struct pci_device_id sil_pci_tbl[] = {
125 { PCI_VDEVICE(CMD, 0x3112), sil_3112 },
126 { PCI_VDEVICE(CMD, 0x0240), sil_3112 },
127 { PCI_VDEVICE(CMD, 0x3512), sil_3512 },
128 { PCI_VDEVICE(CMD, 0x3114), sil_3114 },
129 { PCI_VDEVICE(ATI, 0x436e), sil_3112 },
130 { PCI_VDEVICE(ATI, 0x4379), sil_3112_no_sata_irq },
131 { PCI_VDEVICE(ATI, 0x437a), sil_3112_no_sata_irq },
133 { } /* terminate list */
137 /* TODO firmware versions should be added - eric */
138 static const struct sil_drivelist {
139 const char * product;
141 } sil_blacklist [] = {
142 { "ST320012AS", SIL_QUIRK_MOD15WRITE },
143 { "ST330013AS", SIL_QUIRK_MOD15WRITE },
144 { "ST340017AS", SIL_QUIRK_MOD15WRITE },
145 { "ST360015AS", SIL_QUIRK_MOD15WRITE },
146 { "ST380023AS", SIL_QUIRK_MOD15WRITE },
147 { "ST3120023AS", SIL_QUIRK_MOD15WRITE },
148 { "ST340014ASL", SIL_QUIRK_MOD15WRITE },
149 { "ST360014ASL", SIL_QUIRK_MOD15WRITE },
150 { "ST380011ASL", SIL_QUIRK_MOD15WRITE },
151 { "ST3120022ASL", SIL_QUIRK_MOD15WRITE },
152 { "ST3160021ASL", SIL_QUIRK_MOD15WRITE },
153 { "Maxtor 4D060H3", SIL_QUIRK_UDMA5MAX },
157 static struct pci_driver sil_pci_driver = {
159 .id_table = sil_pci_tbl,
160 .probe = sil_init_one,
161 .remove = ata_pci_remove_one,
163 .suspend = ata_pci_device_suspend,
164 .resume = sil_pci_device_resume,
168 static struct scsi_host_template sil_sht = {
169 .module = THIS_MODULE,
171 .ioctl = ata_scsi_ioctl,
172 .queuecommand = ata_scsi_queuecmd,
173 .can_queue = ATA_DEF_QUEUE,
174 .this_id = ATA_SHT_THIS_ID,
175 .sg_tablesize = LIBATA_MAX_PRD,
176 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
177 .emulated = ATA_SHT_EMULATED,
178 .use_clustering = ATA_SHT_USE_CLUSTERING,
179 .proc_name = DRV_NAME,
180 .dma_boundary = ATA_DMA_BOUNDARY,
181 .slave_configure = ata_scsi_slave_config,
182 .slave_destroy = ata_scsi_slave_destroy,
183 .bios_param = ata_std_bios_param,
184 .suspend = ata_scsi_device_suspend,
185 .resume = ata_scsi_device_resume,
188 static const struct ata_port_operations sil_ops = {
189 .port_disable = ata_port_disable,
190 .dev_config = sil_dev_config,
191 .tf_load = ata_tf_load,
192 .tf_read = ata_tf_read,
193 .check_status = ata_check_status,
194 .exec_command = ata_exec_command,
195 .dev_select = ata_std_dev_select,
196 .post_set_mode = sil_post_set_mode,
197 .bmdma_setup = ata_bmdma_setup,
198 .bmdma_start = ata_bmdma_start,
199 .bmdma_stop = ata_bmdma_stop,
200 .bmdma_status = ata_bmdma_status,
201 .qc_prep = ata_qc_prep,
202 .qc_issue = ata_qc_issue_prot,
203 .data_xfer = ata_mmio_data_xfer,
204 .freeze = sil_freeze,
206 .error_handler = ata_bmdma_error_handler,
207 .post_internal_cmd = ata_bmdma_post_internal_cmd,
208 .irq_handler = sil_interrupt,
209 .irq_clear = ata_bmdma_irq_clear,
210 .scr_read = sil_scr_read,
211 .scr_write = sil_scr_write,
212 .port_start = ata_port_start,
213 .port_stop = ata_port_stop,
214 .host_stop = ata_pci_host_stop,
217 static const struct ata_port_info sil_port_info[] = {
221 .flags = SIL_DFL_PORT_FLAGS | SIL_FLAG_MOD15WRITE,
222 .pio_mask = 0x1f, /* pio0-4 */
223 .mwdma_mask = 0x07, /* mwdma0-2 */
224 .udma_mask = 0x3f, /* udma0-5 */
225 .port_ops = &sil_ops,
227 /* sil_3112_no_sata_irq */
230 .flags = SIL_DFL_PORT_FLAGS | SIL_FLAG_MOD15WRITE |
231 SIL_FLAG_NO_SATA_IRQ,
232 .pio_mask = 0x1f, /* pio0-4 */
233 .mwdma_mask = 0x07, /* mwdma0-2 */
234 .udma_mask = 0x3f, /* udma0-5 */
235 .port_ops = &sil_ops,
240 .flags = SIL_DFL_PORT_FLAGS | SIL_FLAG_RERR_ON_DMA_ACT,
241 .pio_mask = 0x1f, /* pio0-4 */
242 .mwdma_mask = 0x07, /* mwdma0-2 */
243 .udma_mask = 0x3f, /* udma0-5 */
244 .port_ops = &sil_ops,
249 .flags = SIL_DFL_PORT_FLAGS | SIL_FLAG_RERR_ON_DMA_ACT,
250 .pio_mask = 0x1f, /* pio0-4 */
251 .mwdma_mask = 0x07, /* mwdma0-2 */
252 .udma_mask = 0x3f, /* udma0-5 */
253 .port_ops = &sil_ops,
257 /* per-port register offsets */
258 /* TODO: we can probably calculate rather than use a table */
259 static const struct {
260 unsigned long tf; /* ATA taskfile register block */
261 unsigned long ctl; /* ATA control/altstatus register block */
262 unsigned long bmdma; /* DMA register block */
263 unsigned long bmdma2; /* DMA register block #2 */
264 unsigned long fifo_cfg; /* FIFO Valid Byte Count and Control */
265 unsigned long scr; /* SATA control register block */
266 unsigned long sien; /* SATA Interrupt Enable register */
267 unsigned long xfer_mode;/* data transfer mode register */
268 unsigned long sfis_cfg; /* SATA FIS reception config register */
271 { 0x80, 0x8A, 0x00, 0x10, 0x40, 0x100, 0x148, 0xb4, 0x14c },
272 { 0xC0, 0xCA, 0x08, 0x18, 0x44, 0x180, 0x1c8, 0xf4, 0x1cc },
273 { 0x280, 0x28A, 0x200, 0x210, 0x240, 0x300, 0x348, 0x2b4, 0x34c },
274 { 0x2C0, 0x2CA, 0x208, 0x218, 0x244, 0x380, 0x3c8, 0x2f4, 0x3cc },
278 MODULE_AUTHOR("Jeff Garzik");
279 MODULE_DESCRIPTION("low-level driver for Silicon Image SATA controller");
280 MODULE_LICENSE("GPL");
281 MODULE_DEVICE_TABLE(pci, sil_pci_tbl);
282 MODULE_VERSION(DRV_VERSION);
284 static int slow_down = 0;
285 module_param(slow_down, int, 0444);
286 MODULE_PARM_DESC(slow_down, "Sledgehammer used to work around random problems, by limiting commands to 15 sectors (0=off, 1=on)");
289 static unsigned char sil_get_device_cache_line(struct pci_dev *pdev)
292 pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &cache_line);
296 static void sil_post_set_mode (struct ata_port *ap)
298 struct ata_host *host = ap->host;
299 struct ata_device *dev;
300 void __iomem *addr = host->mmio_base + sil_port[ap->port_no].xfer_mode;
301 u32 tmp, dev_mode[2];
304 for (i = 0; i < 2; i++) {
305 dev = &ap->device[i];
306 if (!ata_dev_enabled(dev))
307 dev_mode[i] = 0; /* PIO0/1/2 */
308 else if (dev->flags & ATA_DFLAG_PIO)
309 dev_mode[i] = 1; /* PIO3/4 */
311 dev_mode[i] = 3; /* UDMA */
312 /* value 2 indicates MDMA */
316 tmp &= ~((1<<5) | (1<<4) | (1<<1) | (1<<0));
318 tmp |= (dev_mode[1] << 4);
320 readl(addr); /* flush */
323 static inline unsigned long sil_scr_addr(struct ata_port *ap, unsigned int sc_reg)
325 unsigned long offset = ap->ioaddr.scr_addr;
342 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg)
344 void __iomem *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
350 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
352 void __iomem *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
357 static void sil_host_intr(struct ata_port *ap, u32 bmdma2)
359 struct ata_queued_cmd *qc = ata_qc_from_tag(ap, ap->active_tag);
362 if (unlikely(bmdma2 & SIL_DMA_SATA_IRQ)) {
365 /* SIEN doesn't mask SATA IRQs on some 3112s. Those
366 * controllers continue to assert IRQ as long as
367 * SError bits are pending. Clear SError immediately.
369 serror = sil_scr_read(ap, SCR_ERROR);
370 sil_scr_write(ap, SCR_ERROR, serror);
372 /* Trigger hotplug and accumulate SError only if the
373 * port isn't already frozen. Otherwise, PHY events
374 * during hardreset makes controllers with broken SIEN
375 * repeat probing needlessly.
377 if (!(ap->pflags & ATA_PFLAG_FROZEN)) {
378 ata_ehi_hotplugged(&ap->eh_info);
379 ap->eh_info.serror |= serror;
385 if (unlikely(!qc || qc->tf.ctl & ATA_NIEN))
388 /* Check whether we are expecting interrupt in this state */
389 switch (ap->hsm_task_state) {
391 /* Some pre-ATAPI-4 devices assert INTRQ
392 * at this state when ready to receive CDB.
395 /* Check the ATA_DFLAG_CDB_INTR flag is enough here.
396 * The flag was turned on only for atapi devices.
397 * No need to check is_atapi_taskfile(&qc->tf) again.
399 if (!(qc->dev->flags & ATA_DFLAG_CDB_INTR))
403 if (qc->tf.protocol == ATA_PROT_DMA ||
404 qc->tf.protocol == ATA_PROT_ATAPI_DMA) {
405 /* clear DMA-Start bit */
406 ap->ops->bmdma_stop(qc);
408 if (bmdma2 & SIL_DMA_ERROR) {
409 qc->err_mask |= AC_ERR_HOST_BUS;
410 ap->hsm_task_state = HSM_ST_ERR;
420 /* check main status, clearing INTRQ */
421 status = ata_chk_status(ap);
422 if (unlikely(status & ATA_BUSY))
425 /* ack bmdma irq events */
426 ata_bmdma_irq_clear(ap);
428 /* kick HSM in the ass */
429 ata_hsm_move(ap, qc, status, 0);
434 qc->err_mask |= AC_ERR_HSM;
439 static irqreturn_t sil_interrupt(int irq, void *dev_instance)
441 struct ata_host *host = dev_instance;
442 void __iomem *mmio_base = host->mmio_base;
446 spin_lock(&host->lock);
448 for (i = 0; i < host->n_ports; i++) {
449 struct ata_port *ap = host->ports[i];
450 u32 bmdma2 = readl(mmio_base + sil_port[ap->port_no].bmdma2);
452 if (unlikely(!ap || ap->flags & ATA_FLAG_DISABLED))
455 /* turn off SATA_IRQ if not supported */
456 if (ap->flags & SIL_FLAG_NO_SATA_IRQ)
457 bmdma2 &= ~SIL_DMA_SATA_IRQ;
459 if (bmdma2 == 0xffffffff ||
460 !(bmdma2 & (SIL_DMA_COMPLETE | SIL_DMA_SATA_IRQ)))
463 sil_host_intr(ap, bmdma2);
467 spin_unlock(&host->lock);
469 return IRQ_RETVAL(handled);
472 static void sil_freeze(struct ata_port *ap)
474 void __iomem *mmio_base = ap->host->mmio_base;
477 /* global IRQ mask doesn't block SATA IRQ, turn off explicitly */
478 writel(0, mmio_base + sil_port[ap->port_no].sien);
481 tmp = readl(mmio_base + SIL_SYSCFG);
482 tmp |= SIL_MASK_IDE0_INT << ap->port_no;
483 writel(tmp, mmio_base + SIL_SYSCFG);
484 readl(mmio_base + SIL_SYSCFG); /* flush */
487 static void sil_thaw(struct ata_port *ap)
489 void __iomem *mmio_base = ap->host->mmio_base;
494 ata_bmdma_irq_clear(ap);
496 /* turn on SATA IRQ if supported */
497 if (!(ap->flags & SIL_FLAG_NO_SATA_IRQ))
498 writel(SIL_SIEN_N, mmio_base + sil_port[ap->port_no].sien);
501 tmp = readl(mmio_base + SIL_SYSCFG);
502 tmp &= ~(SIL_MASK_IDE0_INT << ap->port_no);
503 writel(tmp, mmio_base + SIL_SYSCFG);
507 * sil_dev_config - Apply device/host-specific errata fixups
508 * @ap: Port containing device to be examined
509 * @dev: Device to be examined
511 * After the IDENTIFY [PACKET] DEVICE step is complete, and a
512 * device is known to be present, this function is called.
513 * We apply two errata fixups which are specific to Silicon Image,
514 * a Seagate and a Maxtor fixup.
516 * For certain Seagate devices, we must limit the maximum sectors
519 * For certain Maxtor devices, we must not program the drive
522 * Both fixups are unfairly pessimistic. As soon as I get more
523 * information on these errata, I will create a more exhaustive
524 * list, and apply the fixups to only the specific
525 * devices/hosts/firmwares that need it.
527 * 20040111 - Seagate drives affected by the Mod15Write bug are blacklisted
528 * The Maxtor quirk is in the blacklist, but I'm keeping the original
529 * pessimistic fix for the following reasons...
530 * - There seems to be less info on it, only one device gleaned off the
531 * Windows driver, maybe only one is affected. More info would be greatly
533 * - But then again UDMA5 is hardly anything to complain about
535 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev)
537 unsigned int n, quirks = 0;
538 unsigned char model_num[41];
540 ata_id_c_string(dev->id, model_num, ATA_ID_PROD_OFS, sizeof(model_num));
542 for (n = 0; sil_blacklist[n].product; n++)
543 if (!strcmp(sil_blacklist[n].product, model_num)) {
544 quirks = sil_blacklist[n].quirk;
548 /* limit requests to 15 sectors */
550 ((ap->flags & SIL_FLAG_MOD15WRITE) &&
551 (quirks & SIL_QUIRK_MOD15WRITE))) {
552 ata_dev_printk(dev, KERN_INFO, "applying Seagate errata fix "
553 "(mod15write workaround)\n");
554 dev->max_sectors = 15;
559 if (quirks & SIL_QUIRK_UDMA5MAX) {
560 ata_dev_printk(dev, KERN_INFO,
561 "applying Maxtor errata fix %s\n", model_num);
562 dev->udma_mask &= ATA_UDMA5;
567 static void sil_init_controller(struct pci_dev *pdev,
568 int n_ports, unsigned long port_flags,
569 void __iomem *mmio_base)
575 /* Initialize FIFO PCI bus arbitration */
576 cls = sil_get_device_cache_line(pdev);
579 cls++; /* cls = (line_size/8)+1 */
580 for (i = 0; i < n_ports; i++)
581 writew(cls << 8 | cls,
582 mmio_base + sil_port[i].fifo_cfg);
584 dev_printk(KERN_WARNING, &pdev->dev,
585 "cache line size not set. Driver may not function\n");
587 /* Apply R_ERR on DMA activate FIS errata workaround */
588 if (port_flags & SIL_FLAG_RERR_ON_DMA_ACT) {
591 for (i = 0, cnt = 0; i < n_ports; i++) {
592 tmp = readl(mmio_base + sil_port[i].sfis_cfg);
593 if ((tmp & 0x3) != 0x01)
596 dev_printk(KERN_INFO, &pdev->dev,
597 "Applying R_ERR on DMA activate "
599 writel(tmp & ~0x3, mmio_base + sil_port[i].sfis_cfg);
605 /* flip the magic "make 4 ports work" bit */
606 tmp = readl(mmio_base + sil_port[2].bmdma);
607 if ((tmp & SIL_INTR_STEERING) == 0)
608 writel(tmp | SIL_INTR_STEERING,
609 mmio_base + sil_port[2].bmdma);
613 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
615 static int printed_version;
616 struct ata_probe_ent *probe_ent = NULL;
618 void __iomem *mmio_base;
621 int pci_dev_busy = 0;
623 if (!printed_version++)
624 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
626 rc = pci_enable_device(pdev);
630 rc = pci_request_regions(pdev, DRV_NAME);
636 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
638 goto err_out_regions;
639 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
641 goto err_out_regions;
643 probe_ent = kzalloc(sizeof(*probe_ent), GFP_KERNEL);
644 if (probe_ent == NULL) {
646 goto err_out_regions;
649 INIT_LIST_HEAD(&probe_ent->node);
650 probe_ent->dev = pci_dev_to_dev(pdev);
651 probe_ent->port_ops = sil_port_info[ent->driver_data].port_ops;
652 probe_ent->sht = sil_port_info[ent->driver_data].sht;
653 probe_ent->n_ports = (ent->driver_data == sil_3114) ? 4 : 2;
654 probe_ent->pio_mask = sil_port_info[ent->driver_data].pio_mask;
655 probe_ent->mwdma_mask = sil_port_info[ent->driver_data].mwdma_mask;
656 probe_ent->udma_mask = sil_port_info[ent->driver_data].udma_mask;
657 probe_ent->irq = pdev->irq;
658 probe_ent->irq_flags = IRQF_SHARED;
659 probe_ent->port_flags = sil_port_info[ent->driver_data].flags;
661 mmio_base = pci_iomap(pdev, 5, 0);
662 if (mmio_base == NULL) {
664 goto err_out_free_ent;
667 probe_ent->mmio_base = mmio_base;
669 base = (unsigned long) mmio_base;
671 for (i = 0; i < probe_ent->n_ports; i++) {
672 probe_ent->port[i].cmd_addr = base + sil_port[i].tf;
673 probe_ent->port[i].altstatus_addr =
674 probe_ent->port[i].ctl_addr = base + sil_port[i].ctl;
675 probe_ent->port[i].bmdma_addr = base + sil_port[i].bmdma;
676 probe_ent->port[i].scr_addr = base + sil_port[i].scr;
677 ata_std_ports(&probe_ent->port[i]);
680 sil_init_controller(pdev, probe_ent->n_ports, probe_ent->port_flags,
683 pci_set_master(pdev);
685 /* FIXME: check ata_device_add return value */
686 ata_device_add(probe_ent);
694 pci_release_regions(pdev);
697 pci_disable_device(pdev);
702 static int sil_pci_device_resume(struct pci_dev *pdev)
704 struct ata_host *host = dev_get_drvdata(&pdev->dev);
706 ata_pci_device_do_resume(pdev);
707 sil_init_controller(pdev, host->n_ports, host->ports[0]->flags,
709 ata_host_resume(host);
715 static int __init sil_init(void)
717 return pci_register_driver(&sil_pci_driver);
720 static void __exit sil_exit(void)
722 pci_unregister_driver(&sil_pci_driver);
726 module_init(sil_init);
727 module_exit(sil_exit);