]> git.ipfire.org Git - people/ms/linux.git/blame - drivers/acpi/power.c
ACPI: power: Use u8 as the power resource state data type
[people/ms/linux.git] / drivers / acpi / power.c
CommitLineData
c942fddf 1// SPDX-License-Identifier: GPL-2.0-or-later
1da177e4 2/*
aa57aca8 3 * drivers/acpi/power.c - ACPI Power Resources management.
1da177e4 4 *
aa57aca8
RW
5 * Copyright (C) 2001 - 2015 Intel Corp.
6 * Author: Andy Grover <andrew.grover@intel.com>
7 * Author: Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
8 * Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
1da177e4
LT
9 */
10
11/*
12 * ACPI power-managed devices may be controlled in two ways:
13 * 1. via "Device Specific (D-State) Control"
14 * 2. via "Power Resource Control".
aa57aca8 15 * The code below deals with ACPI Power Resources control.
c6237b21 16 *
aa57aca8
RW
17 * An ACPI "power resource object" represents a software controllable power
18 * plane, clock plane, or other resource depended on by a device.
19 *
1da177e4
LT
20 * A device may rely on multiple power resources, and a power resource
21 * may be shared by multiple devices.
22 */
23
56ce8339
RW
24#define pr_fmt(fmt) "ACPI: PM: " fmt
25
1da177e4
LT
26#include <linux/kernel.h>
27#include <linux/module.h>
28#include <linux/init.h>
29#include <linux/types.h>
5a0e3ad6 30#include <linux/slab.h>
0090def6 31#include <linux/pm_runtime.h>
18a38709 32#include <linux/sysfs.h>
8b48463f 33#include <linux/acpi.h>
9b83ccd2 34#include "sleep.h"
0090def6 35#include "internal.h"
9b83ccd2 36
1da177e4 37#define ACPI_POWER_CLASS "power_resource"
1da177e4 38#define ACPI_POWER_DEVICE_NAME "Power Resource"
1da177e4
LT
39#define ACPI_POWER_RESOURCE_STATE_OFF 0x00
40#define ACPI_POWER_RESOURCE_STATE_ON 0x01
41#define ACPI_POWER_RESOURCE_STATE_UNKNOWN 0xFF
f5adfaa3 42
4533771c
MW
43struct acpi_power_dependent_device {
44 struct device *dev;
45 struct list_head node;
46};
47
4be44fcd 48struct acpi_power_resource {
82c7d5ef 49 struct acpi_device device;
781d737c 50 struct list_head list_node;
82c7d5ef 51 char *name;
4be44fcd
LB
52 u32 system_level;
53 u32 order;
3e384ee6 54 unsigned int ref_count;
9b7ff25d 55 unsigned int users;
b5d667eb 56 bool wakeup_enabled;
0a613902 57 struct mutex resource_lock;
4533771c 58 struct list_head dependents;
1da177e4
LT
59};
60
0b224527
RW
61struct acpi_power_resource_entry {
62 struct list_head node;
63 struct acpi_power_resource *resource;
64};
65
781d737c
RW
66static LIST_HEAD(acpi_power_resource_list);
67static DEFINE_MUTEX(power_resource_list_lock);
1da177e4 68
1da177e4
LT
69/* --------------------------------------------------------------------------
70 Power Resource Management
71 -------------------------------------------------------------------------- */
72
b1c0f99b
RW
73static inline
74struct acpi_power_resource *to_power_resource(struct acpi_device *device)
75{
76 return container_of(device, struct acpi_power_resource, device);
77}
78
82c7d5ef 79static struct acpi_power_resource *acpi_power_get_context(acpi_handle handle)
1da177e4 80{
82c7d5ef 81 struct acpi_device *device;
1da177e4 82
82c7d5ef
RW
83 if (acpi_bus_get_device(handle, &device))
84 return NULL;
1da177e4 85
b1c0f99b 86 return to_power_resource(device);
1da177e4
LT
87}
88
e88c9c60
RW
89static int acpi_power_resources_list_add(acpi_handle handle,
90 struct list_head *list)
0b224527
RW
91{
92 struct acpi_power_resource *resource = acpi_power_get_context(handle);
93 struct acpi_power_resource_entry *entry;
94
95 if (!resource || !list)
e88c9c60 96 return -EINVAL;
0b224527
RW
97
98 entry = kzalloc(sizeof(*entry), GFP_KERNEL);
99 if (!entry)
e88c9c60 100 return -ENOMEM;
0b224527
RW
101
102 entry->resource = resource;
103 if (!list_empty(list)) {
104 struct acpi_power_resource_entry *e;
105
106 list_for_each_entry(e, list, node)
107 if (e->resource->order > resource->order) {
108 list_add_tail(&entry->node, &e->node);
e88c9c60 109 return 0;
0b224527
RW
110 }
111 }
112 list_add_tail(&entry->node, list);
e88c9c60 113 return 0;
0b224527
RW
114}
115
116void acpi_power_resources_list_free(struct list_head *list)
117{
118 struct acpi_power_resource_entry *entry, *e;
119
120 list_for_each_entry_safe(entry, e, list, node) {
121 list_del(&entry->node);
122 kfree(entry);
123 }
124}
125
7d7b467c
HG
126static bool acpi_power_resource_is_dup(union acpi_object *package,
127 unsigned int start, unsigned int i)
128{
129 acpi_handle rhandle, dup;
130 unsigned int j;
131
132 /* The caller is expected to check the package element types */
133 rhandle = package->package.elements[i].reference.handle;
134 for (j = start; j < i; j++) {
135 dup = package->package.elements[j].reference.handle;
136 if (dup == rhandle)
137 return true;
138 }
139
140 return false;
141}
142
e88c9c60
RW
143int acpi_extract_power_resources(union acpi_object *package, unsigned int start,
144 struct list_head *list)
ef85bdbe 145{
ef85bdbe 146 unsigned int i;
e88c9c60 147 int err = 0;
ef85bdbe
RW
148
149 for (i = start; i < package->package.count; i++) {
150 union acpi_object *element = &package->package.elements[i];
9b7ff25d 151 struct acpi_device *rdev;
ef85bdbe
RW
152 acpi_handle rhandle;
153
154 if (element->type != ACPI_TYPE_LOCAL_REFERENCE) {
e88c9c60 155 err = -ENODATA;
ef85bdbe
RW
156 break;
157 }
158 rhandle = element->reference.handle;
159 if (!rhandle) {
e88c9c60 160 err = -ENODEV;
ef85bdbe
RW
161 break;
162 }
7d7b467c
HG
163
164 /* Some ACPI tables contain duplicate power resource references */
165 if (acpi_power_resource_is_dup(package, start, i))
166 continue;
167
9b7ff25d
RW
168 rdev = acpi_add_power_resource(rhandle);
169 if (!rdev) {
170 err = -ENODEV;
e88c9c60 171 break;
9b7ff25d 172 }
e88c9c60
RW
173 err = acpi_power_resources_list_add(rhandle, list);
174 if (err)
175 break;
9b7ff25d
RW
176
177 to_power_resource(rdev)->users++;
ef85bdbe 178 }
e88c9c60 179 if (err)
ef85bdbe
RW
180 acpi_power_resources_list_free(list);
181
e88c9c60 182 return err;
ef85bdbe
RW
183}
184
587024b8 185static int acpi_power_get_state(acpi_handle handle, u8 *state)
1da177e4 186{
4be44fcd 187 acpi_status status = AE_OK;
27663c58 188 unsigned long long sta = 0;
587024b8 189 u8 cur_state;
1da177e4 190
a51e145f 191 if (!handle || !state)
d550d98d 192 return -EINVAL;
1da177e4 193
a51e145f 194 status = acpi_evaluate_integer(handle, "_STA", NULL, &sta);
1da177e4 195 if (ACPI_FAILURE(status))
d550d98d 196 return -ENODEV;
1da177e4 197
587024b8 198 cur_state = sta & ACPI_POWER_RESOURCE_STATE_ON;
1da177e4 199
56ce8339 200 acpi_handle_debug(handle, "Power resource is %s\n",
587024b8 201 cur_state ? "on" : "off");
1da177e4 202
587024b8 203 *state = cur_state;
d550d98d 204 return 0;
1da177e4
LT
205}
206
587024b8 207static int acpi_power_get_list_state(struct list_head *list, u8 *state)
1da177e4 208{
0b224527 209 struct acpi_power_resource_entry *entry;
587024b8 210 u8 cur_state = ACPI_POWER_RESOURCE_STATE_OFF;
1da177e4
LT
211
212 if (!list || !state)
d550d98d 213 return -EINVAL;
1da177e4
LT
214
215 /* The state of the list is 'on' IFF all resources are 'on'. */
0b224527
RW
216 list_for_each_entry(entry, list, node) {
217 struct acpi_power_resource *resource = entry->resource;
218 acpi_handle handle = resource->device.handle;
d0515d9f
RW
219 int result;
220
d0515d9f 221 mutex_lock(&resource->resource_lock);
d0515d9f 222 result = acpi_power_get_state(handle, &cur_state);
d0515d9f 223 mutex_unlock(&resource->resource_lock);
d0515d9f
RW
224 if (result)
225 return result;
226
227 if (cur_state != ACPI_POWER_RESOURCE_STATE_ON)
1da177e4
LT
228 break;
229 }
230
56ce8339 231 pr_debug("Power resource list is %s\n", cur_state ? "on" : "off");
1da177e4 232
d0515d9f 233 *state = cur_state;
d0515d9f 234 return 0;
1da177e4
LT
235}
236
4533771c
MW
237static int
238acpi_power_resource_add_dependent(struct acpi_power_resource *resource,
239 struct device *dev)
240{
241 struct acpi_power_dependent_device *dep;
242 int ret = 0;
243
244 mutex_lock(&resource->resource_lock);
245 list_for_each_entry(dep, &resource->dependents, node) {
246 /* Only add it once */
247 if (dep->dev == dev)
248 goto unlock;
249 }
250
251 dep = kzalloc(sizeof(*dep), GFP_KERNEL);
252 if (!dep) {
253 ret = -ENOMEM;
254 goto unlock;
255 }
256
257 dep->dev = dev;
258 list_add_tail(&dep->node, &resource->dependents);
259 dev_dbg(dev, "added power dependency to [%s]\n", resource->name);
260
261unlock:
262 mutex_unlock(&resource->resource_lock);
263 return ret;
264}
265
266static void
267acpi_power_resource_remove_dependent(struct acpi_power_resource *resource,
268 struct device *dev)
269{
270 struct acpi_power_dependent_device *dep;
271
272 mutex_lock(&resource->resource_lock);
273 list_for_each_entry(dep, &resource->dependents, node) {
274 if (dep->dev == dev) {
275 list_del(&dep->node);
276 kfree(dep);
277 dev_dbg(dev, "removed power dependency to [%s]\n",
278 resource->name);
279 break;
280 }
281 }
282 mutex_unlock(&resource->resource_lock);
283}
284
285/**
286 * acpi_device_power_add_dependent - Add dependent device of this ACPI device
287 * @adev: ACPI device pointer
288 * @dev: Dependent device
289 *
290 * If @adev has non-empty _PR0 the @dev is added as dependent device to all
291 * power resources returned by it. This means that whenever these power
292 * resources are turned _ON the dependent devices get runtime resumed. This
293 * is needed for devices such as PCI to allow its driver to re-initialize
294 * it after it went to D0uninitialized.
295 *
296 * If @adev does not have _PR0 this does nothing.
297 *
298 * Returns %0 in case of success and negative errno otherwise.
299 */
300int acpi_device_power_add_dependent(struct acpi_device *adev,
301 struct device *dev)
302{
303 struct acpi_power_resource_entry *entry;
304 struct list_head *resources;
305 int ret;
306
307 if (!adev->flags.power_manageable)
308 return 0;
309
310 resources = &adev->power.states[ACPI_STATE_D0].resources;
311 list_for_each_entry(entry, resources, node) {
312 ret = acpi_power_resource_add_dependent(entry->resource, dev);
313 if (ret)
314 goto err;
315 }
316
317 return 0;
318
319err:
320 list_for_each_entry(entry, resources, node)
321 acpi_power_resource_remove_dependent(entry->resource, dev);
322
323 return ret;
324}
325
326/**
327 * acpi_device_power_remove_dependent - Remove dependent device
328 * @adev: ACPI device pointer
329 * @dev: Dependent device
330 *
331 * Does the opposite of acpi_device_power_add_dependent() and removes the
332 * dependent device if it is found. Can be called to @adev that does not
333 * have _PR0 as well.
334 */
335void acpi_device_power_remove_dependent(struct acpi_device *adev,
336 struct device *dev)
337{
338 struct acpi_power_resource_entry *entry;
339 struct list_head *resources;
340
341 if (!adev->flags.power_manageable)
342 return;
343
344 resources = &adev->power.states[ACPI_STATE_D0].resources;
345 list_for_each_entry_reverse(entry, resources, node)
346 acpi_power_resource_remove_dependent(entry->resource, dev);
347}
348
3e384ee6 349static int __acpi_power_on(struct acpi_power_resource *resource)
1da177e4 350{
4533771c 351 struct acpi_power_dependent_device *dep;
4be44fcd 352 acpi_status status = AE_OK;
1da177e4 353
82c7d5ef 354 status = acpi_evaluate_object(resource->device.handle, "_ON", NULL, NULL);
3e384ee6
RW
355 if (ACPI_FAILURE(status))
356 return -ENODEV;
357
56ce8339 358 pr_debug("Power resource [%s] turned on\n", resource->name);
3e384ee6 359
4533771c
MW
360 /*
361 * If there are other dependents on this power resource we need to
362 * resume them now so that their drivers can re-initialize the
363 * hardware properly after it went back to D0.
364 */
365 if (list_empty(&resource->dependents) ||
366 list_is_singular(&resource->dependents))
367 return 0;
368
369 list_for_each_entry(dep, &resource->dependents, node) {
370 dev_dbg(dep->dev, "runtime resuming because [%s] turned on\n",
371 resource->name);
372 pm_request_resume(dep->dev);
373 }
374
3e384ee6
RW
375 return 0;
376}
377
b5d667eb 378static int acpi_power_on_unlocked(struct acpi_power_resource *resource)
3e384ee6 379{
b5d667eb 380 int result = 0;
0a613902 381
3e384ee6 382 if (resource->ref_count++) {
56ce8339 383 pr_debug("Power resource [%s] already on\n", resource->name);
3e384ee6
RW
384 } else {
385 result = __acpi_power_on(resource);
41863fce 386 if (result)
12b3b5af 387 resource->ref_count--;
40bf66ec 388 }
b5d667eb
RW
389 return result;
390}
40bf66ec 391
b5d667eb
RW
392static int acpi_power_on(struct acpi_power_resource *resource)
393{
394 int result;
40bf66ec 395
b5d667eb
RW
396 mutex_lock(&resource->resource_lock);
397 result = acpi_power_on_unlocked(resource);
398 mutex_unlock(&resource->resource_lock);
12b3b5af 399 return result;
1da177e4
LT
400}
401
660b1113
RW
402static int __acpi_power_off(struct acpi_power_resource *resource)
403{
404 acpi_status status;
405
406 status = acpi_evaluate_object(resource->device.handle, "_OFF",
407 NULL, NULL);
408 if (ACPI_FAILURE(status))
409 return -ENODEV;
410
56ce8339
RW
411 pr_debug("Power resource [%s] turned off\n", resource->name);
412
660b1113
RW
413 return 0;
414}
415
b5d667eb 416static int acpi_power_off_unlocked(struct acpi_power_resource *resource)
1da177e4 417{
0b224527 418 int result = 0;
1da177e4 419
3e384ee6 420 if (!resource->ref_count) {
56ce8339 421 pr_debug("Power resource [%s] already off\n", resource->name);
b5d667eb 422 return 0;
0a613902 423 }
1da177e4 424
3e384ee6 425 if (--resource->ref_count) {
56ce8339 426 pr_debug("Power resource [%s] still in use\n", resource->name);
660b1113
RW
427 } else {
428 result = __acpi_power_off(resource);
429 if (result)
430 resource->ref_count++;
1da177e4 431 }
b5d667eb
RW
432 return result;
433}
1da177e4 434
b5d667eb
RW
435static int acpi_power_off(struct acpi_power_resource *resource)
436{
437 int result;
1da177e4 438
b5d667eb
RW
439 mutex_lock(&resource->resource_lock);
440 result = acpi_power_off_unlocked(resource);
441 mutex_unlock(&resource->resource_lock);
3e384ee6 442 return result;
1da177e4
LT
443}
444
0b224527 445static int acpi_power_off_list(struct list_head *list)
d2ef555b 446{
0b224527
RW
447 struct acpi_power_resource_entry *entry;
448 int result = 0;
d2ef555b 449
0b224527
RW
450 list_for_each_entry_reverse(entry, list, node) {
451 result = acpi_power_off(entry->resource);
452 if (result)
453 goto err;
454 }
455 return 0;
d2ef555b 456
0b224527
RW
457 err:
458 list_for_each_entry_continue(entry, list, node)
459 acpi_power_on(entry->resource);
460
461 return result;
d2ef555b
RW
462}
463
0b224527 464static int acpi_power_on_list(struct list_head *list)
d2ef555b 465{
0b224527 466 struct acpi_power_resource_entry *entry;
d2ef555b 467 int result = 0;
d2ef555b 468
0b224527
RW
469 list_for_each_entry(entry, list, node) {
470 result = acpi_power_on(entry->resource);
471 if (result)
472 goto err;
d2ef555b 473 }
0b224527
RW
474 return 0;
475
476 err:
477 list_for_each_entry_continue_reverse(entry, list, node)
478 acpi_power_off(entry->resource);
d2ef555b
RW
479
480 return result;
481}
482
18a38709
RW
483static struct attribute *attrs[] = {
484 NULL,
485};
486
26408b24 487static const struct attribute_group attr_groups[] = {
18a38709
RW
488 [ACPI_STATE_D0] = {
489 .name = "power_resources_D0",
490 .attrs = attrs,
491 },
492 [ACPI_STATE_D1] = {
493 .name = "power_resources_D1",
494 .attrs = attrs,
495 },
496 [ACPI_STATE_D2] = {
497 .name = "power_resources_D2",
498 .attrs = attrs,
499 },
500 [ACPI_STATE_D3_HOT] = {
501 .name = "power_resources_D3hot",
502 .attrs = attrs,
503 },
504};
505
26408b24 506static const struct attribute_group wakeup_attr_group = {
41a2a466
RW
507 .name = "power_resources_wakeup",
508 .attrs = attrs,
509};
510
511static void acpi_power_hide_list(struct acpi_device *adev,
512 struct list_head *resources,
26408b24 513 const struct attribute_group *attr_group)
18a38709 514{
18a38709
RW
515 struct acpi_power_resource_entry *entry;
516
41a2a466 517 if (list_empty(resources))
18a38709
RW
518 return;
519
41a2a466 520 list_for_each_entry_reverse(entry, resources, node) {
18a38709
RW
521 struct acpi_device *res_dev = &entry->resource->device;
522
523 sysfs_remove_link_from_group(&adev->dev.kobj,
41a2a466 524 attr_group->name,
18a38709
RW
525 dev_name(&res_dev->dev));
526 }
41a2a466 527 sysfs_remove_group(&adev->dev.kobj, attr_group);
18a38709
RW
528}
529
41a2a466
RW
530static void acpi_power_expose_list(struct acpi_device *adev,
531 struct list_head *resources,
26408b24 532 const struct attribute_group *attr_group)
0090def6 533{
18a38709
RW
534 struct acpi_power_resource_entry *entry;
535 int ret;
536
41a2a466 537 if (list_empty(resources))
18a38709
RW
538 return;
539
41a2a466 540 ret = sysfs_create_group(&adev->dev.kobj, attr_group);
18a38709
RW
541 if (ret)
542 return;
543
41a2a466 544 list_for_each_entry(entry, resources, node) {
18a38709
RW
545 struct acpi_device *res_dev = &entry->resource->device;
546
547 ret = sysfs_add_link_to_group(&adev->dev.kobj,
41a2a466 548 attr_group->name,
18a38709
RW
549 &res_dev->dev.kobj,
550 dev_name(&res_dev->dev));
551 if (ret) {
41a2a466 552 acpi_power_hide_list(adev, resources, attr_group);
18a38709 553 break;
0090def6
LM
554 }
555 }
0090def6 556}
bc9b6407 557
41a2a466
RW
558static void acpi_power_expose_hide(struct acpi_device *adev,
559 struct list_head *resources,
26408b24 560 const struct attribute_group *attr_group,
41a2a466
RW
561 bool expose)
562{
563 if (expose)
564 acpi_power_expose_list(adev, resources, attr_group);
565 else
566 acpi_power_hide_list(adev, resources, attr_group);
567}
568
18a38709
RW
569void acpi_power_add_remove_device(struct acpi_device *adev, bool add)
570{
18a38709
RW
571 int state;
572
41a2a466
RW
573 if (adev->wakeup.flags.valid)
574 acpi_power_expose_hide(adev, &adev->wakeup.resources,
575 &wakeup_attr_group, add);
576
18a38709
RW
577 if (!adev->power.flags.power_resources)
578 return;
579
41a2a466
RW
580 for (state = ACPI_STATE_D0; state <= ACPI_STATE_D3_HOT; state++)
581 acpi_power_expose_hide(adev,
582 &adev->power.states[state].resources,
583 &attr_groups[state], add);
18a38709
RW
584}
585
b5d667eb 586int acpi_power_wakeup_list_init(struct list_head *list, int *system_level_p)
0596a52b
RW
587{
588 struct acpi_power_resource_entry *entry;
589 int system_level = 5;
590
591 list_for_each_entry(entry, list, node) {
592 struct acpi_power_resource *resource = entry->resource;
b5d667eb
RW
593 acpi_handle handle = resource->device.handle;
594 int result;
587024b8 595 u8 state;
0596a52b 596
b5d667eb
RW
597 mutex_lock(&resource->resource_lock);
598
599 result = acpi_power_get_state(handle, &state);
600 if (result) {
601 mutex_unlock(&resource->resource_lock);
602 return result;
603 }
604 if (state == ACPI_POWER_RESOURCE_STATE_ON) {
605 resource->ref_count++;
606 resource->wakeup_enabled = true;
607 }
0596a52b
RW
608 if (system_level > resource->system_level)
609 system_level = resource->system_level;
b5d667eb
RW
610
611 mutex_unlock(&resource->resource_lock);
0596a52b 612 }
b5d667eb
RW
613 *system_level_p = system_level;
614 return 0;
0596a52b
RW
615}
616
bc9b6407
RW
617/* --------------------------------------------------------------------------
618 Device Power Management
619 -------------------------------------------------------------------------- */
0090def6 620
77e76609
RW
621/**
622 * acpi_device_sleep_wake - execute _DSW (Device Sleep Wake) or (deprecated in
623 * ACPI 3.0) _PSW (Power State Wake)
624 * @dev: Device to handle.
625 * @enable: 0 - disable, 1 - enable the wake capabilities of the device.
626 * @sleep_state: Target sleep state of the system.
627 * @dev_state: Target power state of the device.
628 *
629 * Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
630 * State Wake) for the device, if present. On failure reset the device's
631 * wakeup.flags.valid flag.
632 *
633 * RETURN VALUE:
634 * 0 if either _DSW or _PSW has been successfully executed
635 * 0 if neither _DSW nor _PSW has been found
636 * -ENODEV if the execution of either _DSW or _PSW has failed
637 */
638int acpi_device_sleep_wake(struct acpi_device *dev,
c6237b21 639 int enable, int sleep_state, int dev_state)
77e76609
RW
640{
641 union acpi_object in_arg[3];
642 struct acpi_object_list arg_list = { 3, in_arg };
643 acpi_status status = AE_OK;
644
645 /*
646 * Try to execute _DSW first.
647 *
603fadf3 648 * Three arguments are needed for the _DSW object:
77e76609
RW
649 * Argument 0: enable/disable the wake capabilities
650 * Argument 1: target system state
651 * Argument 2: target device state
652 * When _DSW object is called to disable the wake capabilities, maybe
603fadf3 653 * the first argument is filled. The values of the other two arguments
77e76609
RW
654 * are meaningless.
655 */
656 in_arg[0].type = ACPI_TYPE_INTEGER;
657 in_arg[0].integer.value = enable;
658 in_arg[1].type = ACPI_TYPE_INTEGER;
659 in_arg[1].integer.value = sleep_state;
660 in_arg[2].type = ACPI_TYPE_INTEGER;
661 in_arg[2].integer.value = dev_state;
662 status = acpi_evaluate_object(dev->handle, "_DSW", &arg_list, NULL);
663 if (ACPI_SUCCESS(status)) {
664 return 0;
665 } else if (status != AE_NOT_FOUND) {
56ce8339 666 acpi_handle_info(dev->handle, "_DSW execution failed\n");
77e76609
RW
667 dev->wakeup.flags.valid = 0;
668 return -ENODEV;
669 }
670
671 /* Execute _PSW */
0db98202 672 status = acpi_execute_simple_method(dev->handle, "_PSW", enable);
77e76609 673 if (ACPI_FAILURE(status) && (status != AE_NOT_FOUND)) {
56ce8339 674 acpi_handle_info(dev->handle, "_PSW execution failed\n");
77e76609
RW
675 dev->wakeup.flags.valid = 0;
676 return -ENODEV;
677 }
678
679 return 0;
680}
681
1da177e4
LT
682/*
683 * Prepare a wakeup device, two steps (Ref ACPI 2.0:P229):
c6237b21 684 * 1. Power on the power resources required for the wakeup device
77e76609
RW
685 * 2. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
686 * State Wake) for the device, if present
1da177e4 687 */
77e76609 688int acpi_enable_wakeup_device_power(struct acpi_device *dev, int sleep_state)
1da177e4 689{
b5d667eb 690 struct acpi_power_resource_entry *entry;
993cbe59 691 int err = 0;
1da177e4 692
1da177e4 693 if (!dev || !dev->wakeup.flags.valid)
77e76609 694 return -EINVAL;
1da177e4 695
9b83ccd2
RW
696 mutex_lock(&acpi_device_lock);
697
698 if (dev->wakeup.prepare_count++)
699 goto out;
0af4b8c4 700
b5d667eb
RW
701 list_for_each_entry(entry, &dev->wakeup.resources, node) {
702 struct acpi_power_resource *resource = entry->resource;
703
704 mutex_lock(&resource->resource_lock);
705
706 if (!resource->wakeup_enabled) {
707 err = acpi_power_on_unlocked(resource);
708 if (!err)
709 resource->wakeup_enabled = true;
710 }
711
712 mutex_unlock(&resource->resource_lock);
713
714 if (err) {
715 dev_err(&dev->dev,
716 "Cannot turn wakeup power resources on\n");
717 dev->wakeup.flags.valid = 0;
718 goto out;
719 }
1da177e4 720 }
b5d667eb
RW
721 /*
722 * Passing 3 as the third argument below means the device may be
723 * put into arbitrary power state afterward.
724 */
725 err = acpi_device_sleep_wake(dev, 1, sleep_state, 3);
9b83ccd2
RW
726 if (err)
727 dev->wakeup.prepare_count = 0;
728
729 out:
730 mutex_unlock(&acpi_device_lock);
0af4b8c4 731 return err;
1da177e4
LT
732}
733
734/*
735 * Shutdown a wakeup device, counterpart of above method
77e76609
RW
736 * 1. Execute _DSW (Device Sleep Wake) or (deprecated in ACPI 3.0) _PSW (Power
737 * State Wake) for the device, if present
1da177e4
LT
738 * 2. Shutdown down the power resources
739 */
4be44fcd 740int acpi_disable_wakeup_device_power(struct acpi_device *dev)
1da177e4 741{
b5d667eb 742 struct acpi_power_resource_entry *entry;
993cbe59 743 int err = 0;
1da177e4
LT
744
745 if (!dev || !dev->wakeup.flags.valid)
77e76609 746 return -EINVAL;
1da177e4 747
9b83ccd2
RW
748 mutex_lock(&acpi_device_lock);
749
750 if (--dev->wakeup.prepare_count > 0)
751 goto out;
752
0af4b8c4 753 /*
9b83ccd2
RW
754 * Executing the code below even if prepare_count is already zero when
755 * the function is called may be useful, for example for initialisation.
0af4b8c4 756 */
9b83ccd2
RW
757 if (dev->wakeup.prepare_count < 0)
758 dev->wakeup.prepare_count = 0;
0af4b8c4 759
9b83ccd2
RW
760 err = acpi_device_sleep_wake(dev, 0, 0, 0);
761 if (err)
762 goto out;
1da177e4 763
b5d667eb
RW
764 list_for_each_entry(entry, &dev->wakeup.resources, node) {
765 struct acpi_power_resource *resource = entry->resource;
766
767 mutex_lock(&resource->resource_lock);
768
769 if (resource->wakeup_enabled) {
770 err = acpi_power_off_unlocked(resource);
771 if (!err)
772 resource->wakeup_enabled = false;
773 }
774
775 mutex_unlock(&resource->resource_lock);
776
777 if (err) {
778 dev_err(&dev->dev,
779 "Cannot turn wakeup power resources off\n");
780 dev->wakeup.flags.valid = 0;
781 break;
782 }
1da177e4
LT
783 }
784
9b83ccd2
RW
785 out:
786 mutex_unlock(&acpi_device_lock);
787 return err;
1da177e4
LT
788}
789
32a00d27 790int acpi_power_get_inferred_state(struct acpi_device *device, int *state)
1da177e4 791{
587024b8 792 u8 list_state = ACPI_POWER_RESOURCE_STATE_OFF;
4be44fcd 793 int result = 0;
4be44fcd 794 int i = 0;
1da177e4 795
32a00d27 796 if (!device || !state)
d550d98d 797 return -EINVAL;
1da177e4 798
1da177e4
LT
799 /*
800 * We know a device's inferred power state when all the resources
801 * required for a given D-state are 'on'.
802 */
38c92fff 803 for (i = ACPI_STATE_D0; i <= ACPI_STATE_D3_HOT; i++) {
0b224527
RW
804 struct list_head *list = &device->power.states[i].resources;
805
806 if (list_empty(list))
1da177e4
LT
807 continue;
808
809 result = acpi_power_get_list_state(list, &list_state);
810 if (result)
d550d98d 811 return result;
1da177e4
LT
812
813 if (list_state == ACPI_POWER_RESOURCE_STATE_ON) {
32a00d27 814 *state = i;
d550d98d 815 return 0;
1da177e4
LT
816 }
817 }
818
20dacb71
RW
819 *state = device->power.states[ACPI_STATE_D3_COLD].flags.valid ?
820 ACPI_STATE_D3_COLD : ACPI_STATE_D3_HOT;
d550d98d 821 return 0;
1da177e4
LT
822}
823
30d3df41
RW
824int acpi_power_on_resources(struct acpi_device *device, int state)
825{
87e753b0 826 if (!device || state < ACPI_STATE_D0 || state > ACPI_STATE_D3_HOT)
30d3df41
RW
827 return -EINVAL;
828
829 return acpi_power_on_list(&device->power.states[state].resources);
830}
831
4be44fcd 832int acpi_power_transition(struct acpi_device *device, int state)
1da177e4 833{
5c7dd710 834 int result = 0;
1da177e4 835
3ebc81b8 836 if (!device || (state < ACPI_STATE_D0) || (state > ACPI_STATE_D3_COLD))
d550d98d 837 return -EINVAL;
1da177e4 838
0b224527 839 if (device->power.state == state || !device->flags.power_manageable)
212967c6
RW
840 return 0;
841
4be44fcd 842 if ((device->power.state < ACPI_STATE_D0)
3ebc81b8 843 || (device->power.state > ACPI_STATE_D3_COLD))
d550d98d 844 return -ENODEV;
1da177e4 845
1da177e4
LT
846 /*
847 * First we reference all power resources required in the target list
d2ef555b
RW
848 * (e.g. so the device doesn't lose power while transitioning). Then,
849 * we dereference all power resources used in the current list.
1da177e4 850 */
5c7dd710
RW
851 if (state < ACPI_STATE_D3_COLD)
852 result = acpi_power_on_list(
853 &device->power.states[state].resources);
854
855 if (!result && device->power.state < ACPI_STATE_D3_COLD)
d2ef555b
RW
856 acpi_power_off_list(
857 &device->power.states[device->power.state].resources);
1da177e4 858
d2ef555b
RW
859 /* We shouldn't change the state unless the above operations succeed. */
860 device->power.state = result ? ACPI_STATE_UNKNOWN : state;
1da177e4 861
d550d98d 862 return result;
1da177e4
LT
863}
864
82c7d5ef
RW
865static void acpi_release_power_resource(struct device *dev)
866{
867 struct acpi_device *device = to_acpi_device(dev);
868 struct acpi_power_resource *resource;
869
82c7d5ef 870 resource = container_of(device, struct acpi_power_resource, device);
781d737c
RW
871
872 mutex_lock(&power_resource_list_lock);
873 list_del(&resource->list_node);
874 mutex_unlock(&power_resource_list_lock);
875
c0af4175 876 acpi_free_pnp_ids(&device->pnp);
82c7d5ef
RW
877 kfree(resource);
878}
1da177e4 879
0f39ee83
DR
880static ssize_t resource_in_use_show(struct device *dev,
881 struct device_attribute *attr,
882 char *buf)
883{
b1c0f99b
RW
884 struct acpi_power_resource *resource;
885
886 resource = to_power_resource(to_acpi_device(dev));
887 return sprintf(buf, "%u\n", !!resource->ref_count);
888}
0f39ee83 889static DEVICE_ATTR_RO(resource_in_use);
b1c0f99b
RW
890
891static void acpi_power_sysfs_remove(struct acpi_device *device)
892{
893 device_remove_file(&device->dev, &dev_attr_resource_in_use);
894}
895
d5eefa82
RW
896static void acpi_power_add_resource_to_list(struct acpi_power_resource *resource)
897{
898 mutex_lock(&power_resource_list_lock);
899
900 if (!list_empty(&acpi_power_resource_list)) {
901 struct acpi_power_resource *r;
902
903 list_for_each_entry(r, &acpi_power_resource_list, list_node)
904 if (r->order > resource->order) {
905 list_add_tail(&resource->list_node, &r->list_node);
906 goto out;
907 }
908 }
909 list_add_tail(&resource->list_node, &acpi_power_resource_list);
910
911 out:
912 mutex_unlock(&power_resource_list_lock);
913}
914
9b7ff25d 915struct acpi_device *acpi_add_power_resource(acpi_handle handle)
1da177e4 916{
82c7d5ef
RW
917 struct acpi_power_resource *resource;
918 struct acpi_device *device = NULL;
4be44fcd
LB
919 union acpi_object acpi_object;
920 struct acpi_buffer buffer = { sizeof(acpi_object), &acpi_object };
82c7d5ef 921 acpi_status status;
587024b8
RW
922 int result;
923 u8 state;
1da177e4 924
82c7d5ef
RW
925 acpi_bus_get_device(handle, &device);
926 if (device)
9b7ff25d 927 return device;
1da177e4 928
82c7d5ef 929 resource = kzalloc(sizeof(*resource), GFP_KERNEL);
1da177e4 930 if (!resource)
9b7ff25d 931 return NULL;
1da177e4 932
82c7d5ef 933 device = &resource->device;
c830dbcf 934 acpi_init_device_object(device, handle, ACPI_BUS_TYPE_POWER);
0a613902 935 mutex_init(&resource->resource_lock);
6ee22e9d 936 INIT_LIST_HEAD(&resource->list_node);
4533771c 937 INIT_LIST_HEAD(&resource->dependents);
82c7d5ef 938 resource->name = device->pnp.bus_id;
1da177e4
LT
939 strcpy(acpi_device_name(device), ACPI_POWER_DEVICE_NAME);
940 strcpy(acpi_device_class(device), ACPI_POWER_CLASS);
722c929f 941 device->power.state = ACPI_STATE_UNKNOWN;
1da177e4 942
935ab850 943 /* Evaluate the object to get the system level and resource order. */
82c7d5ef
RW
944 status = acpi_evaluate_object(handle, NULL, NULL, &buffer);
945 if (ACPI_FAILURE(status))
781d737c 946 goto err;
82c7d5ef 947
1da177e4
LT
948 resource->system_level = acpi_object.power_resource.system_level;
949 resource->order = acpi_object.power_resource.resource_order;
950
82c7d5ef 951 result = acpi_power_get_state(handle, &state);
1da177e4 952 if (result)
781d737c 953 goto err;
1da177e4 954
56ce8339
RW
955 pr_info("%s [%s] (%s)\n", acpi_device_name(device),
956 acpi_device_bid(device), state ? "on" : "off");
1da177e4 957
82c7d5ef 958 device->flags.match_driver = true;
cf860be6 959 result = acpi_device_add(device, acpi_release_power_resource);
1da177e4 960 if (result)
781d737c 961 goto err;
4be44fcd 962
b1c0f99b
RW
963 if (!device_create_file(&device->dev, &dev_attr_resource_in_use))
964 device->remove = acpi_power_sysfs_remove;
965
d5eefa82 966 acpi_power_add_resource_to_list(resource);
cf860be6 967 acpi_device_add_finalize(device);
9b7ff25d 968 return device;
1da177e4 969
781d737c
RW
970 err:
971 acpi_release_power_resource(&device->dev);
9b7ff25d 972 return NULL;
781d737c 973}
1da177e4 974
781d737c
RW
975#ifdef CONFIG_ACPI_SLEEP
976void acpi_resume_power_resources(void)
0a613902 977{
3e384ee6 978 struct acpi_power_resource *resource;
0a613902 979
781d737c 980 mutex_lock(&power_resource_list_lock);
0a613902 981
781d737c 982 list_for_each_entry(resource, &acpi_power_resource_list, list_node) {
587024b8
RW
983 int result;
984 u8 state;
0a613902 985
781d737c 986 mutex_lock(&resource->resource_lock);
0a613902 987
781d737c 988 result = acpi_power_get_state(resource->device.handle, &state);
d7d49012
LT
989 if (result) {
990 mutex_unlock(&resource->resource_lock);
660b1113 991 continue;
d7d49012 992 }
660b1113
RW
993
994 if (state == ACPI_POWER_RESOURCE_STATE_OFF
781d737c
RW
995 && resource->ref_count) {
996 dev_info(&resource->device.dev, "Turning ON\n");
997 __acpi_power_on(resource);
d5eefa82
RW
998 }
999
1000 mutex_unlock(&resource->resource_lock);
1001 }
8ece1d83
HG
1002
1003 mutex_unlock(&power_resource_list_lock);
1004}
29038ae2 1005#endif
8ece1d83 1006
9b7ff25d
RW
1007static void acpi_power_turn_off_if_unused(struct acpi_power_resource *resource,
1008 bool init)
1009{
1010 if (resource->ref_count > 0)
1011 return;
1012
1013 if (init) {
1014 if (resource->users > 0)
1015 return;
1016 } else {
587024b8
RW
1017 int result;
1018 u8 state;
9b7ff25d
RW
1019
1020 result = acpi_power_get_state(resource->device.handle, &state);
1021 if (result || state == ACPI_POWER_RESOURCE_STATE_OFF)
1022 return;
1023 }
1024
1025 dev_info(&resource->device.dev, "Turning OFF\n");
1026 __acpi_power_off(resource);
1027}
1028
1029/**
1030 * acpi_turn_off_unused_power_resources - Turn off power resources not in use.
1031 * @init: Control switch.
1032 *
1033 * If @ainit is set, unconditionally turn off all of the ACPI power resources
1034 * without any users.
1035 *
1036 * Otherwise, turn off all ACPI power resources without active references (that
1037 * is, the ones that should be "off" at the moment) that are "on".
1038 */
1039void acpi_turn_off_unused_power_resources(bool init)
8ece1d83
HG
1040{
1041 struct acpi_power_resource *resource;
1042
1043 mutex_lock(&power_resource_list_lock);
1044
d5eefa82 1045 list_for_each_entry_reverse(resource, &acpi_power_resource_list, list_node) {
d5eefa82
RW
1046 mutex_lock(&resource->resource_lock);
1047
9b7ff25d 1048 acpi_power_turn_off_if_unused(resource, init);
0a613902 1049
781d737c
RW
1050 mutex_unlock(&resource->resource_lock);
1051 }
3e384ee6 1052
781d737c 1053 mutex_unlock(&power_resource_list_lock);
0a613902 1054}