ide: make void and rename ide_dma_timeout() method
[linux-2.6] / drivers / ide / pci / pdc202xx_old.c
1 /*
2  *  linux/drivers/ide/pci/pdc202xx_old.c        Version 0.50    Mar 3, 2007
3  *
4  *  Copyright (C) 1998-2002             Andre Hedrick <andre@linux-ide.org>
5  *  Copyright (C) 2006-2007             MontaVista Software, Inc.
6  *  Copyright (C) 2007                  Bartlomiej Zolnierkiewicz
7  *
8  *  Promise Ultra33 cards with BIOS v1.20 through 1.28 will need this
9  *  compiled into the kernel if you have more than one card installed.
10  *  Note that BIOS v1.29 is reported to fix the problem.  Since this is
11  *  safe chipset tuning, including this support is harmless
12  *
13  *  Promise Ultra66 cards with BIOS v1.11 this
14  *  compiled into the kernel if you have more than one card installed.
15  *
16  *  Promise Ultra100 cards.
17  *
18  *  The latest chipset code will support the following ::
19  *  Three Ultra33 controllers and 12 drives.
20  *  8 are UDMA supported and 4 are limited to DMA mode 2 multi-word.
21  *  The 8/4 ratio is a BIOS code limit by promise.
22  *
23  *  UNLESS you enable "CONFIG_PDC202XX_BURST"
24  *
25  */
26
27 /*
28  *  Portions Copyright (C) 1999 Promise Technology, Inc.
29  *  Author: Frank Tiernan (frankt@promise.com)
30  *  Released under terms of General Public License
31  */
32
33 #include <linux/types.h>
34 #include <linux/module.h>
35 #include <linux/kernel.h>
36 #include <linux/delay.h>
37 #include <linux/timer.h>
38 #include <linux/mm.h>
39 #include <linux/ioport.h>
40 #include <linux/blkdev.h>
41 #include <linux/hdreg.h>
42 #include <linux/interrupt.h>
43 #include <linux/pci.h>
44 #include <linux/init.h>
45 #include <linux/ide.h>
46
47 #include <asm/io.h>
48 #include <asm/irq.h>
49
50 #define PDC202XX_DEBUG_DRIVE_INFO       0
51
52 static const char *pdc_quirk_drives[] = {
53         "QUANTUM FIREBALLlct08 08",
54         "QUANTUM FIREBALLP KA6.4",
55         "QUANTUM FIREBALLP KA9.1",
56         "QUANTUM FIREBALLP LM20.4",
57         "QUANTUM FIREBALLP KX13.6",
58         "QUANTUM FIREBALLP KX20.5",
59         "QUANTUM FIREBALLP KX27.3",
60         "QUANTUM FIREBALLP LM20.5",
61         NULL
62 };
63
64 static void pdc_old_disable_66MHz_clock(ide_hwif_t *);
65
66 static int pdc202xx_tune_chipset (ide_drive_t *drive, u8 xferspeed)
67 {
68         ide_hwif_t *hwif        = HWIF(drive);
69         struct pci_dev *dev     = hwif->pci_dev;
70         u8 drive_pci            = 0x60 + (drive->dn << 2);
71         u8 speed                = ide_rate_filter(drive, xferspeed);
72
73         u8                      AP = 0, BP = 0, CP = 0;
74         u8                      TA = 0, TB = 0, TC = 0;
75
76 #if PDC202XX_DEBUG_DRIVE_INFO
77         u32                     drive_conf = 0;
78         pci_read_config_dword(dev, drive_pci, &drive_conf);
79 #endif
80
81         /*
82          * TODO: do this once per channel
83          */
84         if (dev->device != PCI_DEVICE_ID_PROMISE_20246)
85                 pdc_old_disable_66MHz_clock(hwif);
86
87         pci_read_config_byte(dev, drive_pci,     &AP);
88         pci_read_config_byte(dev, drive_pci + 1, &BP);
89         pci_read_config_byte(dev, drive_pci + 2, &CP);
90
91         switch(speed) {
92                 case XFER_UDMA_5:
93                 case XFER_UDMA_4:       TB = 0x20; TC = 0x01; break;
94                 case XFER_UDMA_2:       TB = 0x20; TC = 0x01; break;
95                 case XFER_UDMA_3:
96                 case XFER_UDMA_1:       TB = 0x40; TC = 0x02; break;
97                 case XFER_UDMA_0:
98                 case XFER_MW_DMA_2:     TB = 0x60; TC = 0x03; break;
99                 case XFER_MW_DMA_1:     TB = 0x60; TC = 0x04; break;
100                 case XFER_MW_DMA_0:     TB = 0xE0; TC = 0x0F; break;
101                 case XFER_SW_DMA_2:     TB = 0x60; TC = 0x05; break;
102                 case XFER_SW_DMA_1:     TB = 0x80; TC = 0x06; break;
103                 case XFER_SW_DMA_0:     TB = 0xC0; TC = 0x0B; break;
104                 case XFER_PIO_4:        TA = 0x01; TB = 0x04; break;
105                 case XFER_PIO_3:        TA = 0x02; TB = 0x06; break;
106                 case XFER_PIO_2:        TA = 0x03; TB = 0x08; break;
107                 case XFER_PIO_1:        TA = 0x05; TB = 0x0C; break;
108                 case XFER_PIO_0:
109                 default:                TA = 0x09; TB = 0x13; break;
110         }
111
112         if (speed < XFER_SW_DMA_0) {
113                 /*
114                  * preserve SYNC_INT / ERDDY_EN bits while clearing
115                  * Prefetch_EN / IORDY_EN / PA[3:0] bits of register A
116                  */
117                 AP &= ~0x3f;
118                 if (drive->id->capability & 4)
119                         AP |= 0x20;     /* set IORDY_EN bit */
120                 if (drive->media == ide_disk)
121                         AP |= 0x10;     /* set Prefetch_EN bit */
122                 /* clear PB[4:0] bits of register B */
123                 BP &= ~0x1f;
124                 pci_write_config_byte(dev, drive_pci,     AP | TA);
125                 pci_write_config_byte(dev, drive_pci + 1, BP | TB);
126         } else {
127                 /* clear MB[2:0] bits of register B */
128                 BP &= ~0xe0;
129                 /* clear MC[3:0] bits of register C */
130                 CP &= ~0x0f;
131                 pci_write_config_byte(dev, drive_pci + 1, BP | TB);
132                 pci_write_config_byte(dev, drive_pci + 2, CP | TC);
133         }
134
135 #if PDC202XX_DEBUG_DRIVE_INFO
136         printk(KERN_DEBUG "%s: %s drive%d 0x%08x ",
137                 drive->name, ide_xfer_verbose(speed),
138                 drive->dn, drive_conf);
139         pci_read_config_dword(dev, drive_pci, &drive_conf);
140         printk("0x%08x\n", drive_conf);
141 #endif
142
143         return ide_config_drive_speed(drive, speed);
144 }
145
146 static void pdc202xx_tune_drive(ide_drive_t *drive, u8 pio)
147 {
148         pio = ide_get_best_pio_mode(drive, pio, 4, NULL);
149         pdc202xx_tune_chipset(drive, XFER_PIO_0 + pio);
150 }
151
152 static u8 pdc202xx_old_cable_detect (ide_hwif_t *hwif)
153 {
154         u16 CIS = 0, mask = (hwif->channel) ? (1<<11) : (1<<10);
155         pci_read_config_word(hwif->pci_dev, 0x50, &CIS);
156         return (CIS & mask) ? 1 : 0;
157 }
158
159 /*
160  * Set the control register to use the 66MHz system
161  * clock for UDMA 3/4/5 mode operation when necessary.
162  *
163  * FIXME: this register is shared by both channels, some locking is needed
164  *
165  * It may also be possible to leave the 66MHz clock on
166  * and readjust the timing parameters.
167  */
168 static void pdc_old_enable_66MHz_clock(ide_hwif_t *hwif)
169 {
170         unsigned long clock_reg = hwif->dma_master + 0x11;
171         u8 clock = inb(clock_reg);
172
173         outb(clock | (hwif->channel ? 0x08 : 0x02), clock_reg);
174 }
175
176 static void pdc_old_disable_66MHz_clock(ide_hwif_t *hwif)
177 {
178         unsigned long clock_reg = hwif->dma_master + 0x11;
179         u8 clock = inb(clock_reg);
180
181         outb(clock & ~(hwif->channel ? 0x08 : 0x02), clock_reg);
182 }
183
184 static int pdc202xx_config_drive_xfer_rate (ide_drive_t *drive)
185 {
186         drive->init_speed = 0;
187
188         if (ide_tune_dma(drive))
189                 return 0;
190
191         if (ide_use_fast_pio(drive))
192                 pdc202xx_tune_drive(drive, 255);
193
194         return -1;
195 }
196
197 static int pdc202xx_quirkproc (ide_drive_t *drive)
198 {
199         const char **list, *model = drive->id->model;
200
201         for (list = pdc_quirk_drives; *list != NULL; list++)
202                 if (strstr(model, *list) != NULL)
203                         return 2;
204         return 0;
205 }
206
207 static void pdc202xx_old_ide_dma_start(ide_drive_t *drive)
208 {
209         if (drive->current_speed > XFER_UDMA_2)
210                 pdc_old_enable_66MHz_clock(drive->hwif);
211         if (drive->media != ide_disk || drive->addressing == 1) {
212                 struct request *rq      = HWGROUP(drive)->rq;
213                 ide_hwif_t *hwif        = HWIF(drive);
214                 unsigned long high_16   = hwif->dma_master;
215                 unsigned long atapi_reg = high_16 + (hwif->channel ? 0x24 : 0x20);
216                 u32 word_count  = 0;
217                 u8 clock = inb(high_16 + 0x11);
218
219                 outb(clock | (hwif->channel ? 0x08 : 0x02), high_16 + 0x11);
220                 word_count = (rq->nr_sectors << 8);
221                 word_count = (rq_data_dir(rq) == READ) ?
222                                         word_count | 0x05000000 :
223                                         word_count | 0x06000000;
224                 outl(word_count, atapi_reg);
225         }
226         ide_dma_start(drive);
227 }
228
229 static int pdc202xx_old_ide_dma_end(ide_drive_t *drive)
230 {
231         if (drive->media != ide_disk || drive->addressing == 1) {
232                 ide_hwif_t *hwif        = HWIF(drive);
233                 unsigned long high_16   = hwif->dma_master;
234                 unsigned long atapi_reg = high_16 + (hwif->channel ? 0x24 : 0x20);
235                 u8 clock                = 0;
236
237                 outl(0, atapi_reg); /* zero out extra */
238                 clock = inb(high_16 + 0x11);
239                 outb(clock & ~(hwif->channel ? 0x08:0x02), high_16 + 0x11);
240         }
241         if (drive->current_speed > XFER_UDMA_2)
242                 pdc_old_disable_66MHz_clock(drive->hwif);
243         return __ide_dma_end(drive);
244 }
245
246 static int pdc202xx_old_ide_dma_test_irq(ide_drive_t *drive)
247 {
248         ide_hwif_t *hwif        = HWIF(drive);
249         unsigned long high_16   = hwif->dma_master;
250         u8 dma_stat             = inb(hwif->dma_status);
251         u8 sc1d                 = inb(high_16 + 0x001d);
252
253         if (hwif->channel) {
254                 /* bit7: Error, bit6: Interrupting, bit5: FIFO Full, bit4: FIFO Empty */
255                 if ((sc1d & 0x50) == 0x50)
256                         goto somebody_else;
257                 else if ((sc1d & 0x40) == 0x40)
258                         return (dma_stat & 4) == 4;
259         } else {
260                 /* bit3: Error, bit2: Interrupting, bit1: FIFO Full, bit0: FIFO Empty */
261                 if ((sc1d & 0x05) == 0x05)
262                         goto somebody_else;
263                 else if ((sc1d & 0x04) == 0x04)
264                         return (dma_stat & 4) == 4;
265         }
266 somebody_else:
267         return (dma_stat & 4) == 4;     /* return 1 if INTR asserted */
268 }
269
270 static void pdc202xx_dma_lost_irq(ide_drive_t *drive)
271 {
272         ide_hwif_t *hwif = HWIF(drive);
273
274         if (hwif->resetproc != NULL)
275                 hwif->resetproc(drive);
276
277         ide_dma_lost_irq(drive);
278 }
279
280 static void pdc202xx_dma_timeout(ide_drive_t *drive)
281 {
282         ide_hwif_t *hwif = HWIF(drive);
283
284         if (hwif->resetproc != NULL)
285                 hwif->resetproc(drive);
286
287         ide_dma_timeout(drive);
288 }
289
290 static void pdc202xx_reset_host (ide_hwif_t *hwif)
291 {
292         unsigned long high_16   = hwif->dma_master;
293         u8 udma_speed_flag      = inb(high_16 | 0x001f);
294
295         outb(udma_speed_flag | 0x10, high_16 | 0x001f);
296         mdelay(100);
297         outb(udma_speed_flag & ~0x10, high_16 | 0x001f);
298         mdelay(2000);   /* 2 seconds ?! */
299
300         printk(KERN_WARNING "PDC202XX: %s channel reset.\n",
301                 hwif->channel ? "Secondary" : "Primary");
302 }
303
304 static void pdc202xx_reset (ide_drive_t *drive)
305 {
306         ide_hwif_t *hwif        = HWIF(drive);
307         ide_hwif_t *mate        = hwif->mate;
308         
309         pdc202xx_reset_host(hwif);
310         pdc202xx_reset_host(mate);
311         pdc202xx_tune_drive(drive, 255);
312 }
313
314 static unsigned int __devinit init_chipset_pdc202xx(struct pci_dev *dev,
315                                                         const char *name)
316 {
317         /* This doesn't appear needed */
318         if (dev->resource[PCI_ROM_RESOURCE].start) {
319                 pci_write_config_dword(dev, PCI_ROM_ADDRESS,
320                         dev->resource[PCI_ROM_RESOURCE].start | PCI_ROM_ADDRESS_ENABLE);
321                 printk(KERN_INFO "%s: ROM enabled at 0x%08lx\n", name,
322                         (unsigned long)dev->resource[PCI_ROM_RESOURCE].start);
323         }
324
325         return dev->irq;
326 }
327
328 static void __devinit init_hwif_pdc202xx(ide_hwif_t *hwif)
329 {
330         struct pci_dev *dev = hwif->pci_dev;
331
332         /* PDC20265 has problems with large LBA48 requests */
333         if ((dev->device == PCI_DEVICE_ID_PROMISE_20267) ||
334             (dev->device == PCI_DEVICE_ID_PROMISE_20265))
335                 hwif->rqsize = 256;
336
337         hwif->autodma = 0;
338         hwif->tuneproc  = &pdc202xx_tune_drive;
339         hwif->quirkproc = &pdc202xx_quirkproc;
340
341         if (hwif->pci_dev->device != PCI_DEVICE_ID_PROMISE_20246)
342                 hwif->resetproc = &pdc202xx_reset;
343
344         hwif->speedproc = &pdc202xx_tune_chipset;
345
346         hwif->drives[0].autotune = hwif->drives[1].autotune = 1;
347
348         hwif->ultra_mask = hwif->cds->udma_mask;
349         hwif->mwdma_mask = 0x07;
350         hwif->swdma_mask = 0x07;
351         hwif->atapi_dma = 1;
352
353         hwif->err_stops_fifo = 1;
354
355         hwif->ide_dma_check = &pdc202xx_config_drive_xfer_rate;
356         hwif->dma_lost_irq = &pdc202xx_dma_lost_irq;
357         hwif->dma_timeout = &pdc202xx_dma_timeout;
358
359         if (hwif->pci_dev->device != PCI_DEVICE_ID_PROMISE_20246) {
360                 if (!(hwif->udma_four))
361                         hwif->udma_four = (pdc202xx_old_cable_detect(hwif)) ? 0 : 1;
362                 hwif->dma_start = &pdc202xx_old_ide_dma_start;
363                 hwif->ide_dma_end = &pdc202xx_old_ide_dma_end;
364         } 
365         hwif->ide_dma_test_irq = &pdc202xx_old_ide_dma_test_irq;
366
367         if (!noautodma)
368                 hwif->autodma = 1;
369         hwif->drives[0].autodma = hwif->drives[1].autodma = hwif->autodma;
370 }
371
372 static void __devinit init_dma_pdc202xx(ide_hwif_t *hwif, unsigned long dmabase)
373 {
374         u8 udma_speed_flag = 0, primary_mode = 0, secondary_mode = 0;
375
376         if (hwif->channel) {
377                 ide_setup_dma(hwif, dmabase, 8);
378                 return;
379         }
380
381         udma_speed_flag = inb(dmabase | 0x1f);
382         primary_mode    = inb(dmabase | 0x1a);
383         secondary_mode  = inb(dmabase | 0x1b);
384         printk(KERN_INFO "%s: (U)DMA Burst Bit %sABLED " \
385                 "Primary %s Mode " \
386                 "Secondary %s Mode.\n", hwif->cds->name,
387                 (udma_speed_flag & 1) ? "EN" : "DIS",
388                 (primary_mode & 1) ? "MASTER" : "PCI",
389                 (secondary_mode & 1) ? "MASTER" : "PCI" );
390
391 #ifdef CONFIG_PDC202XX_BURST
392         if (!(udma_speed_flag & 1)) {
393                 printk(KERN_INFO "%s: FORCING BURST BIT 0x%02x->0x%02x ",
394                         hwif->cds->name, udma_speed_flag,
395                         (udma_speed_flag|1));
396                 outb(udma_speed_flag | 1, dmabase | 0x1f);
397                 printk("%sACTIVE\n", (inb(dmabase | 0x1f) & 1) ? "" : "IN");
398         }
399 #endif /* CONFIG_PDC202XX_BURST */
400
401         ide_setup_dma(hwif, dmabase, 8);
402 }
403
404 static int __devinit init_setup_pdc202ata4(struct pci_dev *dev,
405                                            ide_pci_device_t *d)
406 {
407         if ((dev->class >> 8) != PCI_CLASS_STORAGE_IDE) {
408                 u8 irq = 0, irq2 = 0;
409                 pci_read_config_byte(dev, PCI_INTERRUPT_LINE, &irq);
410                 /* 0xbc */
411                 pci_read_config_byte(dev, (PCI_INTERRUPT_LINE)|0x80, &irq2);
412                 if (irq != irq2) {
413                         pci_write_config_byte(dev,
414                                 (PCI_INTERRUPT_LINE)|0x80, irq);     /* 0xbc */
415                         printk(KERN_INFO "%s: pci-config space interrupt "
416                                 "mirror fixed.\n", d->name);
417                 }
418         }
419         return ide_setup_pci_device(dev, d);
420 }
421
422 static int __devinit init_setup_pdc20265(struct pci_dev *dev,
423                                          ide_pci_device_t *d)
424 {
425         if ((dev->bus->self) &&
426             (dev->bus->self->vendor == PCI_VENDOR_ID_INTEL) &&
427             ((dev->bus->self->device == PCI_DEVICE_ID_INTEL_I960) ||
428              (dev->bus->self->device == PCI_DEVICE_ID_INTEL_I960RM))) {
429                 printk(KERN_INFO "ide: Skipping Promise PDC20265 "
430                         "attached to I2O RAID controller.\n");
431                 return -ENODEV;
432         }
433         return ide_setup_pci_device(dev, d);
434 }
435
436 static int __devinit init_setup_pdc202xx(struct pci_dev *dev,
437                                          ide_pci_device_t *d)
438 {
439         return ide_setup_pci_device(dev, d);
440 }
441
442 static ide_pci_device_t pdc202xx_chipsets[] __devinitdata = {
443         {       /* 0 */
444                 .name           = "PDC20246",
445                 .init_setup     = init_setup_pdc202ata4,
446                 .init_chipset   = init_chipset_pdc202xx,
447                 .init_hwif      = init_hwif_pdc202xx,
448                 .init_dma       = init_dma_pdc202xx,
449                 .channels       = 2,
450                 .autodma        = AUTODMA,
451                 .bootable       = OFF_BOARD,
452                 .extra          = 16,
453                 .udma_mask      = 0x07, /* udma0-2 */
454         },{     /* 1 */
455                 .name           = "PDC20262",
456                 .init_setup     = init_setup_pdc202ata4,
457                 .init_chipset   = init_chipset_pdc202xx,
458                 .init_hwif      = init_hwif_pdc202xx,
459                 .init_dma       = init_dma_pdc202xx,
460                 .channels       = 2,
461                 .autodma        = AUTODMA,
462                 .bootable       = OFF_BOARD,
463                 .extra          = 48,
464                 .udma_mask      = 0x1f, /* udma0-4 */
465         },{     /* 2 */
466                 .name           = "PDC20263",
467                 .init_setup     = init_setup_pdc202ata4,
468                 .init_chipset   = init_chipset_pdc202xx,
469                 .init_hwif      = init_hwif_pdc202xx,
470                 .init_dma       = init_dma_pdc202xx,
471                 .channels       = 2,
472                 .autodma        = AUTODMA,
473                 .bootable       = OFF_BOARD,
474                 .extra          = 48,
475                 .udma_mask      = 0x1f, /* udma0-4 */
476         },{     /* 3 */
477                 .name           = "PDC20265",
478                 .init_setup     = init_setup_pdc20265,
479                 .init_chipset   = init_chipset_pdc202xx,
480                 .init_hwif      = init_hwif_pdc202xx,
481                 .init_dma       = init_dma_pdc202xx,
482                 .channels       = 2,
483                 .autodma        = AUTODMA,
484                 .bootable       = OFF_BOARD,
485                 .extra          = 48,
486                 .udma_mask      = 0x3f, /* udma0-5 */
487         },{     /* 4 */
488                 .name           = "PDC20267",
489                 .init_setup     = init_setup_pdc202xx,
490                 .init_chipset   = init_chipset_pdc202xx,
491                 .init_hwif      = init_hwif_pdc202xx,
492                 .init_dma       = init_dma_pdc202xx,
493                 .channels       = 2,
494                 .autodma        = AUTODMA,
495                 .bootable       = OFF_BOARD,
496                 .extra          = 48,
497                 .udma_mask      = 0x3f, /* udma0-5 */
498         }
499 };
500
501 /**
502  *      pdc202xx_init_one       -       called when a PDC202xx is found
503  *      @dev: the pdc202xx device
504  *      @id: the matching pci id
505  *
506  *      Called when the PCI registration layer (or the IDE initialization)
507  *      finds a device matching our IDE device tables.
508  */
509  
510 static int __devinit pdc202xx_init_one(struct pci_dev *dev, const struct pci_device_id *id)
511 {
512         ide_pci_device_t *d = &pdc202xx_chipsets[id->driver_data];
513
514         return d->init_setup(dev, d);
515 }
516
517 static struct pci_device_id pdc202xx_pci_tbl[] = {
518         { PCI_VENDOR_ID_PROMISE, PCI_DEVICE_ID_PROMISE_20246, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
519         { PCI_VENDOR_ID_PROMISE, PCI_DEVICE_ID_PROMISE_20262, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 1},
520         { PCI_VENDOR_ID_PROMISE, PCI_DEVICE_ID_PROMISE_20263, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 2},
521         { PCI_VENDOR_ID_PROMISE, PCI_DEVICE_ID_PROMISE_20265, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 3},
522         { PCI_VENDOR_ID_PROMISE, PCI_DEVICE_ID_PROMISE_20267, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 4},
523         { 0, },
524 };
525 MODULE_DEVICE_TABLE(pci, pdc202xx_pci_tbl);
526
527 static struct pci_driver driver = {
528         .name           = "Promise_Old_IDE",
529         .id_table       = pdc202xx_pci_tbl,
530         .probe          = pdc202xx_init_one,
531 };
532
533 static int __init pdc202xx_ide_init(void)
534 {
535         return ide_pci_register_driver(&driver);
536 }
537
538 module_init(pdc202xx_ide_init);
539
540 MODULE_AUTHOR("Andre Hedrick, Frank Tiernan");
541 MODULE_DESCRIPTION("PCI driver module for older Promise IDE");
542 MODULE_LICENSE("GPL");