drivers/ata/libahci_platform.c

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