via82cxxx: fix SATA cable detection
[platform/adaptation/renesas_rcar/renesas_kernel.git] / drivers / ide / via82cxxx.c
1 /*
2  * VIA IDE driver for Linux. Supported southbridges:
3  *
4  *   vt82c576, vt82c586, vt82c586a, vt82c586b, vt82c596a, vt82c596b,
5  *   vt82c686, vt82c686a, vt82c686b, vt8231, vt8233, vt8233c, vt8233a,
6  *   vt8235, vt8237, vt8237a
7  *
8  * Copyright (c) 2000-2002 Vojtech Pavlik
9  * Copyright (c) 2007-2010 Bartlomiej Zolnierkiewicz
10  *
11  * Based on the work of:
12  *      Michel Aubry
13  *      Jeff Garzik
14  *      Andre Hedrick
15  *
16  * Documentation:
17  *      Obsolete device documentation publically available from via.com.tw
18  *      Current device documentation available under NDA only
19  */
20
21 /*
22  * This program is free software; you can redistribute it and/or modify it
23  * under the terms of the GNU General Public License version 2 as published by
24  * the Free Software Foundation.
25  */
26
27 #include <linux/module.h>
28 #include <linux/kernel.h>
29 #include <linux/pci.h>
30 #include <linux/init.h>
31 #include <linux/ide.h>
32 #include <linux/dmi.h>
33
34 #ifdef CONFIG_PPC_CHRP
35 #include <asm/processor.h>
36 #endif
37
38 #define DRV_NAME "via82cxxx"
39
40 #define VIA_IDE_ENABLE          0x40
41 #define VIA_IDE_CONFIG          0x41
42 #define VIA_FIFO_CONFIG         0x43
43 #define VIA_MISC_1              0x44
44 #define VIA_MISC_2              0x45
45 #define VIA_MISC_3              0x46
46 #define VIA_DRIVE_TIMING        0x48
47 #define VIA_8BIT_TIMING         0x4e
48 #define VIA_ADDRESS_SETUP       0x4c
49 #define VIA_UDMA_TIMING         0x50
50
51 #define VIA_BAD_PREQ            0x01 /* Crashes if PREQ# till DDACK# set */
52 #define VIA_BAD_CLK66           0x02 /* 66 MHz clock doesn't work correctly */
53 #define VIA_SET_FIFO            0x04 /* Needs to have FIFO split set */
54 #define VIA_NO_UNMASK           0x08 /* Doesn't work with IRQ unmasking on */
55 #define VIA_BAD_ID              0x10 /* Has wrong vendor ID (0x1107) */
56 #define VIA_BAD_AST             0x20 /* Don't touch Address Setup Timing */
57 #define VIA_SATA_PATA           0x80 /* SATA/PATA combined configuration */
58
59 enum {
60         VIA_IDFLAG_SINGLE = (1 << 1), /* single channel controller */
61 };
62
63 /*
64  * VIA SouthBridge chips.
65  */
66
67 static struct via_isa_bridge {
68         char *name;
69         u16 id;
70         u8 rev_min;
71         u8 rev_max;
72         u8 udma_mask;
73         u8 flags;
74 } via_isa_bridges[] = {
75         { "vx855",      PCI_DEVICE_ID_VIA_VX855,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST | VIA_SATA_PATA },
76         { "vx800",      PCI_DEVICE_ID_VIA_VX800,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST | VIA_SATA_PATA },
77         { "cx700",      PCI_DEVICE_ID_VIA_CX700,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST | VIA_SATA_PATA },
78         { "vt8237s",    PCI_DEVICE_ID_VIA_8237S,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
79         { "vt6410",     PCI_DEVICE_ID_VIA_6410,     0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
80         { "vt8251",     PCI_DEVICE_ID_VIA_8251,     0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
81         { "vt8237",     PCI_DEVICE_ID_VIA_8237,     0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
82         { "vt8237a",    PCI_DEVICE_ID_VIA_8237A,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
83         { "vt8235",     PCI_DEVICE_ID_VIA_8235,     0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
84         { "vt8233a",    PCI_DEVICE_ID_VIA_8233A,    0x00, 0x2f, ATA_UDMA6, VIA_BAD_AST },
85         { "vt8233c",    PCI_DEVICE_ID_VIA_8233C_0,  0x00, 0x2f, ATA_UDMA5, },
86         { "vt8233",     PCI_DEVICE_ID_VIA_8233_0,   0x00, 0x2f, ATA_UDMA5, },
87         { "vt8231",     PCI_DEVICE_ID_VIA_8231,     0x00, 0x2f, ATA_UDMA5, },
88         { "vt82c686b",  PCI_DEVICE_ID_VIA_82C686,   0x40, 0x4f, ATA_UDMA5, },
89         { "vt82c686a",  PCI_DEVICE_ID_VIA_82C686,   0x10, 0x2f, ATA_UDMA4, },
90         { "vt82c686",   PCI_DEVICE_ID_VIA_82C686,   0x00, 0x0f, ATA_UDMA2, VIA_BAD_CLK66 },
91         { "vt82c596b",  PCI_DEVICE_ID_VIA_82C596,   0x10, 0x2f, ATA_UDMA4, },
92         { "vt82c596a",  PCI_DEVICE_ID_VIA_82C596,   0x00, 0x0f, ATA_UDMA2, VIA_BAD_CLK66 },
93         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x47, 0x4f, ATA_UDMA2, VIA_SET_FIFO },
94         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x40, 0x46, ATA_UDMA2, VIA_SET_FIFO | VIA_BAD_PREQ },
95         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x30, 0x3f, ATA_UDMA2, VIA_SET_FIFO },
96         { "vt82c586a",  PCI_DEVICE_ID_VIA_82C586_0, 0x20, 0x2f, ATA_UDMA2, VIA_SET_FIFO },
97         { "vt82c586",   PCI_DEVICE_ID_VIA_82C586_0, 0x00, 0x0f,      0x00, VIA_SET_FIFO },
98         { "vt82c576",   PCI_DEVICE_ID_VIA_82C576,   0x00, 0x2f,      0x00, VIA_SET_FIFO | VIA_NO_UNMASK },
99         { "vt82c576",   PCI_DEVICE_ID_VIA_82C576,   0x00, 0x2f,      0x00, VIA_SET_FIFO | VIA_NO_UNMASK | VIA_BAD_ID },
100         { NULL }
101 };
102
103 static unsigned int via_clock;
104 static char *via_dma[] = { "16", "25", "33", "44", "66", "100", "133" };
105
106 struct via82cxxx_dev
107 {
108         struct via_isa_bridge *via_config;
109         unsigned int via_80w;
110 };
111
112 /**
113  *      via_set_speed                   -       write timing registers
114  *      @dev: PCI device
115  *      @dn: device
116  *      @timing: IDE timing data to use
117  *
118  *      via_set_speed writes timing values to the chipset registers
119  */
120
121 static void via_set_speed(ide_hwif_t *hwif, u8 dn, struct ide_timing *timing)
122 {
123         struct pci_dev *dev = to_pci_dev(hwif->dev);
124         struct ide_host *host = pci_get_drvdata(dev);
125         struct via82cxxx_dev *vdev = host->host_priv;
126         u8 t;
127
128         if (~vdev->via_config->flags & VIA_BAD_AST) {
129                 pci_read_config_byte(dev, VIA_ADDRESS_SETUP, &t);
130                 t = (t & ~(3 << ((3 - dn) << 1))) | ((clamp_val(timing->setup, 1, 4) - 1) << ((3 - dn) << 1));
131                 pci_write_config_byte(dev, VIA_ADDRESS_SETUP, t);
132         }
133
134         pci_write_config_byte(dev, VIA_8BIT_TIMING + (1 - (dn >> 1)),
135                 ((clamp_val(timing->act8b, 1, 16) - 1) << 4) | (clamp_val(timing->rec8b, 1, 16) - 1));
136
137         pci_write_config_byte(dev, VIA_DRIVE_TIMING + (3 - dn),
138                 ((clamp_val(timing->active, 1, 16) - 1) << 4) | (clamp_val(timing->recover, 1, 16) - 1));
139
140         switch (vdev->via_config->udma_mask) {
141         case ATA_UDMA2: t = timing->udma ? (0xe0 | (clamp_val(timing->udma, 2, 5) - 2)) : 0x03; break;
142         case ATA_UDMA4: t = timing->udma ? (0xe8 | (clamp_val(timing->udma, 2, 9) - 2)) : 0x0f; break;
143         case ATA_UDMA5: t = timing->udma ? (0xe0 | (clamp_val(timing->udma, 2, 9) - 2)) : 0x07; break;
144         case ATA_UDMA6: t = timing->udma ? (0xe0 | (clamp_val(timing->udma, 2, 9) - 2)) : 0x07; break;
145         default: return;
146         }
147
148         pci_write_config_byte(dev, VIA_UDMA_TIMING + (3 - dn), t);
149 }
150
151 /**
152  *      via_set_drive           -       configure transfer mode
153  *      @drive: Drive to set up
154  *      @speed: desired speed
155  *
156  *      via_set_drive() computes timing values configures the chipset to
157  *      a desired transfer mode.  It also can be called by upper layers.
158  */
159
160 static void via_set_drive(ide_drive_t *drive, const u8 speed)
161 {
162         ide_hwif_t *hwif = drive->hwif;
163         ide_drive_t *peer = ide_get_pair_dev(drive);
164         struct pci_dev *dev = to_pci_dev(hwif->dev);
165         struct ide_host *host = pci_get_drvdata(dev);
166         struct via82cxxx_dev *vdev = host->host_priv;
167         struct ide_timing t, p;
168         unsigned int T, UT;
169
170         T = 1000000000 / via_clock;
171
172         switch (vdev->via_config->udma_mask) {
173         case ATA_UDMA2: UT = T;   break;
174         case ATA_UDMA4: UT = T/2; break;
175         case ATA_UDMA5: UT = T/3; break;
176         case ATA_UDMA6: UT = T/4; break;
177         default:        UT = T;
178         }
179
180         ide_timing_compute(drive, speed, &t, T, UT);
181
182         if (peer) {
183                 ide_timing_compute(peer, peer->current_speed, &p, T, UT);
184                 ide_timing_merge(&p, &t, &t, IDE_TIMING_8BIT);
185         }
186
187         via_set_speed(hwif, drive->dn, &t);
188 }
189
190 /**
191  *      via_set_pio_mode        -       set host controller for PIO mode
192  *      @drive: drive
193  *      @pio: PIO mode number
194  *
195  *      A callback from the upper layers for PIO-only tuning.
196  */
197
198 static void via_set_pio_mode(ide_drive_t *drive, const u8 pio)
199 {
200         via_set_drive(drive, XFER_PIO_0 + pio);
201 }
202
203 static struct via_isa_bridge *via_config_find(struct pci_dev **isa)
204 {
205         struct via_isa_bridge *via_config;
206
207         for (via_config = via_isa_bridges; via_config->id; via_config++)
208                 if ((*isa = pci_get_device(PCI_VENDOR_ID_VIA +
209                         !!(via_config->flags & VIA_BAD_ID),
210                         via_config->id, NULL))) {
211
212                         if ((*isa)->revision >= via_config->rev_min &&
213                             (*isa)->revision <= via_config->rev_max)
214                                 break;
215                         pci_dev_put(*isa);
216                 }
217
218         return via_config;
219 }
220
221 /*
222  * Check and handle 80-wire cable presence
223  */
224 static void via_cable_detect(struct via82cxxx_dev *vdev, u32 u)
225 {
226         int i;
227
228         switch (vdev->via_config->udma_mask) {
229                 case ATA_UDMA4:
230                         for (i = 24; i >= 0; i -= 8)
231                                 if (((u >> (i & 16)) & 8) &&
232                                     ((u >> i) & 0x20) &&
233                                      (((u >> i) & 7) < 2)) {
234                                         /*
235                                          * 2x PCI clock and
236                                          * UDMA w/ < 3T/cycle
237                                          */
238                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
239                                 }
240                         break;
241
242                 case ATA_UDMA5:
243                         for (i = 24; i >= 0; i -= 8)
244                                 if (((u >> i) & 0x10) ||
245                                     (((u >> i) & 0x20) &&
246                                      (((u >> i) & 7) < 4))) {
247                                         /* BIOS 80-wire bit or
248                                          * UDMA w/ < 60ns/cycle
249                                          */
250                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
251                                 }
252                         break;
253
254                 case ATA_UDMA6:
255                         for (i = 24; i >= 0; i -= 8)
256                                 if (((u >> i) & 0x10) ||
257                                     (((u >> i) & 0x20) &&
258                                      (((u >> i) & 7) < 6))) {
259                                         /* BIOS 80-wire bit or
260                                          * UDMA w/ < 60ns/cycle
261                                          */
262                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
263                                 }
264                         break;
265         }
266 }
267
268 /**
269  *      init_chipset_via82cxxx  -       initialization handler
270  *      @dev: PCI device
271  *
272  *      The initialization callback. Here we determine the IDE chip type
273  *      and initialize its drive independent registers.
274  */
275
276 static int init_chipset_via82cxxx(struct pci_dev *dev)
277 {
278         struct ide_host *host = pci_get_drvdata(dev);
279         struct via82cxxx_dev *vdev = host->host_priv;
280         struct via_isa_bridge *via_config = vdev->via_config;
281         u8 t, v;
282         u32 u;
283
284         /*
285          * Detect cable and configure Clk66
286          */
287         pci_read_config_dword(dev, VIA_UDMA_TIMING, &u);
288
289         via_cable_detect(vdev, u);
290
291         if (via_config->udma_mask == ATA_UDMA4) {
292                 /* Enable Clk66 */
293                 pci_write_config_dword(dev, VIA_UDMA_TIMING, u|0x80008);
294         } else if (via_config->flags & VIA_BAD_CLK66) {
295                 /* Would cause trouble on 596a and 686 */
296                 pci_write_config_dword(dev, VIA_UDMA_TIMING, u & ~0x80008);
297         }
298
299         /*
300          * Check whether interfaces are enabled.
301          */
302
303         pci_read_config_byte(dev, VIA_IDE_ENABLE, &v);
304
305         /*
306          * Set up FIFO sizes and thresholds.
307          */
308
309         pci_read_config_byte(dev, VIA_FIFO_CONFIG, &t);
310
311         /* Disable PREQ# till DDACK# */
312         if (via_config->flags & VIA_BAD_PREQ) {
313                 /* Would crash on 586b rev 41 */
314                 t &= 0x7f;
315         }
316
317         /* Fix FIFO split between channels */
318         if (via_config->flags & VIA_SET_FIFO) {
319                 t &= (t & 0x9f);
320                 switch (v & 3) {
321                         case 2: t |= 0x00; break;       /* 16 on primary */
322                         case 1: t |= 0x60; break;       /* 16 on secondary */
323                         case 3: t |= 0x20; break;       /* 8 pri 8 sec */
324                 }
325         }
326
327         pci_write_config_byte(dev, VIA_FIFO_CONFIG, t);
328
329         return 0;
330 }
331
332 /*
333  *      Cable special cases
334  */
335
336 static const struct dmi_system_id cable_dmi_table[] = {
337         {
338                 .ident = "Acer Ferrari 3400",
339                 .matches = {
340                         DMI_MATCH(DMI_BOARD_VENDOR, "Acer,Inc."),
341                         DMI_MATCH(DMI_BOARD_NAME, "Ferrari 3400"),
342                 },
343         },
344         { }
345 };
346
347 static int via_cable_override(struct pci_dev *pdev)
348 {
349         /* Systems by DMI */
350         if (dmi_check_system(cable_dmi_table))
351                 return 1;
352
353         /* Arima W730-K8/Targa Visionary 811/... */
354         if (pdev->subsystem_vendor == 0x161F &&
355             pdev->subsystem_device == 0x2032)
356                 return 1;
357
358         return 0;
359 }
360
361 static u8 via82cxxx_cable_detect(ide_hwif_t *hwif)
362 {
363         struct pci_dev *pdev = to_pci_dev(hwif->dev);
364         struct ide_host *host = pci_get_drvdata(pdev);
365         struct via82cxxx_dev *vdev = host->host_priv;
366
367         if (via_cable_override(pdev))
368                 return ATA_CBL_PATA40_SHORT;
369
370         if ((vdev->via_config->flags & VIA_SATA_PATA) && hwif->channel == 0)
371                 return ATA_CBL_SATA;
372
373         if ((vdev->via_80w >> hwif->channel) & 1)
374                 return ATA_CBL_PATA80;
375         else
376                 return ATA_CBL_PATA40;
377 }
378
379 static const struct ide_port_ops via_port_ops = {
380         .set_pio_mode           = via_set_pio_mode,
381         .set_dma_mode           = via_set_drive,
382         .cable_detect           = via82cxxx_cable_detect,
383 };
384
385 static const struct ide_port_info via82cxxx_chipset __devinitdata = {
386         .name           = DRV_NAME,
387         .init_chipset   = init_chipset_via82cxxx,
388         .enablebits     = { { 0x40, 0x02, 0x02 }, { 0x40, 0x01, 0x01 } },
389         .port_ops       = &via_port_ops,
390         .host_flags     = IDE_HFLAG_PIO_NO_BLACKLIST |
391                           IDE_HFLAG_POST_SET_MODE |
392                           IDE_HFLAG_IO_32BIT,
393         .pio_mask       = ATA_PIO5,
394         .swdma_mask     = ATA_SWDMA2,
395         .mwdma_mask     = ATA_MWDMA2,
396 };
397
398 static int __devinit via_init_one(struct pci_dev *dev, const struct pci_device_id *id)
399 {
400         struct pci_dev *isa = NULL;
401         struct via_isa_bridge *via_config;
402         struct via82cxxx_dev *vdev;
403         int rc;
404         u8 idx = id->driver_data;
405         struct ide_port_info d;
406
407         d = via82cxxx_chipset;
408
409         /*
410          * Find the ISA bridge and check we know what it is.
411          */
412         via_config = via_config_find(&isa);
413         if (!via_config->id) {
414                 printk(KERN_WARNING DRV_NAME " %s: unknown chipset, skipping\n",
415                         pci_name(dev));
416                 return -ENODEV;
417         }
418
419         /*
420          * Print the boot message.
421          */
422         printk(KERN_INFO DRV_NAME " %s: VIA %s (rev %02x) IDE %sDMA%s\n",
423                 pci_name(dev), via_config->name, isa->revision,
424                 via_config->udma_mask ? "U" : "MW",
425                 via_dma[via_config->udma_mask ?
426                         (fls(via_config->udma_mask) - 1) : 0]);
427
428         pci_dev_put(isa);
429
430         /*
431          * Determine system bus clock.
432          */
433         via_clock = (ide_pci_clk ? ide_pci_clk : 33) * 1000;
434
435         switch (via_clock) {
436         case 33000: via_clock = 33333; break;
437         case 37000: via_clock = 37500; break;
438         case 41000: via_clock = 41666; break;
439         }
440
441         if (via_clock < 20000 || via_clock > 50000) {
442                 printk(KERN_WARNING DRV_NAME ": User given PCI clock speed "
443                         "impossible (%d), using 33 MHz instead.\n", via_clock);
444                 via_clock = 33333;
445         }
446
447         if (idx == 1)
448                 d.enablebits[1].reg = d.enablebits[0].reg = 0;
449         else
450                 d.host_flags |= IDE_HFLAG_NO_AUTODMA;
451
452         if (idx == VIA_IDFLAG_SINGLE)
453                 d.host_flags |= IDE_HFLAG_SINGLE;
454
455         if ((via_config->flags & VIA_NO_UNMASK) == 0)
456                 d.host_flags |= IDE_HFLAG_UNMASK_IRQS;
457
458         d.udma_mask = via_config->udma_mask;
459
460         vdev = kzalloc(sizeof(*vdev), GFP_KERNEL);
461         if (!vdev) {
462                 printk(KERN_ERR DRV_NAME " %s: out of memory :(\n",
463                         pci_name(dev));
464                 return -ENOMEM;
465         }
466
467         vdev->via_config = via_config;
468
469         rc = ide_pci_init_one(dev, &d, vdev);
470         if (rc)
471                 kfree(vdev);
472
473         return rc;
474 }
475
476 static void __devexit via_remove(struct pci_dev *dev)
477 {
478         struct ide_host *host = pci_get_drvdata(dev);
479         struct via82cxxx_dev *vdev = host->host_priv;
480
481         ide_pci_remove(dev);
482         kfree(vdev);
483 }
484
485 static const struct pci_device_id via_pci_tbl[] = {
486         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_82C576_1),  0 },
487         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_82C586_1),  0 },
488         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_CX700_IDE), 0 },
489         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_VX855_IDE), VIA_IDFLAG_SINGLE },
490         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_6410),      1 },
491         { PCI_VDEVICE(VIA, PCI_DEVICE_ID_VIA_SATA_EIDE), 1 },
492         { 0, },
493 };
494 MODULE_DEVICE_TABLE(pci, via_pci_tbl);
495
496 static struct pci_driver via_pci_driver = {
497         .name           = "VIA_IDE",
498         .id_table       = via_pci_tbl,
499         .probe          = via_init_one,
500         .remove         = __devexit_p(via_remove),
501         .suspend        = ide_pci_suspend,
502         .resume         = ide_pci_resume,
503 };
504
505 static int __init via_ide_init(void)
506 {
507         return ide_pci_register_driver(&via_pci_driver);
508 }
509
510 static void __exit via_ide_exit(void)
511 {
512         pci_unregister_driver(&via_pci_driver);
513 }
514
515 module_init(via_ide_init);
516 module_exit(via_ide_exit);
517
518 MODULE_AUTHOR("Vojtech Pavlik, Bartlomiej Zolnierkiewicz, Michel Aubry, Jeff Garzik, Andre Hedrick");
519 MODULE_DESCRIPTION("PCI driver module for VIA IDE");
520 MODULE_LICENSE("GPL");