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)
67 if (dmi_check_system(cable_dmi_table))
73 * ali_c2_cable_detect - cable detection
76 * Perform cable detection for C2 and later revisions
79 static int ali_c2_cable_detect(struct ata_port *ap)
81 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
84 /* Certain laptops use short but suitable cables and don't
85 implement the detect logic */
87 if (ali_cable_override(pdev))
88 return ATA_CBL_PATA40_SHORT;
90 /* Host view cable detect 0x4A bit 0 primary bit 1 secondary
92 pci_read_config_byte(pdev, 0x4A, &ata66);
93 if (ata66 & (1 << ap->port_no))
94 return ATA_CBL_PATA40;
96 return ATA_CBL_PATA80;
100 * ali_20_filter - filter for earlier ALI DMA
102 * @adev: attached device
104 * Ensure that we do not do DMA on CD devices. We may be able to
105 * fix that later on. Also ensure we do not do UDMA on WDC drives
108 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
110 char model_num[ATA_ID_PROD_LEN + 1];
111 /* No DMA on anything but a disk for now */
112 if (adev->class != ATA_DEV_ATA)
113 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
114 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
115 if (strstr(model_num, "WDC"))
116 return mask &= ~ATA_MASK_UDMA;
117 return ata_pci_default_filter(adev, mask);
121 * ali_fifo_control - FIFO manager
122 * @ap: ALi channel to control
123 * @adev: device for FIFO control
124 * @on: 0 for off 1 for on
126 * Enable or disable the FIFO on a given device. Because of the way the
127 * ALi FIFO works it provides a boost on ATA disk but can be confused by
128 * ATAPI and we must therefore manage it.
131 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
133 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
134 int pio_fifo = 0x54 + ap->port_no;
136 int shift = 4 * adev->devno;
138 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
139 0x00. Not all the docs agree but the behaviour we now use is the
140 one stated in the BIOS Programming Guide */
142 pci_read_config_byte(pdev, pio_fifo, &fifo);
143 fifo &= ~(0x0F << shift);
145 fifo |= (on << shift);
146 pci_write_config_byte(pdev, pio_fifo, fifo);
150 * ali_program_modes - load mode registers
151 * @ap: ALi channel to load
152 * @adev: Device the timing is for
153 * @cmd: Command timing
155 * @ultra: UDMA timing or zero for off
157 * Loads the timing registers for cmd/data and disable UDMA if
158 * ultra is zero. If ultra is set then load and enable the UDMA
159 * timing but do not touch the command/data timing.
162 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
164 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
165 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
166 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
167 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
168 int udmat = 0x56 + ap->port_no; /* UDMA timing */
169 int shift = 4 * adev->devno;
173 t->setup = FIT(t->setup, 1, 8) & 7;
174 t->act8b = FIT(t->act8b, 1, 8) & 7;
175 t->rec8b = FIT(t->rec8b, 1, 16) & 15;
176 t->active = FIT(t->active, 1, 8) & 7;
177 t->recover = FIT(t->recover, 1, 16) & 15;
179 pci_write_config_byte(pdev, cas, t->setup);
180 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
181 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
184 /* Set up the UDMA enable */
185 pci_read_config_byte(pdev, udmat, &udma);
186 udma &= ~(0x0F << shift);
187 udma |= ultra << shift;
188 pci_write_config_byte(pdev, udmat, udma);
192 * ali_set_piomode - set initial PIO mode data
196 * Program the ALi registers for PIO mode. FIXME: add timings for
200 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
202 struct ata_device *pair = ata_dev_pair(adev);
204 unsigned long T = 1000000000 / 33333; /* PCI clock based */
206 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
209 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
210 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
211 if (pair->dma_mode) {
212 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
213 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
217 /* PIO FIFO is only permitted on ATA disk */
218 if (adev->class != ATA_DEV_ATA)
219 ali_fifo_control(ap, adev, 0x00);
220 ali_program_modes(ap, adev, &t, 0);
221 if (adev->class == ATA_DEV_ATA)
222 ali_fifo_control(ap, adev, 0x05);
227 * ali_set_dmamode - set initial DMA mode data
231 * FIXME: MWDMA timings
234 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
236 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
237 struct ata_device *pair = ata_dev_pair(adev);
239 unsigned long T = 1000000000 / 33333; /* PCI clock based */
240 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
243 if (adev->class == ATA_DEV_ATA)
244 ali_fifo_control(ap, adev, 0x08);
246 if (adev->dma_mode >= XFER_UDMA_0) {
247 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
248 if (adev->dma_mode >= XFER_UDMA_3) {
250 pci_read_config_byte(pdev, 0x4B, ®4b);
252 pci_write_config_byte(pdev, 0x4B, reg4b);
255 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
258 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
259 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
260 if (pair->dma_mode) {
261 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
262 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
265 ali_program_modes(ap, adev, &t, 0);
270 * ali_lock_sectors - Keep older devices to 255 sector mode
273 * Called during the bus probe for each device that is found. We use
274 * this call to lock the sector count of the device to 255 or less on
275 * older ALi controllers. If we didn't do this then large I/O's would
276 * require LBA48 commands which the older ALi requires are issued by
280 static void ali_lock_sectors(struct ata_device *adev)
282 adev->max_sectors = 255;
285 static struct scsi_host_template ali_sht = {
286 .module = THIS_MODULE,
288 .ioctl = ata_scsi_ioctl,
289 .queuecommand = ata_scsi_queuecmd,
290 .can_queue = ATA_DEF_QUEUE,
291 .this_id = ATA_SHT_THIS_ID,
292 .sg_tablesize = LIBATA_MAX_PRD,
293 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
294 .emulated = ATA_SHT_EMULATED,
295 .use_clustering = ATA_SHT_USE_CLUSTERING,
296 .proc_name = DRV_NAME,
297 .dma_boundary = ATA_DMA_BOUNDARY,
298 .slave_configure = ata_scsi_slave_config,
299 .slave_destroy = ata_scsi_slave_destroy,
300 .bios_param = ata_std_bios_param,
304 * Port operations for PIO only ALi
307 static struct ata_port_operations ali_early_port_ops = {
308 .port_disable = ata_port_disable,
309 .set_piomode = ali_set_piomode,
310 .tf_load = ata_tf_load,
311 .tf_read = ata_tf_read,
312 .check_status = ata_check_status,
313 .exec_command = ata_exec_command,
314 .dev_select = ata_std_dev_select,
316 .freeze = ata_bmdma_freeze,
317 .thaw = ata_bmdma_thaw,
318 .error_handler = ata_bmdma_error_handler,
319 .post_internal_cmd = ata_bmdma_post_internal_cmd,
320 .cable_detect = ata_cable_40wire,
322 .qc_prep = ata_qc_prep,
323 .qc_issue = ata_qc_issue_prot,
325 .data_xfer = ata_data_xfer,
327 .irq_handler = ata_interrupt,
328 .irq_clear = ata_bmdma_irq_clear,
329 .irq_on = ata_irq_on,
331 .port_start = ata_port_start,
335 * Port operations for DMA capable ALi without cable
338 static struct ata_port_operations ali_20_port_ops = {
339 .port_disable = ata_port_disable,
341 .set_piomode = ali_set_piomode,
342 .set_dmamode = ali_set_dmamode,
343 .mode_filter = ali_20_filter,
345 .tf_load = ata_tf_load,
346 .tf_read = ata_tf_read,
347 .check_status = ata_check_status,
348 .exec_command = ata_exec_command,
349 .dev_select = ata_std_dev_select,
350 .dev_config = ali_lock_sectors,
352 .freeze = ata_bmdma_freeze,
353 .thaw = ata_bmdma_thaw,
354 .error_handler = ata_bmdma_error_handler,
355 .post_internal_cmd = ata_bmdma_post_internal_cmd,
356 .cable_detect = ata_cable_40wire,
358 .bmdma_setup = ata_bmdma_setup,
359 .bmdma_start = ata_bmdma_start,
360 .bmdma_stop = ata_bmdma_stop,
361 .bmdma_status = ata_bmdma_status,
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_bmdma_irq_clear,
370 .irq_on = ata_irq_on,
372 .port_start = ata_port_start,
376 * Port operations for DMA capable ALi with cable detect
378 static struct ata_port_operations ali_c2_port_ops = {
379 .port_disable = ata_port_disable,
380 .set_piomode = ali_set_piomode,
381 .set_dmamode = ali_set_dmamode,
382 .mode_filter = ata_pci_default_filter,
383 .tf_load = ata_tf_load,
384 .tf_read = ata_tf_read,
385 .check_status = ata_check_status,
386 .exec_command = ata_exec_command,
387 .dev_select = ata_std_dev_select,
388 .dev_config = ali_lock_sectors,
390 .freeze = ata_bmdma_freeze,
391 .thaw = ata_bmdma_thaw,
392 .error_handler = ata_bmdma_error_handler,
393 .post_internal_cmd = ata_bmdma_post_internal_cmd,
394 .cable_detect = ali_c2_cable_detect,
396 .bmdma_setup = ata_bmdma_setup,
397 .bmdma_start = ata_bmdma_start,
398 .bmdma_stop = ata_bmdma_stop,
399 .bmdma_status = ata_bmdma_status,
401 .qc_prep = ata_qc_prep,
402 .qc_issue = ata_qc_issue_prot,
404 .data_xfer = ata_data_xfer,
406 .irq_handler = ata_interrupt,
407 .irq_clear = ata_bmdma_irq_clear,
408 .irq_on = ata_irq_on,
410 .port_start = ata_port_start,
414 * Port operations for DMA capable ALi with cable detect and LBA48
416 static struct ata_port_operations ali_c5_port_ops = {
417 .port_disable = ata_port_disable,
418 .set_piomode = ali_set_piomode,
419 .set_dmamode = ali_set_dmamode,
420 .mode_filter = ata_pci_default_filter,
421 .tf_load = ata_tf_load,
422 .tf_read = ata_tf_read,
423 .check_status = ata_check_status,
424 .exec_command = ata_exec_command,
425 .dev_select = ata_std_dev_select,
427 .freeze = ata_bmdma_freeze,
428 .thaw = ata_bmdma_thaw,
429 .error_handler = ata_bmdma_error_handler,
430 .post_internal_cmd = ata_bmdma_post_internal_cmd,
431 .cable_detect = ali_c2_cable_detect,
433 .bmdma_setup = ata_bmdma_setup,
434 .bmdma_start = ata_bmdma_start,
435 .bmdma_stop = ata_bmdma_stop,
436 .bmdma_status = ata_bmdma_status,
438 .qc_prep = ata_qc_prep,
439 .qc_issue = ata_qc_issue_prot,
441 .data_xfer = ata_data_xfer,
443 .irq_handler = ata_interrupt,
444 .irq_clear = ata_bmdma_irq_clear,
445 .irq_on = ata_irq_on,
447 .port_start = ata_port_start,
452 * ali_init_chipset - chip setup function
453 * @pdev: PCI device of ATA controller
455 * Perform the setup on the device that must be done both at boot
456 * and at resume time.
459 static void ali_init_chipset(struct pci_dev *pdev)
462 struct pci_dev *north, *isa_bridge;
465 * The chipset revision selects the driver operations and
469 if (pdev->revision >= 0x20 && pdev->revision < 0xC2) {
470 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
471 pci_read_config_byte(pdev, 0x4B, &tmp);
472 /* Clear CD-ROM DMA write bit */
474 pci_write_config_byte(pdev, 0x4B, tmp);
475 } else if (pdev->revision >= 0xC2) {
476 /* Enable cable detection logic */
477 pci_read_config_byte(pdev, 0x4B, &tmp);
478 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
480 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
481 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
483 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
484 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
485 Set the south bridge enable bit */
486 pci_read_config_byte(isa_bridge, 0x79, &tmp);
487 if (pdev->revision == 0xC2)
488 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
489 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
490 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
492 if (pdev->revision >= 0x20) {
494 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
495 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
498 pci_read_config_byte(pdev, 0x53, &tmp);
499 if (pdev->revision <= 0x20)
501 if (pdev->revision >= 0xc7)
504 tmp |= 0x01; /* CD_ROM enable for DMA */
505 pci_write_config_byte(pdev, 0x53, tmp);
507 pci_dev_put(isa_bridge);
509 ata_pci_clear_simplex(pdev);
512 * ali_init_one - discovery callback
513 * @pdev: PCI device ID
514 * @id: PCI table info
516 * An ALi IDE interface has been discovered. Figure out what revision
517 * and perform configuration work before handing it to the ATA layer
520 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
522 static const struct ata_port_info info_early = {
524 .flags = ATA_FLAG_SLAVE_POSS,
526 .port_ops = &ali_early_port_ops
528 /* Revision 0x20 added DMA */
529 static const struct ata_port_info info_20 = {
531 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
534 .port_ops = &ali_20_port_ops
536 /* Revision 0x20 with support logic added UDMA */
537 static const struct ata_port_info info_20_udma = {
539 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
542 .udma_mask = 0x07, /* UDMA33 */
543 .port_ops = &ali_20_port_ops
545 /* Revision 0xC2 adds UDMA66 */
546 static const struct ata_port_info info_c2 = {
548 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
551 .udma_mask = ATA_UDMA4,
552 .port_ops = &ali_c2_port_ops
554 /* Revision 0xC3 is UDMA66 for now */
555 static const struct ata_port_info info_c3 = {
557 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
560 .udma_mask = ATA_UDMA4,
561 .port_ops = &ali_c2_port_ops
563 /* Revision 0xC4 is UDMA100 */
564 static const struct ata_port_info info_c4 = {
566 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
569 .udma_mask = ATA_UDMA5,
570 .port_ops = &ali_c2_port_ops
572 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
573 static const struct ata_port_info info_c5 = {
575 .flags = ATA_FLAG_SLAVE_POSS,
578 .udma_mask = ATA_UDMA6,
579 .port_ops = &ali_c5_port_ops
582 const struct ata_port_info *ppi[] = { NULL, NULL };
584 struct pci_dev *isa_bridge;
587 * The chipset revision selects the driver operations and
591 if (pdev->revision < 0x20) {
592 ppi[0] = &info_early;
593 } else if (pdev->revision < 0xC2) {
595 } else if (pdev->revision == 0xC2) {
597 } else if (pdev->revision == 0xC3) {
599 } else if (pdev->revision == 0xC4) {
604 ali_init_chipset(pdev);
606 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
607 if (isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
608 /* Are we paired with a UDMA capable chip */
609 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
610 if ((tmp & 0x1E) == 0x12)
611 ppi[0] = &info_20_udma;
612 pci_dev_put(isa_bridge);
614 return ata_pci_init_one(pdev, ppi);
618 static int ali_reinit_one(struct pci_dev *pdev)
620 ali_init_chipset(pdev);
621 return ata_pci_device_resume(pdev);
625 static const struct pci_device_id ali[] = {
626 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
627 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
632 static struct pci_driver ali_pci_driver = {
635 .probe = ali_init_one,
636 .remove = ata_pci_remove_one,
638 .suspend = ata_pci_device_suspend,
639 .resume = ali_reinit_one,
643 static int __init ali_init(void)
645 return pci_register_driver(&ali_pci_driver);
649 static void __exit ali_exit(void)
651 pci_unregister_driver(&ali_pci_driver);
655 MODULE_AUTHOR("Alan Cox");
656 MODULE_DESCRIPTION("low-level driver for ALi PATA");
657 MODULE_LICENSE("GPL");
658 MODULE_DEVICE_TABLE(pci, ali);
659 MODULE_VERSION(DRV_VERSION);
661 module_init(ali_init);
662 module_exit(ali_exit);