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 D3cold is not supported, 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(target_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(target_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                 device->flags.initialized = false;
 267                 return -ENXIO;
 268         }
 269
 270         result = acpi_device_get_power(device, &state);
 271         if (result)
 272                 return result;
 273
 274         if (state < ACPI_STATE_D3_COLD && device->power.flags.power_resources) {
 275                 /* Reference count the power resources. */
 276                 result = acpi_power_on_resources(device, state);
 277                 if (result)
 278                         return result;
 279
 280                 if (state == ACPI_STATE_D0) {
 281                         /*
 282                          * If _PSC is not present and the state inferred from
 283                          * power resources appears to be D0, it still may be
 284                          * necessary to execute _PS0 at this point, because
 285                          * another device using the same power resources may
 286                          * have been put into D0 previously and that's why we
 287                          * see D0 here.
 288                          */
 289                         result = acpi_dev_pm_explicit_set(device, state);
 290                         if (result)
 291                                 return result;
 292                 }
 293         } else if (state == ACPI_STATE_UNKNOWN) {
 294                 /*
 295                  * No power resources and missing _PSC?  Cross fingers and make
 296                  * it D0 in hope that this is what the BIOS put the device into.
 297                  * [We tried to force D0 here by executing _PS0, but that broke
 298                  * Toshiba P870-303 in a nasty way.]
 299                  */
 300                 state = ACPI_STATE_D0;
 301         }
 302         device->power.state = state;
 303         return 0;
 304 }
 305
 306 /**
 307  * acpi_device_fix_up_power - Force device with missing _PSC into D0.
 308  * @device: Device object whose power state is to be fixed up.
 309  *
 310  * Devices without power resources and _PSC, but having _PS0 and _PS3 defined,
 311  * are assumed to be put into D0 by the BIOS.  However, in some cases that may
 312  * not be the case and this function should be used then.
 313  */
 314 int acpi_device_fix_up_power(struct acpi_device *device)
 315 {
 316         int ret = 0;
 317
 318         if (!device->power.flags.power_resources
 319             && !device->power.flags.explicit_get
 320             && device->power.state == ACPI_STATE_D0)
 321                 ret = acpi_dev_pm_explicit_set(device, ACPI_STATE_D0);
 322
 323         return ret;
 324 }
 325 EXPORT_SYMBOL_GPL(acpi_device_fix_up_power);
 326
 327 int acpi_device_update_power(struct acpi_device *device, int *state_p)
 328 {
 329         int state;
 330         int result;
 331
 332         if (device->power.state == ACPI_STATE_UNKNOWN) {
 333                 result = acpi_bus_init_power(device);
 334                 if (!result && state_p)
 335                         *state_p = device->power.state;
 336
 337                 return result;
 338         }
 339
 340         result = acpi_device_get_power(device, &state);
 341         if (result)
 342                 return result;
 343
 344         if (state == ACPI_STATE_UNKNOWN) {
 345                 state = ACPI_STATE_D0;
 346                 result = acpi_device_set_power(device, state);
 347                 if (result)
 348                         return result;
 349         } else {
 350                 if (device->power.flags.power_resources) {
 351                         /*
 352                          * We don't need to really switch the state, bu we need
 353                          * to update the power resources' reference counters.
 354                          */
 355                         result = acpi_power_transition(device, state);
 356                         if (result)
 357                                 return result;
 358                 }
 359                 device->power.state = state;
 360         }
 361         if (state_p)
 362                 *state_p = state;
 363
 364         return 0;
 365 }
 366 EXPORT_SYMBOL_GPL(acpi_device_update_power);
 367
 368 int acpi_bus_update_power(acpi_handle handle, int *state_p)
 369 {
 370         struct acpi_device *device;
 371         int result;
 372
 373         result = acpi_bus_get_device(handle, &device);
 374         return result ? result : acpi_device_update_power(device, state_p);
 375 }
 376 EXPORT_SYMBOL_GPL(acpi_bus_update_power);
 377
 378 bool acpi_bus_power_manageable(acpi_handle handle)
 379 {
 380         struct acpi_device *device;
 381         int result;
 382
 383         result = acpi_bus_get_device(handle, &device);
 384         return result ? false : device->flags.power_manageable;
 385 }
 386 EXPORT_SYMBOL(acpi_bus_power_manageable);
 387
 388 #ifdef CONFIG_PM
 389 static DEFINE_MUTEX(acpi_pm_notifier_lock);
 390 static DEFINE_MUTEX(acpi_pm_notifier_install_lock);
 391
 392 void acpi_pm_wakeup_event(struct device *dev)
 393 {
 394         pm_wakeup_dev_event(dev, 0, acpi_s2idle_wakeup());
 395 }
 396 EXPORT_SYMBOL_GPL(acpi_pm_wakeup_event);
 397
 398 static void acpi_pm_notify_handler(acpi_handle handle, u32 val, void *not_used)
 399 {
 400         struct acpi_device *adev;
 401
 402         if (val != ACPI_NOTIFY_DEVICE_WAKE)
 403                 return;
 404
 405         acpi_handle_debug(handle, "Wake notify\n");
 406
 407         adev = acpi_bus_get_acpi_device(handle);
 408         if (!adev)
 409                 return;
 410
 411         mutex_lock(&acpi_pm_notifier_lock);
 412
 413         if (adev->wakeup.flags.notifier_present) {
 414                 pm_wakeup_ws_event(adev->wakeup.ws, 0, acpi_s2idle_wakeup());
 415                 if (adev->wakeup.context.func) {
 416                         acpi_handle_debug(handle, "Running %pF for %s\n",
 417                                           adev->wakeup.context.func,
 418                                           dev_name(adev->wakeup.context.dev));
 419                         adev->wakeup.context.func(&adev->wakeup.context);
 420                 }
 421         }
 422
 423         mutex_unlock(&acpi_pm_notifier_lock);
 424
 425         acpi_bus_put_acpi_device(adev);
 426 }
 427
 428 /**
 429  * acpi_add_pm_notifier - Register PM notify handler for given ACPI device.
 430  * @adev: ACPI device to add the notify handler for.
 431  * @dev: Device to generate a wakeup event for while handling the notification.
 432  * @func: Work function to execute when handling the notification.
 433  *
 434  * NOTE: @adev need not be a run-wake or wakeup device to be a valid source of
 435  * PM wakeup events.  For example, wakeup events may be generated for bridges
 436  * if one of the devices below the bridge is signaling wakeup, even if the
 437  * bridge itself doesn't have a wakeup GPE associated with it.
 438  */
 439 acpi_status acpi_add_pm_notifier(struct acpi_device *adev, struct device *dev,
 440                         void (*func)(struct acpi_device_wakeup_context *context))
 441 {
 442         acpi_status status = AE_ALREADY_EXISTS;
 443
 444         if (!dev && !func)
 445                 return AE_BAD_PARAMETER;
 446
 447         mutex_lock(&acpi_pm_notifier_install_lock);
 448
 449         if (adev->wakeup.flags.notifier_present)
 450                 goto out;
 451
 452         status = acpi_install_notify_handler(adev->handle, ACPI_SYSTEM_NOTIFY,
 453                                              acpi_pm_notify_handler, NULL);
 454         if (ACPI_FAILURE(status))
 455                 goto out;
 456
 457         mutex_lock(&acpi_pm_notifier_lock);
 458         adev->wakeup.ws = wakeup_source_register(dev_name(&adev->dev));
 459         adev->wakeup.context.dev = dev;
 460         adev->wakeup.context.func = func;
 461         adev->wakeup.flags.notifier_present = true;
 462         mutex_unlock(&acpi_pm_notifier_lock);
 463
 464  out:
 465         mutex_unlock(&acpi_pm_notifier_install_lock);
 466         return status;
 467 }
 468
 469 /**
 470  * acpi_remove_pm_notifier - Unregister PM notifier from given ACPI device.
 471  * @adev: ACPI device to remove the notifier from.
 472  */
 473 acpi_status acpi_remove_pm_notifier(struct acpi_device *adev)
 474 {
 475         acpi_status status = AE_BAD_PARAMETER;
 476
 477         mutex_lock(&acpi_pm_notifier_install_lock);
 478
 479         if (!adev->wakeup.flags.notifier_present)
 480                 goto out;
 481
 482         status = acpi_remove_notify_handler(adev->handle,
 483                                             ACPI_SYSTEM_NOTIFY,
 484                                             acpi_pm_notify_handler);
 485         if (ACPI_FAILURE(status))
 486                 goto out;
 487
 488         mutex_lock(&acpi_pm_notifier_lock);
 489         adev->wakeup.context.func = NULL;
 490         adev->wakeup.context.dev = NULL;
 491         wakeup_source_unregister(adev->wakeup.ws);
 492         adev->wakeup.flags.notifier_present = false;
 493         mutex_unlock(&acpi_pm_notifier_lock);
 494
 495  out:
 496         mutex_unlock(&acpi_pm_notifier_install_lock);
 497         return status;
 498 }
 499
 500 bool acpi_bus_can_wakeup(acpi_handle handle)
 501 {
 502         struct acpi_device *device;
 503         int result;
 504
 505         result = acpi_bus_get_device(handle, &device);
 506         return result ? false : device->wakeup.flags.valid;
 507 }
 508 EXPORT_SYMBOL(acpi_bus_can_wakeup);
 509
 510 bool acpi_pm_device_can_wakeup(struct device *dev)
 511 {
 512         struct acpi_device *adev = ACPI_COMPANION(dev);
 513
 514         return adev ? acpi_device_can_wakeup(adev) : false;
 515 }
 516
 517 /**
 518  * acpi_dev_pm_get_state - Get preferred power state of ACPI device.
 519  * @dev: Device whose preferred target power state to return.
 520  * @adev: ACPI device node corresponding to @dev.
 521  * @target_state: System state to match the resultant device state.
 522  * @d_min_p: Location to store the highest power state available to the device.
 523  * @d_max_p: Location to store the lowest power state available to the device.
 524  *
 525  * Find the lowest power (highest number) and highest power (lowest number) ACPI
 526  * device power states that the device can be in while the system is in the
 527  * state represented by @target_state.  Store the integer numbers representing
 528  * those stats in the memory locations pointed to by @d_max_p and @d_min_p,
 529  * respectively.
 530  *
 531  * Callers must ensure that @dev and @adev are valid pointers and that @adev
 532  * actually corresponds to @dev before using this function.
 533  *
 534  * Returns 0 on success or -ENODATA when one of the ACPI methods fails or
 535  * returns a value that doesn't make sense.  The memory locations pointed to by
 536  * @d_max_p and @d_min_p are only modified on success.
 537  */
 538 static int acpi_dev_pm_get_state(struct device *dev, struct acpi_device *adev,
 539                                  u32 target_state, int *d_min_p, int *d_max_p)
 540 {
 541         char method[] = { '_', 'S', '0' + target_state, 'D', '\0' };
 542         acpi_handle handle = adev->handle;
 543         unsigned long long ret;
 544         int d_min, d_max;
 545         bool wakeup = false;
 546         bool has_sxd = false;
 547         acpi_status status;
 548
 549         /*
 550          * If the system state is S0, the lowest power state the device can be
 551          * in is D3cold, unless the device has _S0W and is supposed to signal
 552          * wakeup, in which case the return value of _S0W has to be used as the
 553          * lowest power state available to the device.
 554          */
 555         d_min = ACPI_STATE_D0;
 556         d_max = ACPI_STATE_D3_COLD;
 557
 558         /*
 559          * If present, _SxD methods return the minimum D-state (highest power
 560          * state) we can use for the corresponding S-states.  Otherwise, the
 561          * minimum D-state is D0 (ACPI 3.x).
 562          */
 563         if (target_state > ACPI_STATE_S0) {
 564                 /*
 565                  * We rely on acpi_evaluate_integer() not clobbering the integer
 566                  * provided if AE_NOT_FOUND is returned.
 567                  */
 568                 ret = d_min;
 569                 status = acpi_evaluate_integer(handle, method, NULL, &ret);
 570                 if ((ACPI_FAILURE(status) && status != AE_NOT_FOUND)
 571                     || ret > ACPI_STATE_D3_COLD)
 572                         return -ENODATA;
 573
 574                 /*
 575                  * We need to handle legacy systems where D3hot and D3cold are
 576                  * the same and 3 is returned in both cases, so fall back to
 577                  * D3cold if D3hot is not a valid state.
 578                  */
 579                 if (!adev->power.states[ret].flags.valid) {
 580                         if (ret == ACPI_STATE_D3_HOT)
 581                                 ret = ACPI_STATE_D3_COLD;
 582                         else
 583                                 return -ENODATA;
 584                 }
 585
 586                 if (status == AE_OK)
 587                         has_sxd = true;
 588
 589                 d_min = ret;
 590                 wakeup = device_may_wakeup(dev) && adev->wakeup.flags.valid
 591                         && adev->wakeup.sleep_state >= target_state;
 592         } else {
 593                 wakeup = adev->wakeup.flags.valid;
 594         }
 595
 596         /*
 597          * If _PRW says we can wake up the system from the target sleep state,
 598          * the D-state returned by _SxD is sufficient for that (we assume a
 599          * wakeup-aware driver if wake is set).  Still, if _SxW exists
 600          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
 601          * can wake the system.  _S0W may be valid, too.
 602          */
 603         if (wakeup) {
 604                 method[3] = 'W';
 605                 status = acpi_evaluate_integer(handle, method, NULL, &ret);
 606                 if (status == AE_NOT_FOUND) {
 607                         /* No _SxW. In this case, the ACPI spec says that we
 608                          * must not go into any power state deeper than the
 609                          * value returned from _SxD.
 610                          */
 611                         if (has_sxd && target_state > ACPI_STATE_S0)
 612                                 d_max = d_min;
 613                 } else if (ACPI_SUCCESS(status) && ret <= ACPI_STATE_D3_COLD) {
 614                         /* Fall back to D3cold if ret is not a valid state. */
 615                         if (!adev->power.states[ret].flags.valid)
 616                                 ret = ACPI_STATE_D3_COLD;
 617
 618                         d_max = ret > d_min ? ret : d_min;
 619                 } else {
 620                         return -ENODATA;
 621                 }
 622         }
 623
 624         if (d_min_p)
 625                 *d_min_p = d_min;
 626
 627         if (d_max_p)
 628                 *d_max_p = d_max;
 629
 630         return 0;
 631 }
 632
 633 /**
 634  * acpi_pm_device_sleep_state - Get preferred power state of ACPI device.
 635  * @dev: Device whose preferred target power state to return.
 636  * @d_min_p: Location to store the upper limit of the allowed states range.
 637  * @d_max_in: Deepest low-power state to take into consideration.
 638  * Return value: Preferred power state of the device on success, -ENODEV
 639  * if there's no 'struct acpi_device' for @dev, -EINVAL if @d_max_in is
 640  * incorrect, or -ENODATA on ACPI method failure.
 641  *
 642  * The caller must ensure that @dev is valid before using this function.
 643  */
 644 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p, int d_max_in)
 645 {
 646         struct acpi_device *adev;
 647         int ret, d_min, d_max;
 648
 649         if (d_max_in < ACPI_STATE_D0 || d_max_in > ACPI_STATE_D3_COLD)
 650                 return -EINVAL;
 651
 652         if (d_max_in > ACPI_STATE_D2) {
 653                 enum pm_qos_flags_status stat;
 654
 655                 stat = dev_pm_qos_flags(dev, PM_QOS_FLAG_NO_POWER_OFF);
 656                 if (stat == PM_QOS_FLAGS_ALL)
 657                         d_max_in = ACPI_STATE_D2;
 658         }
 659
 660         adev = ACPI_COMPANION(dev);
 661         if (!adev) {
 662                 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
 663                 return -ENODEV;
 664         }
 665
 666         ret = acpi_dev_pm_get_state(dev, adev, acpi_target_system_state(),
 667                                     &d_min, &d_max);
 668         if (ret)
 669                 return ret;
 670
 671         if (d_max_in < d_min)
 672                 return -EINVAL;
 673
 674         if (d_max > d_max_in) {
 675                 for (d_max = d_max_in; d_max > d_min; d_max--) {
 676                         if (adev->power.states[d_max].flags.valid)
 677                                 break;
 678                 }
 679         }
 680
 681         if (d_min_p)
 682                 *d_min_p = d_min;
 683
 684         return d_max;
 685 }
 686 EXPORT_SYMBOL(acpi_pm_device_sleep_state);
 687
 688 /**
 689  * acpi_pm_notify_work_func - ACPI devices wakeup notification work function.
 690  * @context: Device wakeup context.
 691  */
 692 static void acpi_pm_notify_work_func(struct acpi_device_wakeup_context *context)
 693 {
 694         struct device *dev = context->dev;
 695
 696         if (dev) {
 697                 pm_wakeup_event(dev, 0);
 698                 pm_request_resume(dev);
 699         }
 700 }
 701
 702 static DEFINE_MUTEX(acpi_wakeup_lock);
 703
 704 static int __acpi_device_wakeup_enable(struct acpi_device *adev,
 705                                        u32 target_state)
 706 {
 707         struct acpi_device_wakeup *wakeup = &adev->wakeup;
 708         acpi_status status;
 709         int error = 0;
 710
 711         mutex_lock(&acpi_wakeup_lock);
 712
 713         if (wakeup->enable_count >= INT_MAX) {
 714                 acpi_handle_info(adev->handle, "Wakeup enable count out of bounds!\n");
 715                 goto out;
 716         }
 717         if (wakeup->enable_count > 0)
 718                 goto inc;
 719
 720         error = acpi_enable_wakeup_device_power(adev, target_state);
 721         if (error)
 722                 goto out;
 723
 724         status = acpi_enable_gpe(wakeup->gpe_device, wakeup->gpe_number);
 725         if (ACPI_FAILURE(status)) {
 726                 acpi_disable_wakeup_device_power(adev);
 727                 error = -EIO;
 728                 goto out;
 729         }
 730
 731 inc:
 732         wakeup->enable_count++;
 733
 734 out:
 735         mutex_unlock(&acpi_wakeup_lock);
 736         return error;
 737 }
 738
 739 /**
 740  * acpi_device_wakeup_enable - Enable wakeup functionality for device.
 741  * @adev: ACPI device to enable wakeup functionality for.
 742  * @target_state: State the system is transitioning into.
 743  *
 744  * Enable the GPE associated with @adev so that it can generate wakeup signals
 745  * for the device in response to external (remote) events and enable wakeup
 746  * power for it.
 747  *
 748  * Callers must ensure that @adev is a valid ACPI device node before executing
 749  * this function.
 750  */
 751 static int acpi_device_wakeup_enable(struct acpi_device *adev, u32 target_state)
 752 {
 753         return __acpi_device_wakeup_enable(adev, target_state);
 754 }
 755
 756 /**
 757  * acpi_device_wakeup_disable - Disable wakeup functionality for device.
 758  * @adev: ACPI device to disable wakeup functionality for.
 759  *
 760  * Disable the GPE associated with @adev and disable wakeup power for it.
 761  *
 762  * Callers must ensure that @adev is a valid ACPI device node before executing
 763  * this function.
 764  */
 765 static void acpi_device_wakeup_disable(struct acpi_device *adev)
 766 {
 767         struct acpi_device_wakeup *wakeup = &adev->wakeup;
 768
 769         mutex_lock(&acpi_wakeup_lock);
 770
 771         if (!wakeup->enable_count)
 772                 goto out;
 773
 774         acpi_disable_gpe(wakeup->gpe_device, wakeup->gpe_number);
 775         acpi_disable_wakeup_device_power(adev);
 776
 777         wakeup->enable_count--;
 778
 779 out:
 780         mutex_unlock(&acpi_wakeup_lock);
 781 }
 782
 783 /**
 784  * acpi_pm_set_device_wakeup - Enable/disable remote wakeup for given device.
 785  * @dev: Device to enable/disable to generate wakeup events.
 786  * @enable: Whether to enable or disable the wakeup functionality.
 787  */
 788 int acpi_pm_set_device_wakeup(struct device *dev, bool enable)
 789 {
 790         struct acpi_device *adev;
 791         int error;
 792
 793         adev = ACPI_COMPANION(dev);
 794         if (!adev) {
 795                 dev_dbg(dev, "ACPI companion missing in %s!\n", __func__);
 796                 return -ENODEV;
 797         }
 798
 799         if (!acpi_device_can_wakeup(adev))
 800                 return -EINVAL;
 801
 802         if (!enable) {
 803                 acpi_device_wakeup_disable(adev);
 804                 dev_dbg(dev, "Wakeup disabled by ACPI\n");
 805                 return 0;
 806         }
 807
 808         error = __acpi_device_wakeup_enable(adev, acpi_target_system_state());
 809         if (!error)
 810                 dev_dbg(dev, "Wakeup enabled by ACPI\n");
 811
 812         return error;
 813 }
 814 EXPORT_SYMBOL_GPL(acpi_pm_set_device_wakeup);
 815
 816 /**
 817  * acpi_dev_pm_low_power - Put ACPI device into a low-power state.
 818  * @dev: Device to put into a low-power state.
 819  * @adev: ACPI device node corresponding to @dev.
 820  * @system_state: System state to choose the device state for.
 821  */
 822 static int acpi_dev_pm_low_power(struct device *dev, struct acpi_device *adev,
 823                                  u32 system_state)
 824 {
 825         int ret, state;
 826
 827         if (!acpi_device_power_manageable(adev))
 828                 return 0;
 829
 830         ret = acpi_dev_pm_get_state(dev, adev, system_state, NULL, &state);
 831         return ret ? ret : acpi_device_set_power(adev, state);
 832 }
 833
 834 /**
 835  * acpi_dev_pm_full_power - Put ACPI device into the full-power state.
 836  * @adev: ACPI device node to put into the full-power state.
 837  */
 838 static int acpi_dev_pm_full_power(struct acpi_device *adev)
 839 {
 840         return acpi_device_power_manageable(adev) ?
 841                 acpi_device_set_power(adev, ACPI_STATE_D0) : 0;
 842 }
 843
 844 /**
 845  * acpi_dev_suspend - Put device into a low-power state using ACPI.
 846  * @dev: Device to put into a low-power state.
 847  * @wakeup: Whether or not to enable wakeup for the device.
 848  *
 849  * Put the given device into a low-power state using the standard ACPI
 850  * mechanism.  Set up remote wakeup if desired, choose the state to put the
 851  * device into (this checks if remote wakeup is expected to work too), and set
 852  * the power state of the device.
 853  */
 854 int acpi_dev_suspend(struct device *dev, bool wakeup)
 855 {
 856         struct acpi_device *adev = ACPI_COMPANION(dev);
 857         u32 target_state = acpi_target_system_state();
 858         int error;
 859
 860         if (!adev)
 861                 return 0;
 862
 863         if (wakeup && acpi_device_can_wakeup(adev)) {
 864                 error = acpi_device_wakeup_enable(adev, target_state);
 865                 if (error)
 866                         return -EAGAIN;
 867         } else {
 868                 wakeup = false;
 869         }
 870
 871         error = acpi_dev_pm_low_power(dev, adev, target_state);
 872         if (error && wakeup)
 873                 acpi_device_wakeup_disable(adev);
 874
 875         return error;
 876 }
 877 EXPORT_SYMBOL_GPL(acpi_dev_suspend);
 878
 879 /**
 880  * acpi_dev_resume - Put device into the full-power state using ACPI.
 881  * @dev: Device to put into the full-power state.
 882  *
 883  * Put the given device into the full-power state using the standard ACPI
 884  * mechanism.  Set the power state of the device to ACPI D0 and disable wakeup.
 885  */
 886 int acpi_dev_resume(struct device *dev)
 887 {
 888         struct acpi_device *adev = ACPI_COMPANION(dev);
 889         int error;
 890
 891         if (!adev)
 892                 return 0;
 893
 894         error = acpi_dev_pm_full_power(adev);
 895         acpi_device_wakeup_disable(adev);
 896         return error;
 897 }
 898 EXPORT_SYMBOL_GPL(acpi_dev_resume);
 899
 900 /**
 901  * acpi_subsys_runtime_suspend - Suspend device using ACPI.
 902  * @dev: Device to suspend.
 903  *
 904  * Carry out the generic runtime suspend procedure for @dev and use ACPI to put
 905  * it into a runtime low-power state.
 906  */
 907 int acpi_subsys_runtime_suspend(struct device *dev)
 908 {
 909         int ret = pm_generic_runtime_suspend(dev);
 910         return ret ? ret : acpi_dev_suspend(dev, true);
 911 }
 912 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_suspend);
 913
 914 /**
 915  * acpi_subsys_runtime_resume - Resume device using ACPI.
 916  * @dev: Device to Resume.
 917  *
 918  * Use ACPI to put the given device into the full-power state and carry out the
 919  * generic runtime resume procedure for it.
 920  */
 921 int acpi_subsys_runtime_resume(struct device *dev)
 922 {
 923         int ret = acpi_dev_resume(dev);
 924         return ret ? ret : pm_generic_runtime_resume(dev);
 925 }
 926 EXPORT_SYMBOL_GPL(acpi_subsys_runtime_resume);
 927
 928 #ifdef CONFIG_PM_SLEEP
 929 static bool acpi_dev_needs_resume(struct device *dev, struct acpi_device *adev)
 930 {
 931         u32 sys_target = acpi_target_system_state();
 932         int ret, state;
 933
 934         if (!pm_runtime_suspended(dev) || !adev || (adev->wakeup.flags.valid &&
 935             device_may_wakeup(dev) != !!adev->wakeup.prepare_count))
 936                 return true;
 937
 938         if (sys_target == ACPI_STATE_S0)
 939                 return false;
 940
 941         if (adev->power.flags.dsw_present)
 942                 return true;
 943
 944         ret = acpi_dev_pm_get_state(dev, adev, sys_target, NULL, &state);
 945         if (ret)
 946                 return true;
 947
 948         return state != adev->power.state;
 949 }
 950
 951 /**
 952  * acpi_subsys_prepare - Prepare device for system transition to a sleep state.
 953  * @dev: Device to prepare.
 954  */
 955 int acpi_subsys_prepare(struct device *dev)
 956 {
 957         struct acpi_device *adev = ACPI_COMPANION(dev);
 958
 959         if (dev->driver && dev->driver->pm && dev->driver->pm->prepare) {
 960                 int ret = dev->driver->pm->prepare(dev);
 961
 962                 if (ret < 0)
 963                         return ret;
 964
 965                 if (!ret && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
 966                         return 0;
 967         }
 968
 969         return !acpi_dev_needs_resume(dev, adev);
 970 }
 971 EXPORT_SYMBOL_GPL(acpi_subsys_prepare);
 972
 973 /**
 974  * acpi_subsys_complete - Finalize device's resume during system resume.
 975  * @dev: Device to handle.
 976  */
 977 void acpi_subsys_complete(struct device *dev)
 978 {
 979         pm_generic_complete(dev);
 980         /*
 981          * If the device had been runtime-suspended before the system went into
 982          * the sleep state it is going out of and it has never been resumed till
 983          * now, resume it in case the firmware powered it up.
 984          */
 985         if (pm_runtime_suspended(dev) && pm_resume_via_firmware())
 986                 pm_request_resume(dev);
 987 }
 988 EXPORT_SYMBOL_GPL(acpi_subsys_complete);
 989
 990 /**
 991  * acpi_subsys_suspend - Run the device driver's suspend callback.
 992  * @dev: Device to handle.
 993  *
 994  * Follow PCI and resume devices from runtime suspend before running their
 995  * system suspend callbacks, unless the driver can cope with runtime-suspended
 996  * devices during system suspend and there are no ACPI-specific reasons for
 997  * resuming them.
 998  */
 999 int acpi_subsys_suspend(struct device *dev)
1000 {
1001         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1002             acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1003                 pm_runtime_resume(dev);
1004
1005         return pm_generic_suspend(dev);
1006 }
1007 EXPORT_SYMBOL_GPL(acpi_subsys_suspend);
1008
1009 /**
1010  * acpi_subsys_suspend_late - Suspend device using ACPI.
1011  * @dev: Device to suspend.
1012  *
1013  * Carry out the generic late suspend procedure for @dev and use ACPI to put
1014  * it into a low-power state during system transition into a sleep state.
1015  */
1016 int acpi_subsys_suspend_late(struct device *dev)
1017 {
1018         int ret;
1019
1020         if (dev_pm_smart_suspend_and_suspended(dev))
1021                 return 0;
1022
1023         ret = pm_generic_suspend_late(dev);
1024         return ret ? ret : acpi_dev_suspend(dev, device_may_wakeup(dev));
1025 }
1026 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_late);
1027
1028 /**
1029  * acpi_subsys_suspend_noirq - Run the device driver's "noirq" suspend callback.
1030  * @dev: Device to suspend.
1031  */
1032 int acpi_subsys_suspend_noirq(struct device *dev)
1033 {
1034         int ret;
1035
1036         if (dev_pm_smart_suspend_and_suspended(dev)) {
1037                 dev->power.may_skip_resume = true;
1038                 return 0;
1039         }
1040
1041         ret = pm_generic_suspend_noirq(dev);
1042         if (ret)
1043                 return ret;
1044
1045         /*
1046          * If the target system sleep state is suspend-to-idle, it is sufficient
1047          * to check whether or not the device's wakeup settings are good for
1048          * runtime PM.  Otherwise, the pm_resume_via_firmware() check will cause
1049          * acpi_subsys_complete() to take care of fixing up the device's state
1050          * anyway, if need be.
1051          */
1052         dev->power.may_skip_resume = device_may_wakeup(dev) ||
1053                                         !device_can_wakeup(dev);
1054
1055         return 0;
1056 }
1057 EXPORT_SYMBOL_GPL(acpi_subsys_suspend_noirq);
1058
1059 /**
1060  * acpi_subsys_resume_noirq - Run the device driver's "noirq" resume callback.
1061  * @dev: Device to handle.
1062  */
1063 static int acpi_subsys_resume_noirq(struct device *dev)
1064 {
1065         if (dev_pm_may_skip_resume(dev))
1066                 return 0;
1067
1068         /*
1069          * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
1070          * during system suspend, so update their runtime PM status to "active"
1071          * as they will be put into D0 going forward.
1072          */
1073         if (dev_pm_smart_suspend_and_suspended(dev))
1074                 pm_runtime_set_active(dev);
1075
1076         return pm_generic_resume_noirq(dev);
1077 }
1078
1079 /**
1080  * acpi_subsys_resume_early - Resume device using ACPI.
1081  * @dev: Device to Resume.
1082  *
1083  * Use ACPI to put the given device into the full-power state and carry out the
1084  * generic early resume procedure for it during system transition into the
1085  * working state.
1086  */
1087 static int acpi_subsys_resume_early(struct device *dev)
1088 {
1089         int ret = acpi_dev_resume(dev);
1090         return ret ? ret : pm_generic_resume_early(dev);
1091 }
1092
1093 /**
1094  * acpi_subsys_freeze - Run the device driver's freeze callback.
1095  * @dev: Device to handle.
1096  */
1097 int acpi_subsys_freeze(struct device *dev)
1098 {
1099         /*
1100          * Resume all runtime-suspended devices before creating a snapshot
1101          * image of system memory, because the restore kernel generally cannot
1102          * be expected to always handle them consistently and they need to be
1103          * put into the runtime-active metastate during system resume anyway,
1104          * so it is better to ensure that the state saved in the image will be
1105          * always consistent with that.
1106          */
1107         pm_runtime_resume(dev);
1108
1109         return pm_generic_freeze(dev);
1110 }
1111 EXPORT_SYMBOL_GPL(acpi_subsys_freeze);
1112
1113 /**
1114  * acpi_subsys_restore_early - Restore device using ACPI.
1115  * @dev: Device to restore.
1116  */
1117 int acpi_subsys_restore_early(struct device *dev)
1118 {
1119         int ret = acpi_dev_resume(dev);
1120         return ret ? ret : pm_generic_restore_early(dev);
1121 }
1122 EXPORT_SYMBOL_GPL(acpi_subsys_restore_early);
1123
1124 /**
1125  * acpi_subsys_poweroff - Run the device driver's poweroff callback.
1126  * @dev: Device to handle.
1127  *
1128  * Follow PCI and resume devices from runtime suspend before running their
1129  * system poweroff callbacks, unless the driver can cope with runtime-suspended
1130  * devices during system suspend and there are no ACPI-specific reasons for
1131  * resuming them.
1132  */
1133 int acpi_subsys_poweroff(struct device *dev)
1134 {
1135         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1136             acpi_dev_needs_resume(dev, ACPI_COMPANION(dev)))
1137                 pm_runtime_resume(dev);
1138
1139         return pm_generic_poweroff(dev);
1140 }
1141 EXPORT_SYMBOL_GPL(acpi_subsys_poweroff);
1142
1143 /**
1144  * acpi_subsys_poweroff_late - Run the device driver's poweroff callback.
1145  * @dev: Device to handle.
1146  *
1147  * Carry out the generic late poweroff procedure for @dev and use ACPI to put
1148  * it into a low-power state during system transition into a sleep state.
1149  */
1150 static int acpi_subsys_poweroff_late(struct device *dev)
1151 {
1152         int ret;
1153
1154         if (dev_pm_smart_suspend_and_suspended(dev))
1155                 return 0;
1156
1157         ret = pm_generic_poweroff_late(dev);
1158         if (ret)
1159                 return ret;
1160
1161         return acpi_dev_suspend(dev, device_may_wakeup(dev));
1162 }
1163
1164 /**
1165  * acpi_subsys_poweroff_noirq - Run the driver's "noirq" poweroff callback.
1166  * @dev: Device to suspend.
1167  */
1168 static int acpi_subsys_poweroff_noirq(struct device *dev)
1169 {
1170         if (dev_pm_smart_suspend_and_suspended(dev))
1171                 return 0;
1172
1173         return pm_generic_poweroff_noirq(dev);
1174 }
1175 #endif /* CONFIG_PM_SLEEP */
1176
1177 static struct dev_pm_domain acpi_general_pm_domain = {
1178         .ops = {
1179                 .runtime_suspend = acpi_subsys_runtime_suspend,
1180                 .runtime_resume = acpi_subsys_runtime_resume,
1181 #ifdef CONFIG_PM_SLEEP
1182                 .prepare = acpi_subsys_prepare,
1183                 .complete = acpi_subsys_complete,
1184                 .suspend = acpi_subsys_suspend,
1185                 .suspend_late = acpi_subsys_suspend_late,
1186                 .suspend_noirq = acpi_subsys_suspend_noirq,
1187                 .resume_noirq = acpi_subsys_resume_noirq,
1188                 .resume_early = acpi_subsys_resume_early,
1189                 .freeze = acpi_subsys_freeze,
1190                 .poweroff = acpi_subsys_poweroff,
1191                 .poweroff_late = acpi_subsys_poweroff_late,
1192                 .poweroff_noirq = acpi_subsys_poweroff_noirq,
1193                 .restore_early = acpi_subsys_restore_early,
1194 #endif
1195         },
1196 };
1197
1198 /**
1199  * acpi_dev_pm_detach - Remove ACPI power management from the device.
1200  * @dev: Device to take care of.
1201  * @power_off: Whether or not to try to remove power from the device.
1202  *
1203  * Remove the device from the general ACPI PM domain and remove its wakeup
1204  * notifier.  If @power_off is set, additionally remove power from the device if
1205  * possible.
1206  *
1207  * Callers must ensure proper synchronization of this function with power
1208  * management callbacks.
1209  */
1210 static void acpi_dev_pm_detach(struct device *dev, bool power_off)
1211 {
1212         struct acpi_device *adev = ACPI_COMPANION(dev);
1213
1214         if (adev && dev->pm_domain == &acpi_general_pm_domain) {
1215                 dev_pm_domain_set(dev, NULL);
1216                 acpi_remove_pm_notifier(adev);
1217                 if (power_off) {
1218                         /*
1219                          * If the device's PM QoS resume latency limit or flags
1220                          * have been exposed to user space, they have to be
1221                          * hidden at this point, so that they don't affect the
1222                          * choice of the low-power state to put the device into.
1223                          */
1224                         dev_pm_qos_hide_latency_limit(dev);
1225                         dev_pm_qos_hide_flags(dev);
1226                         acpi_device_wakeup_disable(adev);
1227                         acpi_dev_pm_low_power(dev, adev, ACPI_STATE_S0);
1228                 }
1229         }
1230 }
1231
1232 /**
1233  * acpi_dev_pm_attach - Prepare device for ACPI power management.
1234  * @dev: Device to prepare.
1235  * @power_on: Whether or not to power on the device.
1236  *
1237  * If @dev has a valid ACPI handle that has a valid struct acpi_device object
1238  * attached to it, install a wakeup notification handler for the device and
1239  * add it to the general ACPI PM domain.  If @power_on is set, the device will
1240  * be put into the ACPI D0 state before the function returns.
1241  *
1242  * This assumes that the @dev's bus type uses generic power management callbacks
1243  * (or doesn't use any power management callbacks at all).
1244  *
1245  * Callers must ensure proper synchronization of this function with power
1246  * management callbacks.
1247  */
1248 int acpi_dev_pm_attach(struct device *dev, bool power_on)
1249 {
1250         /*
1251          * Skip devices whose ACPI companions match the device IDs below,
1252          * because they require special power management handling incompatible
1253          * with the generic ACPI PM domain.
1254          */
1255         static const struct acpi_device_id special_pm_ids[] = {
1256                 {"PNP0C0B", }, /* Generic ACPI fan */
1257                 {"INT3404", }, /* Fan */
1258                 {}
1259         };
1260         struct acpi_device *adev = ACPI_COMPANION(dev);
1261
1262         if (!adev || !acpi_match_device_ids(adev, special_pm_ids))
1263                 return 0;
1264
1265         /*
1266          * Only attach the power domain to the first device if the
1267          * companion is shared by multiple. This is to prevent doing power
1268          * management twice.
1269          */
1270         if (!acpi_device_is_first_physical_node(adev, dev))
1271                 return 0;
1272
1273         acpi_add_pm_notifier(adev, dev, acpi_pm_notify_work_func);
1274         dev_pm_domain_set(dev, &acpi_general_pm_domain);
1275         if (power_on) {
1276                 acpi_dev_pm_full_power(adev);
1277                 acpi_device_wakeup_disable(adev);
1278         }
1279
1280         dev->pm_domain->detach = acpi_dev_pm_detach;
1281         return 1;
1282 }
1283 EXPORT_SYMBOL_GPL(acpi_dev_pm_attach);
1284 #endif /* CONFIG_PM */