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.
39 * Modified for ReactOS and latest ACPICA
40 * Copyright (C)2009 Samuel Serapion
46 #include <acpi_drivers.h>
53 #define _COMPONENT ACPI_POWER_COMPONENT
54 ACPI_MODULE_NAME ("acpi_power")
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
;
62 static int acpi_power_add (struct acpi_device
*device
);
63 static int acpi_power_remove (struct acpi_device
*device
, int type
);
64 static int acpi_power_resume(struct acpi_device
*device
, int state
);
66 static struct acpi_driver acpi_power_driver
= {
68 ACPI_POWER_DRIVER_NAME
,
73 {acpi_power_add
, acpi_power_remove
, NULL
, NULL
, acpi_power_resume
}
76 struct acpi_power_reference
{
77 struct list_head node
;
78 struct acpi_device
*device
;
81 struct acpi_power_resource
83 struct acpi_device
* device
;
87 //struct mutex resource_lock;
88 struct list_head reference
;
91 static struct list_head acpi_power_resource_list
;
94 /* --------------------------------------------------------------------------
95 Power Resource Management
96 -------------------------------------------------------------------------- */
99 acpi_power_get_context (
101 struct acpi_power_resource
**resource
)
104 struct acpi_device
*device
= NULL
;
109 result
= acpi_bus_get_device(handle
, &device
);
111 ACPI_DEBUG_PRINT((ACPI_DB_WARN
, "Error getting context [%p]\n",
113 return_VALUE(result
);
116 *resource
= (struct acpi_power_resource
*) acpi_driver_data(device
);
125 acpi_power_get_state (
129 ACPI_STATUS status
= AE_OK
;
130 unsigned long long sta
= 0;
132 ACPI_BUFFER buffer
= { sizeof(node_name
), node_name
};
135 if (!handle
|| !state
)
138 status
= acpi_evaluate_integer(handle
, "_STA", NULL
, &sta
);
139 if (ACPI_FAILURE(status
))
142 *state
= (sta
& 0x01)?ACPI_POWER_RESOURCE_STATE_ON
:
143 ACPI_POWER_RESOURCE_STATE_OFF
;
145 AcpiGetName(handle
, ACPI_SINGLE_NAME
, &buffer
);
147 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
148 node_name
, *state
?"on":"off"));
155 acpi_power_get_list_state (
156 struct acpi_handle_list
*list
,
159 int result
= 0, state1
;
165 /* The state of the list is 'on' IFF all resources are 'on'. */
167 for (i
=0; i
<list
->count
; i
++) {
169 * The state of the power resource can be obtained by
170 * using the ACPI handle. In such case it is unnecessary to
171 * get the Power resource first and then get its state again.
173 result
= acpi_power_get_state(list
->handles
[i
], &state1
);
179 if (*state
!= ACPI_POWER_RESOURCE_STATE_ON
)
183 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
192 ACPI_HANDLE handle
, struct acpi_device
*dev
)
196 ACPI_STATUS status
= AE_OK
;
197 struct acpi_power_resource
*resource
= NULL
;
198 struct list_head
*node
, *next
;
199 struct acpi_power_reference
*ref
;
201 result
= acpi_power_get_context(handle
, &resource
);
205 //mutex_lock(&resource->resource_lock);
206 list_for_each_safe(node
, next
, &resource
->reference
) {
207 ref
= container_of(node
, struct acpi_power_reference
, node
);
208 if (dev
->handle
== ref
->device
->handle
) {
209 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] already referenced by resource [%s]\n",
210 dev
->pnp
.bus_id
, resource
->name
));
217 ref
= ExAllocatePoolWithTag(NonPagedPool
,sizeof (struct acpi_power_reference
),'IPCA');
219 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "kmalloc() failed\n"));
220 //mutex_unlock(&resource->resource_lock);
223 list_add_tail(&ref
->node
, &resource
->reference
);
225 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] added to resource [%s] references\n",
226 dev
->pnp
.bus_id
, resource
->name
));
228 //mutex_unlock(&resource->resource_lock);
230 status
= AcpiEvaluateObject(resource
->device
->handle
, "_ON", NULL
, NULL
);
231 if (ACPI_FAILURE(status
))
234 /* Update the power resource's _device_ power state */
235 resource
->device
->power
.state
= ACPI_STATE_D0
;
242 acpi_power_off_device (
244 struct acpi_device
*dev
)
247 ACPI_STATUS status
= AE_OK
;
248 struct acpi_power_resource
*resource
= NULL
;
249 struct list_head
*node
, *next
;
250 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
= AcpiEvaluateObject(resource
->device
->handle
, "_OFF", NULL
, NULL
);
277 if (ACPI_FAILURE(status
))
280 /* Update the power resource's _device_ power state */
281 resource
->device
->power
.state
= ACPI_STATE_D3
;
283 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned off\n",
290 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
291 * ACPI 3.0) _PSW (Power State Wake)
292 * @dev: Device to handle.
293 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
294 * @sleep_state: Target sleep state of the system.
295 * @dev_state: Target power state of the device.
297 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
298 * State Wake) for the device, if present. On failure reset the device's
299 * wakeup.flags.valid flag.
302 * 0 if either _DSW or _PSW has been successfully executed
303 * 0 if neither _DSW nor _PSW has been found
304 * -ENODEV if the execution of either _DSW or _PSW has failed
306 int acpi_device_sleep_wake(struct acpi_device
*dev
,
307 int enable
, int sleep_state
, int dev_state
)
309 union acpi_object in_arg
[3];
310 struct acpi_object_list arg_list
= { 3, in_arg
};
311 ACPI_STATUS status
= AE_OK
;
314 * Try to execute _DSW first.
316 * Three agruments are needed for the _DSW object:
317 * Argument 0: enable/disable the wake capabilities
318 * Argument 1: target system state
319 * Argument 2: target device state
320 * When _DSW object is called to disable the wake capabilities, maybe
321 * the first argument is filled. The values of the other two agruments
324 in_arg
[0].Type
= ACPI_TYPE_INTEGER
;
325 in_arg
[0].Integer
.Value
= enable
;
326 in_arg
[1].Type
= ACPI_TYPE_INTEGER
;
327 in_arg
[1].Integer
.Value
= sleep_state
;
328 in_arg
[2].Type
= ACPI_TYPE_INTEGER
;
329 in_arg
[2].Integer
.Value
= dev_state
;
330 status
= AcpiEvaluateObject(dev
->handle
, "_DSW", &arg_list
, NULL
);
331 if (ACPI_SUCCESS(status
)) {
333 } else if (status
!= AE_NOT_FOUND
) {
334 DPRINT1("_DSW execution failed\n");
335 dev
->wakeup
.flags
.valid
= 0;
341 in_arg
[0].Integer
.Value
= enable
;
342 status
= AcpiEvaluateObject(dev
->handle
, "_PSW", &arg_list
, NULL
);
343 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
344 DPRINT1("_PSW execution failed\n");
345 dev
->wakeup
.flags
.valid
= 0;
353 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
354 * 1. Power on the power resources required for the wakeup device
355 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
356 * State Wake) for the device, if present
358 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int sleep_state
)
362 if (!dev
|| !dev
->wakeup
.flags
.valid
)
365 //mutex_lock(&acpi_device_lock);
367 if (dev
->wakeup
.prepare_count
++)
370 /* Open power resource */
371 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
372 int ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
], dev
);
374 DPRINT( "Transition power state\n");
375 dev
->wakeup
.flags
.valid
= 0;
382 * Passing 3 as the third argument below means the device may be placed
383 * in arbitrary power state afterwards.
385 err
= acpi_device_sleep_wake(dev
, 1, sleep_state
, 3);
389 dev
->wakeup
.prepare_count
= 0;
392 //mutex_unlock(&acpi_device_lock);
397 * Shutdown a wakeup device, counterpart of above method
398 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
399 * State Wake) for the device, if present
400 * 2. Shutdown down the power resources
402 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
)
406 if (!dev
|| !dev
->wakeup
.flags
.valid
)
409 //mutex_lock(&acpi_device_lock);
411 if (--dev
->wakeup
.prepare_count
> 0)
415 * Executing the code below even if prepare_count is already zero when
416 * the function is called may be useful, for example for initialisation.
418 if (dev
->wakeup
.prepare_count
< 0)
419 dev
->wakeup
.prepare_count
= 0;
421 err
= acpi_device_sleep_wake(dev
, 0, 0, 0);
425 /* Close power resource */
426 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
427 int ret
= acpi_power_off_device(
428 dev
->wakeup
.resources
.handles
[i
], dev
);
430 DPRINT("Transition power state\n");
431 dev
->wakeup
.flags
.valid
= 0;
438 //mutex_unlock(&acpi_device_lock);
442 /* --------------------------------------------------------------------------
443 Device Power Management
444 -------------------------------------------------------------------------- */
447 acpi_power_get_inferred_state (
448 struct acpi_device
*device
)
451 struct acpi_handle_list
*list
= NULL
;
459 device
->power
.state
= ACPI_STATE_UNKNOWN
;
462 * We know a device's inferred power state when all the resources
463 * required for a given D-state are 'on'.
465 for (i
=ACPI_STATE_D0
; i
<ACPI_STATE_D3
; i
++) {
466 list
= &device
->power
.states
[i
].resources
;
470 result
= acpi_power_get_list_state(list
, &list_state
);
472 return_VALUE(result
);
474 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
475 device
->power
.state
= i
;
480 device
->power
.state
= ACPI_STATE_D3
;
487 acpi_power_transition (
488 struct acpi_device
*device
,
492 struct acpi_handle_list
*cl
= NULL
; /* Current Resources */
493 struct acpi_handle_list
*tl
= NULL
; /* Target Resources */
496 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3
))
499 if ((device
->power
.state
< ACPI_STATE_D0
) || (device
->power
.state
> ACPI_STATE_D3
))
502 cl
= &device
->power
.states
[device
->power
.state
].resources
;
503 tl
= &device
->power
.states
[state
].resources
;
505 /* TBD: Resources must be ordered. */
508 * First we reference all power resources required in the target list
509 * (e.g. so the device doesn't lose power while transitioning).
511 for (i
= 0; i
< tl
->count
; i
++) {
512 result
= acpi_power_on(tl
->handles
[i
], device
);
517 if (device
->power
.state
== state
) {
522 * Then we dereference all power resources used in the current list.
524 for (i
= 0; i
< cl
->count
; i
++) {
525 result
= acpi_power_off_device(cl
->handles
[i
], device
);
532 device
->power
.state
= ACPI_STATE_UNKNOWN
;
534 /* We shouldn't change the state till all above operations succeed */
535 device
->power
.state
= state
;
541 /* --------------------------------------------------------------------------
543 -------------------------------------------------------------------------- */
547 struct acpi_device
*device
)
549 int result
= 0, state
;
550 ACPI_STATUS status
= AE_OK
;
551 struct acpi_power_resource
*resource
= NULL
;
552 union acpi_object acpi_object
;
553 ACPI_BUFFER buffer
= {sizeof(ACPI_OBJECT
), &acpi_object
};
559 resource
= ExAllocatePoolWithTag(NonPagedPool
,sizeof(struct acpi_power_resource
),'IPCA');
563 resource
->device
= device
;
564 //mutex_init(&resource->resource_lock);
565 INIT_LIST_HEAD(&resource
->reference
);
567 strcpy(resource
->name
, device
->pnp
.bus_id
);
568 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
569 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
570 device
->driver_data
= resource
;
572 /* Evalute the object to get the system level and resource order. */
573 status
= AcpiEvaluateObject(device
->handle
, NULL
, NULL
, &buffer
);
574 if (ACPI_FAILURE(status
)) {
578 resource
->system_level
= acpi_object
.PowerResource
.SystemLevel
;
579 resource
->order
= acpi_object
.PowerResource
.ResourceOrder
;
581 result
= acpi_power_get_state(device
->handle
, &state
);
586 case ACPI_POWER_RESOURCE_STATE_ON
:
587 device
->power
.state
= ACPI_STATE_D0
;
589 case ACPI_POWER_RESOURCE_STATE_OFF
:
590 device
->power
.state
= ACPI_STATE_D3
;
593 device
->power
.state
= ACPI_STATE_UNKNOWN
;
598 DPRINT("%s [%s] (%s)\n", acpi_device_name(device
),
599 acpi_device_bid(device
), state
?"on":"off");
603 ExFreePool(resource
);
611 struct acpi_device
*device
,
614 struct acpi_power_resource
*resource
= NULL
;
615 struct list_head
*node
, *next
;
617 if (!device
|| !acpi_driver_data(device
))
620 resource
= acpi_driver_data(device
);
622 //mutex_lock(&resource->resource_lock);
623 list_for_each_safe(node
, next
, &resource
->reference
) {
624 struct acpi_power_reference
*ref
= container_of(node
, struct acpi_power_reference
, node
);
625 list_del(&ref
->node
);
628 //mutex_unlock(&resource->resource_lock);
629 ExFreePool(resource
);
634 static int acpi_power_resume(struct acpi_device
*device
, int state
)
637 struct acpi_power_resource
*resource
= NULL
;
638 struct acpi_power_reference
*ref
;
640 if (!device
|| !acpi_driver_data(device
))
643 resource
= acpi_driver_data(device
);
645 result
= acpi_power_get_state(device
->handle
, &state
);
649 //mutex_lock(&resource->resource_lock);
650 if (state
== ACPI_POWER_RESOURCE_STATE_OFF
&&
651 !list_empty(&resource
->reference
)) {
652 ref
= container_of(resource
->reference
.next
, struct acpi_power_reference
, node
);
653 //mutex_unlock(&resource->resource_lock);
654 result
= acpi_power_on(device
->handle
, ref
->device
);
658 //mutex_unlock(&resource->resource_lock);
663 acpi_power_init (void)
667 DPRINT("acpi_power_init");
669 INIT_LIST_HEAD(&acpi_power_resource_list
);
672 result
= acpi_bus_register_driver(&acpi_power_driver
);