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