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