2 * pata_via.c - VIA PATA for new ATA layer
3 * (C) 2005-2006 Red Hat Inc
4 * Alan Cox <alan@redhat.com>
7 * Most chipset documentation available under NDA only
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.
40 * VIA IDE driver for Linux. Supported southbridges:
42 * vt82c576, vt82c586, vt82c586a, vt82c586b, vt82c596a, vt82c596b,
43 * vt82c686, vt82c686a, vt82c686b, vt8231, vt8233, vt8233c, vt8233a,
46 * Copyright (c) 2000-2002 Vojtech Pavlik
48 * Based on the work of:
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.1"
69 * The following comes directly from Vojtech Pavlik's ide/pci/via82cxxx
75 VIA_UDMA_NONE = 0x000,
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 */
90 * VIA SouthBridge chips.
93 static const struct via_isa_bridge {
99 } via_isa_bridges[] = {
100 { "vt8237s", PCI_DEVICE_ID_VIA_8237S, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
101 { "vt8251", PCI_DEVICE_ID_VIA_8251, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
102 { "cx700", PCI_DEVICE_ID_VIA_CX700, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
103 { "vt6410", PCI_DEVICE_ID_VIA_6410, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST | VIA_NO_ENABLES},
104 { "vt8237a", PCI_DEVICE_ID_VIA_8237A, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
105 { "vt8237", PCI_DEVICE_ID_VIA_8237, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
106 { "vt8235", PCI_DEVICE_ID_VIA_8235, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
107 { "vt8233a", PCI_DEVICE_ID_VIA_8233A, 0x00, 0x2f, VIA_UDMA_133 | VIA_BAD_AST },
108 { "vt8233c", PCI_DEVICE_ID_VIA_8233C_0, 0x00, 0x2f, VIA_UDMA_100 },
109 { "vt8233", PCI_DEVICE_ID_VIA_8233_0, 0x00, 0x2f, VIA_UDMA_100 },
110 { "vt8231", PCI_DEVICE_ID_VIA_8231, 0x00, 0x2f, VIA_UDMA_100 },
111 { "vt82c686b", PCI_DEVICE_ID_VIA_82C686, 0x40, 0x4f, VIA_UDMA_100 },
112 { "vt82c686a", PCI_DEVICE_ID_VIA_82C686, 0x10, 0x2f, VIA_UDMA_66 },
113 { "vt82c686", PCI_DEVICE_ID_VIA_82C686, 0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
114 { "vt82c596b", PCI_DEVICE_ID_VIA_82C596, 0x10, 0x2f, VIA_UDMA_66 },
115 { "vt82c596a", PCI_DEVICE_ID_VIA_82C596, 0x00, 0x0f, VIA_UDMA_33 | VIA_BAD_CLK66 },
116 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x47, 0x4f, VIA_UDMA_33 | VIA_SET_FIFO },
117 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x40, 0x46, VIA_UDMA_33 | VIA_SET_FIFO | VIA_BAD_PREQ },
118 { "vt82c586b", PCI_DEVICE_ID_VIA_82C586_0, 0x30, 0x3f, VIA_UDMA_33 | VIA_SET_FIFO },
119 { "vt82c586a", PCI_DEVICE_ID_VIA_82C586_0, 0x20, 0x2f, VIA_UDMA_33 | VIA_SET_FIFO },
120 { "vt82c586", PCI_DEVICE_ID_VIA_82C586_0, 0x00, 0x0f, VIA_UDMA_NONE | VIA_SET_FIFO },
121 { "vt82c576", PCI_DEVICE_ID_VIA_82C576, 0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK },
122 { "vt82c576", PCI_DEVICE_ID_VIA_82C576, 0x00, 0x2f, VIA_UDMA_NONE | VIA_SET_FIFO | VIA_NO_UNMASK | VIA_BAD_ID },
128 * Cable special cases
131 static struct dmi_system_id cable_dmi_table[] = {
133 .ident = "Acer Ferrari 3400",
135 DMI_MATCH(DMI_BOARD_VENDOR, "Acer,Inc."),
136 DMI_MATCH(DMI_BOARD_NAME, "Ferrari 3400"),
142 static int via_cable_override(struct pci_dev *pdev)
145 if (dmi_check_system(cable_dmi_table))
152 * via_cable_detect - cable detection
155 * Perform cable detection. Actually for the VIA case the BIOS
156 * already did this for us. We read the values provided by the
157 * BIOS. If you are using an 8235 in a non-PC configuration you
158 * may need to update this code.
160 * Hotplug also impacts on this.
163 static int via_cable_detect(struct ata_port *ap) {
164 const struct via_isa_bridge *config = ap->host->private_data;
165 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
168 if (via_cable_override(pdev))
169 return ATA_CBL_PATA40_SHORT;
171 /* Early chips are 40 wire */
172 if ((config->flags & VIA_UDMA) < VIA_UDMA_66)
173 return ATA_CBL_PATA40;
174 /* UDMA 66 chips have only drive side logic */
175 else if((config->flags & VIA_UDMA) < VIA_UDMA_100)
176 return ATA_CBL_PATA_UNK;
177 /* UDMA 100 or later */
178 pci_read_config_dword(pdev, 0x50, &ata66);
179 /* Check both the drive cable reporting bits, we might not have
181 if (ata66 & (0x10100000 >> (16 * ap->port_no)))
182 return ATA_CBL_PATA80;
183 return ATA_CBL_PATA40;
186 static int via_pre_reset(struct ata_port *ap, unsigned long deadline)
188 const struct via_isa_bridge *config = ap->host->private_data;
190 if (!(config->flags & VIA_NO_ENABLES)) {
191 static const struct pci_bits via_enable_bits[] = {
192 { 0x40, 1, 0x02, 0x02 },
193 { 0x40, 1, 0x01, 0x01 }
195 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
196 if (!pci_test_config_bits(pdev, &via_enable_bits[ap->port_no]))
200 return ata_std_prereset(ap, deadline);
205 * via_error_handler - reset for VIA chips
208 * Handle the reset callback for the later chips with cable detect
211 static void via_error_handler(struct ata_port *ap)
213 ata_bmdma_drive_eh(ap, via_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
217 * via_do_set_mode - set initial PIO mode data
220 * @mode: ATA mode being programmed
221 * @tdiv: Clocks per PCI clock
222 * @set_ast: Set to program address setup
223 * @udma_type: UDMA mode/format of registers
225 * Program the VIA registers for DMA and PIO modes. Uses the ata timing
226 * support in order to compute modes.
228 * FIXME: Hotplug will require we serialize multiple mode changes
229 * on the two channels.
232 static void via_do_set_mode(struct ata_port *ap, struct ata_device *adev, int mode, int tdiv, int set_ast, int udma_type)
234 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
235 struct ata_device *peer = ata_dev_pair(adev);
236 struct ata_timing t, p;
237 static int via_clock = 33333; /* Bus clock in kHZ - ought to be tunable one day */
238 unsigned long T = 1000000000 / via_clock;
239 unsigned long UT = T/tdiv;
241 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 */
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 */
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 */
278 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 5) - 2)) : 0x03;
281 ut = t.udma ? (0xe8 | (FIT(t.udma, 2, 9) - 2)) : 0x0f;
284 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 9) - 2)) : 0x07;
287 ut = t.udma ? (0xe0 | (FIT(t.udma, 2, 9) - 2)) : 0x07;
290 /* Set UDMA unless device is not UDMA capable */
292 pci_write_config_byte(pdev, 0x50 + offset, ut);
295 static void via_set_piomode(struct ata_port *ap, struct ata_device *adev)
297 const struct via_isa_bridge *config = ap->host->private_data;
298 int set_ast = (config->flags & VIA_BAD_AST) ? 0 : 1;
299 int mode = config->flags & VIA_UDMA;
300 static u8 tclock[5] = { 1, 1, 2, 3, 4 };
301 static u8 udma[5] = { 0, 33, 66, 100, 133 };
303 via_do_set_mode(ap, adev, adev->pio_mode, tclock[mode], set_ast, udma[mode]);
306 static void via_set_dmamode(struct ata_port *ap, struct ata_device *adev)
308 const struct via_isa_bridge *config = ap->host->private_data;
309 int set_ast = (config->flags & VIA_BAD_AST) ? 0 : 1;
310 int mode = config->flags & VIA_UDMA;
311 static u8 tclock[5] = { 1, 1, 2, 3, 4 };
312 static u8 udma[5] = { 0, 33, 66, 100, 133 };
314 via_do_set_mode(ap, adev, adev->dma_mode, tclock[mode], set_ast, udma[mode]);
317 static struct scsi_host_template via_sht = {
318 .module = THIS_MODULE,
320 .ioctl = ata_scsi_ioctl,
321 .queuecommand = ata_scsi_queuecmd,
322 .can_queue = ATA_DEF_QUEUE,
323 .this_id = ATA_SHT_THIS_ID,
324 .sg_tablesize = LIBATA_MAX_PRD,
325 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
326 .emulated = ATA_SHT_EMULATED,
327 .use_clustering = ATA_SHT_USE_CLUSTERING,
328 .proc_name = DRV_NAME,
329 .dma_boundary = ATA_DMA_BOUNDARY,
330 .slave_configure = ata_scsi_slave_config,
331 .slave_destroy = ata_scsi_slave_destroy,
332 .bios_param = ata_std_bios_param,
335 static struct ata_port_operations via_port_ops = {
336 .port_disable = ata_port_disable,
337 .set_piomode = via_set_piomode,
338 .set_dmamode = via_set_dmamode,
339 .mode_filter = ata_pci_default_filter,
341 .tf_load = ata_tf_load,
342 .tf_read = ata_tf_read,
343 .check_status = ata_check_status,
344 .exec_command = ata_exec_command,
345 .dev_select = ata_std_dev_select,
347 .freeze = ata_bmdma_freeze,
348 .thaw = ata_bmdma_thaw,
349 .error_handler = via_error_handler,
350 .post_internal_cmd = ata_bmdma_post_internal_cmd,
351 .cable_detect = via_cable_detect,
353 .bmdma_setup = ata_bmdma_setup,
354 .bmdma_start = ata_bmdma_start,
355 .bmdma_stop = ata_bmdma_stop,
356 .bmdma_status = ata_bmdma_status,
358 .qc_prep = ata_qc_prep,
359 .qc_issue = ata_qc_issue_prot,
361 .data_xfer = ata_data_xfer,
363 .irq_handler = ata_interrupt,
364 .irq_clear = ata_bmdma_irq_clear,
365 .irq_on = ata_irq_on,
366 .irq_ack = ata_irq_ack,
368 .port_start = ata_port_start,
371 static struct ata_port_operations via_port_ops_noirq = {
372 .port_disable = ata_port_disable,
373 .set_piomode = via_set_piomode,
374 .set_dmamode = via_set_dmamode,
375 .mode_filter = ata_pci_default_filter,
377 .tf_load = ata_tf_load,
378 .tf_read = ata_tf_read,
379 .check_status = ata_check_status,
380 .exec_command = ata_exec_command,
381 .dev_select = ata_std_dev_select,
383 .freeze = ata_bmdma_freeze,
384 .thaw = ata_bmdma_thaw,
385 .error_handler = via_error_handler,
386 .post_internal_cmd = ata_bmdma_post_internal_cmd,
387 .cable_detect = via_cable_detect,
389 .bmdma_setup = ata_bmdma_setup,
390 .bmdma_start = ata_bmdma_start,
391 .bmdma_stop = ata_bmdma_stop,
392 .bmdma_status = ata_bmdma_status,
394 .qc_prep = ata_qc_prep,
395 .qc_issue = ata_qc_issue_prot,
397 .data_xfer = ata_data_xfer_noirq,
399 .irq_handler = ata_interrupt,
400 .irq_clear = ata_bmdma_irq_clear,
401 .irq_on = ata_irq_on,
402 .irq_ack = ata_irq_ack,
404 .port_start = ata_port_start,
408 * via_config_fifo - set up the FIFO
410 * @flags: configuration flags
412 * Set the FIFO properties for this device if neccessary. Used both on
413 * set up and on and the resume path
416 static void via_config_fifo(struct pci_dev *pdev, unsigned int flags)
420 /* 0x40 low bits indicate enabled channels */
421 pci_read_config_byte(pdev, 0x40 , &enable);
424 if (flags & VIA_SET_FIFO) {
425 static const u8 fifo_setting[4] = {0x00, 0x60, 0x00, 0x20};
428 pci_read_config_byte(pdev, 0x43, &fifo);
430 /* Clear PREQ# until DDACK# for errata */
431 if (flags & VIA_BAD_PREQ)
435 /* Turn on FIFO for enabled channels */
436 fifo |= fifo_setting[enable];
437 pci_write_config_byte(pdev, 0x43, fifo);
442 * via_init_one - discovery callback
444 * @id: PCI table info
446 * A VIA IDE interface has been discovered. Figure out what revision
447 * and perform configuration work before handing it to the ATA layer
450 static int via_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
452 /* Early VIA without UDMA support */
453 static const struct ata_port_info via_mwdma_info = {
455 .flags = ATA_FLAG_SLAVE_POSS,
458 .port_ops = &via_port_ops
460 /* Ditto with IRQ masking required */
461 static const struct ata_port_info via_mwdma_info_borked = {
463 .flags = ATA_FLAG_SLAVE_POSS,
466 .port_ops = &via_port_ops_noirq,
468 /* VIA UDMA 33 devices (and borked 66) */
469 static const struct ata_port_info via_udma33_info = {
471 .flags = ATA_FLAG_SLAVE_POSS,
475 .port_ops = &via_port_ops
477 /* VIA UDMA 66 devices */
478 static const struct ata_port_info via_udma66_info = {
480 .flags = ATA_FLAG_SLAVE_POSS,
484 .port_ops = &via_port_ops
486 /* VIA UDMA 100 devices */
487 static const struct ata_port_info via_udma100_info = {
489 .flags = ATA_FLAG_SLAVE_POSS,
493 .port_ops = &via_port_ops
495 /* UDMA133 with bad AST (All current 133) */
496 static const struct ata_port_info via_udma133_info = {
498 .flags = ATA_FLAG_SLAVE_POSS,
501 .udma_mask = 0x7f, /* FIXME: should check north bridge */
502 .port_ops = &via_port_ops
504 struct ata_port_info type;
505 const struct ata_port_info *ppi[] = { &type, NULL };
506 struct pci_dev *isa = NULL;
507 const struct via_isa_bridge *config;
508 static int printed_version;
513 if (!printed_version++)
514 dev_printk(KERN_DEBUG, &pdev->dev, "version " DRV_VERSION "\n");
516 /* To find out how the IDE will behave and what features we
517 actually have to look at the bridge not the IDE controller */
518 for (config = via_isa_bridges; config->id; config++)
519 if ((isa = pci_get_device(PCI_VENDOR_ID_VIA +
520 !!(config->flags & VIA_BAD_ID),
521 config->id, NULL))) {
523 pci_read_config_byte(isa, PCI_REVISION_ID, &t);
524 if (t >= config->rev_min &&
525 t <= config->rev_max)
531 printk(KERN_WARNING "via: Unknown VIA SouthBridge, disabling.\n");
536 /* 0x40 low bits indicate enabled channels */
537 pci_read_config_byte(pdev, 0x40 , &enable);
543 /* Initialise the FIFO for the enabled channels. */
544 via_config_fifo(pdev, config->flags);
547 switch(config->flags & VIA_UDMA) {
549 if (config->flags & VIA_NO_UNMASK)
550 type = via_mwdma_info_borked;
552 type = via_mwdma_info;
555 type = via_udma33_info;
558 type = via_udma66_info;
559 /* The 66 MHz devices require we enable the clock */
560 pci_read_config_dword(pdev, 0x50, &timing);
562 pci_write_config_dword(pdev, 0x50, timing);
565 type = via_udma100_info;
568 type = via_udma133_info;
575 if (config->flags & VIA_BAD_CLK66) {
576 /* Disable the 66MHz clock on problem devices */
577 pci_read_config_dword(pdev, 0x50, &timing);
579 pci_write_config_dword(pdev, 0x50, timing);
582 /* We have established the device type, now fire it up */
583 type.private_data = (void *)config;
585 return ata_pci_init_one(pdev, ppi);
590 * via_reinit_one - reinit after resume
593 * Called when the VIA PATA device is resumed. We must then
594 * reconfigure the fifo and other setup we may have altered. In
595 * addition the kernel needs to have the resume methods on PCI
599 static int via_reinit_one(struct pci_dev *pdev)
602 struct ata_host *host = dev_get_drvdata(&pdev->dev);
603 const struct via_isa_bridge *config = host->private_data;
605 via_config_fifo(pdev, config->flags);
607 if ((config->flags & VIA_UDMA) == VIA_UDMA_66) {
608 /* The 66 MHz devices require we enable the clock */
609 pci_read_config_dword(pdev, 0x50, &timing);
611 pci_write_config_dword(pdev, 0x50, timing);
613 if (config->flags & VIA_BAD_CLK66) {
614 /* Disable the 66MHz clock on problem devices */
615 pci_read_config_dword(pdev, 0x50, &timing);
617 pci_write_config_dword(pdev, 0x50, timing);
619 return ata_pci_device_resume(pdev);
623 static const struct pci_device_id via[] = {
624 { PCI_VDEVICE(VIA, 0x0571), },
625 { PCI_VDEVICE(VIA, 0x0581), },
626 { PCI_VDEVICE(VIA, 0x1571), },
627 { PCI_VDEVICE(VIA, 0x3164), },
628 { PCI_VDEVICE(VIA, 0x5324), },
633 static struct pci_driver via_pci_driver = {
636 .probe = via_init_one,
637 .remove = ata_pci_remove_one,
639 .suspend = ata_pci_device_suspend,
640 .resume = via_reinit_one,
644 static int __init via_init(void)
646 return pci_register_driver(&via_pci_driver);
649 static void __exit via_exit(void)
651 pci_unregister_driver(&via_pci_driver);
654 MODULE_AUTHOR("Alan Cox");
655 MODULE_DESCRIPTION("low-level driver for VIA PATA");
656 MODULE_LICENSE("GPL");
657 MODULE_DEVICE_TABLE(pci, via);
658 MODULE_VERSION(DRV_VERSION);
660 module_init(via_init);
661 module_exit(via_exit);