drivers/ata/sata_sis.c

   1 /*
   2  *  sata_sis.c - Silicon Integrated Systems SATA
   3  *
   4  *  Maintained by:  Uwe Koziolek
   5  *                  Please ALWAYS copy linux-ide@vger.kernel.org
   6  *                  on emails.
   7  *
   8  *  Copyright 2004 Uwe Koziolek
   9  *
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2, or (at your option)
  14  *  any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program; see the file COPYING.  If not, write to
  23  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  24  *
  25  *
  26  *  libata documentation is available via 'make {ps|pdf}docs',
  27  *  as Documentation/DocBook/libata.*
  28  *
  29  *  Hardware documentation available under NDA.
  30  *
  31  */
  32
  33 #include <linux/kernel.h>
  34 #include <linux/module.h>
  35 #include <linux/pci.h>
  36 #include <linux/init.h>
  37 #include <linux/blkdev.h>
  38 #include <linux/delay.h>
  39 #include <linux/interrupt.h>
  40 #include <linux/device.h>
  41 #include <scsi/scsi_host.h>
  42 #include <linux/libata.h>
  43
  44 #define DRV_NAME        "sata_sis"
  45 #define DRV_VERSION     "0.6"
  46
  47 enum {
  48         sis_180                 = 0,
  49         SIS_SCR_PCI_BAR         = 5,
  50
  51         /* PCI configuration registers */
  52         SIS_GENCTL              = 0x54, /* IDE General Control register */
  53         SIS_SCR_BASE            = 0xc0, /* sata0 phy SCR registers */
  54         SIS180_SATA1_OFS        = 0x10, /* offset from sata0->sata1 phy regs */
  55         SIS182_SATA1_OFS        = 0x20, /* offset from sata0->sata1 phy regs */
  56         SIS_PMR                 = 0x90, /* port mapping register */
  57         SIS_PMR_COMBINED        = 0x30,
  58
  59         /* random bits */
  60         SIS_FLAG_CFGSCR         = (1 << 30), /* host flag: SCRs via PCI cfg */
  61
  62         GENCTL_IOMAPPED_SCR     = (1 << 26), /* if set, SCRs are in IO space */
  63 };
  64
  65 static int sis_init_one (struct pci_dev *pdev, const struct pci_device_id *ent);
  66 static u32 sis_scr_read (struct ata_port *ap, unsigned int sc_reg);
  67 static void sis_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val);
  68
  69 static const struct pci_device_id sis_pci_tbl[] = {
  70         { PCI_VDEVICE(SI, 0x180), sis_180 },
  71         { PCI_VDEVICE(SI, 0x181), sis_180 },
  72         { PCI_VDEVICE(SI, 0x182), sis_180 },
  73
  74         { }     /* terminate list */
  75 };
  76
  77 static struct pci_driver sis_pci_driver = {
  78         .name                   = DRV_NAME,
  79         .id_table               = sis_pci_tbl,
  80         .probe                  = sis_init_one,
  81         .remove                 = ata_pci_remove_one,
  82 };
  83
  84 static struct scsi_host_template sis_sht = {
  85         .module                 = THIS_MODULE,
  86         .name                   = DRV_NAME,
  87         .ioctl                  = ata_scsi_ioctl,
  88         .queuecommand           = ata_scsi_queuecmd,
  89         .can_queue              = ATA_DEF_QUEUE,
  90         .this_id                = ATA_SHT_THIS_ID,
  91         .sg_tablesize           = ATA_MAX_PRD,
  92         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
  93         .emulated               = ATA_SHT_EMULATED,
  94         .use_clustering         = ATA_SHT_USE_CLUSTERING,
  95         .proc_name              = DRV_NAME,
  96         .dma_boundary           = ATA_DMA_BOUNDARY,
  97         .slave_configure        = ata_scsi_slave_config,
  98         .slave_destroy          = ata_scsi_slave_destroy,
  99         .bios_param             = ata_std_bios_param,
 100 };
 101
 102 static const struct ata_port_operations sis_ops = {
 103         .port_disable           = ata_port_disable,
 104         .tf_load                = ata_tf_load,
 105         .tf_read                = ata_tf_read,
 106         .check_status           = ata_check_status,
 107         .exec_command           = ata_exec_command,
 108         .dev_select             = ata_std_dev_select,
 109         .bmdma_setup            = ata_bmdma_setup,
 110         .bmdma_start            = ata_bmdma_start,
 111         .bmdma_stop             = ata_bmdma_stop,
 112         .bmdma_status           = ata_bmdma_status,
 113         .qc_prep                = ata_qc_prep,
 114         .qc_issue               = ata_qc_issue_prot,
 115         .data_xfer              = ata_pio_data_xfer,
 116         .freeze                 = ata_bmdma_freeze,
 117         .thaw                   = ata_bmdma_thaw,
 118         .error_handler          = ata_bmdma_error_handler,
 119         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 120         .irq_handler            = ata_interrupt,
 121         .irq_clear              = ata_bmdma_irq_clear,
 122         .scr_read               = sis_scr_read,
 123         .scr_write              = sis_scr_write,
 124         .port_start             = ata_port_start,
 125         .port_stop              = ata_port_stop,
 126         .host_stop              = ata_host_stop,
 127 };
 128
 129 static struct ata_port_info sis_port_info = {
 130         .sht            = &sis_sht,
 131         .flags          = ATA_FLAG_SATA | ATA_FLAG_NO_LEGACY,
 132         .pio_mask       = 0x1f,
 133         .mwdma_mask     = 0x7,
 134         .udma_mask      = 0x7f,
 135         .port_ops       = &sis_ops,
 136 };
 137
 138
 139 MODULE_AUTHOR("Uwe Koziolek");
 140 MODULE_DESCRIPTION("low-level driver for Silicon Integratad Systems SATA controller");
 141 MODULE_LICENSE("GPL");
 142 MODULE_DEVICE_TABLE(pci, sis_pci_tbl);
 143 MODULE_VERSION(DRV_VERSION);
 144
 145 static unsigned int get_scr_cfg_addr(unsigned int port_no, unsigned int sc_reg, int device)
 146 {
 147         unsigned int addr = SIS_SCR_BASE + (4 * sc_reg);
 148
 149         if (port_no)  {
 150                 if (device == 0x182)
 151                         addr += SIS182_SATA1_OFS;
 152                 else
 153                         addr += SIS180_SATA1_OFS;
 154         }
 155
 156         return addr;
 157 }
 158
 159 static u32 sis_scr_cfg_read (struct ata_port *ap, unsigned int sc_reg)
 160 {
 161         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 162         unsigned int cfg_addr = get_scr_cfg_addr(ap->port_no, sc_reg, pdev->device);
 163         u32 val, val2 = 0;
 164         u8 pmr;
 165
 166         if (sc_reg == SCR_ERROR) /* doesn't exist in PCI cfg space */
 167                 return 0xffffffff;
 168
 169         pci_read_config_byte(pdev, SIS_PMR, &pmr);
 170
 171         pci_read_config_dword(pdev, cfg_addr, &val);
 172
 173         if ((pdev->device == 0x182) || (pmr & SIS_PMR_COMBINED))
 174                 pci_read_config_dword(pdev, cfg_addr+0x10, &val2);
 175
 176         return val|val2;
 177 }
 178
 179 static void sis_scr_cfg_write (struct ata_port *ap, unsigned int scr, u32 val)
 180 {
 181         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 182         unsigned int cfg_addr = get_scr_cfg_addr(ap->port_no, scr, pdev->device);
 183         u8 pmr;
 184
 185         if (scr == SCR_ERROR) /* doesn't exist in PCI cfg space */
 186                 return;
 187
 188         pci_read_config_byte(pdev, SIS_PMR, &pmr);
 189
 190         pci_write_config_dword(pdev, cfg_addr, val);
 191
 192         if ((pdev->device == 0x182) || (pmr & SIS_PMR_COMBINED))
 193                 pci_write_config_dword(pdev, cfg_addr+0x10, val);
 194 }
 195
 196 static u32 sis_scr_read (struct ata_port *ap, unsigned int sc_reg)
 197 {
 198         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 199         u32 val, val2 = 0;
 200         u8 pmr;
 201
 202         if (sc_reg > SCR_CONTROL)
 203                 return 0xffffffffU;
 204
 205         if (ap->flags & SIS_FLAG_CFGSCR)
 206                 return sis_scr_cfg_read(ap, sc_reg);
 207
 208         pci_read_config_byte(pdev, SIS_PMR, &pmr);
 209
 210         val = inl(ap->ioaddr.scr_addr + (sc_reg * 4));
 211
 212         if ((pdev->device == 0x182) || (pmr & SIS_PMR_COMBINED))
 213                 val2 = inl(ap->ioaddr.scr_addr + (sc_reg * 4) + 0x10);
 214
 215         return val | val2;
 216 }
 217
 218 static void sis_scr_write (struct ata_port *ap, unsigned int sc_reg, u32 val)
 219 {
 220         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 221         u8 pmr;
 222
 223         if (sc_reg > SCR_CONTROL)
 224                 return;
 225
 226         pci_read_config_byte(pdev, SIS_PMR, &pmr);
 227
 228         if (ap->flags & SIS_FLAG_CFGSCR)
 229                 sis_scr_cfg_write(ap, sc_reg, val);
 230         else {
 231                 outl(val, ap->ioaddr.scr_addr + (sc_reg * 4));
 232                 if ((pdev->device == 0x182) || (pmr & SIS_PMR_COMBINED))
 233                         outl(val, ap->ioaddr.scr_addr + (sc_reg * 4)+0x10);
 234         }
 235 }
 236
 237 static int sis_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
 238 {
 239         static int printed_version;
 240         struct ata_probe_ent *probe_ent = NULL;
 241         int rc;
 242         u32 genctl;
 243         struct ata_port_info pi = sis_port_info, *ppi[2] = { &pi, &pi };
 244         int pci_dev_busy = 0;
 245         u8 pmr;
 246         u8 port2_start;
 247
 248         if (!printed_version++)
 249                 dev_printk(KERN_INFO, &pdev->dev, "version " DRV_VERSION "\n");
 250
 251         rc = pci_enable_device(pdev);
 252         if (rc)
 253                 return rc;
 254
 255         rc = pci_request_regions(pdev, DRV_NAME);
 256         if (rc) {
 257                 pci_dev_busy = 1;
 258                 goto err_out;
 259         }
 260
 261         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 262         if (rc)
 263                 goto err_out_regions;
 264         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 265         if (rc)
 266                 goto err_out_regions;
 267
 268         /* check and see if the SCRs are in IO space or PCI cfg space */
 269         pci_read_config_dword(pdev, SIS_GENCTL, &genctl);
 270         if ((genctl & GENCTL_IOMAPPED_SCR) == 0)
 271                 pi.flags |= SIS_FLAG_CFGSCR;
 272
 273         /* if hardware thinks SCRs are in IO space, but there are
 274          * no IO resources assigned, change to PCI cfg space.
 275          */
 276         if ((!(pi.flags & SIS_FLAG_CFGSCR)) &&
 277             ((pci_resource_start(pdev, SIS_SCR_PCI_BAR) == 0) ||
 278              (pci_resource_len(pdev, SIS_SCR_PCI_BAR) < 128))) {
 279                 genctl &= ~GENCTL_IOMAPPED_SCR;
 280                 pci_write_config_dword(pdev, SIS_GENCTL, genctl);
 281                 pi.flags |= SIS_FLAG_CFGSCR;
 282         }
 283
 284         pci_read_config_byte(pdev, SIS_PMR, &pmr);
 285         if (ent->device != 0x182) {
 286                 if ((pmr & SIS_PMR_COMBINED) == 0) {
 287                         dev_printk(KERN_INFO, &pdev->dev,
 288                                    "Detected SiS 180/181 chipset in SATA mode\n");
 289                         port2_start = 64;
 290                 }
 291                 else {
 292                         dev_printk(KERN_INFO, &pdev->dev,
 293                                    "Detected SiS 180/181 chipset in combined mode\n");
 294                         port2_start=0;
 295                 }
 296         }
 297         else {
 298                 dev_printk(KERN_INFO, &pdev->dev, "Detected SiS 182 chipset\n");
 299                 port2_start = 0x20;
 300         }
 301
 302         probe_ent = ata_pci_init_native_mode(pdev, ppi, ATA_PORT_PRIMARY | ATA_PORT_SECONDARY);
 303         if (!probe_ent) {
 304                 rc = -ENOMEM;
 305                 goto err_out_regions;
 306         }
 307
 308         if (!(probe_ent->port_flags & SIS_FLAG_CFGSCR)) {
 309                 probe_ent->port[0].scr_addr =
 310                         pci_resource_start(pdev, SIS_SCR_PCI_BAR);
 311                 probe_ent->port[1].scr_addr =
 312                         pci_resource_start(pdev, SIS_SCR_PCI_BAR) + port2_start;
 313         }
 314
 315         pci_set_master(pdev);
 316         pci_intx(pdev, 1);
 317
 318         /* FIXME: check ata_device_add return value */
 319         ata_device_add(probe_ent);
 320         kfree(probe_ent);
 321
 322         return 0;
 323
 324 err_out_regions:
 325         pci_release_regions(pdev);
 326
 327 err_out:
 328         if (!pci_dev_busy)
 329                 pci_disable_device(pdev);
 330         return rc;
 331
 332 }
 333
 334 static int __init sis_init(void)
 335 {
 336         return pci_register_driver(&sis_pci_driver);
 337 }
 338
 339 static void __exit sis_exit(void)
 340 {
 341         pci_unregister_driver(&sis_pci_driver);
 342 }
 343
 344 module_init(sis_init);
 345 module_exit(sis_exit);
 346