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