pcmcia: ide-cs: Remove outdated comment
[linux-2.6] / drivers / ide / pci / ns87415.c
1 /*
2  * Copyright (C) 1997-1998      Mark Lord <mlord@pobox.com>
3  * Copyright (C) 1998           Eddie C. Dost <ecd@skynet.be>
4  * Copyright (C) 1999-2000      Andre Hedrick <andre@linux-ide.org>
5  * Copyright (C) 2004           Grant Grundler <grundler at parisc-linux.org>
6  *
7  * Inspired by an earlier effort from David S. Miller <davem@redhat.com>
8  */
9
10 #include <linux/module.h>
11 #include <linux/types.h>
12 #include <linux/kernel.h>
13 #include <linux/interrupt.h>
14 #include <linux/hdreg.h>
15 #include <linux/pci.h>
16 #include <linux/delay.h>
17 #include <linux/ide.h>
18 #include <linux/init.h>
19
20 #include <asm/io.h>
21
22 #ifdef CONFIG_SUPERIO
23 /* SUPERIO 87560 is a PoS chip that NatSem denies exists.
24  * Unfortunately, it's built-in on all Astro-based PA-RISC workstations
25  * which use the integrated NS87514 cell for CD-ROM support.
26  * i.e we have to support for CD-ROM installs.
27  * See drivers/parisc/superio.c for more gory details.
28  */
29 #include <asm/superio.h>
30
31 static unsigned long superio_ide_status[2];
32 static unsigned long superio_ide_select[2];
33 static unsigned long superio_ide_dma_status[2];
34
35 #define SUPERIO_IDE_MAX_RETRIES 25
36
37 /* Because of a defect in Super I/O, all reads of the PCI DMA status 
38  * registers, IDE status register and the IDE select register need to be 
39  * retried
40  */
41 static u8 superio_ide_inb (unsigned long port)
42 {
43         if (port == superio_ide_status[0] ||
44             port == superio_ide_status[1] ||
45             port == superio_ide_select[0] ||
46             port == superio_ide_select[1] ||
47             port == superio_ide_dma_status[0] ||
48             port == superio_ide_dma_status[1]) {
49                 u8 tmp;
50                 int retries = SUPERIO_IDE_MAX_RETRIES;
51
52                 /* printk(" [ reading port 0x%x with retry ] ", port); */
53
54                 do {
55                         tmp = inb(port);
56                         if (tmp == 0)
57                                 udelay(50);
58                 } while (tmp == 0 && retries-- > 0);
59
60                 return tmp;
61         }
62
63         return inb(port);
64 }
65
66 static void superio_tf_read(ide_drive_t *drive, ide_task_t *task)
67 {
68         struct ide_io_ports *io_ports = &drive->hwif->io_ports;
69         struct ide_taskfile *tf = &task->tf;
70
71         if (task->tf_flags & IDE_TFLAG_IN_DATA) {
72                 u16 data = inw(io_ports->data_addr);
73
74                 tf->data = data & 0xff;
75                 tf->hob_data = (data >> 8) & 0xff;
76         }
77
78         /* be sure we're looking at the low order bits */
79         outb(drive->ctl & ~0x80, io_ports->ctl_addr);
80
81         if (task->tf_flags & IDE_TFLAG_IN_NSECT)
82                 tf->nsect  = inb(io_ports->nsect_addr);
83         if (task->tf_flags & IDE_TFLAG_IN_LBAL)
84                 tf->lbal   = inb(io_ports->lbal_addr);
85         if (task->tf_flags & IDE_TFLAG_IN_LBAM)
86                 tf->lbam   = inb(io_ports->lbam_addr);
87         if (task->tf_flags & IDE_TFLAG_IN_LBAH)
88                 tf->lbah   = inb(io_ports->lbah_addr);
89         if (task->tf_flags & IDE_TFLAG_IN_DEVICE)
90                 tf->device = superio_ide_inb(io_ports->device_addr);
91
92         if (task->tf_flags & IDE_TFLAG_LBA48) {
93                 outb(drive->ctl | 0x80, io_ports->ctl_addr);
94
95                 if (task->tf_flags & IDE_TFLAG_IN_HOB_FEATURE)
96                         tf->hob_feature = inb(io_ports->feature_addr);
97                 if (task->tf_flags & IDE_TFLAG_IN_HOB_NSECT)
98                         tf->hob_nsect   = inb(io_ports->nsect_addr);
99                 if (task->tf_flags & IDE_TFLAG_IN_HOB_LBAL)
100                         tf->hob_lbal    = inb(io_ports->lbal_addr);
101                 if (task->tf_flags & IDE_TFLAG_IN_HOB_LBAM)
102                         tf->hob_lbam    = inb(io_ports->lbam_addr);
103                 if (task->tf_flags & IDE_TFLAG_IN_HOB_LBAH)
104                         tf->hob_lbah    = inb(io_ports->lbah_addr);
105         }
106 }
107
108 static void __devinit superio_ide_init_iops (struct hwif_s *hwif)
109 {
110         struct pci_dev *pdev = to_pci_dev(hwif->dev);
111         u32 base, dmabase;
112         u8 port = hwif->channel, tmp;
113
114         base = pci_resource_start(pdev, port * 2) & ~3;
115         dmabase = pci_resource_start(pdev, 4) & ~3;
116
117         superio_ide_status[port] = base + 7;
118         superio_ide_select[port] = base + 6;
119         superio_ide_dma_status[port] = dmabase + (!port ? 2 : 0xa);
120
121         /* Clear error/interrupt, enable dma */
122         tmp = superio_ide_inb(superio_ide_dma_status[port]);
123         outb(tmp | 0x66, superio_ide_dma_status[port]);
124
125         hwif->tf_read = superio_tf_read;
126
127         /* We need to override inb to workaround a SuperIO errata */
128         hwif->INB = superio_ide_inb;
129 }
130
131 static void __devinit init_iops_ns87415(ide_hwif_t *hwif)
132 {
133         struct pci_dev *dev = to_pci_dev(hwif->dev);
134
135         if (PCI_SLOT(dev->devfn) == 0xE)
136                 /* Built-in - assume it's under superio. */
137                 superio_ide_init_iops(hwif);
138 }
139 #endif
140
141 static unsigned int ns87415_count = 0, ns87415_control[MAX_HWIFS] = { 0 };
142
143 /*
144  * This routine either enables/disables (according to drive->present)
145  * the IRQ associated with the port (HWIF(drive)),
146  * and selects either PIO or DMA handshaking for the next I/O operation.
147  */
148 static void ns87415_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
149 {
150         ide_hwif_t *hwif = HWIF(drive);
151         struct pci_dev *dev = to_pci_dev(hwif->dev);
152         unsigned int bit, other, new, *old = (unsigned int *) hwif->select_data;
153         unsigned long flags;
154
155         local_irq_save(flags);
156         new = *old;
157
158         /* Adjust IRQ enable bit */
159         bit = 1 << (8 + hwif->channel);
160         new = drive->present ? (new & ~bit) : (new | bit);
161
162         /* Select PIO or DMA, DMA may only be selected for one drive/channel. */
163         bit   = 1 << (20 + drive->select.b.unit       + (hwif->channel << 1));
164         other = 1 << (20 + (1 - drive->select.b.unit) + (hwif->channel << 1));
165         new = use_dma ? ((new & ~other) | bit) : (new & ~bit);
166
167         if (new != *old) {
168                 unsigned char stat;
169
170                 /*
171                  * Don't change DMA engine settings while Write Buffers
172                  * are busy.
173                  */
174                 (void) pci_read_config_byte(dev, 0x43, &stat);
175                 while (stat & 0x03) {
176                         udelay(1);
177                         (void) pci_read_config_byte(dev, 0x43, &stat);
178                 }
179
180                 *old = new;
181                 (void) pci_write_config_dword(dev, 0x40, new);
182
183                 /*
184                  * And let things settle...
185                  */
186                 udelay(10);
187         }
188
189         local_irq_restore(flags);
190 }
191
192 static void ns87415_selectproc (ide_drive_t *drive)
193 {
194         ns87415_prepare_drive (drive, drive->using_dma);
195 }
196
197 static int ns87415_dma_end(ide_drive_t *drive)
198 {
199         ide_hwif_t      *hwif = HWIF(drive);
200         u8 dma_stat = 0, dma_cmd = 0;
201
202         drive->waiting_for_dma = 0;
203         dma_stat = hwif->INB(hwif->dma_status);
204         /* get dma command mode */
205         dma_cmd = hwif->INB(hwif->dma_command);
206         /* stop DMA */
207         outb(dma_cmd & ~1, hwif->dma_command);
208         /* from ERRATA: clear the INTR & ERROR bits */
209         dma_cmd = hwif->INB(hwif->dma_command);
210         outb(dma_cmd | 6, hwif->dma_command);
211         /* and free any DMA resources */
212         ide_destroy_dmatable(drive);
213         /* verify good DMA status */
214         return (dma_stat & 7) != 4;
215 }
216
217 static int ns87415_dma_setup(ide_drive_t *drive)
218 {
219         /* select DMA xfer */
220         ns87415_prepare_drive(drive, 1);
221         if (!ide_dma_setup(drive))
222                 return 0;
223         /* DMA failed: select PIO xfer */
224         ns87415_prepare_drive(drive, 0);
225         return 1;
226 }
227
228 static void __devinit init_hwif_ns87415 (ide_hwif_t *hwif)
229 {
230         struct pci_dev *dev = to_pci_dev(hwif->dev);
231         unsigned int ctrl, using_inta;
232         u8 progif;
233 #ifdef __sparc_v9__
234         int timeout;
235         u8 stat;
236 #endif
237
238         /*
239          * We cannot probe for IRQ: both ports share common IRQ on INTA.
240          * Also, leave IRQ masked during drive probing, to prevent infinite
241          * interrupts from a potentially floating INTA..
242          *
243          * IRQs get unmasked in selectproc when drive is first used.
244          */
245         (void) pci_read_config_dword(dev, 0x40, &ctrl);
246         (void) pci_read_config_byte(dev, 0x09, &progif);
247         /* is irq in "native" mode? */
248         using_inta = progif & (1 << (hwif->channel << 1));
249         if (!using_inta)
250                 using_inta = ctrl & (1 << (4 + hwif->channel));
251         if (hwif->mate) {
252                 hwif->select_data = hwif->mate->select_data;
253         } else {
254                 hwif->select_data = (unsigned long)
255                                         &ns87415_control[ns87415_count++];
256                 ctrl |= (1 << 8) | (1 << 9);    /* mask both IRQs */
257                 if (using_inta)
258                         ctrl &= ~(1 << 6);      /* unmask INTA */
259                 *((unsigned int *)hwif->select_data) = ctrl;
260                 (void) pci_write_config_dword(dev, 0x40, ctrl);
261
262                 /*
263                  * Set prefetch size to 512 bytes for both ports,
264                  * but don't turn on/off prefetching here.
265                  */
266                 pci_write_config_byte(dev, 0x55, 0xee);
267
268 #ifdef __sparc_v9__
269                 /*
270                  * XXX: Reset the device, if we don't it will not respond to
271                  *      SELECT_DRIVE() properly during first ide_probe_port().
272                  */
273                 timeout = 10000;
274                 outb(12, hwif->io_ports.ctl_addr);
275                 udelay(10);
276                 outb(8, hwif->io_ports.ctl_addr);
277                 do {
278                         udelay(50);
279                         stat = hwif->INB(hwif->io_ports.status_addr);
280                         if (stat == 0xff)
281                                 break;
282                 } while ((stat & BUSY_STAT) && --timeout);
283 #endif
284         }
285
286         if (!using_inta)
287                 hwif->irq = __ide_default_irq(hwif->io_ports.data_addr);
288         else if (!hwif->irq && hwif->mate && hwif->mate->irq)
289                 hwif->irq = hwif->mate->irq;    /* share IRQ with mate */
290
291         if (!hwif->dma_base)
292                 return;
293
294         outb(0x60, hwif->dma_status);
295 }
296
297 static const struct ide_port_ops ns87415_port_ops = {
298         .selectproc             = ns87415_selectproc,
299 };
300
301 static const struct ide_dma_ops ns87415_dma_ops = {
302         .dma_host_set           = ide_dma_host_set,
303         .dma_setup              = ns87415_dma_setup,
304         .dma_exec_cmd           = ide_dma_exec_cmd,
305         .dma_start              = ide_dma_start,
306         .dma_end                = ns87415_dma_end,
307         .dma_test_irq           = ide_dma_test_irq,
308         .dma_lost_irq           = ide_dma_lost_irq,
309         .dma_timeout            = ide_dma_timeout,
310 };
311
312 static const struct ide_port_info ns87415_chipset __devinitdata = {
313         .name           = "NS87415",
314 #ifdef CONFIG_SUPERIO
315         .init_iops      = init_iops_ns87415,
316 #endif
317         .init_hwif      = init_hwif_ns87415,
318         .port_ops       = &ns87415_port_ops,
319         .dma_ops        = &ns87415_dma_ops,
320         .host_flags     = IDE_HFLAG_TRUST_BIOS_FOR_DMA |
321                           IDE_HFLAG_NO_ATAPI_DMA,
322 };
323
324 static int __devinit ns87415_init_one(struct pci_dev *dev, const struct pci_device_id *id)
325 {
326         return ide_setup_pci_device(dev, &ns87415_chipset);
327 }
328
329 static const struct pci_device_id ns87415_pci_tbl[] = {
330         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), 0 },
331         { 0, },
332 };
333 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
334
335 static struct pci_driver driver = {
336         .name           = "NS87415_IDE",
337         .id_table       = ns87415_pci_tbl,
338         .probe          = ns87415_init_one,
339 };
340
341 static int __init ns87415_ide_init(void)
342 {
343         return ide_pci_register_driver(&driver);
344 }
345
346 module_init(ns87415_ide_init);
347
348 MODULE_AUTHOR("Mark Lord, Eddie Dost, Andre Hedrick");
349 MODULE_DESCRIPTION("PCI driver module for NS87415 IDE");
350 MODULE_LICENSE("GPL");