2 * pata_ali.c - ALI 15x3 PATA for new ATA layer
4 * Alan Cox <alan@redhat.com>
7 * linux/drivers/ide/pci/alim15x3.c Version 0.17 2003/01/02
9 * Copyright (C) 1998-2000 Michel Aubry, Maintainer
10 * Copyright (C) 1998-2000 Andrzej Krzysztofowicz, Maintainer
11 * Copyright (C) 1999-2000 CJ, cjtsai@ali.com.tw, Maintainer
13 * Copyright (C) 1998-2000 Andre Hedrick (andre@linux-ide.org)
14 * May be copied or modified under the terms of the GNU General Public License
15 * Copyright (C) 2002 Alan Cox <alan@redhat.com>
16 * ALi (now ULi M5228) support by Clear Zhang <Clear.Zhang@ali.com.tw>
19 * Chipset documentation available under NDA only
22 * Cannot have ATAPI on both master & slave for rev < c2 (???) but
23 * otherwise should do atapi DMA.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/pci.h>
29 #include <linux/init.h>
30 #include <linux/blkdev.h>
31 #include <linux/delay.h>
32 #include <scsi/scsi_host.h>
33 #include <linux/libata.h>
34 #include <linux/dmi.h>
36 #define DRV_NAME "pata_ali"
37 #define DRV_VERSION "0.7.5"
39 static int ali_atapi_dma = 0;
40 module_param_named(atapi_dma, ali_atapi_dma, int, 0644);
41 MODULE_PARM_DESC(atapi_dma, "Enable ATAPI DMA (0=disable, 1=enable)");
47 static const struct dmi_system_id cable_dmi_table[] = {
49 .ident = "HP Pavilion N5430",
51 DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
52 DMI_MATCH(DMI_BOARD_VERSION, "OmniBook N32N-736"),
56 .ident = "Toshiba Satelite S1800-814",
58 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
59 DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
65 static int ali_cable_override(struct pci_dev *pdev)
68 if (pdev->subsystem_vendor == 0x10CF && pdev->subsystem_device == 0x10AF)
70 /* Mitac 8317 (Winbook-A) and relatives */
71 if (pdev->subsystem_vendor == 0x1071 && pdev->subsystem_device == 0x8317)
74 if (dmi_check_system(cable_dmi_table))
80 * ali_c2_cable_detect - cable detection
83 * Perform cable detection for C2 and later revisions
86 static int ali_c2_cable_detect(struct ata_port *ap)
88 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
91 /* Certain laptops use short but suitable cables and don't
92 implement the detect logic */
94 if (ali_cable_override(pdev))
95 return ATA_CBL_PATA40_SHORT;
97 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
99 pci_read_config_byte(pdev, 0x4A, &ata66);
100 if (ata66 & (1 << ap->port_no))
101 return ATA_CBL_PATA40;
103 return ATA_CBL_PATA80;
107 * ali_20_filter - filter for earlier ALI DMA
109 * @adev: attached device
111 * Ensure that we do not do DMA on CD devices. We may be able to
112 * fix that later on. Also ensure we do not do UDMA on WDC drives
115 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
117 char model_num[ATA_ID_PROD_LEN + 1];
118 /* No DMA on anything but a disk for now */
119 if (adev->class != ATA_DEV_ATA)
120 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
121 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
122 if (strstr(model_num, "WDC"))
123 return mask &= ~ATA_MASK_UDMA;
124 return ata_pci_default_filter(adev, mask);
128 * ali_fifo_control - FIFO manager
129 * @ap: ALi channel to control
130 * @adev: device for FIFO control
131 * @on: 0 for off 1 for on
133 * Enable or disable the FIFO on a given device. Because of the way the
134 * ALi FIFO works it provides a boost on ATA disk but can be confused by
135 * ATAPI and we must therefore manage it.
138 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
140 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
141 int pio_fifo = 0x54 + ap->port_no;
143 int shift = 4 * adev->devno;
145 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
146 0x00. Not all the docs agree but the behaviour we now use is the
147 one stated in the BIOS Programming Guide */
149 pci_read_config_byte(pdev, pio_fifo, &fifo);
150 fifo &= ~(0x0F << shift);
152 fifo |= (on << shift);
153 pci_write_config_byte(pdev, pio_fifo, fifo);
157 * ali_program_modes - load mode registers
158 * @ap: ALi channel to load
159 * @adev: Device the timing is for
160 * @cmd: Command timing
162 * @ultra: UDMA timing or zero for off
164 * Loads the timing registers for cmd/data and disable UDMA if
165 * ultra is zero. If ultra is set then load and enable the UDMA
166 * timing but do not touch the command/data timing.
169 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
171 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
172 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
173 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
174 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
175 int udmat = 0x56 + ap->port_no; /* UDMA timing */
176 int shift = 4 * adev->devno;
180 t->setup = FIT(t->setup, 1, 8) & 7;
181 t->act8b = FIT(t->act8b, 1, 8) & 7;
182 t->rec8b = FIT(t->rec8b, 1, 16) & 15;
183 t->active = FIT(t->active, 1, 8) & 7;
184 t->recover = FIT(t->recover, 1, 16) & 15;
186 pci_write_config_byte(pdev, cas, t->setup);
187 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
188 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
191 /* Set up the UDMA enable */
192 pci_read_config_byte(pdev, udmat, &udma);
193 udma &= ~(0x0F << shift);
194 udma |= ultra << shift;
195 pci_write_config_byte(pdev, udmat, udma);
199 * ali_set_piomode - set initial PIO mode data
203 * Program the ALi registers for PIO mode. FIXME: add timings for
207 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
209 struct ata_device *pair = ata_dev_pair(adev);
211 unsigned long T = 1000000000 / 33333; /* PCI clock based */
213 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
216 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
217 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
218 if (pair->dma_mode) {
219 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
220 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
224 /* PIO FIFO is only permitted on ATA disk */
225 if (adev->class != ATA_DEV_ATA)
226 ali_fifo_control(ap, adev, 0x00);
227 ali_program_modes(ap, adev, &t, 0);
228 if (adev->class == ATA_DEV_ATA)
229 ali_fifo_control(ap, adev, 0x05);
234 * ali_set_dmamode - set initial DMA mode data
238 * FIXME: MWDMA timings
241 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
243 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
244 struct ata_device *pair = ata_dev_pair(adev);
246 unsigned long T = 1000000000 / 33333; /* PCI clock based */
247 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
250 if (adev->class == ATA_DEV_ATA)
251 ali_fifo_control(ap, adev, 0x08);
253 if (adev->dma_mode >= XFER_UDMA_0) {
254 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
255 if (adev->dma_mode >= XFER_UDMA_3) {
257 pci_read_config_byte(pdev, 0x4B, ®4b);
259 pci_write_config_byte(pdev, 0x4B, reg4b);
262 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
265 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
266 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
267 if (pair->dma_mode) {
268 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
269 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
272 ali_program_modes(ap, adev, &t, 0);
277 * ali_warn_atapi_dma - Warn about ATAPI DMA disablement
280 * Whine about ATAPI DMA disablement if @adev is an ATAPI device.
281 * Can be used as ->dev_config.
284 static void ali_warn_atapi_dma(struct ata_device *adev)
286 struct ata_eh_context *ehc = &adev->link->eh_context;
287 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
289 if (print_info && adev->class == ATA_DEV_ATAPI && !ali_atapi_dma) {
290 ata_dev_printk(adev, KERN_WARNING,
291 "WARNING: ATAPI DMA disabled for reliablity issues. It can be enabled\n");
292 ata_dev_printk(adev, KERN_WARNING,
293 "WARNING: via pata_ali.atapi_dma modparam or corresponding sysfs node.\n");
298 * ali_lock_sectors - Keep older devices to 255 sector mode
301 * Called during the bus probe for each device that is found. We use
302 * this call to lock the sector count of the device to 255 or less on
303 * older ALi controllers. If we didn't do this then large I/O's would
304 * require LBA48 commands which the older ALi requires are issued by
308 static void ali_lock_sectors(struct ata_device *adev)
310 adev->max_sectors = 255;
311 ali_warn_atapi_dma(adev);
315 * ali_check_atapi_dma - DMA check for most ALi controllers
318 * Called to decide whether commands should be sent by DMA or PIO
321 static int ali_check_atapi_dma(struct ata_queued_cmd *qc)
323 if (!ali_atapi_dma) {
324 /* FIXME: pata_ali can't do ATAPI DMA reliably but the
325 * IDE alim15x3 driver can. I tried lots of things
326 * but couldn't find what the actual difference was.
327 * If you got an idea, please write it to
328 * linux-ide@vger.kernel.org and cc htejun@gmail.com.
330 * Disable ATAPI DMA for now.
335 /* If its not a media command, its not worth it */
336 if (atapi_cmd_type(qc->cdb[0]) == ATAPI_MISC)
341 static struct scsi_host_template ali_sht = {
342 ATA_BMDMA_SHT(DRV_NAME),
346 * Port operations for PIO only ALi
349 static struct ata_port_operations ali_early_port_ops = {
350 .set_piomode = ali_set_piomode,
351 .tf_load = ata_tf_load,
352 .tf_read = ata_tf_read,
353 .check_status = ata_check_status,
354 .exec_command = ata_exec_command,
355 .dev_select = ata_std_dev_select,
357 .freeze = ata_bmdma_freeze,
358 .thaw = ata_bmdma_thaw,
359 .error_handler = ata_bmdma_error_handler,
360 .post_internal_cmd = ata_bmdma_post_internal_cmd,
361 .cable_detect = ata_cable_40wire,
363 .qc_prep = ata_qc_prep,
364 .qc_issue = ata_qc_issue_prot,
366 .data_xfer = ata_data_xfer,
368 .irq_handler = ata_interrupt,
369 .irq_clear = ata_noop_irq_clear,
370 .irq_on = ata_irq_on,
372 .port_start = ata_sff_port_start,
376 * Port operations for DMA capable ALi without cable
379 static struct ata_port_operations ali_20_port_ops = {
380 .set_piomode = ali_set_piomode,
381 .set_dmamode = ali_set_dmamode,
382 .mode_filter = ali_20_filter,
384 .tf_load = ata_tf_load,
385 .tf_read = ata_tf_read,
386 .check_atapi_dma = ali_check_atapi_dma,
387 .check_status = ata_check_status,
388 .exec_command = ata_exec_command,
389 .dev_select = ata_std_dev_select,
390 .dev_config = ali_lock_sectors,
392 .freeze = ata_bmdma_freeze,
393 .thaw = ata_bmdma_thaw,
394 .error_handler = ata_bmdma_error_handler,
395 .post_internal_cmd = ata_bmdma_post_internal_cmd,
396 .cable_detect = ata_cable_40wire,
398 .bmdma_setup = ata_bmdma_setup,
399 .bmdma_start = ata_bmdma_start,
400 .bmdma_stop = ata_bmdma_stop,
401 .bmdma_status = ata_bmdma_status,
403 .qc_prep = ata_qc_prep,
404 .qc_issue = ata_qc_issue_prot,
406 .data_xfer = ata_data_xfer,
408 .irq_handler = ata_interrupt,
409 .irq_clear = ata_bmdma_irq_clear,
410 .irq_on = ata_irq_on,
412 .port_start = ata_sff_port_start,
416 * Port operations for DMA capable ALi with cable detect
418 static struct ata_port_operations ali_c2_port_ops = {
419 .set_piomode = ali_set_piomode,
420 .set_dmamode = ali_set_dmamode,
421 .mode_filter = ata_pci_default_filter,
422 .tf_load = ata_tf_load,
423 .tf_read = ata_tf_read,
424 .check_atapi_dma = ali_check_atapi_dma,
425 .check_status = ata_check_status,
426 .exec_command = ata_exec_command,
427 .dev_select = ata_std_dev_select,
428 .dev_config = ali_lock_sectors,
430 .freeze = ata_bmdma_freeze,
431 .thaw = ata_bmdma_thaw,
432 .error_handler = ata_bmdma_error_handler,
433 .post_internal_cmd = ata_bmdma_post_internal_cmd,
434 .cable_detect = ali_c2_cable_detect,
436 .bmdma_setup = ata_bmdma_setup,
437 .bmdma_start = ata_bmdma_start,
438 .bmdma_stop = ata_bmdma_stop,
439 .bmdma_status = ata_bmdma_status,
441 .qc_prep = ata_qc_prep,
442 .qc_issue = ata_qc_issue_prot,
444 .data_xfer = ata_data_xfer,
446 .irq_handler = ata_interrupt,
447 .irq_clear = ata_bmdma_irq_clear,
448 .irq_on = ata_irq_on,
450 .port_start = ata_sff_port_start,
454 * Port operations for DMA capable ALi with cable detect and LBA48
456 static struct ata_port_operations ali_c5_port_ops = {
457 .set_piomode = ali_set_piomode,
458 .set_dmamode = ali_set_dmamode,
459 .mode_filter = ata_pci_default_filter,
460 .tf_load = ata_tf_load,
461 .tf_read = ata_tf_read,
462 .check_atapi_dma = ali_check_atapi_dma,
463 .check_status = ata_check_status,
464 .exec_command = ata_exec_command,
465 .dev_select = ata_std_dev_select,
466 .dev_config = ali_warn_atapi_dma,
468 .freeze = ata_bmdma_freeze,
469 .thaw = ata_bmdma_thaw,
470 .error_handler = ata_bmdma_error_handler,
471 .post_internal_cmd = ata_bmdma_post_internal_cmd,
472 .cable_detect = ali_c2_cable_detect,
474 .bmdma_setup = ata_bmdma_setup,
475 .bmdma_start = ata_bmdma_start,
476 .bmdma_stop = ata_bmdma_stop,
477 .bmdma_status = ata_bmdma_status,
479 .qc_prep = ata_qc_prep,
480 .qc_issue = ata_qc_issue_prot,
482 .data_xfer = ata_data_xfer,
484 .irq_handler = ata_interrupt,
485 .irq_clear = ata_bmdma_irq_clear,
486 .irq_on = ata_irq_on,
488 .port_start = ata_sff_port_start,
493 * ali_init_chipset - chip setup function
494 * @pdev: PCI device of ATA controller
496 * Perform the setup on the device that must be done both at boot
497 * and at resume time.
500 static void ali_init_chipset(struct pci_dev *pdev)
503 struct pci_dev *north, *isa_bridge;
506 * The chipset revision selects the driver operations and
510 if (pdev->revision >= 0x20 && pdev->revision < 0xC2) {
511 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
512 pci_read_config_byte(pdev, 0x4B, &tmp);
513 /* Clear CD-ROM DMA write bit */
515 pci_write_config_byte(pdev, 0x4B, tmp);
516 } else if (pdev->revision >= 0xC2) {
517 /* Enable cable detection logic */
518 pci_read_config_byte(pdev, 0x4B, &tmp);
519 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
521 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
522 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
524 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
525 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
526 Set the south bridge enable bit */
527 pci_read_config_byte(isa_bridge, 0x79, &tmp);
528 if (pdev->revision == 0xC2)
529 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
530 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
531 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
533 if (pdev->revision >= 0x20) {
535 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
536 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
539 pci_read_config_byte(pdev, 0x53, &tmp);
540 if (pdev->revision <= 0x20)
542 if (pdev->revision >= 0xc7)
545 tmp |= 0x01; /* CD_ROM enable for DMA */
546 pci_write_config_byte(pdev, 0x53, tmp);
548 pci_dev_put(isa_bridge);
550 ata_pci_clear_simplex(pdev);
553 * ali_init_one - discovery callback
554 * @pdev: PCI device ID
555 * @id: PCI table info
557 * An ALi IDE interface has been discovered. Figure out what revision
558 * and perform configuration work before handing it to the ATA layer
561 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
563 static const struct ata_port_info info_early = {
565 .flags = ATA_FLAG_SLAVE_POSS,
567 .port_ops = &ali_early_port_ops
569 /* Revision 0x20 added DMA */
570 static const struct ata_port_info info_20 = {
572 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
575 .port_ops = &ali_20_port_ops
577 /* Revision 0x20 with support logic added UDMA */
578 static const struct ata_port_info info_20_udma = {
580 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
583 .udma_mask = 0x07, /* UDMA33 */
584 .port_ops = &ali_20_port_ops
586 /* Revision 0xC2 adds UDMA66 */
587 static const struct ata_port_info info_c2 = {
589 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
592 .udma_mask = ATA_UDMA4,
593 .port_ops = &ali_c2_port_ops
595 /* Revision 0xC3 is UDMA66 for now */
596 static const struct ata_port_info info_c3 = {
598 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
601 .udma_mask = ATA_UDMA4,
602 .port_ops = &ali_c2_port_ops
604 /* Revision 0xC4 is UDMA100 */
605 static const struct ata_port_info info_c4 = {
607 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
610 .udma_mask = ATA_UDMA5,
611 .port_ops = &ali_c2_port_ops
613 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
614 static const struct ata_port_info info_c5 = {
616 .flags = ATA_FLAG_SLAVE_POSS,
619 .udma_mask = ATA_UDMA6,
620 .port_ops = &ali_c5_port_ops
623 const struct ata_port_info *ppi[] = { NULL, NULL };
625 struct pci_dev *isa_bridge;
628 rc = pcim_enable_device(pdev);
633 * The chipset revision selects the driver operations and
637 if (pdev->revision < 0x20) {
638 ppi[0] = &info_early;
639 } else if (pdev->revision < 0xC2) {
641 } else if (pdev->revision == 0xC2) {
643 } else if (pdev->revision == 0xC3) {
645 } else if (pdev->revision == 0xC4) {
650 ali_init_chipset(pdev);
652 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
653 if (isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
654 /* Are we paired with a UDMA capable chip */
655 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
656 if ((tmp & 0x1E) == 0x12)
657 ppi[0] = &info_20_udma;
658 pci_dev_put(isa_bridge);
660 return ata_pci_init_one(pdev, ppi);
664 static int ali_reinit_one(struct pci_dev *pdev)
666 struct ata_host *host = dev_get_drvdata(&pdev->dev);
669 rc = ata_pci_device_do_resume(pdev);
672 ali_init_chipset(pdev);
673 ata_host_resume(host);
678 static const struct pci_device_id ali[] = {
679 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
680 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
685 static struct pci_driver ali_pci_driver = {
688 .probe = ali_init_one,
689 .remove = ata_pci_remove_one,
691 .suspend = ata_pci_device_suspend,
692 .resume = ali_reinit_one,
696 static int __init ali_init(void)
698 return pci_register_driver(&ali_pci_driver);
702 static void __exit ali_exit(void)
704 pci_unregister_driver(&ali_pci_driver);
708 MODULE_AUTHOR("Alan Cox");
709 MODULE_DESCRIPTION("low-level driver for ALi PATA");
710 MODULE_LICENSE("GPL");
711 MODULE_DEVICE_TABLE(pci, ali);
712 MODULE_VERSION(DRV_VERSION);
714 module_init(ali_init);
715 module_exit(ali_exit);