Linux 2.6.26-rc1
[cris-mirror.git] / drivers / ata / pata_via.c
blob2fea6cbe7755853b73331d09c1de61ccbba28a35
1 /*
2 * pata_via.c - VIA PATA for new ATA layer
3 * (C) 2005-2006 Red Hat Inc
4 * Alan Cox <alan@redhat.com>
6 * Documentation
7 * Most chipset documentation available under NDA only
9 * VIA version guide
10 * VIA VT82C561 - early design, uses ata_generic currently
11 * VIA VT82C576 - MWDMA, 33Mhz
12 * VIA VT82C586 - MWDMA, 33Mhz
13 * VIA VT82C586a - Added UDMA to 33Mhz
14 * VIA VT82C586b - UDMA33
15 * VIA VT82C596a - Nonfunctional UDMA66
16 * VIA VT82C596b - Working UDMA66
17 * VIA VT82C686 - Nonfunctional UDMA66
18 * VIA VT82C686a - Working UDMA66
19 * VIA VT82C686b - Updated to UDMA100
20 * VIA VT8231 - UDMA100
21 * VIA VT8233 - UDMA100
22 * VIA VT8233a - UDMA133
23 * VIA VT8233c - UDMA100
24 * VIA VT8235 - UDMA133
25 * VIA VT8237 - UDMA133
26 * VIA VT8237S - UDMA133
27 * VIA VT8251 - UDMA133
29 * Most registers remain compatible across chips. Others start reserved
30 * and acquire sensible semantics if set to 1 (eg cable detect). A few
31 * exceptions exist, notably around the FIFO settings.
33 * One additional quirk of the VIA design is that like ALi they use few
34 * PCI IDs for a lot of chips.
36 * Based heavily on:
38 * Version 3.38
40 * VIA IDE driver for Linux. Supported southbridges:
42 * vt82c576, vt82c586, vt82c586a, vt82c586b, vt82c596a, vt82c596b,
43 * vt82c686, vt82c686a, vt82c686b, vt8231, vt8233, vt8233c, vt8233a,
44 * vt8235, vt8237
46 * Copyright (c) 2000-2002 Vojtech Pavlik
48 * Based on the work of:
49 * Michel Aubry
50 * Jeff Garzik
51 * Andre Hedrick
55 #include <linux/kernel.h>
56 #include <linux/module.h>
57 #include <linux/pci.h>
58 #include <linux/init.h>
59 #include <linux/blkdev.h>
60 #include <linux/delay.h>
61 #include <scsi/scsi_host.h>
62 #include <linux/libata.h>
63 #include <linux/dmi.h>
65 #define DRV_NAME "pata_via"
66 #define DRV_VERSION "0.3.3"
69 * The following comes directly from Vojtech Pavlik's ide/pci/via82cxxx
70 * driver.
73 enum {
74 VIA_UDMA = 0x007,
75 VIA_UDMA_NONE = 0x000,
76 VIA_UDMA_33 = 0x001,
77 VIA_UDMA_66 = 0x002,
78 VIA_UDMA_100 = 0x003,
79 VIA_UDMA_133 = 0x004,
80 VIA_BAD_PREQ = 0x010, /* Crashes if PREQ# till DDACK# set */
81 VIA_BAD_CLK66 = 0x020, /* 66 MHz clock doesn't work correctly */
82 VIA_SET_FIFO = 0x040, /* Needs to have FIFO split set */
83 VIA_NO_UNMASK = 0x080, /* Doesn't work with IRQ unmasking on */
84 VIA_BAD_ID = 0x100, /* Has wrong vendor ID (0x1107) */
85 VIA_BAD_AST = 0x200, /* Don't touch Address Setup Timing */
86 VIA_NO_ENABLES = 0x400, /* Has no enablebits */
87 VIA_SATA_PATA = 0x800, /* SATA/PATA combined configuration */
91 * VIA SouthBridge chips.
94 static const struct via_isa_bridge {
95 const char *name;
96 u16 id;
97 u8 rev_min;
98 u8 rev_max;
99 u16 flags;
100 } via_isa_bridges[] = {
101 { "vx800", PCI_DEVICE_ID_VIA_VX800, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
102 { "vt8237s", PCI_DEVICE_ID_VIA_8237S, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
103 { "vt8251", PCI_DEVICE_ID_VIA_8251, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
104 { "cx700", PCI_DEVICE_ID_VIA_CX700, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST | VIA_SATA_PATA },
105 { "vt6410", PCI_DEVICE_ID_VIA_6410, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST | VIA_NO_ENABLES},
106 { "vt8237a", PCI_DEVICE_ID_VIA_8237A, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
107 { "vt8237", PCI_DEVICE_ID_VIA_8237, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
108 { "vt8235", PCI_DEVICE_ID_VIA_8235, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
109 { "vt8233a", PCI_DEVICE_ID_VIA_8233A, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
110 { "vt8233c", PCI_DEVICE_ID_VIA_8233C_0, 0x00, 0x2f, VIA_UDMA_100 },
111 { "vt8233", PCI_DEVICE_ID_VIA_8233_0, 0x00, 0x2f, VIA_UDMA_100 },
112 { "vt8231", PCI_DEVICE_ID_VIA_8231, 0x00, 0x2f, VIA_UDMA_100 },
113 { "vt82c686b", PCI_DEVICE_ID_VIA_82C686, 0x40, 0x4f, VIA_UDMA_100 },
114 { "vt82c686a", PCI_DEVICE_ID_VIA_82C686, 0x10, 0x2f, VIA_UDMA_66 },
115 { "vt82c686", PCI_DEVICE_ID_VIA_82C686, 0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
116 { "vt82c596b", PCI_DEVICE_ID_VIA_82C596, 0x10, 0x2f, VIA_UDMA_66 },
117 { "vt82c596a", PCI_DEVICE_ID_VIA_82C596, 0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
118 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x47, 0x4f, VIA_UDMA_33 | VIA_SET_FIFO },
119 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x40, 0x46, VIA_UDMA_33 | VIA_SET_FIFO | VIA_BAD_PREQ },
120 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x30, 0x3f, VIA_UDMA_33 | VIA_SET_FIFO },
121 { "vt82c586a", PCI_DEVICE_ID_VIA_82C586_0, 0x20, 0x2f, VIA_UDMA_33 | VIA_SET_FIFO },
122 { "vt82c586", PCI_DEVICE_ID_VIA_82C586_0, 0x00, 0x0f, VIA_UDMA_NONE | VIA_SET_FIFO },
123 { "vt82c576", PCI_DEVICE_ID_VIA_82C576, 0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK },
124 { "vt82c576", PCI_DEVICE_ID_VIA_82C576, 0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK | VIA_BAD_ID },
125 { NULL }
130 * Cable special cases
133 static const struct dmi_system_id cable_dmi_table[] = {
135 .ident = "Acer Ferrari 3400",
136 .matches = {
137 DMI_MATCH(DMI_BOARD_VENDOR, "Acer,Inc."),
138 DMI_MATCH(DMI_BOARD_NAME, "Ferrari 3400"),
144 static int via_cable_override(struct pci_dev *pdev)
146 /* Systems by DMI */
147 if (dmi_check_system(cable_dmi_table))
148 return 1;
149 /* Arima W730-K8/Targa Visionary 811/... */
150 if (pdev->subsystem_vendor == 0x161F && pdev->subsystem_device == 0x2032)
151 return 1;
152 return 0;
157 * via_cable_detect - cable detection
158 * @ap: ATA port
160 * Perform cable detection. Actually for the VIA case the BIOS
161 * already did this for us. We read the values provided by the
162 * BIOS. If you are using an 8235 in a non-PC configuration you
163 * may need to update this code.
165 * Hotplug also impacts on this.
168 static int via_cable_detect(struct ata_port *ap) {
169 const struct via_isa_bridge *config = ap->host->private_data;
170 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
171 u32 ata66;
173 if (via_cable_override(pdev))
174 return ATA_CBL_PATA40_SHORT;
176 if ((config->flags & VIA_SATA_PATA) && ap->port_no == 0)
177 return ATA_CBL_SATA;
179 /* Early chips are 40 wire */
180 if ((config->flags & VIA_UDMA) < VIA_UDMA_66)
181 return ATA_CBL_PATA40;
182 /* UDMA 66 chips have only drive side logic */
183 else if ((config->flags & VIA_UDMA) < VIA_UDMA_100)
184 return ATA_CBL_PATA_UNK;
185 /* UDMA 100 or later */
186 pci_read_config_dword(pdev, 0x50, &ata66);
187 /* Check both the drive cable reporting bits, we might not have
188 two drives */
189 if (ata66 & (0x10100000 >> (16 * ap->port_no)))
190 return ATA_CBL_PATA80;
191 /* Check with ACPI so we can spot BIOS reported SATA bridges */
192 if (ata_acpi_init_gtm(ap) &&
193 ata_acpi_cbl_80wire(ap, ata_acpi_init_gtm(ap)))
194 return ATA_CBL_PATA80;
195 return ATA_CBL_PATA40;
198 static int via_pre_reset(struct ata_link *link, unsigned long deadline)
200 struct ata_port *ap = link->ap;
201 const struct via_isa_bridge *config = ap->host->private_data;
203 if (!(config->flags & VIA_NO_ENABLES)) {
204 static const struct pci_bits via_enable_bits[] = {
205 { 0x40, 1, 0x02, 0x02 },
206 { 0x40, 1, 0x01, 0x01 }
208 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
209 if (!pci_test_config_bits(pdev, &via_enable_bits[ap->port_no]))
210 return -ENOENT;
213 return ata_sff_prereset(link, deadline);
218 * via_do_set_mode - set initial PIO mode data
219 * @ap: ATA interface
220 * @adev: ATA device
221 * @mode: ATA mode being programmed
222 * @tdiv: Clocks per PCI clock
223 * @set_ast: Set to program address setup
224 * @udma_type: UDMA mode/format of registers
226 * Program the VIA registers for DMA and PIO modes. Uses the ata timing
227 * support in order to compute modes.
229 * FIXME: Hotplug will require we serialize multiple mode changes
230 * on the two channels.
233 static void via_do_set_mode(struct ata_port *ap, struct ata_device *adev, int mode, int tdiv, int set_ast, int udma_type)
235 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
236 struct ata_device *peer = ata_dev_pair(adev);
237 struct ata_timing t, p;
238 static int via_clock = 33333; /* Bus clock in kHZ - ought to be tunable one day */
239 unsigned long T = 1000000000 / via_clock;
240 unsigned long UT = T/tdiv;
241 int ut;
242 int offset = 3 - (2*ap->port_no) - adev->devno;
244 /* Calculate the timing values we require */
245 ata_timing_compute(adev, mode, &t, T, UT);
247 /* We share 8bit timing so we must merge the constraints */
248 if (peer) {
249 if (peer->pio_mode) {
250 ata_timing_compute(peer, peer->pio_mode, &p, T, UT);
251 ata_timing_merge(&p, &t, &t, ATA_TIMING_8BIT);
255 /* Address setup is programmable but breaks on UDMA133 setups */
256 if (set_ast) {
257 u8 setup; /* 2 bits per drive */
258 int shift = 2 * offset;
260 pci_read_config_byte(pdev, 0x4C, &setup);
261 setup &= ~(3 << shift);
262 setup |= FIT(t.setup, 1, 4) << shift; /* 1,4 or 1,4 - 1 FIXME */
263 pci_write_config_byte(pdev, 0x4C, setup);
266 /* Load the PIO mode bits */
267 pci_write_config_byte(pdev, 0x4F - ap->port_no,
268 ((FIT(t.act8b, 1, 16) - 1) << 4) | (FIT(t.rec8b, 1, 16) - 1));
269 pci_write_config_byte(pdev, 0x48 + offset,
270 ((FIT(t.active, 1, 16) - 1) << 4) | (FIT(t.recover, 1, 16) - 1));
272 /* Load the UDMA bits according to type */
273 switch(udma_type) {
274 default:
275 /* BUG() ? */
276 /* fall through */
277 case 33:
278 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 5) - 2)) : 0x03;
279 break;
280 case 66:
281 ut = t.udma ? (0xe8 | (FIT(t.udma, 2, 9) - 2)) : 0x0f;
282 break;
283 case 100:
284 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 9) - 2)) : 0x07;
285 break;
286 case 133:
287 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 9) - 2)) : 0x07;
288 break;
291 /* Set UDMA unless device is not UDMA capable */
292 if (udma_type && t.udma) {
293 u8 cable80_status;
295 /* Get 80-wire cable detection bit */
296 pci_read_config_byte(pdev, 0x50 + offset, &cable80_status);
297 cable80_status &= 0x10;
299 pci_write_config_byte(pdev, 0x50 + offset, ut | cable80_status);
303 static void via_set_piomode(struct ata_port *ap, struct ata_device *adev)
305 const struct via_isa_bridge *config = ap->host->private_data;
306 int set_ast = (config->flags & VIA_BAD_AST) ? 0 : 1;
307 int mode = config->flags & VIA_UDMA;
308 static u8 tclock[5] = { 1, 1, 2, 3, 4 };
309 static u8 udma[5] = { 0, 33, 66, 100, 133 };
311 via_do_set_mode(ap, adev, adev->pio_mode, tclock[mode], set_ast, udma[mode]);
314 static void via_set_dmamode(struct ata_port *ap, struct ata_device *adev)
316 const struct via_isa_bridge *config = ap->host->private_data;
317 int set_ast = (config->flags & VIA_BAD_AST) ? 0 : 1;
318 int mode = config->flags & VIA_UDMA;
319 static u8 tclock[5] = { 1, 1, 2, 3, 4 };
320 static u8 udma[5] = { 0, 33, 66, 100, 133 };
322 via_do_set_mode(ap, adev, adev->dma_mode, tclock[mode], set_ast, udma[mode]);
325 static struct scsi_host_template via_sht = {
326 ATA_BMDMA_SHT(DRV_NAME),
329 static struct ata_port_operations via_port_ops = {
330 .inherits = &ata_bmdma_port_ops,
331 .cable_detect = via_cable_detect,
332 .set_piomode = via_set_piomode,
333 .set_dmamode = via_set_dmamode,
334 .prereset = via_pre_reset,
337 static struct ata_port_operations via_port_ops_noirq = {
338 .inherits = &via_port_ops,
339 .sff_data_xfer = ata_sff_data_xfer_noirq,
343 * via_config_fifo - set up the FIFO
344 * @pdev: PCI device
345 * @flags: configuration flags
347 * Set the FIFO properties for this device if necessary. Used both on
348 * set up and on and the resume path
351 static void via_config_fifo(struct pci_dev *pdev, unsigned int flags)
353 u8 enable;
355 /* 0x40 low bits indicate enabled channels */
356 pci_read_config_byte(pdev, 0x40 , &enable);
357 enable &= 3;
359 if (flags & VIA_SET_FIFO) {
360 static const u8 fifo_setting[4] = {0x00, 0x60, 0x00, 0x20};
361 u8 fifo;
363 pci_read_config_byte(pdev, 0x43, &fifo);
365 /* Clear PREQ# until DDACK# for errata */
366 if (flags & VIA_BAD_PREQ)
367 fifo &= 0x7F;
368 else
369 fifo &= 0x9f;
370 /* Turn on FIFO for enabled channels */
371 fifo |= fifo_setting[enable];
372 pci_write_config_byte(pdev, 0x43, fifo);
377 * via_init_one - discovery callback
378 * @pdev: PCI device
379 * @id: PCI table info
381 * A VIA IDE interface has been discovered. Figure out what revision
382 * and perform configuration work before handing it to the ATA layer
385 static int via_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
387 /* Early VIA without UDMA support */
388 static const struct ata_port_info via_mwdma_info = {
389 .flags = ATA_FLAG_SLAVE_POSS,
390 .pio_mask = 0x1f,
391 .mwdma_mask = 0x07,
392 .port_ops = &via_port_ops
394 /* Ditto with IRQ masking required */
395 static const struct ata_port_info via_mwdma_info_borked = {
396 .flags = ATA_FLAG_SLAVE_POSS,
397 .pio_mask = 0x1f,
398 .mwdma_mask = 0x07,
399 .port_ops = &via_port_ops_noirq,
401 /* VIA UDMA 33 devices (and borked 66) */
402 static const struct ata_port_info via_udma33_info = {
403 .flags = ATA_FLAG_SLAVE_POSS,
404 .pio_mask = 0x1f,
405 .mwdma_mask = 0x07,
406 .udma_mask = ATA_UDMA2,
407 .port_ops = &via_port_ops
409 /* VIA UDMA 66 devices */
410 static const struct ata_port_info via_udma66_info = {
411 .flags = ATA_FLAG_SLAVE_POSS,
412 .pio_mask = 0x1f,
413 .mwdma_mask = 0x07,
414 .udma_mask = ATA_UDMA4,
415 .port_ops = &via_port_ops
417 /* VIA UDMA 100 devices */
418 static const struct ata_port_info via_udma100_info = {
419 .flags = ATA_FLAG_SLAVE_POSS,
420 .pio_mask = 0x1f,
421 .mwdma_mask = 0x07,
422 .udma_mask = ATA_UDMA5,
423 .port_ops = &via_port_ops
425 /* UDMA133 with bad AST (All current 133) */
426 static const struct ata_port_info via_udma133_info = {
427 .flags = ATA_FLAG_SLAVE_POSS,
428 .pio_mask = 0x1f,
429 .mwdma_mask = 0x07,
430 .udma_mask = ATA_UDMA6, /* FIXME: should check north bridge */
431 .port_ops = &via_port_ops
433 const struct ata_port_info *ppi[] = { NULL, NULL };
434 struct pci_dev *isa = NULL;
435 const struct via_isa_bridge *config;
436 static int printed_version;
437 u8 enable;
438 u32 timing;
439 int rc;
441 if (!printed_version++)
442 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
444 rc = pcim_enable_device(pdev);
445 if (rc)
446 return rc;
448 /* To find out how the IDE will behave and what features we
449 actually have to look at the bridge not the IDE controller */
450 for (config = via_isa_bridges; config->id; config++)
451 if ((isa = pci_get_device(PCI_VENDOR_ID_VIA +
452 !!(config->flags & VIA_BAD_ID),
453 config->id, NULL))) {
455 if (isa->revision >= config->rev_min &&
456 isa->revision <= config->rev_max)
457 break;
458 pci_dev_put(isa);
461 if (!config->id) {
462 printk(KERN_WARNING "via: Unknown VIA SouthBridge, disabling.\n");
463 return -ENODEV;
465 pci_dev_put(isa);
467 if (!(config->flags & VIA_NO_ENABLES)) {
468 /* 0x40 low bits indicate enabled channels */
469 pci_read_config_byte(pdev, 0x40 , &enable);
470 enable &= 3;
471 if (enable == 0)
472 return -ENODEV;
475 /* Initialise the FIFO for the enabled channels. */
476 via_config_fifo(pdev, config->flags);
478 /* Clock set up */
479 switch(config->flags & VIA_UDMA) {
480 case VIA_UDMA_NONE:
481 if (config->flags & VIA_NO_UNMASK)
482 ppi[0] = &via_mwdma_info_borked;
483 else
484 ppi[0] = &via_mwdma_info;
485 break;
486 case VIA_UDMA_33:
487 ppi[0] = &via_udma33_info;
488 break;
489 case VIA_UDMA_66:
490 ppi[0] = &via_udma66_info;
491 /* The 66 MHz devices require we enable the clock */
492 pci_read_config_dword(pdev, 0x50, &timing);
493 timing |= 0x80008;
494 pci_write_config_dword(pdev, 0x50, timing);
495 break;
496 case VIA_UDMA_100:
497 ppi[0] = &via_udma100_info;
498 break;
499 case VIA_UDMA_133:
500 ppi[0] = &via_udma133_info;
501 break;
502 default:
503 WARN_ON(1);
504 return -ENODEV;
507 if (config->flags & VIA_BAD_CLK66) {
508 /* Disable the 66MHz clock on problem devices */
509 pci_read_config_dword(pdev, 0x50, &timing);
510 timing &= ~0x80008;
511 pci_write_config_dword(pdev, 0x50, timing);
514 /* We have established the device type, now fire it up */
515 return ata_pci_sff_init_one(pdev, ppi, &via_sht, (void *)config);
518 #ifdef CONFIG_PM
520 * via_reinit_one - reinit after resume
521 * @pdev; PCI device
523 * Called when the VIA PATA device is resumed. We must then
524 * reconfigure the fifo and other setup we may have altered. In
525 * addition the kernel needs to have the resume methods on PCI
526 * quirk supported.
529 static int via_reinit_one(struct pci_dev *pdev)
531 u32 timing;
532 struct ata_host *host = dev_get_drvdata(&pdev->dev);
533 const struct via_isa_bridge *config = host->private_data;
534 int rc;
536 rc = ata_pci_device_do_resume(pdev);
537 if (rc)
538 return rc;
540 via_config_fifo(pdev, config->flags);
542 if ((config->flags & VIA_UDMA) == VIA_UDMA_66) {
543 /* The 66 MHz devices require we enable the clock */
544 pci_read_config_dword(pdev, 0x50, &timing);
545 timing |= 0x80008;
546 pci_write_config_dword(pdev, 0x50, timing);
548 if (config->flags & VIA_BAD_CLK66) {
549 /* Disable the 66MHz clock on problem devices */
550 pci_read_config_dword(pdev, 0x50, &timing);
551 timing &= ~0x80008;
552 pci_write_config_dword(pdev, 0x50, timing);
555 ata_host_resume(host);
556 return 0;
558 #endif
560 static const struct pci_device_id via[] = {
561 { PCI_VDEVICE(VIA, 0x0571), },
562 { PCI_VDEVICE(VIA, 0x0581), },
563 { PCI_VDEVICE(VIA, 0x1571), },
564 { PCI_VDEVICE(VIA, 0x3164), },
565 { PCI_VDEVICE(VIA, 0x5324), },
567 { },
570 static struct pci_driver via_pci_driver = {
571 .name = DRV_NAME,
572 .id_table = via,
573 .probe = via_init_one,
574 .remove = ata_pci_remove_one,
575 #ifdef CONFIG_PM
576 .suspend = ata_pci_device_suspend,
577 .resume = via_reinit_one,
578 #endif
581 static int __init via_init(void)
583 return pci_register_driver(&via_pci_driver);
586 static void __exit via_exit(void)
588 pci_unregister_driver(&via_pci_driver);
591 MODULE_AUTHOR("Alan Cox");
592 MODULE_DESCRIPTION("low-level driver for VIA PATA");
593 MODULE_LICENSE("GPL");
594 MODULE_DEVICE_TABLE(pci, via);
595 MODULE_VERSION(DRV_VERSION);
597 module_init(via_init);
598 module_exit(via_exit);