drivers/ide/pci/trm290.c

   1 /*
   2  *  linux/drivers/ide/pci/trm290.c              Version 1.02    Mar. 18, 2000
   3  *
   4  *  Copyright (c) 1997-1998  Mark Lord
   5  *  May be copied or modified under the terms of the GNU General Public License
   6  */
   7
   8 /*
   9  * This module provides support for the bus-master IDE DMA function
  10  * of the Tekram TRM290 chip, used on a variety of PCI IDE add-on boards,
  11  * including a "Precision Instruments" board.  The TRM290 pre-dates
  12  * the sff-8038 standard (ide-dma.c) by a few months, and differs
  13  * significantly enough to warrant separate routines for some functions,
  14  * while re-using others from ide-dma.c.
  15  *
  16  * EXPERIMENTAL!  It works for me (a sample of one).
  17  *
  18  * Works reliably for me in DMA mode (READs only),
  19  * DMA WRITEs are disabled by default (see #define below);
  20  *
  21  * DMA is not enabled automatically for this chipset,
  22  * but can be turned on manually (with "hdparm -d1") at run time.
  23  *
  24  * I need volunteers with "spare" drives for further testing
  25  * and development, and maybe to help figure out the peculiarities.
  26  * Even knowing the registers (below), some things behave strangely.
  27  */
  28
  29 #define TRM290_NO_DMA_WRITES    /* DMA writes seem unreliable sometimes */
  30
  31 /*
  32  * TRM-290 PCI-IDE2 Bus Master Chip
  33  * ================================
  34  * The configuration registers are addressed in normal I/O port space
  35  * and are used as follows:
  36  *
  37  * trm290_base depends on jumper settings, and is probed for by ide-dma.c
  38  *
  39  * trm290_base+2 when WRITTEN: chiptest register (byte, write-only)
  40  *      bit7 must always be written as "1"
  41  *      bits6-2 undefined
  42  *      bit1 1=legacy_compatible_mode, 0=native_pci_mode
  43  *      bit0 1=test_mode, 0=normal(default)
  44  *
  45  * trm290_base+2 when READ: status register (byte, read-only)
  46  *      bits7-2 undefined
  47  *      bit1 channel0 busmaster interrupt status 0=none, 1=asserted
  48  *      bit0 channel0 interrupt status 0=none, 1=asserted
  49  *
  50  * trm290_base+3 Interrupt mask register
  51  *      bits7-5 undefined
  52  *      bit4 legacy_header: 1=present, 0=absent
  53  *      bit3 channel1 busmaster interrupt status 0=none, 1=asserted (read only)
  54  *      bit2 channel1 interrupt status 0=none, 1=asserted (read only)
  55  *      bit1 channel1 interrupt mask: 1=masked, 0=unmasked(default)
  56  *      bit0 channel0 interrupt mask: 1=masked, 0=unmasked(default)
  57  *
  58  * trm290_base+1 "CPR" Config Pointer Register (byte)
  59  *      bit7 1=autoincrement CPR bits 2-0 after each access of CDR
  60  *      bit6 1=min. 1 wait-state posted write cycle (default), 0=0 wait-state
  61  *      bit5 0=enabled master burst access (default), 1=disable  (write only)
  62  *      bit4 PCI DEVSEL# timing select: 1=medium(default), 0=fast
  63  *      bit3 0=primary IDE channel, 1=secondary IDE channel
  64  *      bits2-0 register index for accesses through CDR port
  65  *
  66  * trm290_base+0 "CDR" Config Data Register (word)
  67  *      two sets of seven config registers,
  68  *      selected by CPR bit 3 (channel) and CPR bits 2-0 (index 0 to 6),
  69  *      each index defined below:
  70  *
  71  * Index-0 Base address register for command block (word)
  72  *      defaults: 0x1f0 for primary, 0x170 for secondary
  73  *
  74  * Index-1 general config register (byte)
  75  *      bit7 1=DMA enable, 0=DMA disable
  76  *      bit6 1=activate IDE_RESET, 0=no action (default)
  77  *      bit5 1=enable IORDY, 0=disable IORDY (default)
  78  *      bit4 0=16-bit data port(default), 1=8-bit (XT) data port
  79  *      bit3 interrupt polarity: 1=active_low, 0=active_high(default)
  80  *      bit2 power-saving-mode(?): 1=enable, 0=disable(default) (write only)
  81  *      bit1 bus_master_mode(?): 1=enable, 0=disable(default)
  82  *      bit0 enable_io_ports: 1=enable(default), 0=disable
  83  *
  84  * Index-2 read-ahead counter preload bits 0-7 (byte, write only)
  85  *      bits7-0 bits7-0 of readahead count
  86  *
  87  * Index-3 read-ahead config register (byte, write only)
  88  *      bit7 1=enable_readahead, 0=disable_readahead(default)
  89  *      bit6 1=clear_FIFO, 0=no_action
  90  *      bit5 undefined
  91  *      bit4 mode4 timing control: 1=enable, 0=disable(default)
  92  *      bit3 undefined
  93  *      bit2 undefined
  94  *      bits1-0 bits9-8 of read-ahead count
  95  *
  96  * Index-4 base address register for control block (word)
  97  *      defaults: 0x3f6 for primary, 0x376 for secondary
  98  *
  99  * Index-5 data port timings (shared by both drives) (byte)
 100  *      standard PCI "clk" (clock) counts, default value = 0xf5
 101  *
 102  *      bits7-6 setup time:  00=1clk, 01=2clk, 10=3clk, 11=4clk
 103  *      bits5-3 hold time:      000=1clk, 001=2clk, 010=3clk,
 104  *                              011=4clk, 100=5clk, 101=6clk,
 105  *                              110=8clk, 111=12clk
 106  *      bits2-0 active time:    000=2clk, 001=3clk, 010=4clk,
 107  *                              011=5clk, 100=6clk, 101=8clk,
 108  *                              110=12clk, 111=16clk
 109  *
 110  * Index-6 command/control port timings (shared by both drives) (byte)
 111  *      same layout as Index-5, default value = 0xde
 112  *
 113  * Suggested CDR programming for PIO mode0 (600ns):
 114  *      0x01f0,0x21,0xff,0x80,0x03f6,0xf5,0xde  ; primary
 115  *      0x0170,0x21,0xff,0x80,0x0376,0xf5,0xde  ; secondary
 116  *
 117  * Suggested CDR programming for PIO mode3 (180ns):
 118  *      0x01f0,0x21,0xff,0x80,0x03f6,0x09,0xde  ; primary
 119  *      0x0170,0x21,0xff,0x80,0x0376,0x09,0xde  ; secondary
 120  *
 121  * Suggested CDR programming for PIO mode4 (120ns):
 122  *      0x01f0,0x21,0xff,0x80,0x03f6,0x00,0xde  ; primary
 123  *      0x0170,0x21,0xff,0x80,0x0376,0x00,0xde  ; secondary
 124  *
 125  */
 126
 127 #include <linux/config.h>
 128 #include <linux/types.h>
 129 #include <linux/module.h>
 130 #include <linux/kernel.h>
 131 #include <linux/mm.h>
 132 #include <linux/ioport.h>
 133 #include <linux/interrupt.h>
 134 #include <linux/blkdev.h>
 135 #include <linux/init.h>
 136 #include <linux/hdreg.h>
 137 #include <linux/pci.h>
 138 #include <linux/delay.h>
 139 #include <linux/ide.h>
 140
 141 #include <asm/io.h>
 142
 143 static void trm290_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
 144 {
 145         ide_hwif_t *hwif = HWIF(drive);
 146         u16 reg = 0;
 147         unsigned long flags;
 148
 149         /* select PIO or DMA */
 150         reg = use_dma ? (0x21 | 0x82) : (0x21 & ~0x82);
 151
 152         local_irq_save(flags);
 153
 154         if (reg != hwif->select_data) {
 155                 hwif->select_data = reg;
 156                 /* set PIO/DMA */
 157                 hwif->OUTB(0x51|(hwif->channel<<3), hwif->config_data+1);
 158                 hwif->OUTW(reg & 0xff, hwif->config_data);
 159         }
 160
 161         /* enable IRQ if not probing */
 162         if (drive->present) {
 163                 reg = hwif->INW(hwif->config_data + 3);
 164                 reg &= 0x13;
 165                 reg &= ~(1 << hwif->channel);
 166                 hwif->OUTW(reg, hwif->config_data+3);
 167         }
 168
 169         local_irq_restore(flags);
 170 }
 171
 172 static void trm290_selectproc (ide_drive_t *drive)
 173 {
 174         trm290_prepare_drive(drive, drive->using_dma);
 175 }
 176
 177 #ifdef CONFIG_BLK_DEV_IDEDMA
 178 static int trm290_ide_dma_write (ide_drive_t *drive /*, struct request *rq */)
 179 {
 180         ide_hwif_t *hwif        = HWIF(drive);
 181         struct request *rq      = HWGROUP(drive)->rq;
 182 //      ide_task_t *args        = rq->special;
 183         task_ioreg_t command    = WIN_NOP;
 184         unsigned int count, reading = 2, writing = 0;
 185
 186         reading = 0;
 187         writing = 1;
 188 #ifdef TRM290_NO_DMA_WRITES
 189         /* always use PIO for writes */
 190         trm290_prepare_drive(drive, 0); /* select PIO xfer */
 191         return 1;
 192 #endif
 193         if (!(count = ide_build_dmatable(drive, rq))) {
 194                 /* try PIO instead of DMA */
 195                 trm290_prepare_drive(drive, 0); /* select PIO xfer */
 196                 return 1;
 197         }
 198         /* select DMA xfer */
 199         trm290_prepare_drive(drive, 1);
 200         hwif->OUTL(hwif->dmatable_dma|reading|writing, hwif->dma_command);
 201         drive->waiting_for_dma = 1;
 202         /* start DMA */
 203         hwif->OUTW((count * 2) - 1, hwif->dma_status);
 204         if (drive->media != ide_disk)
 205                 return 0;
 206         if (HWGROUP(drive)->handler != NULL)    /* paranoia check */
 207                 BUG();
 208         ide_set_handler(drive, &ide_dma_intr, WAIT_CMD, NULL);
 209         /*
 210          * FIX ME to use only ACB ide_task_t args Struct
 211          */
 212 #if 0
 213         {
 214                 ide_task_t *args = rq->special;
 215                 command = args->tfRegister[IDE_COMMAND_OFFSET];
 216         }
 217 #else
 218         command = /* (lba48) ? WIN_READDMA_EXT : */ WIN_READDMA;
 219         if (rq->flags & REQ_DRIVE_TASKFILE) {
 220                 ide_task_t *args = rq->special;
 221                 command = args->tfRegister[IDE_COMMAND_OFFSET];
 222         }
 223 #endif
 224         /* issue cmd to drive */
 225         hwif->OUTB(command, IDE_COMMAND_REG);
 226         return hwif->ide_dma_begin(drive);
 227 }
 228
 229 static int trm290_ide_dma_read (ide_drive_t *drive  /*, struct request *rq */)
 230 {
 231         ide_hwif_t *hwif        = HWIF(drive);
 232         struct request *rq      = HWGROUP(drive)->rq;
 233 //      ide_task_t *args        = rq->special;
 234         task_ioreg_t command    = WIN_NOP;
 235         unsigned int count, reading = 2, writing = 0;
 236
 237         if (!(count = ide_build_dmatable(drive, rq))) {
 238                 /* try PIO instead of DMA */
 239                 trm290_prepare_drive(drive, 0); /* select PIO xfer */
 240                 return 1;
 241         }
 242         /* select DMA xfer */
 243         trm290_prepare_drive(drive, 1);
 244         hwif->OUTL(hwif->dmatable_dma|reading|writing, hwif->dma_command);
 245         drive->waiting_for_dma = 1;
 246         /* start DMA */
 247         hwif->OUTW((count * 2) - 1, hwif->dma_status);
 248         if (drive->media != ide_disk)
 249                 return 0;
 250         if (HWGROUP(drive)->handler != NULL)    /* paranoia check */
 251                 BUG();
 252         ide_set_handler(drive, &ide_dma_intr, WAIT_CMD, NULL);
 253         /*
 254          * FIX ME to use only ACB ide_task_t args Struct
 255          */
 256 #if 0
 257         {
 258                 ide_task_t *args = rq->special;
 259                 command = args->tfRegister[IDE_COMMAND_OFFSET];
 260         }
 261 #else
 262         command = /* (lba48) ? WIN_WRITEDMA_EXT : */ WIN_WRITEDMA;
 263         if (rq->flags & REQ_DRIVE_TASKFILE) {
 264                 ide_task_t *args = rq->special;
 265                 command = args->tfRegister[IDE_COMMAND_OFFSET];
 266         }
 267 #endif
 268         /* issue cmd to drive */
 269         hwif->OUTB(command, IDE_COMMAND_REG);
 270         return hwif->ide_dma_begin(drive);
 271 }
 272
 273 static int trm290_ide_dma_begin (ide_drive_t *drive)
 274 {
 275         return 0;
 276 }
 277
 278 static int trm290_ide_dma_end (ide_drive_t *drive)
 279 {
 280         ide_hwif_t *hwif = HWIF(drive);
 281         u16 status = 0;
 282
 283         drive->waiting_for_dma = 0;
 284         /* purge DMA mappings */
 285         ide_destroy_dmatable(drive);
 286         status = hwif->INW(hwif->dma_status);
 287         return (status != 0x00ff);
 288 }
 289
 290 static int trm290_ide_dma_test_irq (ide_drive_t *drive)
 291 {
 292         ide_hwif_t *hwif = HWIF(drive);
 293         u16 status = 0;
 294
 295         status = hwif->INW(hwif->dma_status);
 296         return (status == 0x00ff);
 297 }
 298 #endif /* CONFIG_BLK_DEV_IDEDMA */
 299
 300 /*
 301  * Invoked from ide-dma.c at boot time.
 302  */
 303 void __devinit init_hwif_trm290(ide_hwif_t *hwif)
 304 {
 305         unsigned int cfgbase = 0;
 306         unsigned long flags;
 307         u8 reg = 0;
 308         struct pci_dev *dev = hwif->pci_dev;
 309
 310         hwif->no_lba48 = 1;
 311         hwif->chipset = ide_trm290;
 312         cfgbase = pci_resource_start(dev, 4);
 313         if ((dev->class & 5) && cfgbase) {
 314                 hwif->config_data = cfgbase;
 315                 printk(KERN_INFO "TRM290: chip config base at 0x%04lx\n",
 316                         hwif->config_data);
 317         } else {
 318                 hwif->config_data = 0x3df0;
 319                 printk(KERN_INFO "TRM290: using default config base at 0x%04lx\n",
 320                         hwif->config_data);
 321         }
 322
 323         local_irq_save(flags);
 324         /* put config reg into first byte of hwif->select_data */
 325         hwif->OUTB(0x51|(hwif->channel<<3), hwif->config_data+1);
 326         /* select PIO as default */
 327         hwif->select_data = 0x21;
 328         hwif->OUTB(hwif->select_data, hwif->config_data);
 329         /* get IRQ info */
 330         reg = hwif->INB(hwif->config_data+3);
 331         /* mask IRQs for both ports */
 332         reg = (reg & 0x10) | 0x03;
 333         hwif->OUTB(reg, hwif->config_data+3);
 334         local_irq_restore(flags);
 335
 336         if ((reg & 0x10))
 337                 /* legacy mode */
 338                 hwif->irq = hwif->channel ? 15 : 14;
 339         else if (!hwif->irq && hwif->mate && hwif->mate->irq)
 340                 /* sharing IRQ with mate */
 341                 hwif->irq = hwif->mate->irq;
 342
 343         ide_setup_dma(hwif, (hwif->config_data + 4) ^ (hwif->channel ? 0x0080 : 0x0000), 3);
 344
 345 #ifdef CONFIG_BLK_DEV_IDEDMA
 346         hwif->ide_dma_write = &trm290_ide_dma_write;
 347         hwif->ide_dma_read = &trm290_ide_dma_read;
 348         hwif->ide_dma_begin = &trm290_ide_dma_begin;
 349         hwif->ide_dma_end = &trm290_ide_dma_end;
 350         hwif->ide_dma_test_irq = &trm290_ide_dma_test_irq;
 351 #endif /* CONFIG_BLK_DEV_IDEDMA */
 352
 353         hwif->selectproc = &trm290_selectproc;
 354         hwif->autodma = 0;              /* play it safe for now */
 355         hwif->drives[0].autodma = hwif->autodma;
 356         hwif->drives[1].autodma = hwif->autodma;
 357 #if 1
 358         {
 359         /*
 360          * My trm290-based card doesn't seem to work with all possible values
 361          * for the control basereg, so this kludge ensures that we use only
 362          * values that are known to work.  Ugh.         -ml
 363          */
 364                 u16 new, old, compat = hwif->channel ? 0x374 : 0x3f4;
 365                 static u16 next_offset = 0;
 366                 u8 old_mask;
 367
 368                 hwif->OUTB(0x54|(hwif->channel<<3), hwif->config_data+1);
 369                 old = hwif->INW(hwif->config_data);
 370                 old &= ~1;
 371                 old_mask = hwif->INB(old+2);
 372                 if (old != compat && old_mask == 0xff) {
 373                         /* leave lower 10 bits untouched */
 374                         compat += (next_offset += 0x400);
 375 #  if 1
 376                         if (check_region(compat + 2, 1))
 377                                 printk(KERN_ERR "%s: check_region failure at 0x%04x\n",
 378                                         hwif->name, (compat + 2));
 379                         /*
 380                          * The region check is not needed; however.........
 381                          * Since this is the checked in ide-probe.c,
 382                          * this is only an assignment.
 383                          */
 384 #  endif
 385                         hwif->io_ports[IDE_CONTROL_OFFSET] = compat + 2;
 386                         hwif->OUTW(compat|1, hwif->config_data);
 387                         new = hwif->INW(hwif->config_data);
 388                         printk(KERN_INFO "%s: control basereg workaround: "
 389                                 "old=0x%04x, new=0x%04x\n",
 390                                 hwif->name, old, new & ~1);
 391                 }
 392         }
 393 #endif
 394 }
 395
 396 static ide_pci_device_t trm290_chipset __devinitdata = {
 397         .name           = "TRM290",
 398         .init_hwif      = init_hwif_trm290,
 399         .channels       = 2,
 400         .autodma        = NOAUTODMA,
 401         .bootable       = ON_BOARD,
 402 };
 403
 404 static int __devinit trm290_init_one(struct pci_dev *dev, const struct pci_device_id *id)
 405 {
 406         ide_setup_pci_device(dev, &trm290_chipset);
 407         return 0;
 408 }
 409
 410 static struct pci_device_id trm290_pci_tbl[] = {
 411         { PCI_VENDOR_ID_TEKRAM, PCI_DEVICE_ID_TEKRAM_DC290, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
 412         { 0, },
 413 };
 414 MODULE_DEVICE_TABLE(pci, trm290_pci_tbl);
 415
 416 static struct pci_driver driver = {
 417         .name           = "TRM290 IDE",
 418         .id_table       = trm290_pci_tbl,
 419         .probe          = trm290_init_one,
 420 };
 421
 422 static int trm290_ide_init(void)
 423 {
 424         return ide_pci_register_driver(&driver);
 425 }
 426
 427 module_init(trm290_ide_init);
 428
 429 MODULE_AUTHOR("Mark Lord");
 430 MODULE_DESCRIPTION("PCI driver module for Tekram TRM290 IDE");
 431 MODULE_LICENSE("GPL");