drivers/scsi/sata_sil.c

   1 /*
   2  *  sata_sil.c - Silicon Image SATA
   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-2005 Red Hat, Inc.
   9  *  Copyright 2003 Benjamin Herrenschmidt
  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  *  Documentation for SiI 3112:
  31  *  http://gkernel.sourceforge.net/specs/sii/3112A_SiI-DS-0095-B2.pdf.bz2
  32  *
  33  *  Other errata and documentation available under NDA.
  34  *
  35  */
  36
  37 #include <linux/kernel.h>
  38 #include <linux/module.h>
  39 #include <linux/pci.h>
  40 #include <linux/init.h>
  41 #include <linux/blkdev.h>
  42 #include <linux/delay.h>
  43 #include <linux/interrupt.h>
  44 #include <linux/device.h>
  45 #include "scsi.h"
  46 #include <scsi/scsi_host.h>
  47 #include <linux/libata.h>
  48
  49 #define DRV_NAME        "sata_sil"
  50 #define DRV_VERSION     "0.9"
  51
  52 enum {
  53         SIL_FLAG_MOD15WRITE     = (1 << 30),
  54
  55         sil_3112                = 0,
  56         sil_3112_m15w           = 1,
  57         sil_3114                = 2,
  58
  59         SIL_FIFO_R0             = 0x40,
  60         SIL_FIFO_W0             = 0x41,
  61         SIL_FIFO_R1             = 0x44,
  62         SIL_FIFO_W1             = 0x45,
  63         SIL_FIFO_R2             = 0x240,
  64         SIL_FIFO_W2             = 0x241,
  65         SIL_FIFO_R3             = 0x244,
  66         SIL_FIFO_W3             = 0x245,
  67
  68         SIL_SYSCFG              = 0x48,
  69         SIL_MASK_IDE0_INT       = (1 << 22),
  70         SIL_MASK_IDE1_INT       = (1 << 23),
  71         SIL_MASK_IDE2_INT       = (1 << 24),
  72         SIL_MASK_IDE3_INT       = (1 << 25),
  73         SIL_MASK_2PORT          = SIL_MASK_IDE0_INT | SIL_MASK_IDE1_INT,
  74         SIL_MASK_4PORT          = SIL_MASK_2PORT |
  75                                   SIL_MASK_IDE2_INT | SIL_MASK_IDE3_INT,
  76
  77         SIL_IDE2_BMDMA          = 0x200,
  78
  79         SIL_INTR_STEERING       = (1 << 1),
  80         SIL_QUIRK_MOD15WRITE    = (1 << 0),
  81         SIL_QUIRK_UDMA5MAX      = (1 << 1),
  82 };
  83
  84 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
  85 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev);
  86 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg);
  87 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
  88 static void sil_post_set_mode (struct ata_port *ap);
  89
  90
  91 static struct pci_device_id sil_pci_tbl[] = {
  92         { 0x1095, 0x3112, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
  93         { 0x1095, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
  94         { 0x1095, 0x3512, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112 },
  95         { 0x1095, 0x3114, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3114 },
  96         { 0x1002, 0x436e, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
  97         { 0x1002, 0x4379, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
  98         { 0x1002, 0x437a, PCI_ANY_ID, PCI_ANY_ID, 0, 0, sil_3112_m15w },
  99         { }     /* terminate list */
 100 };
 101
 102
 103 /* TODO firmware versions should be added - eric */
 104 static const struct sil_drivelist {
 105         const char * product;
 106         unsigned int quirk;
 107 } sil_blacklist [] = {
 108         { "ST320012AS",         SIL_QUIRK_MOD15WRITE },
 109         { "ST330013AS",         SIL_QUIRK_MOD15WRITE },
 110         { "ST340017AS",         SIL_QUIRK_MOD15WRITE },
 111         { "ST360015AS",         SIL_QUIRK_MOD15WRITE },
 112         { "ST380013AS",         SIL_QUIRK_MOD15WRITE },
 113         { "ST380023AS",         SIL_QUIRK_MOD15WRITE },
 114         { "ST3120023AS",        SIL_QUIRK_MOD15WRITE },
 115         { "ST3160023AS",        SIL_QUIRK_MOD15WRITE },
 116         { "ST3120026AS",        SIL_QUIRK_MOD15WRITE },
 117         { "ST3200822AS",        SIL_QUIRK_MOD15WRITE },
 118         { "ST340014ASL",        SIL_QUIRK_MOD15WRITE },
 119         { "ST360014ASL",        SIL_QUIRK_MOD15WRITE },
 120         { "ST380011ASL",        SIL_QUIRK_MOD15WRITE },
 121         { "ST3120022ASL",       SIL_QUIRK_MOD15WRITE },
 122         { "ST3160021ASL",       SIL_QUIRK_MOD15WRITE },
 123         { "Maxtor 4D060H3",     SIL_QUIRK_UDMA5MAX },
 124         { }
 125 };
 126
 127 static struct pci_driver sil_pci_driver = {
 128         .name                   = DRV_NAME,
 129         .id_table               = sil_pci_tbl,
 130         .probe                  = sil_init_one,
 131         .remove                 = ata_pci_remove_one,
 132 };
 133
 134 static Scsi_Host_Template sil_sht = {
 135         .module                 = THIS_MODULE,
 136         .name                   = DRV_NAME,
 137         .ioctl                  = ata_scsi_ioctl,
 138         .queuecommand           = ata_scsi_queuecmd,
 139         .eh_strategy_handler    = ata_scsi_error,
 140         .can_queue              = ATA_DEF_QUEUE,
 141         .this_id                = ATA_SHT_THIS_ID,
 142         .sg_tablesize           = LIBATA_MAX_PRD,
 143         .max_sectors            = ATA_MAX_SECTORS,
 144         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 145         .emulated               = ATA_SHT_EMULATED,
 146         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 147         .proc_name              = DRV_NAME,
 148         .dma_boundary           = ATA_DMA_BOUNDARY,
 149         .slave_configure        = ata_scsi_slave_config,
 150         .bios_param             = ata_std_bios_param,
 151         .ordered_flush          = 1,
 152 };
 153
 154 static const struct ata_port_operations sil_ops = {
 155         .port_disable           = ata_port_disable,
 156         .dev_config             = sil_dev_config,
 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         .phy_reset              = sata_phy_reset,
 163         .post_set_mode          = sil_post_set_mode,
 164         .bmdma_setup            = ata_bmdma_setup,
 165         .bmdma_start            = ata_bmdma_start,
 166         .bmdma_stop             = ata_bmdma_stop,
 167         .bmdma_status           = ata_bmdma_status,
 168         .qc_prep                = ata_qc_prep,
 169         .qc_issue               = ata_qc_issue_prot,
 170         .eng_timeout            = ata_eng_timeout,
 171         .irq_handler            = ata_interrupt,
 172         .irq_clear              = ata_bmdma_irq_clear,
 173         .scr_read               = sil_scr_read,
 174         .scr_write              = sil_scr_write,
 175         .port_start             = ata_port_start,
 176         .port_stop              = ata_port_stop,
 177         .host_stop              = ata_pci_host_stop,
 178 };
 179
 180 static struct ata_port_info sil_port_info[] = {
 181         /* sil_3112 */
 182         {
 183                 .sht            = &sil_sht,
 184                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
 185                                   ATA_FLAG_SRST | ATA_FLAG_MMIO,
 186                 .pio_mask       = 0x1f,                 /* pio0-4 */
 187                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
 188                 .udma_mask      = 0x3f,                 /* udma0-5 */
 189                 .port_ops       = &sil_ops,
 190         }, /* sil_3112_15w - keep it sync'd w/ sil_3112 */
 191         {
 192                 .sht            = &sil_sht,
 193                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
 194                                   ATA_FLAG_SRST | ATA_FLAG_MMIO |
 195                                   SIL_FLAG_MOD15WRITE,
 196                 .pio_mask       = 0x1f,                 /* pio0-4 */
 197                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
 198                 .udma_mask      = 0x3f,                 /* udma0-5 */
 199                 .port_ops       = &sil_ops,
 200         }, /* sil_3114 */
 201         {
 202                 .sht            = &sil_sht,
 203                 .host_flags     = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY |
 204                                   ATA_FLAG_SRST | ATA_FLAG_MMIO,
 205                 .pio_mask       = 0x1f,                 /* pio0-4 */
 206                 .mwdma_mask     = 0x07,                 /* mwdma0-2 */
 207                 .udma_mask      = 0x3f,                 /* udma0-5 */
 208                 .port_ops       = &sil_ops,
 209         },
 210 };
 211
 212 /* per-port register offsets */
 213 /* TODO: we can probably calculate rather than use a table */
 214 static const struct {
 215         unsigned long tf;       /* ATA taskfile register block */
 216         unsigned long ctl;      /* ATA control/altstatus register block */
 217         unsigned long bmdma;    /* DMA register block */
 218         unsigned long scr;      /* SATA control register block */
 219         unsigned long sien;     /* SATA Interrupt Enable register */
 220         unsigned long xfer_mode;/* data transfer mode register */
 221 } sil_port[] = {
 222         /* port 0 ... */
 223         { 0x80, 0x8A, 0x00, 0x100, 0x148, 0xb4 },
 224         { 0xC0, 0xCA, 0x08, 0x180, 0x1c8, 0xf4 },
 225         { 0x280, 0x28A, 0x200, 0x300, 0x348, 0x2b4 },
 226         { 0x2C0, 0x2CA, 0x208, 0x380, 0x3c8, 0x2f4 },
 227         /* ... port 3 */
 228 };
 229
 230 MODULE_AUTHOR("Jeff Garzik");
 231 MODULE_DESCRIPTION("low-level driver for Silicon Image SATA controller");
 232 MODULE_LICENSE("GPL");
 233 MODULE_DEVICE_TABLE(pci, sil_pci_tbl);
 234 MODULE_VERSION(DRV_VERSION);
 235
 236
 237 static unsigned char sil_get_device_cache_line(struct pci_dev *pdev)
 238 {
 239         u8 cache_line = 0;
 240         pci_read_config_byte(pdev, PCI_CACHE_LINE_SIZE, &cache_line);
 241         return cache_line;
 242 }
 243
 244 static void sil_post_set_mode (struct ata_port *ap)
 245 {
 246         struct ata_host_set *host_set = ap->host_set;
 247         struct ata_device *dev;
 248         void __iomem *addr =
 249                 host_set->mmio_base + sil_port[ap->port_no].xfer_mode;
 250         u32 tmp, dev_mode[2];
 251         unsigned int i;
 252
 253         for (i = 0; i < 2; i++) {
 254                 dev = &ap->device[i];
 255                 if (!ata_dev_present(dev))
 256                         dev_mode[i] = 0;        /* PIO0/1/2 */
 257                 else if (dev->flags & ATA_DFLAG_PIO)
 258                         dev_mode[i] = 1;        /* PIO3/4 */
 259                 else
 260                         dev_mode[i] = 3;        /* UDMA */
 261                 /* value 2 indicates MDMA */
 262         }
 263
 264         tmp = readl(addr);
 265         tmp &= ~((1<<5) | (1<<4) | (1<<1) | (1<<0));
 266         tmp |= dev_mode[0];
 267         tmp |= (dev_mode[1] << 4);
 268         writel(tmp, addr);
 269         readl(addr);    /* flush */
 270 }
 271
 272 static inline unsigned long sil_scr_addr(struct ata_port *ap, unsigned int sc_reg)
 273 {
 274         unsigned long offset = ap->ioaddr.scr_addr;
 275
 276         switch (sc_reg) {
 277         case SCR_STATUS:
 278                 return offset + 4;
 279         case SCR_ERROR:
 280                 return offset + 8;
 281         case SCR_CONTROL:
 282                 return offset;
 283         default:
 284                 /* do nothing */
 285                 break;
 286         }
 287
 288         return 0;
 289 }
 290
 291 static u32 sil_scr_read (struct ata_port *ap, unsigned int sc_reg)
 292 {
 293         void __iomem *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
 294         if (mmio)
 295                 return readl(mmio);
 296         return 0xffffffffU;
 297 }
 298
 299 static void sil_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
 300 {
 301         void *mmio = (void __iomem *) sil_scr_addr(ap, sc_reg);
 302         if (mmio)
 303                 writel(val, mmio);
 304 }
 305
 306 /**
 307  *      sil_dev_config - Apply device/host-specific errata fixups
 308  *      @ap: Port containing device to be examined
 309  *      @dev: Device to be examined
 310  *
 311  *      After the IDENTIFY [PACKET] DEVICE step is complete, and a
 312  *      device is known to be present, this function is called.
 313  *      We apply two errata fixups which are specific to Silicon Image,
 314  *      a Seagate and a Maxtor fixup.
 315  *
 316  *      For certain Seagate devices, we must limit the maximum sectors
 317  *      to under 8K.
 318  *
 319  *      For certain Maxtor devices, we must not program the drive
 320  *      beyond udma5.
 321  *
 322  *      Both fixups are unfairly pessimistic.  As soon as I get more
 323  *      information on these errata, I will create a more exhaustive
 324  *      list, and apply the fixups to only the specific
 325  *      devices/hosts/firmwares that need it.
 326  *
 327  *      20040111 - Seagate drives affected by the Mod15Write bug are blacklisted
 328  *      The Maxtor quirk is in the blacklist, but I'm keeping the original
 329  *      pessimistic fix for the following reasons...
 330  *      - There seems to be less info on it, only one device gleaned off the
 331  *      Windows driver, maybe only one is affected.  More info would be greatly
 332  *      appreciated.
 333  *      - But then again UDMA5 is hardly anything to complain about
 334  */
 335 static void sil_dev_config(struct ata_port *ap, struct ata_device *dev)
 336 {
 337         unsigned int n, quirks = 0;
 338         unsigned char model_num[40];
 339         const char *s;
 340         unsigned int len;
 341
 342         ata_dev_id_string(dev->id, model_num, ATA_ID_PROD_OFS,
 343                           sizeof(model_num));
 344         s = &model_num[0];
 345         len = strnlen(s, sizeof(model_num));
 346
 347         /* ATAPI specifies that empty space is blank-filled; remove blanks */
 348         while ((len > 0) && (s[len - 1] == ' '))
 349                 len--;
 350
 351         for (n = 0; sil_blacklist[n].product; n++)
 352                 if (!memcmp(sil_blacklist[n].product, s,
 353                             strlen(sil_blacklist[n].product))) {
 354                         quirks = sil_blacklist[n].quirk;
 355                         break;
 356                 }
 357
 358         /* limit requests to 15 sectors */
 359         if ((ap->flags & SIL_FLAG_MOD15WRITE) && (quirks & SIL_QUIRK_MOD15WRITE)) {
 360                 printk(KERN_INFO "ata%u(%u): applying Seagate errata fix\n",
 361                        ap->id, dev->devno);
 362                 ap->host->max_sectors = 15;
 363                 ap->host->hostt->max_sectors = 15;
 364                 dev->flags |= ATA_DFLAG_LOCK_SECTORS;
 365                 return;
 366         }
 367
 368         /* limit to udma5 */
 369         if (quirks & SIL_QUIRK_UDMA5MAX) {
 370                 printk(KERN_INFO "ata%u(%u): applying Maxtor errata fix %s\n",
 371                        ap->id, dev->devno, s);
 372                 ap->udma_mask &= ATA_UDMA5;
 373                 return;
 374         }
 375 }
 376
 377 static int sil_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 378 {
 379         static int printed_version;
 380         struct ata_probe_ent *probe_ent = NULL;
 381         unsigned long base;
 382         void __iomem *mmio_base;
 383         int rc;
 384         unsigned int i;
 385         int pci_dev_busy = 0;
 386         u32 tmp, irq_mask;
 387         u8 cls;
 388
 389         if (!printed_version++)
 390                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 391
 392         /*
 393          * If this driver happens to only be useful on Apple's K2, then
 394          * we should check that here as it has a normal Serverworks ID
 395          */
 396         rc = pci_enable_device(pdev);
 397         if (rc)
 398                 return rc;
 399
 400         rc = pci_request_regions(pdev, DRV_NAME);
 401         if (rc) {
 402                 pci_dev_busy = 1;
 403                 goto err_out;
 404         }
 405
 406         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 407         if (rc)
 408                 goto err_out_regions;
 409         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 410         if (rc)
 411                 goto err_out_regions;
 412
 413         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
 414         if (probe_ent == NULL) {
 415                 rc = -ENOMEM;
 416                 goto err_out_regions;
 417         }
 418
 419         memset(probe_ent, 0, sizeof(*probe_ent));
 420         INIT_LIST_HEAD(&probe_ent->node);
 421         probe_ent->dev = pci_dev_to_dev(pdev);
 422         probe_ent->port_ops = sil_port_info[ent->driver_data].port_ops;
 423         probe_ent->sht = sil_port_info[ent->driver_data].sht;
 424         probe_ent->n_ports = (ent->driver_data == sil_3114) ? 4 : 2;
 425         probe_ent->pio_mask = sil_port_info[ent->driver_data].pio_mask;
 426         probe_ent->mwdma_mask = sil_port_info[ent->driver_data].mwdma_mask;
 427         probe_ent->udma_mask = sil_port_info[ent->driver_data].udma_mask;
 428         probe_ent->irq = pdev->irq;
 429         probe_ent->irq_flags = SA_SHIRQ;
 430         probe_ent->host_flags = sil_port_info[ent->driver_data].host_flags;
 431
 432         mmio_base = pci_iomap(pdev, 5, 0);
 433         if (mmio_base == NULL) {
 434                 rc = -ENOMEM;
 435                 goto err_out_free_ent;
 436         }
 437
 438         probe_ent->mmio_base = mmio_base;
 439
 440         base = (unsigned long) mmio_base;
 441
 442         for (i = 0; i < probe_ent->n_ports; i++) {
 443                 probe_ent->port[i].cmd_addr = base + sil_port[i].tf;
 444                 probe_ent->port[i].altstatus_addr =
 445                 probe_ent->port[i].ctl_addr = base + sil_port[i].ctl;
 446                 probe_ent->port[i].bmdma_addr = base + sil_port[i].bmdma;
 447                 probe_ent->port[i].scr_addr = base + sil_port[i].scr;
 448                 ata_std_ports(&probe_ent->port[i]);
 449         }
 450
 451         /* Initialize FIFO PCI bus arbitration */
 452         cls = sil_get_device_cache_line(pdev);
 453         if (cls) {
 454                 cls >>= 3;
 455                 cls++;  /* cls = (line_size/8)+1 */
 456                 writeb(cls, mmio_base + SIL_FIFO_R0);
 457                 writeb(cls, mmio_base + SIL_FIFO_W0);
 458                 writeb(cls, mmio_base + SIL_FIFO_R1);
 459                 writeb(cls, mmio_base + SIL_FIFO_W1);
 460                 if (ent->driver_data == sil_3114) {
 461                         writeb(cls, mmio_base + SIL_FIFO_R2);
 462                         writeb(cls, mmio_base + SIL_FIFO_W2);
 463                         writeb(cls, mmio_base + SIL_FIFO_R3);
 464                         writeb(cls, mmio_base + SIL_FIFO_W3);
 465                 }
 466         } else
 467                 dev_printk(KERN_WARNING, &pdev->dev,
 468                          "cache line size not set.  Driver may not function\n");
 469
 470         if (ent->driver_data == sil_3114) {
 471                 irq_mask = SIL_MASK_4PORT;
 472
 473                 /* flip the magic "make 4 ports work" bit */
 474                 tmp = readl(mmio_base + SIL_IDE2_BMDMA);
 475                 if ((tmp & SIL_INTR_STEERING) == 0)
 476                         writel(tmp | SIL_INTR_STEERING,
 477                                mmio_base + SIL_IDE2_BMDMA);
 478
 479         } else {
 480                 irq_mask = SIL_MASK_2PORT;
 481         }
 482
 483         /* make sure IDE0/1/2/3 interrupts are not masked */
 484         tmp = readl(mmio_base + SIL_SYSCFG);
 485         if (tmp & irq_mask) {
 486                 tmp &= ~irq_mask;
 487                 writel(tmp, mmio_base + SIL_SYSCFG);
 488                 readl(mmio_base + SIL_SYSCFG);  /* flush */
 489         }
 490
 491         /* mask all SATA phy-related interrupts */
 492         /* TODO: unmask bit 6 (SError N bit) for hotplug */
 493         for (i = 0; i < probe_ent->n_ports; i++)
 494                 writel(0, mmio_base + sil_port[i].sien);
 495
 496         pci_set_master(pdev);
 497
 498         /* FIXME: check ata_device_add return value */
 499         ata_device_add(probe_ent);
 500         kfree(probe_ent);
 501
 502         return 0;
 503
 504 err_out_free_ent:
 505         kfree(probe_ent);
 506 err_out_regions:
 507         pci_release_regions(pdev);
 508 err_out:
 509         if (!pci_dev_busy)
 510                 pci_disable_device(pdev);
 511         return rc;
 512 }
 513
 514 static int __init sil_init(void)
 515 {
 516         return pci_module_init(&sil_pci_driver);
 517 }
 518
 519 static void __exit sil_exit(void)
 520 {
 521         pci_unregister_driver(&sil_pci_driver);
 522 }
 523
 524
 525 module_init(sil_init);
 526 module_exit(sil_exit);