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