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