drivers/ata/libahci_platform.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  * AHCI SATA platform library
   4  *
   5  * Copyright 2004-2005  Red Hat, Inc.
   6  *   Jeff Garzik <jgarzik@pobox.com>
   7  * Copyright 2010  MontaVista Software, LLC.
   8  *   Anton Vorontsov <avorontsov@ru.mvista.com>
   9  */
  10
  11 #include <linux/clk.h>
  12 #include <linux/kernel.h>
  13 #include <linux/gfp.h>
  14 #include <linux/module.h>
  15 #include <linux/pm.h>
  16 #include <linux/interrupt.h>
  17 #include <linux/device.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/libata.h>
  20 #include <linux/ahci_platform.h>
  21 #include <linux/phy/phy.h>
  22 #include <linux/pm_runtime.h>
  23 #include <linux/of_platform.h>
  24 #include <linux/reset.h>
  25 #include "ahci.h"
  26
  27 static void ahci_host_stop(struct ata_host *host);
  28
  29 struct ata_port_operations ahci_platform_ops = {
  30         .inherits       = &ahci_ops,
  31         .host_stop      = ahci_host_stop,
  32 };
  33 EXPORT_SYMBOL_GPL(ahci_platform_ops);
  34
  35 /**
  36  * ahci_platform_enable_phys - Enable PHYs
  37  * @hpriv: host private area to store config values
  38  *
  39  * This function enables all the PHYs found in hpriv->phys, if any.
  40  * If a PHY fails to be enabled, it disables all the PHYs already
  41  * enabled in reverse order and returns an error.
  42  *
  43  * RETURNS:
  44  * 0 on success otherwise a negative error code
  45  */
  46 static int ahci_platform_enable_phys(struct ahci_host_priv *hpriv)
  47 {
  48         int rc, i;
  49
  50         for (i = 0; i < hpriv->nports; i++) {
  51                 rc = phy_init(hpriv->phys[i]);
  52                 if (rc)
  53                         goto disable_phys;
  54
  55                 rc = phy_set_mode(hpriv->phys[i], PHY_MODE_SATA);
  56                 if (rc) {
  57                         phy_exit(hpriv->phys[i]);
  58                         goto disable_phys;
  59                 }
  60
  61                 rc = phy_power_on(hpriv->phys[i]);
  62                 if (rc) {
  63                         phy_exit(hpriv->phys[i]);
  64                         goto disable_phys;
  65                 }
  66         }
  67
  68         return 0;
  69
  70 disable_phys:
  71         while (--i >= 0) {
  72                 phy_power_off(hpriv->phys[i]);
  73                 phy_exit(hpriv->phys[i]);
  74         }
  75         return rc;
  76 }
  77
  78 /**
  79  * ahci_platform_disable_phys - Disable PHYs
  80  * @hpriv: host private area to store config values
  81  *
  82  * This function disables all PHYs found in hpriv->phys.
  83  */
  84 static void ahci_platform_disable_phys(struct ahci_host_priv *hpriv)
  85 {
  86         int i;
  87
  88         for (i = 0; i < hpriv->nports; i++) {
  89                 phy_power_off(hpriv->phys[i]);
  90                 phy_exit(hpriv->phys[i]);
  91         }
  92 }
  93
  94 /**
  95  * ahci_platform_enable_clks - Enable platform clocks
  96  * @hpriv: host private area to store config values
  97  *
  98  * This function enables all the clks found in hpriv->clks, starting at
  99  * index 0. If any clk fails to enable it disables all the clks already
 100  * enabled in reverse order, and then returns an error.
 101  *
 102  * RETURNS:
 103  * 0 on success otherwise a negative error code
 104  */
 105 int ahci_platform_enable_clks(struct ahci_host_priv *hpriv)
 106 {
 107         int c, rc;
 108
 109         for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++) {
 110                 rc = clk_prepare_enable(hpriv->clks[c]);
 111                 if (rc)
 112                         goto disable_unprepare_clk;
 113         }
 114         return 0;
 115
 116 disable_unprepare_clk:
 117         while (--c >= 0)
 118                 clk_disable_unprepare(hpriv->clks[c]);
 119         return rc;
 120 }
 121 EXPORT_SYMBOL_GPL(ahci_platform_enable_clks);
 122
 123 /**
 124  * ahci_platform_disable_clks - Disable platform clocks
 125  * @hpriv: host private area to store config values
 126  *
 127  * This function disables all the clks found in hpriv->clks, in reverse
 128  * order of ahci_platform_enable_clks (starting at the end of the array).
 129  */
 130 void ahci_platform_disable_clks(struct ahci_host_priv *hpriv)
 131 {
 132         int c;
 133
 134         for (c = AHCI_MAX_CLKS - 1; c >= 0; c--)
 135                 if (hpriv->clks[c])
 136                         clk_disable_unprepare(hpriv->clks[c]);
 137 }
 138 EXPORT_SYMBOL_GPL(ahci_platform_disable_clks);
 139
 140 /**
 141  * ahci_platform_enable_regulators - Enable regulators
 142  * @hpriv: host private area to store config values
 143  *
 144  * This function enables all the regulators found in controller and
 145  * hpriv->target_pwrs, if any.  If a regulator fails to be enabled, it
 146  * disables all the regulators already enabled in reverse order and
 147  * returns an error.
 148  *
 149  * RETURNS:
 150  * 0 on success otherwise a negative error code
 151  */
 152 int ahci_platform_enable_regulators(struct ahci_host_priv *hpriv)
 153 {
 154         int rc, i;
 155
 156         if (hpriv->ahci_regulator) {
 157                 rc = regulator_enable(hpriv->ahci_regulator);
 158                 if (rc)
 159                         return rc;
 160         }
 161
 162         if (hpriv->phy_regulator) {
 163                 rc = regulator_enable(hpriv->phy_regulator);
 164                 if (rc)
 165                         goto disable_ahci_pwrs;
 166         }
 167
 168         for (i = 0; i < hpriv->nports; i++) {
 169                 if (!hpriv->target_pwrs[i])
 170                         continue;
 171
 172                 rc = regulator_enable(hpriv->target_pwrs[i]);
 173                 if (rc)
 174                         goto disable_target_pwrs;
 175         }
 176
 177         return 0;
 178
 179 disable_target_pwrs:
 180         while (--i >= 0)
 181                 if (hpriv->target_pwrs[i])
 182                         regulator_disable(hpriv->target_pwrs[i]);
 183
 184         if (hpriv->phy_regulator)
 185                 regulator_disable(hpriv->phy_regulator);
 186 disable_ahci_pwrs:
 187         if (hpriv->ahci_regulator)
 188                 regulator_disable(hpriv->ahci_regulator);
 189         return rc;
 190 }
 191 EXPORT_SYMBOL_GPL(ahci_platform_enable_regulators);
 192
 193 /**
 194  * ahci_platform_disable_regulators - Disable regulators
 195  * @hpriv: host private area to store config values
 196  *
 197  * This function disables all regulators found in hpriv->target_pwrs and
 198  * AHCI controller.
 199  */
 200 void ahci_platform_disable_regulators(struct ahci_host_priv *hpriv)
 201 {
 202         int i;
 203
 204         for (i = 0; i < hpriv->nports; i++) {
 205                 if (!hpriv->target_pwrs[i])
 206                         continue;
 207                 regulator_disable(hpriv->target_pwrs[i]);
 208         }
 209
 210         if (hpriv->ahci_regulator)
 211                 regulator_disable(hpriv->ahci_regulator);
 212         if (hpriv->phy_regulator)
 213                 regulator_disable(hpriv->phy_regulator);
 214 }
 215 EXPORT_SYMBOL_GPL(ahci_platform_disable_regulators);
 216 /**
 217  * ahci_platform_enable_resources - Enable platform resources
 218  * @hpriv: host private area to store config values
 219  *
 220  * This function enables all ahci_platform managed resources in the
 221  * following order:
 222  * 1) Regulator
 223  * 2) Clocks (through ahci_platform_enable_clks)
 224  * 3) Resets
 225  * 4) Phys
 226  *
 227  * If resource enabling fails at any point the previous enabled resources
 228  * are disabled in reverse order.
 229  *
 230  * RETURNS:
 231  * 0 on success otherwise a negative error code
 232  */
 233 int ahci_platform_enable_resources(struct ahci_host_priv *hpriv)
 234 {
 235         int rc;
 236
 237         rc = ahci_platform_enable_regulators(hpriv);
 238         if (rc)
 239                 return rc;
 240
 241         rc = ahci_platform_enable_clks(hpriv);
 242         if (rc)
 243                 goto disable_regulator;
 244
 245         rc = reset_control_deassert(hpriv->rsts);
 246         if (rc)
 247                 goto disable_clks;
 248
 249         rc = ahci_platform_enable_phys(hpriv);
 250         if (rc)
 251                 goto disable_resets;
 252
 253         return 0;
 254
 255 disable_resets:
 256         reset_control_assert(hpriv->rsts);
 257
 258 disable_clks:
 259         ahci_platform_disable_clks(hpriv);
 260
 261 disable_regulator:
 262         ahci_platform_disable_regulators(hpriv);
 263
 264         return rc;
 265 }
 266 EXPORT_SYMBOL_GPL(ahci_platform_enable_resources);
 267
 268 /**
 269  * ahci_platform_disable_resources - Disable platform resources
 270  * @hpriv: host private area to store config values
 271  *
 272  * This function disables all ahci_platform managed resources in the
 273  * following order:
 274  * 1) Phys
 275  * 2) Resets
 276  * 3) Clocks (through ahci_platform_disable_clks)
 277  * 4) Regulator
 278  */
 279 void ahci_platform_disable_resources(struct ahci_host_priv *hpriv)
 280 {
 281         ahci_platform_disable_phys(hpriv);
 282
 283         reset_control_assert(hpriv->rsts);
 284
 285         ahci_platform_disable_clks(hpriv);
 286
 287         ahci_platform_disable_regulators(hpriv);
 288 }
 289 EXPORT_SYMBOL_GPL(ahci_platform_disable_resources);
 290
 291 static void ahci_platform_put_resources(struct device *dev, void *res)
 292 {
 293         struct ahci_host_priv *hpriv = res;
 294         int c;
 295
 296         if (hpriv->got_runtime_pm) {
 297                 pm_runtime_put_sync(dev);
 298                 pm_runtime_disable(dev);
 299         }
 300
 301         for (c = 0; c < AHCI_MAX_CLKS && hpriv->clks[c]; c++)
 302                 clk_put(hpriv->clks[c]);
 303         /*
 304          * The regulators are tied to child node device and not to the
 305          * SATA device itself. So we can't use devm for automatically
 306          * releasing them. We have to do it manually here.
 307          */
 308         for (c = 0; c < hpriv->nports; c++)
 309                 if (hpriv->target_pwrs && hpriv->target_pwrs[c])
 310                         regulator_put(hpriv->target_pwrs[c]);
 311
 312         kfree(hpriv->target_pwrs);
 313 }
 314
 315 static int ahci_platform_get_phy(struct ahci_host_priv *hpriv, u32 port,
 316                                 struct device *dev, struct device_node *node)
 317 {
 318         int rc;
 319
 320         hpriv->phys[port] = devm_of_phy_get(dev, node, NULL);
 321
 322         if (!IS_ERR(hpriv->phys[port]))
 323                 return 0;
 324
 325         rc = PTR_ERR(hpriv->phys[port]);
 326         switch (rc) {
 327         case -ENOSYS:
 328                 /* No PHY support. Check if PHY is required. */
 329                 if (of_find_property(node, "phys", NULL)) {
 330                         dev_err(dev,
 331                                 "couldn't get PHY in node %pOFn: ENOSYS\n",
 332                                 node);
 333                         break;
 334                 }
 335                 /* fall through */
 336         case -ENODEV:
 337                 /* continue normally */
 338                 hpriv->phys[port] = NULL;
 339                 rc = 0;
 340                 break;
 341
 342         default:
 343                 dev_err(dev,
 344                         "couldn't get PHY in node %pOFn: %d\n",
 345                         node, rc);
 346
 347                 break;
 348         }
 349
 350         return rc;
 351 }
 352
 353 static int ahci_platform_get_regulator(struct ahci_host_priv *hpriv, u32 port,
 354                                 struct device *dev)
 355 {
 356         struct regulator *target_pwr;
 357         int rc = 0;
 358
 359         target_pwr = regulator_get_optional(dev, "target");
 360
 361         if (!IS_ERR(target_pwr))
 362                 hpriv->target_pwrs[port] = target_pwr;
 363         else
 364                 rc = PTR_ERR(target_pwr);
 365
 366         return rc;
 367 }
 368
 369 /**
 370  * ahci_platform_get_resources - Get platform resources
 371  * @pdev: platform device to get resources for
 372  * @flags: bitmap representing the resource to get
 373  *
 374  * This function allocates an ahci_host_priv struct, and gets the following
 375  * resources, storing a reference to them inside the returned struct:
 376  *
 377  * 1) mmio registers (IORESOURCE_MEM 0, mandatory)
 378  * 2) regulator for controlling the targets power (optional)
 379  *    regulator for controlling the AHCI controller (optional)
 380  * 3) 0 - AHCI_MAX_CLKS clocks, as specified in the devs devicetree node,
 381  *    or for non devicetree enabled platforms a single clock
 382  * 4) resets, if flags has AHCI_PLATFORM_GET_RESETS (optional)
 383  * 5) phys (optional)
 384  *
 385  * RETURNS:
 386  * The allocated ahci_host_priv on success, otherwise an ERR_PTR value
 387  */
 388 struct ahci_host_priv *ahci_platform_get_resources(struct platform_device *pdev,
 389                                                    unsigned int flags)
 390 {
 391         struct device *dev = &pdev->dev;
 392         struct ahci_host_priv *hpriv;
 393         struct clk *clk;
 394         struct device_node *child;
 395         int i, enabled_ports = 0, rc = -ENOMEM, child_nodes;
 396         u32 mask_port_map = 0;
 397
 398         if (!devres_open_group(dev, NULL, GFP_KERNEL))
 399                 return ERR_PTR(-ENOMEM);
 400
 401         hpriv = devres_alloc(ahci_platform_put_resources, sizeof(*hpriv),
 402                              GFP_KERNEL);
 403         if (!hpriv)
 404                 goto err_out;
 405
 406         devres_add(dev, hpriv);
 407
 408         hpriv->mmio = devm_ioremap_resource(dev,
 409                               platform_get_resource(pdev, IORESOURCE_MEM, 0));
 410         if (IS_ERR(hpriv->mmio)) {
 411                 dev_err(dev, "no mmio space\n");
 412                 rc = PTR_ERR(hpriv->mmio);
 413                 goto err_out;
 414         }
 415
 416         for (i = 0; i < AHCI_MAX_CLKS; i++) {
 417                 /*
 418                  * For now we must use clk_get(dev, NULL) for the first clock,
 419                  * because some platforms (da850, spear13xx) are not yet
 420                  * converted to use devicetree for clocks.  For new platforms
 421                  * this is equivalent to of_clk_get(dev->of_node, 0).
 422                  */
 423                 if (i == 0)
 424                         clk = clk_get(dev, NULL);
 425                 else
 426                         clk = of_clk_get(dev->of_node, i);
 427
 428                 if (IS_ERR(clk)) {
 429                         rc = PTR_ERR(clk);
 430                         if (rc == -EPROBE_DEFER)
 431                                 goto err_out;
 432                         break;
 433                 }
 434                 hpriv->clks[i] = clk;
 435         }
 436
 437         hpriv->ahci_regulator = devm_regulator_get_optional(dev, "ahci");
 438         if (IS_ERR(hpriv->ahci_regulator)) {
 439                 rc = PTR_ERR(hpriv->ahci_regulator);
 440                 if (rc == -EPROBE_DEFER)
 441                         goto err_out;
 442                 rc = 0;
 443                 hpriv->ahci_regulator = NULL;
 444         }
 445
 446         hpriv->phy_regulator = devm_regulator_get_optional(dev, "phy");
 447         if (IS_ERR(hpriv->phy_regulator)) {
 448                 rc = PTR_ERR(hpriv->phy_regulator);
 449                 if (rc == -EPROBE_DEFER)
 450                         goto err_out;
 451                 rc = 0;
 452                 hpriv->phy_regulator = NULL;
 453         }
 454
 455         if (flags & AHCI_PLATFORM_GET_RESETS) {
 456                 hpriv->rsts = devm_reset_control_array_get_optional_shared(dev);
 457                 if (IS_ERR(hpriv->rsts)) {
 458                         rc = PTR_ERR(hpriv->rsts);
 459                         goto err_out;
 460                 }
 461         }
 462
 463         hpriv->nports = child_nodes = of_get_child_count(dev->of_node);
 464
 465         /*
 466          * If no sub-node was found, we still need to set nports to
 467          * one in order to be able to use the
 468          * ahci_platform_[en|dis]able_[phys|regulators] functions.
 469          */
 470         if (!child_nodes)
 471                 hpriv->nports = 1;
 472
 473         hpriv->phys = devm_kcalloc(dev, hpriv->nports, sizeof(*hpriv->phys), GFP_KERNEL);
 474         if (!hpriv->phys) {
 475                 rc = -ENOMEM;
 476                 goto err_out;
 477         }
 478         /*
 479          * We cannot use devm_ here, since ahci_platform_put_resources() uses
 480          * target_pwrs after devm_ have freed memory
 481          */
 482         hpriv->target_pwrs = kcalloc(hpriv->nports, sizeof(*hpriv->target_pwrs), GFP_KERNEL);
 483         if (!hpriv->target_pwrs) {
 484                 rc = -ENOMEM;
 485                 goto err_out;
 486         }
 487
 488         if (child_nodes) {
 489                 for_each_child_of_node(dev->of_node, child) {
 490                         u32 port;
 491                         struct platform_device *port_dev __maybe_unused;
 492
 493                         if (!of_device_is_available(child))
 494                                 continue;
 495
 496                         if (of_property_read_u32(child, "reg", &port)) {
 497                                 rc = -EINVAL;
 498                                 goto err_out;
 499                         }
 500
 501                         if (port >= hpriv->nports) {
 502                                 dev_warn(dev, "invalid port number %d\n", port);
 503                                 continue;
 504                         }
 505                         mask_port_map |= BIT(port);
 506
 507 #ifdef CONFIG_OF_ADDRESS
 508                         of_platform_device_create(child, NULL, NULL);
 509
 510                         port_dev = of_find_device_by_node(child);
 511
 512                         if (port_dev) {
 513                                 rc = ahci_platform_get_regulator(hpriv, port,
 514                                                                 &port_dev->dev);
 515                                 if (rc == -EPROBE_DEFER)
 516                                         goto err_out;
 517                         }
 518 #endif
 519
 520                         rc = ahci_platform_get_phy(hpriv, port, dev, child);
 521                         if (rc)
 522                                 goto err_out;
 523
 524                         enabled_ports++;
 525                 }
 526                 if (!enabled_ports) {
 527                         dev_warn(dev, "No port enabled\n");
 528                         rc = -ENODEV;
 529                         goto err_out;
 530                 }
 531
 532                 if (!hpriv->mask_port_map)
 533                         hpriv->mask_port_map = mask_port_map;
 534         } else {
 535                 /*
 536                  * If no sub-node was found, keep this for device tree
 537                  * compatibility
 538                  */
 539                 rc = ahci_platform_get_phy(hpriv, 0, dev, dev->of_node);
 540                 if (rc)
 541                         goto err_out;
 542
 543                 rc = ahci_platform_get_regulator(hpriv, 0, dev);
 544                 if (rc == -EPROBE_DEFER)
 545                         goto err_out;
 546         }
 547         pm_runtime_enable(dev);
 548         pm_runtime_get_sync(dev);
 549         hpriv->got_runtime_pm = true;
 550
 551         devres_remove_group(dev, NULL);
 552         return hpriv;
 553
 554 err_out:
 555         devres_release_group(dev, NULL);
 556         return ERR_PTR(rc);
 557 }
 558 EXPORT_SYMBOL_GPL(ahci_platform_get_resources);
 559
 560 /**
 561  * ahci_platform_init_host - Bring up an ahci-platform host
 562  * @pdev: platform device pointer for the host
 563  * @hpriv: ahci-host private data for the host
 564  * @pi_template: template for the ata_port_info to use
 565  * @sht: scsi_host_template to use when registering
 566  *
 567  * This function does all the usual steps needed to bring up an
 568  * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
 569  * must be initialized / enabled before calling this.
 570  *
 571  * RETURNS:
 572  * 0 on success otherwise a negative error code
 573  */
 574 int ahci_platform_init_host(struct platform_device *pdev,
 575                             struct ahci_host_priv *hpriv,
 576                             const struct ata_port_info *pi_template,
 577                             struct scsi_host_template *sht)
 578 {
 579         struct device *dev = &pdev->dev;
 580         struct ata_port_info pi = *pi_template;
 581         const struct ata_port_info *ppi[] = { &pi, NULL };
 582         struct ata_host *host;
 583         int i, irq, n_ports, rc;
 584
 585         irq = platform_get_irq(pdev, 0);
 586         if (irq <= 0) {
 587                 if (irq != -EPROBE_DEFER)
 588                         dev_err(dev, "no irq\n");
 589                 return irq;
 590         }
 591
 592         hpriv->irq = irq;
 593
 594         /* prepare host */
 595         pi.private_data = (void *)(unsigned long)hpriv->flags;
 596
 597         ahci_save_initial_config(dev, hpriv);
 598
 599         if (hpriv->cap & HOST_CAP_NCQ)
 600                 pi.flags |= ATA_FLAG_NCQ;
 601
 602         if (hpriv->cap & HOST_CAP_PMP)
 603                 pi.flags |= ATA_FLAG_PMP;
 604
 605         ahci_set_em_messages(hpriv, &pi);
 606
 607         /* CAP.NP sometimes indicate the index of the last enabled
 608          * port, at other times, that of the last possible port, so
 609          * determining the maximum port number requires looking at
 610          * both CAP.NP and port_map.
 611          */
 612         n_ports = max(ahci_nr_ports(hpriv->cap), fls(hpriv->port_map));
 613
 614         host = ata_host_alloc_pinfo(dev, ppi, n_ports);
 615         if (!host)
 616                 return -ENOMEM;
 617
 618         host->private_data = hpriv;
 619
 620         if (!(hpriv->cap & HOST_CAP_SSS) || ahci_ignore_sss)
 621                 host->flags |= ATA_HOST_PARALLEL_SCAN;
 622         else
 623                 dev_info(dev, "SSS flag set, parallel bus scan disabled\n");
 624
 625         if (pi.flags & ATA_FLAG_EM)
 626                 ahci_reset_em(host);
 627
 628         for (i = 0; i < host->n_ports; i++) {
 629                 struct ata_port *ap = host->ports[i];
 630
 631                 ata_port_desc(ap, "mmio %pR",
 632                               platform_get_resource(pdev, IORESOURCE_MEM, 0));
 633                 ata_port_desc(ap, "port 0x%x", 0x100 + ap->port_no * 0x80);
 634
 635                 /* set enclosure management message type */
 636                 if (ap->flags & ATA_FLAG_EM)
 637                         ap->em_message_type = hpriv->em_msg_type;
 638
 639                 /* disabled/not-implemented port */
 640                 if (!(hpriv->port_map & (1 << i)))
 641                         ap->ops = &ata_dummy_port_ops;
 642         }
 643
 644         if (hpriv->cap & HOST_CAP_64) {
 645                 rc = dma_coerce_mask_and_coherent(dev, DMA_BIT_MASK(64));
 646                 if (rc) {
 647                         rc = dma_coerce_mask_and_coherent(dev,
 648                                                           DMA_BIT_MASK(32));
 649                         if (rc) {
 650                                 dev_err(dev, "Failed to enable 64-bit DMA.\n");
 651                                 return rc;
 652                         }
 653                         dev_warn(dev, "Enable 32-bit DMA instead of 64-bit.\n");
 654                 }
 655         }
 656
 657         rc = ahci_reset_controller(host);
 658         if (rc)
 659                 return rc;
 660
 661         ahci_init_controller(host);
 662         ahci_print_info(host, "platform");
 663
 664         return ahci_host_activate(host, sht);
 665 }
 666 EXPORT_SYMBOL_GPL(ahci_platform_init_host);
 667
 668 static void ahci_host_stop(struct ata_host *host)
 669 {
 670         struct ahci_host_priv *hpriv = host->private_data;
 671
 672         ahci_platform_disable_resources(hpriv);
 673 }
 674
 675 /**
 676  * ahci_platform_shutdown - Disable interrupts and stop DMA for host ports
 677  * @pdev: platform device pointer for the host
 678  *
 679  * This function is called during system shutdown and performs the minimal
 680  * deconfiguration required to ensure that an ahci_platform host cannot
 681  * corrupt or otherwise interfere with a new kernel being started with kexec.
 682  */
 683 void ahci_platform_shutdown(struct platform_device *pdev)
 684 {
 685         struct ata_host *host = platform_get_drvdata(pdev);
 686         struct ahci_host_priv *hpriv = host->private_data;
 687         void __iomem *mmio = hpriv->mmio;
 688         int i;
 689
 690         for (i = 0; i < host->n_ports; i++) {
 691                 struct ata_port *ap = host->ports[i];
 692
 693                 /* Disable port interrupts */
 694                 if (ap->ops->freeze)
 695                         ap->ops->freeze(ap);
 696
 697                 /* Stop the port DMA engines */
 698                 if (ap->ops->port_stop)
 699                         ap->ops->port_stop(ap);
 700         }
 701
 702         /* Disable and clear host interrupts */
 703         writel(readl(mmio + HOST_CTL) & ~HOST_IRQ_EN, mmio + HOST_CTL);
 704         readl(mmio + HOST_CTL); /* flush */
 705         writel(GENMASK(host->n_ports, 0), mmio + HOST_IRQ_STAT);
 706 }
 707 EXPORT_SYMBOL_GPL(ahci_platform_shutdown);
 708
 709 #ifdef CONFIG_PM_SLEEP
 710 /**
 711  * ahci_platform_suspend_host - Suspend an ahci-platform host
 712  * @dev: device pointer for the host
 713  *
 714  * This function does all the usual steps needed to suspend an
 715  * ahci-platform host, note any necessary resources (ie clks, phys, etc.)
 716  * must be disabled after calling this.
 717  *
 718  * RETURNS:
 719  * 0 on success otherwise a negative error code
 720  */
 721 int ahci_platform_suspend_host(struct device *dev)
 722 {
 723         struct ata_host *host = dev_get_drvdata(dev);
 724         struct ahci_host_priv *hpriv = host->private_data;
 725         void __iomem *mmio = hpriv->mmio;
 726         u32 ctl;
 727
 728         if (hpriv->flags & AHCI_HFLAG_NO_SUSPEND) {
 729                 dev_err(dev, "firmware update required for suspend/resume\n");
 730                 return -EIO;
 731         }
 732
 733         /*
 734          * AHCI spec rev1.1 section 8.3.3:
 735          * Software must disable interrupts prior to requesting a
 736          * transition of the HBA to D3 state.
 737          */
 738         ctl = readl(mmio + HOST_CTL);
 739         ctl &= ~HOST_IRQ_EN;
 740         writel(ctl, mmio + HOST_CTL);
 741         readl(mmio + HOST_CTL); /* flush */
 742
 743         if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
 744                 ahci_platform_disable_phys(hpriv);
 745
 746         return ata_host_suspend(host, PMSG_SUSPEND);
 747 }
 748 EXPORT_SYMBOL_GPL(ahci_platform_suspend_host);
 749
 750 /**
 751  * ahci_platform_resume_host - Resume an ahci-platform host
 752  * @dev: device pointer for the host
 753  *
 754  * This function does all the usual steps needed to resume an ahci-platform
 755  * host, note any necessary resources (ie clks, phys, etc.)  must be
 756  * initialized / enabled before calling this.
 757  *
 758  * RETURNS:
 759  * 0 on success otherwise a negative error code
 760  */
 761 int ahci_platform_resume_host(struct device *dev)
 762 {
 763         struct ata_host *host = dev_get_drvdata(dev);
 764         struct ahci_host_priv *hpriv = host->private_data;
 765         int rc;
 766
 767         if (dev->power.power_state.event == PM_EVENT_SUSPEND) {
 768                 rc = ahci_reset_controller(host);
 769                 if (rc)
 770                         return rc;
 771
 772                 ahci_init_controller(host);
 773         }
 774
 775         if (hpriv->flags & AHCI_HFLAG_SUSPEND_PHYS)
 776                 ahci_platform_enable_phys(hpriv);
 777
 778         ata_host_resume(host);
 779
 780         return 0;
 781 }
 782 EXPORT_SYMBOL_GPL(ahci_platform_resume_host);
 783
 784 /**
 785  * ahci_platform_suspend - Suspend an ahci-platform device
 786  * @dev: the platform device to suspend
 787  *
 788  * This function suspends the host associated with the device, followed by
 789  * disabling all the resources of the device.
 790  *
 791  * RETURNS:
 792  * 0 on success otherwise a negative error code
 793  */
 794 int ahci_platform_suspend(struct device *dev)
 795 {
 796         struct ata_host *host = dev_get_drvdata(dev);
 797         struct ahci_host_priv *hpriv = host->private_data;
 798         int rc;
 799
 800         rc = ahci_platform_suspend_host(dev);
 801         if (rc)
 802                 return rc;
 803
 804         ahci_platform_disable_resources(hpriv);
 805
 806         return 0;
 807 }
 808 EXPORT_SYMBOL_GPL(ahci_platform_suspend);
 809
 810 /**
 811  * ahci_platform_resume - Resume an ahci-platform device
 812  * @dev: the platform device to resume
 813  *
 814  * This function enables all the resources of the device followed by
 815  * resuming the host associated with the device.
 816  *
 817  * RETURNS:
 818  * 0 on success otherwise a negative error code
 819  */
 820 int ahci_platform_resume(struct device *dev)
 821 {
 822         struct ata_host *host = dev_get_drvdata(dev);
 823         struct ahci_host_priv *hpriv = host->private_data;
 824         int rc;
 825
 826         rc = ahci_platform_enable_resources(hpriv);
 827         if (rc)
 828                 return rc;
 829
 830         rc = ahci_platform_resume_host(dev);
 831         if (rc)
 832                 goto disable_resources;
 833
 834         /* We resumed so update PM runtime state */
 835         pm_runtime_disable(dev);
 836         pm_runtime_set_active(dev);
 837         pm_runtime_enable(dev);
 838
 839         return 0;
 840
 841 disable_resources:
 842         ahci_platform_disable_resources(hpriv);
 843
 844         return rc;
 845 }
 846 EXPORT_SYMBOL_GPL(ahci_platform_resume);
 847 #endif
 848
 849 MODULE_DESCRIPTION("AHCI SATA platform library");
 850 MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>");
 851 MODULE_LICENSE("GPL");