wmi_acpi.c revision 1.20 1 1.20 andvar /* $NetBSD: wmi_acpi.c,v 1.20 2021/12/12 22:20:52 andvar Exp $ */
2 1.1 jruoho
3 1.1 jruoho /*-
4 1.1 jruoho * Copyright (c) 2009, 2010 Jukka Ruohonen <jruohonen (at) iki.fi>
5 1.1 jruoho * All rights reserved.
6 1.1 jruoho *
7 1.1 jruoho * Redistribution and use in source and binary forms, with or without
8 1.1 jruoho * modification, are permitted provided that the following conditions
9 1.1 jruoho * are met:
10 1.1 jruoho *
11 1.1 jruoho * 1. Redistributions of source code must retain the above copyright
12 1.1 jruoho * notice, this list of conditions and the following disclaimer.
13 1.1 jruoho * 2. Redistributions in binary form must reproduce the above copyright
14 1.1 jruoho * notice, this list of conditions and the following disclaimer in the
15 1.1 jruoho * documentation and/or other materials provided with the distribution.
16 1.1 jruoho *
17 1.1 jruoho * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 1.1 jruoho * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 1.1 jruoho * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 1.1 jruoho * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 1.1 jruoho * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 1.1 jruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 1.1 jruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 1.1 jruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 1.1 jruoho * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 1.1 jruoho * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 1.1 jruoho * SUCH DAMAGE.
28 1.1 jruoho */
29 1.1 jruoho #include <sys/cdefs.h>
30 1.20 andvar __KERNEL_RCSID(0, "$NetBSD: wmi_acpi.c,v 1.20 2021/12/12 22:20:52 andvar Exp $");
31 1.1 jruoho
32 1.1 jruoho #include <sys/param.h>
33 1.1 jruoho #include <sys/device.h>
34 1.1 jruoho #include <sys/endian.h>
35 1.1 jruoho #include <sys/kmem.h>
36 1.1 jruoho #include <sys/systm.h>
37 1.9 jmcneill #include <sys/module.h>
38 1.1 jruoho
39 1.1 jruoho #include <dev/acpi/acpireg.h>
40 1.1 jruoho #include <dev/acpi/acpivar.h>
41 1.11 jruoho #include <dev/acpi/acpi_ecvar.h>
42 1.1 jruoho #include <dev/acpi/wmi/wmi_acpivar.h>
43 1.1 jruoho
44 1.1 jruoho #define _COMPONENT ACPI_RESOURCE_COMPONENT
45 1.1 jruoho ACPI_MODULE_NAME ("wmi_acpi")
46 1.1 jruoho
47 1.1 jruoho /*
48 1.1 jruoho * This implements something called "Microsoft Windows Management
49 1.20 andvar * Instrumentation" (WMI). This subset of ACPI is described in:
50 1.1 jruoho *
51 1.1 jruoho * http://www.microsoft.com/whdc/system/pnppwr/wmi/wmi-acpi.mspx
52 1.1 jruoho *
53 1.1 jruoho * (Obtained on Thu Feb 12 18:21:44 EET 2009.)
54 1.1 jruoho */
55 1.1 jruoho
56 1.11 jruoho static int acpi_wmi_match(device_t, cfdata_t, void *);
57 1.11 jruoho static void acpi_wmi_attach(device_t, device_t, void *);
58 1.11 jruoho static int acpi_wmi_detach(device_t, int);
59 1.11 jruoho static int acpi_wmi_rescan(device_t, const char *, const int *);
60 1.11 jruoho static void acpi_wmi_childdet(device_t, device_t);
61 1.11 jruoho static int acpi_wmi_print(void *, const char *);
62 1.11 jruoho static bool acpi_wmi_init(struct acpi_wmi_softc *);
63 1.11 jruoho static void acpi_wmi_init_ec(struct acpi_wmi_softc *);
64 1.15 chs static void acpi_wmi_add(struct acpi_wmi_softc *, ACPI_OBJECT *);
65 1.11 jruoho static void acpi_wmi_del(struct acpi_wmi_softc *);
66 1.11 jruoho static void acpi_wmi_dump(struct acpi_wmi_softc *);
67 1.11 jruoho static ACPI_STATUS acpi_wmi_guid_get(struct acpi_wmi_softc *,
68 1.11 jruoho const char *, struct wmi_t **);
69 1.11 jruoho static void acpi_wmi_event_add(struct acpi_wmi_softc *);
70 1.11 jruoho static void acpi_wmi_event_del(struct acpi_wmi_softc *);
71 1.11 jruoho static void acpi_wmi_event_handler(ACPI_HANDLE, uint32_t, void *);
72 1.11 jruoho static ACPI_STATUS acpi_wmi_ec_handler(uint32_t, ACPI_PHYSICAL_ADDRESS,
73 1.11 jruoho uint32_t, ACPI_INTEGER *, void *, void *);
74 1.11 jruoho static bool acpi_wmi_suspend(device_t, const pmf_qual_t *);
75 1.11 jruoho static bool acpi_wmi_resume(device_t, const pmf_qual_t *);
76 1.13 jakllsch static ACPI_STATUS acpi_wmi_enable_event(ACPI_HANDLE, uint8_t, bool);
77 1.13 jakllsch static ACPI_STATUS acpi_wmi_enable_collection(ACPI_HANDLE, const char *, bool);
78 1.11 jruoho static bool acpi_wmi_input(struct wmi_t *, uint8_t, uint8_t);
79 1.1 jruoho
80 1.17 thorpej static const struct device_compatible_entry compat_data[] = {
81 1.17 thorpej { .compat = "PNP0C14" },
82 1.17 thorpej { .compat = "pnp0c14" },
83 1.17 thorpej DEVICE_COMPAT_EOL
84 1.1 jruoho };
85 1.1 jruoho
86 1.8 jmcneill CFATTACH_DECL2_NEW(acpiwmi, sizeof(struct acpi_wmi_softc),
87 1.8 jmcneill acpi_wmi_match, acpi_wmi_attach, acpi_wmi_detach, NULL,
88 1.8 jmcneill acpi_wmi_rescan, acpi_wmi_childdet);
89 1.1 jruoho
90 1.1 jruoho static int
91 1.1 jruoho acpi_wmi_match(device_t parent, cfdata_t match, void *aux)
92 1.1 jruoho {
93 1.1 jruoho struct acpi_attach_args *aa = aux;
94 1.1 jruoho
95 1.17 thorpej return acpi_compatible_match(aa, compat_data);
96 1.1 jruoho }
97 1.1 jruoho
98 1.1 jruoho static void
99 1.1 jruoho acpi_wmi_attach(device_t parent, device_t self, void *aux)
100 1.1 jruoho {
101 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
102 1.1 jruoho struct acpi_attach_args *aa = aux;
103 1.1 jruoho
104 1.1 jruoho sc->sc_dev = self;
105 1.1 jruoho sc->sc_node = aa->aa_node;
106 1.1 jruoho
107 1.1 jruoho sc->sc_child = NULL;
108 1.11 jruoho sc->sc_ecdev = NULL;
109 1.1 jruoho sc->sc_handler = NULL;
110 1.1 jruoho
111 1.1 jruoho aprint_naive("\n");
112 1.1 jruoho aprint_normal(": ACPI WMI Interface\n");
113 1.1 jruoho
114 1.1 jruoho if (acpi_wmi_init(sc) != true)
115 1.1 jruoho return;
116 1.1 jruoho
117 1.7 jruoho acpi_wmi_dump(sc);
118 1.11 jruoho acpi_wmi_init_ec(sc);
119 1.4 jruoho acpi_wmi_event_add(sc);
120 1.8 jmcneill acpi_wmi_rescan(self, NULL, NULL);
121 1.4 jruoho
122 1.4 jruoho (void)pmf_device_register(self, acpi_wmi_suspend, acpi_wmi_resume);
123 1.1 jruoho }
124 1.1 jruoho
125 1.1 jruoho static int
126 1.1 jruoho acpi_wmi_detach(device_t self, int flags)
127 1.1 jruoho {
128 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
129 1.1 jruoho
130 1.4 jruoho acpi_wmi_event_del(sc);
131 1.1 jruoho
132 1.11 jruoho if (sc->sc_ecdev != NULL) {
133 1.11 jruoho
134 1.11 jruoho (void)AcpiRemoveAddressSpaceHandler(sc->sc_node->ad_handle,
135 1.11 jruoho ACPI_ADR_SPACE_EC, acpi_wmi_ec_handler);
136 1.11 jruoho }
137 1.11 jruoho
138 1.1 jruoho if (sc->sc_child != NULL)
139 1.1 jruoho (void)config_detach(sc->sc_child, flags);
140 1.1 jruoho
141 1.1 jruoho acpi_wmi_del(sc);
142 1.1 jruoho pmf_device_deregister(self);
143 1.1 jruoho
144 1.1 jruoho return 0;
145 1.1 jruoho }
146 1.1 jruoho
147 1.1 jruoho static int
148 1.8 jmcneill acpi_wmi_rescan(device_t self, const char *ifattr, const int *locators)
149 1.8 jmcneill {
150 1.8 jmcneill struct acpi_wmi_softc *sc = device_private(self);
151 1.8 jmcneill
152 1.18 thorpej if (sc->sc_child == NULL) {
153 1.18 thorpej sc->sc_child =
154 1.19 thorpej config_found(self, NULL, acpi_wmi_print, CFARGS_NONE);
155 1.18 thorpej }
156 1.8 jmcneill
157 1.8 jmcneill return 0;
158 1.8 jmcneill }
159 1.8 jmcneill
160 1.8 jmcneill static void
161 1.8 jmcneill acpi_wmi_childdet(device_t self, device_t child)
162 1.8 jmcneill {
163 1.8 jmcneill struct acpi_wmi_softc *sc = device_private(self);
164 1.8 jmcneill
165 1.8 jmcneill if (sc->sc_child == child)
166 1.8 jmcneill sc->sc_child = NULL;
167 1.8 jmcneill }
168 1.8 jmcneill
169 1.8 jmcneill static int
170 1.1 jruoho acpi_wmi_print(void *aux, const char *pnp)
171 1.1 jruoho {
172 1.1 jruoho
173 1.1 jruoho if (pnp != NULL)
174 1.1 jruoho aprint_normal("acpiwmibus at %s", pnp);
175 1.1 jruoho
176 1.1 jruoho return UNCONF;
177 1.1 jruoho }
178 1.1 jruoho
179 1.1 jruoho static bool
180 1.1 jruoho acpi_wmi_init(struct acpi_wmi_softc *sc)
181 1.1 jruoho {
182 1.1 jruoho ACPI_OBJECT *obj;
183 1.1 jruoho ACPI_BUFFER buf;
184 1.1 jruoho ACPI_STATUS rv;
185 1.1 jruoho uint32_t len;
186 1.1 jruoho
187 1.1 jruoho rv = acpi_eval_struct(sc->sc_node->ad_handle, "_WDG", &buf);
188 1.1 jruoho
189 1.1 jruoho if (ACPI_FAILURE(rv))
190 1.1 jruoho goto fail;
191 1.1 jruoho
192 1.1 jruoho obj = buf.Pointer;
193 1.1 jruoho
194 1.1 jruoho if (obj->Type != ACPI_TYPE_BUFFER) {
195 1.1 jruoho rv = AE_TYPE;
196 1.1 jruoho goto fail;
197 1.1 jruoho }
198 1.1 jruoho
199 1.1 jruoho len = obj->Buffer.Length;
200 1.1 jruoho
201 1.1 jruoho if (len != obj->Package.Count) {
202 1.1 jruoho rv = AE_BAD_VALUE;
203 1.1 jruoho goto fail;
204 1.1 jruoho }
205 1.1 jruoho
206 1.1 jruoho CTASSERT(sizeof(struct guid_t) == 20);
207 1.1 jruoho
208 1.1 jruoho if (len < sizeof(struct guid_t) ||
209 1.1 jruoho len % sizeof(struct guid_t) != 0) {
210 1.1 jruoho rv = AE_BAD_DATA;
211 1.1 jruoho goto fail;
212 1.1 jruoho }
213 1.1 jruoho
214 1.15 chs acpi_wmi_add(sc, obj);
215 1.15 chs return true;
216 1.1 jruoho
217 1.1 jruoho fail:
218 1.1 jruoho aprint_error_dev(sc->sc_dev, "failed to evaluate _WDG: %s\n",
219 1.1 jruoho AcpiFormatException(rv));
220 1.1 jruoho
221 1.1 jruoho if (buf.Pointer != NULL)
222 1.1 jruoho ACPI_FREE(buf.Pointer);
223 1.1 jruoho
224 1.1 jruoho return false;
225 1.1 jruoho }
226 1.1 jruoho
227 1.15 chs static void
228 1.1 jruoho acpi_wmi_add(struct acpi_wmi_softc *sc, ACPI_OBJECT *obj)
229 1.1 jruoho {
230 1.1 jruoho struct wmi_t *wmi;
231 1.1 jruoho size_t i, n, offset, siz;
232 1.1 jruoho
233 1.1 jruoho siz = sizeof(struct guid_t);
234 1.1 jruoho n = obj->Buffer.Length / siz;
235 1.1 jruoho
236 1.1 jruoho SIMPLEQ_INIT(&sc->wmi_head);
237 1.1 jruoho
238 1.1 jruoho for (i = offset = 0; i < n; ++i) {
239 1.1 jruoho
240 1.15 chs wmi = kmem_zalloc(sizeof(*wmi), KM_SLEEP);
241 1.1 jruoho (void)memcpy(&wmi->guid, obj->Buffer.Pointer + offset, siz);
242 1.1 jruoho
243 1.1 jruoho wmi->eevent = false;
244 1.1 jruoho offset = offset + siz;
245 1.1 jruoho
246 1.1 jruoho SIMPLEQ_INSERT_TAIL(&sc->wmi_head, wmi, wmi_link);
247 1.1 jruoho }
248 1.1 jruoho
249 1.1 jruoho ACPI_FREE(obj);
250 1.1 jruoho }
251 1.1 jruoho
252 1.1 jruoho static void
253 1.1 jruoho acpi_wmi_del(struct acpi_wmi_softc *sc)
254 1.1 jruoho {
255 1.1 jruoho struct wmi_t *wmi;
256 1.1 jruoho
257 1.1 jruoho while (SIMPLEQ_FIRST(&sc->wmi_head) != NULL) {
258 1.1 jruoho wmi = SIMPLEQ_FIRST(&sc->wmi_head);
259 1.1 jruoho SIMPLEQ_REMOVE_HEAD(&sc->wmi_head, wmi_link);
260 1.1 jruoho kmem_free(wmi, sizeof(*wmi));
261 1.1 jruoho }
262 1.1 jruoho }
263 1.1 jruoho
264 1.7 jruoho static void
265 1.7 jruoho acpi_wmi_dump(struct acpi_wmi_softc *sc)
266 1.7 jruoho {
267 1.7 jruoho struct wmi_t *wmi;
268 1.7 jruoho
269 1.7 jruoho KASSERT(SIMPLEQ_EMPTY(&sc->wmi_head) == 0);
270 1.7 jruoho
271 1.7 jruoho SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
272 1.7 jruoho
273 1.7 jruoho aprint_debug_dev(sc->sc_dev, "{%08X-%04X-%04X-",
274 1.7 jruoho wmi->guid.data1, wmi->guid.data2, wmi->guid.data3);
275 1.7 jruoho
276 1.7 jruoho aprint_debug("%02X%02X-%02X%02X%02X%02X%02X%02X} ",
277 1.7 jruoho wmi->guid.data4[0], wmi->guid.data4[1],
278 1.7 jruoho wmi->guid.data4[2], wmi->guid.data4[3],
279 1.7 jruoho wmi->guid.data4[4], wmi->guid.data4[5],
280 1.7 jruoho wmi->guid.data4[6], wmi->guid.data4[7]);
281 1.7 jruoho
282 1.7 jruoho aprint_debug("oid %04X count %02X flags %02X\n",
283 1.7 jruoho UGET16(wmi->guid.oid), wmi->guid.count, wmi->guid.flags);
284 1.7 jruoho }
285 1.7 jruoho }
286 1.7 jruoho
287 1.11 jruoho static void
288 1.11 jruoho acpi_wmi_init_ec(struct acpi_wmi_softc *sc)
289 1.11 jruoho {
290 1.11 jruoho ACPI_STATUS rv;
291 1.11 jruoho deviter_t i;
292 1.11 jruoho device_t d;
293 1.11 jruoho
294 1.11 jruoho d = deviter_first(&i, DEVITER_F_ROOT_FIRST);
295 1.11 jruoho
296 1.11 jruoho for (; d != NULL; d = deviter_next(&i)) {
297 1.11 jruoho
298 1.11 jruoho if (device_is_a(d, "acpiec") != false ||
299 1.11 jruoho device_is_a(d, "acpiecdt") != false) {
300 1.11 jruoho sc->sc_ecdev = d;
301 1.11 jruoho break;
302 1.11 jruoho }
303 1.11 jruoho }
304 1.11 jruoho
305 1.11 jruoho deviter_release(&i);
306 1.11 jruoho
307 1.11 jruoho if (sc->sc_ecdev == NULL)
308 1.11 jruoho return;
309 1.11 jruoho
310 1.11 jruoho rv = AcpiInstallAddressSpaceHandler(sc->sc_node->ad_handle,
311 1.11 jruoho ACPI_ADR_SPACE_EC, acpi_wmi_ec_handler, NULL, sc);
312 1.11 jruoho
313 1.11 jruoho if (ACPI_FAILURE(rv))
314 1.11 jruoho sc->sc_ecdev = NULL;
315 1.11 jruoho }
316 1.11 jruoho
317 1.1 jruoho static ACPI_STATUS
318 1.1 jruoho acpi_wmi_guid_get(struct acpi_wmi_softc *sc,
319 1.1 jruoho const char *src, struct wmi_t **out)
320 1.1 jruoho {
321 1.1 jruoho struct wmi_t *wmi;
322 1.1 jruoho struct guid_t *guid;
323 1.1 jruoho char bin[16];
324 1.16 bouyer char hex[3];
325 1.1 jruoho const char *ptr;
326 1.1 jruoho uint8_t i;
327 1.1 jruoho
328 1.1 jruoho if (sc == NULL || src == NULL || strlen(src) != 36)
329 1.1 jruoho return AE_BAD_PARAMETER;
330 1.1 jruoho
331 1.1 jruoho for (ptr = src, i = 0; i < 16; i++) {
332 1.1 jruoho
333 1.1 jruoho if (*ptr == '-')
334 1.1 jruoho ptr++;
335 1.1 jruoho
336 1.1 jruoho (void)memcpy(hex, ptr, 2);
337 1.16 bouyer hex[2] = '\0';
338 1.1 jruoho
339 1.2 jruoho if (HEXCHAR(hex[0]) == 0 || HEXCHAR(hex[1]) == 0)
340 1.1 jruoho return AE_BAD_HEX_CONSTANT;
341 1.1 jruoho
342 1.1 jruoho bin[i] = strtoul(hex, NULL, 16) & 0xFF;
343 1.1 jruoho
344 1.1 jruoho ptr++;
345 1.1 jruoho ptr++;
346 1.1 jruoho }
347 1.1 jruoho
348 1.1 jruoho guid = (struct guid_t *)bin;
349 1.1 jruoho guid->data1 = be32toh(guid->data1);
350 1.1 jruoho guid->data2 = be16toh(guid->data2);
351 1.1 jruoho guid->data3 = be16toh(guid->data3);
352 1.1 jruoho
353 1.1 jruoho SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
354 1.1 jruoho
355 1.1 jruoho if (GUIDCMP(guid, &wmi->guid) != 0) {
356 1.1 jruoho
357 1.1 jruoho if (out != NULL)
358 1.1 jruoho *out = wmi;
359 1.1 jruoho
360 1.1 jruoho return AE_OK;
361 1.1 jruoho }
362 1.1 jruoho }
363 1.1 jruoho
364 1.1 jruoho return AE_NOT_FOUND;
365 1.1 jruoho }
366 1.1 jruoho
367 1.1 jruoho /*
368 1.1 jruoho * Checks if a GUID is present. Child devices
369 1.1 jruoho * can use this in their autoconf(9) routines.
370 1.1 jruoho */
371 1.1 jruoho int
372 1.1 jruoho acpi_wmi_guid_match(device_t self, const char *guid)
373 1.1 jruoho {
374 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
375 1.1 jruoho ACPI_STATUS rv;
376 1.1 jruoho
377 1.1 jruoho rv = acpi_wmi_guid_get(sc, guid, NULL);
378 1.1 jruoho
379 1.1 jruoho if (ACPI_SUCCESS(rv))
380 1.1 jruoho return 1;
381 1.1 jruoho
382 1.1 jruoho return 0;
383 1.1 jruoho }
384 1.1 jruoho
385 1.1 jruoho /*
386 1.1 jruoho * Adds internal event handler.
387 1.1 jruoho */
388 1.4 jruoho static void
389 1.1 jruoho acpi_wmi_event_add(struct acpi_wmi_softc *sc)
390 1.1 jruoho {
391 1.1 jruoho struct wmi_t *wmi;
392 1.1 jruoho ACPI_STATUS rv;
393 1.1 jruoho
394 1.4 jruoho if (acpi_register_notify(sc->sc_node, acpi_wmi_event_handler) != true)
395 1.4 jruoho return;
396 1.1 jruoho
397 1.6 jruoho /*
398 1.13 jakllsch * Enable possible events, expensive or otherwise.
399 1.6 jruoho */
400 1.1 jruoho SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
401 1.1 jruoho
402 1.13 jakllsch if ((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) != 0) {
403 1.1 jruoho
404 1.13 jakllsch rv = acpi_wmi_enable_event(sc->sc_node->ad_handle,
405 1.13 jakllsch wmi->guid.nid, true);
406 1.1 jruoho
407 1.1 jruoho if (ACPI_SUCCESS(rv)) {
408 1.1 jruoho wmi->eevent = true;
409 1.1 jruoho continue;
410 1.1 jruoho }
411 1.1 jruoho
412 1.6 jruoho aprint_debug_dev(sc->sc_dev, "failed to enable "
413 1.1 jruoho "expensive WExx: %s\n", AcpiFormatException(rv));
414 1.1 jruoho }
415 1.1 jruoho }
416 1.1 jruoho }
417 1.1 jruoho
418 1.1 jruoho /*
419 1.1 jruoho * Removes the internal event handler.
420 1.1 jruoho */
421 1.4 jruoho static void
422 1.1 jruoho acpi_wmi_event_del(struct acpi_wmi_softc *sc)
423 1.1 jruoho {
424 1.1 jruoho struct wmi_t *wmi;
425 1.1 jruoho ACPI_STATUS rv;
426 1.1 jruoho
427 1.4 jruoho acpi_deregister_notify(sc->sc_node);
428 1.1 jruoho
429 1.1 jruoho SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
430 1.1 jruoho
431 1.1 jruoho if (wmi->eevent != true)
432 1.1 jruoho continue;
433 1.1 jruoho
434 1.1 jruoho KASSERT((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) != 0);
435 1.1 jruoho
436 1.13 jakllsch rv = acpi_wmi_enable_event(sc->sc_node->ad_handle,
437 1.13 jakllsch wmi->guid.nid, false);
438 1.1 jruoho
439 1.1 jruoho if (ACPI_SUCCESS(rv)) {
440 1.1 jruoho wmi->eevent = false;
441 1.1 jruoho continue;
442 1.1 jruoho }
443 1.1 jruoho
444 1.6 jruoho aprint_debug_dev(sc->sc_dev, "failed to disable "
445 1.1 jruoho "expensive WExx: %s\n", AcpiFormatException(rv));
446 1.1 jruoho }
447 1.1 jruoho }
448 1.1 jruoho
449 1.1 jruoho /*
450 1.1 jruoho * Returns extra information possibly associated with an event.
451 1.1 jruoho */
452 1.1 jruoho ACPI_STATUS
453 1.1 jruoho acpi_wmi_event_get(device_t self, uint32_t event, ACPI_BUFFER *obuf)
454 1.1 jruoho {
455 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
456 1.1 jruoho struct wmi_t *wmi;
457 1.1 jruoho ACPI_OBJECT_LIST arg;
458 1.1 jruoho ACPI_OBJECT obj;
459 1.2 jruoho ACPI_HANDLE hdl;
460 1.2 jruoho
461 1.1 jruoho if (sc == NULL || obuf == NULL)
462 1.1 jruoho return AE_BAD_PARAMETER;
463 1.1 jruoho
464 1.1 jruoho if (sc->sc_handler == NULL)
465 1.1 jruoho return AE_ABORT_METHOD;
466 1.1 jruoho
467 1.3 jruoho hdl = sc->sc_node->ad_handle;
468 1.3 jruoho
469 1.1 jruoho obj.Type = ACPI_TYPE_INTEGER;
470 1.1 jruoho obj.Integer.Value = event;
471 1.1 jruoho
472 1.1 jruoho arg.Count = 0x01;
473 1.1 jruoho arg.Pointer = &obj;
474 1.1 jruoho
475 1.1 jruoho obuf->Pointer = NULL;
476 1.1 jruoho obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
477 1.1 jruoho
478 1.1 jruoho SIMPLEQ_FOREACH(wmi, &sc->wmi_head, wmi_link) {
479 1.1 jruoho
480 1.1 jruoho if ((wmi->guid.flags & ACPI_WMI_FLAG_EVENT) == 0)
481 1.1 jruoho continue;
482 1.1 jruoho
483 1.1 jruoho if (wmi->guid.nid != event)
484 1.1 jruoho continue;
485 1.1 jruoho
486 1.2 jruoho return AcpiEvaluateObject(hdl, "_WED", &arg, obuf);
487 1.1 jruoho }
488 1.1 jruoho
489 1.1 jruoho return AE_NOT_FOUND;
490 1.1 jruoho }
491 1.1 jruoho
492 1.1 jruoho /*
493 1.1 jruoho * Forwards events to the external handler through the internal one.
494 1.1 jruoho */
495 1.1 jruoho static void
496 1.1 jruoho acpi_wmi_event_handler(ACPI_HANDLE hdl, uint32_t evt, void *aux)
497 1.1 jruoho {
498 1.4 jruoho struct acpi_wmi_softc *sc;
499 1.4 jruoho device_t self = aux;
500 1.4 jruoho
501 1.4 jruoho sc = device_private(self);
502 1.1 jruoho
503 1.1 jruoho if (sc->sc_child == NULL)
504 1.1 jruoho return;
505 1.1 jruoho
506 1.1 jruoho if (sc->sc_handler == NULL)
507 1.1 jruoho return;
508 1.1 jruoho
509 1.1 jruoho (*sc->sc_handler)(NULL, evt, sc->sc_child);
510 1.1 jruoho }
511 1.1 jruoho
512 1.1 jruoho ACPI_STATUS
513 1.1 jruoho acpi_wmi_event_register(device_t self, ACPI_NOTIFY_HANDLER handler)
514 1.1 jruoho {
515 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
516 1.1 jruoho
517 1.1 jruoho if (sc == NULL)
518 1.1 jruoho return AE_BAD_PARAMETER;
519 1.1 jruoho
520 1.1 jruoho if (handler != NULL && sc->sc_handler != NULL)
521 1.1 jruoho return AE_ALREADY_EXISTS;
522 1.1 jruoho
523 1.1 jruoho sc->sc_handler = handler;
524 1.1 jruoho
525 1.1 jruoho return AE_OK;
526 1.1 jruoho }
527 1.1 jruoho
528 1.1 jruoho ACPI_STATUS
529 1.1 jruoho acpi_wmi_event_deregister(device_t self)
530 1.1 jruoho {
531 1.1 jruoho return acpi_wmi_event_register(self, NULL);
532 1.1 jruoho }
533 1.1 jruoho
534 1.1 jruoho /*
535 1.11 jruoho * Handler for EC regions, which may be embedded in WMI.
536 1.11 jruoho */
537 1.11 jruoho static ACPI_STATUS
538 1.11 jruoho acpi_wmi_ec_handler(uint32_t func, ACPI_PHYSICAL_ADDRESS addr,
539 1.11 jruoho uint32_t width, ACPI_INTEGER *val, void *setup, void *aux)
540 1.11 jruoho {
541 1.11 jruoho struct acpi_wmi_softc *sc = aux;
542 1.11 jruoho
543 1.11 jruoho if (aux == NULL || val == NULL)
544 1.11 jruoho return AE_BAD_PARAMETER;
545 1.11 jruoho
546 1.11 jruoho if (addr > 0xFF || width % 8 != 0)
547 1.11 jruoho return AE_BAD_ADDRESS;
548 1.11 jruoho
549 1.11 jruoho switch (func) {
550 1.11 jruoho
551 1.11 jruoho case ACPI_READ:
552 1.11 jruoho (void)acpiec_bus_read(sc->sc_ecdev, addr, val, width);
553 1.11 jruoho break;
554 1.11 jruoho
555 1.11 jruoho case ACPI_WRITE:
556 1.11 jruoho (void)acpiec_bus_write(sc->sc_ecdev, addr, *val, width);
557 1.11 jruoho break;
558 1.11 jruoho
559 1.11 jruoho default:
560 1.11 jruoho return AE_BAD_PARAMETER;
561 1.11 jruoho }
562 1.11 jruoho
563 1.11 jruoho return AE_OK;
564 1.11 jruoho }
565 1.11 jruoho
566 1.11 jruoho /*
567 1.1 jruoho * As there is no prior knowledge about the expensive
568 1.1 jruoho * events that cause "significant overhead", try to
569 1.1 jruoho * disable (enable) these before suspending (resuming).
570 1.1 jruoho */
571 1.1 jruoho static bool
572 1.1 jruoho acpi_wmi_suspend(device_t self, const pmf_qual_t *qual)
573 1.1 jruoho {
574 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
575 1.1 jruoho
576 1.1 jruoho acpi_wmi_event_del(sc);
577 1.1 jruoho
578 1.1 jruoho return true;
579 1.1 jruoho }
580 1.1 jruoho
581 1.1 jruoho static bool
582 1.1 jruoho acpi_wmi_resume(device_t self, const pmf_qual_t *qual)
583 1.1 jruoho {
584 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
585 1.1 jruoho
586 1.1 jruoho acpi_wmi_event_add(sc);
587 1.1 jruoho
588 1.1 jruoho return true;
589 1.1 jruoho }
590 1.1 jruoho
591 1.1 jruoho static ACPI_STATUS
592 1.13 jakllsch acpi_wmi_enable_event(ACPI_HANDLE hdl, uint8_t nid, bool flag)
593 1.1 jruoho {
594 1.1 jruoho char path[5];
595 1.1 jruoho
596 1.13 jakllsch snprintf(path, sizeof(path), "WE%02X", nid);
597 1.13 jakllsch
598 1.13 jakllsch return acpi_eval_set_integer(hdl, path, (flag != false) ? 0x01 : 0x00);
599 1.13 jakllsch }
600 1.13 jakllsch
601 1.13 jakllsch static ACPI_STATUS
602 1.13 jakllsch acpi_wmi_enable_collection(ACPI_HANDLE hdl, const char *oid, bool flag)
603 1.13 jakllsch {
604 1.13 jakllsch char path[5];
605 1.1 jruoho
606 1.13 jakllsch strlcpy(path, "WC", sizeof(path));
607 1.13 jakllsch strlcat(path, oid, sizeof(path));
608 1.1 jruoho
609 1.1 jruoho return acpi_eval_set_integer(hdl, path, (flag != false) ? 0x01 : 0x00);
610 1.1 jruoho }
611 1.1 jruoho
612 1.1 jruoho static bool
613 1.1 jruoho acpi_wmi_input(struct wmi_t *wmi, uint8_t flag, uint8_t idx)
614 1.1 jruoho {
615 1.16 bouyer /* A data block may have no flags at all */
616 1.16 bouyer if ((wmi->guid.flags & flag) == 0 &&
617 1.16 bouyer (flag == ACPI_WMI_FLAG_DATA &&
618 1.16 bouyer (wmi->guid.flags & ~ACPI_WMI_FLAG_EXPENSIVE) != 0))
619 1.1 jruoho return false;
620 1.1 jruoho
621 1.1 jruoho if (wmi->guid.count == 0x00)
622 1.1 jruoho return false;
623 1.1 jruoho
624 1.1 jruoho if (wmi->guid.count < idx)
625 1.1 jruoho return false;
626 1.1 jruoho
627 1.1 jruoho return true;
628 1.1 jruoho }
629 1.1 jruoho
630 1.1 jruoho /*
631 1.1 jruoho * Makes a WMI data block query (WQxx). The corresponding control
632 1.1 jruoho * method for data collection will be invoked if it is available.
633 1.1 jruoho */
634 1.1 jruoho ACPI_STATUS
635 1.1 jruoho acpi_wmi_data_query(device_t self, const char *guid,
636 1.1 jruoho uint8_t idx, ACPI_BUFFER *obuf)
637 1.1 jruoho {
638 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
639 1.1 jruoho struct wmi_t *wmi;
640 1.1 jruoho char path[5] = "WQ";
641 1.1 jruoho ACPI_OBJECT_LIST arg;
642 1.1 jruoho ACPI_STATUS rv, rvxx;
643 1.1 jruoho ACPI_OBJECT obj;
644 1.1 jruoho
645 1.1 jruoho rvxx = AE_SUPPORT;
646 1.1 jruoho
647 1.1 jruoho if (obuf == NULL)
648 1.1 jruoho return AE_BAD_PARAMETER;
649 1.1 jruoho
650 1.1 jruoho rv = acpi_wmi_guid_get(sc, guid, &wmi);
651 1.1 jruoho
652 1.1 jruoho if (ACPI_FAILURE(rv))
653 1.1 jruoho return rv;
654 1.1 jruoho
655 1.1 jruoho if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_DATA, idx) != true)
656 1.1 jruoho return AE_BAD_DATA;
657 1.1 jruoho
658 1.1 jruoho (void)strlcat(path, wmi->guid.oid, sizeof(path));
659 1.1 jruoho
660 1.1 jruoho obj.Type = ACPI_TYPE_INTEGER;
661 1.1 jruoho obj.Integer.Value = idx;
662 1.1 jruoho
663 1.1 jruoho arg.Count = 0x01;
664 1.1 jruoho arg.Pointer = &obj;
665 1.1 jruoho
666 1.1 jruoho obuf->Pointer = NULL;
667 1.1 jruoho obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
668 1.1 jruoho
669 1.1 jruoho /*
670 1.1 jruoho * If the expensive flag is set, we should enable
671 1.1 jruoho * data collection before evaluating the WQxx buffer.
672 1.1 jruoho */
673 1.1 jruoho if ((wmi->guid.flags & ACPI_WMI_FLAG_EXPENSIVE) != 0) {
674 1.1 jruoho
675 1.13 jakllsch rvxx = acpi_wmi_enable_collection(sc->sc_node->ad_handle,
676 1.13 jakllsch wmi->guid.oid, true);
677 1.1 jruoho }
678 1.1 jruoho
679 1.1 jruoho rv = AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, obuf);
680 1.1 jruoho
681 1.1 jruoho /* No longer needed. */
682 1.1 jruoho if (ACPI_SUCCESS(rvxx)) {
683 1.1 jruoho
684 1.13 jakllsch (void)acpi_wmi_enable_collection(sc->sc_node->ad_handle,
685 1.13 jakllsch wmi->guid.oid, false);
686 1.1 jruoho }
687 1.1 jruoho
688 1.1 jruoho #ifdef DIAGNOSTIC
689 1.1 jruoho /*
690 1.1 jruoho * XXX: It appears that quite a few laptops have WQxx
691 1.1 jruoho * methods that are declared as expensive, but lack the
692 1.1 jruoho * corresponding WCxx control method.
693 1.1 jruoho *
694 1.1 jruoho * -- Acer Aspire One is one example <jruohonen (at) iki.fi>.
695 1.1 jruoho */
696 1.1 jruoho if (ACPI_FAILURE(rvxx) && rvxx != AE_SUPPORT)
697 1.1 jruoho aprint_error_dev(sc->sc_dev, "failed to evaluate WCxx "
698 1.1 jruoho "for %s: %s\n", path, AcpiFormatException(rvxx));
699 1.1 jruoho #endif
700 1.1 jruoho return rv;
701 1.1 jruoho }
702 1.1 jruoho
703 1.1 jruoho /*
704 1.1 jruoho * Writes to a data block (WSxx).
705 1.1 jruoho */
706 1.1 jruoho ACPI_STATUS
707 1.1 jruoho acpi_wmi_data_write(device_t self, const char *guid,
708 1.1 jruoho uint8_t idx, ACPI_BUFFER *ibuf)
709 1.1 jruoho {
710 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
711 1.1 jruoho struct wmi_t *wmi;
712 1.1 jruoho ACPI_OBJECT_LIST arg;
713 1.1 jruoho ACPI_OBJECT obj[2];
714 1.1 jruoho char path[5] = "WS";
715 1.1 jruoho ACPI_STATUS rv;
716 1.1 jruoho
717 1.1 jruoho if (ibuf == NULL)
718 1.1 jruoho return AE_BAD_PARAMETER;
719 1.1 jruoho
720 1.1 jruoho rv = acpi_wmi_guid_get(sc, guid, &wmi);
721 1.1 jruoho
722 1.1 jruoho if (ACPI_FAILURE(rv))
723 1.1 jruoho return rv;
724 1.1 jruoho
725 1.1 jruoho if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_DATA, idx) != true)
726 1.1 jruoho return AE_BAD_DATA;
727 1.1 jruoho
728 1.1 jruoho (void)strlcat(path, wmi->guid.oid, sizeof(path));
729 1.1 jruoho
730 1.1 jruoho obj[0].Integer.Value = idx;
731 1.1 jruoho obj[0].Type = ACPI_TYPE_INTEGER;
732 1.1 jruoho
733 1.1 jruoho obj[1].Buffer.Length = ibuf->Length;
734 1.1 jruoho obj[1].Buffer.Pointer = ibuf->Pointer;
735 1.1 jruoho
736 1.1 jruoho obj[1].Type = ((wmi->guid.flags & ACPI_WMI_FLAG_STRING) != 0) ?
737 1.1 jruoho ACPI_TYPE_STRING : ACPI_TYPE_BUFFER;
738 1.1 jruoho
739 1.1 jruoho arg.Count = 0x02;
740 1.1 jruoho arg.Pointer = obj;
741 1.1 jruoho
742 1.1 jruoho return AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, NULL);
743 1.1 jruoho }
744 1.1 jruoho
745 1.1 jruoho /*
746 1.1 jruoho * Executes a method (WMxx).
747 1.1 jruoho */
748 1.1 jruoho ACPI_STATUS
749 1.1 jruoho acpi_wmi_method(device_t self, const char *guid, uint8_t idx,
750 1.1 jruoho uint32_t mid, ACPI_BUFFER *ibuf, ACPI_BUFFER *obuf)
751 1.1 jruoho {
752 1.1 jruoho struct acpi_wmi_softc *sc = device_private(self);
753 1.1 jruoho struct wmi_t *wmi;
754 1.1 jruoho ACPI_OBJECT_LIST arg;
755 1.1 jruoho ACPI_OBJECT obj[3];
756 1.1 jruoho char path[5] = "WM";
757 1.1 jruoho ACPI_STATUS rv;
758 1.1 jruoho
759 1.1 jruoho if (ibuf == NULL || obuf == NULL)
760 1.1 jruoho return AE_BAD_PARAMETER;
761 1.1 jruoho
762 1.1 jruoho rv = acpi_wmi_guid_get(sc, guid, &wmi);
763 1.1 jruoho
764 1.1 jruoho if (ACPI_FAILURE(rv))
765 1.1 jruoho return rv;
766 1.1 jruoho
767 1.1 jruoho if (acpi_wmi_input(wmi, ACPI_WMI_FLAG_METHOD, idx) != true)
768 1.1 jruoho return AE_BAD_DATA;
769 1.1 jruoho
770 1.1 jruoho (void)strlcat(path, wmi->guid.oid, sizeof(path));
771 1.1 jruoho
772 1.1 jruoho obj[0].Integer.Value = idx;
773 1.1 jruoho obj[1].Integer.Value = mid;
774 1.1 jruoho obj[0].Type = obj[1].Type = ACPI_TYPE_INTEGER;
775 1.1 jruoho
776 1.1 jruoho obj[2].Buffer.Length = ibuf->Length;
777 1.1 jruoho obj[2].Buffer.Pointer = ibuf->Pointer;
778 1.1 jruoho
779 1.1 jruoho obj[2].Type = ((wmi->guid.flags & ACPI_WMI_FLAG_STRING) != 0) ?
780 1.1 jruoho ACPI_TYPE_STRING : ACPI_TYPE_BUFFER;
781 1.1 jruoho
782 1.1 jruoho arg.Count = 0x03;
783 1.1 jruoho arg.Pointer = obj;
784 1.1 jruoho
785 1.1 jruoho obuf->Pointer = NULL;
786 1.1 jruoho obuf->Length = ACPI_ALLOCATE_LOCAL_BUFFER;
787 1.1 jruoho
788 1.1 jruoho return AcpiEvaluateObject(sc->sc_node->ad_handle, path, &arg, obuf);
789 1.1 jruoho }
790 1.9 jmcneill
791 1.9 jmcneill MODULE(MODULE_CLASS_DRIVER, acpiwmi, NULL);
792 1.9 jmcneill
793 1.12 jruoho #ifdef _MODULE
794 1.12 jruoho #include "ioconf.c"
795 1.12 jruoho #endif
796 1.9 jmcneill
797 1.9 jmcneill static int
798 1.12 jruoho acpiwmi_modcmd(modcmd_t cmd, void *aux)
799 1.9 jmcneill {
800 1.12 jruoho int rv = 0;
801 1.9 jmcneill
802 1.9 jmcneill switch (cmd) {
803 1.9 jmcneill
804 1.9 jmcneill case MODULE_CMD_INIT:
805 1.9 jmcneill
806 1.12 jruoho #ifdef _MODULE
807 1.12 jruoho rv = config_init_component(cfdriver_ioconf_acpiwmi,
808 1.12 jruoho cfattach_ioconf_acpiwmi, cfdata_ioconf_acpiwmi);
809 1.12 jruoho #endif
810 1.12 jruoho break;
811 1.9 jmcneill
812 1.9 jmcneill case MODULE_CMD_FINI:
813 1.9 jmcneill
814 1.12 jruoho #ifdef _MODULE
815 1.12 jruoho rv = config_fini_component(cfdriver_ioconf_acpiwmi,
816 1.12 jruoho cfattach_ioconf_acpiwmi, cfdata_ioconf_acpiwmi);
817 1.12 jruoho #endif
818 1.12 jruoho break;
819 1.9 jmcneill
820 1.9 jmcneill default:
821 1.12 jruoho rv = ENOTTY;
822 1.9 jmcneill }
823 1.12 jruoho
824 1.12 jruoho return rv;
825 1.9 jmcneill }
826