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.3"
43 static struct dmi_system_id cable_dmi_table[] = {
45 .ident = "HP Pavilion N5430",
47 DMI_MATCH(DMI_BOARD_VENDOR, "Hewlett-Packard"),
48 DMI_MATCH(DMI_BOARD_NAME, "OmniBook N32N-736"),
54 static int ali_cable_override(struct pci_dev *pdev)
57 if (pdev->subsystem_vendor == 0x10CF && pdev->subsystem_device == 0x10AF)
60 if (dmi_check_system(cable_dmi_table))
66 * ali_c2_cable_detect - cable detection
69 * Perform cable detection for C2 and later revisions
72 static int ali_c2_cable_detect(struct ata_port *ap)
74 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
77 /* Certain laptops use short but suitable cables and don't
78 implement the detect logic */
80 if (ali_cable_override(pdev))
81 return ATA_CBL_PATA40_SHORT;
83 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
85 pci_read_config_byte(pdev, 0x4A, &ata66);
86 if (ata66 & (1 << ap->port_no))
87 return ATA_CBL_PATA40;
89 return ATA_CBL_PATA80;
93 * ali_early_error_handler - reset for eary chip
96 * Handle the reset callback for the later chips with cable detect
99 static int ali_c2_pre_reset(struct ata_port *ap)
101 ap->cbl = ali_c2_cable_detect(ap);
102 return ata_std_prereset(ap);
105 static void ali_c2_error_handler(struct ata_port *ap)
107 ata_bmdma_drive_eh(ap, ali_c2_pre_reset,
108 ata_std_softreset, NULL,
113 * ali_early_cable_detect - cable detection
116 * Perform cable detection for older chipsets. This turns out to be
117 * rather easy to implement
120 static int ali_early_cable_detect(struct ata_port *ap)
122 return ATA_CBL_PATA40;
126 * ali_early_probe_init - reset for early chip
129 * Handle the reset callback for the early (pre cable detect) chips.
132 static int ali_early_pre_reset(struct ata_port *ap)
134 ap->cbl = ali_early_cable_detect(ap);
135 return ata_std_prereset(ap);
138 static void ali_early_error_handler(struct ata_port *ap)
140 return ata_bmdma_drive_eh(ap, ali_early_pre_reset,
141 ata_std_softreset, NULL,
146 * ali_20_filter - filter for earlier ALI DMA
148 * @adev: attached device
150 * Ensure that we do not do DMA on CD devices. We may be able to
151 * fix that later on. Also ensure we do not do UDMA on WDC drives
154 static unsigned long ali_20_filter(const struct ata_port *ap, struct ata_device *adev, unsigned long mask)
156 char model_num[ATA_ID_PROD_LEN + 1];
157 /* No DMA on anything but a disk for now */
158 if (adev->class != ATA_DEV_ATA)
159 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
160 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
161 if (strstr(model_num, "WDC"))
162 return mask &= ~ATA_MASK_UDMA;
163 return ata_pci_default_filter(ap, adev, mask);
167 * ali_fifo_control - FIFO manager
168 * @ap: ALi channel to control
169 * @adev: device for FIFO control
170 * @on: 0 for off 1 for on
172 * Enable or disable the FIFO on a given device. Because of the way the
173 * ALi FIFO works it provides a boost on ATA disk but can be confused by
174 * ATAPI and we must therefore manage it.
177 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
179 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
180 int pio_fifo = 0x54 + ap->port_no;
182 int shift = 4 * adev->devno;
184 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
185 0x00. Not all the docs agree but the behaviour we now use is the
186 one stated in the BIOS Programming Guide */
188 pci_read_config_byte(pdev, pio_fifo, &fifo);
189 fifo &= ~(0x0F << shift);
191 fifo |= (on << shift);
192 pci_write_config_byte(pdev, pio_fifo, fifo);
196 * ali_program_modes - load mode registers
197 * @ap: ALi channel to load
198 * @adev: Device the timing is for
199 * @cmd: Command timing
201 * @ultra: UDMA timing or zero for off
203 * Loads the timing registers for cmd/data and disable UDMA if
204 * ultra is zero. If ultra is set then load and enable the UDMA
205 * timing but do not touch the command/data timing.
208 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
210 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
211 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
212 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
213 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
214 int udmat = 0x56 + ap->port_no; /* UDMA timing */
215 int shift = 4 * adev->devno;
219 t->setup = FIT(t->setup, 1, 8) & 7;
220 t->act8b = FIT(t->act8b, 1, 8) & 7;
221 t->rec8b = FIT(t->rec8b, 1, 16) & 15;
222 t->active = FIT(t->active, 1, 8) & 7;
223 t->recover = FIT(t->recover, 1, 16) & 15;
225 pci_write_config_byte(pdev, cas, t->setup);
226 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
227 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
230 /* Set up the UDMA enable */
231 pci_read_config_byte(pdev, udmat, &udma);
232 udma &= ~(0x0F << shift);
233 udma |= ultra << shift;
234 pci_write_config_byte(pdev, udmat, udma);
238 * ali_set_piomode - set initial PIO mode data
242 * Program the ALi registers for PIO mode. FIXME: add timings for
246 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
248 struct ata_device *pair = ata_dev_pair(adev);
250 unsigned long T = 1000000000 / 33333; /* PCI clock based */
252 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
255 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
256 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
257 if (pair->dma_mode) {
258 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
259 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
263 /* PIO FIFO is only permitted on ATA disk */
264 if (adev->class != ATA_DEV_ATA)
265 ali_fifo_control(ap, adev, 0x00);
266 ali_program_modes(ap, adev, &t, 0);
267 if (adev->class == ATA_DEV_ATA)
268 ali_fifo_control(ap, adev, 0x05);
273 * ali_set_dmamode - set initial DMA mode data
277 * FIXME: MWDMA timings
280 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
282 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
283 struct ata_device *pair = ata_dev_pair(adev);
285 unsigned long T = 1000000000 / 33333; /* PCI clock based */
286 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
289 if (adev->class == ATA_DEV_ATA)
290 ali_fifo_control(ap, adev, 0x08);
292 if (adev->dma_mode >= XFER_UDMA_0) {
293 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
294 if (adev->dma_mode >= XFER_UDMA_3) {
296 pci_read_config_byte(pdev, 0x4B, ®4b);
298 pci_write_config_byte(pdev, 0x4B, reg4b);
301 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
304 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
305 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
306 if (pair->dma_mode) {
307 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
308 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
311 ali_program_modes(ap, adev, &t, 0);
316 * ali_lock_sectors - Keep older devices to 255 sector mode
320 * Called during the bus probe for each device that is found. We use
321 * this call to lock the sector count of the device to 255 or less on
322 * older ALi controllers. If we didn't do this then large I/O's would
323 * require LBA48 commands which the older ALi requires are issued by
327 static void ali_lock_sectors(struct ata_port *ap, struct ata_device *adev)
329 adev->max_sectors = 255;
332 static struct scsi_host_template ali_sht = {
333 .module = THIS_MODULE,
335 .ioctl = ata_scsi_ioctl,
336 .queuecommand = ata_scsi_queuecmd,
337 .can_queue = ATA_DEF_QUEUE,
338 .this_id = ATA_SHT_THIS_ID,
339 .sg_tablesize = LIBATA_MAX_PRD,
340 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
341 .emulated = ATA_SHT_EMULATED,
342 .use_clustering = ATA_SHT_USE_CLUSTERING,
343 .proc_name = DRV_NAME,
344 .dma_boundary = ATA_DMA_BOUNDARY,
345 .slave_configure = ata_scsi_slave_config,
346 .slave_destroy = ata_scsi_slave_destroy,
347 .bios_param = ata_std_bios_param,
348 .resume = ata_scsi_device_resume,
349 .suspend = ata_scsi_device_suspend,
353 * Port operations for PIO only ALi
356 static struct ata_port_operations ali_early_port_ops = {
357 .port_disable = ata_port_disable,
358 .set_piomode = ali_set_piomode,
359 .tf_load = ata_tf_load,
360 .tf_read = ata_tf_read,
361 .check_status = ata_check_status,
362 .exec_command = ata_exec_command,
363 .dev_select = ata_std_dev_select,
365 .freeze = ata_bmdma_freeze,
366 .thaw = ata_bmdma_thaw,
367 .error_handler = ali_early_error_handler,
368 .post_internal_cmd = ata_bmdma_post_internal_cmd,
370 .qc_prep = ata_qc_prep,
371 .qc_issue = ata_qc_issue_prot,
373 .data_xfer = ata_data_xfer,
375 .irq_handler = ata_interrupt,
376 .irq_clear = ata_bmdma_irq_clear,
377 .irq_on = ata_irq_on,
378 .irq_ack = ata_irq_ack,
380 .port_start = ata_port_start,
384 * Port operations for DMA capable ALi without cable
387 static struct ata_port_operations ali_20_port_ops = {
388 .port_disable = ata_port_disable,
390 .set_piomode = ali_set_piomode,
391 .set_dmamode = ali_set_dmamode,
392 .mode_filter = ali_20_filter,
394 .tf_load = ata_tf_load,
395 .tf_read = ata_tf_read,
396 .check_status = ata_check_status,
397 .exec_command = ata_exec_command,
398 .dev_select = ata_std_dev_select,
399 .dev_config = ali_lock_sectors,
401 .freeze = ata_bmdma_freeze,
402 .thaw = ata_bmdma_thaw,
403 .error_handler = ali_early_error_handler,
404 .post_internal_cmd = ata_bmdma_post_internal_cmd,
406 .bmdma_setup = ata_bmdma_setup,
407 .bmdma_start = ata_bmdma_start,
408 .bmdma_stop = ata_bmdma_stop,
409 .bmdma_status = ata_bmdma_status,
411 .qc_prep = ata_qc_prep,
412 .qc_issue = ata_qc_issue_prot,
414 .data_xfer = ata_data_xfer,
416 .irq_handler = ata_interrupt,
417 .irq_clear = ata_bmdma_irq_clear,
418 .irq_on = ata_irq_on,
419 .irq_ack = ata_irq_ack,
421 .port_start = ata_port_start,
425 * Port operations for DMA capable ALi with cable detect
427 static struct ata_port_operations ali_c2_port_ops = {
428 .port_disable = ata_port_disable,
429 .set_piomode = ali_set_piomode,
430 .set_dmamode = ali_set_dmamode,
431 .mode_filter = ata_pci_default_filter,
432 .tf_load = ata_tf_load,
433 .tf_read = ata_tf_read,
434 .check_status = ata_check_status,
435 .exec_command = ata_exec_command,
436 .dev_select = ata_std_dev_select,
437 .dev_config = ali_lock_sectors,
439 .freeze = ata_bmdma_freeze,
440 .thaw = ata_bmdma_thaw,
441 .error_handler = ali_c2_error_handler,
442 .post_internal_cmd = ata_bmdma_post_internal_cmd,
444 .bmdma_setup = ata_bmdma_setup,
445 .bmdma_start = ata_bmdma_start,
446 .bmdma_stop = ata_bmdma_stop,
447 .bmdma_status = ata_bmdma_status,
449 .qc_prep = ata_qc_prep,
450 .qc_issue = ata_qc_issue_prot,
452 .data_xfer = ata_data_xfer,
454 .irq_handler = ata_interrupt,
455 .irq_clear = ata_bmdma_irq_clear,
456 .irq_on = ata_irq_on,
457 .irq_ack = ata_irq_ack,
459 .port_start = ata_port_start,
463 * Port operations for DMA capable ALi with cable detect and LBA48
465 static struct ata_port_operations ali_c5_port_ops = {
466 .port_disable = ata_port_disable,
467 .set_piomode = ali_set_piomode,
468 .set_dmamode = ali_set_dmamode,
469 .mode_filter = ata_pci_default_filter,
470 .tf_load = ata_tf_load,
471 .tf_read = ata_tf_read,
472 .check_status = ata_check_status,
473 .exec_command = ata_exec_command,
474 .dev_select = ata_std_dev_select,
476 .freeze = ata_bmdma_freeze,
477 .thaw = ata_bmdma_thaw,
478 .error_handler = ali_c2_error_handler,
479 .post_internal_cmd = ata_bmdma_post_internal_cmd,
481 .bmdma_setup = ata_bmdma_setup,
482 .bmdma_start = ata_bmdma_start,
483 .bmdma_stop = ata_bmdma_stop,
484 .bmdma_status = ata_bmdma_status,
486 .qc_prep = ata_qc_prep,
487 .qc_issue = ata_qc_issue_prot,
489 .data_xfer = ata_data_xfer,
491 .irq_handler = ata_interrupt,
492 .irq_clear = ata_bmdma_irq_clear,
493 .irq_on = ata_irq_on,
494 .irq_ack = ata_irq_ack,
496 .port_start = ata_port_start,
501 * ali_init_chipset - chip setup function
502 * @pdev: PCI device of ATA controller
504 * Perform the setup on the device that must be done both at boot
505 * and at resume time.
508 static void ali_init_chipset(struct pci_dev *pdev)
511 struct pci_dev *north, *isa_bridge;
513 pci_read_config_byte(pdev, PCI_REVISION_ID, &rev);
516 * The chipset revision selects the driver operations and
520 if (rev >= 0x20 && rev < 0xC2) {
521 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
522 pci_read_config_byte(pdev, 0x4B, &tmp);
523 /* Clear CD-ROM DMA write bit */
525 pci_write_config_byte(pdev, 0x4B, tmp);
526 } else if (rev >= 0xC2) {
527 /* Enable cable detection logic */
528 pci_read_config_byte(pdev, 0x4B, &tmp);
529 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
531 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
532 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
534 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
535 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
536 Set the south bridge enable bit */
537 pci_read_config_byte(isa_bridge, 0x79, &tmp);
539 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
540 else if (rev > 0xC2 && rev < 0xC5)
541 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
545 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
546 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
549 pci_read_config_byte(pdev, 0x53, &tmp);
555 tmp |= 0x01; /* CD_ROM enable for DMA */
556 pci_write_config_byte(pdev, 0x53, tmp);
558 pci_dev_put(isa_bridge);
560 ata_pci_clear_simplex(pdev);
563 * ali_init_one - discovery callback
564 * @pdev: PCI device ID
565 * @id: PCI table info
567 * An ALi IDE interface has been discovered. Figure out what revision
568 * and perform configuration work before handing it to the ATA layer
571 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
573 static struct ata_port_info info_early = {
575 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
577 .port_ops = &ali_early_port_ops
579 /* Revision 0x20 added DMA */
580 static struct ata_port_info info_20 = {
582 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST | ATA_FLAG_PIO_LBA48,
585 .port_ops = &ali_20_port_ops
587 /* Revision 0x20 with support logic added UDMA */
588 static struct ata_port_info info_20_udma = {
590 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST | ATA_FLAG_PIO_LBA48,
593 .udma_mask = 0x07, /* UDMA33 */
594 .port_ops = &ali_20_port_ops
596 /* Revision 0xC2 adds UDMA66 */
597 static struct ata_port_info info_c2 = {
599 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST | ATA_FLAG_PIO_LBA48,
603 .port_ops = &ali_c2_port_ops
605 /* Revision 0xC3 is UDMA100 */
606 static struct ata_port_info info_c3 = {
608 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST | ATA_FLAG_PIO_LBA48,
612 .port_ops = &ali_c2_port_ops
614 /* Revision 0xC4 is UDMA133 */
615 static struct ata_port_info info_c4 = {
617 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST | ATA_FLAG_PIO_LBA48,
621 .port_ops = &ali_c2_port_ops
623 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
624 static struct ata_port_info info_c5 = {
626 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
630 .port_ops = &ali_c5_port_ops
633 static struct ata_port_info *port_info[2];
635 struct pci_dev *isa_bridge;
637 pci_read_config_byte(pdev, PCI_REVISION_ID, &rev);
640 * The chipset revision selects the driver operations and
645 port_info[0] = port_info[1] = &info_early;
646 } else if (rev < 0xC2) {
647 port_info[0] = port_info[1] = &info_20;
648 } else if (rev == 0xC2) {
649 port_info[0] = port_info[1] = &info_c2;
650 } else if (rev == 0xC3) {
651 port_info[0] = port_info[1] = &info_c3;
652 } else if (rev == 0xC4) {
653 port_info[0] = port_info[1] = &info_c4;
655 port_info[0] = port_info[1] = &info_c5;
657 ali_init_chipset(pdev);
659 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
660 if (isa_bridge && rev >= 0x20 && rev < 0xC2) {
661 /* Are we paired with a UDMA capable chip */
662 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
663 if ((tmp & 0x1E) == 0x12)
664 port_info[0] = port_info[1] = &info_20_udma;
665 pci_dev_put(isa_bridge);
667 return ata_pci_init_one(pdev, port_info, 2);
670 static int ali_reinit_one(struct pci_dev *pdev)
672 ali_init_chipset(pdev);
673 return ata_pci_device_resume(pdev);
676 static const struct pci_device_id ali[] = {
677 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
678 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
683 static struct pci_driver ali_pci_driver = {
686 .probe = ali_init_one,
687 .remove = ata_pci_remove_one,
688 .suspend = ata_pci_device_suspend,
689 .resume = ali_reinit_one,
692 static int __init ali_init(void)
694 return pci_register_driver(&ali_pci_driver);
698 static void __exit ali_exit(void)
700 pci_unregister_driver(&ali_pci_driver);
704 MODULE_AUTHOR("Alan Cox");
705 MODULE_DESCRIPTION("low-level driver for ALi PATA");
706 MODULE_LICENSE("GPL");
707 MODULE_DEVICE_TABLE(pci, ali);
708 MODULE_VERSION(DRV_VERSION);
710 module_init(ali_init);
711 module_exit(ali_exit);