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
48 #define _COMPONENT ACPI_POWER_COMPONENT
49 ACPI_MODULE_NAME ("acpi_power")
51 #define ACPI_POWER_RESOURCE_STATE_OFF 0x00
52 #define ACPI_POWER_RESOURCE_STATE_ON 0x01
53 #define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
55 int acpi_power_nocheck
;
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
, int state
);
61 static struct acpi_driver acpi_power_driver
= {
63 ACPI_POWER_DRIVER_NAME
,
68 {acpi_power_add
, acpi_power_remove
, NULL
, NULL
, acpi_power_resume
}
71 struct acpi_power_reference
{
72 struct list_head node
;
73 struct acpi_device
*device
;
76 struct acpi_power_resource
78 struct acpi_device
* device
;
82 //struct mutex resource_lock;
83 struct list_head reference
;
86 static struct list_head acpi_power_resource_list
;
89 /* --------------------------------------------------------------------------
90 Power Resource Management
91 -------------------------------------------------------------------------- */
94 acpi_power_get_context (
96 struct acpi_power_resource
**resource
)
99 struct acpi_device
*device
= NULL
;
104 result
= acpi_bus_get_device(handle
, &device
);
106 ACPI_DEBUG_PRINT((ACPI_DB_WARN
, "Error getting context [%p]\n",
108 return_VALUE(result
);
111 *resource
= (struct acpi_power_resource
*) acpi_driver_data(device
);
120 acpi_power_get_state (
124 ACPI_STATUS status
= AE_OK
;
125 unsigned long long sta
= 0;
127 ACPI_BUFFER buffer
= { sizeof(node_name
), node_name
};
130 if (!handle
|| !state
)
133 status
= acpi_evaluate_integer(handle
, "_STA", NULL
, &sta
);
134 if (ACPI_FAILURE(status
))
137 *state
= (sta
& 0x01)?ACPI_POWER_RESOURCE_STATE_ON
:
138 ACPI_POWER_RESOURCE_STATE_OFF
;
140 AcpiGetName(handle
, ACPI_SINGLE_NAME
, &buffer
);
142 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
143 node_name
, *state
?"on":"off"));
150 acpi_power_get_list_state (
151 struct acpi_handle_list
*list
,
154 int result
= 0, state1
;
160 /* The state of the list is 'on' IFF all resources are 'on'. */
162 for (i
=0; i
<list
->count
; i
++) {
164 * The state of the power resource can be obtained by
165 * using the ACPI handle. In such case it is unnecessary to
166 * get the Power resource first and then get its state again.
168 result
= acpi_power_get_state(list
->handles
[i
], &state1
);
174 if (*state
!= ACPI_POWER_RESOURCE_STATE_ON
)
178 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
187 ACPI_HANDLE handle
, struct acpi_device
*dev
)
191 ACPI_STATUS status
= AE_OK
;
192 struct acpi_power_resource
*resource
= NULL
;
193 struct list_head
*node
, *next
;
194 struct acpi_power_reference
*ref
;
196 result
= acpi_power_get_context(handle
, &resource
);
200 //mutex_lock(&resource->resource_lock);
201 list_for_each_safe(node
, next
, &resource
->reference
) {
202 ref
= container_of(node
, struct acpi_power_reference
, node
);
203 if (dev
->handle
== ref
->device
->handle
) {
204 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] already referenced by resource [%s]\n",
205 dev
->pnp
.bus_id
, resource
->name
));
212 ref
= ExAllocatePoolWithTag(NonPagedPool
,sizeof (struct acpi_power_reference
),'IPCA');
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
= AcpiEvaluateObject(resource
->device
->handle
, "_ON", NULL
, NULL
);
226 if (ACPI_FAILURE(status
))
229 /* Update the power resource's _device_ power state */
230 resource
->device
->power
.state
= ACPI_STATE_D0
;
237 acpi_power_off_device (
239 struct acpi_device
*dev
)
242 ACPI_STATUS status
= AE_OK
;
243 struct acpi_power_resource
*resource
= NULL
;
244 struct list_head
*node
, *next
;
245 struct acpi_power_reference
*ref
;
247 result
= acpi_power_get_context(handle
, &resource
);
251 //mutex_lock(&resource->resource_lock);
252 list_for_each_safe(node
, next
, &resource
->reference
) {
253 ref
= container_of(node
, struct acpi_power_reference
, node
);
254 if (dev
->handle
== ref
->device
->handle
) {
255 list_del(&ref
->node
);
257 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Device [%s] removed from resource [%s] references\n",
258 dev
->pnp
.bus_id
, resource
->name
));
263 if (!list_empty(&resource
->reference
)) {
264 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Cannot turn resource [%s] off - resource is in use\n",
266 //mutex_unlock(&resource->resource_lock);
269 //mutex_unlock(&resource->resource_lock);
271 status
= AcpiEvaluateObject(resource
->device
->handle
, "_OFF", NULL
, NULL
);
272 if (ACPI_FAILURE(status
))
275 /* Update the power resource's _device_ power state */
276 resource
->device
->power
.state
= ACPI_STATE_D3
;
278 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned off\n",
285 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
286 * ACPI 3.0) _PSW (Power State Wake)
287 * @dev: Device to handle.
288 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
289 * @sleep_state: Target sleep state of the system.
290 * @dev_state: Target power state of the device.
292 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
293 * State Wake) for the device, if present. On failure reset the device's
294 * wakeup.flags.valid flag.
297 * 0 if either _DSW or _PSW has been successfully executed
298 * 0 if neither _DSW nor _PSW has been found
299 * -ENODEV if the execution of either _DSW or _PSW has failed
301 int acpi_device_sleep_wake(struct acpi_device
*dev
,
302 int enable
, int sleep_state
, int dev_state
)
304 union acpi_object in_arg
[3];
305 struct acpi_object_list arg_list
= { 3, in_arg
};
306 ACPI_STATUS status
= AE_OK
;
309 * Try to execute _DSW first.
311 * Three agruments are needed for the _DSW object:
312 * Argument 0: enable/disable the wake capabilities
313 * Argument 1: target system state
314 * Argument 2: target device state
315 * When _DSW object is called to disable the wake capabilities, maybe
316 * the first argument is filled. The values of the other two agruments
319 in_arg
[0].Type
= ACPI_TYPE_INTEGER
;
320 in_arg
[0].Integer
.Value
= enable
;
321 in_arg
[1].Type
= ACPI_TYPE_INTEGER
;
322 in_arg
[1].Integer
.Value
= sleep_state
;
323 in_arg
[2].Type
= ACPI_TYPE_INTEGER
;
324 in_arg
[2].Integer
.Value
= dev_state
;
325 status
= AcpiEvaluateObject(dev
->handle
, "_DSW", &arg_list
, NULL
);
326 if (ACPI_SUCCESS(status
)) {
328 } else if (status
!= AE_NOT_FOUND
) {
329 DPRINT1("_DSW execution failed\n");
330 dev
->wakeup
.flags
.valid
= 0;
336 in_arg
[0].Integer
.Value
= enable
;
337 status
= AcpiEvaluateObject(dev
->handle
, "_PSW", &arg_list
, NULL
);
338 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
339 DPRINT1("_PSW execution failed\n");
340 dev
->wakeup
.flags
.valid
= 0;
348 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
349 * 1. Power on the power resources required for the wakeup device
350 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
351 * State Wake) for the device, if present
353 int acpi_enable_wakeup_device_power(struct acpi_device
*dev
, int sleep_state
)
357 if (!dev
|| !dev
->wakeup
.flags
.valid
)
360 //mutex_lock(&acpi_device_lock);
362 if (dev
->wakeup
.prepare_count
++)
365 /* Open power resource */
366 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
367 int ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
], dev
);
369 DPRINT( "Transition power state\n");
370 dev
->wakeup
.flags
.valid
= 0;
377 * Passing 3 as the third argument below means the device may be placed
378 * in arbitrary power state afterwards.
380 err
= acpi_device_sleep_wake(dev
, 1, sleep_state
, 3);
384 dev
->wakeup
.prepare_count
= 0;
387 //mutex_unlock(&acpi_device_lock);
392 * Shutdown a wakeup device, counterpart of above method
393 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
394 * State Wake) for the device, if present
395 * 2. Shutdown down the power resources
397 int acpi_disable_wakeup_device_power(struct acpi_device
*dev
)
401 if (!dev
|| !dev
->wakeup
.flags
.valid
)
404 //mutex_lock(&acpi_device_lock);
406 if (--dev
->wakeup
.prepare_count
> 0)
410 * Executing the code below even if prepare_count is already zero when
411 * the function is called may be useful, for example for initialisation.
413 if (dev
->wakeup
.prepare_count
< 0)
414 dev
->wakeup
.prepare_count
= 0;
416 err
= acpi_device_sleep_wake(dev
, 0, 0, 0);
420 /* Close power resource */
421 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
422 int ret
= acpi_power_off_device(
423 dev
->wakeup
.resources
.handles
[i
], dev
);
425 DPRINT("Transition power state\n");
426 dev
->wakeup
.flags
.valid
= 0;
433 //mutex_unlock(&acpi_device_lock);
437 /* --------------------------------------------------------------------------
438 Device Power Management
439 -------------------------------------------------------------------------- */
442 acpi_power_get_inferred_state (
443 struct acpi_device
*device
)
446 struct acpi_handle_list
*list
= NULL
;
454 device
->power
.state
= ACPI_STATE_UNKNOWN
;
457 * We know a device's inferred power state when all the resources
458 * required for a given D-state are 'on'.
460 for (i
=ACPI_STATE_D0
; i
<ACPI_STATE_D3
; i
++) {
461 list
= &device
->power
.states
[i
].resources
;
465 result
= acpi_power_get_list_state(list
, &list_state
);
467 return_VALUE(result
);
469 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
470 device
->power
.state
= i
;
475 device
->power
.state
= ACPI_STATE_D3
;
482 acpi_power_transition (
483 struct acpi_device
*device
,
487 struct acpi_handle_list
*cl
= NULL
; /* Current Resources */
488 struct acpi_handle_list
*tl
= NULL
; /* Target Resources */
491 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3
))
494 if ((device
->power
.state
< ACPI_STATE_D0
) || (device
->power
.state
> ACPI_STATE_D3
))
497 cl
= &device
->power
.states
[device
->power
.state
].resources
;
498 tl
= &device
->power
.states
[state
].resources
;
500 /* TBD: Resources must be ordered. */
503 * First we reference all power resources required in the target list
504 * (e.g. so the device doesn't lose power while transitioning).
506 for (i
= 0; i
< tl
->count
; i
++) {
507 result
= acpi_power_on(tl
->handles
[i
], device
);
512 if (device
->power
.state
== state
) {
517 * Then we dereference all power resources used in the current list.
519 for (i
= 0; i
< cl
->count
; i
++) {
520 result
= acpi_power_off_device(cl
->handles
[i
], device
);
527 device
->power
.state
= ACPI_STATE_UNKNOWN
;
529 /* We shouldn't change the state till all above operations succeed */
530 device
->power
.state
= state
;
536 /* --------------------------------------------------------------------------
538 -------------------------------------------------------------------------- */
542 struct acpi_device
*device
)
544 int result
= 0, state
;
545 ACPI_STATUS status
= AE_OK
;
546 struct acpi_power_resource
*resource
= NULL
;
547 union acpi_object acpi_object
;
548 ACPI_BUFFER buffer
= {sizeof(ACPI_OBJECT
), &acpi_object
};
554 resource
= ExAllocatePoolWithTag(NonPagedPool
,sizeof(struct acpi_power_resource
),'IPCA');
558 resource
->device
= device
;
559 //mutex_init(&resource->resource_lock);
560 INIT_LIST_HEAD(&resource
->reference
);
562 strcpy(resource
->name
, device
->pnp
.bus_id
);
563 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
564 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
565 device
->driver_data
= resource
;
567 /* Evalute the object to get the system level and resource order. */
568 status
= AcpiEvaluateObject(device
->handle
, NULL
, NULL
, &buffer
);
569 if (ACPI_FAILURE(status
)) {
573 resource
->system_level
= acpi_object
.PowerResource
.SystemLevel
;
574 resource
->order
= acpi_object
.PowerResource
.ResourceOrder
;
576 result
= acpi_power_get_state(device
->handle
, &state
);
581 case ACPI_POWER_RESOURCE_STATE_ON
:
582 device
->power
.state
= ACPI_STATE_D0
;
584 case ACPI_POWER_RESOURCE_STATE_OFF
:
585 device
->power
.state
= ACPI_STATE_D3
;
588 device
->power
.state
= ACPI_STATE_UNKNOWN
;
593 DPRINT("%s [%s] (%s)\n", acpi_device_name(device
),
594 acpi_device_bid(device
), state
?"on":"off");
598 ExFreePool(resource
);
606 struct acpi_device
*device
,
609 struct acpi_power_resource
*resource
= NULL
;
610 struct list_head
*node
, *next
;
612 if (!device
|| !acpi_driver_data(device
))
615 resource
= acpi_driver_data(device
);
617 //mutex_lock(&resource->resource_lock);
618 list_for_each_safe(node
, next
, &resource
->reference
) {
619 struct acpi_power_reference
*ref
= container_of(node
, struct acpi_power_reference
, node
);
620 list_del(&ref
->node
);
623 //mutex_unlock(&resource->resource_lock);
624 ExFreePool(resource
);
629 static int acpi_power_resume(struct acpi_device
*device
, int state
)
632 struct acpi_power_resource
*resource
= NULL
;
633 struct acpi_power_reference
*ref
;
635 if (!device
|| !acpi_driver_data(device
))
638 resource
= acpi_driver_data(device
);
640 result
= acpi_power_get_state(device
->handle
, &state
);
644 //mutex_lock(&resource->resource_lock);
645 if (state
== ACPI_POWER_RESOURCE_STATE_OFF
&&
646 !list_empty(&resource
->reference
)) {
647 ref
= container_of(resource
->reference
.next
, struct acpi_power_reference
, node
);
648 //mutex_unlock(&resource->resource_lock);
649 result
= acpi_power_on(device
->handle
, ref
->device
);
653 //mutex_unlock(&resource->resource_lock);
658 acpi_power_init (void)
662 DPRINT("acpi_power_init");
664 INIT_LIST_HEAD(&acpi_power_resource_list
);
667 result
= acpi_bus_register_driver(&acpi_power_driver
);