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