93eb958cb0c94689713292e0db064ff27fe80097
[linux-2.6.git] / drivers / ata / pata_ns87415.c
1 /*
2  *    pata_ns87415.c - NS87415 (non PARISC) PATA
3  *
4  *      (C) 2005 Red Hat <alan@redhat.com>
5  *
6  *    This is a fairly generic MWDMA controller. It has some limitations
7  *    as it requires timing reloads on PIO/DMA transitions but it is otherwise
8  *    fairly well designed.
9  *
10  *    This driver assumes the firmware has left the chip in a valid ST506
11  *    compliant state, either legacy IRQ 14/15 or native INTA shared. You
12  *    may need to add platform code if your system fails to do this.
13  *
14  *    The same cell appears in the 87560 controller used by some PARISC
15  *    systems. This has its own special mountain of errata.
16  *
17  *    TODO:
18  *      Test PARISC SuperIO
19  *      Get someone to test on SPARC
20  *      Implement lazy pio/dma switching for better performance
21  *      8bit shared timing.
22  *      See if we need to kill the FIFO for ATAPI
23  */
24
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/pci.h>
28 #include <linux/init.h>
29 #include <linux/blkdev.h>
30 #include <linux/delay.h>
31 #include <linux/device.h>
32 #include <scsi/scsi_host.h>
33 #include <linux/libata.h>
34 #include <linux/ata.h>
35
36 #define DRV_NAME        "pata_ns87415"
37 #define DRV_VERSION     "0.0.1"
38
39 /**
40  *      ns87415_set_mode - Initialize host controller mode timings
41  *      @ap: Port whose timings we are configuring
42  *      @adev: Device whose timings we are configuring
43  *      @mode: Mode to set
44  *
45  *      Program the mode registers for this controller, channel and
46  *      device. Because the chip is quite an old design we have to do this
47  *      for PIO/DMA switches.
48  *
49  *      LOCKING:
50  *      None (inherited from caller).
51  */
52
53 static void ns87415_set_mode(struct ata_port *ap, struct ata_device *adev, u8 mode)
54 {
55         struct pci_dev *dev     = to_pci_dev(ap->host->dev);
56         int unit                = 2 * ap->port_no + adev->devno;
57         int timing              = 0x44 + 2 * unit;
58         unsigned long T         = 1000000000 / 33333;   /* PCI clocks */
59         struct ata_timing t;
60         u16 clocking;
61         u8 iordy;
62         u8 status;
63
64         /* Timing register format is 17 - low nybble read timing with
65            the high nybble being 16 - x for recovery time in PCI clocks */
66
67         ata_timing_compute(adev, adev->pio_mode, &t, T, 0);
68
69         clocking = 17 - FIT(t.active, 2, 17);
70         clocking |= (16 - FIT(t.recover, 1, 16)) << 4;
71         /* Use the same timing for read and write bytes */
72         clocking |= (clocking << 8);
73         pci_write_config_word(dev, timing, clocking);
74
75         /* Set the IORDY enable versus DMA enable on or off properly */
76         pci_read_config_byte(dev, 0x42, &iordy);
77         iordy &= ~(1 << (4 + unit));
78         if (mode >= XFER_MW_DMA_0 || !ata_pio_need_iordy(adev))
79                 iordy |= (1 << (4 + unit));
80
81         /* Paranoia: We shouldn't ever get here with busy write buffers
82            but if so wait */
83
84         pci_read_config_byte(dev, 0x43, &status);
85         while (status & 0x03) {
86                 udelay(1);
87                 pci_read_config_byte(dev, 0x43, &status);
88         }
89         /* Flip the IORDY/DMA bits now we are sure the write buffers are
90            clear */
91         pci_write_config_byte(dev, 0x42, iordy);
92
93         /* TODO: Set byte 54 command timing to the best 8bit
94            mode shared by all four devices */
95 }
96
97 /**
98  *      ns87415_set_piomode - Initialize host controller PATA PIO timings
99  *      @ap: Port whose timings we are configuring
100  *      @adev: Device to program
101  *
102  *      Set PIO mode for device, in host controller PCI config space.
103  *
104  *      LOCKING:
105  *      None (inherited from caller).
106  */
107
108 static void ns87415_set_piomode(struct ata_port *ap, struct ata_device *adev)
109 {
110         ns87415_set_mode(ap, adev, adev->pio_mode);
111 }
112
113 /**
114  *      ns87415_bmdma_setup             -       Set up DMA
115  *      @qc: Command block
116  *
117  *      Set up for bus masterng DMA. We have to do this ourselves
118  *      rather than use the helper due to a chip erratum
119  */
120
121 static void ns87415_bmdma_setup(struct ata_queued_cmd *qc)
122 {
123         struct ata_port *ap = qc->ap;
124         unsigned int rw = (qc->tf.flags & ATA_TFLAG_WRITE);
125         u8 dmactl;
126
127         /* load PRD table addr. */
128         mb();   /* make sure PRD table writes are visible to controller */
129         iowrite32(ap->prd_dma, ap->ioaddr.bmdma_addr + ATA_DMA_TABLE_OFS);
130
131         /* specify data direction, triple-check start bit is clear */
132         dmactl = ioread8(ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
133         dmactl &= ~(ATA_DMA_WR | ATA_DMA_START);
134         /* Due to an erratum we need to write these bits to the wrong
135            place - which does save us an I/O bizarrely */
136         dmactl |= ATA_DMA_INTR | ATA_DMA_ERR;
137         if (!rw)
138                 dmactl |= ATA_DMA_WR;
139         iowrite8(dmactl, ap->ioaddr.bmdma_addr + ATA_DMA_CMD);
140         /* issue r/w command */
141         ap->ops->exec_command(ap, &qc->tf);
142 }
143
144 /**
145  *      ns87415_bmdma_start             -       Begin DMA transfer
146  *      @qc: Command block
147  *
148  *      Switch the timings for the chip and set up for a DMA transfer
149  *      before the DMA burst begins.
150  *
151  *      FIXME: We should do lazy switching on bmdma_start versus
152  *      ata_pio_data_xfer for better performance.
153  */
154
155 static void ns87415_bmdma_start(struct ata_queued_cmd *qc)
156 {
157         ns87415_set_mode(qc->ap, qc->dev, qc->dev->dma_mode);
158         ata_bmdma_start(qc);
159 }
160
161 /**
162  *      ns87415_bmdma_stop              -       End DMA transfer
163  *      @qc: Command block
164  *
165  *      End DMA mode and switch the controller back into PIO mode
166  */
167
168 static void ns87415_bmdma_stop(struct ata_queued_cmd *qc)
169 {
170         ata_bmdma_stop(qc);
171         ns87415_set_mode(qc->ap, qc->dev, qc->dev->pio_mode);
172 }
173
174 /**
175  *      ns87415_bmdma_irq_clear         -       Clear interrupt
176  *      @ap: Channel to clear
177  *
178  *      Erratum: Due to a chip bug regisers 02 and 0A bit 1 and 2 (the
179  *      error bits) are reset by writing to register 00 or 08.
180  */
181
182 static void ns87415_bmdma_irq_clear(struct ata_port *ap)
183 {
184         void __iomem *mmio = ap->ioaddr.bmdma_addr;
185
186         if (!mmio)
187                 return;
188         iowrite8((ioread8(mmio + ATA_DMA_CMD) | ATA_DMA_INTR | ATA_DMA_ERR),
189                         mmio + ATA_DMA_CMD);
190 }
191
192 /**
193  *      ns87415_check_atapi_dma         -       ATAPI DMA filter
194  *      @qc: Command block
195  *
196  *      Disable ATAPI DMA (for now). We may be able to do DMA if we
197  *      kill the prefetching. This isn't clear.
198  */
199
200 static int ns87415_check_atapi_dma(struct ata_queued_cmd *qc)
201 {
202         return -EOPNOTSUPP;
203 }
204
205 #if defined(CONFIG_SUPERIO)
206
207 /* SUPERIO 87560 is a PoS chip that NatSem denies exists.
208  * Unfortunately, it's built-in on all Astro-based PA-RISC workstations
209  * which use the integrated NS87514 cell for CD-ROM support.
210  * i.e we have to support for CD-ROM installs.
211  * See drivers/parisc/superio.c for more gory details.
212  *
213  * Workarounds taken from drivers/ide/pci/ns87415.c
214  */
215
216 #include <asm/superio.h>
217
218 #define SUPERIO_IDE_MAX_RETRIES 25
219
220 /**
221  *      ns87560_read_buggy      -       workaround buggy Super I/O chip
222  *      @port: Port to read
223  *
224  *      Work around chipset problems in the 87560 SuperIO chip
225  */
226
227 static u8 ns87560_read_buggy(void __iomem *port)
228 {
229         u8 tmp;
230         int retries = SUPERIO_IDE_MAX_RETRIES;
231         do {
232                 tmp = ioread8(port);
233                 if (tmp != 0)
234                         return tmp;
235                 udelay(50);
236         } while(retries-- > 0);
237         return tmp;
238 }
239
240 /**
241  *      ns87560_check_status
242  *      @ap: channel to check
243  *
244  *      Return the status of the channel working around the
245  *      87560 flaws.
246  */
247
248 static u8 ns87560_check_status(struct ata_port *ap)
249 {
250         return ns87560_read_buggy(ap->ioaddr.status_addr);
251 }
252
253 /**
254  *      ns87560_tf_read - input device's ATA taskfile shadow registers
255  *      @ap: Port from which input is read
256  *      @tf: ATA taskfile register set for storing input
257  *
258  *      Reads ATA taskfile registers for currently-selected device
259  *      into @tf. Work around the 87560 bugs.
260  *
261  *      LOCKING:
262  *      Inherited from caller.
263  */
264 void ns87560_tf_read(struct ata_port *ap, struct ata_taskfile *tf)
265 {
266         struct ata_ioports *ioaddr = &ap->ioaddr;
267
268         tf->command = ns87560_check_status(ap);
269         tf->feature = ioread8(ioaddr->error_addr);
270         tf->nsect = ioread8(ioaddr->nsect_addr);
271         tf->lbal = ioread8(ioaddr->lbal_addr);
272         tf->lbam = ioread8(ioaddr->lbam_addr);
273         tf->lbah = ioread8(ioaddr->lbah_addr);
274         tf->device = ns87560_read_buggy(ioaddr->device_addr);
275
276         if (tf->flags & ATA_TFLAG_LBA48) {
277                 iowrite8(tf->ctl | ATA_HOB, ioaddr->ctl_addr);
278                 tf->hob_feature = ioread8(ioaddr->error_addr);
279                 tf->hob_nsect = ioread8(ioaddr->nsect_addr);
280                 tf->hob_lbal = ioread8(ioaddr->lbal_addr);
281                 tf->hob_lbam = ioread8(ioaddr->lbam_addr);
282                 tf->hob_lbah = ioread8(ioaddr->lbah_addr);
283                 iowrite8(tf->ctl, ioaddr->ctl_addr);
284                 ap->last_ctl = tf->ctl;
285         }
286 }
287
288 /**
289  *      ns87560_bmdma_status
290  *      @ap: channel to check
291  *
292  *      Return the DMA status of the channel working around the
293  *      87560 flaws.
294  */
295
296 static u8 ns87560_bmdma_status(struct ata_port *ap)
297 {
298         return ns87560_read_buggy(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
299 }
300
301 static const struct ata_port_operations ns87560_pata_ops = {
302         .set_piomode            = ns87415_set_piomode,
303         .mode_filter            = ata_pci_default_filter,
304
305         .tf_load                = ata_tf_load,
306         .tf_read                = ns87560_tf_read,
307         .check_status           = ns87560_check_status,
308         .check_atapi_dma        = ns87415_check_atapi_dma,
309         .exec_command           = ata_exec_command,
310         .dev_select             = ata_std_dev_select,
311
312         .freeze                 = ata_bmdma_freeze,
313         .thaw                   = ata_bmdma_thaw,
314         .error_handler          = ata_bmdma_error_handler,
315         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
316         .cable_detect           = ata_cable_40wire,
317
318         .bmdma_setup            = ns87415_bmdma_setup,
319         .bmdma_start            = ns87415_bmdma_start,
320         .bmdma_stop             = ns87415_bmdma_stop,
321         .bmdma_status           = ns87560_bmdma_status,
322         .qc_prep                = ata_qc_prep,
323         .qc_issue               = ata_qc_issue_prot,
324         .data_xfer              = ata_data_xfer,
325
326         .irq_handler            = ata_interrupt,
327         .irq_clear              = ns87415_bmdma_irq_clear,
328         .irq_on                 = ata_irq_on,
329
330         .port_start             = ata_sff_port_start,
331 };
332
333 #endif          /* 87560 SuperIO Support */
334
335
336 static const struct ata_port_operations ns87415_pata_ops = {
337         .set_piomode            = ns87415_set_piomode,
338         .mode_filter            = ata_pci_default_filter,
339
340         .tf_load                = ata_tf_load,
341         .tf_read                = ata_tf_read,
342         .check_status           = ata_check_status,
343         .check_atapi_dma        = ns87415_check_atapi_dma,
344         .exec_command           = ata_exec_command,
345         .dev_select             = ata_std_dev_select,
346
347         .freeze                 = ata_bmdma_freeze,
348         .thaw                   = ata_bmdma_thaw,
349         .error_handler          = ata_bmdma_error_handler,
350         .post_internal_cmd      = ata_bmdma_post_internal_cmd,
351         .cable_detect           = ata_cable_40wire,
352
353         .bmdma_setup            = ns87415_bmdma_setup,
354         .bmdma_start            = ns87415_bmdma_start,
355         .bmdma_stop             = ns87415_bmdma_stop,
356         .bmdma_status           = ata_bmdma_status,
357         .qc_prep                = ata_qc_prep,
358         .qc_issue               = ata_qc_issue_prot,
359         .data_xfer              = ata_data_xfer,
360
361         .irq_handler            = ata_interrupt,
362         .irq_clear              = ns87415_bmdma_irq_clear,
363         .irq_on                 = ata_irq_on,
364
365         .port_start             = ata_sff_port_start,
366 };
367
368 static struct scsi_host_template ns87415_sht = {
369         .module                 = THIS_MODULE,
370         .name                   = DRV_NAME,
371         .ioctl                  = ata_scsi_ioctl,
372         .queuecommand           = ata_scsi_queuecmd,
373         .can_queue              = ATA_DEF_QUEUE,
374         .this_id                = ATA_SHT_THIS_ID,
375         .sg_tablesize           = LIBATA_MAX_PRD,
376         .cmd_per_lun            = ATA_SHT_CMD_PER_LUN,
377         .emulated               = ATA_SHT_EMULATED,
378         .use_clustering         = ATA_SHT_USE_CLUSTERING,
379         .proc_name              = DRV_NAME,
380         .dma_boundary           = ATA_DMA_BOUNDARY,
381         .slave_configure        = ata_scsi_slave_config,
382         .slave_destroy          = ata_scsi_slave_destroy,
383         .bios_param             = ata_std_bios_param,
384 };
385
386
387 /**
388  *      ns87415_init_one - Register 87415 ATA PCI device with kernel services
389  *      @pdev: PCI device to register
390  *      @ent: Entry in ns87415_pci_tbl matching with @pdev
391  *
392  *      Called from kernel PCI layer.  We probe for combined mode (sigh),
393  *      and then hand over control to libata, for it to do the rest.
394  *
395  *      LOCKING:
396  *      Inherited from PCI layer (may sleep).
397  *
398  *      RETURNS:
399  *      Zero on success, or -ERRNO value.
400  */
401
402 static int ns87415_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
403 {
404         static int printed_version;
405         static const struct ata_port_info info = {
406                 .sht            = &ns87415_sht,
407                 .flags          = ATA_FLAG_SLAVE_POSS,
408                 .pio_mask       = 0x1f, /* pio0-4 */
409                 .mwdma_mask     = 0x07, /* mwdma0-2 */
410                 .port_ops       = &ns87415_pata_ops,
411         };
412         const struct ata_port_info *ppi[] = { &info, NULL };
413         int rc;
414 #if defined(CONFIG_SUPERIO)
415         static const struct ata_port_info info87560 = {
416                 .sht            = &ns87415_sht,
417                 .flags          = ATA_FLAG_SLAVE_POSS,
418                 .pio_mask       = 0x1f, /* pio0-4 */
419                 .mwdma_mask     = 0x07, /* mwdma0-2 */
420                 .port_ops       = &ns87560_pata_ops,
421         };
422
423         if (PCI_SLOT(pdev->devfn) == 0x0E)
424                 ppi[0] = &info87560;
425 #endif
426         if (!printed_version++)
427                 dev_printk(KERN_DEBUG, &pdev->dev,
428                            "version " DRV_VERSION "\n");
429
430         rc = pcim_enable_device(pdev);
431         if (rc)
432                 return rc;
433
434         /* Select 512 byte sectors */
435         pci_write_config_byte(pdev, 0x55, 0xEE);
436         /* Select PIO0 8bit clocking */
437         pci_write_config_byte(pdev, 0x54, 0xB7);
438         return ata_pci_init_one(pdev, ppi);
439 }
440
441 static const struct pci_device_id ns87415_pci_tbl[] = {
442         { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), },
443
444         { }     /* terminate list */
445 };
446
447 static struct pci_driver ns87415_pci_driver = {
448         .name                   = DRV_NAME,
449         .id_table               = ns87415_pci_tbl,
450         .probe                  = ns87415_init_one,
451         .remove                 = ata_pci_remove_one,
452 #ifdef CONFIG_PM
453         .suspend                = ata_pci_device_suspend,
454         .resume                 = ata_pci_device_resume,
455 #endif
456 };
457
458 static int __init ns87415_init(void)
459 {
460         return pci_register_driver(&ns87415_pci_driver);
461 }
462
463 static void __exit ns87415_exit(void)
464 {
465         pci_unregister_driver(&ns87415_pci_driver);
466 }
467
468 module_init(ns87415_init);
469 module_exit(ns87415_exit);
470
471 MODULE_AUTHOR("Alan Cox");
472 MODULE_DESCRIPTION("ATA low-level driver for NS87415 controllers");
473 MODULE_LICENSE("GPL");
474 MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
475 MODULE_VERSION(DRV_VERSION);