2 * drivers/acpi/power.c - ACPI Power Resources management.
4 * Copyright (C) 2001 - 2015 Intel Corp.
5 * Author: Andy Grover <andrew.grover@intel.com>
6 * Author: Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
9 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or (at
14 * your option) any later version.
16 * This program is distributed in the hope that it will be useful, but
17 * WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * General Public License for more details.
21 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25 * ACPI power-managed devices may be controlled in two ways:
26 * 1. via "Device Specific (D-State) Control"
27 * 2. via "Power Resource Control".
28 * The code below deals with ACPI Power Resources control.
30 * An ACPI "power resource object" represents a software controllable power
31 * plane, clock plane, or other resource depended on by a device.
33 * A device may rely on multiple power resources, and a power resource
34 * may be shared by multiple devices.
37 #include <linux/kernel.h>
38 #include <linux/module.h>
39 #include <linux/init.h>
40 #include <linux/types.h>
41 #include <linux/slab.h>
42 #include <linux/pm_runtime.h>
43 #include <linux/sysfs.h>
44 #include <linux/acpi.h>
48 #define _COMPONENT ACPI_POWER_COMPONENT
49 ACPI_MODULE_NAME("power");
50 #define ACPI_POWER_CLASS "power_resource"
51 #define ACPI_POWER_DEVICE_NAME "Power Resource"
52 #define ACPI_POWER_FILE_INFO "info"
53 #define ACPI_POWER_FILE_STATUS "state"
54 #define ACPI_POWER_RESOURCE_STATE_OFF 0x00
55 #define ACPI_POWER_RESOURCE_STATE_ON 0x01
56 #define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
58 struct acpi_power_resource {
59 struct acpi_device device;
60 struct list_head list_node;
64 unsigned int ref_count;
66 struct mutex resource_lock;
69 struct acpi_power_resource_entry {
70 struct list_head node;
71 struct acpi_power_resource *resource;
74 static LIST_HEAD(acpi_power_resource_list);
75 static DEFINE_MUTEX(power_resource_list_lock);
77 /* --------------------------------------------------------------------------
78 Power Resource Management
79 -------------------------------------------------------------------------- */
82 struct acpi_power_resource *to_power_resource(struct acpi_device *device)
84 return container_of(device, struct acpi_power_resource, device);
87 static struct acpi_power_resource *acpi_power_get_context(acpi_handle handle)
89 struct acpi_device *device;
91 if (acpi_bus_get_device(handle, &device))
94 return to_power_resource(device);
97 static int acpi_power_resources_list_add(acpi_handle handle,
98 struct list_head *list)
100 struct acpi_power_resource *resource = acpi_power_get_context(handle);
101 struct acpi_power_resource_entry *entry;
103 if (!resource || !list)
106 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
110 entry->resource = resource;
111 if (!list_empty(list)) {
112 struct acpi_power_resource_entry *e;
114 list_for_each_entry(e, list, node)
115 if (e->resource->order > resource->order) {
116 list_add_tail(&entry->node, &e->node);
120 list_add_tail(&entry->node, list);
124 void acpi_power_resources_list_free(struct list_head *list)
126 struct acpi_power_resource_entry *entry, *e;
128 list_for_each_entry_safe(entry, e, list, node) {
129 list_del(&entry->node);
134 static bool acpi_power_resource_is_dup(union acpi_object *package,
135 unsigned int start, unsigned int i)
137 acpi_handle rhandle, dup;
140 /* The caller is expected to check the package element types */
141 rhandle = package->package.elements[i].reference.handle;
142 for (j = start; j < i; j++) {
143 dup = package->package.elements[j].reference.handle;
151 int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
152 struct list_head *list)
157 for (i = start; i < package->package.count; i++) {
158 union acpi_object *element = &package->package.elements[i];
161 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
165 rhandle = element->reference.handle;
171 /* Some ACPI tables contain duplicate power resource references */
172 if (acpi_power_resource_is_dup(package, start, i))
175 err = acpi_add_power_resource(rhandle);
179 err = acpi_power_resources_list_add(rhandle, list);
184 acpi_power_resources_list_free(list);
189 static int acpi_power_get_state(acpi_handle handle, int *state)
191 acpi_status status = AE_OK;
192 unsigned long long sta = 0;
194 struct acpi_buffer buffer = { sizeof(node_name), node_name };
197 if (!handle || !state)
200 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
201 if (ACPI_FAILURE(status))
204 *state = (sta & 0x01)?ACPI_POWER_RESOURCE_STATE_ON:
205 ACPI_POWER_RESOURCE_STATE_OFF;
207 acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
209 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] is %s\n",
211 *state ? "on" : "off"));
216 static int acpi_power_get_list_state(struct list_head *list, int *state)
218 struct acpi_power_resource_entry *entry;
224 /* The state of the list is 'on' IFF all resources are 'on'. */
226 list_for_each_entry(entry, list, node) {
227 struct acpi_power_resource *resource = entry->resource;
228 acpi_handle handle = resource->device.handle;
231 mutex_lock(&resource->resource_lock);
232 result = acpi_power_get_state(handle, &cur_state);
233 mutex_unlock(&resource->resource_lock);
237 if (cur_state != ACPI_POWER_RESOURCE_STATE_ON)
241 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource list is %s\n",
242 cur_state ? "on" : "off"));
248 static int __acpi_power_on(struct acpi_power_resource *resource)
250 acpi_status status = AE_OK;
252 status = acpi_evaluate_object(resource->device.handle, "_ON", NULL, NULL);
253 if (ACPI_FAILURE(status))
256 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned on\n",
262 static int acpi_power_on_unlocked(struct acpi_power_resource *resource)
266 if (resource->ref_count++) {
267 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
268 "Power resource [%s] already on\n",
271 result = __acpi_power_on(resource);
273 resource->ref_count--;
278 static int acpi_power_on(struct acpi_power_resource *resource)
282 mutex_lock(&resource->resource_lock);
283 result = acpi_power_on_unlocked(resource);
284 mutex_unlock(&resource->resource_lock);
288 static int __acpi_power_off(struct acpi_power_resource *resource)
292 status = acpi_evaluate_object(resource->device.handle, "_OFF",
294 if (ACPI_FAILURE(status))
297 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned off\n",
302 static int acpi_power_off_unlocked(struct acpi_power_resource *resource)
306 if (!resource->ref_count) {
307 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
308 "Power resource [%s] already off\n",
313 if (--resource->ref_count) {
314 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
315 "Power resource [%s] still in use\n",
318 result = __acpi_power_off(resource);
320 resource->ref_count++;
325 static int acpi_power_off(struct acpi_power_resource *resource)
329 mutex_lock(&resource->resource_lock);
330 result = acpi_power_off_unlocked(resource);
331 mutex_unlock(&resource->resource_lock);
335 static int acpi_power_off_list(struct list_head *list)
337 struct acpi_power_resource_entry *entry;
340 list_for_each_entry_reverse(entry, list, node) {
341 result = acpi_power_off(entry->resource);
348 list_for_each_entry_continue(entry, list, node)
349 acpi_power_on(entry->resource);
354 static int acpi_power_on_list(struct list_head *list)
356 struct acpi_power_resource_entry *entry;
359 list_for_each_entry(entry, list, node) {
360 result = acpi_power_on(entry->resource);
367 list_for_each_entry_continue_reverse(entry, list, node)
368 acpi_power_off(entry->resource);
373 static struct attribute *attrs[] = {
377 static const struct attribute_group attr_groups[] = {
379 .name = "power_resources_D0",
383 .name = "power_resources_D1",
387 .name = "power_resources_D2",
390 [ACPI_STATE_D3_HOT] = {
391 .name = "power_resources_D3hot",
396 static const struct attribute_group wakeup_attr_group = {
397 .name = "power_resources_wakeup",
401 static void acpi_power_hide_list(struct acpi_device *adev,
402 struct list_head *resources,
403 const struct attribute_group *attr_group)
405 struct acpi_power_resource_entry *entry;
407 if (list_empty(resources))
410 list_for_each_entry_reverse(entry, resources, node) {
411 struct acpi_device *res_dev = &entry->resource->device;
413 sysfs_remove_link_from_group(&adev->dev.kobj,
415 dev_name(&res_dev->dev));
417 sysfs_remove_group(&adev->dev.kobj, attr_group);
420 static void acpi_power_expose_list(struct acpi_device *adev,
421 struct list_head *resources,
422 const struct attribute_group *attr_group)
424 struct acpi_power_resource_entry *entry;
427 if (list_empty(resources))
430 ret = sysfs_create_group(&adev->dev.kobj, attr_group);
434 list_for_each_entry(entry, resources, node) {
435 struct acpi_device *res_dev = &entry->resource->device;
437 ret = sysfs_add_link_to_group(&adev->dev.kobj,
440 dev_name(&res_dev->dev));
442 acpi_power_hide_list(adev, resources, attr_group);
448 static void acpi_power_expose_hide(struct acpi_device *adev,
449 struct list_head *resources,
450 const struct attribute_group *attr_group,
454 acpi_power_expose_list(adev, resources, attr_group);
456 acpi_power_hide_list(adev, resources, attr_group);
459 void acpi_power_add_remove_device(struct acpi_device *adev, bool add)
463 if (adev->wakeup.flags.valid)
464 acpi_power_expose_hide(adev, &adev->wakeup.resources,
465 &wakeup_attr_group, add);
467 if (!adev->power.flags.power_resources)
470 for (state = ACPI_STATE_D0; state <= ACPI_STATE_D3_HOT; state++)
471 acpi_power_expose_hide(adev,
472 &adev->power.states[state].resources,
473 &attr_groups[state], add);
476 int acpi_power_wakeup_list_init(struct list_head *list, int *system_level_p)
478 struct acpi_power_resource_entry *entry;
479 int system_level = 5;
481 list_for_each_entry(entry, list, node) {
482 struct acpi_power_resource *resource = entry->resource;
483 acpi_handle handle = resource->device.handle;
487 mutex_lock(&resource->resource_lock);
489 result = acpi_power_get_state(handle, &state);
491 mutex_unlock(&resource->resource_lock);
494 if (state == ACPI_POWER_RESOURCE_STATE_ON) {
495 resource->ref_count++;
496 resource->wakeup_enabled = true;
498 if (system_level > resource->system_level)
499 system_level = resource->system_level;
501 mutex_unlock(&resource->resource_lock);
503 *system_level_p = system_level;
507 /* --------------------------------------------------------------------------
508 Device Power Management
509 -------------------------------------------------------------------------- */
512 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
513 * ACPI 3.0) _PSW (Power State Wake)
514 * @dev: Device to handle.
515 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
516 * @sleep_state: Target sleep state of the system.
517 * @dev_state: Target power state of the device.
519 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
520 * State Wake) for the device, if present. On failure reset the device's
521 * wakeup.flags.valid flag.
524 * 0 if either _DSW or _PSW has been successfully executed
525 * 0 if neither _DSW nor _PSW has been found
526 * -ENODEV if the execution of either _DSW or _PSW has failed
528 int acpi_device_sleep_wake(struct acpi_device *dev,
529 int enable, int sleep_state, int dev_state)
531 union acpi_object in_arg[3];
532 struct acpi_object_list arg_list = { 3, in_arg };
533 acpi_status status = AE_OK;
536 * Try to execute _DSW first.
538 * Three agruments are needed for the _DSW object:
539 * Argument 0: enable/disable the wake capabilities
540 * Argument 1: target system state
541 * Argument 2: target device state
542 * When _DSW object is called to disable the wake capabilities, maybe
543 * the first argument is filled. The values of the other two agruments
546 in_arg[0].type = ACPI_TYPE_INTEGER;
547 in_arg[0].integer.value = enable;
548 in_arg[1].type = ACPI_TYPE_INTEGER;
549 in_arg[1].integer.value = sleep_state;
550 in_arg[2].type = ACPI_TYPE_INTEGER;
551 in_arg[2].integer.value = dev_state;
552 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
553 if (ACPI_SUCCESS(status)) {
555 } else if (status != AE_NOT_FOUND) {
556 printk(KERN_ERR PREFIX "_DSW execution failed\n");
557 dev->wakeup.flags.valid = 0;
562 status = acpi_execute_simple_method(dev->handle, "_PSW", enable);
563 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
564 printk(KERN_ERR PREFIX "_PSW execution failed\n");
565 dev->wakeup.flags.valid = 0;
573 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
574 * 1. Power on the power resources required for the wakeup device
575 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
576 * State Wake) for the device, if present
578 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
580 struct acpi_power_resource_entry *entry;
583 if (!dev || !dev->wakeup.flags.valid)
586 mutex_lock(&acpi_device_lock);
588 if (dev->wakeup.prepare_count++)
591 list_for_each_entry(entry, &dev->wakeup.resources, node) {
592 struct acpi_power_resource *resource = entry->resource;
594 mutex_lock(&resource->resource_lock);
596 if (!resource->wakeup_enabled) {
597 err = acpi_power_on_unlocked(resource);
599 resource->wakeup_enabled = true;
602 mutex_unlock(&resource->resource_lock);
606 "Cannot turn wakeup power resources on\n");
607 dev->wakeup.flags.valid = 0;
612 * Passing 3 as the third argument below means the device may be
613 * put into arbitrary power state afterward.
615 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
617 dev->wakeup.prepare_count = 0;
620 mutex_unlock(&acpi_device_lock);
625 * Shutdown a wakeup device, counterpart of above method
626 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
627 * State Wake) for the device, if present
628 * 2. Shutdown down the power resources
630 int acpi_disable_wakeup_device_power(struct acpi_device *dev)
632 struct acpi_power_resource_entry *entry;
635 if (!dev || !dev->wakeup.flags.valid)
638 mutex_lock(&acpi_device_lock);
640 if (--dev->wakeup.prepare_count > 0)
644 * Executing the code below even if prepare_count is already zero when
645 * the function is called may be useful, for example for initialisation.
647 if (dev->wakeup.prepare_count < 0)
648 dev->wakeup.prepare_count = 0;
650 err = acpi_device_sleep_wake(dev, 0, 0, 0);
654 list_for_each_entry(entry, &dev->wakeup.resources, node) {
655 struct acpi_power_resource *resource = entry->resource;
657 mutex_lock(&resource->resource_lock);
659 if (resource->wakeup_enabled) {
660 err = acpi_power_off_unlocked(resource);
662 resource->wakeup_enabled = false;
665 mutex_unlock(&resource->resource_lock);
669 "Cannot turn wakeup power resources off\n");
670 dev->wakeup.flags.valid = 0;
676 mutex_unlock(&acpi_device_lock);
680 int acpi_power_get_inferred_state(struct acpi_device *device, int *state)
686 if (!device || !state)
690 * We know a device's inferred power state when all the resources
691 * required for a given D-state are 'on'.
693 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
694 struct list_head *list = &device->power.states[i].resources;
696 if (list_empty(list))
699 result = acpi_power_get_list_state(list, &list_state);
703 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
709 *state = device->power.states[ACPI_STATE_D3_COLD].flags.valid ?
710 ACPI_STATE_D3_COLD : ACPI_STATE_D3_HOT;
714 int acpi_power_on_resources(struct acpi_device *device, int state)
716 if (!device || state < ACPI_STATE_D0 || state > ACPI_STATE_D3_HOT)
719 return acpi_power_on_list(&device->power.states[state].resources);
722 int acpi_power_transition(struct acpi_device *device, int state)
726 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
729 if (device->power.state == state || !device->flags.power_manageable)
732 if ((device->power.state < ACPI_STATE_D0)
733 || (device->power.state > ACPI_STATE_D3_COLD))
737 * First we reference all power resources required in the target list
738 * (e.g. so the device doesn't lose power while transitioning). Then,
739 * we dereference all power resources used in the current list.
741 if (state < ACPI_STATE_D3_COLD)
742 result = acpi_power_on_list(
743 &device->power.states[state].resources);
745 if (!result && device->power.state < ACPI_STATE_D3_COLD)
747 &device->power.states[device->power.state].resources);
749 /* We shouldn't change the state unless the above operations succeed. */
750 device->power.state = result ? ACPI_STATE_UNKNOWN : state;
755 static void acpi_release_power_resource(struct device *dev)
757 struct acpi_device *device = to_acpi_device(dev);
758 struct acpi_power_resource *resource;
760 resource = container_of(device, struct acpi_power_resource, device);
762 mutex_lock(&power_resource_list_lock);
763 list_del(&resource->list_node);
764 mutex_unlock(&power_resource_list_lock);
766 acpi_free_pnp_ids(&device->pnp);
770 static ssize_t acpi_power_in_use_show(struct device *dev,
771 struct device_attribute *attr,
773 struct acpi_power_resource *resource;
775 resource = to_power_resource(to_acpi_device(dev));
776 return sprintf(buf, "%u\n", !!resource->ref_count);
778 static DEVICE_ATTR(resource_in_use, 0444, acpi_power_in_use_show, NULL);
780 static void acpi_power_sysfs_remove(struct acpi_device *device)
782 device_remove_file(&device->dev, &dev_attr_resource_in_use);
785 static void acpi_power_add_resource_to_list(struct acpi_power_resource *resource)
787 mutex_lock(&power_resource_list_lock);
789 if (!list_empty(&acpi_power_resource_list)) {
790 struct acpi_power_resource *r;
792 list_for_each_entry(r, &acpi_power_resource_list, list_node)
793 if (r->order > resource->order) {
794 list_add_tail(&resource->list_node, &r->list_node);
798 list_add_tail(&resource->list_node, &acpi_power_resource_list);
801 mutex_unlock(&power_resource_list_lock);
804 int acpi_add_power_resource(acpi_handle handle)
806 struct acpi_power_resource *resource;
807 struct acpi_device *device = NULL;
808 union acpi_object acpi_object;
809 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
811 int state, result = -ENODEV;
813 acpi_bus_get_device(handle, &device);
817 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
821 device = &resource->device;
822 acpi_init_device_object(device, handle, ACPI_BUS_TYPE_POWER,
824 mutex_init(&resource->resource_lock);
825 INIT_LIST_HEAD(&resource->list_node);
826 resource->name = device->pnp.bus_id;
827 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
828 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
829 device->power.state = ACPI_STATE_UNKNOWN;
831 /* Evalute the object to get the system level and resource order. */
832 status = acpi_evaluate_object(handle, NULL, NULL, &buffer);
833 if (ACPI_FAILURE(status))
836 resource->system_level = acpi_object.power_resource.system_level;
837 resource->order = acpi_object.power_resource.resource_order;
839 result = acpi_power_get_state(handle, &state);
843 printk(KERN_INFO PREFIX "%s [%s] (%s)\n", acpi_device_name(device),
844 acpi_device_bid(device), state ? "on" : "off");
846 device->flags.match_driver = true;
847 result = acpi_device_add(device, acpi_release_power_resource);
851 if (!device_create_file(&device->dev, &dev_attr_resource_in_use))
852 device->remove = acpi_power_sysfs_remove;
854 acpi_power_add_resource_to_list(resource);
855 acpi_device_add_finalize(device);
859 acpi_release_power_resource(&device->dev);
863 #ifdef CONFIG_ACPI_SLEEP
864 void acpi_resume_power_resources(void)
866 struct acpi_power_resource *resource;
868 mutex_lock(&power_resource_list_lock);
870 list_for_each_entry(resource, &acpi_power_resource_list, list_node) {
873 mutex_lock(&resource->resource_lock);
875 result = acpi_power_get_state(resource->device.handle, &state);
877 mutex_unlock(&resource->resource_lock);
881 if (state == ACPI_POWER_RESOURCE_STATE_OFF
882 && resource->ref_count) {
883 dev_info(&resource->device.dev, "Turning ON\n");
884 __acpi_power_on(resource);
887 mutex_unlock(&resource->resource_lock);
890 mutex_unlock(&power_resource_list_lock);
893 void acpi_turn_off_unused_power_resources(void)
895 struct acpi_power_resource *resource;
897 mutex_lock(&power_resource_list_lock);
899 list_for_each_entry_reverse(resource, &acpi_power_resource_list, list_node) {
902 mutex_lock(&resource->resource_lock);
904 result = acpi_power_get_state(resource->device.handle, &state);
906 mutex_unlock(&resource->resource_lock);
910 if (state == ACPI_POWER_RESOURCE_STATE_ON
911 && !resource->ref_count) {
912 dev_info(&resource->device.dev, "Turning OFF\n");
913 __acpi_power_off(resource);
916 mutex_unlock(&resource->resource_lock);
919 mutex_unlock(&power_resource_list_lock);