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"
43 static const 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_VERSION, "OmniBook N32N-736"),
52 .ident = "Toshiba Satelite S1800-814",
54 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
55 DMI_MATCH(DMI_PRODUCT_NAME, "S1800-814"),
61 static int ali_cable_override(struct pci_dev *pdev)
64 if (pdev->subsystem_vendor == 0x10CF && pdev->subsystem_device == 0x10AF)
66 /* Mitac 8317 (Winbook-A) and relatives */
67 if (pdev->subsystem_vendor == 0x1071 && pdev->subsystem_device == 0x8317)
70 if (dmi_check_system(cable_dmi_table))
76 * ali_c2_cable_detect - cable detection
79 * Perform cable detection for C2 and later revisions
82 static int ali_c2_cable_detect(struct ata_port *ap)
84 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
87 /* Certain laptops use short but suitable cables and don't
88 implement the detect logic */
90 if (ali_cable_override(pdev))
91 return ATA_CBL_PATA40_SHORT;
93 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
95 pci_read_config_byte(pdev, 0x4A, &ata66);
96 if (ata66 & (1 << ap->port_no))
97 return ATA_CBL_PATA40;
99 return ATA_CBL_PATA80;
103 * ali_20_filter - filter for earlier ALI DMA
105 * @adev: attached device
107 * Ensure that we do not do DMA on CD devices. We may be able to
108 * fix that later on. Also ensure we do not do UDMA on WDC drives
111 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
113 char model_num[ATA_ID_PROD_LEN + 1];
114 /* No DMA on anything but a disk for now */
115 if (adev->class != ATA_DEV_ATA)
116 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
117 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
118 if (strstr(model_num, "WDC"))
119 return mask &= ~ATA_MASK_UDMA;
120 return ata_pci_default_filter(adev, mask);
124 * ali_fifo_control - FIFO manager
125 * @ap: ALi channel to control
126 * @adev: device for FIFO control
127 * @on: 0 for off 1 for on
129 * Enable or disable the FIFO on a given device. Because of the way the
130 * ALi FIFO works it provides a boost on ATA disk but can be confused by
131 * ATAPI and we must therefore manage it.
134 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
136 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
137 int pio_fifo = 0x54 + ap->port_no;
139 int shift = 4 * adev->devno;
141 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
142 0x00. Not all the docs agree but the behaviour we now use is the
143 one stated in the BIOS Programming Guide */
145 pci_read_config_byte(pdev, pio_fifo, &fifo);
146 fifo &= ~(0x0F << shift);
148 fifo |= (on << shift);
149 pci_write_config_byte(pdev, pio_fifo, fifo);
153 * ali_program_modes - load mode registers
154 * @ap: ALi channel to load
155 * @adev: Device the timing is for
156 * @cmd: Command timing
158 * @ultra: UDMA timing or zero for off
160 * Loads the timing registers for cmd/data and disable UDMA if
161 * ultra is zero. If ultra is set then load and enable the UDMA
162 * timing but do not touch the command/data timing.
165 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
167 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
168 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
169 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
170 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
171 int udmat = 0x56 + ap->port_no; /* UDMA timing */
172 int shift = 4 * adev->devno;
176 t->setup = FIT(t->setup, 1, 8) & 7;
177 t->act8b = FIT(t->act8b, 1, 8) & 7;
178 t->rec8b = FIT(t->rec8b, 1, 16) & 15;
179 t->active = FIT(t->active, 1, 8) & 7;
180 t->recover = FIT(t->recover, 1, 16) & 15;
182 pci_write_config_byte(pdev, cas, t->setup);
183 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
184 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
187 /* Set up the UDMA enable */
188 pci_read_config_byte(pdev, udmat, &udma);
189 udma &= ~(0x0F << shift);
190 udma |= ultra << shift;
191 pci_write_config_byte(pdev, udmat, udma);
195 * ali_set_piomode - set initial PIO mode data
199 * Program the ALi registers for PIO mode. FIXME: add timings for
203 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
205 struct ata_device *pair = ata_dev_pair(adev);
207 unsigned long T = 1000000000 / 33333; /* PCI clock based */
209 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
212 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
213 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
214 if (pair->dma_mode) {
215 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
216 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
220 /* PIO FIFO is only permitted on ATA disk */
221 if (adev->class != ATA_DEV_ATA)
222 ali_fifo_control(ap, adev, 0x00);
223 ali_program_modes(ap, adev, &t, 0);
224 if (adev->class == ATA_DEV_ATA)
225 ali_fifo_control(ap, adev, 0x05);
230 * ali_set_dmamode - set initial DMA mode data
234 * FIXME: MWDMA timings
237 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
239 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
240 struct ata_device *pair = ata_dev_pair(adev);
242 unsigned long T = 1000000000 / 33333; /* PCI clock based */
243 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
246 if (adev->class == ATA_DEV_ATA)
247 ali_fifo_control(ap, adev, 0x08);
249 if (adev->dma_mode >= XFER_UDMA_0) {
250 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
251 if (adev->dma_mode >= XFER_UDMA_3) {
253 pci_read_config_byte(pdev, 0x4B, ®4b);
255 pci_write_config_byte(pdev, 0x4B, reg4b);
258 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
261 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
262 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
263 if (pair->dma_mode) {
264 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
265 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
268 ali_program_modes(ap, adev, &t, 0);
273 * ali_lock_sectors - Keep older devices to 255 sector mode
276 * Called during the bus probe for each device that is found. We use
277 * this call to lock the sector count of the device to 255 or less on
278 * older ALi controllers. If we didn't do this then large I/O's would
279 * require LBA48 commands which the older ALi requires are issued by
283 static void ali_lock_sectors(struct ata_device *adev)
285 adev->max_sectors = 255;
289 * ali_check_atapi_dma - DMA check for most ALi controllers
292 * Called to decide whether commands should be sent by DMA or PIO
295 static int ali_check_atapi_dma(struct ata_queued_cmd *qc)
297 /* If its not a media command, its not worth it */
298 if (atapi_cmd_type(qc->cdb[0]) == ATAPI_MISC)
303 static struct scsi_host_template ali_sht = {
304 .module = THIS_MODULE,
306 .ioctl = ata_scsi_ioctl,
307 .queuecommand = ata_scsi_queuecmd,
308 .can_queue = ATA_DEF_QUEUE,
309 .this_id = ATA_SHT_THIS_ID,
310 .sg_tablesize = LIBATA_MAX_PRD,
311 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
312 .emulated = ATA_SHT_EMULATED,
313 .use_clustering = ATA_SHT_USE_CLUSTERING,
314 .proc_name = DRV_NAME,
315 .dma_boundary = ATA_DMA_BOUNDARY,
316 .slave_configure = ata_scsi_slave_config,
317 .slave_destroy = ata_scsi_slave_destroy,
318 .bios_param = ata_std_bios_param,
322 * Port operations for PIO only ALi
325 static struct ata_port_operations ali_early_port_ops = {
326 .set_piomode = ali_set_piomode,
327 .tf_load = ata_tf_load,
328 .tf_read = ata_tf_read,
329 .check_status = ata_check_status,
330 .exec_command = ata_exec_command,
331 .dev_select = ata_std_dev_select,
333 .freeze = ata_bmdma_freeze,
334 .thaw = ata_bmdma_thaw,
335 .error_handler = ata_bmdma_error_handler,
336 .post_internal_cmd = ata_bmdma_post_internal_cmd,
337 .cable_detect = ata_cable_40wire,
339 .qc_prep = ata_qc_prep,
340 .qc_issue = ata_qc_issue_prot,
342 .data_xfer = ata_data_xfer,
344 .irq_handler = ata_interrupt,
345 .irq_clear = ata_bmdma_irq_clear,
346 .irq_on = ata_irq_on,
348 .port_start = ata_sff_port_start,
352 * Port operations for DMA capable ALi without cable
355 static struct ata_port_operations ali_20_port_ops = {
356 .set_piomode = ali_set_piomode,
357 .set_dmamode = ali_set_dmamode,
358 .mode_filter = ali_20_filter,
360 .tf_load = ata_tf_load,
361 .tf_read = ata_tf_read,
362 .check_status = ata_check_status,
363 .exec_command = ata_exec_command,
364 .dev_select = ata_std_dev_select,
365 .dev_config = ali_lock_sectors,
367 .freeze = ata_bmdma_freeze,
368 .thaw = ata_bmdma_thaw,
369 .error_handler = ata_bmdma_error_handler,
370 .post_internal_cmd = ata_bmdma_post_internal_cmd,
371 .cable_detect = ata_cable_40wire,
373 .bmdma_setup = ata_bmdma_setup,
374 .bmdma_start = ata_bmdma_start,
375 .bmdma_stop = ata_bmdma_stop,
376 .bmdma_status = ata_bmdma_status,
378 .qc_prep = ata_qc_prep,
379 .qc_issue = ata_qc_issue_prot,
381 .data_xfer = ata_data_xfer,
383 .irq_handler = ata_interrupt,
384 .irq_clear = ata_bmdma_irq_clear,
385 .irq_on = ata_irq_on,
387 .port_start = ata_sff_port_start,
391 * Port operations for DMA capable ALi with cable detect
393 static struct ata_port_operations ali_c2_port_ops = {
394 .set_piomode = ali_set_piomode,
395 .set_dmamode = ali_set_dmamode,
396 .mode_filter = ata_pci_default_filter,
397 .tf_load = ata_tf_load,
398 .tf_read = ata_tf_read,
399 .check_atapi_dma = ali_check_atapi_dma,
400 .check_status = ata_check_status,
401 .exec_command = ata_exec_command,
402 .dev_select = ata_std_dev_select,
403 .dev_config = ali_lock_sectors,
405 .freeze = ata_bmdma_freeze,
406 .thaw = ata_bmdma_thaw,
407 .error_handler = ata_bmdma_error_handler,
408 .post_internal_cmd = ata_bmdma_post_internal_cmd,
409 .cable_detect = ali_c2_cable_detect,
411 .bmdma_setup = ata_bmdma_setup,
412 .bmdma_start = ata_bmdma_start,
413 .bmdma_stop = ata_bmdma_stop,
414 .bmdma_status = ata_bmdma_status,
416 .qc_prep = ata_qc_prep,
417 .qc_issue = ata_qc_issue_prot,
419 .data_xfer = ata_data_xfer,
421 .irq_handler = ata_interrupt,
422 .irq_clear = ata_bmdma_irq_clear,
423 .irq_on = ata_irq_on,
425 .port_start = ata_sff_port_start,
429 * Port operations for DMA capable ALi with cable detect and LBA48
431 static struct ata_port_operations ali_c5_port_ops = {
432 .set_piomode = ali_set_piomode,
433 .set_dmamode = ali_set_dmamode,
434 .mode_filter = ata_pci_default_filter,
435 .tf_load = ata_tf_load,
436 .tf_read = ata_tf_read,
437 .check_atapi_dma = ali_check_atapi_dma,
438 .check_status = ata_check_status,
439 .exec_command = ata_exec_command,
440 .dev_select = ata_std_dev_select,
442 .freeze = ata_bmdma_freeze,
443 .thaw = ata_bmdma_thaw,
444 .error_handler = ata_bmdma_error_handler,
445 .post_internal_cmd = ata_bmdma_post_internal_cmd,
446 .cable_detect = ali_c2_cable_detect,
448 .bmdma_setup = ata_bmdma_setup,
449 .bmdma_start = ata_bmdma_start,
450 .bmdma_stop = ata_bmdma_stop,
451 .bmdma_status = ata_bmdma_status,
453 .qc_prep = ata_qc_prep,
454 .qc_issue = ata_qc_issue_prot,
456 .data_xfer = ata_data_xfer,
458 .irq_handler = ata_interrupt,
459 .irq_clear = ata_bmdma_irq_clear,
460 .irq_on = ata_irq_on,
462 .port_start = ata_sff_port_start,
467 * ali_init_chipset - chip setup function
468 * @pdev: PCI device of ATA controller
470 * Perform the setup on the device that must be done both at boot
471 * and at resume time.
474 static void ali_init_chipset(struct pci_dev *pdev)
477 struct pci_dev *north, *isa_bridge;
480 * The chipset revision selects the driver operations and
484 if (pdev->revision >= 0x20 && pdev->revision < 0xC2) {
485 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
486 pci_read_config_byte(pdev, 0x4B, &tmp);
487 /* Clear CD-ROM DMA write bit */
489 pci_write_config_byte(pdev, 0x4B, tmp);
490 } else if (pdev->revision >= 0xC2) {
491 /* Enable cable detection logic */
492 pci_read_config_byte(pdev, 0x4B, &tmp);
493 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
495 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
496 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
498 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
499 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
500 Set the south bridge enable bit */
501 pci_read_config_byte(isa_bridge, 0x79, &tmp);
502 if (pdev->revision == 0xC2)
503 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
504 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
505 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
507 if (pdev->revision >= 0x20) {
509 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
510 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
513 pci_read_config_byte(pdev, 0x53, &tmp);
514 if (pdev->revision <= 0x20)
516 if (pdev->revision >= 0xc7)
519 tmp |= 0x01; /* CD_ROM enable for DMA */
520 pci_write_config_byte(pdev, 0x53, tmp);
522 pci_dev_put(isa_bridge);
524 ata_pci_clear_simplex(pdev);
527 * ali_init_one - discovery callback
528 * @pdev: PCI device ID
529 * @id: PCI table info
531 * An ALi IDE interface has been discovered. Figure out what revision
532 * and perform configuration work before handing it to the ATA layer
535 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
537 static const struct ata_port_info info_early = {
539 .flags = ATA_FLAG_SLAVE_POSS,
541 .port_ops = &ali_early_port_ops
543 /* Revision 0x20 added DMA */
544 static const struct ata_port_info info_20 = {
546 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
549 .port_ops = &ali_20_port_ops
551 /* Revision 0x20 with support logic added UDMA */
552 static const struct ata_port_info info_20_udma = {
554 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
557 .udma_mask = 0x07, /* UDMA33 */
558 .port_ops = &ali_20_port_ops
560 /* Revision 0xC2 adds UDMA66 */
561 static const struct ata_port_info info_c2 = {
563 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
566 .udma_mask = ATA_UDMA4,
567 .port_ops = &ali_c2_port_ops
569 /* Revision 0xC3 is UDMA66 for now */
570 static const struct ata_port_info info_c3 = {
572 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
575 .udma_mask = ATA_UDMA4,
576 .port_ops = &ali_c2_port_ops
578 /* Revision 0xC4 is UDMA100 */
579 static const struct ata_port_info info_c4 = {
581 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
584 .udma_mask = ATA_UDMA5,
585 .port_ops = &ali_c2_port_ops
587 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
588 static const struct ata_port_info info_c5 = {
590 .flags = ATA_FLAG_SLAVE_POSS,
593 .udma_mask = ATA_UDMA6,
594 .port_ops = &ali_c5_port_ops
597 const struct ata_port_info *ppi[] = { NULL, NULL };
599 struct pci_dev *isa_bridge;
602 * The chipset revision selects the driver operations and
606 if (pdev->revision < 0x20) {
607 ppi[0] = &info_early;
608 } else if (pdev->revision < 0xC2) {
610 } else if (pdev->revision == 0xC2) {
612 } else if (pdev->revision == 0xC3) {
614 } else if (pdev->revision == 0xC4) {
619 ali_init_chipset(pdev);
621 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
622 if (isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
623 /* Are we paired with a UDMA capable chip */
624 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
625 if ((tmp & 0x1E) == 0x12)
626 ppi[0] = &info_20_udma;
627 pci_dev_put(isa_bridge);
629 return ata_pci_init_one(pdev, ppi);
633 static int ali_reinit_one(struct pci_dev *pdev)
635 ali_init_chipset(pdev);
636 return ata_pci_device_resume(pdev);
640 static const struct pci_device_id ali[] = {
641 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
642 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
647 static struct pci_driver ali_pci_driver = {
650 .probe = ali_init_one,
651 .remove = ata_pci_remove_one,
653 .suspend = ata_pci_device_suspend,
654 .resume = ali_reinit_one,
658 static int __init ali_init(void)
660 return pci_register_driver(&ali_pci_driver);
664 static void __exit ali_exit(void)
666 pci_unregister_driver(&ali_pci_driver);
670 MODULE_AUTHOR("Alan Cox");
671 MODULE_DESCRIPTION("low-level driver for ALi PATA");
672 MODULE_LICENSE("GPL");
673 MODULE_DEVICE_TABLE(pci, ali);
674 MODULE_VERSION(DRV_VERSION);
676 module_init(ali_init);
677 module_exit(ali_exit);