Merge ../linux-2.6
[linux-2.6] / drivers / ide / pci / tc86c001.c
1 /*
2  * Copyright (C) 2002 Toshiba Corporation
3  * Copyright (C) 2005-2006 MontaVista Software, Inc. <source@mvista.com>
4  *
5  * This file is licensed under the terms of the GNU General Public
6  * License version 2.  This program is licensed "as is" without any
7  * warranty of any kind, whether express or implied.
8  */
9
10 #include <linux/types.h>
11 #include <linux/pci.h>
12 #include <linux/ide.h>
13
14 static void tc86c001_set_mode(ide_drive_t *drive, const u8 speed)
15 {
16         ide_hwif_t *hwif        = HWIF(drive);
17         unsigned long scr_port  = hwif->config_data + (drive->dn ? 0x02 : 0x00);
18         u16 mode, scr           = inw(scr_port);
19
20         switch (speed) {
21         case XFER_UDMA_4:       mode = 0x00c0; break;
22         case XFER_UDMA_3:       mode = 0x00b0; break;
23         case XFER_UDMA_2:       mode = 0x00a0; break;
24         case XFER_UDMA_1:       mode = 0x0090; break;
25         case XFER_UDMA_0:       mode = 0x0080; break;
26         case XFER_MW_DMA_2:     mode = 0x0070; break;
27         case XFER_MW_DMA_1:     mode = 0x0060; break;
28         case XFER_MW_DMA_0:     mode = 0x0050; break;
29         case XFER_PIO_4:        mode = 0x0400; break;
30         case XFER_PIO_3:        mode = 0x0300; break;
31         case XFER_PIO_2:        mode = 0x0200; break;
32         case XFER_PIO_1:        mode = 0x0100; break;
33         case XFER_PIO_0:
34         default:                mode = 0x0000; break;
35         }
36
37         scr &= (speed < XFER_MW_DMA_0) ? 0xf8ff : 0xff0f;
38         scr |= mode;
39         outw(scr, scr_port);
40 }
41
42 static void tc86c001_set_pio_mode(ide_drive_t *drive, const u8 pio)
43 {
44         tc86c001_set_mode(drive, XFER_PIO_0 + pio);
45 }
46
47 /*
48  * HACKITY HACK
49  *
50  * This is a workaround for the limitation 5 of the TC86C001 IDE controller:
51  * if a DMA transfer terminates prematurely, the controller leaves the device's
52  * interrupt request (INTRQ) pending and does not generate a PCI interrupt (or
53  * set the interrupt bit in the DMA status register), thus no PCI interrupt
54  * will occur until a DMA transfer has been successfully completed.
55  *
56  * We work around this by initiating dummy, zero-length DMA transfer on
57  * a DMA timeout expiration. I found no better way to do this with the current
58  * IDE core than to temporarily replace a higher level driver's timer expiry
59  * handler with our own backing up to that handler in case our recovery fails.
60  */
61 static int tc86c001_timer_expiry(ide_drive_t *drive)
62 {
63         ide_hwif_t *hwif        = HWIF(drive);
64         ide_expiry_t *expiry    = ide_get_hwifdata(hwif);
65         ide_hwgroup_t *hwgroup  = HWGROUP(drive);
66         u8 dma_stat             = inb(hwif->dma_base + ATA_DMA_STATUS);
67
68         /* Restore a higher level driver's expiry handler first. */
69         hwgroup->expiry = expiry;
70
71         if ((dma_stat & 5) == 1) {      /* DMA active and no interrupt */
72                 unsigned long sc_base   = hwif->config_data;
73                 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
74                 u8 dma_cmd              = inb(hwif->dma_base + ATA_DMA_CMD);
75
76                 printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
77                        "attempting recovery...\n", drive->name);
78
79                 /* Stop DMA */
80                 outb(dma_cmd & ~0x01, hwif->dma_base + ATA_DMA_CMD);
81
82                 /* Setup the dummy DMA transfer */
83                 outw(0, sc_base + 0x0a);        /* Sector Count */
84                 outw(0, twcr_port);     /* Transfer Word Count 1 or 2 */
85
86                 /* Start the dummy DMA transfer */
87
88                 /* clear R_OR_WCTR for write */
89                 outb(0x00, hwif->dma_base + ATA_DMA_CMD);
90                 /* set START_STOPBM */
91                 outb(0x01, hwif->dma_base + ATA_DMA_CMD);
92
93                 /*
94                  * If an interrupt was pending, it should come thru shortly.
95                  * If not, a higher level driver's expiry handler should
96                  * eventually cause some kind of recovery from the DMA stall.
97                  */
98                 return WAIT_MIN_SLEEP;
99         }
100
101         /* Chain to the restored expiry handler if DMA wasn't active. */
102         if (likely(expiry != NULL))
103                 return expiry(drive);
104
105         /* If there was no handler, "emulate" that for ide_timer_expiry()... */
106         return -1;
107 }
108
109 static void tc86c001_dma_start(ide_drive_t *drive)
110 {
111         ide_hwif_t *hwif        = HWIF(drive);
112         ide_hwgroup_t *hwgroup  = HWGROUP(drive);
113         unsigned long sc_base   = hwif->config_data;
114         unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
115         unsigned long nsectors  = hwgroup->rq->nr_sectors;
116
117         /*
118          * We have to manually load the sector count and size into
119          * the appropriate system control registers for DMA to work
120          * with LBA48 and ATAPI devices...
121          */
122         outw(nsectors, sc_base + 0x0a); /* Sector Count */
123         outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */
124
125         /* Install our timeout expiry hook, saving the current handler... */
126         ide_set_hwifdata(hwif, hwgroup->expiry);
127         hwgroup->expiry = &tc86c001_timer_expiry;
128
129         ide_dma_start(drive);
130 }
131
132 static u8 __devinit tc86c001_cable_detect(ide_hwif_t *hwif)
133 {
134         struct pci_dev *dev = to_pci_dev(hwif->dev);
135         unsigned long sc_base = pci_resource_start(dev, 5);
136         u16 scr1 = inw(sc_base + 0x00);
137
138         /*
139          * System Control  1 Register bit 13 (PDIAGN):
140          * 0=80-pin cable, 1=40-pin cable
141          */
142         return (scr1 & 0x2000) ? ATA_CBL_PATA40 : ATA_CBL_PATA80;
143 }
144
145 static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
146 {
147         struct pci_dev *dev     = to_pci_dev(hwif->dev);
148         unsigned long sc_base   = pci_resource_start(dev, 5);
149         u16 scr1                = inw(sc_base + 0x00);
150
151         /* System Control 1 Register bit 15 (Soft Reset) set */
152         outw(scr1 |  0x8000, sc_base + 0x00);
153
154         /* System Control 1 Register bit 14 (FIFO Reset) set */
155         outw(scr1 |  0x4000, sc_base + 0x00);
156
157         /* System Control 1 Register: reset clear */
158         outw(scr1 & ~0xc000, sc_base + 0x00);
159
160         /* Store the system control register base for convenience... */
161         hwif->config_data = sc_base;
162
163         if (!hwif->dma_base)
164                 return;
165
166         /*
167          * Sector Count Control Register bits 0 and 1 set:
168          * software sets Sector Count Register for master and slave device
169          */
170         outw(0x0003, sc_base + 0x0c);
171
172         /* Sector Count Register limit */
173         hwif->rqsize     = 0xffff;
174 }
175
176 static unsigned int __devinit init_chipset_tc86c001(struct pci_dev *dev,
177                                                         const char *name)
178 {
179         int err = pci_request_region(dev, 5, name);
180
181         if (err)
182                 printk(KERN_ERR "%s: system control regs already in use", name);
183         return err;
184 }
185
186 static const struct ide_port_ops tc86c001_port_ops = {
187         .set_pio_mode           = tc86c001_set_pio_mode,
188         .set_dma_mode           = tc86c001_set_mode,
189         .cable_detect           = tc86c001_cable_detect,
190 };
191
192 static const struct ide_dma_ops tc86c001_dma_ops = {
193         .dma_host_set           = ide_dma_host_set,
194         .dma_setup              = ide_dma_setup,
195         .dma_exec_cmd           = ide_dma_exec_cmd,
196         .dma_start              = tc86c001_dma_start,
197         .dma_end                = __ide_dma_end,
198         .dma_test_irq           = ide_dma_test_irq,
199         .dma_lost_irq           = ide_dma_lost_irq,
200         .dma_timeout            = ide_dma_timeout,
201 };
202
203 static const struct ide_port_info tc86c001_chipset __devinitdata = {
204         .name           = "TC86C001",
205         .init_chipset   = init_chipset_tc86c001,
206         .init_hwif      = init_hwif_tc86c001,
207         .port_ops       = &tc86c001_port_ops,
208         .dma_ops        = &tc86c001_dma_ops,
209         .host_flags     = IDE_HFLAG_SINGLE | IDE_HFLAG_OFF_BOARD,
210         .pio_mask       = ATA_PIO4,
211         .mwdma_mask     = ATA_MWDMA2,
212         .udma_mask      = ATA_UDMA4,
213 };
214
215 static int __devinit tc86c001_init_one(struct pci_dev *dev,
216                                        const struct pci_device_id *id)
217 {
218         return ide_setup_pci_device(dev, &tc86c001_chipset);
219 }
220
221 static const struct pci_device_id tc86c001_pci_tbl[] = {
222         { PCI_VDEVICE(TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE), 0 },
223         { 0, }
224 };
225 MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);
226
227 static struct pci_driver driver = {
228         .name           = "TC86C001",
229         .id_table       = tc86c001_pci_tbl,
230         .probe          = tc86c001_init_one
231 };
232
233 static int __init tc86c001_ide_init(void)
234 {
235         return ide_pci_register_driver(&driver);
236 }
237 module_init(tc86c001_ide_init);
238
239 MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
240 MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
241 MODULE_LICENSE("GPL");