drivers/scsi/sata_svw.c

   1 /*
   2  *  sata_svw.c - ServerWorks / Apple K2 SATA
   3  *
   4  *  Maintained by: Benjamin Herrenschmidt <benh@kernel.crashing.org> and
   5  *                 Jeff Garzik <jgarzik@pobox.com>
   6  *                  Please ALWAYS copy linux-ide@vger.kernel.org
   7  *                  on emails.
   8  *
   9  *  Copyright 2003 Benjamin Herrenschmidt <benh@kernel.crashing.org>
  10  *
  11  *  Bits from Jeff Garzik, Copyright RedHat, Inc.
  12  *
  13  *  This driver probably works with non-Apple versions of the
  14  *  Broadcom chipset...
  15  *
  16  *
  17  *  This program is free software; you can redistribute it and/or modify
  18  *  it under the terms of the GNU General Public License as published by
  19  *  the Free Software Foundation; either version 2, or (at your option)
  20  *  any later version.
  21  *
  22  *  This program is distributed in the hope that it will be useful,
  23  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  *  GNU General Public License for more details.
  26  *
  27  *  You should have received a copy of the GNU General Public License
  28  *  along with this program; see the file COPYING.  If not, write to
  29  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  30  *
  31  *
  32  *  libata documentation is available via 'make {ps|pdf}docs',
  33  *  as Documentation/DocBook/libata.*
  34  *
  35  *  Hardware documentation available under NDA.
  36  *
  37  */
  38
  39 #include <linux/config.h>
  40 #include <linux/kernel.h>
  41 #include <linux/module.h>
  42 #include <linux/pci.h>
  43 #include <linux/init.h>
  44 #include <linux/blkdev.h>
  45 #include <linux/delay.h>
  46 #include <linux/interrupt.h>
  47 #include <linux/device.h>
  48 #include <scsi/scsi_host.h>
  49 #include <linux/libata.h>
  50
  51 #ifdef CONFIG_PPC_OF
  52 #include <asm/prom.h>
  53 #include <asm/pci-bridge.h>
  54 #endif /* CONFIG_PPC_OF */
  55
  56 #define DRV_NAME        "sata_svw"
  57 #define DRV_VERSION     "1.07"
  58
  59 enum {
  60         /* Taskfile registers offsets */
  61         K2_SATA_TF_CMD_OFFSET           = 0x00,
  62         K2_SATA_TF_DATA_OFFSET          = 0x00,
  63         K2_SATA_TF_ERROR_OFFSET         = 0x04,
  64         K2_SATA_TF_NSECT_OFFSET         = 0x08,
  65         K2_SATA_TF_LBAL_OFFSET          = 0x0c,
  66         K2_SATA_TF_LBAM_OFFSET          = 0x10,
  67         K2_SATA_TF_LBAH_OFFSET          = 0x14,
  68         K2_SATA_TF_DEVICE_OFFSET        = 0x18,
  69         K2_SATA_TF_CMDSTAT_OFFSET       = 0x1c,
  70         K2_SATA_TF_CTL_OFFSET           = 0x20,
  71
  72         /* DMA base */
  73         K2_SATA_DMA_CMD_OFFSET          = 0x30,
  74
  75         /* SCRs base */
  76         K2_SATA_SCR_STATUS_OFFSET       = 0x40,
  77         K2_SATA_SCR_ERROR_OFFSET        = 0x44,
  78         K2_SATA_SCR_CONTROL_OFFSET      = 0x48,
  79
  80         /* Others */
  81         K2_SATA_SICR1_OFFSET            = 0x80,
  82         K2_SATA_SICR2_OFFSET            = 0x84,
  83         K2_SATA_SIM_OFFSET              = 0x88,
  84
  85         /* Port stride */
  86         K2_SATA_PORT_OFFSET             = 0x100,
  87 };
  88
  89 static u8 k2_stat_check_status(struct ata_port *ap);
  90
  91
  92 static u32 k2_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
  93 {
  94         if (sc_reg > SCR_CONTROL)
  95                 return 0xffffffffU;
  96         return readl((void *) ap->ioaddr.scr_addr + (sc_reg * 4));
  97 }
  98
  99
 100 static void k2_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
 101                                u32 val)
 102 {
 103         if (sc_reg > SCR_CONTROL)
 104                 return;
 105         writel(val, (void *) ap->ioaddr.scr_addr + (sc_reg * 4));
 106 }
 107
 108
 109 static void k2_sata_tf_load(struct ata_port *ap, const struct ata_taskfile *tf)
 110 {
 111         struct ata_ioports *ioaddr = &ap->ioaddr;
 112         unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
 113
 114         if (tf->ctl != ap->last_ctl) {
 115                 writeb(tf->ctl, ioaddr->ctl_addr);
 116                 ap->last_ctl = tf->ctl;
 117                 ata_wait_idle(ap);
 118         }
 119         if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
 120                 writew(tf->feature | (((u16)tf->hob_feature) << 8), ioaddr->feature_addr);
 121                 writew(tf->nsect | (((u16)tf->hob_nsect) << 8), ioaddr->nsect_addr);
 122                 writew(tf->lbal | (((u16)tf->hob_lbal) << 8), ioaddr->lbal_addr);
 123                 writew(tf->lbam | (((u16)tf->hob_lbam) << 8), ioaddr->lbam_addr);
 124                 writew(tf->lbah | (((u16)tf->hob_lbah) << 8), ioaddr->lbah_addr);
 125         } else if (is_addr) {
 126                 writew(tf->feature, ioaddr->feature_addr);
 127                 writew(tf->nsect, ioaddr->nsect_addr);
 128                 writew(tf->lbal, ioaddr->lbal_addr);
 129                 writew(tf->lbam, ioaddr->lbam_addr);
 130                 writew(tf->lbah, ioaddr->lbah_addr);
 131         }
 132
 133         if (tf->flags & ATA_TFLAG_DEVICE)
 134                 writeb(tf->device, ioaddr->device_addr);
 135
 136         ata_wait_idle(ap);
 137 }
 138
 139
 140 static void k2_sata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
 141 {
 142         struct ata_ioports *ioaddr = &ap->ioaddr;
 143         u16 nsect, lbal, lbam, lbah, feature;
 144
 145         tf->command = k2_stat_check_status(ap);
 146         tf->device = readw(ioaddr->device_addr);
 147         feature = readw(ioaddr->error_addr);
 148         nsect = readw(ioaddr->nsect_addr);
 149         lbal = readw(ioaddr->lbal_addr);
 150         lbam = readw(ioaddr->lbam_addr);
 151         lbah = readw(ioaddr->lbah_addr);
 152
 153         tf->feature = feature;
 154         tf->nsect = nsect;
 155         tf->lbal = lbal;
 156         tf->lbam = lbam;
 157         tf->lbah = lbah;
 158
 159         if (tf->flags & ATA_TFLAG_LBA48) {
 160                 tf->hob_feature = feature >> 8;
 161                 tf->hob_nsect = nsect >> 8;
 162                 tf->hob_lbal = lbal >> 8;
 163                 tf->hob_lbam = lbam >> 8;
 164                 tf->hob_lbah = lbah >> 8;
 165         }
 166 }
 167
 168 /**
 169  *      k2_bmdma_setup_mmio - Set up PCI IDE BMDMA transaction (MMIO)
 170  *      @qc: Info associated with this ATA transaction.
 171  *
 172  *      LOCKING:
 173  *      spin_lock_irqsave(host_set lock)
 174  */
 175
 176 static void k2_bmdma_setup_mmio (struct ata_queued_cmd *qc)
 177 {
 178         struct ata_port *ap = qc->ap;
 179         unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
 180         u8 dmactl;
 181         void *mmio = (void *) ap->ioaddr.bmdma_addr;
 182         /* load PRD table addr. */
 183         mb();   /* make sure PRD table writes are visible to controller */
 184         writel(ap->prd_dma, mmio + ATA_DMA_TABLE_OFS);
 185
 186         /* specify data direction, triple-check start bit is clear */
 187         dmactl = readb(mmio + ATA_DMA_CMD);
 188         dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
 189         if (!rw)
 190                 dmactl |= ATA_DMA_WR;
 191         writeb(dmactl, mmio + ATA_DMA_CMD);
 192
 193         /* issue r/w command if this is not a ATA DMA command*/
 194         if (qc->tf.protocol != ATA_PROT_DMA)
 195                 ap->ops->exec_command(ap, &qc->tf);
 196 }
 197
 198 /**
 199  *      k2_bmdma_start_mmio - Start a PCI IDE BMDMA transaction (MMIO)
 200  *      @qc: Info associated with this ATA transaction.
 201  *
 202  *      LOCKING:
 203  *      spin_lock_irqsave(host_set lock)
 204  */
 205
 206 static void k2_bmdma_start_mmio (struct ata_queued_cmd *qc)
 207 {
 208         struct ata_port *ap = qc->ap;
 209         void *mmio = (void *) ap->ioaddr.bmdma_addr;
 210         u8 dmactl;
 211
 212         /* start host DMA transaction */
 213         dmactl = readb(mmio + ATA_DMA_CMD);
 214         writeb(dmactl | ATA_DMA_START, mmio + ATA_DMA_CMD);
 215         /* There is a race condition in certain SATA controllers that can
 216            be seen when the r/w command is given to the controller before the
 217            host DMA is started. On a Read command, the controller would initiate
 218            the command to the drive even before it sees the DMA start. When there
 219            are very fast drives connected to the controller, or when the data request
 220            hits in the drive cache, there is the possibility that the drive returns a part
 221            or all of the requested data to the controller before the DMA start is issued.
 222            In this case, the controller would become confused as to what to do with the data.
 223            In the worst case when all the data is returned back to the controller, the
 224            controller could hang. In other cases it could return partial data returning
 225            in data corruption. This problem has been seen in PPC systems and can also appear
 226            on an system with very fast disks, where the SATA controller is sitting behind a
 227            number of bridges, and hence there is significant latency between the r/w command
 228            and the start command. */
 229         /* issue r/w command if the access is to ATA*/
 230         if (qc->tf.protocol == ATA_PROT_DMA)
 231                 ap->ops->exec_command(ap, &qc->tf);
 232 }
 233
 234
 235 static u8 k2_stat_check_status(struct ata_port *ap)
 236 {
 237         return readl((void *) ap->ioaddr.status_addr);
 238 }
 239
 240 #ifdef CONFIG_PPC_OF
 241 /*
 242  * k2_sata_proc_info
 243  * inout : decides on the direction of the dataflow and the meaning of the
 244  *         variables
 245  * buffer: If inout==FALSE data is being written to it else read from it
 246  * *start: If inout==FALSE start of the valid data in the buffer
 247  * offset: If inout==FALSE offset from the beginning of the imaginary file
 248  *         from which we start writing into the buffer
 249  * length: If inout==FALSE max number of bytes to be written into the buffer
 250  *         else number of bytes in the buffer
 251  */
 252 static int k2_sata_proc_info(struct Scsi_Host *shost, char *page, char **start,
 253                              off_t offset, int count, int inout)
 254 {
 255         struct ata_port *ap;
 256         struct device_node *np;
 257         int len, index;
 258
 259         /* Find  the ata_port */
 260         ap = (struct ata_port *) &shost->hostdata[0];
 261         if (ap == NULL)
 262                 return 0;
 263
 264         /* Find the OF node for the PCI device proper */
 265         np = pci_device_to_OF_node(to_pci_dev(ap->host_set->dev));
 266         if (np == NULL)
 267                 return 0;
 268
 269         /* Match it to a port node */
 270         index = (ap == ap->host_set->ports[0]) ? 0 : 1;
 271         for (np = np->child; np != NULL; np = np->sibling) {
 272                 u32 *reg = (u32 *)get_property(np, "reg", NULL);
 273                 if (!reg)
 274                         continue;
 275                 if (index == *reg)
 276                         break;
 277         }
 278         if (np == NULL)
 279                 return 0;
 280
 281         len = sprintf(page, "devspec: %s\n", np->full_name);
 282
 283         return len;
 284 }
 285 #endif /* CONFIG_PPC_OF */
 286
 287
 288 static struct scsi_host_template k2_sata_sht = {
 289         .module                 = THIS_MODULE,
 290         .name                   = DRV_NAME,
 291         .ioctl                  = ata_scsi_ioctl,
 292         .queuecommand           = ata_scsi_queuecmd,
 293         .eh_strategy_handler    = ata_scsi_error,
 294         .can_queue              = ATA_DEF_QUEUE,
 295         .this_id                = ATA_SHT_THIS_ID,
 296         .sg_tablesize           = LIBATA_MAX_PRD,
 297         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 298         .emulated               = ATA_SHT_EMULATED,
 299         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 300         .proc_name              = DRV_NAME,
 301         .dma_boundary           = ATA_DMA_BOUNDARY,
 302         .slave_configure        = ata_scsi_slave_config,
 303 #ifdef CONFIG_PPC_OF
 304         .proc_info              = k2_sata_proc_info,
 305 #endif
 306         .bios_param             = ata_std_bios_param,
 307 };
 308
 309
 310 static const struct ata_port_operations k2_sata_ops = {
 311         .port_disable           = ata_port_disable,
 312         .tf_load                = k2_sata_tf_load,
 313         .tf_read                = k2_sata_tf_read,
 314         .check_status           = k2_stat_check_status,
 315         .exec_command           = ata_exec_command,
 316         .dev_select             = ata_std_dev_select,
 317         .phy_reset              = sata_phy_reset,
 318         .bmdma_setup            = k2_bmdma_setup_mmio,
 319         .bmdma_start            = k2_bmdma_start_mmio,
 320         .bmdma_stop             = ata_bmdma_stop,
 321         .bmdma_status           = ata_bmdma_status,
 322         .qc_prep                = ata_qc_prep,
 323         .qc_issue               = ata_qc_issue_prot,
 324         .eng_timeout            = ata_eng_timeout,
 325         .irq_handler            = ata_interrupt,
 326         .irq_clear              = ata_bmdma_irq_clear,
 327         .scr_read               = k2_sata_scr_read,
 328         .scr_write              = k2_sata_scr_write,
 329         .port_start             = ata_port_start,
 330         .port_stop              = ata_port_stop,
 331         .host_stop              = ata_pci_host_stop,
 332 };
 333
 334 static void k2_sata_setup_port(struct ata_ioports *port, unsigned long base)
 335 {
 336         port->cmd_addr          = base + K2_SATA_TF_CMD_OFFSET;
 337         port->data_addr         = base + K2_SATA_TF_DATA_OFFSET;
 338         port->feature_addr      =
 339         port->error_addr        = base + K2_SATA_TF_ERROR_OFFSET;
 340         port->nsect_addr        = base + K2_SATA_TF_NSECT_OFFSET;
 341         port->lbal_addr         = base + K2_SATA_TF_LBAL_OFFSET;
 342         port->lbam_addr         = base + K2_SATA_TF_LBAM_OFFSET;
 343         port->lbah_addr         = base + K2_SATA_TF_LBAH_OFFSET;
 344         port->device_addr       = base + K2_SATA_TF_DEVICE_OFFSET;
 345         port->command_addr      =
 346         port->status_addr       = base + K2_SATA_TF_CMDSTAT_OFFSET;
 347         port->altstatus_addr    =
 348         port->ctl_addr          = base + K2_SATA_TF_CTL_OFFSET;
 349         port->bmdma_addr        = base + K2_SATA_DMA_CMD_OFFSET;
 350         port->scr_addr          = base + K2_SATA_SCR_STATUS_OFFSET;
 351 }
 352
 353
 354 static int k2_sata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 355 {
 356         static int printed_version;
 357         struct ata_probe_ent *probe_ent = NULL;
 358         unsigned long base;
 359         void __iomem *mmio_base;
 360         int pci_dev_busy = 0;
 361         int rc;
 362         int i;
 363
 364         if (!printed_version++)
 365                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 366
 367         /*
 368          * If this driver happens to only be useful on Apple's K2, then
 369          * we should check that here as it has a normal Serverworks ID
 370          */
 371         rc = pci_enable_device(pdev);
 372         if (rc)
 373                 return rc;
 374         /*
 375          * Check if we have resources mapped at all (second function may
 376          * have been disabled by firmware)
 377          */
 378         if (pci_resource_len(pdev, 5) == 0)
 379                 return -ENODEV;
 380
 381         /* Request PCI regions */
 382         rc = pci_request_regions(pdev, DRV_NAME);
 383         if (rc) {
 384                 pci_dev_busy = 1;
 385                 goto err_out;
 386         }
 387
 388         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 389         if (rc)
 390                 goto err_out_regions;
 391         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 392         if (rc)
 393                 goto err_out_regions;
 394
 395         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
 396         if (probe_ent == NULL) {
 397                 rc = -ENOMEM;
 398                 goto err_out_regions;
 399         }
 400
 401         memset(probe_ent, 0, sizeof(*probe_ent));
 402         probe_ent->dev = pci_dev_to_dev(pdev);
 403         INIT_LIST_HEAD(&probe_ent->node);
 404
 405         mmio_base = pci_iomap(pdev, 5, 0);
 406         if (mmio_base == NULL) {
 407                 rc = -ENOMEM;
 408                 goto err_out_free_ent;
 409         }
 410         base = (unsigned long) mmio_base;
 411
 412         /* Clear a magic bit in SCR1 according to Darwin, those help
 413          * some funky seagate drives (though so far, those were already
 414          * set by the firmware on the machines I had access to)
 415          */
 416         writel(readl(mmio_base + K2_SATA_SICR1_OFFSET) & ~0x00040000,
 417                mmio_base + K2_SATA_SICR1_OFFSET);
 418
 419         /* Clear SATA error & interrupts we don't use */
 420         writel(0xffffffff, mmio_base + K2_SATA_SCR_ERROR_OFFSET);
 421         writel(0x0, mmio_base + K2_SATA_SIM_OFFSET);
 422
 423         probe_ent->sht = &k2_sata_sht;
 424         probe_ent->host_flags = ATA_FLAG_SATA | ATA_FLAG_SATA_RESET |
 425                                 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO;
 426         probe_ent->port_ops = &k2_sata_ops;
 427         probe_ent->n_ports = 4;
 428         probe_ent->irq = pdev->irq;
 429         probe_ent->irq_flags = SA_SHIRQ;
 430         probe_ent->mmio_base = mmio_base;
 431
 432         /* We don't care much about the PIO/UDMA masks, but the core won't like us
 433          * if we don't fill these
 434          */
 435         probe_ent->pio_mask = 0x1f;
 436         probe_ent->mwdma_mask = 0x7;
 437         probe_ent->udma_mask = 0x7f;
 438
 439         /* different controllers have different number of ports - currently 4 or 8 */
 440         /* All ports are on the same function. Multi-function device is no
 441          * longer available. This should not be seen in any system. */
 442         for (i = 0; i < ent->driver_data; i++)
 443                 k2_sata_setup_port(&probe_ent->port[i], base + i * K2_SATA_PORT_OFFSET);
 444
 445         pci_set_master(pdev);
 446
 447         /* FIXME: check ata_device_add return value */
 448         ata_device_add(probe_ent);
 449         kfree(probe_ent);
 450
 451         return 0;
 452
 453 err_out_free_ent:
 454         kfree(probe_ent);
 455 err_out_regions:
 456         pci_release_regions(pdev);
 457 err_out:
 458         if (!pci_dev_busy)
 459                 pci_disable_device(pdev);
 460         return rc;
 461 }
 462
 463 /* 0x240 is device ID for Apple K2 device
 464  * 0x241 is device ID for Serverworks Frodo4
 465  * 0x242 is device ID for Serverworks Frodo8
 466  * 0x24a is device ID for BCM5785 (aka HT1000) HT southbridge integrated SATA
 467  * controller
 468  * */
 469 static const struct pci_device_id k2_sata_pci_tbl[] = {
 470         { 0x1166, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
 471         { 0x1166, 0x0241, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
 472         { 0x1166, 0x0242, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 8 },
 473         { 0x1166, 0x024a, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
 474         { 0x1166, 0x024b, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4 },
 475         { }
 476 };
 477
 478
 479 static struct pci_driver k2_sata_pci_driver = {
 480         .name                   = DRV_NAME,
 481         .id_table               = k2_sata_pci_tbl,
 482         .probe                  = k2_sata_init_one,
 483         .remove                 = ata_pci_remove_one,
 484 };
 485
 486
 487 static int __init k2_sata_init(void)
 488 {
 489         return pci_module_init(&k2_sata_pci_driver);
 490 }
 491
 492
 493 static void __exit k2_sata_exit(void)
 494 {
 495         pci_unregister_driver(&k2_sata_pci_driver);
 496 }
 497
 498
 499 MODULE_AUTHOR("Benjamin Herrenschmidt");
 500 MODULE_DESCRIPTION("low-level driver for K2 SATA controller");
 501 MODULE_LICENSE("GPL");
 502 MODULE_DEVICE_TABLE(pci, k2_sata_pci_tbl);
 503 MODULE_VERSION(DRV_VERSION);
 504
 505 module_init(k2_sata_init);
 506 module_exit(k2_sata_exit);