xref: /openbmc/linux/drivers/ata/pata_hpt37x.c (revision 3d37ef41)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Libata driver for the highpoint 37x and 30x UDMA66 ATA controllers.
4  *
5  * This driver is heavily based upon:
6  *
7  * linux/drivers/ide/pci/hpt366.c		Version 0.36	April 25, 2003
8  *
9  * Copyright (C) 1999-2003		Andre Hedrick <andre@linux-ide.org>
10  * Portions Copyright (C) 2001	        Sun Microsystems, Inc.
11  * Portions Copyright (C) 2003		Red Hat Inc
12  * Portions Copyright (C) 2005-2010	MontaVista Software, Inc.
13  *
14  * TODO
15  *	Look into engine reset on timeout errors. Should not be	required.
16  */
17 
18 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
19 
20 #include <linux/kernel.h>
21 #include <linux/module.h>
22 #include <linux/pci.h>
23 #include <linux/blkdev.h>
24 #include <linux/delay.h>
25 #include <scsi/scsi_host.h>
26 #include <linux/libata.h>
27 
28 #define DRV_NAME	"pata_hpt37x"
29 #define DRV_VERSION	"0.6.23"
30 
31 struct hpt_clock {
32 	u8	xfer_speed;
33 	u32	timing;
34 };
35 
36 struct hpt_chip {
37 	const char *name;
38 	unsigned int base;
39 	struct hpt_clock const *clocks[4];
40 };
41 
42 /* key for bus clock timings
43  * bit
44  * 0:3    data_high_time. Inactive time of DIOW_/DIOR_ for PIO and MW DMA.
45  *        cycles = value + 1
46  * 4:8    data_low_time. Active time of DIOW_/DIOR_ for PIO and MW DMA.
47  *        cycles = value + 1
48  * 9:12   cmd_high_time. Inactive time of DIOW_/DIOR_ during task file
49  *        register access.
50  * 13:17  cmd_low_time. Active time of DIOW_/DIOR_ during task file
51  *        register access.
52  * 18:20  udma_cycle_time. Clock cycles for UDMA xfer.
53  * 21     CLK frequency for UDMA: 0=ATA clock, 1=dual ATA clock.
54  * 22:24  pre_high_time. Time to initialize 1st cycle for PIO and MW DMA xfer.
55  * 25:27  cmd_pre_high_time. Time to initialize 1st PIO cycle for task file
56  *        register access.
57  * 28     UDMA enable.
58  * 29     DMA  enable.
59  * 30     PIO_MST enable. If set, the chip is in bus master mode during
60  *        PIO xfer.
61  * 31     FIFO enable. Only for PIO.
62  */
63 
64 static struct hpt_clock hpt37x_timings_33[] = {
65 	{ XFER_UDMA_6,		0x12446231 },	/* 0x12646231 ?? */
66 	{ XFER_UDMA_5,		0x12446231 },
67 	{ XFER_UDMA_4,		0x12446231 },
68 	{ XFER_UDMA_3,		0x126c6231 },
69 	{ XFER_UDMA_2,		0x12486231 },
70 	{ XFER_UDMA_1,		0x124c6233 },
71 	{ XFER_UDMA_0,		0x12506297 },
72 
73 	{ XFER_MW_DMA_2,	0x22406c31 },
74 	{ XFER_MW_DMA_1,	0x22406c33 },
75 	{ XFER_MW_DMA_0,	0x22406c97 },
76 
77 	{ XFER_PIO_4,		0x06414e31 },
78 	{ XFER_PIO_3,		0x06414e42 },
79 	{ XFER_PIO_2,		0x06414e53 },
80 	{ XFER_PIO_1,		0x06814e93 },
81 	{ XFER_PIO_0,		0x06814ea7 }
82 };
83 
84 static struct hpt_clock hpt37x_timings_50[] = {
85 	{ XFER_UDMA_6,		0x12848242 },
86 	{ XFER_UDMA_5,		0x12848242 },
87 	{ XFER_UDMA_4,		0x12ac8242 },
88 	{ XFER_UDMA_3,		0x128c8242 },
89 	{ XFER_UDMA_2,		0x120c8242 },
90 	{ XFER_UDMA_1,		0x12148254 },
91 	{ XFER_UDMA_0,		0x121882ea },
92 
93 	{ XFER_MW_DMA_2,	0x22808242 },
94 	{ XFER_MW_DMA_1,	0x22808254 },
95 	{ XFER_MW_DMA_0,	0x228082ea },
96 
97 	{ XFER_PIO_4,		0x0a81f442 },
98 	{ XFER_PIO_3,		0x0a81f443 },
99 	{ XFER_PIO_2,		0x0a81f454 },
100 	{ XFER_PIO_1,		0x0ac1f465 },
101 	{ XFER_PIO_0,		0x0ac1f48a }
102 };
103 
104 static struct hpt_clock hpt37x_timings_66[] = {
105 	{ XFER_UDMA_6,		0x1c869c62 },
106 	{ XFER_UDMA_5,		0x1cae9c62 },	/* 0x1c8a9c62 */
107 	{ XFER_UDMA_4,		0x1c8a9c62 },
108 	{ XFER_UDMA_3,		0x1c8e9c62 },
109 	{ XFER_UDMA_2,		0x1c929c62 },
110 	{ XFER_UDMA_1,		0x1c9a9c62 },
111 	{ XFER_UDMA_0,		0x1c829c62 },
112 
113 	{ XFER_MW_DMA_2,	0x2c829c62 },
114 	{ XFER_MW_DMA_1,	0x2c829c66 },
115 	{ XFER_MW_DMA_0,	0x2c829d2e },
116 
117 	{ XFER_PIO_4,		0x0c829c62 },
118 	{ XFER_PIO_3,		0x0c829c84 },
119 	{ XFER_PIO_2,		0x0c829ca6 },
120 	{ XFER_PIO_1,		0x0d029d26 },
121 	{ XFER_PIO_0,		0x0d029d5e }
122 };
123 
124 
125 static const struct hpt_chip hpt370 = {
126 	"HPT370",
127 	48,
128 	{
129 		hpt37x_timings_33,
130 		NULL,
131 		NULL,
132 		NULL
133 	}
134 };
135 
136 static const struct hpt_chip hpt370a = {
137 	"HPT370A",
138 	48,
139 	{
140 		hpt37x_timings_33,
141 		NULL,
142 		hpt37x_timings_50,
143 		NULL
144 	}
145 };
146 
147 static const struct hpt_chip hpt372 = {
148 	"HPT372",
149 	55,
150 	{
151 		hpt37x_timings_33,
152 		NULL,
153 		hpt37x_timings_50,
154 		hpt37x_timings_66
155 	}
156 };
157 
158 static const struct hpt_chip hpt302 = {
159 	"HPT302",
160 	66,
161 	{
162 		hpt37x_timings_33,
163 		NULL,
164 		hpt37x_timings_50,
165 		hpt37x_timings_66
166 	}
167 };
168 
169 static const struct hpt_chip hpt371 = {
170 	"HPT371",
171 	66,
172 	{
173 		hpt37x_timings_33,
174 		NULL,
175 		hpt37x_timings_50,
176 		hpt37x_timings_66
177 	}
178 };
179 
180 static const struct hpt_chip hpt372a = {
181 	"HPT372A",
182 	66,
183 	{
184 		hpt37x_timings_33,
185 		NULL,
186 		hpt37x_timings_50,
187 		hpt37x_timings_66
188 	}
189 };
190 
191 static const struct hpt_chip hpt374 = {
192 	"HPT374",
193 	48,
194 	{
195 		hpt37x_timings_33,
196 		NULL,
197 		NULL,
198 		NULL
199 	}
200 };
201 
202 /**
203  *	hpt37x_find_mode	-	reset the hpt37x bus
204  *	@ap: ATA port
205  *	@speed: transfer mode
206  *
207  *	Return the 32bit register programming information for this channel
208  *	that matches the speed provided.
209  */
210 
211 static u32 hpt37x_find_mode(struct ata_port *ap, int speed)
212 {
213 	struct hpt_clock *clocks = ap->host->private_data;
214 
215 	while (clocks->xfer_speed) {
216 		if (clocks->xfer_speed == speed)
217 			return clocks->timing;
218 		clocks++;
219 	}
220 	BUG();
221 	return 0xffffffffU;	/* silence compiler warning */
222 }
223 
224 static int hpt_dma_blacklisted(const struct ata_device *dev, char *modestr,
225 			       const char * const list[])
226 {
227 	unsigned char model_num[ATA_ID_PROD_LEN + 1];
228 	int i;
229 
230 	ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
231 
232 	i = match_string(list, -1, model_num);
233 	if (i >= 0) {
234 		pr_warn("%s is not supported for %s\n", modestr, list[i]);
235 		return 1;
236 	}
237 	return 0;
238 }
239 
240 static const char * const bad_ata33[] = {
241 	"Maxtor 92720U8", "Maxtor 92040U6", "Maxtor 91360U4", "Maxtor 91020U3",
242 	"Maxtor 90845U3", "Maxtor 90650U2",
243 	"Maxtor 91360D8", "Maxtor 91190D7", "Maxtor 91020D6", "Maxtor 90845D5",
244 	"Maxtor 90680D4", "Maxtor 90510D3", "Maxtor 90340D2",
245 	"Maxtor 91152D8", "Maxtor 91008D7", "Maxtor 90845D6", "Maxtor 90840D6",
246 	"Maxtor 90720D5", "Maxtor 90648D5", "Maxtor 90576D4",
247 	"Maxtor 90510D4",
248 	"Maxtor 90432D3", "Maxtor 90288D2", "Maxtor 90256D2",
249 	"Maxtor 91000D8", "Maxtor 90910D8", "Maxtor 90875D7", "Maxtor 90840D7",
250 	"Maxtor 90750D6", "Maxtor 90625D5", "Maxtor 90500D4",
251 	"Maxtor 91728D8", "Maxtor 91512D7", "Maxtor 91303D6", "Maxtor 91080D5",
252 	"Maxtor 90845D4", "Maxtor 90680D4", "Maxtor 90648D3", "Maxtor 90432D2",
253 	NULL
254 };
255 
256 static const char * const bad_ata100_5[] = {
257 	"IBM-DTLA-307075",
258 	"IBM-DTLA-307060",
259 	"IBM-DTLA-307045",
260 	"IBM-DTLA-307030",
261 	"IBM-DTLA-307020",
262 	"IBM-DTLA-307015",
263 	"IBM-DTLA-305040",
264 	"IBM-DTLA-305030",
265 	"IBM-DTLA-305020",
266 	"IC35L010AVER07-0",
267 	"IC35L020AVER07-0",
268 	"IC35L030AVER07-0",
269 	"IC35L040AVER07-0",
270 	"IC35L060AVER07-0",
271 	"WDC AC310200R",
272 	NULL
273 };
274 
275 /**
276  *	hpt370_filter	-	mode selection filter
277  *	@adev: ATA device
278  *	@mask: mode mask
279  *
280  *	Block UDMA on devices that cause trouble with this controller.
281  */
282 
283 static unsigned long hpt370_filter(struct ata_device *adev, unsigned long mask)
284 {
285 	if (adev->class == ATA_DEV_ATA) {
286 		if (hpt_dma_blacklisted(adev, "UDMA", bad_ata33))
287 			mask &= ~ATA_MASK_UDMA;
288 		if (hpt_dma_blacklisted(adev, "UDMA100", bad_ata100_5))
289 			mask &= ~(0xE0 << ATA_SHIFT_UDMA);
290 	}
291 	return mask;
292 }
293 
294 /**
295  *	hpt370a_filter	-	mode selection filter
296  *	@adev: ATA device
297  *	@mask: mode mask
298  *
299  *	Block UDMA on devices that cause trouble with this controller.
300  */
301 
302 static unsigned long hpt370a_filter(struct ata_device *adev, unsigned long mask)
303 {
304 	if (adev->class == ATA_DEV_ATA) {
305 		if (hpt_dma_blacklisted(adev, "UDMA100", bad_ata100_5))
306 			mask &= ~(0xE0 << ATA_SHIFT_UDMA);
307 	}
308 	return mask;
309 }
310 
311 /**
312  *	hpt372_filter	-	mode selection filter
313  *	@adev: ATA device
314  *	@mask: mode mask
315  *
316  *	The Marvell bridge chips used on the HighPoint SATA cards do not seem
317  *	to support the UltraDMA modes 1, 2, and 3 as well as any MWDMA modes...
318  */
319 static unsigned long hpt372_filter(struct ata_device *adev, unsigned long mask)
320 {
321 	if (ata_id_is_sata(adev->id))
322 		mask &= ~((0xE << ATA_SHIFT_UDMA) | ATA_MASK_MWDMA);
323 
324 	return mask;
325 }
326 
327 /**
328  *	hpt37x_cable_detect	-	Detect the cable type
329  *	@ap: ATA port to detect on
330  *
331  *	Return the cable type attached to this port
332  */
333 
334 static int hpt37x_cable_detect(struct ata_port *ap)
335 {
336 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
337 	u8 scr2, ata66;
338 
339 	pci_read_config_byte(pdev, 0x5B, &scr2);
340 	pci_write_config_byte(pdev, 0x5B, scr2 & ~0x01);
341 
342 	udelay(10); /* debounce */
343 
344 	/* Cable register now active */
345 	pci_read_config_byte(pdev, 0x5A, &ata66);
346 	/* Restore state */
347 	pci_write_config_byte(pdev, 0x5B, scr2);
348 
349 	if (ata66 & (2 >> ap->port_no))
350 		return ATA_CBL_PATA40;
351 	else
352 		return ATA_CBL_PATA80;
353 }
354 
355 /**
356  *	hpt374_fn1_cable_detect	-	Detect the cable type
357  *	@ap: ATA port to detect on
358  *
359  *	Return the cable type attached to this port
360  */
361 
362 static int hpt374_fn1_cable_detect(struct ata_port *ap)
363 {
364 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
365 	unsigned int mcrbase = 0x50 + 4 * ap->port_no;
366 	u16 mcr3;
367 	u8 ata66;
368 
369 	/* Do the extra channel work */
370 	pci_read_config_word(pdev, mcrbase + 2, &mcr3);
371 	/* Set bit 15 of 0x52 to enable TCBLID as input */
372 	pci_write_config_word(pdev, mcrbase + 2, mcr3 | 0x8000);
373 	pci_read_config_byte(pdev, 0x5A, &ata66);
374 	/* Reset TCBLID/FCBLID to output */
375 	pci_write_config_word(pdev, mcrbase + 2, mcr3);
376 
377 	if (ata66 & (2 >> ap->port_no))
378 		return ATA_CBL_PATA40;
379 	else
380 		return ATA_CBL_PATA80;
381 }
382 
383 /**
384  *	hpt37x_pre_reset	-	reset the hpt37x bus
385  *	@link: ATA link to reset
386  *	@deadline: deadline jiffies for the operation
387  *
388  *	Perform the initial reset handling for the HPT37x.
389  */
390 
391 static int hpt37x_pre_reset(struct ata_link *link, unsigned long deadline)
392 {
393 	struct ata_port *ap = link->ap;
394 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
395 	static const struct pci_bits hpt37x_enable_bits[] = {
396 		{ 0x50, 1, 0x04, 0x04 },
397 		{ 0x54, 1, 0x04, 0x04 }
398 	};
399 
400 	if (!pci_test_config_bits(pdev, &hpt37x_enable_bits[ap->port_no]))
401 		return -ENOENT;
402 
403 	/* Reset the state machine */
404 	pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
405 	udelay(100);
406 
407 	return ata_sff_prereset(link, deadline);
408 }
409 
410 static void hpt370_set_mode(struct ata_port *ap, struct ata_device *adev,
411 			    u8 mode)
412 {
413 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
414 	u32 addr1, addr2;
415 	u32 reg, timing, mask;
416 	u8 fast;
417 
418 	addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
419 	addr2 = 0x51 + 4 * ap->port_no;
420 
421 	/* Fast interrupt prediction disable, hold off interrupt disable */
422 	pci_read_config_byte(pdev, addr2, &fast);
423 	fast &= ~0x02;
424 	fast |= 0x01;
425 	pci_write_config_byte(pdev, addr2, fast);
426 
427 	/* Determine timing mask and find matching mode entry */
428 	if (mode < XFER_MW_DMA_0)
429 		mask = 0xcfc3ffff;
430 	else if (mode < XFER_UDMA_0)
431 		mask = 0x31c001ff;
432 	else
433 		mask = 0x303c0000;
434 
435 	timing = hpt37x_find_mode(ap, mode);
436 
437 	pci_read_config_dword(pdev, addr1, &reg);
438 	reg = (reg & ~mask) | (timing & mask);
439 	pci_write_config_dword(pdev, addr1, reg);
440 }
441 /**
442  *	hpt370_set_piomode		-	PIO setup
443  *	@ap: ATA interface
444  *	@adev: device on the interface
445  *
446  *	Perform PIO mode setup.
447  */
448 
449 static void hpt370_set_piomode(struct ata_port *ap, struct ata_device *adev)
450 {
451 	hpt370_set_mode(ap, adev, adev->pio_mode);
452 }
453 
454 /**
455  *	hpt370_set_dmamode		-	DMA timing setup
456  *	@ap: ATA interface
457  *	@adev: Device being configured
458  *
459  *	Set up the channel for MWDMA or UDMA modes.
460  */
461 
462 static void hpt370_set_dmamode(struct ata_port *ap, struct ata_device *adev)
463 {
464 	hpt370_set_mode(ap, adev, adev->dma_mode);
465 }
466 
467 /**
468  *	hpt370_bmdma_stop		-	DMA engine stop
469  *	@qc: ATA command
470  *
471  *	Work around the HPT370 DMA engine.
472  */
473 
474 static void hpt370_bmdma_stop(struct ata_queued_cmd *qc)
475 {
476 	struct ata_port *ap = qc->ap;
477 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
478 	void __iomem *bmdma = ap->ioaddr.bmdma_addr;
479 	u8 dma_stat = ioread8(bmdma + ATA_DMA_STATUS);
480 	u8 dma_cmd;
481 
482 	if (dma_stat & ATA_DMA_ACTIVE) {
483 		udelay(20);
484 		dma_stat = ioread8(bmdma + ATA_DMA_STATUS);
485 	}
486 	if (dma_stat & ATA_DMA_ACTIVE) {
487 		/* Clear the engine */
488 		pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
489 		udelay(10);
490 		/* Stop DMA */
491 		dma_cmd = ioread8(bmdma + ATA_DMA_CMD);
492 		iowrite8(dma_cmd & ~ATA_DMA_START, bmdma + ATA_DMA_CMD);
493 		/* Clear Error */
494 		dma_stat = ioread8(bmdma + ATA_DMA_STATUS);
495 		iowrite8(dma_stat | ATA_DMA_INTR | ATA_DMA_ERR,
496 			 bmdma + ATA_DMA_STATUS);
497 		/* Clear the engine */
498 		pci_write_config_byte(pdev, 0x50 + 4 * ap->port_no, 0x37);
499 		udelay(10);
500 	}
501 	ata_bmdma_stop(qc);
502 }
503 
504 static void hpt372_set_mode(struct ata_port *ap, struct ata_device *adev,
505 			    u8 mode)
506 {
507 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
508 	u32 addr1, addr2;
509 	u32 reg, timing, mask;
510 	u8 fast;
511 
512 	addr1 = 0x40 + 4 * (adev->devno + 2 * ap->port_no);
513 	addr2 = 0x51 + 4 * ap->port_no;
514 
515 	/* Fast interrupt prediction disable, hold off interrupt disable */
516 	pci_read_config_byte(pdev, addr2, &fast);
517 	fast &= ~0x07;
518 	pci_write_config_byte(pdev, addr2, fast);
519 
520 	/* Determine timing mask and find matching mode entry */
521 	if (mode < XFER_MW_DMA_0)
522 		mask = 0xcfc3ffff;
523 	else if (mode < XFER_UDMA_0)
524 		mask = 0x31c001ff;
525 	else
526 		mask = 0x303c0000;
527 
528 	timing = hpt37x_find_mode(ap, mode);
529 
530 	pci_read_config_dword(pdev, addr1, &reg);
531 	reg = (reg & ~mask) | (timing & mask);
532 	pci_write_config_dword(pdev, addr1, reg);
533 }
534 
535 /**
536  *	hpt372_set_piomode		-	PIO setup
537  *	@ap: ATA interface
538  *	@adev: device on the interface
539  *
540  *	Perform PIO mode setup.
541  */
542 
543 static void hpt372_set_piomode(struct ata_port *ap, struct ata_device *adev)
544 {
545 	hpt372_set_mode(ap, adev, adev->pio_mode);
546 }
547 
548 /**
549  *	hpt372_set_dmamode		-	DMA timing setup
550  *	@ap: ATA interface
551  *	@adev: Device being configured
552  *
553  *	Set up the channel for MWDMA or UDMA modes.
554  */
555 
556 static void hpt372_set_dmamode(struct ata_port *ap, struct ata_device *adev)
557 {
558 	hpt372_set_mode(ap, adev, adev->dma_mode);
559 }
560 
561 /**
562  *	hpt37x_bmdma_stop		-	DMA engine stop
563  *	@qc: ATA command
564  *
565  *	Clean up after the HPT372 and later DMA engine
566  */
567 
568 static void hpt37x_bmdma_stop(struct ata_queued_cmd *qc)
569 {
570 	struct ata_port *ap = qc->ap;
571 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
572 	int mscreg = 0x50 + 4 * ap->port_no;
573 	u8 bwsr_stat, msc_stat;
574 
575 	pci_read_config_byte(pdev, 0x6A, &bwsr_stat);
576 	pci_read_config_byte(pdev, mscreg, &msc_stat);
577 	if (bwsr_stat & (1 << ap->port_no))
578 		pci_write_config_byte(pdev, mscreg, msc_stat | 0x30);
579 	ata_bmdma_stop(qc);
580 }
581 
582 
583 static struct scsi_host_template hpt37x_sht = {
584 	ATA_BMDMA_SHT(DRV_NAME),
585 };
586 
587 /*
588  *	Configuration for HPT370
589  */
590 
591 static struct ata_port_operations hpt370_port_ops = {
592 	.inherits	= &ata_bmdma_port_ops,
593 
594 	.bmdma_stop	= hpt370_bmdma_stop,
595 
596 	.mode_filter	= hpt370_filter,
597 	.cable_detect	= hpt37x_cable_detect,
598 	.set_piomode	= hpt370_set_piomode,
599 	.set_dmamode	= hpt370_set_dmamode,
600 	.prereset	= hpt37x_pre_reset,
601 };
602 
603 /*
604  *	Configuration for HPT370A. Close to 370 but less filters
605  */
606 
607 static struct ata_port_operations hpt370a_port_ops = {
608 	.inherits	= &hpt370_port_ops,
609 	.mode_filter	= hpt370a_filter,
610 };
611 
612 /*
613  *	Configuration for HPT371 and HPT302. Slightly different PIO and DMA
614  *	mode setting functionality.
615  */
616 
617 static struct ata_port_operations hpt302_port_ops = {
618 	.inherits	= &ata_bmdma_port_ops,
619 
620 	.bmdma_stop	= hpt37x_bmdma_stop,
621 
622 	.cable_detect	= hpt37x_cable_detect,
623 	.set_piomode	= hpt372_set_piomode,
624 	.set_dmamode	= hpt372_set_dmamode,
625 	.prereset	= hpt37x_pre_reset,
626 };
627 
628 /*
629  *	Configuration for HPT372. Mode setting works like 371 and 302
630  *	but we have a mode filter.
631  */
632 
633 static struct ata_port_operations hpt372_port_ops = {
634 	.inherits	= &hpt302_port_ops,
635 	.mode_filter	= hpt372_filter,
636 };
637 
638 /*
639  *	Configuration for HPT374. Mode setting and filtering works like 372
640  *	but we have a different cable detection procedure for function 1.
641  */
642 
643 static struct ata_port_operations hpt374_fn1_port_ops = {
644 	.inherits	= &hpt372_port_ops,
645 	.cable_detect	= hpt374_fn1_cable_detect,
646 };
647 
648 /**
649  *	hpt37x_clock_slot	-	Turn timing to PC clock entry
650  *	@freq: Reported frequency timing
651  *	@base: Base timing
652  *
653  *	Turn the timing data intoa clock slot (0 for 33, 1 for 40, 2 for 50
654  *	and 3 for 66Mhz)
655  */
656 
657 static int hpt37x_clock_slot(unsigned int freq, unsigned int base)
658 {
659 	unsigned int f = (base * freq) / 192;	/* Mhz */
660 	if (f < 40)
661 		return 0;	/* 33Mhz slot */
662 	if (f < 45)
663 		return 1;	/* 40Mhz slot */
664 	if (f < 55)
665 		return 2;	/* 50Mhz slot */
666 	return 3;		/* 60Mhz slot */
667 }
668 
669 /**
670  *	hpt37x_calibrate_dpll		-	Calibrate the DPLL loop
671  *	@dev: PCI device
672  *
673  *	Perform a calibration cycle on the HPT37x DPLL. Returns 1 if this
674  *	succeeds
675  */
676 
677 static int hpt37x_calibrate_dpll(struct pci_dev *dev)
678 {
679 	u8 reg5b;
680 	u32 reg5c;
681 	int tries;
682 
683 	for (tries = 0; tries < 0x5000; tries++) {
684 		udelay(50);
685 		pci_read_config_byte(dev, 0x5b, &reg5b);
686 		if (reg5b & 0x80) {
687 			/* See if it stays set */
688 			for (tries = 0; tries < 0x1000; tries++) {
689 				pci_read_config_byte(dev, 0x5b, &reg5b);
690 				/* Failed ? */
691 				if ((reg5b & 0x80) == 0)
692 					return 0;
693 			}
694 			/* Turn off tuning, we have the DPLL set */
695 			pci_read_config_dword(dev, 0x5c, &reg5c);
696 			pci_write_config_dword(dev, 0x5c, reg5c & ~0x100);
697 			return 1;
698 		}
699 	}
700 	/* Never went stable */
701 	return 0;
702 }
703 
704 static u32 hpt374_read_freq(struct pci_dev *pdev)
705 {
706 	u32 freq;
707 	unsigned long io_base = pci_resource_start(pdev, 4);
708 
709 	if (PCI_FUNC(pdev->devfn) & 1) {
710 		struct pci_dev *pdev_0;
711 
712 		pdev_0 = pci_get_slot(pdev->bus, pdev->devfn - 1);
713 		/* Someone hot plugged the controller on us ? */
714 		if (pdev_0 == NULL)
715 			return 0;
716 		io_base = pci_resource_start(pdev_0, 4);
717 		freq = inl(io_base + 0x90);
718 		pci_dev_put(pdev_0);
719 	} else
720 		freq = inl(io_base + 0x90);
721 	return freq;
722 }
723 
724 /**
725  *	hpt37x_init_one		-	Initialise an HPT37X/302
726  *	@dev: PCI device
727  *	@id: Entry in match table
728  *
729  *	Initialise an HPT37x device. There are some interesting complications
730  *	here. Firstly the chip may report 366 and be one of several variants.
731  *	Secondly all the timings depend on the clock for the chip which we must
732  *	detect and look up
733  *
734  *	This is the known chip mappings. It may be missing a couple of later
735  *	releases.
736  *
737  *	Chip version		PCI		Rev	Notes
738  *	HPT366			4 (HPT366)	0	Other driver
739  *	HPT366			4 (HPT366)	1	Other driver
740  *	HPT368			4 (HPT366)	2	Other driver
741  *	HPT370			4 (HPT366)	3	UDMA100
742  *	HPT370A			4 (HPT366)	4	UDMA100
743  *	HPT372			4 (HPT366)	5	UDMA133 (1)
744  *	HPT372N			4 (HPT366)	6	Other driver
745  *	HPT372A			5 (HPT372)	1	UDMA133 (1)
746  *	HPT372N			5 (HPT372)	2	Other driver
747  *	HPT302			6 (HPT302)	1	UDMA133
748  *	HPT302N			6 (HPT302)	2	Other driver
749  *	HPT371			7 (HPT371)	*	UDMA133
750  *	HPT374			8 (HPT374)	*	UDMA133 4 channel
751  *	HPT372N			9 (HPT372N)	*	Other driver
752  *
753  *	(1) UDMA133 support depends on the bus clock
754  */
755 
756 static int hpt37x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
757 {
758 	/* HPT370 - UDMA100 */
759 	static const struct ata_port_info info_hpt370 = {
760 		.flags = ATA_FLAG_SLAVE_POSS,
761 		.pio_mask = ATA_PIO4,
762 		.mwdma_mask = ATA_MWDMA2,
763 		.udma_mask = ATA_UDMA5,
764 		.port_ops = &hpt370_port_ops
765 	};
766 	/* HPT370A - UDMA100 */
767 	static const struct ata_port_info info_hpt370a = {
768 		.flags = ATA_FLAG_SLAVE_POSS,
769 		.pio_mask = ATA_PIO4,
770 		.mwdma_mask = ATA_MWDMA2,
771 		.udma_mask = ATA_UDMA5,
772 		.port_ops = &hpt370a_port_ops
773 	};
774 	/* HPT370 - UDMA66 */
775 	static const struct ata_port_info info_hpt370_33 = {
776 		.flags = ATA_FLAG_SLAVE_POSS,
777 		.pio_mask = ATA_PIO4,
778 		.mwdma_mask = ATA_MWDMA2,
779 		.udma_mask = ATA_UDMA4,
780 		.port_ops = &hpt370_port_ops
781 	};
782 	/* HPT370A - UDMA66 */
783 	static const struct ata_port_info info_hpt370a_33 = {
784 		.flags = ATA_FLAG_SLAVE_POSS,
785 		.pio_mask = ATA_PIO4,
786 		.mwdma_mask = ATA_MWDMA2,
787 		.udma_mask = ATA_UDMA4,
788 		.port_ops = &hpt370a_port_ops
789 	};
790 	/* HPT372 - UDMA133 */
791 	static const struct ata_port_info info_hpt372 = {
792 		.flags = ATA_FLAG_SLAVE_POSS,
793 		.pio_mask = ATA_PIO4,
794 		.mwdma_mask = ATA_MWDMA2,
795 		.udma_mask = ATA_UDMA6,
796 		.port_ops = &hpt372_port_ops
797 	};
798 	/* HPT371, 302 - UDMA133 */
799 	static const struct ata_port_info info_hpt302 = {
800 		.flags = ATA_FLAG_SLAVE_POSS,
801 		.pio_mask = ATA_PIO4,
802 		.mwdma_mask = ATA_MWDMA2,
803 		.udma_mask = ATA_UDMA6,
804 		.port_ops = &hpt302_port_ops
805 	};
806 	/* HPT374 - UDMA100, function 1 uses different cable_detect method */
807 	static const struct ata_port_info info_hpt374_fn0 = {
808 		.flags = ATA_FLAG_SLAVE_POSS,
809 		.pio_mask = ATA_PIO4,
810 		.mwdma_mask = ATA_MWDMA2,
811 		.udma_mask = ATA_UDMA5,
812 		.port_ops = &hpt372_port_ops
813 	};
814 	static const struct ata_port_info info_hpt374_fn1 = {
815 		.flags = ATA_FLAG_SLAVE_POSS,
816 		.pio_mask = ATA_PIO4,
817 		.mwdma_mask = ATA_MWDMA2,
818 		.udma_mask = ATA_UDMA5,
819 		.port_ops = &hpt374_fn1_port_ops
820 	};
821 
822 	static const int MHz[4] = { 33, 40, 50, 66 };
823 	void *private_data = NULL;
824 	const struct ata_port_info *ppi[] = { NULL, NULL };
825 	u8 rev = dev->revision;
826 	u8 irqmask;
827 	u8 mcr1;
828 	u32 freq;
829 	int prefer_dpll = 1;
830 
831 	unsigned long iobase = pci_resource_start(dev, 4);
832 
833 	const struct hpt_chip *chip_table;
834 	int clock_slot;
835 	int rc;
836 
837 	rc = pcim_enable_device(dev);
838 	if (rc)
839 		return rc;
840 
841 	switch (dev->device) {
842 	case PCI_DEVICE_ID_TTI_HPT366:
843 		/* May be a later chip in disguise. Check */
844 		/* Older chips are in the HPT366 driver. Ignore them */
845 		if (rev < 3)
846 			return -ENODEV;
847 		/* N series chips have their own driver. Ignore */
848 		if (rev == 6)
849 			return -ENODEV;
850 
851 		switch (rev) {
852 		case 3:
853 			ppi[0] = &info_hpt370;
854 			chip_table = &hpt370;
855 			prefer_dpll = 0;
856 			break;
857 		case 4:
858 			ppi[0] = &info_hpt370a;
859 			chip_table = &hpt370a;
860 			prefer_dpll = 0;
861 			break;
862 		case 5:
863 			ppi[0] = &info_hpt372;
864 			chip_table = &hpt372;
865 			break;
866 		default:
867 			pr_err("Unknown HPT366 subtype, please report (%d)\n",
868 			       rev);
869 			return -ENODEV;
870 		}
871 		break;
872 	case PCI_DEVICE_ID_TTI_HPT372:
873 		/* 372N if rev >= 2 */
874 		if (rev >= 2)
875 			return -ENODEV;
876 		ppi[0] = &info_hpt372;
877 		chip_table = &hpt372a;
878 		break;
879 	case PCI_DEVICE_ID_TTI_HPT302:
880 		/* 302N if rev > 1 */
881 		if (rev > 1)
882 			return -ENODEV;
883 		ppi[0] = &info_hpt302;
884 		/* Check this */
885 		chip_table = &hpt302;
886 		break;
887 	case PCI_DEVICE_ID_TTI_HPT371:
888 		if (rev > 1)
889 			return -ENODEV;
890 		ppi[0] = &info_hpt302;
891 		chip_table = &hpt371;
892 		/*
893 		 * Single channel device, master is not present but the BIOS
894 		 * (or us for non x86) must mark it absent
895 		 */
896 		pci_read_config_byte(dev, 0x50, &mcr1);
897 		mcr1 &= ~0x04;
898 		pci_write_config_byte(dev, 0x50, mcr1);
899 		break;
900 	case PCI_DEVICE_ID_TTI_HPT374:
901 		chip_table = &hpt374;
902 		if (!(PCI_FUNC(dev->devfn) & 1))
903 			*ppi = &info_hpt374_fn0;
904 		else
905 			*ppi = &info_hpt374_fn1;
906 		break;
907 	default:
908 		pr_err("PCI table is bogus, please report (%d)\n", dev->device);
909 		return -ENODEV;
910 	}
911 	/* Ok so this is a chip we support */
912 
913 	pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, (L1_CACHE_BYTES / 4));
914 	pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x78);
915 	pci_write_config_byte(dev, PCI_MIN_GNT, 0x08);
916 	pci_write_config_byte(dev, PCI_MAX_LAT, 0x08);
917 
918 	pci_read_config_byte(dev, 0x5A, &irqmask);
919 	irqmask &= ~0x10;
920 	pci_write_config_byte(dev, 0x5a, irqmask);
921 
922 	/*
923 	 * default to pci clock. make sure MA15/16 are set to output
924 	 * to prevent drives having problems with 40-pin cables. Needed
925 	 * for some drives such as IBM-DTLA which will not enter ready
926 	 * state on reset when PDIAG is a input.
927 	 */
928 
929 	pci_write_config_byte(dev, 0x5b, 0x23);
930 
931 	/*
932 	 * HighPoint does this for HPT372A.
933 	 * NOTE: This register is only writeable via I/O space.
934 	 */
935 	if (chip_table == &hpt372a)
936 		outb(0x0e, iobase + 0x9c);
937 
938 	/*
939 	 * Some devices do not let this value be accessed via PCI space
940 	 * according to the old driver. In addition we must use the value
941 	 * from FN 0 on the HPT374.
942 	 */
943 
944 	if (chip_table == &hpt374) {
945 		freq = hpt374_read_freq(dev);
946 		if (freq == 0)
947 			return -ENODEV;
948 	} else
949 		freq = inl(iobase + 0x90);
950 
951 	if ((freq >> 12) != 0xABCDE) {
952 		int i;
953 		u8 sr;
954 		u32 total = 0;
955 
956 		pr_warn("BIOS has not set timing clocks\n");
957 
958 		/* This is the process the HPT371 BIOS is reported to use */
959 		for (i = 0; i < 128; i++) {
960 			pci_read_config_byte(dev, 0x78, &sr);
961 			total += sr & 0x1FF;
962 			udelay(15);
963 		}
964 		freq = total / 128;
965 	}
966 	freq &= 0x1FF;
967 
968 	/*
969 	 *	Turn the frequency check into a band and then find a timing
970 	 *	table to match it.
971 	 */
972 
973 	clock_slot = hpt37x_clock_slot(freq, chip_table->base);
974 	if (chip_table->clocks[clock_slot] == NULL || prefer_dpll) {
975 		/*
976 		 *	We need to try PLL mode instead
977 		 *
978 		 *	For non UDMA133 capable devices we should
979 		 *	use a 50MHz DPLL by choice
980 		 */
981 		unsigned int f_low, f_high;
982 		int dpll, adjust;
983 
984 		/* Compute DPLL */
985 		dpll = (ppi[0]->udma_mask & 0xC0) ? 3 : 2;
986 
987 		f_low = (MHz[clock_slot] * 48) / MHz[dpll];
988 		f_high = f_low + 2;
989 		if (clock_slot > 1)
990 			f_high += 2;
991 
992 		/* Select the DPLL clock. */
993 		pci_write_config_byte(dev, 0x5b, 0x21);
994 		pci_write_config_dword(dev, 0x5C,
995 				       (f_high << 16) | f_low | 0x100);
996 
997 		for (adjust = 0; adjust < 8; adjust++) {
998 			if (hpt37x_calibrate_dpll(dev))
999 				break;
1000 			/*
1001 			 * See if it'll settle at a fractionally
1002 			 * different clock
1003 			 */
1004 			if (adjust & 1)
1005 				f_low -= adjust >> 1;
1006 			else
1007 				f_high += adjust >> 1;
1008 			pci_write_config_dword(dev, 0x5C,
1009 					       (f_high << 16) | f_low | 0x100);
1010 		}
1011 		if (adjust == 8) {
1012 			pr_err("DPLL did not stabilize!\n");
1013 			return -ENODEV;
1014 		}
1015 		if (dpll == 3)
1016 			private_data = (void *)hpt37x_timings_66;
1017 		else
1018 			private_data = (void *)hpt37x_timings_50;
1019 
1020 		pr_info("bus clock %dMHz, using %dMHz DPLL\n",
1021 			MHz[clock_slot], MHz[dpll]);
1022 	} else {
1023 		private_data = (void *)chip_table->clocks[clock_slot];
1024 		/*
1025 		 *	Perform a final fixup. Note that we will have used the
1026 		 *	DPLL on the HPT372 which means we don't have to worry
1027 		 *	about lack of UDMA133 support on lower clocks
1028 		 */
1029 
1030 		if (clock_slot < 2 && ppi[0] == &info_hpt370)
1031 			ppi[0] = &info_hpt370_33;
1032 		if (clock_slot < 2 && ppi[0] == &info_hpt370a)
1033 			ppi[0] = &info_hpt370a_33;
1034 
1035 		pr_info("%s using %dMHz bus clock\n",
1036 			chip_table->name, MHz[clock_slot]);
1037 	}
1038 
1039 	/* Now kick off ATA set up */
1040 	return ata_pci_bmdma_init_one(dev, ppi, &hpt37x_sht, private_data, 0);
1041 }
1042 
1043 static const struct pci_device_id hpt37x[] = {
1044 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT366), },
1045 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT371), },
1046 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT372), },
1047 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT374), },
1048 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT302), },
1049 
1050 	{ },
1051 };
1052 
1053 static struct pci_driver hpt37x_pci_driver = {
1054 	.name		= DRV_NAME,
1055 	.id_table	= hpt37x,
1056 	.probe		= hpt37x_init_one,
1057 	.remove		= ata_pci_remove_one
1058 };
1059 
1060 module_pci_driver(hpt37x_pci_driver);
1061 
1062 MODULE_AUTHOR("Alan Cox");
1063 MODULE_DESCRIPTION("low-level driver for the Highpoint HPT37x/30x");
1064 MODULE_LICENSE("GPL");
1065 MODULE_DEVICE_TABLE(pci, hpt37x);
1066 MODULE_VERSION(DRV_VERSION);
1067