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