drivers/ide/ns87415.c

   1 /*
   2  * Copyright (C) 1997-1998      Mark Lord <mlord@pobox.com>
   3  * Copyright (C) 1998           Eddie C. Dost <ecd@skynet.be>
   4  * Copyright (C) 1999-2000      Andre Hedrick <andre@linux-ide.org>
   5  * Copyright (C) 2004           Grant Grundler <grundler at parisc-linux.org>
   6  *
   7  * Inspired by an earlier effort from David S. Miller <davem@redhat.com>
   8  */
   9
  10 #include <linux/module.h>
  11 #include <linux/types.h>
  12 #include <linux/kernel.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/pci.h>
  15 #include <linux/delay.h>
  16 #include <linux/ide.h>
  17 #include <linux/init.h>
  18
  19 #include <asm/io.h>
  20
  21 #define DRV_NAME "ns87415"
  22
  23 #ifdef CONFIG_SUPERIO
  24 /* SUPERIO 87560 is a PoS chip that NatSem denies exists.
  25  * Unfortunately, it's built-in on all Astro-based PA-RISC workstations
  26  * which use the integrated NS87514 cell for CD-ROM support.
  27  * i.e we have to support for CD-ROM installs.
  28  * See drivers/parisc/superio.c for more gory details.
  29  */
  30 #include <asm/superio.h>
  31
  32 #define SUPERIO_IDE_MAX_RETRIES 25
  33
  34 /* Because of a defect in Super I/O, all reads of the PCI DMA status
  35  * registers, IDE status register and the IDE select register need to be
  36  * retried
  37  */
  38 static u8 superio_ide_inb (unsigned long port)
  39 {
  40         u8 tmp;
  41         int retries = SUPERIO_IDE_MAX_RETRIES;
  42
  43         /* printk(" [ reading port 0x%x with retry ] ", port); */
  44
  45         do {
  46                 tmp = inb(port);
  47                 if (tmp == 0)
  48                         udelay(50);
  49         } while (tmp == 0 && retries-- > 0);
  50
  51         return tmp;
  52 }
  53
  54 static u8 superio_read_status(ide_hwif_t *hwif)
  55 {
  56         return superio_ide_inb(hwif->io_ports.status_addr);
  57 }
  58
  59 static u8 superio_dma_sff_read_status(ide_hwif_t *hwif)
  60 {
  61         return superio_ide_inb(hwif->dma_base + ATA_DMA_STATUS);
  62 }
  63
  64 static void superio_tf_read(ide_drive_t *drive, struct ide_cmd *cmd)
  65 {
  66         struct ide_io_ports *io_ports = &drive->hwif->io_ports;
  67         struct ide_taskfile *tf = &cmd->tf;
  68         u8 valid = cmd->valid.in.tf;
  69
  70         /* be sure we're looking at the low order bits */
  71         outb(ATA_DEVCTL_OBS, io_ports->ctl_addr);
  72
  73         if (valid & IDE_VALID_ERROR)
  74                 tf->error  = inb(io_ports->feature_addr);
  75         if (valid & IDE_VALID_NSECT)
  76                 tf->nsect  = inb(io_ports->nsect_addr);
  77         if (valid & IDE_VALID_LBAL)
  78                 tf->lbal   = inb(io_ports->lbal_addr);
  79         if (valid & IDE_VALID_LBAM)
  80                 tf->lbam   = inb(io_ports->lbam_addr);
  81         if (valid & IDE_VALID_LBAH)
  82                 tf->lbah   = inb(io_ports->lbah_addr);
  83         if (valid & IDE_VALID_DEVICE)
  84                 tf->device = superio_ide_inb(io_ports->device_addr);
  85
  86         if (cmd->tf_flags & IDE_TFLAG_LBA48) {
  87                 outb(ATA_HOB | ATA_DEVCTL_OBS, io_ports->ctl_addr);
  88
  89                 valid = cmd->valid.in.hob;
  90
  91                 if (valid & IDE_VALID_ERROR)
  92                         tf->hob_error = inb(io_ports->feature_addr);
  93                 if (valid & IDE_VALID_NSECT)
  94                         tf->hob_nsect = inb(io_ports->nsect_addr);
  95                 if (valid & IDE_VALID_LBAL)
  96                         tf->hob_lbal  = inb(io_ports->lbal_addr);
  97                 if (valid & IDE_VALID_LBAM)
  98                         tf->hob_lbam  = inb(io_ports->lbam_addr);
  99                 if (valid & IDE_VALID_LBAH)
 100                         tf->hob_lbah  = inb(io_ports->lbah_addr);
 101         }
 102 }
 103
 104 static void ns87415_dev_select(ide_drive_t *drive);
 105
 106 static const struct ide_tp_ops superio_tp_ops = {
 107         .exec_command           = ide_exec_command,
 108         .read_status            = superio_read_status,
 109         .read_altstatus         = ide_read_altstatus,
 110         .write_devctl           = ide_write_devctl,
 111
 112         .dev_select             = ns87415_dev_select,
 113         .tf_load                = ide_tf_load,
 114         .tf_read                = superio_tf_read,
 115
 116         .input_data             = ide_input_data,
 117         .output_data            = ide_output_data,
 118 };
 119
 120 static void __devinit superio_init_iops(struct hwif_s *hwif)
 121 {
 122         struct pci_dev *pdev = to_pci_dev(hwif->dev);
 123         u32 dma_stat;
 124         u8 port = hwif->channel, tmp;
 125
 126         dma_stat = (pci_resource_start(pdev, 4) & ~3) + (!port ? 2 : 0xa);
 127
 128         /* Clear error/interrupt, enable dma */
 129         tmp = superio_ide_inb(dma_stat);
 130         outb(tmp | 0x66, dma_stat);
 131 }
 132 #else
 133 #define superio_dma_sff_read_status ide_dma_sff_read_status
 134 #endif
 135
 136 static unsigned int ns87415_count = 0, ns87415_control[MAX_HWIFS] = { 0 };
 137
 138 /*
 139  * This routine either enables/disables (according to IDE_DFLAG_PRESENT)
 140  * the IRQ associated with the port,
 141  * and selects either PIO or DMA handshaking for the next I/O operation.
 142  */
 143 static void ns87415_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
 144 {
 145         ide_hwif_t *hwif = drive->hwif;
 146         struct pci_dev *dev = to_pci_dev(hwif->dev);
 147         unsigned int bit, other, new, *old = (unsigned int *) hwif->select_data;
 148         unsigned long flags;
 149
 150         local_irq_save(flags);
 151         new = *old;
 152
 153         /* Adjust IRQ enable bit */
 154         bit = 1 << (8 + hwif->channel);
 155
 156         if (drive->dev_flags & IDE_DFLAG_PRESENT)
 157                 new &= ~bit;
 158         else
 159                 new |= bit;
 160
 161         /* Select PIO or DMA, DMA may only be selected for one drive/channel. */
 162         bit   = 1 << (20 + (drive->dn & 1) + (hwif->channel << 1));
 163         other = 1 << (20 + (1 - (drive->dn & 1)) + (hwif->channel << 1));
 164         new = use_dma ? ((new & ~other) | bit) : (new & ~bit);
 165
 166         if (new != *old) {
 167                 unsigned char stat;
 168
 169                 /*
 170                  * Don't change DMA engine settings while Write Buffers
 171                  * are busy.
 172                  */
 173                 (void) pci_read_config_byte(dev, 0x43, &stat);
 174                 while (stat & 0x03) {
 175                         udelay(1);
 176                         (void) pci_read_config_byte(dev, 0x43, &stat);
 177                 }
 178
 179                 *old = new;
 180                 (void) pci_write_config_dword(dev, 0x40, new);
 181
 182                 /*
 183                  * And let things settle...
 184                  */
 185                 udelay(10);
 186         }
 187
 188         local_irq_restore(flags);
 189 }
 190
 191 static void ns87415_dev_select(ide_drive_t *drive)
 192 {
 193         ns87415_prepare_drive(drive,
 194                               !!(drive->dev_flags & IDE_DFLAG_USING_DMA));
 195
 196         outb(drive->select | ATA_DEVICE_OBS, drive->hwif->io_ports.device_addr);
 197 }
 198
 199 static void ns87415_dma_start(ide_drive_t *drive)
 200 {
 201         ns87415_prepare_drive(drive, 1);
 202         ide_dma_start(drive);
 203 }
 204
 205 static int ns87415_dma_end(ide_drive_t *drive)
 206 {
 207         ide_hwif_t *hwif = drive->hwif;
 208         u8 dma_stat = 0, dma_cmd = 0;
 209
 210         dma_stat = hwif->dma_ops->dma_sff_read_status(hwif);
 211         /* get DMA command mode */
 212         dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
 213         /* stop DMA */
 214         outb(dma_cmd & ~1, hwif->dma_base + ATA_DMA_CMD);
 215         /* from ERRATA: clear the INTR & ERROR bits */
 216         dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
 217         outb(dma_cmd | 6, hwif->dma_base + ATA_DMA_CMD);
 218
 219         ns87415_prepare_drive(drive, 0);
 220
 221         /* verify good DMA status */
 222         return (dma_stat & 7) != 4;
 223 }
 224
 225 static void __devinit init_hwif_ns87415 (ide_hwif_t *hwif)
 226 {
 227         struct pci_dev *dev = to_pci_dev(hwif->dev);
 228         unsigned int ctrl, using_inta;
 229         u8 progif;
 230 #ifdef __sparc_v9__
 231         int timeout;
 232         u8 stat;
 233 #endif
 234
 235         /*
 236          * We cannot probe for IRQ: both ports share common IRQ on INTA.
 237          * Also, leave IRQ masked during drive probing, to prevent infinite
 238          * interrupts from a potentially floating INTA..
 239          *
 240          * IRQs get unmasked in dev_select() when drive is first used.
 241          */
 242         (void) pci_read_config_dword(dev, 0x40, &ctrl);
 243         (void) pci_read_config_byte(dev, 0x09, &progif);
 244         /* is irq in "native" mode? */
 245         using_inta = progif & (1 << (hwif->channel << 1));
 246         if (!using_inta)
 247                 using_inta = ctrl & (1 << (4 + hwif->channel));
 248         if (hwif->mate) {
 249                 hwif->select_data = hwif->mate->select_data;
 250         } else {
 251                 hwif->select_data = (unsigned long)
 252                                         &ns87415_control[ns87415_count++];
 253                 ctrl |= (1 << 8) | (1 << 9);    /* mask both IRQs */
 254                 if (using_inta)
 255                         ctrl &= ~(1 << 6);      /* unmask INTA */
 256                 *((unsigned int *)hwif->select_data) = ctrl;
 257                 (void) pci_write_config_dword(dev, 0x40, ctrl);
 258
 259                 /*
 260                  * Set prefetch size to 512 bytes for both ports,
 261                  * but don't turn on/off prefetching here.
 262                  */
 263                 pci_write_config_byte(dev, 0x55, 0xee);
 264
 265 #ifdef __sparc_v9__
 266                 /*
 267                  * XXX: Reset the device, if we don't it will not respond to
 268                  *      dev_select() properly during first ide_probe_port().
 269                  */
 270                 timeout = 10000;
 271                 outb(12, hwif->io_ports.ctl_addr);
 272                 udelay(10);
 273                 outb(8, hwif->io_ports.ctl_addr);
 274                 do {
 275                         udelay(50);
 276                         stat = hwif->tp_ops->read_status(hwif);
 277                         if (stat == 0xff)
 278                                 break;
 279                 } while ((stat & ATA_BUSY) && --timeout);
 280 #endif
 281         }
 282
 283         if (!using_inta)
 284                 hwif->irq = pci_get_legacy_ide_irq(dev, hwif->channel);
 285
 286         if (!hwif->dma_base)
 287                 return;
 288
 289         outb(0x60, hwif->dma_base + ATA_DMA_STATUS);
 290 }
 291
 292 static const struct ide_tp_ops ns87415_tp_ops = {
 293         .exec_command           = ide_exec_command,
 294         .read_status            = ide_read_status,
 295         .read_altstatus         = ide_read_altstatus,
 296         .write_devctl           = ide_write_devctl,
 297
 298         .dev_select             = ns87415_dev_select,
 299         .tf_load                = ide_tf_load,
 300         .tf_read                = ide_tf_read,
 301
 302         .input_data             = ide_input_data,
 303         .output_data            = ide_output_data,
 304 };
 305
 306 static const struct ide_dma_ops ns87415_dma_ops = {
 307         .dma_host_set           = ide_dma_host_set,
 308         .dma_setup              = ide_dma_setup,
 309         .dma_start              = ns87415_dma_start,
 310         .dma_end                = ns87415_dma_end,
 311         .dma_test_irq           = ide_dma_test_irq,
 312         .dma_lost_irq           = ide_dma_lost_irq,
 313         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
 314         .dma_sff_read_status    = superio_dma_sff_read_status,
 315 };
 316
 317 static const struct ide_port_info ns87415_chipset __devinitdata = {
 318         .name           = DRV_NAME,
 319         .init_hwif      = init_hwif_ns87415,
 320         .tp_ops         = &ns87415_tp_ops,
 321         .dma_ops        = &ns87415_dma_ops,
 322         .host_flags     = IDE_HFLAG_TRUST_BIOS_FOR_DMA |
 323                           IDE_HFLAG_NO_ATAPI_DMA,
 324 };
 325
 326 static int __devinit ns87415_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 327 {
 328         struct ide_port_info d = ns87415_chipset;
 329
 330 #ifdef CONFIG_SUPERIO
 331         if (PCI_SLOT(dev->devfn) == 0xE) {
 332                 /* Built-in - assume it's under superio. */
 333                 d.init_iops = superio_init_iops;
 334                 d.tp_ops = &superio_tp_ops;
 335         }
 336 #endif
 337         return ide_pci_init_one(dev, &d, NULL);
 338 }
 339
 340 static const struct pci_device_id ns87415_pci_tbl[] = {
 341         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), 0 },
 342         { 0, },
 343 };
 344 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
 345
 346 static struct pci_driver ns87415_pci_driver = {
 347         .name           = "NS87415_IDE",
 348         .id_table       = ns87415_pci_tbl,
 349         .probe          = ns87415_init_one,
 350         .remove         = ide_pci_remove,
 351         .suspend        = ide_pci_suspend,
 352         .resume         = ide_pci_resume,
 353 };
 354
 355 static int __init ns87415_ide_init(void)
 356 {
 357         return ide_pci_register_driver(&ns87415_pci_driver);
 358 }
 359
 360 static void __exit ns87415_ide_exit(void)
 361 {
 362         pci_unregister_driver(&ns87415_pci_driver);
 363 }
 364
 365 module_init(ns87415_ide_init);
 366 module_exit(ns87415_ide_exit);
 367
 368 MODULE_AUTHOR("Mark Lord, Eddie Dost, Andre Hedrick");
 369 MODULE_DESCRIPTION("PCI driver module for NS87415 IDE");
 370 MODULE_LICENSE("GPL");