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_device_id power_device_ids
[] = {
66 MODULE_DEVICE_TABLE(acpi
, power_device_ids
);
68 static struct acpi_driver acpi_power_driver
= {
70 .class = ACPI_POWER_CLASS
,
71 .ids
= power_device_ids
,
73 .add
= acpi_power_add
,
74 .remove
= acpi_power_remove
,
75 .resume
= acpi_power_resume
,
79 struct acpi_power_reference
{
80 struct list_head node
;
81 struct acpi_device
*device
;
84 struct acpi_power_resource
{
85 struct acpi_device
* device
;
89 struct mutex resource_lock
;
90 struct list_head reference
;
93 static struct list_head acpi_power_resource_list
;
95 static const struct file_operations acpi_power_fops
= {
97 .open
= acpi_power_open_fs
,
100 .release
= single_release
,
103 /* --------------------------------------------------------------------------
104 Power Resource Management
105 -------------------------------------------------------------------------- */
108 acpi_power_get_context(acpi_handle handle
,
109 struct acpi_power_resource
**resource
)
112 struct acpi_device
*device
= NULL
;
118 result
= acpi_bus_get_device(handle
, &device
);
120 printk(KERN_WARNING PREFIX
"Getting context [%p]\n", handle
);
124 *resource
= acpi_driver_data(device
);
131 static int acpi_power_get_state(struct acpi_power_resource
*resource
, int *state
)
133 acpi_status status
= AE_OK
;
134 unsigned long sta
= 0;
137 if (!resource
|| !state
)
140 status
= acpi_evaluate_integer(resource
->device
->handle
, "_STA", NULL
, &sta
);
141 if (ACPI_FAILURE(status
))
144 *state
= (sta
& 0x01)?ACPI_POWER_RESOURCE_STATE_ON
:
145 ACPI_POWER_RESOURCE_STATE_OFF
;
147 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
148 resource
->name
, state
? "on" : "off"));
153 static int acpi_power_get_list_state(struct acpi_handle_list
*list
, int *state
)
155 int result
= 0, state1
;
156 struct acpi_power_resource
*resource
= NULL
;
163 /* The state of the list is 'on' IFF all resources are 'on'. */
165 for (i
= 0; i
< list
->count
; i
++) {
166 result
= acpi_power_get_context(list
->handles
[i
], &resource
);
169 result
= acpi_power_get_state(resource
, &state1
);
175 if (*state
!= ACPI_POWER_RESOURCE_STATE_ON
)
179 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
180 *state
? "on" : "off"));
185 static int acpi_power_on(acpi_handle handle
, struct acpi_device
*dev
)
187 int result
= 0, state
;
189 acpi_status status
= AE_OK
;
190 struct acpi_power_resource
*resource
= NULL
;
191 struct list_head
*node
, *next
;
192 struct acpi_power_reference
*ref
;
195 result
= acpi_power_get_context(handle
, &resource
);
199 mutex_lock(&resource
->resource_lock
);
200 list_for_each_safe(node
, next
, &resource
->reference
) {
201 ref
= container_of(node
, struct acpi_power_reference
, node
);
202 if (dev
->handle
== ref
->device
->handle
) {
203 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] already referenced by resource [%s]\n",
204 dev
->pnp
.bus_id
, resource
->name
));
211 ref
= kmalloc(sizeof (struct acpi_power_reference
),
212 irqs_disabled() ? GFP_ATOMIC
: GFP_KERNEL
);
214 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "kmalloc() failed\n"));
215 mutex_unlock(&resource
->resource_lock
);
218 list_add_tail(&ref
->node
, &resource
->reference
);
220 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] added to resource [%s] references\n",
221 dev
->pnp
.bus_id
, resource
->name
));
223 mutex_unlock(&resource
->resource_lock
);
225 status
= acpi_evaluate_object(resource
->device
->handle
, "_ON", NULL
, NULL
);
226 if (ACPI_FAILURE(status
))
229 result
= acpi_power_get_state(resource
, &state
);
232 if (state
!= ACPI_POWER_RESOURCE_STATE_ON
)
235 /* Update the power resource's _device_ power state */
236 resource
->device
->power
.state
= ACPI_STATE_D0
;
238 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned on\n",
243 static int acpi_power_off_device(acpi_handle handle
, struct acpi_device
*dev
)
245 int result
= 0, state
;
246 acpi_status status
= AE_OK
;
247 struct acpi_power_resource
*resource
= NULL
;
248 struct list_head
*node
, *next
;
249 struct acpi_power_reference
*ref
;
252 result
= acpi_power_get_context(handle
, &resource
);
256 mutex_lock(&resource
->resource_lock
);
257 list_for_each_safe(node
, next
, &resource
->reference
) {
258 ref
= container_of(node
, struct acpi_power_reference
, node
);
259 if (dev
->handle
== ref
->device
->handle
) {
260 list_del(&ref
->node
);
262 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] removed from resource [%s] references\n",
263 dev
->pnp
.bus_id
, resource
->name
));
268 if (!list_empty(&resource
->reference
)) {
269 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Cannot turn resource [%s] off - resource is in use\n",
271 mutex_unlock(&resource
->resource_lock
);
274 mutex_unlock(&resource
->resource_lock
);
276 status
= acpi_evaluate_object(resource
->device
->handle
, "_OFF", NULL
, NULL
);
277 if (ACPI_FAILURE(status
))
280 result
= acpi_power_get_state(resource
, &state
);
283 if (state
!= ACPI_POWER_RESOURCE_STATE_OFF
)
286 /* Update the power resource's _device_ power state */
287 resource
->device
->power
.state
= ACPI_STATE_D3
;
289 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned off\n",
296 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
297 * ACPI 3.0) _PSW (Power State Wake)
298 * @dev: Device to handle.
299 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
300 * @sleep_state: Target sleep state of the system.
301 * @dev_state: Target power state of the device.
303 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
304 * State Wake) for the device, if present. On failure reset the device's
305 * wakeup.flags.valid flag.
308 * 0 if either _DSW or _PSW has been successfully executed
309 * 0 if neither _DSW nor _PSW has been found
310 * -ENODEV if the execution of either _DSW or _PSW has failed
312 int acpi_device_sleep_wake(struct acpi_device
*dev
,
313 int enable
, int sleep_state
, int dev_state
)
315 union acpi_object in_arg
[3];
316 struct acpi_object_list arg_list
= { 3, in_arg
};
317 acpi_status status
= AE_OK
;
320 * Try to execute _DSW first.
322 * Three agruments are needed for the _DSW object:
323 * Argument 0: enable/disable the wake capabilities
324 * Argument 1: target system state
325 * Argument 2: target device state
326 * When _DSW object is called to disable the wake capabilities, maybe
327 * the first argument is filled. The values of the other two agruments
330 in_arg
[0].type
= ACPI_TYPE_INTEGER
;
331 in_arg
[0].integer
.value
= enable
;
332 in_arg
[1].type
= ACPI_TYPE_INTEGER
;
333 in_arg
[1].integer
.value
= sleep_state
;
334 in_arg
[2].type
= ACPI_TYPE_INTEGER
;
335 in_arg
[2].integer
.value
= dev_state
;
336 status
= acpi_evaluate_object(dev
->handle
, "_DSW", &arg_list
, NULL
);
337 if (ACPI_SUCCESS(status
)) {
339 } else if (status
!= AE_NOT_FOUND
) {
340 printk(KERN_ERR PREFIX
"_DSW execution failed\n");
341 dev
->wakeup
.flags
.valid
= 0;
347 in_arg
[0].integer
.value
= enable
;
348 status
= acpi_evaluate_object(dev
->handle
, "_PSW", &arg_list
, NULL
);
349 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
350 printk(KERN_ERR PREFIX
"_PSW execution failed\n");
351 dev
->wakeup
.flags
.valid
= 0;
359 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
360 * 1. Power on the power resources required for the wakeup device
361 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
362 * State Wake) for the device, if present
364 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int sleep_state
)
368 if (!dev
|| !dev
->wakeup
.flags
.valid
)
372 * Do not execute the code below twice in a row without calling
373 * acpi_disable_wakeup_device_power() in between for the same device
375 if (dev
->wakeup
.flags
.prepared
)
378 /* Open power resource */
379 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
380 int ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
], dev
);
382 printk(KERN_ERR PREFIX
"Transition power state\n");
383 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);
394 dev
->wakeup
.flags
.prepared
= 1;
400 * Shutdown a wakeup device, counterpart of above method
401 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
402 * State Wake) for the device, if present
403 * 2. Shutdown down the power resources
405 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
)
409 if (!dev
|| !dev
->wakeup
.flags
.valid
)
413 * Do not execute the code below twice in a row without calling
414 * acpi_enable_wakeup_device_power() in between for the same device
416 if (!dev
->wakeup
.flags
.prepared
)
419 dev
->wakeup
.flags
.prepared
= 0;
421 ret
= acpi_device_sleep_wake(dev
, 0, 0, 0);
425 /* Close power resource */
426 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
427 ret
= acpi_power_off_device(dev
->wakeup
.resources
.handles
[i
], dev
);
429 printk(KERN_ERR PREFIX
"Transition power state\n");
430 dev
->wakeup
.flags
.valid
= 0;
438 /* --------------------------------------------------------------------------
439 Device Power Management
440 -------------------------------------------------------------------------- */
442 int acpi_power_get_inferred_state(struct acpi_device
*device
)
445 struct acpi_handle_list
*list
= NULL
;
453 device
->power
.state
= ACPI_STATE_UNKNOWN
;
456 * We know a device's inferred power state when all the resources
457 * required for a given D-state are 'on'.
459 for (i
= ACPI_STATE_D0
; i
< ACPI_STATE_D3
; i
++) {
460 list
= &device
->power
.states
[i
].resources
;
464 result
= acpi_power_get_list_state(list
, &list_state
);
468 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
469 device
->power
.state
= i
;
474 device
->power
.state
= ACPI_STATE_D3
;
479 int acpi_power_transition(struct acpi_device
*device
, int state
)
482 struct acpi_handle_list
*cl
= NULL
; /* Current Resources */
483 struct acpi_handle_list
*tl
= NULL
; /* Target Resources */
487 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3
))
490 if ((device
->power
.state
< ACPI_STATE_D0
)
491 || (device
->power
.state
> ACPI_STATE_D3
))
494 cl
= &device
->power
.states
[device
->power
.state
].resources
;
495 tl
= &device
->power
.states
[state
].resources
;
497 if (!cl
->count
&& !tl
->count
) {
502 /* TBD: Resources must be ordered. */
505 * First we reference all power resources required in the target list
506 * (e.g. so the device doesn't lose power while transitioning).
508 for (i
= 0; i
< tl
->count
; i
++) {
509 result
= acpi_power_on(tl
->handles
[i
], device
);
514 if (device
->power
.state
== state
) {
519 * Then we dereference all power resources used in the current list.
521 for (i
= 0; i
< cl
->count
; i
++) {
522 result
= acpi_power_off_device(cl
->handles
[i
], device
);
529 device
->power
.state
= ACPI_STATE_UNKNOWN
;
531 /* We shouldn't change the state till all above operations succeed */
532 device
->power
.state
= state
;
538 /* --------------------------------------------------------------------------
540 -------------------------------------------------------------------------- */
542 static struct proc_dir_entry
*acpi_power_dir
;
544 static int acpi_power_seq_show(struct seq_file
*seq
, void *offset
)
547 int result
= 0, state
;
548 struct acpi_power_resource
*resource
= NULL
;
549 struct list_head
*node
, *next
;
550 struct acpi_power_reference
*ref
;
553 resource
= seq
->private;
558 result
= acpi_power_get_state(resource
, &state
);
562 seq_puts(seq
, "state: ");
564 case ACPI_POWER_RESOURCE_STATE_ON
:
565 seq_puts(seq
, "on\n");
567 case ACPI_POWER_RESOURCE_STATE_OFF
:
568 seq_puts(seq
, "off\n");
571 seq_puts(seq
, "unknown\n");
575 mutex_lock(&resource
->resource_lock
);
576 list_for_each_safe(node
, next
, &resource
->reference
) {
577 ref
= container_of(node
, struct acpi_power_reference
, node
);
580 mutex_unlock(&resource
->resource_lock
);
582 seq_printf(seq
, "system level: S%d\n"
584 "reference count: %d\n",
585 resource
->system_level
,
586 resource
->order
, count
);
592 static int acpi_power_open_fs(struct inode
*inode
, struct file
*file
)
594 return single_open(file
, acpi_power_seq_show
, PDE(inode
)->data
);
597 static int acpi_power_add_fs(struct acpi_device
*device
)
599 struct proc_dir_entry
*entry
= NULL
;
605 if (!acpi_device_dir(device
)) {
606 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
608 if (!acpi_device_dir(device
))
613 entry
= proc_create_data(ACPI_POWER_FILE_STATUS
,
614 S_IRUGO
, acpi_device_dir(device
),
615 &acpi_power_fops
, acpi_driver_data(device
));
621 static int acpi_power_remove_fs(struct acpi_device
*device
)
624 if (acpi_device_dir(device
)) {
625 remove_proc_entry(ACPI_POWER_FILE_STATUS
,
626 acpi_device_dir(device
));
627 remove_proc_entry(acpi_device_bid(device
), acpi_power_dir
);
628 acpi_device_dir(device
) = NULL
;
634 /* --------------------------------------------------------------------------
636 -------------------------------------------------------------------------- */
638 static int acpi_power_add(struct acpi_device
*device
)
640 int result
= 0, state
;
641 acpi_status status
= AE_OK
;
642 struct acpi_power_resource
*resource
= NULL
;
643 union acpi_object acpi_object
;
644 struct acpi_buffer buffer
= { sizeof(acpi_object
), &acpi_object
};
650 resource
= kzalloc(sizeof(struct acpi_power_resource
), GFP_KERNEL
);
654 resource
->device
= device
;
655 mutex_init(&resource
->resource_lock
);
656 INIT_LIST_HEAD(&resource
->reference
);
657 strcpy(resource
->name
, device
->pnp
.bus_id
);
658 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
659 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
660 acpi_driver_data(device
) = resource
;
662 /* Evalute the object to get the system level and resource order. */
663 status
= acpi_evaluate_object(device
->handle
, NULL
, NULL
, &buffer
);
664 if (ACPI_FAILURE(status
)) {
668 resource
->system_level
= acpi_object
.power_resource
.system_level
;
669 resource
->order
= acpi_object
.power_resource
.resource_order
;
671 result
= acpi_power_get_state(resource
, &state
);
676 case ACPI_POWER_RESOURCE_STATE_ON
:
677 device
->power
.state
= ACPI_STATE_D0
;
679 case ACPI_POWER_RESOURCE_STATE_OFF
:
680 device
->power
.state
= ACPI_STATE_D3
;
683 device
->power
.state
= ACPI_STATE_UNKNOWN
;
687 result
= acpi_power_add_fs(device
);
691 printk(KERN_INFO PREFIX
"%s [%s] (%s)\n", acpi_device_name(device
),
692 acpi_device_bid(device
), state
? "on" : "off");
701 static int acpi_power_remove(struct acpi_device
*device
, int type
)
703 struct acpi_power_resource
*resource
= NULL
;
704 struct list_head
*node
, *next
;
707 if (!device
|| !acpi_driver_data(device
))
710 resource
= acpi_driver_data(device
);
712 acpi_power_remove_fs(device
);
714 mutex_lock(&resource
->resource_lock
);
715 list_for_each_safe(node
, next
, &resource
->reference
) {
716 struct acpi_power_reference
*ref
= container_of(node
, struct acpi_power_reference
, node
);
717 list_del(&ref
->node
);
720 mutex_unlock(&resource
->resource_lock
);
727 static int acpi_power_resume(struct acpi_device
*device
)
729 int result
= 0, state
;
730 struct acpi_power_resource
*resource
= NULL
;
731 struct acpi_power_reference
*ref
;
733 if (!device
|| !acpi_driver_data(device
))
736 resource
= (struct acpi_power_resource
*)acpi_driver_data(device
);
738 result
= acpi_power_get_state(resource
, &state
);
742 mutex_lock(&resource
->resource_lock
);
743 if (state
== ACPI_POWER_RESOURCE_STATE_OFF
&&
744 !list_empty(&resource
->reference
)) {
745 ref
= container_of(resource
->reference
.next
, struct acpi_power_reference
, node
);
746 mutex_unlock(&resource
->resource_lock
);
747 result
= acpi_power_on(device
->handle
, ref
->device
);
751 mutex_unlock(&resource
->resource_lock
);
755 static int __init
acpi_power_init(void)
763 INIT_LIST_HEAD(&acpi_power_resource_list
);
765 acpi_power_dir
= proc_mkdir(ACPI_POWER_CLASS
, acpi_root_dir
);
769 result
= acpi_bus_register_driver(&acpi_power_driver
);
771 remove_proc_entry(ACPI_POWER_CLASS
, acpi_root_dir
);
778 subsys_initcall(acpi_power_init
);