drivers/ide/pci/tc86c001.c

   1 /*
   2  * drivers/ide/pci/tc86c001.c   Version 1.00    Dec 12, 2006
   3  *
   4  * Copyright (C) 2002 Toshiba Corporation
   5  * Copyright (C) 2005-2006 MontaVista Software, Inc. <source@mvista.com>
   6  *
   7  * This file is licensed under the terms of the GNU General Public
   8  * License version 2.  This program is licensed "as is" without any
   9  * warranty of any kind, whether express or implied.
  10  */
  11
  12 #include <linux/types.h>
  13 #include <linux/pci.h>
  14 #include <linux/ide.h>
  15
  16 static int tc86c001_tune_chipset(ide_drive_t *drive, u8 speed)
  17 {
  18         ide_hwif_t *hwif        = HWIF(drive);
  19         unsigned long scr_port  = hwif->config_data + (drive->dn ? 0x02 : 0x00);
  20         u16 mode, scr           = hwif->INW(scr_port);
  21
  22         speed = ide_rate_filter(drive, speed);
  23
  24         switch (speed) {
  25                 case XFER_UDMA_4:       mode = 0x00c0; break;
  26                 case XFER_UDMA_3:       mode = 0x00b0; break;
  27                 case XFER_UDMA_2:       mode = 0x00a0; break;
  28                 case XFER_UDMA_1:       mode = 0x0090; break;
  29                 case XFER_UDMA_0:       mode = 0x0080; break;
  30                 case XFER_MW_DMA_2:     mode = 0x0070; break;
  31                 case XFER_MW_DMA_1:     mode = 0x0060; break;
  32                 case XFER_MW_DMA_0:     mode = 0x0050; break;
  33                 case XFER_PIO_4:        mode = 0x0400; break;
  34                 case XFER_PIO_3:        mode = 0x0300; break;
  35                 case XFER_PIO_2:        mode = 0x0200; break;
  36                 case XFER_PIO_1:        mode = 0x0100; break;
  37                 case XFER_PIO_0:
  38                 default:                mode = 0x0000; break;
  39         }
  40
  41         scr &= (speed < XFER_MW_DMA_0) ? 0xf8ff : 0xff0f;
  42         scr |= mode;
  43         outw(scr, scr_port);
  44
  45         return ide_config_drive_speed(drive, speed);
  46 }
  47
  48 static void tc86c001_tune_drive(ide_drive_t *drive, u8 pio)
  49 {
  50         pio =  ide_get_best_pio_mode(drive, pio, 4, NULL);
  51         (void) tc86c001_tune_chipset(drive, XFER_PIO_0 + pio);
  52 }
  53
  54 /*
  55  * HACKITY HACK
  56  *
  57  * This is a workaround for the limitation 5 of the TC86C001 IDE controller:
  58  * if a DMA transfer terminates prematurely, the controller leaves the device's
  59  * interrupt request (INTRQ) pending and does not generate a PCI interrupt (or
  60  * set the interrupt bit in the DMA status register), thus no PCI interrupt
  61  * will occur until a DMA transfer has been successfully completed.
  62  *
  63  * We work around this by initiating dummy, zero-length DMA transfer on
  64  * a DMA timeout expiration. I found no better way to do this with the current
  65  * IDE core than to temporarily replace a higher level driver's timer expiry
  66  * handler with our own backing up to that handler in case our recovery fails.
  67  */
  68 static int tc86c001_timer_expiry(ide_drive_t *drive)
  69 {
  70         ide_hwif_t *hwif        = HWIF(drive);
  71         ide_expiry_t *expiry    = ide_get_hwifdata(hwif);
  72         ide_hwgroup_t *hwgroup  = HWGROUP(drive);
  73         u8 dma_stat             = hwif->INB(hwif->dma_status);
  74
  75         /* Restore a higher level driver's expiry handler first. */
  76         hwgroup->expiry = expiry;
  77
  78         if ((dma_stat & 5) == 1) {      /* DMA active and no interrupt */
  79                 unsigned long sc_base   = hwif->config_data;
  80                 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
  81                 u8 dma_cmd              = hwif->INB(hwif->dma_command);
  82
  83                 printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
  84                        "attempting recovery...\n", drive->name);
  85
  86                 /* Stop DMA */
  87                 outb(dma_cmd & ~0x01, hwif->dma_command);
  88
  89                 /* Setup the dummy DMA transfer */
  90                 outw(0, sc_base + 0x0a);        /* Sector Count */
  91                 outw(0, twcr_port);     /* Transfer Word Count 1 or 2 */
  92
  93                 /* Start the dummy DMA transfer */
  94                 outb(0x00, hwif->dma_command); /* clear R_OR_WCTR for write */
  95                 outb(0x01, hwif->dma_command); /* set START_STOPBM */
  96
  97                 /*
  98                  * If an interrupt was pending, it should come thru shortly.
  99                  * If not, a higher level driver's expiry handler should
 100                  * eventually cause some kind of recovery from the DMA stall.
 101                  */
 102                 return WAIT_MIN_SLEEP;
 103         }
 104
 105         /* Chain to the restored expiry handler if DMA wasn't active. */
 106         if (likely(expiry != NULL))
 107                 return expiry(drive);
 108
 109         /* If there was no handler, "emulate" that for ide_timer_expiry()... */
 110         return -1;
 111 }
 112
 113 static void tc86c001_dma_start(ide_drive_t *drive)
 114 {
 115         ide_hwif_t *hwif        = HWIF(drive);
 116         ide_hwgroup_t *hwgroup  = HWGROUP(drive);
 117         unsigned long sc_base   = hwif->config_data;
 118         unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
 119         unsigned long nsectors  = hwgroup->rq->nr_sectors;
 120
 121         /*
 122          * We have to manually load the sector count and size into
 123          * the appropriate system control registers for DMA to work
 124          * with LBA48 and ATAPI devices...
 125          */
 126         outw(nsectors, sc_base + 0x0a); /* Sector Count */
 127         outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */
 128
 129         /* Install our timeout expiry hook, saving the current handler... */
 130         ide_set_hwifdata(hwif, hwgroup->expiry);
 131         hwgroup->expiry = &tc86c001_timer_expiry;
 132
 133         ide_dma_start(drive);
 134 }
 135
 136 static int tc86c001_busproc(ide_drive_t *drive, int state)
 137 {
 138         ide_hwif_t *hwif        = HWIF(drive);
 139         unsigned long sc_base   = hwif->config_data;
 140         u16 scr1;
 141
 142         /* System Control 1 Register bit 11 (ATA Hard Reset) read */
 143         scr1 = hwif->INW(sc_base + 0x00);
 144
 145         switch (state) {
 146                 case BUSSTATE_ON:
 147                         if (!(scr1 & 0x0800))
 148                                 return 0;
 149                         scr1 &= ~0x0800;
 150
 151                         hwif->drives[0].failures = hwif->drives[1].failures = 0;
 152                         break;
 153                 case BUSSTATE_OFF:
 154                         if (scr1 & 0x0800)
 155                                 return 0;
 156                         scr1 |= 0x0800;
 157
 158                         hwif->drives[0].failures = hwif->drives[0].max_failures + 1;
 159                         hwif->drives[1].failures = hwif->drives[1].max_failures + 1;
 160                         break;
 161                 default:
 162                         return -EINVAL;
 163         }
 164
 165         /* System Control 1 Register bit 11 (ATA Hard Reset) write */
 166         outw(scr1, sc_base + 0x00);
 167         return 0;
 168 }
 169
 170 static int config_chipset_for_dma(ide_drive_t *drive)
 171 {
 172         u8 speed = ide_max_dma_mode(drive);
 173
 174         if (!speed)
 175                 return 0;
 176
 177         (void) tc86c001_tune_chipset(drive, speed);
 178         return ide_dma_enable(drive);
 179 }
 180
 181 static int tc86c001_config_drive_xfer_rate(ide_drive_t *drive)
 182 {
 183         if (ide_use_dma(drive) && config_chipset_for_dma(drive))
 184                 return 0;
 185
 186         if (ide_use_fast_pio(drive))
 187                 tc86c001_tune_drive(drive, 255);
 188
 189         return -1;
 190 }
 191
 192 static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
 193 {
 194         unsigned long sc_base   = pci_resource_start(hwif->pci_dev, 5);
 195         u16 scr1                = hwif->INW(sc_base + 0x00);;
 196
 197         /* System Control 1 Register bit 15 (Soft Reset) set */
 198         outw(scr1 |  0x8000, sc_base + 0x00);
 199
 200         /* System Control 1 Register bit 14 (FIFO Reset) set */
 201         outw(scr1 |  0x4000, sc_base + 0x00);
 202
 203         /* System Control 1 Register: reset clear */
 204         outw(scr1 & ~0xc000, sc_base + 0x00);
 205
 206         /* Store the system control register base for convenience... */
 207         hwif->config_data = sc_base;
 208
 209         hwif->tuneproc  = &tc86c001_tune_drive;
 210         hwif->speedproc = &tc86c001_tune_chipset;
 211         hwif->busproc   = &tc86c001_busproc;
 212
 213         hwif->drives[0].autotune = hwif->drives[1].autotune = 1;
 214
 215         if (!hwif->dma_base)
 216                 return;
 217
 218         /*
 219          * Sector Count Control Register bits 0 and 1 set:
 220          * software sets Sector Count Register for master and slave device
 221          */
 222         outw(0x0003, sc_base + 0x0c);
 223
 224         /* Sector Count Register limit */
 225         hwif->rqsize     = 0xffff;
 226
 227         hwif->atapi_dma  = 1;
 228         hwif->ultra_mask = 0x1f;
 229         hwif->mwdma_mask = 0x07;
 230
 231         hwif->ide_dma_check     = &tc86c001_config_drive_xfer_rate;
 232         hwif->dma_start         = &tc86c001_dma_start;
 233
 234         if (!hwif->udma_four) {
 235                 /*
 236                  * System Control  1 Register bit 13 (PDIAGN):
 237                  * 0=80-pin cable, 1=40-pin cable
 238                  */
 239                 scr1 = hwif->INW(sc_base + 0x00);
 240                 hwif->udma_four = (scr1 & 0x2000) ? 0 : 1;
 241         }
 242
 243         if (!noautodma)
 244                 hwif->autodma = 1;
 245         hwif->drives[0].autodma = hwif->drives[1].autodma = hwif->autodma;
 246 }
 247
 248 static unsigned int __devinit init_chipset_tc86c001(struct pci_dev *dev,
 249                                                         const char *name)
 250 {
 251         int err = pci_request_region(dev, 5, name);
 252
 253         if (err)
 254                 printk(KERN_ERR "%s: system control regs already in use", name);
 255         return err;
 256 }
 257
 258 static ide_pci_device_t tc86c001_chipset __devinitdata = {
 259         .name           = "TC86C001",
 260         .init_chipset   = init_chipset_tc86c001,
 261         .init_hwif      = init_hwif_tc86c001,
 262         .channels       = 1,
 263         .autodma        = AUTODMA,
 264         .bootable       = OFF_BOARD
 265 };
 266
 267 static int __devinit tc86c001_init_one(struct pci_dev *dev,
 268                                        const struct pci_device_id *id)
 269 {
 270         return ide_setup_pci_device(dev, &tc86c001_chipset);
 271 }
 272
 273 static struct pci_device_id tc86c001_pci_tbl[] = {
 274         { PCI_VENDOR_ID_TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE,
 275           PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
 276         { 0, }
 277 };
 278 MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);
 279
 280 static struct pci_driver driver = {
 281         .name           = "TC86C001",
 282         .id_table       = tc86c001_pci_tbl,
 283         .probe          = tc86c001_init_one
 284 };
 285
 286 static int __init tc86c001_ide_init(void)
 287 {
 288         return ide_pci_register_driver(&driver);
 289 }
 290 module_init(tc86c001_ide_init);
 291
 292 MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
 293 MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
 294 MODULE_LICENSE("GPL");