drivers/ata/pata_cs5520.c

   1 /*
   2  *      IDE tuning and bus mastering support for the CS5510/CS5520
   3  *      chipsets
   4  *
   5  *      The CS5510/CS5520 are slightly unusual devices. Unlike the
   6  *      typical IDE controllers they do bus mastering with the drive in
   7  *      PIO mode and smarter silicon.
   8  *
   9  *      The practical upshot of this is that we must always tune the
  10  *      drive for the right PIO mode. We must also ignore all the blacklists
  11  *      and the drive bus mastering DMA information. Also to confuse matters
  12  *      further we can do DMA on PIO only drives.
  13  *
  14  *      DMA on the 5510 also requires we disable_hlt() during DMA on early
  15  *      revisions.
  16  *
  17  *      *** This driver is strictly experimental ***
  18  *
  19  *      (c) Copyright Red Hat Inc 2002
  20  *
  21  * This program is free software; you can redistribute it and/or modify it
  22  * under the terms of the GNU General Public License as published by the
  23  * Free Software Foundation; either version 2, or (at your option) any
  24  * later version.
  25  *
  26  * This program is distributed in the hope that it will be useful, but
  27  * WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  29  * General Public License for more details.
  30  *
  31  * Documentation:
  32  *      Not publically available.
  33  */
  34 #include <linux/kernel.h>
  35 #include <linux/module.h>
  36 #include <linux/pci.h>
  37 #include <linux/init.h>
  38 #include <linux/blkdev.h>
  39 #include <linux/delay.h>
  40 #include <scsi/scsi_host.h>
  41 #include <linux/libata.h>
  42
  43 #define DRV_NAME        "pata_cs5520"
  44 #define DRV_VERSION     "0.6.5"
  45
  46 struct pio_clocks
  47 {
  48         int address;
  49         int assert;
  50         int recovery;
  51 };
  52
  53 static const struct pio_clocks cs5520_pio_clocks[]={
  54         {3, 6, 11},
  55         {2, 5, 6},
  56         {1, 4, 3},
  57         {1, 3, 2},
  58         {1, 2, 1}
  59 };
  60
  61 /**
  62  *      cs5520_set_timings      -       program PIO timings
  63  *      @ap: ATA port
  64  *      @adev: ATA device
  65  *
  66  *      Program the PIO mode timings for the controller according to the pio
  67  *      clocking table.
  68  */
  69
  70 static void cs5520_set_timings(struct ata_port *ap, struct ata_device *adev, int pio)
  71 {
  72         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
  73         int slave = adev->devno;
  74
  75         pio -= XFER_PIO_0;
  76
  77         /* Channel command timing */
  78         pci_write_config_byte(pdev, 0x62 + ap->port_no,
  79                                 (cs5520_pio_clocks[pio].recovery << 4) |
  80                                 (cs5520_pio_clocks[pio].assert));
  81         /* FIXME: should these use address ? */
  82         /* Read command timing */
  83         pci_write_config_byte(pdev, 0x64 +  4*ap->port_no + slave,
  84                                 (cs5520_pio_clocks[pio].recovery << 4) |
  85                                 (cs5520_pio_clocks[pio].assert));
  86         /* Write command timing */
  87         pci_write_config_byte(pdev, 0x66 +  4*ap->port_no + slave,
  88                                 (cs5520_pio_clocks[pio].recovery << 4) |
  89                                 (cs5520_pio_clocks[pio].assert));
  90 }
  91
  92 /**
  93  *      cs5520_enable_dma       -       turn on DMA bits
  94  *
  95  *      Turn on the DMA bits for this disk. Needed because the BIOS probably
  96  *      has not done the work for us. Belongs in the core SATA code.
  97  */
  98
  99 static void cs5520_enable_dma(struct ata_port *ap, struct ata_device *adev)
 100 {
 101         /* Set the DMA enable/disable flag */
 102         u8 reg = ioread8(ap->ioaddr.bmdma_addr + 0x02);
 103         reg |= 1<<(adev->devno + 5);
 104         iowrite8(reg, ap->ioaddr.bmdma_addr + 0x02);
 105 }
 106
 107 /**
 108  *      cs5520_set_dmamode      -       program DMA timings
 109  *      @ap: ATA port
 110  *      @adev: ATA device
 111  *
 112  *      Program the DMA mode timings for the controller according to the pio
 113  *      clocking table. Note that this device sets the DMA timings to PIO
 114  *      mode values. This may seem bizarre but the 5520 architecture talks
 115  *      PIO mode to the disk and DMA mode to the controller so the underlying
 116  *      transfers are PIO timed.
 117  */
 118
 119 static void cs5520_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 120 {
 121         static const int dma_xlate[3] = { XFER_PIO_0, XFER_PIO_3, XFER_PIO_4 };
 122         cs5520_set_timings(ap, adev, dma_xlate[adev->dma_mode]);
 123         cs5520_enable_dma(ap, adev);
 124 }
 125
 126 /**
 127  *      cs5520_set_piomode      -       program PIO timings
 128  *      @ap: ATA port
 129  *      @adev: ATA device
 130  *
 131  *      Program the PIO mode timings for the controller according to the pio
 132  *      clocking table. We know pio_mode will equal dma_mode because of the
 133  *      CS5520 architecture. At least once we turned DMA on and wrote a
 134  *      mode setter.
 135  */
 136
 137 static void cs5520_set_piomode(struct ata_port *ap, struct ata_device *adev)
 138 {
 139         cs5520_set_timings(ap, adev, adev->pio_mode);
 140 }
 141
 142 static struct scsi_host_template cs5520_sht = {
 143         .module                 = THIS_MODULE,
 144         .name                   = DRV_NAME,
 145         .ioctl                  = ata_scsi_ioctl,
 146         .queuecommand           = ata_scsi_queuecmd,
 147         .can_queue              = ATA_DEF_QUEUE,
 148         .this_id                = ATA_SHT_THIS_ID,
 149         .sg_tablesize           = LIBATA_MAX_PRD,
 150         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
 151         .emulated               = ATA_SHT_EMULATED,
 152         .use_clustering         = ATA_SHT_USE_CLUSTERING,
 153         .proc_name              = DRV_NAME,
 154         .dma_boundary           = ATA_DMA_BOUNDARY,
 155         .slave_configure        = ata_scsi_slave_config,
 156         .slave_destroy          = ata_scsi_slave_destroy,
 157         .bios_param             = ata_std_bios_param,
 158 };
 159
 160 static struct ata_port_operations cs5520_port_ops = {
 161         .port_disable           = ata_port_disable,
 162         .set_piomode            = cs5520_set_piomode,
 163         .set_dmamode            = cs5520_set_dmamode,
 164
 165         .tf_load                = ata_tf_load,
 166         .tf_read                = ata_tf_read,
 167         .check_status           = ata_check_status,
 168         .exec_command           = ata_exec_command,
 169         .dev_select             = ata_std_dev_select,
 170
 171         .freeze                 = ata_bmdma_freeze,
 172         .thaw                   = ata_bmdma_thaw,
 173         .error_handler          = ata_bmdma_error_handler,
 174         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
 175         .cable_detect           = ata_cable_40wire,
 176
 177         .bmdma_setup            = ata_bmdma_setup,
 178         .bmdma_start            = ata_bmdma_start,
 179         .bmdma_stop             = ata_bmdma_stop,
 180         .bmdma_status           = ata_bmdma_status,
 181         .qc_prep                = ata_qc_prep,
 182         .qc_issue               = ata_qc_issue_prot,
 183         .data_xfer              = ata_data_xfer,
 184
 185         .irq_clear              = ata_bmdma_irq_clear,
 186         .irq_on                 = ata_irq_on,
 187         .irq_ack                = ata_irq_ack,
 188
 189         .port_start             = ata_port_start,
 190 };
 191
 192 static int __devinit cs5520_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 193 {
 194         struct ata_port_info pi = {
 195                 .flags          = ATA_FLAG_SLAVE_POSS,
 196                 .pio_mask       = 0x1f,
 197                 .port_ops       = &cs5520_port_ops,
 198         };
 199         const struct ata_port_info *ppi[2];
 200         u8 pcicfg;
 201         void *iomap[5];
 202         struct ata_host *host;
 203         struct ata_ioports *ioaddr;
 204         int i, rc;
 205
 206         /* IDE port enable bits */
 207         pci_read_config_byte(pdev, 0x60, &pcicfg);
 208
 209         /* Check if the ATA ports are enabled */
 210         if ((pcicfg & 3) == 0)
 211                 return -ENODEV;
 212
 213         ppi[0] = ppi[1] = &ata_dummy_port_info;
 214         if (pcicfg & 1)
 215                 ppi[0] = &pi;
 216         if (pcicfg & 2)
 217                 ppi[1] = &pi;
 218
 219         if ((pcicfg & 0x40) == 0) {
 220                 dev_printk(KERN_WARNING, &pdev->dev,
 221                            "DMA mode disabled. Enabling.\n");
 222                 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40);
 223         }
 224
 225         pi.mwdma_mask = id->driver_data;
 226
 227         host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2);
 228         if (!host)
 229                 return -ENOMEM;
 230
 231         /* Perform set up for DMA */
 232         if (pci_enable_device_bars(pdev, 1<<2)) {
 233                 printk(KERN_ERR DRV_NAME ": unable to configure BAR2.\n");
 234                 return -ENODEV;
 235         }
 236
 237         if (pci_set_dma_mask(pdev, DMA_32BIT_MASK)) {
 238                 printk(KERN_ERR DRV_NAME ": unable to configure DMA mask.\n");
 239                 return -ENODEV;
 240         }
 241         if (pci_set_consistent_dma_mask(pdev, DMA_32BIT_MASK)) {
 242                 printk(KERN_ERR DRV_NAME ": unable to configure consistent DMA mask.\n");
 243                 return -ENODEV;
 244         }
 245
 246         /* Map IO ports and initialize host accordingly */
 247         iomap[0] = devm_ioport_map(&pdev->dev, 0x1F0, 8);
 248         iomap[1] = devm_ioport_map(&pdev->dev, 0x3F6, 1);
 249         iomap[2] = devm_ioport_map(&pdev->dev, 0x170, 8);
 250         iomap[3] = devm_ioport_map(&pdev->dev, 0x376, 1);
 251         iomap[4] = pcim_iomap(pdev, 2, 0);
 252
 253         if (!iomap[0] || !iomap[1] || !iomap[2] || !iomap[3] || !iomap[4])
 254                 return -ENOMEM;
 255
 256         ioaddr = &host->ports[0]->ioaddr;
 257         ioaddr->cmd_addr = iomap[0];
 258         ioaddr->ctl_addr = iomap[1];
 259         ioaddr->altstatus_addr = iomap[1];
 260         ioaddr->bmdma_addr = iomap[4];
 261         ata_std_ports(ioaddr);
 262
 263         ioaddr = &host->ports[1]->ioaddr;
 264         ioaddr->cmd_addr = iomap[2];
 265         ioaddr->ctl_addr = iomap[3];
 266         ioaddr->altstatus_addr = iomap[3];
 267         ioaddr->bmdma_addr = iomap[4] + 8;
 268         ata_std_ports(ioaddr);
 269
 270         /* activate the host */
 271         pci_set_master(pdev);
 272         rc = ata_host_start(host);
 273         if (rc)
 274                 return rc;
 275
 276         for (i = 0; i < 2; i++) {
 277                 static const int irq[] = { 14, 15 };
 278                 struct ata_port *ap = host->ports[0];
 279
 280                 if (ata_port_is_dummy(ap))
 281                         continue;
 282
 283                 rc = devm_request_irq(&pdev->dev, irq[ap->port_no],
 284                                       ata_interrupt, 0, DRV_NAME, host);
 285                 if (rc)
 286                         return rc;
 287         }
 288
 289         return ata_host_register(host, &cs5520_sht);
 290 }
 291
 292 /**
 293  *      cs5520_remove_one       -       device unload
 294  *      @pdev: PCI device being removed
 295  *
 296  *      Handle an unplug/unload event for a PCI device. Unload the
 297  *      PCI driver but do not use the default handler as we manage
 298  *      resources ourself and *MUST NOT* disable the device as it has
 299  *      other functions.
 300  */
 301
 302 static void __devexit cs5520_remove_one(struct pci_dev *pdev)
 303 {
 304         struct device *dev = pci_dev_to_dev(pdev);
 305         struct ata_host *host = dev_get_drvdata(dev);
 306
 307         ata_host_detach(host);
 308 }
 309
 310 #ifdef CONFIG_PM
 311 /**
 312  *      cs5520_reinit_one       -       device resume
 313  *      @pdev: PCI device
 314  *
 315  *      Do any reconfiguration work needed by a resume from RAM. We need
 316  *      to restore DMA mode support on BIOSen which disabled it
 317  */
 318
 319 static int cs5520_reinit_one(struct pci_dev *pdev)
 320 {
 321         u8 pcicfg;
 322         pci_read_config_byte(pdev, 0x60, &pcicfg);
 323         if ((pcicfg & 0x40) == 0)
 324                 pci_write_config_byte(pdev, 0x60, pcicfg | 0x40);
 325         return ata_pci_device_resume(pdev);
 326 }
 327
 328 /**
 329  *      cs5520_pci_device_suspend       -       device suspend
 330  *      @pdev: PCI device
 331  *
 332  *      We have to cut and waste bits from the standard method because
 333  *      the 5520 is a bit odd and not just a pure ATA device. As a result
 334  *      we must not disable it. The needed code is short and this avoids
 335  *      chip specific mess in the core code.
 336  */
 337
 338 static int cs5520_pci_device_suspend(struct pci_dev *pdev, pm_message_t mesg)
 339 {
 340         struct ata_host *host = dev_get_drvdata(&pdev->dev);
 341         int rc = 0;
 342
 343         rc = ata_host_suspend(host, mesg);
 344         if (rc)
 345                 return rc;
 346
 347         pci_save_state(pdev);
 348         return 0;
 349 }
 350 #endif /* CONFIG_PM */
 351
 352 /* For now keep DMA off. We can set it for all but A rev CS5510 once the
 353    core ATA code can handle it */
 354
 355 static const struct pci_device_id pata_cs5520[] = {
 356         { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5510), },
 357         { PCI_VDEVICE(CYRIX, PCI_DEVICE_ID_CYRIX_5520), },
 358
 359         { },
 360 };
 361
 362 static struct pci_driver cs5520_pci_driver = {
 363         .name           = DRV_NAME,
 364         .id_table       = pata_cs5520,
 365         .probe          = cs5520_init_one,
 366         .remove         = cs5520_remove_one,
 367 #ifdef CONFIG_PM
 368         .suspend        = cs5520_pci_device_suspend,
 369         .resume         = cs5520_reinit_one,
 370 #endif
 371 };
 372
 373 static int __init cs5520_init(void)
 374 {
 375         return pci_register_driver(&cs5520_pci_driver);
 376 }
 377
 378 static void __exit cs5520_exit(void)
 379 {
 380         pci_unregister_driver(&cs5520_pci_driver);
 381 }
 382
 383 MODULE_AUTHOR("Alan Cox");
 384 MODULE_DESCRIPTION("low-level driver for Cyrix CS5510/5520");
 385 MODULE_LICENSE("GPL");
 386 MODULE_DEVICE_TABLE(pci, pata_cs5520);
 387 MODULE_VERSION(DRV_VERSION);
 388
 389 module_init(cs5520_init);
 390 module_exit(cs5520_exit);
 391