trm290.c 11.1 KB
Newer Older
L
Linus Torvalds 已提交
1
/*
2
 *  linux/drivers/ide/pci/trm290.c		Version 1.05	Dec. 30, 2007
L
Linus Torvalds 已提交
3 4
 *
 *  Copyright (c) 1997-1998  Mark Lord
5
 *  Copyright (c) 2007       MontaVista Software, Inc. <source@mvista.com>
L
Linus Torvalds 已提交
6 7 8
 *  May be copied or modified under the terms of the GNU General Public License
 *
 *  June 22, 2004 - get rid of check_region
9
 *                   - Jesper Juhl
L
Linus Torvalds 已提交
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
 *
 */

/*
 * This module provides support for the bus-master IDE DMA function
 * of the Tekram TRM290 chip, used on a variety of PCI IDE add-on boards,
 * including a "Precision Instruments" board.  The TRM290 pre-dates
 * the sff-8038 standard (ide-dma.c) by a few months, and differs
 * significantly enough to warrant separate routines for some functions,
 * while re-using others from ide-dma.c.
 *
 * EXPERIMENTAL!  It works for me (a sample of one).
 *
 * Works reliably for me in DMA mode (READs only),
 * DMA WRITEs are disabled by default (see #define below);
 *
 * DMA is not enabled automatically for this chipset,
 * but can be turned on manually (with "hdparm -d1") at run time.
 *
 * I need volunteers with "spare" drives for further testing
 * and development, and maybe to help figure out the peculiarities.
 * Even knowing the registers (below), some things behave strangely.
 */

#define TRM290_NO_DMA_WRITES	/* DMA writes seem unreliable sometimes */

/*
 * TRM-290 PCI-IDE2 Bus Master Chip
 * ================================
 * The configuration registers are addressed in normal I/O port space
 * and are used as follows:
 *
 * trm290_base depends on jumper settings, and is probed for by ide-dma.c
 *
 * trm290_base+2 when WRITTEN: chiptest register (byte, write-only)
 *	bit7 must always be written as "1"
 *	bits6-2 undefined
 *	bit1 1=legacy_compatible_mode, 0=native_pci_mode
 *	bit0 1=test_mode, 0=normal(default)
 *
 * trm290_base+2 when READ: status register (byte, read-only)
 *	bits7-2 undefined
 *	bit1 channel0 busmaster interrupt status 0=none, 1=asserted
 *	bit0 channel0 interrupt status 0=none, 1=asserted
 *
 * trm290_base+3 Interrupt mask register
 *	bits7-5 undefined
 *	bit4 legacy_header: 1=present, 0=absent
 *	bit3 channel1 busmaster interrupt status 0=none, 1=asserted (read only)
 *	bit2 channel1 interrupt status 0=none, 1=asserted (read only)
 *	bit1 channel1 interrupt mask: 1=masked, 0=unmasked(default)
 *	bit0 channel0 interrupt mask: 1=masked, 0=unmasked(default)
 *
 * trm290_base+1 "CPR" Config Pointer Register (byte)
 *	bit7 1=autoincrement CPR bits 2-0 after each access of CDR
 *	bit6 1=min. 1 wait-state posted write cycle (default), 0=0 wait-state
 *	bit5 0=enabled master burst access (default), 1=disable  (write only)
 *	bit4 PCI DEVSEL# timing select: 1=medium(default), 0=fast
 *	bit3 0=primary IDE channel, 1=secondary IDE channel
 *	bits2-0 register index for accesses through CDR port
 *
 * trm290_base+0 "CDR" Config Data Register (word)
 *	two sets of seven config registers,
 *	selected by CPR bit 3 (channel) and CPR bits 2-0 (index 0 to 6),
 *	each index defined below:
 *
 * Index-0 Base address register for command block (word)
 *	defaults: 0x1f0 for primary, 0x170 for secondary
 *
 * Index-1 general config register (byte)
 *	bit7 1=DMA enable, 0=DMA disable
 *	bit6 1=activate IDE_RESET, 0=no action (default)
 *	bit5 1=enable IORDY, 0=disable IORDY (default)
 *	bit4 0=16-bit data port(default), 1=8-bit (XT) data port
 *	bit3 interrupt polarity: 1=active_low, 0=active_high(default)
 *	bit2 power-saving-mode(?): 1=enable, 0=disable(default) (write only)
 *	bit1 bus_master_mode(?): 1=enable, 0=disable(default)
 *	bit0 enable_io_ports: 1=enable(default), 0=disable
 *
 * Index-2 read-ahead counter preload bits 0-7 (byte, write only)
 *	bits7-0 bits7-0 of readahead count
 *
 * Index-3 read-ahead config register (byte, write only)
 *	bit7 1=enable_readahead, 0=disable_readahead(default)
 *	bit6 1=clear_FIFO, 0=no_action
 *	bit5 undefined
 *	bit4 mode4 timing control: 1=enable, 0=disable(default)
 *	bit3 undefined
 *	bit2 undefined
 *	bits1-0 bits9-8 of read-ahead count
 *
 * Index-4 base address register for control block (word)
 *	defaults: 0x3f6 for primary, 0x376 for secondary
 *
 * Index-5 data port timings (shared by both drives) (byte)
 *	standard PCI "clk" (clock) counts, default value = 0xf5
 *
 *	bits7-6 setup time:  00=1clk, 01=2clk, 10=3clk, 11=4clk
 *	bits5-3 hold time:	000=1clk, 001=2clk, 010=3clk,
 *				011=4clk, 100=5clk, 101=6clk,
 *				110=8clk, 111=12clk
 *	bits2-0 active time:	000=2clk, 001=3clk, 010=4clk,
 *				011=5clk, 100=6clk, 101=8clk,
 *				110=12clk, 111=16clk
 *
 * Index-6 command/control port timings (shared by both drives) (byte)
 *	same layout as Index-5, default value = 0xde
 *
 * Suggested CDR programming for PIO mode0 (600ns):
 *	0x01f0,0x21,0xff,0x80,0x03f6,0xf5,0xde	; primary
 *	0x0170,0x21,0xff,0x80,0x0376,0xf5,0xde	; secondary
 *
 * Suggested CDR programming for PIO mode3 (180ns):
 *	0x01f0,0x21,0xff,0x80,0x03f6,0x09,0xde	; primary
 *	0x0170,0x21,0xff,0x80,0x0376,0x09,0xde	; secondary
 *
 * Suggested CDR programming for PIO mode4 (120ns):
 *	0x01f0,0x21,0xff,0x80,0x03f6,0x00,0xde	; primary
 *	0x0170,0x21,0xff,0x80,0x0376,0x00,0xde	; secondary
 *
 */

#include <linux/types.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/mm.h>
#include <linux/ioport.h>
#include <linux/interrupt.h>
#include <linux/blkdev.h>
#include <linux/init.h>
#include <linux/hdreg.h>
#include <linux/pci.h>
#include <linux/delay.h>
#include <linux/ide.h>

#include <asm/io.h>

static void trm290_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
{
	ide_hwif_t *hwif = HWIF(drive);
	u16 reg = 0;
	unsigned long flags;

	/* select PIO or DMA */
	reg = use_dma ? (0x21 | 0x82) : (0x21 & ~0x82);

	local_irq_save(flags);

	if (reg != hwif->select_data) {
		hwif->select_data = reg;
		/* set PIO/DMA */
161 162
		outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
		outw(reg & 0xff, hwif->config_data);
L
Linus Torvalds 已提交
163 164 165 166
	}

	/* enable IRQ if not probing */
	if (drive->present) {
167
		reg = inw(hwif->config_data + 3);
L
Linus Torvalds 已提交
168 169
		reg &= 0x13;
		reg &= ~(1 << hwif->channel);
170
		outw(reg, hwif->config_data + 3);
L
Linus Torvalds 已提交
171 172 173 174 175 176 177 178 179 180
	}

	local_irq_restore(flags);
}

static void trm290_selectproc (ide_drive_t *drive)
{
	trm290_prepare_drive(drive, drive->using_dma);
}

181
static void trm290_dma_exec_cmd(ide_drive_t *drive, u8 command)
L
Linus Torvalds 已提交
182
{
E
Eric Sesterhenn 已提交
183
	BUG_ON(HWGROUP(drive)->handler != NULL);	/* paranoia check */
L
Linus Torvalds 已提交
184 185
	ide_set_handler(drive, &ide_dma_intr, WAIT_CMD, NULL);
	/* issue cmd to drive */
186
	outb(command, IDE_COMMAND_REG);
L
Linus Torvalds 已提交
187 188
}

189
static int trm290_dma_setup(ide_drive_t *drive)
L
Linus Torvalds 已提交
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
{
	ide_hwif_t *hwif = drive->hwif;
	struct request *rq = hwif->hwgroup->rq;
	unsigned int count, rw;

	if (rq_data_dir(rq)) {
#ifdef TRM290_NO_DMA_WRITES
		/* always use PIO for writes */
		trm290_prepare_drive(drive, 0);	/* select PIO xfer */
		return 1;
#endif
		rw = 1;
	} else
		rw = 2;

	if (!(count = ide_build_dmatable(drive, rq))) {
		/* try PIO instead of DMA */
		trm290_prepare_drive(drive, 0); /* select PIO xfer */
		return 1;
	}
	/* select DMA xfer */
	trm290_prepare_drive(drive, 1);
212
	outl(hwif->dmatable_dma | rw, hwif->dma_base);
L
Linus Torvalds 已提交
213 214
	drive->waiting_for_dma = 1;
	/* start DMA */
215
	outw(count * 2 - 1, hwif->dma_base + 2);
L
Linus Torvalds 已提交
216 217 218
	return 0;
}

219
static void trm290_dma_start(ide_drive_t *drive)
L
Linus Torvalds 已提交
220 221 222 223 224
{
}

static int trm290_ide_dma_end (ide_drive_t *drive)
{
225
	u16 status;
L
Linus Torvalds 已提交
226 227 228 229

	drive->waiting_for_dma = 0;
	/* purge DMA mappings */
	ide_destroy_dmatable(drive);
230 231
	status = inw(HWIF(drive)->dma_base + 2);
	return status != 0x00ff;
L
Linus Torvalds 已提交
232 233 234 235
}

static int trm290_ide_dma_test_irq (ide_drive_t *drive)
{
236
	u16 status;
L
Linus Torvalds 已提交
237

238 239
	status = inw(HWIF(drive)->dma_base + 2);
	return status == 0x00ff;
L
Linus Torvalds 已提交
240 241
}

242
static void trm290_dma_host_set(ide_drive_t *drive, int on)
243 244 245
{
}

L
Linus Torvalds 已提交
246 247
static void __devinit init_hwif_trm290(ide_hwif_t *hwif)
{
248
	struct pci_dev *dev	= to_pci_dev(hwif->dev);
249
	unsigned int  cfg_base	= pci_resource_start(dev, 4);
L
Linus Torvalds 已提交
250 251 252
	unsigned long flags;
	u8 reg = 0;

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
	if ((dev->class & 5) && cfg_base)
		printk(KERN_INFO "TRM290: chip");
	else {
		cfg_base = 0x3df0;
		printk(KERN_INFO "TRM290: using default");
	}
	printk(KERN_CONT " config base at 0x%04x\n", cfg_base);
	hwif->config_data = cfg_base;
	hwif->dma_base = (cfg_base + 4) ^ (hwif->channel ? 0x80 : 0);

	printk(KERN_INFO "    %s: BM-DMA at 0x%04lx-0x%04lx",
	       hwif->name, hwif->dma_base, hwif->dma_base + 3);

	if (!request_region(hwif->dma_base, 4, hwif->name)) {
		printk(KERN_CONT " -- Error, ports in use.\n");
		return;
	}

	hwif->dmatable_cpu = pci_alloc_consistent(dev, PRD_ENTRIES * PRD_BYTES,
						  &hwif->dmatable_dma);
	if (!hwif->dmatable_cpu) {
		printk(KERN_CONT " -- Error, unable to allocate DMA table.\n");
		release_region(hwif->dma_base, 4);
		return;
L
Linus Torvalds 已提交
277
	}
278
	printk(KERN_CONT "\n");
L
Linus Torvalds 已提交
279 280 281

	local_irq_save(flags);
	/* put config reg into first byte of hwif->select_data */
282
	outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
L
Linus Torvalds 已提交
283 284
	/* select PIO as default */
	hwif->select_data = 0x21;
285
	outb(hwif->select_data, hwif->config_data);
L
Linus Torvalds 已提交
286
	/* get IRQ info */
287
	reg = inb(hwif->config_data + 3);
L
Linus Torvalds 已提交
288 289
	/* mask IRQs for both ports */
	reg = (reg & 0x10) | 0x03;
290
	outb(reg, hwif->config_data + 3);
L
Linus Torvalds 已提交
291 292
	local_irq_restore(flags);

293
	if (reg & 0x10)
L
Linus Torvalds 已提交
294 295 296 297 298 299
		/* legacy mode */
		hwif->irq = hwif->channel ? 15 : 14;
	else if (!hwif->irq && hwif->mate && hwif->mate->irq)
		/* sharing IRQ with mate */
		hwif->irq = hwif->mate->irq;

300
	hwif->dma_host_set	= &trm290_dma_host_set;
301 302 303 304 305
	hwif->dma_setup 	= &trm290_dma_setup;
	hwif->dma_exec_cmd	= &trm290_dma_exec_cmd;
	hwif->dma_start 	= &trm290_dma_start;
	hwif->ide_dma_end	= &trm290_ide_dma_end;
	hwif->ide_dma_test_irq	= &trm290_ide_dma_test_irq;
L
Linus Torvalds 已提交
306 307 308 309 310 311 312 313 314 315 316 317 318

	hwif->selectproc = &trm290_selectproc;
#if 1
	{
	/*
	 * My trm290-based card doesn't seem to work with all possible values
	 * for the control basereg, so this kludge ensures that we use only
	 * values that are known to work.  Ugh.		-ml
	 */
		u16 new, old, compat = hwif->channel ? 0x374 : 0x3f4;
		static u16 next_offset = 0;
		u8 old_mask;

319 320
		outb(0x54 | (hwif->channel << 3), hwif->config_data + 1);
		old = inw(hwif->config_data);
L
Linus Torvalds 已提交
321
		old &= ~1;
322
		old_mask = inb(old + 2);
L
Linus Torvalds 已提交
323 324 325 326
		if (old != compat && old_mask == 0xff) {
			/* leave lower 10 bits untouched */
			compat += (next_offset += 0x400);
			hwif->io_ports[IDE_CONTROL_OFFSET] = compat + 2;
327 328
			outw(compat | 1, hwif->config_data);
			new = inw(hwif->config_data);
L
Linus Torvalds 已提交
329 330 331 332 333 334 335 336
			printk(KERN_INFO "%s: control basereg workaround: "
				"old=0x%04x, new=0x%04x\n",
				hwif->name, old, new & ~1);
		}
	}
#endif
}

337
static const struct ide_port_info trm290_chipset __devinitdata = {
L
Linus Torvalds 已提交
338 339
	.name		= "TRM290",
	.init_hwif	= init_hwif_trm290,
340
	.chipset	= ide_trm290,
341
	.host_flags	= IDE_HFLAG_NO_ATAPI_DMA |
342
#if 0 /* play it safe for now */
343
			  IDE_HFLAG_TRUST_BIOS_FOR_DMA |
344
#endif
345
			  IDE_HFLAG_NO_AUTODMA |
346 347
			  IDE_HFLAG_BOOTABLE |
			  IDE_HFLAG_NO_LBA48,
L
Linus Torvalds 已提交
348 349 350 351 352 353 354
};

static int __devinit trm290_init_one(struct pci_dev *dev, const struct pci_device_id *id)
{
	return ide_setup_pci_device(dev, &trm290_chipset);
}

355 356
static const struct pci_device_id trm290_pci_tbl[] = {
	{ PCI_VDEVICE(TEKRAM, PCI_DEVICE_ID_TEKRAM_DC290), 0 },
L
Linus Torvalds 已提交
357 358 359 360 361 362 363 364 365 366
	{ 0, },
};
MODULE_DEVICE_TABLE(pci, trm290_pci_tbl);

static struct pci_driver driver = {
	.name		= "TRM290_IDE",
	.id_table	= trm290_pci_tbl,
	.probe		= trm290_init_one,
};

367
static int __init trm290_ide_init(void)
L
Linus Torvalds 已提交
368 369 370 371 372 373 374 375 376
{
	return ide_pci_register_driver(&driver);
}

module_init(trm290_ide_init);

MODULE_AUTHOR("Mark Lord");
MODULE_DESCRIPTION("PCI driver module for Tekram TRM290 IDE");
MODULE_LICENSE("GPL");