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