drivers/ata/pata_sil680.c

   1 /*
   2  * pata_sil680.c        - SIL680 PATA for new ATA layer
   3  *                        (C) 2005 Red Hat Inc
   4  *                        Alan Cox <alan@redhat.com>
   5  *
   6  * based upon
   7  *
   8  * linux/drivers/ide/pci/siimage.c              Version 1.07    Nov 30, 2003
   9  *
  10  * Copyright (C) 2001-2002      Andre Hedrick <andre@linux-ide.org>
  11  * Copyright (C) 2003           Red Hat <alan@redhat.com>
  12  *
  13  *  May be copied or modified under the terms of the GNU General Public License
  14  *
  15  *  Documentation publically available.
  16  *
  17  *      If you have strange problems with nVidia chipset systems please
  18  *      see the SI support documentation and update your system BIOS
  19  *      if necessary
  20  *
  21  * TODO
  22  *      If we know all our devices are LBA28 (or LBA28 sized)  we could use
  23  *      the command fifo mode.
  24  */
  25
  26 #include <linux/kernel.h>
  27 #include <linux/module.h>
  28 #include <linux/pci.h>
  29 #include <linux/init.h>
  30 #include <linux/blkdev.h>
  31 #include <linux/delay.h>
  32 #include <scsi/scsi_host.h>
  33 #include <linux/libata.h>
  34
  35 #define DRV_NAME "pata_sil680"
  36 #define DRV_VERSION "0.4.8"
  37
  38 #define SIL680_MMIO_BAR         5
  39
  40 /**
  41  *      sil680_selreg           -       return register base
  42  *      @hwif: interface
  43  *      @r: config offset
  44  *
  45  *      Turn a config register offset into the right address in either
  46  *      PCI space or MMIO space to access the control register in question
  47  *      Thankfully this is a configuration operation so isnt performance
  48  *      criticial.
  49  */
  50
  51 static unsigned long sil680_selreg(struct ata_port *ap, int r)
  52 {
  53         unsigned long base = 0xA0 + r;
  54         base += (ap->port_no << 4);
  55         return base;
  56 }
  57
  58 /**
  59  *      sil680_seldev           -       return register base
  60  *      @hwif: interface
  61  *      @r: config offset
  62  *
  63  *      Turn a config register offset into the right address in either
  64  *      PCI space or MMIO space to access the control register in question
  65  *      including accounting for the unit shift.
  66  */
  67
  68 static unsigned long sil680_seldev(struct ata_port *ap, struct ata_device *adev, int r)
  69 {
  70         unsigned long base = 0xA0 + r;
  71         base += (ap->port_no << 4);
  72         base |= adev->devno ? 2 : 0;
  73         return base;
  74 }
  75
  76
  77 /**
  78  *      sil680_cable_detect     -       cable detection
  79  *      @ap: ATA port
  80  *
  81  *      Perform cable detection. The SIL680 stores this in PCI config
  82  *      space for us.
  83  */
  84
  85 static int sil680_cable_detect(struct ata_port *ap) {
  86         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
  87         unsigned long addr = sil680_selreg(ap, 0);
  88         u8 ata66;
  89         pci_read_config_byte(pdev, addr, &ata66);
  90         if (ata66 & 1)
  91                 return ATA_CBL_PATA80;
  92         else
  93                 return ATA_CBL_PATA40;
  94 }
  95
  96 /**
  97  *      sil680_set_piomode      -       set initial PIO mode data
  98  *      @ap: ATA interface
  99  *      @adev: ATA device
 100  *
 101  *      Program the SIL680 registers for PIO mode. Note that the task speed
 102  *      registers are shared between the devices so we must pick the lowest
 103  *      mode for command work.
 104  */
 105
 106 static void sil680_set_piomode(struct ata_port *ap, struct ata_device *adev)
 107 {
 108         static u16 speed_p[5] = { 0x328A, 0x2283, 0x1104, 0x10C3, 0x10C1 };
 109         static u16 speed_t[5] = { 0x328A, 0x2283, 0x1281, 0x10C3, 0x10C1 };
 110
 111         unsigned long tfaddr = sil680_selreg(ap, 0x02);
 112         unsigned long addr = sil680_seldev(ap, adev, 0x04);
 113         unsigned long addr_mask = 0x80 + 4 * ap->port_no;
 114         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 115         int pio = adev->pio_mode - XFER_PIO_0;
 116         int lowest_pio = pio;
 117         int port_shift = 4 * adev->devno;
 118         u16 reg;
 119         u8 mode;
 120
 121         struct ata_device *pair = ata_dev_pair(adev);
 122
 123         if (pair != NULL && adev->pio_mode > pair->pio_mode)
 124                 lowest_pio = pair->pio_mode - XFER_PIO_0;
 125
 126         pci_write_config_word(pdev, addr, speed_p[pio]);
 127         pci_write_config_word(pdev, tfaddr, speed_t[lowest_pio]);
 128
 129         pci_read_config_word(pdev, tfaddr-2, &reg);
 130         pci_read_config_byte(pdev, addr_mask, &mode);
 131
 132         reg &= ~0x0200;                 /* Clear IORDY */
 133         mode &= ~(3 << port_shift);     /* Clear IORDY and DMA bits */
 134
 135         if (ata_pio_need_iordy(adev)) {
 136                 reg |= 0x0200;          /* Enable IORDY */
 137                 mode |= 1 << port_shift;
 138         }
 139         pci_write_config_word(pdev, tfaddr-2, reg);
 140         pci_write_config_byte(pdev, addr_mask, mode);
 141 }
 142
 143 /**
 144  *      sil680_set_dmamode      -       set initial DMA mode data
 145  *      @ap: ATA interface
 146  *      @adev: ATA device
 147  *
 148  *      Program the MWDMA/UDMA modes for the sil680 k
 149  *      chipset. The MWDMA mode values are pulled from a lookup table
 150  *      while the chipset uses mode number for UDMA.
 151  */
 152
 153 static void sil680_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 154 {
 155         static u8 ultra_table[2][7] = {
 156                 { 0x0C, 0x07, 0x05, 0x04, 0x02, 0x01, 0xFF },   /* 100MHz */
 157                 { 0x0F, 0x0B, 0x07, 0x05, 0x03, 0x02, 0x01 },   /* 133Mhz */
 158         };
 159         static u16 dma_table[3] = { 0x2208, 0x10C2, 0x10C1 };
 160
 161         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 162         unsigned long ma = sil680_seldev(ap, adev, 0x08);
 163         unsigned long ua = sil680_seldev(ap, adev, 0x0C);
 164         unsigned long addr_mask = 0x80 + 4 * ap->port_no;
 165         int port_shift = adev->devno * 4;
 166         u8 scsc, mode;
 167         u16 multi, ultra;
 168
 169         pci_read_config_byte(pdev, 0x8A, &scsc);
 170         pci_read_config_byte(pdev, addr_mask, &mode);
 171         pci_read_config_word(pdev, ma, &multi);
 172         pci_read_config_word(pdev, ua, &ultra);
 173
 174         /* Mask timing bits */
 175         ultra &= ~0x3F;
 176         mode &= ~(0x03 << port_shift);
 177
 178         /* Extract scsc */
 179         scsc = (scsc & 0x30) ? 1: 0;
 180
 181         if (adev->dma_mode >= XFER_UDMA_0) {
 182                 multi = 0x10C1;
 183                 ultra |= ultra_table[scsc][adev->dma_mode - XFER_UDMA_0];
 184                 mode |= (0x03 << port_shift);
 185         } else {
 186                 multi = dma_table[adev->dma_mode - XFER_MW_DMA_0];
 187                 mode |= (0x02 << port_shift);
 188         }
 189         pci_write_config_byte(pdev, addr_mask, mode);
 190         pci_write_config_word(pdev, ma, multi);
 191         pci_write_config_word(pdev, ua, ultra);
 192 }
 193
 194 static struct scsi_host_template sil680_sht = {
 195         ATA_BMDMA_SHT(DRV_NAME),
 196 };
 197
 198 static struct ata_port_operations sil680_port_ops = {
 199         .inherits       = &ata_bmdma_port_ops,
 200         .cable_detect   = sil680_cable_detect,
 201         .set_piomode    = sil680_set_piomode,
 202         .set_dmamode    = sil680_set_dmamode,
 203 };
 204
 205 /**
 206  *      sil680_init_chip                -       chip setup
 207  *      @pdev: PCI device
 208  *
 209  *      Perform all the chip setup which must be done both when the device
 210  *      is powered up on boot and when we resume in case we resumed from RAM.
 211  *      Returns the final clock settings.
 212  */
 213
 214 static u8 sil680_init_chip(struct pci_dev *pdev, int *try_mmio)
 215 {
 216         u32 class_rev   = 0;
 217         u8 tmpbyte      = 0;
 218
 219         pci_read_config_dword(pdev, PCI_CLASS_REVISION, &class_rev);
 220         class_rev &= 0xff;
 221         /* FIXME: double check */
 222         pci_write_config_byte(pdev, PCI_CACHE_LINE_SIZE, (class_rev) ? 1 : 255);
 223
 224         pci_write_config_byte(pdev, 0x80, 0x00);
 225         pci_write_config_byte(pdev, 0x84, 0x00);
 226
 227         pci_read_config_byte(pdev, 0x8A, &tmpbyte);
 228
 229         dev_dbg(&pdev->dev, "sil680: BA5_EN = %d clock = %02X\n",
 230                 tmpbyte & 1, tmpbyte & 0x30);
 231
 232         *try_mmio = 0;
 233 #ifdef CONFIG_PPC
 234         if (machine_is(cell))
 235                 *try_mmio = (tmpbyte & 1) || pci_resource_start(pdev, 5);
 236 #endif
 237
 238         switch(tmpbyte & 0x30) {
 239                 case 0x00:
 240                         /* 133 clock attempt to force it on */
 241                         pci_write_config_byte(pdev, 0x8A, tmpbyte|0x10);
 242                         break;
 243                 case 0x30:
 244                         /* if clocking is disabled */
 245                         /* 133 clock attempt to force it on */
 246                         pci_write_config_byte(pdev, 0x8A, tmpbyte & ~0x20);
 247                         break;
 248                 case 0x10:
 249                         /* 133 already */
 250                         break;
 251                 case 0x20:
 252                         /* BIOS set PCI x2 clocking */
 253                         break;
 254         }
 255
 256         pci_read_config_byte(pdev,   0x8A, &tmpbyte);
 257         dev_dbg(&pdev->dev, "sil680: BA5_EN = %d clock = %02X\n",
 258                 tmpbyte & 1, tmpbyte & 0x30);
 259
 260         pci_write_config_byte(pdev,  0xA1, 0x72);
 261         pci_write_config_word(pdev,  0xA2, 0x328A);
 262         pci_write_config_dword(pdev, 0xA4, 0x62DD62DD);
 263         pci_write_config_dword(pdev, 0xA8, 0x43924392);
 264         pci_write_config_dword(pdev, 0xAC, 0x40094009);
 265         pci_write_config_byte(pdev,  0xB1, 0x72);
 266         pci_write_config_word(pdev,  0xB2, 0x328A);
 267         pci_write_config_dword(pdev, 0xB4, 0x62DD62DD);
 268         pci_write_config_dword(pdev, 0xB8, 0x43924392);
 269         pci_write_config_dword(pdev, 0xBC, 0x40094009);
 270
 271         switch(tmpbyte & 0x30) {
 272                 case 0x00: printk(KERN_INFO "sil680: 100MHz clock.\n");break;
 273                 case 0x10: printk(KERN_INFO "sil680: 133MHz clock.\n");break;
 274                 case 0x20: printk(KERN_INFO "sil680: Using PCI clock.\n");break;
 275                 /* This last case is _NOT_ ok */
 276                 case 0x30: printk(KERN_ERR "sil680: Clock disabled ?\n");
 277         }
 278         return tmpbyte & 0x30;
 279 }
 280
 281 static int __devinit sil680_init_one(struct pci_dev *pdev,
 282                                      const struct pci_device_id *id)
 283 {
 284         static const struct ata_port_info info = {
 285                 .flags = ATA_FLAG_SLAVE_POSS,
 286                 .pio_mask = 0x1f,
 287                 .mwdma_mask = 0x07,
 288                 .udma_mask = ATA_UDMA6,
 289                 .port_ops = &sil680_port_ops
 290         };
 291         static const struct ata_port_info info_slow = {
 292                 .flags = ATA_FLAG_SLAVE_POSS,
 293                 .pio_mask = 0x1f,
 294                 .mwdma_mask = 0x07,
 295                 .udma_mask = ATA_UDMA5,
 296                 .port_ops = &sil680_port_ops
 297         };
 298         const struct ata_port_info *ppi[] = { &info, NULL };
 299         static int printed_version;
 300         struct ata_host *host;
 301         void __iomem *mmio_base;
 302         int rc, try_mmio;
 303
 304         if (!printed_version++)
 305                 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
 306
 307         rc = pcim_enable_device(pdev);
 308         if (rc)
 309                 return rc;
 310
 311         switch (sil680_init_chip(pdev, &try_mmio)) {
 312                 case 0:
 313                         ppi[0] = &info_slow;
 314                         break;
 315                 case 0x30:
 316                         return -ENODEV;
 317         }
 318
 319         if (!try_mmio)
 320                 goto use_ioports;
 321
 322         /* Try to acquire MMIO resources and fallback to PIO if
 323          * that fails
 324          */
 325         rc = pcim_iomap_regions(pdev, 1 << SIL680_MMIO_BAR, DRV_NAME);
 326         if (rc)
 327                 goto use_ioports;
 328
 329         /* Allocate host and set it up */
 330         host = ata_host_alloc_pinfo(&pdev->dev, ppi, 2);
 331         if (!host)
 332                 return -ENOMEM;
 333         host->iomap = pcim_iomap_table(pdev);
 334
 335         /* Setup DMA masks */
 336         rc = pci_set_dma_mask(pdev, ATA_DMA_MASK);
 337         if (rc)
 338                 return rc;
 339         rc = pci_set_consistent_dma_mask(pdev, ATA_DMA_MASK);
 340         if (rc)
 341                 return rc;
 342         pci_set_master(pdev);
 343
 344         /* Get MMIO base and initialize port addresses */
 345         mmio_base = host->iomap[SIL680_MMIO_BAR];
 346         host->ports[0]->ioaddr.bmdma_addr = mmio_base + 0x00;
 347         host->ports[0]->ioaddr.cmd_addr = mmio_base + 0x80;
 348         host->ports[0]->ioaddr.ctl_addr = mmio_base + 0x8a;
 349         host->ports[0]->ioaddr.altstatus_addr = mmio_base + 0x8a;
 350         ata_sff_std_ports(&host->ports[0]->ioaddr);
 351         host->ports[1]->ioaddr.bmdma_addr = mmio_base + 0x08;
 352         host->ports[1]->ioaddr.cmd_addr = mmio_base + 0xc0;
 353         host->ports[1]->ioaddr.ctl_addr = mmio_base + 0xca;
 354         host->ports[1]->ioaddr.altstatus_addr = mmio_base + 0xca;
 355         ata_sff_std_ports(&host->ports[1]->ioaddr);
 356
 357         /* Register & activate */
 358         return ata_host_activate(host, pdev->irq, ata_sff_interrupt,
 359                                  IRQF_SHARED, &sil680_sht);
 360
 361 use_ioports:
 362         return ata_pci_sff_init_one(pdev, ppi, &sil680_sht, NULL);
 363 }
 364
 365 #ifdef CONFIG_PM
 366 static int sil680_reinit_one(struct pci_dev *pdev)
 367 {
 368         struct ata_host *host = dev_get_drvdata(&pdev->dev);
 369         int try_mmio, rc;
 370
 371         rc = ata_pci_device_do_resume(pdev);
 372         if (rc)
 373                 return rc;
 374         sil680_init_chip(pdev, &try_mmio);
 375         ata_host_resume(host);
 376         return 0;
 377 }
 378 #endif
 379
 380 static const struct pci_device_id sil680[] = {
 381         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_SII_680), },
 382
 383         { },
 384 };
 385
 386 static struct pci_driver sil680_pci_driver = {
 387         .name           = DRV_NAME,
 388         .id_table       = sil680,
 389         .probe          = sil680_init_one,
 390         .remove         = ata_pci_remove_one,
 391 #ifdef CONFIG_PM
 392         .suspend        = ata_pci_device_suspend,
 393         .resume         = sil680_reinit_one,
 394 #endif
 395 };
 396
 397 static int __init sil680_init(void)
 398 {
 399         return pci_register_driver(&sil680_pci_driver);
 400 }
 401
 402 static void __exit sil680_exit(void)
 403 {
 404         pci_unregister_driver(&sil680_pci_driver);
 405 }
 406
 407 MODULE_AUTHOR("Alan Cox");
 408 MODULE_DESCRIPTION("low-level driver for SI680 PATA");
 409 MODULE_LICENSE("GPL");
 410 MODULE_DEVICE_TABLE(pci, sil680);
 411 MODULE_VERSION(DRV_VERSION);
 412
 413 module_init(sil680_init);
 414 module_exit(sil680_exit);