ide: add ->dma_clear method and remove ->dma_timeout one
[linux-3.10.git] / drivers / ide / sl82c105.c
1 /*
2  * SL82C105/Winbond 553 IDE driver
3  *
4  * Maintainer unknown.
5  *
6  * Drive tuning added from Rebel.com's kernel sources
7  *  -- Russell King (15/11/98) linux@arm.linux.org.uk
8  * 
9  * Merge in Russell's HW workarounds, fix various problems
10  * with the timing registers setup.
11  *  -- Benjamin Herrenschmidt (01/11/03) benh@kernel.crashing.org
12  *
13  * Copyright (C) 2006-2007 MontaVista Software, Inc. <source@mvista.com>
14  * Copyright (C)      2007 Bartlomiej Zolnierkiewicz
15  */
16
17 #include <linux/types.h>
18 #include <linux/module.h>
19 #include <linux/kernel.h>
20 #include <linux/pci.h>
21 #include <linux/ide.h>
22
23 #include <asm/io.h>
24
25 #define DRV_NAME "sl82c105"
26
27 #undef DEBUG
28
29 #ifdef DEBUG
30 #define DBG(arg) printk arg
31 #else
32 #define DBG(fmt,...)
33 #endif
34 /*
35  * SL82C105 PCI config register 0x40 bits.
36  */
37 #define CTRL_IDE_IRQB   (1 << 30)
38 #define CTRL_IDE_IRQA   (1 << 28)
39 #define CTRL_LEGIRQ     (1 << 11)
40 #define CTRL_P1F16      (1 << 5)
41 #define CTRL_P1EN       (1 << 4)
42 #define CTRL_P0F16      (1 << 1)
43 #define CTRL_P0EN       (1 << 0)
44
45 /*
46  * Convert a PIO mode and cycle time to the required on/off times
47  * for the interface.  This has protection against runaway timings.
48  */
49 static unsigned int get_pio_timings(ide_drive_t *drive, u8 pio)
50 {
51         struct ide_timing *t = ide_timing_find_mode(XFER_PIO_0 + pio);
52         unsigned int cmd_on, cmd_off;
53         u8 iordy = 0;
54
55         cmd_on  = (t->active + 29) / 30;
56         cmd_off = (ide_pio_cycle_time(drive, pio) - 30 * cmd_on + 29) / 30;
57
58         if (cmd_on == 0)
59                 cmd_on = 1;
60
61         if (cmd_off == 0)
62                 cmd_off = 1;
63
64         if (pio > 2 || ata_id_has_iordy(drive->id))
65                 iordy = 0x40;
66
67         return (cmd_on - 1) << 8 | (cmd_off - 1) | iordy;
68 }
69
70 /*
71  * Configure the chipset for PIO mode.
72  */
73 static void sl82c105_set_pio_mode(ide_drive_t *drive, const u8 pio)
74 {
75         struct pci_dev *dev     = to_pci_dev(drive->hwif->dev);
76         int reg                 = 0x44 + drive->dn * 4;
77         u16 drv_ctrl;
78
79         drv_ctrl = get_pio_timings(drive, pio);
80
81         /*
82          * Store the PIO timings so that we can restore them
83          * in case DMA will be turned off...
84          */
85         drive->drive_data &= 0xffff0000;
86         drive->drive_data |= drv_ctrl;
87
88         pci_write_config_word(dev, reg,  drv_ctrl);
89         pci_read_config_word (dev, reg, &drv_ctrl);
90
91         printk(KERN_DEBUG "%s: selected %s (%dns) (%04X)\n", drive->name,
92                           ide_xfer_verbose(pio + XFER_PIO_0),
93                           ide_pio_cycle_time(drive, pio), drv_ctrl);
94 }
95
96 /*
97  * Configure the chipset for DMA mode.
98  */
99 static void sl82c105_set_dma_mode(ide_drive_t *drive, const u8 speed)
100 {
101         static u16 mwdma_timings[] = {0x0707, 0x0201, 0x0200};
102         u16 drv_ctrl;
103
104         DBG(("sl82c105_tune_chipset(drive:%s, speed:%s)\n",
105              drive->name, ide_xfer_verbose(speed)));
106
107         drv_ctrl = mwdma_timings[speed - XFER_MW_DMA_0];
108
109         /*
110          * Store the DMA timings so that we can actually program
111          * them when DMA will be turned on...
112          */
113         drive->drive_data &= 0x0000ffff;
114         drive->drive_data |= (unsigned long)drv_ctrl << 16;
115 }
116
117 /*
118  * The SL82C105 holds off all IDE interrupts while in DMA mode until
119  * all DMA activity is completed.  Sometimes this causes problems (eg,
120  * when the drive wants to report an error condition).
121  *
122  * 0x7e is a "chip testing" register.  Bit 2 resets the DMA controller
123  * state machine.  We need to kick this to work around various bugs.
124  */
125 static inline void sl82c105_reset_host(struct pci_dev *dev)
126 {
127         u16 val;
128
129         pci_read_config_word(dev, 0x7e, &val);
130         pci_write_config_word(dev, 0x7e, val | (1 << 2));
131         pci_write_config_word(dev, 0x7e, val & ~(1 << 2));
132 }
133
134 /*
135  * If we get an IRQ timeout, it might be that the DMA state machine
136  * got confused.  Fix from Todd Inglett.  Details from Winbond.
137  *
138  * This function is called when the IDE timer expires, the drive
139  * indicates that it is READY, and we were waiting for DMA to complete.
140  */
141 static void sl82c105_dma_lost_irq(ide_drive_t *drive)
142 {
143         ide_hwif_t *hwif        = drive->hwif;
144         struct pci_dev *dev     = to_pci_dev(hwif->dev);
145         u32 val, mask           = hwif->channel ? CTRL_IDE_IRQB : CTRL_IDE_IRQA;
146         u8 dma_cmd;
147
148         printk("sl82c105: lost IRQ, resetting host\n");
149
150         /*
151          * Check the raw interrupt from the drive.
152          */
153         pci_read_config_dword(dev, 0x40, &val);
154         if (val & mask)
155                 printk("sl82c105: drive was requesting IRQ, but host lost it\n");
156
157         /*
158          * Was DMA enabled?  If so, disable it - we're resetting the
159          * host.  The IDE layer will be handling the drive for us.
160          */
161         dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
162         if (dma_cmd & 1) {
163                 outb(dma_cmd & ~1, hwif->dma_base + ATA_DMA_CMD);
164                 printk("sl82c105: DMA was enabled\n");
165         }
166
167         sl82c105_reset_host(dev);
168 }
169
170 /*
171  * ATAPI devices can cause the SL82C105 DMA state machine to go gaga.
172  * Winbond recommend that the DMA state machine is reset prior to
173  * setting the bus master DMA enable bit.
174  *
175  * The generic IDE core will have disabled the BMEN bit before this
176  * function is called.
177  */
178 static void sl82c105_dma_start(ide_drive_t *drive)
179 {
180         ide_hwif_t *hwif        = drive->hwif;
181         struct pci_dev *dev     = to_pci_dev(hwif->dev);
182         int reg                 = 0x44 + drive->dn * 4;
183
184         DBG(("%s(drive:%s)\n", __func__, drive->name));
185
186         pci_write_config_word(dev, reg, drive->drive_data >> 16);
187
188         sl82c105_reset_host(dev);
189         ide_dma_start(drive);
190 }
191
192 static void sl82c105_dma_clear(ide_drive_t *drive)
193 {
194         struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
195
196         DBG(("sl82c105_dma_clear(drive:%s)\n", drive->name));
197
198         sl82c105_reset_host(dev);
199 }
200
201 static int sl82c105_dma_end(ide_drive_t *drive)
202 {
203         struct pci_dev *dev     = to_pci_dev(drive->hwif->dev);
204         int reg                 = 0x44 + drive->dn * 4;
205         int ret;
206
207         DBG(("%s(drive:%s)\n", __func__, drive->name));
208
209         ret = ide_dma_end(drive);
210
211         pci_write_config_word(dev, reg, drive->drive_data);
212
213         return ret;
214 }
215
216 /*
217  * ATA reset will clear the 16 bits mode in the control
218  * register, we need to reprogram it
219  */
220 static void sl82c105_resetproc(ide_drive_t *drive)
221 {
222         struct pci_dev *dev = to_pci_dev(drive->hwif->dev);
223         u32 val;
224
225         DBG(("sl82c105_resetproc(drive:%s)\n", drive->name));
226
227         pci_read_config_dword(dev, 0x40, &val);
228         val |= (CTRL_P1F16 | CTRL_P0F16);
229         pci_write_config_dword(dev, 0x40, val);
230 }
231
232 /*
233  * Return the revision of the Winbond bridge
234  * which this function is part of.
235  */
236 static u8 sl82c105_bridge_revision(struct pci_dev *dev)
237 {
238         struct pci_dev *bridge;
239
240         /*
241          * The bridge should be part of the same device, but function 0.
242          */
243         bridge = pci_get_bus_and_slot(dev->bus->number,
244                                PCI_DEVFN(PCI_SLOT(dev->devfn), 0));
245         if (!bridge)
246                 return -1;
247
248         /*
249          * Make sure it is a Winbond 553 and is an ISA bridge.
250          */
251         if (bridge->vendor != PCI_VENDOR_ID_WINBOND ||
252             bridge->device != PCI_DEVICE_ID_WINBOND_83C553 ||
253             bridge->class >> 8 != PCI_CLASS_BRIDGE_ISA) {
254                 pci_dev_put(bridge);
255                 return -1;
256         }
257         /*
258          * We need to find function 0's revision, not function 1
259          */
260         pci_dev_put(bridge);
261
262         return bridge->revision;
263 }
264
265 /*
266  * Enable the PCI device
267  * 
268  * --BenH: It's arch fixup code that should enable channels that
269  * have not been enabled by firmware. I decided we can still enable
270  * channel 0 here at least, but channel 1 has to be enabled by
271  * firmware or arch code. We still set both to 16 bits mode.
272  */
273 static int init_chipset_sl82c105(struct pci_dev *dev)
274 {
275         u32 val;
276
277         DBG(("init_chipset_sl82c105()\n"));
278
279         pci_read_config_dword(dev, 0x40, &val);
280         val |= CTRL_P0EN | CTRL_P0F16 | CTRL_P1F16;
281         pci_write_config_dword(dev, 0x40, val);
282
283         return 0;
284 }
285
286 static const struct ide_port_ops sl82c105_port_ops = {
287         .set_pio_mode           = sl82c105_set_pio_mode,
288         .set_dma_mode           = sl82c105_set_dma_mode,
289         .resetproc              = sl82c105_resetproc,
290 };
291
292 static const struct ide_dma_ops sl82c105_dma_ops = {
293         .dma_host_set           = ide_dma_host_set,
294         .dma_setup              = ide_dma_setup,
295         .dma_start              = sl82c105_dma_start,
296         .dma_end                = sl82c105_dma_end,
297         .dma_test_irq           = ide_dma_test_irq,
298         .dma_lost_irq           = sl82c105_dma_lost_irq,
299         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
300         .dma_clear              = sl82c105_dma_clear,
301         .dma_sff_read_status    = ide_dma_sff_read_status,
302 };
303
304 static const struct ide_port_info sl82c105_chipset __devinitdata = {
305         .name           = DRV_NAME,
306         .init_chipset   = init_chipset_sl82c105,
307         .enablebits     = {{0x40,0x01,0x01}, {0x40,0x10,0x10}},
308         .port_ops       = &sl82c105_port_ops,
309         .dma_ops        = &sl82c105_dma_ops,
310         .host_flags     = IDE_HFLAG_IO_32BIT |
311                           IDE_HFLAG_UNMASK_IRQS |
312                           IDE_HFLAG_SERIALIZE_DMA |
313                           IDE_HFLAG_NO_AUTODMA,
314         .pio_mask       = ATA_PIO5,
315         .mwdma_mask     = ATA_MWDMA2,
316 };
317
318 static int __devinit sl82c105_init_one(struct pci_dev *dev, const struct pci_device_id *id)
319 {
320         struct ide_port_info d = sl82c105_chipset;
321         u8 rev = sl82c105_bridge_revision(dev);
322
323         if (rev <= 5) {
324                 /*
325                  * Never ever EVER under any circumstances enable
326                  * DMA when the bridge is this old.
327                  */
328                 printk(KERN_INFO DRV_NAME ": Winbond W83C553 bridge "
329                                  "revision %d, BM-DMA disabled\n", rev);
330                 d.dma_ops = NULL;
331                 d.mwdma_mask = 0;
332                 d.host_flags &= ~IDE_HFLAG_SERIALIZE_DMA;
333         }
334
335         return ide_pci_init_one(dev, &d, NULL);
336 }
337
338 static const struct pci_device_id sl82c105_pci_tbl[] = {
339         { PCI_VDEVICE(WINBOND, PCI_DEVICE_ID_WINBOND_82C105), 0 },
340         { 0, },
341 };
342 MODULE_DEVICE_TABLE(pci, sl82c105_pci_tbl);
343
344 static struct pci_driver sl82c105_pci_driver = {
345         .name           = "W82C105_IDE",
346         .id_table       = sl82c105_pci_tbl,
347         .probe          = sl82c105_init_one,
348         .remove         = ide_pci_remove,
349         .suspend        = ide_pci_suspend,
350         .resume         = ide_pci_resume,
351 };
352
353 static int __init sl82c105_ide_init(void)
354 {
355         return ide_pci_register_driver(&sl82c105_pci_driver);
356 }
357
358 static void __exit sl82c105_ide_exit(void)
359 {
360         pci_unregister_driver(&sl82c105_pci_driver);
361 }
362
363 module_init(sl82c105_ide_init);
364 module_exit(sl82c105_ide_exit);
365
366 MODULE_DESCRIPTION("PCI driver module for W82C105 IDE");
367 MODULE_LICENSE("GPL");