Merge master.kernel.org:/home/rmk/linux-2.6-drvmodel
[linux-2.6] / drivers / ide / pci / via82cxxx.c
1 /*
2  *
3  * Version 3.38
4  *
5  * VIA IDE driver for Linux. Supported southbridges:
6  *
7  *   vt82c576, vt82c586, vt82c586a, vt82c586b, vt82c596a, vt82c596b,
8  *   vt82c686, vt82c686a, vt82c686b, vt8231, vt8233, vt8233c, vt8233a,
9  *   vt8235, vt8237
10  *
11  * Copyright (c) 2000-2002 Vojtech Pavlik
12  *
13  * Based on the work of:
14  *      Michel Aubry
15  *      Jeff Garzik
16  *      Andre Hedrick
17  *
18  * Documentation:
19  *      Obsolete device documentation publically available from via.com.tw
20  *      Current device documentation available under NDA only
21  */
22
23 /*
24  * This program is free software; you can redistribute it and/or modify it
25  * under the terms of the GNU General Public License version 2 as published by
26  * the Free Software Foundation.
27  */
28
29 #include <linux/config.h>
30 #include <linux/module.h>
31 #include <linux/kernel.h>
32 #include <linux/ioport.h>
33 #include <linux/blkdev.h>
34 #include <linux/pci.h>
35 #include <linux/init.h>
36 #include <linux/ide.h>
37 #include <asm/io.h>
38
39 #ifdef CONFIG_PPC_MULTIPLATFORM
40 #include <asm/processor.h>
41 #endif
42
43 #include "ide-timing.h"
44
45 #define DISPLAY_VIA_TIMINGS
46
47 #define VIA_IDE_ENABLE          0x40
48 #define VIA_IDE_CONFIG          0x41
49 #define VIA_FIFO_CONFIG         0x43
50 #define VIA_MISC_1              0x44
51 #define VIA_MISC_2              0x45
52 #define VIA_MISC_3              0x46
53 #define VIA_DRIVE_TIMING        0x48
54 #define VIA_8BIT_TIMING         0x4e
55 #define VIA_ADDRESS_SETUP       0x4c
56 #define VIA_UDMA_TIMING         0x50
57
58 #define VIA_UDMA                0x007
59 #define VIA_UDMA_NONE           0x000
60 #define VIA_UDMA_33             0x001
61 #define VIA_UDMA_66             0x002
62 #define VIA_UDMA_100            0x003
63 #define VIA_UDMA_133            0x004
64 #define VIA_BAD_PREQ            0x010   /* Crashes if PREQ# till DDACK# set */
65 #define VIA_BAD_CLK66           0x020   /* 66 MHz clock doesn't work correctly */
66 #define VIA_SET_FIFO            0x040   /* Needs to have FIFO split set */
67 #define VIA_NO_UNMASK           0x080   /* Doesn't work with IRQ unmasking on */
68 #define VIA_BAD_ID              0x100   /* Has wrong vendor ID (0x1107) */
69 #define VIA_BAD_AST             0x200   /* Don't touch Address Setup Timing */
70
71 /*
72  * VIA SouthBridge chips.
73  */
74
75 static struct via_isa_bridge {
76         char *name;
77         u16 id;
78         u8 rev_min;
79         u8 rev_max;
80         u16 flags;
81 } via_isa_bridges[] = {
82         { "vt8237",     PCI_DEVICE_ID_VIA_8237,     0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
83         { "vt8235",     PCI_DEVICE_ID_VIA_8235,     0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
84         { "vt8233a",    PCI_DEVICE_ID_VIA_8233A,    0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
85         { "vt8233c",    PCI_DEVICE_ID_VIA_8233C_0,  0x00, 0x2f, VIA_UDMA_100 },
86         { "vt8233",     PCI_DEVICE_ID_VIA_8233_0,   0x00, 0x2f, VIA_UDMA_100 },
87         { "vt8231",     PCI_DEVICE_ID_VIA_8231,     0x00, 0x2f, VIA_UDMA_100 },
88         { "vt82c686b",  PCI_DEVICE_ID_VIA_82C686,   0x40, 0x4f, VIA_UDMA_100 },
89         { "vt82c686a",  PCI_DEVICE_ID_VIA_82C686,   0x10, 0x2f, VIA_UDMA_66 },
90         { "vt82c686",   PCI_DEVICE_ID_VIA_82C686,   0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
91         { "vt82c596b",  PCI_DEVICE_ID_VIA_82C596,   0x10, 0x2f, VIA_UDMA_66 },
92         { "vt82c596a",  PCI_DEVICE_ID_VIA_82C596,   0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
93         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x47, 0x4f, VIA_UDMA_33 | VIA_SET_FIFO },
94         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x40, 0x46, VIA_UDMA_33 | VIA_SET_FIFO | VIA_BAD_PREQ },
95         { "vt82c586b",  PCI_DEVICE_ID_VIA_82C586_0, 0x30, 0x3f, VIA_UDMA_33 | VIA_SET_FIFO },
96         { "vt82c586a",  PCI_DEVICE_ID_VIA_82C586_0, 0x20, 0x2f, VIA_UDMA_33 | VIA_SET_FIFO },
97         { "vt82c586",   PCI_DEVICE_ID_VIA_82C586_0, 0x00, 0x0f, VIA_UDMA_NONE | VIA_SET_FIFO },
98         { "vt82c576",   PCI_DEVICE_ID_VIA_82C576,   0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK },
99         { "vt82c576",   PCI_DEVICE_ID_VIA_82C576,   0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK | VIA_BAD_ID },
100         { NULL }
101 };
102
103 static unsigned int via_clock;
104 static char *via_dma[] = { "MWDMA16", "UDMA33", "UDMA66", "UDMA100", "UDMA133" };
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 = hwif->pci_dev;
124         struct via82cxxx_dev *vdev = ide_get_hwifdata(hwif);
125         u8 t;
126
127         if (~vdev->via_config->flags & VIA_BAD_AST) {
128                 pci_read_config_byte(dev, VIA_ADDRESS_SETUP, &t);
129                 t = (t & ~(3 << ((3 - dn) << 1))) | ((FIT(timing->setup, 1, 4) - 1) << ((3 - dn) << 1));
130                 pci_write_config_byte(dev, VIA_ADDRESS_SETUP, t);
131         }
132
133         pci_write_config_byte(dev, VIA_8BIT_TIMING + (1 - (dn >> 1)),
134                 ((FIT(timing->act8b, 1, 16) - 1) << 4) | (FIT(timing->rec8b, 1, 16) - 1));
135
136         pci_write_config_byte(dev, VIA_DRIVE_TIMING + (3 - dn),
137                 ((FIT(timing->active, 1, 16) - 1) << 4) | (FIT(timing->recover, 1, 16) - 1));
138
139         switch (vdev->via_config->flags & VIA_UDMA) {
140                 case VIA_UDMA_33:  t = timing->udma ? (0xe0 | (FIT(timing->udma, 2, 5) - 2)) : 0x03; break;
141                 case VIA_UDMA_66:  t = timing->udma ? (0xe8 | (FIT(timing->udma, 2, 9) - 2)) : 0x0f; break;
142                 case VIA_UDMA_100: t = timing->udma ? (0xe0 | (FIT(timing->udma, 2, 9) - 2)) : 0x07; break;
143                 case VIA_UDMA_133: t = timing->udma ? (0xe0 | (FIT(timing->udma, 2, 9) - 2)) : 0x07; break;
144                 default: return;
145         }
146
147         pci_write_config_byte(dev, VIA_UDMA_TIMING + (3 - dn), t);
148 }
149
150 /**
151  *      via_set_drive           -       configure transfer mode
152  *      @drive: Drive to set up
153  *      @speed: desired speed
154  *
155  *      via_set_drive() computes timing values configures the drive and
156  *      the chipset to a desired transfer mode. It also can be called
157  *      by upper layers.
158  */
159
160 static int via_set_drive(ide_drive_t *drive, u8 speed)
161 {
162         ide_drive_t *peer = HWIF(drive)->drives + (~drive->dn & 1);
163         struct via82cxxx_dev *vdev = ide_get_hwifdata(drive->hwif);
164         struct ide_timing t, p;
165         unsigned int T, UT;
166
167         if (speed != XFER_PIO_SLOW)
168                 ide_config_drive_speed(drive, speed);
169
170         T = 1000000000 / via_clock;
171
172         switch (vdev->via_config->flags & VIA_UDMA) {
173                 case VIA_UDMA_33:   UT = T;   break;
174                 case VIA_UDMA_66:   UT = T/2; break;
175                 case VIA_UDMA_100:  UT = T/3; break;
176                 case VIA_UDMA_133:  UT = T/4; break;
177                 default: UT = T;
178         }
179
180         ide_timing_compute(drive, speed, &t, T, UT);
181
182         if (peer->present) {
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), drive->dn, &t);
188
189         if (!drive->init_speed)
190                 drive->init_speed = speed;
191         drive->current_speed = speed;
192
193         return 0;
194 }
195
196 /**
197  *      via82cxxx_tune_drive    -       PIO setup
198  *      @drive: drive to set up
199  *      @pio: mode to use (255 for 'best possible')
200  *
201  *      A callback from the upper layers for PIO-only tuning.
202  */
203
204 static void via82cxxx_tune_drive(ide_drive_t *drive, u8 pio)
205 {
206         if (pio == 255) {
207                 via_set_drive(drive,
208                         ide_find_best_mode(drive, XFER_PIO | XFER_EPIO));
209                 return;
210         }
211
212         via_set_drive(drive, XFER_PIO_0 + min_t(u8, pio, 5));
213 }
214
215 /**
216  *      via82cxxx_ide_dma_check         -       set up for DMA if possible
217  *      @drive: IDE drive to set up
218  *
219  *      Set up the drive for the highest supported speed considering the
220  *      driver, controller and cable
221  */
222  
223 static int via82cxxx_ide_dma_check (ide_drive_t *drive)
224 {
225         ide_hwif_t *hwif = HWIF(drive);
226         struct via82cxxx_dev *vdev = ide_get_hwifdata(hwif);
227         u16 w80 = hwif->udma_four;
228
229         u16 speed = ide_find_best_mode(drive,
230                 XFER_PIO | XFER_EPIO | XFER_SWDMA | XFER_MWDMA |
231                 (vdev->via_config->flags & VIA_UDMA ? XFER_UDMA : 0) |
232                 (w80 && (vdev->via_config->flags & VIA_UDMA) >= VIA_UDMA_66 ? XFER_UDMA_66 : 0) |
233                 (w80 && (vdev->via_config->flags & VIA_UDMA) >= VIA_UDMA_100 ? XFER_UDMA_100 : 0) |
234                 (w80 && (vdev->via_config->flags & VIA_UDMA) >= VIA_UDMA_133 ? XFER_UDMA_133 : 0));
235
236         via_set_drive(drive, speed);
237
238         if (drive->autodma && (speed & XFER_MODE) != XFER_PIO)
239                 return hwif->ide_dma_on(drive);
240         return hwif->ide_dma_off_quietly(drive);
241 }
242
243 static struct via_isa_bridge *via_config_find(struct pci_dev **isa)
244 {
245         struct via_isa_bridge *via_config;
246         u8 t;
247
248         for (via_config = via_isa_bridges; via_config->id; via_config++)
249                 if ((*isa = pci_find_device(PCI_VENDOR_ID_VIA +
250                         !!(via_config->flags & VIA_BAD_ID),
251                         via_config->id, NULL))) {
252
253                         pci_read_config_byte(*isa, PCI_REVISION_ID, &t);
254                         if (t >= via_config->rev_min &&
255                             t <= via_config->rev_max)
256                                 break;
257                 }
258
259         return via_config;
260 }
261
262 /**
263  *      init_chipset_via82cxxx  -       initialization handler
264  *      @dev: PCI device
265  *      @name: Name of interface
266  *
267  *      The initialization callback. Here we determine the IDE chip type
268  *      and initialize its drive independent registers.
269  */
270
271 static unsigned int __devinit init_chipset_via82cxxx(struct pci_dev *dev, const char *name)
272 {
273         struct pci_dev *isa = NULL;
274         struct via_isa_bridge *via_config;
275         u8 t, v;
276         unsigned int u;
277
278         /*
279          * Find the ISA bridge to see how good the IDE is.
280          */
281         via_config = via_config_find(&isa);
282         if (!via_config->id) {
283                 printk(KERN_WARNING "VP_IDE: Unknown VIA SouthBridge, disabling DMA.\n");
284                 return -ENODEV;
285         }
286
287         /*
288          * Setup or disable Clk66 if appropriate
289          */
290
291         if ((via_config->flags & VIA_UDMA) == VIA_UDMA_66) {
292                 /* Enable Clk66 */
293                 pci_read_config_dword(dev, VIA_UDMA_TIMING, &u);
294                 pci_write_config_dword(dev, VIA_UDMA_TIMING, u|0x80008);
295         } else if (via_config->flags & VIA_BAD_CLK66) {
296                 /* Would cause trouble on 596a and 686 */
297                 pci_read_config_dword(dev, VIA_UDMA_TIMING, &u);
298                 pci_write_config_dword(dev, VIA_UDMA_TIMING, u & ~0x80008);
299         }
300
301         /*
302          * Check whether interfaces are enabled.
303          */
304
305         pci_read_config_byte(dev, VIA_IDE_ENABLE, &v);
306
307         /*
308          * Set up FIFO sizes and thresholds.
309          */
310
311         pci_read_config_byte(dev, VIA_FIFO_CONFIG, &t);
312
313         /* Disable PREQ# till DDACK# */
314         if (via_config->flags & VIA_BAD_PREQ) {
315                 /* Would crash on 586b rev 41 */
316                 t &= 0x7f;
317         }
318
319         /* Fix FIFO split between channels */
320         if (via_config->flags & VIA_SET_FIFO) {
321                 t &= (t & 0x9f);
322                 switch (v & 3) {
323                         case 2: t |= 0x00; break;       /* 16 on primary */
324                         case 1: t |= 0x60; break;       /* 16 on secondary */
325                         case 3: t |= 0x20; break;       /* 8 pri 8 sec */
326                 }
327         }
328
329         pci_write_config_byte(dev, VIA_FIFO_CONFIG, t);
330
331         /*
332          * Determine system bus clock.
333          */
334
335         via_clock = system_bus_clock() * 1000;
336
337         switch (via_clock) {
338                 case 33000: via_clock = 33333; break;
339                 case 37000: via_clock = 37500; break;
340                 case 41000: via_clock = 41666; break;
341         }
342
343         if (via_clock < 20000 || via_clock > 50000) {
344                 printk(KERN_WARNING "VP_IDE: User given PCI clock speed "
345                         "impossible (%d), using 33 MHz instead.\n", via_clock);
346                 printk(KERN_WARNING "VP_IDE: Use ide0=ata66 if you want "
347                         "to assume 80-wire cable.\n");
348                 via_clock = 33333;
349         }
350
351         /*
352          * Print the boot message.
353          */
354
355         pci_read_config_byte(isa, PCI_REVISION_ID, &t);
356         printk(KERN_INFO "VP_IDE: VIA %s (rev %02x) IDE %s "
357                 "controller on pci%s\n",
358                 via_config->name, t,
359                 via_dma[via_config->flags & VIA_UDMA],
360                 pci_name(dev));
361
362         return 0;
363 }
364
365 /*
366  * Check and handle 80-wire cable presence
367  */
368 static void __devinit via_cable_detect(struct pci_dev *dev, struct via82cxxx_dev *vdev)
369 {
370         unsigned int u;
371         int i;
372         pci_read_config_dword(dev, VIA_UDMA_TIMING, &u);
373
374         switch (vdev->via_config->flags & VIA_UDMA) {
375
376                 case VIA_UDMA_66:
377                         for (i = 24; i >= 0; i -= 8)
378                                 if (((u >> (i & 16)) & 8) &&
379                                     ((u >> i) & 0x20) &&
380                                      (((u >> i) & 7) < 2)) {
381                                         /*
382                                          * 2x PCI clock and
383                                          * UDMA w/ < 3T/cycle
384                                          */
385                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
386                                 }
387                         break;
388
389                 case VIA_UDMA_100:
390                         for (i = 24; i >= 0; i -= 8)
391                                 if (((u >> i) & 0x10) ||
392                                     (((u >> i) & 0x20) &&
393                                      (((u >> i) & 7) < 4))) {
394                                         /* BIOS 80-wire bit or
395                                          * UDMA w/ < 60ns/cycle
396                                          */
397                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
398                                 }
399                         break;
400
401                 case VIA_UDMA_133:
402                         for (i = 24; i >= 0; i -= 8)
403                                 if (((u >> i) & 0x10) ||
404                                     (((u >> i) & 0x20) &&
405                                      (((u >> i) & 7) < 6))) {
406                                         /* BIOS 80-wire bit or
407                                          * UDMA w/ < 60ns/cycle
408                                          */
409                                         vdev->via_80w |= (1 << (1 - (i >> 4)));
410                                 }
411                         break;
412
413         }
414 }
415
416 static void __devinit init_hwif_via82cxxx(ide_hwif_t *hwif)
417 {
418         struct via82cxxx_dev *vdev = kmalloc(sizeof(struct via82cxxx_dev),
419                 GFP_KERNEL);
420         struct pci_dev *isa = NULL;
421         int i;
422
423         if (vdev == NULL) {
424                 printk(KERN_ERR "VP_IDE: out of memory :(\n");
425                 return;
426         }
427
428         memset(vdev, 0, sizeof(struct via82cxxx_dev));
429         ide_set_hwifdata(hwif, vdev);
430
431         vdev->via_config = via_config_find(&isa);
432         via_cable_detect(hwif->pci_dev, vdev);
433
434         hwif->autodma = 0;
435
436         hwif->tuneproc = &via82cxxx_tune_drive;
437         hwif->speedproc = &via_set_drive;
438
439
440 #if defined(CONFIG_PPC_MULTIPLATFORM) && defined(CONFIG_PPC32)
441         if(_machine == _MACH_chrp && _chrp_type == _CHRP_Pegasos) {
442                 hwif->irq = hwif->channel ? 15 : 14;
443         }
444 #endif
445
446         for (i = 0; i < 2; i++) {
447                 hwif->drives[i].io_32bit = 1;
448                 hwif->drives[i].unmask = (vdev->via_config->flags & VIA_NO_UNMASK) ? 0 : 1;
449                 hwif->drives[i].autotune = 1;
450                 hwif->drives[i].dn = hwif->channel * 2 + i;
451         }
452
453         if (!hwif->dma_base)
454                 return;
455
456         hwif->atapi_dma = 1;
457         hwif->ultra_mask = 0x7f;
458         hwif->mwdma_mask = 0x07;
459         hwif->swdma_mask = 0x07;
460
461         if (!hwif->udma_four)
462                 hwif->udma_four = (vdev->via_80w >> hwif->channel) & 1;
463         hwif->ide_dma_check = &via82cxxx_ide_dma_check;
464         if (!noautodma)
465                 hwif->autodma = 1;
466         hwif->drives[0].autodma = hwif->autodma;
467         hwif->drives[1].autodma = hwif->autodma;
468 }
469
470 static ide_pci_device_t via82cxxx_chipset __devinitdata = {
471         .name           = "VP_IDE",
472         .init_chipset   = init_chipset_via82cxxx,
473         .init_hwif      = init_hwif_via82cxxx,
474         .channels       = 2,
475         .autodma        = NOAUTODMA,
476         .enablebits     = {{0x40,0x02,0x02}, {0x40,0x01,0x01}},
477         .bootable       = ON_BOARD,
478 };
479
480 static int __devinit via_init_one(struct pci_dev *dev, const struct pci_device_id *id)
481 {
482         return ide_setup_pci_device(dev, &via82cxxx_chipset);
483 }
484
485 static struct pci_device_id via_pci_tbl[] = {
486         { PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C576_1, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
487         { PCI_VENDOR_ID_VIA, PCI_DEVICE_ID_VIA_82C586_1, PCI_ANY_ID, PCI_ANY_ID, 0, 0, 0},
488         { 0, },
489 };
490 MODULE_DEVICE_TABLE(pci, via_pci_tbl);
491
492 static struct pci_driver driver = {
493         .name           = "VIA_IDE",
494         .id_table       = via_pci_tbl,
495         .probe          = via_init_one,
496 };
497
498 static int via_ide_init(void)
499 {
500         return ide_pci_register_driver(&driver);
501 }
502
503 module_init(via_ide_init);
504
505 MODULE_AUTHOR("Vojtech Pavlik, Michel Aubry, Jeff Garzik, Andre Hedrick");
506 MODULE_DESCRIPTION("PCI driver module for VIA IDE");
507 MODULE_LICENSE("GPL");