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