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  *  The contents of this file are subject to the Open
  17  *  Software License version 1.1 that can be found at
  18  *  http://www.opensource.org/licenses/osl-1.1.txt and is included herein
  19  *  by reference.
  20  *
  21  *  Alternatively, the contents of this file may be used under the terms
  22  *  of the GNU General Public License version 2 (the "GPL") as distributed
  23  *  in the kernel source COPYING file, in which case the provisions of
  24  *  the GPL are applicable instead of the above.  If you wish to allow
  25  *  the use of your version of this file only under the terms of the
  26  *  GPL and not to allow others to use your version of this file under
  27  *  the OSL, indicate your decision by deleting the provisions above and
  28  *  replace them with the notice and other provisions required by the GPL.
  29  *  If you do not delete the provisions above, a recipient may use your
  30  *  version of this file under either the OSL or the GPL.
  31  *
  32  */
  33
  34 #include <linux/config.h>
  35 #include <linux/kernel.h>
  36 #include <linux/module.h>
  37 #include <linux/pci.h>
  38 #include <linux/init.h>
  39 #include <linux/blkdev.h>
  40 #include <linux/delay.h>
  41 #include <linux/interrupt.h>
  42 #include "scsi.h"
  43 #include <scsi/scsi_host.h>
  44 #include <linux/libata.h>
  45
  46 #ifdef CONFIG_PPC_OF
  47 #include <asm/prom.h>
  48 #include <asm/pci-bridge.h>
  49 #endif /* CONFIG_PPC_OF */
  50
  51 #define DRV_NAME        "sata_svw"
  52 #define DRV_VERSION     "1.04"
  53
  54 /* Taskfile registers offsets */
  55 #define K2_SATA_TF_CMD_OFFSET           0x00
  56 #define K2_SATA_TF_DATA_OFFSET          0x00
  57 #define K2_SATA_TF_ERROR_OFFSET         0x04
  58 #define K2_SATA_TF_NSECT_OFFSET         0x08
  59 #define K2_SATA_TF_LBAL_OFFSET          0x0c
  60 #define K2_SATA_TF_LBAM_OFFSET          0x10
  61 #define K2_SATA_TF_LBAH_OFFSET          0x14
  62 #define K2_SATA_TF_DEVICE_OFFSET        0x18
  63 #define K2_SATA_TF_CMDSTAT_OFFSET       0x1c
  64 #define K2_SATA_TF_CTL_OFFSET           0x20
  65
  66 /* DMA base */
  67 #define K2_SATA_DMA_CMD_OFFSET          0x30
  68
  69 /* SCRs base */
  70 #define K2_SATA_SCR_STATUS_OFFSET       0x40
  71 #define K2_SATA_SCR_ERROR_OFFSET        0x44
  72 #define K2_SATA_SCR_CONTROL_OFFSET      0x48
  73
  74 /* Others */
  75 #define K2_SATA_SICR1_OFFSET            0x80
  76 #define K2_SATA_SICR2_OFFSET            0x84
  77 #define K2_SATA_SIM_OFFSET              0x88
  78
  79 /* Port stride */
  80 #define K2_SATA_PORT_OFFSET             0x100
  81
  82
  83 static u32 k2_sata_scr_read (struct ata_port *ap, unsigned int sc_reg)
  84 {
  85         if (sc_reg > SCR_CONTROL)
  86                 return 0xffffffffU;
  87         return readl((void *) ap->ioaddr.scr_addr + (sc_reg * 4));
  88 }
  89
  90
  91 static void k2_sata_scr_write (struct ata_port *ap, unsigned int sc_reg,
  92                                u32 val)
  93 {
  94         if (sc_reg > SCR_CONTROL)
  95                 return;
  96         writel(val, (void *) ap->ioaddr.scr_addr + (sc_reg * 4));
  97 }
  98
  99
 100 static void k2_sata_tf_load(struct ata_port *ap, struct ata_taskfile *tf)
 101 {
 102         struct ata_ioports *ioaddr = &ap->ioaddr;
 103         unsigned int is_addr = tf->flags & ATA_TFLAG_ISADDR;
 104
 105         if (tf->ctl != ap->last_ctl) {
 106                 writeb(tf->ctl, ioaddr->ctl_addr);
 107                 ap->last_ctl = tf->ctl;
 108                 ata_wait_idle(ap);
 109         }
 110         if (is_addr && (tf->flags & ATA_TFLAG_LBA48)) {
 111                 writew(tf->feature | (((u16)tf->hob_feature) << 8), ioaddr->feature_addr);
 112                 writew(tf->nsect | (((u16)tf->hob_nsect) << 8), ioaddr->nsect_addr);
 113                 writew(tf->lbal | (((u16)tf->hob_lbal) << 8), ioaddr->lbal_addr);
 114                 writew(tf->lbam | (((u16)tf->hob_lbam) << 8), ioaddr->lbam_addr);
 115                 writew(tf->lbah | (((u16)tf->hob_lbah) << 8), ioaddr->lbah_addr);
 116         } else if (is_addr) {
 117                 writew(tf->feature, ioaddr->feature_addr);
 118                 writew(tf->nsect, ioaddr->nsect_addr);
 119                 writew(tf->lbal, ioaddr->lbal_addr);
 120                 writew(tf->lbam, ioaddr->lbam_addr);
 121                 writew(tf->lbah, ioaddr->lbah_addr);
 122         }
 123
 124         if (tf->flags & ATA_TFLAG_DEVICE)
 125                 writeb(tf->device, ioaddr->device_addr);
 126
 127         ata_wait_idle(ap);
 128 }
 129
 130
 131 static void k2_sata_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
 132 {
 133         struct ata_ioports *ioaddr = &ap->ioaddr;
 134         u16 nsect, lbal, lbam, lbah;
 135
 136         nsect = tf->nsect = readw(ioaddr->nsect_addr);
 137         lbal = tf->lbal = readw(ioaddr->lbal_addr);
 138         lbam = tf->lbam = readw(ioaddr->lbam_addr);
 139         lbah = tf->lbah = readw(ioaddr->lbah_addr);
 140         tf->device = readw(ioaddr->device_addr);
 141
 142         if (tf->flags & ATA_TFLAG_LBA48) {
 143                 tf->hob_feature = readw(ioaddr->error_addr) >> 8;
 144                 tf->hob_nsect = nsect >> 8;
 145                 tf->hob_lbal = lbal >> 8;
 146                 tf->hob_lbam = lbam >> 8;
 147                 tf->hob_lbah = lbah >> 8;
 148         }
 149 }
 150
 151
 152 static u8 k2_stat_check_status(struct ata_port *ap)
 153 {
 154         return readl((void *) ap->ioaddr.status_addr);
 155 }
 156
 157 #ifdef CONFIG_PPC_OF
 158 /*
 159  * k2_sata_proc_info
 160  * inout : decides on the direction of the dataflow and the meaning of the
 161  *         variables
 162  * buffer: If inout==FALSE data is being written to it else read from it
 163  * *start: If inout==FALSE start of the valid data in the buffer
 164  * offset: If inout==FALSE offset from the beginning of the imaginary file
 165  *         from which we start writing into the buffer
 166  * length: If inout==FALSE max number of bytes to be written into the buffer
 167  *         else number of bytes in the buffer
 168  */
 169 static int k2_sata_proc_info(struct Scsi_Host *shost, char *page, char **start,
 170                              off_t offset, int count, int inout)
 171 {
 172         struct ata_port *ap;
 173         struct device_node *np;
 174         int len, index;
 175
 176         /* Find  the ata_port */
 177         ap = (struct ata_port *) &shost->hostdata[0];
 178         if (ap == NULL)
 179                 return 0;
 180
 181         /* Find the OF node for the PCI device proper */
 182         np = pci_device_to_OF_node(ap->host_set->pdev);
 183         if (np == NULL)
 184                 return 0;
 185
 186         /* Match it to a port node */
 187         index = (ap == ap->host_set->ports[0]) ? 0 : 1;
 188         for (np = np->child; np != NULL; np = np->sibling) {
 189                 u32 *reg = (u32 *)get_property(np, "reg", NULL);
 190                 if (!reg)
 191                         continue;
 192                 if (index == *reg)
 193                         break;
 194         }
 195         if (np == NULL)
 196                 return 0;
 197
 198         len = sprintf(page, "devspec: %s\n", np->full_name);
 199
 200         return len;
 201 }
 202 #endif /* CONFIG_PPC_OF */
 203
 204
 205 static Scsi_Host_Template k2_sata_sht = {
 206         .module                 = THIS_MODULE,
 207         .name                   = DRV_NAME,
 208         .queuecommand           = ata_scsi_queuecmd,
 209         .eh_strategy_handler    = ata_scsi_error,
 210         .can_queue              = ATA_DEF_QUEUE,
 211         .this_id                = ATA_SHT_THIS_ID,
 212         .sg_tablesize           = LIBATA_MAX_PRD,
 213         .max_sectors            = ATA_MAX_SECTORS,
 214         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 215         .emulated               = ATA_SHT_EMULATED,
 216         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 217         .proc_name              = DRV_NAME,
 218         .dma_boundary           = ATA_DMA_BOUNDARY,
 219         .slave_configure        = ata_scsi_slave_config,
 220 #ifdef CONFIG_PPC_OF
 221         .proc_info              = k2_sata_proc_info,
 222 #endif
 223         .bios_param             = ata_std_bios_param,
 224 };
 225
 226
 227 static struct ata_port_operations k2_sata_ops = {
 228         .port_disable           = ata_port_disable,
 229         .tf_load                = k2_sata_tf_load,
 230         .tf_read                = k2_sata_tf_read,
 231         .check_status           = k2_stat_check_status,
 232         .exec_command           = ata_exec_command_mmio,
 233         .phy_reset              = sata_phy_reset,
 234         .bmdma_setup            = ata_bmdma_setup_mmio,
 235         .bmdma_start            = ata_bmdma_start_mmio,
 236         .qc_prep                = ata_qc_prep,
 237         .qc_issue               = ata_qc_issue_prot,
 238         .eng_timeout            = ata_eng_timeout,
 239         .irq_handler            = ata_interrupt,
 240         .irq_clear              = ata_bmdma_irq_clear,
 241         .scr_read               = k2_sata_scr_read,
 242         .scr_write              = k2_sata_scr_write,
 243         .port_start             = ata_port_start,
 244         .port_stop              = ata_port_stop,
 245 };
 246
 247 static void k2_sata_setup_port(struct ata_ioports *port, unsigned long base)
 248 {
 249         port->cmd_addr          = base + K2_SATA_TF_CMD_OFFSET;
 250         port->data_addr         = base + K2_SATA_TF_DATA_OFFSET;
 251         port->feature_addr      =
 252         port->error_addr        = base + K2_SATA_TF_ERROR_OFFSET;
 253         port->nsect_addr        = base + K2_SATA_TF_NSECT_OFFSET;
 254         port->lbal_addr         = base + K2_SATA_TF_LBAL_OFFSET;
 255         port->lbam_addr         = base + K2_SATA_TF_LBAM_OFFSET;
 256         port->lbah_addr         = base + K2_SATA_TF_LBAH_OFFSET;
 257         port->device_addr       = base + K2_SATA_TF_DEVICE_OFFSET;
 258         port->command_addr      =
 259         port->status_addr       = base + K2_SATA_TF_CMDSTAT_OFFSET;
 260         port->altstatus_addr    =
 261         port->ctl_addr          = base + K2_SATA_TF_CTL_OFFSET;
 262         port->bmdma_addr        = base + K2_SATA_DMA_CMD_OFFSET;
 263         port->scr_addr          = base + K2_SATA_SCR_STATUS_OFFSET;
 264 }
 265
 266
 267 static int k2_sata_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 268 {
 269         static int printed_version;
 270         struct ata_probe_ent *probe_ent = NULL;
 271         unsigned long base;
 272         void *mmio_base;
 273         int rc;
 274
 275         if (!printed_version++)
 276                 printk(KERN_DEBUG DRV_NAME " version " DRV_VERSION "\n");
 277
 278         /*
 279          * If this driver happens to only be useful on Apple's K2, then
 280          * we should check that here as it has a normal Serverworks ID
 281          */
 282         rc = pci_enable_device(pdev);
 283         if (rc)
 284                 return rc;
 285         /*
 286          * Check if we have resources mapped at all (second function may
 287          * have been disabled by firmware)
 288          */
 289         if (pci_resource_len(pdev, 5) == 0)
 290                 return -ENODEV;
 291
 292         /* Request PCI regions */
 293         rc = pci_request_regions(pdev, DRV_NAME);
 294         if (rc)
 295                 goto err_out;
 296
 297         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 298         if (rc)
 299                 goto err_out_regions;
 300         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 301         if (rc)
 302                 goto err_out_regions;
 303
 304         probe_ent = kmalloc(sizeof(*probe_ent), GFP_KERNEL);
 305         if (probe_ent == NULL) {
 306                 rc = -ENOMEM;
 307                 goto err_out_regions;
 308         }
 309
 310         memset(probe_ent, 0, sizeof(*probe_ent));
 311         probe_ent->pdev = pdev;
 312         INIT_LIST_HEAD(&probe_ent->node);
 313
 314         mmio_base = ioremap(pci_resource_start(pdev, 5),
 315                             pci_resource_len(pdev, 5));
 316         if (mmio_base == NULL) {
 317                 rc = -ENOMEM;
 318                 goto err_out_free_ent;
 319         }
 320         base = (unsigned long) mmio_base;
 321
 322         /* Clear a magic bit in SCR1 according to Darwin, those help
 323          * some funky seagate drives (though so far, those were already
 324          * set by the firmware on the machines I had access to
 325          */
 326         writel(readl(mmio_base + K2_SATA_SICR1_OFFSET) & ~0x00040000,
 327                mmio_base + K2_SATA_SICR1_OFFSET);
 328
 329         /* Clear SATA error & interrupts we don't use */
 330         writel(0xffffffff, mmio_base + K2_SATA_SCR_ERROR_OFFSET);
 331         writel(0x0, mmio_base + K2_SATA_SIM_OFFSET);
 332
 333         probe_ent->sht = &k2_sata_sht;
 334         probe_ent->host_flags = ATA_FLAG_SATA | ATA_FLAG_SATA_RESET |
 335                                 ATA_FLAG_NO_LEGACY | ATA_FLAG_MMIO;
 336         probe_ent->port_ops = &k2_sata_ops;
 337         probe_ent->n_ports = 4;
 338         probe_ent->irq = pdev->irq;
 339         probe_ent->irq_flags = SA_SHIRQ;
 340         probe_ent->mmio_base = mmio_base;
 341
 342         /* We don't care much about the PIO/UDMA masks, but the core won't like us
 343          * if we don't fill these
 344          */
 345         probe_ent->pio_mask = 0x1f;
 346         probe_ent->udma_mask = 0x7f;
 347
 348         /* We have 4 ports per PCI function */
 349         k2_sata_setup_port(&probe_ent->port[0], base + 0 * K2_SATA_PORT_OFFSET);
 350         k2_sata_setup_port(&probe_ent->port[1], base + 1 * K2_SATA_PORT_OFFSET);
 351         k2_sata_setup_port(&probe_ent->port[2], base + 2 * K2_SATA_PORT_OFFSET);
 352         k2_sata_setup_port(&probe_ent->port[3], base + 3 * K2_SATA_PORT_OFFSET);
 353
 354         pci_set_master(pdev);
 355
 356         /* FIXME: check ata_device_add return value */
 357         ata_device_add(probe_ent);
 358         kfree(probe_ent);
 359
 360         return 0;
 361
 362 err_out_free_ent:
 363         kfree(probe_ent);
 364 err_out_regions:
 365         pci_release_regions(pdev);
 366 err_out:
 367         pci_disable_device(pdev);
 368         return rc;
 369 }
 370
 371
 372 static struct pci_device_id k2_sata_pci_tbl[] = {
 373         { 0x1166, 0x0240, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0 },
 374         { }
 375 };
 376
 377
 378 static struct pci_driver k2_sata_pci_driver = {
 379         .name                   = DRV_NAME,
 380         .id_table               = k2_sata_pci_tbl,
 381         .probe                  = k2_sata_init_one,
 382         .remove                 = ata_pci_remove_one,
 383 };
 384
 385
 386 static int __init k2_sata_init(void)
 387 {
 388         return pci_module_init(&k2_sata_pci_driver);
 389 }
 390
 391 static void __exit k2_sata_exit(void)
 392 {
 393         pci_unregister_driver(&k2_sata_pci_driver);
 394 }
 395
 396
 397 MODULE_AUTHOR("Benjamin Herrenschmidt");
 398 MODULE_DESCRIPTION("low-level driver for K2 SATA controller");
 399 MODULE_LICENSE("GPL");
 400 MODULE_DEVICE_TABLE(pci, k2_sata_pci_tbl);
 401
 402 module_init(k2_sata_init);
 403 module_exit(k2_sata_exit);