1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
/* $NetBSD: acpi_wakedev.c,v 1.29 2022/05/31 20:28:57 mrg Exp $ */
/*-
* Copyright (c) 2009, 2010, 2011 Jared D. McNeill <jmcneill@invisible.ca>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#include <sys/cdefs.h>
__KERNEL_RCSID(0, "$NetBSD: acpi_wakedev.c,v 1.29 2022/05/31 20:28:57 mrg Exp $");
#include "pci.h"
#include <sys/param.h>
#include <sys/device.h>
#include <sys/kmem.h>
#include <sys/sysctl.h>
#include <dev/acpi/acpireg.h>
#include <dev/acpi/acpivar.h>
#include <dev/acpi/acpi_pci.h>
#include <dev/acpi/acpi_power.h>
#include <dev/acpi/acpi_wakedev.h>
#define _COMPONENT ACPI_BUS_COMPONENT
ACPI_MODULE_NAME ("acpi_wakedev")
static const char * const acpi_wakedev_default[] = {
"PNP0C0C", /* power button */
"PNP0C0E", /* sleep button */
"PNP0C0D", /* lid switch */
"PNP03??", /* PC KBD port */
NULL,
};
static int32_t acpi_wakedev_acpinode = CTL_EOL;
static int32_t acpi_wakedev_wakenode = CTL_EOL;
static void acpi_wakedev_power_add(struct acpi_devnode *, ACPI_OBJECT *);
static void acpi_wakedev_power_set(struct acpi_devnode *, bool);
static void acpi_wakedev_method(struct acpi_devnode *, int);
void
acpi_wakedev_init(struct acpi_devnode *ad)
{
ACPI_OBJECT *elm, *obj;
ACPI_INTEGER val;
ACPI_HANDLE hdl;
ACPI_BUFFER buf;
ACPI_STATUS rv;
KASSERT(ad != NULL && ad->ad_wakedev == NULL);
KASSERT(ad->ad_devinfo->Type == ACPI_TYPE_DEVICE);
rv = acpi_eval_struct(ad->ad_handle, "_PRW", &buf);
if (ACPI_FAILURE(rv))
goto out;
obj = buf.Pointer;
if (obj->Type != ACPI_TYPE_PACKAGE) {
rv = AE_TYPE;
goto out;
}
if (obj->Package.Count < 2 || obj->Package.Count > UINT32_MAX) {
rv = AE_LIMIT;
goto out;
}
/*
* As noted in ACPI 3.0 (section 7.2.10), the _PRW object is
* a package in which the first element is either an integer
* or again a package. In the latter case the package inside
* the package element has two elements, a reference handle
* and the GPE number.
*/
elm = &obj->Package.Elements[0];
switch (elm->Type) {
case ACPI_TYPE_INTEGER:
val = elm->Integer.Value;
hdl = NULL;
break;
case ACPI_TYPE_PACKAGE:
if (elm->Package.Count < 2) {
rv = AE_LIMIT;
goto out;
}
rv = AE_TYPE;
if (elm->Package.Elements[0].Type != ACPI_TYPE_LOCAL_REFERENCE)
goto out;
if (elm->Package.Elements[1].Type != ACPI_TYPE_INTEGER)
goto out;
hdl = elm->Package.Elements[0].Reference.Handle;
val = elm->Package.Elements[1].Integer.Value;
break;
default:
rv = AE_TYPE;
goto out;
}
ad->ad_wakedev = kmem_zalloc(sizeof(*ad->ad_wakedev), KM_SLEEP);
ad->ad_wakedev->aw_handle = hdl;
ad->ad_wakedev->aw_number = val;
/*
* The second element in _PRW is an integer
* that contains the lowest sleep state that
* can be entered while still providing wakeup.
*/
elm = &obj->Package.Elements[1];
if (elm->Type == ACPI_TYPE_INTEGER)
ad->ad_wakedev->aw_state = elm->Integer.Value;
/*
* The rest of the elements are reference
* handles to power resources. Store these.
*/
acpi_wakedev_power_add(ad, obj);
/*
* Last but not least, mark the GPE for wake.
*/
rv = AcpiSetupGpeForWake(ad->ad_handle, hdl, val);
out:
if (buf.Pointer != NULL)
ACPI_FREE(buf.Pointer);
if (ACPI_FAILURE(rv) && rv != AE_NOT_FOUND)
aprint_error_dev(ad->ad_root, "failed to evaluate _PRW "
"for %s: %s\n", ad->ad_name, AcpiFormatException(rv));
}
static void
acpi_wakedev_power_add(struct acpi_devnode *ad, ACPI_OBJECT *obj)
{
struct acpi_wakedev *aw = ad->ad_wakedev;
uint32_t i, j, n;
ACPI_OBJECT *elm;
ACPI_HANDLE hdl;
ACPI_STATUS rv;
for (i = 0; i < __arraycount(aw->aw_power); i++)
aw->aw_power[i] = NULL;
n = obj->Package.Count;
if (n < 3 || n - 2 > __arraycount(aw->aw_power))
return;
for (i = 2, j = 0; i < n; i++, j++) {
elm = &obj->Package.Elements[i];
rv = acpi_eval_reference_handle(elm, &hdl);
if (ACPI_FAILURE(rv))
continue;
ad->ad_wakedev->aw_power[j] = hdl;
}
}
static void
acpi_wakedev_power_set(struct acpi_devnode *ad, bool enable)
{
struct acpi_wakedev *aw = ad->ad_wakedev;
uint8_t i;
for (i = 0; i < __arraycount(aw->aw_power); i++) {
if (aw->aw_power[i] == NULL)
continue;
(void)acpi_power_res(aw->aw_power[i], ad->ad_handle, enable);
}
}
void
acpi_wakedev_add(struct acpi_devnode *ad)
{
struct acpi_wakedev *aw;
const char *str = NULL;
int err;
KASSERT(ad != NULL && ad->ad_wakedev != NULL);
KASSERT((ad->ad_flags & ACPI_DEVICE_WAKEUP) != 0);
aw = ad->ad_wakedev;
aw->aw_enable = false;
if (acpi_match_hid(ad->ad_devinfo, acpi_wakedev_default))
aw->aw_enable = true;
if (acpi_wakedev_acpinode == CTL_EOL ||
acpi_wakedev_wakenode == CTL_EOL)
return;
if (ad->ad_device != NULL)
str = device_xname(ad->ad_device);
#if NPCI > 0
else {
device_t dev = acpi_pcidev_find_dev(ad);
if (dev != NULL)
str = device_xname(dev);
}
#endif
if (str == NULL)
return;
err = sysctl_createv(NULL, 0, NULL, NULL,
CTLFLAG_READWRITE, CTLTYPE_BOOL, str,
NULL, NULL, 0, &aw->aw_enable, 0, CTL_HW,
acpi_wakedev_acpinode, acpi_wakedev_wakenode,
CTL_CREATE, CTL_EOL);
if (err != 0)
aprint_error_dev(ad->ad_root, "sysctl_createv"
"(hw.acpi.wake.%s) failed (err %d)\n", str, err);
}
SYSCTL_SETUP(sysctl_acpi_wakedev_setup, "sysctl hw.acpi.wake subtree setup")
{
const struct sysctlnode *rnode;
int err;
err = sysctl_createv(NULL, 0, NULL, &rnode,
CTLFLAG_PERMANENT, CTLTYPE_NODE, "acpi",
NULL, NULL, 0, NULL, 0,
CTL_HW, CTL_CREATE, CTL_EOL);
if (err != 0)
return;
acpi_wakedev_acpinode = rnode->sysctl_num;
err = sysctl_createv(NULL, 0, &rnode, &rnode,
CTLFLAG_PERMANENT, CTLTYPE_NODE,
"wake", SYSCTL_DESCR("ACPI device wake-up"),
NULL, 0, NULL, 0,
CTL_CREATE, CTL_EOL);
if (err != 0)
return;
acpi_wakedev_wakenode = rnode->sysctl_num;
}
void
acpi_wakedev_commit(struct acpi_softc *sc, int state)
{
struct acpi_devnode *ad;
ACPI_INTEGER val;
ACPI_HANDLE hdl;
/*
* To prepare a device for wakeup:
*
* 1. Set the wake GPE.
*
* 2. Turn on power resources.
*
* 3. Execute _DSW or _PSW method.
*/
SIMPLEQ_FOREACH(ad, &sc->sc_head, ad_list) {
if (ad->ad_wakedev == NULL)
continue;
if (state > ad->ad_wakedev->aw_state)
continue;
hdl = ad->ad_wakedev->aw_handle;
val = ad->ad_wakedev->aw_number;
if (state == ACPI_STATE_S0) {
(void)AcpiSetGpeWakeMask(hdl, val, ACPI_GPE_DISABLE);
continue;
}
(void)AcpiSetGpeWakeMask(hdl, val, ACPI_GPE_ENABLE);
acpi_wakedev_power_set(ad, true);
acpi_wakedev_method(ad, state);
}
}
static void
acpi_wakedev_method(struct acpi_devnode *ad, int state)
{
const bool enable = ad->ad_wakedev->aw_enable;
ACPI_OBJECT_LIST arg;
ACPI_OBJECT obj[3];
ACPI_STATUS rv;
/*
* First try to call the Device Sleep Wake control method, _DSW.
* Only if this is not available, resort to to the Power State
* Wake control method, _PSW, which was deprecated in ACPI 3.0.
*
* The arguments to these methods are as follows:
*
* arg0 arg1 arg2
* ---- ---- ----
* _PSW 0: disable
* 1: enable
*
* _DSW 0: disable 0: S0 0: D0
* 1: enable 1: S1 1: D0 or D1
* 2: D0, D1, or D2
* x: Sx 3: D0, D1, D2 or D3
*/
arg.Count = 3;
arg.Pointer = obj;
obj[0].Integer.Value = enable;
obj[1].Integer.Value = state;
obj[2].Integer.Value = ACPI_STATE_D0;
obj[0].Type = obj[1].Type = obj[2].Type = ACPI_TYPE_INTEGER;
rv = AcpiEvaluateObject(ad->ad_handle, "_DSW", &arg, NULL);
if (ACPI_SUCCESS(rv))
return;
if (rv != AE_NOT_FOUND)
goto fail;
rv = acpi_eval_set_integer(ad->ad_handle, "_PSW", enable);
if (ACPI_FAILURE(rv) && rv != AE_NOT_FOUND)
goto fail;
return;
fail:
aprint_error_dev(ad->ad_root, "failed to evaluate wake "
"control method: %s\n", AcpiFormatException(rv));
}
|