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