blob: 05a93d6baecc60edf3ba587ab26c0947907915aa [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{
Bartlomiej Zolnierkiewicz898ec222009-01-06 17:20:52 +010018 ide_hwif_t *hwif = drive->hwif;
Sergei Shtylyov33dced22007-02-07 18:18:45 +010019 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{
Bartlomiej Zolnierkiewicz898ec222009-01-06 17:20:52 +010065 ide_hwif_t *hwif = drive->hwif;
Sergei Shtylyov33dced22007-02-07 18:18:45 +010066 ide_expiry_t *expiry = ide_get_hwifdata(hwif);
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020067 u8 dma_stat = inb(hwif->dma_base + ATA_DMA_STATUS);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010068
69 /* Restore a higher level driver's expiry handler first. */
Bartlomiej Zolnierkiewiczb65fac32009-01-06 17:20:50 +010070 hwif->expiry = expiry;
Sergei Shtylyov33dced22007-02-07 18:18:45 +010071
72 if ((dma_stat & 5) == 1) { /* DMA active and no interrupt */
73 unsigned long sc_base = hwif->config_data;
74 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020075 u8 dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010076
77 printk(KERN_WARNING "%s: DMA interrupt possibly stuck, "
78 "attempting recovery...\n", drive->name);
79
80 /* Stop DMA */
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020081 outb(dma_cmd & ~0x01, hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010082
83 /* Setup the dummy DMA transfer */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +010084 outw(0, sc_base + 0x0a); /* Sector Count */
85 outw(0, twcr_port); /* Transfer Word Count 1 or 2 */
Sergei Shtylyov33dced22007-02-07 18:18:45 +010086
87 /* Start the dummy DMA transfer */
Bartlomiej Zolnierkiewiczcab7f8e2008-07-23 19:55:51 +020088
89 /* clear R_OR_WCTR for write */
90 outb(0x00, hwif->dma_base + ATA_DMA_CMD);
91 /* set START_STOPBM */
92 outb(0x01, hwif->dma_base + ATA_DMA_CMD);
Sergei Shtylyov33dced22007-02-07 18:18:45 +010093
94 /*
95 * If an interrupt was pending, it should come thru shortly.
96 * If not, a higher level driver's expiry handler should
97 * eventually cause some kind of recovery from the DMA stall.
98 */
99 return WAIT_MIN_SLEEP;
100 }
101
102 /* Chain to the restored expiry handler if DMA wasn't active. */
103 if (likely(expiry != NULL))
104 return expiry(drive);
105
106 /* If there was no handler, "emulate" that for ide_timer_expiry()... */
107 return -1;
108}
109
110static void tc86c001_dma_start(ide_drive_t *drive)
111{
Bartlomiej Zolnierkiewicz898ec222009-01-06 17:20:52 +0100112 ide_hwif_t *hwif = drive->hwif;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100113 unsigned long sc_base = hwif->config_data;
114 unsigned long twcr_port = sc_base + (drive->dn ? 0x06 : 0x04);
Tejun Heo9780e2d2009-05-07 22:24:40 +0900115 unsigned long nsectors = blk_rq_sectors(hwif->rq);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100116
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 */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100122 outw(nsectors, sc_base + 0x0a); /* Sector Count */
123 outw(SECTOR_SIZE / 2, twcr_port); /* Transfer Word Count 1/2 */
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100124
125 /* Install our timeout expiry hook, saving the current handler... */
Bartlomiej Zolnierkiewiczb65fac32009-01-06 17:20:50 +0100126 ide_set_hwifdata(hwif, hwif->expiry);
127 hwif->expiry = &tc86c001_timer_expiry;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100128
129 ide_dma_start(drive);
130}
131
Bartlomiej Zolnierkiewiczf454cbe2008-08-05 18:17:04 +0200132static u8 tc86c001_cable_detect(ide_hwif_t *hwif)
Bartlomiej Zolnierkiewiczbfa14b42008-02-02 19:56:31 +0100133{
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
Adrian Bunke8ab7f52007-02-07 18:18:52 +0100145static void __devinit init_hwif_tc86c001(ide_hwif_t *hwif)
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100146{
Bartlomiej Zolnierkiewicz36501652008-02-01 23:09:31 +0100147 struct pci_dev *dev = to_pci_dev(hwif->dev);
148 unsigned long sc_base = pci_resource_start(dev, 5);
Bartlomiej Zolnierkiewicz31e8a462007-10-19 00:30:08 +0200149 u16 scr1 = inw(sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100150
151 /* System Control 1 Register bit 15 (Soft Reset) set */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100152 outw(scr1 | 0x8000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100153
154 /* System Control 1 Register bit 14 (FIFO Reset) set */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100155 outw(scr1 | 0x4000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100156
157 /* System Control 1 Register: reset clear */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100158 outw(scr1 & ~0xc000, sc_base + 0x00);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100159
160 /* Store the system control register base for convenience... */
161 hwif->config_data = sc_base;
162
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100163 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 */
Bartlomiej Zolnierkiewicz0ecdca22007-02-17 02:40:25 +0100170 outw(0x0003, sc_base + 0x0c);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100171
172 /* Sector Count Register limit */
173 hwif->rqsize = 0xffff;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100174}
175
Bartlomiej Zolnierkiewiczac95bee2008-04-26 22:25:14 +0200176static const struct ide_port_ops tc86c001_port_ops = {
177 .set_pio_mode = tc86c001_set_pio_mode,
178 .set_dma_mode = tc86c001_set_mode,
179 .cable_detect = tc86c001_cable_detect,
180};
181
Bartlomiej Zolnierkiewiczf37afda2008-04-26 22:25:24 +0200182static const struct ide_dma_ops tc86c001_dma_ops = {
183 .dma_host_set = ide_dma_host_set,
184 .dma_setup = ide_dma_setup,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200185 .dma_start = tc86c001_dma_start,
Bartlomiej Zolnierkiewicz653bcf52008-10-13 21:39:46 +0200186 .dma_end = ide_dma_end,
Bartlomiej Zolnierkiewiczf37afda2008-04-26 22:25:24 +0200187 .dma_test_irq = ide_dma_test_irq,
188 .dma_lost_irq = ide_dma_lost_irq,
Bartlomiej Zolnierkiewicz22117d62009-03-27 12:46:47 +0100189 .dma_timer_expiry = ide_dma_sff_timer_expiry,
Sergei Shtylyov592b5312009-01-06 17:21:02 +0100190 .dma_sff_read_status = ide_dma_sff_read_status,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200191};
192
Bartlomiej Zolnierkiewicz85620432007-10-20 00:32:34 +0200193static const struct ide_port_info tc86c001_chipset __devinitdata = {
Bartlomiej Zolnierkiewiczced3ec82008-07-24 22:53:32 +0200194 .name = DRV_NAME,
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100195 .init_hwif = init_hwif_tc86c001,
Bartlomiej Zolnierkiewiczac95bee2008-04-26 22:25:14 +0200196 .port_ops = &tc86c001_port_ops,
Bartlomiej Zolnierkiewicz5e37bdc2008-04-26 22:25:24 +0200197 .dma_ops = &tc86c001_dma_ops,
Bartlomiej Zolnierkiewicz3b2a5c72008-07-23 19:55:56 +0200198 .host_flags = IDE_HFLAG_SINGLE | IDE_HFLAG_OFF_BOARD,
Bartlomiej Zolnierkiewicz4099d142007-07-20 01:11:59 +0200199 .pio_mask = ATA_PIO4,
Bartlomiej Zolnierkiewicz5f8b6c32007-10-19 00:30:07 +0200200 .mwdma_mask = ATA_MWDMA2,
201 .udma_mask = ATA_UDMA4,
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100202};
203
204static int __devinit tc86c001_init_one(struct pci_dev *dev,
205 const struct pci_device_id *id)
206{
Bartlomiej Zolnierkiewiczb16040b2008-07-24 22:53:17 +0200207 int rc;
208
209 rc = pci_enable_device(dev);
210 if (rc)
211 goto out;
212
213 rc = pci_request_region(dev, 5, DRV_NAME);
214 if (rc) {
215 printk(KERN_ERR DRV_NAME ": system control regs already in use");
216 goto out_disable;
217 }
218
219 rc = ide_pci_init_one(dev, &tc86c001_chipset, NULL);
220 if (rc)
221 goto out_release;
222
223 goto out;
224
225out_release:
226 pci_release_region(dev, 5);
227out_disable:
228 pci_disable_device(dev);
229out:
230 return rc;
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100231}
232
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200233static void __devexit tc86c001_remove(struct pci_dev *dev)
234{
235 ide_pci_remove(dev);
236 pci_release_region(dev, 5);
237 pci_disable_device(dev);
238}
239
Bartlomiej Zolnierkiewicz9cbcc5e2007-10-16 22:29:56 +0200240static const struct pci_device_id tc86c001_pci_tbl[] = {
241 { PCI_VDEVICE(TOSHIBA_2, PCI_DEVICE_ID_TOSHIBA_TC86C001_IDE), 0 },
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100242 { 0, }
243};
244MODULE_DEVICE_TABLE(pci, tc86c001_pci_tbl);
245
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200246static struct pci_driver tc86c001_pci_driver = {
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100247 .name = "TC86C001",
248 .id_table = tc86c001_pci_tbl,
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200249 .probe = tc86c001_init_one,
Adrian Bunka69999e2008-08-18 21:40:03 +0200250 .remove = __devexit_p(tc86c001_remove),
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100251};
252
Bartlomiej Zolnierkiewicza534b682007-02-07 18:19:09 +0100253static int __init tc86c001_ide_init(void)
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100254{
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200255 return ide_pci_register_driver(&tc86c001_pci_driver);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100256}
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200257
258static void __exit tc86c001_ide_exit(void)
259{
Bartlomiej Zolnierkiewicza9ab09e2008-10-13 21:39:41 +0200260 pci_unregister_driver(&tc86c001_pci_driver);
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200261}
262
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100263module_init(tc86c001_ide_init);
Bartlomiej Zolnierkiewiczea881d62008-07-24 22:53:26 +0200264module_exit(tc86c001_ide_exit);
Sergei Shtylyov33dced22007-02-07 18:18:45 +0100265
266MODULE_AUTHOR("MontaVista Software, Inc. <source@mvista.com>");
267MODULE_DESCRIPTION("PCI driver module for TC86C001 IDE");
268MODULE_LICENSE("GPL");