ide: export ide_allocate_dma_engine()
[linux-2.6] / drivers / ide / pci / trm290.c
1 /*
2  *  Copyright (c) 1997-1998  Mark Lord
3  *  Copyright (c) 2007       MontaVista Software, Inc. <source@mvista.com>
4  *
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
8  *                   - Jesper Juhl
9  *
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
131 #include <linux/types.h>
132 #include <linux/module.h>
133 #include <linux/kernel.h>
134 #include <linux/ioport.h>
135 #include <linux/interrupt.h>
136 #include <linux/blkdev.h>
137 #include <linux/init.h>
138 #include <linux/hdreg.h>
139 #include <linux/pci.h>
140 #include <linux/ide.h>
141
142 #include <asm/io.h>
143
144 static void trm290_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
145 {
146         ide_hwif_t *hwif = HWIF(drive);
147         u16 reg = 0;
148         unsigned long flags;
149
150         /* select PIO or DMA */
151         reg = use_dma ? (0x21 | 0x82) : (0x21 & ~0x82);
152
153         local_irq_save(flags);
154
155         if (reg != hwif->select_data) {
156                 hwif->select_data = reg;
157                 /* set PIO/DMA */
158                 outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
159                 outw(reg & 0xff, hwif->config_data);
160         }
161
162         /* enable IRQ if not probing */
163         if (drive->present) {
164                 reg = inw(hwif->config_data + 3);
165                 reg &= 0x13;
166                 reg &= ~(1 << hwif->channel);
167                 outw(reg, hwif->config_data + 3);
168         }
169
170         local_irq_restore(flags);
171 }
172
173 static void trm290_selectproc (ide_drive_t *drive)
174 {
175         trm290_prepare_drive(drive, drive->using_dma);
176 }
177
178 static void trm290_dma_exec_cmd(ide_drive_t *drive, u8 command)
179 {
180         ide_execute_command(drive, command, &ide_dma_intr, WAIT_CMD, NULL);
181 }
182
183 static int trm290_dma_setup(ide_drive_t *drive)
184 {
185         ide_hwif_t *hwif = drive->hwif;
186         struct request *rq = hwif->hwgroup->rq;
187         unsigned int count, rw;
188
189         if (rq_data_dir(rq)) {
190 #ifdef TRM290_NO_DMA_WRITES
191                 /* always use PIO for writes */
192                 trm290_prepare_drive(drive, 0); /* select PIO xfer */
193                 return 1;
194 #endif
195                 rw = 1;
196         } else
197                 rw = 2;
198
199         if (!(count = ide_build_dmatable(drive, rq))) {
200                 /* try PIO instead of DMA */
201                 trm290_prepare_drive(drive, 0); /* select PIO xfer */
202                 return 1;
203         }
204         /* select DMA xfer */
205         trm290_prepare_drive(drive, 1);
206         outl(hwif->dmatable_dma | rw, hwif->dma_base);
207         drive->waiting_for_dma = 1;
208         /* start DMA */
209         outw(count * 2 - 1, hwif->dma_base + 2);
210         return 0;
211 }
212
213 static void trm290_dma_start(ide_drive_t *drive)
214 {
215 }
216
217 static int trm290_ide_dma_end (ide_drive_t *drive)
218 {
219         u16 status;
220
221         drive->waiting_for_dma = 0;
222         /* purge DMA mappings */
223         ide_destroy_dmatable(drive);
224         status = inw(HWIF(drive)->dma_base + 2);
225         return status != 0x00ff;
226 }
227
228 static int trm290_ide_dma_test_irq (ide_drive_t *drive)
229 {
230         u16 status;
231
232         status = inw(HWIF(drive)->dma_base + 2);
233         return status == 0x00ff;
234 }
235
236 static void trm290_dma_host_set(ide_drive_t *drive, int on)
237 {
238 }
239
240 static void __devinit init_hwif_trm290(ide_hwif_t *hwif)
241 {
242         struct pci_dev *dev     = to_pci_dev(hwif->dev);
243         unsigned int  cfg_base  = pci_resource_start(dev, 4);
244         unsigned long flags;
245         u8 reg = 0;
246
247         if ((dev->class & 5) && cfg_base)
248                 printk(KERN_INFO "TRM290: chip");
249         else {
250                 cfg_base = 0x3df0;
251                 printk(KERN_INFO "TRM290: using default");
252         }
253         printk(KERN_CONT " config base at 0x%04x\n", cfg_base);
254         hwif->config_data = cfg_base;
255         hwif->dma_base = (cfg_base + 4) ^ (hwif->channel ? 0x80 : 0);
256
257         printk(KERN_INFO "    %s: BM-DMA at 0x%04lx-0x%04lx\n",
258                hwif->name, hwif->dma_base, hwif->dma_base + 3);
259
260         if (ide_allocate_dma_engine(hwif))
261                 return;
262
263         local_irq_save(flags);
264         /* put config reg into first byte of hwif->select_data */
265         outb(0x51 | (hwif->channel << 3), hwif->config_data + 1);
266         /* select PIO as default */
267         hwif->select_data = 0x21;
268         outb(hwif->select_data, hwif->config_data);
269         /* get IRQ info */
270         reg = inb(hwif->config_data + 3);
271         /* mask IRQs for both ports */
272         reg = (reg & 0x10) | 0x03;
273         outb(reg, hwif->config_data + 3);
274         local_irq_restore(flags);
275
276         if (reg & 0x10)
277                 /* legacy mode */
278                 hwif->irq = hwif->channel ? 15 : 14;
279         else if (!hwif->irq && hwif->mate && hwif->mate->irq)
280                 /* sharing IRQ with mate */
281                 hwif->irq = hwif->mate->irq;
282
283         hwif->dma_host_set      = &trm290_dma_host_set;
284         hwif->dma_setup         = &trm290_dma_setup;
285         hwif->dma_exec_cmd      = &trm290_dma_exec_cmd;
286         hwif->dma_start         = &trm290_dma_start;
287         hwif->ide_dma_end       = &trm290_ide_dma_end;
288         hwif->ide_dma_test_irq  = &trm290_ide_dma_test_irq;
289 #if 1
290         {
291         /*
292          * My trm290-based card doesn't seem to work with all possible values
293          * for the control basereg, so this kludge ensures that we use only
294          * values that are known to work.  Ugh.         -ml
295          */
296                 u16 new, old, compat = hwif->channel ? 0x374 : 0x3f4;
297                 static u16 next_offset = 0;
298                 u8 old_mask;
299
300                 outb(0x54 | (hwif->channel << 3), hwif->config_data + 1);
301                 old = inw(hwif->config_data);
302                 old &= ~1;
303                 old_mask = inb(old + 2);
304                 if (old != compat && old_mask == 0xff) {
305                         /* leave lower 10 bits untouched */
306                         compat += (next_offset += 0x400);
307                         hwif->io_ports[IDE_CONTROL_OFFSET] = compat + 2;
308                         outw(compat | 1, hwif->config_data);
309                         new = inw(hwif->config_data);
310                         printk(KERN_INFO "%s: control basereg workaround: "
311                                 "old=0x%04x, new=0x%04x\n",
312                                 hwif->name, old, new & ~1);
313                 }
314         }
315 #endif
316 }
317
318 static const struct ide_port_ops trm290_port_ops = {
319         .selectproc             = trm290_selectproc,
320 };
321
322 static const struct ide_port_info trm290_chipset __devinitdata = {
323         .name           = "TRM290",
324         .init_hwif      = init_hwif_trm290,
325         .chipset        = ide_trm290,
326         .port_ops       = &trm290_port_ops,
327         .host_flags     = IDE_HFLAG_NO_ATAPI_DMA |
328 #if 0 /* play it safe for now */
329                           IDE_HFLAG_TRUST_BIOS_FOR_DMA |
330 #endif
331                           IDE_HFLAG_NO_AUTODMA |
332                           IDE_HFLAG_NO_LBA48,
333 };
334
335 static 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
340 static const struct pci_device_id trm290_pci_tbl[] = {
341         { PCI_VDEVICE(TEKRAM, PCI_DEVICE_ID_TEKRAM_DC290), 0 },
342         { 0, },
343 };
344 MODULE_DEVICE_TABLE(pci, trm290_pci_tbl);
345
346 static struct pci_driver driver = {
347         .name           = "TRM290_IDE",
348         .id_table       = trm290_pci_tbl,
349         .probe          = trm290_init_one,
350 };
351
352 static int __init trm290_ide_init(void)
353 {
354         return ide_pci_register_driver(&driver);
355 }
356
357 module_init(trm290_ide_init);
358
359 MODULE_AUTHOR("Mark Lord");
360 MODULE_DESCRIPTION("PCI driver module for Tekram TRM290 IDE");
361 MODULE_LICENSE("GPL");