2 * acpi_power.c - ACPI Bus Power Management ($Revision: 39 $)
4 * Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
5 * Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
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/proc_fs.h>
43 #include <linux/seq_file.h>
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.h>
47 #define _COMPONENT ACPI_POWER_COMPONENT
48 ACPI_MODULE_NAME("power");
49 #define ACPI_POWER_COMPONENT 0x00800000
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
57 static int acpi_power_add(struct acpi_device *device);
58 static int acpi_power_remove(struct acpi_device *device, int type);
59 static int acpi_power_resume(struct acpi_device *device);
60 static int acpi_power_open_fs(struct inode *inode, struct file *file);
62 static struct acpi_driver acpi_power_driver = {
64 .class = ACPI_POWER_CLASS,
65 .ids = ACPI_POWER_HID,
67 .add = acpi_power_add,
68 .remove = acpi_power_remove,
69 .resume = acpi_power_resume,
73 struct acpi_power_reference {
74 struct list_head node;
75 struct acpi_device *device;
78 struct acpi_power_resource {
79 struct acpi_device * device;
84 struct mutex resource_lock;
85 struct list_head reference;
88 static struct list_head acpi_power_resource_list;
90 static const struct file_operations acpi_power_fops = {
91 .open = acpi_power_open_fs,
94 .release = single_release,
97 /* --------------------------------------------------------------------------
98 Power Resource Management
99 -------------------------------------------------------------------------- */
102 acpi_power_get_context(acpi_handle handle,
103 struct acpi_power_resource **resource)
106 struct acpi_device *device = NULL;
112 result = acpi_bus_get_device(handle, &device);
114 printk(KERN_WARNING PREFIX "Getting context [%p]\n", handle);
118 *resource = acpi_driver_data(device);
125 static int acpi_power_get_state(struct acpi_power_resource *resource)
127 acpi_status status = AE_OK;
128 unsigned long sta = 0;
134 status = acpi_evaluate_integer(resource->device->handle, "_STA", NULL, &sta);
135 if (ACPI_FAILURE(status))
139 resource->state = ACPI_POWER_RESOURCE_STATE_ON;
141 resource->state = ACPI_POWER_RESOURCE_STATE_OFF;
143 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] is %s\n",
144 resource->name, resource->state ? "on" : "off"));
149 static int acpi_power_get_list_state(struct acpi_handle_list *list, int *state)
152 struct acpi_power_resource *resource = NULL;
159 /* The state of the list is 'on' IFF all resources are 'on'. */
161 for (i = 0; i < list->count; i++) {
162 result = acpi_power_get_context(list->handles[i], &resource);
165 result = acpi_power_get_state(resource);
169 *state = resource->state;
171 if (*state != ACPI_POWER_RESOURCE_STATE_ON)
175 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource list is %s\n",
176 *state ? "on" : "off"));
181 static int acpi_power_on(acpi_handle handle, struct acpi_device *dev)
185 acpi_status status = AE_OK;
186 struct acpi_power_resource *resource = NULL;
187 struct list_head *node, *next;
188 struct acpi_power_reference *ref;
191 result = acpi_power_get_context(handle, &resource);
195 mutex_lock(&resource->resource_lock);
196 list_for_each_safe(node, next, &resource->reference) {
197 ref = container_of(node, struct acpi_power_reference, node);
198 if (dev->handle == ref->device->handle) {
199 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] already referenced by resource [%s]\n",
200 dev->pnp.bus_id, resource->name));
207 ref = kmalloc(sizeof (struct acpi_power_reference),
208 irqs_disabled() ? GFP_ATOMIC : GFP_KERNEL);
210 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "kmalloc() failed\n"));
211 mutex_unlock(&resource->resource_lock);
214 list_add_tail(&ref->node, &resource->reference);
216 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] added to resource [%s] references\n",
217 dev->pnp.bus_id, resource->name));
219 mutex_unlock(&resource->resource_lock);
221 if (resource->state == ACPI_POWER_RESOURCE_STATE_ON) {
222 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] already on\n",
227 status = acpi_evaluate_object(resource->device->handle, "_ON", NULL, NULL);
228 if (ACPI_FAILURE(status))
231 result = acpi_power_get_state(resource);
234 if (resource->state != ACPI_POWER_RESOURCE_STATE_ON)
237 /* Update the power resource's _device_ power state */
238 resource->device->power.state = ACPI_STATE_D0;
240 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] turned on\n",
245 static int acpi_power_off_device(acpi_handle handle, struct acpi_device *dev)
248 acpi_status status = AE_OK;
249 struct acpi_power_resource *resource = NULL;
250 struct list_head *node, *next;
251 struct acpi_power_reference *ref;
254 result = acpi_power_get_context(handle, &resource);
258 mutex_lock(&resource->resource_lock);
259 list_for_each_safe(node, next, &resource->reference) {
260 ref = container_of(node, struct acpi_power_reference, node);
261 if (dev->handle == ref->device->handle) {
262 list_del(&ref->node);
264 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] removed from resource [%s] references\n",
265 dev->pnp.bus_id, resource->name));
270 if (!list_empty(&resource->reference)) {
271 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Cannot turn resource [%s] off - resource is in use\n",
273 mutex_unlock(&resource->resource_lock);
276 mutex_unlock(&resource->resource_lock);
278 if (resource->state == ACPI_POWER_RESOURCE_STATE_OFF) {
279 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] already off\n",
284 status = acpi_evaluate_object(resource->device->handle, "_OFF", NULL, NULL);
285 if (ACPI_FAILURE(status))
288 result = acpi_power_get_state(resource);
291 if (resource->state != ACPI_POWER_RESOURCE_STATE_OFF)
294 /* Update the power resource's _device_ power state */
295 resource->device->power.state = ACPI_STATE_D3;
297 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] turned off\n",
304 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
305 * 1. Power on the power resources required for the wakeup device
306 * 2. Enable _PSW (power state wake) for the device if present
308 int acpi_enable_wakeup_device_power(struct acpi_device *dev)
310 union acpi_object arg = { ACPI_TYPE_INTEGER };
311 struct acpi_object_list arg_list = { 1, &arg };
312 acpi_status status = AE_OK;
316 if (!dev || !dev->wakeup.flags.valid)
319 arg.integer.value = 1;
320 /* Open power resource */
321 for (i = 0; i < dev->wakeup.resources.count; i++) {
322 ret = acpi_power_on(dev->wakeup.resources.handles[i], dev);
324 printk(KERN_ERR PREFIX "Transition power state\n");
325 dev->wakeup.flags.valid = 0;
331 status = acpi_evaluate_object(dev->handle, "_PSW", &arg_list, NULL);
332 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
333 printk(KERN_ERR PREFIX "Evaluate _PSW\n");
334 dev->wakeup.flags.valid = 0;
342 * Shutdown a wakeup device, counterpart of above method
343 * 1. Disable _PSW (power state wake)
344 * 2. Shutdown down the power resources
346 int acpi_disable_wakeup_device_power(struct acpi_device *dev)
348 union acpi_object arg = { ACPI_TYPE_INTEGER };
349 struct acpi_object_list arg_list = { 1, &arg };
350 acpi_status status = AE_OK;
355 if (!dev || !dev->wakeup.flags.valid)
358 arg.integer.value = 0;
360 status = acpi_evaluate_object(dev->handle, "_PSW", &arg_list, NULL);
361 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
362 printk(KERN_ERR PREFIX "Evaluate _PSW\n");
363 dev->wakeup.flags.valid = 0;
367 /* Close power resource */
368 for (i = 0; i < dev->wakeup.resources.count; i++) {
369 ret = acpi_power_off_device(dev->wakeup.resources.handles[i], dev);
371 printk(KERN_ERR PREFIX "Transition power state\n");
372 dev->wakeup.flags.valid = 0;
380 /* --------------------------------------------------------------------------
381 Device Power Management
382 -------------------------------------------------------------------------- */
384 int acpi_power_get_inferred_state(struct acpi_device *device)
387 struct acpi_handle_list *list = NULL;
395 device->power.state = ACPI_STATE_UNKNOWN;
398 * We know a device's inferred power state when all the resources
399 * required for a given D-state are 'on'.
401 for (i = ACPI_STATE_D0; i < ACPI_STATE_D3; i++) {
402 list = &device->power.states[i].resources;
406 result = acpi_power_get_list_state(list, &list_state);
410 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
411 device->power.state = i;
416 device->power.state = ACPI_STATE_D3;
421 int acpi_power_transition(struct acpi_device *device, int state)
424 struct acpi_handle_list *cl = NULL; /* Current Resources */
425 struct acpi_handle_list *tl = NULL; /* Target Resources */
429 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3))
432 if ((device->power.state < ACPI_STATE_D0)
433 || (device->power.state > ACPI_STATE_D3))
436 cl = &device->power.states[device->power.state].resources;
437 tl = &device->power.states[state].resources;
439 device->power.state = ACPI_STATE_UNKNOWN;
441 if (!cl->count && !tl->count) {
446 /* TBD: Resources must be ordered. */
449 * First we reference all power resources required in the target list
450 * (e.g. so the device doesn't lose power while transitioning).
452 for (i = 0; i < tl->count; i++) {
453 result = acpi_power_on(tl->handles[i], device);
458 if (device->power.state == state) {
463 * Then we dereference all power resources used in the current list.
465 for (i = 0; i < cl->count; i++) {
466 result = acpi_power_off_device(cl->handles[i], device);
471 /* We shouldn't change the state till all above operations succeed */
472 device->power.state = state;
475 printk(KERN_WARNING PREFIX "Transitioning device [%s] to D%d\n",
476 device->pnp.bus_id, state);
481 /* --------------------------------------------------------------------------
483 -------------------------------------------------------------------------- */
485 static struct proc_dir_entry *acpi_power_dir;
487 static int acpi_power_seq_show(struct seq_file *seq, void *offset)
491 struct acpi_power_resource *resource = NULL;
492 struct list_head *node, *next;
493 struct acpi_power_reference *ref;
496 resource = seq->private;
501 result = acpi_power_get_state(resource);
505 seq_puts(seq, "state: ");
506 switch (resource->state) {
507 case ACPI_POWER_RESOURCE_STATE_ON:
508 seq_puts(seq, "on\n");
510 case ACPI_POWER_RESOURCE_STATE_OFF:
511 seq_puts(seq, "off\n");
514 seq_puts(seq, "unknown\n");
518 mutex_lock(&resource->resource_lock);
519 list_for_each_safe(node, next, &resource->reference) {
520 ref = container_of(node, struct acpi_power_reference, node);
523 mutex_unlock(&resource->resource_lock);
525 seq_printf(seq, "system level: S%d\n"
527 "reference count: %d\n",
528 resource->system_level,
529 resource->order, count);
535 static int acpi_power_open_fs(struct inode *inode, struct file *file)
537 return single_open(file, acpi_power_seq_show, PDE(inode)->data);
540 static int acpi_power_add_fs(struct acpi_device *device)
542 struct proc_dir_entry *entry = NULL;
548 if (!acpi_device_dir(device)) {
549 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
551 if (!acpi_device_dir(device))
556 entry = create_proc_entry(ACPI_POWER_FILE_STATUS,
557 S_IRUGO, acpi_device_dir(device));
561 entry->proc_fops = &acpi_power_fops;
562 entry->data = acpi_driver_data(device);
568 static int acpi_power_remove_fs(struct acpi_device *device)
571 if (acpi_device_dir(device)) {
572 remove_proc_entry(ACPI_POWER_FILE_STATUS,
573 acpi_device_dir(device));
574 remove_proc_entry(acpi_device_bid(device), acpi_power_dir);
575 acpi_device_dir(device) = NULL;
581 /* --------------------------------------------------------------------------
583 -------------------------------------------------------------------------- */
585 static int acpi_power_add(struct acpi_device *device)
588 acpi_status status = AE_OK;
589 struct acpi_power_resource *resource = NULL;
590 union acpi_object acpi_object;
591 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
597 resource = kzalloc(sizeof(struct acpi_power_resource), GFP_KERNEL);
601 resource->device = device;
602 mutex_init(&resource->resource_lock);
603 INIT_LIST_HEAD(&resource->reference);
604 strcpy(resource->name, device->pnp.bus_id);
605 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
606 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
607 acpi_driver_data(device) = resource;
609 /* Evalute the object to get the system level and resource order. */
610 status = acpi_evaluate_object(device->handle, NULL, NULL, &buffer);
611 if (ACPI_FAILURE(status)) {
615 resource->system_level = acpi_object.power_resource.system_level;
616 resource->order = acpi_object.power_resource.resource_order;
618 result = acpi_power_get_state(resource);
622 switch (resource->state) {
623 case ACPI_POWER_RESOURCE_STATE_ON:
624 device->power.state = ACPI_STATE_D0;
626 case ACPI_POWER_RESOURCE_STATE_OFF:
627 device->power.state = ACPI_STATE_D3;
630 device->power.state = ACPI_STATE_UNKNOWN;
634 result = acpi_power_add_fs(device);
638 printk(KERN_INFO PREFIX "%s [%s] (%s)\n", acpi_device_name(device),
639 acpi_device_bid(device), resource->state ? "on" : "off");
648 static int acpi_power_remove(struct acpi_device *device, int type)
650 struct acpi_power_resource *resource = NULL;
651 struct list_head *node, *next;
654 if (!device || !acpi_driver_data(device))
657 resource = acpi_driver_data(device);
659 acpi_power_remove_fs(device);
661 mutex_lock(&resource->resource_lock);
662 list_for_each_safe(node, next, &resource->reference) {
663 struct acpi_power_reference *ref = container_of(node, struct acpi_power_reference, node);
664 list_del(&ref->node);
667 mutex_unlock(&resource->resource_lock);
674 static int acpi_power_resume(struct acpi_device *device)
677 struct acpi_power_resource *resource = NULL;
678 struct acpi_power_reference *ref;
680 if (!device || !acpi_driver_data(device))
683 resource = (struct acpi_power_resource *)acpi_driver_data(device);
685 result = acpi_power_get_state(resource);
689 mutex_lock(&resource->resource_lock);
690 if ((resource->state == ACPI_POWER_RESOURCE_STATE_ON) &&
691 list_empty(&resource->reference)) {
692 mutex_unlock(&resource->resource_lock);
693 result = acpi_power_off_device(device->handle, NULL);
697 if ((resource->state == ACPI_POWER_RESOURCE_STATE_OFF) &&
698 !list_empty(&resource->reference)) {
699 ref = container_of(resource->reference.next, struct acpi_power_reference, node);
700 mutex_unlock(&resource->resource_lock);
701 result = acpi_power_on(device->handle, ref->device);
705 mutex_unlock(&resource->resource_lock);
709 static int __init acpi_power_init(void)
717 INIT_LIST_HEAD(&acpi_power_resource_list);
719 acpi_power_dir = proc_mkdir(ACPI_POWER_CLASS, acpi_root_dir);
723 result = acpi_bus_register_driver(&acpi_power_driver);
725 remove_proc_entry(ACPI_POWER_CLASS, acpi_root_dir);
732 subsys_initcall(acpi_power_init);