blob: 93e2cce4b296f5a55c50f32d5f0a4fe9f9133ff5 [file] [log] [blame]
Sergei Shtylyov33dced22007-02-07 18:18:45 +01001/*
Sergei Shtylyov33dced22007-02-07 18:18:45 +01002 * 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
Bartlomiej Zolnierkiewiczced3ec82008-07-24 22:53:32 +020014#define DRV_NAME "tc86c001"
Bartlomiej Zolnierkiewiczb16040b2008-07-24 22:53:17 +020015
Bartlomiej Zolnierkiewicz88b2b322007-10-13 17:47:51 +020016static void tc86c001_set_mode(ide_drive_t *drive, const u8 speed)
Sergei Shtylyov33dced22007-02-07 18:18:45 +010017{
18 ide_hwif_t *hwif = HWIF(drive);
19 unsigned long scr_port = hwif->config_data + (drive->dn ? 0x02 : 0x00);
Bartlomiej Zolnierkiewicz31e8a462007-10-19 00:30:08 +020020 u16 mode, scr = inw(scr_port);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010021
Sergei Shtylyov33dced22007-02-07 18:18:45 +010022 switch (speed) {
Paolo Ciarrocchi5c634bb2008-04-26 17:36:39 +020023 case XFER_UDMA_4: mode = 0x00c0; break;
24 case XFER_UDMA_3: mode = 0x00b0; break;
25 case XFER_UDMA_2: mode = 0x00a0; break;
26 case XFER_UDMA_1: mode = 0x0090; break;
27 case XFER_UDMA_0: mode = 0x0080; break;
28 case XFER_MW_DMA_2: mode = 0x0070; break;
29 case XFER_MW_DMA_1: mode = 0x0060; break;
30 case XFER_MW_DMA_0: mode = 0x0050; break;
31 case XFER_PIO_4: mode = 0x0400; break;
32 case XFER_PIO_3: mode = 0x0300; break;
33 case XFER_PIO_2: mode = 0x0200; break;
34 case XFER_PIO_1: mode = 0x0100; break;
35 case XFER_PIO_0:
36 default: mode = 0x0000; break;
Sergei Shtylyov33dced22007-02-07 18:18:45 +010037 }
38
39 scr &= (speed < XFER_MW_DMA_0) ? 0xf8ff : 0xff0f;
40 scr |= mode;
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +010041 outw(scr, scr_port);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010042}
43
Bartlomiej Zolnierkiewicz26bcb872007-10-11 23:54:00 +020044static void tc86c001_set_pio_mode(ide_drive_t *drive, const u8 pio)
Sergei Shtylyov33dced22007-02-07 18:18:45 +010045{
Bartlomiej Zolnierkiewicz88b2b322007-10-13 17:47:51 +020046 tc86c001_set_mode(drive, XFER_PIO_0 + pio);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010047}
48
49/*
50 * HACKITY HACK
51 *
52 * This is a workaround for the limitation 5 of the TC86C001 IDE controller:
53 * if a DMA transfer terminates prematurely, the controller leaves the device's
54 * interrupt request (INTRQ) pending and does not generate a PCI interrupt (or
55 * set the interrupt bit in the DMA status register), thus no PCI interrupt
56 * will occur until a DMA transfer has been successfully completed.
57 *
58 * We work around this by initiating dummy, zero-length DMA transfer on
59 * a DMA timeout expiration. I found no better way to do this with the current
60 * IDE core than to temporarily replace a higher level driver's timer expiry
61 * handler with our own backing up to that handler in case our recovery fails.
62 */
63static int tc86c001_timer_expiry(ide_drive_t *drive)
64{
65 ide_hwif_t *hwif = HWIF(drive);
66 ide_expiry_t *expiry = ide_get_hwifdata(hwif);
67 ide_hwgroup_t *hwgroup = HWGROUP(drive);
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020068 u8 dma_stat = inb(hwif->dma_base + ATA_DMA_STATUS);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010069
70 /* Restore a higher level driver's expiry handler first. */
71 hwgroup->expiry = expiry;
72
73 if ((dma_stat & 5) == 1) { /* DMA active and no interrupt */
74 unsigned long sc_base = hwif->config_data;
75 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020076 u8 dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010077
78 printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
79 "attempting recovery...\n", drive->name);
80
81 /* Stop DMA */
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020082 outb(dma_cmd & ~0x01, hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010083
84 /* Setup the dummy DMA transfer */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +010085 outw(0, sc_base + 0x0a); /* Sector Count */
86 outw(0, twcr_port); /* Transfer Word Count 1 or 2 */
Sergei Shtylyov33dced22007-02-07 18:18:45 +010087
88 /* Start the dummy DMA transfer */
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020089
90 /* clear R_OR_WCTR for write */
91 outb(0x00, hwif->dma_base + ATA_DMA_CMD);
92 /* set START_STOPBM */
93 outb(0x01, hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010094
95 /*
96 * If an interrupt was pending, it should come thru shortly.
97 * If not, a higher level driver's expiry handler should
98 * eventually cause some kind of recovery from the DMA stall.
99 */
100 return WAIT_MIN_SLEEP;
101 }
102
103 /* Chain to the restored expiry handler if DMA wasn't active. */
104 if (likely(expiry != NULL))
105 return expiry(drive);
106
107 /* If there was no handler, "emulate" that for ide_timer_expiry()... */
108 return -1;
109}
110
111static void tc86c001_dma_start(ide_drive_t *drive)
112{
113 ide_hwif_t *hwif = HWIF(drive);
114 ide_hwgroup_t *hwgroup = HWGROUP(drive);
115 unsigned long sc_base = hwif->config_data;
116 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
117 unsigned long nsectors = hwgroup->rq->nr_sectors;
118
119 /*
120 * We have to manually load the sector count and size into
121 * the appropriate system control registers for DMA to work
122 * with LBA48 and ATAPI devices...
123 */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100124 outw(nsectors, sc_base + 0x0a); /* Sector Count */
125 outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100126
127 /* Install our timeout expiry hook, saving the current handler... */
128 ide_set_hwifdata(hwif, hwgroup->expiry);
129 hwgroup->expiry = &tc86c001_timer_expiry;
130
131 ide_dma_start(drive);
132}
133
Bartlomiej Zolnierkiewiczf454cbe2008-08-05 18:17:04 +0200134static u8 tc86c001_cable_detect(ide_hwif_t *hwif)
Bartlomiej Zolnierkiewiczbfa14b42008-02-02 19:56:31 +0100135{
136 struct pci_dev *dev = to_pci_dev(hwif->dev);
137 unsigned long sc_base = pci_resource_start(dev, 5);
138 u16 scr1 = inw(sc_base + 0x00);
139
140 /*
141 * System Control 1 Register bit 13 (PDIAGN):
142 * 0=80-pin cable, 1=40-pin cable
143 */
144 return (scr1 & 0x2000) ? ATA_CBL_PATA40 : ATA_CBL_PATA80;
145}
146
Adrian Bunke8ab7f52007-02-07 18:18:52 +0100147static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100148{
Bartlomiej Zolnierkiewicz36501652008-02-01 23:09:31 +0100149 struct pci_dev *dev = to_pci_dev(hwif->dev);
150 unsigned long sc_base = pci_resource_start(dev, 5);
Bartlomiej Zolnierkiewicz31e8a462007-10-19 00:30:08 +0200151 u16 scr1 = inw(sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100152
153 /* System Control 1 Register bit 15 (Soft Reset) set */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100154 outw(scr1 | 0x8000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100155
156 /* System Control 1 Register bit 14 (FIFO Reset) set */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100157 outw(scr1 | 0x4000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100158
159 /* System Control 1 Register: reset clear */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100160 outw(scr1 & ~0xc000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100161
162 /* Store the system control register base for convenience... */
163 hwif->config_data = sc_base;
164
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100165 if (!hwif->dma_base)
166 return;
167
168 /*
169 * Sector Count Control Register bits 0 and 1 set:
170 * software sets Sector Count Register for master and slave device
171 */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100172 outw(0x0003, sc_base + 0x0c);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100173
174 /* Sector Count Register limit */
175 hwif->rqsize = 0xffff;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100176}
177
Bartlomiej Zolnierkiewiczac95bee2008-04-26 22:25:14 +0200178static const struct ide_port_ops tc86c001_port_ops = {
179 .set_pio_mode = tc86c001_set_pio_mode,
180 .set_dma_mode = tc86c001_set_mode,
181 .cable_detect = tc86c001_cable_detect,
182};
183
Bartlomiej Zolnierkiewiczf37afda2008-04-26 22:25:24 +0200184static const struct ide_dma_ops tc86c001_dma_ops = {
185 .dma_host_set = ide_dma_host_set,
186 .dma_setup = ide_dma_setup,
187 .dma_exec_cmd = ide_dma_exec_cmd,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200188 .dma_start = tc86c001_dma_start,
Bartlomiej Zolnierkiewicz653bcf52008-10-13 21:39:46 +0200189 .dma_end = ide_dma_end,
Bartlomiej Zolnierkiewiczf37afda2008-04-26 22:25:24 +0200190 .dma_test_irq = ide_dma_test_irq,
191 .dma_lost_irq = ide_dma_lost_irq,
192 .dma_timeout = ide_dma_timeout,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200193};
194
Bartlomiej Zolnierkiewicz85620432007-10-20 00:32:34 +0200195static const struct ide_port_info tc86c001_chipset __devinitdata = {
Bartlomiej Zolnierkiewiczced3ec82008-07-24 22:53:32 +0200196 .name = DRV_NAME,
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100197 .init_hwif = init_hwif_tc86c001,
Bartlomiej Zolnierkiewiczac95bee2008-04-26 22:25:14 +0200198 .port_ops = &tc86c001_port_ops,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200199 .dma_ops = &tc86c001_dma_ops,
Bartlomiej Zolnierkiewicz3b2a5c72008-07-23 19:55:56 +0200200 .host_flags = IDE_HFLAG_SINGLE | IDE_HFLAG_OFF_BOARD,
Bartlomiej Zolnierkiewicz4099d142007-07-20 01:11:59 +0200201 .pio_mask = ATA_PIO4,
Bartlomiej Zolnierkiewicz5f8b6c32007-10-19 00:30:07 +0200202 .mwdma_mask = ATA_MWDMA2,
203 .udma_mask = ATA_UDMA4,
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100204};
205
206static int __devinit tc86c001_init_one(struct pci_dev *dev,
207 const struct pci_device_id *id)
208{
Bartlomiej Zolnierkiewiczb16040b2008-07-24 22:53:17 +0200209 int rc;
210
211 rc = pci_enable_device(dev);
212 if (rc)
213 goto out;
214
215 rc = pci_request_region(dev, 5, DRV_NAME);
216 if (rc) {
217 printk(KERN_ERR DRV_NAME ": system control regs already in use");
218 goto out_disable;
219 }
220
221 rc = ide_pci_init_one(dev, &tc86c001_chipset, NULL);
222 if (rc)
223 goto out_release;
224
225 goto out;
226
227out_release:
228 pci_release_region(dev, 5);
229out_disable:
230 pci_disable_device(dev);
231out:
232 return rc;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100233}
234
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200235static void __devexit tc86c001_remove(struct pci_dev *dev)
236{
237 ide_pci_remove(dev);
238 pci_release_region(dev, 5);
239 pci_disable_device(dev);
240}
241
Bartlomiej Zolnierkiewicz9cbcc5e2007-10-16 22:29:56 +0200242static const struct pci_device_id tc86c001_pci_tbl[] = {
243 { PCI_VDEVICE(TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE), 0 },
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100244 { 0, }
245};
246MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);
247
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200248static struct pci_driver tc86c001_pci_driver = {
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100249 .name = "TC86C001",
250 .id_table = tc86c001_pci_tbl,
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200251 .probe = tc86c001_init_one,
Adrian Bunka69999e2008-08-18 21:40:03 +0200252 .remove = __devexit_p(tc86c001_remove),
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100253};
254
Bartlomiej Zolnierkiewicza534b682007-02-07 18:19:09 +0100255static int __init tc86c001_ide_init(void)
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100256{
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200257 return ide_pci_register_driver(&tc86c001_pci_driver);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100258}
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200259
260static void __exit tc86c001_ide_exit(void)
261{
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200262 pci_unregister_driver(&tc86c001_pci_driver);
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200263}
264
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100265module_init(tc86c001_ide_init);
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200266module_exit(tc86c001_ide_exit);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100267
268MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
269MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
270MODULE_LICENSE("GPL");