2 * pata_ali.c - ALI 15x3 PATA for new ATA layer
6 * linux/drivers/ide/pci/alim15x3.c Version 0.17 2003/01/02
8 * Copyright (C) 1998-2000 Michel Aubry, Maintainer
9 * Copyright (C) 1998-2000 Andrzej Krzysztofowicz, Maintainer
10 * Copyright (C) 1999-2000 CJ, cjtsai@ali.com.tw, Maintainer
12 * Copyright (C) 1998-2000 Andre Hedrick (andre@linux-ide.org)
13 * May be copied or modified under the terms of the GNU General Public License
14 * Copyright (C) 2002 Alan Cox <alan@redhat.com>
15 * ALi (now ULi M5228) support by Clear Zhang <Clear.Zhang@ali.com.tw>
18 * Chipset documentation available under NDA only
21 * Cannot have ATAPI on both master & slave for rev < c2 (???) but
22 * otherwise should do atapi DMA (For now for old we do PIO only for
24 * Review Sunblade workaround.
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/pci.h>
30 #include <linux/init.h>
31 #include <linux/blkdev.h>
32 #include <linux/delay.h>
33 #include <scsi/scsi_host.h>
34 #include <linux/libata.h>
35 #include <linux/dmi.h>
37 #define DRV_NAME "pata_ali"
38 #define DRV_VERSION "0.7.8"
40 static int ali_atapi_dma = 0;
41 module_param_named(atapi_dma, ali_atapi_dma, int, 0644);
42 MODULE_PARM_DESC(atapi_dma, "Enable ATAPI DMA (0=disable, 1=enable)");
44 static struct pci_dev *ali_isa_bridge;
50 static const struct dmi_system_id cable_dmi_table[] = {
52 .ident = "HP Pavilion N5430",
54 DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
55 DMI_MATCH(DMI_BOARD_VERSION, "OmniBook N32N-736"),
59 .ident = "Toshiba Satelite S1800-814",
61 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
62 DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
68 static int ali_cable_override(struct pci_dev *pdev)
71 if (pdev->subsystem_vendor == 0x10CF && pdev->subsystem_device == 0x10AF)
73 /* Mitac 8317 (Winbook-A) and relatives */
74 if (pdev->subsystem_vendor == 0x1071 && pdev->subsystem_device == 0x8317)
77 if (dmi_check_system(cable_dmi_table))
83 * ali_c2_cable_detect - cable detection
86 * Perform cable detection for C2 and later revisions
89 static int ali_c2_cable_detect(struct ata_port *ap)
91 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
94 /* Certain laptops use short but suitable cables and don't
95 implement the detect logic */
97 if (ali_cable_override(pdev))
98 return ATA_CBL_PATA40_SHORT;
100 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
101 Bit set for 40 pin */
102 pci_read_config_byte(pdev, 0x4A, &ata66);
103 if (ata66 & (1 << ap->port_no))
104 return ATA_CBL_PATA40;
106 return ATA_CBL_PATA80;
110 * ali_20_filter - filter for earlier ALI DMA
112 * @adev: attached device
114 * Ensure that we do not do DMA on CD devices. We may be able to
115 * fix that later on. Also ensure we do not do UDMA on WDC drives
118 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
120 char model_num[ATA_ID_PROD_LEN + 1];
121 /* No DMA on anything but a disk for now */
122 if (adev->class != ATA_DEV_ATA)
123 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
124 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
125 if (strstr(model_num, "WDC"))
126 return mask &= ~ATA_MASK_UDMA;
127 return ata_bmdma_mode_filter(adev, mask);
131 * ali_fifo_control - FIFO manager
132 * @ap: ALi channel to control
133 * @adev: device for FIFO control
134 * @on: 0 for off 1 for on
136 * Enable or disable the FIFO on a given device. Because of the way the
137 * ALi FIFO works it provides a boost on ATA disk but can be confused by
138 * ATAPI and we must therefore manage it.
141 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
143 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
144 int pio_fifo = 0x54 + ap->port_no;
146 int shift = 4 * adev->devno;
148 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
149 0x00. Not all the docs agree but the behaviour we now use is the
150 one stated in the BIOS Programming Guide */
152 pci_read_config_byte(pdev, pio_fifo, &fifo);
153 fifo &= ~(0x0F << shift);
154 fifo |= (on << shift);
155 pci_write_config_byte(pdev, pio_fifo, fifo);
159 * ali_program_modes - load mode registers
160 * @ap: ALi channel to load
161 * @adev: Device the timing is for
162 * @cmd: Command timing
164 * @ultra: UDMA timing or zero for off
166 * Loads the timing registers for cmd/data and disable UDMA if
167 * ultra is zero. If ultra is set then load and enable the UDMA
168 * timing but do not touch the command/data timing.
171 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
173 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
174 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
175 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
176 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
177 int udmat = 0x56 + ap->port_no; /* UDMA timing */
178 int shift = 4 * adev->devno;
182 t->setup = clamp_val(t->setup, 1, 8) & 7;
183 t->act8b = clamp_val(t->act8b, 1, 8) & 7;
184 t->rec8b = clamp_val(t->rec8b, 1, 16) & 15;
185 t->active = clamp_val(t->active, 1, 8) & 7;
186 t->recover = clamp_val(t->recover, 1, 16) & 15;
188 pci_write_config_byte(pdev, cas, t->setup);
189 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
190 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
193 /* Set up the UDMA enable */
194 pci_read_config_byte(pdev, udmat, &udma);
195 udma &= ~(0x0F << shift);
196 udma |= ultra << shift;
197 pci_write_config_byte(pdev, udmat, udma);
201 * ali_set_piomode - set initial PIO mode data
205 * Program the ALi registers for PIO mode. FIXME: add timings for
209 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
211 struct ata_device *pair = ata_dev_pair(adev);
213 unsigned long T = 1000000000 / 33333; /* PCI clock based */
215 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
218 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
219 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
220 if (pair->dma_mode) {
221 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
222 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
226 /* PIO FIFO is only permitted on ATA disk */
227 if (adev->class != ATA_DEV_ATA)
228 ali_fifo_control(ap, adev, 0x00);
229 ali_program_modes(ap, adev, &t, 0);
230 if (adev->class == ATA_DEV_ATA)
231 ali_fifo_control(ap, adev, 0x05);
236 * ali_set_dmamode - set initial DMA mode data
240 * FIXME: MWDMA timings
243 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
245 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
246 struct ata_device *pair = ata_dev_pair(adev);
248 unsigned long T = 1000000000 / 33333; /* PCI clock based */
249 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
252 if (adev->class == ATA_DEV_ATA)
253 ali_fifo_control(ap, adev, 0x08);
255 if (adev->dma_mode >= XFER_UDMA_0) {
256 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
257 if (adev->dma_mode >= XFER_UDMA_3) {
259 pci_read_config_byte(pdev, 0x4B, ®4b);
261 pci_write_config_byte(pdev, 0x4B, reg4b);
264 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
267 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
268 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
269 if (pair->dma_mode) {
270 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
271 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
274 ali_program_modes(ap, adev, &t, 0);
279 * ali_warn_atapi_dma - Warn about ATAPI DMA disablement
282 * Whine about ATAPI DMA disablement if @adev is an ATAPI device.
283 * Can be used as ->dev_config.
286 static void ali_warn_atapi_dma(struct ata_device *adev)
288 struct ata_eh_context *ehc = &adev->link->eh_context;
289 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
291 if (print_info && adev->class == ATA_DEV_ATAPI && !ali_atapi_dma) {
292 ata_dev_printk(adev, KERN_WARNING,
293 "WARNING: ATAPI DMA disabled for reliablity issues. It can be enabled\n");
294 ata_dev_printk(adev, KERN_WARNING,
295 "WARNING: via pata_ali.atapi_dma modparam or corresponding sysfs node.\n");
300 * ali_lock_sectors - Keep older devices to 255 sector mode
303 * Called during the bus probe for each device that is found. We use
304 * this call to lock the sector count of the device to 255 or less on
305 * older ALi controllers. If we didn't do this then large I/O's would
306 * require LBA48 commands which the older ALi requires are issued by
310 static void ali_lock_sectors(struct ata_device *adev)
312 adev->max_sectors = 255;
313 ali_warn_atapi_dma(adev);
317 * ali_check_atapi_dma - DMA check for most ALi controllers
320 * Called to decide whether commands should be sent by DMA or PIO
323 static int ali_check_atapi_dma(struct ata_queued_cmd *qc)
325 if (!ali_atapi_dma) {
326 /* FIXME: pata_ali can't do ATAPI DMA reliably but the
327 * IDE alim15x3 driver can. I tried lots of things
328 * but couldn't find what the actual difference was.
329 * If you got an idea, please write it to
330 * linux-ide@vger.kernel.org and cc htejun@gmail.com.
332 * Disable ATAPI DMA for now.
337 /* If its not a media command, its not worth it */
338 if (atapi_cmd_type(qc->cdb[0]) == ATAPI_MISC)
343 static void ali_c2_c3_postreset(struct ata_link *link, unsigned int *classes)
346 int port_bit = 4 << link->ap->port_no;
348 /* If our bridge is an ALI 1533 then do the extra work */
349 if (ali_isa_bridge) {
350 /* Tristate and re-enable the bus signals */
351 pci_read_config_byte(ali_isa_bridge, 0x58, &r);
353 pci_write_config_byte(ali_isa_bridge, 0x58, r);
355 pci_write_config_byte(ali_isa_bridge, 0x58, r);
357 ata_sff_postreset(link, classes);
360 static struct scsi_host_template ali_sht = {
361 ATA_BMDMA_SHT(DRV_NAME),
365 * Port operations for PIO only ALi
368 static struct ata_port_operations ali_early_port_ops = {
369 .inherits = &ata_sff_port_ops,
370 .cable_detect = ata_cable_40wire,
371 .set_piomode = ali_set_piomode,
372 .sff_data_xfer = ata_sff_data_xfer32,
375 static const struct ata_port_operations ali_dma_base_ops = {
376 .inherits = &ata_bmdma32_port_ops,
377 .set_piomode = ali_set_piomode,
378 .set_dmamode = ali_set_dmamode,
382 * Port operations for DMA capable ALi without cable
385 static struct ata_port_operations ali_20_port_ops = {
386 .inherits = &ali_dma_base_ops,
387 .cable_detect = ata_cable_40wire,
388 .mode_filter = ali_20_filter,
389 .check_atapi_dma = ali_check_atapi_dma,
390 .dev_config = ali_lock_sectors,
394 * Port operations for DMA capable ALi with cable detect
396 static struct ata_port_operations ali_c2_port_ops = {
397 .inherits = &ali_dma_base_ops,
398 .check_atapi_dma = ali_check_atapi_dma,
399 .cable_detect = ali_c2_cable_detect,
400 .dev_config = ali_lock_sectors,
401 .postreset = ali_c2_c3_postreset,
405 * Port operations for DMA capable ALi with cable detect
407 static struct ata_port_operations ali_c4_port_ops = {
408 .inherits = &ali_dma_base_ops,
409 .check_atapi_dma = ali_check_atapi_dma,
410 .cable_detect = ali_c2_cable_detect,
411 .dev_config = ali_lock_sectors,
415 * Port operations for DMA capable ALi with cable detect and LBA48
417 static struct ata_port_operations ali_c5_port_ops = {
418 .inherits = &ali_dma_base_ops,
419 .check_atapi_dma = ali_check_atapi_dma,
420 .dev_config = ali_warn_atapi_dma,
421 .cable_detect = ali_c2_cable_detect,
426 * ali_init_chipset - chip setup function
427 * @pdev: PCI device of ATA controller
429 * Perform the setup on the device that must be done both at boot
430 * and at resume time.
433 static void ali_init_chipset(struct pci_dev *pdev)
436 struct pci_dev *north;
439 * The chipset revision selects the driver operations and
443 if (pdev->revision <= 0x20) {
444 pci_read_config_byte(pdev, 0x53, &tmp);
446 pci_write_config_byte(pdev, 0x53, tmp);
448 pci_read_config_byte(pdev, 0x4a, &tmp);
449 pci_write_config_byte(pdev, 0x4a, tmp | 0x20);
450 pci_read_config_byte(pdev, 0x4B, &tmp);
451 if (pdev->revision < 0xC2)
452 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
453 /* Clear CD-ROM DMA write bit */
456 pci_write_config_byte(pdev, 0x4B, tmp | 0x09);
458 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
459 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
462 pci_read_config_byte(pdev, 0x53, &tmp);
463 if (pdev->revision >= 0xc7)
466 tmp |= 0x01; /* CD_ROM enable for DMA */
467 pci_write_config_byte(pdev, 0x53, tmp);
469 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
470 if (north && north->vendor == PCI_VENDOR_ID_AL && ali_isa_bridge) {
471 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
472 Set the south bridge enable bit */
473 pci_read_config_byte(ali_isa_bridge, 0x79, &tmp);
474 if (pdev->revision == 0xC2)
475 pci_write_config_byte(ali_isa_bridge, 0x79, tmp | 0x04);
476 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
477 pci_write_config_byte(ali_isa_bridge, 0x79, tmp | 0x02);
480 ata_pci_bmdma_clear_simplex(pdev);
483 * ali_init_one - discovery callback
484 * @pdev: PCI device ID
485 * @id: PCI table info
487 * An ALi IDE interface has been discovered. Figure out what revision
488 * and perform configuration work before handing it to the ATA layer
491 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
493 static const struct ata_port_info info_early = {
494 .flags = ATA_FLAG_SLAVE_POSS,
495 .pio_mask = ATA_PIO4,
496 .port_ops = &ali_early_port_ops
498 /* Revision 0x20 added DMA */
499 static const struct ata_port_info info_20 = {
500 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
501 .pio_mask = ATA_PIO4,
502 .mwdma_mask = ATA_MWDMA2,
503 .port_ops = &ali_20_port_ops
505 /* Revision 0x20 with support logic added UDMA */
506 static const struct ata_port_info info_20_udma = {
507 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
508 .pio_mask = ATA_PIO4,
509 .mwdma_mask = ATA_MWDMA2,
510 .udma_mask = ATA_UDMA2,
511 .port_ops = &ali_20_port_ops
513 /* Revision 0xC2 adds UDMA66 */
514 static const struct ata_port_info info_c2 = {
515 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
516 .pio_mask = ATA_PIO4,
517 .mwdma_mask = ATA_MWDMA2,
518 .udma_mask = ATA_UDMA4,
519 .port_ops = &ali_c2_port_ops
521 /* Revision 0xC3 is UDMA66 for now */
522 static const struct ata_port_info info_c3 = {
523 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
524 .pio_mask = ATA_PIO4,
525 .mwdma_mask = ATA_MWDMA2,
526 .udma_mask = ATA_UDMA4,
527 .port_ops = &ali_c2_port_ops
529 /* Revision 0xC4 is UDMA100 */
530 static const struct ata_port_info info_c4 = {
531 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
532 .pio_mask = ATA_PIO4,
533 .mwdma_mask = ATA_MWDMA2,
534 .udma_mask = ATA_UDMA5,
535 .port_ops = &ali_c4_port_ops
537 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
538 static const struct ata_port_info info_c5 = {
539 .flags = ATA_FLAG_SLAVE_POSS,
540 .pio_mask = ATA_PIO4,
541 .mwdma_mask = ATA_MWDMA2,
542 .udma_mask = ATA_UDMA6,
543 .port_ops = &ali_c5_port_ops
546 const struct ata_port_info *ppi[] = { NULL, NULL };
550 rc = pcim_enable_device(pdev);
555 * The chipset revision selects the driver operations and
559 if (pdev->revision < 0x20) {
560 ppi[0] = &info_early;
561 } else if (pdev->revision < 0xC2) {
563 } else if (pdev->revision == 0xC2) {
565 } else if (pdev->revision == 0xC3) {
567 } else if (pdev->revision == 0xC4) {
572 ali_init_chipset(pdev);
574 if (ali_isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
575 /* Are we paired with a UDMA capable chip */
576 pci_read_config_byte(ali_isa_bridge, 0x5E, &tmp);
577 if ((tmp & 0x1E) == 0x12)
578 ppi[0] = &info_20_udma;
581 return ata_pci_sff_init_one(pdev, ppi, &ali_sht, NULL);
585 static int ali_reinit_one(struct pci_dev *pdev)
587 struct ata_host *host = dev_get_drvdata(&pdev->dev);
590 rc = ata_pci_device_do_resume(pdev);
593 ali_init_chipset(pdev);
594 ata_host_resume(host);
599 static const struct pci_device_id ali[] = {
600 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
601 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
606 static struct pci_driver ali_pci_driver = {
609 .probe = ali_init_one,
610 .remove = ata_pci_remove_one,
612 .suspend = ata_pci_device_suspend,
613 .resume = ali_reinit_one,
617 static int __init ali_init(void)
620 ali_isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
622 ret = pci_register_driver(&ali_pci_driver);
624 pci_dev_put(ali_isa_bridge);
629 static void __exit ali_exit(void)
631 pci_unregister_driver(&ali_pci_driver);
632 pci_dev_put(ali_isa_bridge);
636 MODULE_AUTHOR("Alan Cox");
637 MODULE_DESCRIPTION("low-level driver for ALi PATA");
638 MODULE_LICENSE("GPL");
639 MODULE_DEVICE_TABLE(pci, ali);
640 MODULE_VERSION(DRV_VERSION);
642 module_init(ali_init);
643 module_exit(ali_exit);