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