7d64bc079fa83bebb5a406ae0e39c3b4e4d5f1d0
[linux-3.10.git] / 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
69         if (cmd->ftf_flags & IDE_FTFLAG_IN_DATA) {
70                 u8 data[2];
71
72                 ide_input_data(drive, cmd, data, 2);
73
74                 tf->data = data[0];
75                 tf->hob_data = data[1];
76         }
77
78         /* be sure we're looking at the low order bits */
79         outb(ATA_DEVCTL_OBS, io_ports->ctl_addr);
80
81         if (cmd->tf_flags & IDE_TFLAG_IN_ERROR)
82                 tf->error  = inb(io_ports->feature_addr);
83         if (cmd->tf_flags & IDE_TFLAG_IN_NSECT)
84                 tf->nsect  = inb(io_ports->nsect_addr);
85         if (cmd->tf_flags & IDE_TFLAG_IN_LBAL)
86                 tf->lbal   = inb(io_ports->lbal_addr);
87         if (cmd->tf_flags & IDE_TFLAG_IN_LBAM)
88                 tf->lbam   = inb(io_ports->lbam_addr);
89         if (cmd->tf_flags & IDE_TFLAG_IN_LBAH)
90                 tf->lbah   = inb(io_ports->lbah_addr);
91         if (cmd->tf_flags & IDE_TFLAG_IN_DEVICE)
92                 tf->device = superio_ide_inb(io_ports->device_addr);
93
94         if (cmd->tf_flags & IDE_TFLAG_LBA48) {
95                 outb(ATA_HOB | ATA_DEVCTL_OBS, io_ports->ctl_addr);
96
97                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_ERROR)
98                         tf->hob_error = inb(io_ports->feature_addr);
99                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_NSECT)
100                         tf->hob_nsect = inb(io_ports->nsect_addr);
101                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAL)
102                         tf->hob_lbal  = inb(io_ports->lbal_addr);
103                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAM)
104                         tf->hob_lbam  = inb(io_ports->lbam_addr);
105                 if (cmd->tf_flags & IDE_TFLAG_IN_HOB_LBAH)
106                         tf->hob_lbah  = inb(io_ports->lbah_addr);
107         }
108 }
109
110 static const struct ide_tp_ops superio_tp_ops = {
111         .exec_command           = ide_exec_command,
112         .read_status            = superio_read_status,
113         .read_altstatus         = ide_read_altstatus,
114         .write_devctl           = ide_write_devctl,
115
116         .tf_load                = ide_tf_load,
117         .tf_read                = superio_tf_read,
118
119         .input_data             = ide_input_data,
120         .output_data            = ide_output_data,
121 };
122
123 static void __devinit superio_init_iops(struct hwif_s *hwif)
124 {
125         struct pci_dev *pdev = to_pci_dev(hwif->dev);
126         u32 dma_stat;
127         u8 port = hwif->channel, tmp;
128
129         dma_stat = (pci_resource_start(pdev, 4) & ~3) + (!port ? 2 : 0xa);
130
131         /* Clear error/interrupt, enable dma */
132         tmp = superio_ide_inb(dma_stat);
133         outb(tmp | 0x66, dma_stat);
134 }
135 #else
136 #define superio_dma_sff_read_status ide_dma_sff_read_status
137 #endif
138
139 static unsigned int ns87415_count = 0, ns87415_control[MAX_HWIFS] = { 0 };
140
141 /*
142  * This routine either enables/disables (according to IDE_DFLAG_PRESENT)
143  * the IRQ associated with the port,
144  * and selects either PIO or DMA handshaking for the next I/O operation.
145  */
146 static void ns87415_prepare_drive (ide_drive_t *drive, unsigned int use_dma)
147 {
148         ide_hwif_t *hwif = drive->hwif;
149         struct pci_dev *dev = to_pci_dev(hwif->dev);
150         unsigned int bit, other, new, *old = (unsigned int *) hwif->select_data;
151         unsigned long flags;
152
153         local_irq_save(flags);
154         new = *old;
155
156         /* Adjust IRQ enable bit */
157         bit = 1 << (8 + hwif->channel);
158
159         if (drive->dev_flags & IDE_DFLAG_PRESENT)
160                 new &= ~bit;
161         else
162                 new |= bit;
163
164         /* Select PIO or DMA, DMA may only be selected for one drive/channel. */
165         bit   = 1 << (20 + (drive->dn & 1) + (hwif->channel << 1));
166         other = 1 << (20 + (1 - (drive->dn & 1)) + (hwif->channel << 1));
167         new = use_dma ? ((new & ~other) | bit) : (new & ~bit);
168
169         if (new != *old) {
170                 unsigned char stat;
171
172                 /*
173                  * Don't change DMA engine settings while Write Buffers
174                  * are busy.
175                  */
176                 (void) pci_read_config_byte(dev, 0x43, &stat);
177                 while (stat & 0x03) {
178                         udelay(1);
179                         (void) pci_read_config_byte(dev, 0x43, &stat);
180                 }
181
182                 *old = new;
183                 (void) pci_write_config_dword(dev, 0x40, new);
184
185                 /*
186                  * And let things settle...
187                  */
188                 udelay(10);
189         }
190
191         local_irq_restore(flags);
192 }
193
194 static void ns87415_selectproc (ide_drive_t *drive)
195 {
196         ns87415_prepare_drive(drive,
197                               !!(drive->dev_flags & IDE_DFLAG_USING_DMA));
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 selectproc 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                  *      SELECT_DRIVE() 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_port_ops ns87415_port_ops = {
294         .selectproc             = ns87415_selectproc,
295 };
296
297 static const struct ide_dma_ops ns87415_dma_ops = {
298         .dma_host_set           = ide_dma_host_set,
299         .dma_setup              = ide_dma_setup,
300         .dma_start              = ns87415_dma_start,
301         .dma_end                = ns87415_dma_end,
302         .dma_test_irq           = ide_dma_test_irq,
303         .dma_lost_irq           = ide_dma_lost_irq,
304         .dma_timer_expiry       = ide_dma_sff_timer_expiry,
305         .dma_sff_read_status    = superio_dma_sff_read_status,
306 };
307
308 static const struct ide_port_info ns87415_chipset __devinitdata = {
309         .name           = DRV_NAME,
310         .init_hwif      = init_hwif_ns87415,
311         .port_ops       = &ns87415_port_ops,
312         .dma_ops        = &ns87415_dma_ops,
313         .host_flags     = IDE_HFLAG_TRUST_BIOS_FOR_DMA |
314                           IDE_HFLAG_NO_ATAPI_DMA,
315 };
316
317 static int __devinit ns87415_init_one(struct pci_dev *dev, const struct pci_device_id *id)
318 {
319         struct ide_port_info d = ns87415_chipset;
320
321 #ifdef CONFIG_SUPERIO
322         if (PCI_SLOT(dev->devfn) == 0xE) {
323                 /* Built-in - assume it's under superio. */
324                 d.init_iops = superio_init_iops;
325                 d.tp_ops = &superio_tp_ops;
326         }
327 #endif
328         return ide_pci_init_one(dev, &d, NULL);
329 }
330
331 static const struct pci_device_id ns87415_pci_tbl[] = {
332         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), 0 },
333         { 0, },
334 };
335 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
336
337 static struct pci_driver ns87415_pci_driver = {
338         .name           = "NS87415_IDE",
339         .id_table       = ns87415_pci_tbl,
340         .probe          = ns87415_init_one,
341         .remove         = ide_pci_remove,
342         .suspend        = ide_pci_suspend,
343         .resume         = ide_pci_resume,
344 };
345
346 static int __init ns87415_ide_init(void)
347 {
348         return ide_pci_register_driver(&ns87415_pci_driver);
349 }
350
351 static void __exit ns87415_ide_exit(void)
352 {
353         pci_unregister_driver(&ns87415_pci_driver);
354 }
355
356 module_init(ns87415_ide_init);
357 module_exit(ns87415_ide_exit);
358
359 MODULE_AUTHOR("Mark Lord, Eddie Dost, Andre Hedrick");
360 MODULE_DESCRIPTION("PCI driver module for NS87415 IDE");
361 MODULE_LICENSE("GPL");