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>
48 #define PREFIX "ACPI: "
50 #define _COMPONENT ACPI_POWER_COMPONENT
51 ACPI_MODULE_NAME("power");
52 #define ACPI_POWER_CLASS "power_resource"
53 #define ACPI_POWER_DEVICE_NAME "Power Resource"
54 #define ACPI_POWER_FILE_INFO "info"
55 #define ACPI_POWER_FILE_STATUS "state"
56 #define ACPI_POWER_RESOURCE_STATE_OFF 0x00
57 #define ACPI_POWER_RESOURCE_STATE_ON 0x01
58 #define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
60 int acpi_power_nocheck
;
61 module_param_named(power_nocheck
, acpi_power_nocheck
, bool, 000);
63 static int acpi_power_add(struct acpi_device
*device
);
64 static int acpi_power_remove(struct acpi_device
*device
, int type
);
65 static int acpi_power_resume(struct acpi_device
*device
);
66 static int acpi_power_open_fs(struct inode
*inode
, struct file
*file
);
68 static const struct acpi_device_id power_device_ids
[] = {
72 MODULE_DEVICE_TABLE(acpi
, power_device_ids
);
74 static struct acpi_driver acpi_power_driver
= {
76 .class = ACPI_POWER_CLASS
,
77 .ids
= power_device_ids
,
79 .add
= acpi_power_add
,
80 .remove
= acpi_power_remove
,
81 .resume
= acpi_power_resume
,
85 struct acpi_power_reference
{
86 struct list_head node
;
87 struct acpi_device
*device
;
90 struct acpi_power_resource
{
91 struct acpi_device
* device
;
95 struct mutex resource_lock
;
96 struct list_head reference
;
99 static struct list_head acpi_power_resource_list
;
101 static const struct file_operations acpi_power_fops
= {
102 .owner
= THIS_MODULE
,
103 .open
= acpi_power_open_fs
,
106 .release
= single_release
,
109 /* --------------------------------------------------------------------------
110 Power Resource Management
111 -------------------------------------------------------------------------- */
114 acpi_power_get_context(acpi_handle handle
,
115 struct acpi_power_resource
**resource
)
118 struct acpi_device
*device
= NULL
;
124 result
= acpi_bus_get_device(handle
, &device
);
126 printk(KERN_WARNING PREFIX
"Getting context [%p]\n", handle
);
130 *resource
= acpi_driver_data(device
);
137 static int acpi_power_get_state(acpi_handle handle
, int *state
)
139 acpi_status status
= AE_OK
;
140 unsigned long long sta
= 0;
142 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
145 if (!handle
|| !state
)
148 status
= acpi_evaluate_integer(handle
, "_STA", NULL
, &sta
);
149 if (ACPI_FAILURE(status
))
152 *state
= (sta
& 0x01)?ACPI_POWER_RESOURCE_STATE_ON
:
153 ACPI_POWER_RESOURCE_STATE_OFF
;
155 acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
157 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
159 *state
? "on" : "off"));
164 static int acpi_power_get_list_state(struct acpi_handle_list
*list
, int *state
)
166 int result
= 0, state1
;
173 /* The state of the list is 'on' IFF all resources are 'on'. */
176 for (i
= 0; i
< list
->count
; i
++) {
178 * The state of the power resource can be obtained by
179 * using the ACPI handle. In such case it is unnecessary to
180 * get the Power resource first and then get its state again.
182 result
= acpi_power_get_state(list
->handles
[i
], &state1
);
188 if (*state
!= ACPI_POWER_RESOURCE_STATE_ON
)
192 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
193 *state
? "on" : "off"));
198 static int acpi_power_on(acpi_handle handle
, struct acpi_device
*dev
)
202 acpi_status status
= AE_OK
;
203 struct acpi_power_resource
*resource
= NULL
;
204 struct list_head
*node
, *next
;
205 struct acpi_power_reference
*ref
;
208 result
= acpi_power_get_context(handle
, &resource
);
212 mutex_lock(&resource
->resource_lock
);
213 list_for_each_safe(node
, next
, &resource
->reference
) {
214 ref
= container_of(node
, struct acpi_power_reference
, node
);
215 if (dev
->handle
== ref
->device
->handle
) {
216 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] already referenced by resource [%s]\n",
217 dev
->pnp
.bus_id
, resource
->name
));
224 ref
= kmalloc(sizeof (struct acpi_power_reference
),
225 irqs_disabled() ? GFP_ATOMIC
: GFP_KERNEL
);
227 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "kmalloc() failed\n"));
228 mutex_unlock(&resource
->resource_lock
);
231 list_add_tail(&ref
->node
, &resource
->reference
);
233 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] added to resource [%s] references\n",
234 dev
->pnp
.bus_id
, resource
->name
));
236 mutex_unlock(&resource
->resource_lock
);
238 status
= acpi_evaluate_object(resource
->device
->handle
, "_ON", NULL
, NULL
);
239 if (ACPI_FAILURE(status
))
242 /* Update the power resource's _device_ power state */
243 resource
->device
->power
.state
= ACPI_STATE_D0
;
245 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned on\n",
250 static int acpi_power_off_device(acpi_handle handle
, struct acpi_device
*dev
)
253 acpi_status status
= AE_OK
;
254 struct acpi_power_resource
*resource
= NULL
;
255 struct list_head
*node
, *next
;
256 struct acpi_power_reference
*ref
;
259 result
= acpi_power_get_context(handle
, &resource
);
263 mutex_lock(&resource
->resource_lock
);
264 list_for_each_safe(node
, next
, &resource
->reference
) {
265 ref
= container_of(node
, struct acpi_power_reference
, node
);
266 if (dev
->handle
== ref
->device
->handle
) {
267 list_del(&ref
->node
);
269 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] removed from resource [%s] references\n",
270 dev
->pnp
.bus_id
, resource
->name
));
275 if (!list_empty(&resource
->reference
)) {
276 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Cannot turn resource [%s] off - resource is in use\n",
278 mutex_unlock(&resource
->resource_lock
);
281 mutex_unlock(&resource
->resource_lock
);
283 status
= acpi_evaluate_object(resource
->device
->handle
, "_OFF", NULL
, NULL
);
284 if (ACPI_FAILURE(status
))
287 /* Update the power resource's _device_ power state */
288 resource
->device
->power
.state
= ACPI_STATE_D3
;
290 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned off\n",
297 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
298 * ACPI 3.0) _PSW (Power State Wake)
299 * @dev: Device to handle.
300 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
301 * @sleep_state: Target sleep state of the system.
302 * @dev_state: Target power state of the device.
304 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
305 * State Wake) for the device, if present. On failure reset the device's
306 * wakeup.flags.valid flag.
309 * 0 if either _DSW or _PSW has been successfully executed
310 * 0 if neither _DSW nor _PSW has been found
311 * -ENODEV if the execution of either _DSW or _PSW has failed
313 int acpi_device_sleep_wake(struct acpi_device
*dev
,
314 int enable
, int sleep_state
, int dev_state
)
316 union acpi_object in_arg
[3];
317 struct acpi_object_list arg_list
= { 3, in_arg
};
318 acpi_status status
= AE_OK
;
321 * Try to execute _DSW first.
323 * Three agruments are needed for the _DSW object:
324 * Argument 0: enable/disable the wake capabilities
325 * Argument 1: target system state
326 * Argument 2: target device state
327 * When _DSW object is called to disable the wake capabilities, maybe
328 * the first argument is filled. The values of the other two agruments
331 in_arg
[0].type
= ACPI_TYPE_INTEGER
;
332 in_arg
[0].integer
.value
= enable
;
333 in_arg
[1].type
= ACPI_TYPE_INTEGER
;
334 in_arg
[1].integer
.value
= sleep_state
;
335 in_arg
[2].type
= ACPI_TYPE_INTEGER
;
336 in_arg
[2].integer
.value
= dev_state
;
337 status
= acpi_evaluate_object(dev
->handle
, "_DSW", &arg_list
, NULL
);
338 if (ACPI_SUCCESS(status
)) {
340 } else if (status
!= AE_NOT_FOUND
) {
341 printk(KERN_ERR PREFIX
"_DSW execution failed\n");
342 dev
->wakeup
.flags
.valid
= 0;
348 in_arg
[0].integer
.value
= enable
;
349 status
= acpi_evaluate_object(dev
->handle
, "_PSW", &arg_list
, NULL
);
350 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
351 printk(KERN_ERR PREFIX
"_PSW execution failed\n");
352 dev
->wakeup
.flags
.valid
= 0;
360 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
361 * 1. Power on the power resources required for the wakeup device
362 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
363 * State Wake) for the device, if present
365 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int sleep_state
)
369 if (!dev
|| !dev
->wakeup
.flags
.valid
)
372 mutex_lock(&acpi_device_lock
);
374 if (dev
->wakeup
.prepare_count
++)
377 /* Open power resource */
378 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
379 int ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
], dev
);
381 printk(KERN_ERR PREFIX
"Transition power state\n");
382 dev
->wakeup
.flags
.valid
= 0;
389 * Passing 3 as the third argument below means the device may be placed
390 * in arbitrary power state afterwards.
392 err
= acpi_device_sleep_wake(dev
, 1, sleep_state
, 3);
396 dev
->wakeup
.prepare_count
= 0;
399 mutex_unlock(&acpi_device_lock
);
404 * Shutdown a wakeup device, counterpart of above method
405 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
406 * State Wake) for the device, if present
407 * 2. Shutdown down the power resources
409 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
)
413 if (!dev
|| !dev
->wakeup
.flags
.valid
)
416 mutex_lock(&acpi_device_lock
);
418 if (--dev
->wakeup
.prepare_count
> 0)
422 * Executing the code below even if prepare_count is already zero when
423 * the function is called may be useful, for example for initialisation.
425 if (dev
->wakeup
.prepare_count
< 0)
426 dev
->wakeup
.prepare_count
= 0;
428 err
= acpi_device_sleep_wake(dev
, 0, 0, 0);
432 /* Close power resource */
433 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
434 int ret
= acpi_power_off_device(
435 dev
->wakeup
.resources
.handles
[i
], dev
);
437 printk(KERN_ERR PREFIX
"Transition power state\n");
438 dev
->wakeup
.flags
.valid
= 0;
445 mutex_unlock(&acpi_device_lock
);
449 /* --------------------------------------------------------------------------
450 Device Power Management
451 -------------------------------------------------------------------------- */
453 int acpi_power_get_inferred_state(struct acpi_device
*device
)
456 struct acpi_handle_list
*list
= NULL
;
464 device
->power
.state
= ACPI_STATE_UNKNOWN
;
467 * We know a device's inferred power state when all the resources
468 * required for a given D-state are 'on'.
470 for (i
= ACPI_STATE_D0
; i
< ACPI_STATE_D3
; i
++) {
471 list
= &device
->power
.states
[i
].resources
;
475 result
= acpi_power_get_list_state(list
, &list_state
);
479 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
480 device
->power
.state
= i
;
485 device
->power
.state
= ACPI_STATE_D3
;
490 int acpi_power_transition(struct acpi_device
*device
, int state
)
493 struct acpi_handle_list
*cl
= NULL
; /* Current Resources */
494 struct acpi_handle_list
*tl
= NULL
; /* Target Resources */
498 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3
))
501 if ((device
->power
.state
< ACPI_STATE_D0
)
502 || (device
->power
.state
> ACPI_STATE_D3
))
505 cl
= &device
->power
.states
[device
->power
.state
].resources
;
506 tl
= &device
->power
.states
[state
].resources
;
508 /* TBD: Resources must be ordered. */
511 * First we reference all power resources required in the target list
512 * (e.g. so the device doesn't lose power while transitioning).
514 for (i
= 0; i
< tl
->count
; i
++) {
515 result
= acpi_power_on(tl
->handles
[i
], device
);
520 if (device
->power
.state
== state
) {
525 * Then we dereference all power resources used in the current list.
527 for (i
= 0; i
< cl
->count
; i
++) {
528 result
= acpi_power_off_device(cl
->handles
[i
], device
);
535 device
->power
.state
= ACPI_STATE_UNKNOWN
;
537 /* We shouldn't change the state till all above operations succeed */
538 device
->power
.state
= state
;
544 /* --------------------------------------------------------------------------
546 -------------------------------------------------------------------------- */
548 static struct proc_dir_entry
*acpi_power_dir
;
550 static int acpi_power_seq_show(struct seq_file
*seq
, void *offset
)
553 int result
= 0, state
;
554 struct acpi_power_resource
*resource
= NULL
;
555 struct list_head
*node
, *next
;
556 struct acpi_power_reference
*ref
;
559 resource
= seq
->private;
564 result
= acpi_power_get_state(resource
->device
->handle
, &state
);
568 seq_puts(seq
, "state: ");
570 case ACPI_POWER_RESOURCE_STATE_ON
:
571 seq_puts(seq
, "on\n");
573 case ACPI_POWER_RESOURCE_STATE_OFF
:
574 seq_puts(seq
, "off\n");
577 seq_puts(seq
, "unknown\n");
581 mutex_lock(&resource
->resource_lock
);
582 list_for_each_safe(node
, next
, &resource
->reference
) {
583 ref
= container_of(node
, struct acpi_power_reference
, node
);
586 mutex_unlock(&resource
->resource_lock
);
588 seq_printf(seq
, "system level: S%d\n"
590 "reference count: %d\n",
591 resource
->system_level
,
592 resource
->order
, count
);
598 static int acpi_power_open_fs(struct inode
*inode
, struct file
*file
)
600 return single_open(file
, acpi_power_seq_show
, PDE(inode
)->data
);
603 static int acpi_power_add_fs(struct acpi_device
*device
)
605 struct proc_dir_entry
*entry
= NULL
;
611 if (!acpi_device_dir(device
)) {
612 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
614 if (!acpi_device_dir(device
))
619 entry
= proc_create_data(ACPI_POWER_FILE_STATUS
,
620 S_IRUGO
, acpi_device_dir(device
),
621 &acpi_power_fops
, acpi_driver_data(device
));
627 static int acpi_power_remove_fs(struct acpi_device
*device
)
630 if (acpi_device_dir(device
)) {
631 remove_proc_entry(ACPI_POWER_FILE_STATUS
,
632 acpi_device_dir(device
));
633 remove_proc_entry(acpi_device_bid(device
), acpi_power_dir
);
634 acpi_device_dir(device
) = NULL
;
640 /* --------------------------------------------------------------------------
642 -------------------------------------------------------------------------- */
644 static int acpi_power_add(struct acpi_device
*device
)
646 int result
= 0, state
;
647 acpi_status status
= AE_OK
;
648 struct acpi_power_resource
*resource
= NULL
;
649 union acpi_object acpi_object
;
650 struct acpi_buffer buffer
= { sizeof(acpi_object
), &acpi_object
};
656 resource
= kzalloc(sizeof(struct acpi_power_resource
), GFP_KERNEL
);
660 resource
->device
= device
;
661 mutex_init(&resource
->resource_lock
);
662 INIT_LIST_HEAD(&resource
->reference
);
663 strcpy(resource
->name
, device
->pnp
.bus_id
);
664 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
665 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
666 device
->driver_data
= resource
;
668 /* Evalute the object to get the system level and resource order. */
669 status
= acpi_evaluate_object(device
->handle
, NULL
, NULL
, &buffer
);
670 if (ACPI_FAILURE(status
)) {
674 resource
->system_level
= acpi_object
.power_resource
.system_level
;
675 resource
->order
= acpi_object
.power_resource
.resource_order
;
677 result
= acpi_power_get_state(device
->handle
, &state
);
682 case ACPI_POWER_RESOURCE_STATE_ON
:
683 device
->power
.state
= ACPI_STATE_D0
;
685 case ACPI_POWER_RESOURCE_STATE_OFF
:
686 device
->power
.state
= ACPI_STATE_D3
;
689 device
->power
.state
= ACPI_STATE_UNKNOWN
;
693 result
= acpi_power_add_fs(device
);
697 printk(KERN_INFO PREFIX
"%s [%s] (%s)\n", acpi_device_name(device
),
698 acpi_device_bid(device
), state
? "on" : "off");
707 static int acpi_power_remove(struct acpi_device
*device
, int type
)
709 struct acpi_power_resource
*resource
= NULL
;
710 struct list_head
*node
, *next
;
713 if (!device
|| !acpi_driver_data(device
))
716 resource
= acpi_driver_data(device
);
718 acpi_power_remove_fs(device
);
720 mutex_lock(&resource
->resource_lock
);
721 list_for_each_safe(node
, next
, &resource
->reference
) {
722 struct acpi_power_reference
*ref
= container_of(node
, struct acpi_power_reference
, node
);
723 list_del(&ref
->node
);
726 mutex_unlock(&resource
->resource_lock
);
733 static int acpi_power_resume(struct acpi_device
*device
)
735 int result
= 0, state
;
736 struct acpi_power_resource
*resource
= NULL
;
737 struct acpi_power_reference
*ref
;
739 if (!device
|| !acpi_driver_data(device
))
742 resource
= acpi_driver_data(device
);
744 result
= acpi_power_get_state(device
->handle
, &state
);
748 mutex_lock(&resource
->resource_lock
);
749 if (state
== ACPI_POWER_RESOURCE_STATE_OFF
&&
750 !list_empty(&resource
->reference
)) {
751 ref
= container_of(resource
->reference
.next
, struct acpi_power_reference
, node
);
752 mutex_unlock(&resource
->resource_lock
);
753 result
= acpi_power_on(device
->handle
, ref
->device
);
757 mutex_unlock(&resource
->resource_lock
);
761 int __init
acpi_power_init(void)
765 INIT_LIST_HEAD(&acpi_power_resource_list
);
767 acpi_power_dir
= proc_mkdir(ACPI_POWER_CLASS
, acpi_root_dir
);
771 result
= acpi_bus_register_driver(&acpi_power_driver
);
773 remove_proc_entry(ACPI_POWER_CLASS
, acpi_root_dir
);