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 _COMPONENT ACPI_POWER_COMPONENT
49 ACPI_MODULE_NAME ("acpi_power")
51 #define ACPI_POWER_COMPONENT 0x00800000
52 #define ACPI_POWER_CLASS "power_resource"
53 #define ACPI_POWER_DRIVER_NAME "ACPI Power Resource Driver"
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_open_fs(struct inode
*inode
, struct file
*file
);
65 static struct acpi_driver acpi_power_driver
= {
66 .name
= ACPI_POWER_DRIVER_NAME
,
67 .class = ACPI_POWER_CLASS
,
68 .ids
= ACPI_POWER_HID
,
70 .add
= acpi_power_add
,
71 .remove
= acpi_power_remove
,
75 struct acpi_power_resource
85 static struct list_head acpi_power_resource_list
;
87 static struct file_operations acpi_power_fops
= {
88 .open
= acpi_power_open_fs
,
91 .release
= single_release
,
94 /* --------------------------------------------------------------------------
95 Power Resource Management
96 -------------------------------------------------------------------------- */
99 acpi_power_get_context (
101 struct acpi_power_resource
**resource
)
104 struct acpi_device
*device
= NULL
;
106 ACPI_FUNCTION_TRACE("acpi_power_get_context");
109 return_VALUE(-ENODEV
);
111 result
= acpi_bus_get_device(handle
, &device
);
113 ACPI_DEBUG_PRINT((ACPI_DB_WARN
, "Error getting context [%p]\n",
115 return_VALUE(result
);
118 *resource
= (struct acpi_power_resource
*) acpi_driver_data(device
);
120 return_VALUE(-ENODEV
);
127 acpi_power_get_state (
128 struct acpi_power_resource
*resource
)
130 acpi_status status
= AE_OK
;
131 unsigned long sta
= 0;
133 ACPI_FUNCTION_TRACE("acpi_power_get_state");
136 return_VALUE(-EINVAL
);
138 status
= acpi_evaluate_integer(resource
->handle
, "_STA", NULL
, &sta
);
139 if (ACPI_FAILURE(status
))
140 return_VALUE(-ENODEV
);
143 resource
->state
= ACPI_POWER_RESOURCE_STATE_ON
;
145 resource
->state
= ACPI_POWER_RESOURCE_STATE_OFF
;
147 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] is %s\n",
148 resource
->name
, resource
->state
?"on":"off"));
155 acpi_power_get_list_state (
156 struct acpi_handle_list
*list
,
160 struct acpi_power_resource
*resource
= NULL
;
163 ACPI_FUNCTION_TRACE("acpi_power_get_list_state");
166 return_VALUE(-EINVAL
);
168 /* The state of the list is 'on' IFF all resources are 'on'. */
170 for (i
=0; i
<list
->count
; i
++) {
171 result
= acpi_power_get_context(list
->handles
[i
], &resource
);
173 return_VALUE(result
);
174 result
= acpi_power_get_state(resource
);
176 return_VALUE(result
);
178 *state
= resource
->state
;
180 if (*state
!= ACPI_POWER_RESOURCE_STATE_ON
)
184 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource list is %s\n",
187 return_VALUE(result
);
196 acpi_status status
= AE_OK
;
197 struct acpi_device
*device
= NULL
;
198 struct acpi_power_resource
*resource
= NULL
;
200 ACPI_FUNCTION_TRACE("acpi_power_on");
202 result
= acpi_power_get_context(handle
, &resource
);
204 return_VALUE(result
);
206 resource
->references
++;
208 if ((resource
->references
> 1)
209 || (resource
->state
== ACPI_POWER_RESOURCE_STATE_ON
)) {
210 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] already on\n",
215 status
= acpi_evaluate_object(resource
->handle
, "_ON", NULL
, NULL
);
216 if (ACPI_FAILURE(status
))
217 return_VALUE(-ENODEV
);
219 result
= acpi_power_get_state(resource
);
221 return_VALUE(result
);
222 if (resource
->state
!= ACPI_POWER_RESOURCE_STATE_ON
)
223 return_VALUE(-ENOEXEC
);
225 /* Update the power resource's _device_ power state */
226 result
= acpi_bus_get_device(resource
->handle
, &device
);
228 return_VALUE(result
);
229 device
->power
.state
= ACPI_STATE_D0
;
231 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned on\n",
239 acpi_power_off_device (
243 acpi_status status
= AE_OK
;
244 struct acpi_device
*device
= NULL
;
245 struct acpi_power_resource
*resource
= NULL
;
247 ACPI_FUNCTION_TRACE("acpi_power_off_device");
249 result
= acpi_power_get_context(handle
, &resource
);
251 return_VALUE(result
);
253 if (resource
->references
)
254 resource
->references
--;
256 if (resource
->references
) {
257 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
258 "Resource [%s] is still in use, dereferencing\n",
259 device
->pnp
.bus_id
));
263 if (resource
->state
== ACPI_POWER_RESOURCE_STATE_OFF
) {
264 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] already off\n",
265 device
->pnp
.bus_id
));
269 status
= acpi_evaluate_object(resource
->handle
, "_OFF", NULL
, NULL
);
270 if (ACPI_FAILURE(status
))
271 return_VALUE(-ENODEV
);
273 result
= acpi_power_get_state(resource
);
275 return_VALUE(result
);
276 if (resource
->state
!= ACPI_POWER_RESOURCE_STATE_OFF
)
277 return_VALUE(-ENOEXEC
);
279 /* Update the power resource's _device_ power state */
280 result
= acpi_bus_get_device(resource
->handle
, &device
);
282 return_VALUE(result
);
283 device
->power
.state
= ACPI_STATE_D3
;
285 ACPI_DEBUG_PRINT((ACPI_DB_INFO
, "Resource [%s] turned off\n",
292 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
293 * 1. Power on the power resources required for the wakeup device
294 * 2. Enable _PSW (power state wake) for the device if present
296 int acpi_enable_wakeup_device_power (struct acpi_device
*dev
)
298 union acpi_object arg
= {ACPI_TYPE_INTEGER
};
299 struct acpi_object_list arg_list
= {1, &arg
};
300 acpi_status status
= AE_OK
;
304 ACPI_FUNCTION_TRACE("acpi_enable_wakeup_device_power");
305 if (!dev
|| !dev
->wakeup
.flags
.valid
)
308 arg
.integer
.value
= 1;
309 /* Open power resource */
310 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
311 ret
= acpi_power_on(dev
->wakeup
.resources
.handles
[i
]);
313 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
314 "Error transition power state\n"));
315 dev
->wakeup
.flags
.valid
= 0;
321 status
= acpi_evaluate_object(dev
->handle
, "_PSW", &arg_list
, NULL
);
322 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
323 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Error evaluate _PSW\n"));
324 dev
->wakeup
.flags
.valid
= 0;
332 * Shutdown a wakeup device, counterpart of above method
333 * 1. Disable _PSW (power state wake)
334 * 2. Shutdown down the power resources
336 int acpi_disable_wakeup_device_power (struct acpi_device
*dev
)
338 union acpi_object arg
= {ACPI_TYPE_INTEGER
};
339 struct acpi_object_list arg_list
= {1, &arg
};
340 acpi_status status
= AE_OK
;
344 ACPI_FUNCTION_TRACE("acpi_disable_wakeup_device_power");
346 if (!dev
|| !dev
->wakeup
.flags
.valid
)
349 arg
.integer
.value
= 0;
351 status
= acpi_evaluate_object(dev
->handle
, "_PSW", &arg_list
, NULL
);
352 if (ACPI_FAILURE(status
) && (status
!= AE_NOT_FOUND
)) {
353 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
, "Error evaluate _PSW\n"));
354 dev
->wakeup
.flags
.valid
= 0;
358 /* Close power resource */
359 for (i
= 0; i
< dev
->wakeup
.resources
.count
; i
++) {
360 ret
= acpi_power_off_device(dev
->wakeup
.resources
.handles
[i
]);
362 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
363 "Error transition power state\n"));
364 dev
->wakeup
.flags
.valid
= 0;
372 /* --------------------------------------------------------------------------
373 Device Power Management
374 -------------------------------------------------------------------------- */
377 acpi_power_get_inferred_state (
378 struct acpi_device
*device
)
381 struct acpi_handle_list
*list
= NULL
;
385 ACPI_FUNCTION_TRACE("acpi_power_get_inferred_state");
388 return_VALUE(-EINVAL
);
390 device
->power
.state
= ACPI_STATE_UNKNOWN
;
393 * We know a device's inferred power state when all the resources
394 * required for a given D-state are 'on'.
396 for (i
=ACPI_STATE_D0
; i
<ACPI_STATE_D3
; i
++) {
397 list
= &device
->power
.states
[i
].resources
;
401 result
= acpi_power_get_list_state(list
, &list_state
);
403 return_VALUE(result
);
405 if (list_state
== ACPI_POWER_RESOURCE_STATE_ON
) {
406 device
->power
.state
= i
;
411 device
->power
.state
= ACPI_STATE_D3
;
418 acpi_power_transition (
419 struct acpi_device
*device
,
423 struct acpi_handle_list
*cl
= NULL
; /* Current Resources */
424 struct acpi_handle_list
*tl
= NULL
; /* Target Resources */
427 ACPI_FUNCTION_TRACE("acpi_power_transition");
429 if (!device
|| (state
< ACPI_STATE_D0
) || (state
> ACPI_STATE_D3
))
430 return_VALUE(-EINVAL
);
432 if ((device
->power
.state
< ACPI_STATE_D0
) || (device
->power
.state
> ACPI_STATE_D3
))
433 return_VALUE(-ENODEV
);
435 cl
= &device
->power
.states
[device
->power
.state
].resources
;
436 tl
= &device
->power
.states
[state
].resources
;
438 device
->power
.state
= ACPI_STATE_UNKNOWN
;
440 if (!cl
->count
&& !tl
->count
) {
445 /* TBD: Resources must be ordered. */
448 * First we reference all power resources required in the target list
449 * (e.g. so the device doesn't lose power while transitioning).
451 for (i
=0; i
<tl
->count
; i
++) {
452 result
= acpi_power_on(tl
->handles
[i
]);
458 * Then we dereference all power resources used in the current list.
460 for (i
=0; i
<cl
->count
; i
++) {
461 result
= acpi_power_off_device(cl
->handles
[i
]);
466 /* We shouldn't change the state till all above operations succeed */
467 device
->power
.state
= state
;
470 ACPI_DEBUG_PRINT((ACPI_DB_WARN
,
471 "Error transitioning device [%s] to D%d\n",
472 device
->pnp
.bus_id
, state
));
474 return_VALUE(result
);
478 /* --------------------------------------------------------------------------
480 -------------------------------------------------------------------------- */
482 static struct proc_dir_entry
*acpi_power_dir
;
484 static int acpi_power_seq_show(struct seq_file
*seq
, void *offset
)
486 struct acpi_power_resource
*resource
= NULL
;
488 ACPI_FUNCTION_TRACE("acpi_power_seq_show");
490 resource
= (struct acpi_power_resource
*)seq
->private;
495 seq_puts(seq
, "state: ");
496 switch (resource
->state
) {
497 case ACPI_POWER_RESOURCE_STATE_ON
:
498 seq_puts(seq
, "on\n");
500 case ACPI_POWER_RESOURCE_STATE_OFF
:
501 seq_puts(seq
, "off\n");
504 seq_puts(seq
, "unknown\n");
508 seq_printf(seq
, "system level: S%d\n"
510 "reference count: %d\n",
511 resource
->system_level
,
513 resource
->references
);
519 static int acpi_power_open_fs(struct inode
*inode
, struct file
*file
)
521 return single_open(file
, acpi_power_seq_show
, PDE(inode
)->data
);
526 struct acpi_device
*device
)
528 struct proc_dir_entry
*entry
= NULL
;
530 ACPI_FUNCTION_TRACE("acpi_power_add_fs");
533 return_VALUE(-EINVAL
);
535 if (!acpi_device_dir(device
)) {
536 acpi_device_dir(device
) = proc_mkdir(acpi_device_bid(device
),
538 if (!acpi_device_dir(device
))
539 return_VALUE(-ENODEV
);
543 entry
= create_proc_entry(ACPI_POWER_FILE_STATUS
,
544 S_IRUGO
, acpi_device_dir(device
));
546 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
547 "Unable to create '%s' fs entry\n",
548 ACPI_POWER_FILE_STATUS
));
550 entry
->proc_fops
= &acpi_power_fops
;
551 entry
->data
= acpi_driver_data(device
);
559 acpi_power_remove_fs (
560 struct acpi_device
*device
)
562 ACPI_FUNCTION_TRACE("acpi_power_remove_fs");
564 if (acpi_device_dir(device
)) {
565 remove_proc_entry(ACPI_POWER_FILE_STATUS
,
566 acpi_device_dir(device
));
567 remove_proc_entry(acpi_device_bid(device
), acpi_power_dir
);
568 acpi_device_dir(device
) = NULL
;
575 /* --------------------------------------------------------------------------
577 -------------------------------------------------------------------------- */
581 struct acpi_device
*device
)
584 acpi_status status
= AE_OK
;
585 struct acpi_power_resource
*resource
= NULL
;
586 union acpi_object acpi_object
;
587 struct acpi_buffer buffer
= {sizeof(acpi_object
), &acpi_object
};
589 ACPI_FUNCTION_TRACE("acpi_power_add");
592 return_VALUE(-EINVAL
);
594 resource
= kmalloc(sizeof(struct acpi_power_resource
), GFP_KERNEL
);
596 return_VALUE(-ENOMEM
);
597 memset(resource
, 0, sizeof(struct acpi_power_resource
));
599 resource
->handle
= device
->handle
;
600 strcpy(resource
->name
, device
->pnp
.bus_id
);
601 strcpy(acpi_device_name(device
), ACPI_POWER_DEVICE_NAME
);
602 strcpy(acpi_device_class(device
), ACPI_POWER_CLASS
);
603 acpi_driver_data(device
) = resource
;
605 /* Evalute the object to get the system level and resource order. */
606 status
= acpi_evaluate_object(resource
->handle
, NULL
, NULL
, &buffer
);
607 if (ACPI_FAILURE(status
)) {
611 resource
->system_level
= acpi_object
.power_resource
.system_level
;
612 resource
->order
= acpi_object
.power_resource
.resource_order
;
614 result
= acpi_power_get_state(resource
);
618 switch (resource
->state
) {
619 case ACPI_POWER_RESOURCE_STATE_ON
:
620 device
->power
.state
= ACPI_STATE_D0
;
622 case ACPI_POWER_RESOURCE_STATE_OFF
:
623 device
->power
.state
= ACPI_STATE_D3
;
626 device
->power
.state
= ACPI_STATE_UNKNOWN
;
630 result
= acpi_power_add_fs(device
);
634 printk(KERN_INFO PREFIX
"%s [%s] (%s)\n", acpi_device_name(device
),
635 acpi_device_bid(device
), resource
->state
?"on":"off");
641 return_VALUE(result
);
647 struct acpi_device
*device
,
650 struct acpi_power_resource
*resource
= NULL
;
652 ACPI_FUNCTION_TRACE("acpi_power_remove");
654 if (!device
|| !acpi_driver_data(device
))
655 return_VALUE(-EINVAL
);
657 resource
= (struct acpi_power_resource
*) acpi_driver_data(device
);
659 acpi_power_remove_fs(device
);
667 static int __init
acpi_power_init (void)
671 ACPI_FUNCTION_TRACE("acpi_power_init");
676 INIT_LIST_HEAD(&acpi_power_resource_list
);
678 acpi_power_dir
= proc_mkdir(ACPI_POWER_CLASS
, acpi_root_dir
);
680 return_VALUE(-ENODEV
);
682 result
= acpi_bus_register_driver(&acpi_power_driver
);
684 remove_proc_entry(ACPI_POWER_CLASS
, acpi_root_dir
);
685 return_VALUE(-ENODEV
);
691 subsys_initcall(acpi_power_init
);