2 * acpi_power.c - ACPI Bus Power Management ($Revision: 39 $)
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or (at
12 * your option) any later version.
14 * This program is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 * ACPI power-managed devices may be controlled in two ways:
28 * 1. via "Device Specific (D-State) Control"
29 * 2. via "Power Resource Control".
30 * This module is used to manage devices relying on Power Resource Control.
32 * An ACPI "power resource object" describes a software controllable power
33 * plane, clock plane, or other resource used by a power managed device.
34 * A device may rely on multiple power resources, and a power resource
35 * may be shared by multiple devices.
38 #include <linux/kernel.h>
39 #include <linux/module.h>
40 #include <linux/init.h>
41 #include <linux/types.h>
42 #include <linux/slab.h>
43 #include <linux/pm_runtime.h>
44 #include <linux/sysfs.h>
45 #include <linux/acpi.h>
49 #define PREFIX "ACPI: "
51 #define _COMPONENT ACPI_POWER_COMPONENT
52 ACPI_MODULE_NAME("power");
53 #define ACPI_POWER_CLASS "power_resource"
54 #define ACPI_POWER_DEVICE_NAME "Power Resource"
55 #define ACPI_POWER_FILE_INFO "info"
56 #define ACPI_POWER_FILE_STATUS "state"
57 #define ACPI_POWER_RESOURCE_STATE_OFF 0x00
58 #define ACPI_POWER_RESOURCE_STATE_ON 0x01
59 #define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
61 struct acpi_power_resource {
62 struct acpi_device device;
63 struct list_head list_node;
67 unsigned int ref_count;
69 struct mutex resource_lock;
72 struct acpi_power_resource_entry {
73 struct list_head node;
74 struct acpi_power_resource *resource;
77 static LIST_HEAD(acpi_power_resource_list);
78 static DEFINE_MUTEX(power_resource_list_lock);
80 /* --------------------------------------------------------------------------
81 Power Resource Management
82 -------------------------------------------------------------------------- */
85 struct acpi_power_resource *to_power_resource(struct acpi_device *device)
87 return container_of(device, struct acpi_power_resource, device);
90 static struct acpi_power_resource *acpi_power_get_context(acpi_handle handle)
92 struct acpi_device *device;
94 if (acpi_bus_get_device(handle, &device))
97 return to_power_resource(device);
100 static int acpi_power_resources_list_add(acpi_handle handle,
101 struct list_head *list)
103 struct acpi_power_resource *resource = acpi_power_get_context(handle);
104 struct acpi_power_resource_entry *entry;
106 if (!resource || !list)
109 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
113 entry->resource = resource;
114 if (!list_empty(list)) {
115 struct acpi_power_resource_entry *e;
117 list_for_each_entry(e, list, node)
118 if (e->resource->order > resource->order) {
119 list_add_tail(&entry->node, &e->node);
123 list_add_tail(&entry->node, list);
127 void acpi_power_resources_list_free(struct list_head *list)
129 struct acpi_power_resource_entry *entry, *e;
131 list_for_each_entry_safe(entry, e, list, node) {
132 list_del(&entry->node);
137 int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
138 struct list_head *list)
143 for (i = start; i < package->package.count; i++) {
144 union acpi_object *element = &package->package.elements[i];
147 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
151 rhandle = element->reference.handle;
156 err = acpi_add_power_resource(rhandle);
160 err = acpi_power_resources_list_add(rhandle, list);
165 acpi_power_resources_list_free(list);
170 static int acpi_power_get_state(acpi_handle handle, int *state)
172 acpi_status status = AE_OK;
173 unsigned long long sta = 0;
175 struct acpi_buffer buffer = { sizeof(node_name), node_name };
178 if (!handle || !state)
181 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
182 if (ACPI_FAILURE(status))
185 *state = (sta & 0x01)?ACPI_POWER_RESOURCE_STATE_ON:
186 ACPI_POWER_RESOURCE_STATE_OFF;
188 acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
190 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] is %s\n",
192 *state ? "on" : "off"));
197 static int acpi_power_get_list_state(struct list_head *list, int *state)
199 struct acpi_power_resource_entry *entry;
205 /* The state of the list is 'on' IFF all resources are 'on'. */
206 list_for_each_entry(entry, list, node) {
207 struct acpi_power_resource *resource = entry->resource;
208 acpi_handle handle = resource->device.handle;
211 mutex_lock(&resource->resource_lock);
212 result = acpi_power_get_state(handle, &cur_state);
213 mutex_unlock(&resource->resource_lock);
217 if (cur_state != ACPI_POWER_RESOURCE_STATE_ON)
221 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource list is %s\n",
222 cur_state ? "on" : "off"));
228 static int __acpi_power_on(struct acpi_power_resource *resource)
230 acpi_status status = AE_OK;
232 status = acpi_evaluate_object(resource->device.handle, "_ON", NULL, NULL);
233 if (ACPI_FAILURE(status))
236 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned on\n",
242 static int acpi_power_on_unlocked(struct acpi_power_resource *resource)
246 if (resource->ref_count++) {
247 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
248 "Power resource [%s] already on\n",
251 result = __acpi_power_on(resource);
253 resource->ref_count--;
258 static int acpi_power_on(struct acpi_power_resource *resource)
262 mutex_lock(&resource->resource_lock);
263 result = acpi_power_on_unlocked(resource);
264 mutex_unlock(&resource->resource_lock);
268 static int __acpi_power_off(struct acpi_power_resource *resource)
272 status = acpi_evaluate_object(resource->device.handle, "_OFF",
274 if (ACPI_FAILURE(status))
277 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Power resource [%s] turned off\n",
282 static int acpi_power_off_unlocked(struct acpi_power_resource *resource)
286 if (!resource->ref_count) {
287 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
288 "Power resource [%s] already off\n",
293 if (--resource->ref_count) {
294 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
295 "Power resource [%s] still in use\n",
298 result = __acpi_power_off(resource);
300 resource->ref_count++;
305 static int acpi_power_off(struct acpi_power_resource *resource)
309 mutex_lock(&resource->resource_lock);
310 result = acpi_power_off_unlocked(resource);
311 mutex_unlock(&resource->resource_lock);
315 static int acpi_power_off_list(struct list_head *list)
317 struct acpi_power_resource_entry *entry;
320 list_for_each_entry_reverse(entry, list, node) {
321 result = acpi_power_off(entry->resource);
328 list_for_each_entry_continue(entry, list, node)
329 acpi_power_on(entry->resource);
334 static int acpi_power_on_list(struct list_head *list)
336 struct acpi_power_resource_entry *entry;
339 list_for_each_entry(entry, list, node) {
340 result = acpi_power_on(entry->resource);
347 list_for_each_entry_continue_reverse(entry, list, node)
348 acpi_power_off(entry->resource);
353 static struct attribute *attrs[] = {
357 static struct attribute_group attr_groups[] = {
359 .name = "power_resources_D0",
363 .name = "power_resources_D1",
367 .name = "power_resources_D2",
370 [ACPI_STATE_D3_HOT] = {
371 .name = "power_resources_D3hot",
376 static struct attribute_group wakeup_attr_group = {
377 .name = "power_resources_wakeup",
381 static void acpi_power_hide_list(struct acpi_device *adev,
382 struct list_head *resources,
383 struct attribute_group *attr_group)
385 struct acpi_power_resource_entry *entry;
387 if (list_empty(resources))
390 list_for_each_entry_reverse(entry, resources, node) {
391 struct acpi_device *res_dev = &entry->resource->device;
393 sysfs_remove_link_from_group(&adev->dev.kobj,
395 dev_name(&res_dev->dev));
397 sysfs_remove_group(&adev->dev.kobj, attr_group);
400 static void acpi_power_expose_list(struct acpi_device *adev,
401 struct list_head *resources,
402 struct attribute_group *attr_group)
404 struct acpi_power_resource_entry *entry;
407 if (list_empty(resources))
410 ret = sysfs_create_group(&adev->dev.kobj, attr_group);
414 list_for_each_entry(entry, resources, node) {
415 struct acpi_device *res_dev = &entry->resource->device;
417 ret = sysfs_add_link_to_group(&adev->dev.kobj,
420 dev_name(&res_dev->dev));
422 acpi_power_hide_list(adev, resources, attr_group);
428 static void acpi_power_expose_hide(struct acpi_device *adev,
429 struct list_head *resources,
430 struct attribute_group *attr_group,
434 acpi_power_expose_list(adev, resources, attr_group);
436 acpi_power_hide_list(adev, resources, attr_group);
439 void acpi_power_add_remove_device(struct acpi_device *adev, bool add)
443 if (adev->wakeup.flags.valid)
444 acpi_power_expose_hide(adev, &adev->wakeup.resources,
445 &wakeup_attr_group, add);
447 if (!adev->power.flags.power_resources)
450 for (state = ACPI_STATE_D0; state <= ACPI_STATE_D3_HOT; state++)
451 acpi_power_expose_hide(adev,
452 &adev->power.states[state].resources,
453 &attr_groups[state], add);
456 int acpi_power_wakeup_list_init(struct list_head *list, int *system_level_p)
458 struct acpi_power_resource_entry *entry;
459 int system_level = 5;
461 list_for_each_entry(entry, list, node) {
462 struct acpi_power_resource *resource = entry->resource;
463 acpi_handle handle = resource->device.handle;
467 mutex_lock(&resource->resource_lock);
469 result = acpi_power_get_state(handle, &state);
471 mutex_unlock(&resource->resource_lock);
474 if (state == ACPI_POWER_RESOURCE_STATE_ON) {
475 resource->ref_count++;
476 resource->wakeup_enabled = true;
478 if (system_level > resource->system_level)
479 system_level = resource->system_level;
481 mutex_unlock(&resource->resource_lock);
483 *system_level_p = system_level;
487 /* --------------------------------------------------------------------------
488 Device Power Management
489 -------------------------------------------------------------------------- */
492 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
493 * ACPI 3.0) _PSW (Power State Wake)
494 * @dev: Device to handle.
495 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
496 * @sleep_state: Target sleep state of the system.
497 * @dev_state: Target power state of the device.
499 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
500 * State Wake) for the device, if present. On failure reset the device's
501 * wakeup.flags.valid flag.
504 * 0 if either _DSW or _PSW has been successfully executed
505 * 0 if neither _DSW nor _PSW has been found
506 * -ENODEV if the execution of either _DSW or _PSW has failed
508 int acpi_device_sleep_wake(struct acpi_device *dev,
509 int enable, int sleep_state, int dev_state)
511 union acpi_object in_arg[3];
512 struct acpi_object_list arg_list = { 3, in_arg };
513 acpi_status status = AE_OK;
516 * Try to execute _DSW first.
518 * Three agruments are needed for the _DSW object:
519 * Argument 0: enable/disable the wake capabilities
520 * Argument 1: target system state
521 * Argument 2: target device state
522 * When _DSW object is called to disable the wake capabilities, maybe
523 * the first argument is filled. The values of the other two agruments
526 in_arg[0].type = ACPI_TYPE_INTEGER;
527 in_arg[0].integer.value = enable;
528 in_arg[1].type = ACPI_TYPE_INTEGER;
529 in_arg[1].integer.value = sleep_state;
530 in_arg[2].type = ACPI_TYPE_INTEGER;
531 in_arg[2].integer.value = dev_state;
532 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
533 if (ACPI_SUCCESS(status)) {
535 } else if (status != AE_NOT_FOUND) {
536 printk(KERN_ERR PREFIX "_DSW execution failed\n");
537 dev->wakeup.flags.valid = 0;
542 status = acpi_execute_simple_method(dev->handle, "_PSW", enable);
543 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
544 printk(KERN_ERR PREFIX "_PSW execution failed\n");
545 dev->wakeup.flags.valid = 0;
553 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
554 * 1. Power on the power resources required for the wakeup device
555 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
556 * State Wake) for the device, if present
558 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
560 struct acpi_power_resource_entry *entry;
563 if (!dev || !dev->wakeup.flags.valid)
566 mutex_lock(&acpi_device_lock);
568 if (dev->wakeup.prepare_count++)
571 list_for_each_entry(entry, &dev->wakeup.resources, node) {
572 struct acpi_power_resource *resource = entry->resource;
574 mutex_lock(&resource->resource_lock);
576 if (!resource->wakeup_enabled) {
577 err = acpi_power_on_unlocked(resource);
579 resource->wakeup_enabled = true;
582 mutex_unlock(&resource->resource_lock);
586 "Cannot turn wakeup power resources on\n");
587 dev->wakeup.flags.valid = 0;
592 * Passing 3 as the third argument below means the device may be
593 * put into arbitrary power state afterward.
595 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
597 dev->wakeup.prepare_count = 0;
600 mutex_unlock(&acpi_device_lock);
605 * Shutdown a wakeup device, counterpart of above method
606 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
607 * State Wake) for the device, if present
608 * 2. Shutdown down the power resources
610 int acpi_disable_wakeup_device_power(struct acpi_device *dev)
612 struct acpi_power_resource_entry *entry;
615 if (!dev || !dev->wakeup.flags.valid)
618 mutex_lock(&acpi_device_lock);
620 if (--dev->wakeup.prepare_count > 0)
624 * Executing the code below even if prepare_count is already zero when
625 * the function is called may be useful, for example for initialisation.
627 if (dev->wakeup.prepare_count < 0)
628 dev->wakeup.prepare_count = 0;
630 err = acpi_device_sleep_wake(dev, 0, 0, 0);
634 list_for_each_entry(entry, &dev->wakeup.resources, node) {
635 struct acpi_power_resource *resource = entry->resource;
637 mutex_lock(&resource->resource_lock);
639 if (resource->wakeup_enabled) {
640 err = acpi_power_off_unlocked(resource);
642 resource->wakeup_enabled = false;
645 mutex_unlock(&resource->resource_lock);
649 "Cannot turn wakeup power resources off\n");
650 dev->wakeup.flags.valid = 0;
656 mutex_unlock(&acpi_device_lock);
660 int acpi_power_get_inferred_state(struct acpi_device *device, int *state)
666 if (!device || !state)
670 * We know a device's inferred power state when all the resources
671 * required for a given D-state are 'on'.
673 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
674 struct list_head *list = &device->power.states[i].resources;
676 if (list_empty(list))
679 result = acpi_power_get_list_state(list, &list_state);
683 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
689 *state = ACPI_STATE_D3_COLD;
693 int acpi_power_on_resources(struct acpi_device *device, int state)
695 if (!device || state < ACPI_STATE_D0 || state > ACPI_STATE_D3_HOT)
698 return acpi_power_on_list(&device->power.states[state].resources);
701 int acpi_power_transition(struct acpi_device *device, int state)
705 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
708 if (device->power.state == state || !device->flags.power_manageable)
711 if ((device->power.state < ACPI_STATE_D0)
712 || (device->power.state > ACPI_STATE_D3_COLD))
715 /* TBD: Resources must be ordered. */
718 * First we reference all power resources required in the target list
719 * (e.g. so the device doesn't lose power while transitioning). Then,
720 * we dereference all power resources used in the current list.
722 if (state < ACPI_STATE_D3_COLD)
723 result = acpi_power_on_list(
724 &device->power.states[state].resources);
726 if (!result && device->power.state < ACPI_STATE_D3_COLD)
728 &device->power.states[device->power.state].resources);
730 /* We shouldn't change the state unless the above operations succeed. */
731 device->power.state = result ? ACPI_STATE_UNKNOWN : state;
736 static void acpi_release_power_resource(struct device *dev)
738 struct acpi_device *device = to_acpi_device(dev);
739 struct acpi_power_resource *resource;
741 resource = container_of(device, struct acpi_power_resource, device);
743 mutex_lock(&power_resource_list_lock);
744 list_del(&resource->list_node);
745 mutex_unlock(&power_resource_list_lock);
747 acpi_free_pnp_ids(&device->pnp);
751 static ssize_t acpi_power_in_use_show(struct device *dev,
752 struct device_attribute *attr,
754 struct acpi_power_resource *resource;
756 resource = to_power_resource(to_acpi_device(dev));
757 return sprintf(buf, "%u\n", !!resource->ref_count);
759 static DEVICE_ATTR(resource_in_use, 0444, acpi_power_in_use_show, NULL);
761 static void acpi_power_sysfs_remove(struct acpi_device *device)
763 device_remove_file(&device->dev, &dev_attr_resource_in_use);
766 int acpi_add_power_resource(acpi_handle handle)
768 struct acpi_power_resource *resource;
769 struct acpi_device *device = NULL;
770 union acpi_object acpi_object;
771 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
773 int state, result = -ENODEV;
775 acpi_bus_get_device(handle, &device);
779 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
783 device = &resource->device;
784 acpi_init_device_object(device, handle, ACPI_BUS_TYPE_POWER,
786 mutex_init(&resource->resource_lock);
787 INIT_LIST_HEAD(&resource->list_node);
788 resource->name = device->pnp.bus_id;
789 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
790 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
791 device->power.state = ACPI_STATE_UNKNOWN;
793 /* Evalute the object to get the system level and resource order. */
794 status = acpi_evaluate_object(handle, NULL, NULL, &buffer);
795 if (ACPI_FAILURE(status))
798 resource->system_level = acpi_object.power_resource.system_level;
799 resource->order = acpi_object.power_resource.resource_order;
801 result = acpi_power_get_state(handle, &state);
805 printk(KERN_INFO PREFIX "%s [%s] (%s)\n", acpi_device_name(device),
806 acpi_device_bid(device), state ? "on" : "off");
808 device->flags.match_driver = true;
809 result = acpi_device_add(device, acpi_release_power_resource);
813 if (!device_create_file(&device->dev, &dev_attr_resource_in_use))
814 device->remove = acpi_power_sysfs_remove;
816 mutex_lock(&power_resource_list_lock);
817 list_add(&resource->list_node, &acpi_power_resource_list);
818 mutex_unlock(&power_resource_list_lock);
819 acpi_device_add_finalize(device);
823 acpi_release_power_resource(&device->dev);
827 #ifdef CONFIG_ACPI_SLEEP
828 void acpi_resume_power_resources(void)
830 struct acpi_power_resource *resource;
832 mutex_lock(&power_resource_list_lock);
834 list_for_each_entry(resource, &acpi_power_resource_list, list_node) {
837 mutex_lock(&resource->resource_lock);
839 result = acpi_power_get_state(resource->device.handle, &state);
841 mutex_unlock(&resource->resource_lock);
845 if (state == ACPI_POWER_RESOURCE_STATE_OFF
846 && resource->ref_count) {
847 dev_info(&resource->device.dev, "Turning ON\n");
848 __acpi_power_on(resource);
849 } else if (state == ACPI_POWER_RESOURCE_STATE_ON
850 && !resource->ref_count) {
851 dev_info(&resource->device.dev, "Turning OFF\n");
852 __acpi_power_off(resource);
855 mutex_unlock(&resource->resource_lock);
858 mutex_unlock(&power_resource_list_lock);