ide: simplify 'struct ide_taskfile'
[safe/jmp/linux-2.6] / drivers / ide / 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/pci.h>
15 #include <linux/delay.h>
16 #include <linux/ide.h>
17 #include <linux/init.h>
18
19 #include <asm/io.h>
20
21 #define DRV_NAME "ns87415"
22
23 #ifdef CONFIG_SUPERIO
24 /* SUPERIO 87560 is a PoS chip that NatSem denies exists.
25  * Unfortunately, it's built-in on all Astro-based PA-RISC workstations
26  * which use the integrated NS87514 cell for CD-ROM support.
27  * i.e we have to support for CD-ROM installs.
28  * See drivers/parisc/superio.c for more gory details.
29  */
30 #include <asm/superio.h>
31
32 #define SUPERIO_IDE_MAX_RETRIES 25
33
34 /* Because of a defect in Super I/O, all reads of the PCI DMA status 
35  * registers, IDE status register and the IDE select register need to be 
36  * retried
37  */
38 static u8 superio_ide_inb (unsigned long port)
39 {
40         u8 tmp;
41         int retries = SUPERIO_IDE_MAX_RETRIES;
42
43         /* printk(" [ reading port 0x%x with retry ] ", port); */
44
45         do {
46                 tmp = inb(port);
47                 if (tmp == 0)
48                         udelay(50);
49         } while (tmp == 0 && retries-- > 0);
50
51         return tmp;
52 }
53
54 static u8 superio_read_status(ide_hwif_t *hwif)
55 {
56         return superio_ide_inb(hwif->io_ports.status_addr);
57 }
58
59 static u8 superio_dma_sff_read_status(ide_hwif_t *hwif)
60 {
61         return superio_ide_inb(hwif->dma_base + ATA_DMA_STATUS);
62 }
63
64 static void superio_tf_read(ide_drive_t *drive, struct ide_cmd *cmd)
65 {
66         struct ide_io_ports *io_ports = &drive->hwif->io_ports;
67         struct ide_taskfile *tf = &cmd->tf;
68         u8 valid = cmd->valid.in.tf;
69
70         /* be sure we're looking at the low order bits */
71         outb(ATA_DEVCTL_OBS, io_ports->ctl_addr);
72
73         if (valid & IDE_VALID_ERROR)
74                 tf->error  = inb(io_ports->feature_addr);
75         if (valid & IDE_VALID_NSECT)
76                 tf->nsect  = inb(io_ports->nsect_addr);
77         if (valid & IDE_VALID_LBAL)
78                 tf->lbal   = inb(io_ports->lbal_addr);
79         if (valid & IDE_VALID_LBAM)
80                 tf->lbam   = inb(io_ports->lbam_addr);
81         if (valid & IDE_VALID_LBAH)
82                 tf->lbah   = inb(io_ports->lbah_addr);
83         if (valid & IDE_VALID_DEVICE)
84                 tf->device = superio_ide_inb(io_ports->device_addr);
85
86         if (cmd->tf_flags & IDE_TFLAG_LBA48) {
87                 outb(ATA_HOB | ATA_DEVCTL_OBS, io_ports->ctl_addr);
88
89                 tf = &cmd->hob;
90                 valid = cmd->valid.in.hob;
91
92                 if (valid & IDE_VALID_ERROR)
93                         tf->error = inb(io_ports->feature_addr);
94                 if (valid & IDE_VALID_NSECT)
95                         tf->nsect = inb(io_ports->nsect_addr);
96                 if (valid & IDE_VALID_LBAL)
97                         tf->lbal  = inb(io_ports->lbal_addr);
98                 if (valid & IDE_VALID_LBAM)
99                         tf->lbam  = inb(io_ports->lbam_addr);
100                 if (valid & IDE_VALID_LBAH)
101                         tf->lbah  = inb(io_ports->lbah_addr);
102         }
103 }
104
105 static void ns87415_dev_select(ide_drive_t *drive);
106
107 static const struct ide_tp_ops superio_tp_ops = {
108         .exec_command           = ide_exec_command,
109         .read_status            = superio_read_status,
110         .read_altstatus         = ide_read_altstatus,
111         .write_devctl           = ide_write_devctl,
112
113         .dev_select             = ns87415_dev_select,
114         .tf_load                = ide_tf_load,
115         .tf_read                = superio_tf_read,
116
117         .input_data             = ide_input_data,
118         .output_data            = ide_output_data,
119 };
120
121 static void __devinit superio_init_iops(struct hwif_s *hwif)
122 {
123         struct pci_dev *pdev = to_pci_dev(hwif->dev);
124         u32 dma_stat;
125         u8 port = hwif->channel, tmp;
126
127         dma_stat = (pci_resource_start(pdev, 4) & ~3) + (!port ? 2 : 0xa);
128
129         /* Clear error/interrupt, enable dma */
130         tmp = superio_ide_inb(dma_stat);
131         outb(tmp | 0x66, dma_stat);
132 }
133 #else
134 #define superio_dma_sff_read_status ide_dma_sff_read_status
135 #endif
136
137 static unsigned int ns87415_count = 0, ns87415_control[MAX_HWIFS] = { 0 };
138
139 /*
140  * This routine either enables/disables (according to IDE_DFLAG_PRESENT)
141  * the IRQ associated with the port,
142  * and selects either PIO or DMA handshaking for the next I/O operation.
143  */
144 static void ns87415_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
145 {
146         ide_hwif_t *hwif = drive->hwif;
147         struct pci_dev *dev = to_pci_dev(hwif->dev);
148         unsigned int bit, other, new, *old = (unsigned int *) hwif->select_data;
149         unsigned long flags;
150
151         local_irq_save(flags);
152         new = *old;
153
154         /* Adjust IRQ enable bit */
155         bit = 1 << (8 + hwif->channel);
156
157         if (drive->dev_flags & IDE_DFLAG_PRESENT)
158                 new &= ~bit;
159         else
160                 new |= bit;
161
162         /* Select PIO or DMA, DMA may only be selected for one drive/channel. */
163         bit   = 1 << (20 + (drive->dn & 1) + (hwif->channel << 1));
164         other = 1 << (20 + (1 - (drive->dn & 1)) + (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_dev_select(ide_drive_t *drive)
193 {
194         ns87415_prepare_drive(drive,
195                               !!(drive->dev_flags & IDE_DFLAG_USING_DMA));
196
197         outb(drive->select | ATA_DEVICE_OBS, drive->hwif->io_ports.device_addr);
198 }
199
200 static void ns87415_dma_start(ide_drive_t *drive)
201 {
202         ns87415_prepare_drive(drive, 1);
203         ide_dma_start(drive);
204 }
205
206 static int ns87415_dma_end(ide_drive_t *drive)
207 {
208         ide_hwif_t *hwif = drive->hwif;
209         u8 dma_stat = 0, dma_cmd = 0;
210
211         dma_stat = hwif->dma_ops->dma_sff_read_status(hwif);
212         /* get DMA command mode */
213         dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
214         /* stop DMA */
215         outb(dma_cmd & ~1, hwif->dma_base + ATA_DMA_CMD);
216         /* from ERRATA: clear the INTR & ERROR bits */
217         dma_cmd = inb(hwif->dma_base + ATA_DMA_CMD);
218         outb(dma_cmd | 6, hwif->dma_base + ATA_DMA_CMD);
219
220         ns87415_prepare_drive(drive, 0);
221
222         /* verify good DMA status */
223         return (dma_stat & 7) != 4;
224 }
225
226 static void __devinit init_hwif_ns87415 (ide_hwif_t *hwif)
227 {
228         struct pci_dev *dev = to_pci_dev(hwif->dev);
229         unsigned int ctrl, using_inta;
230         u8 progif;
231 #ifdef __sparc_v9__
232         int timeout;
233         u8 stat;
234 #endif
235
236         /*
237          * We cannot probe for IRQ: both ports share common IRQ on INTA.
238          * Also, leave IRQ masked during drive probing, to prevent infinite
239          * interrupts from a potentially floating INTA..
240          *
241          * IRQs get unmasked in dev_select() when drive is first used.
242          */
243         (void) pci_read_config_dword(dev, 0x40, &ctrl);
244         (void) pci_read_config_byte(dev, 0x09, &progif);
245         /* is irq in "native" mode? */
246         using_inta = progif & (1 << (hwif->channel << 1));
247         if (!using_inta)
248                 using_inta = ctrl & (1 << (4 + hwif->channel));
249         if (hwif->mate) {
250                 hwif->select_data = hwif->mate->select_data;
251         } else {
252                 hwif->select_data = (unsigned long)
253                                         &ns87415_control[ns87415_count++];
254                 ctrl |= (1 << 8) | (1 << 9);    /* mask both IRQs */
255                 if (using_inta)
256                         ctrl &= ~(1 << 6);      /* unmask INTA */
257                 *((unsigned int *)hwif->select_data) = ctrl;
258                 (void) pci_write_config_dword(dev, 0x40, ctrl);
259
260                 /*
261                  * Set prefetch size to 512 bytes for both ports,
262                  * but don't turn on/off prefetching here.
263                  */
264                 pci_write_config_byte(dev, 0x55, 0xee);
265
266 #ifdef __sparc_v9__
267                 /*
268                  * XXX: Reset the device, if we don't it will not respond to
269                  *      dev_select() properly during first ide_probe_port().
270                  */
271                 timeout = 10000;
272                 outb(12, hwif->io_ports.ctl_addr);
273                 udelay(10);
274                 outb(8, hwif->io_ports.ctl_addr);
275                 do {
276                         udelay(50);
277                         stat = hwif->tp_ops->read_status(hwif);
278                         if (stat == 0xff)
279                                 break;
280                 } while ((stat & ATA_BUSY) && --timeout);
281 #endif
282         }
283
284         if (!using_inta)
285                 hwif->irq = pci_get_legacy_ide_irq(dev, hwif->channel);
286
287         if (!hwif->dma_base)
288                 return;
289
290         outb(0x60, hwif->dma_base + ATA_DMA_STATUS);
291 }
292
293 static const struct ide_tp_ops ns87415_tp_ops = {
294         .exec_command           = ide_exec_command,
295         .read_status            = ide_read_status,
296         .read_altstatus         = ide_read_altstatus,
297         .write_devctl           = ide_write_devctl,
298
299         .dev_select             = ns87415_dev_select,
300         .tf_load                = ide_tf_load,
301         .tf_read                = ide_tf_read,
302
303         .input_data             = ide_input_data,
304         .output_data            = ide_output_data,
305 };
306
307 static const struct ide_dma_ops ns87415_dma_ops = {
308         .dma_host_set           = ide_dma_host_set,
309         .dma_setup              = ide_dma_setup,
310         .dma_start              = ns87415_dma_start,
311         .dma_end                = ns87415_dma_end,
312         .dma_test_irq           = ide_dma_test_irq,
313         .dma_lost_irq           = ide_dma_lost_irq,
314         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
315         .dma_sff_read_status    = superio_dma_sff_read_status,
316 };
317
318 static const struct ide_port_info ns87415_chipset __devinitdata = {
319         .name           = DRV_NAME,
320         .init_hwif      = init_hwif_ns87415,
321         .tp_ops         = &ns87415_tp_ops,
322         .dma_ops        = &ns87415_dma_ops,
323         .host_flags     = IDE_HFLAG_TRUST_BIOS_FOR_DMA |
324                           IDE_HFLAG_NO_ATAPI_DMA,
325 };
326
327 static int __devinit ns87415_init_one(struct pci_dev *dev, const struct pci_device_id *id)
328 {
329         struct ide_port_info d = ns87415_chipset;
330
331 #ifdef CONFIG_SUPERIO
332         if (PCI_SLOT(dev->devfn) == 0xE) {
333                 /* Built-in - assume it's under superio. */
334                 d.init_iops = superio_init_iops;
335                 d.tp_ops = &superio_tp_ops;
336         }
337 #endif
338         return ide_pci_init_one(dev, &d, NULL);
339 }
340
341 static const struct pci_device_id ns87415_pci_tbl[] = {
342         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), 0 },
343         { 0, },
344 };
345 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
346
347 static struct pci_driver ns87415_pci_driver = {
348         .name           = "NS87415_IDE",
349         .id_table       = ns87415_pci_tbl,
350         .probe          = ns87415_init_one,
351         .remove         = ide_pci_remove,
352         .suspend        = ide_pci_suspend,
353         .resume         = ide_pci_resume,
354 };
355
356 static int __init ns87415_ide_init(void)
357 {
358         return ide_pci_register_driver(&ns87415_pci_driver);
359 }
360
361 static void __exit ns87415_ide_exit(void)
362 {
363         pci_unregister_driver(&ns87415_pci_driver);
364 }
365
366 module_init(ns87415_ide_init);
367 module_exit(ns87415_ide_exit);
368
369 MODULE_AUTHOR("Mark Lord, Eddie Dost, Andre Hedrick");
370 MODULE_DESCRIPTION("PCI driver module for NS87415 IDE");
371 MODULE_LICENSE("GPL");