Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * drivers/acpi/power.c - ACPI Power Resources management.
4 *
5 * Copyright (C) 2001 - 2015 Intel Corp.
6 * Author: Andy Grover <andrew.grover@intel.com>
7 * Author: Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
9 */
10
11/*
12 * ACPI power-managed devices may be controlled in two ways:
13 * 1. via "Device Specific (D-State) Control"
14 * 2. via "Power Resource Control".
15 * The code below deals with ACPI Power Resources control.
16 *
17 * An ACPI "power resource object" represents a software controllable power
18 * plane, clock plane, or other resource depended on by a device.
19 *
20 * A device may rely on multiple power resources, and a power resource
21 * may be shared by multiple devices.
22 */
23
24#define pr_fmt(fmt) "ACPI: PM: " fmt
25
26#include <linux/dmi.h>
27#include <linux/kernel.h>
28#include <linux/module.h>
29#include <linux/init.h>
30#include <linux/types.h>
31#include <linux/slab.h>
32#include <linux/pm_runtime.h>
33#include <linux/sysfs.h>
34#include <linux/acpi.h>
35#include "sleep.h"
36#include "internal.h"
37
38#define ACPI_POWER_CLASS "power_resource"
39#define ACPI_POWER_DEVICE_NAME "Power Resource"
40#define ACPI_POWER_RESOURCE_STATE_OFF 0x00
41#define ACPI_POWER_RESOURCE_STATE_ON 0x01
42#define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
43
44struct acpi_power_dependent_device {
45 struct device *dev;
46 struct list_head node;
47};
48
49struct acpi_power_resource {
50 struct acpi_device device;
51 struct list_head list_node;
52 u32 system_level;
53 u32 order;
54 unsigned int ref_count;
55 u8 state;
56 struct mutex resource_lock;
57 struct list_head dependents;
58};
59
60struct acpi_power_resource_entry {
61 struct list_head node;
62 struct acpi_power_resource *resource;
63};
64
65static LIST_HEAD(acpi_power_resource_list);
66static DEFINE_MUTEX(power_resource_list_lock);
67
68/* --------------------------------------------------------------------------
69 Power Resource Management
70 -------------------------------------------------------------------------- */
71
72static inline const char *resource_dev_name(struct acpi_power_resource *pr)
73{
74 return dev_name(&pr->device.dev);
75}
76
77static inline
78struct acpi_power_resource *to_power_resource(struct acpi_device *device)
79{
80 return container_of(device, struct acpi_power_resource, device);
81}
82
83static struct acpi_power_resource *acpi_power_get_context(acpi_handle handle)
84{
85 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
86
87 if (!device)
88 return NULL;
89
90 return to_power_resource(device);
91}
92
93static int acpi_power_resources_list_add(acpi_handle handle,
94 struct list_head *list)
95{
96 struct acpi_power_resource *resource = acpi_power_get_context(handle);
97 struct acpi_power_resource_entry *entry;
98
99 if (!resource || !list)
100 return -EINVAL;
101
102 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
103 if (!entry)
104 return -ENOMEM;
105
106 entry->resource = resource;
107 if (!list_empty(list)) {
108 struct acpi_power_resource_entry *e;
109
110 list_for_each_entry(e, list, node)
111 if (e->resource->order > resource->order) {
112 list_add_tail(&entry->node, &e->node);
113 return 0;
114 }
115 }
116 list_add_tail(&entry->node, list);
117 return 0;
118}
119
120void acpi_power_resources_list_free(struct list_head *list)
121{
122 struct acpi_power_resource_entry *entry, *e;
123
124 list_for_each_entry_safe(entry, e, list, node) {
125 list_del(&entry->node);
126 kfree(entry);
127 }
128}
129
130static bool acpi_power_resource_is_dup(union acpi_object *package,
131 unsigned int start, unsigned int i)
132{
133 acpi_handle rhandle, dup;
134 unsigned int j;
135
136 /* The caller is expected to check the package element types */
137 rhandle = package->package.elements[i].reference.handle;
138 for (j = start; j < i; j++) {
139 dup = package->package.elements[j].reference.handle;
140 if (dup == rhandle)
141 return true;
142 }
143
144 return false;
145}
146
147int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
148 struct list_head *list)
149{
150 unsigned int i;
151 int err = 0;
152
153 for (i = start; i < package->package.count; i++) {
154 union acpi_object *element = &package->package.elements[i];
155 struct acpi_device *rdev;
156 acpi_handle rhandle;
157
158 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
159 err = -ENODATA;
160 break;
161 }
162 rhandle = element->reference.handle;
163 if (!rhandle) {
164 err = -ENODEV;
165 break;
166 }
167
168 /* Some ACPI tables contain duplicate power resource references */
169 if (acpi_power_resource_is_dup(package, start, i))
170 continue;
171
172 rdev = acpi_add_power_resource(rhandle);
173 if (!rdev) {
174 err = -ENODEV;
175 break;
176 }
177 err = acpi_power_resources_list_add(rhandle, list);
178 if (err)
179 break;
180 }
181 if (err)
182 acpi_power_resources_list_free(list);
183
184 return err;
185}
186
187static int __get_state(acpi_handle handle, u8 *state)
188{
189 acpi_status status = AE_OK;
190 unsigned long long sta = 0;
191 u8 cur_state;
192
193 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
194 if (ACPI_FAILURE(status))
195 return -ENODEV;
196
197 cur_state = sta & ACPI_POWER_RESOURCE_STATE_ON;
198
199 acpi_handle_debug(handle, "Power resource is %s\n",
200 cur_state ? "on" : "off");
201
202 *state = cur_state;
203 return 0;
204}
205
206static int acpi_power_get_state(struct acpi_power_resource *resource, u8 *state)
207{
208 if (resource->state == ACPI_POWER_RESOURCE_STATE_UNKNOWN) {
209 int ret;
210
211 ret = __get_state(resource->device.handle, &resource->state);
212 if (ret)
213 return ret;
214 }
215
216 *state = resource->state;
217 return 0;
218}
219
220static int acpi_power_get_list_state(struct list_head *list, u8 *state)
221{
222 struct acpi_power_resource_entry *entry;
223 u8 cur_state = ACPI_POWER_RESOURCE_STATE_OFF;
224
225 if (!list || !state)
226 return -EINVAL;
227
228 /* The state of the list is 'on' IFF all resources are 'on'. */
229 list_for_each_entry(entry, list, node) {
230 struct acpi_power_resource *resource = entry->resource;
231 int result;
232
233 mutex_lock(&resource->resource_lock);
234 result = acpi_power_get_state(resource, &cur_state);
235 mutex_unlock(&resource->resource_lock);
236 if (result)
237 return result;
238
239 if (cur_state != ACPI_POWER_RESOURCE_STATE_ON)
240 break;
241 }
242
243 pr_debug("Power resource list is %s\n", cur_state ? "on" : "off");
244
245 *state = cur_state;
246 return 0;
247}
248
249static int
250acpi_power_resource_add_dependent(struct acpi_power_resource *resource,
251 struct device *dev)
252{
253 struct acpi_power_dependent_device *dep;
254 int ret = 0;
255
256 mutex_lock(&resource->resource_lock);
257 list_for_each_entry(dep, &resource->dependents, node) {
258 /* Only add it once */
259 if (dep->dev == dev)
260 goto unlock;
261 }
262
263 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
264 if (!dep) {
265 ret = -ENOMEM;
266 goto unlock;
267 }
268
269 dep->dev = dev;
270 list_add_tail(&dep->node, &resource->dependents);
271 dev_dbg(dev, "added power dependency to [%s]\n",
272 resource_dev_name(resource));
273
274unlock:
275 mutex_unlock(&resource->resource_lock);
276 return ret;
277}
278
279static void
280acpi_power_resource_remove_dependent(struct acpi_power_resource *resource,
281 struct device *dev)
282{
283 struct acpi_power_dependent_device *dep;
284
285 mutex_lock(&resource->resource_lock);
286 list_for_each_entry(dep, &resource->dependents, node) {
287 if (dep->dev == dev) {
288 list_del(&dep->node);
289 kfree(dep);
290 dev_dbg(dev, "removed power dependency to [%s]\n",
291 resource_dev_name(resource));
292 break;
293 }
294 }
295 mutex_unlock(&resource->resource_lock);
296}
297
298/**
299 * acpi_device_power_add_dependent - Add dependent device of this ACPI device
300 * @adev: ACPI device pointer
301 * @dev: Dependent device
302 *
303 * If @adev has non-empty _PR0 the @dev is added as dependent device to all
304 * power resources returned by it. This means that whenever these power
305 * resources are turned _ON the dependent devices get runtime resumed. This
306 * is needed for devices such as PCI to allow its driver to re-initialize
307 * it after it went to D0uninitialized.
308 *
309 * If @adev does not have _PR0 this does nothing.
310 *
311 * Returns %0 in case of success and negative errno otherwise.
312 */
313int acpi_device_power_add_dependent(struct acpi_device *adev,
314 struct device *dev)
315{
316 struct acpi_power_resource_entry *entry;
317 struct list_head *resources;
318 int ret;
319
320 if (!adev->flags.power_manageable)
321 return 0;
322
323 resources = &adev->power.states[ACPI_STATE_D0].resources;
324 list_for_each_entry(entry, resources, node) {
325 ret = acpi_power_resource_add_dependent(entry->resource, dev);
326 if (ret)
327 goto err;
328 }
329
330 return 0;
331
332err:
333 list_for_each_entry(entry, resources, node)
334 acpi_power_resource_remove_dependent(entry->resource, dev);
335
336 return ret;
337}
338
339/**
340 * acpi_device_power_remove_dependent - Remove dependent device
341 * @adev: ACPI device pointer
342 * @dev: Dependent device
343 *
344 * Does the opposite of acpi_device_power_add_dependent() and removes the
345 * dependent device if it is found. Can be called to @adev that does not
346 * have _PR0 as well.
347 */
348void acpi_device_power_remove_dependent(struct acpi_device *adev,
349 struct device *dev)
350{
351 struct acpi_power_resource_entry *entry;
352 struct list_head *resources;
353
354 if (!adev->flags.power_manageable)
355 return;
356
357 resources = &adev->power.states[ACPI_STATE_D0].resources;
358 list_for_each_entry_reverse(entry, resources, node)
359 acpi_power_resource_remove_dependent(entry->resource, dev);
360}
361
362static int __acpi_power_on(struct acpi_power_resource *resource)
363{
364 acpi_handle handle = resource->device.handle;
365 struct acpi_power_dependent_device *dep;
366 acpi_status status = AE_OK;
367
368 status = acpi_evaluate_object(handle, "_ON", NULL, NULL);
369 if (ACPI_FAILURE(status)) {
370 resource->state = ACPI_POWER_RESOURCE_STATE_UNKNOWN;
371 return -ENODEV;
372 }
373
374 resource->state = ACPI_POWER_RESOURCE_STATE_ON;
375
376 acpi_handle_debug(handle, "Power resource turned on\n");
377
378 /*
379 * If there are other dependents on this power resource we need to
380 * resume them now so that their drivers can re-initialize the
381 * hardware properly after it went back to D0.
382 */
383 if (list_empty(&resource->dependents) ||
384 list_is_singular(&resource->dependents))
385 return 0;
386
387 list_for_each_entry(dep, &resource->dependents, node) {
388 dev_dbg(dep->dev, "runtime resuming because [%s] turned on\n",
389 resource_dev_name(resource));
390 pm_request_resume(dep->dev);
391 }
392
393 return 0;
394}
395
396static int acpi_power_on_unlocked(struct acpi_power_resource *resource)
397{
398 int result = 0;
399
400 if (resource->ref_count++) {
401 acpi_handle_debug(resource->device.handle,
402 "Power resource already on\n");
403 } else {
404 result = __acpi_power_on(resource);
405 if (result)
406 resource->ref_count--;
407 }
408 return result;
409}
410
411static int acpi_power_on(struct acpi_power_resource *resource)
412{
413 int result;
414
415 mutex_lock(&resource->resource_lock);
416 result = acpi_power_on_unlocked(resource);
417 mutex_unlock(&resource->resource_lock);
418 return result;
419}
420
421static int __acpi_power_off(struct acpi_power_resource *resource)
422{
423 acpi_handle handle = resource->device.handle;
424 acpi_status status;
425
426 status = acpi_evaluate_object(handle, "_OFF", NULL, NULL);
427 if (ACPI_FAILURE(status)) {
428 resource->state = ACPI_POWER_RESOURCE_STATE_UNKNOWN;
429 return -ENODEV;
430 }
431
432 resource->state = ACPI_POWER_RESOURCE_STATE_OFF;
433
434 acpi_handle_debug(handle, "Power resource turned off\n");
435
436 return 0;
437}
438
439static int acpi_power_off_unlocked(struct acpi_power_resource *resource)
440{
441 int result = 0;
442
443 if (!resource->ref_count) {
444 acpi_handle_debug(resource->device.handle,
445 "Power resource already off\n");
446 return 0;
447 }
448
449 if (--resource->ref_count) {
450 acpi_handle_debug(resource->device.handle,
451 "Power resource still in use\n");
452 } else {
453 result = __acpi_power_off(resource);
454 if (result)
455 resource->ref_count++;
456 }
457 return result;
458}
459
460static int acpi_power_off(struct acpi_power_resource *resource)
461{
462 int result;
463
464 mutex_lock(&resource->resource_lock);
465 result = acpi_power_off_unlocked(resource);
466 mutex_unlock(&resource->resource_lock);
467 return result;
468}
469
470static int acpi_power_off_list(struct list_head *list)
471{
472 struct acpi_power_resource_entry *entry;
473 int result = 0;
474
475 list_for_each_entry_reverse(entry, list, node) {
476 result = acpi_power_off(entry->resource);
477 if (result)
478 goto err;
479 }
480 return 0;
481
482 err:
483 list_for_each_entry_continue(entry, list, node)
484 acpi_power_on(entry->resource);
485
486 return result;
487}
488
489static int acpi_power_on_list(struct list_head *list)
490{
491 struct acpi_power_resource_entry *entry;
492 int result = 0;
493
494 list_for_each_entry(entry, list, node) {
495 result = acpi_power_on(entry->resource);
496 if (result)
497 goto err;
498 }
499 return 0;
500
501 err:
502 list_for_each_entry_continue_reverse(entry, list, node)
503 acpi_power_off(entry->resource);
504
505 return result;
506}
507
508static struct attribute *attrs[] = {
509 NULL,
510};
511
512static const struct attribute_group attr_groups[] = {
513 [ACPI_STATE_D0] = {
514 .name = "power_resources_D0",
515 .attrs = attrs,
516 },
517 [ACPI_STATE_D1] = {
518 .name = "power_resources_D1",
519 .attrs = attrs,
520 },
521 [ACPI_STATE_D2] = {
522 .name = "power_resources_D2",
523 .attrs = attrs,
524 },
525 [ACPI_STATE_D3_HOT] = {
526 .name = "power_resources_D3hot",
527 .attrs = attrs,
528 },
529};
530
531static const struct attribute_group wakeup_attr_group = {
532 .name = "power_resources_wakeup",
533 .attrs = attrs,
534};
535
536static void acpi_power_hide_list(struct acpi_device *adev,
537 struct list_head *resources,
538 const struct attribute_group *attr_group)
539{
540 struct acpi_power_resource_entry *entry;
541
542 if (list_empty(resources))
543 return;
544
545 list_for_each_entry_reverse(entry, resources, node) {
546 struct acpi_device *res_dev = &entry->resource->device;
547
548 sysfs_remove_link_from_group(&adev->dev.kobj,
549 attr_group->name,
550 dev_name(&res_dev->dev));
551 }
552 sysfs_remove_group(&adev->dev.kobj, attr_group);
553}
554
555static void acpi_power_expose_list(struct acpi_device *adev,
556 struct list_head *resources,
557 const struct attribute_group *attr_group)
558{
559 struct acpi_power_resource_entry *entry;
560 int ret;
561
562 if (list_empty(resources))
563 return;
564
565 ret = sysfs_create_group(&adev->dev.kobj, attr_group);
566 if (ret)
567 return;
568
569 list_for_each_entry(entry, resources, node) {
570 struct acpi_device *res_dev = &entry->resource->device;
571
572 ret = sysfs_add_link_to_group(&adev->dev.kobj,
573 attr_group->name,
574 &res_dev->dev.kobj,
575 dev_name(&res_dev->dev));
576 if (ret) {
577 acpi_power_hide_list(adev, resources, attr_group);
578 break;
579 }
580 }
581}
582
583static void acpi_power_expose_hide(struct acpi_device *adev,
584 struct list_head *resources,
585 const struct attribute_group *attr_group,
586 bool expose)
587{
588 if (expose)
589 acpi_power_expose_list(adev, resources, attr_group);
590 else
591 acpi_power_hide_list(adev, resources, attr_group);
592}
593
594void acpi_power_add_remove_device(struct acpi_device *adev, bool add)
595{
596 int state;
597
598 if (adev->wakeup.flags.valid)
599 acpi_power_expose_hide(adev, &adev->wakeup.resources,
600 &wakeup_attr_group, add);
601
602 if (!adev->power.flags.power_resources)
603 return;
604
605 for (state = ACPI_STATE_D0; state <= ACPI_STATE_D3_HOT; state++)
606 acpi_power_expose_hide(adev,
607 &adev->power.states[state].resources,
608 &attr_groups[state], add);
609}
610
611int acpi_power_wakeup_list_init(struct list_head *list, int *system_level_p)
612{
613 struct acpi_power_resource_entry *entry;
614 int system_level = 5;
615
616 list_for_each_entry(entry, list, node) {
617 struct acpi_power_resource *resource = entry->resource;
618 u8 state;
619
620 mutex_lock(&resource->resource_lock);
621
622 /*
623 * Make sure that the power resource state and its reference
624 * counter value are consistent with each other.
625 */
626 if (!resource->ref_count &&
627 !acpi_power_get_state(resource, &state) &&
628 state == ACPI_POWER_RESOURCE_STATE_ON)
629 __acpi_power_off(resource);
630
631 if (system_level > resource->system_level)
632 system_level = resource->system_level;
633
634 mutex_unlock(&resource->resource_lock);
635 }
636 *system_level_p = system_level;
637 return 0;
638}
639
640/* --------------------------------------------------------------------------
641 Device Power Management
642 -------------------------------------------------------------------------- */
643
644/**
645 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
646 * ACPI 3.0) _PSW (Power State Wake)
647 * @dev: Device to handle.
648 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
649 * @sleep_state: Target sleep state of the system.
650 * @dev_state: Target power state of the device.
651 *
652 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
653 * State Wake) for the device, if present. On failure reset the device's
654 * wakeup.flags.valid flag.
655 *
656 * RETURN VALUE:
657 * 0 if either _DSW or _PSW has been successfully executed
658 * 0 if neither _DSW nor _PSW has been found
659 * -ENODEV if the execution of either _DSW or _PSW has failed
660 */
661int acpi_device_sleep_wake(struct acpi_device *dev,
662 int enable, int sleep_state, int dev_state)
663{
664 union acpi_object in_arg[3];
665 struct acpi_object_list arg_list = { 3, in_arg };
666 acpi_status status = AE_OK;
667
668 /*
669 * Try to execute _DSW first.
670 *
671 * Three arguments are needed for the _DSW object:
672 * Argument 0: enable/disable the wake capabilities
673 * Argument 1: target system state
674 * Argument 2: target device state
675 * When _DSW object is called to disable the wake capabilities, maybe
676 * the first argument is filled. The values of the other two arguments
677 * are meaningless.
678 */
679 in_arg[0].type = ACPI_TYPE_INTEGER;
680 in_arg[0].integer.value = enable;
681 in_arg[1].type = ACPI_TYPE_INTEGER;
682 in_arg[1].integer.value = sleep_state;
683 in_arg[2].type = ACPI_TYPE_INTEGER;
684 in_arg[2].integer.value = dev_state;
685 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
686 if (ACPI_SUCCESS(status)) {
687 return 0;
688 } else if (status != AE_NOT_FOUND) {
689 acpi_handle_info(dev->handle, "_DSW execution failed\n");
690 dev->wakeup.flags.valid = 0;
691 return -ENODEV;
692 }
693
694 /* Execute _PSW */
695 status = acpi_execute_simple_method(dev->handle, "_PSW", enable);
696 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
697 acpi_handle_info(dev->handle, "_PSW execution failed\n");
698 dev->wakeup.flags.valid = 0;
699 return -ENODEV;
700 }
701
702 return 0;
703}
704
705/*
706 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
707 * 1. Power on the power resources required for the wakeup device
708 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
709 * State Wake) for the device, if present
710 */
711int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
712{
713 int err = 0;
714
715 if (!dev || !dev->wakeup.flags.valid)
716 return -EINVAL;
717
718 mutex_lock(&acpi_device_lock);
719
720 dev_dbg(&dev->dev, "Enabling wakeup power (count %d)\n",
721 dev->wakeup.prepare_count);
722
723 if (dev->wakeup.prepare_count++)
724 goto out;
725
726 err = acpi_power_on_list(&dev->wakeup.resources);
727 if (err) {
728 dev_err(&dev->dev, "Cannot turn on wakeup power resources\n");
729 dev->wakeup.flags.valid = 0;
730 goto out;
731 }
732
733 /*
734 * Passing 3 as the third argument below means the device may be
735 * put into arbitrary power state afterward.
736 */
737 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
738 if (err) {
739 acpi_power_off_list(&dev->wakeup.resources);
740 dev->wakeup.prepare_count = 0;
741 goto out;
742 }
743
744 dev_dbg(&dev->dev, "Wakeup power enabled\n");
745
746 out:
747 mutex_unlock(&acpi_device_lock);
748 return err;
749}
750
751/*
752 * Shutdown a wakeup device, counterpart of above method
753 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
754 * State Wake) for the device, if present
755 * 2. Shutdown down the power resources
756 */
757int acpi_disable_wakeup_device_power(struct acpi_device *dev)
758{
759 struct acpi_power_resource_entry *entry;
760 int err = 0;
761
762 if (!dev || !dev->wakeup.flags.valid)
763 return -EINVAL;
764
765 mutex_lock(&acpi_device_lock);
766
767 dev_dbg(&dev->dev, "Disabling wakeup power (count %d)\n",
768 dev->wakeup.prepare_count);
769
770 /* Do nothing if wakeup power has not been enabled for this device. */
771 if (dev->wakeup.prepare_count <= 0)
772 goto out;
773
774 if (--dev->wakeup.prepare_count > 0)
775 goto out;
776
777 err = acpi_device_sleep_wake(dev, 0, 0, 0);
778 if (err)
779 goto out;
780
781 /*
782 * All of the power resources in the list need to be turned off even if
783 * there are errors.
784 */
785 list_for_each_entry(entry, &dev->wakeup.resources, node) {
786 int ret;
787
788 ret = acpi_power_off(entry->resource);
789 if (ret && !err)
790 err = ret;
791 }
792 if (err) {
793 dev_err(&dev->dev, "Cannot turn off wakeup power resources\n");
794 dev->wakeup.flags.valid = 0;
795 goto out;
796 }
797
798 dev_dbg(&dev->dev, "Wakeup power disabled\n");
799
800 out:
801 mutex_unlock(&acpi_device_lock);
802 return err;
803}
804
805int acpi_power_get_inferred_state(struct acpi_device *device, int *state)
806{
807 u8 list_state = ACPI_POWER_RESOURCE_STATE_OFF;
808 int result = 0;
809 int i = 0;
810
811 if (!device || !state)
812 return -EINVAL;
813
814 /*
815 * We know a device's inferred power state when all the resources
816 * required for a given D-state are 'on'.
817 */
818 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
819 struct list_head *list = &device->power.states[i].resources;
820
821 if (list_empty(list))
822 continue;
823
824 result = acpi_power_get_list_state(list, &list_state);
825 if (result)
826 return result;
827
828 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
829 *state = i;
830 return 0;
831 }
832 }
833
834 *state = device->power.states[ACPI_STATE_D3_COLD].flags.valid ?
835 ACPI_STATE_D3_COLD : ACPI_STATE_D3_HOT;
836 return 0;
837}
838
839int acpi_power_on_resources(struct acpi_device *device, int state)
840{
841 if (!device || state < ACPI_STATE_D0 || state > ACPI_STATE_D3_HOT)
842 return -EINVAL;
843
844 return acpi_power_on_list(&device->power.states[state].resources);
845}
846
847int acpi_power_transition(struct acpi_device *device, int state)
848{
849 int result = 0;
850
851 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
852 return -EINVAL;
853
854 if (device->power.state == state || !device->flags.power_manageable)
855 return 0;
856
857 if ((device->power.state < ACPI_STATE_D0)
858 || (device->power.state > ACPI_STATE_D3_COLD))
859 return -ENODEV;
860
861 /*
862 * First we reference all power resources required in the target list
863 * (e.g. so the device doesn't lose power while transitioning). Then,
864 * we dereference all power resources used in the current list.
865 */
866 if (state < ACPI_STATE_D3_COLD)
867 result = acpi_power_on_list(
868 &device->power.states[state].resources);
869
870 if (!result && device->power.state < ACPI_STATE_D3_COLD)
871 acpi_power_off_list(
872 &device->power.states[device->power.state].resources);
873
874 /* We shouldn't change the state unless the above operations succeed. */
875 device->power.state = result ? ACPI_STATE_UNKNOWN : state;
876
877 return result;
878}
879
880static void acpi_release_power_resource(struct device *dev)
881{
882 struct acpi_device *device = to_acpi_device(dev);
883 struct acpi_power_resource *resource;
884
885 resource = container_of(device, struct acpi_power_resource, device);
886
887 mutex_lock(&power_resource_list_lock);
888 list_del(&resource->list_node);
889 mutex_unlock(&power_resource_list_lock);
890
891 acpi_free_pnp_ids(&device->pnp);
892 kfree(resource);
893}
894
895static ssize_t resource_in_use_show(struct device *dev,
896 struct device_attribute *attr,
897 char *buf)
898{
899 struct acpi_power_resource *resource;
900
901 resource = to_power_resource(to_acpi_device(dev));
902 return sprintf(buf, "%u\n", !!resource->ref_count);
903}
904static DEVICE_ATTR_RO(resource_in_use);
905
906static void acpi_power_sysfs_remove(struct acpi_device *device)
907{
908 device_remove_file(&device->dev, &dev_attr_resource_in_use);
909}
910
911static void acpi_power_add_resource_to_list(struct acpi_power_resource *resource)
912{
913 mutex_lock(&power_resource_list_lock);
914
915 if (!list_empty(&acpi_power_resource_list)) {
916 struct acpi_power_resource *r;
917
918 list_for_each_entry(r, &acpi_power_resource_list, list_node)
919 if (r->order > resource->order) {
920 list_add_tail(&resource->list_node, &r->list_node);
921 goto out;
922 }
923 }
924 list_add_tail(&resource->list_node, &acpi_power_resource_list);
925
926 out:
927 mutex_unlock(&power_resource_list_lock);
928}
929
930struct acpi_device *acpi_add_power_resource(acpi_handle handle)
931{
932 struct acpi_device *device = acpi_fetch_acpi_dev(handle);
933 struct acpi_power_resource *resource;
934 union acpi_object acpi_object;
935 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
936 acpi_status status;
937 u8 state_dummy;
938 int result;
939
940 if (device)
941 return device;
942
943 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
944 if (!resource)
945 return NULL;
946
947 device = &resource->device;
948 acpi_init_device_object(device, handle, ACPI_BUS_TYPE_POWER,
949 acpi_release_power_resource);
950 mutex_init(&resource->resource_lock);
951 INIT_LIST_HEAD(&resource->list_node);
952 INIT_LIST_HEAD(&resource->dependents);
953 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
954 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
955 device->power.state = ACPI_STATE_UNKNOWN;
956 device->flags.match_driver = true;
957
958 /* Evaluate the object to get the system level and resource order. */
959 status = acpi_evaluate_object(handle, NULL, NULL, &buffer);
960 if (ACPI_FAILURE(status))
961 goto err;
962
963 resource->system_level = acpi_object.power_resource.system_level;
964 resource->order = acpi_object.power_resource.resource_order;
965 resource->state = ACPI_POWER_RESOURCE_STATE_UNKNOWN;
966
967 /* Get the initial state or just flip it on if that fails. */
968 if (acpi_power_get_state(resource, &state_dummy))
969 __acpi_power_on(resource);
970
971 acpi_handle_info(handle, "New power resource\n");
972
973 result = acpi_tie_acpi_dev(device);
974 if (result)
975 goto err;
976
977 result = acpi_device_add(device);
978 if (result)
979 goto err;
980
981 if (!device_create_file(&device->dev, &dev_attr_resource_in_use))
982 device->remove = acpi_power_sysfs_remove;
983
984 acpi_power_add_resource_to_list(resource);
985 acpi_device_add_finalize(device);
986 return device;
987
988 err:
989 acpi_release_power_resource(&device->dev);
990 return NULL;
991}
992
993#ifdef CONFIG_ACPI_SLEEP
994void acpi_resume_power_resources(void)
995{
996 struct acpi_power_resource *resource;
997
998 mutex_lock(&power_resource_list_lock);
999
1000 list_for_each_entry(resource, &acpi_power_resource_list, list_node) {
1001 int result;
1002 u8 state;
1003
1004 mutex_lock(&resource->resource_lock);
1005
1006 resource->state = ACPI_POWER_RESOURCE_STATE_UNKNOWN;
1007 result = acpi_power_get_state(resource, &state);
1008 if (result) {
1009 mutex_unlock(&resource->resource_lock);
1010 continue;
1011 }
1012
1013 if (state == ACPI_POWER_RESOURCE_STATE_OFF
1014 && resource->ref_count) {
1015 acpi_handle_debug(resource->device.handle, "Turning ON\n");
1016 __acpi_power_on(resource);
1017 }
1018
1019 mutex_unlock(&resource->resource_lock);
1020 }
1021
1022 mutex_unlock(&power_resource_list_lock);
1023}
1024#endif
1025
1026static const struct dmi_system_id dmi_leave_unused_power_resources_on[] = {
1027 {
1028 /*
1029 * The Toshiba Click Mini has a CPR3 power-resource which must
1030 * be on for the touchscreen to work, but which is not in any
1031 * _PR? lists. The other 2 affected power-resources are no-ops.
1032 */
1033 .matches = {
1034 DMI_MATCH(DMI_SYS_VENDOR, "TOSHIBA"),
1035 DMI_MATCH(DMI_PRODUCT_NAME, "SATELLITE Click Mini L9W-B"),
1036 },
1037 },
1038 {}
1039};
1040
1041/**
1042 * acpi_turn_off_unused_power_resources - Turn off power resources not in use.
1043 */
1044void acpi_turn_off_unused_power_resources(void)
1045{
1046 struct acpi_power_resource *resource;
1047
1048 if (dmi_check_system(dmi_leave_unused_power_resources_on))
1049 return;
1050
1051 mutex_lock(&power_resource_list_lock);
1052
1053 list_for_each_entry_reverse(resource, &acpi_power_resource_list, list_node) {
1054 mutex_lock(&resource->resource_lock);
1055
1056 if (!resource->ref_count &&
1057 resource->state == ACPI_POWER_RESOURCE_STATE_ON) {
1058 acpi_handle_debug(resource->device.handle, "Turning OFF\n");
1059 __acpi_power_off(resource);
1060 }
1061
1062 mutex_unlock(&resource->resource_lock);
1063 }
1064
1065 mutex_unlock(&power_resource_list_lock);
1066}
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * drivers/acpi/power.c - ACPI Power Resources management.
4 *
5 * Copyright (C) 2001 - 2015 Intel Corp.
6 * Author: Andy Grover <andrew.grover@intel.com>
7 * Author: Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
9 */
10
11/*
12 * ACPI power-managed devices may be controlled in two ways:
13 * 1. via "Device Specific (D-State) Control"
14 * 2. via "Power Resource Control".
15 * The code below deals with ACPI Power Resources control.
16 *
17 * An ACPI "power resource object" represents a software controllable power
18 * plane, clock plane, or other resource depended on by a device.
19 *
20 * A device may rely on multiple power resources, and a power resource
21 * may be shared by multiple devices.
22 */
23
24#include <linux/kernel.h>
25#include <linux/module.h>
26#include <linux/init.h>
27#include <linux/types.h>
28#include <linux/slab.h>
29#include <linux/pm_runtime.h>
30#include <linux/sysfs.h>
31#include <linux/acpi.h>
32#include "sleep.h"
33#include "internal.h"
34
35#define _COMPONENT ACPI_POWER_COMPONENT
36ACPI_MODULE_NAME("power");
37#define ACPI_POWER_CLASS "power_resource"
38#define ACPI_POWER_DEVICE_NAME "Power Resource"
39#define ACPI_POWER_FILE_INFO "info"
40#define ACPI_POWER_FILE_STATUS "state"
41#define ACPI_POWER_RESOURCE_STATE_OFF 0x00
42#define ACPI_POWER_RESOURCE_STATE_ON 0x01
43#define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
44
45struct acpi_power_dependent_device {
46 struct device *dev;
47 struct list_head node;
48};
49
50struct acpi_power_resource {
51 struct acpi_device device;
52 struct list_head list_node;
53 char *name;
54 u32 system_level;
55 u32 order;
56 unsigned int ref_count;
57 bool wakeup_enabled;
58 struct mutex resource_lock;
59 struct list_head dependents;
60};
61
62struct acpi_power_resource_entry {
63 struct list_head node;
64 struct acpi_power_resource *resource;
65};
66
67static LIST_HEAD(acpi_power_resource_list);
68static DEFINE_MUTEX(power_resource_list_lock);
69
70/* --------------------------------------------------------------------------
71 Power Resource Management
72 -------------------------------------------------------------------------- */
73
74static inline
75struct acpi_power_resource *to_power_resource(struct acpi_device *device)
76{
77 return container_of(device, struct acpi_power_resource, device);
78}
79
80static struct acpi_power_resource *acpi_power_get_context(acpi_handle handle)
81{
82 struct acpi_device *device;
83
84 if (acpi_bus_get_device(handle, &device))
85 return NULL;
86
87 return to_power_resource(device);
88}
89
90static int acpi_power_resources_list_add(acpi_handle handle,
91 struct list_head *list)
92{
93 struct acpi_power_resource *resource = acpi_power_get_context(handle);
94 struct acpi_power_resource_entry *entry;
95
96 if (!resource || !list)
97 return -EINVAL;
98
99 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
100 if (!entry)
101 return -ENOMEM;
102
103 entry->resource = resource;
104 if (!list_empty(list)) {
105 struct acpi_power_resource_entry *e;
106
107 list_for_each_entry(e, list, node)
108 if (e->resource->order > resource->order) {
109 list_add_tail(&entry->node, &e->node);
110 return 0;
111 }
112 }
113 list_add_tail(&entry->node, list);
114 return 0;
115}
116
117void acpi_power_resources_list_free(struct list_head *list)
118{
119 struct acpi_power_resource_entry *entry, *e;
120
121 list_for_each_entry_safe(entry, e, list, node) {
122 list_del(&entry->node);
123 kfree(entry);
124 }
125}
126
127static bool acpi_power_resource_is_dup(union acpi_object *package,
128 unsigned int start, unsigned int i)
129{
130 acpi_handle rhandle, dup;
131 unsigned int j;
132
133 /* The caller is expected to check the package element types */
134 rhandle = package->package.elements[i].reference.handle;
135 for (j = start; j < i; j++) {
136 dup = package->package.elements[j].reference.handle;
137 if (dup == rhandle)
138 return true;
139 }
140
141 return false;
142}
143
144int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
145 struct list_head *list)
146{
147 unsigned int i;
148 int err = 0;
149
150 for (i = start; i < package->package.count; i++) {
151 union acpi_object *element = &package->package.elements[i];
152 acpi_handle rhandle;
153
154 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
155 err = -ENODATA;
156 break;
157 }
158 rhandle = element->reference.handle;
159 if (!rhandle) {
160 err = -ENODEV;
161 break;
162 }
163
164 /* Some ACPI tables contain duplicate power resource references */
165 if (acpi_power_resource_is_dup(package, start, i))
166 continue;
167
168 err = acpi_add_power_resource(rhandle);
169 if (err)
170 break;
171
172 err = acpi_power_resources_list_add(rhandle, list);
173 if (err)
174 break;
175 }
176 if (err)
177 acpi_power_resources_list_free(list);
178
179 return err;
180}
181
182static int acpi_power_get_state(acpi_handle handle, int *state)
183{
184 acpi_status status = AE_OK;
185 unsigned long long sta = 0;
186 char node_name[5];
187 struct acpi_buffer buffer = { sizeof(node_name), node_name };
188
189
190 if (!handle || !state)
191 return -EINVAL;
192
193 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
194 if (ACPI_FAILURE(status))
195 return -ENODEV;
196
197 *state = (sta & 0x01)?ACPI_POWER_RESOURCE_STATE_ON:
198 ACPI_POWER_RESOURCE_STATE_OFF;
199
200 acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
201
202 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] is %s\n",
203 node_name,
204 *state ? "on" : "off"));
205
206 return 0;
207}
208
209static int acpi_power_get_list_state(struct list_head *list, int *state)
210{
211 struct acpi_power_resource_entry *entry;
212 int cur_state;
213
214 if (!list || !state)
215 return -EINVAL;
216
217 /* The state of the list is 'on' IFF all resources are 'on'. */
218 cur_state = 0;
219 list_for_each_entry(entry, list, node) {
220 struct acpi_power_resource *resource = entry->resource;
221 acpi_handle handle = resource->device.handle;
222 int result;
223
224 mutex_lock(&resource->resource_lock);
225 result = acpi_power_get_state(handle, &cur_state);
226 mutex_unlock(&resource->resource_lock);
227 if (result)
228 return result;
229
230 if (cur_state != ACPI_POWER_RESOURCE_STATE_ON)
231 break;
232 }
233
234 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource list is %s\n",
235 cur_state ? "on" : "off"));
236
237 *state = cur_state;
238 return 0;
239}
240
241static int
242acpi_power_resource_add_dependent(struct acpi_power_resource *resource,
243 struct device *dev)
244{
245 struct acpi_power_dependent_device *dep;
246 int ret = 0;
247
248 mutex_lock(&resource->resource_lock);
249 list_for_each_entry(dep, &resource->dependents, node) {
250 /* Only add it once */
251 if (dep->dev == dev)
252 goto unlock;
253 }
254
255 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
256 if (!dep) {
257 ret = -ENOMEM;
258 goto unlock;
259 }
260
261 dep->dev = dev;
262 list_add_tail(&dep->node, &resource->dependents);
263 dev_dbg(dev, "added power dependency to [%s]\n", resource->name);
264
265unlock:
266 mutex_unlock(&resource->resource_lock);
267 return ret;
268}
269
270static void
271acpi_power_resource_remove_dependent(struct acpi_power_resource *resource,
272 struct device *dev)
273{
274 struct acpi_power_dependent_device *dep;
275
276 mutex_lock(&resource->resource_lock);
277 list_for_each_entry(dep, &resource->dependents, node) {
278 if (dep->dev == dev) {
279 list_del(&dep->node);
280 kfree(dep);
281 dev_dbg(dev, "removed power dependency to [%s]\n",
282 resource->name);
283 break;
284 }
285 }
286 mutex_unlock(&resource->resource_lock);
287}
288
289/**
290 * acpi_device_power_add_dependent - Add dependent device of this ACPI device
291 * @adev: ACPI device pointer
292 * @dev: Dependent device
293 *
294 * If @adev has non-empty _PR0 the @dev is added as dependent device to all
295 * power resources returned by it. This means that whenever these power
296 * resources are turned _ON the dependent devices get runtime resumed. This
297 * is needed for devices such as PCI to allow its driver to re-initialize
298 * it after it went to D0uninitialized.
299 *
300 * If @adev does not have _PR0 this does nothing.
301 *
302 * Returns %0 in case of success and negative errno otherwise.
303 */
304int acpi_device_power_add_dependent(struct acpi_device *adev,
305 struct device *dev)
306{
307 struct acpi_power_resource_entry *entry;
308 struct list_head *resources;
309 int ret;
310
311 if (!adev->flags.power_manageable)
312 return 0;
313
314 resources = &adev->power.states[ACPI_STATE_D0].resources;
315 list_for_each_entry(entry, resources, node) {
316 ret = acpi_power_resource_add_dependent(entry->resource, dev);
317 if (ret)
318 goto err;
319 }
320
321 return 0;
322
323err:
324 list_for_each_entry(entry, resources, node)
325 acpi_power_resource_remove_dependent(entry->resource, dev);
326
327 return ret;
328}
329
330/**
331 * acpi_device_power_remove_dependent - Remove dependent device
332 * @adev: ACPI device pointer
333 * @dev: Dependent device
334 *
335 * Does the opposite of acpi_device_power_add_dependent() and removes the
336 * dependent device if it is found. Can be called to @adev that does not
337 * have _PR0 as well.
338 */
339void acpi_device_power_remove_dependent(struct acpi_device *adev,
340 struct device *dev)
341{
342 struct acpi_power_resource_entry *entry;
343 struct list_head *resources;
344
345 if (!adev->flags.power_manageable)
346 return;
347
348 resources = &adev->power.states[ACPI_STATE_D0].resources;
349 list_for_each_entry_reverse(entry, resources, node)
350 acpi_power_resource_remove_dependent(entry->resource, dev);
351}
352
353static int __acpi_power_on(struct acpi_power_resource *resource)
354{
355 struct acpi_power_dependent_device *dep;
356 acpi_status status = AE_OK;
357
358 status = acpi_evaluate_object(resource->device.handle, "_ON", NULL, NULL);
359 if (ACPI_FAILURE(status))
360 return -ENODEV;
361
362 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned on\n",
363 resource->name));
364
365 /*
366 * If there are other dependents on this power resource we need to
367 * resume them now so that their drivers can re-initialize the
368 * hardware properly after it went back to D0.
369 */
370 if (list_empty(&resource->dependents) ||
371 list_is_singular(&resource->dependents))
372 return 0;
373
374 list_for_each_entry(dep, &resource->dependents, node) {
375 dev_dbg(dep->dev, "runtime resuming because [%s] turned on\n",
376 resource->name);
377 pm_request_resume(dep->dev);
378 }
379
380 return 0;
381}
382
383static int acpi_power_on_unlocked(struct acpi_power_resource *resource)
384{
385 int result = 0;
386
387 if (resource->ref_count++) {
388 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
389 "Power resource [%s] already on\n",
390 resource->name));
391 } else {
392 result = __acpi_power_on(resource);
393 if (result)
394 resource->ref_count--;
395 }
396 return result;
397}
398
399static int acpi_power_on(struct acpi_power_resource *resource)
400{
401 int result;
402
403 mutex_lock(&resource->resource_lock);
404 result = acpi_power_on_unlocked(resource);
405 mutex_unlock(&resource->resource_lock);
406 return result;
407}
408
409static int __acpi_power_off(struct acpi_power_resource *resource)
410{
411 acpi_status status;
412
413 status = acpi_evaluate_object(resource->device.handle, "_OFF",
414 NULL, NULL);
415 if (ACPI_FAILURE(status))
416 return -ENODEV;
417
418 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned off\n",
419 resource->name));
420 return 0;
421}
422
423static int acpi_power_off_unlocked(struct acpi_power_resource *resource)
424{
425 int result = 0;
426
427 if (!resource->ref_count) {
428 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
429 "Power resource [%s] already off\n",
430 resource->name));
431 return 0;
432 }
433
434 if (--resource->ref_count) {
435 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
436 "Power resource [%s] still in use\n",
437 resource->name));
438 } else {
439 result = __acpi_power_off(resource);
440 if (result)
441 resource->ref_count++;
442 }
443 return result;
444}
445
446static int acpi_power_off(struct acpi_power_resource *resource)
447{
448 int result;
449
450 mutex_lock(&resource->resource_lock);
451 result = acpi_power_off_unlocked(resource);
452 mutex_unlock(&resource->resource_lock);
453 return result;
454}
455
456static int acpi_power_off_list(struct list_head *list)
457{
458 struct acpi_power_resource_entry *entry;
459 int result = 0;
460
461 list_for_each_entry_reverse(entry, list, node) {
462 result = acpi_power_off(entry->resource);
463 if (result)
464 goto err;
465 }
466 return 0;
467
468 err:
469 list_for_each_entry_continue(entry, list, node)
470 acpi_power_on(entry->resource);
471
472 return result;
473}
474
475static int acpi_power_on_list(struct list_head *list)
476{
477 struct acpi_power_resource_entry *entry;
478 int result = 0;
479
480 list_for_each_entry(entry, list, node) {
481 result = acpi_power_on(entry->resource);
482 if (result)
483 goto err;
484 }
485 return 0;
486
487 err:
488 list_for_each_entry_continue_reverse(entry, list, node)
489 acpi_power_off(entry->resource);
490
491 return result;
492}
493
494static struct attribute *attrs[] = {
495 NULL,
496};
497
498static const struct attribute_group attr_groups[] = {
499 [ACPI_STATE_D0] = {
500 .name = "power_resources_D0",
501 .attrs = attrs,
502 },
503 [ACPI_STATE_D1] = {
504 .name = "power_resources_D1",
505 .attrs = attrs,
506 },
507 [ACPI_STATE_D2] = {
508 .name = "power_resources_D2",
509 .attrs = attrs,
510 },
511 [ACPI_STATE_D3_HOT] = {
512 .name = "power_resources_D3hot",
513 .attrs = attrs,
514 },
515};
516
517static const struct attribute_group wakeup_attr_group = {
518 .name = "power_resources_wakeup",
519 .attrs = attrs,
520};
521
522static void acpi_power_hide_list(struct acpi_device *adev,
523 struct list_head *resources,
524 const struct attribute_group *attr_group)
525{
526 struct acpi_power_resource_entry *entry;
527
528 if (list_empty(resources))
529 return;
530
531 list_for_each_entry_reverse(entry, resources, node) {
532 struct acpi_device *res_dev = &entry->resource->device;
533
534 sysfs_remove_link_from_group(&adev->dev.kobj,
535 attr_group->name,
536 dev_name(&res_dev->dev));
537 }
538 sysfs_remove_group(&adev->dev.kobj, attr_group);
539}
540
541static void acpi_power_expose_list(struct acpi_device *adev,
542 struct list_head *resources,
543 const struct attribute_group *attr_group)
544{
545 struct acpi_power_resource_entry *entry;
546 int ret;
547
548 if (list_empty(resources))
549 return;
550
551 ret = sysfs_create_group(&adev->dev.kobj, attr_group);
552 if (ret)
553 return;
554
555 list_for_each_entry(entry, resources, node) {
556 struct acpi_device *res_dev = &entry->resource->device;
557
558 ret = sysfs_add_link_to_group(&adev->dev.kobj,
559 attr_group->name,
560 &res_dev->dev.kobj,
561 dev_name(&res_dev->dev));
562 if (ret) {
563 acpi_power_hide_list(adev, resources, attr_group);
564 break;
565 }
566 }
567}
568
569static void acpi_power_expose_hide(struct acpi_device *adev,
570 struct list_head *resources,
571 const struct attribute_group *attr_group,
572 bool expose)
573{
574 if (expose)
575 acpi_power_expose_list(adev, resources, attr_group);
576 else
577 acpi_power_hide_list(adev, resources, attr_group);
578}
579
580void acpi_power_add_remove_device(struct acpi_device *adev, bool add)
581{
582 int state;
583
584 if (adev->wakeup.flags.valid)
585 acpi_power_expose_hide(adev, &adev->wakeup.resources,
586 &wakeup_attr_group, add);
587
588 if (!adev->power.flags.power_resources)
589 return;
590
591 for (state = ACPI_STATE_D0; state <= ACPI_STATE_D3_HOT; state++)
592 acpi_power_expose_hide(adev,
593 &adev->power.states[state].resources,
594 &attr_groups[state], add);
595}
596
597int acpi_power_wakeup_list_init(struct list_head *list, int *system_level_p)
598{
599 struct acpi_power_resource_entry *entry;
600 int system_level = 5;
601
602 list_for_each_entry(entry, list, node) {
603 struct acpi_power_resource *resource = entry->resource;
604 acpi_handle handle = resource->device.handle;
605 int result;
606 int state;
607
608 mutex_lock(&resource->resource_lock);
609
610 result = acpi_power_get_state(handle, &state);
611 if (result) {
612 mutex_unlock(&resource->resource_lock);
613 return result;
614 }
615 if (state == ACPI_POWER_RESOURCE_STATE_ON) {
616 resource->ref_count++;
617 resource->wakeup_enabled = true;
618 }
619 if (system_level > resource->system_level)
620 system_level = resource->system_level;
621
622 mutex_unlock(&resource->resource_lock);
623 }
624 *system_level_p = system_level;
625 return 0;
626}
627
628/* --------------------------------------------------------------------------
629 Device Power Management
630 -------------------------------------------------------------------------- */
631
632/**
633 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
634 * ACPI 3.0) _PSW (Power State Wake)
635 * @dev: Device to handle.
636 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
637 * @sleep_state: Target sleep state of the system.
638 * @dev_state: Target power state of the device.
639 *
640 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
641 * State Wake) for the device, if present. On failure reset the device's
642 * wakeup.flags.valid flag.
643 *
644 * RETURN VALUE:
645 * 0 if either _DSW or _PSW has been successfully executed
646 * 0 if neither _DSW nor _PSW has been found
647 * -ENODEV if the execution of either _DSW or _PSW has failed
648 */
649int acpi_device_sleep_wake(struct acpi_device *dev,
650 int enable, int sleep_state, int dev_state)
651{
652 union acpi_object in_arg[3];
653 struct acpi_object_list arg_list = { 3, in_arg };
654 acpi_status status = AE_OK;
655
656 /*
657 * Try to execute _DSW first.
658 *
659 * Three arguments are needed for the _DSW object:
660 * Argument 0: enable/disable the wake capabilities
661 * Argument 1: target system state
662 * Argument 2: target device state
663 * When _DSW object is called to disable the wake capabilities, maybe
664 * the first argument is filled. The values of the other two arguments
665 * are meaningless.
666 */
667 in_arg[0].type = ACPI_TYPE_INTEGER;
668 in_arg[0].integer.value = enable;
669 in_arg[1].type = ACPI_TYPE_INTEGER;
670 in_arg[1].integer.value = sleep_state;
671 in_arg[2].type = ACPI_TYPE_INTEGER;
672 in_arg[2].integer.value = dev_state;
673 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
674 if (ACPI_SUCCESS(status)) {
675 return 0;
676 } else if (status != AE_NOT_FOUND) {
677 printk(KERN_ERR PREFIX "_DSW execution failed\n");
678 dev->wakeup.flags.valid = 0;
679 return -ENODEV;
680 }
681
682 /* Execute _PSW */
683 status = acpi_execute_simple_method(dev->handle, "_PSW", enable);
684 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
685 printk(KERN_ERR PREFIX "_PSW execution failed\n");
686 dev->wakeup.flags.valid = 0;
687 return -ENODEV;
688 }
689
690 return 0;
691}
692
693/*
694 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
695 * 1. Power on the power resources required for the wakeup device
696 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
697 * State Wake) for the device, if present
698 */
699int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
700{
701 struct acpi_power_resource_entry *entry;
702 int err = 0;
703
704 if (!dev || !dev->wakeup.flags.valid)
705 return -EINVAL;
706
707 mutex_lock(&acpi_device_lock);
708
709 if (dev->wakeup.prepare_count++)
710 goto out;
711
712 list_for_each_entry(entry, &dev->wakeup.resources, node) {
713 struct acpi_power_resource *resource = entry->resource;
714
715 mutex_lock(&resource->resource_lock);
716
717 if (!resource->wakeup_enabled) {
718 err = acpi_power_on_unlocked(resource);
719 if (!err)
720 resource->wakeup_enabled = true;
721 }
722
723 mutex_unlock(&resource->resource_lock);
724
725 if (err) {
726 dev_err(&dev->dev,
727 "Cannot turn wakeup power resources on\n");
728 dev->wakeup.flags.valid = 0;
729 goto out;
730 }
731 }
732 /*
733 * Passing 3 as the third argument below means the device may be
734 * put into arbitrary power state afterward.
735 */
736 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
737 if (err)
738 dev->wakeup.prepare_count = 0;
739
740 out:
741 mutex_unlock(&acpi_device_lock);
742 return err;
743}
744
745/*
746 * Shutdown a wakeup device, counterpart of above method
747 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
748 * State Wake) for the device, if present
749 * 2. Shutdown down the power resources
750 */
751int acpi_disable_wakeup_device_power(struct acpi_device *dev)
752{
753 struct acpi_power_resource_entry *entry;
754 int err = 0;
755
756 if (!dev || !dev->wakeup.flags.valid)
757 return -EINVAL;
758
759 mutex_lock(&acpi_device_lock);
760
761 if (--dev->wakeup.prepare_count > 0)
762 goto out;
763
764 /*
765 * Executing the code below even if prepare_count is already zero when
766 * the function is called may be useful, for example for initialisation.
767 */
768 if (dev->wakeup.prepare_count < 0)
769 dev->wakeup.prepare_count = 0;
770
771 err = acpi_device_sleep_wake(dev, 0, 0, 0);
772 if (err)
773 goto out;
774
775 list_for_each_entry(entry, &dev->wakeup.resources, node) {
776 struct acpi_power_resource *resource = entry->resource;
777
778 mutex_lock(&resource->resource_lock);
779
780 if (resource->wakeup_enabled) {
781 err = acpi_power_off_unlocked(resource);
782 if (!err)
783 resource->wakeup_enabled = false;
784 }
785
786 mutex_unlock(&resource->resource_lock);
787
788 if (err) {
789 dev_err(&dev->dev,
790 "Cannot turn wakeup power resources off\n");
791 dev->wakeup.flags.valid = 0;
792 break;
793 }
794 }
795
796 out:
797 mutex_unlock(&acpi_device_lock);
798 return err;
799}
800
801int acpi_power_get_inferred_state(struct acpi_device *device, int *state)
802{
803 int result = 0;
804 int list_state = 0;
805 int i = 0;
806
807 if (!device || !state)
808 return -EINVAL;
809
810 /*
811 * We know a device's inferred power state when all the resources
812 * required for a given D-state are 'on'.
813 */
814 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
815 struct list_head *list = &device->power.states[i].resources;
816
817 if (list_empty(list))
818 continue;
819
820 result = acpi_power_get_list_state(list, &list_state);
821 if (result)
822 return result;
823
824 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
825 *state = i;
826 return 0;
827 }
828 }
829
830 *state = device->power.states[ACPI_STATE_D3_COLD].flags.valid ?
831 ACPI_STATE_D3_COLD : ACPI_STATE_D3_HOT;
832 return 0;
833}
834
835int acpi_power_on_resources(struct acpi_device *device, int state)
836{
837 if (!device || state < ACPI_STATE_D0 || state > ACPI_STATE_D3_HOT)
838 return -EINVAL;
839
840 return acpi_power_on_list(&device->power.states[state].resources);
841}
842
843int acpi_power_transition(struct acpi_device *device, int state)
844{
845 int result = 0;
846
847 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
848 return -EINVAL;
849
850 if (device->power.state == state || !device->flags.power_manageable)
851 return 0;
852
853 if ((device->power.state < ACPI_STATE_D0)
854 || (device->power.state > ACPI_STATE_D3_COLD))
855 return -ENODEV;
856
857 /*
858 * First we reference all power resources required in the target list
859 * (e.g. so the device doesn't lose power while transitioning). Then,
860 * we dereference all power resources used in the current list.
861 */
862 if (state < ACPI_STATE_D3_COLD)
863 result = acpi_power_on_list(
864 &device->power.states[state].resources);
865
866 if (!result && device->power.state < ACPI_STATE_D3_COLD)
867 acpi_power_off_list(
868 &device->power.states[device->power.state].resources);
869
870 /* We shouldn't change the state unless the above operations succeed. */
871 device->power.state = result ? ACPI_STATE_UNKNOWN : state;
872
873 return result;
874}
875
876static void acpi_release_power_resource(struct device *dev)
877{
878 struct acpi_device *device = to_acpi_device(dev);
879 struct acpi_power_resource *resource;
880
881 resource = container_of(device, struct acpi_power_resource, device);
882
883 mutex_lock(&power_resource_list_lock);
884 list_del(&resource->list_node);
885 mutex_unlock(&power_resource_list_lock);
886
887 acpi_free_pnp_ids(&device->pnp);
888 kfree(resource);
889}
890
891static ssize_t acpi_power_in_use_show(struct device *dev,
892 struct device_attribute *attr,
893 char *buf) {
894 struct acpi_power_resource *resource;
895
896 resource = to_power_resource(to_acpi_device(dev));
897 return sprintf(buf, "%u\n", !!resource->ref_count);
898}
899static DEVICE_ATTR(resource_in_use, 0444, acpi_power_in_use_show, NULL);
900
901static void acpi_power_sysfs_remove(struct acpi_device *device)
902{
903 device_remove_file(&device->dev, &dev_attr_resource_in_use);
904}
905
906static void acpi_power_add_resource_to_list(struct acpi_power_resource *resource)
907{
908 mutex_lock(&power_resource_list_lock);
909
910 if (!list_empty(&acpi_power_resource_list)) {
911 struct acpi_power_resource *r;
912
913 list_for_each_entry(r, &acpi_power_resource_list, list_node)
914 if (r->order > resource->order) {
915 list_add_tail(&resource->list_node, &r->list_node);
916 goto out;
917 }
918 }
919 list_add_tail(&resource->list_node, &acpi_power_resource_list);
920
921 out:
922 mutex_unlock(&power_resource_list_lock);
923}
924
925int acpi_add_power_resource(acpi_handle handle)
926{
927 struct acpi_power_resource *resource;
928 struct acpi_device *device = NULL;
929 union acpi_object acpi_object;
930 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
931 acpi_status status;
932 int state, result = -ENODEV;
933
934 acpi_bus_get_device(handle, &device);
935 if (device)
936 return 0;
937
938 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
939 if (!resource)
940 return -ENOMEM;
941
942 device = &resource->device;
943 acpi_init_device_object(device, handle, ACPI_BUS_TYPE_POWER,
944 ACPI_STA_DEFAULT);
945 mutex_init(&resource->resource_lock);
946 INIT_LIST_HEAD(&resource->list_node);
947 INIT_LIST_HEAD(&resource->dependents);
948 resource->name = device->pnp.bus_id;
949 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
950 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
951 device->power.state = ACPI_STATE_UNKNOWN;
952
953 /* Evalute the object to get the system level and resource order. */
954 status = acpi_evaluate_object(handle, NULL, NULL, &buffer);
955 if (ACPI_FAILURE(status))
956 goto err;
957
958 resource->system_level = acpi_object.power_resource.system_level;
959 resource->order = acpi_object.power_resource.resource_order;
960
961 result = acpi_power_get_state(handle, &state);
962 if (result)
963 goto err;
964
965 printk(KERN_INFO PREFIX "%s [%s] (%s)\n", acpi_device_name(device),
966 acpi_device_bid(device), state ? "on" : "off");
967
968 device->flags.match_driver = true;
969 result = acpi_device_add(device, acpi_release_power_resource);
970 if (result)
971 goto err;
972
973 if (!device_create_file(&device->dev, &dev_attr_resource_in_use))
974 device->remove = acpi_power_sysfs_remove;
975
976 acpi_power_add_resource_to_list(resource);
977 acpi_device_add_finalize(device);
978 return 0;
979
980 err:
981 acpi_release_power_resource(&device->dev);
982 return result;
983}
984
985#ifdef CONFIG_ACPI_SLEEP
986void acpi_resume_power_resources(void)
987{
988 struct acpi_power_resource *resource;
989
990 mutex_lock(&power_resource_list_lock);
991
992 list_for_each_entry(resource, &acpi_power_resource_list, list_node) {
993 int result, state;
994
995 mutex_lock(&resource->resource_lock);
996
997 result = acpi_power_get_state(resource->device.handle, &state);
998 if (result) {
999 mutex_unlock(&resource->resource_lock);
1000 continue;
1001 }
1002
1003 if (state == ACPI_POWER_RESOURCE_STATE_OFF
1004 && resource->ref_count) {
1005 dev_info(&resource->device.dev, "Turning ON\n");
1006 __acpi_power_on(resource);
1007 }
1008
1009 mutex_unlock(&resource->resource_lock);
1010 }
1011
1012 mutex_unlock(&power_resource_list_lock);
1013}
1014
1015void acpi_turn_off_unused_power_resources(void)
1016{
1017 struct acpi_power_resource *resource;
1018
1019 mutex_lock(&power_resource_list_lock);
1020
1021 list_for_each_entry_reverse(resource, &acpi_power_resource_list, list_node) {
1022 int result, state;
1023
1024 mutex_lock(&resource->resource_lock);
1025
1026 result = acpi_power_get_state(resource->device.handle, &state);
1027 if (result) {
1028 mutex_unlock(&resource->resource_lock);
1029 continue;
1030 }
1031
1032 if (state == ACPI_POWER_RESOURCE_STATE_ON
1033 && !resource->ref_count) {
1034 dev_info(&resource->device.dev, "Turning OFF\n");
1035 __acpi_power_off(resource);
1036 }
1037
1038 mutex_unlock(&resource->resource_lock);
1039 }
1040
1041 mutex_unlock(&power_resource_list_lock);
1042}
1043#endif