xref: /openbmc/linux/drivers/ata/pata_hpt366.c (revision e67f88dd12f610da98ca838822f2c9b4e7c6100e)
1 /*
2  * Libata driver for the highpoint 366 and 368 UDMA66 ATA controllers.
3  *
4  * This driver is heavily based upon:
5  *
6  * linux/drivers/ide/pci/hpt366.c		Version 0.36	April 25, 2003
7  *
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
11  *
12  *
13  * TODO
14  *	Look into engine reset on timeout errors. Should not be required.
15  */
16 
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/pci.h>
22 #include <linux/init.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_hpt366"
29 #define DRV_VERSION	"0.6.11"
30 
31 struct hpt_clock {
32 	u8	xfer_mode;
33 	u32	timing;
34 };
35 
36 /* key for bus clock timings
37  * bit
38  * 0:3    data_high_time. Inactive time of DIOW_/DIOR_ for PIO and MW DMA.
39  *        cycles = value + 1
40  * 4:7    data_low_time. Active time of DIOW_/DIOR_ for PIO and MW DMA.
41  *        cycles = value + 1
42  * 8:11   cmd_high_time. Inactive time of DIOW_/DIOR_ during task file
43  *        register access.
44  * 12:15  cmd_low_time. Active time of DIOW_/DIOR_ during task file
45  *        register access.
46  * 16:18  udma_cycle_time. Clock cycles for UDMA xfer?
47  * 19:21  pre_high_time. Time to initialize 1st cycle for PIO and MW DMA xfer.
48  * 22:24  cmd_pre_high_time. Time to initialize 1st PIO cycle for task file
49  *        register access.
50  * 28     UDMA enable.
51  * 29     DMA  enable.
52  * 30     PIO_MST enable. If set, the chip is in bus master mode during
53  *        PIO xfer.
54  * 31     FIFO enable.
55  */
56 
57 static const struct hpt_clock hpt366_40[] = {
58 	{	XFER_UDMA_4,	0x900fd943	},
59 	{	XFER_UDMA_3,	0x900ad943	},
60 	{	XFER_UDMA_2,	0x900bd943	},
61 	{	XFER_UDMA_1,	0x9008d943	},
62 	{	XFER_UDMA_0,	0x9008d943	},
63 
64 	{	XFER_MW_DMA_2,	0xa008d943	},
65 	{	XFER_MW_DMA_1,	0xa010d955	},
66 	{	XFER_MW_DMA_0,	0xa010d9fc	},
67 
68 	{	XFER_PIO_4,	0xc008d963	},
69 	{	XFER_PIO_3,	0xc010d974	},
70 	{	XFER_PIO_2,	0xc010d997	},
71 	{	XFER_PIO_1,	0xc010d9c7	},
72 	{	XFER_PIO_0,	0xc018d9d9	},
73 	{	0,		0x0120d9d9	}
74 };
75 
76 static const struct hpt_clock hpt366_33[] = {
77 	{	XFER_UDMA_4,	0x90c9a731	},
78 	{	XFER_UDMA_3,	0x90cfa731	},
79 	{	XFER_UDMA_2,	0x90caa731	},
80 	{	XFER_UDMA_1,	0x90cba731	},
81 	{	XFER_UDMA_0,	0x90c8a731	},
82 
83 	{	XFER_MW_DMA_2,	0xa0c8a731	},
84 	{	XFER_MW_DMA_1,	0xa0c8a732	},	/* 0xa0c8a733 */
85 	{	XFER_MW_DMA_0,	0xa0c8a797	},
86 
87 	{	XFER_PIO_4,	0xc0c8a731	},
88 	{	XFER_PIO_3,	0xc0c8a742	},
89 	{	XFER_PIO_2,	0xc0d0a753	},
90 	{	XFER_PIO_1,	0xc0d0a7a3	},	/* 0xc0d0a793 */
91 	{	XFER_PIO_0,	0xc0d0a7aa	},	/* 0xc0d0a7a7 */
92 	{	0,		0x0120a7a7	}
93 };
94 
95 static const struct hpt_clock hpt366_25[] = {
96 	{	XFER_UDMA_4,	0x90c98521	},
97 	{	XFER_UDMA_3,	0x90cf8521	},
98 	{	XFER_UDMA_2,	0x90cf8521	},
99 	{	XFER_UDMA_1,	0x90cb8521	},
100 	{	XFER_UDMA_0,	0x90cb8521	},
101 
102 	{	XFER_MW_DMA_2,	0xa0ca8521	},
103 	{	XFER_MW_DMA_1,	0xa0ca8532	},
104 	{	XFER_MW_DMA_0,	0xa0ca8575	},
105 
106 	{	XFER_PIO_4,	0xc0ca8521	},
107 	{	XFER_PIO_3,	0xc0ca8532	},
108 	{	XFER_PIO_2,	0xc0ca8542	},
109 	{	XFER_PIO_1,	0xc0d08572	},
110 	{	XFER_PIO_0,	0xc0d08585	},
111 	{	0,		0x01208585	}
112 };
113 
114 static const char * const bad_ata33[] = {
115 	"Maxtor 92720U8", "Maxtor 92040U6", "Maxtor 91360U4", "Maxtor 91020U3",
116 	"Maxtor 90845U3", "Maxtor 90650U2",
117 	"Maxtor 91360D8", "Maxtor 91190D7", "Maxtor 91020D6", "Maxtor 90845D5",
118 	"Maxtor 90680D4", "Maxtor 90510D3", "Maxtor 90340D2",
119 	"Maxtor 91152D8", "Maxtor 91008D7", "Maxtor 90845D6", "Maxtor 90840D6",
120 	"Maxtor 90720D5", "Maxtor 90648D5", "Maxtor 90576D4",
121 	"Maxtor 90510D4",
122 	"Maxtor 90432D3", "Maxtor 90288D2", "Maxtor 90256D2",
123 	"Maxtor 91000D8", "Maxtor 90910D8", "Maxtor 90875D7", "Maxtor 90840D7",
124 	"Maxtor 90750D6", "Maxtor 90625D5", "Maxtor 90500D4",
125 	"Maxtor 91728D8", "Maxtor 91512D7", "Maxtor 91303D6", "Maxtor 91080D5",
126 	"Maxtor 90845D4", "Maxtor 90680D4", "Maxtor 90648D3", "Maxtor 90432D2",
127 	NULL
128 };
129 
130 static const char * const bad_ata66_4[] = {
131 	"IBM-DTLA-307075",
132 	"IBM-DTLA-307060",
133 	"IBM-DTLA-307045",
134 	"IBM-DTLA-307030",
135 	"IBM-DTLA-307020",
136 	"IBM-DTLA-307015",
137 	"IBM-DTLA-305040",
138 	"IBM-DTLA-305030",
139 	"IBM-DTLA-305020",
140 	"IC35L010AVER07-0",
141 	"IC35L020AVER07-0",
142 	"IC35L030AVER07-0",
143 	"IC35L040AVER07-0",
144 	"IC35L060AVER07-0",
145 	"WDC AC310200R",
146 	NULL
147 };
148 
149 static const char * const bad_ata66_3[] = {
150 	"WDC AC310200R",
151 	NULL
152 };
153 
154 static int hpt_dma_blacklisted(const struct ata_device *dev, char *modestr,
155 			       const char * const list[])
156 {
157 	unsigned char model_num[ATA_ID_PROD_LEN + 1];
158 	int i = 0;
159 
160 	ata_id_c_string(dev->id, model_num, ATA_ID_PROD, sizeof(model_num));
161 
162 	while (list[i] != NULL) {
163 		if (!strcmp(list[i], model_num)) {
164 			pr_warn("%s is not supported for %s\n",
165 				modestr, list[i]);
166 			return 1;
167 		}
168 		i++;
169 	}
170 	return 0;
171 }
172 
173 /**
174  *	hpt366_filter	-	mode selection filter
175  *	@adev: ATA device
176  *
177  *	Block UDMA on devices that cause trouble with this controller.
178  */
179 
180 static unsigned long hpt366_filter(struct ata_device *adev, unsigned long mask)
181 {
182 	if (adev->class == ATA_DEV_ATA) {
183 		if (hpt_dma_blacklisted(adev, "UDMA",  bad_ata33))
184 			mask &= ~ATA_MASK_UDMA;
185 		if (hpt_dma_blacklisted(adev, "UDMA3", bad_ata66_3))
186 			mask &= ~(0xF8 << ATA_SHIFT_UDMA);
187 		if (hpt_dma_blacklisted(adev, "UDMA4", bad_ata66_4))
188 			mask &= ~(0xF0 << ATA_SHIFT_UDMA);
189 	} else if (adev->class == ATA_DEV_ATAPI)
190 		mask &= ~(ATA_MASK_MWDMA | ATA_MASK_UDMA);
191 
192 	return mask;
193 }
194 
195 static int hpt36x_cable_detect(struct ata_port *ap)
196 {
197 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
198 	u8 ata66;
199 
200 	/*
201 	 * Each channel of pata_hpt366 occupies separate PCI function
202 	 * as the primary channel and bit1 indicates the cable type.
203 	 */
204 	pci_read_config_byte(pdev, 0x5A, &ata66);
205 	if (ata66 & 2)
206 		return ATA_CBL_PATA40;
207 	return ATA_CBL_PATA80;
208 }
209 
210 static void hpt366_set_mode(struct ata_port *ap, struct ata_device *adev,
211 			    u8 mode)
212 {
213 	struct hpt_clock *clocks = ap->host->private_data;
214 	struct pci_dev *pdev = to_pci_dev(ap->host->dev);
215 	u32 addr = 0x40 + 4 * adev->devno;
216 	u32 mask, reg;
217 
218 	/* determine timing mask and find matching clock entry */
219 	if (mode < XFER_MW_DMA_0)
220 		mask = 0xc1f8ffff;
221 	else if (mode < XFER_UDMA_0)
222 		mask = 0x303800ff;
223 	else
224 		mask = 0x30070000;
225 
226 	while (clocks->xfer_mode) {
227 		if (clocks->xfer_mode == mode)
228 			break;
229 		clocks++;
230 	}
231 	if (!clocks->xfer_mode)
232 		BUG();
233 
234 	/*
235 	 * Combine new mode bits with old config bits and disable
236 	 * on-chip PIO FIFO/buffer (and PIO MST mode as well) to avoid
237 	 * problems handling I/O errors later.
238 	 */
239 	pci_read_config_dword(pdev, addr, &reg);
240 	reg = ((reg & ~mask) | (clocks->timing & mask)) & ~0xc0000000;
241 	pci_write_config_dword(pdev, addr, reg);
242 }
243 
244 /**
245  *	hpt366_set_piomode		-	PIO setup
246  *	@ap: ATA interface
247  *	@adev: device on the interface
248  *
249  *	Perform PIO mode setup.
250  */
251 
252 static void hpt366_set_piomode(struct ata_port *ap, struct ata_device *adev)
253 {
254 	hpt366_set_mode(ap, adev, adev->pio_mode);
255 }
256 
257 /**
258  *	hpt366_set_dmamode		-	DMA timing setup
259  *	@ap: ATA interface
260  *	@adev: Device being configured
261  *
262  *	Set up the channel for MWDMA or UDMA modes. Much the same as with
263  *	PIO, load the mode number and then set MWDMA or UDMA flag.
264  */
265 
266 static void hpt366_set_dmamode(struct ata_port *ap, struct ata_device *adev)
267 {
268 	hpt366_set_mode(ap, adev, adev->dma_mode);
269 }
270 
271 static struct scsi_host_template hpt36x_sht = {
272 	ATA_BMDMA_SHT(DRV_NAME),
273 };
274 
275 /*
276  *	Configuration for HPT366/68
277  */
278 
279 static struct ata_port_operations hpt366_port_ops = {
280 	.inherits	= &ata_bmdma_port_ops,
281 	.cable_detect	= hpt36x_cable_detect,
282 	.mode_filter	= hpt366_filter,
283 	.set_piomode	= hpt366_set_piomode,
284 	.set_dmamode	= hpt366_set_dmamode,
285 };
286 
287 /**
288  *	hpt36x_init_chipset	-	common chip setup
289  *	@dev: PCI device
290  *
291  *	Perform the chip setup work that must be done at both init and
292  *	resume time
293  */
294 
295 static void hpt36x_init_chipset(struct pci_dev *dev)
296 {
297 	u8 drive_fast;
298 
299 	pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, (L1_CACHE_BYTES / 4));
300 	pci_write_config_byte(dev, PCI_LATENCY_TIMER, 0x78);
301 	pci_write_config_byte(dev, PCI_MIN_GNT, 0x08);
302 	pci_write_config_byte(dev, PCI_MAX_LAT, 0x08);
303 
304 	pci_read_config_byte(dev, 0x51, &drive_fast);
305 	if (drive_fast & 0x80)
306 		pci_write_config_byte(dev, 0x51, drive_fast & ~0x80);
307 }
308 
309 /**
310  *	hpt36x_init_one		-	Initialise an HPT366/368
311  *	@dev: PCI device
312  *	@id: Entry in match table
313  *
314  *	Initialise an HPT36x device. There are some interesting complications
315  *	here. Firstly the chip may report 366 and be one of several variants.
316  *	Secondly all the timings depend on the clock for the chip which we must
317  *	detect and look up
318  *
319  *	This is the known chip mappings. It may be missing a couple of later
320  *	releases.
321  *
322  *	Chip version		PCI		Rev	Notes
323  *	HPT366			4 (HPT366)	0	UDMA66
324  *	HPT366			4 (HPT366)	1	UDMA66
325  *	HPT368			4 (HPT366)	2	UDMA66
326  *	HPT37x/30x		4 (HPT366)	3+	Other driver
327  *
328  */
329 
330 static int hpt36x_init_one(struct pci_dev *dev, const struct pci_device_id *id)
331 {
332 	static const struct ata_port_info info_hpt366 = {
333 		.flags = ATA_FLAG_SLAVE_POSS,
334 		.pio_mask = ATA_PIO4,
335 		.mwdma_mask = ATA_MWDMA2,
336 		.udma_mask = ATA_UDMA4,
337 		.port_ops = &hpt366_port_ops
338 	};
339 	const struct ata_port_info *ppi[] = { &info_hpt366, NULL };
340 
341 	void *hpriv = NULL;
342 	u32 reg1;
343 	int rc;
344 
345 	rc = pcim_enable_device(dev);
346 	if (rc)
347 		return rc;
348 
349 	/* May be a later chip in disguise. Check */
350 	/* Newer chips are not in the HPT36x driver. Ignore them */
351 	if (dev->revision > 2)
352 		return -ENODEV;
353 
354 	hpt36x_init_chipset(dev);
355 
356 	pci_read_config_dword(dev, 0x40,  &reg1);
357 
358 	/* PCI clocking determines the ATA timing values to use */
359 	/* info_hpt366 is safe against re-entry so we can scribble on it */
360 	switch ((reg1 & 0x700) >> 8) {
361 	case 9:
362 		hpriv = &hpt366_40;
363 		break;
364 	case 5:
365 		hpriv = &hpt366_25;
366 		break;
367 	default:
368 		hpriv = &hpt366_33;
369 		break;
370 	}
371 	/* Now kick off ATA set up */
372 	return ata_pci_bmdma_init_one(dev, ppi, &hpt36x_sht, hpriv, 0);
373 }
374 
375 #ifdef CONFIG_PM
376 static int hpt36x_reinit_one(struct pci_dev *dev)
377 {
378 	struct ata_host *host = dev_get_drvdata(&dev->dev);
379 	int rc;
380 
381 	rc = ata_pci_device_do_resume(dev);
382 	if (rc)
383 		return rc;
384 	hpt36x_init_chipset(dev);
385 	ata_host_resume(host);
386 	return 0;
387 }
388 #endif
389 
390 static const struct pci_device_id hpt36x[] = {
391 	{ PCI_VDEVICE(TTI, PCI_DEVICE_ID_TTI_HPT366), },
392 	{ },
393 };
394 
395 static struct pci_driver hpt36x_pci_driver = {
396 	.name		= DRV_NAME,
397 	.id_table	= hpt36x,
398 	.probe		= hpt36x_init_one,
399 	.remove		= ata_pci_remove_one,
400 #ifdef CONFIG_PM
401 	.suspend	= ata_pci_device_suspend,
402 	.resume		= hpt36x_reinit_one,
403 #endif
404 };
405 
406 static int __init hpt36x_init(void)
407 {
408 	return pci_register_driver(&hpt36x_pci_driver);
409 }
410 
411 static void __exit hpt36x_exit(void)
412 {
413 	pci_unregister_driver(&hpt36x_pci_driver);
414 }
415 
416 MODULE_AUTHOR("Alan Cox");
417 MODULE_DESCRIPTION("low-level driver for the Highpoint HPT366/368");
418 MODULE_LICENSE("GPL");
419 MODULE_DEVICE_TABLE(pci, hpt36x);
420 MODULE_VERSION(DRV_VERSION);
421 
422 module_init(hpt36x_init);
423 module_exit(hpt36x_exit);
424