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         .port_disable           = ata_port_disable,
 
 127         .tf_load                = ata_tf_load,
 
 128         .tf_read                = ata_tf_read,
 
 129         .check_status           = ata_check_status,
 
 130         .exec_command           = ata_exec_command,
 
 131         .dev_select             = ata_std_dev_select,
 
 133         .bmdma_setup            = ata_bmdma_setup,
 
 134         .bmdma_start            = ata_bmdma_start,
 
 135         .bmdma_stop             = ata_bmdma_stop,
 
 136         .bmdma_status           = ata_bmdma_status,
 
 138         .qc_prep                = ata_qc_prep,
 
 139         .qc_issue               = ata_qc_issue_prot,
 
 140         .data_xfer              = ata_data_xfer,
 
 142         .freeze                 = svia_noop_freeze,
 
 143         .thaw                   = ata_bmdma_thaw,
 
 144         .error_handler          = vt6420_error_handler,
 
 145         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 
 147         .irq_clear              = ata_bmdma_irq_clear,
 
 148         .irq_on                 = ata_irq_on,
 
 149         .irq_ack                = ata_irq_ack,
 
 151         .port_start             = ata_port_start,
 
 154 static const struct ata_port_operations vt6421_pata_ops = {
 
 155         .port_disable           = ata_port_disable,
 
 157         .set_piomode            = vt6421_set_pio_mode,
 
 158         .set_dmamode            = vt6421_set_dma_mode,
 
 160         .tf_load                = ata_tf_load,
 
 161         .tf_read                = ata_tf_read,
 
 162         .check_status           = ata_check_status,
 
 163         .exec_command           = ata_exec_command,
 
 164         .dev_select             = ata_std_dev_select,
 
 166         .bmdma_setup            = ata_bmdma_setup,
 
 167         .bmdma_start            = ata_bmdma_start,
 
 168         .bmdma_stop             = ata_bmdma_stop,
 
 169         .bmdma_status           = ata_bmdma_status,
 
 171         .qc_prep                = ata_qc_prep,
 
 172         .qc_issue               = ata_qc_issue_prot,
 
 173         .data_xfer              = ata_data_xfer,
 
 175         .freeze                 = ata_bmdma_freeze,
 
 176         .thaw                   = ata_bmdma_thaw,
 
 177         .error_handler          = ata_bmdma_error_handler,
 
 178         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 
 179         .cable_detect           = vt6421_pata_cable_detect,
 
 181         .irq_clear              = ata_bmdma_irq_clear,
 
 182         .irq_on                 = ata_irq_on,
 
 183         .irq_ack                = ata_irq_ack,
 
 185         .port_start             = ata_port_start,
 
 188 static const struct ata_port_operations vt6421_sata_ops = {
 
 189         .port_disable           = ata_port_disable,
 
 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,
 
 197         .bmdma_setup            = ata_bmdma_setup,
 
 198         .bmdma_start            = ata_bmdma_start,
 
 199         .bmdma_stop             = ata_bmdma_stop,
 
 200         .bmdma_status           = ata_bmdma_status,
 
 202         .qc_prep                = ata_qc_prep,
 
 203         .qc_issue               = ata_qc_issue_prot,
 
 204         .data_xfer              = ata_data_xfer,
 
 206         .freeze                 = ata_bmdma_freeze,
 
 207         .thaw                   = ata_bmdma_thaw,
 
 208         .error_handler          = ata_bmdma_error_handler,
 
 209         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 
 210         .cable_detect           = ata_cable_sata,
 
 212         .irq_clear              = ata_bmdma_irq_clear,
 
 213         .irq_on                 = ata_irq_on,
 
 214         .irq_ack                = ata_irq_ack,
 
 216         .scr_read               = svia_scr_read,
 
 217         .scr_write              = svia_scr_write,
 
 219         .port_start             = ata_port_start,
 
 222 static const struct ata_port_info vt6420_port_info = {
 
 223         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 
 226         .udma_mask      = ATA_UDMA6,
 
 227         .port_ops       = &vt6420_sata_ops,
 
 230 static struct ata_port_info vt6421_sport_info = {
 
 231         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 
 234         .udma_mask      = ATA_UDMA6,
 
 235         .port_ops       = &vt6421_sata_ops,
 
 238 static struct ata_port_info vt6421_pport_info = {
 
 239         .flags          = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY,
 
 242         .udma_mask      = ATA_UDMA6,
 
 243         .port_ops       = &vt6421_pata_ops,
 
 246 MODULE_AUTHOR("Jeff Garzik");
 
 247 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
 
 248 MODULE_LICENSE("GPL");
 
 249 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
 
 250 MODULE_VERSION(DRV_VERSION);
 
 252 static int svia_scr_read(struct ata_port *ap, unsigned int sc_reg, u32 *val)
 
 254         if (sc_reg > SCR_CONTROL)
 
 256         *val = ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
 
 260 static int svia_scr_write(struct ata_port *ap, unsigned int sc_reg, u32 val)
 
 262         if (sc_reg > SCR_CONTROL)
 
 264         iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
 
 268 static void svia_noop_freeze(struct ata_port *ap)
 
 270         /* Some VIA controllers choke if ATA_NIEN is manipulated in
 
 271          * certain way.  Leave it alone and just clear pending IRQ.
 
 274         ata_bmdma_irq_clear(ap);
 
 278  *      vt6420_prereset - prereset for vt6420
 
 279  *      @ap: target ATA port
 
 280  *      @deadline: deadline jiffies for the operation
 
 282  *      SCR registers on vt6420 are pieces of shit and may hang the
 
 283  *      whole machine completely if accessed with the wrong timing.
 
 284  *      To avoid such catastrophe, vt6420 doesn't provide generic SCR
 
 285  *      access operations, but uses SStatus and SControl only during
 
 286  *      boot probing in controlled way.
 
 288  *      As the old (pre EH update) probing code is proven to work, we
 
 289  *      strictly follow the access pattern.
 
 292  *      Kernel thread context (may sleep)
 
 295  *      0 on success, -errno otherwise.
 
 297 static int vt6420_prereset(struct ata_port *ap, unsigned long deadline)
 
 299         struct ata_eh_context *ehc = &ap->eh_context;
 
 300         unsigned long timeout = jiffies + (HZ * 5);
 
 301         u32 sstatus, scontrol;
 
 304         /* don't do any SCR stuff if we're not loading */
 
 305         if (!(ap->pflags & ATA_PFLAG_LOADING))
 
 308         /* Resume phy.  This is the old SATA resume sequence */
 
 309         svia_scr_write(ap, SCR_CONTROL, 0x300);
 
 310         svia_scr_read(ap, SCR_CONTROL, &scontrol); /* flush */
 
 312         /* wait for phy to become ready, if necessary */
 
 315                 svia_scr_read(ap, SCR_STATUS, &sstatus);
 
 316                 if ((sstatus & 0xf) != 1)
 
 318         } while (time_before(jiffies, timeout));
 
 320         /* open code sata_print_link_status() */
 
 321         svia_scr_read(ap, SCR_STATUS, &sstatus);
 
 322         svia_scr_read(ap, SCR_CONTROL, &scontrol);
 
 324         online = (sstatus & 0xf) == 0x3;
 
 326         ata_port_printk(ap, KERN_INFO,
 
 327                         "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
 
 328                         online ? "up" : "down", sstatus, scontrol);
 
 330         /* SStatus is read one more time */
 
 331         svia_scr_read(ap, SCR_STATUS, &sstatus);
 
 334                 /* tell EH to bail */
 
 335                 ehc->i.action &= ~ATA_EH_RESET_MASK;
 
 341         ata_wait_ready(ap, deadline);
 
 346 static void vt6420_error_handler(struct ata_port *ap)
 
 348         return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
 
 349                                   NULL, ata_std_postreset);
 
 352 static int vt6421_pata_cable_detect(struct ata_port *ap)
 
 354         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 357         pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
 
 359                 return ATA_CBL_PATA40;
 
 360         return ATA_CBL_PATA80;
 
 363 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
 
 365         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 366         static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
 
 367         pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
 
 370 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
 
 372         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 
 373         static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
 
 374         pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->dma_mode - XFER_UDMA_0]);
 
 377 static const unsigned int svia_bar_sizes[] = {
 
 381 static const unsigned int vt6421_bar_sizes[] = {
 
 382         16, 16, 16, 16, 32, 128
 
 385 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
 
 387         return addr + (port * 128);
 
 390 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
 
 392         return addr + (port * 64);
 
 395 static void vt6421_init_addrs(struct ata_port *ap)
 
 397         void __iomem * const * iomap = ap->host->iomap;
 
 398         void __iomem *reg_addr = iomap[ap->port_no];
 
 399         void __iomem *bmdma_addr = iomap[4] + (ap->port_no * 8);
 
 400         struct ata_ioports *ioaddr = &ap->ioaddr;
 
 402         ioaddr->cmd_addr = reg_addr;
 
 403         ioaddr->altstatus_addr =
 
 404         ioaddr->ctl_addr = (void __iomem *)
 
 405                 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
 
 406         ioaddr->bmdma_addr = bmdma_addr;
 
 407         ioaddr->scr_addr = vt6421_scr_addr(iomap[5], ap->port_no);
 
 409         ata_std_ports(ioaddr);
 
 412 static int vt6420_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
 
 414         const struct ata_port_info *ppi[] = { &vt6420_port_info, NULL };
 
 415         struct ata_host *host;
 
 418         rc = ata_pci_prepare_sff_host(pdev, ppi, &host);
 
 423         rc = pcim_iomap_regions(pdev, 1 << 5, DRV_NAME);
 
 425                 dev_printk(KERN_ERR, &pdev->dev, "failed to iomap PCI BAR 5\n");
 
 429         host->ports[0]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 0);
 
 430         host->ports[1]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 1);
 
 435 static int vt6421_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
 
 437         const struct ata_port_info *ppi[] =
 
 438                 { &vt6421_sport_info, &vt6421_sport_info, &vt6421_pport_info };
 
 439         struct ata_host *host;
 
 442         *r_host = host = ata_host_alloc_pinfo(&pdev->dev, ppi, ARRAY_SIZE(ppi));
 
 444                 dev_printk(KERN_ERR, &pdev->dev, "failed to allocate host\n");
 
 448         rc = pcim_iomap_regions(pdev, 0x3f, DRV_NAME);
 
 450                 dev_printk(KERN_ERR, &pdev->dev, "failed to request/iomap "
 
 451                            "PCI BARs (errno=%d)\n", rc);
 
 454         host->iomap = pcim_iomap_table(pdev);
 
 456         for (i = 0; i < host->n_ports; i++)
 
 457                 vt6421_init_addrs(host->ports[i]);
 
 459         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 
 462         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 
 469 static void svia_configure(struct pci_dev *pdev)
 
 473         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
 
 474         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
 
 475                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
 
 477         /* make sure SATA channels are enabled */
 
 478         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
 
 479         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 
 480                 dev_printk(KERN_DEBUG, &pdev->dev,
 
 481                            "enabling SATA channels (0x%x)\n",
 
 484                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
 
 487         /* make sure interrupts for each channel sent to us */
 
 488         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
 
 489         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 
 490                 dev_printk(KERN_DEBUG, &pdev->dev,
 
 491                            "enabling SATA channel interrupts (0x%x)\n",
 
 494                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
 
 497         /* make sure native mode is enabled */
 
 498         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
 
 499         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
 
 500                 dev_printk(KERN_DEBUG, &pdev->dev,
 
 501                            "enabling SATA channel native mode (0x%x)\n",
 
 503                 tmp8 |= NATIVE_MODE_ALL;
 
 504                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
 
 508 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 
 510         static int printed_version;
 
 513         struct ata_host *host;
 
 514         int board_id = (int) ent->driver_data;
 
 515         const int *bar_sizes;
 
 518         if (!printed_version++)
 
 519                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 
 521         rc = pcim_enable_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         if (board_id == vt6420)
 
 551                 rc = vt6420_prepare_host(pdev, &host);
 
 553                 rc = vt6421_prepare_host(pdev, &host);
 
 557         svia_configure(pdev);
 
 559         pci_set_master(pdev);
 
 560         return ata_host_activate(host, pdev->irq, ata_interrupt, IRQF_SHARED,
 
 564 static int __init svia_init(void)
 
 566         return pci_register_driver(&svia_pci_driver);
 
 569 static void __exit svia_exit(void)
 
 571         pci_unregister_driver(&svia_pci_driver);
 
 574 module_init(svia_init);
 
 575 module_exit(svia_exit);