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