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.
25 #include <linux/kernel.h>
26 #include <linux/module.h>
27 #include <linux/pci.h>
28 #include <linux/init.h>
29 #include <linux/blkdev.h>
30 #include <linux/delay.h>
31 #include <scsi/scsi_host.h>
32 #include <linux/libata.h>
33 #include <linux/dmi.h>
35 #define DRV_NAME "pata_ali"
36 #define DRV_VERSION "0.7.5"
38 static int ali_atapi_dma = 0;
39 module_param_named(atapi_dma, ali_atapi_dma, int, 0644);
40 MODULE_PARM_DESC(atapi_dma, "Enable ATAPI DMA (0=disable, 1=enable)");
46 static const struct dmi_system_id cable_dmi_table[] = {
48 .ident = "HP Pavilion N5430",
50 DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
51 DMI_MATCH(DMI_BOARD_VERSION, "OmniBook N32N-736"),
55 .ident = "Toshiba Satelite S1800-814",
57 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
58 DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
64 static int ali_cable_override(struct pci_dev *pdev)
67 if (pdev->subsystem_vendor == 0x10CF && pdev->subsystem_device == 0x10AF)
69 /* Mitac 8317 (Winbook-A) and relatives */
70 if (pdev->subsystem_vendor == 0x1071 && pdev->subsystem_device == 0x8317)
73 if (dmi_check_system(cable_dmi_table))
79 * ali_c2_cable_detect - cable detection
82 * Perform cable detection for C2 and later revisions
85 static int ali_c2_cable_detect(struct ata_port *ap)
87 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
90 /* Certain laptops use short but suitable cables and don't
91 implement the detect logic */
93 if (ali_cable_override(pdev))
94 return ATA_CBL_PATA40_SHORT;
96 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
98 pci_read_config_byte(pdev, 0x4A, &ata66);
99 if (ata66 & (1 << ap->port_no))
100 return ATA_CBL_PATA40;
102 return ATA_CBL_PATA80;
106 * ali_20_filter - filter for earlier ALI DMA
108 * @adev: attached device
110 * Ensure that we do not do DMA on CD devices. We may be able to
111 * fix that later on. Also ensure we do not do UDMA on WDC drives
114 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
116 char model_num[ATA_ID_PROD_LEN + 1];
117 /* No DMA on anything but a disk for now */
118 if (adev->class != ATA_DEV_ATA)
119 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
120 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
121 if (strstr(model_num, "WDC"))
122 return mask &= ~ATA_MASK_UDMA;
123 return ata_bmdma_mode_filter(adev, mask);
127 * ali_fifo_control - FIFO manager
128 * @ap: ALi channel to control
129 * @adev: device for FIFO control
130 * @on: 0 for off 1 for on
132 * Enable or disable the FIFO on a given device. Because of the way the
133 * ALi FIFO works it provides a boost on ATA disk but can be confused by
134 * ATAPI and we must therefore manage it.
137 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
139 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
140 int pio_fifo = 0x54 + ap->port_no;
142 int shift = 4 * adev->devno;
144 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
145 0x00. Not all the docs agree but the behaviour we now use is the
146 one stated in the BIOS Programming Guide */
148 pci_read_config_byte(pdev, pio_fifo, &fifo);
149 fifo &= ~(0x0F << shift);
151 fifo |= (on << shift);
152 pci_write_config_byte(pdev, pio_fifo, fifo);
156 * ali_program_modes - load mode registers
157 * @ap: ALi channel to load
158 * @adev: Device the timing is for
159 * @cmd: Command timing
161 * @ultra: UDMA timing or zero for off
163 * Loads the timing registers for cmd/data and disable UDMA if
164 * ultra is zero. If ultra is set then load and enable the UDMA
165 * timing but do not touch the command/data timing.
168 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
170 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
171 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
172 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
173 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
174 int udmat = 0x56 + ap->port_no; /* UDMA timing */
175 int shift = 4 * adev->devno;
179 t->setup = clamp_val(t->setup, 1, 8) & 7;
180 t->act8b = clamp_val(t->act8b, 1, 8) & 7;
181 t->rec8b = clamp_val(t->rec8b, 1, 16) & 15;
182 t->active = clamp_val(t->active, 1, 8) & 7;
183 t->recover = clamp_val(t->recover, 1, 16) & 15;
185 pci_write_config_byte(pdev, cas, t->setup);
186 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
187 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
190 /* Set up the UDMA enable */
191 pci_read_config_byte(pdev, udmat, &udma);
192 udma &= ~(0x0F << shift);
193 udma |= ultra << shift;
194 pci_write_config_byte(pdev, udmat, udma);
198 * ali_set_piomode - set initial PIO mode data
202 * Program the ALi registers for PIO mode. FIXME: add timings for
206 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
208 struct ata_device *pair = ata_dev_pair(adev);
210 unsigned long T = 1000000000 / 33333; /* PCI clock based */
212 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
215 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
216 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
217 if (pair->dma_mode) {
218 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
219 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
223 /* PIO FIFO is only permitted on ATA disk */
224 if (adev->class != ATA_DEV_ATA)
225 ali_fifo_control(ap, adev, 0x00);
226 ali_program_modes(ap, adev, &t, 0);
227 if (adev->class == ATA_DEV_ATA)
228 ali_fifo_control(ap, adev, 0x05);
233 * ali_set_dmamode - set initial DMA mode data
237 * FIXME: MWDMA timings
240 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
242 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
243 struct ata_device *pair = ata_dev_pair(adev);
245 unsigned long T = 1000000000 / 33333; /* PCI clock based */
246 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
249 if (adev->class == ATA_DEV_ATA)
250 ali_fifo_control(ap, adev, 0x08);
252 if (adev->dma_mode >= XFER_UDMA_0) {
253 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
254 if (adev->dma_mode >= XFER_UDMA_3) {
256 pci_read_config_byte(pdev, 0x4B, ®4b);
258 pci_write_config_byte(pdev, 0x4B, reg4b);
261 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
264 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
265 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
266 if (pair->dma_mode) {
267 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
268 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
271 ali_program_modes(ap, adev, &t, 0);
276 * ali_warn_atapi_dma - Warn about ATAPI DMA disablement
279 * Whine about ATAPI DMA disablement if @adev is an ATAPI device.
280 * Can be used as ->dev_config.
283 static void ali_warn_atapi_dma(struct ata_device *adev)
285 struct ata_eh_context *ehc = &adev->link->eh_context;
286 int print_info = ehc->i.flags & ATA_EHI_PRINTINFO;
288 if (print_info && adev->class == ATA_DEV_ATAPI && !ali_atapi_dma) {
289 ata_dev_printk(adev, KERN_WARNING,
290 "WARNING: ATAPI DMA disabled for reliablity issues. It can be enabled\n");
291 ata_dev_printk(adev, KERN_WARNING,
292 "WARNING: via pata_ali.atapi_dma modparam or corresponding sysfs node.\n");
297 * ali_lock_sectors - Keep older devices to 255 sector mode
300 * Called during the bus probe for each device that is found. We use
301 * this call to lock the sector count of the device to 255 or less on
302 * older ALi controllers. If we didn't do this then large I/O's would
303 * require LBA48 commands which the older ALi requires are issued by
307 static void ali_lock_sectors(struct ata_device *adev)
309 adev->max_sectors = 255;
310 ali_warn_atapi_dma(adev);
314 * ali_check_atapi_dma - DMA check for most ALi controllers
317 * Called to decide whether commands should be sent by DMA or PIO
320 static int ali_check_atapi_dma(struct ata_queued_cmd *qc)
322 if (!ali_atapi_dma) {
323 /* FIXME: pata_ali can't do ATAPI DMA reliably but the
324 * IDE alim15x3 driver can. I tried lots of things
325 * but couldn't find what the actual difference was.
326 * If you got an idea, please write it to
327 * linux-ide@vger.kernel.org and cc htejun@gmail.com.
329 * Disable ATAPI DMA for now.
334 /* If its not a media command, its not worth it */
335 if (atapi_cmd_type(qc->cdb[0]) == ATAPI_MISC)
340 static struct scsi_host_template ali_sht = {
341 ATA_BMDMA_SHT(DRV_NAME),
345 * Port operations for PIO only ALi
348 static struct ata_port_operations ali_early_port_ops = {
349 .inherits = &ata_sff_port_ops,
350 .cable_detect = ata_cable_40wire,
351 .set_piomode = ali_set_piomode,
354 static const struct ata_port_operations ali_dma_base_ops = {
355 .inherits = &ata_bmdma_port_ops,
356 .set_piomode = ali_set_piomode,
357 .set_dmamode = ali_set_dmamode,
361 * Port operations for DMA capable ALi without cable
364 static struct ata_port_operations ali_20_port_ops = {
365 .inherits = &ali_dma_base_ops,
366 .cable_detect = ata_cable_40wire,
367 .mode_filter = ali_20_filter,
368 .check_atapi_dma = ali_check_atapi_dma,
369 .dev_config = ali_lock_sectors,
373 * Port operations for DMA capable ALi with cable detect
375 static struct ata_port_operations ali_c2_port_ops = {
376 .inherits = &ali_dma_base_ops,
377 .check_atapi_dma = ali_check_atapi_dma,
378 .cable_detect = ali_c2_cable_detect,
379 .dev_config = ali_lock_sectors,
383 * Port operations for DMA capable ALi with cable detect and LBA48
385 static struct ata_port_operations ali_c5_port_ops = {
386 .inherits = &ali_dma_base_ops,
387 .check_atapi_dma = ali_check_atapi_dma,
388 .dev_config = ali_warn_atapi_dma,
389 .cable_detect = ali_c2_cable_detect,
394 * ali_init_chipset - chip setup function
395 * @pdev: PCI device of ATA controller
397 * Perform the setup on the device that must be done both at boot
398 * and at resume time.
401 static void ali_init_chipset(struct pci_dev *pdev)
404 struct pci_dev *north, *isa_bridge;
407 * The chipset revision selects the driver operations and
411 if (pdev->revision >= 0x20 && pdev->revision < 0xC2) {
412 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
413 pci_read_config_byte(pdev, 0x4B, &tmp);
414 /* Clear CD-ROM DMA write bit */
416 pci_write_config_byte(pdev, 0x4B, tmp);
417 } else if (pdev->revision >= 0xC2) {
418 /* Enable cable detection logic */
419 pci_read_config_byte(pdev, 0x4B, &tmp);
420 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
422 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
423 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
425 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
426 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
427 Set the south bridge enable bit */
428 pci_read_config_byte(isa_bridge, 0x79, &tmp);
429 if (pdev->revision == 0xC2)
430 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
431 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
432 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
434 if (pdev->revision >= 0x20) {
436 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
437 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
440 pci_read_config_byte(pdev, 0x53, &tmp);
441 if (pdev->revision <= 0x20)
443 if (pdev->revision >= 0xc7)
446 tmp |= 0x01; /* CD_ROM enable for DMA */
447 pci_write_config_byte(pdev, 0x53, tmp);
449 pci_dev_put(isa_bridge);
451 ata_pci_bmdma_clear_simplex(pdev);
454 * ali_init_one - discovery callback
455 * @pdev: PCI device ID
456 * @id: PCI table info
458 * An ALi IDE interface has been discovered. Figure out what revision
459 * and perform configuration work before handing it to the ATA layer
462 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
464 static const struct ata_port_info info_early = {
465 .flags = ATA_FLAG_SLAVE_POSS,
467 .port_ops = &ali_early_port_ops
469 /* Revision 0x20 added DMA */
470 static const struct ata_port_info info_20 = {
471 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
474 .port_ops = &ali_20_port_ops
476 /* Revision 0x20 with support logic added UDMA */
477 static const struct ata_port_info info_20_udma = {
478 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
481 .udma_mask = 0x07, /* UDMA33 */
482 .port_ops = &ali_20_port_ops
484 /* Revision 0xC2 adds UDMA66 */
485 static const struct ata_port_info info_c2 = {
486 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
489 .udma_mask = ATA_UDMA4,
490 .port_ops = &ali_c2_port_ops
492 /* Revision 0xC3 is UDMA66 for now */
493 static const struct ata_port_info info_c3 = {
494 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
497 .udma_mask = ATA_UDMA4,
498 .port_ops = &ali_c2_port_ops
500 /* Revision 0xC4 is UDMA100 */
501 static const struct ata_port_info info_c4 = {
502 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
505 .udma_mask = ATA_UDMA5,
506 .port_ops = &ali_c2_port_ops
508 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
509 static const struct ata_port_info info_c5 = {
510 .flags = ATA_FLAG_SLAVE_POSS,
513 .udma_mask = ATA_UDMA6,
514 .port_ops = &ali_c5_port_ops
517 const struct ata_port_info *ppi[] = { NULL, NULL };
519 struct pci_dev *isa_bridge;
522 rc = pcim_enable_device(pdev);
527 * The chipset revision selects the driver operations and
531 if (pdev->revision < 0x20) {
532 ppi[0] = &info_early;
533 } else if (pdev->revision < 0xC2) {
535 } else if (pdev->revision == 0xC2) {
537 } else if (pdev->revision == 0xC3) {
539 } else if (pdev->revision == 0xC4) {
544 ali_init_chipset(pdev);
546 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
547 if (isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
548 /* Are we paired with a UDMA capable chip */
549 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
550 if ((tmp & 0x1E) == 0x12)
551 ppi[0] = &info_20_udma;
553 pci_dev_put(isa_bridge);
555 return ata_pci_sff_init_one(pdev, ppi, &ali_sht, NULL);
559 static int ali_reinit_one(struct pci_dev *pdev)
561 struct ata_host *host = dev_get_drvdata(&pdev->dev);
564 rc = ata_pci_device_do_resume(pdev);
567 ali_init_chipset(pdev);
568 ata_host_resume(host);
573 static const struct pci_device_id ali[] = {
574 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
575 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
580 static struct pci_driver ali_pci_driver = {
583 .probe = ali_init_one,
584 .remove = ata_pci_remove_one,
586 .suspend = ata_pci_device_suspend,
587 .resume = ali_reinit_one,
591 static int __init ali_init(void)
593 return pci_register_driver(&ali_pci_driver);
597 static void __exit ali_exit(void)
599 pci_unregister_driver(&ali_pci_driver);
603 MODULE_AUTHOR("Alan Cox");
604 MODULE_DESCRIPTION("low-level driver for ALi PATA");
605 MODULE_LICENSE("GPL");
606 MODULE_DEVICE_TABLE(pci, ali);
607 MODULE_VERSION(DRV_VERSION);
609 module_init(ali_init);
610 module_exit(ali_exit);