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 */
sata_pmp_read(struct ata_link * link,int reg,u32 * r_val)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 */
sata_pmp_write(struct ata_link * link,int reg,u32 val)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 */
sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd * qc)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 */
sata_pmp_scr_read(struct ata_link * link,int reg,u32 * r_val)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 */
sata_pmp_scr_write(struct ata_link * link,int reg,u32 val)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 */
sata_pmp_set_lpm(struct ata_link * link,enum ata_lpm_policy policy,unsigned hints)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 */
sata_pmp_read_gscr(struct ata_device * dev,u32 * gscr)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
sata_pmp_spec_rev_str(const u32 * gscr)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
sata_pmp_configure(struct ata_device * dev,int print_info)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, ®);
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
sata_pmp_init_links(struct ata_port * ap,int nr_ports)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
sata_pmp_quirks(struct ata_port * ap)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 }
453 }
454
455 /**
456 * sata_pmp_attach - attach a SATA PMP device
457 * @dev: SATA PMP device to attach
458 *
459 * Configure and attach SATA PMP device @dev. This function is
460 * also responsible for allocating and initializing PMP links.
461 *
462 * LOCKING:
463 * Kernel thread context (may sleep).
464 *
465 * RETURNS:
466 * 0 on success, -errno on failure.
467 */
sata_pmp_attach(struct ata_device * dev)468 int sata_pmp_attach(struct ata_device *dev)
469 {
470 struct ata_link *link = dev->link;
471 struct ata_port *ap = link->ap;
472 unsigned long flags;
473 struct ata_link *tlink;
474 int rc;
475
476 /* is it hanging off the right place? */
477 if (!sata_pmp_supported(ap)) {
478 ata_dev_printk(dev, KERN_ERR,
479 "host does not support Port Multiplier\n");
480 return -EINVAL;
481 }
482
483 if (!ata_is_host_link(link)) {
484 ata_dev_printk(dev, KERN_ERR,
485 "Port Multipliers cannot be nested\n");
486 return -EINVAL;
487 }
488
489 if (dev->devno) {
490 ata_dev_printk(dev, KERN_ERR,
491 "Port Multiplier must be the first device\n");
492 return -EINVAL;
493 }
494
495 WARN_ON(link->pmp != 0);
496 link->pmp = SATA_PMP_CTRL_PORT;
497
498 /* read GSCR block */
499 rc = sata_pmp_read_gscr(dev, dev->gscr);
500 if (rc)
501 goto fail;
502
503 /* config PMP */
504 rc = sata_pmp_configure(dev, 1);
505 if (rc)
506 goto fail;
507
508 rc = sata_pmp_init_links(ap, sata_pmp_gscr_ports(dev->gscr));
509 if (rc) {
510 ata_dev_printk(dev, KERN_INFO,
511 "failed to initialize PMP links\n");
512 goto fail;
513 }
514
515 /* attach it */
516 spin_lock_irqsave(ap->lock, flags);
517 WARN_ON(ap->nr_pmp_links);
518 ap->nr_pmp_links = sata_pmp_gscr_ports(dev->gscr);
519 spin_unlock_irqrestore(ap->lock, flags);
520
521 sata_pmp_quirks(ap);
522
523 if (ap->ops->pmp_attach)
524 ap->ops->pmp_attach(ap);
525
526 ata_for_each_link(tlink, ap, EDGE)
527 sata_link_init_spd(tlink);
528
529 ata_acpi_associate_sata_port(ap);
530
531 return 0;
532
533 fail:
534 link->pmp = 0;
535 return rc;
536 }
537
538 /**
539 * sata_pmp_detach - detach a SATA PMP device
540 * @dev: SATA PMP device to detach
541 *
542 * Detach SATA PMP device @dev. This function is also
543 * responsible for deconfiguring PMP links.
544 *
545 * LOCKING:
546 * Kernel thread context (may sleep).
547 */
sata_pmp_detach(struct ata_device * dev)548 static void sata_pmp_detach(struct ata_device *dev)
549 {
550 struct ata_link *link = dev->link;
551 struct ata_port *ap = link->ap;
552 struct ata_link *tlink;
553 unsigned long flags;
554
555 ata_dev_printk(dev, KERN_INFO, "Port Multiplier detaching\n");
556
557 WARN_ON(!ata_is_host_link(link) || dev->devno ||
558 link->pmp != SATA_PMP_CTRL_PORT);
559
560 if (ap->ops->pmp_detach)
561 ap->ops->pmp_detach(ap);
562
563 ata_for_each_link(tlink, ap, EDGE)
564 ata_eh_detach_dev(tlink->device);
565
566 spin_lock_irqsave(ap->lock, flags);
567 ap->nr_pmp_links = 0;
568 link->pmp = 0;
569 spin_unlock_irqrestore(ap->lock, flags);
570
571 ata_acpi_associate_sata_port(ap);
572 }
573
574 /**
575 * sata_pmp_same_pmp - does new GSCR matches the configured PMP?
576 * @dev: PMP device to compare against
577 * @new_gscr: GSCR block of the new device
578 *
579 * Compare @new_gscr against @dev and determine whether @dev is
580 * the PMP described by @new_gscr.
581 *
582 * LOCKING:
583 * None.
584 *
585 * RETURNS:
586 * 1 if @dev matches @new_gscr, 0 otherwise.
587 */
sata_pmp_same_pmp(struct ata_device * dev,const u32 * new_gscr)588 static int sata_pmp_same_pmp(struct ata_device *dev, const u32 *new_gscr)
589 {
590 const u32 *old_gscr = dev->gscr;
591 u16 old_vendor, new_vendor, old_devid, new_devid;
592 int old_nr_ports, new_nr_ports;
593
594 old_vendor = sata_pmp_gscr_vendor(old_gscr);
595 new_vendor = sata_pmp_gscr_vendor(new_gscr);
596 old_devid = sata_pmp_gscr_devid(old_gscr);
597 new_devid = sata_pmp_gscr_devid(new_gscr);
598 old_nr_ports = sata_pmp_gscr_ports(old_gscr);
599 new_nr_ports = sata_pmp_gscr_ports(new_gscr);
600
601 if (old_vendor != new_vendor) {
602 ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
603 "vendor mismatch '0x%x' != '0x%x'\n",
604 old_vendor, new_vendor);
605 return 0;
606 }
607
608 if (old_devid != new_devid) {
609 ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
610 "device ID mismatch '0x%x' != '0x%x'\n",
611 old_devid, new_devid);
612 return 0;
613 }
614
615 if (old_nr_ports != new_nr_ports) {
616 ata_dev_printk(dev, KERN_INFO, "Port Multiplier "
617 "nr_ports mismatch '0x%x' != '0x%x'\n",
618 old_nr_ports, new_nr_ports);
619 return 0;
620 }
621
622 return 1;
623 }
624
625 /**
626 * sata_pmp_revalidate - revalidate SATA PMP
627 * @dev: PMP device to revalidate
628 * @new_class: new class code
629 *
630 * Re-read GSCR block and make sure @dev is still attached to the
631 * port and properly configured.
632 *
633 * LOCKING:
634 * Kernel thread context (may sleep).
635 *
636 * RETURNS:
637 * 0 on success, -errno otherwise.
638 */
sata_pmp_revalidate(struct ata_device * dev,unsigned int new_class)639 static int sata_pmp_revalidate(struct ata_device *dev, unsigned int new_class)
640 {
641 struct ata_link *link = dev->link;
642 struct ata_port *ap = link->ap;
643 u32 *gscr = (void *)ap->sector_buf;
644 int rc;
645
646 DPRINTK("ENTER\n");
647
648 ata_eh_about_to_do(link, NULL, ATA_EH_REVALIDATE);
649
650 if (!ata_dev_enabled(dev)) {
651 rc = -ENODEV;
652 goto fail;
653 }
654
655 /* wrong class? */
656 if (ata_class_enabled(new_class) && new_class != ATA_DEV_PMP) {
657 rc = -ENODEV;
658 goto fail;
659 }
660
661 /* read GSCR */
662 rc = sata_pmp_read_gscr(dev, gscr);
663 if (rc)
664 goto fail;
665
666 /* is the pmp still there? */
667 if (!sata_pmp_same_pmp(dev, gscr)) {
668 rc = -ENODEV;
669 goto fail;
670 }
671
672 memcpy(dev->gscr, gscr, sizeof(gscr[0]) * SATA_PMP_GSCR_DWORDS);
673
674 rc = sata_pmp_configure(dev, 0);
675 if (rc)
676 goto fail;
677
678 ata_eh_done(link, NULL, ATA_EH_REVALIDATE);
679
680 DPRINTK("EXIT, rc=0\n");
681 return 0;
682
683 fail:
684 ata_dev_printk(dev, KERN_ERR,
685 "PMP revalidation failed (errno=%d)\n", rc);
686 DPRINTK("EXIT, rc=%d\n", rc);
687 return rc;
688 }
689
690 /**
691 * sata_pmp_revalidate_quick - revalidate SATA PMP quickly
692 * @dev: PMP device to revalidate
693 *
694 * Make sure the attached PMP is accessible.
695 *
696 * LOCKING:
697 * Kernel thread context (may sleep).
698 *
699 * RETURNS:
700 * 0 on success, -errno otherwise.
701 */
sata_pmp_revalidate_quick(struct ata_device * dev)702 static int sata_pmp_revalidate_quick(struct ata_device *dev)
703 {
704 unsigned int err_mask;
705 u32 prod_id;
706
707 err_mask = sata_pmp_read(dev->link, SATA_PMP_GSCR_PROD_ID, &prod_id);
708 if (err_mask) {
709 ata_dev_printk(dev, KERN_ERR, "failed to read PMP product ID "
710 "(Emask=0x%x)\n", err_mask);
711 return -EIO;
712 }
713
714 if (prod_id != dev->gscr[SATA_PMP_GSCR_PROD_ID]) {
715 ata_dev_printk(dev, KERN_ERR, "PMP product ID mismatch\n");
716 /* something weird is going on, request full PMP recovery */
717 return -EIO;
718 }
719
720 return 0;
721 }
722
723 /**
724 * sata_pmp_eh_recover_pmp - recover PMP
725 * @ap: ATA port PMP is attached to
726 * @prereset: prereset method (can be NULL)
727 * @softreset: softreset method
728 * @hardreset: hardreset method
729 * @postreset: postreset method (can be NULL)
730 *
731 * Recover PMP attached to @ap. Recovery procedure is somewhat
732 * similar to that of ata_eh_recover() except that reset should
733 * always be performed in hard->soft sequence and recovery
734 * failure results in PMP detachment.
735 *
736 * LOCKING:
737 * Kernel thread context (may sleep).
738 *
739 * RETURNS:
740 * 0 on success, -errno on failure.
741 */
sata_pmp_eh_recover_pmp(struct ata_port * ap,ata_prereset_fn_t prereset,ata_reset_fn_t softreset,ata_reset_fn_t hardreset,ata_postreset_fn_t postreset)742 static int sata_pmp_eh_recover_pmp(struct ata_port *ap,
743 ata_prereset_fn_t prereset, ata_reset_fn_t softreset,
744 ata_reset_fn_t hardreset, ata_postreset_fn_t postreset)
745 {
746 struct ata_link *link = &ap->link;
747 struct ata_eh_context *ehc = &link->eh_context;
748 struct ata_device *dev = link->device;
749 int tries = ATA_EH_PMP_TRIES;
750 int detach = 0, rc = 0;
751 int reval_failed = 0;
752
753 DPRINTK("ENTER\n");
754
755 if (dev->flags & ATA_DFLAG_DETACH) {
756 detach = 1;
757 goto fail;
758 }
759
760 retry:
761 ehc->classes[0] = ATA_DEV_UNKNOWN;
762
763 if (ehc->i.action & ATA_EH_RESET) {
764 struct ata_link *tlink;
765
766 /* reset */
767 rc = ata_eh_reset(link, 0, prereset, softreset, hardreset,
768 postreset);
769 if (rc) {
770 ata_link_printk(link, KERN_ERR,
771 "failed to reset PMP, giving up\n");
772 goto fail;
773 }
774
775 /* PMP is reset, SErrors cannot be trusted, scan all */
776 ata_for_each_link(tlink, ap, EDGE) {
777 struct ata_eh_context *ehc = &tlink->eh_context;
778
779 ehc->i.probe_mask |= ATA_ALL_DEVICES;
780 ehc->i.action |= ATA_EH_RESET;
781 }
782 }
783
784 /* If revalidation is requested, revalidate and reconfigure;
785 * otherwise, do quick revalidation.
786 */
787 if (ehc->i.action & ATA_EH_REVALIDATE)
788 rc = sata_pmp_revalidate(dev, ehc->classes[0]);
789 else
790 rc = sata_pmp_revalidate_quick(dev);
791
792 if (rc) {
793 tries--;
794
795 if (rc == -ENODEV) {
796 ehc->i.probe_mask |= ATA_ALL_DEVICES;
797 detach = 1;
798 /* give it just two more chances */
799 tries = min(tries, 2);
800 }
801
802 if (tries) {
803 /* consecutive revalidation failures? speed down */
804 if (reval_failed)
805 sata_down_spd_limit(link, 0);
806 else
807 reval_failed = 1;
808
809 ehc->i.action |= ATA_EH_RESET;
810 goto retry;
811 } else {
812 ata_dev_printk(dev, KERN_ERR, "failed to recover PMP "
813 "after %d tries, giving up\n",
814 ATA_EH_PMP_TRIES);
815 goto fail;
816 }
817 }
818
819 /* okay, PMP resurrected */
820 ehc->i.flags = 0;
821
822 DPRINTK("EXIT, rc=0\n");
823 return 0;
824
825 fail:
826 sata_pmp_detach(dev);
827 if (detach)
828 ata_eh_detach_dev(dev);
829 else
830 ata_dev_disable(dev);
831
832 DPRINTK("EXIT, rc=%d\n", rc);
833 return rc;
834 }
835
sata_pmp_eh_handle_disabled_links(struct ata_port * ap)836 static int sata_pmp_eh_handle_disabled_links(struct ata_port *ap)
837 {
838 struct ata_link *link;
839 unsigned long flags;
840 int rc;
841
842 spin_lock_irqsave(ap->lock, flags);
843
844 ata_for_each_link(link, ap, EDGE) {
845 if (!(link->flags & ATA_LFLAG_DISABLED))
846 continue;
847
848 spin_unlock_irqrestore(ap->lock, flags);
849
850 /* Some PMPs require hardreset sequence to get
851 * SError.N working.
852 */
853 sata_link_hardreset(link, sata_deb_timing_normal,
854 ata_deadline(jiffies, ATA_TMOUT_INTERNAL_QUICK),
855 NULL, NULL);
856
857 /* unconditionally clear SError.N */
858 rc = sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
859 if (rc) {
860 ata_link_printk(link, KERN_ERR, "failed to clear "
861 "SError.N (errno=%d)\n", rc);
862 return rc;
863 }
864
865 spin_lock_irqsave(ap->lock, flags);
866 }
867
868 spin_unlock_irqrestore(ap->lock, flags);
869
870 return 0;
871 }
872
sata_pmp_handle_link_fail(struct ata_link * link,int * link_tries)873 static int sata_pmp_handle_link_fail(struct ata_link *link, int *link_tries)
874 {
875 struct ata_port *ap = link->ap;
876 unsigned long flags;
877
878 if (link_tries[link->pmp] && --link_tries[link->pmp])
879 return 1;
880
881 /* disable this link */
882 if (!(link->flags & ATA_LFLAG_DISABLED)) {
883 ata_link_printk(link, KERN_WARNING,
884 "failed to recover link after %d tries, disabling\n",
885 ATA_EH_PMP_LINK_TRIES);
886
887 spin_lock_irqsave(ap->lock, flags);
888 link->flags |= ATA_LFLAG_DISABLED;
889 spin_unlock_irqrestore(ap->lock, flags);
890 }
891
892 ata_dev_disable(link->device);
893 link->eh_context.i.action = 0;
894
895 return 0;
896 }
897
898 /**
899 * sata_pmp_eh_recover - recover PMP-enabled port
900 * @ap: ATA port to recover
901 *
902 * Drive EH recovery operation for PMP enabled port @ap. This
903 * function recovers host and PMP ports with proper retrials and
904 * fallbacks. Actual recovery operations are performed using
905 * ata_eh_recover() and sata_pmp_eh_recover_pmp().
906 *
907 * LOCKING:
908 * Kernel thread context (may sleep).
909 *
910 * RETURNS:
911 * 0 on success, -errno on failure.
912 */
sata_pmp_eh_recover(struct ata_port * ap)913 static int sata_pmp_eh_recover(struct ata_port *ap)
914 {
915 struct ata_port_operations *ops = ap->ops;
916 int pmp_tries, link_tries[SATA_PMP_MAX_PORTS];
917 struct ata_link *pmp_link = &ap->link;
918 struct ata_device *pmp_dev = pmp_link->device;
919 struct ata_eh_context *pmp_ehc = &pmp_link->eh_context;
920 u32 *gscr = pmp_dev->gscr;
921 struct ata_link *link;
922 struct ata_device *dev;
923 unsigned int err_mask;
924 u32 gscr_error, sntf;
925 int cnt, rc;
926
927 pmp_tries = ATA_EH_PMP_TRIES;
928 ata_for_each_link(link, ap, EDGE)
929 link_tries[link->pmp] = ATA_EH_PMP_LINK_TRIES;
930
931 retry:
932 /* PMP attached? */
933 if (!sata_pmp_attached(ap)) {
934 rc = ata_eh_recover(ap, ops->prereset, ops->softreset,
935 ops->hardreset, ops->postreset, NULL);
936 if (rc) {
937 ata_for_each_dev(dev, &ap->link, ALL)
938 ata_dev_disable(dev);
939 return rc;
940 }
941
942 if (pmp_dev->class != ATA_DEV_PMP)
943 return 0;
944
945 /* new PMP online */
946 ata_for_each_link(link, ap, EDGE)
947 link_tries[link->pmp] = ATA_EH_PMP_LINK_TRIES;
948
949 /* fall through */
950 }
951
952 /* recover pmp */
953 rc = sata_pmp_eh_recover_pmp(ap, ops->prereset, ops->softreset,
954 ops->hardreset, ops->postreset);
955 if (rc)
956 goto pmp_fail;
957
958 /* PHY event notification can disturb reset and other recovery
959 * operations. Turn it off.
960 */
961 if (gscr[SATA_PMP_GSCR_FEAT_EN] & SATA_PMP_FEAT_NOTIFY) {
962 gscr[SATA_PMP_GSCR_FEAT_EN] &= ~SATA_PMP_FEAT_NOTIFY;
963
964 err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
965 gscr[SATA_PMP_GSCR_FEAT_EN]);
966 if (err_mask) {
967 ata_link_printk(pmp_link, KERN_WARNING,
968 "failed to disable NOTIFY (err_mask=0x%x)\n",
969 err_mask);
970 goto pmp_fail;
971 }
972 }
973
974 /* handle disabled links */
975 rc = sata_pmp_eh_handle_disabled_links(ap);
976 if (rc)
977 goto pmp_fail;
978
979 /* recover links */
980 rc = ata_eh_recover(ap, ops->pmp_prereset, ops->pmp_softreset,
981 ops->pmp_hardreset, ops->pmp_postreset, &link);
982 if (rc)
983 goto link_fail;
984
985 /* clear SNotification */
986 rc = sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf);
987 if (rc == 0)
988 sata_scr_write(&ap->link, SCR_NOTIFICATION, sntf);
989
990 /*
991 * If LPM is active on any fan-out port, hotplug wouldn't
992 * work. Return w/ PHY event notification disabled.
993 */
994 ata_for_each_link(link, ap, EDGE)
995 if (link->lpm_policy > ATA_LPM_MAX_POWER)
996 return 0;
997
998 /*
999 * Connection status might have changed while resetting other
1000 * links, enable notification and check SATA_PMP_GSCR_ERROR
1001 * before returning.
1002 */
1003
1004 /* enable notification */
1005 if (pmp_dev->flags & ATA_DFLAG_AN) {
1006 gscr[SATA_PMP_GSCR_FEAT_EN] |= SATA_PMP_FEAT_NOTIFY;
1007
1008 err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
1009 gscr[SATA_PMP_GSCR_FEAT_EN]);
1010 if (err_mask) {
1011 ata_dev_printk(pmp_dev, KERN_ERR, "failed to write "
1012 "PMP_FEAT_EN (Emask=0x%x)\n", err_mask);
1013 rc = -EIO;
1014 goto pmp_fail;
1015 }
1016 }
1017
1018 /* check GSCR_ERROR */
1019 err_mask = sata_pmp_read(pmp_link, SATA_PMP_GSCR_ERROR, &gscr_error);
1020 if (err_mask) {
1021 ata_dev_printk(pmp_dev, KERN_ERR, "failed to read "
1022 "PMP_GSCR_ERROR (Emask=0x%x)\n", err_mask);
1023 rc = -EIO;
1024 goto pmp_fail;
1025 }
1026
1027 cnt = 0;
1028 ata_for_each_link(link, ap, EDGE) {
1029 if (!(gscr_error & (1 << link->pmp)))
1030 continue;
1031
1032 if (sata_pmp_handle_link_fail(link, link_tries)) {
1033 ata_ehi_hotplugged(&link->eh_context.i);
1034 cnt++;
1035 } else {
1036 ata_link_printk(link, KERN_WARNING,
1037 "PHY status changed but maxed out on retries, "
1038 "giving up\n");
1039 ata_link_printk(link, KERN_WARNING,
1040 "Manully issue scan to resume this link\n");
1041 }
1042 }
1043
1044 if (cnt) {
1045 ata_port_printk(ap, KERN_INFO, "PMP SError.N set for some "
1046 "ports, repeating recovery\n");
1047 goto retry;
1048 }
1049
1050 return 0;
1051
1052 link_fail:
1053 if (sata_pmp_handle_link_fail(link, link_tries)) {
1054 pmp_ehc->i.action |= ATA_EH_RESET;
1055 goto retry;
1056 }
1057
1058 /* fall through */
1059 pmp_fail:
1060 /* Control always ends up here after detaching PMP. Shut up
1061 * and return if we're unloading.
1062 */
1063 if (ap->pflags & ATA_PFLAG_UNLOADING)
1064 return rc;
1065
1066 if (!sata_pmp_attached(ap))
1067 goto retry;
1068
1069 if (--pmp_tries) {
1070 pmp_ehc->i.action |= ATA_EH_RESET;
1071 goto retry;
1072 }
1073
1074 ata_port_printk(ap, KERN_ERR,
1075 "failed to recover PMP after %d tries, giving up\n",
1076 ATA_EH_PMP_TRIES);
1077 sata_pmp_detach(pmp_dev);
1078 ata_dev_disable(pmp_dev);
1079
1080 return rc;
1081 }
1082
1083 /**
1084 * sata_pmp_error_handler - do standard error handling for PMP-enabled host
1085 * @ap: host port to handle error for
1086 *
1087 * Perform standard error handling sequence for PMP-enabled host
1088 * @ap.
1089 *
1090 * LOCKING:
1091 * Kernel thread context (may sleep).
1092 */
sata_pmp_error_handler(struct ata_port * ap)1093 void sata_pmp_error_handler(struct ata_port *ap)
1094 {
1095 ata_eh_autopsy(ap);
1096 ata_eh_report(ap);
1097 sata_pmp_eh_recover(ap);
1098 ata_eh_finish(ap);
1099 }
1100
1101 EXPORT_SYMBOL_GPL(sata_pmp_port_ops);
1102 EXPORT_SYMBOL_GPL(sata_pmp_qc_defer_cmd_switch);
1103 EXPORT_SYMBOL_GPL(sata_pmp_error_handler);
1104