blob: b0403ccd8a25d97aec9e220d175844dd45448076 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * sata_nv.c - NVIDIA nForce SATA
3 *
4 * Copyright 2004 NVIDIA Corp. All rights reserved.
5 * Copyright 2004 Andrew Chew
6 *
7 * The contents of this file are subject to the Open
8 * Software License version 1.1 that can be found at
9 * http://www.opensource.org/licenses/osl-1.1.txt and is included herein
10 * by reference.
11 *
12 * Alternatively, the contents of this file may be used under the terms
13 * of the GNU General Public License version 2 (the "GPL") as distributed
14 * in the kernel source COPYING file, in which case the provisions of
15 * the GPL are applicable instead of the above. If you wish to allow
16 * the use of your version of this file only under the terms of the
17 * GPL and not to allow others to use your version of this file under
18 * the OSL, indicate your decision by deleting the provisions above and
19 * replace them with the notice and other provisions required by the GPL.
20 * If you do not delete the provisions above, a recipient may use your
21 * version of this file under either the OSL or the GPL.
22 *
23 * 0.06
24 * - Added generic SATA support by using a pci_device_id that filters on
25 * the IDE storage class code.
26 *
27 * 0.03
28 * - Fixed a bug where the hotplug handlers for non-CK804/MCP04 were using
29 * mmio_base, which is only set for the CK804/MCP04 case.
30 *
31 * 0.02
32 * - Added support for CK804 SATA controller.
33 *
34 * 0.01
35 * - Initial revision.
36 */
37
38#include <linux/config.h>
39#include <linux/kernel.h>
40#include <linux/module.h>
41#include <linux/pci.h>
42#include <linux/init.h>
43#include <linux/blkdev.h>
44#include <linux/delay.h>
45#include <linux/interrupt.h>
46#include "scsi.h"
47#include <scsi/scsi_host.h>
48#include <linux/libata.h>
49
50#define DRV_NAME "sata_nv"
51#define DRV_VERSION "0.6"
52
53#define NV_PORTS 2
54#define NV_PIO_MASK 0x1f
55#define NV_MWDMA_MASK 0x07
56#define NV_UDMA_MASK 0x7f
57#define NV_PORT0_SCR_REG_OFFSET 0x00
58#define NV_PORT1_SCR_REG_OFFSET 0x40
59
60#define NV_INT_STATUS 0x10
61#define NV_INT_STATUS_CK804 0x440
62#define NV_INT_STATUS_PDEV_INT 0x01
63#define NV_INT_STATUS_PDEV_PM 0x02
64#define NV_INT_STATUS_PDEV_ADDED 0x04
65#define NV_INT_STATUS_PDEV_REMOVED 0x08
66#define NV_INT_STATUS_SDEV_INT 0x10
67#define NV_INT_STATUS_SDEV_PM 0x20
68#define NV_INT_STATUS_SDEV_ADDED 0x40
69#define NV_INT_STATUS_SDEV_REMOVED 0x80
70#define NV_INT_STATUS_PDEV_HOTPLUG (NV_INT_STATUS_PDEV_ADDED | \
71 NV_INT_STATUS_PDEV_REMOVED)
72#define NV_INT_STATUS_SDEV_HOTPLUG (NV_INT_STATUS_SDEV_ADDED | \
73 NV_INT_STATUS_SDEV_REMOVED)
74#define NV_INT_STATUS_HOTPLUG (NV_INT_STATUS_PDEV_HOTPLUG | \
75 NV_INT_STATUS_SDEV_HOTPLUG)
76
77#define NV_INT_ENABLE 0x11
78#define NV_INT_ENABLE_CK804 0x441
79#define NV_INT_ENABLE_PDEV_MASK 0x01
80#define NV_INT_ENABLE_PDEV_PM 0x02
81#define NV_INT_ENABLE_PDEV_ADDED 0x04
82#define NV_INT_ENABLE_PDEV_REMOVED 0x08
83#define NV_INT_ENABLE_SDEV_MASK 0x10
84#define NV_INT_ENABLE_SDEV_PM 0x20
85#define NV_INT_ENABLE_SDEV_ADDED 0x40
86#define NV_INT_ENABLE_SDEV_REMOVED 0x80
87#define NV_INT_ENABLE_PDEV_HOTPLUG (NV_INT_ENABLE_PDEV_ADDED | \
88 NV_INT_ENABLE_PDEV_REMOVED)
89#define NV_INT_ENABLE_SDEV_HOTPLUG (NV_INT_ENABLE_SDEV_ADDED | \
90 NV_INT_ENABLE_SDEV_REMOVED)
91#define NV_INT_ENABLE_HOTPLUG (NV_INT_ENABLE_PDEV_HOTPLUG | \
92 NV_INT_ENABLE_SDEV_HOTPLUG)
93
94#define NV_INT_CONFIG 0x12
95#define NV_INT_CONFIG_METHD 0x01 // 0 = INT, 1 = SMI
96
97// For PCI config register 20
98#define NV_MCP_SATA_CFG_20 0x50
99#define NV_MCP_SATA_CFG_20_SATA_SPACE_EN 0x04
100
101static int nv_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
102static irqreturn_t nv_interrupt (int irq, void *dev_instance,
103 struct pt_regs *regs);
104static u32 nv_scr_read (struct ata_port *ap, unsigned int sc_reg);
105static void nv_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
106static void nv_host_stop (struct ata_host_set *host_set);
107static void nv_enable_hotplug(struct ata_probe_ent *probe_ent);
108static void nv_disable_hotplug(struct ata_host_set *host_set);
109static void nv_check_hotplug(struct ata_host_set *host_set);
110static void nv_enable_hotplug_ck804(struct ata_probe_ent *probe_ent);
111static void nv_disable_hotplug_ck804(struct ata_host_set *host_set);
112static void nv_check_hotplug_ck804(struct ata_host_set *host_set);
113
114enum nv_host_type
115{
116 GENERIC,
117 NFORCE2,
118 NFORCE3,
119 CK804
120};
121
122static struct pci_device_id nv_pci_tbl[] = {
123 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE2S_SATA,
124 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE2 },
125 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SATA,
126 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE3 },
127 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE3S_SATA2,
128 PCI_ANY_ID, PCI_ANY_ID, 0, 0, NFORCE3 },
129 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_CK804_SATA,
130 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
131 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_CK804_SATA2,
132 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
133 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP04_SATA,
134 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
135 { PCI_VENDOR_ID_NVIDIA, PCI_DEVICE_ID_NVIDIA_NFORCE_MCP04_SATA2,
136 PCI_ANY_ID, PCI_ANY_ID, 0, 0, CK804 },
137 { PCI_VENDOR_ID_NVIDIA, PCI_ANY_ID,
138 PCI_ANY_ID, PCI_ANY_ID,
139 PCI_CLASS_STORAGE_IDE<<8, 0xffff00, GENERIC },
140 { 0, } /* terminate list */
141};
142
143#define NV_HOST_FLAGS_SCR_MMIO 0x00000001
144
145struct nv_host_desc
146{
147 enum nv_host_type host_type;
148 void (*enable_hotplug)(struct ata_probe_ent *probe_ent);
149 void (*disable_hotplug)(struct ata_host_set *host_set);
150 void (*check_hotplug)(struct ata_host_set *host_set);
151
152};
153static struct nv_host_desc nv_device_tbl[] = {
154 {
155 .host_type = GENERIC,
156 .enable_hotplug = NULL,
157 .disable_hotplug= NULL,
158 .check_hotplug = NULL,
159 },
160 {
161 .host_type = NFORCE2,
162 .enable_hotplug = nv_enable_hotplug,
163 .disable_hotplug= nv_disable_hotplug,
164 .check_hotplug = nv_check_hotplug,
165 },
166 {
167 .host_type = NFORCE3,
168 .enable_hotplug = nv_enable_hotplug,
169 .disable_hotplug= nv_disable_hotplug,
170 .check_hotplug = nv_check_hotplug,
171 },
172 { .host_type = CK804,
173 .enable_hotplug = nv_enable_hotplug_ck804,
174 .disable_hotplug= nv_disable_hotplug_ck804,
175 .check_hotplug = nv_check_hotplug_ck804,
176 },
177};
178
179struct nv_host
180{
181 struct nv_host_desc *host_desc;
182 unsigned long host_flags;
183};
184
185static struct pci_driver nv_pci_driver = {
186 .name = DRV_NAME,
187 .id_table = nv_pci_tbl,
188 .probe = nv_init_one,
189 .remove = ata_pci_remove_one,
190};
191
192static Scsi_Host_Template nv_sht = {
193 .module = THIS_MODULE,
194 .name = DRV_NAME,
195 .ioctl = ata_scsi_ioctl,
196 .queuecommand = ata_scsi_queuecmd,
197 .eh_strategy_handler = ata_scsi_error,
198 .can_queue = ATA_DEF_QUEUE,
199 .this_id = ATA_SHT_THIS_ID,
200 .sg_tablesize = LIBATA_MAX_PRD,
201 .max_sectors = ATA_MAX_SECTORS,
202 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
203 .emulated = ATA_SHT_EMULATED,
204 .use_clustering = ATA_SHT_USE_CLUSTERING,
205 .proc_name = DRV_NAME,
206 .dma_boundary = ATA_DMA_BOUNDARY,
207 .slave_configure = ata_scsi_slave_config,
208 .bios_param = ata_std_bios_param,
209 .ordered_flush = 1,
210};
211
212static struct ata_port_operations nv_ops = {
213 .port_disable = ata_port_disable,
214 .tf_load = ata_tf_load,
215 .tf_read = ata_tf_read,
216 .exec_command = ata_exec_command,
217 .check_status = ata_check_status,
218 .dev_select = ata_std_dev_select,
219 .phy_reset = sata_phy_reset,
220 .bmdma_setup = ata_bmdma_setup,
221 .bmdma_start = ata_bmdma_start,
222 .bmdma_stop = ata_bmdma_stop,
223 .bmdma_status = ata_bmdma_status,
224 .qc_prep = ata_qc_prep,
225 .qc_issue = ata_qc_issue_prot,
226 .eng_timeout = ata_eng_timeout,
227 .irq_handler = nv_interrupt,
228 .irq_clear = ata_bmdma_irq_clear,
229 .scr_read = nv_scr_read,
230 .scr_write = nv_scr_write,
231 .port_start = ata_port_start,
232 .port_stop = ata_port_stop,
233 .host_stop = nv_host_stop,
234};
235
236/* FIXME: The hardware provides the necessary SATA PHY controls
237 * to support ATA_FLAG_SATA_RESET. However, it is currently
238 * necessary to disable that flag, to solve misdetection problems.
239 * See http://bugme.osdl.org/show_bug.cgi?id=3352 for more info.
240 *
241 * This problem really needs to be investigated further. But in the
242 * meantime, we avoid ATA_FLAG_SATA_RESET to get people working.
243 */
244static struct ata_port_info nv_port_info = {
245 .sht = &nv_sht,
246 .host_flags = ATA_FLAG_SATA |
247 /* ATA_FLAG_SATA_RESET | */
248 ATA_FLAG_SRST |
249 ATA_FLAG_NO_LEGACY,
250 .pio_mask = NV_PIO_MASK,
251 .mwdma_mask = NV_MWDMA_MASK,
252 .udma_mask = NV_UDMA_MASK,
253 .port_ops = &nv_ops,
254};
255
256MODULE_AUTHOR("NVIDIA");
257MODULE_DESCRIPTION("low-level driver for NVIDIA nForce SATA controller");
258MODULE_LICENSE("GPL");
259MODULE_DEVICE_TABLE(pci, nv_pci_tbl);
260MODULE_VERSION(DRV_VERSION);
261
262static irqreturn_t nv_interrupt (int irq, void *dev_instance,
263 struct pt_regs *regs)
264{
265 struct ata_host_set *host_set = dev_instance;
266 struct nv_host *host = host_set->private_data;
267 unsigned int i;
268 unsigned int handled = 0;
269 unsigned long flags;
270
271 spin_lock_irqsave(&host_set->lock, flags);
272
273 for (i = 0; i < host_set->n_ports; i++) {
274 struct ata_port *ap;
275
276 ap = host_set->ports[i];
277 if (ap && (!(ap->flags & ATA_FLAG_PORT_DISABLED))) {
278 struct ata_queued_cmd *qc;
279
280 qc = ata_qc_from_tag(ap, ap->active_tag);
281 if (qc && (!(qc->tf.ctl & ATA_NIEN)))
282 handled += ata_host_intr(ap, qc);
283 }
284
285 }
286
287 if (host->host_desc->check_hotplug)
288 host->host_desc->check_hotplug(host_set);
289
290 spin_unlock_irqrestore(&host_set->lock, flags);
291
292 return IRQ_RETVAL(handled);
293}
294
295static u32 nv_scr_read (struct ata_port *ap, unsigned int sc_reg)
296{
297 struct ata_host_set *host_set = ap->host_set;
298 struct nv_host *host = host_set->private_data;
299
300 if (sc_reg > SCR_CONTROL)
301 return 0xffffffffU;
302
303 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
304 return readl((void*)ap->ioaddr.scr_addr + (sc_reg * 4));
305 else
306 return inl(ap->ioaddr.scr_addr + (sc_reg * 4));
307}
308
309static void nv_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
310{
311 struct ata_host_set *host_set = ap->host_set;
312 struct nv_host *host = host_set->private_data;
313
314 if (sc_reg > SCR_CONTROL)
315 return;
316
317 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
318 writel(val, (void*)ap->ioaddr.scr_addr + (sc_reg * 4));
319 else
320 outl(val, ap->ioaddr.scr_addr + (sc_reg * 4));
321}
322
323static void nv_host_stop (struct ata_host_set *host_set)
324{
325 struct nv_host *host = host_set->private_data;
326
327 // Disable hotplug event interrupts.
328 if (host->host_desc->disable_hotplug)
329 host->host_desc->disable_hotplug(host_set);
330
331 kfree(host);
Jeff Garzikaa8f0dc2005-05-26 21:54:27 -0400332
333 ata_host_stop(host_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
336static int nv_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
337{
338 static int printed_version = 0;
339 struct nv_host *host;
340 struct ata_port_info *ppi;
341 struct ata_probe_ent *probe_ent;
342 int pci_dev_busy = 0;
343 int rc;
344 u32 bar;
345
346 // Make sure this is a SATA controller by counting the number of bars
347 // (NVIDIA SATA controllers will always have six bars). Otherwise,
348 // it's an IDE controller and we ignore it.
349 for (bar=0; bar<6; bar++)
350 if (pci_resource_start(pdev, bar) == 0)
351 return -ENODEV;
352
353 if (!printed_version++)
354 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
355
356 rc = pci_enable_device(pdev);
357 if (rc)
358 goto err_out;
359
360 rc = pci_request_regions(pdev, DRV_NAME);
361 if (rc) {
362 pci_dev_busy = 1;
363 goto err_out_disable;
364 }
365
366 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
367 if (rc)
368 goto err_out_regions;
369 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
370 if (rc)
371 goto err_out_regions;
372
373 rc = -ENOMEM;
374
375 ppi = &nv_port_info;
376 probe_ent = ata_pci_init_native_mode(pdev, &ppi);
377 if (!probe_ent)
378 goto err_out_regions;
379
380 host = kmalloc(sizeof(struct nv_host), GFP_KERNEL);
381 if (!host)
382 goto err_out_free_ent;
383
384 memset(host, 0, sizeof(struct nv_host));
385 host->host_desc = &nv_device_tbl[ent->driver_data];
386
387 probe_ent->private_data = host;
388
389 if (pci_resource_flags(pdev, 5) & IORESOURCE_MEM)
390 host->host_flags |= NV_HOST_FLAGS_SCR_MMIO;
391
392 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO) {
393 unsigned long base;
394
395 probe_ent->mmio_base = ioremap(pci_resource_start(pdev, 5),
396 pci_resource_len(pdev, 5));
397 if (probe_ent->mmio_base == NULL) {
398 rc = -EIO;
399 goto err_out_free_host;
400 }
401
402 base = (unsigned long)probe_ent->mmio_base;
403
404 probe_ent->port[0].scr_addr =
405 base + NV_PORT0_SCR_REG_OFFSET;
406 probe_ent->port[1].scr_addr =
407 base + NV_PORT1_SCR_REG_OFFSET;
408 } else {
409
410 probe_ent->port[0].scr_addr =
411 pci_resource_start(pdev, 5) | NV_PORT0_SCR_REG_OFFSET;
412 probe_ent->port[1].scr_addr =
413 pci_resource_start(pdev, 5) | NV_PORT1_SCR_REG_OFFSET;
414 }
415
416 pci_set_master(pdev);
417
418 rc = ata_device_add(probe_ent);
419 if (rc != NV_PORTS)
420 goto err_out_iounmap;
421
422 // Enable hotplug event interrupts.
423 if (host->host_desc->enable_hotplug)
424 host->host_desc->enable_hotplug(probe_ent);
425
426 kfree(probe_ent);
427
428 return 0;
429
430err_out_iounmap:
431 if (host->host_flags & NV_HOST_FLAGS_SCR_MMIO)
432 iounmap(probe_ent->mmio_base);
433err_out_free_host:
434 kfree(host);
435err_out_free_ent:
436 kfree(probe_ent);
437err_out_regions:
438 pci_release_regions(pdev);
439err_out_disable:
440 if (!pci_dev_busy)
441 pci_disable_device(pdev);
442err_out:
443 return rc;
444}
445
446static void nv_enable_hotplug(struct ata_probe_ent *probe_ent)
447{
448 u8 intr_mask;
449
450 outb(NV_INT_STATUS_HOTPLUG,
451 probe_ent->port[0].scr_addr + NV_INT_STATUS);
452
453 intr_mask = inb(probe_ent->port[0].scr_addr + NV_INT_ENABLE);
454 intr_mask |= NV_INT_ENABLE_HOTPLUG;
455
456 outb(intr_mask, probe_ent->port[0].scr_addr + NV_INT_ENABLE);
457}
458
459static void nv_disable_hotplug(struct ata_host_set *host_set)
460{
461 u8 intr_mask;
462
463 intr_mask = inb(host_set->ports[0]->ioaddr.scr_addr + NV_INT_ENABLE);
464
465 intr_mask &= ~(NV_INT_ENABLE_HOTPLUG);
466
467 outb(intr_mask, host_set->ports[0]->ioaddr.scr_addr + NV_INT_ENABLE);
468}
469
470static void nv_check_hotplug(struct ata_host_set *host_set)
471{
472 u8 intr_status;
473
474 intr_status = inb(host_set->ports[0]->ioaddr.scr_addr + NV_INT_STATUS);
475
476 // Clear interrupt status.
477 outb(0xff, host_set->ports[0]->ioaddr.scr_addr + NV_INT_STATUS);
478
479 if (intr_status & NV_INT_STATUS_HOTPLUG) {
480 if (intr_status & NV_INT_STATUS_PDEV_ADDED)
481 printk(KERN_WARNING "nv_sata: "
482 "Primary device added\n");
483
484 if (intr_status & NV_INT_STATUS_PDEV_REMOVED)
485 printk(KERN_WARNING "nv_sata: "
486 "Primary device removed\n");
487
488 if (intr_status & NV_INT_STATUS_SDEV_ADDED)
489 printk(KERN_WARNING "nv_sata: "
490 "Secondary device added\n");
491
492 if (intr_status & NV_INT_STATUS_SDEV_REMOVED)
493 printk(KERN_WARNING "nv_sata: "
494 "Secondary device removed\n");
495 }
496}
497
498static void nv_enable_hotplug_ck804(struct ata_probe_ent *probe_ent)
499{
500 struct pci_dev *pdev = to_pci_dev(probe_ent->dev);
501 u8 intr_mask;
502 u8 regval;
503
504 pci_read_config_byte(pdev, NV_MCP_SATA_CFG_20, &regval);
505 regval |= NV_MCP_SATA_CFG_20_SATA_SPACE_EN;
506 pci_write_config_byte(pdev, NV_MCP_SATA_CFG_20, regval);
507
508 writeb(NV_INT_STATUS_HOTPLUG, probe_ent->mmio_base + NV_INT_STATUS_CK804);
509
510 intr_mask = readb(probe_ent->mmio_base + NV_INT_ENABLE_CK804);
511 intr_mask |= NV_INT_ENABLE_HOTPLUG;
512
513 writeb(intr_mask, probe_ent->mmio_base + NV_INT_ENABLE_CK804);
514}
515
516static void nv_disable_hotplug_ck804(struct ata_host_set *host_set)
517{
518 struct pci_dev *pdev = to_pci_dev(host_set->dev);
519 u8 intr_mask;
520 u8 regval;
521
522 intr_mask = readb(host_set->mmio_base + NV_INT_ENABLE_CK804);
523
524 intr_mask &= ~(NV_INT_ENABLE_HOTPLUG);
525
526 writeb(intr_mask, host_set->mmio_base + NV_INT_ENABLE_CK804);
527
528 pci_read_config_byte(pdev, NV_MCP_SATA_CFG_20, &regval);
529 regval &= ~NV_MCP_SATA_CFG_20_SATA_SPACE_EN;
530 pci_write_config_byte(pdev, NV_MCP_SATA_CFG_20, regval);
531}
532
533static void nv_check_hotplug_ck804(struct ata_host_set *host_set)
534{
535 u8 intr_status;
536
537 intr_status = readb(host_set->mmio_base + NV_INT_STATUS_CK804);
538
539 // Clear interrupt status.
540 writeb(0xff, host_set->mmio_base + NV_INT_STATUS_CK804);
541
542 if (intr_status & NV_INT_STATUS_HOTPLUG) {
543 if (intr_status & NV_INT_STATUS_PDEV_ADDED)
544 printk(KERN_WARNING "nv_sata: "
545 "Primary device added\n");
546
547 if (intr_status & NV_INT_STATUS_PDEV_REMOVED)
548 printk(KERN_WARNING "nv_sata: "
549 "Primary device removed\n");
550
551 if (intr_status & NV_INT_STATUS_SDEV_ADDED)
552 printk(KERN_WARNING "nv_sata: "
553 "Secondary device added\n");
554
555 if (intr_status & NV_INT_STATUS_SDEV_REMOVED)
556 printk(KERN_WARNING "nv_sata: "
557 "Secondary device removed\n");
558 }
559}
560
561static int __init nv_init(void)
562{
563 return pci_module_init(&nv_pci_driver);
564}
565
566static void __exit nv_exit(void)
567{
568 pci_unregister_driver(&nv_pci_driver);
569}
570
571module_init(nv_init);
572module_exit(nv_exit);