drivers/scsi/sata_svw.c

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