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