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 const struct ata_port_operations sata_pmp_port_ops = {
  17         .inherits               = &sata_port_ops,
  18         .pmp_prereset           = ata_std_prereset,
  19         .pmp_hardreset          = sata_std_hardreset,
  20         .pmp_postreset          = ata_std_postreset,
  21         .error_handler          = sata_pmp_error_handler,
  22 };
  23
  24 /**
  25  *      sata_pmp_read - read PMP register
  26  *      @link: link to read PMP register for
  27  *      @reg: register to read
  28  *      @r_val: resulting value
  29  *
  30  *      Read PMP register.
  31  *
  32  *      LOCKING:
  33  *      Kernel thread context (may sleep).
  34  *
  35  *      RETURNS:
  36  *      0 on success, AC_ERR_* mask on failure.
  37  */
  38 static unsigned int sata_pmp_read(struct ata_link *link, int reg, u32 *r_val)
  39 {
  40         struct ata_port *ap = link->ap;
  41         struct ata_device *pmp_dev = ap->link.device;
  42         struct ata_taskfile tf;
  43         unsigned int err_mask;
  44
  45         ata_tf_init(pmp_dev, &tf);
  46         tf.command = ATA_CMD_PMP_READ;
  47         tf.protocol = ATA_PROT_NODATA;
  48         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
  49         tf.feature = reg;
  50         tf.device = link->pmp;
  51
  52         err_mask = ata_exec_internal(pmp_dev, &tf, NULL, DMA_NONE, NULL, 0,
  53                                      SATA_PMP_RW_TIMEOUT);
  54         if (err_mask)
  55                 return err_mask;
  56
  57         *r_val = tf.nsect | tf.lbal << 8 | tf.lbam << 16 | tf.lbah << 24;
  58         return 0;
  59 }
  60
  61 /**
  62  *      sata_pmp_write - write PMP register
  63  *      @link: link to write PMP register for
  64  *      @reg: register to write
  65  *      @r_val: value to write
  66  *
  67  *      Write PMP register.
  68  *
  69  *      LOCKING:
  70  *      Kernel thread context (may sleep).
  71  *
  72  *      RETURNS:
  73  *      0 on success, AC_ERR_* mask on failure.
  74  */
  75 static unsigned int sata_pmp_write(struct ata_link *link, int reg, u32 val)
  76 {
  77         struct ata_port *ap = link->ap;
  78         struct ata_device *pmp_dev = ap->link.device;
  79         struct ata_taskfile tf;
  80
  81         ata_tf_init(pmp_dev, &tf);
  82         tf.command = ATA_CMD_PMP_WRITE;
  83         tf.protocol = ATA_PROT_NODATA;
  84         tf.flags |= ATA_TFLAG_ISADDR | ATA_TFLAG_DEVICE | ATA_TFLAG_LBA48;
  85         tf.feature = reg;
  86         tf.device = link->pmp;
  87         tf.nsect = val & 0xff;
  88         tf.lbal = (val >> 8) & 0xff;
  89         tf.lbam = (val >> 16) & 0xff;
  90         tf.lbah = (val >> 24) & 0xff;
  91
  92         return ata_exec_internal(pmp_dev, &tf, NULL, DMA_NONE, NULL, 0,
  93                                  SATA_PMP_RW_TIMEOUT);
  94 }
  95
  96 /**
  97  *      sata_pmp_qc_defer_cmd_switch - qc_defer for command switching PMP
  98  *      @qc: ATA command in question
  99  *
 100  *      A host which has command switching PMP support cannot issue
 101  *      commands to multiple links simultaneously.
 102  *
 103  *      LOCKING:
 104  *      spin_lock_irqsave(host lock)
 105  *
 106  *      RETURNS:
 107  *      ATA_DEFER_* if deferring is needed, 0 otherwise.
 108  */
 109 int sata_pmp_qc_defer_cmd_switch(struct ata_queued_cmd *qc)
 110 {
 111         struct ata_link *link = qc->dev->link;
 112         struct ata_port *ap = link->ap;
 113
 114         if (ap->excl_link == NULL || ap->excl_link == link) {
 115                 if (ap->nr_active_links == 0 || ata_link_active(link)) {
 116                         qc->flags |= ATA_QCFLAG_CLEAR_EXCL;
 117                         return ata_std_qc_defer(qc);
 118                 }
 119
 120                 ap->excl_link = link;
 121         }
 122
 123         return ATA_DEFER_PORT;
 124 }
 125
 126 /**
 127  *      sata_pmp_scr_read - read PSCR
 128  *      @link: ATA link to read PSCR for
 129  *      @reg: PSCR to read
 130  *      @r_val: resulting value
 131  *
 132  *      Read PSCR @reg into @r_val for @link, to be called from
 133  *      ata_scr_read().
 134  *
 135  *      LOCKING:
 136  *      Kernel thread context (may sleep).
 137  *
 138  *      RETURNS:
 139  *      0 on success, -errno on failure.
 140  */
 141 int sata_pmp_scr_read(struct ata_link *link, int reg, u32 *r_val)
 142 {
 143         unsigned int err_mask;
 144
 145         if (reg > SATA_PMP_PSCR_CONTROL)
 146                 return -EINVAL;
 147
 148         err_mask = sata_pmp_read(link, reg, r_val);
 149         if (err_mask) {
 150                 ata_link_warn(link, "failed to read SCR %d (Emask=0x%x)\n",
 151                               reg, err_mask);
 152                 return -EIO;
 153         }
 154         return 0;
 155 }
 156
 157 /**
 158  *      sata_pmp_scr_write - write PSCR
 159  *      @link: ATA link to write PSCR for
 160  *      @reg: PSCR to write
 161  *      @val: value to be written
 162  *
 163  *      Write @val to PSCR @reg for @link, to be called from
 164  *      ata_scr_write() and ata_scr_write_flush().
 165  *
 166  *      LOCKING:
 167  *      Kernel thread context (may sleep).
 168  *
 169  *      RETURNS:
 170  *      0 on success, -errno on failure.
 171  */
 172 int sata_pmp_scr_write(struct ata_link *link, int reg, u32 val)
 173 {
 174         unsigned int err_mask;
 175
 176         if (reg > SATA_PMP_PSCR_CONTROL)
 177                 return -EINVAL;
 178
 179         err_mask = sata_pmp_write(link, reg, val);
 180         if (err_mask) {
 181                 ata_link_warn(link, "failed to write SCR %d (Emask=0x%x)\n",
 182                               reg, err_mask);
 183                 return -EIO;
 184         }
 185         return 0;
 186 }
 187
 188 /**
 189  *      sata_pmp_set_lpm - configure LPM for a PMP link
 190  *      @link: PMP link to configure LPM for
 191  *      @policy: target LPM policy
 192  *      @hints: LPM hints
 193  *
 194  *      Configure LPM for @link.  This function will contain any PMP
 195  *      specific workarounds if necessary.
 196  *
 197  *      LOCKING:
 198  *      EH context.
 199  *
 200  *      RETURNS:
 201  *      0 on success, -errno on failure.
 202  */
 203 int sata_pmp_set_lpm(struct ata_link *link, enum ata_lpm_policy policy,
 204                      unsigned hints)
 205 {
 206         return sata_link_scr_lpm(link, policy, true);
 207 }
 208
 209 /**
 210  *      sata_pmp_read_gscr - read GSCR block of SATA PMP
 211  *      @dev: PMP device
 212  *      @gscr: buffer to read GSCR block into
 213  *
 214  *      Read selected PMP GSCRs from the PMP at @dev.  This will serve
 215  *      as configuration and identification info for the PMP.
 216  *
 217  *      LOCKING:
 218  *      Kernel thread context (may sleep).
 219  *
 220  *      RETURNS:
 221  *      0 on success, -errno on failure.
 222  */
 223 static int sata_pmp_read_gscr(struct ata_device *dev, u32 *gscr)
 224 {
 225         static const int gscr_to_read[] = { 0, 1, 2, 32, 33, 64, 96 };
 226         int i;
 227
 228         for (i = 0; i < ARRAY_SIZE(gscr_to_read); i++) {
 229                 int reg = gscr_to_read[i];
 230                 unsigned int err_mask;
 231
 232                 err_mask = sata_pmp_read(dev->link, reg, &gscr[reg]);
 233                 if (err_mask) {
 234                         ata_dev_err(dev, "failed to read PMP GSCR[%d] (Emask=0x%x)\n",
 235                                     reg, err_mask);
 236                         return -EIO;
 237                 }
 238         }
 239
 240         return 0;
 241 }
 242
 243 static const char *sata_pmp_spec_rev_str(const u32 *gscr)
 244 {
 245         u32 rev = gscr[SATA_PMP_GSCR_REV];
 246
 247         if (rev & (1 << 3))
 248                 return "1.2";
 249         if (rev & (1 << 2))
 250                 return "1.1";
 251         if (rev & (1 << 1))
 252                 return "1.0";
 253         return "<unknown>";
 254 }
 255
 256 #define PMP_GSCR_SII_POL 129
 257
 258 static int sata_pmp_configure(struct ata_device *dev, int print_info)
 259 {
 260         struct ata_port *ap = dev->link->ap;
 261         u32 *gscr = dev->gscr;
 262         u16 vendor = sata_pmp_gscr_vendor(gscr);
 263         u16 devid = sata_pmp_gscr_devid(gscr);
 264         unsigned int err_mask = 0;
 265         const char *reason;
 266         int nr_ports, rc;
 267
 268         nr_ports = sata_pmp_gscr_ports(gscr);
 269
 270         if (nr_ports <= 0 || nr_ports > SATA_PMP_MAX_PORTS) {
 271                 rc = -EINVAL;
 272                 reason = "invalid nr_ports";
 273                 goto fail;
 274         }
 275
 276         if ((ap->flags & ATA_FLAG_AN) &&
 277             (gscr[SATA_PMP_GSCR_FEAT] & SATA_PMP_FEAT_NOTIFY))
 278                 dev->flags |= ATA_DFLAG_AN;
 279
 280         /* monitor SERR_PHYRDY_CHG on fan-out ports */
 281         err_mask = sata_pmp_write(dev->link, SATA_PMP_GSCR_ERROR_EN,
 282                                   SERR_PHYRDY_CHG);
 283         if (err_mask) {
 284                 rc = -EIO;
 285                 reason = "failed to write GSCR_ERROR_EN";
 286                 goto fail;
 287         }
 288
 289         /* Disable sending Early R_OK.
 290          * With "cached read" HDD testing and multiple ports busy on a SATA
 291          * host controller, 3726 PMP will very rarely drop a deferred
 292          * R_OK that was intended for the host. Symptom will be all
 293          * 5 drives under test will timeout, get reset, and recover.
 294          */
 295         if (vendor == 0x1095 && devid == 0x3726) {
 296                 u32 reg;
 297
 298                 err_mask = sata_pmp_read(&ap->link, PMP_GSCR_SII_POL, &reg);
 299                 if (err_mask) {
 300                         rc = -EIO;
 301                         reason = "failed to read Sil3726 Private Register";
 302                         goto fail;
 303                 }
 304                 reg &= ~0x1;
 305                 err_mask = sata_pmp_write(&ap->link, PMP_GSCR_SII_POL, reg);
 306                 if (err_mask) {
 307                         rc = -EIO;
 308                         reason = "failed to write Sil3726 Private Register";
 309                         goto fail;
 310                 }
 311         }
 312
 313         if (print_info) {
 314                 ata_dev_info(dev, "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_info(dev,
 323                                 "Asynchronous notification not supported, "
 324                                 "hotplug won't work on fan-out ports. Use warm-plug instead.\n");
 325         }
 326
 327         return 0;
 328
 329  fail:
 330         ata_dev_err(dev,
 331                     "failed to configure Port Multiplier (%s, Emask=0x%x)\n",
 332                     reason, err_mask);
 333         return rc;
 334 }
 335
 336 static int sata_pmp_init_links (struct ata_port *ap, int nr_ports)
 337 {
 338         struct ata_link *pmp_link = ap->pmp_link;
 339         int i, err;
 340
 341         if (!pmp_link) {
 342                 pmp_link = kzalloc(sizeof(pmp_link[0]) * SATA_PMP_MAX_PORTS,
 343                                    GFP_NOIO);
 344                 if (!pmp_link)
 345                         return -ENOMEM;
 346
 347                 for (i = 0; i < SATA_PMP_MAX_PORTS; i++)
 348                         ata_link_init(ap, &pmp_link[i], i);
 349
 350                 ap->pmp_link = pmp_link;
 351
 352                 for (i = 0; i < SATA_PMP_MAX_PORTS; i++) {
 353                         err = ata_tlink_add(&pmp_link[i]);
 354                         if (err) {
 355                                 goto err_tlink;
 356                         }
 357                 }
 358         }
 359
 360         for (i = 0; i < nr_ports; i++) {
 361                 struct ata_link *link = &pmp_link[i];
 362                 struct ata_eh_context *ehc = &link->eh_context;
 363
 364                 link->flags = 0;
 365                 ehc->i.probe_mask |= ATA_ALL_DEVICES;
 366                 ehc->i.action |= ATA_EH_RESET;
 367         }
 368
 369         return 0;
 370   err_tlink:
 371         while (--i >= 0)
 372                 ata_tlink_delete(&pmp_link[i]);
 373         kfree(pmp_link);
 374         ap->pmp_link = NULL;
 375         return err;
 376 }
 377
 378 static void sata_pmp_quirks(struct ata_port *ap)
 379 {
 380         u32 *gscr = ap->link.device->gscr;
 381         u16 vendor = sata_pmp_gscr_vendor(gscr);
 382         u16 devid = sata_pmp_gscr_devid(gscr);
 383         struct ata_link *link;
 384
 385         if (vendor == 0x1095 && devid == 0x3726) {
 386                 /* sil3726 quirks */
 387                 ata_for_each_link(link, ap, EDGE) {
 388                         /* link reports offline after LPM */
 389                         link->flags |= ATA_LFLAG_NO_LPM;
 390
 391                         /* Class code report is unreliable and SRST
 392                          * times out under certain configurations.
 393                          */
 394                         if (link->pmp < 5)
 395                                 link->flags |= ATA_LFLAG_NO_SRST |
 396                                                ATA_LFLAG_ASSUME_ATA;
 397
 398                         /* port 5 is for SEMB device and it doesn't like SRST */
 399                         if (link->pmp == 5)
 400                                 link->flags |= ATA_LFLAG_NO_SRST |
 401                                                ATA_LFLAG_ASSUME_SEMB;
 402                 }
 403         } else if (vendor == 0x1095 && devid == 0x4723) {
 404                 /* sil4723 quirks */
 405                 ata_for_each_link(link, ap, EDGE) {
 406                         /* link reports offline after LPM */
 407                         link->flags |= ATA_LFLAG_NO_LPM;
 408
 409                         /* class code report is unreliable */
 410                         if (link->pmp < 2)
 411                                 link->flags |= ATA_LFLAG_ASSUME_ATA;
 412
 413                         /* the config device at port 2 locks up on SRST */
 414                         if (link->pmp == 2)
 415                                 link->flags |= ATA_LFLAG_NO_SRST |
 416                                                ATA_LFLAG_ASSUME_ATA;
 417                 }
 418         } else if (vendor == 0x1095 && devid == 0x4726) {
 419                 /* sil4726 quirks */
 420                 ata_for_each_link(link, ap, EDGE) {
 421                         /* link reports offline after LPM */
 422                         link->flags |= ATA_LFLAG_NO_LPM;
 423
 424                         /* Class code report is unreliable and SRST
 425                          * times out under certain configurations.
 426                          * Config device can be at port 0 or 5 and
 427                          * locks up on SRST.
 428                          */
 429                         if (link->pmp <= 5)
 430                                 link->flags |= ATA_LFLAG_NO_SRST |
 431                                                ATA_LFLAG_ASSUME_ATA;
 432
 433                         /* Port 6 is for SEMB device which doesn't
 434                          * like SRST either.
 435                          */
 436                         if (link->pmp == 6)
 437                                 link->flags |= ATA_LFLAG_NO_SRST |
 438                                                ATA_LFLAG_ASSUME_SEMB;
 439                 }
 440         } else if (vendor == 0x1095 && (devid == 0x5723 || devid == 0x5733 ||
 441                                         devid == 0x5734 || devid == 0x5744)) {
 442                 /* sil5723/5744 quirks */
 443
 444                 /* sil5723/5744 has either two or three downstream
 445                  * ports depending on operation mode.  The last port
 446                  * is empty if any actual IO device is available or
 447                  * occupied by a pseudo configuration device
 448                  * otherwise.  Don't try hard to recover it.
 449                  */
 450                 ap->pmp_link[ap->nr_pmp_links - 1].flags |= ATA_LFLAG_NO_RETRY;
 451         } else if (vendor == 0x197b && devid == 0x2352) {
 452                 /* chip found in Thermaltake BlackX Duet, jmicron JMB350? */
 453                 ata_for_each_link(link, ap, EDGE) {
 454                         /* SRST breaks detection and disks get misclassified
 455                          * LPM disabled to avoid potential problems
 456                          */
 457                         link->flags |= ATA_LFLAG_NO_LPM |
 458                                        ATA_LFLAG_NO_SRST |
 459                                        ATA_LFLAG_ASSUME_ATA;
 460                 }
 461         }
 462 }
 463
 464 /**
 465  *      sata_pmp_attach - attach a SATA PMP device
 466  *      @dev: SATA PMP device to attach
 467  *
 468  *      Configure and attach SATA PMP device @dev.  This function is
 469  *      also responsible for allocating and initializing PMP links.
 470  *
 471  *      LOCKING:
 472  *      Kernel thread context (may sleep).
 473  *
 474  *      RETURNS:
 475  *      0 on success, -errno on failure.
 476  */
 477 int sata_pmp_attach(struct ata_device *dev)
 478 {
 479         struct ata_link *link = dev->link;
 480         struct ata_port *ap = link->ap;
 481         unsigned long flags;
 482         struct ata_link *tlink;
 483         int rc;
 484
 485         /* is it hanging off the right place? */
 486         if (!sata_pmp_supported(ap)) {
 487                 ata_dev_err(dev, "host does not support Port Multiplier\n");
 488                 return -EINVAL;
 489         }
 490
 491         if (!ata_is_host_link(link)) {
 492                 ata_dev_err(dev, "Port Multipliers cannot be nested\n");
 493                 return -EINVAL;
 494         }
 495
 496         if (dev->devno) {
 497                 ata_dev_err(dev, "Port Multiplier must be the first device\n");
 498                 return -EINVAL;
 499         }
 500
 501         WARN_ON(link->pmp != 0);
 502         link->pmp = SATA_PMP_CTRL_PORT;
 503
 504         /* read GSCR block */
 505         rc = sata_pmp_read_gscr(dev, dev->gscr);
 506         if (rc)
 507                 goto fail;
 508
 509         /* config PMP */
 510         rc = sata_pmp_configure(dev, 1);
 511         if (rc)
 512                 goto fail;
 513
 514         rc = sata_pmp_init_links(ap, sata_pmp_gscr_ports(dev->gscr));
 515         if (rc) {
 516                 ata_dev_info(dev, "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_info(dev, "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_info(dev,
 608                              "Port Multiplier 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_info(dev,
 615                              "Port Multiplier 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_info(dev,
 622                              "Port Multiplier 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_err(dev, "PMP revalidation failed (errno=%d)\n", rc);
 690         DPRINTK("EXIT, rc=%d\n", rc);
 691         return rc;
 692 }
 693
 694 /**
 695  *      sata_pmp_revalidate_quick - revalidate SATA PMP quickly
 696  *      @dev: PMP device to revalidate
 697  *
 698  *      Make sure the attached PMP is accessible.
 699  *
 700  *      LOCKING:
 701  *      Kernel thread context (may sleep).
 702  *
 703  *      RETURNS:
 704  *      0 on success, -errno otherwise.
 705  */
 706 static int sata_pmp_revalidate_quick(struct ata_device *dev)
 707 {
 708         unsigned int err_mask;
 709         u32 prod_id;
 710
 711         err_mask = sata_pmp_read(dev->link, SATA_PMP_GSCR_PROD_ID, &prod_id);
 712         if (err_mask) {
 713                 ata_dev_err(dev,
 714                             "failed to read PMP product ID (Emask=0x%x)\n",
 715                             err_mask);
 716                 return -EIO;
 717         }
 718
 719         if (prod_id != dev->gscr[SATA_PMP_GSCR_PROD_ID]) {
 720                 ata_dev_err(dev, "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_err(link, "failed to reset PMP, giving up\n");
 776                         goto fail;
 777                 }
 778
 779                 /* PMP is reset, SErrors cannot be trusted, scan all */
 780                 ata_for_each_link(tlink, ap, EDGE) {
 781                         struct ata_eh_context *ehc = &tlink->eh_context;
 782
 783                         ehc->i.probe_mask |= ATA_ALL_DEVICES;
 784                         ehc->i.action |= ATA_EH_RESET;
 785                 }
 786         }
 787
 788         /* If revalidation is requested, revalidate and reconfigure;
 789          * otherwise, do quick revalidation.
 790          */
 791         if (ehc->i.action & ATA_EH_REVALIDATE)
 792                 rc = sata_pmp_revalidate(dev, ehc->classes[0]);
 793         else
 794                 rc = sata_pmp_revalidate_quick(dev);
 795
 796         if (rc) {
 797                 tries--;
 798
 799                 if (rc == -ENODEV) {
 800                         ehc->i.probe_mask |= ATA_ALL_DEVICES;
 801                         detach = 1;
 802                         /* give it just two more chances */
 803                         tries = min(tries, 2);
 804                 }
 805
 806                 if (tries) {
 807                         /* consecutive revalidation failures? speed down */
 808                         if (reval_failed)
 809                                 sata_down_spd_limit(link, 0);
 810                         else
 811                                 reval_failed = 1;
 812
 813                         ehc->i.action |= ATA_EH_RESET;
 814                         goto retry;
 815                 } else {
 816                         ata_dev_err(dev,
 817                                     "failed to recover PMP after %d tries, giving up\n",
 818                                     ATA_EH_PMP_TRIES);
 819                         goto fail;
 820                 }
 821         }
 822
 823         /* okay, PMP resurrected */
 824         ehc->i.flags = 0;
 825
 826         DPRINTK("EXIT, rc=0\n");
 827         return 0;
 828
 829  fail:
 830         sata_pmp_detach(dev);
 831         if (detach)
 832                 ata_eh_detach_dev(dev);
 833         else
 834                 ata_dev_disable(dev);
 835
 836         DPRINTK("EXIT, rc=%d\n", rc);
 837         return rc;
 838 }
 839
 840 static int sata_pmp_eh_handle_disabled_links(struct ata_port *ap)
 841 {
 842         struct ata_link *link;
 843         unsigned long flags;
 844         int rc;
 845
 846         spin_lock_irqsave(ap->lock, flags);
 847
 848         ata_for_each_link(link, ap, EDGE) {
 849                 if (!(link->flags & ATA_LFLAG_DISABLED))
 850                         continue;
 851
 852                 spin_unlock_irqrestore(ap->lock, flags);
 853
 854                 /* Some PMPs require hardreset sequence to get
 855                  * SError.N working.
 856                  */
 857                 sata_link_hardreset(link, sata_deb_timing_normal,
 858                                 ata_deadline(jiffies, ATA_TMOUT_INTERNAL_QUICK),
 859                                 NULL, NULL);
 860
 861                 /* unconditionally clear SError.N */
 862                 rc = sata_scr_write(link, SCR_ERROR, SERR_PHYRDY_CHG);
 863                 if (rc) {
 864                         ata_link_err(link,
 865                                      "failed to clear SError.N (errno=%d)\n",
 866                                      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_warn(link,
 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         /* PHY event notification can disturb reset and other recovery
 964          * operations.  Turn it off.
 965          */
 966         if (gscr[SATA_PMP_GSCR_FEAT_EN] & SATA_PMP_FEAT_NOTIFY) {
 967                 gscr[SATA_PMP_GSCR_FEAT_EN] &= ~SATA_PMP_FEAT_NOTIFY;
 968
 969                 err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
 970                                           gscr[SATA_PMP_GSCR_FEAT_EN]);
 971                 if (err_mask) {
 972                         ata_link_warn(pmp_link,
 973                                 "failed to disable NOTIFY (err_mask=0x%x)\n",
 974                                 err_mask);
 975                         goto pmp_fail;
 976                 }
 977         }
 978
 979         /* handle disabled links */
 980         rc = sata_pmp_eh_handle_disabled_links(ap);
 981         if (rc)
 982                 goto pmp_fail;
 983
 984         /* recover links */
 985         rc = ata_eh_recover(ap, ops->pmp_prereset, ops->pmp_softreset,
 986                             ops->pmp_hardreset, ops->pmp_postreset, &link);
 987         if (rc)
 988                 goto link_fail;
 989
 990         /* clear SNotification */
 991         rc = sata_scr_read(&ap->link, SCR_NOTIFICATION, &sntf);
 992         if (rc == 0)
 993                 sata_scr_write(&ap->link, SCR_NOTIFICATION, sntf);
 994
 995         /*
 996          * If LPM is active on any fan-out port, hotplug wouldn't
 997          * work.  Return w/ PHY event notification disabled.
 998          */
 999         ata_for_each_link(link, ap, EDGE)
1000                 if (link->lpm_policy > ATA_LPM_MAX_POWER)
1001                         return 0;
1002
1003         /*
1004          * Connection status might have changed while resetting other
1005          * links, enable notification and check SATA_PMP_GSCR_ERROR
1006          * before returning.
1007          */
1008
1009         /* enable notification */
1010         if (pmp_dev->flags & ATA_DFLAG_AN) {
1011                 gscr[SATA_PMP_GSCR_FEAT_EN] |= SATA_PMP_FEAT_NOTIFY;
1012
1013                 err_mask = sata_pmp_write(pmp_link, SATA_PMP_GSCR_FEAT_EN,
1014                                           gscr[SATA_PMP_GSCR_FEAT_EN]);
1015                 if (err_mask) {
1016                         ata_dev_err(pmp_dev,
1017                                     "failed to write PMP_FEAT_EN (Emask=0x%x)\n",
1018                                     err_mask);
1019                         rc = -EIO;
1020                         goto pmp_fail;
1021                 }
1022         }
1023
1024         /* check GSCR_ERROR */
1025         err_mask = sata_pmp_read(pmp_link, SATA_PMP_GSCR_ERROR, &gscr_error);
1026         if (err_mask) {
1027                 ata_dev_err(pmp_dev,
1028                             "failed to read PMP_GSCR_ERROR (Emask=0x%x)\n",
1029                             err_mask);
1030                 rc = -EIO;
1031                 goto pmp_fail;
1032         }
1033
1034         cnt = 0;
1035         ata_for_each_link(link, ap, EDGE) {
1036                 if (!(gscr_error & (1 << link->pmp)))
1037                         continue;
1038
1039                 if (sata_pmp_handle_link_fail(link, link_tries)) {
1040                         ata_ehi_hotplugged(&link->eh_context.i);
1041                         cnt++;
1042                 } else {
1043                         ata_link_warn(link,
1044                                 "PHY status changed but maxed out on retries, giving up\n");
1045                         ata_link_warn(link,
1046                                 "Manually issue scan to resume this link\n");
1047                 }
1048         }
1049
1050         if (cnt) {
1051                 ata_port_info(ap,
1052                         "PMP SError.N set for some ports, repeating recovery\n");
1053                 goto retry;
1054         }
1055
1056         return 0;
1057
1058  link_fail:
1059         if (sata_pmp_handle_link_fail(link, link_tries)) {
1060                 pmp_ehc->i.action |= ATA_EH_RESET;
1061                 goto retry;
1062         }
1063
1064         /* fall through */
1065  pmp_fail:
1066         /* Control always ends up here after detaching PMP.  Shut up
1067          * and return if we're unloading.
1068          */
1069         if (ap->pflags & ATA_PFLAG_UNLOADING)
1070                 return rc;
1071
1072         if (!sata_pmp_attached(ap))
1073                 goto retry;
1074
1075         if (--pmp_tries) {
1076                 pmp_ehc->i.action |= ATA_EH_RESET;
1077                 goto retry;
1078         }
1079
1080         ata_port_err(ap, "failed to recover PMP after %d tries, giving up\n",
1081                      ATA_EH_PMP_TRIES);
1082         sata_pmp_detach(pmp_dev);
1083         ata_dev_disable(pmp_dev);
1084
1085         return rc;
1086 }
1087
1088 /**
1089  *      sata_pmp_error_handler - do standard error handling for PMP-enabled host
1090  *      @ap: host port to handle error for
1091  *
1092  *      Perform standard error handling sequence for PMP-enabled host
1093  *      @ap.
1094  *
1095  *      LOCKING:
1096  *      Kernel thread context (may sleep).
1097  */
1098 void sata_pmp_error_handler(struct ata_port *ap)
1099 {
1100         ata_eh_autopsy(ap);
1101         ata_eh_report(ap);
1102         sata_pmp_eh_recover(ap);
1103         ata_eh_finish(ap);
1104 }
1105
1106 EXPORT_SYMBOL_GPL(sata_pmp_port_ops);
1107 EXPORT_SYMBOL_GPL(sata_pmp_qc_defer_cmd_switch);
1108 EXPORT_SYMBOL_GPL(sata_pmp_error_handler);