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