drivers/ata/libata-pmp.c

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