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