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