Merge branch 'master' of /pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / acpi / power.c
blob56665a63bf19b29f86c4088f02cd0ff8c7ad9faa
1 /*
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_CLASS "power_resource"
50 #define ACPI_POWER_DEVICE_NAME "Power Resource"
51 #define ACPI_POWER_FILE_INFO "info"
52 #define ACPI_POWER_FILE_STATUS "state"
53 #define ACPI_POWER_RESOURCE_STATE_OFF 0x00
54 #define ACPI_POWER_RESOURCE_STATE_ON 0x01
55 #define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
57 int acpi_power_nocheck;
58 module_param_named(power_nocheck, acpi_power_nocheck, bool, 000);
60 static int acpi_power_add(struct acpi_device *device);
61 static int acpi_power_remove(struct acpi_device *device, int type);
62 static int acpi_power_resume(struct acpi_device *device);
63 static int acpi_power_open_fs(struct inode *inode, struct file *file);
65 static struct acpi_device_id power_device_ids[] = {
66 {ACPI_POWER_HID, 0},
67 {"", 0},
69 MODULE_DEVICE_TABLE(acpi, power_device_ids);
71 static struct acpi_driver acpi_power_driver = {
72 .name = "power",
73 .class = ACPI_POWER_CLASS,
74 .ids = power_device_ids,
75 .ops = {
76 .add = acpi_power_add,
77 .remove = acpi_power_remove,
78 .resume = acpi_power_resume,
82 struct acpi_power_reference {
83 struct list_head node;
84 struct acpi_device *device;
87 struct acpi_power_resource {
88 struct acpi_device * device;
89 acpi_bus_id name;
90 u32 system_level;
91 u32 order;
92 struct mutex resource_lock;
93 struct list_head reference;
96 static struct list_head acpi_power_resource_list;
98 static const struct file_operations acpi_power_fops = {
99 .owner = THIS_MODULE,
100 .open = acpi_power_open_fs,
101 .read = seq_read,
102 .llseek = seq_lseek,
103 .release = single_release,
106 /* --------------------------------------------------------------------------
107 Power Resource Management
108 -------------------------------------------------------------------------- */
110 static int
111 acpi_power_get_context(acpi_handle handle,
112 struct acpi_power_resource **resource)
114 int result = 0;
115 struct acpi_device *device = NULL;
118 if (!resource)
119 return -ENODEV;
121 result = acpi_bus_get_device(handle, &device);
122 if (result) {
123 printk(KERN_WARNING PREFIX "Getting context [%p]\n", handle);
124 return result;
127 *resource = acpi_driver_data(device);
128 if (!*resource)
129 return -ENODEV;
131 return 0;
134 static int acpi_power_get_state(acpi_handle handle, int *state)
136 acpi_status status = AE_OK;
137 unsigned long long sta = 0;
138 char node_name[5];
139 struct acpi_buffer buffer = { sizeof(node_name), node_name };
142 if (!handle || !state)
143 return -EINVAL;
145 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
146 if (ACPI_FAILURE(status))
147 return -ENODEV;
149 *state = (sta & 0x01)?ACPI_POWER_RESOURCE_STATE_ON:
150 ACPI_POWER_RESOURCE_STATE_OFF;
152 acpi_get_name(handle, ACPI_SINGLE_NAME, &buffer);
154 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] is %s\n",
155 node_name,
156 *state ? "on" : "off"));
158 return 0;
161 static int acpi_power_get_list_state(struct acpi_handle_list *list, int *state)
163 int result = 0, state1;
164 u32 i = 0;
167 if (!list || !state)
168 return -EINVAL;
170 /* The state of the list is 'on' IFF all resources are 'on'. */
171 /* */
173 for (i = 0; i < list->count; i++) {
175 * The state of the power resource can be obtained by
176 * using the ACPI handle. In such case it is unnecessary to
177 * get the Power resource first and then get its state again.
179 result = acpi_power_get_state(list->handles[i], &state1);
180 if (result)
181 return result;
183 *state = state1;
185 if (*state != ACPI_POWER_RESOURCE_STATE_ON)
186 break;
189 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource list is %s\n",
190 *state ? "on" : "off"));
192 return result;
195 static int acpi_power_on(acpi_handle handle, struct acpi_device *dev)
197 int result = 0, state;
198 int found = 0;
199 acpi_status status = AE_OK;
200 struct acpi_power_resource *resource = NULL;
201 struct list_head *node, *next;
202 struct acpi_power_reference *ref;
205 result = acpi_power_get_context(handle, &resource);
206 if (result)
207 return result;
209 mutex_lock(&resource->resource_lock);
210 list_for_each_safe(node, next, &resource->reference) {
211 ref = container_of(node, struct acpi_power_reference, node);
212 if (dev->handle == ref->device->handle) {
213 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] already referenced by resource [%s]\n",
214 dev->pnp.bus_id, resource->name));
215 found = 1;
216 break;
220 if (!found) {
221 ref = kmalloc(sizeof (struct acpi_power_reference),
222 irqs_disabled() ? GFP_ATOMIC : GFP_KERNEL);
223 if (!ref) {
224 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "kmalloc() failed\n"));
225 mutex_unlock(&resource->resource_lock);
226 return -ENOMEM;
228 list_add_tail(&ref->node, &resource->reference);
229 ref->device = dev;
230 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] added to resource [%s] references\n",
231 dev->pnp.bus_id, resource->name));
233 mutex_unlock(&resource->resource_lock);
235 status = acpi_evaluate_object(resource->device->handle, "_ON", NULL, NULL);
236 if (ACPI_FAILURE(status))
237 return -ENODEV;
239 if (!acpi_power_nocheck) {
241 * If acpi_power_nocheck is set, it is unnecessary to check
242 * the power state after power transition.
244 result = acpi_power_get_state(resource->device->handle,
245 &state);
246 if (result)
247 return result;
248 if (state != ACPI_POWER_RESOURCE_STATE_ON)
249 return -ENOEXEC;
251 /* Update the power resource's _device_ power state */
252 resource->device->power.state = ACPI_STATE_D0;
254 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] turned on\n",
255 resource->name));
256 return 0;
259 static int acpi_power_off_device(acpi_handle handle, struct acpi_device *dev)
261 int result = 0, state;
262 acpi_status status = AE_OK;
263 struct acpi_power_resource *resource = NULL;
264 struct list_head *node, *next;
265 struct acpi_power_reference *ref;
268 result = acpi_power_get_context(handle, &resource);
269 if (result)
270 return result;
272 mutex_lock(&resource->resource_lock);
273 list_for_each_safe(node, next, &resource->reference) {
274 ref = container_of(node, struct acpi_power_reference, node);
275 if (dev->handle == ref->device->handle) {
276 list_del(&ref->node);
277 kfree(ref);
278 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Device [%s] removed from resource [%s] references\n",
279 dev->pnp.bus_id, resource->name));
280 break;
284 if (!list_empty(&resource->reference)) {
285 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Cannot turn resource [%s] off - resource is in use\n",
286 resource->name));
287 mutex_unlock(&resource->resource_lock);
288 return 0;
290 mutex_unlock(&resource->resource_lock);
292 status = acpi_evaluate_object(resource->device->handle, "_OFF", NULL, NULL);
293 if (ACPI_FAILURE(status))
294 return -ENODEV;
296 if (!acpi_power_nocheck) {
298 * If acpi_power_nocheck is set, it is unnecessary to check
299 * the power state after power transition.
301 result = acpi_power_get_state(handle, &state);
302 if (result)
303 return result;
304 if (state != ACPI_POWER_RESOURCE_STATE_OFF)
305 return -ENOEXEC;
308 /* Update the power resource's _device_ power state */
309 resource->device->power.state = ACPI_STATE_D3;
311 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Resource [%s] turned off\n",
312 resource->name));
314 return 0;
318 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
319 * ACPI 3.0) _PSW (Power State Wake)
320 * @dev: Device to handle.
321 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
322 * @sleep_state: Target sleep state of the system.
323 * @dev_state: Target power state of the device.
325 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
326 * State Wake) for the device, if present. On failure reset the device's
327 * wakeup.flags.valid flag.
329 * RETURN VALUE:
330 * 0 if either _DSW or _PSW has been successfully executed
331 * 0 if neither _DSW nor _PSW has been found
332 * -ENODEV if the execution of either _DSW or _PSW has failed
334 int acpi_device_sleep_wake(struct acpi_device *dev,
335 int enable, int sleep_state, int dev_state)
337 union acpi_object in_arg[3];
338 struct acpi_object_list arg_list = { 3, in_arg };
339 acpi_status status = AE_OK;
342 * Try to execute _DSW first.
344 * Three agruments are needed for the _DSW object:
345 * Argument 0: enable/disable the wake capabilities
346 * Argument 1: target system state
347 * Argument 2: target device state
348 * When _DSW object is called to disable the wake capabilities, maybe
349 * the first argument is filled. The values of the other two agruments
350 * are meaningless.
352 in_arg[0].type = ACPI_TYPE_INTEGER;
353 in_arg[0].integer.value = enable;
354 in_arg[1].type = ACPI_TYPE_INTEGER;
355 in_arg[1].integer.value = sleep_state;
356 in_arg[2].type = ACPI_TYPE_INTEGER;
357 in_arg[2].integer.value = dev_state;
358 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
359 if (ACPI_SUCCESS(status)) {
360 return 0;
361 } else if (status != AE_NOT_FOUND) {
362 printk(KERN_ERR PREFIX "_DSW execution failed\n");
363 dev->wakeup.flags.valid = 0;
364 return -ENODEV;
367 /* Execute _PSW */
368 arg_list.count = 1;
369 in_arg[0].integer.value = enable;
370 status = acpi_evaluate_object(dev->handle, "_PSW", &arg_list, NULL);
371 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
372 printk(KERN_ERR PREFIX "_PSW execution failed\n");
373 dev->wakeup.flags.valid = 0;
374 return -ENODEV;
377 return 0;
381 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
382 * 1. Power on the power resources required for the wakeup device
383 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
384 * State Wake) for the device, if present
386 int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
388 int i, err;
390 if (!dev || !dev->wakeup.flags.valid)
391 return -EINVAL;
394 * Do not execute the code below twice in a row without calling
395 * acpi_disable_wakeup_device_power() in between for the same device
397 if (dev->wakeup.flags.prepared)
398 return 0;
400 /* Open power resource */
401 for (i = 0; i < dev->wakeup.resources.count; i++) {
402 int ret = acpi_power_on(dev->wakeup.resources.handles[i], dev);
403 if (ret) {
404 printk(KERN_ERR PREFIX "Transition power state\n");
405 dev->wakeup.flags.valid = 0;
406 return -ENODEV;
411 * Passing 3 as the third argument below means the device may be placed
412 * in arbitrary power state afterwards.
414 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
415 if (!err)
416 dev->wakeup.flags.prepared = 1;
418 return err;
422 * Shutdown a wakeup device, counterpart of above method
423 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
424 * State Wake) for the device, if present
425 * 2. Shutdown down the power resources
427 int acpi_disable_wakeup_device_power(struct acpi_device *dev)
429 int i, ret;
431 if (!dev || !dev->wakeup.flags.valid)
432 return -EINVAL;
435 * Do not execute the code below twice in a row without calling
436 * acpi_enable_wakeup_device_power() in between for the same device
438 if (!dev->wakeup.flags.prepared)
439 return 0;
441 dev->wakeup.flags.prepared = 0;
443 ret = acpi_device_sleep_wake(dev, 0, 0, 0);
444 if (ret)
445 return ret;
447 /* Close power resource */
448 for (i = 0; i < dev->wakeup.resources.count; i++) {
449 ret = acpi_power_off_device(dev->wakeup.resources.handles[i], dev);
450 if (ret) {
451 printk(KERN_ERR PREFIX "Transition power state\n");
452 dev->wakeup.flags.valid = 0;
453 return -ENODEV;
457 return ret;
460 /* --------------------------------------------------------------------------
461 Device Power Management
462 -------------------------------------------------------------------------- */
464 int acpi_power_get_inferred_state(struct acpi_device *device)
466 int result = 0;
467 struct acpi_handle_list *list = NULL;
468 int list_state = 0;
469 int i = 0;
472 if (!device)
473 return -EINVAL;
475 device->power.state = ACPI_STATE_UNKNOWN;
478 * We know a device's inferred power state when all the resources
479 * required for a given D-state are 'on'.
481 for (i = ACPI_STATE_D0; i < ACPI_STATE_D3; i++) {
482 list = &device->power.states[i].resources;
483 if (list->count < 1)
484 continue;
486 result = acpi_power_get_list_state(list, &list_state);
487 if (result)
488 return result;
490 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
491 device->power.state = i;
492 return 0;
496 device->power.state = ACPI_STATE_D3;
498 return 0;
501 int acpi_power_transition(struct acpi_device *device, int state)
503 int result = 0;
504 struct acpi_handle_list *cl = NULL; /* Current Resources */
505 struct acpi_handle_list *tl = NULL; /* Target Resources */
506 int i = 0;
509 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3))
510 return -EINVAL;
512 if ((device->power.state < ACPI_STATE_D0)
513 || (device->power.state > ACPI_STATE_D3))
514 return -ENODEV;
516 cl = &device->power.states[device->power.state].resources;
517 tl = &device->power.states[state].resources;
519 /* TBD: Resources must be ordered. */
522 * First we reference all power resources required in the target list
523 * (e.g. so the device doesn't lose power while transitioning).
525 for (i = 0; i < tl->count; i++) {
526 result = acpi_power_on(tl->handles[i], device);
527 if (result)
528 goto end;
531 if (device->power.state == state) {
532 goto end;
536 * Then we dereference all power resources used in the current list.
538 for (i = 0; i < cl->count; i++) {
539 result = acpi_power_off_device(cl->handles[i], device);
540 if (result)
541 goto end;
544 end:
545 if (result)
546 device->power.state = ACPI_STATE_UNKNOWN;
547 else {
548 /* We shouldn't change the state till all above operations succeed */
549 device->power.state = state;
552 return result;
555 /* --------------------------------------------------------------------------
556 FS Interface (/proc)
557 -------------------------------------------------------------------------- */
559 static struct proc_dir_entry *acpi_power_dir;
561 static int acpi_power_seq_show(struct seq_file *seq, void *offset)
563 int count = 0;
564 int result = 0, state;
565 struct acpi_power_resource *resource = NULL;
566 struct list_head *node, *next;
567 struct acpi_power_reference *ref;
570 resource = seq->private;
572 if (!resource)
573 goto end;
575 result = acpi_power_get_state(resource->device->handle, &state);
576 if (result)
577 goto end;
579 seq_puts(seq, "state: ");
580 switch (state) {
581 case ACPI_POWER_RESOURCE_STATE_ON:
582 seq_puts(seq, "on\n");
583 break;
584 case ACPI_POWER_RESOURCE_STATE_OFF:
585 seq_puts(seq, "off\n");
586 break;
587 default:
588 seq_puts(seq, "unknown\n");
589 break;
592 mutex_lock(&resource->resource_lock);
593 list_for_each_safe(node, next, &resource->reference) {
594 ref = container_of(node, struct acpi_power_reference, node);
595 count++;
597 mutex_unlock(&resource->resource_lock);
599 seq_printf(seq, "system level: S%d\n"
600 "order: %d\n"
601 "reference count: %d\n",
602 resource->system_level,
603 resource->order, count);
605 end:
606 return 0;
609 static int acpi_power_open_fs(struct inode *inode, struct file *file)
611 return single_open(file, acpi_power_seq_show, PDE(inode)->data);
614 static int acpi_power_add_fs(struct acpi_device *device)
616 struct proc_dir_entry *entry = NULL;
619 if (!device)
620 return -EINVAL;
622 if (!acpi_device_dir(device)) {
623 acpi_device_dir(device) = proc_mkdir(acpi_device_bid(device),
624 acpi_power_dir);
625 if (!acpi_device_dir(device))
626 return -ENODEV;
629 /* 'status' [R] */
630 entry = proc_create_data(ACPI_POWER_FILE_STATUS,
631 S_IRUGO, acpi_device_dir(device),
632 &acpi_power_fops, acpi_driver_data(device));
633 if (!entry)
634 return -EIO;
635 return 0;
638 static int acpi_power_remove_fs(struct acpi_device *device)
641 if (acpi_device_dir(device)) {
642 remove_proc_entry(ACPI_POWER_FILE_STATUS,
643 acpi_device_dir(device));
644 remove_proc_entry(acpi_device_bid(device), acpi_power_dir);
645 acpi_device_dir(device) = NULL;
648 return 0;
651 /* --------------------------------------------------------------------------
652 Driver Interface
653 -------------------------------------------------------------------------- */
655 static int acpi_power_add(struct acpi_device *device)
657 int result = 0, state;
658 acpi_status status = AE_OK;
659 struct acpi_power_resource *resource = NULL;
660 union acpi_object acpi_object;
661 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
664 if (!device)
665 return -EINVAL;
667 resource = kzalloc(sizeof(struct acpi_power_resource), GFP_KERNEL);
668 if (!resource)
669 return -ENOMEM;
671 resource->device = device;
672 mutex_init(&resource->resource_lock);
673 INIT_LIST_HEAD(&resource->reference);
674 strcpy(resource->name, device->pnp.bus_id);
675 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
676 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
677 device->driver_data = resource;
679 /* Evalute the object to get the system level and resource order. */
680 status = acpi_evaluate_object(device->handle, NULL, NULL, &buffer);
681 if (ACPI_FAILURE(status)) {
682 result = -ENODEV;
683 goto end;
685 resource->system_level = acpi_object.power_resource.system_level;
686 resource->order = acpi_object.power_resource.resource_order;
688 result = acpi_power_get_state(device->handle, &state);
689 if (result)
690 goto end;
692 switch (state) {
693 case ACPI_POWER_RESOURCE_STATE_ON:
694 device->power.state = ACPI_STATE_D0;
695 break;
696 case ACPI_POWER_RESOURCE_STATE_OFF:
697 device->power.state = ACPI_STATE_D3;
698 break;
699 default:
700 device->power.state = ACPI_STATE_UNKNOWN;
701 break;
704 result = acpi_power_add_fs(device);
705 if (result)
706 goto end;
708 printk(KERN_INFO PREFIX "%s [%s] (%s)\n", acpi_device_name(device),
709 acpi_device_bid(device), state ? "on" : "off");
711 end:
712 if (result)
713 kfree(resource);
715 return result;
718 static int acpi_power_remove(struct acpi_device *device, int type)
720 struct acpi_power_resource *resource = NULL;
721 struct list_head *node, *next;
724 if (!device || !acpi_driver_data(device))
725 return -EINVAL;
727 resource = acpi_driver_data(device);
729 acpi_power_remove_fs(device);
731 mutex_lock(&resource->resource_lock);
732 list_for_each_safe(node, next, &resource->reference) {
733 struct acpi_power_reference *ref = container_of(node, struct acpi_power_reference, node);
734 list_del(&ref->node);
735 kfree(ref);
737 mutex_unlock(&resource->resource_lock);
739 kfree(resource);
741 return 0;
744 static int acpi_power_resume(struct acpi_device *device)
746 int result = 0, state;
747 struct acpi_power_resource *resource = NULL;
748 struct acpi_power_reference *ref;
750 if (!device || !acpi_driver_data(device))
751 return -EINVAL;
753 resource = acpi_driver_data(device);
755 result = acpi_power_get_state(device->handle, &state);
756 if (result)
757 return result;
759 mutex_lock(&resource->resource_lock);
760 if (state == ACPI_POWER_RESOURCE_STATE_OFF &&
761 !list_empty(&resource->reference)) {
762 ref = container_of(resource->reference.next, struct acpi_power_reference, node);
763 mutex_unlock(&resource->resource_lock);
764 result = acpi_power_on(device->handle, ref->device);
765 return result;
768 mutex_unlock(&resource->resource_lock);
769 return 0;
772 int __init acpi_power_init(void)
774 int result = 0;
776 INIT_LIST_HEAD(&acpi_power_resource_list);
778 acpi_power_dir = proc_mkdir(ACPI_POWER_CLASS, acpi_root_dir);
779 if (!acpi_power_dir)
780 return -ENODEV;
782 result = acpi_bus_register_driver(&acpi_power_driver);
783 if (result < 0) {
784 remove_proc_entry(ACPI_POWER_CLASS, acpi_root_dir);
785 return -ENODEV;
788 return 0;