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/slab.h>
43 #include <linux/pm_runtime.h>
44 #include <acpi/acpi_bus.h>
45 #include <acpi/acpi_drivers.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 static int acpi_power_add(struct acpi_device
*device
);
62 static int acpi_power_remove(struct acpi_device
*device
, int type
);
63 static int acpi_power_resume(struct acpi_device
*device
);
65 static const struct acpi_device_id power_device_ids
[] = {
69 MODULE_DEVICE_TABLE(acpi
, power_device_ids
);
71 static struct acpi_driver acpi_power_driver
= {
73 .class = ACPI_POWER_CLASS
,
74 .ids
= power_device_ids
,
76 .add
= acpi_power_add
,
77 .remove
= acpi_power_remove
,
78 .resume
= acpi_power_resume
,
83 * A power managed device
84 * A device may rely on multiple power resources.
86 struct acpi_power_managed_device
{
87 struct device
*dev
; /* The physical device */
91 struct acpi_power_resource_device
{
92 struct acpi_power_managed_device
*device
;
93 struct acpi_power_resource_device
*next
;
96 struct acpi_power_resource
{
97 struct acpi_device
* device
;
101 unsigned int ref_count
;
102 struct mutex resource_lock
;
104 /* List of devices relying on this power resource */
105 struct acpi_power_resource_device
*devices
;
108 static struct list_head acpi_power_resource_list
;
110 /* --------------------------------------------------------------------------
111 Power Resource Management
112 -------------------------------------------------------------------------- */
115 acpi_power_get_context(acpi_handle handle
,
116 struct acpi_power_resource
**resource
)
119 struct acpi_device
*device
= NULL
;
125 result
= acpi_bus_get_device(handle
, &device
);
127 printk(KERN_WARNING PREFIX
"Getting context [%p]\n", handle
);
131 *resource
= acpi_driver_data(device
);
138 static int acpi_power_get_state(acpi_handle handle
, int *state
)
140 acpi_status status
= AE_OK
;
141 unsigned long long sta
= 0;
143 struct acpi_buffer buffer
= { sizeof(node_name
), node_name
};
146 if (!handle
|| !state
)
149 status
= acpi_evaluate_integer(handle
, "_STA", NULL
, &sta
);
150 if (ACPI_FAILURE(status
))
153 *state
= (sta
& 0x01)?ACPI_POWER_RESOURCE_STATE_ON
:
154 ACPI_POWER_RESOURCE_STATE_OFF
;
156 acpi_get_name(handle
, ACPI_SINGLE_NAME
, &buffer
);
158 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
160 *state
? "on" : "off"));
165 static int acpi_power_get_list_state(struct acpi_handle_list
*list
, int *state
)
173 /* The state of the list is 'on' IFF all resources are 'on'. */
175 for (i
= 0; i
< list
->count
; i
++) {
176 struct acpi_power_resource
*resource
;
177 acpi_handle handle
= list
->handles
[i
];
180 result
= acpi_power_get_context(handle
, &resource
);
184 mutex_lock(&resource
->resource_lock
);
186 result
= acpi_power_get_state(handle
, &cur_state
);
188 mutex_unlock(&resource
->resource_lock
);
193 if (cur_state
!= ACPI_POWER_RESOURCE_STATE_ON
)
197 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
198 cur_state
? "on" : "off"));
205 /* Resume the device when all power resources in _PR0 are on */
206 static void acpi_power_on_device(struct acpi_power_managed_device
*device
)
208 struct acpi_device
*acpi_dev
;
209 acpi_handle handle
= device
->handle
;
212 if (acpi_bus_get_device(handle
, &acpi_dev
))
215 if(acpi_power_get_inferred_state(acpi_dev
, &state
))
218 if (state
== ACPI_STATE_D0
&& pm_runtime_suspended(device
->dev
))
219 pm_request_resume(device
->dev
);
222 static int __acpi_power_on(struct acpi_power_resource
*resource
)
224 struct acpi_power_resource_device
*device_list
= resource
->devices
;
225 acpi_status status
= AE_OK
;
227 status
= acpi_evaluate_object(resource
->device
->handle
, "_ON", NULL
, NULL
);
228 if (ACPI_FAILURE(status
))
231 /* Update the power resource's _device_ power state */
232 resource
->device
->power
.state
= ACPI_STATE_D0
;
234 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Power resource [%s] turned on\n",
237 while (device_list
) {
238 acpi_power_on_device(device_list
->device
);
240 device_list
= device_list
->next
;
246 static int acpi_power_on(acpi_handle handle
)
249 struct acpi_power_resource
*resource
= NULL
;
251 result
= acpi_power_get_context(handle
, &resource
);
255 mutex_lock(&resource
->resource_lock
);
257 if (resource
->ref_count
++) {
258 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
259 "Power resource [%s] already on",
262 result
= __acpi_power_on(resource
);
264 resource
->ref_count
--;
267 mutex_unlock(&resource
->resource_lock
);
272 static int acpi_power_off(acpi_handle handle
)
275 acpi_status status
= AE_OK
;
276 struct acpi_power_resource
*resource
= NULL
;
278 result
= acpi_power_get_context(handle
, &resource
);
282 mutex_lock(&resource
->resource_lock
);
284 if (!resource
->ref_count
) {
285 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
286 "Power resource [%s] already off",
291 if (--resource
->ref_count
) {
292 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
293 "Power resource [%s] still in use\n",
298 status
= acpi_evaluate_object(resource
->device
->handle
, "_OFF", NULL
, NULL
);
299 if (ACPI_FAILURE(status
)) {
302 /* Update the power resource's _device_ power state */
303 resource
->device
->power
.state
= ACPI_STATE_D3
;
305 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
306 "Power resource [%s] turned off\n",
311 mutex_unlock(&resource
->resource_lock
);
316 static void __acpi_power_off_list(struct acpi_handle_list
*list
, int num_res
)
320 for (i
= num_res
- 1; i
>= 0 ; i
--)
321 acpi_power_off(list
->handles
[i
]);
324 static void acpi_power_off_list(struct acpi_handle_list
*list
)
326 __acpi_power_off_list(list
, list
->count
);
329 static int acpi_power_on_list(struct acpi_handle_list
*list
)
334 for (i
= 0; i
< list
->count
; i
++) {
335 result
= acpi_power_on(list
->handles
[i
]);
337 __acpi_power_off_list(list
, i
);
345 static void __acpi_power_resource_unregister_device(struct device
*dev
,
346 acpi_handle res_handle
)
348 struct acpi_power_resource
*resource
= NULL
;
349 struct acpi_power_resource_device
*prev
, *curr
;
351 if (acpi_power_get_context(res_handle
, &resource
))
354 mutex_lock(&resource
->resource_lock
);
356 curr
= resource
->devices
;
358 if (curr
->device
->dev
== dev
) {
360 resource
->devices
= curr
->next
;
362 prev
->next
= curr
->next
;
371 mutex_unlock(&resource
->resource_lock
);
374 /* Unlink dev from all power resources in _PR0 */
375 void acpi_power_resource_unregister_device(struct device
*dev
, acpi_handle handle
)
377 struct acpi_device
*acpi_dev
;
378 struct acpi_handle_list
*list
;
384 if (acpi_bus_get_device(handle
, &acpi_dev
))
387 list
= &acpi_dev
->power
.states
[ACPI_STATE_D0
].resources
;
389 for (i
= 0; i
< list
->count
; i
++)
390 __acpi_power_resource_unregister_device(dev
,
394 static int __acpi_power_resource_register_device(
395 struct acpi_power_managed_device
*powered_device
, acpi_handle handle
)
397 struct acpi_power_resource
*resource
= NULL
;
398 struct acpi_power_resource_device
*power_resource_device
;
401 result
= acpi_power_get_context(handle
, &resource
);
405 power_resource_device
= kzalloc(
406 sizeof(*power_resource_device
), GFP_KERNEL
);
407 if (!power_resource_device
)
410 power_resource_device
->device
= powered_device
;
412 mutex_lock(&resource
->resource_lock
);
413 power_resource_device
->next
= resource
->devices
;
414 resource
->devices
= power_resource_device
;
415 mutex_unlock(&resource
->resource_lock
);
420 /* Link dev to all power resources in _PR0 */
421 int acpi_power_resource_register_device(struct device
*dev
, acpi_handle handle
)
423 struct acpi_device
*acpi_dev
;
424 struct acpi_handle_list
*list
;
425 struct acpi_power_managed_device
*powered_device
;
431 ret
= acpi_bus_get_device(handle
, &acpi_dev
);
433 goto no_power_resource
;
435 if (!acpi_dev
->power
.flags
.power_resources
)
436 goto no_power_resource
;
438 powered_device
= kzalloc(sizeof(*powered_device
), GFP_KERNEL
);
442 powered_device
->dev
= dev
;
443 powered_device
->handle
= handle
;
445 list
= &acpi_dev
->power
.states
[ACPI_STATE_D0
].resources
;
447 for (i
= 0; i
< list
->count
; i
++) {
448 ret
= __acpi_power_resource_register_device(powered_device
,
452 acpi_power_resource_unregister_device(dev
, handle
);
460 printk(KERN_WARNING PREFIX
"Invalid Power Resource to register!");
465 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
466 * ACPI 3.0) _PSW (Power State Wake)
467 * @dev: Device to handle.
468 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
469 * @sleep_state: Target sleep state of the system.
470 * @dev_state: Target power state of the device.
472 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
473 * State Wake) for the device, if present. On failure reset the device's
474 * wakeup.flags.valid flag.
477 * 0 if either _DSW or _PSW has been successfully executed
478 * 0 if neither _DSW nor _PSW has been found
479 * -ENODEV if the execution of either _DSW or _PSW has failed
481 int acpi_device_sleep_wake(struct acpi_device
*dev
,
482 int enable
, int sleep_state
, int dev_state
)
484 union acpi_object in_arg
[3];
485 struct acpi_object_list arg_list
= { 3, in_arg
};
486 acpi_status status
= AE_OK
;
489 * Try to execute _DSW first.
491 * Three agruments are needed for the _DSW object:
492 * Argument 0: enable/disable the wake capabilities
493 * Argument 1: target system state
494 * Argument 2: target device state
495 * When _DSW object is called to disable the wake capabilities, maybe
496 * the first argument is filled. The values of the other two agruments
499 in_arg
[0].type
= ACPI_TYPE_INTEGER
;
500 in_arg
[0].integer
.value
= enable
;
501 in_arg
[1].type
= ACPI_TYPE_INTEGER
;
502 in_arg
[1].integer
.value
= sleep_state
;
503 in_arg
[2].type
= ACPI_TYPE_INTEGER
;
504 in_arg
[2].integer
.value
= dev_state
;
505 status
= acpi_evaluate_object(dev
->handle
, "_DSW", &arg_list
, NULL
);
506 if (ACPI_SUCCESS(status
)) {
508 } else if (status
!= AE_NOT_FOUND
) {
509 printk(KERN_ERR PREFIX
"_DSW execution failed\n");
510 dev
->wakeup
.flags
.valid
= 0;
516 in_arg
[0].integer
.value
= enable
;
517 status
= acpi_evaluate_object(dev
->handle
, "_PSW", &arg_list
, NULL
);
518 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
519 printk(KERN_ERR PREFIX
"_PSW execution failed\n");
520 dev
->wakeup
.flags
.valid
= 0;
528 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
529 * 1. Power on the power resources required for the wakeup device
530 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
531 * State Wake) for the device, if present
533 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int sleep_state
)
537 if (!dev
|| !dev
->wakeup
.flags
.valid
)
540 mutex_lock(&acpi_device_lock
);
542 if (dev
->wakeup
.prepare_count
++)
545 /* Open power resource */
546 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
547 int ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
]);
549 printk(KERN_ERR PREFIX
"Transition power state\n");
550 dev
->wakeup
.flags
.valid
= 0;
557 * Passing 3 as the third argument below means the device may be placed
558 * in arbitrary power state afterwards.
560 err
= acpi_device_sleep_wake(dev
, 1, sleep_state
, 3);
564 dev
->wakeup
.prepare_count
= 0;
567 mutex_unlock(&acpi_device_lock
);
572 * Shutdown a wakeup device, counterpart of above method
573 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
574 * State Wake) for the device, if present
575 * 2. Shutdown down the power resources
577 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
)
581 if (!dev
|| !dev
->wakeup
.flags
.valid
)
584 mutex_lock(&acpi_device_lock
);
586 if (--dev
->wakeup
.prepare_count
> 0)
590 * Executing the code below even if prepare_count is already zero when
591 * the function is called may be useful, for example for initialisation.
593 if (dev
->wakeup
.prepare_count
< 0)
594 dev
->wakeup
.prepare_count
= 0;
596 err
= acpi_device_sleep_wake(dev
, 0, 0, 0);
600 /* Close power resource */
601 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
602 int ret
= acpi_power_off(dev
->wakeup
.resources
.handles
[i
]);
604 printk(KERN_ERR PREFIX
"Transition power state\n");
605 dev
->wakeup
.flags
.valid
= 0;
612 mutex_unlock(&acpi_device_lock
);
616 /* --------------------------------------------------------------------------
617 Device Power Management
618 -------------------------------------------------------------------------- */
620 int acpi_power_get_inferred_state(struct acpi_device
*device
, int *state
)
623 struct acpi_handle_list
*list
= NULL
;
627 if (!device
|| !state
)
631 * We know a device's inferred power state when all the resources
632 * required for a given D-state are 'on'.
634 for (i
= ACPI_STATE_D0
; i
< ACPI_STATE_D3
; i
++) {
635 list
= &device
->power
.states
[i
].resources
;
639 result
= acpi_power_get_list_state(list
, &list_state
);
643 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
649 *state
= ACPI_STATE_D3
;
653 int acpi_power_on_resources(struct acpi_device
*device
, int state
)
655 if (!device
|| state
< ACPI_STATE_D0
|| state
> ACPI_STATE_D3
)
658 return acpi_power_on_list(&device
->power
.states
[state
].resources
);
661 int acpi_power_transition(struct acpi_device
*device
, int state
)
665 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3_COLD
))
668 if (device
->power
.state
== state
)
671 if ((device
->power
.state
< ACPI_STATE_D0
)
672 || (device
->power
.state
> ACPI_STATE_D3_COLD
))
675 /* TBD: Resources must be ordered. */
678 * First we reference all power resources required in the target list
679 * (e.g. so the device doesn't lose power while transitioning). Then,
680 * we dereference all power resources used in the current list.
682 result
= acpi_power_on_list(&device
->power
.states
[state
].resources
);
685 &device
->power
.states
[device
->power
.state
].resources
);
687 /* We shouldn't change the state unless the above operations succeed. */
688 device
->power
.state
= result
? ACPI_STATE_UNKNOWN
: state
;
693 /* --------------------------------------------------------------------------
695 -------------------------------------------------------------------------- */
697 static int acpi_power_add(struct acpi_device
*device
)
699 int result
= 0, state
;
700 acpi_status status
= AE_OK
;
701 struct acpi_power_resource
*resource
= NULL
;
702 union acpi_object acpi_object
;
703 struct acpi_buffer buffer
= { sizeof(acpi_object
), &acpi_object
};
709 resource
= kzalloc(sizeof(struct acpi_power_resource
), GFP_KERNEL
);
713 resource
->device
= device
;
714 mutex_init(&resource
->resource_lock
);
715 strcpy(resource
->name
, device
->pnp
.bus_id
);
716 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
717 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
718 device
->driver_data
= resource
;
720 /* Evalute the object to get the system level and resource order. */
721 status
= acpi_evaluate_object(device
->handle
, NULL
, NULL
, &buffer
);
722 if (ACPI_FAILURE(status
)) {
726 resource
->system_level
= acpi_object
.power_resource
.system_level
;
727 resource
->order
= acpi_object
.power_resource
.resource_order
;
729 result
= acpi_power_get_state(device
->handle
, &state
);
734 case ACPI_POWER_RESOURCE_STATE_ON
:
735 device
->power
.state
= ACPI_STATE_D0
;
737 case ACPI_POWER_RESOURCE_STATE_OFF
:
738 device
->power
.state
= ACPI_STATE_D3
;
741 device
->power
.state
= ACPI_STATE_UNKNOWN
;
745 printk(KERN_INFO PREFIX
"%s [%s] (%s)\n", acpi_device_name(device
),
746 acpi_device_bid(device
), state
? "on" : "off");
755 static int acpi_power_remove(struct acpi_device
*device
, int type
)
757 struct acpi_power_resource
*resource
;
762 resource
= acpi_driver_data(device
);
771 static int acpi_power_resume(struct acpi_device
*device
)
773 int result
= 0, state
;
774 struct acpi_power_resource
*resource
;
779 resource
= acpi_driver_data(device
);
783 mutex_lock(&resource
->resource_lock
);
785 result
= acpi_power_get_state(device
->handle
, &state
);
789 if (state
== ACPI_POWER_RESOURCE_STATE_OFF
&& resource
->ref_count
)
790 result
= __acpi_power_on(resource
);
793 mutex_unlock(&resource
->resource_lock
);
798 int __init
acpi_power_init(void)
800 INIT_LIST_HEAD(&acpi_power_resource_list
);
801 return acpi_bus_register_driver(&acpi_power_driver
);