ide: make void and rename ide_dma_lostirq() method
[linux-2.6] / drivers / ide / pci / sl82c105.c
1 /*
2  * linux/drivers/ide/pci/sl82c105.c
3  *
4  * SL82C105/Winbond 553 IDE driver
5  *
6  * Maintainer unknown.
7  *
8  * Drive tuning added from Rebel.com's kernel sources
9  *  -- Russell King (15/11/98) linux@arm.linux.org.uk
10  * 
11  * Merge in Russell's HW workarounds, fix various problems
12  * with the timing registers setup.
13  *  -- Benjamin Herrenschmidt (01/11/03) benh@kernel.crashing.org
14  *
15  * Copyright (C) 2006-2007 MontaVista Software, Inc. <source@mvista.com>
16  */
17
18 #include <linux/types.h>
19 #include <linux/module.h>
20 #include <linux/kernel.h>
21 #include <linux/timer.h>
22 #include <linux/mm.h>
23 #include <linux/ioport.h>
24 #include <linux/interrupt.h>
25 #include <linux/blkdev.h>
26 #include <linux/hdreg.h>
27 #include <linux/pci.h>
28 #include <linux/ide.h>
29
30 #include <asm/io.h>
31 #include <asm/dma.h>
32
33 #undef DEBUG
34
35 #ifdef DEBUG
36 #define DBG(arg) printk arg
37 #else
38 #define DBG(fmt,...)
39 #endif
40 /*
41  * SL82C105 PCI config register 0x40 bits.
42  */
43 #define CTRL_IDE_IRQB   (1 << 30)
44 #define CTRL_IDE_IRQA   (1 << 28)
45 #define CTRL_LEGIRQ     (1 << 11)
46 #define CTRL_P1F16      (1 << 5)
47 #define CTRL_P1EN       (1 << 4)
48 #define CTRL_P0F16      (1 << 1)
49 #define CTRL_P0EN       (1 << 0)
50
51 /*
52  * Convert a PIO mode and cycle time to the required on/off times
53  * for the interface.  This has protection against runaway timings.
54  */
55 static unsigned int get_pio_timings(ide_pio_data_t *p)
56 {
57         unsigned int cmd_on, cmd_off;
58
59         cmd_on  = (ide_pio_timings[p->pio_mode].active_time + 29) / 30;
60         cmd_off = (p->cycle_time - 30 * cmd_on + 29) / 30;
61
62         if (cmd_on == 0)
63                 cmd_on = 1;
64
65         if (cmd_off == 0)
66                 cmd_off = 1;
67
68         return (cmd_on - 1) << 8 | (cmd_off - 1) | (p->use_iordy ? 0x40 : 0x00);
69 }
70
71 /*
72  * Configure the chipset for PIO mode.
73  */
74 static u8 sl82c105_tune_pio(ide_drive_t *drive, u8 pio)
75 {
76         struct pci_dev *dev     = HWIF(drive)->pci_dev;
77         int reg                 = 0x44 + drive->dn * 4;
78         ide_pio_data_t p;
79         u16 drv_ctrl;
80
81         DBG(("sl82c105_tune_pio(drive:%s, pio:%u)\n", drive->name, pio));
82
83         pio = ide_get_best_pio_mode(drive, pio, 5, &p);
84
85         drv_ctrl = get_pio_timings(&p);
86
87         /*
88          * Store the PIO timings so that we can restore them
89          * in case DMA will be turned off...
90          */
91         drive->drive_data &= 0xffff0000;
92         drive->drive_data |= drv_ctrl;
93
94         if (!drive->using_dma) {
95                 /*
96                  * If we are actually using MW DMA, then we can not
97                  * reprogram the interface drive control register.
98                  */
99                 pci_write_config_word(dev, reg,  drv_ctrl);
100                 pci_read_config_word (dev, reg, &drv_ctrl);
101         }
102
103         printk(KERN_DEBUG "%s: selected %s (%dns) (%04X)\n", drive->name,
104                ide_xfer_verbose(pio + XFER_PIO_0), p.cycle_time, drv_ctrl);
105
106         return pio;
107 }
108
109 /*
110  * Configure the drive and chipset for a new transfer speed.
111  */
112 static int sl82c105_tune_chipset(ide_drive_t *drive, u8 speed)
113 {
114         static u16 mwdma_timings[] = {0x0707, 0x0201, 0x0200};
115         u16 drv_ctrl;
116
117         DBG(("sl82c105_tune_chipset(drive:%s, speed:%s)\n",
118              drive->name, ide_xfer_verbose(speed)));
119
120         speed = ide_rate_filter(drive, speed);
121
122         switch (speed) {
123         case XFER_MW_DMA_2:
124         case XFER_MW_DMA_1:
125         case XFER_MW_DMA_0:
126                 drv_ctrl = mwdma_timings[speed - XFER_MW_DMA_0];
127
128                 /*
129                  * Store the DMA timings so that we can actually program
130                  * them when DMA will be turned on...
131                  */
132                 drive->drive_data &= 0x0000ffff;
133                 drive->drive_data |= (unsigned long)drv_ctrl << 16;
134
135                 /*
136                  * If we are already using DMA, we just reprogram
137                  * the drive control register.
138                  */
139                 if (drive->using_dma) {
140                         struct pci_dev *dev     = HWIF(drive)->pci_dev;
141                         int reg                 = 0x44 + drive->dn * 4;
142
143                         pci_write_config_word(dev, reg, drv_ctrl);
144                 }
145                 break;
146         case XFER_PIO_5:
147         case XFER_PIO_4:
148         case XFER_PIO_3:
149         case XFER_PIO_2:
150         case XFER_PIO_1:
151         case XFER_PIO_0:
152                 (void) sl82c105_tune_pio(drive, speed - XFER_PIO_0);
153                 break;
154         default:
155                 return -1;
156         }
157
158         return ide_config_drive_speed(drive, speed);
159 }
160
161 /*
162  * Check to see if the drive and chipset are capable of DMA mode.
163  */
164 static int sl82c105_ide_dma_check(ide_drive_t *drive)
165 {
166         DBG(("sl82c105_ide_dma_check(drive:%s)\n", drive->name));
167
168         if (ide_tune_dma(drive))
169                 return 0;
170
171         return -1;
172 }
173
174 /*
175  * The SL82C105 holds off all IDE interrupts while in DMA mode until
176  * all DMA activity is completed.  Sometimes this causes problems (eg,
177  * when the drive wants to report an error condition).
178  *
179  * 0x7e is a "chip testing" register.  Bit 2 resets the DMA controller
180  * state machine.  We need to kick this to work around various bugs.
181  */
182 static inline void sl82c105_reset_host(struct pci_dev *dev)
183 {
184         u16 val;
185
186         pci_read_config_word(dev, 0x7e, &val);
187         pci_write_config_word(dev, 0x7e, val | (1 << 2));
188         pci_write_config_word(dev, 0x7e, val & ~(1 << 2));
189 }
190
191 /*
192  * If we get an IRQ timeout, it might be that the DMA state machine
193  * got confused.  Fix from Todd Inglett.  Details from Winbond.
194  *
195  * This function is called when the IDE timer expires, the drive
196  * indicates that it is READY, and we were waiting for DMA to complete.
197  */
198 static void sl82c105_dma_lost_irq(ide_drive_t *drive)
199 {
200         ide_hwif_t *hwif        = HWIF(drive);
201         struct pci_dev *dev     = hwif->pci_dev;
202         u32 val, mask           = hwif->channel ? CTRL_IDE_IRQB : CTRL_IDE_IRQA;
203         u8 dma_cmd;
204
205         printk("sl82c105: lost IRQ, resetting host\n");
206
207         /*
208          * Check the raw interrupt from the drive.
209          */
210         pci_read_config_dword(dev, 0x40, &val);
211         if (val & mask)
212                 printk("sl82c105: drive was requesting IRQ, but host lost it\n");
213
214         /*
215          * Was DMA enabled?  If so, disable it - we're resetting the
216          * host.  The IDE layer will be handling the drive for us.
217          */
218         dma_cmd = inb(hwif->dma_command);
219         if (dma_cmd & 1) {
220                 outb(dma_cmd & ~1, hwif->dma_command);
221                 printk("sl82c105: DMA was enabled\n");
222         }
223
224         sl82c105_reset_host(dev);
225 }
226
227 /*
228  * ATAPI devices can cause the SL82C105 DMA state machine to go gaga.
229  * Winbond recommend that the DMA state machine is reset prior to
230  * setting the bus master DMA enable bit.
231  *
232  * The generic IDE core will have disabled the BMEN bit before this
233  * function is called.
234  */
235 static void sl82c105_dma_start(ide_drive_t *drive)
236 {
237         ide_hwif_t *hwif        = HWIF(drive);
238         struct pci_dev *dev     = hwif->pci_dev;
239
240         sl82c105_reset_host(dev);
241         ide_dma_start(drive);
242 }
243
244 static int sl82c105_ide_dma_timeout(ide_drive_t *drive)
245 {
246         ide_hwif_t *hwif        = HWIF(drive);
247         struct pci_dev *dev     = hwif->pci_dev;
248
249         DBG(("sl82c105_ide_dma_timeout(drive:%s)\n", drive->name));
250
251         sl82c105_reset_host(dev);
252         return __ide_dma_timeout(drive);
253 }
254
255 static int sl82c105_ide_dma_on(ide_drive_t *drive)
256 {
257         struct pci_dev *dev     = HWIF(drive)->pci_dev;
258         int rc, reg             = 0x44 + drive->dn * 4;
259
260         DBG(("sl82c105_ide_dma_on(drive:%s)\n", drive->name));
261
262         rc = __ide_dma_on(drive);
263         if (rc == 0) {
264                 pci_write_config_word(dev, reg, drive->drive_data >> 16);
265
266                 printk(KERN_INFO "%s: DMA enabled\n", drive->name);
267         }
268         return rc;
269 }
270
271 static void sl82c105_dma_off_quietly(ide_drive_t *drive)
272 {
273         struct pci_dev *dev     = HWIF(drive)->pci_dev;
274         int reg                 = 0x44 + drive->dn * 4;
275
276         DBG(("sl82c105_dma_off_quietly(drive:%s)\n", drive->name));
277
278         pci_write_config_word(dev, reg, drive->drive_data);
279
280         ide_dma_off_quietly(drive);
281 }
282
283 /*
284  * Ok, that is nasty, but we must make sure the DMA timings
285  * won't be used for a PIO access. The solution here is
286  * to make sure the 16 bits mode is diabled on the channel
287  * when DMA is enabled, thus causing the chip to use PIO0
288  * timings for those operations.
289  */
290 static void sl82c105_selectproc(ide_drive_t *drive)
291 {
292         ide_hwif_t *hwif        = HWIF(drive);
293         struct pci_dev *dev     = hwif->pci_dev;
294         u32 val, old, mask;
295
296         //DBG(("sl82c105_selectproc(drive:%s)\n", drive->name));
297
298         mask = hwif->channel ? CTRL_P1F16 : CTRL_P0F16;
299         old = val = (u32)pci_get_drvdata(dev);
300         if (drive->using_dma)
301                 val &= ~mask;
302         else
303                 val |= mask;
304         if (old != val) {
305                 pci_write_config_dword(dev, 0x40, val); 
306                 pci_set_drvdata(dev, (void *)val);
307         }
308 }
309
310 /*
311  * ATA reset will clear the 16 bits mode in the control
312  * register, we need to update our cache
313  */
314 static void sl82c105_resetproc(ide_drive_t *drive)
315 {
316         struct pci_dev *dev = HWIF(drive)->pci_dev;
317         u32 val;
318
319         DBG(("sl82c105_resetproc(drive:%s)\n", drive->name));
320
321         pci_read_config_dword(dev, 0x40, &val);
322         pci_set_drvdata(dev, (void *)val);
323 }
324         
325 /*
326  * We only deal with PIO mode here - DMA mode 'using_dma' is not
327  * initialised at the point that this function is called.
328  */
329 static void sl82c105_tune_drive(ide_drive_t *drive, u8 pio)
330 {
331         DBG(("sl82c105_tune_drive(drive:%s, pio:%u)\n", drive->name, pio));
332
333         pio = sl82c105_tune_pio(drive, pio);
334         (void) ide_config_drive_speed(drive, XFER_PIO_0 + pio);
335 }
336
337 /*
338  * Return the revision of the Winbond bridge
339  * which this function is part of.
340  */
341 static unsigned int sl82c105_bridge_revision(struct pci_dev *dev)
342 {
343         struct pci_dev *bridge;
344         u8 rev;
345
346         /*
347          * The bridge should be part of the same device, but function 0.
348          */
349         bridge = pci_get_bus_and_slot(dev->bus->number,
350                                PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
351         if (!bridge)
352                 return -1;
353
354         /*
355          * Make sure it is a Winbond 553 and is an ISA bridge.
356          */
357         if (bridge->vendor != PCI_VENDOR_ID_WINBOND ||
358             bridge->device != PCI_DEVICE_ID_WINBOND_83C553 ||
359             bridge->class >> 8 != PCI_CLASS_BRIDGE_ISA) {
360                 pci_dev_put(bridge);
361                 return -1;
362         }
363         /*
364          * We need to find function 0's revision, not function 1
365          */
366         pci_read_config_byte(bridge, PCI_REVISION_ID, &rev);
367         pci_dev_put(bridge);
368
369         return rev;
370 }
371
372 /*
373  * Enable the PCI device
374  * 
375  * --BenH: It's arch fixup code that should enable channels that
376  * have not been enabled by firmware. I decided we can still enable
377  * channel 0 here at least, but channel 1 has to be enabled by
378  * firmware or arch code. We still set both to 16 bits mode.
379  */
380 static unsigned int __devinit init_chipset_sl82c105(struct pci_dev *dev, const char *msg)
381 {
382         u32 val;
383
384         DBG(("init_chipset_sl82c105()\n"));
385
386         pci_read_config_dword(dev, 0x40, &val);
387         val |= CTRL_P0EN | CTRL_P0F16 | CTRL_P1F16;
388         pci_write_config_dword(dev, 0x40, val);
389         pci_set_drvdata(dev, (void *)val);
390
391         return dev->irq;
392 }
393
394 /*
395  * Initialise IDE channel
396  */
397 static void __devinit init_hwif_sl82c105(ide_hwif_t *hwif)
398 {
399         unsigned int rev;
400
401         DBG(("init_hwif_sl82c105(hwif: ide%d)\n", hwif->index));
402
403         hwif->tuneproc          = &sl82c105_tune_drive;
404         hwif->speedproc         = &sl82c105_tune_chipset;
405         hwif->selectproc        = &sl82c105_selectproc;
406         hwif->resetproc         = &sl82c105_resetproc;
407
408         /*
409          * We support 32-bit I/O on this interface, and
410          * it doesn't have problems with interrupts.
411          */
412         hwif->drives[0].io_32bit = hwif->drives[1].io_32bit = 1;
413         hwif->drives[0].unmask   = hwif->drives[1].unmask   = 1;
414
415         /*
416          * We always autotune PIO,  this is done before DMA is checked,
417          * so there's no risk of accidentally disabling DMA
418          */
419         hwif->drives[0].autotune = hwif->drives[1].autotune = 1;
420
421         if (!hwif->dma_base)
422                 return;
423
424         rev = sl82c105_bridge_revision(hwif->pci_dev);
425         if (rev <= 5) {
426                 /*
427                  * Never ever EVER under any circumstances enable
428                  * DMA when the bridge is this old.
429                  */
430                 printk("    %s: Winbond W83C553 bridge revision %d, "
431                        "BM-DMA disabled\n", hwif->name, rev);
432                 return;
433         }
434
435         hwif->atapi_dma  = 1;
436         hwif->mwdma_mask = 0x07;
437
438         hwif->ide_dma_check             = &sl82c105_ide_dma_check;
439         hwif->ide_dma_on                = &sl82c105_ide_dma_on;
440         hwif->dma_off_quietly           = &sl82c105_dma_off_quietly;
441         hwif->dma_lost_irq              = &sl82c105_dma_lost_irq;
442         hwif->dma_start                 = &sl82c105_dma_start;
443         hwif->ide_dma_timeout           = &sl82c105_ide_dma_timeout;
444
445         if (!noautodma)
446                 hwif->autodma = 1;
447         hwif->drives[0].autodma = hwif->drives[1].autodma = hwif->autodma;
448
449         if (hwif->mate)
450                 hwif->serialized = hwif->mate->serialized = 1;
451 }
452
453 static ide_pci_device_t sl82c105_chipset __devinitdata = {
454         .name           = "W82C105",
455         .init_chipset   = init_chipset_sl82c105,
456         .init_hwif      = init_hwif_sl82c105,
457         .channels       = 2,
458         .autodma        = NOAUTODMA,
459         .enablebits     = {{0x40,0x01,0x01}, {0x40,0x10,0x10}},
460         .bootable       = ON_BOARD,
461 };
462
463 static int __devinit sl82c105_init_one(struct pci_dev *dev, const struct pci_device_id *id)
464 {
465         return ide_setup_pci_device(dev, &sl82c105_chipset);
466 }
467
468 static struct pci_device_id sl82c105_pci_tbl[] = {
469         { PCI_DEVICE(PCI_VENDOR_ID_WINBOND, PCI_DEVICE_ID_WINBOND_82C105), 0},
470         { 0, },
471 };
472 MODULE_DEVICE_TABLE(pci, sl82c105_pci_tbl);
473
474 static struct pci_driver driver = {
475         .name           = "W82C105_IDE",
476         .id_table       = sl82c105_pci_tbl,
477         .probe          = sl82c105_init_one,
478 };
479
480 static int __init sl82c105_ide_init(void)
481 {
482         return ide_pci_register_driver(&driver);
483 }
484
485 module_init(sl82c105_ide_init);
486
487 MODULE_DESCRIPTION("PCI driver module for W82C105 IDE");
488 MODULE_LICENSE("GPL");