drivers/acpi/device_pm.c

   1 /*
   2  * drivers/acpi/device_pm.c - ACPI device power management routines.
   3  *
   4  * Copyright (C) 2012, Intel Corp.
   5  * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
   6  *
   7  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   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 version 2 as published
  11  *  by the Free Software Foundation.
  12  *
  13  *  This program is distributed in the hope that it will be useful, but
  14  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  *  General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License along
  19  *  with this program; if not, write to the Free Software Foundation, Inc.,
  20  *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  21  *
  22  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  23  */
  24
  25 #include <linux/device.h>
  26 #include <linux/export.h>
  27 #include <linux/mutex.h>
  28 #include <linux/pm_qos.h>
  29 #include <linux/pm_runtime.h>
  30
  31 #include <acpi/acpi.h>
  32 #include <acpi/acpi_bus.h>
  33 #include <acpi/acpi_drivers.h>
  34
  35 #include "internal.h"
  36
  37 #define _COMPONENT      ACPI_POWER_COMPONENT
  38 ACPI_MODULE_NAME("device_pm");
  39
  40 /**
  41  * acpi_power_state_string - String representation of ACPI device power state.
  42  * @state: ACPI device power state to return the string representation of.
  43  */
  44 const char *acpi_power_state_string(int state)
  45 {
  46         switch (state) {
  47         case ACPI_STATE_D0:
  48                 return "D0";
  49         case ACPI_STATE_D1:
  50                 return "D1";
  51         case ACPI_STATE_D2:
  52                 return "D2";
  53         case ACPI_STATE_D3_HOT:
  54                 return "D3hot";
  55         case ACPI_STATE_D3_COLD:
  56                 return "D3cold";
  57         default:
  58                 return "(unknown)";
  59         }
  60 }
  61
  62 /**
  63  * acpi_device_get_power - Get power state of an ACPI device.
  64  * @device: Device to get the power state of.
  65  * @state: Place to store the power state of the device.
  66  *
  67  * This function does not update the device's power.state field, but it may
  68  * update its parent's power.state field (when the parent's power state is
  69  * unknown and the device's power state turns out to be D0).
  70  */
  71 int acpi_device_get_power(struct acpi_device *device, int *state)
  72 {
  73         int result = ACPI_STATE_UNKNOWN;
  74
  75         if (!device || !state)
  76                 return -EINVAL;
  77
  78         if (!device->flags.power_manageable) {
  79                 /* TBD: Non-recursive algorithm for walking up hierarchy. */
  80                 *state = device->parent ?
  81                         device->parent->power.state : ACPI_STATE_D0;
  82                 goto out;
  83         }
  84
  85         /*
  86          * Get the device's power state from power resources settings and _PSC,
  87          * if available.
  88          */
  89         if (device->power.flags.power_resources) {
  90                 int error = acpi_power_get_inferred_state(device, &result);
  91                 if (error)
  92                         return error;
  93         }
  94         if (device->power.flags.explicit_get) {
  95                 acpi_handle handle = device->handle;
  96                 unsigned long long psc;
  97                 acpi_status status;
  98
  99                 status = acpi_evaluate_integer(handle, "_PSC", NULL, &psc);
 100                 if (ACPI_FAILURE(status))
 101                         return -ENODEV;
 102
 103                 /*
 104                  * The power resources settings may indicate a power state
 105                  * shallower than the actual power state of the device.
 106                  *
 107                  * Moreover, on systems predating ACPI 4.0, if the device
 108                  * doesn't depend on any power resources and _PSC returns 3,
 109                  * that means "power off".  We need to maintain compatibility
 110                  * with those systems.
 111                  */
 112                 if (psc > result && psc < ACPI_STATE_D3_COLD)
 113                         result = psc;
 114                 else if (result == ACPI_STATE_UNKNOWN)
 115                         result = psc > ACPI_STATE_D2 ? ACPI_STATE_D3_COLD : psc;
 116         }
 117
 118         /*
 119          * If we were unsure about the device parent's power state up to this
 120          * point, the fact that the device is in D0 implies that the parent has
 121          * to be in D0 too, except if ignore_parent is set.
 122          */
 123         if (!device->power.flags.ignore_parent && device->parent
 124             && device->parent->power.state == ACPI_STATE_UNKNOWN
 125             && result == ACPI_STATE_D0)
 126                 device->parent->power.state = ACPI_STATE_D0;
 127
 128         *state = result;
 129
 130  out:
 131         ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] power state is %s\n",
 132                           device->pnp.bus_id, acpi_power_state_string(*state)));
 133
 134         return 0;
 135 }
 136
 137 static int acpi_dev_pm_explicit_set(struct acpi_device *adev, int state)
 138 {
 139         if (adev->power.states[state].flags.explicit_set) {
 140                 char method[5] = { '_', 'P', 'S', '0' + state, '\0' };
 141                 acpi_status status;
 142
 143                 status = acpi_evaluate_object(adev->handle, method, NULL, NULL);
 144                 if (ACPI_FAILURE(status))
 145                         return -ENODEV;
 146         }
 147         return 0;
 148 }
 149
 150 /**
 151  * acpi_device_set_power - Set power state of an ACPI device.
 152  * @device: Device to set the power state of.
 153  * @state: New power state to set.
 154  *
 155  * Callers must ensure that the device is power manageable before using this
 156  * function.
 157  */
 158 int acpi_device_set_power(struct acpi_device *device, int state)
 159 {
 160         int result = 0;
 161         bool cut_power = false;
 162
 163         if (!device || !device->flags.power_manageable
 164             || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
 165                 return -EINVAL;
 166
 167         /* Make sure this is a valid target state */
 168
 169         if (state == device->power.state) {
 170                 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] already in %s\n",
 171                                   device->pnp.bus_id,
 172                                   acpi_power_state_string(state)));
 173                 return 0;
 174         }
 175
 176         if (!device->power.states[state].flags.valid) {
 177                 dev_warn(&device->dev, "Power state %s not supported\n",
 178                          acpi_power_state_string(state));
 179                 return -ENODEV;
 180         }
 181         if (!device->power.flags.ignore_parent &&
 182             device->parent && (state < device->parent->power.state)) {
 183                 dev_warn(&device->dev,
 184                          "Cannot transition to power state %s for parent in %s\n",
 185                          acpi_power_state_string(state),
 186                          acpi_power_state_string(device->parent->power.state));
 187                 return -ENODEV;
 188         }
 189
 190         /* For D3cold we should first transition into D3hot. */
 191         if (state == ACPI_STATE_D3_COLD
 192             && device->power.states[ACPI_STATE_D3_COLD].flags.os_accessible) {
 193                 state = ACPI_STATE_D3_HOT;
 194                 cut_power = true;
 195         }
 196
 197         if (state < device->power.state && state != ACPI_STATE_D0
 198             && device->power.state >= ACPI_STATE_D3_HOT) {
 199                 dev_warn(&device->dev,
 200                          "Cannot transition to non-D0 state from D3\n");
 201                 return -ENODEV;
 202         }
 203
 204         /*
 205          * Transition Power
 206          * ----------------
 207          * In accordance with the ACPI specification first apply power (via
 208          * power resources) and then evalute _PSx.
 209          */
 210         if (device->power.flags.power_resources) {
 211                 result = acpi_power_transition(device, state);
 212                 if (result)
 213                         goto end;
 214         }
 215         result = acpi_dev_pm_explicit_set(device, state);
 216         if (result)
 217                 goto end;
 218
 219         if (cut_power) {
 220                 device->power.state = state;
 221                 state = ACPI_STATE_D3_COLD;
 222                 result = acpi_power_transition(device, state);
 223         }
 224
 225  end:
 226         if (result) {
 227                 dev_warn(&device->dev, "Failed to change power state to %s\n",
 228                          acpi_power_state_string(state));
 229         } else {
 230                 device->power.state = state;
 231                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
 232                                   "Device [%s] transitioned to %s\n",
 233                                   device->pnp.bus_id,
 234                                   acpi_power_state_string(state)));
 235         }
 236
 237         return result;
 238 }
 239 EXPORT_SYMBOL(acpi_device_set_power);
 240
 241 int acpi_bus_set_power(acpi_handle handle, int state)
 242 {
 243         struct acpi_device *device;
 244         int result;
 245
 246         result = acpi_bus_get_device(handle, &device);
 247         if (result)
 248                 return result;
 249
 250         return acpi_device_set_power(device, state);
 251 }
 252 EXPORT_SYMBOL(acpi_bus_set_power);
 253
 254 int acpi_bus_init_power(struct acpi_device *device)
 255 {
 256         int state;
 257         int result;
 258
 259         if (!device)
 260                 return -EINVAL;
 261
 262         device->power.state = ACPI_STATE_UNKNOWN;
 263
 264         result = acpi_device_get_power(device, &state);
 265         if (result)
 266                 return result;
 267
 268         if (state < ACPI_STATE_D3_COLD && device->power.flags.power_resources) {
 269                 result = acpi_power_on_resources(device, state);
 270                 if (result)
 271                         return result;
 272
 273                 result = acpi_dev_pm_explicit_set(device, state);
 274                 if (result)
 275                         return result;
 276         } else if (state == ACPI_STATE_UNKNOWN) {
 277                 /*
 278                  * No power resources and missing _PSC?  Cross fingers and make
 279                  * it D0 in hope that this is what the BIOS put the device into.
 280                  * [We tried to force D0 here by executing _PS0, but that broke
 281                  * Toshiba P870-303 in a nasty way.]
 282                  */
 283                 state = ACPI_STATE_D0;
 284         }
 285         device->power.state = state;
 286         return 0;
 287 }
 288
 289 /**
 290  * acpi_device_fix_up_power - Force device with missing _PSC into D0.
 291  * @device: Device object whose power state is to be fixed up.
 292  *
 293  * Devices without power resources and _PSC, but having _PS0 and _PS3 defined,
 294  * are assumed to be put into D0 by the BIOS.  However, in some cases that may
 295  * not be the case and this function should be used then.
 296  */
 297 int acpi_device_fix_up_power(struct acpi_device *device)
 298 {
 299         int ret = 0;
 300
 301         if (!device->power.flags.power_resources
 302             && !device->power.flags.explicit_get
 303             && device->power.state == ACPI_STATE_D0)
 304                 ret = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
 305
 306         return ret;
 307 }
 308
 309 int acpi_bus_update_power(acpi_handle handle, int *state_p)
 310 {
 311         struct acpi_device *device;
 312         int state;
 313         int result;
 314
 315         result = acpi_bus_get_device(handle, &device);
 316         if (result)
 317                 return result;
 318
 319         result = acpi_device_get_power(device, &state);
 320         if (result)
 321                 return result;
 322
 323         if (state == ACPI_STATE_UNKNOWN) {
 324                 state = ACPI_STATE_D0;
 325                 result = acpi_device_set_power(device, state);
 326                 if (result)
 327                         return result;
 328         } else {
 329                 if (device->power.flags.power_resources) {
 330                         /*
 331                          * We don't need to really switch the state, bu we need
 332                          * to update the power resources' reference counters.
 333                          */
 334                         result = acpi_power_transition(device, state);
 335                         if (result)
 336                                 return result;
 337                 }
 338                 device->power.state = state;
 339         }
 340         if (state_p)
 341                 *state_p = state;
 342
 343         return 0;
 344 }
 345 EXPORT_SYMBOL_GPL(acpi_bus_update_power);
 346
 347 bool acpi_bus_power_manageable(acpi_handle handle)
 348 {
 349         struct acpi_device *device;
 350         int result;
 351
 352         result = acpi_bus_get_device(handle, &device);
 353         return result ? false : device->flags.power_manageable;
 354 }
 355 EXPORT_SYMBOL(acpi_bus_power_manageable);
 356
 357 #ifdef CONFIG_PM
 358 static DEFINE_MUTEX(acpi_pm_notifier_lock);
 359
 360 /**
 361  * acpi_add_pm_notifier - Register PM notifier for given ACPI device.
 362  * @adev: ACPI device to add the notifier for.
 363  * @context: Context information to pass to the notifier routine.
 364  *
 365  * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of
 366  * PM wakeup events.  For example, wakeup events may be generated for bridges
 367  * if one of the devices below the bridge is signaling wakeup, even if the
 368  * bridge itself doesn't have a wakeup GPE associated with it.
 369  */
 370 acpi_status acpi_add_pm_notifier(struct acpi_device *adev,
 371                                  acpi_notify_handler handler, void *context)
 372 {
 373         acpi_status status = AE_ALREADY_EXISTS;
 374
 375         mutex_lock(&acpi_pm_notifier_lock);
 376
 377         if (adev->wakeup.flags.notifier_present)
 378                 goto out;
 379
 380         status = acpi_install_notify_handler(adev->handle,
 381                                              ACPI_SYSTEM_NOTIFY,
 382                                              handler, context);
 383         if (ACPI_FAILURE(status))
 384                 goto out;
 385
 386         adev->wakeup.flags.notifier_present = true;
 387
 388  out:
 389         mutex_unlock(&acpi_pm_notifier_lock);
 390         return status;
 391 }
 392
 393 /**
 394  * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device.
 395  * @adev: ACPI device to remove the notifier from.
 396  */
 397 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev,
 398                                     acpi_notify_handler handler)
 399 {
 400         acpi_status status = AE_BAD_PARAMETER;
 401
 402         mutex_lock(&acpi_pm_notifier_lock);
 403
 404         if (!adev->wakeup.flags.notifier_present)
 405                 goto out;
 406
 407         status = acpi_remove_notify_handler(adev->handle,
 408                                             ACPI_SYSTEM_NOTIFY,
 409                                             handler);
 410         if (ACPI_FAILURE(status))
 411                 goto out;
 412
 413         adev->wakeup.flags.notifier_present = false;
 414
 415  out:
 416         mutex_unlock(&acpi_pm_notifier_lock);
 417         return status;
 418 }
 419
 420 bool acpi_bus_can_wakeup(acpi_handle handle)
 421 {
 422         struct acpi_device *device;
 423         int result;
 424
 425         result = acpi_bus_get_device(handle, &device);
 426         return result ? false : device->wakeup.flags.valid;
 427 }
 428 EXPORT_SYMBOL(acpi_bus_can_wakeup);
 429
 430 /**
 431  * acpi_dev_pm_get_state - Get preferred power state of ACPI device.
 432  * @dev: Device whose preferred target power state to return.
 433  * @adev: ACPI device node corresponding to @dev.
 434  * @target_state: System state to match the resultant device state.
 435  * @d_min_p: Location to store the highest power state available to the device.
 436  * @d_max_p: Location to store the lowest power state available to the device.
 437  *
 438  * Find the lowest power (highest number) and highest power (lowest number) ACPI
 439  * device power states that the device can be in while the system is in the
 440  * state represented by @target_state.  Store the integer numbers representing
 441  * those stats in the memory locations pointed to by @d_max_p and @d_min_p,
 442  * respectively.
 443  *
 444  * Callers must ensure that @dev and @adev are valid pointers and that @adev
 445  * actually corresponds to @dev before using this function.
 446  *
 447  * Returns 0 on success or -ENODATA when one of the ACPI methods fails or
 448  * returns a value that doesn't make sense.  The memory locations pointed to by
 449  * @d_max_p and @d_min_p are only modified on success.
 450  */
 451 static int acpi_dev_pm_get_state(struct device *dev, struct acpi_device *adev,
 452                                  u32 target_state, int *d_min_p, int *d_max_p)
 453 {
 454         char method[] = { '_', 'S', '0' + target_state, 'D', '\0' };
 455         acpi_handle handle = adev->handle;
 456         unsigned long long ret;
 457         int d_min, d_max;
 458         bool wakeup = false;
 459         acpi_status status;
 460
 461         /*
 462          * If the system state is S0, the lowest power state the device can be
 463          * in is D3cold, unless the device has _S0W and is supposed to signal
 464          * wakeup, in which case the return value of _S0W has to be used as the
 465          * lowest power state available to the device.
 466          */
 467         d_min = ACPI_STATE_D0;
 468         d_max = ACPI_STATE_D3_COLD;
 469
 470         /*
 471          * If present, _SxD methods return the minimum D-state (highest power
 472          * state) we can use for the corresponding S-states.  Otherwise, the
 473          * minimum D-state is D0 (ACPI 3.x).
 474          */
 475         if (target_state > ACPI_STATE_S0) {
 476                 /*
 477                  * We rely on acpi_evaluate_integer() not clobbering the integer
 478                  * provided if AE_NOT_FOUND is returned.
 479                  */
 480                 ret = d_min;
 481                 status = acpi_evaluate_integer(handle, method, NULL, &ret);
 482                 if ((ACPI_FAILURE(status) && status != AE_NOT_FOUND)
 483                     || ret > ACPI_STATE_D3_COLD)
 484                         return -ENODATA;
 485
 486                 /*
 487                  * We need to handle legacy systems where D3hot and D3cold are
 488                  * the same and 3 is returned in both cases, so fall back to
 489                  * D3cold if D3hot is not a valid state.
 490                  */
 491                 if (!adev->power.states[ret].flags.valid) {
 492                         if (ret == ACPI_STATE_D3_HOT)
 493                                 ret = ACPI_STATE_D3_COLD;
 494                         else
 495                                 return -ENODATA;
 496                 }
 497                 d_min = ret;
 498                 wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid
 499                         && adev->wakeup.sleep_state >= target_state;
 500         } else if (dev_pm_qos_flags(dev, PM_QOS_FLAG_REMOTE_WAKEUP) !=
 501                         PM_QOS_FLAGS_NONE) {
 502                 wakeup = adev->wakeup.flags.valid;
 503         }
 504
 505         /*
 506          * If _PRW says we can wake up the system from the target sleep state,
 507          * the D-state returned by _SxD is sufficient for that (we assume a
 508          * wakeup-aware driver if wake is set).  Still, if _SxW exists
 509          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
 510          * can wake the system.  _S0W may be valid, too.
 511          */
 512         if (wakeup) {
 513                 method[3] = 'W';
 514                 status = acpi_evaluate_integer(handle, method, NULL, &ret);
 515                 if (status == AE_NOT_FOUND) {
 516                         if (target_state > ACPI_STATE_S0)
 517                                 d_max = d_min;
 518                 } else if (ACPI_SUCCESS(status) && ret <= ACPI_STATE_D3_COLD) {
 519                         /* Fall back to D3cold if ret is not a valid state. */
 520                         if (!adev->power.states[ret].flags.valid)
 521                                 ret = ACPI_STATE_D3_COLD;
 522
 523                         d_max = ret > d_min ? ret : d_min;
 524                 } else {
 525                         return -ENODATA;
 526                 }
 527         }
 528
 529         if (d_min_p)
 530                 *d_min_p = d_min;
 531
 532         if (d_max_p)
 533                 *d_max_p = d_max;
 534
 535         return 0;
 536 }
 537
 538 /**
 539  * acpi_pm_device_sleep_state - Get preferred power state of ACPI device.
 540  * @dev: Device whose preferred target power state to return.
 541  * @d_min_p: Location to store the upper limit of the allowed states range.
 542  * @d_max_in: Deepest low-power state to take into consideration.
 543  * Return value: Preferred power state of the device on success, -ENODEV
 544  * if there's no 'struct acpi_device' for @dev, -EINVAL if @d_max_in is
 545  * incorrect, or -ENODATA on ACPI method failure.
 546  *
 547  * The caller must ensure that @dev is valid before using this function.
 548  */
 549 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in)
 550 {
 551         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
 552         struct acpi_device *adev;
 553         int ret, d_min, d_max;
 554
 555         if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3_COLD)
 556                 return -EINVAL;
 557
 558         if (d_max_in > ACPI_STATE_D3_HOT) {
 559                 enum pm_qos_flags_status stat;
 560
 561                 stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF);
 562                 if (stat == PM_QOS_FLAGS_ALL)
 563                         d_max_in = ACPI_STATE_D3_HOT;
 564         }
 565
 566         if (!handle || acpi_bus_get_device(handle, &adev)) {
 567                 dev_dbg(dev, "ACPI handle without context in %s!\n", __func__);
 568                 return -ENODEV;
 569         }
 570
 571         ret = acpi_dev_pm_get_state(dev, adev, acpi_target_system_state(),
 572                                     &d_min, &d_max);
 573         if (ret)
 574                 return ret;
 575
 576         if (d_max_in < d_min)
 577                 return -EINVAL;
 578
 579         if (d_max > d_max_in) {
 580                 for (d_max = d_max_in; d_max > d_min; d_max--) {
 581                         if (adev->power.states[d_max].flags.valid)
 582                                 break;
 583                 }
 584         }
 585
 586         if (d_min_p)
 587                 *d_min_p = d_min;
 588
 589         return d_max;
 590 }
 591 EXPORT_SYMBOL(acpi_pm_device_sleep_state);
 592
 593 #ifdef CONFIG_PM_RUNTIME
 594 /**
 595  * acpi_wakeup_device - Wakeup notification handler for ACPI devices.
 596  * @handle: ACPI handle of the device the notification is for.
 597  * @event: Type of the signaled event.
 598  * @context: Device corresponding to @handle.
 599  */
 600 static void acpi_wakeup_device(acpi_handle handle, u32 event, void *context)
 601 {
 602         struct device *dev = context;
 603
 604         if (event == ACPI_NOTIFY_DEVICE_WAKE && dev) {
 605                 pm_wakeup_event(dev, 0);
 606                 pm_runtime_resume(dev);
 607         }
 608 }
 609
 610 /**
 611  * __acpi_device_run_wake - Enable/disable runtime remote wakeup for device.
 612  * @adev: ACPI device to enable/disable the remote wakeup for.
 613  * @enable: Whether to enable or disable the wakeup functionality.
 614  *
 615  * Enable/disable the GPE associated with @adev so that it can generate
 616  * wakeup signals for the device in response to external (remote) events and
 617  * enable/disable device wakeup power.
 618  *
 619  * Callers must ensure that @adev is a valid ACPI device node before executing
 620  * this function.
 621  */
 622 int __acpi_device_run_wake(struct acpi_device *adev, bool enable)
 623 {
 624         struct acpi_device_wakeup *wakeup = &adev->wakeup;
 625
 626         if (enable) {
 627                 acpi_status res;
 628                 int error;
 629
 630                 error = acpi_enable_wakeup_device_power(adev, ACPI_STATE_S0);
 631                 if (error)
 632                         return error;
 633
 634                 res = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number);
 635                 if (ACPI_FAILURE(res)) {
 636                         acpi_disable_wakeup_device_power(adev);
 637                         return -EIO;
 638                 }
 639         } else {
 640                 acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
 641                 acpi_disable_wakeup_device_power(adev);
 642         }
 643         return 0;
 644 }
 645
 646 /**
 647  * acpi_pm_device_run_wake - Enable/disable remote wakeup for given device.
 648  * @dev: Device to enable/disable the platform to wake up.
 649  * @enable: Whether to enable or disable the wakeup functionality.
 650  */
 651 int acpi_pm_device_run_wake(struct device *phys_dev, bool enable)
 652 {
 653         struct acpi_device *adev;
 654         acpi_handle handle;
 655
 656         if (!device_run_wake(phys_dev))
 657                 return -EINVAL;
 658
 659         handle = DEVICE_ACPI_HANDLE(phys_dev);
 660         if (!handle || acpi_bus_get_device(handle, &adev)) {
 661                 dev_dbg(phys_dev, "ACPI handle without context in %s!\n",
 662                         __func__);
 663                 return -ENODEV;
 664         }
 665
 666         return __acpi_device_run_wake(adev, enable);
 667 }
 668 EXPORT_SYMBOL(acpi_pm_device_run_wake);
 669 #else
 670 static inline void acpi_wakeup_device(acpi_handle handle, u32 event,
 671                                       void *context) {}
 672 #endif /* CONFIG_PM_RUNTIME */
 673
 674 #ifdef CONFIG_PM_SLEEP
 675 /**
 676  * __acpi_device_sleep_wake - Enable or disable device to wake up the system.
 677  * @dev: Device to enable/desible to wake up the system.
 678  * @target_state: System state the device is supposed to wake up from.
 679  * @enable: Whether to enable or disable @dev to wake up the system.
 680  */
 681 int __acpi_device_sleep_wake(struct acpi_device *adev, u32 target_state,
 682                              bool enable)
 683 {
 684         return enable ?
 685                 acpi_enable_wakeup_device_power(adev, target_state) :
 686                 acpi_disable_wakeup_device_power(adev);
 687 }
 688
 689 /**
 690  * acpi_pm_device_sleep_wake - Enable or disable device to wake up the system.
 691  * @dev: Device to enable/desible to wake up the system from sleep states.
 692  * @enable: Whether to enable or disable @dev to wake up the system.
 693  */
 694 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 695 {
 696         acpi_handle handle;
 697         struct acpi_device *adev;
 698         int error;
 699
 700         if (!device_can_wakeup(dev))
 701                 return -EINVAL;
 702
 703         handle = DEVICE_ACPI_HANDLE(dev);
 704         if (!handle || acpi_bus_get_device(handle, &adev)) {
 705                 dev_dbg(dev, "ACPI handle without context in %s!\n", __func__);
 706                 return -ENODEV;
 707         }
 708
 709         error = __acpi_device_sleep_wake(adev, acpi_target_system_state(),
 710                                          enable);
 711         if (!error)
 712                 dev_info(dev, "System wakeup %s by ACPI\n",
 713                                 enable ? "enabled" : "disabled");
 714
 715         return error;
 716 }
 717 #endif /* CONFIG_PM_SLEEP */
 718
 719 /**
 720  * acpi_dev_pm_get_node - Get ACPI device node for the given physical device.
 721  * @dev: Device to get the ACPI node for.
 722  */
 723 struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
 724 {
 725         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
 726         struct acpi_device *adev;
 727
 728         return handle && !acpi_bus_get_device(handle, &adev) ? adev : NULL;
 729 }
 730
 731 /**
 732  * acpi_dev_pm_low_power - Put ACPI device into a low-power state.
 733  * @dev: Device to put into a low-power state.
 734  * @adev: ACPI device node corresponding to @dev.
 735  * @system_state: System state to choose the device state for.
 736  */
 737 static int acpi_dev_pm_low_power(struct device *dev, struct acpi_device *adev,
 738                                  u32 system_state)
 739 {
 740         int ret, state;
 741
 742         if (!acpi_device_power_manageable(adev))
 743                 return 0;
 744
 745         ret = acpi_dev_pm_get_state(dev, adev, system_state, NULL, &state);
 746         return ret ? ret : acpi_device_set_power(adev, state);
 747 }
 748
 749 /**
 750  * acpi_dev_pm_full_power - Put ACPI device into the full-power state.
 751  * @adev: ACPI device node to put into the full-power state.
 752  */
 753 static int acpi_dev_pm_full_power(struct acpi_device *adev)
 754 {
 755         return acpi_device_power_manageable(adev) ?
 756                 acpi_device_set_power(adev, ACPI_STATE_D0) : 0;
 757 }
 758
 759 #ifdef CONFIG_PM_RUNTIME
 760 /**
 761  * acpi_dev_runtime_suspend - Put device into a low-power state using ACPI.
 762  * @dev: Device to put into a low-power state.
 763  *
 764  * Put the given device into a runtime low-power state using the standard ACPI
 765  * mechanism.  Set up remote wakeup if desired, choose the state to put the
 766  * device into (this checks if remote wakeup is expected to work too), and set
 767  * the power state of the device.
 768  */
 769 int acpi_dev_runtime_suspend(struct device *dev)
 770 {
 771         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
 772         bool remote_wakeup;
 773         int error;
 774
 775         if (!adev)
 776                 return 0;
 777
 778         remote_wakeup = dev_pm_qos_flags(dev, PM_QOS_FLAG_REMOTE_WAKEUP) >
 779                                 PM_QOS_FLAGS_NONE;
 780         error = __acpi_device_run_wake(adev, remote_wakeup);
 781         if (remote_wakeup && error)
 782                 return -EAGAIN;
 783
 784         error = acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0);
 785         if (error)
 786                 __acpi_device_run_wake(adev, false);
 787
 788         return error;
 789 }
 790 EXPORT_SYMBOL_GPL(acpi_dev_runtime_suspend);
 791
 792 /**
 793  * acpi_dev_runtime_resume - Put device into the full-power state using ACPI.
 794  * @dev: Device to put into the full-power state.
 795  *
 796  * Put the given device into the full-power state using the standard ACPI
 797  * mechanism at run time.  Set the power state of the device to ACPI D0 and
 798  * disable remote wakeup.
 799  */
 800 int acpi_dev_runtime_resume(struct device *dev)
 801 {
 802         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
 803         int error;
 804
 805         if (!adev)
 806                 return 0;
 807
 808         error = acpi_dev_pm_full_power(adev);
 809         __acpi_device_run_wake(adev, false);
 810         return error;
 811 }
 812 EXPORT_SYMBOL_GPL(acpi_dev_runtime_resume);
 813
 814 /**
 815  * acpi_subsys_runtime_suspend - Suspend device using ACPI.
 816  * @dev: Device to suspend.
 817  *
 818  * Carry out the generic runtime suspend procedure for @dev and use ACPI to put
 819  * it into a runtime low-power state.
 820  */
 821 int acpi_subsys_runtime_suspend(struct device *dev)
 822 {
 823         int ret = pm_generic_runtime_suspend(dev);
 824         return ret ? ret : acpi_dev_runtime_suspend(dev);
 825 }
 826 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_suspend);
 827
 828 /**
 829  * acpi_subsys_runtime_resume - Resume device using ACPI.
 830  * @dev: Device to Resume.
 831  *
 832  * Use ACPI to put the given device into the full-power state and carry out the
 833  * generic runtime resume procedure for it.
 834  */
 835 int acpi_subsys_runtime_resume(struct device *dev)
 836 {
 837         int ret = acpi_dev_runtime_resume(dev);
 838         return ret ? ret : pm_generic_runtime_resume(dev);
 839 }
 840 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_resume);
 841 #endif /* CONFIG_PM_RUNTIME */
 842
 843 #ifdef CONFIG_PM_SLEEP
 844 /**
 845  * acpi_dev_suspend_late - Put device into a low-power state using ACPI.
 846  * @dev: Device to put into a low-power state.
 847  *
 848  * Put the given device into a low-power state during system transition to a
 849  * sleep state using the standard ACPI mechanism.  Set up system wakeup if
 850  * desired, choose the state to put the device into (this checks if system
 851  * wakeup is expected to work too), and set the power state of the device.
 852  */
 853 int acpi_dev_suspend_late(struct device *dev)
 854 {
 855         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
 856         u32 target_state;
 857         bool wakeup;
 858         int error;
 859
 860         if (!adev)
 861                 return 0;
 862
 863         target_state = acpi_target_system_state();
 864         wakeup = device_may_wakeup(dev);
 865         error = __acpi_device_sleep_wake(adev, target_state, wakeup);
 866         if (wakeup && error)
 867                 return error;
 868
 869         error = acpi_dev_pm_low_power(dev, adev, target_state);
 870         if (error)
 871                 __acpi_device_sleep_wake(adev, ACPI_STATE_UNKNOWN, false);
 872
 873         return error;
 874 }
 875 EXPORT_SYMBOL_GPL(acpi_dev_suspend_late);
 876
 877 /**
 878  * acpi_dev_resume_early - Put device into the full-power state using ACPI.
 879  * @dev: Device to put into the full-power state.
 880  *
 881  * Put the given device into the full-power state using the standard ACPI
 882  * mechanism during system transition to the working state.  Set the power
 883  * state of the device to ACPI D0 and disable remote wakeup.
 884  */
 885 int acpi_dev_resume_early(struct device *dev)
 886 {
 887         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
 888         int error;
 889
 890         if (!adev)
 891                 return 0;
 892
 893         error = acpi_dev_pm_full_power(adev);
 894         __acpi_device_sleep_wake(adev, ACPI_STATE_UNKNOWN, false);
 895         return error;
 896 }
 897 EXPORT_SYMBOL_GPL(acpi_dev_resume_early);
 898
 899 /**
 900  * acpi_subsys_prepare - Prepare device for system transition to a sleep state.
 901  * @dev: Device to prepare.
 902  */
 903 int acpi_subsys_prepare(struct device *dev)
 904 {
 905         /*
 906          * Follow PCI and resume devices suspended at run time before running
 907          * their system suspend callbacks.
 908          */
 909         pm_runtime_resume(dev);
 910         return pm_generic_prepare(dev);
 911 }
 912 EXPORT_SYMBOL_GPL(acpi_subsys_prepare);
 913
 914 /**
 915  * acpi_subsys_suspend_late - Suspend device using ACPI.
 916  * @dev: Device to suspend.
 917  *
 918  * Carry out the generic late suspend procedure for @dev and use ACPI to put
 919  * it into a low-power state during system transition into a sleep state.
 920  */
 921 int acpi_subsys_suspend_late(struct device *dev)
 922 {
 923         int ret = pm_generic_suspend_late(dev);
 924         return ret ? ret : acpi_dev_suspend_late(dev);
 925 }
 926 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_late);
 927
 928 /**
 929  * acpi_subsys_resume_early - Resume device using ACPI.
 930  * @dev: Device to Resume.
 931  *
 932  * Use ACPI to put the given device into the full-power state and carry out the
 933  * generic early resume procedure for it during system transition into the
 934  * working state.
 935  */
 936 int acpi_subsys_resume_early(struct device *dev)
 937 {
 938         int ret = acpi_dev_resume_early(dev);
 939         return ret ? ret : pm_generic_resume_early(dev);
 940 }
 941 EXPORT_SYMBOL_GPL(acpi_subsys_resume_early);
 942 #endif /* CONFIG_PM_SLEEP */
 943
 944 static struct dev_pm_domain acpi_general_pm_domain = {
 945         .ops = {
 946 #ifdef CONFIG_PM_RUNTIME
 947                 .runtime_suspend = acpi_subsys_runtime_suspend,
 948                 .runtime_resume = acpi_subsys_runtime_resume,
 949 #endif
 950 #ifdef CONFIG_PM_SLEEP
 951                 .prepare = acpi_subsys_prepare,
 952                 .suspend_late = acpi_subsys_suspend_late,
 953                 .resume_early = acpi_subsys_resume_early,
 954                 .poweroff_late = acpi_subsys_suspend_late,
 955                 .restore_early = acpi_subsys_resume_early,
 956 #endif
 957         },
 958 };
 959
 960 /**
 961  * acpi_dev_pm_attach - Prepare device for ACPI power management.
 962  * @dev: Device to prepare.
 963  * @power_on: Whether or not to power on the device.
 964  *
 965  * If @dev has a valid ACPI handle that has a valid struct acpi_device object
 966  * attached to it, install a wakeup notification handler for the device and
 967  * add it to the general ACPI PM domain.  If @power_on is set, the device will
 968  * be put into the ACPI D0 state before the function returns.
 969  *
 970  * This assumes that the @dev's bus type uses generic power management callbacks
 971  * (or doesn't use any power management callbacks at all).
 972  *
 973  * Callers must ensure proper synchronization of this function with power
 974  * management callbacks.
 975  */
 976 int acpi_dev_pm_attach(struct device *dev, bool power_on)
 977 {
 978         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
 979
 980         if (!adev)
 981                 return -ENODEV;
 982
 983         if (dev->pm_domain)
 984                 return -EEXIST;
 985
 986         acpi_add_pm_notifier(adev, acpi_wakeup_device, dev);
 987         dev->pm_domain = &acpi_general_pm_domain;
 988         if (power_on) {
 989                 acpi_dev_pm_full_power(adev);
 990                 __acpi_device_run_wake(adev, false);
 991         }
 992         return 0;
 993 }
 994 EXPORT_SYMBOL_GPL(acpi_dev_pm_attach);
 995
 996 /**
 997  * acpi_dev_pm_detach - Remove ACPI power management from the device.
 998  * @dev: Device to take care of.
 999  * @power_off: Whether or not to try to remove power from the device.
1000  *
1001  * Remove the device from the general ACPI PM domain and remove its wakeup
1002  * notifier.  If @power_off is set, additionally remove power from the device if
1003  * possible.
1004  *
1005  * Callers must ensure proper synchronization of this function with power
1006  * management callbacks.
1007  */
1008 void acpi_dev_pm_detach(struct device *dev, bool power_off)
1009 {
1010         struct acpi_device *adev = acpi_dev_pm_get_node(dev);
1011
1012         if (adev && dev->pm_domain == &acpi_general_pm_domain) {
1013                 dev->pm_domain = NULL;
1014                 acpi_remove_pm_notifier(adev, acpi_wakeup_device);
1015                 if (power_off) {
1016                         /*
1017                          * If the device's PM QoS resume latency limit or flags
1018                          * have been exposed to user space, they have to be
1019                          * hidden at this point, so that they don't affect the
1020                          * choice of the low-power state to put the device into.
1021                          */
1022                         dev_pm_qos_hide_latency_limit(dev);
1023                         dev_pm_qos_hide_flags(dev);
1024                         __acpi_device_run_wake(adev, false);
1025                         acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0);
1026                 }
1027         }
1028 }
1029 EXPORT_SYMBOL_GPL(acpi_dev_pm_detach);
1030 #endif /* CONFIG_PM */