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