2 * sata_nv.c - NVIDIA nForce SATA
4 * Copyright 2004 NVIDIA Corp. All rights reserved.
5 * Copyright 2004 Andrew Chew
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2, or (at your option)
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; see the file COPYING. If not, write to
20 * the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23 * libata documentation is available via 'make {ps|pdf}docs',
24 * as Documentation/DocBook/libata.*
26 * No hardware documentation available outside of NVIDIA.
27 * This driver programs the NVIDIA SATA controller in a similar
28 * fashion as with other PCI IDE BMDMA controllers, with a few
29 * NV-specific details such as register offsets, SATA phy location,
33 * - Fixed spurious interrupts issue seen with the Maxtor 6H500F0 500GB
34 * drive. Also made the check_hotplug() callbacks return whether there
35 * was a hotplug interrupt or not. This was not the source of the
36 * spurious interrupts, but is the right thing to do anyway.
39 * - Fixed bug introduced by 0.08's MCP51 and MCP55 support.
42 * - Added support for MCP51 and MCP55.
45 * - Added support for RAID class code.
48 * - Added generic SATA support by using a pci_device_id that filters on
49 * the IDE storage class code.
52 * - Fixed a bug where the hotplug handlers for non-CK804/MCP04 were using
53 * mmio_base, which is only set for the CK804/MCP04 case.
56 * - Added support for CK804 SATA controller.
62 #include <linux/config.h>
63 #include <linux/kernel.h>
64 #include <linux/module.h>
65 #include <linux/pci.h>
66 #include <linux/init.h>
67 #include <linux/blkdev.h>
68 #include <linux/delay.h>
69 #include <linux/interrupt.h>
70 #include <linux/device.h>
71 #include <scsi/scsi_host.h>
72 #include <linux/libata.h>
74 #define DRV_NAME "sata_nv"
75 #define DRV_VERSION "0.8"
78 #define NV_PIO_MASK 0x1f
79 #define NV_MWDMA_MASK 0x07
80 #define NV_UDMA_MASK 0x7f
81 #define NV_PORT0_SCR_REG_OFFSET 0x00
82 #define NV_PORT1_SCR_REG_OFFSET 0x40
84 #define NV_INT_STATUS 0x10
85 #define NV_INT_STATUS_CK804 0x440
86 #define NV_INT_STATUS_PDEV_INT 0x01
87 #define NV_INT_STATUS_PDEV_PM 0x02
88 #define NV_INT_STATUS_PDEV_ADDED 0x04
89 #define NV_INT_STATUS_PDEV_REMOVED 0x08
90 #define NV_INT_STATUS_SDEV_INT 0x10
91 #define NV_INT_STATUS_SDEV_PM 0x20
92 #define NV_INT_STATUS_SDEV_ADDED 0x40
93 #define NV_INT_STATUS_SDEV_REMOVED 0x80
94 #define NV_INT_STATUS_PDEV_HOTPLUG (NV_INT_STATUS_PDEV_ADDED | \
95 NV_INT_STATUS_PDEV_REMOVED)
96 #define NV_INT_STATUS_SDEV_HOTPLUG (NV_INT_STATUS_SDEV_ADDED | \
97 NV_INT_STATUS_SDEV_REMOVED)
98 #define NV_INT_STATUS_HOTPLUG (NV_INT_STATUS_PDEV_HOTPLUG | \
99 NV_INT_STATUS_SDEV_HOTPLUG)
101 #define NV_INT_ENABLE 0x11
102 #define NV_INT_ENABLE_CK804 0x441
103 #define NV_INT_ENABLE_PDEV_MASK 0x01
104 #define NV_INT_ENABLE_PDEV_PM 0x02
105 #define NV_INT_ENABLE_PDEV_ADDED 0x04
106 #define NV_INT_ENABLE_PDEV_REMOVED 0x08
107 #define NV_INT_ENABLE_SDEV_MASK 0x10
108 #define NV_INT_ENABLE_SDEV_PM 0x20
109 #define NV_INT_ENABLE_SDEV_ADDED 0x40
110 #define NV_INT_ENABLE_SDEV_REMOVED 0x80
111 #define NV_INT_ENABLE_PDEV_HOTPLUG (NV_INT_ENABLE_PDEV_ADDED | \
112 NV_INT_ENABLE_PDEV_REMOVED)
113 #define NV_INT_ENABLE_SDEV_HOTPLUG (NV_INT_ENABLE_SDEV_ADDED | \
114 NV_INT_ENABLE_SDEV_REMOVED)
115 #define NV_INT_ENABLE_HOTPLUG (NV_INT_ENABLE_PDEV_HOTPLUG | \
116 NV_INT_ENABLE_SDEV_HOTPLUG)
118 #define NV_INT_CONFIG 0x12
119 #define NV_INT_CONFIG_METHD 0x01 // 0 = INT, 1 = SMI
121 // For PCI config register 20
122 #define NV_MCP_SATA_CFG_20 0x50
123 #define NV_MCP_SATA_CFG_20_SATA_SPACE_EN 0x04
125 static int nv_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
126 static irqreturn_t nv_interrupt (int irq, void *dev_instance,
127 struct pt_regs *regs);
128 static u32 nv_scr_read (struct ata_port *ap, unsigned int sc_reg);
129 static void nv_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
130 static void nv_host_stop (struct ata_host_set *host_set);
131 static void nv_enable_hotplug(struct ata_probe_ent *probe_ent);
132 static void nv_disable_hotplug(struct ata_host_set *host_set);
133 static int nv_check_hotplug(struct ata_host_set *host_set);
134 static void nv_enable_hotplug_ck804(struct ata_probe_ent *probe_ent);
135 static void nv_disable_hotplug_ck804(struct ata_host_set *host_set);
136 static int nv_check_hotplug_ck804(struct ata_host_set *host_set);
146 static const struct pci_device_id nv_pci_tbl[] = {
147 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2S_SATA,
148 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE2 },
149 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SATA,
150 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE3 },
151 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SATA2,
152 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE3 },
153 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_CK804_SATA,
154 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
155 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_CK804_SATA2,
156 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
157 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP04_SATA,
158 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
159 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP04_SATA2,
160 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
161 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP51_SATA,
162 PCI_ANY_ID, PCI_ANY_ID, 0, 0, GENERIC },
163 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP51_SATA2,
164 PCI_ANY_ID, PCI_ANY_ID, 0, 0, GENERIC },
165 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP55_SATA,
166 PCI_ANY_ID, PCI_ANY_ID, 0, 0, GENERIC },
167 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP55_SATA2,
168 PCI_ANY_ID, PCI_ANY_ID, 0, 0, GENERIC },
169 { PCI_VENDOR_ID_NVIDIA, PCI_ANY_ID,
170 PCI_ANY_ID, PCI_ANY_ID,
171 PCI_CLASS_STORAGE_IDE<<8, 0xffff00, GENERIC },
172 { PCI_VENDOR_ID_NVIDIA, PCI_ANY_ID,
173 PCI_ANY_ID, PCI_ANY_ID,
174 PCI_CLASS_STORAGE_RAID<<8, 0xffff00, GENERIC },
175 { 0, } /* terminate list */
178 #define NV_HOST_FLAGS_SCR_MMIO 0x00000001
182 enum nv_host_type host_type;
183 void (*enable_hotplug)(struct ata_probe_ent *probe_ent);
184 void (*disable_hotplug)(struct ata_host_set *host_set);
185 int (*check_hotplug)(struct ata_host_set *host_set);
188 static struct nv_host_desc nv_device_tbl[] = {
190 .host_type = GENERIC,
191 .enable_hotplug = NULL,
192 .disable_hotplug= NULL,
193 .check_hotplug = NULL,
196 .host_type = NFORCE2,
197 .enable_hotplug = nv_enable_hotplug,
198 .disable_hotplug= nv_disable_hotplug,
199 .check_hotplug = nv_check_hotplug,
202 .host_type = NFORCE3,
203 .enable_hotplug = nv_enable_hotplug,
204 .disable_hotplug= nv_disable_hotplug,
205 .check_hotplug = nv_check_hotplug,
207 { .host_type = CK804,
208 .enable_hotplug = nv_enable_hotplug_ck804,
209 .disable_hotplug= nv_disable_hotplug_ck804,
210 .check_hotplug = nv_check_hotplug_ck804,
216 struct nv_host_desc *host_desc;
217 unsigned long host_flags;
220 static struct pci_driver nv_pci_driver = {
222 .id_table = nv_pci_tbl,
223 .probe = nv_init_one,
224 .remove = ata_pci_remove_one,
227 static struct scsi_host_template nv_sht = {
228 .module = THIS_MODULE,
230 .ioctl = ata_scsi_ioctl,
231 .queuecommand = ata_scsi_queuecmd,
232 .eh_strategy_handler = ata_scsi_error,
233 .can_queue = ATA_DEF_QUEUE,
234 .this_id = ATA_SHT_THIS_ID,
235 .sg_tablesize = LIBATA_MAX_PRD,
236 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
237 .emulated = ATA_SHT_EMULATED,
238 .use_clustering = ATA_SHT_USE_CLUSTERING,
239 .proc_name = DRV_NAME,
240 .dma_boundary = ATA_DMA_BOUNDARY,
241 .slave_configure = ata_scsi_slave_config,
242 .bios_param = ata_std_bios_param,
245 static const struct ata_port_operations nv_ops = {
246 .port_disable = ata_port_disable,
247 .tf_load = ata_tf_load,
248 .tf_read = ata_tf_read,
249 .exec_command = ata_exec_command,
250 .check_status = ata_check_status,
251 .dev_select = ata_std_dev_select,
252 .phy_reset = sata_phy_reset,
253 .bmdma_setup = ata_bmdma_setup,
254 .bmdma_start = ata_bmdma_start,
255 .bmdma_stop = ata_bmdma_stop,
256 .bmdma_status = ata_bmdma_status,
257 .qc_prep = ata_qc_prep,
258 .qc_issue = ata_qc_issue_prot,
259 .eng_timeout = ata_eng_timeout,
260 .irq_handler = nv_interrupt,
261 .irq_clear = ata_bmdma_irq_clear,
262 .scr_read = nv_scr_read,
263 .scr_write = nv_scr_write,
264 .port_start = ata_port_start,
265 .port_stop = ata_port_stop,
266 .host_stop = nv_host_stop,
269 /* FIXME: The hardware provides the necessary SATA PHY controls
270 * to support ATA_FLAG_SATA_RESET. However, it is currently
271 * necessary to disable that flag, to solve misdetection problems.
272 * See http://bugme.osdl.org/show_bug.cgi?id=3352 for more info.
274 * This problem really needs to be investigated further. But in the
275 * meantime, we avoid ATA_FLAG_SATA_RESET to get people working.
277 static struct ata_port_info nv_port_info = {
279 .host_flags = ATA_FLAG_SATA |
280 /* ATA_FLAG_SATA_RESET | */
283 .pio_mask = NV_PIO_MASK,
284 .mwdma_mask = NV_MWDMA_MASK,
285 .udma_mask = NV_UDMA_MASK,
289 MODULE_AUTHOR("NVIDIA");
290 MODULE_DESCRIPTION("low-level driver for NVIDIA nForce SATA controller");
291 MODULE_LICENSE("GPL");
292 MODULE_DEVICE_TABLE(pci, nv_pci_tbl);
293 MODULE_VERSION(DRV_VERSION);
295 static irqreturn_t nv_interrupt (int irq, void *dev_instance,
296 struct pt_regs *regs)
298 struct ata_host_set *host_set = dev_instance;
299 struct nv_host *host = host_set->private_data;
301 unsigned int handled = 0;
304 spin_lock_irqsave(&host_set->lock, flags);
306 for (i = 0; i < host_set->n_ports; i++) {
309 ap = host_set->ports[i];
311 !(ap->flags & (ATA_FLAG_PORT_DISABLED | ATA_FLAG_NOINTR))) {
312 struct ata_queued_cmd *qc;
314 qc = ata_qc_from_tag(ap, ap->active_tag);
315 if (qc && (!(qc->tf.ctl & ATA_NIEN)))
316 handled += ata_host_intr(ap, qc);
318 // No request pending? Clear interrupt status
319 // anyway, in case there's one pending.
320 ap->ops->check_status(ap);
325 if (host->host_desc->check_hotplug)
326 handled += host->host_desc->check_hotplug(host_set);
328 spin_unlock_irqrestore(&host_set->lock, flags);
330 return IRQ_RETVAL(handled);
333 static u32 nv_scr_read (struct ata_port *ap, unsigned int sc_reg)
335 struct ata_host_set *host_set = ap->host_set;
336 struct nv_host *host = host_set->private_data;
338 if (sc_reg > SCR_CONTROL)
341 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
342 return readl((void __iomem *)ap->ioaddr.scr_addr + (sc_reg * 4));
344 return inl(ap->ioaddr.scr_addr + (sc_reg * 4));
347 static void nv_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
349 struct ata_host_set *host_set = ap->host_set;
350 struct nv_host *host = host_set->private_data;
352 if (sc_reg > SCR_CONTROL)
355 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
356 writel(val, (void __iomem *)ap->ioaddr.scr_addr + (sc_reg * 4));
358 outl(val, ap->ioaddr.scr_addr + (sc_reg * 4));
361 static void nv_host_stop (struct ata_host_set *host_set)
363 struct nv_host *host = host_set->private_data;
364 struct pci_dev *pdev = to_pci_dev(host_set->dev);
366 // Disable hotplug event interrupts.
367 if (host->host_desc->disable_hotplug)
368 host->host_desc->disable_hotplug(host_set);
372 if (host_set->mmio_base)
373 pci_iounmap(pdev, host_set->mmio_base);
376 static int nv_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
378 static int printed_version = 0;
379 struct nv_host *host;
380 struct ata_port_info *ppi;
381 struct ata_probe_ent *probe_ent;
382 int pci_dev_busy = 0;
386 // Make sure this is a SATA controller by counting the number of bars
387 // (NVIDIA SATA controllers will always have six bars). Otherwise,
388 // it's an IDE controller and we ignore it.
389 for (bar=0; bar<6; bar++)
390 if (pci_resource_start(pdev, bar) == 0)
393 if (!printed_version++)
394 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
396 rc = pci_enable_device(pdev);
400 rc = pci_request_regions(pdev, DRV_NAME);
403 goto err_out_disable;
406 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
408 goto err_out_regions;
409 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
411 goto err_out_regions;
416 probe_ent = ata_pci_init_native_mode(pdev, &ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
418 goto err_out_regions;
420 host = kmalloc(sizeof(struct nv_host), GFP_KERNEL);
422 goto err_out_free_ent;
424 memset(host, 0, sizeof(struct nv_host));
425 host->host_desc = &nv_device_tbl[ent->driver_data];
427 probe_ent->private_data = host;
429 if (pci_resource_flags(pdev, 5) & IORESOURCE_MEM)
430 host->host_flags |= NV_HOST_FLAGS_SCR_MMIO;
432 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO) {
435 probe_ent->mmio_base = pci_iomap(pdev, 5, 0);
436 if (probe_ent->mmio_base == NULL) {
438 goto err_out_free_host;
441 base = (unsigned long)probe_ent->mmio_base;
443 probe_ent->port[0].scr_addr =
444 base + NV_PORT0_SCR_REG_OFFSET;
445 probe_ent->port[1].scr_addr =
446 base + NV_PORT1_SCR_REG_OFFSET;
449 probe_ent->port[0].scr_addr =
450 pci_resource_start(pdev, 5) | NV_PORT0_SCR_REG_OFFSET;
451 probe_ent->port[1].scr_addr =
452 pci_resource_start(pdev, 5) | NV_PORT1_SCR_REG_OFFSET;
455 pci_set_master(pdev);
457 rc = ata_device_add(probe_ent);
459 goto err_out_iounmap;
461 // Enable hotplug event interrupts.
462 if (host->host_desc->enable_hotplug)
463 host->host_desc->enable_hotplug(probe_ent);
470 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
471 pci_iounmap(pdev, probe_ent->mmio_base);
477 pci_release_regions(pdev);
480 pci_disable_device(pdev);
485 static void nv_enable_hotplug(struct ata_probe_ent *probe_ent)
489 outb(NV_INT_STATUS_HOTPLUG,
490 probe_ent->port[0].scr_addr + NV_INT_STATUS);
492 intr_mask = inb(probe_ent->port[0].scr_addr + NV_INT_ENABLE);
493 intr_mask |= NV_INT_ENABLE_HOTPLUG;
495 outb(intr_mask, probe_ent->port[0].scr_addr + NV_INT_ENABLE);
498 static void nv_disable_hotplug(struct ata_host_set *host_set)
502 intr_mask = inb(host_set->ports[0]->ioaddr.scr_addr + NV_INT_ENABLE);
504 intr_mask &= ~(NV_INT_ENABLE_HOTPLUG);
506 outb(intr_mask, host_set->ports[0]->ioaddr.scr_addr + NV_INT_ENABLE);
509 static int nv_check_hotplug(struct ata_host_set *host_set)
513 intr_status = inb(host_set->ports[0]->ioaddr.scr_addr + NV_INT_STATUS);
515 // Clear interrupt status.
516 outb(0xff, host_set->ports[0]->ioaddr.scr_addr + NV_INT_STATUS);
518 if (intr_status & NV_INT_STATUS_HOTPLUG) {
519 if (intr_status & NV_INT_STATUS_PDEV_ADDED)
520 printk(KERN_WARNING "nv_sata: "
521 "Primary device added\n");
523 if (intr_status & NV_INT_STATUS_PDEV_REMOVED)
524 printk(KERN_WARNING "nv_sata: "
525 "Primary device removed\n");
527 if (intr_status & NV_INT_STATUS_SDEV_ADDED)
528 printk(KERN_WARNING "nv_sata: "
529 "Secondary device added\n");
531 if (intr_status & NV_INT_STATUS_SDEV_REMOVED)
532 printk(KERN_WARNING "nv_sata: "
533 "Secondary device removed\n");
541 static void nv_enable_hotplug_ck804(struct ata_probe_ent *probe_ent)
543 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
547 pci_read_config_byte(pdev, NV_MCP_SATA_CFG_20, ®val);
548 regval |= NV_MCP_SATA_CFG_20_SATA_SPACE_EN;
549 pci_write_config_byte(pdev, NV_MCP_SATA_CFG_20, regval);
551 writeb(NV_INT_STATUS_HOTPLUG, probe_ent->mmio_base + NV_INT_STATUS_CK804);
553 intr_mask = readb(probe_ent->mmio_base + NV_INT_ENABLE_CK804);
554 intr_mask |= NV_INT_ENABLE_HOTPLUG;
556 writeb(intr_mask, probe_ent->mmio_base + NV_INT_ENABLE_CK804);
559 static void nv_disable_hotplug_ck804(struct ata_host_set *host_set)
561 struct pci_dev *pdev = to_pci_dev(host_set->dev);
565 intr_mask = readb(host_set->mmio_base + NV_INT_ENABLE_CK804);
567 intr_mask &= ~(NV_INT_ENABLE_HOTPLUG);
569 writeb(intr_mask, host_set->mmio_base + NV_INT_ENABLE_CK804);
571 pci_read_config_byte(pdev, NV_MCP_SATA_CFG_20, ®val);
572 regval &= ~NV_MCP_SATA_CFG_20_SATA_SPACE_EN;
573 pci_write_config_byte(pdev, NV_MCP_SATA_CFG_20, regval);
576 static int nv_check_hotplug_ck804(struct ata_host_set *host_set)
580 intr_status = readb(host_set->mmio_base + NV_INT_STATUS_CK804);
582 // Clear interrupt status.
583 writeb(0xff, host_set->mmio_base + NV_INT_STATUS_CK804);
585 if (intr_status & NV_INT_STATUS_HOTPLUG) {
586 if (intr_status & NV_INT_STATUS_PDEV_ADDED)
587 printk(KERN_WARNING "nv_sata: "
588 "Primary device added\n");
590 if (intr_status & NV_INT_STATUS_PDEV_REMOVED)
591 printk(KERN_WARNING "nv_sata: "
592 "Primary device removed\n");
594 if (intr_status & NV_INT_STATUS_SDEV_ADDED)
595 printk(KERN_WARNING "nv_sata: "
596 "Secondary device added\n");
598 if (intr_status & NV_INT_STATUS_SDEV_REMOVED)
599 printk(KERN_WARNING "nv_sata: "
600 "Secondary device removed\n");
608 static int __init nv_init(void)
610 return pci_module_init(&nv_pci_driver);
613 static void __exit nv_exit(void)
615 pci_unregister_driver(&nv_pci_driver);
618 module_init(nv_init);
619 module_exit(nv_exit);