drivers/scsi/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 #include <asm/io.h>
  48
  49 #define DRV_NAME        "sata_via"
  50 #define DRV_VERSION     "2.0"
  51
  52 enum board_ids_enum {
  53         vt6420,
  54         vt6421,
  55 };
  56
  57 enum {
  58         SATA_CHAN_ENAB          = 0x40, /* SATA channel enable */
  59         SATA_INT_GATE           = 0x41, /* SATA interrupt gating */
  60         SATA_NATIVE_MODE        = 0x42, /* Native mode enable */
  61         SATA_PATA_SHARING       = 0x49, /* PATA/SATA sharing func ctrl */
  62
  63         PORT0                   = (1 << 1),
  64         PORT1                   = (1 << 0),
  65         ALL_PORTS               = PORT0 | PORT1,
  66         N_PORTS                 = 2,
  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 vt6420_error_handler(struct ata_port *ap);
  78
  79 static const struct pci_device_id svia_pci_tbl[] = {
  80         { 0x1106, 0x3149, PCI_ANY_ID, PCI_ANY_ID, 0, 0, vt6420 },
  81         { 0x1106, 0x3249, PCI_ANY_ID, PCI_ANY_ID, 0, 0, vt6421 },
  82
  83         { }     /* terminate list */
  84 };
  85
  86 static struct pci_driver svia_pci_driver = {
  87         .name                   = DRV_NAME,
  88         .id_table               = svia_pci_tbl,
  89         .probe                  = svia_init_one,
  90         .remove                 = ata_pci_remove_one,
  91 };
  92
  93 static struct scsi_host_template svia_sht = {
  94         .module                 = THIS_MODULE,
  95         .name                   = DRV_NAME,
  96         .ioctl                  = ata_scsi_ioctl,
  97         .queuecommand           = ata_scsi_queuecmd,
  98         .can_queue              = ATA_DEF_QUEUE,
  99         .this_id                = ATA_SHT_THIS_ID,
 100         .sg_tablesize           = LIBATA_MAX_PRD,
 101         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 102         .emulated               = ATA_SHT_EMULATED,
 103         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 104         .proc_name              = DRV_NAME,
 105         .dma_boundary           = ATA_DMA_BOUNDARY,
 106         .slave_configure        = ata_scsi_slave_config,
 107         .slave_destroy          = ata_scsi_slave_destroy,
 108         .bios_param             = ata_std_bios_param,
 109 };
 110
 111 static const struct ata_port_operations vt6420_sata_ops = {
 112         .port_disable           = ata_port_disable,
 113
 114         .tf_load                = ata_tf_load,
 115         .tf_read                = ata_tf_read,
 116         .check_status           = ata_check_status,
 117         .exec_command           = ata_exec_command,
 118         .dev_select             = ata_std_dev_select,
 119
 120         .bmdma_setup            = ata_bmdma_setup,
 121         .bmdma_start            = ata_bmdma_start,
 122         .bmdma_stop             = ata_bmdma_stop,
 123         .bmdma_status           = ata_bmdma_status,
 124
 125         .qc_prep                = ata_qc_prep,
 126         .qc_issue               = ata_qc_issue_prot,
 127         .data_xfer              = ata_pio_data_xfer,
 128
 129         .freeze                 = ata_bmdma_freeze,
 130         .thaw                   = ata_bmdma_thaw,
 131         .error_handler          = vt6420_error_handler,
 132         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 133
 134         .irq_handler            = ata_interrupt,
 135         .irq_clear              = ata_bmdma_irq_clear,
 136
 137         .port_start             = ata_port_start,
 138         .port_stop              = ata_port_stop,
 139         .host_stop              = ata_host_stop,
 140 };
 141
 142 static const struct ata_port_operations vt6421_sata_ops = {
 143         .port_disable           = ata_port_disable,
 144
 145         .tf_load                = ata_tf_load,
 146         .tf_read                = ata_tf_read,
 147         .check_status           = ata_check_status,
 148         .exec_command           = ata_exec_command,
 149         .dev_select             = ata_std_dev_select,
 150
 151         .bmdma_setup            = ata_bmdma_setup,
 152         .bmdma_start            = ata_bmdma_start,
 153         .bmdma_stop             = ata_bmdma_stop,
 154         .bmdma_status           = ata_bmdma_status,
 155
 156         .qc_prep                = ata_qc_prep,
 157         .qc_issue               = ata_qc_issue_prot,
 158         .data_xfer              = ata_pio_data_xfer,
 159
 160         .freeze                 = ata_bmdma_freeze,
 161         .thaw                   = ata_bmdma_thaw,
 162         .error_handler          = ata_bmdma_error_handler,
 163         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 164
 165         .irq_handler            = ata_interrupt,
 166         .irq_clear              = ata_bmdma_irq_clear,
 167
 168         .scr_read               = svia_scr_read,
 169         .scr_write              = svia_scr_write,
 170
 171         .port_start             = ata_port_start,
 172         .port_stop              = ata_port_stop,
 173         .host_stop              = ata_host_stop,
 174 };
 175
 176 static struct ata_port_info vt6420_port_info = {
 177         .sht            = &svia_sht,
 178         .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 179         .pio_mask       = 0x1f,
 180         .mwdma_mask     = 0x07,
 181         .udma_mask      = 0x7f,
 182         .port_ops       = &vt6420_sata_ops,
 183 };
 184
 185 MODULE_AUTHOR("Jeff Garzik");
 186 MODULE_DESCRIPTION("SCSI low-level driver for VIA SATA controllers");
 187 MODULE_LICENSE("GPL");
 188 MODULE_DEVICE_TABLE(pci, svia_pci_tbl);
 189 MODULE_VERSION(DRV_VERSION);
 190
 191 static u32 svia_scr_read (struct ata_port *ap, unsigned int sc_reg)
 192 {
 193         if (sc_reg > SCR_CONTROL)
 194                 return 0xffffffffU;
 195         return inl(ap->ioaddr.scr_addr + (4 * sc_reg));
 196 }
 197
 198 static void svia_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
 199 {
 200         if (sc_reg > SCR_CONTROL)
 201                 return;
 202         outl(val, ap->ioaddr.scr_addr + (4 * sc_reg));
 203 }
 204
 205 /**
 206  *      vt6420_prereset - prereset for vt6420
 207  *      @ap: target ATA port
 208  *
 209  *      SCR registers on vt6420 are pieces of shit and may hang the
 210  *      whole machine completely if accessed with the wrong timing.
 211  *      To avoid such catastrophe, vt6420 doesn't provide generic SCR
 212  *      access operations, but uses SStatus and SControl only during
 213  *      boot probing in controlled way.
 214  *
 215  *      As the old (pre EH update) probing code is proven to work, we
 216  *      strictly follow the access pattern.
 217  *
 218  *      LOCKING:
 219  *      Kernel thread context (may sleep)
 220  *
 221  *      RETURNS:
 222  *      0 on success, -errno otherwise.
 223  */
 224 static int vt6420_prereset(struct ata_port *ap)
 225 {
 226         struct ata_eh_context *ehc = &ap->eh_context;
 227         unsigned long timeout = jiffies + (HZ * 5);
 228         u32 sstatus, scontrol;
 229         int online;
 230
 231         /* don't do any SCR stuff if we're not loading */
 232         if (!ATA_PFLAG_LOADING)
 233                 goto skip_scr;
 234
 235         /* Resume phy.  This is the old resume sequence from
 236          * __sata_phy_reset().
 237          */
 238         svia_scr_write(ap, SCR_CONTROL, 0x300);
 239         svia_scr_read(ap, SCR_CONTROL); /* flush */
 240
 241         /* wait for phy to become ready, if necessary */
 242         do {
 243                 msleep(200);
 244                 if ((svia_scr_read(ap, SCR_STATUS) & 0xf) != 1)
 245                         break;
 246         } while (time_before(jiffies, timeout));
 247
 248         /* open code sata_print_link_status() */
 249         sstatus = svia_scr_read(ap, SCR_STATUS);
 250         scontrol = svia_scr_read(ap, SCR_CONTROL);
 251
 252         online = (sstatus & 0xf) == 0x3;
 253
 254         ata_port_printk(ap, KERN_INFO,
 255                         "SATA link %s 1.5 Gbps (SStatus %X SControl %X)\n",
 256                         online ? "up" : "down", sstatus, scontrol);
 257
 258         /* SStatus is read one more time */
 259         svia_scr_read(ap, SCR_STATUS);
 260
 261         if (!online) {
 262                 /* tell EH to bail */
 263                 ehc->i.action &= ~ATA_EH_RESET_MASK;
 264                 return 0;
 265         }
 266
 267  skip_scr:
 268         /* wait for !BSY */
 269         ata_busy_sleep(ap, ATA_TMOUT_BOOT_QUICK, ATA_TMOUT_BOOT);
 270
 271         return 0;
 272 }
 273
 274 static void vt6420_error_handler(struct ata_port *ap)
 275 {
 276         return ata_bmdma_drive_eh(ap, vt6420_prereset, ata_std_softreset,
 277                                   NULL, ata_std_postreset);
 278 }
 279
 280 static const unsigned int svia_bar_sizes[] = {
 281         8, 4, 8, 4, 16, 256
 282 };
 283
 284 static const unsigned int vt6421_bar_sizes[] = {
 285         16, 16, 16, 16, 32, 128
 286 };
 287
 288 static unsigned long svia_scr_addr(unsigned long addr, unsigned int port)
 289 {
 290         return addr + (port * 128);
 291 }
 292
 293 static unsigned long vt6421_scr_addr(unsigned long addr, unsigned int port)
 294 {
 295         return addr + (port * 64);
 296 }
 297
 298 static void vt6421_init_addrs(struct ata_probe_ent *probe_ent,
 299                               struct pci_dev *pdev,
 300                               unsigned int port)
 301 {
 302         unsigned long reg_addr = pci_resource_start(pdev, port);
 303         unsigned long bmdma_addr = pci_resource_start(pdev, 4) + (port * 8);
 304         unsigned long scr_addr;
 305
 306         probe_ent->port[port].cmd_addr = reg_addr;
 307         probe_ent->port[port].altstatus_addr =
 308         probe_ent->port[port].ctl_addr = (reg_addr + 8) | ATA_PCI_CTL_OFS;
 309         probe_ent->port[port].bmdma_addr = bmdma_addr;
 310
 311         scr_addr = vt6421_scr_addr(pci_resource_start(pdev, 5), port);
 312         probe_ent->port[port].scr_addr = scr_addr;
 313
 314         ata_std_ports(&probe_ent->port[port]);
 315 }
 316
 317 static struct ata_probe_ent *vt6420_init_probe_ent(struct pci_dev *pdev)
 318 {
 319         struct ata_probe_ent *probe_ent;
 320         struct ata_port_info *ppi = &vt6420_port_info;
 321
 322         probe_ent = ata_pci_init_native_mode(pdev, &ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
 323         if (!probe_ent)
 324                 return NULL;
 325
 326         probe_ent->port[0].scr_addr =
 327                 svia_scr_addr(pci_resource_start(pdev, 5), 0);
 328         probe_ent->port[1].scr_addr =
 329                 svia_scr_addr(pci_resource_start(pdev, 5), 1);
 330
 331         return probe_ent;
 332 }
 333
 334 static struct ata_probe_ent *vt6421_init_probe_ent(struct pci_dev *pdev)
 335 {
 336         struct ata_probe_ent *probe_ent;
 337         unsigned int i;
 338
 339         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
 340         if (!probe_ent)
 341                 return NULL;
 342
 343         memset(probe_ent, 0, sizeof(*probe_ent));
 344         probe_ent->dev = pci_dev_to_dev(pdev);
 345         INIT_LIST_HEAD(&probe_ent->node);
 346
 347         probe_ent->sht          = &svia_sht;
 348         probe_ent->host_flags   = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY;
 349         probe_ent->port_ops     = &vt6421_sata_ops;
 350         probe_ent->n_ports      = N_PORTS;
 351         probe_ent->irq          = pdev->irq;
 352         probe_ent->irq_flags    = IRQF_SHARED;
 353         probe_ent->pio_mask     = 0x1f;
 354         probe_ent->mwdma_mask   = 0x07;
 355         probe_ent->udma_mask    = 0x7f;
 356
 357         for (i = 0; i < N_PORTS; i++)
 358                 vt6421_init_addrs(probe_ent, pdev, i);
 359
 360         return probe_ent;
 361 }
 362
 363 static void svia_configure(struct pci_dev *pdev)
 364 {
 365         u8 tmp8;
 366
 367         pci_read_config_byte(pdev, PCI_INTERRUPT_LINE, &tmp8);
 368         dev_printk(KERN_INFO, &pdev->dev, "routed to hard irq line %d\n",
 369                (int) (tmp8 & 0xf0) == 0xf0 ? 0 : tmp8 & 0x0f);
 370
 371         /* make sure SATA channels are enabled */
 372         pci_read_config_byte(pdev, SATA_CHAN_ENAB, &tmp8);
 373         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 374                 dev_printk(KERN_DEBUG, &pdev->dev,
 375                            "enabling SATA channels (0x%x)\n",
 376                            (int) tmp8);
 377                 tmp8 |= ALL_PORTS;
 378                 pci_write_config_byte(pdev, SATA_CHAN_ENAB, tmp8);
 379         }
 380
 381         /* make sure interrupts for each channel sent to us */
 382         pci_read_config_byte(pdev, SATA_INT_GATE, &tmp8);
 383         if ((tmp8 & ALL_PORTS) != ALL_PORTS) {
 384                 dev_printk(KERN_DEBUG, &pdev->dev,
 385                            "enabling SATA channel interrupts (0x%x)\n",
 386                            (int) tmp8);
 387                 tmp8 |= ALL_PORTS;
 388                 pci_write_config_byte(pdev, SATA_INT_GATE, tmp8);
 389         }
 390
 391         /* make sure native mode is enabled */
 392         pci_read_config_byte(pdev, SATA_NATIVE_MODE, &tmp8);
 393         if ((tmp8 & NATIVE_MODE_ALL) != NATIVE_MODE_ALL) {
 394                 dev_printk(KERN_DEBUG, &pdev->dev,
 395                            "enabling SATA channel native mode (0x%x)\n",
 396                            (int) tmp8);
 397                 tmp8 |= NATIVE_MODE_ALL;
 398                 pci_write_config_byte(pdev, SATA_NATIVE_MODE, tmp8);
 399         }
 400 }
 401
 402 static int svia_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 403 {
 404         static int printed_version;
 405         unsigned int i;
 406         int rc;
 407         struct ata_probe_ent *probe_ent;
 408         int board_id = (int) ent->driver_data;
 409         const int *bar_sizes;
 410         int pci_dev_busy = 0;
 411         u8 tmp8;
 412
 413         if (!printed_version++)
 414                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 415
 416         rc = pci_enable_device(pdev);
 417         if (rc)
 418                 return rc;
 419
 420         rc = pci_request_regions(pdev, DRV_NAME);
 421         if (rc) {
 422                 pci_dev_busy = 1;
 423                 goto err_out;
 424         }
 425
 426         if (board_id == vt6420) {
 427                 pci_read_config_byte(pdev, SATA_PATA_SHARING, &tmp8);
 428                 if (tmp8 & SATA_2DEV) {
 429                         dev_printk(KERN_ERR, &pdev->dev,
 430                                    "SATA master/slave not supported (0x%x)\n",
 431                                    (int) tmp8);
 432                         rc = -EIO;
 433                         goto err_out_regions;
 434                 }
 435
 436                 bar_sizes = &svia_bar_sizes[0];
 437         } else {
 438                 bar_sizes = &vt6421_bar_sizes[0];
 439         }
 440
 441         for (i = 0; i < ARRAY_SIZE(svia_bar_sizes); i++)
 442                 if ((pci_resource_start(pdev, i) == 0) ||
 443                     (pci_resource_len(pdev, i) < bar_sizes[i])) {
 444                         dev_printk(KERN_ERR, &pdev->dev,
 445                                 "invalid PCI BAR %u (sz 0x%llx, val 0x%llx)\n",
 446                                 i,
 447                                 (unsigned long long)pci_resource_start(pdev, i),
 448                                 (unsigned long long)pci_resource_len(pdev, i));
 449                         rc = -ENODEV;
 450                         goto err_out_regions;
 451                 }
 452
 453         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 454         if (rc)
 455                 goto err_out_regions;
 456         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 457         if (rc)
 458                 goto err_out_regions;
 459
 460         if (board_id == vt6420)
 461                 probe_ent = vt6420_init_probe_ent(pdev);
 462         else
 463                 probe_ent = vt6421_init_probe_ent(pdev);
 464
 465         if (!probe_ent) {
 466                 dev_printk(KERN_ERR, &pdev->dev, "out of memory\n");
 467                 rc = -ENOMEM;
 468                 goto err_out_regions;
 469         }
 470
 471         svia_configure(pdev);
 472
 473         pci_set_master(pdev);
 474
 475         /* FIXME: check ata_device_add return value */
 476         ata_device_add(probe_ent);
 477         kfree(probe_ent);
 478
 479         return 0;
 480
 481 err_out_regions:
 482         pci_release_regions(pdev);
 483 err_out:
 484         if (!pci_dev_busy)
 485                 pci_disable_device(pdev);
 486         return rc;
 487 }
 488
 489 static int __init svia_init(void)
 490 {
 491         return pci_module_init(&svia_pci_driver);
 492 }
 493
 494 static void __exit svia_exit(void)
 495 {
 496         pci_unregister_driver(&svia_pci_driver);
 497 }
 498
 499 module_init(svia_init);
 500 module_exit(svia_exit);
 501