acpi.c revision 1.235 1 /* $NetBSD: acpi.c,v 1.235 2011/02/15 20:24:11 jruoho Exp $ */
2
3 /*-
4 * Copyright (c) 2003, 2007 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Charles M. Hannum of By Noon Software, Inc.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32 /*
33 * Copyright (c) 2003 Wasabi Systems, Inc.
34 * All rights reserved.
35 *
36 * Written by Frank van der Linden for Wasabi Systems, Inc.
37 *
38 * Redistribution and use in source and binary forms, with or without
39 * modification, are permitted provided that the following conditions
40 * are met:
41 * 1. Redistributions of source code must retain the above copyright
42 * notice, this list of conditions and the following disclaimer.
43 * 2. Redistributions in binary form must reproduce the above copyright
44 * notice, this list of conditions and the following disclaimer in the
45 * documentation and/or other materials provided with the distribution.
46 * 3. All advertising materials mentioning features or use of this software
47 * must display the following acknowledgement:
48 * This product includes software developed for the NetBSD Project by
49 * Wasabi Systems, Inc.
50 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
51 * or promote products derived from this software without specific prior
52 * written permission.
53 *
54 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
56 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
57 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
58 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
59 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
60 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
61 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
62 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
63 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
64 * POSSIBILITY OF SUCH DAMAGE.
65 */
66
67 /*
68 * Copyright 2001, 2003 Wasabi Systems, Inc.
69 * All rights reserved.
70 *
71 * Written by Jason R. Thorpe for Wasabi Systems, Inc.
72 *
73 * Redistribution and use in source and binary forms, with or without
74 * modification, are permitted provided that the following conditions
75 * are met:
76 * 1. Redistributions of source code must retain the above copyright
77 * notice, this list of conditions and the following disclaimer.
78 * 2. Redistributions in binary form must reproduce the above copyright
79 * notice, this list of conditions and the following disclaimer in the
80 * documentation and/or other materials provided with the distribution.
81 * 3. All advertising materials mentioning features or use of this software
82 * must display the following acknowledgement:
83 * This product includes software developed for the NetBSD Project by
84 * Wasabi Systems, Inc.
85 * 4. The name of Wasabi Systems, Inc. may not be used to endorse
86 * or promote products derived from this software without specific prior
87 * written permission.
88 *
89 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
90 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
91 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
92 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
93 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
94 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
95 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
96 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
97 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
98 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
99 * POSSIBILITY OF SUCH DAMAGE.
100 */
101
102 #include <sys/cdefs.h>
103 __KERNEL_RCSID(0, "$NetBSD: acpi.c,v 1.235 2011/02/15 20:24:11 jruoho Exp $");
104
105 #include "opt_acpi.h"
106 #include "opt_pcifixup.h"
107
108 #include <sys/param.h>
109 #include <sys/device.h>
110 #include <sys/kernel.h>
111 #include <sys/malloc.h>
112 #include <sys/module.h>
113 #include <sys/mutex.h>
114 #include <sys/sysctl.h>
115 #include <sys/systm.h>
116 #include <sys/timetc.h>
117
118 #include <dev/acpi/acpireg.h>
119 #include <dev/acpi/acpivar.h>
120 #include <dev/acpi/acpi_osd.h>
121 #include <dev/acpi/acpi_pci.h>
122 #include <dev/acpi/acpi_power.h>
123 #include <dev/acpi/acpi_timer.h>
124 #include <dev/acpi/acpi_wakedev.h>
125
126 #define _COMPONENT ACPI_BUS_COMPONENT
127 ACPI_MODULE_NAME ("acpi")
128
129 #if defined(ACPI_PCI_FIXUP)
130 #error The option ACPI_PCI_FIXUP has been obsoleted by PCI_INTR_FIXUP_DISABLED. Please adjust your kernel configuration file.
131 #endif
132
133 #ifdef PCI_INTR_FIXUP_DISABLED
134 #include <dev/pci/pcidevs.h>
135 #endif
136
137 MALLOC_DECLARE(M_ACPI);
138
139 #include <machine/acpi_machdep.h>
140
141 #ifdef ACPI_DEBUGGER
142 #define ACPI_DBGR_INIT 0x01
143 #define ACPI_DBGR_TABLES 0x02
144 #define ACPI_DBGR_ENABLE 0x04
145 #define ACPI_DBGR_PROBE 0x08
146 #define ACPI_DBGR_RUNNING 0x10
147
148 static int acpi_dbgr = 0x00;
149 #endif
150
151 /*
152 * The acpi_active variable is set when the ACPI subsystem is active.
153 * Machine-dependent code may wish to skip other steps (such as attaching
154 * subsystems that ACPI supercedes) when ACPI is active.
155 */
156 uint32_t acpi_cpus = 0;
157 int acpi_active = 0;
158 int acpi_suspended = 0;
159 int acpi_force_load = 0;
160 int acpi_verbose_loaded = 0;
161
162 struct acpi_softc *acpi_softc;
163 static uint64_t acpi_root_pointer;
164 extern kmutex_t acpi_interrupt_list_mtx;
165 extern struct cfdriver acpi_cd;
166 static ACPI_HANDLE acpi_scopes[4];
167 ACPI_TABLE_HEADER *madt_header;
168
169 /*
170 * This structure provides a context for the ACPI
171 * namespace walk performed in acpi_build_tree().
172 */
173 struct acpi_walkcontext {
174 struct acpi_softc *aw_sc;
175 struct acpi_devnode *aw_parent;
176 };
177
178 /*
179 * Ignored HIDs.
180 */
181 static const char * const acpi_ignored_ids[] = {
182 #if defined(i386) || defined(x86_64)
183 "PNP0000", /* AT interrupt controller is handled internally */
184 "PNP0200", /* AT DMA controller is handled internally */
185 "PNP0A??", /* PCI Busses are handled internally */
186 "PNP0B00", /* AT RTC is handled internally */
187 "PNP0C0F", /* ACPI PCI link devices are handled internally */
188 #endif
189 #if defined(x86_64)
190 "PNP0C04", /* FPU is handled internally */
191 #endif
192 NULL
193 };
194
195 /*
196 * Devices that should be attached early.
197 */
198 static const char * const acpi_early_ids[] = {
199 "PNP0C09", /* acpiec(4) */
200 NULL
201 };
202
203 static int acpi_match(device_t, cfdata_t, void *);
204 static int acpi_submatch(device_t, cfdata_t, const int *, void *);
205 static void acpi_attach(device_t, device_t, void *);
206 static int acpi_detach(device_t, int);
207 static void acpi_childdet(device_t, device_t);
208 static bool acpi_suspend(device_t, const pmf_qual_t *);
209 static bool acpi_resume(device_t, const pmf_qual_t *);
210
211 static void acpi_build_tree(struct acpi_softc *);
212 static ACPI_STATUS acpi_make_devnode(ACPI_HANDLE, uint32_t,
213 void *, void **);
214 static ACPI_STATUS acpi_make_devnode_post(ACPI_HANDLE, uint32_t,
215 void *, void **);
216 static void acpi_make_name(struct acpi_devnode *, uint32_t);
217
218 static int acpi_rescan(device_t, const char *, const int *);
219 static void acpi_rescan_early(struct acpi_softc *);
220 static void acpi_rescan_nodes(struct acpi_softc *);
221 static void acpi_rescan_capabilities(device_t);
222 static int acpi_print(void *aux, const char *);
223
224 static void acpi_notify_handler(ACPI_HANDLE, uint32_t, void *);
225
226 static void acpi_register_fixed_button(struct acpi_softc *, int);
227 static void acpi_deregister_fixed_button(struct acpi_softc *, int);
228 static uint32_t acpi_fixed_button_handler(void *);
229 static void acpi_fixed_button_pressed(void *);
230
231 static void acpi_sleep_init(struct acpi_softc *);
232
233 static int sysctl_hw_acpi_fixedstats(SYSCTLFN_PROTO);
234 static int sysctl_hw_acpi_sleepstate(SYSCTLFN_PROTO);
235 static int sysctl_hw_acpi_sleepstates(SYSCTLFN_PROTO);
236
237 static bool acpi_is_scope(struct acpi_devnode *);
238 static ACPI_TABLE_HEADER *acpi_map_rsdt(void);
239 static void acpi_unmap_rsdt(ACPI_TABLE_HEADER *);
240
241 void acpi_print_verbose_stub(struct acpi_softc *);
242 void acpi_print_dev_stub(const char *);
243
244 static void acpi_activate_device(ACPI_HANDLE, ACPI_DEVICE_INFO **);
245 ACPI_STATUS acpi_allocate_resources(ACPI_HANDLE);
246
247 void (*acpi_print_verbose)(struct acpi_softc *) = acpi_print_verbose_stub;
248 void (*acpi_print_dev)(const char *) = acpi_print_dev_stub;
249
250 CFATTACH_DECL2_NEW(acpi, sizeof(struct acpi_softc),
251 acpi_match, acpi_attach, acpi_detach, NULL, acpi_rescan, acpi_childdet);
252
253 /*
254 * Probe for ACPI support.
255 *
256 * This is called by the machine-dependent ACPI front-end.
257 * Note: this is not an autoconfiguration interface function.
258 */
259 int
260 acpi_probe(void)
261 {
262 ACPI_TABLE_HEADER *rsdt;
263 const char *func;
264 static int once;
265 bool initialized;
266 ACPI_STATUS rv;
267
268 if (once != 0)
269 panic("%s: already probed", __func__);
270
271 once = 1;
272 func = NULL;
273 acpi_softc = NULL;
274 initialized = false;
275
276 mutex_init(&acpi_interrupt_list_mtx, MUTEX_DEFAULT, IPL_NONE);
277
278 /*
279 * Start up ACPICA.
280 */
281 #ifdef ACPI_DEBUGGER
282 if (acpi_dbgr & ACPI_DBGR_INIT)
283 acpi_osd_debugger();
284 #endif
285
286 CTASSERT(TRUE == true);
287 CTASSERT(FALSE == false);
288
289 AcpiGbl_AllMethodsSerialized = false;
290 AcpiGbl_EnableInterpreterSlack = true;
291
292 rv = AcpiInitializeSubsystem();
293
294 if (ACPI_SUCCESS(rv))
295 initialized = true;
296 else {
297 func = "AcpiInitializeSubsystem()";
298 goto fail;
299 }
300
301 /*
302 * Allocate space for RSDT/XSDT and DSDT,
303 * but allow resizing if more tables exist.
304 */
305 rv = AcpiInitializeTables(NULL, 2, true);
306
307 if (ACPI_FAILURE(rv)) {
308 func = "AcpiInitializeTables()";
309 goto fail;
310 }
311
312 #ifdef ACPI_DEBUGGER
313 if (acpi_dbgr & ACPI_DBGR_TABLES)
314 acpi_osd_debugger();
315 #endif
316
317 rv = AcpiLoadTables();
318
319 if (ACPI_FAILURE(rv)) {
320 func = "AcpiLoadTables()";
321 goto fail;
322 }
323
324 rsdt = acpi_map_rsdt();
325
326 if (rsdt == NULL) {
327 func = "acpi_map_rsdt()";
328 rv = AE_ERROR;
329 goto fail;
330 }
331
332 if (acpi_force_load == 0 && (acpi_find_quirks() & ACPI_QUIRK_BROKEN)) {
333 aprint_normal("ACPI: BIOS is listed as broken:\n");
334 aprint_normal("ACPI: X/RSDT: OemId <%6.6s,%8.8s,%08x>, "
335 "AslId <%4.4s,%08x>\n",
336 rsdt->OemId, rsdt->OemTableId,
337 rsdt->OemRevision,
338 rsdt->AslCompilerId,
339 rsdt->AslCompilerRevision);
340 aprint_normal("ACPI: Not used. Set acpi_force_load to use.\n");
341 acpi_unmap_rsdt(rsdt);
342 AcpiTerminate();
343 return 0;
344 }
345 if (acpi_force_load == 0 && (acpi_find_quirks() & ACPI_QUIRK_OLDBIOS)) {
346 aprint_normal("ACPI: BIOS is too old (%s). Set acpi_force_load to use.\n",
347 pmf_get_platform("firmware-date"));
348 acpi_unmap_rsdt(rsdt);
349 AcpiTerminate();
350 return 0;
351 }
352
353 acpi_unmap_rsdt(rsdt);
354
355 rv = AcpiEnableSubsystem(~(ACPI_NO_HARDWARE_INIT|ACPI_NO_ACPI_ENABLE));
356
357 if (ACPI_FAILURE(rv)) {
358 func = "AcpiEnableSubsystem()";
359 goto fail;
360 }
361
362 /*
363 * Looks like we have ACPI!
364 */
365 return 1;
366
367 fail:
368 KASSERT(rv != AE_OK);
369 KASSERT(func != NULL);
370
371 aprint_error("%s: failed to probe ACPI: %s\n",
372 func, AcpiFormatException(rv));
373
374 if (initialized != false)
375 (void)AcpiTerminate();
376
377 return 0;
378 }
379
380 void
381 acpi_disable(void)
382 {
383
384 if (acpi_softc == NULL)
385 return;
386
387 KASSERT(acpi_active != 0);
388
389 if (AcpiGbl_FADT.SmiCommand != 0)
390 AcpiDisable();
391 }
392
393 int
394 acpi_check(device_t parent, const char *ifattr)
395 {
396 return (config_search_ia(acpi_submatch, parent, ifattr, NULL) != NULL);
397 }
398
399 /*
400 * Autoconfiguration.
401 */
402 static int
403 acpi_match(device_t parent, cfdata_t match, void *aux)
404 {
405 /*
406 * XXX: Nada; MD code has called acpi_probe().
407 */
408 return 1;
409 }
410
411 static int
412 acpi_submatch(device_t parent, cfdata_t cf, const int *locs, void *aux)
413 {
414 struct cfattach *ca;
415
416 ca = config_cfattach_lookup(cf->cf_name, cf->cf_atname);
417
418 return (ca == &acpi_ca);
419 }
420
421 static void
422 acpi_attach(device_t parent, device_t self, void *aux)
423 {
424 struct acpi_softc *sc = device_private(self);
425 struct acpibus_attach_args *aa = aux;
426 ACPI_TABLE_HEADER *rsdt;
427 ACPI_STATUS rv;
428
429 aprint_naive("\n");
430 aprint_normal(": Intel ACPICA %08x\n", ACPI_CA_VERSION);
431
432 if (acpi_softc != NULL)
433 panic("%s: already attached", __func__);
434
435 rsdt = acpi_map_rsdt();
436
437 if (rsdt == NULL)
438 aprint_error_dev(self, "X/RSDT: Not found\n");
439 else {
440 aprint_verbose_dev(self,
441 "X/RSDT: OemId <%6.6s,%8.8s,%08x>, AslId <%4.4s,%08x>\n",
442 rsdt->OemId, rsdt->OemTableId,
443 rsdt->OemRevision,
444 rsdt->AslCompilerId, rsdt->AslCompilerRevision);
445 }
446
447 acpi_unmap_rsdt(rsdt);
448
449 sc->sc_dev = self;
450 sc->sc_root = NULL;
451
452 sc->sc_sleepstate = ACPI_STATE_S0;
453 sc->sc_quirks = acpi_find_quirks();
454
455 sysmon_power_settype("acpi");
456
457 sc->sc_iot = aa->aa_iot;
458 sc->sc_memt = aa->aa_memt;
459 sc->sc_pc = aa->aa_pc;
460 sc->sc_pciflags = aa->aa_pciflags;
461 sc->sc_ic = aa->aa_ic;
462
463 SIMPLEQ_INIT(&sc->ad_head);
464
465 acpi_softc = sc;
466
467 if (pmf_device_register(self, acpi_suspend, acpi_resume) != true)
468 aprint_error_dev(self, "couldn't establish power handler\n");
469
470 /*
471 * Bring ACPI on-line.
472 */
473 #ifdef ACPI_DEBUGGER
474 if (acpi_dbgr & ACPI_DBGR_ENABLE)
475 acpi_osd_debugger();
476 #endif
477
478 #define ACPI_ENABLE_PHASE1 \
479 (ACPI_NO_HANDLER_INIT | ACPI_NO_EVENT_INIT)
480 #define ACPI_ENABLE_PHASE2 \
481 (ACPI_NO_HARDWARE_INIT | ACPI_NO_ACPI_ENABLE | \
482 ACPI_NO_ADDRESS_SPACE_INIT)
483
484 rv = AcpiEnableSubsystem(ACPI_ENABLE_PHASE1);
485
486 if (ACPI_FAILURE(rv))
487 goto fail;
488
489 acpi_md_callback();
490
491 rv = AcpiEnableSubsystem(ACPI_ENABLE_PHASE2);
492
493 if (ACPI_FAILURE(rv))
494 goto fail;
495
496 /*
497 * Early EC handler initialization if ECDT table is available.
498 */
499 config_found_ia(self, "acpiecdtbus", aa, NULL);
500
501 rv = AcpiInitializeObjects(ACPI_FULL_INITIALIZATION);
502
503 if (ACPI_FAILURE(rv))
504 goto fail;
505
506 /*
507 * Install global notify handlers.
508 */
509 rv = AcpiInstallNotifyHandler(ACPI_ROOT_OBJECT,
510 ACPI_SYSTEM_NOTIFY, acpi_notify_handler, NULL);
511
512 if (ACPI_FAILURE(rv))
513 goto fail;
514
515 rv = AcpiInstallNotifyHandler(ACPI_ROOT_OBJECT,
516 ACPI_DEVICE_NOTIFY, acpi_notify_handler, NULL);
517
518 if (ACPI_FAILURE(rv))
519 goto fail;
520
521 acpi_active = 1;
522
523 /* Show SCI interrupt. */
524 aprint_verbose_dev(self, "SCI interrupting at int %u\n",
525 AcpiGbl_FADT.SciInterrupt);
526
527 /*
528 * Install fixed-event handlers.
529 */
530 acpi_register_fixed_button(sc, ACPI_EVENT_POWER_BUTTON);
531 acpi_register_fixed_button(sc, ACPI_EVENT_SLEEP_BUTTON);
532
533 acpitimer_init(sc);
534
535 #ifdef ACPI_DEBUGGER
536 if (acpi_dbgr & ACPI_DBGR_PROBE)
537 acpi_osd_debugger();
538 #endif
539
540 /*
541 * Scan the namespace and build our device tree.
542 */
543 acpi_build_tree(sc);
544 acpi_sleep_init(sc);
545
546 #ifdef ACPI_DEBUGGER
547 if (acpi_dbgr & ACPI_DBGR_RUNNING)
548 acpi_osd_debugger();
549 #endif
550
551 #ifdef ACPI_DEBUG
552 acpi_debug_init();
553 #endif
554
555 /*
556 * Print debug information.
557 */
558 acpi_print_verbose(sc);
559
560 return;
561
562 fail:
563 aprint_error("%s: failed to initialize ACPI: %s\n",
564 __func__, AcpiFormatException(rv));
565 }
566
567 /*
568 * XXX: This is incomplete.
569 */
570 static int
571 acpi_detach(device_t self, int flags)
572 {
573 struct acpi_softc *sc = device_private(self);
574 ACPI_STATUS rv;
575 int rc;
576
577 rv = AcpiRemoveNotifyHandler(ACPI_ROOT_OBJECT,
578 ACPI_SYSTEM_NOTIFY, acpi_notify_handler);
579
580 if (ACPI_FAILURE(rv))
581 return EBUSY;
582
583 rv = AcpiRemoveNotifyHandler(ACPI_ROOT_OBJECT,
584 ACPI_DEVICE_NOTIFY, acpi_notify_handler);
585
586 if (ACPI_FAILURE(rv))
587 return EBUSY;
588
589 if ((rc = config_detach_children(self, flags)) != 0)
590 return rc;
591
592 if ((rc = acpitimer_detach()) != 0)
593 return rc;
594
595 acpi_deregister_fixed_button(sc, ACPI_EVENT_POWER_BUTTON);
596 acpi_deregister_fixed_button(sc, ACPI_EVENT_SLEEP_BUTTON);
597
598 pmf_device_deregister(self);
599
600 acpi_softc = NULL;
601
602 return 0;
603 }
604
605 /*
606 * XXX: Need to reclaim any resources? Yes.
607 */
608 static void
609 acpi_childdet(device_t self, device_t child)
610 {
611 struct acpi_softc *sc = device_private(self);
612 struct acpi_devnode *ad;
613
614 if (sc->sc_apmbus == child)
615 sc->sc_apmbus = NULL;
616 if (sc->sc_wdrt == child)
617 sc->sc_wdrt = NULL;
618
619 SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
620
621 if (ad->ad_device == child)
622 ad->ad_device = NULL;
623 }
624 }
625
626 static bool
627 acpi_suspend(device_t dv, const pmf_qual_t *qual)
628 {
629
630 acpi_suspended = 1;
631
632 return true;
633 }
634
635 static bool
636 acpi_resume(device_t dv, const pmf_qual_t *qual)
637 {
638
639 acpi_suspended = 0;
640
641 return true;
642 }
643
644 /*
645 * Namespace scan.
646 */
647 static void
648 acpi_build_tree(struct acpi_softc *sc)
649 {
650 struct acpi_walkcontext awc;
651
652 /*
653 * Get the root scope handles.
654 */
655 KASSERT(__arraycount(acpi_scopes) == 4);
656
657 (void)AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_PR_", &acpi_scopes[0]);
658 (void)AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &acpi_scopes[1]);
659 (void)AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SI_", &acpi_scopes[2]);
660 (void)AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_TZ_", &acpi_scopes[3]);
661
662 /*
663 * Make the root node.
664 */
665 awc.aw_sc = sc;
666 awc.aw_parent = NULL;
667
668 (void)acpi_make_devnode(ACPI_ROOT_OBJECT, 0, &awc, NULL);
669
670 KASSERT(sc->sc_root == NULL);
671 KASSERT(awc.aw_parent != NULL);
672
673 sc->sc_root = awc.aw_parent;
674
675 /*
676 * Build the internal namespace.
677 */
678 (void)AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, UINT32_MAX,
679 acpi_make_devnode, acpi_make_devnode_post, &awc, NULL);
680
681 /*
682 * Scan the internal namespace.
683 */
684 (void)acpi_pcidev_scan(sc->sc_root);
685 (void)acpi_rescan(sc->sc_dev, NULL, NULL);
686
687 /*
688 * Defer rest of the configuration.
689 */
690 (void)config_defer(sc->sc_dev, acpi_rescan_capabilities);
691 }
692
693 static ACPI_STATUS
694 acpi_make_devnode(ACPI_HANDLE handle, uint32_t level,
695 void *context, void **status)
696 {
697 struct acpi_walkcontext *awc = context;
698 struct acpi_softc *sc = awc->aw_sc;
699 struct acpi_devnode *ad;
700 ACPI_DEVICE_INFO *devinfo;
701 ACPI_OBJECT_TYPE type;
702 ACPI_STATUS rv;
703
704 rv = AcpiGetObjectInfo(handle, &devinfo);
705
706 if (ACPI_FAILURE(rv))
707 return AE_OK; /* Do not terminate the walk. */
708
709 type = devinfo->Type;
710
711 switch (type) {
712
713 case ACPI_TYPE_DEVICE:
714 acpi_activate_device(handle, &devinfo);
715 case ACPI_TYPE_PROCESSOR:
716 case ACPI_TYPE_THERMAL:
717 case ACPI_TYPE_POWER:
718
719 ad = malloc(sizeof(*ad), M_ACPI, M_NOWAIT | M_ZERO);
720
721 if (ad == NULL)
722 return AE_NO_MEMORY;
723
724 ad->ad_device = NULL;
725 ad->ad_notify = NULL;
726 ad->ad_pciinfo = NULL;
727
728 ad->ad_type = type;
729 ad->ad_handle = handle;
730 ad->ad_devinfo = devinfo;
731
732 ad->ad_root = sc->sc_dev;
733 ad->ad_parent = awc->aw_parent;
734
735 acpi_set_node(ad);
736 acpi_make_name(ad, devinfo->Name);
737
738 SIMPLEQ_INIT(&ad->ad_child_head);
739 SIMPLEQ_INSERT_TAIL(&sc->ad_head, ad, ad_list);
740
741 if (ad->ad_parent != NULL) {
742
743 SIMPLEQ_INSERT_TAIL(&ad->ad_parent->ad_child_head,
744 ad, ad_child_list);
745 }
746
747 awc->aw_parent = ad;
748 }
749
750 return AE_OK;
751 }
752
753 static ACPI_STATUS
754 acpi_make_devnode_post(ACPI_HANDLE handle, uint32_t level,
755 void *context, void **status)
756 {
757 struct acpi_walkcontext *awc = context;
758
759 KASSERT(awc != NULL);
760 KASSERT(awc->aw_parent != NULL);
761
762 if (handle == awc->aw_parent->ad_handle)
763 awc->aw_parent = awc->aw_parent->ad_parent;
764
765 return AE_OK;
766 }
767
768 static void
769 acpi_make_name(struct acpi_devnode *ad, uint32_t name)
770 {
771 ACPI_NAME_UNION *anu;
772 int clear, i;
773
774 anu = (ACPI_NAME_UNION *)&name;
775 ad->ad_name[4] = '\0';
776
777 for (i = 3, clear = 0; i >= 0; i--) {
778
779 if (clear == 0 && anu->Ascii[i] == '_')
780 ad->ad_name[i] = '\0';
781 else {
782 ad->ad_name[i] = anu->Ascii[i];
783 clear = 1;
784 }
785 }
786
787 if (ad->ad_name[0] == '\0')
788 ad->ad_name[0] = '_';
789 }
790
791 /*
792 * Device attachment.
793 */
794 static int
795 acpi_rescan(device_t self, const char *ifattr, const int *locators)
796 {
797 struct acpi_softc *sc = device_private(self);
798
799 /*
800 * A two-pass scan for acpinodebus.
801 */
802 if (ifattr_match(ifattr, "acpinodebus")) {
803 acpi_rescan_early(sc);
804 acpi_rescan_nodes(sc);
805 }
806
807 if (ifattr_match(ifattr, "acpiapmbus") && sc->sc_apmbus == NULL)
808 sc->sc_apmbus = config_found_ia(sc->sc_dev,
809 "acpiapmbus", NULL, NULL);
810
811 if (ifattr_match(ifattr, "acpiwdrtbus") && sc->sc_wdrt == NULL)
812 sc->sc_wdrt = config_found_ia(sc->sc_dev,
813 "acpiwdrtbus", NULL, NULL);
814
815 return 0;
816 }
817
818 static void
819 acpi_rescan_early(struct acpi_softc *sc)
820 {
821 struct acpi_attach_args aa;
822 struct acpi_devnode *ad;
823
824 /*
825 * First scan for devices such as acpiec(4) that
826 * should be always attached before anything else.
827 * We want these devices to attach regardless of
828 * the device status and other restrictions.
829 */
830 SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
831
832 if (ad->ad_device != NULL)
833 continue;
834
835 if (ad->ad_devinfo->Type != ACPI_TYPE_DEVICE)
836 continue;
837
838 if (acpi_match_hid(ad->ad_devinfo, acpi_early_ids) == 0)
839 continue;
840
841 aa.aa_node = ad;
842 aa.aa_iot = sc->sc_iot;
843 aa.aa_memt = sc->sc_memt;
844 aa.aa_pc = sc->sc_pc;
845 aa.aa_pciflags = sc->sc_pciflags;
846 aa.aa_ic = sc->sc_ic;
847
848 ad->ad_device = config_found_ia(sc->sc_dev,
849 "acpinodebus", &aa, acpi_print);
850 }
851 }
852
853 static void
854 acpi_rescan_nodes(struct acpi_softc *sc)
855 {
856 const uint32_t ncpus = acpi_md_ncpus();
857 struct acpi_attach_args aa;
858 struct acpi_devnode *ad;
859 ACPI_DEVICE_INFO *di;
860
861 SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
862
863 if (ad->ad_device != NULL)
864 continue;
865
866 /*
867 * There is a bug in ACPICA: it defines the type
868 * of the scopes incorrectly for its own reasons.
869 */
870 if (acpi_is_scope(ad) != false)
871 continue;
872
873 di = ad->ad_devinfo;
874
875 /*
876 * We only attach devices which are present, enabled, and
877 * functioning properly. However, if a device is enabled,
878 * it is decoding resources and we should claim these,
879 * if possible. This requires changes to bus_space(9).
880 * Note: there is a possible race condition, because _STA
881 * may have changed since di->CurrentStatus was set.
882 */
883 if (di->Type == ACPI_TYPE_DEVICE) {
884
885 if ((di->Valid & ACPI_VALID_STA) != 0 &&
886 (di->CurrentStatus & ACPI_STA_OK) != ACPI_STA_OK)
887 continue;
888 }
889
890 if (di->Type == ACPI_TYPE_POWER)
891 continue;
892
893 if (di->Type == ACPI_TYPE_PROCESSOR && acpi_cpus >= ncpus)
894 continue;
895
896 if (acpi_match_hid(di, acpi_early_ids) != 0)
897 continue;
898
899 if (acpi_match_hid(di, acpi_ignored_ids) != 0)
900 continue;
901
902 aa.aa_node = ad;
903 aa.aa_iot = sc->sc_iot;
904 aa.aa_memt = sc->sc_memt;
905 aa.aa_pc = sc->sc_pc;
906 aa.aa_pciflags = sc->sc_pciflags;
907 aa.aa_ic = sc->sc_ic;
908
909 ad->ad_device = config_found_ia(sc->sc_dev,
910 "acpinodebus", &aa, acpi_print);
911 }
912 }
913
914 static void
915 acpi_rescan_capabilities(device_t self)
916 {
917 struct acpi_softc *sc = device_private(self);
918 struct acpi_devnode *ad;
919 ACPI_HANDLE tmp;
920 ACPI_STATUS rv;
921
922 SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
923
924 if (ad->ad_devinfo->Type != ACPI_TYPE_DEVICE)
925 continue;
926
927 /*
928 * Scan power resource capabilities.
929 *
930 * If any power states are supported,
931 * at least _PR0 and _PR3 must be present.
932 */
933 rv = AcpiGetHandle(ad->ad_handle, "_PR0", &tmp);
934
935 if (ACPI_SUCCESS(rv)) {
936 ad->ad_flags |= ACPI_DEVICE_POWER;
937 acpi_power_add(ad);
938 }
939
940 /*
941 * Scan wake-up capabilities.
942 */
943 rv = AcpiGetHandle(ad->ad_handle, "_PRW", &tmp);
944
945 if (ACPI_SUCCESS(rv)) {
946 ad->ad_flags |= ACPI_DEVICE_WAKEUP;
947 acpi_wakedev_add(ad);
948 }
949
950 /*
951 * Scan docking stations.
952 */
953 rv = AcpiGetHandle(ad->ad_handle, "_DCK", &tmp);
954
955 if (ACPI_SUCCESS(rv))
956 ad->ad_flags |= ACPI_DEVICE_DOCK;
957
958 /*
959 * Scan devices that are ejectable.
960 */
961 rv = AcpiGetHandle(ad->ad_handle, "_EJ0", &tmp);
962
963 if (ACPI_SUCCESS(rv))
964 ad->ad_flags |= ACPI_DEVICE_EJECT;
965 }
966 }
967
968 static int
969 acpi_print(void *aux, const char *pnp)
970 {
971 struct acpi_attach_args *aa = aux;
972 struct acpi_devnode *ad;
973 const char *hid, *uid;
974 ACPI_DEVICE_INFO *di;
975
976 ad = aa->aa_node;
977 di = ad->ad_devinfo;
978
979 hid = di->HardwareId.String;
980 uid = di->UniqueId.String;
981
982 if (pnp != NULL) {
983
984 if (di->Type != ACPI_TYPE_DEVICE) {
985
986 aprint_normal("%s (ACPI Object Type '%s') at %s",
987 ad->ad_name, AcpiUtGetTypeName(ad->ad_type), pnp);
988
989 return UNCONF;
990 }
991
992 if ((di->Valid & ACPI_VALID_HID) == 0 || hid == NULL)
993 return 0;
994
995 aprint_normal("%s (%s) ", ad->ad_name, hid);
996 acpi_print_dev(hid);
997 aprint_normal("at %s", pnp);
998
999 return UNCONF;
1000 }
1001
1002 aprint_normal(" (%s", ad->ad_name);
1003
1004 if ((di->Valid & ACPI_VALID_HID) != 0 && hid != NULL) {
1005
1006 aprint_normal(", %s", hid);
1007
1008 if ((di->Valid & ACPI_VALID_UID) != 0 && uid != NULL) {
1009
1010 if (uid[0] == '\0')
1011 uid = "<null>";
1012
1013 aprint_normal("-%s", uid);
1014 }
1015 }
1016
1017 aprint_normal(")");
1018
1019 return UNCONF;
1020 }
1021
1022 /*
1023 * Notify.
1024 */
1025 static void
1026 acpi_notify_handler(ACPI_HANDLE handle, uint32_t event, void *aux)
1027 {
1028 struct acpi_softc *sc = acpi_softc;
1029 struct acpi_devnode *ad;
1030
1031 KASSERT(sc != NULL);
1032 KASSERT(aux == NULL);
1033 KASSERT(acpi_active != 0);
1034
1035 if (acpi_suspended != 0)
1036 return;
1037
1038 /*
1039 * System: 0x00 - 0x7F.
1040 * Device: 0x80 - 0xFF.
1041 */
1042 switch (event) {
1043
1044 case ACPI_NOTIFY_BUS_CHECK:
1045 case ACPI_NOTIFY_DEVICE_CHECK:
1046 case ACPI_NOTIFY_DEVICE_WAKE:
1047 case ACPI_NOTIFY_EJECT_REQUEST:
1048 case ACPI_NOTIFY_DEVICE_CHECK_LIGHT:
1049 case ACPI_NOTIFY_FREQUENCY_MISMATCH:
1050 case ACPI_NOTIFY_BUS_MODE_MISMATCH:
1051 case ACPI_NOTIFY_POWER_FAULT:
1052 case ACPI_NOTIFY_CAPABILITIES_CHECK:
1053 case ACPI_NOTIFY_DEVICE_PLD_CHECK:
1054 case ACPI_NOTIFY_RESERVED:
1055 case ACPI_NOTIFY_LOCALITY_UPDATE:
1056 break;
1057 }
1058
1059 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "notification 0x%02X for "
1060 "%s (%p)\n", event, acpi_name(handle), handle));
1061
1062 /*
1063 * We deliver notifications only to drivers
1064 * that have been succesfully attached and
1065 * that have registered a handler with us.
1066 * The opaque pointer is always the device_t.
1067 */
1068 SIMPLEQ_FOREACH(ad, &sc->ad_head, ad_list) {
1069
1070 if (ad->ad_device == NULL)
1071 continue;
1072
1073 if (ad->ad_notify == NULL)
1074 continue;
1075
1076 if (ad->ad_handle != handle)
1077 continue;
1078
1079 (*ad->ad_notify)(ad->ad_handle, event, ad->ad_device);
1080
1081 return;
1082 }
1083
1084 aprint_debug_dev(sc->sc_dev, "unhandled notify 0x%02X "
1085 "for %s (%p)\n", event, acpi_name(handle), handle);
1086 }
1087
1088 bool
1089 acpi_register_notify(struct acpi_devnode *ad, ACPI_NOTIFY_HANDLER notify)
1090 {
1091 struct acpi_softc *sc = acpi_softc;
1092
1093 KASSERT(sc != NULL);
1094 KASSERT(acpi_active != 0);
1095
1096 if (acpi_suspended != 0)
1097 goto fail;
1098
1099 if (ad == NULL || notify == NULL)
1100 goto fail;
1101
1102 ad->ad_notify = notify;
1103
1104 return true;
1105
1106 fail:
1107 aprint_error_dev(sc->sc_dev, "failed to register notify "
1108 "handler for %s (%p)\n", ad->ad_name, ad->ad_handle);
1109
1110 return false;
1111 }
1112
1113 void
1114 acpi_deregister_notify(struct acpi_devnode *ad)
1115 {
1116
1117 ad->ad_notify = NULL;
1118 }
1119
1120 /*
1121 * Fixed buttons.
1122 */
1123 static void
1124 acpi_register_fixed_button(struct acpi_softc *sc, int event)
1125 {
1126 struct sysmon_pswitch *smpsw;
1127 ACPI_STATUS rv;
1128 int type;
1129
1130 switch (event) {
1131
1132 case ACPI_EVENT_POWER_BUTTON:
1133
1134 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) != 0)
1135 return;
1136
1137 type = PSWITCH_TYPE_POWER;
1138 smpsw = &sc->sc_smpsw_power;
1139 break;
1140
1141 case ACPI_EVENT_SLEEP_BUTTON:
1142
1143 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) != 0)
1144 return;
1145
1146 type = PSWITCH_TYPE_SLEEP;
1147 smpsw = &sc->sc_smpsw_sleep;
1148 break;
1149
1150 default:
1151 rv = AE_TYPE;
1152 goto fail;
1153 }
1154
1155 smpsw->smpsw_type = type;
1156 smpsw->smpsw_name = device_xname(sc->sc_dev);
1157
1158 if (sysmon_pswitch_register(smpsw) != 0) {
1159 rv = AE_ERROR;
1160 goto fail;
1161 }
1162
1163 rv = AcpiInstallFixedEventHandler(event,
1164 acpi_fixed_button_handler, smpsw);
1165
1166 if (ACPI_FAILURE(rv)) {
1167 sysmon_pswitch_unregister(smpsw);
1168 goto fail;
1169 }
1170
1171 aprint_debug_dev(sc->sc_dev, "fixed %s button present\n",
1172 (type != ACPI_EVENT_SLEEP_BUTTON) ? "power" : "sleep");
1173
1174 return;
1175
1176 fail:
1177 aprint_error_dev(sc->sc_dev, "failed to register "
1178 "fixed event: %s\n", AcpiFormatException(rv));
1179 }
1180
1181 static void
1182 acpi_deregister_fixed_button(struct acpi_softc *sc, int event)
1183 {
1184 struct sysmon_pswitch *smpsw;
1185 ACPI_STATUS rv;
1186
1187 switch (event) {
1188
1189 case ACPI_EVENT_POWER_BUTTON:
1190 smpsw = &sc->sc_smpsw_power;
1191
1192 if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) != 0) {
1193 KASSERT(smpsw->smpsw_type != PSWITCH_TYPE_POWER);
1194 return;
1195 }
1196
1197 break;
1198
1199 case ACPI_EVENT_SLEEP_BUTTON:
1200 smpsw = &sc->sc_smpsw_sleep;
1201
1202 if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) != 0) {
1203 KASSERT(smpsw->smpsw_type != PSWITCH_TYPE_SLEEP);
1204 return;
1205 }
1206
1207 break;
1208
1209 default:
1210 rv = AE_TYPE;
1211 goto fail;
1212 }
1213
1214 rv = AcpiRemoveFixedEventHandler(event, acpi_fixed_button_handler);
1215
1216 if (ACPI_SUCCESS(rv)) {
1217 sysmon_pswitch_unregister(smpsw);
1218 return;
1219 }
1220
1221 fail:
1222 aprint_error_dev(sc->sc_dev, "failed to deregister "
1223 "fixed event: %s\n", AcpiFormatException(rv));
1224 }
1225
1226 static uint32_t
1227 acpi_fixed_button_handler(void *context)
1228 {
1229 static const int handler = OSL_NOTIFY_HANDLER;
1230 struct sysmon_pswitch *smpsw = context;
1231
1232 (void)AcpiOsExecute(handler, acpi_fixed_button_pressed, smpsw);
1233
1234 return ACPI_INTERRUPT_HANDLED;
1235 }
1236
1237 static void
1238 acpi_fixed_button_pressed(void *context)
1239 {
1240 struct sysmon_pswitch *smpsw = context;
1241
1242 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s fixed button pressed\n",
1243 (smpsw->smpsw_type != ACPI_EVENT_SLEEP_BUTTON) ?
1244 "power" : "sleep"));
1245
1246 sysmon_pswitch_event(smpsw, PSWITCH_EVENT_PRESSED);
1247 }
1248
1249 /*
1250 * Sleep.
1251 */
1252 static void
1253 acpi_sleep_init(struct acpi_softc *sc)
1254 {
1255 uint8_t a, b, i;
1256 ACPI_STATUS rv;
1257
1258 CTASSERT(ACPI_STATE_S0 == 0 && ACPI_STATE_S1 == 1);
1259 CTASSERT(ACPI_STATE_S2 == 2 && ACPI_STATE_S3 == 3);
1260 CTASSERT(ACPI_STATE_S4 == 4 && ACPI_STATE_S5 == 5);
1261
1262 /*
1263 * Evaluate supported sleep states.
1264 */
1265 for (i = ACPI_STATE_S0; i <= ACPI_STATE_S5; i++) {
1266
1267 rv = AcpiGetSleepTypeData(i, &a, &b);
1268
1269 if (ACPI_SUCCESS(rv))
1270 sc->sc_sleepstates |= __BIT(i);
1271 }
1272 }
1273
1274 /*
1275 * Must be called with interrupts enabled.
1276 */
1277 void
1278 acpi_enter_sleep_state(int state)
1279 {
1280 struct acpi_softc *sc = acpi_softc;
1281 ACPI_STATUS rv;
1282 int err;
1283
1284 if (acpi_softc == NULL)
1285 return;
1286
1287 if (state == sc->sc_sleepstate)
1288 return;
1289
1290 if (state < ACPI_STATE_S0 || state > ACPI_STATE_S5)
1291 return;
1292
1293 aprint_normal_dev(sc->sc_dev, "entering state S%d\n", state);
1294
1295 switch (state) {
1296
1297 case ACPI_STATE_S0:
1298 sc->sc_sleepstate = ACPI_STATE_S0;
1299 return;
1300
1301 case ACPI_STATE_S1:
1302 case ACPI_STATE_S2:
1303 case ACPI_STATE_S3:
1304 case ACPI_STATE_S4:
1305
1306 if ((sc->sc_sleepstates & __BIT(state)) == 0) {
1307 aprint_error_dev(sc->sc_dev, "sleep state "
1308 "S%d is not available\n", state);
1309 return;
1310 }
1311
1312 /*
1313 * Evaluate the _TTS method. This should be done before
1314 * pmf_system_suspend(9) and the evaluation of _PTS.
1315 * We should also re-evaluate this once we return to
1316 * S0 or if we abort the sleep state transition in the
1317 * middle (see ACPI 3.0, section 7.3.6). In reality,
1318 * however, the _TTS method is seldom seen in the field.
1319 */
1320 rv = acpi_eval_set_integer(NULL, "\\_TTS", state);
1321
1322 if (ACPI_SUCCESS(rv))
1323 aprint_debug_dev(sc->sc_dev, "evaluated _TTS\n");
1324
1325 if (state != ACPI_STATE_S1 &&
1326 pmf_system_suspend(PMF_Q_NONE) != true) {
1327 aprint_error_dev(sc->sc_dev, "aborting suspend\n");
1328 break;
1329 }
1330
1331 /*
1332 * This will evaluate the _PTS and _SST methods,
1333 * but unlike the documentation claims, not _GTS,
1334 * which is evaluated in AcpiEnterSleepState().
1335 * This must be called with interrupts enabled.
1336 */
1337 rv = AcpiEnterSleepStatePrep(state);
1338
1339 if (ACPI_FAILURE(rv)) {
1340 aprint_error_dev(sc->sc_dev, "failed to prepare "
1341 "S%d: %s\n", state, AcpiFormatException(rv));
1342 break;
1343 }
1344
1345 /*
1346 * After the _PTS method has been evaluated, we can
1347 * enable wake and evaluate _PSW (ACPI 4.0, p. 284).
1348 */
1349 acpi_wakedev_commit(sc, state);
1350
1351 sc->sc_sleepstate = state;
1352
1353 if (state == ACPI_STATE_S1) {
1354
1355 /* Just enter the state. */
1356 acpi_md_OsDisableInterrupt();
1357 rv = AcpiEnterSleepState(state);
1358
1359 if (ACPI_FAILURE(rv))
1360 aprint_error_dev(sc->sc_dev, "failed to "
1361 "enter S1: %s\n", AcpiFormatException(rv));
1362
1363 (void)AcpiLeaveSleepState(state);
1364
1365 } else {
1366
1367 err = acpi_md_sleep(state);
1368
1369 if (state == ACPI_STATE_S4)
1370 AcpiEnable();
1371
1372 (void)pmf_system_bus_resume(PMF_Q_NONE);
1373 (void)AcpiLeaveSleepState(state);
1374 (void)AcpiSetFirmwareWakingVector(0);
1375 (void)pmf_system_resume(PMF_Q_NONE);
1376 }
1377
1378 break;
1379
1380 case ACPI_STATE_S5:
1381
1382 (void)acpi_eval_set_integer(NULL, "\\_TTS", ACPI_STATE_S5);
1383
1384 rv = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
1385
1386 if (ACPI_FAILURE(rv)) {
1387 aprint_error_dev(sc->sc_dev, "failed to prepare "
1388 "S%d: %s\n", state, AcpiFormatException(rv));
1389 break;
1390 }
1391
1392 (void)AcpiDisableAllGpes();
1393
1394 DELAY(1000000);
1395
1396 sc->sc_sleepstate = state;
1397 acpi_md_OsDisableInterrupt();
1398
1399 (void)AcpiEnterSleepState(ACPI_STATE_S5);
1400
1401 aprint_error_dev(sc->sc_dev, "WARNING: powerdown failed!\n");
1402
1403 break;
1404 }
1405
1406 sc->sc_sleepstate = ACPI_STATE_S0;
1407
1408 (void)acpi_eval_set_integer(NULL, "\\_TTS", ACPI_STATE_S0);
1409 }
1410
1411 /*
1412 * Sysctl.
1413 */
1414 SYSCTL_SETUP(sysctl_acpi_setup, "sysctl hw.acpi subtree setup")
1415 {
1416 const struct sysctlnode *mnode, *rnode, *snode;
1417 int err;
1418
1419 err = sysctl_createv(clog, 0, NULL, &rnode,
1420 CTLFLAG_PERMANENT, CTLTYPE_NODE, "hw",
1421 NULL, NULL, 0, NULL, 0,
1422 CTL_HW, CTL_EOL);
1423
1424 if (err != 0)
1425 return;
1426
1427 err = sysctl_createv(clog, 0, &rnode, &rnode,
1428 CTLFLAG_PERMANENT, CTLTYPE_NODE,
1429 "acpi", SYSCTL_DESCR("ACPI subsystem parameters"),
1430 NULL, 0, NULL, 0,
1431 CTL_CREATE, CTL_EOL);
1432
1433 if (err != 0)
1434 return;
1435
1436 (void)sysctl_createv(NULL, 0, &rnode, NULL,
1437 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_QUAD,
1438 "root", SYSCTL_DESCR("ACPI root pointer"),
1439 NULL, 0, &acpi_root_pointer, sizeof(acpi_root_pointer),
1440 CTL_CREATE, CTL_EOL);
1441
1442 err = sysctl_createv(clog, 0, &rnode, &snode,
1443 CTLFLAG_PERMANENT, CTLTYPE_NODE,
1444 "sleep", SYSCTL_DESCR("ACPI sleep"),
1445 NULL, 0, NULL, 0,
1446 CTL_CREATE, CTL_EOL);
1447
1448 if (err != 0)
1449 return;
1450
1451 (void)sysctl_createv(NULL, 0, &snode, NULL,
1452 CTLFLAG_PERMANENT | CTLFLAG_READWRITE, CTLTYPE_INT,
1453 "state", SYSCTL_DESCR("System sleep state"),
1454 sysctl_hw_acpi_sleepstate, 0, NULL, 0,
1455 CTL_CREATE, CTL_EOL);
1456
1457 (void)sysctl_createv(NULL, 0, &snode, NULL,
1458 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_STRING,
1459 "states", SYSCTL_DESCR("Supported sleep states"),
1460 sysctl_hw_acpi_sleepstates, 0, NULL, 0,
1461 CTL_CREATE, CTL_EOL);
1462
1463 /*
1464 * For the time being, machdep.sleep_state
1465 * is provided for backwards compatibility.
1466 */
1467 err = sysctl_createv(NULL, 0, NULL, &mnode,
1468 CTLFLAG_PERMANENT, CTLTYPE_NODE, "machdep",
1469 NULL, NULL, 0, NULL, 0,
1470 CTL_MACHDEP, CTL_EOL);
1471
1472 if (err == 0) {
1473
1474 (void)sysctl_createv(NULL, 0, &mnode, NULL,
1475 CTLFLAG_PERMANENT | CTLFLAG_READWRITE, CTLTYPE_INT,
1476 "sleep_state", SYSCTL_DESCR("System sleep state"),
1477 sysctl_hw_acpi_sleepstate, 0, NULL, 0,
1478 CTL_CREATE, CTL_EOL);
1479 }
1480
1481 err = sysctl_createv(clog, 0, &rnode, &rnode,
1482 CTLFLAG_PERMANENT, CTLTYPE_NODE,
1483 "stat", SYSCTL_DESCR("ACPI statistics"),
1484 NULL, 0, NULL, 0,
1485 CTL_CREATE, CTL_EOL);
1486
1487 if (err != 0)
1488 return;
1489
1490 (void)sysctl_createv(clog, 0, &rnode, NULL,
1491 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_QUAD,
1492 "gpe", SYSCTL_DESCR("Number of dispatched GPEs"),
1493 NULL, 0, &AcpiGpeCount, sizeof(AcpiGpeCount),
1494 CTL_CREATE, CTL_EOL);
1495
1496 (void)sysctl_createv(clog, 0, &rnode, NULL,
1497 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_QUAD,
1498 "sci", SYSCTL_DESCR("Number of SCI interrupts"),
1499 NULL, 0, &AcpiSciCount, sizeof(AcpiSciCount),
1500 CTL_CREATE, CTL_EOL);
1501
1502 (void)sysctl_createv(clog, 0, &rnode, NULL,
1503 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_QUAD,
1504 "fixed", SYSCTL_DESCR("Number of fixed events"),
1505 sysctl_hw_acpi_fixedstats, 0, NULL, 0,
1506 CTL_CREATE, CTL_EOL);
1507
1508 (void)sysctl_createv(clog, 0, &rnode, NULL,
1509 CTLFLAG_PERMANENT | CTLFLAG_READONLY, CTLTYPE_QUAD,
1510 "method", SYSCTL_DESCR("Number of methods executed"),
1511 NULL, 0, &AcpiMethodCount, sizeof(AcpiMethodCount),
1512 CTL_CREATE, CTL_EOL);
1513
1514 CTASSERT(sizeof(AcpiGpeCount) == sizeof(uint64_t));
1515 CTASSERT(sizeof(AcpiSciCount) == sizeof(uint64_t));
1516 }
1517
1518 static int
1519 sysctl_hw_acpi_fixedstats(SYSCTLFN_ARGS)
1520 {
1521 struct sysctlnode node;
1522 uint64_t t;
1523 int err, i;
1524
1525 for (i = t = 0; i < __arraycount(AcpiFixedEventCount); i++)
1526 t += AcpiFixedEventCount[i];
1527
1528 node = *rnode;
1529 node.sysctl_data = &t;
1530
1531 err = sysctl_lookup(SYSCTLFN_CALL(&node));
1532
1533 if (err || newp == NULL)
1534 return err;
1535
1536 return 0;
1537 }
1538
1539 static int
1540 sysctl_hw_acpi_sleepstate(SYSCTLFN_ARGS)
1541 {
1542 struct acpi_softc *sc = acpi_softc;
1543 struct sysctlnode node;
1544 int err, t;
1545
1546 if (acpi_softc == NULL)
1547 return ENOSYS;
1548
1549 node = *rnode;
1550 t = sc->sc_sleepstate;
1551 node.sysctl_data = &t;
1552
1553 err = sysctl_lookup(SYSCTLFN_CALL(&node));
1554
1555 if (err || newp == NULL)
1556 return err;
1557
1558 if (t < ACPI_STATE_S0 || t > ACPI_STATE_S5)
1559 return EINVAL;
1560
1561 acpi_enter_sleep_state(t);
1562
1563 return 0;
1564 }
1565
1566 static int
1567 sysctl_hw_acpi_sleepstates(SYSCTLFN_ARGS)
1568 {
1569 struct acpi_softc *sc = acpi_softc;
1570 struct sysctlnode node;
1571 char t[3 * 6 + 1];
1572 int err;
1573
1574 if (acpi_softc == NULL)
1575 return ENOSYS;
1576
1577 (void)memset(t, '\0', sizeof(t));
1578
1579 (void)snprintf(t, sizeof(t), "%s%s%s%s%s%s",
1580 ((sc->sc_sleepstates & __BIT(0)) != 0) ? "S0 " : "",
1581 ((sc->sc_sleepstates & __BIT(1)) != 0) ? "S1 " : "",
1582 ((sc->sc_sleepstates & __BIT(2)) != 0) ? "S2 " : "",
1583 ((sc->sc_sleepstates & __BIT(3)) != 0) ? "S3 " : "",
1584 ((sc->sc_sleepstates & __BIT(4)) != 0) ? "S4 " : "",
1585 ((sc->sc_sleepstates & __BIT(5)) != 0) ? "S5 " : "");
1586
1587 node = *rnode;
1588 node.sysctl_data = &t;
1589
1590 err = sysctl_lookup(SYSCTLFN_CALL(&node));
1591
1592 if (err || newp == NULL)
1593 return err;
1594
1595 return 0;
1596 }
1597
1598 /*
1599 * Tables.
1600 */
1601 ACPI_PHYSICAL_ADDRESS
1602 acpi_OsGetRootPointer(void)
1603 {
1604 ACPI_PHYSICAL_ADDRESS PhysicalAddress;
1605
1606 /*
1607 * We let MD code handle this since there are multiple ways to do it:
1608 *
1609 * IA-32: Use AcpiFindRootPointer() to locate the RSDP.
1610 *
1611 * IA-64: Use the EFI.
1612 */
1613 PhysicalAddress = acpi_md_OsGetRootPointer();
1614
1615 if (acpi_root_pointer == 0)
1616 acpi_root_pointer = PhysicalAddress;
1617
1618 return PhysicalAddress;
1619 }
1620
1621 static ACPI_TABLE_HEADER *
1622 acpi_map_rsdt(void)
1623 {
1624 ACPI_PHYSICAL_ADDRESS paddr;
1625 ACPI_TABLE_RSDP *rsdp;
1626
1627 paddr = AcpiOsGetRootPointer();
1628
1629 if (paddr == 0)
1630 return NULL;
1631
1632 rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP));
1633
1634 if (rsdp == NULL)
1635 return NULL;
1636
1637 if (rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress)
1638 paddr = rsdp->XsdtPhysicalAddress;
1639 else
1640 paddr = rsdp->RsdtPhysicalAddress;
1641
1642 AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
1643
1644 return AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER));
1645 }
1646
1647 static void
1648 acpi_unmap_rsdt(ACPI_TABLE_HEADER *rsdt)
1649 {
1650
1651 if (rsdt == NULL)
1652 return;
1653
1654 AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
1655 }
1656
1657 /*
1658 * XXX: Refactor to be a generic function that maps tables.
1659 */
1660 ACPI_STATUS
1661 acpi_madt_map(void)
1662 {
1663 ACPI_STATUS rv;
1664
1665 if (madt_header != NULL)
1666 return AE_ALREADY_EXISTS;
1667
1668 rv = AcpiGetTable(ACPI_SIG_MADT, 1, &madt_header);
1669
1670 if (ACPI_FAILURE(rv))
1671 return rv;
1672
1673 return AE_OK;
1674 }
1675
1676 void
1677 acpi_madt_unmap(void)
1678 {
1679 madt_header = NULL;
1680 }
1681
1682 /*
1683 * XXX: Refactor to be a generic function that walks tables.
1684 */
1685 void
1686 acpi_madt_walk(ACPI_STATUS (*func)(ACPI_SUBTABLE_HEADER *, void *), void *aux)
1687 {
1688 ACPI_SUBTABLE_HEADER *hdrp;
1689 char *madtend, *where;
1690
1691 madtend = (char *)madt_header + madt_header->Length;
1692 where = (char *)madt_header + sizeof (ACPI_TABLE_MADT);
1693
1694 while (where < madtend) {
1695
1696 hdrp = (ACPI_SUBTABLE_HEADER *)where;
1697
1698 if (ACPI_FAILURE(func(hdrp, aux)))
1699 break;
1700
1701 where += hdrp->Length;
1702 }
1703 }
1704
1705 /*
1706 * Miscellaneous.
1707 */
1708 static bool
1709 acpi_is_scope(struct acpi_devnode *ad)
1710 {
1711 int i;
1712
1713 /*
1714 * Return true if the node is a root scope.
1715 */
1716 if (ad->ad_parent == NULL)
1717 return false;
1718
1719 if (ad->ad_parent->ad_handle != ACPI_ROOT_OBJECT)
1720 return false;
1721
1722 for (i = 0; i < __arraycount(acpi_scopes); i++) {
1723
1724 if (acpi_scopes[i] == NULL)
1725 continue;
1726
1727 if (ad->ad_handle == acpi_scopes[i])
1728 return true;
1729 }
1730
1731 return false;
1732 }
1733
1734 /*
1735 * ACPIVERBOSE.
1736 */
1737 void
1738 acpi_load_verbose(void)
1739 {
1740
1741 if (acpi_verbose_loaded == 0)
1742 module_autoload("acpiverbose", MODULE_CLASS_MISC);
1743 }
1744
1745 void
1746 acpi_print_verbose_stub(struct acpi_softc *sc)
1747 {
1748
1749 acpi_load_verbose();
1750
1751 if (acpi_verbose_loaded != 0)
1752 acpi_print_verbose(sc);
1753 }
1754
1755 void
1756 acpi_print_dev_stub(const char *pnpstr)
1757 {
1758
1759 acpi_load_verbose();
1760
1761 if (acpi_verbose_loaded != 0)
1762 acpi_print_dev(pnpstr);
1763 }
1764
1765 /*
1766 * ACPI_ACTIVATE_DEV.
1767 */
1768 static void
1769 acpi_activate_device(ACPI_HANDLE handle, ACPI_DEVICE_INFO **di)
1770 {
1771
1772 #ifndef ACPI_ACTIVATE_DEV
1773 return;
1774 }
1775 #else
1776 static const int valid = ACPI_VALID_STA | ACPI_VALID_HID;
1777 ACPI_DEVICE_INFO *newdi;
1778 ACPI_STATUS rv;
1779 uint32_t old;
1780
1781 /*
1782 * If the device is valid and present,
1783 * but not enabled, try to activate it.
1784 */
1785 if (((*di)->Valid & valid) != valid)
1786 return;
1787
1788 old = (*di)->CurrentStatus;
1789
1790 if ((old & (ACPI_STA_DEVICE_PRESENT | ACPI_STA_DEVICE_ENABLED)) !=
1791 ACPI_STA_DEVICE_PRESENT)
1792 return;
1793
1794 rv = acpi_allocate_resources(handle);
1795
1796 if (ACPI_FAILURE(rv))
1797 goto fail;
1798
1799 rv = AcpiGetObjectInfo(handle, &newdi);
1800
1801 if (ACPI_FAILURE(rv))
1802 goto fail;
1803
1804 ACPI_FREE(*di);
1805 *di = newdi;
1806
1807 aprint_verbose_dev(acpi_softc->sc_dev,
1808 "%s activated, STA 0x%08X -> STA 0x%08X\n",
1809 (*di)->HardwareId.String, old, (*di)->CurrentStatus);
1810
1811 return;
1812
1813 fail:
1814 aprint_error_dev(acpi_softc->sc_dev, "failed to "
1815 "activate %s\n", (*di)->HardwareId.String);
1816 }
1817
1818 /*
1819 * XXX: This very incomplete.
1820 */
1821 ACPI_STATUS
1822 acpi_allocate_resources(ACPI_HANDLE handle)
1823 {
1824 ACPI_BUFFER bufp, bufc, bufn;
1825 ACPI_RESOURCE *resp, *resc, *resn;
1826 ACPI_RESOURCE_IRQ *irq;
1827 ACPI_RESOURCE_EXTENDED_IRQ *xirq;
1828 ACPI_STATUS rv;
1829 uint delta;
1830
1831 rv = acpi_get(handle, &bufp, AcpiGetPossibleResources);
1832 if (ACPI_FAILURE(rv))
1833 goto out;
1834 rv = acpi_get(handle, &bufc, AcpiGetCurrentResources);
1835 if (ACPI_FAILURE(rv)) {
1836 goto out1;
1837 }
1838
1839 bufn.Length = 1000;
1840 bufn.Pointer = resn = malloc(bufn.Length, M_ACPI, M_WAITOK);
1841 resp = bufp.Pointer;
1842 resc = bufc.Pointer;
1843 while (resc->Type != ACPI_RESOURCE_TYPE_END_TAG &&
1844 resp->Type != ACPI_RESOURCE_TYPE_END_TAG) {
1845 while (resc->Type != resp->Type && resp->Type != ACPI_RESOURCE_TYPE_END_TAG)
1846 resp = ACPI_NEXT_RESOURCE(resp);
1847 if (resp->Type == ACPI_RESOURCE_TYPE_END_TAG)
1848 break;
1849 /* Found identical Id */
1850 resn->Type = resc->Type;
1851 switch (resc->Type) {
1852 case ACPI_RESOURCE_TYPE_IRQ:
1853 memcpy(&resn->Data, &resp->Data,
1854 sizeof(ACPI_RESOURCE_IRQ));
1855 irq = (ACPI_RESOURCE_IRQ *)&resn->Data;
1856 irq->Interrupts[0] =
1857 ((ACPI_RESOURCE_IRQ *)&resp->Data)->
1858 Interrupts[irq->InterruptCount-1];
1859 irq->InterruptCount = 1;
1860 resn->Length = ACPI_RS_SIZE(ACPI_RESOURCE_IRQ);
1861 break;
1862 case ACPI_RESOURCE_TYPE_EXTENDED_IRQ:
1863 memcpy(&resn->Data, &resp->Data,
1864 sizeof(ACPI_RESOURCE_EXTENDED_IRQ));
1865 xirq = (ACPI_RESOURCE_EXTENDED_IRQ *)&resn->Data;
1866 #if 0
1867 /*
1868 * XXX: Not duplicating the interrupt logic above
1869 * because its not clear what it accomplishes.
1870 */
1871 xirq->Interrupts[0] =
1872 ((ACPI_RESOURCE_EXT_IRQ *)&resp->Data)->
1873 Interrupts[irq->NumberOfInterrupts-1];
1874 xirq->NumberOfInterrupts = 1;
1875 #endif
1876 resn->Length = ACPI_RS_SIZE(ACPI_RESOURCE_EXTENDED_IRQ);
1877 break;
1878 case ACPI_RESOURCE_TYPE_IO:
1879 memcpy(&resn->Data, &resp->Data,
1880 sizeof(ACPI_RESOURCE_IO));
1881 resn->Length = resp->Length;
1882 break;
1883 default:
1884 aprint_error_dev(acpi_softc->sc_dev,
1885 "%s: invalid type %u\n", __func__, resc->Type);
1886 rv = AE_BAD_DATA;
1887 goto out2;
1888 }
1889 resc = ACPI_NEXT_RESOURCE(resc);
1890 resn = ACPI_NEXT_RESOURCE(resn);
1891 resp = ACPI_NEXT_RESOURCE(resp);
1892 delta = (uint8_t *)resn - (uint8_t *)bufn.Pointer;
1893 if (delta >=
1894 bufn.Length-ACPI_RS_SIZE(ACPI_RESOURCE_DATA)) {
1895 bufn.Length *= 2;
1896 bufn.Pointer = realloc(bufn.Pointer, bufn.Length,
1897 M_ACPI, M_WAITOK);
1898 resn = (ACPI_RESOURCE *)((uint8_t *)bufn.Pointer +
1899 delta);
1900 }
1901 }
1902
1903 if (resc->Type != ACPI_RESOURCE_TYPE_END_TAG) {
1904 aprint_error_dev(acpi_softc->sc_dev,
1905 "%s: resc not exhausted\n", __func__);
1906 rv = AE_BAD_DATA;
1907 goto out3;
1908 }
1909
1910 resn->Type = ACPI_RESOURCE_TYPE_END_TAG;
1911 rv = AcpiSetCurrentResources(handle, &bufn);
1912
1913 if (ACPI_FAILURE(rv))
1914 aprint_error_dev(acpi_softc->sc_dev, "%s: failed to set "
1915 "resources: %s\n", __func__, AcpiFormatException(rv));
1916
1917 out3:
1918 free(bufn.Pointer, M_ACPI);
1919 out2:
1920 ACPI_FREE(bufc.Pointer);
1921 out1:
1922 ACPI_FREE(bufp.Pointer);
1923 out:
1924 return rv;
1925 }
1926
1927 #endif /* ACPI_ACTIVATE_DEV */
1928