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 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"),
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_20_filter - filter for earlier ALI DMA
95 * @adev: attached device
97 * Ensure that we do not do DMA on CD devices. We may be able to
98 * fix that later on. Also ensure we do not do UDMA on WDC drives
101 static unsigned long ali_20_filter(struct ata_device *adev, unsigned long mask)
103 char model_num[ATA_ID_PROD_LEN + 1];
104 /* No DMA on anything but a disk for now */
105 if (adev->class != ATA_DEV_ATA)
106 mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
107 ata_id_c_string(adev->id, model_num, ATA_ID_PROD, sizeof(model_num));
108 if (strstr(model_num, "WDC"))
109 return mask &= ~ATA_MASK_UDMA;
110 return ata_pci_default_filter(adev, mask);
114 * ali_fifo_control - FIFO manager
115 * @ap: ALi channel to control
116 * @adev: device for FIFO control
117 * @on: 0 for off 1 for on
119 * Enable or disable the FIFO on a given device. Because of the way the
120 * ALi FIFO works it provides a boost on ATA disk but can be confused by
121 * ATAPI and we must therefore manage it.
124 static void ali_fifo_control(struct ata_port *ap, struct ata_device *adev, int on)
126 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
127 int pio_fifo = 0x54 + ap->port_no;
129 int shift = 4 * adev->devno;
131 /* ATA - FIFO on set nibble to 0x05, ATAPI - FIFO off, set nibble to
132 0x00. Not all the docs agree but the behaviour we now use is the
133 one stated in the BIOS Programming Guide */
135 pci_read_config_byte(pdev, pio_fifo, &fifo);
136 fifo &= ~(0x0F << shift);
138 fifo |= (on << shift);
139 pci_write_config_byte(pdev, pio_fifo, fifo);
143 * ali_program_modes - load mode registers
144 * @ap: ALi channel to load
145 * @adev: Device the timing is for
146 * @cmd: Command timing
148 * @ultra: UDMA timing or zero for off
150 * Loads the timing registers for cmd/data and disable UDMA if
151 * ultra is zero. If ultra is set then load and enable the UDMA
152 * timing but do not touch the command/data timing.
155 static void ali_program_modes(struct ata_port *ap, struct ata_device *adev, struct ata_timing *t, u8 ultra)
157 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
158 int cas = 0x58 + 4 * ap->port_no; /* Command timing */
159 int cbt = 0x59 + 4 * ap->port_no; /* Command timing */
160 int drwt = 0x5A + 4 * ap->port_no + adev->devno; /* R/W timing */
161 int udmat = 0x56 + ap->port_no; /* UDMA timing */
162 int shift = 4 * adev->devno;
166 t->setup = FIT(t->setup, 1, 8) & 7;
167 t->act8b = FIT(t->act8b, 1, 8) & 7;
168 t->rec8b = FIT(t->rec8b, 1, 16) & 15;
169 t->active = FIT(t->active, 1, 8) & 7;
170 t->recover = FIT(t->recover, 1, 16) & 15;
172 pci_write_config_byte(pdev, cas, t->setup);
173 pci_write_config_byte(pdev, cbt, (t->act8b << 4) | t->rec8b);
174 pci_write_config_byte(pdev, drwt, (t->active << 4) | t->recover);
177 /* Set up the UDMA enable */
178 pci_read_config_byte(pdev, udmat, &udma);
179 udma &= ~(0x0F << shift);
180 udma |= ultra << shift;
181 pci_write_config_byte(pdev, udmat, udma);
185 * ali_set_piomode - set initial PIO mode data
189 * Program the ALi registers for PIO mode. FIXME: add timings for
193 static void ali_set_piomode(struct ata_port *ap, struct ata_device *adev)
195 struct ata_device *pair = ata_dev_pair(adev);
197 unsigned long T = 1000000000 / 33333; /* PCI clock based */
199 ata_timing_compute(adev, adev->pio_mode, &t, T, 1);
202 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
203 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
204 if (pair->dma_mode) {
205 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
206 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
210 /* PIO FIFO is only permitted on ATA disk */
211 if (adev->class != ATA_DEV_ATA)
212 ali_fifo_control(ap, adev, 0x00);
213 ali_program_modes(ap, adev, &t, 0);
214 if (adev->class == ATA_DEV_ATA)
215 ali_fifo_control(ap, adev, 0x05);
220 * ali_set_dmamode - set initial DMA mode data
224 * FIXME: MWDMA timings
227 static void ali_set_dmamode(struct ata_port *ap, struct ata_device *adev)
229 static u8 udma_timing[7] = { 0xC, 0xB, 0xA, 0x9, 0x8, 0xF, 0xD };
230 struct ata_device *pair = ata_dev_pair(adev);
232 unsigned long T = 1000000000 / 33333; /* PCI clock based */
233 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
236 if (adev->class == ATA_DEV_ATA)
237 ali_fifo_control(ap, adev, 0x08);
239 if (adev->dma_mode >= XFER_UDMA_0) {
240 ali_program_modes(ap, adev, NULL, udma_timing[adev->dma_mode - XFER_UDMA_0]);
241 if (adev->dma_mode >= XFER_UDMA_3) {
243 pci_read_config_byte(pdev, 0x4B, ®4b);
245 pci_write_config_byte(pdev, 0x4B, reg4b);
248 ata_timing_compute(adev, adev->dma_mode, &t, T, 1);
251 ata_timing_compute(pair, pair->pio_mode, &p, T, 1);
252 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
253 if (pair->dma_mode) {
254 ata_timing_compute(pair, pair->dma_mode, &p, T, 1);
255 ata_timing_merge(&p, &t, &t, ATA_TIMING_SETUP|ATA_TIMING_8BIT);
258 ali_program_modes(ap, adev, &t, 0);
263 * ali_lock_sectors - Keep older devices to 255 sector mode
266 * Called during the bus probe for each device that is found. We use
267 * this call to lock the sector count of the device to 255 or less on
268 * older ALi controllers. If we didn't do this then large I/O's would
269 * require LBA48 commands which the older ALi requires are issued by
273 static void ali_lock_sectors(struct ata_device *adev)
275 adev->max_sectors = 255;
278 static struct scsi_host_template ali_sht = {
279 .module = THIS_MODULE,
281 .ioctl = ata_scsi_ioctl,
282 .queuecommand = ata_scsi_queuecmd,
283 .can_queue = ATA_DEF_QUEUE,
284 .this_id = ATA_SHT_THIS_ID,
285 .sg_tablesize = LIBATA_MAX_PRD,
286 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
287 .emulated = ATA_SHT_EMULATED,
288 .use_clustering = ATA_SHT_USE_CLUSTERING,
289 .proc_name = DRV_NAME,
290 .dma_boundary = ATA_DMA_BOUNDARY,
291 .slave_configure = ata_scsi_slave_config,
292 .slave_destroy = ata_scsi_slave_destroy,
293 .bios_param = ata_std_bios_param,
297 * Port operations for PIO only ALi
300 static struct ata_port_operations ali_early_port_ops = {
301 .port_disable = ata_port_disable,
302 .set_piomode = ali_set_piomode,
303 .tf_load = ata_tf_load,
304 .tf_read = ata_tf_read,
305 .check_status = ata_check_status,
306 .exec_command = ata_exec_command,
307 .dev_select = ata_std_dev_select,
309 .freeze = ata_bmdma_freeze,
310 .thaw = ata_bmdma_thaw,
311 .error_handler = ata_bmdma_error_handler,
312 .post_internal_cmd = ata_bmdma_post_internal_cmd,
313 .cable_detect = ata_cable_40wire,
315 .qc_prep = ata_qc_prep,
316 .qc_issue = ata_qc_issue_prot,
318 .data_xfer = ata_data_xfer,
320 .irq_handler = ata_interrupt,
321 .irq_clear = ata_bmdma_irq_clear,
322 .irq_on = ata_irq_on,
323 .irq_ack = ata_irq_ack,
325 .port_start = ata_port_start,
329 * Port operations for DMA capable ALi without cable
332 static struct ata_port_operations ali_20_port_ops = {
333 .port_disable = ata_port_disable,
335 .set_piomode = ali_set_piomode,
336 .set_dmamode = ali_set_dmamode,
337 .mode_filter = ali_20_filter,
339 .tf_load = ata_tf_load,
340 .tf_read = ata_tf_read,
341 .check_status = ata_check_status,
342 .exec_command = ata_exec_command,
343 .dev_select = ata_std_dev_select,
344 .dev_config = ali_lock_sectors,
346 .freeze = ata_bmdma_freeze,
347 .thaw = ata_bmdma_thaw,
348 .error_handler = ata_bmdma_error_handler,
349 .post_internal_cmd = ata_bmdma_post_internal_cmd,
350 .cable_detect = ata_cable_40wire,
352 .bmdma_setup = ata_bmdma_setup,
353 .bmdma_start = ata_bmdma_start,
354 .bmdma_stop = ata_bmdma_stop,
355 .bmdma_status = ata_bmdma_status,
357 .qc_prep = ata_qc_prep,
358 .qc_issue = ata_qc_issue_prot,
360 .data_xfer = ata_data_xfer,
362 .irq_handler = ata_interrupt,
363 .irq_clear = ata_bmdma_irq_clear,
364 .irq_on = ata_irq_on,
365 .irq_ack = ata_irq_ack,
367 .port_start = ata_port_start,
371 * Port operations for DMA capable ALi with cable detect
373 static struct ata_port_operations ali_c2_port_ops = {
374 .port_disable = ata_port_disable,
375 .set_piomode = ali_set_piomode,
376 .set_dmamode = ali_set_dmamode,
377 .mode_filter = ata_pci_default_filter,
378 .tf_load = ata_tf_load,
379 .tf_read = ata_tf_read,
380 .check_status = ata_check_status,
381 .exec_command = ata_exec_command,
382 .dev_select = ata_std_dev_select,
383 .dev_config = ali_lock_sectors,
385 .freeze = ata_bmdma_freeze,
386 .thaw = ata_bmdma_thaw,
387 .error_handler = ata_bmdma_error_handler,
388 .post_internal_cmd = ata_bmdma_post_internal_cmd,
389 .cable_detect = ali_c2_cable_detect,
391 .bmdma_setup = ata_bmdma_setup,
392 .bmdma_start = ata_bmdma_start,
393 .bmdma_stop = ata_bmdma_stop,
394 .bmdma_status = ata_bmdma_status,
396 .qc_prep = ata_qc_prep,
397 .qc_issue = ata_qc_issue_prot,
399 .data_xfer = ata_data_xfer,
401 .irq_handler = ata_interrupt,
402 .irq_clear = ata_bmdma_irq_clear,
403 .irq_on = ata_irq_on,
404 .irq_ack = ata_irq_ack,
406 .port_start = ata_port_start,
410 * Port operations for DMA capable ALi with cable detect and LBA48
412 static struct ata_port_operations ali_c5_port_ops = {
413 .port_disable = ata_port_disable,
414 .set_piomode = ali_set_piomode,
415 .set_dmamode = ali_set_dmamode,
416 .mode_filter = ata_pci_default_filter,
417 .tf_load = ata_tf_load,
418 .tf_read = ata_tf_read,
419 .check_status = ata_check_status,
420 .exec_command = ata_exec_command,
421 .dev_select = ata_std_dev_select,
423 .freeze = ata_bmdma_freeze,
424 .thaw = ata_bmdma_thaw,
425 .error_handler = ata_bmdma_error_handler,
426 .post_internal_cmd = ata_bmdma_post_internal_cmd,
427 .cable_detect = ali_c2_cable_detect,
429 .bmdma_setup = ata_bmdma_setup,
430 .bmdma_start = ata_bmdma_start,
431 .bmdma_stop = ata_bmdma_stop,
432 .bmdma_status = ata_bmdma_status,
434 .qc_prep = ata_qc_prep,
435 .qc_issue = ata_qc_issue_prot,
437 .data_xfer = ata_data_xfer,
439 .irq_handler = ata_interrupt,
440 .irq_clear = ata_bmdma_irq_clear,
441 .irq_on = ata_irq_on,
442 .irq_ack = ata_irq_ack,
444 .port_start = ata_port_start,
449 * ali_init_chipset - chip setup function
450 * @pdev: PCI device of ATA controller
452 * Perform the setup on the device that must be done both at boot
453 * and at resume time.
456 static void ali_init_chipset(struct pci_dev *pdev)
459 struct pci_dev *north, *isa_bridge;
462 * The chipset revision selects the driver operations and
466 if (pdev->revision >= 0x20 && pdev->revision < 0xC2) {
467 /* 1543-E/F, 1543C-C, 1543C-D, 1543C-E */
468 pci_read_config_byte(pdev, 0x4B, &tmp);
469 /* Clear CD-ROM DMA write bit */
471 pci_write_config_byte(pdev, 0x4B, tmp);
472 } else if (pdev->revision >= 0xC2) {
473 /* Enable cable detection logic */
474 pci_read_config_byte(pdev, 0x4B, &tmp);
475 pci_write_config_byte(pdev, 0x4B, tmp | 0x08);
477 north = pci_get_bus_and_slot(0, PCI_DEVFN(0,0));
478 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
480 if (north && north->vendor == PCI_VENDOR_ID_AL && isa_bridge) {
481 /* Configure the ALi bridge logic. For non ALi rely on BIOS.
482 Set the south bridge enable bit */
483 pci_read_config_byte(isa_bridge, 0x79, &tmp);
484 if (pdev->revision == 0xC2)
485 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x04);
486 else if (pdev->revision > 0xC2 && pdev->revision < 0xC5)
487 pci_write_config_byte(isa_bridge, 0x79, tmp | 0x02);
489 if (pdev->revision >= 0x20) {
491 * CD_ROM DMA on (0x53 bit 0). Enable this even if we want
492 * to use PIO. 0x53 bit 1 (rev 20 only) - enable FIFO control
495 pci_read_config_byte(pdev, 0x53, &tmp);
496 if (pdev->revision <= 0x20)
498 if (pdev->revision >= 0xc7)
501 tmp |= 0x01; /* CD_ROM enable for DMA */
502 pci_write_config_byte(pdev, 0x53, tmp);
504 pci_dev_put(isa_bridge);
506 ata_pci_clear_simplex(pdev);
509 * ali_init_one - discovery callback
510 * @pdev: PCI device ID
511 * @id: PCI table info
513 * An ALi IDE interface has been discovered. Figure out what revision
514 * and perform configuration work before handing it to the ATA layer
517 static int ali_init_one(struct pci_dev *pdev, const struct pci_device_id *id)
519 static const struct ata_port_info info_early = {
521 .flags = ATA_FLAG_SLAVE_POSS,
523 .port_ops = &ali_early_port_ops
525 /* Revision 0x20 added DMA */
526 static const struct ata_port_info info_20 = {
528 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
531 .port_ops = &ali_20_port_ops
533 /* Revision 0x20 with support logic added UDMA */
534 static const struct ata_port_info info_20_udma = {
536 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
539 .udma_mask = 0x07, /* UDMA33 */
540 .port_ops = &ali_20_port_ops
542 /* Revision 0xC2 adds UDMA66 */
543 static const struct ata_port_info info_c2 = {
545 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
548 .udma_mask = ATA_UDMA4,
549 .port_ops = &ali_c2_port_ops
551 /* Revision 0xC3 is UDMA66 for now */
552 static const struct ata_port_info info_c3 = {
554 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
557 .udma_mask = ATA_UDMA4,
558 .port_ops = &ali_c2_port_ops
560 /* Revision 0xC4 is UDMA100 */
561 static const struct ata_port_info info_c4 = {
563 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_PIO_LBA48,
566 .udma_mask = ATA_UDMA5,
567 .port_ops = &ali_c2_port_ops
569 /* Revision 0xC5 is UDMA133 with LBA48 DMA */
570 static const struct ata_port_info info_c5 = {
572 .flags = ATA_FLAG_SLAVE_POSS,
575 .udma_mask = ATA_UDMA6,
576 .port_ops = &ali_c5_port_ops
579 const struct ata_port_info *ppi[] = { NULL, NULL };
581 struct pci_dev *isa_bridge;
584 * The chipset revision selects the driver operations and
588 if (pdev->revision < 0x20) {
589 ppi[0] = &info_early;
590 } else if (pdev->revision < 0xC2) {
592 } else if (pdev->revision == 0xC2) {
594 } else if (pdev->revision == 0xC3) {
596 } else if (pdev->revision == 0xC4) {
601 ali_init_chipset(pdev);
603 isa_bridge = pci_get_device(PCI_VENDOR_ID_AL, PCI_DEVICE_ID_AL_M1533, NULL);
604 if (isa_bridge && pdev->revision >= 0x20 && pdev->revision < 0xC2) {
605 /* Are we paired with a UDMA capable chip */
606 pci_read_config_byte(isa_bridge, 0x5E, &tmp);
607 if ((tmp & 0x1E) == 0x12)
608 ppi[0] = &info_20_udma;
609 pci_dev_put(isa_bridge);
611 return ata_pci_init_one(pdev, ppi);
615 static int ali_reinit_one(struct pci_dev *pdev)
617 ali_init_chipset(pdev);
618 return ata_pci_device_resume(pdev);
622 static const struct pci_device_id ali[] = {
623 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5228), },
624 { PCI_VDEVICE(AL, PCI_DEVICE_ID_AL_M5229), },
629 static struct pci_driver ali_pci_driver = {
632 .probe = ali_init_one,
633 .remove = ata_pci_remove_one,
635 .suspend = ata_pci_device_suspend,
636 .resume = ali_reinit_one,
640 static int __init ali_init(void)
642 return pci_register_driver(&ali_pci_driver);
646 static void __exit ali_exit(void)
648 pci_unregister_driver(&ali_pci_driver);
652 MODULE_AUTHOR("Alan Cox");
653 MODULE_DESCRIPTION("low-level driver for ALi PATA");
654 MODULE_LICENSE("GPL");
655 MODULE_DEVICE_TABLE(pci, ali);
656 MODULE_VERSION(DRV_VERSION);
658 module_init(ali_init);
659 module_exit(ali_exit);