drivers/ata/pata_cmd64x.c

   1 /*
   2  * pata_cmd64x.c        - CMD64x PATA for new ATA layer
   3  *                        (C) 2005 Red Hat Inc
   4  *                        Alan Cox <alan@lxorguk.ukuu.org.uk>
   5  *                        (C) 2009-2010 Bartlomiej Zolnierkiewicz
   6  *
   7  * Based upon
   8  * linux/drivers/ide/pci/cmd64x.c               Version 1.30    Sept 10, 2002
   9  *
  10  * cmd64x.c: Enable interrupts at initialization time on Ultra/PCI machines.
  11  *           Note, this driver is not used at all on other systems because
  12  *           there the "BIOS" has done all of the following already.
  13  *           Due to massive hardware bugs, UltraDMA is only supported
  14  *           on the 646U2 and not on the 646U.
  15  *
  16  * Copyright (C) 1998           Eddie C. Dost  (ecd@skynet.be)
  17  * Copyright (C) 1998           David S. Miller (davem@redhat.com)
  18  *
  19  * Copyright (C) 1999-2002      Andre Hedrick <andre@linux-ide.org>
  20  *
  21  * TODO
  22  *      Testing work
  23  */
  24
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/pci.h>
  28 #include <linux/init.h>
  29 #include <linux/blkdev.h>
  30 #include <linux/delay.h>
  31 #include <scsi/scsi_host.h>
  32 #include <linux/libata.h>
  33
  34 #define DRV_NAME "pata_cmd64x"
  35 #define DRV_VERSION "0.2.5"
  36
  37 /*
  38  * CMD64x specific registers definition.
  39  */
  40
  41 enum {
  42         CFR             = 0x50,
  43                 CFR_INTR_CH0  = 0x02,
  44         CNTRL           = 0x51,
  45                 CNTRL_DIS_RA0 = 0x40,
  46                 CNTRL_DIS_RA1 = 0x80,
  47                 CNTRL_ENA_2ND = 0x08,
  48         CMDTIM          = 0x52,
  49         ARTTIM0         = 0x53,
  50         DRWTIM0         = 0x54,
  51         ARTTIM1         = 0x55,
  52         DRWTIM1         = 0x56,
  53         ARTTIM23        = 0x57,
  54                 ARTTIM23_DIS_RA2  = 0x04,
  55                 ARTTIM23_DIS_RA3  = 0x08,
  56                 ARTTIM23_INTR_CH1 = 0x10,
  57         ARTTIM2         = 0x57,
  58         ARTTIM3         = 0x57,
  59         DRWTIM23        = 0x58,
  60         DRWTIM2         = 0x58,
  61         BRST            = 0x59,
  62         DRWTIM3         = 0x5b,
  63         BMIDECR0        = 0x70,
  64         MRDMODE         = 0x71,
  65                 MRDMODE_INTR_CH0 = 0x04,
  66                 MRDMODE_INTR_CH1 = 0x08,
  67                 MRDMODE_BLK_CH0  = 0x10,
  68                 MRDMODE_BLK_CH1  = 0x20,
  69         BMIDESR0        = 0x72,
  70         UDIDETCR0       = 0x73,
  71         DTPR0           = 0x74,
  72         BMIDECR1        = 0x78,
  73         BMIDECSR        = 0x79,
  74         BMIDESR1        = 0x7A,
  75         UDIDETCR1       = 0x7B,
  76         DTPR1           = 0x7C
  77 };
  78
  79 static int cmd648_cable_detect(struct ata_port *ap)
  80 {
  81         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
  82         u8 r;
  83
  84         /* Check cable detect bits */
  85         pci_read_config_byte(pdev, BMIDECSR, &r);
  86         if (r & (1 << ap->port_no))
  87                 return ATA_CBL_PATA80;
  88         return ATA_CBL_PATA40;
  89 }
  90
  91 /**
  92  *      cmd64x_set_piomode      -       set PIO and MWDMA timing
  93  *      @ap: ATA interface
  94  *      @adev: ATA device
  95  *      @mode: mode
  96  *
  97  *      Called to do the PIO and MWDMA mode setup.
  98  */
  99
 100 static void cmd64x_set_timing(struct ata_port *ap, struct ata_device *adev, u8 mode)
 101 {
 102         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 103         struct ata_timing t;
 104         const unsigned long T = 1000000 / 33;
 105         const u8 setup_data[] = { 0x40, 0x40, 0x40, 0x80, 0x00 };
 106
 107         u8 reg;
 108
 109         /* Port layout is not logical so use a table */
 110         const u8 arttim_port[2][2] = {
 111                 { ARTTIM0, ARTTIM1 },
 112                 { ARTTIM23, ARTTIM23 }
 113         };
 114         const u8 drwtim_port[2][2] = {
 115                 { DRWTIM0, DRWTIM1 },
 116                 { DRWTIM2, DRWTIM3 }
 117         };
 118
 119         int arttim = arttim_port[ap->port_no][adev->devno];
 120         int drwtim = drwtim_port[ap->port_no][adev->devno];
 121
 122         /* ata_timing_compute is smart and will produce timings for MWDMA
 123            that don't violate the drives PIO capabilities. */
 124         if (ata_timing_compute(adev, mode, &t, T, 0) < 0) {
 125                 printk(KERN_ERR DRV_NAME ": mode computation failed.\n");
 126                 return;
 127         }
 128         if (ap->port_no) {
 129                 /* Slave has shared address setup */
 130                 struct ata_device *pair = ata_dev_pair(adev);
 131
 132                 if (pair) {
 133                         struct ata_timing tp;
 134
 135                         ata_timing_compute(pair, pair->pio_mode, &tp, T, 0);
 136                         ata_timing_merge(&t, &tp, &t, ATA_TIMING_SETUP);
 137                         if (pair->dma_mode) {
 138                                 ata_timing_compute(pair, pair->dma_mode,
 139                                                 &tp, T, 0);
 140                                 ata_timing_merge(&tp, &t, &t, ATA_TIMING_SETUP);
 141                         }
 142                 }
 143         }
 144
 145         printk(KERN_DEBUG DRV_NAME ": active %d recovery %d setup %d.\n",
 146                 t.active, t.recover, t.setup);
 147         if (t.recover > 16) {
 148                 t.active += t.recover - 16;
 149                 t.recover = 16;
 150         }
 151         if (t.active > 16)
 152                 t.active = 16;
 153
 154         /* Now convert the clocks into values we can actually stuff into
 155            the chip */
 156
 157         if (t.recover == 16)
 158                 t.recover = 0;
 159         else if (t.recover > 1)
 160                 t.recover--;
 161         else
 162                 t.recover = 15;
 163
 164         if (t.setup > 4)
 165                 t.setup = 0xC0;
 166         else
 167                 t.setup = setup_data[t.setup];
 168
 169         t.active &= 0x0F;       /* 0 = 16 */
 170
 171         /* Load setup timing */
 172         pci_read_config_byte(pdev, arttim, &reg);
 173         reg &= 0x3F;
 174         reg |= t.setup;
 175         pci_write_config_byte(pdev, arttim, reg);
 176
 177         /* Load active/recovery */
 178         pci_write_config_byte(pdev, drwtim, (t.active << 4) | t.recover);
 179 }
 180
 181 /**
 182  *      cmd64x_set_piomode      -       set initial PIO mode data
 183  *      @ap: ATA interface
 184  *      @adev: ATA device
 185  *
 186  *      Used when configuring the devices ot set the PIO timings. All the
 187  *      actual work is done by the PIO/MWDMA setting helper
 188  */
 189
 190 static void cmd64x_set_piomode(struct ata_port *ap, struct ata_device *adev)
 191 {
 192         cmd64x_set_timing(ap, adev, adev->pio_mode);
 193 }
 194
 195 /**
 196  *      cmd64x_set_dmamode      -       set initial DMA mode data
 197  *      @ap: ATA interface
 198  *      @adev: ATA device
 199  *
 200  *      Called to do the DMA mode setup.
 201  */
 202
 203 static void cmd64x_set_dmamode(struct ata_port *ap, struct ata_device *adev)
 204 {
 205         static const u8 udma_data[] = {
 206                 0x30, 0x20, 0x10, 0x20, 0x10, 0x00
 207         };
 208
 209         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 210         u8 regU, regD;
 211
 212         int pciU = UDIDETCR0 + 8 * ap->port_no;
 213         int pciD = BMIDESR0 + 8 * ap->port_no;
 214         int shift = 2 * adev->devno;
 215
 216         pci_read_config_byte(pdev, pciD, &regD);
 217         pci_read_config_byte(pdev, pciU, &regU);
 218
 219         /* DMA bits off */
 220         regD &= ~(0x20 << adev->devno);
 221         /* DMA control bits */
 222         regU &= ~(0x30 << shift);
 223         /* DMA timing bits */
 224         regU &= ~(0x05 << adev->devno);
 225
 226         if (adev->dma_mode >= XFER_UDMA_0) {
 227                 /* Merge the timing value */
 228                 regU |= udma_data[adev->dma_mode - XFER_UDMA_0] << shift;
 229                 /* Merge the control bits */
 230                 regU |= 1 << adev->devno; /* UDMA on */
 231                 if (adev->dma_mode > XFER_UDMA_2) /* 15nS timing */
 232                         regU |= 4 << adev->devno;
 233         } else {
 234                 regU &= ~ (1 << adev->devno);   /* UDMA off */
 235                 cmd64x_set_timing(ap, adev, adev->dma_mode);
 236         }
 237
 238         regD |= 0x20 << adev->devno;
 239
 240         pci_write_config_byte(pdev, pciU, regU);
 241         pci_write_config_byte(pdev, pciD, regD);
 242 }
 243
 244 /**
 245  *      cmd648_dma_stop -       DMA stop callback
 246  *      @qc: Command in progress
 247  *
 248  *      DMA has completed.
 249  */
 250
 251 static void cmd648_bmdma_stop(struct ata_queued_cmd *qc)
 252 {
 253         struct ata_port *ap = qc->ap;
 254         struct pci_dev *pdev = to_pci_dev(ap->host->dev);
 255         u8 dma_intr;
 256         int dma_mask = ap->port_no ? ARTTIM23_INTR_CH1 : CFR_INTR_CH0;
 257         int dma_reg = ap->port_no ? ARTTIM2 : CFR;
 258
 259         ata_bmdma_stop(qc);
 260
 261         pci_read_config_byte(pdev, dma_reg, &dma_intr);
 262         pci_write_config_byte(pdev, dma_reg, dma_intr | dma_mask);
 263 }
 264
 265 /**
 266  *      cmd646r1_dma_stop       -       DMA stop callback
 267  *      @qc: Command in progress
 268  *
 269  *      Stub for now while investigating the r1 quirk in the old driver.
 270  */
 271
 272 static void cmd646r1_bmdma_stop(struct ata_queued_cmd *qc)
 273 {
 274         ata_bmdma_stop(qc);
 275 }
 276
 277 static struct scsi_host_template cmd64x_sht = {
 278         ATA_BMDMA_SHT(DRV_NAME),
 279 };
 280
 281 static const struct ata_port_operations cmd64x_base_ops = {
 282         .inherits       = &ata_bmdma_port_ops,
 283         .set_piomode    = cmd64x_set_piomode,
 284         .set_dmamode    = cmd64x_set_dmamode,
 285 };
 286
 287 static struct ata_port_operations cmd64x_port_ops = {
 288         .inherits       = &cmd64x_base_ops,
 289         .cable_detect   = ata_cable_40wire,
 290 };
 291
 292 static struct ata_port_operations cmd646r1_port_ops = {
 293         .inherits       = &cmd64x_base_ops,
 294         .bmdma_stop     = cmd646r1_bmdma_stop,
 295         .cable_detect   = ata_cable_40wire,
 296 };
 297
 298 static struct ata_port_operations cmd648_port_ops = {
 299         .inherits       = &cmd64x_base_ops,
 300         .bmdma_stop     = cmd648_bmdma_stop,
 301         .cable_detect   = cmd648_cable_detect,
 302 };
 303
 304 static int cmd64x_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
 305 {
 306         static const struct ata_port_info cmd_info[6] = {
 307                 {       /* CMD 643 - no UDMA */
 308                         .flags = ATA_FLAG_SLAVE_POSS,
 309                         .pio_mask = ATA_PIO4,
 310                         .mwdma_mask = ATA_MWDMA2,
 311                         .port_ops = &cmd64x_port_ops
 312                 },
 313                 {       /* CMD 646 with broken UDMA */
 314                         .flags = ATA_FLAG_SLAVE_POSS,
 315                         .pio_mask = ATA_PIO4,
 316                         .mwdma_mask = ATA_MWDMA2,
 317                         .port_ops = &cmd64x_port_ops
 318                 },
 319                 {       /* CMD 646 with working UDMA */
 320                         .flags = ATA_FLAG_SLAVE_POSS,
 321                         .pio_mask = ATA_PIO4,
 322                         .mwdma_mask = ATA_MWDMA2,
 323                         .udma_mask = ATA_UDMA2,
 324                         .port_ops = &cmd64x_port_ops
 325                 },
 326                 {       /* CMD 646 rev 1  */
 327                         .flags = ATA_FLAG_SLAVE_POSS,
 328                         .pio_mask = ATA_PIO4,
 329                         .mwdma_mask = ATA_MWDMA2,
 330                         .port_ops = &cmd646r1_port_ops
 331                 },
 332                 {       /* CMD 648 */
 333                         .flags = ATA_FLAG_SLAVE_POSS,
 334                         .pio_mask = ATA_PIO4,
 335                         .mwdma_mask = ATA_MWDMA2,
 336                         .udma_mask = ATA_UDMA4,
 337                         .port_ops = &cmd648_port_ops
 338                 },
 339                 {       /* CMD 649 */
 340                         .flags = ATA_FLAG_SLAVE_POSS,
 341                         .pio_mask = ATA_PIO4,
 342                         .mwdma_mask = ATA_MWDMA2,
 343                         .udma_mask = ATA_UDMA5,
 344                         .port_ops = &cmd648_port_ops
 345                 }
 346         };
 347         const struct ata_port_info *ppi[] = { &cmd_info[id->driver_data], NULL };
 348         u8 mrdmode;
 349         int rc;
 350
 351         rc = pcim_enable_device(pdev);
 352         if (rc)
 353                 return rc;
 354
 355         if (id->driver_data == 0)       /* 643 */
 356                 ata_pci_bmdma_clear_simplex(pdev);
 357
 358         if (pdev->device == PCI_DEVICE_ID_CMD_646) {
 359                 /* Does UDMA work ? */
 360                 if (pdev->revision > 4)
 361                         ppi[0] = &cmd_info[2];
 362                 /* Early rev with other problems ? */
 363                 else if (pdev->revision == 1)
 364                         ppi[0] = &cmd_info[3];
 365         }
 366
 367         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 64);
 368         pci_read_config_byte(pdev, MRDMODE, &mrdmode);
 369         mrdmode &= ~ 0x30;      /* IRQ set up */
 370         mrdmode |= 0x02;        /* Memory read line enable */
 371         pci_write_config_byte(pdev, MRDMODE, mrdmode);
 372
 373         /* Force PIO 0 here.. */
 374
 375         /* PPC specific fixup copied from old driver */
 376 #ifdef CONFIG_PPC
 377         pci_write_config_byte(pdev, UDIDETCR0, 0xF0);
 378 #endif
 379
 380         return ata_pci_sff_init_one(pdev, ppi, &cmd64x_sht, NULL);
 381 }
 382
 383 #ifdef CONFIG_PM
 384 static int cmd64x_reinit_one(struct pci_dev *pdev)
 385 {
 386         struct ata_host *host = dev_get_drvdata(&pdev->dev);
 387         u8 mrdmode;
 388         int rc;
 389
 390         rc = ata_pci_device_do_resume(pdev);
 391         if (rc)
 392                 return rc;
 393
 394         pci_write_config_byte(pdev, PCI_LATENCY_TIMER, 64);
 395         pci_read_config_byte(pdev, MRDMODE, &mrdmode);
 396         mrdmode &= ~ 0x30;      /* IRQ set up */
 397         mrdmode |= 0x02;        /* Memory read line enable */
 398         pci_write_config_byte(pdev, MRDMODE, mrdmode);
 399 #ifdef CONFIG_PPC
 400         pci_write_config_byte(pdev, UDIDETCR0, 0xF0);
 401 #endif
 402         ata_host_resume(host);
 403         return 0;
 404 }
 405 #endif
 406
 407 static const struct pci_device_id cmd64x[] = {
 408         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_CMD_643), 0 },
 409         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_CMD_646), 1 },
 410         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_CMD_648), 4 },
 411         { PCI_VDEVICE(CMD, PCI_DEVICE_ID_CMD_649), 5 },
 412
 413         { },
 414 };
 415
 416 static struct pci_driver cmd64x_pci_driver = {
 417         .name           = DRV_NAME,
 418         .id_table       = cmd64x,
 419         .probe          = cmd64x_init_one,
 420         .remove         = ata_pci_remove_one,
 421 #ifdef CONFIG_PM
 422         .suspend        = ata_pci_device_suspend,
 423         .resume         = cmd64x_reinit_one,
 424 #endif
 425 };
 426
 427 static int __init cmd64x_init(void)
 428 {
 429         return pci_register_driver(&cmd64x_pci_driver);
 430 }
 431
 432 static void __exit cmd64x_exit(void)
 433 {
 434         pci_unregister_driver(&cmd64x_pci_driver);
 435 }
 436
 437 MODULE_AUTHOR("Alan Cox");
 438 MODULE_DESCRIPTION("low-level driver for CMD64x series PATA controllers");
 439 MODULE_LICENSE("GPL");
 440 MODULE_DEVICE_TABLE(pci, cmd64x);
 441 MODULE_VERSION(DRV_VERSION);
 442
 443 module_init(cmd64x_init);
 444 module_exit(cmd64x_exit);