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