2 * Libata driver for the highpoint 372N and 302N UDMA66 ATA controllers.
4 * This driver is heavily based upon:
6 * linux/drivers/ide/pci/hpt366.c Version 0.36 April 25, 2003
8 * Copyright (C) 1999-2003 Andre Hedrick <andre@linux-ide.org>
9 * Portions Copyright (C) 2001 Sun Microsystems, Inc.
10 * Portions Copyright (C) 2003 Red Hat Inc
15 * Work out best PLL policy
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/pci.h>
21 #include <linux/init.h>
22 #include <linux/blkdev.h>
23 #include <linux/delay.h>
24 #include <scsi/scsi_host.h>
25 #include <linux/libata.h>
27 #define DRV_NAME "pata_hpt3x2n"
28 #define DRV_VERSION "0.3.2"
31 HPT_PCI_FAST = (1 << 31),
43 struct hpt_clock *clocks[3];
46 /* key for bus clock timings
48 * 0:3 data_high_time. inactive time of DIOW_/DIOR_ for PIO and MW
49 * DMA. cycles = value + 1
50 * 4:8 data_low_time. active time of DIOW_/DIOR_ for PIO and MW
51 * DMA. cycles = value + 1
52 * 9:12 cmd_high_time. inactive time of DIOW_/DIOR_ during task file
54 * 13:17 cmd_low_time. active time of DIOW_/DIOR_ during task file
56 * 18:21 udma_cycle_time. clock freq and clock cycles for UDMA xfer.
57 * during task file register access.
58 * 22:24 pre_high_time. time to initialize 1st cycle for PIO and MW DMA
60 * 25:27 cmd_pre_high_time. time to initialize 1st PIO cycle for task
64 * 30 PIO_MST enable. if set, the chip is in bus master mode during
69 /* 66MHz DPLL clocks */
71 static struct hpt_clock hpt3x2n_clocks[] = {
72 { XFER_UDMA_7, 0x1c869c62 },
73 { XFER_UDMA_6, 0x1c869c62 },
74 { XFER_UDMA_5, 0x1c8a9c62 },
75 { XFER_UDMA_4, 0x1c8a9c62 },
76 { XFER_UDMA_3, 0x1c8e9c62 },
77 { XFER_UDMA_2, 0x1c929c62 },
78 { XFER_UDMA_1, 0x1c9a9c62 },
79 { XFER_UDMA_0, 0x1c829c62 },
81 { XFER_MW_DMA_2, 0x2c829c62 },
82 { XFER_MW_DMA_1, 0x2c829c66 },
83 { XFER_MW_DMA_0, 0x2c829d2c },
85 { XFER_PIO_4, 0x0c829c62 },
86 { XFER_PIO_3, 0x0c829c84 },
87 { XFER_PIO_2, 0x0c829ca6 },
88 { XFER_PIO_1, 0x0d029d26 },
89 { XFER_PIO_0, 0x0d029d5e },
94 * hpt3x2n_find_mode - reset the hpt3x2n bus
96 * @speed: transfer mode
98 * Return the 32bit register programming information for this channel
99 * that matches the speed provided. For the moment the clocks table
100 * is hard coded but easy to change. This will be needed if we use
104 static u32 hpt3x2n_find_mode(struct ata_port *ap, int speed)
106 struct hpt_clock *clocks = hpt3x2n_clocks;
108 while(clocks->xfer_speed) {
109 if (clocks->xfer_speed == speed)
110 return clocks->timing;
114 return 0xffffffffU; /* silence compiler warning */
118 * hpt3x2n_pre_reset - reset the hpt3x2n bus
119 * @ap: ATA port to reset
121 * Perform the initial reset handling for the 3x2n series controllers.
122 * Reset the hardware and state machine, obtain the cable type.
125 static int hpt3xn_pre_reset(struct ata_port *ap)
128 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
130 pci_read_config_byte(pdev, 0x5B, &scr2);
131 pci_write_config_byte(pdev, 0x5B, scr2 & ~0x01);
132 /* Cable register now active */
133 pci_read_config_byte(pdev, 0x5A, &ata66);
135 pci_write_config_byte(pdev, 0x5B, scr2);
137 if (ata66 & (1 << ap->port_no))
138 ap->cbl = ATA_CBL_PATA40;
140 ap->cbl = ATA_CBL_PATA80;
142 /* Reset the state machine */
143 pci_write_config_byte(pdev, 0x50, 0x37);
144 pci_write_config_byte(pdev, 0x54, 0x37);
147 return ata_std_prereset(ap);
151 * hpt3x2n_error_handler - probe the hpt3x2n bus
152 * @ap: ATA port to reset
154 * Perform the probe reset handling for the 3x2N
157 static void hpt3x2n_error_handler(struct ata_port *ap)
159 ata_bmdma_drive_eh(ap, hpt3xn_pre_reset, ata_std_softreset, NULL, ata_std_postreset);
163 * hpt3x2n_set_piomode - PIO setup
165 * @adev: device on the interface
167 * Perform PIO mode setup.
170 static void hpt3x2n_set_piomode(struct ata_port *ap, struct ata_device *adev)
172 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
178 addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
179 addr2 = 0x51 + 4 * ap->port_no;
181 /* Fast interrupt prediction disable, hold off interrupt disable */
182 pci_read_config_byte(pdev, addr2, &fast);
184 pci_write_config_byte(pdev, addr2, fast);
186 pci_read_config_dword(pdev, addr1, ®);
187 mode = hpt3x2n_find_mode(ap, adev->pio_mode);
188 mode &= ~0x8000000; /* No FIFO in PIO */
189 mode &= ~0x30070000; /* Leave config bits alone */
190 reg &= 0x30070000; /* Strip timing bits */
191 pci_write_config_dword(pdev, addr1, reg | mode);
195 * hpt3x2n_set_dmamode - DMA timing setup
197 * @adev: Device being configured
199 * Set up the channel for MWDMA or UDMA modes. Much the same as with
200 * PIO, load the mode number and then set MWDMA or UDMA flag.
203 static void hpt3x2n_set_dmamode(struct ata_port *ap, struct ata_device *adev)
205 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
211 addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
212 addr2 = 0x51 + 4 * ap->port_no;
214 /* Fast interrupt prediction disable, hold off interrupt disable */
215 pci_read_config_byte(pdev, addr2, &fast);
217 pci_write_config_byte(pdev, addr2, fast);
219 pci_read_config_dword(pdev, addr1, ®);
220 mode = hpt3x2n_find_mode(ap, adev->dma_mode);
221 mode |= 0x8000000; /* FIFO in MWDMA or UDMA */
222 mode &= ~0xC0000000; /* Leave config bits alone */
223 reg &= 0xC0000000; /* Strip timing bits */
224 pci_write_config_dword(pdev, addr1, reg | mode);
228 * hpt3x2n_bmdma_end - DMA engine stop
231 * Clean up after the HPT3x2n and later DMA engine
234 static void hpt3x2n_bmdma_stop(struct ata_queued_cmd *qc)
236 struct ata_port *ap = qc->ap;
237 struct pci_dev *pdev = to_pci_dev(ap->host->dev);
238 int mscreg = 0x50 + 2 * ap->port_no;
239 u8 bwsr_stat, msc_stat;
241 pci_read_config_byte(pdev, 0x6A, &bwsr_stat);
242 pci_read_config_byte(pdev, mscreg, &msc_stat);
243 if (bwsr_stat & (1 << ap->port_no))
244 pci_write_config_byte(pdev, mscreg, msc_stat | 0x30);
249 * hpt3x2n_set_clock - clock control
251 * @source: 0x21 or 0x23 for PLL or PCI sourced clock
253 * Switch the ATA bus clock between the PLL and PCI clock sources
254 * while correctly isolating the bus and resetting internal logic
256 * We must use the DPLL for
258 * - second channel UDMA7 (SATA ports) or higher
261 * or we will underclock the device and get reduced performance.
264 static void hpt3x2n_set_clock(struct ata_port *ap, int source)
266 void __iomem *bmdma = ap->ioaddr.bmdma_addr;
268 /* Tristate the bus */
269 iowrite8(0x80, bmdma+0x73);
270 iowrite8(0x80, bmdma+0x77);
272 /* Switch clock and reset channels */
273 iowrite8(source, bmdma+0x7B);
274 iowrite8(0xC0, bmdma+0x79);
276 /* Reset state machines */
277 iowrite8(0x37, bmdma+0x70);
278 iowrite8(0x37, bmdma+0x74);
281 iowrite8(0x00, bmdma+0x79);
283 /* Reconnect channels to bus */
284 iowrite8(0x00, bmdma+0x73);
285 iowrite8(0x00, bmdma+0x77);
288 /* Check if our partner interface is busy */
290 static int hpt3x2n_pair_idle(struct ata_port *ap)
292 struct ata_host *host = ap->host;
293 struct ata_port *pair = host->ports[ap->port_no ^ 1];
295 if (pair->hsm_task_state == HSM_ST_IDLE)
300 static int hpt3x2n_use_dpll(struct ata_port *ap, int writing)
302 long flags = (long)ap->host->private_data;
303 /* See if we should use the DPLL */
305 return USE_DPLL; /* Needed for write */
307 return USE_DPLL; /* Needed at 66Mhz */
311 static unsigned int hpt3x2n_qc_issue_prot(struct ata_queued_cmd *qc)
313 struct ata_taskfile *tf = &qc->tf;
314 struct ata_port *ap = qc->ap;
315 int flags = (long)ap->host->private_data;
317 if (hpt3x2n_pair_idle(ap)) {
318 int dpll = hpt3x2n_use_dpll(ap, (tf->flags & ATA_TFLAG_WRITE));
319 if ((flags & USE_DPLL) != dpll) {
321 hpt3x2n_set_clock(ap, 0x21);
323 hpt3x2n_set_clock(ap, 0x23);
326 return ata_qc_issue_prot(qc);
329 static struct scsi_host_template hpt3x2n_sht = {
330 .module = THIS_MODULE,
332 .ioctl = ata_scsi_ioctl,
333 .queuecommand = ata_scsi_queuecmd,
334 .can_queue = ATA_DEF_QUEUE,
335 .this_id = ATA_SHT_THIS_ID,
336 .sg_tablesize = LIBATA_MAX_PRD,
337 .cmd_per_lun = ATA_SHT_CMD_PER_LUN,
338 .emulated = ATA_SHT_EMULATED,
339 .use_clustering = ATA_SHT_USE_CLUSTERING,
340 .proc_name = DRV_NAME,
341 .dma_boundary = ATA_DMA_BOUNDARY,
342 .slave_configure = ata_scsi_slave_config,
343 .slave_destroy = ata_scsi_slave_destroy,
344 .bios_param = ata_std_bios_param,
348 * Configuration for HPT3x2n.
351 static struct ata_port_operations hpt3x2n_port_ops = {
352 .port_disable = ata_port_disable,
353 .set_piomode = hpt3x2n_set_piomode,
354 .set_dmamode = hpt3x2n_set_dmamode,
355 .mode_filter = ata_pci_default_filter,
357 .tf_load = ata_tf_load,
358 .tf_read = ata_tf_read,
359 .check_status = ata_check_status,
360 .exec_command = ata_exec_command,
361 .dev_select = ata_std_dev_select,
363 .freeze = ata_bmdma_freeze,
364 .thaw = ata_bmdma_thaw,
365 .error_handler = hpt3x2n_error_handler,
366 .post_internal_cmd = ata_bmdma_post_internal_cmd,
368 .bmdma_setup = ata_bmdma_setup,
369 .bmdma_start = ata_bmdma_start,
370 .bmdma_stop = hpt3x2n_bmdma_stop,
371 .bmdma_status = ata_bmdma_status,
373 .qc_prep = ata_qc_prep,
374 .qc_issue = hpt3x2n_qc_issue_prot,
376 .data_xfer = ata_data_xfer,
378 .irq_handler = ata_interrupt,
379 .irq_clear = ata_bmdma_irq_clear,
380 .irq_on = ata_irq_on,
381 .irq_ack = ata_irq_ack,
383 .port_start = ata_port_start,
387 * hpt3xn_calibrate_dpll - Calibrate the DPLL loop
390 * Perform a calibration cycle on the HPT3xN DPLL. Returns 1 if this
394 static int hpt3xn_calibrate_dpll(struct pci_dev *dev)
400 for(tries = 0; tries < 0x5000; tries++) {
402 pci_read_config_byte(dev, 0x5b, ®5b);
404 /* See if it stays set */
405 for(tries = 0; tries < 0x1000; tries ++) {
406 pci_read_config_byte(dev, 0x5b, ®5b);
408 if ((reg5b & 0x80) == 0)
411 /* Turn off tuning, we have the DPLL set */
412 pci_read_config_dword(dev, 0x5c, ®5c);
413 pci_write_config_dword(dev, 0x5c, reg5c & ~ 0x100);
417 /* Never went stable */
421 static int hpt3x2n_pci_clock(struct pci_dev *pdev)
426 pci_read_config_dword(pdev, 0x70/*CHECKME*/, &fcnt);
427 if ((fcnt >> 12) != 0xABCDE) {
428 printk(KERN_WARNING "hpt3xn: BIOS clock data not set.\n");
429 return 33; /* Not BIOS set */
433 freq = (fcnt * 77) / 192;
446 * hpt3x2n_init_one - Initialise an HPT37X/302
448 * @id: Entry in match table
450 * Initialise an HPT3x2n device. There are some interesting complications
451 * here. Firstly the chip may report 366 and be one of several variants.
452 * Secondly all the timings depend on the clock for the chip which we must
455 * This is the known chip mappings. It may be missing a couple of later
458 * Chip version PCI Rev Notes
459 * HPT372 4 (HPT366) 5 Other driver
460 * HPT372N 4 (HPT366) 6 UDMA133
461 * HPT372 5 (HPT372) 1 Other driver
462 * HPT372N 5 (HPT372) 2 UDMA133
463 * HPT302 6 (HPT302) * Other driver
464 * HPT302N 6 (HPT302) > 1 UDMA133
465 * HPT371 7 (HPT371) * Other driver
466 * HPT371N 7 (HPT371) > 1 UDMA133
467 * HPT374 8 (HPT374) * Other driver
468 * HPT372N 9 (HPT372N) * UDMA133
470 * (1) UDMA133 support depends on the bus clock
472 * To pin down HPT371N
475 static int hpt3x2n_init_one(struct pci_dev *dev, const struct pci_device_id *id)
477 /* HPT372N and friends - UDMA133 */
478 static struct ata_port_info info = {
480 .flags = ATA_FLAG_SLAVE_POSS | ATA_FLAG_SRST,
484 .port_ops = &hpt3x2n_port_ops
486 struct ata_port_info *port_info[2];
487 struct ata_port_info *port = &info;
492 unsigned int pci_mhz;
493 unsigned int f_low, f_high;
496 pci_read_config_dword(dev, PCI_CLASS_REVISION, &class_rev);
499 switch(dev->device) {
500 case PCI_DEVICE_ID_TTI_HPT366:
504 case PCI_DEVICE_ID_TTI_HPT372:
505 /* 372N if rev >= 1*/
509 case PCI_DEVICE_ID_TTI_HPT302:
513 case PCI_DEVICE_ID_TTI_HPT372N:
516 printk(KERN_ERR "pata_hpt3x2n: PCI table is bogus please report (%d).\n", dev->device);
520 /* Ok so this is a chip we support */
522 pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, (L1_CACHE_BYTES / 4));
523 pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x78);
524 pci_write_config_byte(dev, PCI_MIN_GNT, 0x08);
525 pci_write_config_byte(dev, PCI_MAX_LAT, 0x08);
527 pci_read_config_byte(dev, 0x5A, &irqmask);
529 pci_write_config_byte(dev, 0x5a, irqmask);
531 /* Tune the PLL. HPT recommend using 75 for SATA, 66 for UDMA133 or
532 50 for UDMA100. Right now we always use 66 */
534 pci_mhz = hpt3x2n_pci_clock(dev);
536 f_low = (pci_mhz * 48) / 66; /* PCI Mhz for 66Mhz DPLL */
537 f_high = f_low + 2; /* Tolerance */
539 pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low | 0x100);
541 pci_write_config_byte(dev, 0x5B, 0x21);
543 /* Unlike the 37x we don't try jiggling the frequency */
544 for(adjust = 0; adjust < 8; adjust++) {
545 if (hpt3xn_calibrate_dpll(dev))
547 pci_write_config_dword(dev, 0x5C, (f_high << 16) | f_low);
550 printk(KERN_WARNING "hpt3xn: DPLL did not stabilize.\n");
552 /* Set our private data up. We only need a few flags so we use
554 port->private_data = NULL;
556 port->private_data = (void *)PCI66;
558 /* Now kick off ATA set up */
559 port_info[0] = port_info[1] = port;
560 return ata_pci_init_one(dev, port_info, 2);
563 static const struct pci_device_id hpt3x2n[] = {
564 { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT366), },
565 { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT372), },
566 { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT302), },
567 { PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT372N), },
572 static struct pci_driver hpt3x2n_pci_driver = {
575 .probe = hpt3x2n_init_one,
576 .remove = ata_pci_remove_one
579 static int __init hpt3x2n_init(void)
581 return pci_register_driver(&hpt3x2n_pci_driver);
584 static void __exit hpt3x2n_exit(void)
586 pci_unregister_driver(&hpt3x2n_pci_driver);
589 MODULE_AUTHOR("Alan Cox");
590 MODULE_DESCRIPTION("low-level driver for the Highpoint HPT3x2n/30x");
591 MODULE_LICENSE("GPL");
592 MODULE_DEVICE_TABLE(pci, hpt3x2n);
593 MODULE_VERSION(DRV_VERSION);
595 module_init(hpt3x2n_init);
596 module_exit(hpt3x2n_exit);