blob: be5d145a94f1703d71b367550ebe7304702302fa [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 * June 22, 2004 - get rid of check_region
Jesper Juhl59904152005-07-27 11:46:10 -07008 * - Jesper Juhl
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 *
10 */
11
12/*
13 * This module provides support for the bus-master IDE DMA function
14 * of the Tekram TRM290 chip, used on a variety of PCI IDE add-on boards,
15 * including a "Precision Instruments" board. The TRM290 pre-dates
16 * the sff-8038 standard (ide-dma.c) by a few months, and differs
17 * significantly enough to warrant separate routines for some functions,
18 * while re-using others from ide-dma.c.
19 *
20 * EXPERIMENTAL! It works for me (a sample of one).
21 *
22 * Works reliably for me in DMA mode (READs only),
23 * DMA WRITEs are disabled by default (see #define below);
24 *
25 * DMA is not enabled automatically for this chipset,
26 * but can be turned on manually (with "hdparm -d1") at run time.
27 *
28 * I need volunteers with "spare" drives for further testing
29 * and development, and maybe to help figure out the peculiarities.
30 * Even knowing the registers (below), some things behave strangely.
31 */
32
33#define TRM290_NO_DMA_WRITES /* DMA writes seem unreliable sometimes */
34
35/*
36 * TRM-290 PCI-IDE2 Bus Master Chip
37 * ================================
38 * The configuration registers are addressed in normal I/O port space
39 * and are used as follows:
40 *
41 * trm290_base depends on jumper settings, and is probed for by ide-dma.c
42 *
43 * trm290_base+2 when WRITTEN: chiptest register (byte, write-only)
44 * bit7 must always be written as "1"
45 * bits6-2 undefined
46 * bit1 1=legacy_compatible_mode, 0=native_pci_mode
47 * bit0 1=test_mode, 0=normal(default)
48 *
49 * trm290_base+2 when READ: status register (byte, read-only)
50 * bits7-2 undefined
51 * bit1 channel0 busmaster interrupt status 0=none, 1=asserted
52 * bit0 channel0 interrupt status 0=none, 1=asserted
53 *
54 * trm290_base+3 Interrupt mask register
55 * bits7-5 undefined
56 * bit4 legacy_header: 1=present, 0=absent
57 * bit3 channel1 busmaster interrupt status 0=none, 1=asserted (read only)
58 * bit2 channel1 interrupt status 0=none, 1=asserted (read only)
59 * bit1 channel1 interrupt mask: 1=masked, 0=unmasked(default)
60 * bit0 channel0 interrupt mask: 1=masked, 0=unmasked(default)
61 *
62 * trm290_base+1 "CPR" Config Pointer Register (byte)
63 * bit7 1=autoincrement CPR bits 2-0 after each access of CDR
64 * bit6 1=min. 1 wait-state posted write cycle (default), 0=0 wait-state
65 * bit5 0=enabled master burst access (default), 1=disable (write only)
66 * bit4 PCI DEVSEL# timing select: 1=medium(default), 0=fast
67 * bit3 0=primary IDE channel, 1=secondary IDE channel
68 * bits2-0 register index for accesses through CDR port
69 *
70 * trm290_base+0 "CDR" Config Data Register (word)
71 * two sets of seven config registers,
72 * selected by CPR bit 3 (channel) and CPR bits 2-0 (index 0 to 6),
73 * each index defined below:
74 *
75 * Index-0 Base address register for command block (word)
76 * defaults: 0x1f0 for primary, 0x170 for secondary
77 *
78 * Index-1 general config register (byte)
79 * bit7 1=DMA enable, 0=DMA disable
80 * bit6 1=activate IDE_RESET, 0=no action (default)
81 * bit5 1=enable IORDY, 0=disable IORDY (default)
82 * bit4 0=16-bit data port(default), 1=8-bit (XT) data port
83 * bit3 interrupt polarity: 1=active_low, 0=active_high(default)
84 * bit2 power-saving-mode(?): 1=enable, 0=disable(default) (write only)
85 * bit1 bus_master_mode(?): 1=enable, 0=disable(default)
86 * bit0 enable_io_ports: 1=enable(default), 0=disable
87 *
88 * Index-2 read-ahead counter preload bits 0-7 (byte, write only)
89 * bits7-0 bits7-0 of readahead count
90 *
91 * Index-3 read-ahead config register (byte, write only)
92 * bit7 1=enable_readahead, 0=disable_readahead(default)
93 * bit6 1=clear_FIFO, 0=no_action
94 * bit5 undefined
95 * bit4 mode4 timing control: 1=enable, 0=disable(default)
96 * bit3 undefined
97 * bit2 undefined
98 * bits1-0 bits9-8 of read-ahead count
99 *
100 * Index-4 base address register for control block (word)
101 * defaults: 0x3f6 for primary, 0x376 for secondary
102 *
103 * Index-5 data port timings (shared by both drives) (byte)
104 * standard PCI "clk" (clock) counts, default value = 0xf5
105 *
106 * bits7-6 setup time: 00=1clk, 01=2clk, 10=3clk, 11=4clk
107 * bits5-3 hold time: 000=1clk, 001=2clk, 010=3clk,
108 * 011=4clk, 100=5clk, 101=6clk,
109 * 110=8clk, 111=12clk
110 * bits2-0 active time: 000=2clk, 001=3clk, 010=4clk,
111 * 011=5clk, 100=6clk, 101=8clk,
112 * 110=12clk, 111=16clk
113 *
114 * Index-6 command/control port timings (shared by both drives) (byte)
115 * same layout as Index-5, default value = 0xde
116 *
117 * Suggested CDR programming for PIO mode0 (600ns):
118 * 0x01f0,0x21,0xff,0x80,0x03f6,0xf5,0xde ; primary
119 * 0x0170,0x21,0xff,0x80,0x0376,0xf5,0xde ; secondary
120 *
121 * Suggested CDR programming for PIO mode3 (180ns):
122 * 0x01f0,0x21,0xff,0x80,0x03f6,0x09,0xde ; primary
123 * 0x0170,0x21,0xff,0x80,0x0376,0x09,0xde ; secondary
124 *
125 * Suggested CDR programming for PIO mode4 (120ns):
126 * 0x01f0,0x21,0xff,0x80,0x03f6,0x00,0xde ; primary
127 * 0x0170,0x21,0xff,0x80,0x0376,0x00,0xde ; secondary
128 *
129 */
130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131#include <linux/types.h>
132#include <linux/module.h>
133#include <linux/kernel.h>
134#include <linux/mm.h>
135#include <linux/ioport.h>
136#include <linux/interrupt.h>
137#include <linux/blkdev.h>
138#include <linux/init.h>
139#include <linux/hdreg.h>
140#include <linux/pci.h>
141#include <linux/delay.h>
142#include <linux/ide.h>
143
144#include <asm/io.h>
145
146static void trm290_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
147{
148 ide_hwif_t *hwif = HWIF(drive);
149 u16 reg = 0;
150 unsigned long flags;
151
152 /* select PIO or DMA */
153 reg = use_dma ? (0x21 | 0x82) : (0x21 & ~0x82);
154
155 local_irq_save(flags);
156
157 if (reg != hwif->select_data) {
158 hwif->select_data = reg;
159 /* set PIO/DMA */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100160 outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
161 outw(reg & 0xff, hwif->config_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 }
163
164 /* enable IRQ if not probing */
165 if (drive->present) {
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100166 reg = inw(hwif->config_data + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 reg &= 0x13;
168 reg &= ~(1 << hwif->channel);
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100169 outw(reg, hwif->config_data + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 }
171
172 local_irq_restore(flags);
173}
174
175static void trm290_selectproc (ide_drive_t *drive)
176{
177 trm290_prepare_drive(drive, drive->using_dma);
178}
179
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180static void trm290_ide_dma_exec_cmd(ide_drive_t *drive, u8 command)
181{
Eric Sesterhenn125e1872006-06-23 02:06:06 -0700182 BUG_ON(HWGROUP(drive)->handler != NULL); /* paranoia check */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183 ide_set_handler(drive, &ide_dma_intr, WAIT_CMD, NULL);
184 /* issue cmd to drive */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100185 outb(command, IDE_COMMAND_REG);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186}
187
188static int trm290_ide_dma_setup(ide_drive_t *drive)
189{
190 ide_hwif_t *hwif = drive->hwif;
191 struct request *rq = hwif->hwgroup->rq;
192 unsigned int count, rw;
193
194 if (rq_data_dir(rq)) {
195#ifdef TRM290_NO_DMA_WRITES
196 /* always use PIO for writes */
197 trm290_prepare_drive(drive, 0); /* select PIO xfer */
198 return 1;
199#endif
200 rw = 1;
201 } else
202 rw = 2;
203
204 if (!(count = ide_build_dmatable(drive, rq))) {
205 /* try PIO instead of DMA */
206 trm290_prepare_drive(drive, 0); /* select PIO xfer */
207 return 1;
208 }
209 /* select DMA xfer */
210 trm290_prepare_drive(drive, 1);
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100211 outl(hwif->dmatable_dma | rw, hwif->dma_command);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 drive->waiting_for_dma = 1;
213 /* start DMA */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100214 outw((count * 2) - 1, hwif->dma_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 return 0;
216}
217
218static void trm290_ide_dma_start(ide_drive_t *drive)
219{
220}
221
222static int trm290_ide_dma_end (ide_drive_t *drive)
223{
224 ide_hwif_t *hwif = HWIF(drive);
225 u16 status = 0;
226
227 drive->waiting_for_dma = 0;
228 /* purge DMA mappings */
229 ide_destroy_dmatable(drive);
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100230 status = inw(hwif->dma_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 return (status != 0x00ff);
232}
233
234static int trm290_ide_dma_test_irq (ide_drive_t *drive)
235{
236 ide_hwif_t *hwif = HWIF(drive);
237 u16 status = 0;
238
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100239 status = inw(hwif->dma_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return (status == 0x00ff);
241}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
243/*
244 * Invoked from ide-dma.c at boot time.
245 */
246static void __devinit init_hwif_trm290(ide_hwif_t *hwif)
247{
248 unsigned int cfgbase = 0;
249 unsigned long flags;
250 u8 reg = 0;
251 struct pci_dev *dev = hwif->pci_dev;
252
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 cfgbase = pci_resource_start(dev, 4);
254 if ((dev->class & 5) && cfgbase) {
255 hwif->config_data = cfgbase;
256 printk(KERN_INFO "TRM290: chip config base at 0x%04lx\n",
257 hwif->config_data);
258 } else {
259 hwif->config_data = 0x3df0;
260 printk(KERN_INFO "TRM290: using default config base at 0x%04lx\n",
261 hwif->config_data);
262 }
263
264 local_irq_save(flags);
265 /* put config reg into first byte of hwif->select_data */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100266 outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 /* select PIO as default */
268 hwif->select_data = 0x21;
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100269 outb(hwif->select_data, hwif->config_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 /* get IRQ info */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100271 reg = inb(hwif->config_data + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 /* mask IRQs for both ports */
273 reg = (reg & 0x10) | 0x03;
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100274 outb(reg, hwif->config_data + 3);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 local_irq_restore(flags);
276
277 if ((reg & 0x10))
278 /* legacy mode */
279 hwif->irq = hwif->channel ? 15 : 14;
280 else if (!hwif->irq && hwif->mate && hwif->mate->irq)
281 /* sharing IRQ with mate */
282 hwif->irq = hwif->mate->irq;
283
284 ide_setup_dma(hwif, (hwif->config_data + 4) ^ (hwif->channel ? 0x0080 : 0x0000), 3);
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 hwif->dma_setup = &trm290_ide_dma_setup;
287 hwif->dma_exec_cmd = &trm290_ide_dma_exec_cmd;
288 hwif->dma_start = &trm290_ide_dma_start;
289 hwif->ide_dma_end = &trm290_ide_dma_end;
290 hwif->ide_dma_test_irq = &trm290_ide_dma_test_irq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 hwif->selectproc = &trm290_selectproc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293#if 1
294 {
295 /*
296 * My trm290-based card doesn't seem to work with all possible values
297 * for the control basereg, so this kludge ensures that we use only
298 * values that are known to work. Ugh. -ml
299 */
300 u16 new, old, compat = hwif->channel ? 0x374 : 0x3f4;
301 static u16 next_offset = 0;
302 u8 old_mask;
303
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100304 outb(0x54 | (hwif->channel << 3), hwif->config_data + 1);
305 old = inw(hwif->config_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 old &= ~1;
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100307 old_mask = inb(old + 2);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 if (old != compat && old_mask == 0xff) {
309 /* leave lower 10 bits untouched */
310 compat += (next_offset += 0x400);
311 hwif->io_ports[IDE_CONTROL_OFFSET] = compat + 2;
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100312 outw(compat | 1, hwif->config_data);
313 new = inw(hwif->config_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 printk(KERN_INFO "%s: control basereg workaround: "
315 "old=0x%04x, new=0x%04x\n",
316 hwif->name, old, new & ~1);
317 }
318 }
319#endif
320}
321
322static ide_pci_device_t trm290_chipset __devinitdata = {
323 .name = "TRM290",
324 .init_hwif = init_hwif_trm290,
Bartlomiej Zolnierkiewicz528a5722007-10-20 00:32:30 +0200325 .chipset = ide_trm290,
Bartlomiej Zolnierkiewicz7cab14a2007-10-19 00:30:06 +0200326 .host_flags = IDE_HFLAG_NO_ATAPI_DMA |
Bartlomiej Zolnierkiewicz9ff6f722007-10-16 22:29:58 +0200327#if 0 /* play it safe for now */
Bartlomiej Zolnierkiewicz7cab14a2007-10-19 00:30:06 +0200328 IDE_HFLAG_TRUST_BIOS_FOR_DMA |
Bartlomiej Zolnierkiewicz9ff6f722007-10-16 22:29:58 +0200329#endif
Bartlomiej Zolnierkiewicz47b68782007-10-19 00:30:06 +0200330 IDE_HFLAG_NO_AUTODMA |
Bartlomiej Zolnierkiewicz238e4f12007-10-19 00:30:07 +0200331 IDE_HFLAG_BOOTABLE |
332 IDE_HFLAG_NO_LBA48,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333};
334
335static int __devinit trm290_init_one(struct pci_dev *dev, const struct pci_device_id *id)
336{
337 return ide_setup_pci_device(dev, &trm290_chipset);
338}
339
Bartlomiej Zolnierkiewicz9cbcc5e2007-10-16 22:29:56 +0200340static const struct pci_device_id trm290_pci_tbl[] = {
341 { PCI_VDEVICE(TEKRAM, PCI_DEVICE_ID_TEKRAM_DC290), 0 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 { 0, },
343};
344MODULE_DEVICE_TABLE(pci, trm290_pci_tbl);
345
346static struct pci_driver driver = {
347 .name = "TRM290_IDE",
348 .id_table = trm290_pci_tbl,
349 .probe = trm290_init_one,
350};
351
Bartlomiej Zolnierkiewicz82ab1ee2007-01-27 13:46:56 +0100352static int __init trm290_ide_init(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353{
354 return ide_pci_register_driver(&driver);
355}
356
357module_init(trm290_ide_init);
358
359MODULE_AUTHOR("Mark Lord");
360MODULE_DESCRIPTION("PCI driver module for Tekram TRM290 IDE");
361MODULE_LICENSE("GPL");