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