drivers/ide/pci/sl82c105.c

   1 /*
   2  * linux/drivers/ide/pci/sl82c105.c
   3  *
   4  * SL82C105/Winbond 553 IDE driver
   5  *
   6  * Maintainer unknown.
   7  *
   8  * Drive tuning added from Rebel.com's kernel sources
   9  *  -- Russell King (15/11/98) linux@arm.linux.org.uk
  10  *
  11  * Merge in Russell's HW workarounds, fix various problems
  12  * with the timing registers setup.
  13  *  -- Benjamin Herrenschmidt (01/11/03) benh@kernel.crashing.org
  14  */
  15
  16 #include <linux/types.h>
  17 #include <linux/module.h>
  18 #include <linux/kernel.h>
  19 #include <linux/timer.h>
  20 #include <linux/mm.h>
  21 #include <linux/ioport.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/blkdev.h>
  24 #include <linux/hdreg.h>
  25 #include <linux/pci.h>
  26 #include <linux/ide.h>
  27
  28 #include <asm/io.h>
  29 #include <asm/dma.h>
  30
  31 #undef DEBUG
  32
  33 #ifdef DEBUG
  34 #define DBG(arg) printk arg
  35 #else
  36 #define DBG(fmt,...)
  37 #endif
  38 /*
  39  * SL82C105 PCI config register 0x40 bits.
  40  */
  41 #define CTRL_IDE_IRQB   (1 << 30)
  42 #define CTRL_IDE_IRQA   (1 << 28)
  43 #define CTRL_LEGIRQ     (1 << 11)
  44 #define CTRL_P1F16      (1 << 5)
  45 #define CTRL_P1EN       (1 << 4)
  46 #define CTRL_P0F16      (1 << 1)
  47 #define CTRL_P0EN       (1 << 0)
  48
  49 /*
  50  * Convert a PIO mode and cycle time to the required on/off
  51  * times for the interface.  This has protection against run-away
  52  * timings.
  53  */
  54 static unsigned int get_timing_sl82c105(ide_pio_data_t *p)
  55 {
  56         unsigned int cmd_on;
  57         unsigned int cmd_off;
  58
  59         cmd_on = (ide_pio_timings[p->pio_mode].active_time + 29) / 30;
  60         cmd_off = (p->cycle_time - 30 * cmd_on + 29) / 30;
  61
  62         if (cmd_on > 32)
  63                 cmd_on = 32;
  64         if (cmd_on == 0)
  65                 cmd_on = 1;
  66
  67         if (cmd_off > 32)
  68                 cmd_off = 32;
  69         if (cmd_off == 0)
  70                 cmd_off = 1;
  71
  72         return (cmd_on - 1) << 8 | (cmd_off - 1) | (p->use_iordy ? 0x40 : 0x00);
  73 }
  74
  75 /*
  76  * Configure the drive and chipset for PIO
  77  */
  78 static void config_for_pio(ide_drive_t *drive, int pio, int report, int chipset_only)
  79 {
  80         ide_hwif_t *hwif = HWIF(drive);
  81         struct pci_dev *dev = hwif->pci_dev;
  82         ide_pio_data_t p;
  83         u16 drv_ctrl = 0x909;
  84         unsigned int xfer_mode, reg;
  85
  86         DBG(("config_for_pio(drive:%s, pio:%d, report:%d, chipset_only:%d)\n",
  87                 drive->name, pio, report, chipset_only));
  88
  89         reg = (hwif->channel ? 0x4c : 0x44) + (drive->select.b.unit ? 4 : 0);
  90
  91         pio = ide_get_best_pio_mode(drive, pio, 5, &p);
  92
  93         xfer_mode = XFER_PIO_0 + pio;
  94
  95         if (chipset_only || ide_config_drive_speed(drive, xfer_mode) == 0) {
  96                 drv_ctrl = get_timing_sl82c105(&p);
  97                 drive->pio_speed = xfer_mode;
  98         } else
  99                 drive->pio_speed = XFER_PIO_0;
 100
 101         if (drive->using_dma == 0) {
 102                 /*
 103                  * If we are actually using MW DMA, then we can not
 104                  * reprogram the interface drive control register.
 105                  */
 106                 pci_write_config_word(dev, reg, drv_ctrl);
 107                 pci_read_config_word(dev, reg, &drv_ctrl);
 108
 109                 if (report) {
 110                         printk("%s: selected %s (%dns) (%04X)\n", drive->name,
 111                                ide_xfer_verbose(xfer_mode), p.cycle_time, drv_ctrl);
 112                 }
 113         }
 114 }
 115
 116 /*
 117  * Configure the drive and the chipset for DMA
 118  */
 119 static int config_for_dma (ide_drive_t *drive)
 120 {
 121         ide_hwif_t *hwif = HWIF(drive);
 122         struct pci_dev *dev = hwif->pci_dev;
 123         unsigned int reg;
 124
 125         DBG(("config_for_dma(drive:%s)\n", drive->name));
 126
 127         reg = (hwif->channel ? 0x4c : 0x44) + (drive->select.b.unit ? 4 : 0);
 128
 129         if (ide_config_drive_speed(drive, XFER_MW_DMA_2) != 0)
 130                 return 1;
 131
 132         pci_write_config_word(dev, reg, 0x0240);
 133
 134         return 0;
 135 }
 136
 137 /*
 138  * Check to see if the drive and
 139  * chipset is capable of DMA mode
 140  */
 141
 142 static int sl82c105_check_drive (ide_drive_t *drive)
 143 {
 144         ide_hwif_t *hwif        = HWIF(drive);
 145
 146         DBG(("sl82c105_check_drive(drive:%s)\n", drive->name));
 147
 148         do {
 149                 struct hd_driveid *id = drive->id;
 150
 151                 if (!drive->autodma)
 152                         break;
 153
 154                 if (!id || !(id->capability & 1))
 155                         break;
 156
 157                 /* Consult the list of known "bad" drives */
 158                 if (__ide_dma_bad_drive(drive))
 159                         break;
 160
 161                 if (id->field_valid & 2) {
 162                         if ((id->dma_mword & hwif->mwdma_mask) ||
 163                             (id->dma_1word & hwif->swdma_mask))
 164                                 return hwif->ide_dma_on(drive);
 165                 }
 166
 167                 if (__ide_dma_good_drive(drive))
 168                         return hwif->ide_dma_on(drive);
 169         } while (0);
 170
 171         return hwif->ide_dma_off_quietly(drive);
 172 }
 173
 174 /*
 175  * The SL82C105 holds off all IDE interrupts while in DMA mode until
 176  * all DMA activity is completed.  Sometimes this causes problems (eg,
 177  * when the drive wants to report an error condition).
 178  *
 179  * 0x7e is a "chip testing" register.  Bit 2 resets the DMA controller
 180  * state machine.  We need to kick this to work around various bugs.
 181  */
 182 static inline void sl82c105_reset_host(struct pci_dev *dev)
 183 {
 184         u16 val;
 185
 186         pci_read_config_word(dev, 0x7e, &val);
 187         pci_write_config_word(dev, 0x7e, val | (1 << 2));
 188         pci_write_config_word(dev, 0x7e, val & ~(1 << 2));
 189 }
 190
 191 /*
 192  * If we get an IRQ timeout, it might be that the DMA state machine
 193  * got confused.  Fix from Todd Inglett.  Details from Winbond.
 194  *
 195  * This function is called when the IDE timer expires, the drive
 196  * indicates that it is READY, and we were waiting for DMA to complete.
 197  */
 198 static int sl82c105_ide_dma_lost_irq(ide_drive_t *drive)
 199 {
 200         ide_hwif_t *hwif = HWIF(drive);
 201         struct pci_dev *dev = hwif->pci_dev;
 202         u32 val, mask = hwif->channel ? CTRL_IDE_IRQB : CTRL_IDE_IRQA;
 203         unsigned long dma_base = hwif->dma_base;
 204
 205         printk("sl82c105: lost IRQ: resetting host\n");
 206
 207         /*
 208          * Check the raw interrupt from the drive.
 209          */
 210         pci_read_config_dword(dev, 0x40, &val);
 211         if (val & mask)
 212                 printk("sl82c105: drive was requesting IRQ, but host lost it\n");
 213
 214         /*
 215          * Was DMA enabled?  If so, disable it - we're resetting the
 216          * host.  The IDE layer will be handling the drive for us.
 217          */
 218         val = hwif->INB(dma_base);
 219         if (val & 1) {
 220                 outb(val & ~1, dma_base);
 221                 printk("sl82c105: DMA was enabled\n");
 222         }
 223
 224         sl82c105_reset_host(dev);
 225
 226         /* ide_dmaproc would return 1, so we do as well */
 227         return 1;
 228 }
 229
 230 /*
 231  * ATAPI devices can cause the SL82C105 DMA state machine to go gaga.
 232  * Winbond recommend that the DMA state machine is reset prior to
 233  * setting the bus master DMA enable bit.
 234  *
 235  * The generic IDE core will have disabled the BMEN bit before this
 236  * function is called.
 237  */
 238 static void sl82c105_ide_dma_start(ide_drive_t *drive)
 239 {
 240         ide_hwif_t *hwif = HWIF(drive);
 241         struct pci_dev *dev = hwif->pci_dev;
 242
 243         sl82c105_reset_host(dev);
 244         ide_dma_start(drive);
 245 }
 246
 247 static int sl82c105_ide_dma_timeout(ide_drive_t *drive)
 248 {
 249         ide_hwif_t *hwif = HWIF(drive);
 250         struct pci_dev *dev = hwif->pci_dev;
 251
 252         DBG(("sl82c105_ide_dma_timeout(drive:%s)\n", drive->name));
 253
 254         sl82c105_reset_host(dev);
 255         return __ide_dma_timeout(drive);
 256 }
 257
 258 static int sl82c105_ide_dma_on (ide_drive_t *drive)
 259 {
 260         DBG(("sl82c105_ide_dma_on(drive:%s)\n", drive->name));
 261
 262         if (config_for_dma(drive)) {
 263                 config_for_pio(drive, 4, 0, 0);
 264                 return HWIF(drive)->ide_dma_off_quietly(drive);
 265         }
 266         printk(KERN_INFO "%s: DMA enabled\n", drive->name);
 267         return __ide_dma_on(drive);
 268 }
 269
 270 static int sl82c105_ide_dma_off_quietly (ide_drive_t *drive)
 271 {
 272         u8 speed = XFER_PIO_0;
 273         int rc;
 274
 275         DBG(("sl82c105_ide_dma_off_quietly(drive:%s)\n", drive->name));
 276
 277         rc = __ide_dma_off_quietly(drive);
 278         if (drive->pio_speed)
 279                 speed = drive->pio_speed - XFER_PIO_0;
 280         config_for_pio(drive, speed, 0, 1);
 281         drive->current_speed = drive->pio_speed;
 282
 283         return rc;
 284 }
 285
 286 /*
 287  * Ok, that is nasty, but we must make sure the DMA timings
 288  * won't be used for a PIO access. The solution here is
 289  * to make sure the 16 bits mode is diabled on the channel
 290  * when DMA is enabled, thus causing the chip to use PIO0
 291  * timings for those operations.
 292  */
 293 static void sl82c105_selectproc(ide_drive_t *drive)
 294 {
 295         ide_hwif_t *hwif = HWIF(drive);
 296         struct pci_dev *dev = hwif->pci_dev;
 297         u32 val, old, mask;
 298
 299         //DBG(("sl82c105_selectproc(drive:%s)\n", drive->name));
 300
 301         mask = hwif->channel ? CTRL_P1F16 : CTRL_P0F16;
 302         old = val = *((u32 *)&hwif->hwif_data);
 303         if (drive->using_dma)
 304                 val &= ~mask;
 305         else
 306                 val |= mask;
 307         if (old != val) {
 308                 pci_write_config_dword(dev, 0x40, val);
 309                 *((u32 *)&hwif->hwif_data) = val;
 310         }
 311 }
 312
 313 /*
 314  * ATA reset will clear the 16 bits mode in the control
 315  * register, we need to update our cache
 316  */
 317 static void sl82c105_resetproc(ide_drive_t *drive)
 318 {
 319         ide_hwif_t *hwif = HWIF(drive);
 320         struct pci_dev *dev = hwif->pci_dev;
 321         u32 val;
 322
 323         DBG(("sl82c105_resetproc(drive:%s)\n", drive->name));
 324
 325         pci_read_config_dword(dev, 0x40, &val);
 326         *((u32 *)&hwif->hwif_data) = val;
 327 }
 328
 329 /*
 330  * We only deal with PIO mode here - DMA mode 'using_dma' is not
 331  * initialised at the point that this function is called.
 332  */
 333 static void tune_sl82c105(ide_drive_t *drive, u8 pio)
 334 {
 335         DBG(("tune_sl82c105(drive:%s)\n", drive->name));
 336
 337         config_for_pio(drive, pio, 1, 0);
 338
 339         /*
 340          * We support 32-bit I/O on this interface, and it
 341          * doesn't have problems with interrupts.
 342          */
 343         drive->io_32bit = 1;
 344         drive->unmask = 1;
 345 }
 346
 347 /*
 348  * Return the revision of the Winbond bridge
 349  * which this function is part of.
 350  */
 351 static unsigned int sl82c105_bridge_revision(struct pci_dev *dev)
 352 {
 353         struct pci_dev *bridge;
 354         u8 rev;
 355
 356         /*
 357          * The bridge should be part of the same device, but function 0.
 358          */
 359         bridge = pci_find_slot(dev->bus->number,
 360                                PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
 361         if (!bridge)
 362                 return -1;
 363
 364         /*
 365          * Make sure it is a Winbond 553 and is an ISA bridge.
 366          */
 367         if (bridge->vendor != PCI_VENDOR_ID_WINBOND ||
 368             bridge->device != PCI_DEVICE_ID_WINBOND_83C553 ||
 369             bridge->class >> 8 != PCI_CLASS_BRIDGE_ISA)
 370                 return -1;
 371
 372         /*
 373          * We need to find function 0's revision, not function 1
 374          */
 375         pci_read_config_byte(bridge, PCI_REVISION_ID, &rev);
 376
 377         return rev;
 378 }
 379
 380 /*
 381  * Enable the PCI device
 382  *
 383  * --BenH: It's arch fixup code that should enable channels that
 384  * have not been enabled by firmware. I decided we can still enable
 385  * channel 0 here at least, but channel 1 has to be enabled by
 386  * firmware or arch code. We still set both to 16 bits mode.
 387  */
 388 static unsigned int __devinit init_chipset_sl82c105(struct pci_dev *dev, const char *msg)
 389 {
 390         u32 val;
 391
 392         DBG(("init_chipset_sl82c105()\n"));
 393
 394         pci_read_config_dword(dev, 0x40, &val);
 395         val |= CTRL_P0EN | CTRL_P0F16 | CTRL_P1F16;
 396         pci_write_config_dword(dev, 0x40, val);
 397
 398         return dev->irq;
 399 }
 400
 401 /*
 402  * Initialise the chip
 403  */
 404
 405 static void __devinit init_hwif_sl82c105(ide_hwif_t *hwif)
 406 {
 407         struct pci_dev *dev = hwif->pci_dev;
 408         unsigned int rev;
 409         u8 dma_state;
 410         u32 val;
 411
 412         DBG(("init_hwif_sl82c105(hwif: ide%d)\n", hwif->index));
 413
 414         hwif->tuneproc = tune_sl82c105;
 415         hwif->selectproc = sl82c105_selectproc;
 416         hwif->resetproc = sl82c105_resetproc;
 417
 418         /* Default to PIO 0 for fallback unless tuned otherwise,
 419          * we always autotune PIO, this is done before DMA is
 420          * checked, so there is no risk of accidentally disabling
 421          * DMA
 422           */
 423         hwif->drives[0].pio_speed = XFER_PIO_0;
 424         hwif->drives[0].autotune = 1;
 425         hwif->drives[1].pio_speed = XFER_PIO_1;
 426         hwif->drives[1].autotune = 1;
 427
 428         pci_read_config_dword(dev, 0x40, &val);
 429         *((u32 *)&hwif->hwif_data) = val;
 430
 431         hwif->atapi_dma = 0;
 432         hwif->mwdma_mask = 0;
 433         hwif->swdma_mask = 0;
 434         hwif->autodma = 0;
 435
 436         if (!hwif->dma_base)
 437                 return;
 438
 439         dma_state = hwif->INB(hwif->dma_base + 2) & ~0x60;
 440         rev = sl82c105_bridge_revision(hwif->pci_dev);
 441         if (rev <= 5) {
 442                 /*
 443                  * Never ever EVER under any circumstances enable
 444                  * DMA when the bridge is this old.
 445                  */
 446                 printk("    %s: Winbond 553 bridge revision %d, BM-DMA disabled\n",
 447                        hwif->name, rev);
 448         } else {
 449                 dma_state |= 0x60;
 450
 451                 hwif->atapi_dma = 1;
 452                 hwif->mwdma_mask = 0x07;
 453                 hwif->swdma_mask = 0x07;
 454
 455                 hwif->ide_dma_check = &sl82c105_check_drive;
 456                 hwif->ide_dma_on = &sl82c105_ide_dma_on;
 457                 hwif->ide_dma_off_quietly = &sl82c105_ide_dma_off_quietly;
 458                 hwif->ide_dma_lostirq = &sl82c105_ide_dma_lost_irq;
 459                 hwif->dma_start = &sl82c105_ide_dma_start;
 460                 hwif->ide_dma_timeout = &sl82c105_ide_dma_timeout;
 461
 462                 if (!noautodma)
 463                         hwif->autodma = 1;
 464                 hwif->drives[0].autodma = hwif->autodma;
 465                 hwif->drives[1].autodma = hwif->autodma;
 466
 467                 if (hwif->mate)
 468                         hwif->serialized = hwif->mate->serialized = 1;
 469         }
 470         hwif->OUTB(dma_state, hwif->dma_base + 2);
 471 }
 472
 473 static ide_pci_device_t sl82c105_chipset __devinitdata = {
 474         .name           = "W82C105",
 475         .init_chipset   = init_chipset_sl82c105,
 476         .init_hwif      = init_hwif_sl82c105,
 477         .channels       = 2,
 478         .autodma        = NOAUTODMA,
 479         .enablebits     = {{0x40,0x01,0x01}, {0x40,0x10,0x10}},
 480         .bootable       = ON_BOARD,
 481 };
 482
 483 static int __devinit sl82c105_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 484 {
 485         return ide_setup_pci_device(dev, &sl82c105_chipset);
 486 }
 487
 488 static struct pci_device_id sl82c105_pci_tbl[] = {
 489         { PCI_DEVICE(PCI_VENDOR_ID_WINBOND, PCI_DEVICE_ID_WINBOND_82C105), 0},
 490         { 0, },
 491 };
 492 MODULE_DEVICE_TABLE(pci, sl82c105_pci_tbl);
 493
 494 static struct pci_driver driver = {
 495         .name           = "W82C105_IDE",
 496         .id_table       = sl82c105_pci_tbl,
 497         .probe          = sl82c105_init_one,
 498 };
 499
 500 static int sl82c105_ide_init(void)
 501 {
 502         return ide_pci_register_driver(&driver);
 503 }
 504
 505 module_init(sl82c105_ide_init);
 506
 507 MODULE_DESCRIPTION("PCI driver module for W82C105 IDE");
 508 MODULE_LICENSE("GPL");