libata: beef up iterators
[linux-3.10.git] / drivers / ata / pata_legacy.c
1 /*
2  *   pata-legacy.c - Legacy port PATA/SATA controller driver.
3  *   Copyright 2005/2006 Red Hat, all rights reserved.
4  *
5  *  This program is free software; you can redistribute it and/or modify
6  *  it under the terms of the GNU General Public License as published by
7  *  the Free Software Foundation; either version 2, or (at your option)
8  *  any later version.
9  *
10  *  This program is distributed in the hope that it will be useful,
11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  *  GNU General Public License for more details.
14  *
15  *  You should have received a copy of the GNU General Public License
16  *  along with this program; see the file COPYING.  If not, write to
17  *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
18  *
19  *   An ATA driver for the legacy ATA ports.
20  *
21  *   Data Sources:
22  *      Opti 82C465/82C611 support: Data sheets at opti-inc.com
23  *      HT6560 series:
24  *      Promise 20230/20620:
25  *              http://www.ryston.cz/petr/vlb/pdc20230b.html
26  *              http://www.ryston.cz/petr/vlb/pdc20230c.html
27  *              http://www.ryston.cz/petr/vlb/pdc20630.html
28  *
29  *  Unsupported but docs exist:
30  *      Appian/Adaptec AIC25VL01/Cirrus Logic PD7220
31  *
32  *  This driver handles legacy (that is "ISA/VLB side") IDE ports found
33  *  on PC class systems. There are three hybrid devices that are exceptions
34  *  The Cyrix 5510/5520 where a pre SFF ATA device is on the bridge and
35  *  the MPIIX where the tuning is PCI side but the IDE is "ISA side".
36  *
37  *  Specific support is included for the ht6560a/ht6560b/opti82c611a/
38  *  opti82c465mv/promise 20230c/20630/winbond83759A
39  *
40  *  Use the autospeed and pio_mask options with:
41  *      Appian ADI/2 aka CLPD7220 or AIC25VL01.
42  *  Use the jumpers, autospeed and set pio_mask to the mode on the jumpers with
43  *      Goldstar GM82C711, PIC-1288A-125, UMC 82C871F, Winbond W83759,
44  *      Winbond W83759A, Promise PDC20230-B
45  *
46  *  For now use autospeed and pio_mask as above with the W83759A. This may
47  *  change.
48  *
49  */
50
51 #include <linux/kernel.h>
52 #include <linux/module.h>
53 #include <linux/pci.h>
54 #include <linux/init.h>
55 #include <linux/blkdev.h>
56 #include <linux/delay.h>
57 #include <scsi/scsi_host.h>
58 #include <linux/ata.h>
59 #include <linux/libata.h>
60 #include <linux/platform_device.h>
61
62 #define DRV_NAME "pata_legacy"
63 #define DRV_VERSION "0.6.5"
64
65 #define NR_HOST 6
66
67 static int all;
68 module_param(all, int, 0444);
69 MODULE_PARM_DESC(all, "Grab all legacy port devices, even if PCI(0=off, 1=on)");
70
71 struct legacy_data {
72         unsigned long timing;
73         u8 clock[2];
74         u8 last;
75         int fast;
76         struct platform_device *platform_dev;
77
78 };
79
80 enum controller {
81         BIOS = 0,
82         SNOOP = 1,
83         PDC20230 = 2,
84         HT6560A = 3,
85         HT6560B = 4,
86         OPTI611A = 5,
87         OPTI46X = 6,
88         QDI6500 = 7,
89         QDI6580 = 8,
90         QDI6580DP = 9,          /* Dual channel mode is different */
91         W83759A = 10,
92
93         UNKNOWN = -1
94 };
95
96
97 struct legacy_probe {
98         unsigned char *name;
99         unsigned long port;
100         unsigned int irq;
101         unsigned int slot;
102         enum controller type;
103         unsigned long private;
104 };
105
106 struct legacy_controller {
107         const char *name;
108         struct ata_port_operations *ops;
109         unsigned int pio_mask;
110         unsigned int flags;
111         int (*setup)(struct platform_device *, struct legacy_probe *probe,
112                 struct legacy_data *data);
113 };
114
115 static int legacy_port[NR_HOST] = { 0x1f0, 0x170, 0x1e8, 0x168, 0x1e0, 0x160 };
116
117 static struct legacy_probe probe_list[NR_HOST];
118 static struct legacy_data legacy_data[NR_HOST];
119 static struct ata_host *legacy_host[NR_HOST];
120 static int nr_legacy_host;
121
122
123 static int probe_all;           /* Set to check all ISA port ranges */
124 static int ht6560a;             /* HT 6560A on primary 1, second 2, both 3 */
125 static int ht6560b;             /* HT 6560A on primary 1, second 2, both 3 */
126 static int opti82c611a;         /* Opti82c611A on primary 1, sec 2, both 3 */
127 static int opti82c46x;          /* Opti 82c465MV present(pri/sec autodetect) */
128 static int qdi;                 /* Set to probe QDI controllers */
129 static int winbond;             /* Set to probe Winbond controllers,
130                                         give I/O port if non standard */
131 static int autospeed;           /* Chip present which snoops speed changes */
132 static int pio_mask = 0x1F;     /* PIO range for autospeed devices */
133 static int iordy_mask = 0xFFFFFFFF;     /* Use iordy if available */
134
135 /**
136  *      legacy_probe_add        -       Add interface to probe list
137  *      @port: Controller port
138  *      @irq: IRQ number
139  *      @type: Controller type
140  *      @private: Controller specific info
141  *
142  *      Add an entry into the probe list for ATA controllers. This is used
143  *      to add the default ISA slots and then to build up the table
144  *      further according to other ISA/VLB/Weird device scans
145  *
146  *      An I/O port list is used to keep ordering stable and sane, as we
147  *      don't have any good way to talk about ordering otherwise
148  */
149
150 static int legacy_probe_add(unsigned long port, unsigned int irq,
151                                 enum controller type, unsigned long private)
152 {
153         struct legacy_probe *lp = &probe_list[0];
154         int i;
155         struct legacy_probe *free = NULL;
156
157         for (i = 0; i < NR_HOST; i++) {
158                 if (lp->port == 0 && free == NULL)
159                         free = lp;
160                 /* Matching port, or the correct slot for ordering */
161                 if (lp->port == port || legacy_port[i] == port) {
162                         free = lp;
163                         break;
164                 }
165                 lp++;
166         }
167         if (free == NULL) {
168                 printk(KERN_ERR "pata_legacy: Too many interfaces.\n");
169                 return -1;
170         }
171         /* Fill in the entry for later probing */
172         free->port = port;
173         free->irq = irq;
174         free->type = type;
175         free->private = private;
176         return 0;
177 }
178
179
180 /**
181  *      legacy_set_mode         -       mode setting
182  *      @link: IDE link
183  *      @unused: Device that failed when error is returned
184  *
185  *      Use a non standard set_mode function. We don't want to be tuned.
186  *
187  *      The BIOS configured everything. Our job is not to fiddle. Just use
188  *      whatever PIO the hardware is using and leave it at that. When we
189  *      get some kind of nice user driven API for control then we can
190  *      expand on this as per hdparm in the base kernel.
191  */
192
193 static int legacy_set_mode(struct ata_link *link, struct ata_device **unused)
194 {
195         struct ata_device *dev;
196
197         ata_for_each_dev(dev, link, ENABLED) {
198                 ata_dev_printk(dev, KERN_INFO, "configured for PIO\n");
199                 dev->pio_mode = XFER_PIO_0;
200                 dev->xfer_mode = XFER_PIO_0;
201                 dev->xfer_shift = ATA_SHIFT_PIO;
202                 dev->flags |= ATA_DFLAG_PIO;
203         }
204         return 0;
205 }
206
207 static struct scsi_host_template legacy_sht = {
208         ATA_PIO_SHT(DRV_NAME),
209 };
210
211 static const struct ata_port_operations legacy_base_port_ops = {
212         .inherits       = &ata_sff_port_ops,
213         .cable_detect   = ata_cable_40wire,
214 };
215
216 /*
217  *      These ops are used if the user indicates the hardware
218  *      snoops the commands to decide on the mode and handles the
219  *      mode selection "magically" itself. Several legacy controllers
220  *      do this. The mode range can be set if it is not 0x1F by setting
221  *      pio_mask as well.
222  */
223
224 static struct ata_port_operations simple_port_ops = {
225         .inherits       = &legacy_base_port_ops,
226         .sff_data_xfer  = ata_sff_data_xfer_noirq,
227 };
228
229 static struct ata_port_operations legacy_port_ops = {
230         .inherits       = &legacy_base_port_ops,
231         .sff_data_xfer  = ata_sff_data_xfer_noirq,
232         .set_mode       = legacy_set_mode,
233 };
234
235 /*
236  *      Promise 20230C and 20620 support
237  *
238  *      This controller supports PIO0 to PIO2. We set PIO timings
239  *      conservatively to allow for 50MHz Vesa Local Bus. The 20620 DMA
240  *      support is weird being DMA to controller and PIO'd to the host
241  *      and not supported.
242  */
243
244 static void pdc20230_set_piomode(struct ata_port *ap, struct ata_device *adev)
245 {
246         int tries = 5;
247         int pio = adev->pio_mode - XFER_PIO_0;
248         u8 rt;
249         unsigned long flags;
250
251         /* Safe as UP only. Force I/Os to occur together */
252
253         local_irq_save(flags);
254
255         /* Unlock the control interface */
256         do {
257                 inb(0x1F5);
258                 outb(inb(0x1F2) | 0x80, 0x1F2);
259                 inb(0x1F2);
260                 inb(0x3F6);
261                 inb(0x3F6);
262                 inb(0x1F2);
263                 inb(0x1F2);
264         }
265         while ((inb(0x1F2) & 0x80) && --tries);
266
267         local_irq_restore(flags);
268
269         outb(inb(0x1F4) & 0x07, 0x1F4);
270
271         rt = inb(0x1F3);
272         rt &= 0x07 << (3 * adev->devno);
273         if (pio)
274                 rt |= (1 + 3 * pio) << (3 * adev->devno);
275
276         udelay(100);
277         outb(inb(0x1F2) | 0x01, 0x1F2);
278         udelay(100);
279         inb(0x1F5);
280
281 }
282
283 static unsigned int pdc_data_xfer_vlb(struct ata_device *dev,
284                         unsigned char *buf, unsigned int buflen, int rw)
285 {
286         if (ata_id_has_dword_io(dev->id)) {
287                 struct ata_port *ap = dev->link->ap;
288                 int slop = buflen & 3;
289                 unsigned long flags;
290
291                 local_irq_save(flags);
292
293                 /* Perform the 32bit I/O synchronization sequence */
294                 ioread8(ap->ioaddr.nsect_addr);
295                 ioread8(ap->ioaddr.nsect_addr);
296                 ioread8(ap->ioaddr.nsect_addr);
297
298                 /* Now the data */
299                 if (rw == READ)
300                         ioread32_rep(ap->ioaddr.data_addr, buf, buflen >> 2);
301                 else
302                         iowrite32_rep(ap->ioaddr.data_addr, buf, buflen >> 2);
303
304                 if (unlikely(slop)) {
305                         __le32 pad;
306                         if (rw == READ) {
307                                 pad = cpu_to_le32(ioread32(ap->ioaddr.data_addr));
308                                 memcpy(buf + buflen - slop, &pad, slop);
309                         } else {
310                                 memcpy(&pad, buf + buflen - slop, slop);
311                                 iowrite32(le32_to_cpu(pad), ap->ioaddr.data_addr);
312                         }
313                         buflen += 4 - slop;
314                 }
315                 local_irq_restore(flags);
316         } else
317                 buflen = ata_sff_data_xfer_noirq(dev, buf, buflen, rw);
318
319         return buflen;
320 }
321
322 static struct ata_port_operations pdc20230_port_ops = {
323         .inherits       = &legacy_base_port_ops,
324         .set_piomode    = pdc20230_set_piomode,
325         .sff_data_xfer  = pdc_data_xfer_vlb,
326 };
327
328 /*
329  *      Holtek 6560A support
330  *
331  *      This controller supports PIO0 to PIO2 (no IORDY even though higher
332  *      timings can be loaded).
333  */
334
335 static void ht6560a_set_piomode(struct ata_port *ap, struct ata_device *adev)
336 {
337         u8 active, recover;
338         struct ata_timing t;
339
340         /* Get the timing data in cycles. For now play safe at 50Mhz */
341         ata_timing_compute(adev, adev->pio_mode, &t, 20000, 1000);
342
343         active = clamp_val(t.active, 2, 15);
344         recover = clamp_val(t.recover, 4, 15);
345
346         inb(0x3E6);
347         inb(0x3E6);
348         inb(0x3E6);
349         inb(0x3E6);
350
351         iowrite8(recover << 4 | active, ap->ioaddr.device_addr);
352         ioread8(ap->ioaddr.status_addr);
353 }
354
355 static struct ata_port_operations ht6560a_port_ops = {
356         .inherits       = &legacy_base_port_ops,
357         .set_piomode    = ht6560a_set_piomode,
358 };
359
360 /*
361  *      Holtek 6560B support
362  *
363  *      This controller supports PIO0 to PIO4. We honour the BIOS/jumper FIFO
364  *      setting unless we see an ATAPI device in which case we force it off.
365  *
366  *      FIXME: need to implement 2nd channel support.
367  */
368
369 static void ht6560b_set_piomode(struct ata_port *ap, struct ata_device *adev)
370 {
371         u8 active, recover;
372         struct ata_timing t;
373
374         /* Get the timing data in cycles. For now play safe at 50Mhz */
375         ata_timing_compute(adev, adev->pio_mode, &t, 20000, 1000);
376
377         active = clamp_val(t.active, 2, 15);
378         recover = clamp_val(t.recover, 2, 16);
379         recover &= 0x15;
380
381         inb(0x3E6);
382         inb(0x3E6);
383         inb(0x3E6);
384         inb(0x3E6);
385
386         iowrite8(recover << 4 | active, ap->ioaddr.device_addr);
387
388         if (adev->class != ATA_DEV_ATA) {
389                 u8 rconf = inb(0x3E6);
390                 if (rconf & 0x24) {
391                         rconf &= ~0x24;
392                         outb(rconf, 0x3E6);
393                 }
394         }
395         ioread8(ap->ioaddr.status_addr);
396 }
397
398 static struct ata_port_operations ht6560b_port_ops = {
399         .inherits       = &legacy_base_port_ops,
400         .set_piomode    = ht6560b_set_piomode,
401 };
402
403 /*
404  *      Opti core chipset helpers
405  */
406
407 /**
408  *      opti_syscfg     -       read OPTI chipset configuration
409  *      @reg: Configuration register to read
410  *
411  *      Returns the value of an OPTI system board configuration register.
412  */
413
414 static u8 opti_syscfg(u8 reg)
415 {
416         unsigned long flags;
417         u8 r;
418
419         /* Uniprocessor chipset and must force cycles adjancent */
420         local_irq_save(flags);
421         outb(reg, 0x22);
422         r = inb(0x24);
423         local_irq_restore(flags);
424         return r;
425 }
426
427 /*
428  *      Opti 82C611A
429  *
430  *      This controller supports PIO0 to PIO3.
431  */
432
433 static void opti82c611a_set_piomode(struct ata_port *ap,
434                                                 struct ata_device *adev)
435 {
436         u8 active, recover, setup;
437         struct ata_timing t;
438         struct ata_device *pair = ata_dev_pair(adev);
439         int clock;
440         int khz[4] = { 50000, 40000, 33000, 25000 };
441         u8 rc;
442
443         /* Enter configuration mode */
444         ioread16(ap->ioaddr.error_addr);
445         ioread16(ap->ioaddr.error_addr);
446         iowrite8(3, ap->ioaddr.nsect_addr);
447
448         /* Read VLB clock strapping */
449         clock = 1000000000 / khz[ioread8(ap->ioaddr.lbah_addr) & 0x03];
450
451         /* Get the timing data in cycles */
452         ata_timing_compute(adev, adev->pio_mode, &t, clock, 1000);
453
454         /* Setup timing is shared */
455         if (pair) {
456                 struct ata_timing tp;
457                 ata_timing_compute(pair, pair->pio_mode, &tp, clock, 1000);
458
459                 ata_timing_merge(&t, &tp, &t, ATA_TIMING_SETUP);
460         }
461
462         active = clamp_val(t.active, 2, 17) - 2;
463         recover = clamp_val(t.recover, 1, 16) - 1;
464         setup = clamp_val(t.setup, 1, 4) - 1;
465
466         /* Select the right timing bank for write timing */
467         rc = ioread8(ap->ioaddr.lbal_addr);
468         rc &= 0x7F;
469         rc |= (adev->devno << 7);
470         iowrite8(rc, ap->ioaddr.lbal_addr);
471
472         /* Write the timings */
473         iowrite8(active << 4 | recover, ap->ioaddr.error_addr);
474
475         /* Select the right bank for read timings, also
476            load the shared timings for address */
477         rc = ioread8(ap->ioaddr.device_addr);
478         rc &= 0xC0;
479         rc |= adev->devno;      /* Index select */
480         rc |= (setup << 4) | 0x04;
481         iowrite8(rc, ap->ioaddr.device_addr);
482
483         /* Load the read timings */
484         iowrite8(active << 4 | recover, ap->ioaddr.data_addr);
485
486         /* Ensure the timing register mode is right */
487         rc = ioread8(ap->ioaddr.lbal_addr);
488         rc &= 0x73;
489         rc |= 0x84;
490         iowrite8(rc, ap->ioaddr.lbal_addr);
491
492         /* Exit command mode */
493         iowrite8(0x83,  ap->ioaddr.nsect_addr);
494 }
495
496
497 static struct ata_port_operations opti82c611a_port_ops = {
498         .inherits       = &legacy_base_port_ops,
499         .set_piomode    = opti82c611a_set_piomode,
500 };
501
502 /*
503  *      Opti 82C465MV
504  *
505  *      This controller supports PIO0 to PIO3. Unlike the 611A the MVB
506  *      version is dual channel but doesn't have a lot of unique registers.
507  */
508
509 static void opti82c46x_set_piomode(struct ata_port *ap, struct ata_device *adev)
510 {
511         u8 active, recover, setup;
512         struct ata_timing t;
513         struct ata_device *pair = ata_dev_pair(adev);
514         int clock;
515         int khz[4] = { 50000, 40000, 33000, 25000 };
516         u8 rc;
517         u8 sysclk;
518
519         /* Get the clock */
520         sysclk = opti_syscfg(0xAC) & 0xC0;      /* BIOS set */
521
522         /* Enter configuration mode */
523         ioread16(ap->ioaddr.error_addr);
524         ioread16(ap->ioaddr.error_addr);
525         iowrite8(3, ap->ioaddr.nsect_addr);
526
527         /* Read VLB clock strapping */
528         clock = 1000000000 / khz[sysclk];
529
530         /* Get the timing data in cycles */
531         ata_timing_compute(adev, adev->pio_mode, &t, clock, 1000);
532
533         /* Setup timing is shared */
534         if (pair) {
535                 struct ata_timing tp;
536                 ata_timing_compute(pair, pair->pio_mode, &tp, clock, 1000);
537
538                 ata_timing_merge(&t, &tp, &t, ATA_TIMING_SETUP);
539         }
540
541         active = clamp_val(t.active, 2, 17) - 2;
542         recover = clamp_val(t.recover, 1, 16) - 1;
543         setup = clamp_val(t.setup, 1, 4) - 1;
544
545         /* Select the right timing bank for write timing */
546         rc = ioread8(ap->ioaddr.lbal_addr);
547         rc &= 0x7F;
548         rc |= (adev->devno << 7);
549         iowrite8(rc, ap->ioaddr.lbal_addr);
550
551         /* Write the timings */
552         iowrite8(active << 4 | recover, ap->ioaddr.error_addr);
553
554         /* Select the right bank for read timings, also
555            load the shared timings for address */
556         rc = ioread8(ap->ioaddr.device_addr);
557         rc &= 0xC0;
558         rc |= adev->devno;      /* Index select */
559         rc |= (setup << 4) | 0x04;
560         iowrite8(rc, ap->ioaddr.device_addr);
561
562         /* Load the read timings */
563         iowrite8(active << 4 | recover, ap->ioaddr.data_addr);
564
565         /* Ensure the timing register mode is right */
566         rc = ioread8(ap->ioaddr.lbal_addr);
567         rc &= 0x73;
568         rc |= 0x84;
569         iowrite8(rc, ap->ioaddr.lbal_addr);
570
571         /* Exit command mode */
572         iowrite8(0x83,  ap->ioaddr.nsect_addr);
573
574         /* We need to know this for quad device on the MVB */
575         ap->host->private_data = ap;
576 }
577
578 /**
579  *      opt82c465mv_qc_issue            -       command issue
580  *      @qc: command pending
581  *
582  *      Called when the libata layer is about to issue a command. We wrap
583  *      this interface so that we can load the correct ATA timings. The
584  *      MVB has a single set of timing registers and these are shared
585  *      across channels. As there are two registers we really ought to
586  *      track the last two used values as a sort of register window. For
587  *      now we just reload on a channel switch. On the single channel
588  *      setup this condition never fires so we do nothing extra.
589  *
590  *      FIXME: dual channel needs ->serialize support
591  */
592
593 static unsigned int opti82c46x_qc_issue(struct ata_queued_cmd *qc)
594 {
595         struct ata_port *ap = qc->ap;
596         struct ata_device *adev = qc->dev;
597
598         /* If timings are set and for the wrong channel (2nd test is
599            due to a libata shortcoming and will eventually go I hope) */
600         if (ap->host->private_data != ap->host
601             && ap->host->private_data != NULL)
602                 opti82c46x_set_piomode(ap, adev);
603
604         return ata_sff_qc_issue(qc);
605 }
606
607 static struct ata_port_operations opti82c46x_port_ops = {
608         .inherits       = &legacy_base_port_ops,
609         .set_piomode    = opti82c46x_set_piomode,
610         .qc_issue       = opti82c46x_qc_issue,
611 };
612
613 static void qdi6500_set_piomode(struct ata_port *ap, struct ata_device *adev)
614 {
615         struct ata_timing t;
616         struct legacy_data *ld_qdi = ap->host->private_data;
617         int active, recovery;
618         u8 timing;
619
620         /* Get the timing data in cycles */
621         ata_timing_compute(adev, adev->pio_mode, &t, 30303, 1000);
622
623         if (ld_qdi->fast) {
624                 active = 8 - clamp_val(t.active, 1, 8);
625                 recovery = 18 - clamp_val(t.recover, 3, 18);
626         } else {
627                 active = 9 - clamp_val(t.active, 2, 9);
628                 recovery = 15 - clamp_val(t.recover, 0, 15);
629         }
630         timing = (recovery << 4) | active | 0x08;
631
632         ld_qdi->clock[adev->devno] = timing;
633
634         outb(timing, ld_qdi->timing);
635 }
636
637 /**
638  *      qdi6580dp_set_piomode           -       PIO setup for dual channel
639  *      @ap: Port
640  *      @adev: Device
641  *      @irq: interrupt line
642  *
643  *      In dual channel mode the 6580 has one clock per channel and we have
644  *      to software clockswitch in qc_issue.
645  */
646
647 static void qdi6580dp_set_piomode(struct ata_port *ap, struct ata_device *adev)
648 {
649         struct ata_timing t;
650         struct legacy_data *ld_qdi = ap->host->private_data;
651         int active, recovery;
652         u8 timing;
653
654         /* Get the timing data in cycles */
655         ata_timing_compute(adev, adev->pio_mode, &t, 30303, 1000);
656
657         if (ld_qdi->fast) {
658                 active = 8 - clamp_val(t.active, 1, 8);
659                 recovery = 18 - clamp_val(t.recover, 3, 18);
660         } else {
661                 active = 9 - clamp_val(t.active, 2, 9);
662                 recovery = 15 - clamp_val(t.recover, 0, 15);
663         }
664         timing = (recovery << 4) | active | 0x08;
665
666         ld_qdi->clock[adev->devno] = timing;
667
668         outb(timing, ld_qdi->timing + 2 * ap->port_no);
669         /* Clear the FIFO */
670         if (adev->class != ATA_DEV_ATA)
671                 outb(0x5F, ld_qdi->timing + 3);
672 }
673
674 /**
675  *      qdi6580_set_piomode             -       PIO setup for single channel
676  *      @ap: Port
677  *      @adev: Device
678  *
679  *      In single channel mode the 6580 has one clock per device and we can
680  *      avoid the requirement to clock switch. We also have to load the timing
681  *      into the right clock according to whether we are master or slave.
682  */
683
684 static void qdi6580_set_piomode(struct ata_port *ap, struct ata_device *adev)
685 {
686         struct ata_timing t;
687         struct legacy_data *ld_qdi = ap->host->private_data;
688         int active, recovery;
689         u8 timing;
690
691         /* Get the timing data in cycles */
692         ata_timing_compute(adev, adev->pio_mode, &t, 30303, 1000);
693
694         if (ld_qdi->fast) {
695                 active = 8 - clamp_val(t.active, 1, 8);
696                 recovery = 18 - clamp_val(t.recover, 3, 18);
697         } else {
698                 active = 9 - clamp_val(t.active, 2, 9);
699                 recovery = 15 - clamp_val(t.recover, 0, 15);
700         }
701         timing = (recovery << 4) | active | 0x08;
702         ld_qdi->clock[adev->devno] = timing;
703         outb(timing, ld_qdi->timing + 2 * adev->devno);
704         /* Clear the FIFO */
705         if (adev->class != ATA_DEV_ATA)
706                 outb(0x5F, ld_qdi->timing + 3);
707 }
708
709 /**
710  *      qdi_qc_issue            -       command issue
711  *      @qc: command pending
712  *
713  *      Called when the libata layer is about to issue a command. We wrap
714  *      this interface so that we can load the correct ATA timings.
715  */
716
717 static unsigned int qdi_qc_issue(struct ata_queued_cmd *qc)
718 {
719         struct ata_port *ap = qc->ap;
720         struct ata_device *adev = qc->dev;
721         struct legacy_data *ld_qdi = ap->host->private_data;
722
723         if (ld_qdi->clock[adev->devno] != ld_qdi->last) {
724                 if (adev->pio_mode) {
725                         ld_qdi->last = ld_qdi->clock[adev->devno];
726                         outb(ld_qdi->clock[adev->devno], ld_qdi->timing +
727                                                         2 * ap->port_no);
728                 }
729         }
730         return ata_sff_qc_issue(qc);
731 }
732
733 static unsigned int vlb32_data_xfer(struct ata_device *adev, unsigned char *buf,
734                                         unsigned int buflen, int rw)
735 {
736         struct ata_port *ap = adev->link->ap;
737         int slop = buflen & 3;
738
739         if (ata_id_has_dword_io(adev->id)) {
740                 if (rw == WRITE)
741                         iowrite32_rep(ap->ioaddr.data_addr, buf, buflen >> 2);
742                 else
743                         ioread32_rep(ap->ioaddr.data_addr, buf, buflen >> 2);
744
745                 if (unlikely(slop)) {
746                         __le32 pad;
747                         if (rw == WRITE) {
748                                 memcpy(&pad, buf + buflen - slop, slop);
749                                 iowrite32(le32_to_cpu(pad), ap->ioaddr.data_addr);
750                         } else {
751                                 pad = cpu_to_le32(ioread32(ap->ioaddr.data_addr));
752                                 memcpy(buf + buflen - slop, &pad, slop);
753                         }
754                 }
755                 return (buflen + 3) & ~3;
756         } else
757                 return ata_sff_data_xfer(adev, buf, buflen, rw);
758 }
759
760 static int qdi_port(struct platform_device *dev,
761                         struct legacy_probe *lp, struct legacy_data *ld)
762 {
763         if (devm_request_region(&dev->dev, lp->private, 4, "qdi") == NULL)
764                 return -EBUSY;
765         ld->timing = lp->private;
766         return 0;
767 }
768
769 static struct ata_port_operations qdi6500_port_ops = {
770         .inherits       = &legacy_base_port_ops,
771         .set_piomode    = qdi6500_set_piomode,
772         .qc_issue       = qdi_qc_issue,
773         .sff_data_xfer  = vlb32_data_xfer,
774 };
775
776 static struct ata_port_operations qdi6580_port_ops = {
777         .inherits       = &legacy_base_port_ops,
778         .set_piomode    = qdi6580_set_piomode,
779         .sff_data_xfer  = vlb32_data_xfer,
780 };
781
782 static struct ata_port_operations qdi6580dp_port_ops = {
783         .inherits       = &legacy_base_port_ops,
784         .set_piomode    = qdi6580dp_set_piomode,
785         .sff_data_xfer  = vlb32_data_xfer,
786 };
787
788 static DEFINE_SPINLOCK(winbond_lock);
789
790 static void winbond_writecfg(unsigned long port, u8 reg, u8 val)
791 {
792         unsigned long flags;
793         spin_lock_irqsave(&winbond_lock, flags);
794         outb(reg, port + 0x01);
795         outb(val, port + 0x02);
796         spin_unlock_irqrestore(&winbond_lock, flags);
797 }
798
799 static u8 winbond_readcfg(unsigned long port, u8 reg)
800 {
801         u8 val;
802
803         unsigned long flags;
804         spin_lock_irqsave(&winbond_lock, flags);
805         outb(reg, port + 0x01);
806         val = inb(port + 0x02);
807         spin_unlock_irqrestore(&winbond_lock, flags);
808
809         return val;
810 }
811
812 static void winbond_set_piomode(struct ata_port *ap, struct ata_device *adev)
813 {
814         struct ata_timing t;
815         struct legacy_data *ld_winbond = ap->host->private_data;
816         int active, recovery;
817         u8 reg;
818         int timing = 0x88 + (ap->port_no * 4) + (adev->devno * 2);
819
820         reg = winbond_readcfg(ld_winbond->timing, 0x81);
821
822         /* Get the timing data in cycles */
823         if (reg & 0x40)         /* Fast VLB bus, assume 50MHz */
824                 ata_timing_compute(adev, adev->pio_mode, &t, 20000, 1000);
825         else
826                 ata_timing_compute(adev, adev->pio_mode, &t, 30303, 1000);
827
828         active = (clamp_val(t.active, 3, 17) - 1) & 0x0F;
829         recovery = (clamp_val(t.recover, 1, 15) + 1) & 0x0F;
830         timing = (active << 4) | recovery;
831         winbond_writecfg(ld_winbond->timing, timing, reg);
832
833         /* Load the setup timing */
834
835         reg = 0x35;
836         if (adev->class != ATA_DEV_ATA)
837                 reg |= 0x08;    /* FIFO off */
838         if (!ata_pio_need_iordy(adev))
839                 reg |= 0x02;    /* IORDY off */
840         reg |= (clamp_val(t.setup, 0, 3) << 6);
841         winbond_writecfg(ld_winbond->timing, timing + 1, reg);
842 }
843
844 static int winbond_port(struct platform_device *dev,
845                         struct legacy_probe *lp, struct legacy_data *ld)
846 {
847         if (devm_request_region(&dev->dev, lp->private, 4, "winbond") == NULL)
848                 return -EBUSY;
849         ld->timing = lp->private;
850         return 0;
851 }
852
853 static struct ata_port_operations winbond_port_ops = {
854         .inherits       = &legacy_base_port_ops,
855         .set_piomode    = winbond_set_piomode,
856         .sff_data_xfer  = vlb32_data_xfer,
857 };
858
859 static struct legacy_controller controllers[] = {
860         {"BIOS",        &legacy_port_ops,       0x1F,
861                                                 ATA_FLAG_NO_IORDY,      NULL },
862         {"Snooping",    &simple_port_ops,       0x1F,
863                                                 0              ,        NULL },
864         {"PDC20230",    &pdc20230_port_ops,     0x7,
865                                                 ATA_FLAG_NO_IORDY,      NULL },
866         {"HT6560A",     &ht6560a_port_ops,      0x07,
867                                                 ATA_FLAG_NO_IORDY,      NULL },
868         {"HT6560B",     &ht6560b_port_ops,      0x1F,
869                                                 ATA_FLAG_NO_IORDY,      NULL },
870         {"OPTI82C611A", &opti82c611a_port_ops,  0x0F,
871                                                 0              ,        NULL },
872         {"OPTI82C46X",  &opti82c46x_port_ops,   0x0F,
873                                                 0              ,        NULL },
874         {"QDI6500",     &qdi6500_port_ops,      0x07,
875                                         ATA_FLAG_NO_IORDY,      qdi_port },
876         {"QDI6580",     &qdi6580_port_ops,      0x1F,
877                                         0              ,        qdi_port },
878         {"QDI6580DP",   &qdi6580dp_port_ops,    0x1F,
879                                         0              ,        qdi_port },
880         {"W83759A",     &winbond_port_ops,      0x1F,
881                                         0              ,        winbond_port }
882 };
883
884 /**
885  *      probe_chip_type         -       Discover controller
886  *      @probe: Probe entry to check
887  *
888  *      Probe an ATA port and identify the type of controller. We don't
889  *      check if the controller appears to be driveless at this point.
890  */
891
892 static __init int probe_chip_type(struct legacy_probe *probe)
893 {
894         int mask = 1 << probe->slot;
895
896         if (winbond && (probe->port == 0x1F0 || probe->port == 0x170)) {
897                 u8 reg = winbond_readcfg(winbond, 0x81);
898                 reg |= 0x80;    /* jumpered mode off */
899                 winbond_writecfg(winbond, 0x81, reg);
900                 reg = winbond_readcfg(winbond, 0x83);
901                 reg |= 0xF0;    /* local control */
902                 winbond_writecfg(winbond, 0x83, reg);
903                 reg = winbond_readcfg(winbond, 0x85);
904                 reg |= 0xF0;    /* programmable timing */
905                 winbond_writecfg(winbond, 0x85, reg);
906
907                 reg = winbond_readcfg(winbond, 0x81);
908
909                 if (reg & mask)
910                         return W83759A;
911         }
912         if (probe->port == 0x1F0) {
913                 unsigned long flags;
914                 local_irq_save(flags);
915                 /* Probes */
916                 outb(inb(0x1F2) | 0x80, 0x1F2);
917                 inb(0x1F5);
918                 inb(0x1F2);
919                 inb(0x3F6);
920                 inb(0x3F6);
921                 inb(0x1F2);
922                 inb(0x1F2);
923
924                 if ((inb(0x1F2) & 0x80) == 0) {
925                         /* PDC20230c or 20630 ? */
926                         printk(KERN_INFO  "PDC20230-C/20630 VLB ATA controller"
927                                                         " detected.\n");
928                         udelay(100);
929                         inb(0x1F5);
930                         local_irq_restore(flags);
931                         return PDC20230;
932                 } else {
933                         outb(0x55, 0x1F2);
934                         inb(0x1F2);
935                         inb(0x1F2);
936                         if (inb(0x1F2) == 0x00)
937                                 printk(KERN_INFO "PDC20230-B VLB ATA "
938                                                      "controller detected.\n");
939                         local_irq_restore(flags);
940                         return BIOS;
941                 }
942                 local_irq_restore(flags);
943         }
944
945         if (ht6560a & mask)
946                 return HT6560A;
947         if (ht6560b & mask)
948                 return HT6560B;
949         if (opti82c611a & mask)
950                 return OPTI611A;
951         if (opti82c46x & mask)
952                 return OPTI46X;
953         if (autospeed & mask)
954                 return SNOOP;
955         return BIOS;
956 }
957
958
959 /**
960  *      legacy_init_one         -       attach a legacy interface
961  *      @pl: probe record
962  *
963  *      Register an ISA bus IDE interface. Such interfaces are PIO and we
964  *      assume do not support IRQ sharing.
965  */
966
967 static __init int legacy_init_one(struct legacy_probe *probe)
968 {
969         struct legacy_controller *controller = &controllers[probe->type];
970         int pio_modes = controller->pio_mask;
971         unsigned long io = probe->port;
972         u32 mask = (1 << probe->slot);
973         struct ata_port_operations *ops = controller->ops;
974         struct legacy_data *ld = &legacy_data[probe->slot];
975         struct ata_host *host = NULL;
976         struct ata_port *ap;
977         struct platform_device *pdev;
978         struct ata_device *dev;
979         void __iomem *io_addr, *ctrl_addr;
980         u32 iordy = (iordy_mask & mask) ? 0: ATA_FLAG_NO_IORDY;
981         int ret;
982
983         iordy |= controller->flags;
984
985         pdev = platform_device_register_simple(DRV_NAME, probe->slot, NULL, 0);
986         if (IS_ERR(pdev))
987                 return PTR_ERR(pdev);
988
989         ret = -EBUSY;
990         if (devm_request_region(&pdev->dev, io, 8, "pata_legacy") == NULL ||
991             devm_request_region(&pdev->dev, io + 0x0206, 1,
992                                                         "pata_legacy") == NULL)
993                 goto fail;
994
995         ret = -ENOMEM;
996         io_addr = devm_ioport_map(&pdev->dev, io, 8);
997         ctrl_addr = devm_ioport_map(&pdev->dev, io + 0x0206, 1);
998         if (!io_addr || !ctrl_addr)
999                 goto fail;
1000         if (controller->setup)
1001                 if (controller->setup(pdev, probe, ld) < 0)
1002                         goto fail;
1003         host = ata_host_alloc(&pdev->dev, 1);
1004         if (!host)
1005                 goto fail;
1006         ap = host->ports[0];
1007
1008         ap->ops = ops;
1009         ap->pio_mask = pio_modes;
1010         ap->flags |= ATA_FLAG_SLAVE_POSS | iordy;
1011         ap->ioaddr.cmd_addr = io_addr;
1012         ap->ioaddr.altstatus_addr = ctrl_addr;
1013         ap->ioaddr.ctl_addr = ctrl_addr;
1014         ata_sff_std_ports(&ap->ioaddr);
1015         ap->host->private_data = ld;
1016
1017         ata_port_desc(ap, "cmd 0x%lx ctl 0x%lx", io, io + 0x0206);
1018
1019         ret = ata_host_activate(host, probe->irq, ata_sff_interrupt, 0,
1020                                 &legacy_sht);
1021         if (ret)
1022                 goto fail;
1023         ld->platform_dev = pdev;
1024
1025         /* Nothing found means we drop the port as its probably not there */
1026
1027         ret = -ENODEV;
1028         ata_for_each_dev(dev, &ap->link, ALL) {
1029                 if (!ata_dev_absent(dev)) {
1030                         legacy_host[probe->slot] = host;
1031                         ld->platform_dev = pdev;
1032                         return 0;
1033                 }
1034         }
1035 fail:
1036         platform_device_unregister(pdev);
1037         return ret;
1038 }
1039
1040 /**
1041  *      legacy_check_special_cases      -       ATA special cases
1042  *      @p: PCI device to check
1043  *      @master: set this if we find an ATA master
1044  *      @master: set this if we find an ATA secondary
1045  *
1046  *      A small number of vendors implemented early PCI ATA interfaces
1047  *      on bridge logic without the ATA interface being PCI visible.
1048  *      Where we have a matching PCI driver we must skip the relevant
1049  *      device here. If we don't know about it then the legacy driver
1050  *      is the right driver anyway.
1051  */
1052
1053 static void __init legacy_check_special_cases(struct pci_dev *p, int *primary,
1054                                                                 int *secondary)
1055 {
1056         /* Cyrix CS5510 pre SFF MWDMA ATA on the bridge */
1057         if (p->vendor == 0x1078 && p->device == 0x0000) {
1058                 *primary = *secondary = 1;
1059                 return;
1060         }
1061         /* Cyrix CS5520 pre SFF MWDMA ATA on the bridge */
1062         if (p->vendor == 0x1078 && p->device == 0x0002) {
1063                 *primary = *secondary = 1;
1064                 return;
1065         }
1066         /* Intel MPIIX - PIO ATA on non PCI side of bridge */
1067         if (p->vendor == 0x8086 && p->device == 0x1234) {
1068                 u16 r;
1069                 pci_read_config_word(p, 0x6C, &r);
1070                 if (r & 0x8000) {
1071                         /* ATA port enabled */
1072                         if (r & 0x4000)
1073                                 *secondary = 1;
1074                         else
1075                                 *primary = 1;
1076                 }
1077                 return;
1078         }
1079 }
1080
1081 static __init void probe_opti_vlb(void)
1082 {
1083         /* If an OPTI 82C46X is present find out where the channels are */
1084         static const char *optis[4] = {
1085                 "3/463MV", "5MV",
1086                 "5MVA", "5MVB"
1087         };
1088         u8 chans = 1;
1089         u8 ctrl = (opti_syscfg(0x30) & 0xC0) >> 6;
1090
1091         opti82c46x = 3; /* Assume master and slave first */
1092         printk(KERN_INFO DRV_NAME ": Opti 82C46%s chipset support.\n",
1093                                                                 optis[ctrl]);
1094         if (ctrl == 3)
1095                 chans = (opti_syscfg(0x3F) & 0x20) ? 2 : 1;
1096         ctrl = opti_syscfg(0xAC);
1097         /* Check enabled and this port is the 465MV port. On the
1098            MVB we may have two channels */
1099         if (ctrl & 8) {
1100                 if (chans == 2) {
1101                         legacy_probe_add(0x1F0, 14, OPTI46X, 0);
1102                         legacy_probe_add(0x170, 15, OPTI46X, 0);
1103                 }
1104                 if (ctrl & 4)
1105                         legacy_probe_add(0x170, 15, OPTI46X, 0);
1106                 else
1107                         legacy_probe_add(0x1F0, 14, OPTI46X, 0);
1108         } else
1109                 legacy_probe_add(0x1F0, 14, OPTI46X, 0);
1110 }
1111
1112 static __init void qdi65_identify_port(u8 r, u8 res, unsigned long port)
1113 {
1114         static const unsigned long ide_port[2] = { 0x170, 0x1F0 };
1115         /* Check card type */
1116         if ((r & 0xF0) == 0xC0) {
1117                 /* QD6500: single channel */
1118                 if (r & 8)
1119                         /* Disabled ? */
1120                         return;
1121                 legacy_probe_add(ide_port[r & 0x01], 14 + (r & 0x01),
1122                                                                 QDI6500, port);
1123         }
1124         if (((r & 0xF0) == 0xA0) || (r & 0xF0) == 0x50) {
1125                 /* QD6580: dual channel */
1126                 if (!request_region(port + 2 , 2, "pata_qdi")) {
1127                         release_region(port, 2);
1128                         return;
1129                 }
1130                 res = inb(port + 3);
1131                 /* Single channel mode ? */
1132                 if (res & 1)
1133                         legacy_probe_add(ide_port[r & 0x01], 14 + (r & 0x01),
1134                                                                 QDI6580, port);
1135                 else { /* Dual channel mode */
1136                         legacy_probe_add(0x1F0, 14, QDI6580DP, port);
1137                         /* port + 0x02, r & 0x04 */
1138                         legacy_probe_add(0x170, 15, QDI6580DP, port + 2);
1139                 }
1140                 release_region(port + 2, 2);
1141         }
1142 }
1143
1144 static __init void probe_qdi_vlb(void)
1145 {
1146         unsigned long flags;
1147         static const unsigned long qd_port[2] = { 0x30, 0xB0 };
1148         int i;
1149
1150         /*
1151          *      Check each possible QD65xx base address
1152          */
1153
1154         for (i = 0; i < 2; i++) {
1155                 unsigned long port = qd_port[i];
1156                 u8 r, res;
1157
1158
1159                 if (request_region(port, 2, "pata_qdi")) {
1160                         /* Check for a card */
1161                         local_irq_save(flags);
1162                         /* I have no h/w that needs this delay but it
1163                            is present in the historic code */
1164                         r = inb(port);
1165                         udelay(1);
1166                         outb(0x19, port);
1167                         udelay(1);
1168                         res = inb(port);
1169                         udelay(1);
1170                         outb(r, port);
1171                         udelay(1);
1172                         local_irq_restore(flags);
1173
1174                         /* Fail */
1175                         if (res == 0x19) {
1176                                 release_region(port, 2);
1177                                 continue;
1178                         }
1179                         /* Passes the presence test */
1180                         r = inb(port + 1);
1181                         udelay(1);
1182                         /* Check port agrees with port set */
1183                         if ((r & 2) >> 1 == i)
1184                                 qdi65_identify_port(r, res, port);
1185                         release_region(port, 2);
1186                 }
1187         }
1188 }
1189
1190 /**
1191  *      legacy_init             -       attach legacy interfaces
1192  *
1193  *      Attach legacy IDE interfaces by scanning the usual IRQ/port suspects.
1194  *      Right now we do not scan the ide0 and ide1 address but should do so
1195  *      for non PCI systems or systems with no PCI IDE legacy mode devices.
1196  *      If you fix that note there are special cases to consider like VLB
1197  *      drivers and CS5510/20.
1198  */
1199
1200 static __init int legacy_init(void)
1201 {
1202         int i;
1203         int ct = 0;
1204         int primary = 0;
1205         int secondary = 0;
1206         int pci_present = 0;
1207         struct legacy_probe *pl = &probe_list[0];
1208         int slot = 0;
1209
1210         struct pci_dev *p = NULL;
1211
1212         for_each_pci_dev(p) {
1213                 int r;
1214                 /* Check for any overlap of the system ATA mappings. Native
1215                    mode controllers stuck on these addresses or some devices
1216                    in 'raid' mode won't be found by the storage class test */
1217                 for (r = 0; r < 6; r++) {
1218                         if (pci_resource_start(p, r) == 0x1f0)
1219                                 primary = 1;
1220                         if (pci_resource_start(p, r) == 0x170)
1221                                 secondary = 1;
1222                 }
1223                 /* Check for special cases */
1224                 legacy_check_special_cases(p, &primary, &secondary);
1225
1226                 /* If PCI bus is present then don't probe for tertiary
1227                    legacy ports */
1228                 pci_present = 1;
1229         }
1230
1231         if (winbond == 1)
1232                 winbond = 0x130;        /* Default port, alt is 1B0 */
1233
1234         if (primary == 0 || all)
1235                 legacy_probe_add(0x1F0, 14, UNKNOWN, 0);
1236         if (secondary == 0 || all)
1237                 legacy_probe_add(0x170, 15, UNKNOWN, 0);
1238
1239         if (probe_all || !pci_present) {
1240                 /* ISA/VLB extra ports */
1241                 legacy_probe_add(0x1E8, 11, UNKNOWN, 0);
1242                 legacy_probe_add(0x168, 10, UNKNOWN, 0);
1243                 legacy_probe_add(0x1E0, 8, UNKNOWN, 0);
1244                 legacy_probe_add(0x160, 12, UNKNOWN, 0);
1245         }
1246
1247         if (opti82c46x)
1248                 probe_opti_vlb();
1249         if (qdi)
1250                 probe_qdi_vlb();
1251
1252         for (i = 0; i < NR_HOST; i++, pl++) {
1253                 if (pl->port == 0)
1254                         continue;
1255                 if (pl->type == UNKNOWN)
1256                         pl->type = probe_chip_type(pl);
1257                 pl->slot = slot++;
1258                 if (legacy_init_one(pl) == 0)
1259                         ct++;
1260         }
1261         if (ct != 0)
1262                 return 0;
1263         return -ENODEV;
1264 }
1265
1266 static __exit void legacy_exit(void)
1267 {
1268         int i;
1269
1270         for (i = 0; i < nr_legacy_host; i++) {
1271                 struct legacy_data *ld = &legacy_data[i];
1272                 ata_host_detach(legacy_host[i]);
1273                 platform_device_unregister(ld->platform_dev);
1274         }
1275 }
1276
1277 MODULE_AUTHOR("Alan Cox");
1278 MODULE_DESCRIPTION("low-level driver for legacy ATA");
1279 MODULE_LICENSE("GPL");
1280 MODULE_VERSION(DRV_VERSION);
1281
1282 module_param(probe_all, int, 0);
1283 module_param(autospeed, int, 0);
1284 module_param(ht6560a, int, 0);
1285 module_param(ht6560b, int, 0);
1286 module_param(opti82c611a, int, 0);
1287 module_param(opti82c46x, int, 0);
1288 module_param(qdi, int, 0);
1289 module_param(pio_mask, int, 0);
1290 module_param(iordy_mask, int, 0);
1291
1292 module_init(legacy_init);
1293 module_exit(legacy_exit);