blob: 061aa1c41a4859347f51753e3b194ab20a794fe7 [file] [log] [blame]
Alan Coxc4b5b7b2007-09-29 02:35:10 -04001/*
2 * pata_ns87415.c - NS87415 (non PARISC) PATA
3 *
Alan Coxab771632008-10-27 15:09:10 +00004 * (C) 2005 Red Hat <alan@lxorguk.ukuu.org.uk>
Alan Coxc4b5b7b2007-09-29 02:35:10 -04005 *
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
Jeff Garzik2dcb4072007-10-19 06:42:56 -040020 * Implement lazy pio/dma switching for better performance
Alan Coxc4b5b7b2007-09-29 02:35:10 -040021 * 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
53static 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;
Jeff Garzik2dcb4072007-10-19 06:42:56 -040063
Alan Coxc4b5b7b2007-09-29 02:35:10 -040064 /* Timing register format is 17 - low nybble read timing with
65 the high nybble being 16 - x for recovery time in PCI clocks */
Jeff Garzik2dcb4072007-10-19 06:42:56 -040066
Alan Coxc4b5b7b2007-09-29 02:35:10 -040067 ata_timing_compute(adev, adev->pio_mode, &t, T, 0);
68
Harvey Harrison07633b52008-05-14 16:17:00 -070069 clocking = 17 - clamp_val(t.active, 2, 17);
70 clocking |= (16 - clamp_val(t.recover, 1, 16)) << 4;
Alan Coxc4b5b7b2007-09-29 02:35:10 -040071 /* Use the same timing for read and write bytes */
72 clocking |= (clocking << 8);
73 pci_write_config_word(dev, timing, clocking);
Jeff Garzik2dcb4072007-10-19 06:42:56 -040074
Alan Coxc4b5b7b2007-09-29 02:35:10 -040075 /* 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
108static 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
121static 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 */
Tejun Heo5682ed32008-04-07 22:47:16 +0900141 ap->ops->sff_exec_command(ap, &qc->tf);
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400142}
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
155static 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
168static 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/**
Tejun Heo9363c382008-04-07 22:47:16 +0900175 * ns87415_irq_clear - Clear interrupt
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400176 * @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
Tejun Heo9363c382008-04-07 22:47:16 +0900182static void ns87415_irq_clear(struct ata_port *ap)
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400183{
184 void __iomem *mmio = ap->ioaddr.bmdma_addr;
185
186 if (!mmio)
187 return;
Jeff Garzik2dcb4072007-10-19 06:42:56 -0400188 iowrite8((ioread8(mmio + ATA_DMA_CMD) | ATA_DMA_INTR | ATA_DMA_ERR),
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400189 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
200static 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
Frank Lichtenhelda9efacb2007-10-29 02:49:20 +0100218#define SUPERIO_IDE_MAX_RETRIES 25
219
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400220/**
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
227static 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
248static 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 */
264void 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
296static u8 ns87560_bmdma_status(struct ata_port *ap)
297{
298 return ns87560_read_buggy(ap->ioaddr.bmdma_addr + ATA_DMA_STATUS);
299}
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400300#endif /* 87560 SuperIO Support */
301
Tejun Heo029cfd62008-03-25 12:22:49 +0900302static struct ata_port_operations ns87415_pata_ops = {
303 .inherits = &ata_bmdma_port_ops,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400304
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400305 .check_atapi_dma = ns87415_check_atapi_dma,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400306 .bmdma_setup = ns87415_bmdma_setup,
307 .bmdma_start = ns87415_bmdma_start,
308 .bmdma_stop = ns87415_bmdma_stop,
Tejun Heo5682ed32008-04-07 22:47:16 +0900309 .sff_irq_clear = ns87415_irq_clear,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400310
Tejun Heo029cfd62008-03-25 12:22:49 +0900311 .cable_detect = ata_cable_40wire,
312 .set_piomode = ns87415_set_piomode,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400313};
314
Tejun Heo029cfd62008-03-25 12:22:49 +0900315#if defined(CONFIG_SUPERIO)
316static struct ata_port_operations ns87560_pata_ops = {
317 .inherits = &ns87415_pata_ops,
Tejun Heo5682ed32008-04-07 22:47:16 +0900318 .sff_tf_read = ns87560_tf_read,
319 .sff_check_status = ns87560_check_status,
Tejun Heo029cfd62008-03-25 12:22:49 +0900320 .bmdma_status = ns87560_bmdma_status,
321};
322#endif
323
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400324static struct scsi_host_template ns87415_sht = {
Tejun Heo68d1d072008-03-25 12:22:49 +0900325 ATA_BMDMA_SHT(DRV_NAME),
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400326};
327
Bartlomiej Zolnierkiewicza809c682009-12-03 20:32:12 +0100328static void ns87415_fixup(struct pci_dev *pdev)
329{
330 /* Select 512 byte sectors */
331 pci_write_config_byte(pdev, 0x55, 0xEE);
332 /* Select PIO0 8bit clocking */
333 pci_write_config_byte(pdev, 0x54, 0xB7);
334}
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400335
336/**
337 * ns87415_init_one - Register 87415 ATA PCI device with kernel services
338 * @pdev: PCI device to register
339 * @ent: Entry in ns87415_pci_tbl matching with @pdev
340 *
341 * Called from kernel PCI layer. We probe for combined mode (sigh),
342 * and then hand over control to libata, for it to do the rest.
343 *
344 * LOCKING:
345 * Inherited from PCI layer (may sleep).
346 *
347 * RETURNS:
348 * Zero on success, or -ERRNO value.
349 */
350
351static int ns87415_init_one (struct pci_dev *pdev, const struct pci_device_id *ent)
352{
353 static int printed_version;
354 static const struct ata_port_info info = {
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400355 .flags = ATA_FLAG_SLAVE_POSS,
Erik Inge Bolsø14bdef92009-03-14 21:38:24 +0100356 .pio_mask = ATA_PIO4,
357 .mwdma_mask = ATA_MWDMA2,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400358 .port_ops = &ns87415_pata_ops,
359 };
360 const struct ata_port_info *ppi[] = { &info, NULL };
Tejun Heof08048e2008-03-25 12:22:47 +0900361 int rc;
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400362#if defined(CONFIG_SUPERIO)
363 static const struct ata_port_info info87560 = {
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400364 .flags = ATA_FLAG_SLAVE_POSS,
Erik Inge Bolsø14bdef92009-03-14 21:38:24 +0100365 .pio_mask = ATA_PIO4,
366 .mwdma_mask = ATA_MWDMA2,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400367 .port_ops = &ns87560_pata_ops,
368 };
369
370 if (PCI_SLOT(pdev->devfn) == 0x0E)
371 ppi[0] = &info87560;
372#endif
373 if (!printed_version++)
374 dev_printk(KERN_DEBUG, &pdev->dev,
375 "version " DRV_VERSION "\n");
Tejun Heof08048e2008-03-25 12:22:47 +0900376
377 rc = pcim_enable_device(pdev);
378 if (rc)
379 return rc;
380
Bartlomiej Zolnierkiewicza809c682009-12-03 20:32:12 +0100381 ns87415_fixup(pdev);
382
Tejun Heo9363c382008-04-07 22:47:16 +0900383 return ata_pci_sff_init_one(pdev, ppi, &ns87415_sht, NULL);
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400384}
385
386static const struct pci_device_id ns87415_pci_tbl[] = {
387 { PCI_VDEVICE(NS, PCI_DEVICE_ID_NS_87415), },
388
389 { } /* terminate list */
390};
391
Bartlomiej Zolnierkiewicza809c682009-12-03 20:32:12 +0100392#ifdef CONFIG_PM
393static int ns87415_reinit_one(struct pci_dev *pdev)
394{
395 struct ata_host *host = dev_get_drvdata(&pdev->dev);
396 int rc;
397
398 rc = ata_pci_device_do_resume(pdev);
399 if (rc)
400 return rc;
401
402 ns87415_fixup(pdev);
403
404 ata_host_resume(host);
405 return 0;
406}
407#endif
408
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400409static struct pci_driver ns87415_pci_driver = {
410 .name = DRV_NAME,
411 .id_table = ns87415_pci_tbl,
412 .probe = ns87415_init_one,
413 .remove = ata_pci_remove_one,
414#ifdef CONFIG_PM
415 .suspend = ata_pci_device_suspend,
Bartlomiej Zolnierkiewicza809c682009-12-03 20:32:12 +0100416 .resume = ns87415_reinit_one,
Alan Coxc4b5b7b2007-09-29 02:35:10 -0400417#endif
418};
419
420static int __init ns87415_init(void)
421{
422 return pci_register_driver(&ns87415_pci_driver);
423}
424
425static void __exit ns87415_exit(void)
426{
427 pci_unregister_driver(&ns87415_pci_driver);
428}
429
430module_init(ns87415_init);
431module_exit(ns87415_exit);
432
433MODULE_AUTHOR("Alan Cox");
434MODULE_DESCRIPTION("ATA low-level driver for NS87415 controllers");
435MODULE_LICENSE("GPL");
436MODULE_DEVICE_TABLE(pci, ns87415_pci_tbl);
437MODULE_VERSION(DRV_VERSION);