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.3"
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,
68 NATIVE_MODE_ALL = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
70 SATA_EXT_PHY = (1 << 6), /* 0==use PATA, 1==ext phy */
71 SATA_2DEV = (1 << 5), /* SATA is master/slave */
74 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
75 static int svia_scr_read(struct ata_port *ap, unsigned int sc_reg, u32 *val);
76 static int svia_scr_write(struct ata_port *ap, unsigned int sc_reg, u32 val);
77 static void svia_noop_freeze(struct ata_port *ap);
78 static void vt6420_error_handler(struct ata_port *ap);
79 static int vt6421_pata_cable_detect(struct ata_port *ap);
80 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev);
81 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev);
83 static const struct pci_device_id svia_pci_tbl[] = {
84 { PCI_VDEVICE(VIA, 0x5337), vt6420 },
85 { PCI_VDEVICE(VIA, 0x0591), vt6420 },
86 { PCI_VDEVICE(VIA, 0x3149), vt6420 },
87 { PCI_VDEVICE(VIA, 0x3249), vt6421 },
88 { PCI_VDEVICE(VIA, 0x5287), vt6420 },
89 { PCI_VDEVICE(VIA, 0x5372), vt6420 },
90 { PCI_VDEVICE(VIA, 0x7372), vt6420 },
92 { } /* terminate list */
95 static struct pci_driver svia_pci_driver = {
97 .id_table = svia_pci_tbl,
98 .probe = svia_init_one,
100 .suspend = ata_pci_device_suspend,
101 .resume = ata_pci_device_resume,
103 .remove = ata_pci_remove_one,
106 static struct scsi_host_template svia_sht = {
107 .module = THIS_MODULE,
109 .ioctl = ata_scsi_ioctl,
110 .queuecommand = ata_scsi_queuecmd,
111 .can_queue = ATA_DEF_QUEUE,
112 .this_id = ATA_SHT_THIS_ID,
113 .sg_tablesize = LIBATA_MAX_PRD,
114 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
115 .emulated = ATA_SHT_EMULATED,
116 .use_clustering = ATA_SHT_USE_CLUSTERING,
117 .proc_name = DRV_NAME,
118 .dma_boundary = ATA_DMA_BOUNDARY,
119 .slave_configure = ata_scsi_slave_config,
120 .slave_destroy = ata_scsi_slave_destroy,
121 .bios_param = ata_std_bios_param,
124 static const struct ata_port_operations vt6420_sata_ops = {
125 .tf_load = ata_tf_load,
126 .tf_read = ata_tf_read,
127 .check_status = ata_check_status,
128 .exec_command = ata_exec_command,
129 .dev_select = ata_std_dev_select,
131 .bmdma_setup = ata_bmdma_setup,
132 .bmdma_start = ata_bmdma_start,
133 .bmdma_stop = ata_bmdma_stop,
134 .bmdma_status = ata_bmdma_status,
136 .qc_prep = ata_qc_prep,
137 .qc_issue = ata_qc_issue_prot,
138 .data_xfer = ata_data_xfer,
140 .freeze = svia_noop_freeze,
141 .thaw = ata_bmdma_thaw,
142 .error_handler = vt6420_error_handler,
143 .post_internal_cmd = ata_bmdma_post_internal_cmd,
145 .irq_clear = ata_bmdma_irq_clear,
146 .irq_on = ata_irq_on,
148 .port_start = ata_port_start,
151 static const struct ata_port_operations vt6421_pata_ops = {
152 .set_piomode = vt6421_set_pio_mode,
153 .set_dmamode = vt6421_set_dma_mode,
155 .tf_load = ata_tf_load,
156 .tf_read = ata_tf_read,
157 .check_status = ata_check_status,
158 .exec_command = ata_exec_command,
159 .dev_select = ata_std_dev_select,
161 .bmdma_setup = ata_bmdma_setup,
162 .bmdma_start = ata_bmdma_start,
163 .bmdma_stop = ata_bmdma_stop,
164 .bmdma_status = ata_bmdma_status,
166 .qc_prep = ata_qc_prep,
167 .qc_issue = ata_qc_issue_prot,
168 .data_xfer = ata_data_xfer,
170 .freeze = ata_bmdma_freeze,
171 .thaw = ata_bmdma_thaw,
172 .error_handler = ata_bmdma_error_handler,
173 .post_internal_cmd = ata_bmdma_post_internal_cmd,
174 .cable_detect = vt6421_pata_cable_detect,
176 .irq_clear = ata_bmdma_irq_clear,
177 .irq_on = ata_irq_on,
179 .port_start = ata_port_start,
182 static const struct ata_port_operations vt6421_sata_ops = {
183 .tf_load = ata_tf_load,
184 .tf_read = ata_tf_read,
185 .check_status = ata_check_status,
186 .exec_command = ata_exec_command,
187 .dev_select = ata_std_dev_select,
189 .bmdma_setup = ata_bmdma_setup,
190 .bmdma_start = ata_bmdma_start,
191 .bmdma_stop = ata_bmdma_stop,
192 .bmdma_status = ata_bmdma_status,
194 .qc_prep = ata_qc_prep,
195 .qc_issue = ata_qc_issue_prot,
196 .data_xfer = ata_data_xfer,
198 .freeze = ata_bmdma_freeze,
199 .thaw = ata_bmdma_thaw,
200 .error_handler = ata_bmdma_error_handler,
201 .post_internal_cmd = ata_bmdma_post_internal_cmd,
202 .cable_detect = ata_cable_sata,
204 .irq_clear = ata_bmdma_irq_clear,
205 .irq_on = ata_irq_on,
207 .scr_read = svia_scr_read,
208 .scr_write = svia_scr_write,
210 .port_start = ata_port_start,
213 static const struct ata_port_info vt6420_port_info = {
214 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
217 .udma_mask = ATA_UDMA6,
218 .port_ops = &vt6420_sata_ops,
221 static struct ata_port_info vt6421_sport_info = {
222 .flags = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
225 .udma_mask = ATA_UDMA6,
226 .port_ops = &vt6421_sata_ops,
229 static struct ata_port_info vt6421_pport_info = {
230 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY,
233 .udma_mask = ATA_UDMA6,
234 .port_ops = &vt6421_pata_ops,
237 MODULE_AUTHOR("Jeff Garzik");
238 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
239 MODULE_LICENSE("GPL");
240 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
241 MODULE_VERSION(DRV_VERSION);
243 static int svia_scr_read(struct ata_port *ap, unsigned int sc_reg, u32 *val)
245 if (sc_reg > SCR_CONTROL)
247 *val = ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
251 static int svia_scr_write(struct ata_port *ap, unsigned int sc_reg, u32 val)
253 if (sc_reg > SCR_CONTROL)
255 iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
259 static void svia_noop_freeze(struct ata_port *ap)
261 /* Some VIA controllers choke if ATA_NIEN is manipulated in
262 * certain way. Leave it alone and just clear pending IRQ.
265 ata_bmdma_irq_clear(ap);
269 * vt6420_prereset - prereset for vt6420
270 * @link: target ATA link
271 * @deadline: deadline jiffies for the operation
273 * SCR registers on vt6420 are pieces of shit and may hang the
274 * whole machine completely if accessed with the wrong timing.
275 * To avoid such catastrophe, vt6420 doesn't provide generic SCR
276 * access operations, but uses SStatus and SControl only during
277 * boot probing in controlled way.
279 * As the old (pre EH update) probing code is proven to work, we
280 * strictly follow the access pattern.
283 * Kernel thread context (may sleep)
286 * 0 on success, -errno otherwise.
288 static int vt6420_prereset(struct ata_link *link, unsigned long deadline)
290 struct ata_port *ap = link->ap;
291 struct ata_eh_context *ehc = &ap->link.eh_context;
292 unsigned long timeout = jiffies + (HZ * 5);
293 u32 sstatus, scontrol;
296 /* don't do any SCR stuff if we're not loading */
297 if (!(ap->pflags & ATA_PFLAG_LOADING))
300 /* Resume phy. This is the old SATA resume sequence */
301 svia_scr_write(ap, SCR_CONTROL, 0x300);
302 svia_scr_read(ap, SCR_CONTROL, &scontrol); /* flush */
304 /* wait for phy to become ready, if necessary */
307 svia_scr_read(ap, SCR_STATUS, &sstatus);
308 if ((sstatus & 0xf) != 1)
310 } while (time_before(jiffies, timeout));
312 /* open code sata_print_link_status() */
313 svia_scr_read(ap, SCR_STATUS, &sstatus);
314 svia_scr_read(ap, SCR_CONTROL, &scontrol);
316 online = (sstatus & 0xf) == 0x3;
318 ata_port_printk(ap, KERN_INFO,
319 "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
320 online ? "up" : "down", sstatus, scontrol);
322 /* SStatus is read one more time */
323 svia_scr_read(ap, SCR_STATUS, &sstatus);
326 /* tell EH to bail */
327 ehc->i.action &= ~ATA_EH_RESET_MASK;
333 ata_wait_ready(ap, deadline);
338 static void vt6420_error_handler(struct ata_port *ap)
340 return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
341 NULL, ata_std_postreset);
344 static int vt6421_pata_cable_detect(struct ata_port *ap)
346 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
349 pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
351 return ATA_CBL_PATA40;
352 return ATA_CBL_PATA80;
355 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
357 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
358 static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
359 pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
362 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
364 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
365 static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
366 pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->dma_mode - XFER_UDMA_0]);
369 static const unsigned int svia_bar_sizes[] = {
373 static const unsigned int vt6421_bar_sizes[] = {
374 16, 16, 16, 16, 32, 128
377 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
379 return addr + (port * 128);
382 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
384 return addr + (port * 64);
387 static void vt6421_init_addrs(struct ata_port *ap)
389 void __iomem * const * iomap = ap->host->iomap;
390 void __iomem *reg_addr = iomap[ap->port_no];
391 void __iomem *bmdma_addr = iomap[4] + (ap->port_no * 8);
392 struct ata_ioports *ioaddr = &ap->ioaddr;
394 ioaddr->cmd_addr = reg_addr;
395 ioaddr->altstatus_addr =
396 ioaddr->ctl_addr = (void __iomem *)
397 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
398 ioaddr->bmdma_addr = bmdma_addr;
399 ioaddr->scr_addr = vt6421_scr_addr(iomap[5], ap->port_no);
401 ata_std_ports(ioaddr);
403 ata_port_pbar_desc(ap, ap->port_no, -1, "port");
404 ata_port_pbar_desc(ap, 4, ap->port_no * 8, "bmdma");
407 static int vt6420_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
409 const struct ata_port_info *ppi[] = { &vt6420_port_info, NULL };
410 struct ata_host *host;
413 rc = ata_pci_prepare_sff_host(pdev, ppi, &host);
418 rc = pcim_iomap_regions(pdev, 1 << 5, DRV_NAME);
420 dev_printk(KERN_ERR, &pdev->dev, "failed to iomap PCI BAR 5\n");
424 host->ports[0]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 0);
425 host->ports[1]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 1);
430 static int vt6421_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
432 const struct ata_port_info *ppi[] =
433 { &vt6421_sport_info, &vt6421_sport_info, &vt6421_pport_info };
434 struct ata_host *host;
437 *r_host = host = ata_host_alloc_pinfo(&pdev->dev, ppi, ARRAY_SIZE(ppi));
439 dev_printk(KERN_ERR, &pdev->dev, "failed to allocate host\n");
443 rc = pcim_iomap_regions(pdev, 0x3f, DRV_NAME);
445 dev_printk(KERN_ERR, &pdev->dev, "failed to request/iomap "
446 "PCI BARs (errno=%d)\n", rc);
449 host->iomap = pcim_iomap_table(pdev);
451 for (i = 0; i < host->n_ports; i++)
452 vt6421_init_addrs(host->ports[i]);
454 rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
457 rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
464 static void svia_configure(struct pci_dev *pdev)
468 pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
469 dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
470 (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
472 /* make sure SATA channels are enabled */
473 pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
474 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
475 dev_printk(KERN_DEBUG, &pdev->dev,
476 "enabling SATA channels (0x%x)\n",
479 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
482 /* make sure interrupts for each channel sent to us */
483 pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
484 if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
485 dev_printk(KERN_DEBUG, &pdev->dev,
486 "enabling SATA channel interrupts (0x%x)\n",
489 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
492 /* make sure native mode is enabled */
493 pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
494 if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
495 dev_printk(KERN_DEBUG, &pdev->dev,
496 "enabling SATA channel native mode (0x%x)\n",
498 tmp8 |= NATIVE_MODE_ALL;
499 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
503 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
505 static int printed_version;
508 struct ata_host *host;
509 int board_id = (int) ent->driver_data;
510 const int *bar_sizes;
513 if (!printed_version++)
514 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
516 rc = pcim_enable_device(pdev);
520 if (board_id == vt6420) {
521 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
522 if (tmp8 & SATA_2DEV) {
523 dev_printk(KERN_ERR, &pdev->dev,
524 "SATA master/slave not supported (0x%x)\n",
529 bar_sizes = &svia_bar_sizes[0];
531 bar_sizes = &vt6421_bar_sizes[0];
534 for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
535 if ((pci_resource_start(pdev, i) == 0) ||
536 (pci_resource_len(pdev, i) < bar_sizes[i])) {
537 dev_printk(KERN_ERR, &pdev->dev,
538 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
540 (unsigned long long)pci_resource_start(pdev, i),
541 (unsigned long long)pci_resource_len(pdev, i));
545 if (board_id == vt6420)
546 rc = vt6420_prepare_host(pdev, &host);
548 rc = vt6421_prepare_host(pdev, &host);
552 svia_configure(pdev);
554 pci_set_master(pdev);
555 return ata_host_activate(host, pdev->irq, ata_interrupt, IRQF_SHARED,
559 static int __init svia_init(void)
561 return pci_register_driver(&svia_pci_driver);
564 static void __exit svia_exit(void)
566 pci_unregister_driver(&svia_pci_driver);
569 module_init(svia_init);
570 module_exit(svia_exit);