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