2 * sata_via.c - VIA Serial ATA controllers
4 * Maintained by: Jeff Garzik <jgarzik@pobox.com>
5 * Please ALWAYS copy linux-ide@vger.kernel.org
8 * Copyright 2003-2004 Red Hat, Inc. All rights reserved.
9 * Copyright 2003-2004 Jeff Garzik
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 * Hardware documentation available under NDA.
34 * - VT6421 PATA support
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/pci.h>
41 #include <linux/init.h>
42 #include <linux/blkdev.h>
43 #include <linux/delay.h>
44 #include <linux/device.h>
45 #include <scsi/scsi_host.h>
46 #include <linux/libata.h>
48 #define DRV_NAME "sata_via"
49 #define DRV_VERSION "2.0"
57 SATA_CHAN_ENAB = 0x40, /* SATA channel enable */
58 SATA_INT_GATE = 0x41, /* SATA interrupt gating */
59 SATA_NATIVE_MODE = 0x42, /* Native mode enable */
60 SATA_PATA_SHARING = 0x49, /* PATA/SATA sharing func ctrl */
61 PATA_UDMA_TIMING = 0xB3, /* PATA timing for DMA/ cable detect */
62 PATA_PIO_TIMING = 0xAB, /* PATA timing register */
66 ALL_PORTS = PORT0 | PORT1,
67 PATA_PORT = 2, /* PATA is port 2 */
70 NATIVE_MODE_ALL = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
72 SATA_EXT_PHY = (1 << 6), /* 0==use PATA, 1==ext phy */
73 SATA_2DEV = (1 << 5), /* SATA is master/slave */
76 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
77 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg);
78 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
79 static void svia_noop_freeze(struct ata_port *ap);
80 static void vt6420_error_handler(struct ata_port *ap);
81 static void vt6421_sata_error_handler(struct ata_port *ap);
82 static void vt6421_pata_error_handler(struct ata_port *ap);
83 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev);
84 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev);
85 static int vt6421_port_start(struct ata_port *ap);
87 static const struct pci_device_id svia_pci_tbl[] = {
88 { PCI_VDEVICE(VIA, 0x5337), vt6420 },
89 { PCI_VDEVICE(VIA, 0x0591), vt6420 },
90 { PCI_VDEVICE(VIA, 0x3149), vt6420 },
91 { PCI_VDEVICE(VIA, 0x3249), vt6421 },
93 { } /* terminate list */
96 static struct pci_driver svia_pci_driver = {
98 .id_table = svia_pci_tbl,
99 .probe = svia_init_one,
100 .remove = ata_pci_remove_one,
103 static struct scsi_host_template svia_sht = {
104 .module = THIS_MODULE,
106 .ioctl = ata_scsi_ioctl,
107 .queuecommand = ata_scsi_queuecmd,
108 .can_queue = ATA_DEF_QUEUE,
109 .this_id = ATA_SHT_THIS_ID,
110 .sg_tablesize = LIBATA_MAX_PRD,
111 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
112 .emulated = ATA_SHT_EMULATED,
113 .use_clustering = ATA_SHT_USE_CLUSTERING,
114 .proc_name = DRV_NAME,
115 .dma_boundary = ATA_DMA_BOUNDARY,
116 .slave_configure = ata_scsi_slave_config,
117 .slave_destroy = ata_scsi_slave_destroy,
118 .bios_param = ata_std_bios_param,
121 static const struct ata_port_operations vt6420_sata_ops = {
122 .port_disable = ata_port_disable,
124 .tf_load = ata_tf_load,
125 .tf_read = ata_tf_read,
126 .check_status = ata_check_status,
127 .exec_command = ata_exec_command,
128 .dev_select = ata_std_dev_select,
130 .bmdma_setup = ata_bmdma_setup,
131 .bmdma_start = ata_bmdma_start,
132 .bmdma_stop = ata_bmdma_stop,
133 .bmdma_status = ata_bmdma_status,
135 .qc_prep = ata_qc_prep,
136 .qc_issue = ata_qc_issue_prot,
137 .data_xfer = ata_data_xfer,
139 .freeze = svia_noop_freeze,
140 .thaw = ata_bmdma_thaw,
141 .error_handler = vt6420_error_handler,
142 .post_internal_cmd = ata_bmdma_post_internal_cmd,
144 .irq_handler = ata_interrupt,
145 .irq_clear = ata_bmdma_irq_clear,
147 .port_start = ata_port_start,
150 static const struct ata_port_operations vt6421_pata_ops = {
151 .port_disable = ata_port_disable,
153 .set_piomode = vt6421_set_pio_mode,
154 .set_dmamode = vt6421_set_dma_mode,
156 .tf_load = ata_tf_load,
157 .tf_read = ata_tf_read,
158 .check_status = ata_check_status,
159 .exec_command = ata_exec_command,
160 .dev_select = ata_std_dev_select,
162 .bmdma_setup = ata_bmdma_setup,
163 .bmdma_start = ata_bmdma_start,
164 .bmdma_stop = ata_bmdma_stop,
165 .bmdma_status = ata_bmdma_status,
167 .qc_prep = ata_qc_prep,
168 .qc_issue = ata_qc_issue_prot,
169 .data_xfer = ata_data_xfer,
171 .freeze = ata_bmdma_freeze,
172 .thaw = ata_bmdma_thaw,
173 .error_handler = vt6421_pata_error_handler,
174 .post_internal_cmd = ata_bmdma_post_internal_cmd,
176 .irq_handler = ata_interrupt,
177 .irq_clear = ata_bmdma_irq_clear,
179 .port_start = vt6421_port_start,
182 static const struct ata_port_operations vt6421_sata_ops = {
183 .port_disable = ata_port_disable,
185 .tf_load = ata_tf_load,
186 .tf_read = ata_tf_read,
187 .check_status = ata_check_status,
188 .exec_command = ata_exec_command,
189 .dev_select = ata_std_dev_select,
191 .bmdma_setup = ata_bmdma_setup,
192 .bmdma_start = ata_bmdma_start,
193 .bmdma_stop = ata_bmdma_stop,
194 .bmdma_status = ata_bmdma_status,
196 .qc_prep = ata_qc_prep,
197 .qc_issue = ata_qc_issue_prot,
198 .data_xfer = ata_data_xfer,
200 .freeze = ata_bmdma_freeze,
201 .thaw = ata_bmdma_thaw,
202 .error_handler = vt6421_sata_error_handler,
203 .post_internal_cmd = ata_bmdma_post_internal_cmd,
205 .irq_handler = ata_interrupt,
206 .irq_clear = ata_bmdma_irq_clear,
208 .scr_read = svia_scr_read,
209 .scr_write = svia_scr_write,
211 .port_start = vt6421_port_start,
214 static struct ata_port_info vt6420_port_info = {
216 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
220 .port_ops = &vt6420_sata_ops,
223 MODULE_AUTHOR("Jeff Garzik");
224 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
225 MODULE_LICENSE("GPL");
226 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
227 MODULE_VERSION(DRV_VERSION);
229 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
231 if (sc_reg > SCR_CONTROL)
233 return ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
236 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
238 if (sc_reg > SCR_CONTROL)
240 iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
243 static void svia_noop_freeze(struct ata_port *ap)
245 /* Some VIA controllers choke if ATA_NIEN is manipulated in
246 * certain way. Leave it alone and just clear pending IRQ.
249 ata_bmdma_irq_clear(ap);
253 * vt6420_prereset - prereset for vt6420
254 * @ap: target ATA port
256 * SCR registers on vt6420 are pieces of shit and may hang the
257 * whole machine completely if accessed with the wrong timing.
258 * To avoid such catastrophe, vt6420 doesn't provide generic SCR
259 * access operations, but uses SStatus and SControl only during
260 * boot probing in controlled way.
262 * As the old (pre EH update) probing code is proven to work, we
263 * strictly follow the access pattern.
266 * Kernel thread context (may sleep)
269 * 0 on success, -errno otherwise.
271 static int vt6420_prereset(struct ata_port *ap)
273 struct ata_eh_context *ehc = &ap->eh_context;
274 unsigned long timeout = jiffies + (HZ * 5);
275 u32 sstatus, scontrol;
278 /* don't do any SCR stuff if we're not loading */
279 if (!(ap->pflags & ATA_PFLAG_LOADING))
282 /* Resume phy. This is the old resume sequence from
283 * __sata_phy_reset().
285 svia_scr_write(ap, SCR_CONTROL, 0x300);
286 svia_scr_read(ap, SCR_CONTROL); /* flush */
288 /* wait for phy to become ready, if necessary */
291 if ((svia_scr_read(ap, SCR_STATUS) & 0xf) != 1)
293 } while (time_before(jiffies, timeout));
295 /* open code sata_print_link_status() */
296 sstatus = svia_scr_read(ap, SCR_STATUS);
297 scontrol = svia_scr_read(ap, SCR_CONTROL);
299 online = (sstatus & 0xf) == 0x3;
301 ata_port_printk(ap, KERN_INFO,
302 "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
303 online ? "up" : "down", sstatus, scontrol);
305 /* SStatus is read one more time */
306 svia_scr_read(ap, SCR_STATUS);
309 /* tell EH to bail */
310 ehc->i.action &= ~ATA_EH_RESET_MASK;
316 ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
321 static void vt6420_error_handler(struct ata_port *ap)
323 return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
324 NULL, ata_std_postreset);
327 static int vt6421_pata_prereset(struct ata_port *ap)
329 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
332 pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
334 ap->cbl = ATA_CBL_PATA40;
336 ap->cbl = ATA_CBL_PATA80;
340 static void vt6421_pata_error_handler(struct ata_port *ap)
342 return ata_bmdma_drive_eh(ap, vt6421_pata_prereset, ata_std_softreset,
343 NULL, ata_std_postreset);
346 static int vt6421_sata_prereset(struct ata_port *ap)
348 ap->cbl = ATA_CBL_SATA;
352 static void vt6421_sata_error_handler(struct ata_port *ap)
354 return ata_bmdma_drive_eh(ap, vt6421_sata_prereset, ata_std_softreset,
355 NULL, ata_std_postreset);
358 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
360 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
361 static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
362 pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
365 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
367 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
368 static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
369 pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->pio_mode - XFER_UDMA_0]);
372 static int vt6421_port_start(struct ata_port *ap)
374 if (ap->port_no == PATA_PORT) {
375 ap->ops = &vt6421_pata_ops;
377 ap->flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY | ATA_FLAG_SRST;
379 return ata_port_start(ap);
382 static const unsigned int svia_bar_sizes[] = {
386 static const unsigned int vt6421_bar_sizes[] = {
387 16, 16, 16, 16, 32, 128
390 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
392 return addr + (port * 128);
395 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
397 return addr + (port * 64);
400 static void vt6421_init_addrs(struct ata_probe_ent *probe_ent,
401 void __iomem * const *iomap, unsigned int port)
403 void __iomem *reg_addr = iomap[port];
404 void __iomem *bmdma_addr = iomap[4] + (port * 8);
406 probe_ent->port[port].cmd_addr = reg_addr;
407 probe_ent->port[port].altstatus_addr =
408 probe_ent->port[port].ctl_addr = (void __iomem *)
409 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
410 probe_ent->port[port].bmdma_addr = bmdma_addr;
411 probe_ent->port[port].scr_addr = vt6421_scr_addr(iomap[5], port);
413 ata_std_ports(&probe_ent->port[port]);
416 static struct ata_probe_ent *vt6420_init_probe_ent(struct pci_dev *pdev)
418 struct ata_probe_ent *probe_ent;
419 struct ata_port_info *ppi[2];
420 void __iomem * const *iomap;
422 ppi[0] = ppi[1] = &vt6420_port_info;
423 probe_ent = ata_pci_init_native_mode(pdev, ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
427 iomap = pcim_iomap_table(pdev);
428 probe_ent->port[0].scr_addr = svia_scr_addr(iomap[5], 0);
429 probe_ent->port[1].scr_addr = svia_scr_addr(iomap[5], 1);
434 static struct ata_probe_ent *vt6421_init_probe_ent(struct pci_dev *pdev)
436 struct ata_probe_ent *probe_ent;
439 probe_ent = devm_kzalloc(&pdev->dev, sizeof(*probe_ent), GFP_KERNEL);
443 memset(probe_ent, 0, sizeof(*probe_ent));
444 probe_ent->dev = pci_dev_to_dev(pdev);
445 INIT_LIST_HEAD(&probe_ent->node);
447 probe_ent->sht = &svia_sht;
448 probe_ent->port_flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY;
449 probe_ent->port_ops = &vt6421_sata_ops;
450 probe_ent->n_ports = N_PORTS;
451 probe_ent->irq = pdev->irq;
452 probe_ent->irq_flags = IRQF_SHARED;
453 probe_ent->pio_mask = 0x1f;
454 probe_ent->mwdma_mask = 0x07;
455 probe_ent->udma_mask = 0x7f;
457 for (i = 0; i < N_PORTS; i++)
458 vt6421_init_addrs(probe_ent, pcim_iomap_table(pdev), i);
463 static void svia_configure(struct pci_dev *pdev)
467 pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
468 dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
469 (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
471 /* make sure SATA channels are enabled */
472 pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
473 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
474 dev_printk(KERN_DEBUG, &pdev->dev,
475 "enabling SATA channels (0x%x)\n",
478 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
481 /* make sure interrupts for each channel sent to us */
482 pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
483 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
484 dev_printk(KERN_DEBUG, &pdev->dev,
485 "enabling SATA channel interrupts (0x%x)\n",
488 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
491 /* make sure native mode is enabled */
492 pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
493 if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
494 dev_printk(KERN_DEBUG, &pdev->dev,
495 "enabling SATA channel native mode (0x%x)\n",
497 tmp8 |= NATIVE_MODE_ALL;
498 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
502 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
504 static int printed_version;
507 struct ata_probe_ent *probe_ent;
508 int board_id = (int) ent->driver_data;
509 const int *bar_sizes;
512 if (!printed_version++)
513 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
515 rc = pcim_enable_device(pdev);
519 rc = pcim_iomap_regions(pdev, 0x1f, DRV_NAME);
521 pcim_pin_device(pdev);
525 if (board_id == vt6420) {
526 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
527 if (tmp8 & SATA_2DEV) {
528 dev_printk(KERN_ERR, &pdev->dev,
529 "SATA master/slave not supported (0x%x)\n",
534 bar_sizes = &svia_bar_sizes[0];
536 bar_sizes = &vt6421_bar_sizes[0];
539 for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
540 if ((pci_resource_start(pdev, i) == 0) ||
541 (pci_resource_len(pdev, i) < bar_sizes[i])) {
542 dev_printk(KERN_ERR, &pdev->dev,
543 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
545 (unsigned long long)pci_resource_start(pdev, i),
546 (unsigned long long)pci_resource_len(pdev, i));
550 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
553 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
557 if (board_id == vt6420)
558 probe_ent = vt6420_init_probe_ent(pdev);
560 probe_ent = vt6421_init_probe_ent(pdev);
563 dev_printk(KERN_ERR, &pdev->dev, "out of memory\n");
567 svia_configure(pdev);
569 pci_set_master(pdev);
571 if (!ata_device_add(probe_ent))
574 devm_kfree(&pdev->dev, probe_ent);
578 static int __init svia_init(void)
580 return pci_register_driver(&svia_pci_driver);
583 static void __exit svia_exit(void)
585 pci_unregister_driver(&svia_pci_driver);
588 module_init(svia_init);
589 module_exit(svia_exit);