xref: /openbmc/linux/drivers/ata/libata-pmp.c (revision 28f65c11)
1 /*
2  * libata-pmp.c - libata port multiplier support
3  *
4  * Copyright (c) 2007  SUSE Linux Products GmbH
5  * Copyright (c) 2007  Tejun Heo <teheo@suse.de>
6  *
7  * This file is released under the GPLv2.
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/libata.h>
12 #include <linux/slab.h>
13 #include "libata.h"
14 #include "libata-transport.h"
15 
16 const struct ata_port_operations sata_pmp_port_ops = {
17 	.inherits		= &sata_port_ops,
18 	.pmp_prereset		= ata_std_prereset,
19 	.pmp_hardreset		= sata_std_hardreset,
20 	.pmp_postreset		= ata_std_postreset,
21 	.error_handler		= sata_pmp_error_handler,
22 };
23 
24 /**
25  *	sata_pmp_read - read PMP register
26  *	@link: link to read PMP register for
27  *	@reg: register to read
28  *	@r_val: resulting value
29  *
30  *	Read PMP register.
31  *
32  *	LOCKING:
33  *	Kernel thread context (may sleep).
34  *
35  *	RETURNS:
36  *	0 on success, AC_ERR_* mask on failure.
37  */
38 static unsigned int sata_pmp_read(struct ata_link *link, int reg, u32 *r_val)
39 {
40 	struct ata_port *ap = link->ap;
41 	struct ata_device *pmp_dev = ap->link.device;
42 	struct ata_taskfile tf;
43 	unsigned int err_mask;
44 
45 	ata_tf_init(pmp_dev, &tf);
46 	tf.command = ATA_CMD_PMP_READ;
47 	tf.protocol = ATA_PROT_NODATA;
48 	tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
49 	tf.feature = reg;
50 	tf.device = link->pmp;
51 
52 	err_mask = ata_exec_internal(pmp_dev, &tf, NULL, DMA_NONE, NULL, 0,
53 				     SATA_PMP_RW_TIMEOUT);
54 	if (err_mask)
55 		return err_mask;
56 
57 	*r_val = tf.nsect | tf.lbal << 8 | tf.lbam << 16 | tf.lbah << 24;
58 	return 0;
59 }
60 
61 /**
62  *	sata_pmp_write - write PMP register
63  *	@link: link to write PMP register for
64  *	@reg: register to write
65  *	@r_val: value to write
66  *
67  *	Write PMP register.
68  *
69  *	LOCKING:
70  *	Kernel thread context (may sleep).
71  *
72  *	RETURNS:
73  *	0 on success, AC_ERR_* mask on failure.
74  */
75 static unsigned int sata_pmp_write(struct ata_link *link, int reg, u32 val)
76 {
77 	struct ata_port *ap = link->ap;
78 	struct ata_device *pmp_dev = ap->link.device;
79 	struct ata_taskfile tf;
80 
81 	ata_tf_init(pmp_dev, &tf);
82 	tf.command = ATA_CMD_PMP_WRITE;
83 	tf.protocol = ATA_PROT_NODATA;
84 	tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
85 	tf.feature = reg;
86 	tf.device = link->pmp;
87 	tf.nsect = val & 0xff;
88 	tf.lbal = (val >> 8) & 0xff;
89 	tf.lbam = (val >> 16) & 0xff;
90 	tf.lbah = (val >> 24) & 0xff;
91 
92 	return ata_exec_internal(pmp_dev, &tf, NULL, DMA_NONE, NULL, 0,
93 				 SATA_PMP_RW_TIMEOUT);
94 }
95 
96 /**
97  *	sata_pmp_qc_defer_cmd_switch - qc_defer for command switching PMP
98  *	@qc: ATA command in question
99  *
100  *	A host which has command switching PMP support cannot issue
101  *	commands to multiple links simultaneously.
102  *
103  *	LOCKING:
104  *	spin_lock_irqsave(host lock)
105  *
106  *	RETURNS:
107  *	ATA_DEFER_* if deferring is needed, 0 otherwise.
108  */
109 int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc)
110 {
111 	struct ata_link *link = qc->dev->link;
112 	struct ata_port *ap = link->ap;
113 
114 	if (ap->excl_link == NULL || ap->excl_link == link) {
115 		if (ap->nr_active_links == 0 || ata_link_active(link)) {
116 			qc->flags |= ATA_QCFLAG_CLEAR_EXCL;
117 			return ata_std_qc_defer(qc);
118 		}
119 
120 		ap->excl_link = link;
121 	}
122 
123 	return ATA_DEFER_PORT;
124 }
125 
126 /**
127  *	sata_pmp_scr_read - read PSCR
128  *	@link: ATA link to read PSCR for
129  *	@reg: PSCR to read
130  *	@r_val: resulting value
131  *
132  *	Read PSCR @reg into @r_val for @link, to be called from
133  *	ata_scr_read().
134  *
135  *	LOCKING:
136  *	Kernel thread context (may sleep).
137  *
138  *	RETURNS:
139  *	0 on success, -errno on failure.
140  */
141 int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *r_val)
142 {
143 	unsigned int err_mask;
144 
145 	if (reg > SATA_PMP_PSCR_CONTROL)
146 		return -EINVAL;
147 
148 	err_mask = sata_pmp_read(link, reg, r_val);
149 	if (err_mask) {
150 		ata_link_printk(link, KERN_WARNING, "failed to read SCR %d "
151 				"(Emask=0x%x)\n", reg, err_mask);
152 		return -EIO;
153 	}
154 	return 0;
155 }
156 
157 /**
158  *	sata_pmp_scr_write - write PSCR
159  *	@link: ATA link to write PSCR for
160  *	@reg: PSCR to write
161  *	@val: value to be written
162  *
163  *	Write @val to PSCR @reg for @link, to be called from
164  *	ata_scr_write() and ata_scr_write_flush().
165  *
166  *	LOCKING:
167  *	Kernel thread context (may sleep).
168  *
169  *	RETURNS:
170  *	0 on success, -errno on failure.
171  */
172 int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
173 {
174 	unsigned int err_mask;
175 
176 	if (reg > SATA_PMP_PSCR_CONTROL)
177 		return -EINVAL;
178 
179 	err_mask = sata_pmp_write(link, reg, val);
180 	if (err_mask) {
181 		ata_link_printk(link, KERN_WARNING, "failed to write SCR %d "
182 				"(Emask=0x%x)\n", reg, err_mask);
183 		return -EIO;
184 	}
185 	return 0;
186 }
187 
188 /**
189  *	sata_pmp_set_lpm - configure LPM for a PMP link
190  *	@link: PMP link to configure LPM for
191  *	@policy: target LPM policy
192  *	@hints: LPM hints
193  *
194  *	Configure LPM for @link.  This function will contain any PMP
195  *	specific workarounds if necessary.
196  *
197  *	LOCKING:
198  *	EH context.
199  *
200  *	RETURNS:
201  *	0 on success, -errno on failure.
202  */
203 int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
204 		     unsigned hints)
205 {
206 	return sata_link_scr_lpm(link, policy, true);
207 }
208 
209 /**
210  *	sata_pmp_read_gscr - read GSCR block of SATA PMP
211  *	@dev: PMP device
212  *	@gscr: buffer to read GSCR block into
213  *
214  *	Read selected PMP GSCRs from the PMP at @dev.  This will serve
215  *	as configuration and identification info for the PMP.
216  *
217  *	LOCKING:
218  *	Kernel thread context (may sleep).
219  *
220  *	RETURNS:
221  *	0 on success, -errno on failure.
222  */
223 static int sata_pmp_read_gscr(struct ata_device *dev, u32 *gscr)
224 {
225 	static const int gscr_to_read[] = { 0, 1, 2, 32, 33, 64, 96 };
226 	int i;
227 
228 	for (i = 0; i < ARRAY_SIZE(gscr_to_read); i++) {
229 		int reg = gscr_to_read[i];
230 		unsigned int err_mask;
231 
232 		err_mask = sata_pmp_read(dev->link, reg, &gscr[reg]);
233 		if (err_mask) {
234 			ata_dev_printk(dev, KERN_ERR, "failed to read PMP "
235 				"GSCR[%d] (Emask=0x%x)\n", reg, err_mask);
236 			return -EIO;
237 		}
238 	}
239 
240 	return 0;
241 }
242 
243 static const char *sata_pmp_spec_rev_str(const u32 *gscr)
244 {
245 	u32 rev = gscr[SATA_PMP_GSCR_REV];
246 
247 	if (rev & (1 << 3))
248 		return "1.2";
249 	if (rev & (1 << 2))
250 		return "1.1";
251 	if (rev & (1 << 1))
252 		return "1.0";
253 	return "<unknown>";
254 }
255 
256 #define PMP_GSCR_SII_POL 129
257 
258 static int sata_pmp_configure(struct ata_device *dev, int print_info)
259 {
260 	struct ata_port *ap = dev->link->ap;
261 	u32 *gscr = dev->gscr;
262 	u16 vendor = sata_pmp_gscr_vendor(gscr);
263 	u16 devid = sata_pmp_gscr_devid(gscr);
264 	unsigned int err_mask = 0;
265 	const char *reason;
266 	int nr_ports, rc;
267 
268 	nr_ports = sata_pmp_gscr_ports(gscr);
269 
270 	if (nr_ports <= 0 || nr_ports > SATA_PMP_MAX_PORTS) {
271 		rc = -EINVAL;
272 		reason = "invalid nr_ports";
273 		goto fail;
274 	}
275 
276 	if ((ap->flags & ATA_FLAG_AN) &&
277 	    (gscr[SATA_PMP_GSCR_FEAT] & SATA_PMP_FEAT_NOTIFY))
278 		dev->flags |= ATA_DFLAG_AN;
279 
280 	/* monitor SERR_PHYRDY_CHG on fan-out ports */
281 	err_mask = sata_pmp_write(dev->link, SATA_PMP_GSCR_ERROR_EN,
282 				  SERR_PHYRDY_CHG);
283 	if (err_mask) {
284 		rc = -EIO;
285 		reason = "failed to write GSCR_ERROR_EN";
286 		goto fail;
287 	}
288 
289 	/* Disable sending Early R_OK.
290 	 * With "cached read" HDD testing and multiple ports busy on a SATA
291 	 * host controller, 3726 PMP will very rarely drop a deferred
292 	 * R_OK that was intended for the host. Symptom will be all
293 	 * 5 drives under test will timeout, get reset, and recover.
294 	 */
295 	if (vendor == 0x1095 && devid == 0x3726) {
296 		u32 reg;
297 
298 		err_mask = sata_pmp_read(&ap->link, PMP_GSCR_SII_POL, &reg);
299 		if (err_mask) {
300 			rc = -EIO;
301 			reason = "failed to read Sil3726 Private Register";
302 			goto fail;
303 		}
304 		reg &= ~0x1;
305 		err_mask = sata_pmp_write(&ap->link, PMP_GSCR_SII_POL, reg);
306 		if (err_mask) {
307 			rc = -EIO;
308 			reason = "failed to write Sil3726 Private Register";
309 			goto fail;
310 		}
311 	}
312 
313 	if (print_info) {
314 		ata_dev_printk(dev, KERN_INFO, "Port Multiplier %s, "
315 			       "0x%04x:0x%04x r%d, %d ports, feat 0x%x/0x%x\n",
316 			       sata_pmp_spec_rev_str(gscr), vendor, devid,
317 			       sata_pmp_gscr_rev(gscr),
318 			       nr_ports, gscr[SATA_PMP_GSCR_FEAT_EN],
319 			       gscr[SATA_PMP_GSCR_FEAT]);
320 
321 		if (!(dev->flags & ATA_DFLAG_AN))
322 			ata_dev_printk(dev, KERN_INFO,
323 				"Asynchronous notification not supported, "
324 				"hotplug won't\n         work on fan-out "
325 				"ports. Use warm-plug instead.\n");
326 	}
327 
328 	return 0;
329 
330  fail:
331 	ata_dev_printk(dev, KERN_ERR,
332 		       "failed to configure Port Multiplier (%s, Emask=0x%x)\n",
333 		       reason, err_mask);
334 	return rc;
335 }
336 
337 static int sata_pmp_init_links (struct ata_port *ap, int nr_ports)
338 {
339 	struct ata_link *pmp_link = ap->pmp_link;
340 	int i, err;
341 
342 	if (!pmp_link) {
343 		pmp_link = kzalloc(sizeof(pmp_link[0]) * SATA_PMP_MAX_PORTS,
344 				   GFP_NOIO);
345 		if (!pmp_link)
346 			return -ENOMEM;
347 
348 		for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
349 			ata_link_init(ap, &pmp_link[i], i);
350 
351 		ap->pmp_link = pmp_link;
352 
353 		for (i = 0; i < SATA_PMP_MAX_PORTS; i++) {
354 			err = ata_tlink_add(&pmp_link[i]);
355 			if (err) {
356 				goto err_tlink;
357 			}
358 		}
359 	}
360 
361 	for (i = 0; i < nr_ports; i++) {
362 		struct ata_link *link = &pmp_link[i];
363 		struct ata_eh_context *ehc = &link->eh_context;
364 
365 		link->flags = 0;
366 		ehc->i.probe_mask |= ATA_ALL_DEVICES;
367 		ehc->i.action |= ATA_EH_RESET;
368 	}
369 
370 	return 0;
371   err_tlink:
372 	while (--i >= 0)
373 		ata_tlink_delete(&pmp_link[i]);
374 	kfree(pmp_link);
375 	ap->pmp_link = NULL;
376 	return err;
377 }
378 
379 static void sata_pmp_quirks(struct ata_port *ap)
380 {
381 	u32 *gscr = ap->link.device->gscr;
382 	u16 vendor = sata_pmp_gscr_vendor(gscr);
383 	u16 devid = sata_pmp_gscr_devid(gscr);
384 	struct ata_link *link;
385 
386 	if (vendor == 0x1095 && devid == 0x3726) {
387 		/* sil3726 quirks */
388 		ata_for_each_link(link, ap, EDGE) {
389 			/* link reports offline after LPM */
390 			link->flags |= ATA_LFLAG_NO_LPM;
391 
392 			/* Class code report is unreliable and SRST
393 			 * times out under certain configurations.
394 			 */
395 			if (link->pmp < 5)
396 				link->flags |= ATA_LFLAG_NO_SRST |
397 					       ATA_LFLAG_ASSUME_ATA;
398 
399 			/* port 5 is for SEMB device and it doesn't like SRST */
400 			if (link->pmp == 5)
401 				link->flags |= ATA_LFLAG_NO_SRST |
402 					       ATA_LFLAG_ASSUME_SEMB;
403 		}
404 	} else if (vendor == 0x1095 && devid == 0x4723) {
405 		/* sil4723 quirks */
406 		ata_for_each_link(link, ap, EDGE) {
407 			/* link reports offline after LPM */
408 			link->flags |= ATA_LFLAG_NO_LPM;
409 
410 			/* class code report is unreliable */
411 			if (link->pmp < 2)
412 				link->flags |= ATA_LFLAG_ASSUME_ATA;
413 
414 			/* the config device at port 2 locks up on SRST */
415 			if (link->pmp == 2)
416 				link->flags |= ATA_LFLAG_NO_SRST |
417 					       ATA_LFLAG_ASSUME_ATA;
418 		}
419 	} else if (vendor == 0x1095 && devid == 0x4726) {
420 		/* sil4726 quirks */
421 		ata_for_each_link(link, ap, EDGE) {
422 			/* link reports offline after LPM */
423 			link->flags |= ATA_LFLAG_NO_LPM;
424 
425 			/* Class code report is unreliable and SRST
426 			 * times out under certain configurations.
427 			 * Config device can be at port 0 or 5 and
428 			 * locks up on SRST.
429 			 */
430 			if (link->pmp <= 5)
431 				link->flags |= ATA_LFLAG_NO_SRST |
432 					       ATA_LFLAG_ASSUME_ATA;
433 
434 			/* Port 6 is for SEMB device which doesn't
435 			 * like SRST either.
436 			 */
437 			if (link->pmp == 6)
438 				link->flags |= ATA_LFLAG_NO_SRST |
439 					       ATA_LFLAG_ASSUME_SEMB;
440 		}
441 	} else if (vendor == 0x1095 && (devid == 0x5723 || devid == 0x5733 ||
442 					devid == 0x5734 || devid == 0x5744)) {
443 		/* sil5723/5744 quirks */
444 
445 		/* sil5723/5744 has either two or three downstream
446 		 * ports depending on operation mode.  The last port
447 		 * is empty if any actual IO device is available or
448 		 * occupied by a pseudo configuration device
449 		 * otherwise.  Don't try hard to recover it.
450 		 */
451 		ap->pmp_link[ap->nr_pmp_links - 1].flags |= ATA_LFLAG_NO_RETRY;
452 	} else if (vendor == 0x197b && devid == 0x2352) {
453 		/* chip found in Thermaltake BlackX Duet, jmicron JMB350? */
454 		ata_for_each_link(link, ap, EDGE) {
455 			/* SRST breaks detection and disks get misclassified
456 			 * LPM disabled to avoid potential problems
457 			 */
458 			link->flags |= ATA_LFLAG_NO_LPM |
459 				       ATA_LFLAG_NO_SRST |
460 				       ATA_LFLAG_ASSUME_ATA;
461 		}
462 	}
463 }
464 
465 /**
466  *	sata_pmp_attach - attach a SATA PMP device
467  *	@dev: SATA PMP device to attach
468  *
469  *	Configure and attach SATA PMP device @dev.  This function is
470  *	also responsible for allocating and initializing PMP links.
471  *
472  *	LOCKING:
473  *	Kernel thread context (may sleep).
474  *
475  *	RETURNS:
476  *	0 on success, -errno on failure.
477  */
478 int sata_pmp_attach(struct ata_device *dev)
479 {
480 	struct ata_link *link = dev->link;
481 	struct ata_port *ap = link->ap;
482 	unsigned long flags;
483 	struct ata_link *tlink;
484 	int rc;
485 
486 	/* is it hanging off the right place? */
487 	if (!sata_pmp_supported(ap)) {
488 		ata_dev_printk(dev, KERN_ERR,
489 			       "host does not support Port Multiplier\n");
490 		return -EINVAL;
491 	}
492 
493 	if (!ata_is_host_link(link)) {
494 		ata_dev_printk(dev, KERN_ERR,
495 			       "Port Multipliers cannot be nested\n");
496 		return -EINVAL;
497 	}
498 
499 	if (dev->devno) {
500 		ata_dev_printk(dev, KERN_ERR,
501 			       "Port Multiplier must be the first device\n");
502 		return -EINVAL;
503 	}
504 
505 	WARN_ON(link->pmp != 0);
506 	link->pmp = SATA_PMP_CTRL_PORT;
507 
508 	/* read GSCR block */
509 	rc = sata_pmp_read_gscr(dev, dev->gscr);
510 	if (rc)
511 		goto fail;
512 
513 	/* config PMP */
514 	rc = sata_pmp_configure(dev, 1);
515 	if (rc)
516 		goto fail;
517 
518 	rc = sata_pmp_init_links(ap, sata_pmp_gscr_ports(dev->gscr));
519 	if (rc) {
520 		ata_dev_printk(dev, KERN_INFO,
521 			       "failed to initialize PMP links\n");
522 		goto fail;
523 	}
524 
525 	/* attach it */
526 	spin_lock_irqsave(ap->lock, flags);
527 	WARN_ON(ap->nr_pmp_links);
528 	ap->nr_pmp_links = sata_pmp_gscr_ports(dev->gscr);
529 	spin_unlock_irqrestore(ap->lock, flags);
530 
531 	sata_pmp_quirks(ap);
532 
533 	if (ap->ops->pmp_attach)
534 		ap->ops->pmp_attach(ap);
535 
536 	ata_for_each_link(tlink, ap, EDGE)
537 		sata_link_init_spd(tlink);
538 
539 	ata_acpi_associate_sata_port(ap);
540 
541 	return 0;
542 
543  fail:
544 	link->pmp = 0;
545 	return rc;
546 }
547 
548 /**
549  *	sata_pmp_detach - detach a SATA PMP device
550  *	@dev: SATA PMP device to detach
551  *
552  *	Detach SATA PMP device @dev.  This function is also
553  *	responsible for deconfiguring PMP links.
554  *
555  *	LOCKING:
556  *	Kernel thread context (may sleep).
557  */
558 static void sata_pmp_detach(struct ata_device *dev)
559 {
560 	struct ata_link *link = dev->link;
561 	struct ata_port *ap = link->ap;
562 	struct ata_link *tlink;
563 	unsigned long flags;
564 
565 	ata_dev_printk(dev, KERN_INFO, "Port Multiplier detaching\n");
566 
567 	WARN_ON(!ata_is_host_link(link) || dev->devno ||
568 		link->pmp != SATA_PMP_CTRL_PORT);
569 
570 	if (ap->ops->pmp_detach)
571 		ap->ops->pmp_detach(ap);
572 
573 	ata_for_each_link(tlink, ap, EDGE)
574 		ata_eh_detach_dev(tlink->device);
575 
576 	spin_lock_irqsave(ap->lock, flags);
577 	ap->nr_pmp_links = 0;
578 	link->pmp = 0;
579 	spin_unlock_irqrestore(ap->lock, flags);
580 
581 	ata_acpi_associate_sata_port(ap);
582 }
583 
584 /**
585  *	sata_pmp_same_pmp - does new GSCR matches the configured PMP?
586  *	@dev: PMP device to compare against
587  *	@new_gscr: GSCR block of the new device
588  *
589  *	Compare @new_gscr against @dev and determine whether @dev is
590  *	the PMP described by @new_gscr.
591  *
592  *	LOCKING:
593  *	None.
594  *
595  *	RETURNS:
596  *	1 if @dev matches @new_gscr, 0 otherwise.
597  */
598 static int sata_pmp_same_pmp(struct ata_device *dev, const u32 *new_gscr)
599 {
600 	const u32 *old_gscr = dev->gscr;
601 	u16 old_vendor, new_vendor, old_devid, new_devid;
602 	int old_nr_ports, new_nr_ports;
603 
604 	old_vendor = sata_pmp_gscr_vendor(old_gscr);
605 	new_vendor = sata_pmp_gscr_vendor(new_gscr);
606 	old_devid = sata_pmp_gscr_devid(old_gscr);
607 	new_devid = sata_pmp_gscr_devid(new_gscr);
608 	old_nr_ports = sata_pmp_gscr_ports(old_gscr);
609 	new_nr_ports = sata_pmp_gscr_ports(new_gscr);
610 
611 	if (old_vendor != new_vendor) {
612 		ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
613 			       "vendor mismatch '0x%x' != '0x%x'\n",
614 			       old_vendor, new_vendor);
615 		return 0;
616 	}
617 
618 	if (old_devid != new_devid) {
619 		ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
620 			       "device ID mismatch '0x%x' != '0x%x'\n",
621 			       old_devid, new_devid);
622 		return 0;
623 	}
624 
625 	if (old_nr_ports != new_nr_ports) {
626 		ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
627 			       "nr_ports mismatch '0x%x' != '0x%x'\n",
628 			       old_nr_ports, new_nr_ports);
629 		return 0;
630 	}
631 
632 	return 1;
633 }
634 
635 /**
636  *	sata_pmp_revalidate - revalidate SATA PMP
637  *	@dev: PMP device to revalidate
638  *	@new_class: new class code
639  *
640  *	Re-read GSCR block and make sure @dev is still attached to the
641  *	port and properly configured.
642  *
643  *	LOCKING:
644  *	Kernel thread context (may sleep).
645  *
646  *	RETURNS:
647  *	0 on success, -errno otherwise.
648  */
649 static int sata_pmp_revalidate(struct ata_device *dev, unsigned int new_class)
650 {
651 	struct ata_link *link = dev->link;
652 	struct ata_port *ap = link->ap;
653 	u32 *gscr = (void *)ap->sector_buf;
654 	int rc;
655 
656 	DPRINTK("ENTER\n");
657 
658 	ata_eh_about_to_do(link, NULL, ATA_EH_REVALIDATE);
659 
660 	if (!ata_dev_enabled(dev)) {
661 		rc = -ENODEV;
662 		goto fail;
663 	}
664 
665 	/* wrong class? */
666 	if (ata_class_enabled(new_class) && new_class != ATA_DEV_PMP) {
667 		rc = -ENODEV;
668 		goto fail;
669 	}
670 
671 	/* read GSCR */
672 	rc = sata_pmp_read_gscr(dev, gscr);
673 	if (rc)
674 		goto fail;
675 
676 	/* is the pmp still there? */
677 	if (!sata_pmp_same_pmp(dev, gscr)) {
678 		rc = -ENODEV;
679 		goto fail;
680 	}
681 
682 	memcpy(dev->gscr, gscr, sizeof(gscr[0]) * SATA_PMP_GSCR_DWORDS);
683 
684 	rc = sata_pmp_configure(dev, 0);
685 	if (rc)
686 		goto fail;
687 
688 	ata_eh_done(link, NULL, ATA_EH_REVALIDATE);
689 
690 	DPRINTK("EXIT, rc=0\n");
691 	return 0;
692 
693  fail:
694 	ata_dev_printk(dev, KERN_ERR,
695 		       "PMP revalidation failed (errno=%d)\n", rc);
696 	DPRINTK("EXIT, rc=%d\n", rc);
697 	return rc;
698 }
699 
700 /**
701  *	sata_pmp_revalidate_quick - revalidate SATA PMP quickly
702  *	@dev: PMP device to revalidate
703  *
704  *	Make sure the attached PMP is accessible.
705  *
706  *	LOCKING:
707  *	Kernel thread context (may sleep).
708  *
709  *	RETURNS:
710  *	0 on success, -errno otherwise.
711  */
712 static int sata_pmp_revalidate_quick(struct ata_device *dev)
713 {
714 	unsigned int err_mask;
715 	u32 prod_id;
716 
717 	err_mask = sata_pmp_read(dev->link, SATA_PMP_GSCR_PROD_ID, &prod_id);
718 	if (err_mask) {
719 		ata_dev_printk(dev, KERN_ERR, "failed to read PMP product ID "
720 			       "(Emask=0x%x)\n", err_mask);
721 		return -EIO;
722 	}
723 
724 	if (prod_id != dev->gscr[SATA_PMP_GSCR_PROD_ID]) {
725 		ata_dev_printk(dev, KERN_ERR, "PMP product ID mismatch\n");
726 		/* something weird is going on, request full PMP recovery */
727 		return -EIO;
728 	}
729 
730 	return 0;
731 }
732 
733 /**
734  *	sata_pmp_eh_recover_pmp - recover PMP
735  *	@ap: ATA port PMP is attached to
736  *	@prereset: prereset method (can be NULL)
737  *	@softreset: softreset method
738  *	@hardreset: hardreset method
739  *	@postreset: postreset method (can be NULL)
740  *
741  *	Recover PMP attached to @ap.  Recovery procedure is somewhat
742  *	similar to that of ata_eh_recover() except that reset should
743  *	always be performed in hard->soft sequence and recovery
744  *	failure results in PMP detachment.
745  *
746  *	LOCKING:
747  *	Kernel thread context (may sleep).
748  *
749  *	RETURNS:
750  *	0 on success, -errno on failure.
751  */
752 static int sata_pmp_eh_recover_pmp(struct ata_port *ap,
753 		ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
754 		ata_reset_fn_t hardreset, ata_postreset_fn_t postreset)
755 {
756 	struct ata_link *link = &ap->link;
757 	struct ata_eh_context *ehc = &link->eh_context;
758 	struct ata_device *dev = link->device;
759 	int tries = ATA_EH_PMP_TRIES;
760 	int detach = 0, rc = 0;
761 	int reval_failed = 0;
762 
763 	DPRINTK("ENTER\n");
764 
765 	if (dev->flags & ATA_DFLAG_DETACH) {
766 		detach = 1;
767 		goto fail;
768 	}
769 
770  retry:
771 	ehc->classes[0] = ATA_DEV_UNKNOWN;
772 
773 	if (ehc->i.action & ATA_EH_RESET) {
774 		struct ata_link *tlink;
775 
776 		/* reset */
777 		rc = ata_eh_reset(link, 0, prereset, softreset, hardreset,
778 				  postreset);
779 		if (rc) {
780 			ata_link_printk(link, KERN_ERR,
781 					"failed to reset PMP, giving up\n");
782 			goto fail;
783 		}
784 
785 		/* PMP is reset, SErrors cannot be trusted, scan all */
786 		ata_for_each_link(tlink, ap, EDGE) {
787 			struct ata_eh_context *ehc = &tlink->eh_context;
788 
789 			ehc->i.probe_mask |= ATA_ALL_DEVICES;
790 			ehc->i.action |= ATA_EH_RESET;
791 		}
792 	}
793 
794 	/* If revalidation is requested, revalidate and reconfigure;
795 	 * otherwise, do quick revalidation.
796 	 */
797 	if (ehc->i.action & ATA_EH_REVALIDATE)
798 		rc = sata_pmp_revalidate(dev, ehc->classes[0]);
799 	else
800 		rc = sata_pmp_revalidate_quick(dev);
801 
802 	if (rc) {
803 		tries--;
804 
805 		if (rc == -ENODEV) {
806 			ehc->i.probe_mask |= ATA_ALL_DEVICES;
807 			detach = 1;
808 			/* give it just two more chances */
809 			tries = min(tries, 2);
810 		}
811 
812 		if (tries) {
813 			/* consecutive revalidation failures? speed down */
814 			if (reval_failed)
815 				sata_down_spd_limit(link, 0);
816 			else
817 				reval_failed = 1;
818 
819 			ehc->i.action |= ATA_EH_RESET;
820 			goto retry;
821 		} else {
822 			ata_dev_printk(dev, KERN_ERR, "failed to recover PMP "
823 				       "after %d tries, giving up\n",
824 				       ATA_EH_PMP_TRIES);
825 			goto fail;
826 		}
827 	}
828 
829 	/* okay, PMP resurrected */
830 	ehc->i.flags = 0;
831 
832 	DPRINTK("EXIT, rc=0\n");
833 	return 0;
834 
835  fail:
836 	sata_pmp_detach(dev);
837 	if (detach)
838 		ata_eh_detach_dev(dev);
839 	else
840 		ata_dev_disable(dev);
841 
842 	DPRINTK("EXIT, rc=%d\n", rc);
843 	return rc;
844 }
845 
846 static int sata_pmp_eh_handle_disabled_links(struct ata_port *ap)
847 {
848 	struct ata_link *link;
849 	unsigned long flags;
850 	int rc;
851 
852 	spin_lock_irqsave(ap->lock, flags);
853 
854 	ata_for_each_link(link, ap, EDGE) {
855 		if (!(link->flags & ATA_LFLAG_DISABLED))
856 			continue;
857 
858 		spin_unlock_irqrestore(ap->lock, flags);
859 
860 		/* Some PMPs require hardreset sequence to get
861 		 * SError.N working.
862 		 */
863 		sata_link_hardreset(link, sata_deb_timing_normal,
864 				ata_deadline(jiffies, ATA_TMOUT_INTERNAL_QUICK),
865 				NULL, NULL);
866 
867 		/* unconditionally clear SError.N */
868 		rc = sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
869 		if (rc) {
870 			ata_link_printk(link, KERN_ERR, "failed to clear "
871 					"SError.N (errno=%d)\n", rc);
872 			return rc;
873 		}
874 
875 		spin_lock_irqsave(ap->lock, flags);
876 	}
877 
878 	spin_unlock_irqrestore(ap->lock, flags);
879 
880 	return 0;
881 }
882 
883 static int sata_pmp_handle_link_fail(struct ata_link *link, int *link_tries)
884 {
885 	struct ata_port *ap = link->ap;
886 	unsigned long flags;
887 
888 	if (link_tries[link->pmp] && --link_tries[link->pmp])
889 		return 1;
890 
891 	/* disable this link */
892 	if (!(link->flags & ATA_LFLAG_DISABLED)) {
893 		ata_link_printk(link, KERN_WARNING,
894 			"failed to recover link after %d tries, disabling\n",
895 			ATA_EH_PMP_LINK_TRIES);
896 
897 		spin_lock_irqsave(ap->lock, flags);
898 		link->flags |= ATA_LFLAG_DISABLED;
899 		spin_unlock_irqrestore(ap->lock, flags);
900 	}
901 
902 	ata_dev_disable(link->device);
903 	link->eh_context.i.action = 0;
904 
905 	return 0;
906 }
907 
908 /**
909  *	sata_pmp_eh_recover - recover PMP-enabled port
910  *	@ap: ATA port to recover
911  *
912  *	Drive EH recovery operation for PMP enabled port @ap.  This
913  *	function recovers host and PMP ports with proper retrials and
914  *	fallbacks.  Actual recovery operations are performed using
915  *	ata_eh_recover() and sata_pmp_eh_recover_pmp().
916  *
917  *	LOCKING:
918  *	Kernel thread context (may sleep).
919  *
920  *	RETURNS:
921  *	0 on success, -errno on failure.
922  */
923 static int sata_pmp_eh_recover(struct ata_port *ap)
924 {
925 	struct ata_port_operations *ops = ap->ops;
926 	int pmp_tries, link_tries[SATA_PMP_MAX_PORTS];
927 	struct ata_link *pmp_link = &ap->link;
928 	struct ata_device *pmp_dev = pmp_link->device;
929 	struct ata_eh_context *pmp_ehc = &pmp_link->eh_context;
930 	u32 *gscr = pmp_dev->gscr;
931 	struct ata_link *link;
932 	struct ata_device *dev;
933 	unsigned int err_mask;
934 	u32 gscr_error, sntf;
935 	int cnt, rc;
936 
937 	pmp_tries = ATA_EH_PMP_TRIES;
938 	ata_for_each_link(link, ap, EDGE)
939 		link_tries[link->pmp] = ATA_EH_PMP_LINK_TRIES;
940 
941  retry:
942 	/* PMP attached? */
943 	if (!sata_pmp_attached(ap)) {
944 		rc = ata_eh_recover(ap, ops->prereset, ops->softreset,
945 				    ops->hardreset, ops->postreset, NULL);
946 		if (rc) {
947 			ata_for_each_dev(dev, &ap->link, ALL)
948 				ata_dev_disable(dev);
949 			return rc;
950 		}
951 
952 		if (pmp_dev->class != ATA_DEV_PMP)
953 			return 0;
954 
955 		/* new PMP online */
956 		ata_for_each_link(link, ap, EDGE)
957 			link_tries[link->pmp] = ATA_EH_PMP_LINK_TRIES;
958 
959 		/* fall through */
960 	}
961 
962 	/* recover pmp */
963 	rc = sata_pmp_eh_recover_pmp(ap, ops->prereset, ops->softreset,
964 				     ops->hardreset, ops->postreset);
965 	if (rc)
966 		goto pmp_fail;
967 
968 	/* PHY event notification can disturb reset and other recovery
969 	 * operations.  Turn it off.
970 	 */
971 	if (gscr[SATA_PMP_GSCR_FEAT_EN] & SATA_PMP_FEAT_NOTIFY) {
972 		gscr[SATA_PMP_GSCR_FEAT_EN] &= ~SATA_PMP_FEAT_NOTIFY;
973 
974 		err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
975 					  gscr[SATA_PMP_GSCR_FEAT_EN]);
976 		if (err_mask) {
977 			ata_link_printk(pmp_link, KERN_WARNING,
978 				"failed to disable NOTIFY (err_mask=0x%x)\n",
979 				err_mask);
980 			goto pmp_fail;
981 		}
982 	}
983 
984 	/* handle disabled links */
985 	rc = sata_pmp_eh_handle_disabled_links(ap);
986 	if (rc)
987 		goto pmp_fail;
988 
989 	/* recover links */
990 	rc = ata_eh_recover(ap, ops->pmp_prereset, ops->pmp_softreset,
991 			    ops->pmp_hardreset, ops->pmp_postreset, &link);
992 	if (rc)
993 		goto link_fail;
994 
995 	/* clear SNotification */
996 	rc = sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf);
997 	if (rc == 0)
998 		sata_scr_write(&ap->link, SCR_NOTIFICATION, sntf);
999 
1000 	/*
1001 	 * If LPM is active on any fan-out port, hotplug wouldn't
1002 	 * work.  Return w/ PHY event notification disabled.
1003 	 */
1004 	ata_for_each_link(link, ap, EDGE)
1005 		if (link->lpm_policy > ATA_LPM_MAX_POWER)
1006 			return 0;
1007 
1008 	/*
1009 	 * Connection status might have changed while resetting other
1010 	 * links, enable notification and check SATA_PMP_GSCR_ERROR
1011 	 * before returning.
1012 	 */
1013 
1014 	/* enable notification */
1015 	if (pmp_dev->flags & ATA_DFLAG_AN) {
1016 		gscr[SATA_PMP_GSCR_FEAT_EN] |= SATA_PMP_FEAT_NOTIFY;
1017 
1018 		err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
1019 					  gscr[SATA_PMP_GSCR_FEAT_EN]);
1020 		if (err_mask) {
1021 			ata_dev_printk(pmp_dev, KERN_ERR, "failed to write "
1022 				       "PMP_FEAT_EN (Emask=0x%x)\n", err_mask);
1023 			rc = -EIO;
1024 			goto pmp_fail;
1025 		}
1026 	}
1027 
1028 	/* check GSCR_ERROR */
1029 	err_mask = sata_pmp_read(pmp_link, SATA_PMP_GSCR_ERROR, &gscr_error);
1030 	if (err_mask) {
1031 		ata_dev_printk(pmp_dev, KERN_ERR, "failed to read "
1032 			       "PMP_GSCR_ERROR (Emask=0x%x)\n", err_mask);
1033 		rc = -EIO;
1034 		goto pmp_fail;
1035 	}
1036 
1037 	cnt = 0;
1038 	ata_for_each_link(link, ap, EDGE) {
1039 		if (!(gscr_error & (1 << link->pmp)))
1040 			continue;
1041 
1042 		if (sata_pmp_handle_link_fail(link, link_tries)) {
1043 			ata_ehi_hotplugged(&link->eh_context.i);
1044 			cnt++;
1045 		} else {
1046 			ata_link_printk(link, KERN_WARNING,
1047 				"PHY status changed but maxed out on retries, "
1048 				"giving up\n");
1049 			ata_link_printk(link, KERN_WARNING,
1050 				"Manully issue scan to resume this link\n");
1051 		}
1052 	}
1053 
1054 	if (cnt) {
1055 		ata_port_printk(ap, KERN_INFO, "PMP SError.N set for some "
1056 				"ports, repeating recovery\n");
1057 		goto retry;
1058 	}
1059 
1060 	return 0;
1061 
1062  link_fail:
1063 	if (sata_pmp_handle_link_fail(link, link_tries)) {
1064 		pmp_ehc->i.action |= ATA_EH_RESET;
1065 		goto retry;
1066 	}
1067 
1068 	/* fall through */
1069  pmp_fail:
1070 	/* Control always ends up here after detaching PMP.  Shut up
1071 	 * and return if we're unloading.
1072 	 */
1073 	if (ap->pflags & ATA_PFLAG_UNLOADING)
1074 		return rc;
1075 
1076 	if (!sata_pmp_attached(ap))
1077 		goto retry;
1078 
1079 	if (--pmp_tries) {
1080 		pmp_ehc->i.action |= ATA_EH_RESET;
1081 		goto retry;
1082 	}
1083 
1084 	ata_port_printk(ap, KERN_ERR,
1085 			"failed to recover PMP after %d tries, giving up\n",
1086 			ATA_EH_PMP_TRIES);
1087 	sata_pmp_detach(pmp_dev);
1088 	ata_dev_disable(pmp_dev);
1089 
1090 	return rc;
1091 }
1092 
1093 /**
1094  *	sata_pmp_error_handler - do standard error handling for PMP-enabled host
1095  *	@ap: host port to handle error for
1096  *
1097  *	Perform standard error handling sequence for PMP-enabled host
1098  *	@ap.
1099  *
1100  *	LOCKING:
1101  *	Kernel thread context (may sleep).
1102  */
1103 void sata_pmp_error_handler(struct ata_port *ap)
1104 {
1105 	ata_eh_autopsy(ap);
1106 	ata_eh_report(ap);
1107 	sata_pmp_eh_recover(ap);
1108 	ata_eh_finish(ap);
1109 }
1110 
1111 EXPORT_SYMBOL_GPL(sata_pmp_port_ops);
1112 EXPORT_SYMBOL_GPL(sata_pmp_qc_defer_cmd_switch);
1113 EXPORT_SYMBOL_GPL(sata_pmp_error_handler);
1114