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