drivers/ata/sata_via.c

   1 /*
   2  *  sata_via.c - VIA Serial ATA controllers
   3  *
   4  *  Maintained by:  Jeff Garzik <jgarzik@pobox.com>
   5  *                 Please ALWAYS copy linux-ide@vger.kernel.org
   6                    on emails.
   7  *
   8  *  Copyright 2003-2004 Red Hat, Inc.  All rights reserved.
   9  *  Copyright 2003-2004 Jeff Garzik
  10  *
  11  *
  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)
  15  *  any later version.
  16  *
  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.
  21  *
  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.
  25  *
  26  *
  27  *  libata documentation is available via 'make {ps|pdf}docs',
  28  *  as Documentation/DocBook/libata.*
  29  *
  30  *  Hardware documentation available under NDA.
  31  *
  32  *
  33  *  To-do list:
  34  *  - VT6421 PATA support
  35  *
  36  */
  37
  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>
  47
  48 #define DRV_NAME        "sata_via"
  49 #define DRV_VERSION     "2.2"
  50
  51 enum board_ids_enum {
  52         vt6420,
  53         vt6421,
  54 };
  55
  56 enum {
  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 */
  63
  64         PORT0                   = (1 << 1),
  65         PORT1                   = (1 << 0),
  66         ALL_PORTS               = PORT0 | PORT1,
  67
  68         NATIVE_MODE_ALL         = (1 << 7) | (1 << 6) | (1 << 5) | (1 << 4),
  69
  70         SATA_EXT_PHY            = (1 << 6), /* 0==use PATA, 1==ext phy */
  71         SATA_2DEV               = (1 << 5), /* SATA is master/slave */
  72 };
  73
  74 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
  75 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg);
  76 static void 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);
  82
  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
  89         { }     /* terminate list */
  90 };
  91
  92 static struct pci_driver svia_pci_driver = {
  93         .name                   = DRV_NAME,
  94         .id_table               = svia_pci_tbl,
  95         .probe                  = svia_init_one,
  96 #ifdef CONFIG_PM
  97         .suspend                = ata_pci_device_suspend,
  98         .resume                 = ata_pci_device_resume,
  99 #endif
 100         .remove                 = ata_pci_remove_one,
 101 };
 102
 103 static struct scsi_host_template svia_sht = {
 104         .module                 = THIS_MODULE,
 105         .name                   = DRV_NAME,
 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,
 119 };
 120
 121 static const struct ata_port_operations vt6420_sata_ops = {
 122         .port_disable           = ata_port_disable,
 123
 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,
 129
 130         .bmdma_setup            = ata_bmdma_setup,
 131         .bmdma_start            = ata_bmdma_start,
 132         .bmdma_stop             = ata_bmdma_stop,
 133         .bmdma_status           = ata_bmdma_status,
 134
 135         .qc_prep                = ata_qc_prep,
 136         .qc_issue               = ata_qc_issue_prot,
 137         .data_xfer              = ata_data_xfer,
 138
 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,
 143
 144         .irq_clear              = ata_bmdma_irq_clear,
 145         .irq_on                 = ata_irq_on,
 146         .irq_ack                = ata_irq_ack,
 147
 148         .port_start             = ata_port_start,
 149 };
 150
 151 static const struct ata_port_operations vt6421_pata_ops = {
 152         .port_disable           = ata_port_disable,
 153
 154         .set_piomode            = vt6421_set_pio_mode,
 155         .set_dmamode            = vt6421_set_dma_mode,
 156
 157         .tf_load                = ata_tf_load,
 158         .tf_read                = ata_tf_read,
 159         .check_status           = ata_check_status,
 160         .exec_command           = ata_exec_command,
 161         .dev_select             = ata_std_dev_select,
 162
 163         .bmdma_setup            = ata_bmdma_setup,
 164         .bmdma_start            = ata_bmdma_start,
 165         .bmdma_stop             = ata_bmdma_stop,
 166         .bmdma_status           = ata_bmdma_status,
 167
 168         .qc_prep                = ata_qc_prep,
 169         .qc_issue               = ata_qc_issue_prot,
 170         .data_xfer              = ata_data_xfer,
 171
 172         .freeze                 = ata_bmdma_freeze,
 173         .thaw                   = ata_bmdma_thaw,
 174         .error_handler          = ata_bmdma_error_handler,
 175         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 176         .cable_detect           = vt6421_pata_cable_detect,
 177
 178         .irq_clear              = ata_bmdma_irq_clear,
 179         .irq_on                 = ata_irq_on,
 180         .irq_ack                = ata_irq_ack,
 181
 182         .port_start             = ata_port_start,
 183 };
 184
 185 static const struct ata_port_operations vt6421_sata_ops = {
 186         .port_disable           = ata_port_disable,
 187
 188         .tf_load                = ata_tf_load,
 189         .tf_read                = ata_tf_read,
 190         .check_status           = ata_check_status,
 191         .exec_command           = ata_exec_command,
 192         .dev_select             = ata_std_dev_select,
 193
 194         .bmdma_setup            = ata_bmdma_setup,
 195         .bmdma_start            = ata_bmdma_start,
 196         .bmdma_stop             = ata_bmdma_stop,
 197         .bmdma_status           = ata_bmdma_status,
 198
 199         .qc_prep                = ata_qc_prep,
 200         .qc_issue               = ata_qc_issue_prot,
 201         .data_xfer              = ata_data_xfer,
 202
 203         .freeze                 = ata_bmdma_freeze,
 204         .thaw                   = ata_bmdma_thaw,
 205         .error_handler          = ata_bmdma_error_handler,
 206         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 207         .cable_detect           = ata_cable_sata,
 208
 209         .irq_clear              = ata_bmdma_irq_clear,
 210         .irq_on                 = ata_irq_on,
 211         .irq_ack                = ata_irq_ack,
 212
 213         .scr_read               = svia_scr_read,
 214         .scr_write              = svia_scr_write,
 215
 216         .port_start             = ata_port_start,
 217 };
 218
 219 static const struct ata_port_info vt6420_port_info = {
 220         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 221         .pio_mask       = 0x1f,
 222         .mwdma_mask     = 0x07,
 223         .udma_mask      = 0x7f,
 224         .port_ops       = &vt6420_sata_ops,
 225 };
 226
 227 static struct ata_port_info vt6421_sport_info = {
 228         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 229         .pio_mask       = 0x1f,
 230         .mwdma_mask     = 0x07,
 231         .udma_mask      = 0x7f,
 232         .port_ops       = &vt6421_sata_ops,
 233 };
 234
 235 static struct ata_port_info vt6421_pport_info = {
 236         .flags          = ATA_FLAG_SLAVE_POSS | ATA_FLAG_NO_LEGACY,
 237         .pio_mask       = 0x1f,
 238         .mwdma_mask     = 0,
 239         .udma_mask      = 0x7f,
 240         .port_ops       = &vt6421_pata_ops,
 241 };
 242
 243 MODULE_AUTHOR("Jeff Garzik");
 244 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
 245 MODULE_LICENSE("GPL");
 246 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
 247 MODULE_VERSION(DRV_VERSION);
 248
 249 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
 250 {
 251         if (sc_reg > SCR_CONTROL)
 252                 return 0xffffffffU;
 253         return ioread32(ap->ioaddr.scr_addr + (4 * sc_reg));
 254 }
 255
 256 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
 257 {
 258         if (sc_reg > SCR_CONTROL)
 259                 return;
 260         iowrite32(val, ap->ioaddr.scr_addr + (4 * sc_reg));
 261 }
 262
 263 static void svia_noop_freeze(struct ata_port *ap)
 264 {
 265         /* Some VIA controllers choke if ATA_NIEN is manipulated in
 266          * certain way.  Leave it alone and just clear pending IRQ.
 267          */
 268         ata_chk_status(ap);
 269         ata_bmdma_irq_clear(ap);
 270 }
 271
 272 /**
 273  *      vt6420_prereset - prereset for vt6420
 274  *      @ap: target ATA port
 275  *      @deadline: deadline jiffies for the operation
 276  *
 277  *      SCR registers on vt6420 are pieces of shit and may hang the
 278  *      whole machine completely if accessed with the wrong timing.
 279  *      To avoid such catastrophe, vt6420 doesn't provide generic SCR
 280  *      access operations, but uses SStatus and SControl only during
 281  *      boot probing in controlled way.
 282  *
 283  *      As the old (pre EH update) probing code is proven to work, we
 284  *      strictly follow the access pattern.
 285  *
 286  *      LOCKING:
 287  *      Kernel thread context (may sleep)
 288  *
 289  *      RETURNS:
 290  *      0 on success, -errno otherwise.
 291  */
 292 static int vt6420_prereset(struct ata_port *ap, unsigned long deadline)
 293 {
 294         struct ata_eh_context *ehc = &ap->eh_context;
 295         unsigned long timeout = jiffies + (HZ * 5);
 296         u32 sstatus, scontrol;
 297         int online;
 298
 299         /* don't do any SCR stuff if we're not loading */
 300         if (!(ap->pflags & ATA_PFLAG_LOADING))
 301                 goto skip_scr;
 302
 303         /* Resume phy.  This is the old resume sequence from
 304          * __sata_phy_reset().
 305          */
 306         svia_scr_write(ap, SCR_CONTROL, 0x300);
 307         svia_scr_read(ap, SCR_CONTROL); /* flush */
 308
 309         /* wait for phy to become ready, if necessary */
 310         do {
 311                 msleep(200);
 312                 if ((svia_scr_read(ap, SCR_STATUS) & 0xf) != 1)
 313                         break;
 314         } while (time_before(jiffies, timeout));
 315
 316         /* open code sata_print_link_status() */
 317         sstatus = svia_scr_read(ap, SCR_STATUS);
 318         scontrol = svia_scr_read(ap, SCR_CONTROL);
 319
 320         online = (sstatus & 0xf) == 0x3;
 321
 322         ata_port_printk(ap, KERN_INFO,
 323                         "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
 324                         online ? "up" : "down", sstatus, scontrol);
 325
 326         /* SStatus is read one more time */
 327         svia_scr_read(ap, SCR_STATUS);
 328
 329         if (!online) {
 330                 /* tell EH to bail */
 331                 ehc->i.action &= ~ATA_EH_RESET_MASK;
 332                 return 0;
 333         }
 334
 335  skip_scr:
 336         /* wait for !BSY */
 337         ata_wait_ready(ap, deadline);
 338
 339         return 0;
 340 }
 341
 342 static void vt6420_error_handler(struct ata_port *ap)
 343 {
 344         return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
 345                                   NULL, ata_std_postreset);
 346 }
 347
 348 static int vt6421_pata_cable_detect(struct ata_port *ap)
 349 {
 350         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 351         u8 tmp;
 352
 353         pci_read_config_byte(pdev, PATA_UDMA_TIMING, &tmp);
 354         if (tmp & 0x10)
 355                 return ATA_CBL_PATA40;
 356         return ATA_CBL_PATA80;
 357 }
 358
 359 static void vt6421_set_pio_mode(struct ata_port *ap, struct ata_device *adev)
 360 {
 361         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 362         static const u8 pio_bits[] = { 0xA8, 0x65, 0x65, 0x31, 0x20 };
 363         pci_write_config_byte(pdev, PATA_PIO_TIMING, pio_bits[adev->pio_mode - XFER_PIO_0]);
 364 }
 365
 366 static void vt6421_set_dma_mode(struct ata_port *ap, struct ata_device *adev)
 367 {
 368         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 369         static const u8 udma_bits[] = { 0xEE, 0xE8, 0xE6, 0xE4, 0xE2, 0xE1, 0xE0, 0xE0 };
 370         pci_write_config_byte(pdev, PATA_UDMA_TIMING, udma_bits[adev->pio_mode - XFER_UDMA_0]);
 371 }
 372
 373 static const unsigned int svia_bar_sizes[] = {
 374         8, 4, 8, 4, 16, 256
 375 };
 376
 377 static const unsigned int vt6421_bar_sizes[] = {
 378         16, 16, 16, 16, 32, 128
 379 };
 380
 381 static void __iomem * svia_scr_addr(void __iomem *addr, unsigned int port)
 382 {
 383         return addr + (port * 128);
 384 }
 385
 386 static void __iomem * vt6421_scr_addr(void __iomem *addr, unsigned int port)
 387 {
 388         return addr + (port * 64);
 389 }
 390
 391 static void vt6421_init_addrs(struct ata_port *ap)
 392 {
 393         void __iomem * const * iomap = ap->host->iomap;
 394         void __iomem *reg_addr = iomap[ap->port_no];
 395         void __iomem *bmdma_addr = iomap[4] + (ap->port_no * 8);
 396         struct ata_ioports *ioaddr = &ap->ioaddr;
 397
 398         ioaddr->cmd_addr = reg_addr;
 399         ioaddr->altstatus_addr =
 400         ioaddr->ctl_addr = (void __iomem *)
 401                 ((unsigned long)(reg_addr + 8) | ATA_PCI_CTL_OFS);
 402         ioaddr->bmdma_addr = bmdma_addr;
 403         ioaddr->scr_addr = vt6421_scr_addr(iomap[5], ap->port_no);
 404
 405         ata_std_ports(ioaddr);
 406 }
 407
 408 static int vt6420_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
 409 {
 410         const struct ata_port_info *ppi[] = { &vt6420_port_info, NULL };
 411         struct ata_host *host;
 412         int rc;
 413
 414         rc = ata_pci_prepare_native_host(pdev, ppi, &host);
 415         if (rc)
 416                 return rc;
 417         *r_host = host;
 418
 419         rc = pcim_iomap_regions(pdev, 1 << 5, DRV_NAME);
 420         if (rc) {
 421                 dev_printk(KERN_ERR, &pdev->dev, "failed to iomap PCI BAR 5\n");
 422                 return rc;
 423         }
 424
 425         host->ports[0]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 0);
 426         host->ports[1]->ioaddr.scr_addr = svia_scr_addr(host->iomap[5], 1);
 427
 428         return 0;
 429 }
 430
 431 static int vt6421_prepare_host(struct pci_dev *pdev, struct ata_host **r_host)
 432 {
 433         const struct ata_port_info *ppi[] =
 434                 { &vt6421_sport_info, &vt6421_sport_info, &vt6421_pport_info };
 435         struct ata_host *host;
 436         int i, rc;
 437
 438         *r_host = host = ata_host_alloc_pinfo(&pdev->dev, ppi, ARRAY_SIZE(ppi));
 439         if (!host) {
 440                 dev_printk(KERN_ERR, &pdev->dev, "failed to allocate host\n");
 441                 return -ENOMEM;
 442         }
 443
 444         rc = pcim_iomap_regions(pdev, 0x3f, DRV_NAME);
 445         if (rc) {
 446                 dev_printk(KERN_ERR, &pdev->dev, "failed to request/iomap "
 447                            "PCI BARs (errno=%d)\n", rc);
 448                 return rc;
 449         }
 450         host->iomap = pcim_iomap_table(pdev);
 451
 452         for (i = 0; i < host->n_ports; i++)
 453                 vt6421_init_addrs(host->ports[i]);
 454
 455         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 456         if (rc)
 457                 return rc;
 458         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 459         if (rc)
 460                 return rc;
 461
 462         return 0;
 463 }
 464
 465 static void svia_configure(struct pci_dev *pdev)
 466 {
 467         u8 tmp8;
 468
 469         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
 470         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
 471                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
 472
 473         /* make sure SATA channels are enabled */
 474         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
 475         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 476                 dev_printk(KERN_DEBUG, &pdev->dev,
 477                            "enabling SATA channels (0x%x)\n",
 478                            (int) tmp8);
 479                 tmp8 |= ALL_PORTS;
 480                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
 481         }
 482
 483         /* make sure interrupts for each channel sent to us */
 484         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
 485         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 486                 dev_printk(KERN_DEBUG, &pdev->dev,
 487                            "enabling SATA channel interrupts (0x%x)\n",
 488                            (int) tmp8);
 489                 tmp8 |= ALL_PORTS;
 490                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
 491         }
 492
 493         /* make sure native mode is enabled */
 494         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
 495         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
 496                 dev_printk(KERN_DEBUG, &pdev->dev,
 497                            "enabling SATA channel native mode (0x%x)\n",
 498                            (int) tmp8);
 499                 tmp8 |= NATIVE_MODE_ALL;
 500                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
 501         }
 502 }
 503
 504 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 505 {
 506         static int printed_version;
 507         unsigned int i;
 508         int rc;
 509         struct ata_host *host;
 510         int board_id = (int) ent->driver_data;
 511         const int *bar_sizes;
 512         u8 tmp8;
 513
 514         if (!printed_version++)
 515                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 516
 517         rc = pcim_enable_device(pdev);
 518         if (rc)
 519                 return rc;
 520
 521         if (board_id == vt6420) {
 522                 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
 523                 if (tmp8 & SATA_2DEV) {
 524                         dev_printk(KERN_ERR, &pdev->dev,
 525                                    "SATA master/slave not supported (0x%x)\n",
 526                                    (int) tmp8);
 527                         return -EIO;
 528                 }
 529
 530                 bar_sizes = &svia_bar_sizes[0];
 531         } else {
 532                 bar_sizes = &vt6421_bar_sizes[0];
 533         }
 534
 535         for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
 536                 if ((pci_resource_start(pdev, i) == 0) ||
 537                     (pci_resource_len(pdev, i) < bar_sizes[i])) {
 538                         dev_printk(KERN_ERR, &pdev->dev,
 539                                 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
 540                                 i,
 541                                 (unsigned long long)pci_resource_start(pdev, i),
 542                                 (unsigned long long)pci_resource_len(pdev, i));
 543                         return -ENODEV;
 544                 }
 545
 546         if (board_id == vt6420)
 547                 rc = vt6420_prepare_host(pdev, &host);
 548         else
 549                 rc = vt6421_prepare_host(pdev, &host);
 550         if (rc)
 551                 return rc;
 552
 553         svia_configure(pdev);
 554
 555         pci_set_master(pdev);
 556         return ata_host_activate(host, pdev->irq, ata_interrupt, IRQF_SHARED,
 557                                  &svia_sht);
 558 }
 559
 560 static int __init svia_init(void)
 561 {
 562         return pci_register_driver(&svia_pci_driver);
 563 }
 564
 565 static void __exit svia_exit(void)
 566 {
 567         pci_unregister_driver(&svia_pci_driver);
 568 }
 569
 570 module_init(svia_init);
 571 module_exit(svia_exit);