drivers/acpi/device_pm.c

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