xref: /freebsd-12.1/sys/dev/acpica/acpi.c (revision 414858e3)
1 /*-
2  * Copyright (c) 2000 Takanori Watanabe <[email protected]>
3  * Copyright (c) 2000 Mitsuru IWASAKI <[email protected]>
4  * Copyright (c) 2000, 2001 Michael Smith
5  * Copyright (c) 2000 BSDi
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  */
29 
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include "opt_acpi.h"
34 
35 #include <sys/param.h>
36 #include <sys/kernel.h>
37 #include <sys/proc.h>
38 #include <sys/fcntl.h>
39 #include <sys/malloc.h>
40 #include <sys/module.h>
41 #include <sys/bus.h>
42 #include <sys/conf.h>
43 #include <sys/ioccom.h>
44 #include <sys/reboot.h>
45 #include <sys/sysctl.h>
46 #include <sys/ctype.h>
47 #include <sys/linker.h>
48 #include <sys/power.h>
49 #include <sys/sbuf.h>
50 #include <sys/sched.h>
51 #include <sys/smp.h>
52 #include <sys/timetc.h>
53 
54 #if defined(__i386__) || defined(__amd64__)
55 #include <machine/clock.h>
56 #include <machine/pci_cfgreg.h>
57 #endif
58 #include <machine/resource.h>
59 #include <machine/bus.h>
60 #include <sys/rman.h>
61 #include <isa/isavar.h>
62 #include <isa/pnpvar.h>
63 
64 #include <contrib/dev/acpica/include/acpi.h>
65 #include <contrib/dev/acpica/include/accommon.h>
66 #include <contrib/dev/acpica/include/acnamesp.h>
67 
68 #include <dev/acpica/acpivar.h>
69 #include <dev/acpica/acpiio.h>
70 
71 #include <dev/pci/pcivar.h>
72 
73 #include <vm/vm_param.h>
74 
75 static MALLOC_DEFINE(M_ACPIDEV, "acpidev", "ACPI devices");
76 
77 /* Hooks for the ACPI CA debugging infrastructure */
78 #define _COMPONENT	ACPI_BUS
79 ACPI_MODULE_NAME("ACPI")
80 
81 static d_open_t		acpiopen;
82 static d_close_t	acpiclose;
83 static d_ioctl_t	acpiioctl;
84 
85 static struct cdevsw acpi_cdevsw = {
86 	.d_version =	D_VERSION,
87 	.d_open =	acpiopen,
88 	.d_close =	acpiclose,
89 	.d_ioctl =	acpiioctl,
90 	.d_name =	"acpi",
91 };
92 
93 struct acpi_interface {
94 	ACPI_STRING	*data;
95 	int		num;
96 };
97 
98 static char *sysres_ids[] = { "PNP0C01", "PNP0C02", NULL };
99 static char *pcilink_ids[] = { "PNP0C0F", NULL };
100 
101 /* Global mutex for locking access to the ACPI subsystem. */
102 struct mtx	acpi_mutex;
103 struct callout	acpi_sleep_timer;
104 
105 /* Bitmap of device quirks. */
106 int		acpi_quirks;
107 
108 /* Supported sleep states. */
109 static BOOLEAN	acpi_sleep_states[ACPI_S_STATE_COUNT];
110 
111 static void	acpi_lookup(void *arg, const char *name, device_t *dev);
112 static int	acpi_modevent(struct module *mod, int event, void *junk);
113 static int	acpi_probe(device_t dev);
114 static int	acpi_attach(device_t dev);
115 static int	acpi_suspend(device_t dev);
116 static int	acpi_resume(device_t dev);
117 static int	acpi_shutdown(device_t dev);
118 static device_t	acpi_add_child(device_t bus, u_int order, const char *name,
119 			int unit);
120 static int	acpi_print_child(device_t bus, device_t child);
121 static void	acpi_probe_nomatch(device_t bus, device_t child);
122 static void	acpi_driver_added(device_t dev, driver_t *driver);
123 static int	acpi_read_ivar(device_t dev, device_t child, int index,
124 			uintptr_t *result);
125 static int	acpi_write_ivar(device_t dev, device_t child, int index,
126 			uintptr_t value);
127 static struct resource_list *acpi_get_rlist(device_t dev, device_t child);
128 static void	acpi_reserve_resources(device_t dev);
129 static int	acpi_sysres_alloc(device_t dev);
130 static int	acpi_set_resource(device_t dev, device_t child, int type,
131 			int rid, rman_res_t start, rman_res_t count);
132 static struct resource *acpi_alloc_resource(device_t bus, device_t child,
133 			int type, int *rid, rman_res_t start, rman_res_t end,
134 			rman_res_t count, u_int flags);
135 static int	acpi_adjust_resource(device_t bus, device_t child, int type,
136 			struct resource *r, rman_res_t start, rman_res_t end);
137 static int	acpi_release_resource(device_t bus, device_t child, int type,
138 			int rid, struct resource *r);
139 static void	acpi_delete_resource(device_t bus, device_t child, int type,
140 		    int rid);
141 static uint32_t	acpi_isa_get_logicalid(device_t dev);
142 static int	acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count);
143 static char	*acpi_device_id_probe(device_t bus, device_t dev, char **ids);
144 static ACPI_STATUS acpi_device_eval_obj(device_t bus, device_t dev,
145 		    ACPI_STRING pathname, ACPI_OBJECT_LIST *parameters,
146 		    ACPI_BUFFER *ret);
147 static ACPI_STATUS acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level,
148 		    void *context, void **retval);
149 static ACPI_STATUS acpi_device_scan_children(device_t bus, device_t dev,
150 		    int max_depth, acpi_scan_cb_t user_fn, void *arg);
151 static int	acpi_set_powerstate(device_t child, int state);
152 static int	acpi_isa_pnp_probe(device_t bus, device_t child,
153 		    struct isa_pnp_id *ids);
154 static void	acpi_probe_children(device_t bus);
155 static void	acpi_probe_order(ACPI_HANDLE handle, int *order);
156 static ACPI_STATUS acpi_probe_child(ACPI_HANDLE handle, UINT32 level,
157 		    void *context, void **status);
158 static void	acpi_sleep_enable(void *arg);
159 static ACPI_STATUS acpi_sleep_disable(struct acpi_softc *sc);
160 static ACPI_STATUS acpi_EnterSleepState(struct acpi_softc *sc, int state);
161 static void	acpi_shutdown_final(void *arg, int howto);
162 static void	acpi_enable_fixed_events(struct acpi_softc *sc);
163 static BOOLEAN	acpi_has_hid(ACPI_HANDLE handle);
164 static void	acpi_resync_clock(struct acpi_softc *sc);
165 static int	acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate);
166 static int	acpi_wake_run_prep(ACPI_HANDLE handle, int sstate);
167 static int	acpi_wake_prep_walk(int sstate);
168 static int	acpi_wake_sysctl_walk(device_t dev);
169 static int	acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS);
170 static void	acpi_system_eventhandler_sleep(void *arg, int state);
171 static void	acpi_system_eventhandler_wakeup(void *arg, int state);
172 static int	acpi_sname2sstate(const char *sname);
173 static const char *acpi_sstate2sname(int sstate);
174 static int	acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
175 static int	acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS);
176 static int	acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS);
177 static int	acpi_pm_func(u_long cmd, void *arg, ...);
178 static int	acpi_child_location_str_method(device_t acdev, device_t child,
179 					       char *buf, size_t buflen);
180 static int	acpi_child_pnpinfo_str_method(device_t acdev, device_t child,
181 					      char *buf, size_t buflen);
182 static void	acpi_enable_pcie(void);
183 static void	acpi_hint_device_unit(device_t acdev, device_t child,
184 		    const char *name, int *unitp);
185 static void	acpi_reset_interfaces(device_t dev);
186 
187 static device_method_t acpi_methods[] = {
188     /* Device interface */
189     DEVMETHOD(device_probe,		acpi_probe),
190     DEVMETHOD(device_attach,		acpi_attach),
191     DEVMETHOD(device_shutdown,		acpi_shutdown),
192     DEVMETHOD(device_detach,		bus_generic_detach),
193     DEVMETHOD(device_suspend,		acpi_suspend),
194     DEVMETHOD(device_resume,		acpi_resume),
195 
196     /* Bus interface */
197     DEVMETHOD(bus_add_child,		acpi_add_child),
198     DEVMETHOD(bus_print_child,		acpi_print_child),
199     DEVMETHOD(bus_probe_nomatch,	acpi_probe_nomatch),
200     DEVMETHOD(bus_driver_added,		acpi_driver_added),
201     DEVMETHOD(bus_read_ivar,		acpi_read_ivar),
202     DEVMETHOD(bus_write_ivar,		acpi_write_ivar),
203     DEVMETHOD(bus_get_resource_list,	acpi_get_rlist),
204     DEVMETHOD(bus_set_resource,		acpi_set_resource),
205     DEVMETHOD(bus_get_resource,		bus_generic_rl_get_resource),
206     DEVMETHOD(bus_alloc_resource,	acpi_alloc_resource),
207     DEVMETHOD(bus_adjust_resource,	acpi_adjust_resource),
208     DEVMETHOD(bus_release_resource,	acpi_release_resource),
209     DEVMETHOD(bus_delete_resource,	acpi_delete_resource),
210     DEVMETHOD(bus_child_pnpinfo_str,	acpi_child_pnpinfo_str_method),
211     DEVMETHOD(bus_child_location_str,	acpi_child_location_str_method),
212     DEVMETHOD(bus_activate_resource,	bus_generic_activate_resource),
213     DEVMETHOD(bus_deactivate_resource,	bus_generic_deactivate_resource),
214     DEVMETHOD(bus_setup_intr,		bus_generic_setup_intr),
215     DEVMETHOD(bus_teardown_intr,	bus_generic_teardown_intr),
216     DEVMETHOD(bus_hint_device_unit,	acpi_hint_device_unit),
217     DEVMETHOD(bus_get_cpus,		acpi_get_cpus),
218     DEVMETHOD(bus_get_domain,		acpi_get_domain),
219 
220     /* ACPI bus */
221     DEVMETHOD(acpi_id_probe,		acpi_device_id_probe),
222     DEVMETHOD(acpi_evaluate_object,	acpi_device_eval_obj),
223     DEVMETHOD(acpi_pwr_for_sleep,	acpi_device_pwr_for_sleep),
224     DEVMETHOD(acpi_scan_children,	acpi_device_scan_children),
225 
226     /* ISA emulation */
227     DEVMETHOD(isa_pnp_probe,		acpi_isa_pnp_probe),
228 
229     DEVMETHOD_END
230 };
231 
232 static driver_t acpi_driver = {
233     "acpi",
234     acpi_methods,
235     sizeof(struct acpi_softc),
236 };
237 
238 static devclass_t acpi_devclass;
239 DRIVER_MODULE(acpi, nexus, acpi_driver, acpi_devclass, acpi_modevent, 0);
240 MODULE_VERSION(acpi, 1);
241 
242 ACPI_SERIAL_DECL(acpi, "ACPI root bus");
243 
244 /* Local pools for managing system resources for ACPI child devices. */
245 static struct rman acpi_rman_io, acpi_rman_mem;
246 
247 #define ACPI_MINIMUM_AWAKETIME	5
248 
249 /* Holds the description of the acpi0 device. */
250 static char acpi_desc[ACPI_OEM_ID_SIZE + ACPI_OEM_TABLE_ID_SIZE + 2];
251 
252 SYSCTL_NODE(_debug, OID_AUTO, acpi, CTLFLAG_RD, NULL, "ACPI debugging");
253 static char acpi_ca_version[12];
254 SYSCTL_STRING(_debug_acpi, OID_AUTO, acpi_ca_version, CTLFLAG_RD,
255 	      acpi_ca_version, 0, "Version of Intel ACPI-CA");
256 
257 /*
258  * Allow overriding _OSI methods.
259  */
260 static char acpi_install_interface[256];
261 TUNABLE_STR("hw.acpi.install_interface", acpi_install_interface,
262     sizeof(acpi_install_interface));
263 static char acpi_remove_interface[256];
264 TUNABLE_STR("hw.acpi.remove_interface", acpi_remove_interface,
265     sizeof(acpi_remove_interface));
266 
267 /* Allow users to dump Debug objects without ACPI debugger. */
268 static int acpi_debug_objects;
269 TUNABLE_INT("debug.acpi.enable_debug_objects", &acpi_debug_objects);
270 SYSCTL_PROC(_debug_acpi, OID_AUTO, enable_debug_objects,
271     CTLFLAG_RW | CTLTYPE_INT, NULL, 0, acpi_debug_objects_sysctl, "I",
272     "Enable Debug objects");
273 
274 /* Allow the interpreter to ignore common mistakes in BIOS. */
275 static int acpi_interpreter_slack = 1;
276 TUNABLE_INT("debug.acpi.interpreter_slack", &acpi_interpreter_slack);
277 SYSCTL_INT(_debug_acpi, OID_AUTO, interpreter_slack, CTLFLAG_RDTUN,
278     &acpi_interpreter_slack, 1, "Turn on interpreter slack mode.");
279 
280 /* Ignore register widths set by FADT and use default widths instead. */
281 static int acpi_ignore_reg_width = 1;
282 TUNABLE_INT("debug.acpi.default_register_width", &acpi_ignore_reg_width);
283 SYSCTL_INT(_debug_acpi, OID_AUTO, default_register_width, CTLFLAG_RDTUN,
284     &acpi_ignore_reg_width, 1, "Ignore register widths set by FADT");
285 
286 /* Allow users to override quirks. */
287 TUNABLE_INT("debug.acpi.quirks", &acpi_quirks);
288 
289 int acpi_susp_bounce;
290 SYSCTL_INT(_debug_acpi, OID_AUTO, suspend_bounce, CTLFLAG_RW,
291     &acpi_susp_bounce, 0, "Don't actually suspend, just test devices.");
292 
293 /*
294  * ACPI can only be loaded as a module by the loader; activating it after
295  * system bootstrap time is not useful, and can be fatal to the system.
296  * It also cannot be unloaded, since the entire system bus hierarchy hangs
297  * off it.
298  */
299 static int
acpi_modevent(struct module * mod,int event,void * junk)300 acpi_modevent(struct module *mod, int event, void *junk)
301 {
302     switch (event) {
303     case MOD_LOAD:
304 	if (!cold) {
305 	    printf("The ACPI driver cannot be loaded after boot.\n");
306 	    return (EPERM);
307 	}
308 	break;
309     case MOD_UNLOAD:
310 	if (!cold && power_pm_get_type() == POWER_PM_TYPE_ACPI)
311 	    return (EBUSY);
312 	break;
313     default:
314 	break;
315     }
316     return (0);
317 }
318 
319 /*
320  * Perform early initialization.
321  */
322 ACPI_STATUS
acpi_Startup(void)323 acpi_Startup(void)
324 {
325     static int started = 0;
326     ACPI_STATUS status;
327     int val;
328 
329     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
330 
331     /* Only run the startup code once.  The MADT driver also calls this. */
332     if (started)
333 	return_VALUE (AE_OK);
334     started = 1;
335 
336     /*
337      * Initialize the ACPICA subsystem.
338      */
339     if (ACPI_FAILURE(status = AcpiInitializeSubsystem())) {
340 	printf("ACPI: Could not initialize Subsystem: %s\n",
341 	    AcpiFormatException(status));
342 	return_VALUE (status);
343     }
344 
345     /*
346      * Pre-allocate space for RSDT/XSDT and DSDT tables and allow resizing
347      * if more tables exist.
348      */
349     if (ACPI_FAILURE(status = AcpiInitializeTables(NULL, 2, TRUE))) {
350 	printf("ACPI: Table initialisation failed: %s\n",
351 	    AcpiFormatException(status));
352 	return_VALUE (status);
353     }
354 
355     /* Set up any quirks we have for this system. */
356     if (acpi_quirks == ACPI_Q_OK)
357 	acpi_table_quirks(&acpi_quirks);
358 
359     /* If the user manually set the disabled hint to 0, force-enable ACPI. */
360     if (resource_int_value("acpi", 0, "disabled", &val) == 0 && val == 0)
361 	acpi_quirks &= ~ACPI_Q_BROKEN;
362     if (acpi_quirks & ACPI_Q_BROKEN) {
363 	printf("ACPI disabled by blacklist.  Contact your BIOS vendor.\n");
364 	status = AE_SUPPORT;
365     }
366 
367     return_VALUE (status);
368 }
369 
370 /*
371  * Detect ACPI and perform early initialisation.
372  */
373 int
acpi_identify(void)374 acpi_identify(void)
375 {
376     ACPI_TABLE_RSDP	*rsdp;
377     ACPI_TABLE_HEADER	*rsdt;
378     ACPI_PHYSICAL_ADDRESS paddr;
379     struct sbuf		sb;
380 
381     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
382 
383     if (!cold)
384 	return (ENXIO);
385 
386     /* Check that we haven't been disabled with a hint. */
387     if (resource_disabled("acpi", 0))
388 	return (ENXIO);
389 
390     /* Check for other PM systems. */
391     if (power_pm_get_type() != POWER_PM_TYPE_NONE &&
392 	power_pm_get_type() != POWER_PM_TYPE_ACPI) {
393 	printf("ACPI identify failed, other PM system enabled.\n");
394 	return (ENXIO);
395     }
396 
397     /* Initialize root tables. */
398     if (ACPI_FAILURE(acpi_Startup())) {
399 	printf("ACPI: Try disabling either ACPI or apic support.\n");
400 	return (ENXIO);
401     }
402 
403     if ((paddr = AcpiOsGetRootPointer()) == 0 ||
404 	(rsdp = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_RSDP))) == NULL)
405 	return (ENXIO);
406     if (rsdp->Revision > 1 && rsdp->XsdtPhysicalAddress != 0)
407 	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->XsdtPhysicalAddress;
408     else
409 	paddr = (ACPI_PHYSICAL_ADDRESS)rsdp->RsdtPhysicalAddress;
410     AcpiOsUnmapMemory(rsdp, sizeof(ACPI_TABLE_RSDP));
411 
412     if ((rsdt = AcpiOsMapMemory(paddr, sizeof(ACPI_TABLE_HEADER))) == NULL)
413 	return (ENXIO);
414     sbuf_new(&sb, acpi_desc, sizeof(acpi_desc), SBUF_FIXEDLEN);
415     sbuf_bcat(&sb, rsdt->OemId, ACPI_OEM_ID_SIZE);
416     sbuf_trim(&sb);
417     sbuf_putc(&sb, ' ');
418     sbuf_bcat(&sb, rsdt->OemTableId, ACPI_OEM_TABLE_ID_SIZE);
419     sbuf_trim(&sb);
420     sbuf_finish(&sb);
421     sbuf_delete(&sb);
422     AcpiOsUnmapMemory(rsdt, sizeof(ACPI_TABLE_HEADER));
423 
424     snprintf(acpi_ca_version, sizeof(acpi_ca_version), "%x", ACPI_CA_VERSION);
425 
426     return (0);
427 }
428 
429 /*
430  * Fetch some descriptive data from ACPI to put in our attach message.
431  */
432 static int
acpi_probe(device_t dev)433 acpi_probe(device_t dev)
434 {
435 
436     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
437 
438     device_set_desc(dev, acpi_desc);
439 
440     return_VALUE (BUS_PROBE_NOWILDCARD);
441 }
442 
443 static int
acpi_attach(device_t dev)444 acpi_attach(device_t dev)
445 {
446     struct acpi_softc	*sc;
447     ACPI_STATUS		status;
448     int			error, state;
449     UINT32		flags;
450     UINT8		TypeA, TypeB;
451     char		*env;
452 
453     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
454 
455     sc = device_get_softc(dev);
456     sc->acpi_dev = dev;
457     callout_init(&sc->susp_force_to, 1);
458 
459     error = ENXIO;
460 
461     /* Initialize resource manager. */
462     acpi_rman_io.rm_type = RMAN_ARRAY;
463     acpi_rman_io.rm_start = 0;
464     acpi_rman_io.rm_end = 0xffff;
465     acpi_rman_io.rm_descr = "ACPI I/O ports";
466     if (rman_init(&acpi_rman_io) != 0)
467 	panic("acpi rman_init IO ports failed");
468     acpi_rman_mem.rm_type = RMAN_ARRAY;
469     acpi_rman_mem.rm_descr = "ACPI I/O memory addresses";
470     if (rman_init(&acpi_rman_mem) != 0)
471 	panic("acpi rman_init memory failed");
472 
473     /* Initialise the ACPI mutex */
474     mtx_init(&acpi_mutex, "ACPI global lock", NULL, MTX_DEF);
475 
476     /*
477      * Set the globals from our tunables.  This is needed because ACPI-CA
478      * uses UINT8 for some values and we have no tunable_byte.
479      */
480     AcpiGbl_EnableInterpreterSlack = acpi_interpreter_slack ? TRUE : FALSE;
481     AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
482     AcpiGbl_UseDefaultRegisterWidths = acpi_ignore_reg_width ? TRUE : FALSE;
483 
484 #ifndef ACPI_DEBUG
485     /*
486      * Disable all debugging layers and levels.
487      */
488     AcpiDbgLayer = 0;
489     AcpiDbgLevel = 0;
490 #endif
491 
492     /* Override OS interfaces if the user requested. */
493     acpi_reset_interfaces(dev);
494 
495     /* Load ACPI name space. */
496     status = AcpiLoadTables();
497     if (ACPI_FAILURE(status)) {
498 	device_printf(dev, "Could not load Namespace: %s\n",
499 		      AcpiFormatException(status));
500 	goto out;
501     }
502 
503     /* Handle MCFG table if present. */
504     acpi_enable_pcie();
505 
506     /*
507      * Note that some systems (specifically, those with namespace evaluation
508      * issues that require the avoidance of parts of the namespace) must
509      * avoid running _INI and _STA on everything, as well as dodging the final
510      * object init pass.
511      *
512      * For these devices, we set ACPI_NO_DEVICE_INIT and ACPI_NO_OBJECT_INIT).
513      *
514      * XXX We should arrange for the object init pass after we have attached
515      *     all our child devices, but on many systems it works here.
516      */
517     flags = 0;
518     if (testenv("debug.acpi.avoid"))
519 	flags = ACPI_NO_DEVICE_INIT | ACPI_NO_OBJECT_INIT;
520 
521     /* Bring the hardware and basic handlers online. */
522     if (ACPI_FAILURE(status = AcpiEnableSubsystem(flags))) {
523 	device_printf(dev, "Could not enable ACPI: %s\n",
524 		      AcpiFormatException(status));
525 	goto out;
526     }
527 
528     /*
529      * Call the ECDT probe function to provide EC functionality before
530      * the namespace has been evaluated.
531      *
532      * XXX This happens before the sysresource devices have been probed and
533      * attached so its resources come from nexus0.  In practice, this isn't
534      * a problem but should be addressed eventually.
535      */
536     acpi_ec_ecdt_probe(dev);
537 
538     /* Bring device objects and regions online. */
539     if (ACPI_FAILURE(status = AcpiInitializeObjects(flags))) {
540 	device_printf(dev, "Could not initialize ACPI objects: %s\n",
541 		      AcpiFormatException(status));
542 	goto out;
543     }
544 
545     /*
546      * Setup our sysctl tree.
547      *
548      * XXX: This doesn't check to make sure that none of these fail.
549      */
550     sysctl_ctx_init(&sc->acpi_sysctl_ctx);
551     sc->acpi_sysctl_tree = SYSCTL_ADD_NODE(&sc->acpi_sysctl_ctx,
552 			       SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO,
553 			       device_get_name(dev), CTLFLAG_RD, 0, "");
554     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
555 	OID_AUTO, "supported_sleep_state", CTLTYPE_STRING | CTLFLAG_RD,
556 	0, 0, acpi_supported_sleep_state_sysctl, "A",
557 	"List supported ACPI sleep states.");
558     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
559 	OID_AUTO, "power_button_state", CTLTYPE_STRING | CTLFLAG_RW,
560 	&sc->acpi_power_button_sx, 0, acpi_sleep_state_sysctl, "A",
561 	"Power button ACPI sleep state.");
562     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
563 	OID_AUTO, "sleep_button_state", CTLTYPE_STRING | CTLFLAG_RW,
564 	&sc->acpi_sleep_button_sx, 0, acpi_sleep_state_sysctl, "A",
565 	"Sleep button ACPI sleep state.");
566     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
567 	OID_AUTO, "lid_switch_state", CTLTYPE_STRING | CTLFLAG_RW,
568 	&sc->acpi_lid_switch_sx, 0, acpi_sleep_state_sysctl, "A",
569 	"Lid ACPI sleep state. Set to S3 if you want to suspend your laptop when close the Lid.");
570     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
571 	OID_AUTO, "standby_state", CTLTYPE_STRING | CTLFLAG_RW,
572 	&sc->acpi_standby_sx, 0, acpi_sleep_state_sysctl, "A", "");
573     SYSCTL_ADD_PROC(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
574 	OID_AUTO, "suspend_state", CTLTYPE_STRING | CTLFLAG_RW,
575 	&sc->acpi_suspend_sx, 0, acpi_sleep_state_sysctl, "A", "");
576     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
577 	OID_AUTO, "sleep_delay", CTLFLAG_RW, &sc->acpi_sleep_delay, 0,
578 	"sleep delay in seconds");
579     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
580 	OID_AUTO, "s4bios", CTLFLAG_RW, &sc->acpi_s4bios, 0, "S4BIOS mode");
581     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
582 	OID_AUTO, "verbose", CTLFLAG_RW, &sc->acpi_verbose, 0, "verbose mode");
583     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
584 	OID_AUTO, "disable_on_reboot", CTLFLAG_RW,
585 	&sc->acpi_do_disable, 0, "Disable ACPI when rebooting/halting system");
586     SYSCTL_ADD_INT(&sc->acpi_sysctl_ctx, SYSCTL_CHILDREN(sc->acpi_sysctl_tree),
587 	OID_AUTO, "handle_reboot", CTLFLAG_RW,
588 	&sc->acpi_handle_reboot, 0, "Use ACPI Reset Register to reboot");
589 
590     /*
591      * Default to 1 second before sleeping to give some machines time to
592      * stabilize.
593      */
594     sc->acpi_sleep_delay = 1;
595     if (bootverbose)
596 	sc->acpi_verbose = 1;
597     if ((env = kern_getenv("hw.acpi.verbose")) != NULL) {
598 	if (strcmp(env, "0") != 0)
599 	    sc->acpi_verbose = 1;
600 	freeenv(env);
601     }
602 
603     /* Only enable reboot by default if the FADT says it is available. */
604     if (AcpiGbl_FADT.Flags & ACPI_FADT_RESET_REGISTER)
605 	sc->acpi_handle_reboot = 1;
606 
607 #if !ACPI_REDUCED_HARDWARE
608     /* Only enable S4BIOS by default if the FACS says it is available. */
609     if (AcpiGbl_FACS != NULL && AcpiGbl_FACS->Flags & ACPI_FACS_S4_BIOS_PRESENT)
610 	sc->acpi_s4bios = 1;
611 #endif
612 
613     /* Probe all supported sleep states. */
614     acpi_sleep_states[ACPI_STATE_S0] = TRUE;
615     for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++)
616 	if (ACPI_SUCCESS(AcpiEvaluateObject(ACPI_ROOT_OBJECT,
617 	    __DECONST(char *, AcpiGbl_SleepStateNames[state]), NULL, NULL)) &&
618 	    ACPI_SUCCESS(AcpiGetSleepTypeData(state, &TypeA, &TypeB)))
619 	    acpi_sleep_states[state] = TRUE;
620 
621     /*
622      * Dispatch the default sleep state to devices.  The lid switch is set
623      * to UNKNOWN by default to avoid surprising users.
624      */
625     sc->acpi_power_button_sx = acpi_sleep_states[ACPI_STATE_S5] ?
626 	ACPI_STATE_S5 : ACPI_STATE_UNKNOWN;
627     sc->acpi_lid_switch_sx = ACPI_STATE_UNKNOWN;
628     sc->acpi_standby_sx = acpi_sleep_states[ACPI_STATE_S1] ?
629 	ACPI_STATE_S1 : ACPI_STATE_UNKNOWN;
630     sc->acpi_suspend_sx = acpi_sleep_states[ACPI_STATE_S3] ?
631 	ACPI_STATE_S3 : ACPI_STATE_UNKNOWN;
632 
633     /* Pick the first valid sleep state for the sleep button default. */
634     sc->acpi_sleep_button_sx = ACPI_STATE_UNKNOWN;
635     for (state = ACPI_STATE_S1; state <= ACPI_STATE_S4; state++)
636 	if (acpi_sleep_states[state]) {
637 	    sc->acpi_sleep_button_sx = state;
638 	    break;
639 	}
640 
641     acpi_enable_fixed_events(sc);
642 
643     /*
644      * Scan the namespace and attach/initialise children.
645      */
646 
647     /* Register our shutdown handler. */
648     EVENTHANDLER_REGISTER(shutdown_final, acpi_shutdown_final, sc,
649 	SHUTDOWN_PRI_LAST);
650 
651     /*
652      * Register our acpi event handlers.
653      * XXX should be configurable eg. via userland policy manager.
654      */
655     EVENTHANDLER_REGISTER(acpi_sleep_event, acpi_system_eventhandler_sleep,
656 	sc, ACPI_EVENT_PRI_LAST);
657     EVENTHANDLER_REGISTER(acpi_wakeup_event, acpi_system_eventhandler_wakeup,
658 	sc, ACPI_EVENT_PRI_LAST);
659 
660     /* Flag our initial states. */
661     sc->acpi_enabled = TRUE;
662     sc->acpi_sstate = ACPI_STATE_S0;
663     sc->acpi_sleep_disabled = TRUE;
664 
665     /* Create the control device */
666     sc->acpi_dev_t = make_dev(&acpi_cdevsw, 0, UID_ROOT, GID_OPERATOR, 0664,
667 			      "acpi");
668     sc->acpi_dev_t->si_drv1 = sc;
669 
670     if ((error = acpi_machdep_init(dev)))
671 	goto out;
672 
673     /* Register ACPI again to pass the correct argument of pm_func. */
674     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, sc);
675 
676     if (!acpi_disabled("bus")) {
677 	EVENTHANDLER_REGISTER(dev_lookup, acpi_lookup, NULL, 1000);
678 	acpi_probe_children(dev);
679     }
680 
681     /* Update all GPEs and enable runtime GPEs. */
682     status = AcpiUpdateAllGpes();
683     if (ACPI_FAILURE(status))
684 	device_printf(dev, "Could not update all GPEs: %s\n",
685 	    AcpiFormatException(status));
686 
687     /* Allow sleep request after a while. */
688     callout_init_mtx(&acpi_sleep_timer, &acpi_mutex, 0);
689     callout_reset(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME,
690 	acpi_sleep_enable, sc);
691 
692     error = 0;
693 
694  out:
695     return_VALUE (error);
696 }
697 
698 static void
acpi_set_power_children(device_t dev,int state)699 acpi_set_power_children(device_t dev, int state)
700 {
701 	device_t child;
702 	device_t *devlist;
703 	int dstate, i, numdevs;
704 
705 	if (device_get_children(dev, &devlist, &numdevs) != 0)
706 		return;
707 
708 	/*
709 	 * Retrieve and set D-state for the sleep state if _SxD is present.
710 	 * Skip children who aren't attached since they are handled separately.
711 	 */
712 	for (i = 0; i < numdevs; i++) {
713 		child = devlist[i];
714 		dstate = state;
715 		if (device_is_attached(child) &&
716 		    acpi_device_pwr_for_sleep(dev, child, &dstate) == 0)
717 			acpi_set_powerstate(child, dstate);
718 	}
719 	free(devlist, M_TEMP);
720 }
721 
722 static int
acpi_suspend(device_t dev)723 acpi_suspend(device_t dev)
724 {
725     int error;
726 
727     GIANT_REQUIRED;
728 
729     error = bus_generic_suspend(dev);
730     if (error == 0)
731 	acpi_set_power_children(dev, ACPI_STATE_D3);
732 
733     return (error);
734 }
735 
736 static int
acpi_resume(device_t dev)737 acpi_resume(device_t dev)
738 {
739 
740     GIANT_REQUIRED;
741 
742     acpi_set_power_children(dev, ACPI_STATE_D0);
743 
744     return (bus_generic_resume(dev));
745 }
746 
747 static int
acpi_shutdown(device_t dev)748 acpi_shutdown(device_t dev)
749 {
750 
751     GIANT_REQUIRED;
752 
753     /* Allow children to shutdown first. */
754     bus_generic_shutdown(dev);
755 
756     /*
757      * Enable any GPEs that are able to power-on the system (i.e., RTC).
758      * Also, disable any that are not valid for this state (most).
759      */
760     acpi_wake_prep_walk(ACPI_STATE_S5);
761 
762     return (0);
763 }
764 
765 /*
766  * Handle a new device being added
767  */
768 static device_t
acpi_add_child(device_t bus,u_int order,const char * name,int unit)769 acpi_add_child(device_t bus, u_int order, const char *name, int unit)
770 {
771     struct acpi_device	*ad;
772     device_t		child;
773 
774     if ((ad = malloc(sizeof(*ad), M_ACPIDEV, M_NOWAIT | M_ZERO)) == NULL)
775 	return (NULL);
776 
777     resource_list_init(&ad->ad_rl);
778 
779     child = device_add_child_ordered(bus, order, name, unit);
780     if (child != NULL)
781 	device_set_ivars(child, ad);
782     else
783 	free(ad, M_ACPIDEV);
784     return (child);
785 }
786 
787 static int
acpi_print_child(device_t bus,device_t child)788 acpi_print_child(device_t bus, device_t child)
789 {
790     struct acpi_device	 *adev = device_get_ivars(child);
791     struct resource_list *rl = &adev->ad_rl;
792     int retval = 0;
793 
794     retval += bus_print_child_header(bus, child);
795     retval += resource_list_print_type(rl, "port",  SYS_RES_IOPORT, "%#jx");
796     retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#jx");
797     retval += resource_list_print_type(rl, "irq",   SYS_RES_IRQ,    "%jd");
798     retval += resource_list_print_type(rl, "drq",   SYS_RES_DRQ,    "%jd");
799     if (device_get_flags(child))
800 	retval += printf(" flags %#x", device_get_flags(child));
801     retval += bus_print_child_domain(bus, child);
802     retval += bus_print_child_footer(bus, child);
803 
804     return (retval);
805 }
806 
807 /*
808  * If this device is an ACPI child but no one claimed it, attempt
809  * to power it off.  We'll power it back up when a driver is added.
810  *
811  * XXX Disabled for now since many necessary devices (like fdc and
812  * ATA) don't claim the devices we created for them but still expect
813  * them to be powered up.
814  */
815 static void
acpi_probe_nomatch(device_t bus,device_t child)816 acpi_probe_nomatch(device_t bus, device_t child)
817 {
818 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER
819     acpi_set_powerstate(child, ACPI_STATE_D3);
820 #endif
821 }
822 
823 /*
824  * If a new driver has a chance to probe a child, first power it up.
825  *
826  * XXX Disabled for now (see acpi_probe_nomatch for details).
827  */
828 static void
acpi_driver_added(device_t dev,driver_t * driver)829 acpi_driver_added(device_t dev, driver_t *driver)
830 {
831     device_t child, *devlist;
832     int i, numdevs;
833 
834     DEVICE_IDENTIFY(driver, dev);
835     if (device_get_children(dev, &devlist, &numdevs))
836 	    return;
837     for (i = 0; i < numdevs; i++) {
838 	child = devlist[i];
839 	if (device_get_state(child) == DS_NOTPRESENT) {
840 #ifdef ACPI_ENABLE_POWERDOWN_NODRIVER
841 	    acpi_set_powerstate(child, ACPI_STATE_D0);
842 	    if (device_probe_and_attach(child) != 0)
843 		acpi_set_powerstate(child, ACPI_STATE_D3);
844 #else
845 	    device_probe_and_attach(child);
846 #endif
847 	}
848     }
849     free(devlist, M_TEMP);
850 }
851 
852 /* Location hint for devctl(8) */
853 static int
acpi_child_location_str_method(device_t cbdev,device_t child,char * buf,size_t buflen)854 acpi_child_location_str_method(device_t cbdev, device_t child, char *buf,
855     size_t buflen)
856 {
857     struct acpi_device *dinfo = device_get_ivars(child);
858     char buf2[32];
859     int pxm;
860 
861     if (dinfo->ad_handle) {
862         snprintf(buf, buflen, "handle=%s", acpi_name(dinfo->ad_handle));
863         if (ACPI_SUCCESS(acpi_GetInteger(dinfo->ad_handle, "_PXM", &pxm))) {
864                 snprintf(buf2, 32, " _PXM=%d", pxm);
865                 strlcat(buf, buf2, buflen);
866         }
867     } else {
868         snprintf(buf, buflen, "");
869     }
870     return (0);
871 }
872 
873 /* PnP information for devctl(8) */
874 static int
acpi_child_pnpinfo_str_method(device_t cbdev,device_t child,char * buf,size_t buflen)875 acpi_child_pnpinfo_str_method(device_t cbdev, device_t child, char *buf,
876     size_t buflen)
877 {
878     struct acpi_device *dinfo = device_get_ivars(child);
879     ACPI_DEVICE_INFO *adinfo;
880 
881     if (ACPI_FAILURE(AcpiGetObjectInfo(dinfo->ad_handle, &adinfo))) {
882 	snprintf(buf, buflen, "unknown");
883 	return (0);
884     }
885 
886     snprintf(buf, buflen, "_HID=%s _UID=%lu",
887 	(adinfo->Valid & ACPI_VALID_HID) ?
888 	adinfo->HardwareId.String : "none",
889 	(adinfo->Valid & ACPI_VALID_UID) ?
890 	strtoul(adinfo->UniqueId.String, NULL, 10) : 0UL);
891     AcpiOsFree(adinfo);
892 
893     return (0);
894 }
895 
896 /*
897  * Handle per-device ivars
898  */
899 static int
acpi_read_ivar(device_t dev,device_t child,int index,uintptr_t * result)900 acpi_read_ivar(device_t dev, device_t child, int index, uintptr_t *result)
901 {
902     struct acpi_device	*ad;
903 
904     if ((ad = device_get_ivars(child)) == NULL) {
905 	device_printf(child, "device has no ivars\n");
906 	return (ENOENT);
907     }
908 
909     /* ACPI and ISA compatibility ivars */
910     switch(index) {
911     case ACPI_IVAR_HANDLE:
912 	*(ACPI_HANDLE *)result = ad->ad_handle;
913 	break;
914     case ACPI_IVAR_PRIVATE:
915 	*(void **)result = ad->ad_private;
916 	break;
917     case ACPI_IVAR_FLAGS:
918 	*(int *)result = ad->ad_flags;
919 	break;
920     case ISA_IVAR_VENDORID:
921     case ISA_IVAR_SERIAL:
922     case ISA_IVAR_COMPATID:
923 	*(int *)result = -1;
924 	break;
925     case ISA_IVAR_LOGICALID:
926 	*(int *)result = acpi_isa_get_logicalid(child);
927 	break;
928     case PCI_IVAR_CLASS:
929 	*(uint8_t*)result = (ad->ad_cls_class >> 16) & 0xff;
930 	break;
931     case PCI_IVAR_SUBCLASS:
932 	*(uint8_t*)result = (ad->ad_cls_class >> 8) & 0xff;
933 	break;
934     case PCI_IVAR_PROGIF:
935 	*(uint8_t*)result = (ad->ad_cls_class >> 0) & 0xff;
936 	break;
937     default:
938 	return (ENOENT);
939     }
940 
941     return (0);
942 }
943 
944 static int
acpi_write_ivar(device_t dev,device_t child,int index,uintptr_t value)945 acpi_write_ivar(device_t dev, device_t child, int index, uintptr_t value)
946 {
947     struct acpi_device	*ad;
948 
949     if ((ad = device_get_ivars(child)) == NULL) {
950 	device_printf(child, "device has no ivars\n");
951 	return (ENOENT);
952     }
953 
954     switch(index) {
955     case ACPI_IVAR_HANDLE:
956 	ad->ad_handle = (ACPI_HANDLE)value;
957 	break;
958     case ACPI_IVAR_PRIVATE:
959 	ad->ad_private = (void *)value;
960 	break;
961     case ACPI_IVAR_FLAGS:
962 	ad->ad_flags = (int)value;
963 	break;
964     default:
965 	panic("bad ivar write request (%d)", index);
966 	return (ENOENT);
967     }
968 
969     return (0);
970 }
971 
972 /*
973  * Handle child resource allocation/removal
974  */
975 static struct resource_list *
acpi_get_rlist(device_t dev,device_t child)976 acpi_get_rlist(device_t dev, device_t child)
977 {
978     struct acpi_device		*ad;
979 
980     ad = device_get_ivars(child);
981     return (&ad->ad_rl);
982 }
983 
984 static int
acpi_match_resource_hint(device_t dev,int type,long value)985 acpi_match_resource_hint(device_t dev, int type, long value)
986 {
987     struct acpi_device *ad = device_get_ivars(dev);
988     struct resource_list *rl = &ad->ad_rl;
989     struct resource_list_entry *rle;
990 
991     STAILQ_FOREACH(rle, rl, link) {
992 	if (rle->type != type)
993 	    continue;
994 	if (rle->start <= value && rle->end >= value)
995 	    return (1);
996     }
997     return (0);
998 }
999 
1000 /*
1001  * Wire device unit numbers based on resource matches in hints.
1002  */
1003 static void
acpi_hint_device_unit(device_t acdev,device_t child,const char * name,int * unitp)1004 acpi_hint_device_unit(device_t acdev, device_t child, const char *name,
1005     int *unitp)
1006 {
1007     const char *s;
1008     long value;
1009     int line, matches, unit;
1010 
1011     /*
1012      * Iterate over all the hints for the devices with the specified
1013      * name to see if one's resources are a subset of this device.
1014      */
1015     line = 0;
1016     while (resource_find_dev(&line, name, &unit, "at", NULL) == 0) {
1017 	/* Must have an "at" for acpi or isa. */
1018 	resource_string_value(name, unit, "at", &s);
1019 	if (!(strcmp(s, "acpi0") == 0 || strcmp(s, "acpi") == 0 ||
1020 	    strcmp(s, "isa0") == 0 || strcmp(s, "isa") == 0))
1021 	    continue;
1022 
1023 	/*
1024 	 * Check for matching resources.  We must have at least one match.
1025 	 * Since I/O and memory resources cannot be shared, if we get a
1026 	 * match on either of those, ignore any mismatches in IRQs or DRQs.
1027 	 *
1028 	 * XXX: We may want to revisit this to be more lenient and wire
1029 	 * as long as it gets one match.
1030 	 */
1031 	matches = 0;
1032 	if (resource_long_value(name, unit, "port", &value) == 0) {
1033 	    /*
1034 	     * Floppy drive controllers are notorious for having a
1035 	     * wide variety of resources not all of which include the
1036 	     * first port that is specified by the hint (typically
1037 	     * 0x3f0) (see the comment above fdc_isa_alloc_resources()
1038 	     * in fdc_isa.c).  However, they do all seem to include
1039 	     * port + 2 (e.g. 0x3f2) so for a floppy device, look for
1040 	     * 'value + 2' in the port resources instead of the hint
1041 	     * value.
1042 	     */
1043 	    if (strcmp(name, "fdc") == 0)
1044 		value += 2;
1045 	    if (acpi_match_resource_hint(child, SYS_RES_IOPORT, value))
1046 		matches++;
1047 	    else
1048 		continue;
1049 	}
1050 	if (resource_long_value(name, unit, "maddr", &value) == 0) {
1051 	    if (acpi_match_resource_hint(child, SYS_RES_MEMORY, value))
1052 		matches++;
1053 	    else
1054 		continue;
1055 	}
1056 	if (matches > 0)
1057 	    goto matched;
1058 	if (resource_long_value(name, unit, "irq", &value) == 0) {
1059 	    if (acpi_match_resource_hint(child, SYS_RES_IRQ, value))
1060 		matches++;
1061 	    else
1062 		continue;
1063 	}
1064 	if (resource_long_value(name, unit, "drq", &value) == 0) {
1065 	    if (acpi_match_resource_hint(child, SYS_RES_DRQ, value))
1066 		matches++;
1067 	    else
1068 		continue;
1069 	}
1070 
1071     matched:
1072 	if (matches > 0) {
1073 	    /* We have a winner! */
1074 	    *unitp = unit;
1075 	    break;
1076 	}
1077     }
1078 }
1079 
1080 /*
1081  * Fetch the NUMA domain for a device by mapping the value returned by
1082  * _PXM to a NUMA domain.  If the device does not have a _PXM method,
1083  * -2 is returned.  If any other error occurs, -1 is returned.
1084  */
1085 static int
acpi_parse_pxm(device_t dev)1086 acpi_parse_pxm(device_t dev)
1087 {
1088 #ifdef NUMA
1089 #if defined(__i386__) || defined(__amd64__)
1090 	ACPI_HANDLE handle;
1091 	ACPI_STATUS status;
1092 	int pxm;
1093 
1094 	handle = acpi_get_handle(dev);
1095 	if (handle == NULL)
1096 		return (-2);
1097 	status = acpi_GetInteger(handle, "_PXM", &pxm);
1098 	if (ACPI_SUCCESS(status))
1099 		return (acpi_map_pxm_to_vm_domainid(pxm));
1100 	if (status == AE_NOT_FOUND)
1101 		return (-2);
1102 #endif
1103 #endif
1104 	return (-1);
1105 }
1106 
1107 int
acpi_get_cpus(device_t dev,device_t child,enum cpu_sets op,size_t setsize,cpuset_t * cpuset)1108 acpi_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
1109     cpuset_t *cpuset)
1110 {
1111 	int d, error;
1112 
1113 	d = acpi_parse_pxm(child);
1114 	if (d < 0)
1115 		return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
1116 
1117 	switch (op) {
1118 	case LOCAL_CPUS:
1119 		if (setsize != sizeof(cpuset_t))
1120 			return (EINVAL);
1121 		*cpuset = cpuset_domain[d];
1122 		return (0);
1123 	case INTR_CPUS:
1124 		error = bus_generic_get_cpus(dev, child, op, setsize, cpuset);
1125 		if (error != 0)
1126 			return (error);
1127 		if (setsize != sizeof(cpuset_t))
1128 			return (EINVAL);
1129 		CPU_AND(cpuset, &cpuset_domain[d]);
1130 		return (0);
1131 	default:
1132 		return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
1133 	}
1134 }
1135 
1136 /*
1137  * Fetch the NUMA domain for the given device 'dev'.
1138  *
1139  * If a device has a _PXM method, map that to a NUMA domain.
1140  * Otherwise, pass the request up to the parent.
1141  * If there's no matching domain or the domain cannot be
1142  * determined, return ENOENT.
1143  */
1144 int
acpi_get_domain(device_t dev,device_t child,int * domain)1145 acpi_get_domain(device_t dev, device_t child, int *domain)
1146 {
1147 	int d;
1148 
1149 	d = acpi_parse_pxm(child);
1150 	if (d >= 0) {
1151 		*domain = d;
1152 		return (0);
1153 	}
1154 	if (d == -1)
1155 		return (ENOENT);
1156 
1157 	/* No _PXM node; go up a level */
1158 	return (bus_generic_get_domain(dev, child, domain));
1159 }
1160 
1161 /*
1162  * Pre-allocate/manage all memory and IO resources.  Since rman can't handle
1163  * duplicates, we merge any in the sysresource attach routine.
1164  */
1165 static int
acpi_sysres_alloc(device_t dev)1166 acpi_sysres_alloc(device_t dev)
1167 {
1168     struct resource *res;
1169     struct resource_list *rl;
1170     struct resource_list_entry *rle;
1171     struct rman *rm;
1172     device_t *children;
1173     int child_count, i;
1174 
1175     /*
1176      * Probe/attach any sysresource devices.  This would be unnecessary if we
1177      * had multi-pass probe/attach.
1178      */
1179     if (device_get_children(dev, &children, &child_count) != 0)
1180 	return (ENXIO);
1181     for (i = 0; i < child_count; i++) {
1182 	if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1183 	    device_probe_and_attach(children[i]);
1184     }
1185     free(children, M_TEMP);
1186 
1187     rl = BUS_GET_RESOURCE_LIST(device_get_parent(dev), dev);
1188     STAILQ_FOREACH(rle, rl, link) {
1189 	if (rle->res != NULL) {
1190 	    device_printf(dev, "duplicate resource for %jx\n", rle->start);
1191 	    continue;
1192 	}
1193 
1194 	/* Only memory and IO resources are valid here. */
1195 	switch (rle->type) {
1196 	case SYS_RES_IOPORT:
1197 	    rm = &acpi_rman_io;
1198 	    break;
1199 	case SYS_RES_MEMORY:
1200 	    rm = &acpi_rman_mem;
1201 	    break;
1202 	default:
1203 	    continue;
1204 	}
1205 
1206 	/* Pre-allocate resource and add to our rman pool. */
1207 	res = BUS_ALLOC_RESOURCE(device_get_parent(dev), dev, rle->type,
1208 	    &rle->rid, rle->start, rle->start + rle->count - 1, rle->count, 0);
1209 	if (res != NULL) {
1210 	    rman_manage_region(rm, rman_get_start(res), rman_get_end(res));
1211 	    rle->res = res;
1212 	} else if (bootverbose)
1213 	    device_printf(dev, "reservation of %jx, %jx (%d) failed\n",
1214 		rle->start, rle->count, rle->type);
1215     }
1216     return (0);
1217 }
1218 
1219 /*
1220  * Reserve declared resources for devices found during attach once system
1221  * resources have been allocated.
1222  */
1223 static void
acpi_reserve_resources(device_t dev)1224 acpi_reserve_resources(device_t dev)
1225 {
1226     struct resource_list_entry *rle;
1227     struct resource_list *rl;
1228     struct acpi_device *ad;
1229     struct acpi_softc *sc;
1230     device_t *children;
1231     int child_count, i;
1232 
1233     sc = device_get_softc(dev);
1234     if (device_get_children(dev, &children, &child_count) != 0)
1235 	return;
1236     for (i = 0; i < child_count; i++) {
1237 	ad = device_get_ivars(children[i]);
1238 	rl = &ad->ad_rl;
1239 
1240 	/* Don't reserve system resources. */
1241 	if (ACPI_ID_PROBE(dev, children[i], sysres_ids) != NULL)
1242 	    continue;
1243 
1244 	STAILQ_FOREACH(rle, rl, link) {
1245 	    /*
1246 	     * Don't reserve IRQ resources.  There are many sticky things
1247 	     * to get right otherwise (e.g. IRQs for psm, atkbd, and HPET
1248 	     * when using legacy routing).
1249 	     */
1250 	    if (rle->type == SYS_RES_IRQ)
1251 		continue;
1252 
1253 	    /*
1254 	     * Don't reserve the resource if it is already allocated.
1255 	     * The acpi_ec(4) driver can allocate its resources early
1256 	     * if ECDT is present.
1257 	     */
1258 	    if (rle->res != NULL)
1259 		continue;
1260 
1261 	    /*
1262 	     * Try to reserve the resource from our parent.  If this
1263 	     * fails because the resource is a system resource, just
1264 	     * let it be.  The resource range is already reserved so
1265 	     * that other devices will not use it.  If the driver
1266 	     * needs to allocate the resource, then
1267 	     * acpi_alloc_resource() will sub-alloc from the system
1268 	     * resource.
1269 	     */
1270 	    resource_list_reserve(rl, dev, children[i], rle->type, &rle->rid,
1271 		rle->start, rle->end, rle->count, 0);
1272 	}
1273     }
1274     free(children, M_TEMP);
1275     sc->acpi_resources_reserved = 1;
1276 }
1277 
1278 static int
acpi_set_resource(device_t dev,device_t child,int type,int rid,rman_res_t start,rman_res_t count)1279 acpi_set_resource(device_t dev, device_t child, int type, int rid,
1280     rman_res_t start, rman_res_t count)
1281 {
1282     struct acpi_softc *sc = device_get_softc(dev);
1283     struct acpi_device *ad = device_get_ivars(child);
1284     struct resource_list *rl = &ad->ad_rl;
1285     ACPI_DEVICE_INFO *devinfo;
1286     rman_res_t end;
1287     int allow;
1288 
1289     /* Ignore IRQ resources for PCI link devices. */
1290     if (type == SYS_RES_IRQ && ACPI_ID_PROBE(dev, child, pcilink_ids) != NULL)
1291 	return (0);
1292 
1293     /*
1294      * Ignore most resources for PCI root bridges.  Some BIOSes
1295      * incorrectly enumerate the memory ranges they decode as plain
1296      * memory resources instead of as ResourceProducer ranges.  Other
1297      * BIOSes incorrectly list system resource entries for I/O ranges
1298      * under the PCI bridge.  Do allow the one known-correct case on
1299      * x86 of a PCI bridge claiming the I/O ports used for PCI config
1300      * access.
1301      */
1302     if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
1303 	if (ACPI_SUCCESS(AcpiGetObjectInfo(ad->ad_handle, &devinfo))) {
1304 	    if ((devinfo->Flags & ACPI_PCI_ROOT_BRIDGE) != 0) {
1305 #if defined(__i386__) || defined(__amd64__)
1306 		allow = (type == SYS_RES_IOPORT && start == CONF1_ADDR_PORT);
1307 #else
1308 		allow = 0;
1309 #endif
1310 		if (!allow) {
1311 		    AcpiOsFree(devinfo);
1312 		    return (0);
1313 		}
1314 	    }
1315 	    AcpiOsFree(devinfo);
1316 	}
1317     }
1318 
1319 #ifdef INTRNG
1320     /* map with default for now */
1321     if (type == SYS_RES_IRQ)
1322 	start = (rman_res_t)acpi_map_intr(child, (u_int)start,
1323 			acpi_get_handle(child));
1324 #endif
1325 
1326     /* If the resource is already allocated, fail. */
1327     if (resource_list_busy(rl, type, rid))
1328 	return (EBUSY);
1329 
1330     /* If the resource is already reserved, release it. */
1331     if (resource_list_reserved(rl, type, rid))
1332 	resource_list_unreserve(rl, dev, child, type, rid);
1333 
1334     /* Add the resource. */
1335     end = (start + count - 1);
1336     resource_list_add(rl, type, rid, start, end, count);
1337 
1338     /* Don't reserve resources until the system resources are allocated. */
1339     if (!sc->acpi_resources_reserved)
1340 	return (0);
1341 
1342     /* Don't reserve system resources. */
1343     if (ACPI_ID_PROBE(dev, child, sysres_ids) != NULL)
1344 	return (0);
1345 
1346     /*
1347      * Don't reserve IRQ resources.  There are many sticky things to
1348      * get right otherwise (e.g. IRQs for psm, atkbd, and HPET when
1349      * using legacy routing).
1350      */
1351     if (type == SYS_RES_IRQ)
1352 	return (0);
1353 
1354     /*
1355      * Don't reserve resources for CPU devices.  Some of these
1356      * resources need to be allocated as shareable, but reservations
1357      * are always non-shareable.
1358      */
1359     if (device_get_devclass(child) == devclass_find("cpu"))
1360 	return (0);
1361 
1362     /*
1363      * Reserve the resource.
1364      *
1365      * XXX: Ignores failure for now.  Failure here is probably a
1366      * BIOS/firmware bug?
1367      */
1368     resource_list_reserve(rl, dev, child, type, &rid, start, end, count, 0);
1369     return (0);
1370 }
1371 
1372 static struct resource *
acpi_alloc_resource(device_t bus,device_t child,int type,int * rid,rman_res_t start,rman_res_t end,rman_res_t count,u_int flags)1373 acpi_alloc_resource(device_t bus, device_t child, int type, int *rid,
1374     rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
1375 {
1376 #ifndef INTRNG
1377     ACPI_RESOURCE ares;
1378 #endif
1379     struct acpi_device *ad;
1380     struct resource_list_entry *rle;
1381     struct resource_list *rl;
1382     struct resource *res;
1383     int isdefault = RMAN_IS_DEFAULT_RANGE(start, end);
1384 
1385     /*
1386      * First attempt at allocating the resource.  For direct children,
1387      * use resource_list_alloc() to handle reserved resources.  For
1388      * other devices, pass the request up to our parent.
1389      */
1390     if (bus == device_get_parent(child)) {
1391 	ad = device_get_ivars(child);
1392 	rl = &ad->ad_rl;
1393 
1394 	/*
1395 	 * Simulate the behavior of the ISA bus for direct children
1396 	 * devices.  That is, if a non-default range is specified for
1397 	 * a resource that doesn't exist, use bus_set_resource() to
1398 	 * add the resource before allocating it.  Note that these
1399 	 * resources will not be reserved.
1400 	 */
1401 	if (!isdefault && resource_list_find(rl, type, *rid) == NULL)
1402 		resource_list_add(rl, type, *rid, start, end, count);
1403 	res = resource_list_alloc(rl, bus, child, type, rid, start, end, count,
1404 	    flags);
1405 #ifndef INTRNG
1406 	if (res != NULL && type == SYS_RES_IRQ) {
1407 	    /*
1408 	     * Since bus_config_intr() takes immediate effect, we cannot
1409 	     * configure the interrupt associated with a device when we
1410 	     * parse the resources but have to defer it until a driver
1411 	     * actually allocates the interrupt via bus_alloc_resource().
1412 	     *
1413 	     * XXX: Should we handle the lookup failing?
1414 	     */
1415 	    if (ACPI_SUCCESS(acpi_lookup_irq_resource(child, *rid, res, &ares)))
1416 		acpi_config_intr(child, &ares);
1417 	}
1418 #endif
1419 
1420 	/*
1421 	 * If this is an allocation of the "default" range for a given
1422 	 * RID, fetch the exact bounds for this resource from the
1423 	 * resource list entry to try to allocate the range from the
1424 	 * system resource regions.
1425 	 */
1426 	if (res == NULL && isdefault) {
1427 	    rle = resource_list_find(rl, type, *rid);
1428 	    if (rle != NULL) {
1429 		start = rle->start;
1430 		end = rle->end;
1431 		count = rle->count;
1432 	    }
1433 	}
1434     } else
1435 	res = BUS_ALLOC_RESOURCE(device_get_parent(bus), child, type, rid,
1436 	    start, end, count, flags);
1437 
1438     /*
1439      * If the first attempt failed and this is an allocation of a
1440      * specific range, try to satisfy the request via a suballocation
1441      * from our system resource regions.
1442      */
1443     if (res == NULL && start + count - 1 == end)
1444 	res = acpi_alloc_sysres(child, type, rid, start, end, count, flags);
1445     return (res);
1446 }
1447 
1448 /*
1449  * Attempt to allocate a specific resource range from the system
1450  * resource ranges.  Note that we only handle memory and I/O port
1451  * system resources.
1452  */
1453 struct resource *
acpi_alloc_sysres(device_t child,int type,int * rid,rman_res_t start,rman_res_t end,rman_res_t count,u_int flags)1454 acpi_alloc_sysres(device_t child, int type, int *rid, rman_res_t start,
1455     rman_res_t end, rman_res_t count, u_int flags)
1456 {
1457     struct rman *rm;
1458     struct resource *res;
1459 
1460     switch (type) {
1461     case SYS_RES_IOPORT:
1462 	rm = &acpi_rman_io;
1463 	break;
1464     case SYS_RES_MEMORY:
1465 	rm = &acpi_rman_mem;
1466 	break;
1467     default:
1468 	return (NULL);
1469     }
1470 
1471     KASSERT(start + count - 1 == end, ("wildcard resource range"));
1472     res = rman_reserve_resource(rm, start, end, count, flags & ~RF_ACTIVE,
1473 	child);
1474     if (res == NULL)
1475 	return (NULL);
1476 
1477     rman_set_rid(res, *rid);
1478 
1479     /* If requested, activate the resource using the parent's method. */
1480     if (flags & RF_ACTIVE)
1481 	if (bus_activate_resource(child, type, *rid, res) != 0) {
1482 	    rman_release_resource(res);
1483 	    return (NULL);
1484 	}
1485 
1486     return (res);
1487 }
1488 
1489 static int
acpi_is_resource_managed(int type,struct resource * r)1490 acpi_is_resource_managed(int type, struct resource *r)
1491 {
1492 
1493     /* We only handle memory and IO resources through rman. */
1494     switch (type) {
1495     case SYS_RES_IOPORT:
1496 	return (rman_is_region_manager(r, &acpi_rman_io));
1497     case SYS_RES_MEMORY:
1498 	return (rman_is_region_manager(r, &acpi_rman_mem));
1499     }
1500     return (0);
1501 }
1502 
1503 static int
acpi_adjust_resource(device_t bus,device_t child,int type,struct resource * r,rman_res_t start,rman_res_t end)1504 acpi_adjust_resource(device_t bus, device_t child, int type, struct resource *r,
1505     rman_res_t start, rman_res_t end)
1506 {
1507 
1508     if (acpi_is_resource_managed(type, r))
1509 	return (rman_adjust_resource(r, start, end));
1510     return (bus_generic_adjust_resource(bus, child, type, r, start, end));
1511 }
1512 
1513 static int
acpi_release_resource(device_t bus,device_t child,int type,int rid,struct resource * r)1514 acpi_release_resource(device_t bus, device_t child, int type, int rid,
1515     struct resource *r)
1516 {
1517     int ret;
1518 
1519     /*
1520      * If this resource belongs to one of our internal managers,
1521      * deactivate it and release it to the local pool.
1522      */
1523     if (acpi_is_resource_managed(type, r)) {
1524 	if (rman_get_flags(r) & RF_ACTIVE) {
1525 	    ret = bus_deactivate_resource(child, type, rid, r);
1526 	    if (ret != 0)
1527 		return (ret);
1528 	}
1529 	return (rman_release_resource(r));
1530     }
1531 
1532     return (bus_generic_rl_release_resource(bus, child, type, rid, r));
1533 }
1534 
1535 static void
acpi_delete_resource(device_t bus,device_t child,int type,int rid)1536 acpi_delete_resource(device_t bus, device_t child, int type, int rid)
1537 {
1538     struct resource_list *rl;
1539 
1540     rl = acpi_get_rlist(bus, child);
1541     if (resource_list_busy(rl, type, rid)) {
1542 	device_printf(bus, "delete_resource: Resource still owned by child"
1543 	    " (type=%d, rid=%d)\n", type, rid);
1544 	return;
1545     }
1546     resource_list_unreserve(rl, bus, child, type, rid);
1547     resource_list_delete(rl, type, rid);
1548 }
1549 
1550 /* Allocate an IO port or memory resource, given its GAS. */
1551 int
acpi_bus_alloc_gas(device_t dev,int * type,int * rid,ACPI_GENERIC_ADDRESS * gas,struct resource ** res,u_int flags)1552 acpi_bus_alloc_gas(device_t dev, int *type, int *rid, ACPI_GENERIC_ADDRESS *gas,
1553     struct resource **res, u_int flags)
1554 {
1555     int error, res_type;
1556 
1557     error = ENOMEM;
1558     if (type == NULL || rid == NULL || gas == NULL || res == NULL)
1559 	return (EINVAL);
1560 
1561     /* We only support memory and IO spaces. */
1562     switch (gas->SpaceId) {
1563     case ACPI_ADR_SPACE_SYSTEM_MEMORY:
1564 	res_type = SYS_RES_MEMORY;
1565 	break;
1566     case ACPI_ADR_SPACE_SYSTEM_IO:
1567 	res_type = SYS_RES_IOPORT;
1568 	break;
1569     default:
1570 	return (EOPNOTSUPP);
1571     }
1572 
1573     /*
1574      * If the register width is less than 8, assume the BIOS author means
1575      * it is a bit field and just allocate a byte.
1576      */
1577     if (gas->BitWidth && gas->BitWidth < 8)
1578 	gas->BitWidth = 8;
1579 
1580     /* Validate the address after we're sure we support the space. */
1581     if (gas->Address == 0 || gas->BitWidth == 0)
1582 	return (EINVAL);
1583 
1584     bus_set_resource(dev, res_type, *rid, gas->Address,
1585 	gas->BitWidth / 8);
1586     *res = bus_alloc_resource_any(dev, res_type, rid, RF_ACTIVE | flags);
1587     if (*res != NULL) {
1588 	*type = res_type;
1589 	error = 0;
1590     } else
1591 	bus_delete_resource(dev, res_type, *rid);
1592 
1593     return (error);
1594 }
1595 
1596 /* Probe _HID and _CID for compatible ISA PNP ids. */
1597 static uint32_t
acpi_isa_get_logicalid(device_t dev)1598 acpi_isa_get_logicalid(device_t dev)
1599 {
1600     ACPI_DEVICE_INFO	*devinfo;
1601     ACPI_HANDLE		h;
1602     uint32_t		pnpid;
1603 
1604     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1605 
1606     /* Fetch and validate the HID. */
1607     if ((h = acpi_get_handle(dev)) == NULL ||
1608 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1609 	return_VALUE (0);
1610 
1611     pnpid = (devinfo->Valid & ACPI_VALID_HID) != 0 &&
1612 	devinfo->HardwareId.Length >= ACPI_EISAID_STRING_SIZE ?
1613 	PNP_EISAID(devinfo->HardwareId.String) : 0;
1614     AcpiOsFree(devinfo);
1615 
1616     return_VALUE (pnpid);
1617 }
1618 
1619 static int
acpi_isa_get_compatid(device_t dev,uint32_t * cids,int count)1620 acpi_isa_get_compatid(device_t dev, uint32_t *cids, int count)
1621 {
1622     ACPI_DEVICE_INFO	*devinfo;
1623     ACPI_PNP_DEVICE_ID	*ids;
1624     ACPI_HANDLE		h;
1625     uint32_t		*pnpid;
1626     int			i, valid;
1627 
1628     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1629 
1630     pnpid = cids;
1631 
1632     /* Fetch and validate the CID */
1633     if ((h = acpi_get_handle(dev)) == NULL ||
1634 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
1635 	return_VALUE (0);
1636 
1637     if ((devinfo->Valid & ACPI_VALID_CID) == 0) {
1638 	AcpiOsFree(devinfo);
1639 	return_VALUE (0);
1640     }
1641 
1642     if (devinfo->CompatibleIdList.Count < count)
1643 	count = devinfo->CompatibleIdList.Count;
1644     ids = devinfo->CompatibleIdList.Ids;
1645     for (i = 0, valid = 0; i < count; i++)
1646 	if (ids[i].Length >= ACPI_EISAID_STRING_SIZE &&
1647 	    strncmp(ids[i].String, "PNP", 3) == 0) {
1648 	    *pnpid++ = PNP_EISAID(ids[i].String);
1649 	    valid++;
1650 	}
1651     AcpiOsFree(devinfo);
1652 
1653     return_VALUE (valid);
1654 }
1655 
1656 static char *
acpi_device_id_probe(device_t bus,device_t dev,char ** ids)1657 acpi_device_id_probe(device_t bus, device_t dev, char **ids)
1658 {
1659     ACPI_HANDLE h;
1660     ACPI_OBJECT_TYPE t;
1661     int i;
1662 
1663     h = acpi_get_handle(dev);
1664     if (ids == NULL || h == NULL)
1665 	return (NULL);
1666     t = acpi_get_type(dev);
1667     if (t != ACPI_TYPE_DEVICE && t != ACPI_TYPE_PROCESSOR)
1668 	return (NULL);
1669 
1670     /* Try to match one of the array of IDs with a HID or CID. */
1671     for (i = 0; ids[i] != NULL; i++) {
1672 	if (acpi_MatchHid(h, ids[i]))
1673 	    return (ids[i]);
1674     }
1675     return (NULL);
1676 }
1677 
1678 static ACPI_STATUS
acpi_device_eval_obj(device_t bus,device_t dev,ACPI_STRING pathname,ACPI_OBJECT_LIST * parameters,ACPI_BUFFER * ret)1679 acpi_device_eval_obj(device_t bus, device_t dev, ACPI_STRING pathname,
1680     ACPI_OBJECT_LIST *parameters, ACPI_BUFFER *ret)
1681 {
1682     ACPI_HANDLE h;
1683 
1684     if (dev == NULL)
1685 	h = ACPI_ROOT_OBJECT;
1686     else if ((h = acpi_get_handle(dev)) == NULL)
1687 	return (AE_BAD_PARAMETER);
1688     return (AcpiEvaluateObject(h, pathname, parameters, ret));
1689 }
1690 
1691 int
acpi_device_pwr_for_sleep(device_t bus,device_t dev,int * dstate)1692 acpi_device_pwr_for_sleep(device_t bus, device_t dev, int *dstate)
1693 {
1694     struct acpi_softc *sc;
1695     ACPI_HANDLE handle;
1696     ACPI_STATUS status;
1697     char sxd[8];
1698 
1699     handle = acpi_get_handle(dev);
1700 
1701     /*
1702      * XXX If we find these devices, don't try to power them down.
1703      * The serial and IRDA ports on my T23 hang the system when
1704      * set to D3 and it appears that such legacy devices may
1705      * need special handling in their drivers.
1706      */
1707     if (dstate == NULL || handle == NULL ||
1708 	acpi_MatchHid(handle, "PNP0500") ||
1709 	acpi_MatchHid(handle, "PNP0501") ||
1710 	acpi_MatchHid(handle, "PNP0502") ||
1711 	acpi_MatchHid(handle, "PNP0510") ||
1712 	acpi_MatchHid(handle, "PNP0511"))
1713 	return (ENXIO);
1714 
1715     /*
1716      * Override next state with the value from _SxD, if present.
1717      * Note illegal _S0D is evaluated because some systems expect this.
1718      */
1719     sc = device_get_softc(bus);
1720     snprintf(sxd, sizeof(sxd), "_S%dD", sc->acpi_sstate);
1721     status = acpi_GetInteger(handle, sxd, dstate);
1722     if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
1723 	    device_printf(dev, "failed to get %s on %s: %s\n", sxd,
1724 		acpi_name(handle), AcpiFormatException(status));
1725 	    return (ENXIO);
1726     }
1727 
1728     return (0);
1729 }
1730 
1731 /* Callback arg for our implementation of walking the namespace. */
1732 struct acpi_device_scan_ctx {
1733     acpi_scan_cb_t	user_fn;
1734     void		*arg;
1735     ACPI_HANDLE		parent;
1736 };
1737 
1738 static ACPI_STATUS
acpi_device_scan_cb(ACPI_HANDLE h,UINT32 level,void * arg,void ** retval)1739 acpi_device_scan_cb(ACPI_HANDLE h, UINT32 level, void *arg, void **retval)
1740 {
1741     struct acpi_device_scan_ctx *ctx;
1742     device_t dev, old_dev;
1743     ACPI_STATUS status;
1744     ACPI_OBJECT_TYPE type;
1745 
1746     /*
1747      * Skip this device if we think we'll have trouble with it or it is
1748      * the parent where the scan began.
1749      */
1750     ctx = (struct acpi_device_scan_ctx *)arg;
1751     if (acpi_avoid(h) || h == ctx->parent)
1752 	return (AE_OK);
1753 
1754     /* If this is not a valid device type (e.g., a method), skip it. */
1755     if (ACPI_FAILURE(AcpiGetType(h, &type)))
1756 	return (AE_OK);
1757     if (type != ACPI_TYPE_DEVICE && type != ACPI_TYPE_PROCESSOR &&
1758 	type != ACPI_TYPE_THERMAL && type != ACPI_TYPE_POWER)
1759 	return (AE_OK);
1760 
1761     /*
1762      * Call the user function with the current device.  If it is unchanged
1763      * afterwards, return.  Otherwise, we update the handle to the new dev.
1764      */
1765     old_dev = acpi_get_device(h);
1766     dev = old_dev;
1767     status = ctx->user_fn(h, &dev, level, ctx->arg);
1768     if (ACPI_FAILURE(status) || old_dev == dev)
1769 	return (status);
1770 
1771     /* Remove the old child and its connection to the handle. */
1772     if (old_dev != NULL) {
1773 	device_delete_child(device_get_parent(old_dev), old_dev);
1774 	AcpiDetachData(h, acpi_fake_objhandler);
1775     }
1776 
1777     /* Recreate the handle association if the user created a device. */
1778     if (dev != NULL)
1779 	AcpiAttachData(h, acpi_fake_objhandler, dev);
1780 
1781     return (AE_OK);
1782 }
1783 
1784 static ACPI_STATUS
acpi_device_scan_children(device_t bus,device_t dev,int max_depth,acpi_scan_cb_t user_fn,void * arg)1785 acpi_device_scan_children(device_t bus, device_t dev, int max_depth,
1786     acpi_scan_cb_t user_fn, void *arg)
1787 {
1788     ACPI_HANDLE h;
1789     struct acpi_device_scan_ctx ctx;
1790 
1791     if (acpi_disabled("children"))
1792 	return (AE_OK);
1793 
1794     if (dev == NULL)
1795 	h = ACPI_ROOT_OBJECT;
1796     else if ((h = acpi_get_handle(dev)) == NULL)
1797 	return (AE_BAD_PARAMETER);
1798     ctx.user_fn = user_fn;
1799     ctx.arg = arg;
1800     ctx.parent = h;
1801     return (AcpiWalkNamespace(ACPI_TYPE_ANY, h, max_depth,
1802 	acpi_device_scan_cb, NULL, &ctx, NULL));
1803 }
1804 
1805 /*
1806  * Even though ACPI devices are not PCI, we use the PCI approach for setting
1807  * device power states since it's close enough to ACPI.
1808  */
1809 static int
acpi_set_powerstate(device_t child,int state)1810 acpi_set_powerstate(device_t child, int state)
1811 {
1812     ACPI_HANDLE h;
1813     ACPI_STATUS status;
1814 
1815     h = acpi_get_handle(child);
1816     if (state < ACPI_STATE_D0 || state > ACPI_D_STATES_MAX)
1817 	return (EINVAL);
1818     if (h == NULL)
1819 	return (0);
1820 
1821     /* Ignore errors if the power methods aren't present. */
1822     status = acpi_pwr_switch_consumer(h, state);
1823     if (ACPI_SUCCESS(status)) {
1824 	if (bootverbose)
1825 	    device_printf(child, "set ACPI power state D%d on %s\n",
1826 		state, acpi_name(h));
1827     } else if (status != AE_NOT_FOUND)
1828 	device_printf(child,
1829 	    "failed to set ACPI power state D%d on %s: %s\n", state,
1830 	    acpi_name(h), AcpiFormatException(status));
1831 
1832     return (0);
1833 }
1834 
1835 static int
acpi_isa_pnp_probe(device_t bus,device_t child,struct isa_pnp_id * ids)1836 acpi_isa_pnp_probe(device_t bus, device_t child, struct isa_pnp_id *ids)
1837 {
1838     int			result, cid_count, i;
1839     uint32_t		lid, cids[8];
1840 
1841     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1842 
1843     /*
1844      * ISA-style drivers attached to ACPI may persist and
1845      * probe manually if we return ENOENT.  We never want
1846      * that to happen, so don't ever return it.
1847      */
1848     result = ENXIO;
1849 
1850     /* Scan the supplied IDs for a match */
1851     lid = acpi_isa_get_logicalid(child);
1852     cid_count = acpi_isa_get_compatid(child, cids, 8);
1853     while (ids && ids->ip_id) {
1854 	if (lid == ids->ip_id) {
1855 	    result = 0;
1856 	    goto out;
1857 	}
1858 	for (i = 0; i < cid_count; i++) {
1859 	    if (cids[i] == ids->ip_id) {
1860 		result = 0;
1861 		goto out;
1862 	    }
1863 	}
1864 	ids++;
1865     }
1866 
1867  out:
1868     if (result == 0 && ids->ip_desc)
1869 	device_set_desc(child, ids->ip_desc);
1870 
1871     return_VALUE (result);
1872 }
1873 
1874 /*
1875  * Look for a MCFG table.  If it is present, use the settings for
1876  * domain (segment) 0 to setup PCI config space access via the memory
1877  * map.
1878  *
1879  * On non-x86 architectures (arm64 for now), this will be done from the
1880  * PCI host bridge driver.
1881  */
1882 static void
acpi_enable_pcie(void)1883 acpi_enable_pcie(void)
1884 {
1885 #if defined(__i386__) || defined(__amd64__)
1886 	ACPI_TABLE_HEADER *hdr;
1887 	ACPI_MCFG_ALLOCATION *alloc, *end;
1888 	ACPI_STATUS status;
1889 
1890 	status = AcpiGetTable(ACPI_SIG_MCFG, 1, &hdr);
1891 	if (ACPI_FAILURE(status))
1892 		return;
1893 
1894 	end = (ACPI_MCFG_ALLOCATION *)((char *)hdr + hdr->Length);
1895 	alloc = (ACPI_MCFG_ALLOCATION *)((ACPI_TABLE_MCFG *)hdr + 1);
1896 	while (alloc < end) {
1897 		if (alloc->PciSegment == 0) {
1898 			pcie_cfgregopen(alloc->Address, alloc->StartBusNumber,
1899 			    alloc->EndBusNumber);
1900 			return;
1901 		}
1902 		alloc++;
1903 	}
1904 #endif
1905 }
1906 
1907 /*
1908  * Scan all of the ACPI namespace and attach child devices.
1909  *
1910  * We should only expect to find devices in the \_PR, \_TZ, \_SI, and
1911  * \_SB scopes, and \_PR and \_TZ became obsolete in the ACPI 2.0 spec.
1912  * However, in violation of the spec, some systems place their PCI link
1913  * devices in \, so we have to walk the whole namespace.  We check the
1914  * type of namespace nodes, so this should be ok.
1915  */
1916 static void
acpi_probe_children(device_t bus)1917 acpi_probe_children(device_t bus)
1918 {
1919 
1920     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
1921 
1922     /*
1923      * Scan the namespace and insert placeholders for all the devices that
1924      * we find.  We also probe/attach any early devices.
1925      *
1926      * Note that we use AcpiWalkNamespace rather than AcpiGetDevices because
1927      * we want to create nodes for all devices, not just those that are
1928      * currently present. (This assumes that we don't want to create/remove
1929      * devices as they appear, which might be smarter.)
1930      */
1931     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "namespace scan\n"));
1932     AcpiWalkNamespace(ACPI_TYPE_ANY, ACPI_ROOT_OBJECT, 100, acpi_probe_child,
1933 	NULL, bus, NULL);
1934 
1935     /* Pre-allocate resources for our rman from any sysresource devices. */
1936     acpi_sysres_alloc(bus);
1937 
1938     /* Reserve resources already allocated to children. */
1939     acpi_reserve_resources(bus);
1940 
1941     /* Create any static children by calling device identify methods. */
1942     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "device identify routines\n"));
1943     bus_generic_probe(bus);
1944 
1945     /* Probe/attach all children, created statically and from the namespace. */
1946     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "acpi bus_generic_attach\n"));
1947     bus_generic_attach(bus);
1948 
1949     /* Attach wake sysctls. */
1950     acpi_wake_sysctl_walk(bus);
1951 
1952     ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "done attaching children\n"));
1953     return_VOID;
1954 }
1955 
1956 /*
1957  * Determine the probe order for a given device.
1958  */
1959 static void
acpi_probe_order(ACPI_HANDLE handle,int * order)1960 acpi_probe_order(ACPI_HANDLE handle, int *order)
1961 {
1962 	ACPI_OBJECT_TYPE type;
1963 
1964 	/*
1965 	 * 0. CPUs
1966 	 * 1. I/O port and memory system resource holders
1967 	 * 2. Clocks and timers (to handle early accesses)
1968 	 * 3. Embedded controllers (to handle early accesses)
1969 	 * 4. PCI Link Devices
1970 	 */
1971 	AcpiGetType(handle, &type);
1972 	if (type == ACPI_TYPE_PROCESSOR)
1973 		*order = 0;
1974 	else if (acpi_MatchHid(handle, "PNP0C01") ||
1975 	    acpi_MatchHid(handle, "PNP0C02"))
1976 		*order = 1;
1977 	else if (acpi_MatchHid(handle, "PNP0100") ||
1978 	    acpi_MatchHid(handle, "PNP0103") ||
1979 	    acpi_MatchHid(handle, "PNP0B00"))
1980 		*order = 2;
1981 	else if (acpi_MatchHid(handle, "PNP0C09"))
1982 		*order = 3;
1983 	else if (acpi_MatchHid(handle, "PNP0C0F"))
1984 		*order = 4;
1985 }
1986 
1987 /*
1988  * Evaluate a child device and determine whether we might attach a device to
1989  * it.
1990  */
1991 static ACPI_STATUS
acpi_probe_child(ACPI_HANDLE handle,UINT32 level,void * context,void ** status)1992 acpi_probe_child(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
1993 {
1994     ACPI_DEVICE_INFO *devinfo;
1995     struct acpi_device	*ad;
1996     struct acpi_prw_data prw;
1997     ACPI_OBJECT_TYPE type;
1998     ACPI_HANDLE h;
1999     device_t bus, child;
2000     char *handle_str;
2001     int order;
2002 
2003     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
2004 
2005     if (acpi_disabled("children"))
2006 	return_ACPI_STATUS (AE_OK);
2007 
2008     /* Skip this device if we think we'll have trouble with it. */
2009     if (acpi_avoid(handle))
2010 	return_ACPI_STATUS (AE_OK);
2011 
2012     bus = (device_t)context;
2013     if (ACPI_SUCCESS(AcpiGetType(handle, &type))) {
2014 	handle_str = acpi_name(handle);
2015 	switch (type) {
2016 	case ACPI_TYPE_DEVICE:
2017 	    /*
2018 	     * Since we scan from \, be sure to skip system scope objects.
2019 	     * \_SB_ and \_TZ_ are defined in ACPICA as devices to work around
2020 	     * BIOS bugs.  For example, \_SB_ is to allow \_SB_._INI to be run
2021 	     * during the initialization and \_TZ_ is to support Notify() on it.
2022 	     */
2023 	    if (strcmp(handle_str, "\\_SB_") == 0 ||
2024 		strcmp(handle_str, "\\_TZ_") == 0)
2025 		break;
2026 	    if (acpi_parse_prw(handle, &prw) == 0)
2027 		AcpiSetupGpeForWake(handle, prw.gpe_handle, prw.gpe_bit);
2028 
2029 	    /*
2030 	     * Ignore devices that do not have a _HID or _CID.  They should
2031 	     * be discovered by other buses (e.g. the PCI bus driver).
2032 	     */
2033 	    if (!acpi_has_hid(handle))
2034 		break;
2035 	    /* FALLTHROUGH */
2036 	case ACPI_TYPE_PROCESSOR:
2037 	case ACPI_TYPE_THERMAL:
2038 	case ACPI_TYPE_POWER:
2039 	    /*
2040 	     * Create a placeholder device for this node.  Sort the
2041 	     * placeholder so that the probe/attach passes will run
2042 	     * breadth-first.  Orders less than ACPI_DEV_BASE_ORDER
2043 	     * are reserved for special objects (i.e., system
2044 	     * resources).
2045 	     */
2046 	    ACPI_DEBUG_PRINT((ACPI_DB_OBJECTS, "scanning '%s'\n", handle_str));
2047 	    order = level * 10 + ACPI_DEV_BASE_ORDER;
2048 	    acpi_probe_order(handle, &order);
2049 	    child = BUS_ADD_CHILD(bus, order, NULL, -1);
2050 	    if (child == NULL)
2051 		break;
2052 
2053 	    /* Associate the handle with the device_t and vice versa. */
2054 	    acpi_set_handle(child, handle);
2055 	    AcpiAttachData(handle, acpi_fake_objhandler, child);
2056 
2057 	    /*
2058 	     * Check that the device is present.  If it's not present,
2059 	     * leave it disabled (so that we have a device_t attached to
2060 	     * the handle, but we don't probe it).
2061 	     *
2062 	     * XXX PCI link devices sometimes report "present" but not
2063 	     * "functional" (i.e. if disabled).  Go ahead and probe them
2064 	     * anyway since we may enable them later.
2065 	     */
2066 	    if (type == ACPI_TYPE_DEVICE && !acpi_DeviceIsPresent(child)) {
2067 		/* Never disable PCI link devices. */
2068 		if (acpi_MatchHid(handle, "PNP0C0F"))
2069 		    break;
2070 		/*
2071 		 * Docking stations should remain enabled since the system
2072 		 * may be undocked at boot.
2073 		 */
2074 		if (ACPI_SUCCESS(AcpiGetHandle(handle, "_DCK", &h)))
2075 		    break;
2076 
2077 		device_disable(child);
2078 		break;
2079 	    }
2080 
2081 	    /*
2082 	     * Get the device's resource settings and attach them.
2083 	     * Note that if the device has _PRS but no _CRS, we need
2084 	     * to decide when it's appropriate to try to configure the
2085 	     * device.  Ignore the return value here; it's OK for the
2086 	     * device not to have any resources.
2087 	     */
2088 	    acpi_parse_resources(child, handle, &acpi_res_parse_set, NULL);
2089 
2090 	    ad = device_get_ivars(child);
2091 	    ad->ad_cls_class = 0xffffff;
2092 	    if (ACPI_SUCCESS(AcpiGetObjectInfo(handle, &devinfo))) {
2093 		if ((devinfo->Valid & ACPI_VALID_CLS) != 0 &&
2094 		    devinfo->ClassCode.Length >= ACPI_PCICLS_STRING_SIZE) {
2095 		    ad->ad_cls_class = strtoul(devinfo->ClassCode.String,
2096 			NULL, 16);
2097 		}
2098 		AcpiOsFree(devinfo);
2099 	    }
2100 	    break;
2101 	}
2102     }
2103 
2104     return_ACPI_STATUS (AE_OK);
2105 }
2106 
2107 /*
2108  * AcpiAttachData() requires an object handler but never uses it.  This is a
2109  * placeholder object handler so we can store a device_t in an ACPI_HANDLE.
2110  */
2111 void
acpi_fake_objhandler(ACPI_HANDLE h,void * data)2112 acpi_fake_objhandler(ACPI_HANDLE h, void *data)
2113 {
2114 }
2115 
2116 static void
acpi_shutdown_final(void * arg,int howto)2117 acpi_shutdown_final(void *arg, int howto)
2118 {
2119     struct acpi_softc *sc = (struct acpi_softc *)arg;
2120     register_t intr;
2121     ACPI_STATUS status;
2122 
2123     /*
2124      * XXX Shutdown code should only run on the BSP (cpuid 0).
2125      * Some chipsets do not power off the system correctly if called from
2126      * an AP.
2127      */
2128     if ((howto & RB_POWEROFF) != 0) {
2129 	status = AcpiEnterSleepStatePrep(ACPI_STATE_S5);
2130 	if (ACPI_FAILURE(status)) {
2131 	    device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
2132 		AcpiFormatException(status));
2133 	    return;
2134 	}
2135 	device_printf(sc->acpi_dev, "Powering system off\n");
2136 	intr = intr_disable();
2137 	status = AcpiEnterSleepState(ACPI_STATE_S5);
2138 	if (ACPI_FAILURE(status)) {
2139 	    intr_restore(intr);
2140 	    device_printf(sc->acpi_dev, "power-off failed - %s\n",
2141 		AcpiFormatException(status));
2142 	} else {
2143 	    DELAY(1000000);
2144 	    intr_restore(intr);
2145 	    device_printf(sc->acpi_dev, "power-off failed - timeout\n");
2146 	}
2147     } else if ((howto & RB_HALT) == 0 && sc->acpi_handle_reboot) {
2148 	/* Reboot using the reset register. */
2149 	status = AcpiReset();
2150 	if (ACPI_SUCCESS(status)) {
2151 	    DELAY(1000000);
2152 	    device_printf(sc->acpi_dev, "reset failed - timeout\n");
2153 	} else if (status != AE_NOT_EXIST)
2154 	    device_printf(sc->acpi_dev, "reset failed - %s\n",
2155 		AcpiFormatException(status));
2156     } else if (sc->acpi_do_disable && panicstr == NULL) {
2157 	/*
2158 	 * Only disable ACPI if the user requested.  On some systems, writing
2159 	 * the disable value to SMI_CMD hangs the system.
2160 	 */
2161 	device_printf(sc->acpi_dev, "Shutting down\n");
2162 	AcpiTerminate();
2163     }
2164 }
2165 
2166 static void
acpi_enable_fixed_events(struct acpi_softc * sc)2167 acpi_enable_fixed_events(struct acpi_softc *sc)
2168 {
2169     static int	first_time = 1;
2170 
2171     /* Enable and clear fixed events and install handlers. */
2172     if ((AcpiGbl_FADT.Flags & ACPI_FADT_POWER_BUTTON) == 0) {
2173 	AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
2174 	AcpiInstallFixedEventHandler(ACPI_EVENT_POWER_BUTTON,
2175 				     acpi_event_power_button_sleep, sc);
2176 	if (first_time)
2177 	    device_printf(sc->acpi_dev, "Power Button (fixed)\n");
2178     }
2179     if ((AcpiGbl_FADT.Flags & ACPI_FADT_SLEEP_BUTTON) == 0) {
2180 	AcpiClearEvent(ACPI_EVENT_SLEEP_BUTTON);
2181 	AcpiInstallFixedEventHandler(ACPI_EVENT_SLEEP_BUTTON,
2182 				     acpi_event_sleep_button_sleep, sc);
2183 	if (first_time)
2184 	    device_printf(sc->acpi_dev, "Sleep Button (fixed)\n");
2185     }
2186 
2187     first_time = 0;
2188 }
2189 
2190 /*
2191  * Returns true if the device is actually present and should
2192  * be attached to.  This requires the present, enabled, UI-visible
2193  * and diagnostics-passed bits to be set.
2194  */
2195 BOOLEAN
acpi_DeviceIsPresent(device_t dev)2196 acpi_DeviceIsPresent(device_t dev)
2197 {
2198 	ACPI_HANDLE h;
2199 	UINT32 s;
2200 	ACPI_STATUS status;
2201 
2202 	h = acpi_get_handle(dev);
2203 	if (h == NULL)
2204 		return (FALSE);
2205 	/*
2206 	 * Onboard serial ports on certain AMD motherboards have an invalid _STA
2207 	 * method that always returns 0.  Force them to always be treated as present.
2208 	 *
2209 	 * This may solely be a quirk of a preproduction BIOS.
2210 	 */
2211 	if (acpi_MatchHid(h, "AMDI0020") || acpi_MatchHid(h, "AMDI0010"))
2212 		return (TRUE);
2213 
2214 	status = acpi_GetInteger(h, "_STA", &s);
2215 
2216 	/*
2217 	 * If no _STA method or if it failed, then assume that
2218 	 * the device is present.
2219 	 */
2220 	if (ACPI_FAILURE(status))
2221 		return (TRUE);
2222 
2223 	return (ACPI_DEVICE_PRESENT(s) ? TRUE : FALSE);
2224 }
2225 
2226 /*
2227  * Returns true if the battery is actually present and inserted.
2228  */
2229 BOOLEAN
acpi_BatteryIsPresent(device_t dev)2230 acpi_BatteryIsPresent(device_t dev)
2231 {
2232 	ACPI_HANDLE h;
2233 	UINT32 s;
2234 	ACPI_STATUS status;
2235 
2236 	h = acpi_get_handle(dev);
2237 	if (h == NULL)
2238 		return (FALSE);
2239 	status = acpi_GetInteger(h, "_STA", &s);
2240 
2241 	/*
2242 	 * If no _STA method or if it failed, then assume that
2243 	 * the device is present.
2244 	 */
2245 	if (ACPI_FAILURE(status))
2246 		return (TRUE);
2247 
2248 	return (ACPI_BATTERY_PRESENT(s) ? TRUE : FALSE);
2249 }
2250 
2251 /*
2252  * Returns true if a device has at least one valid device ID.
2253  */
2254 static BOOLEAN
acpi_has_hid(ACPI_HANDLE h)2255 acpi_has_hid(ACPI_HANDLE h)
2256 {
2257     ACPI_DEVICE_INFO	*devinfo;
2258     BOOLEAN		ret;
2259 
2260     if (h == NULL ||
2261 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2262 	return (FALSE);
2263 
2264     ret = FALSE;
2265     if ((devinfo->Valid & ACPI_VALID_HID) != 0)
2266 	ret = TRUE;
2267     else if ((devinfo->Valid & ACPI_VALID_CID) != 0)
2268 	if (devinfo->CompatibleIdList.Count > 0)
2269 	    ret = TRUE;
2270 
2271     AcpiOsFree(devinfo);
2272     return (ret);
2273 }
2274 
2275 /*
2276  * Match a HID string against a handle
2277  */
2278 BOOLEAN
acpi_MatchHid(ACPI_HANDLE h,const char * hid)2279 acpi_MatchHid(ACPI_HANDLE h, const char *hid)
2280 {
2281     ACPI_DEVICE_INFO	*devinfo;
2282     BOOLEAN		ret;
2283     int			i;
2284 
2285     if (hid == NULL || h == NULL ||
2286 	ACPI_FAILURE(AcpiGetObjectInfo(h, &devinfo)))
2287 	return (FALSE);
2288 
2289     ret = FALSE;
2290     if ((devinfo->Valid & ACPI_VALID_HID) != 0 &&
2291 	strcmp(hid, devinfo->HardwareId.String) == 0)
2292 	    ret = TRUE;
2293     else if ((devinfo->Valid & ACPI_VALID_CID) != 0)
2294 	for (i = 0; i < devinfo->CompatibleIdList.Count; i++) {
2295 	    if (strcmp(hid, devinfo->CompatibleIdList.Ids[i].String) == 0) {
2296 		ret = TRUE;
2297 		break;
2298 	    }
2299 	}
2300 
2301     AcpiOsFree(devinfo);
2302     return (ret);
2303 }
2304 
2305 /*
2306  * Return the handle of a named object within our scope, ie. that of (parent)
2307  * or one if its parents.
2308  */
2309 ACPI_STATUS
acpi_GetHandleInScope(ACPI_HANDLE parent,char * path,ACPI_HANDLE * result)2310 acpi_GetHandleInScope(ACPI_HANDLE parent, char *path, ACPI_HANDLE *result)
2311 {
2312     ACPI_HANDLE		r;
2313     ACPI_STATUS		status;
2314 
2315     /* Walk back up the tree to the root */
2316     for (;;) {
2317 	status = AcpiGetHandle(parent, path, &r);
2318 	if (ACPI_SUCCESS(status)) {
2319 	    *result = r;
2320 	    return (AE_OK);
2321 	}
2322 	/* XXX Return error here? */
2323 	if (status != AE_NOT_FOUND)
2324 	    return (AE_OK);
2325 	if (ACPI_FAILURE(AcpiGetParent(parent, &r)))
2326 	    return (AE_NOT_FOUND);
2327 	parent = r;
2328     }
2329 }
2330 
2331 /*
2332  * Allocate a buffer with a preset data size.
2333  */
2334 ACPI_BUFFER *
acpi_AllocBuffer(int size)2335 acpi_AllocBuffer(int size)
2336 {
2337     ACPI_BUFFER	*buf;
2338 
2339     if ((buf = malloc(size + sizeof(*buf), M_ACPIDEV, M_NOWAIT)) == NULL)
2340 	return (NULL);
2341     buf->Length = size;
2342     buf->Pointer = (void *)(buf + 1);
2343     return (buf);
2344 }
2345 
2346 ACPI_STATUS
acpi_SetInteger(ACPI_HANDLE handle,char * path,UINT32 number)2347 acpi_SetInteger(ACPI_HANDLE handle, char *path, UINT32 number)
2348 {
2349     ACPI_OBJECT arg1;
2350     ACPI_OBJECT_LIST args;
2351 
2352     arg1.Type = ACPI_TYPE_INTEGER;
2353     arg1.Integer.Value = number;
2354     args.Count = 1;
2355     args.Pointer = &arg1;
2356 
2357     return (AcpiEvaluateObject(handle, path, &args, NULL));
2358 }
2359 
2360 /*
2361  * Evaluate a path that should return an integer.
2362  */
2363 ACPI_STATUS
acpi_GetInteger(ACPI_HANDLE handle,char * path,UINT32 * number)2364 acpi_GetInteger(ACPI_HANDLE handle, char *path, UINT32 *number)
2365 {
2366     ACPI_STATUS	status;
2367     ACPI_BUFFER	buf;
2368     ACPI_OBJECT	param;
2369 
2370     if (handle == NULL)
2371 	handle = ACPI_ROOT_OBJECT;
2372 
2373     /*
2374      * Assume that what we've been pointed at is an Integer object, or
2375      * a method that will return an Integer.
2376      */
2377     buf.Pointer = &param;
2378     buf.Length = sizeof(param);
2379     status = AcpiEvaluateObject(handle, path, NULL, &buf);
2380     if (ACPI_SUCCESS(status)) {
2381 	if (param.Type == ACPI_TYPE_INTEGER)
2382 	    *number = param.Integer.Value;
2383 	else
2384 	    status = AE_TYPE;
2385     }
2386 
2387     /*
2388      * In some applications, a method that's expected to return an Integer
2389      * may instead return a Buffer (probably to simplify some internal
2390      * arithmetic).  We'll try to fetch whatever it is, and if it's a Buffer,
2391      * convert it into an Integer as best we can.
2392      *
2393      * This is a hack.
2394      */
2395     if (status == AE_BUFFER_OVERFLOW) {
2396 	if ((buf.Pointer = AcpiOsAllocate(buf.Length)) == NULL) {
2397 	    status = AE_NO_MEMORY;
2398 	} else {
2399 	    status = AcpiEvaluateObject(handle, path, NULL, &buf);
2400 	    if (ACPI_SUCCESS(status))
2401 		status = acpi_ConvertBufferToInteger(&buf, number);
2402 	    AcpiOsFree(buf.Pointer);
2403 	}
2404     }
2405     return (status);
2406 }
2407 
2408 ACPI_STATUS
acpi_ConvertBufferToInteger(ACPI_BUFFER * bufp,UINT32 * number)2409 acpi_ConvertBufferToInteger(ACPI_BUFFER *bufp, UINT32 *number)
2410 {
2411     ACPI_OBJECT	*p;
2412     UINT8	*val;
2413     int		i;
2414 
2415     p = (ACPI_OBJECT *)bufp->Pointer;
2416     if (p->Type == ACPI_TYPE_INTEGER) {
2417 	*number = p->Integer.Value;
2418 	return (AE_OK);
2419     }
2420     if (p->Type != ACPI_TYPE_BUFFER)
2421 	return (AE_TYPE);
2422     if (p->Buffer.Length > sizeof(int))
2423 	return (AE_BAD_DATA);
2424 
2425     *number = 0;
2426     val = p->Buffer.Pointer;
2427     for (i = 0; i < p->Buffer.Length; i++)
2428 	*number += val[i] << (i * 8);
2429     return (AE_OK);
2430 }
2431 
2432 /*
2433  * Iterate over the elements of an a package object, calling the supplied
2434  * function for each element.
2435  *
2436  * XXX possible enhancement might be to abort traversal on error.
2437  */
2438 ACPI_STATUS
acpi_ForeachPackageObject(ACPI_OBJECT * pkg,void (* func)(ACPI_OBJECT * comp,void * arg),void * arg)2439 acpi_ForeachPackageObject(ACPI_OBJECT *pkg,
2440 	void (*func)(ACPI_OBJECT *comp, void *arg), void *arg)
2441 {
2442     ACPI_OBJECT	*comp;
2443     int		i;
2444 
2445     if (pkg == NULL || pkg->Type != ACPI_TYPE_PACKAGE)
2446 	return (AE_BAD_PARAMETER);
2447 
2448     /* Iterate over components */
2449     i = 0;
2450     comp = pkg->Package.Elements;
2451     for (; i < pkg->Package.Count; i++, comp++)
2452 	func(comp, arg);
2453 
2454     return (AE_OK);
2455 }
2456 
2457 /*
2458  * Find the (index)th resource object in a set.
2459  */
2460 ACPI_STATUS
acpi_FindIndexedResource(ACPI_BUFFER * buf,int index,ACPI_RESOURCE ** resp)2461 acpi_FindIndexedResource(ACPI_BUFFER *buf, int index, ACPI_RESOURCE **resp)
2462 {
2463     ACPI_RESOURCE	*rp;
2464     int			i;
2465 
2466     rp = (ACPI_RESOURCE *)buf->Pointer;
2467     i = index;
2468     while (i-- > 0) {
2469 	/* Range check */
2470 	if (rp > (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2471 	    return (AE_BAD_PARAMETER);
2472 
2473 	/* Check for terminator */
2474 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2475 	    return (AE_NOT_FOUND);
2476 	rp = ACPI_NEXT_RESOURCE(rp);
2477     }
2478     if (resp != NULL)
2479 	*resp = rp;
2480 
2481     return (AE_OK);
2482 }
2483 
2484 /*
2485  * Append an ACPI_RESOURCE to an ACPI_BUFFER.
2486  *
2487  * Given a pointer to an ACPI_RESOURCE structure, expand the ACPI_BUFFER
2488  * provided to contain it.  If the ACPI_BUFFER is empty, allocate a sensible
2489  * backing block.  If the ACPI_RESOURCE is NULL, return an empty set of
2490  * resources.
2491  */
2492 #define ACPI_INITIAL_RESOURCE_BUFFER_SIZE	512
2493 
2494 ACPI_STATUS
acpi_AppendBufferResource(ACPI_BUFFER * buf,ACPI_RESOURCE * res)2495 acpi_AppendBufferResource(ACPI_BUFFER *buf, ACPI_RESOURCE *res)
2496 {
2497     ACPI_RESOURCE	*rp;
2498     void		*newp;
2499 
2500     /* Initialise the buffer if necessary. */
2501     if (buf->Pointer == NULL) {
2502 	buf->Length = ACPI_INITIAL_RESOURCE_BUFFER_SIZE;
2503 	if ((buf->Pointer = AcpiOsAllocate(buf->Length)) == NULL)
2504 	    return (AE_NO_MEMORY);
2505 	rp = (ACPI_RESOURCE *)buf->Pointer;
2506 	rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2507 	rp->Length = ACPI_RS_SIZE_MIN;
2508     }
2509     if (res == NULL)
2510 	return (AE_OK);
2511 
2512     /*
2513      * Scan the current buffer looking for the terminator.
2514      * This will either find the terminator or hit the end
2515      * of the buffer and return an error.
2516      */
2517     rp = (ACPI_RESOURCE *)buf->Pointer;
2518     for (;;) {
2519 	/* Range check, don't go outside the buffer */
2520 	if (rp >= (ACPI_RESOURCE *)((u_int8_t *)buf->Pointer + buf->Length))
2521 	    return (AE_BAD_PARAMETER);
2522 	if (rp->Type == ACPI_RESOURCE_TYPE_END_TAG || rp->Length == 0)
2523 	    break;
2524 	rp = ACPI_NEXT_RESOURCE(rp);
2525     }
2526 
2527     /*
2528      * Check the size of the buffer and expand if required.
2529      *
2530      * Required size is:
2531      *	size of existing resources before terminator +
2532      *	size of new resource and header +
2533      * 	size of terminator.
2534      *
2535      * Note that this loop should really only run once, unless
2536      * for some reason we are stuffing a *really* huge resource.
2537      */
2538     while ((((u_int8_t *)rp - (u_int8_t *)buf->Pointer) +
2539 	    res->Length + ACPI_RS_SIZE_NO_DATA +
2540 	    ACPI_RS_SIZE_MIN) >= buf->Length) {
2541 	if ((newp = AcpiOsAllocate(buf->Length * 2)) == NULL)
2542 	    return (AE_NO_MEMORY);
2543 	bcopy(buf->Pointer, newp, buf->Length);
2544 	rp = (ACPI_RESOURCE *)((u_int8_t *)newp +
2545 			       ((u_int8_t *)rp - (u_int8_t *)buf->Pointer));
2546 	AcpiOsFree(buf->Pointer);
2547 	buf->Pointer = newp;
2548 	buf->Length += buf->Length;
2549     }
2550 
2551     /* Insert the new resource. */
2552     bcopy(res, rp, res->Length + ACPI_RS_SIZE_NO_DATA);
2553 
2554     /* And add the terminator. */
2555     rp = ACPI_NEXT_RESOURCE(rp);
2556     rp->Type = ACPI_RESOURCE_TYPE_END_TAG;
2557     rp->Length = ACPI_RS_SIZE_MIN;
2558 
2559     return (AE_OK);
2560 }
2561 
2562 UINT8
acpi_DSMQuery(ACPI_HANDLE h,uint8_t * uuid,int revision)2563 acpi_DSMQuery(ACPI_HANDLE h, uint8_t *uuid, int revision)
2564 {
2565     /*
2566      * ACPI spec 9.1.1 defines this.
2567      *
2568      * "Arg2: Function Index Represents a specific function whose meaning is
2569      * specific to the UUID and Revision ID. Function indices should start
2570      * with 1. Function number zero is a query function (see the special
2571      * return code defined below)."
2572      */
2573     ACPI_BUFFER buf;
2574     ACPI_OBJECT *obj;
2575     UINT8 ret = 0;
2576 
2577     if (!ACPI_SUCCESS(acpi_EvaluateDSM(h, uuid, revision, 0, NULL, &buf))) {
2578 	ACPI_INFO(("Failed to enumerate DSM functions\n"));
2579 	return (0);
2580     }
2581 
2582     obj = (ACPI_OBJECT *)buf.Pointer;
2583     KASSERT(obj, ("Object not allowed to be NULL\n"));
2584 
2585     /*
2586      * From ACPI 6.2 spec 9.1.1:
2587      * If Function Index = 0, a Buffer containing a function index bitfield.
2588      * Otherwise, the return value and type depends on the UUID and revision
2589      * ID (see below).
2590      */
2591     switch (obj->Type) {
2592     case ACPI_TYPE_BUFFER:
2593 	ret = *(uint8_t *)obj->Buffer.Pointer;
2594 	break;
2595     case ACPI_TYPE_INTEGER:
2596 	ACPI_BIOS_WARNING((AE_INFO,
2597 	    "Possibly buggy BIOS with ACPI_TYPE_INTEGER for function enumeration\n"));
2598 	ret = obj->Integer.Value & 0xFF;
2599 	break;
2600     default:
2601 	ACPI_WARNING((AE_INFO, "Unexpected return type %u\n", obj->Type));
2602     };
2603 
2604     AcpiOsFree(obj);
2605     return ret;
2606 }
2607 
2608 /*
2609  * DSM may return multiple types depending on the function. It is therefore
2610  * unsafe to use the typed evaluation. It is highly recommended that the caller
2611  * check the type of the returned object.
2612  */
2613 ACPI_STATUS
acpi_EvaluateDSM(ACPI_HANDLE handle,uint8_t * uuid,int revision,uint64_t function,union acpi_object * package,ACPI_BUFFER * out_buf)2614 acpi_EvaluateDSM(ACPI_HANDLE handle, uint8_t *uuid, int revision,
2615     uint64_t function, union acpi_object *package, ACPI_BUFFER *out_buf)
2616 {
2617     ACPI_OBJECT arg[4];
2618     ACPI_OBJECT_LIST arglist;
2619     ACPI_BUFFER buf;
2620     ACPI_STATUS status;
2621 
2622     if (out_buf == NULL)
2623 	return (AE_NO_MEMORY);
2624 
2625     arg[0].Type = ACPI_TYPE_BUFFER;
2626     arg[0].Buffer.Length = ACPI_UUID_LENGTH;
2627     arg[0].Buffer.Pointer = uuid;
2628     arg[1].Type = ACPI_TYPE_INTEGER;
2629     arg[1].Integer.Value = revision;
2630     arg[2].Type = ACPI_TYPE_INTEGER;
2631     arg[2].Integer.Value = function;
2632     if (package) {
2633 	arg[3] = *package;
2634     } else {
2635 	arg[3].Type = ACPI_TYPE_PACKAGE;
2636 	arg[3].Package.Count = 0;
2637 	arg[3].Package.Elements = NULL;
2638     }
2639 
2640     arglist.Pointer = arg;
2641     arglist.Count = 4;
2642     buf.Pointer = NULL;
2643     buf.Length = ACPI_ALLOCATE_BUFFER;
2644     status = AcpiEvaluateObject(handle, "_DSM", &arglist, &buf);
2645     if (ACPI_FAILURE(status))
2646 	return (status);
2647 
2648     KASSERT(ACPI_SUCCESS(status), ("Unexpected status"));
2649 
2650     *out_buf = buf;
2651     return (status);
2652 }
2653 
2654 ACPI_STATUS
acpi_EvaluateOSC(ACPI_HANDLE handle,uint8_t * uuid,int revision,int count,uint32_t * caps_in,uint32_t * caps_out,bool query)2655 acpi_EvaluateOSC(ACPI_HANDLE handle, uint8_t *uuid, int revision, int count,
2656     uint32_t *caps_in, uint32_t *caps_out, bool query)
2657 {
2658 	ACPI_OBJECT arg[4], *ret;
2659 	ACPI_OBJECT_LIST arglist;
2660 	ACPI_BUFFER buf;
2661 	ACPI_STATUS status;
2662 
2663 	arglist.Pointer = arg;
2664 	arglist.Count = 4;
2665 	arg[0].Type = ACPI_TYPE_BUFFER;
2666 	arg[0].Buffer.Length = ACPI_UUID_LENGTH;
2667 	arg[0].Buffer.Pointer = uuid;
2668 	arg[1].Type = ACPI_TYPE_INTEGER;
2669 	arg[1].Integer.Value = revision;
2670 	arg[2].Type = ACPI_TYPE_INTEGER;
2671 	arg[2].Integer.Value = count;
2672 	arg[3].Type = ACPI_TYPE_BUFFER;
2673 	arg[3].Buffer.Length = count * sizeof(*caps_in);
2674 	arg[3].Buffer.Pointer = (uint8_t *)caps_in;
2675 	caps_in[0] = query ? 1 : 0;
2676 	buf.Pointer = NULL;
2677 	buf.Length = ACPI_ALLOCATE_BUFFER;
2678 	status = AcpiEvaluateObjectTyped(handle, "_OSC", &arglist, &buf,
2679 	    ACPI_TYPE_BUFFER);
2680 	if (ACPI_FAILURE(status))
2681 		return (status);
2682 	if (caps_out != NULL) {
2683 		ret = buf.Pointer;
2684 		if (ret->Buffer.Length != count * sizeof(*caps_out)) {
2685 			AcpiOsFree(buf.Pointer);
2686 			return (AE_BUFFER_OVERFLOW);
2687 		}
2688 		bcopy(ret->Buffer.Pointer, caps_out, ret->Buffer.Length);
2689 	}
2690 	AcpiOsFree(buf.Pointer);
2691 	return (status);
2692 }
2693 
2694 /*
2695  * Set interrupt model.
2696  */
2697 ACPI_STATUS
acpi_SetIntrModel(int model)2698 acpi_SetIntrModel(int model)
2699 {
2700 
2701     return (acpi_SetInteger(ACPI_ROOT_OBJECT, "_PIC", model));
2702 }
2703 
2704 /*
2705  * Walk subtables of a table and call a callback routine for each
2706  * subtable.  The caller should provide the first subtable and a
2707  * pointer to the end of the table.  This can be used to walk tables
2708  * such as MADT and SRAT that use subtable entries.
2709  */
2710 void
acpi_walk_subtables(void * first,void * end,acpi_subtable_handler * handler,void * arg)2711 acpi_walk_subtables(void *first, void *end, acpi_subtable_handler *handler,
2712     void *arg)
2713 {
2714     ACPI_SUBTABLE_HEADER *entry;
2715 
2716     for (entry = first; (void *)entry < end; ) {
2717 	/* Avoid an infinite loop if we hit a bogus entry. */
2718 	if (entry->Length < sizeof(ACPI_SUBTABLE_HEADER))
2719 	    return;
2720 
2721 	handler(entry, arg);
2722 	entry = ACPI_ADD_PTR(ACPI_SUBTABLE_HEADER, entry, entry->Length);
2723     }
2724 }
2725 
2726 /*
2727  * DEPRECATED.  This interface has serious deficiencies and will be
2728  * removed.
2729  *
2730  * Immediately enter the sleep state.  In the old model, acpiconf(8) ran
2731  * rc.suspend and rc.resume so we don't have to notify devd(8) to do this.
2732  */
2733 ACPI_STATUS
acpi_SetSleepState(struct acpi_softc * sc,int state)2734 acpi_SetSleepState(struct acpi_softc *sc, int state)
2735 {
2736     static int once;
2737 
2738     if (!once) {
2739 	device_printf(sc->acpi_dev,
2740 "warning: acpi_SetSleepState() deprecated, need to update your software\n");
2741 	once = 1;
2742     }
2743     return (acpi_EnterSleepState(sc, state));
2744 }
2745 
2746 #if defined(__amd64__) || defined(__i386__)
2747 static void
acpi_sleep_force_task(void * context)2748 acpi_sleep_force_task(void *context)
2749 {
2750     struct acpi_softc *sc = (struct acpi_softc *)context;
2751 
2752     if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2753 	device_printf(sc->acpi_dev, "force sleep state S%d failed\n",
2754 	    sc->acpi_next_sstate);
2755 }
2756 
2757 static void
acpi_sleep_force(void * arg)2758 acpi_sleep_force(void *arg)
2759 {
2760     struct acpi_softc *sc = (struct acpi_softc *)arg;
2761 
2762     device_printf(sc->acpi_dev,
2763 	"suspend request timed out, forcing sleep now\n");
2764     /*
2765      * XXX Suspending from callout causes freezes in DEVICE_SUSPEND().
2766      * Suspend from acpi_task thread instead.
2767      */
2768     if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
2769 	acpi_sleep_force_task, sc)))
2770 	device_printf(sc->acpi_dev, "AcpiOsExecute() for sleeping failed\n");
2771 }
2772 #endif
2773 
2774 /*
2775  * Request that the system enter the given suspend state.  All /dev/apm
2776  * devices and devd(8) will be notified.  Userland then has a chance to
2777  * save state and acknowledge the request.  The system sleeps once all
2778  * acks are in.
2779  */
2780 int
acpi_ReqSleepState(struct acpi_softc * sc,int state)2781 acpi_ReqSleepState(struct acpi_softc *sc, int state)
2782 {
2783 #if defined(__amd64__) || defined(__i386__)
2784     struct apm_clone_data *clone;
2785     ACPI_STATUS status;
2786 
2787     if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX)
2788 	return (EINVAL);
2789     if (!acpi_sleep_states[state])
2790 	return (EOPNOTSUPP);
2791 
2792     /*
2793      * If a reboot/shutdown/suspend request is already in progress or
2794      * suspend is blocked due to an upcoming shutdown, just return.
2795      */
2796     if (rebooting || sc->acpi_next_sstate != 0 || suspend_blocked) {
2797 	return (0);
2798     }
2799 
2800     /* Wait until sleep is enabled. */
2801     while (sc->acpi_sleep_disabled) {
2802 	AcpiOsSleep(1000);
2803     }
2804 
2805     ACPI_LOCK(acpi);
2806 
2807     sc->acpi_next_sstate = state;
2808 
2809     /* S5 (soft-off) should be entered directly with no waiting. */
2810     if (state == ACPI_STATE_S5) {
2811     	ACPI_UNLOCK(acpi);
2812 	status = acpi_EnterSleepState(sc, state);
2813 	return (ACPI_SUCCESS(status) ? 0 : ENXIO);
2814     }
2815 
2816     /* Record the pending state and notify all apm devices. */
2817     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2818 	clone->notify_status = APM_EV_NONE;
2819 	if ((clone->flags & ACPI_EVF_DEVD) == 0) {
2820 	    selwakeuppri(&clone->sel_read, PZERO);
2821 	    KNOTE_LOCKED(&clone->sel_read.si_note, 0);
2822 	}
2823     }
2824 
2825     /* If devd(8) is not running, immediately enter the sleep state. */
2826     if (!devctl_process_running()) {
2827 	ACPI_UNLOCK(acpi);
2828 	status = acpi_EnterSleepState(sc, state);
2829 	return (ACPI_SUCCESS(status) ? 0 : ENXIO);
2830     }
2831 
2832     /*
2833      * Set a timeout to fire if userland doesn't ack the suspend request
2834      * in time.  This way we still eventually go to sleep if we were
2835      * overheating or running low on battery, even if userland is hung.
2836      * We cancel this timeout once all userland acks are in or the
2837      * suspend request is aborted.
2838      */
2839     callout_reset(&sc->susp_force_to, 10 * hz, acpi_sleep_force, sc);
2840     ACPI_UNLOCK(acpi);
2841 
2842     /* Now notify devd(8) also. */
2843     acpi_UserNotify("Suspend", ACPI_ROOT_OBJECT, state);
2844 
2845     return (0);
2846 #else
2847     /* This platform does not support acpi suspend/resume. */
2848     return (EOPNOTSUPP);
2849 #endif
2850 }
2851 
2852 /*
2853  * Acknowledge (or reject) a pending sleep state.  The caller has
2854  * prepared for suspend and is now ready for it to proceed.  If the
2855  * error argument is non-zero, it indicates suspend should be cancelled
2856  * and gives an errno value describing why.  Once all votes are in,
2857  * we suspend the system.
2858  */
2859 int
acpi_AckSleepState(struct apm_clone_data * clone,int error)2860 acpi_AckSleepState(struct apm_clone_data *clone, int error)
2861 {
2862 #if defined(__amd64__) || defined(__i386__)
2863     struct acpi_softc *sc;
2864     int ret, sleeping;
2865 
2866     /* If no pending sleep state, return an error. */
2867     ACPI_LOCK(acpi);
2868     sc = clone->acpi_sc;
2869     if (sc->acpi_next_sstate == 0) {
2870     	ACPI_UNLOCK(acpi);
2871 	return (ENXIO);
2872     }
2873 
2874     /* Caller wants to abort suspend process. */
2875     if (error) {
2876 	sc->acpi_next_sstate = 0;
2877 	callout_stop(&sc->susp_force_to);
2878 	device_printf(sc->acpi_dev,
2879 	    "listener on %s cancelled the pending suspend\n",
2880 	    devtoname(clone->cdev));
2881     	ACPI_UNLOCK(acpi);
2882 	return (0);
2883     }
2884 
2885     /*
2886      * Mark this device as acking the suspend request.  Then, walk through
2887      * all devices, seeing if they agree yet.  We only count devices that
2888      * are writable since read-only devices couldn't ack the request.
2889      */
2890     sleeping = TRUE;
2891     clone->notify_status = APM_EV_ACKED;
2892     STAILQ_FOREACH(clone, &sc->apm_cdevs, entries) {
2893 	if ((clone->flags & ACPI_EVF_WRITE) != 0 &&
2894 	    clone->notify_status != APM_EV_ACKED) {
2895 	    sleeping = FALSE;
2896 	    break;
2897 	}
2898     }
2899 
2900     /* If all devices have voted "yes", we will suspend now. */
2901     if (sleeping)
2902 	callout_stop(&sc->susp_force_to);
2903     ACPI_UNLOCK(acpi);
2904     ret = 0;
2905     if (sleeping) {
2906 	if (ACPI_FAILURE(acpi_EnterSleepState(sc, sc->acpi_next_sstate)))
2907 		ret = ENODEV;
2908     }
2909     return (ret);
2910 #else
2911     /* This platform does not support acpi suspend/resume. */
2912     return (EOPNOTSUPP);
2913 #endif
2914 }
2915 
2916 static void
acpi_sleep_enable(void * arg)2917 acpi_sleep_enable(void *arg)
2918 {
2919     struct acpi_softc	*sc = (struct acpi_softc *)arg;
2920 
2921     ACPI_LOCK_ASSERT(acpi);
2922 
2923     /* Reschedule if the system is not fully up and running. */
2924     if (!AcpiGbl_SystemAwakeAndRunning) {
2925 	callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME);
2926 	return;
2927     }
2928 
2929     sc->acpi_sleep_disabled = FALSE;
2930 }
2931 
2932 static ACPI_STATUS
acpi_sleep_disable(struct acpi_softc * sc)2933 acpi_sleep_disable(struct acpi_softc *sc)
2934 {
2935     ACPI_STATUS		status;
2936 
2937     /* Fail if the system is not fully up and running. */
2938     if (!AcpiGbl_SystemAwakeAndRunning)
2939 	return (AE_ERROR);
2940 
2941     ACPI_LOCK(acpi);
2942     status = sc->acpi_sleep_disabled ? AE_ERROR : AE_OK;
2943     sc->acpi_sleep_disabled = TRUE;
2944     ACPI_UNLOCK(acpi);
2945 
2946     return (status);
2947 }
2948 
2949 enum acpi_sleep_state {
2950     ACPI_SS_NONE,
2951     ACPI_SS_GPE_SET,
2952     ACPI_SS_DEV_SUSPEND,
2953     ACPI_SS_SLP_PREP,
2954     ACPI_SS_SLEPT,
2955 };
2956 
2957 /*
2958  * Enter the desired system sleep state.
2959  *
2960  * Currently we support S1-S5 but S4 is only S4BIOS
2961  */
2962 static ACPI_STATUS
acpi_EnterSleepState(struct acpi_softc * sc,int state)2963 acpi_EnterSleepState(struct acpi_softc *sc, int state)
2964 {
2965     register_t intr;
2966     ACPI_STATUS status;
2967     ACPI_EVENT_STATUS power_button_status;
2968     enum acpi_sleep_state slp_state;
2969     int sleep_result;
2970 
2971     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
2972 
2973     if (state < ACPI_STATE_S1 || state > ACPI_S_STATES_MAX)
2974 	return_ACPI_STATUS (AE_BAD_PARAMETER);
2975     if (!acpi_sleep_states[state]) {
2976 	device_printf(sc->acpi_dev, "Sleep state S%d not supported by BIOS\n",
2977 	    state);
2978 	return (AE_SUPPORT);
2979     }
2980 
2981     /* Re-entry once we're suspending is not allowed. */
2982     status = acpi_sleep_disable(sc);
2983     if (ACPI_FAILURE(status)) {
2984 	device_printf(sc->acpi_dev,
2985 	    "suspend request ignored (not ready yet)\n");
2986 	return (status);
2987     }
2988 
2989     if (state == ACPI_STATE_S5) {
2990 	/*
2991 	 * Shut down cleanly and power off.  This will call us back through the
2992 	 * shutdown handlers.
2993 	 */
2994 	shutdown_nice(RB_POWEROFF);
2995 	return_ACPI_STATUS (AE_OK);
2996     }
2997 
2998     EVENTHANDLER_INVOKE(power_suspend_early);
2999     stop_all_proc();
3000     EVENTHANDLER_INVOKE(power_suspend);
3001 
3002 #ifdef EARLY_AP_STARTUP
3003     MPASS(mp_ncpus == 1 || smp_started);
3004     thread_lock(curthread);
3005     sched_bind(curthread, 0);
3006     thread_unlock(curthread);
3007 #else
3008     if (smp_started) {
3009 	thread_lock(curthread);
3010 	sched_bind(curthread, 0);
3011 	thread_unlock(curthread);
3012     }
3013 #endif
3014 
3015     /*
3016      * Be sure to hold Giant across DEVICE_SUSPEND/RESUME since non-MPSAFE
3017      * drivers need this.
3018      */
3019     mtx_lock(&Giant);
3020 
3021     slp_state = ACPI_SS_NONE;
3022 
3023     sc->acpi_sstate = state;
3024 
3025     /* Enable any GPEs as appropriate and requested by the user. */
3026     acpi_wake_prep_walk(state);
3027     slp_state = ACPI_SS_GPE_SET;
3028 
3029     /*
3030      * Inform all devices that we are going to sleep.  If at least one
3031      * device fails, DEVICE_SUSPEND() automatically resumes the tree.
3032      *
3033      * XXX Note that a better two-pass approach with a 'veto' pass
3034      * followed by a "real thing" pass would be better, but the current
3035      * bus interface does not provide for this.
3036      */
3037     if (DEVICE_SUSPEND(root_bus) != 0) {
3038 	device_printf(sc->acpi_dev, "device_suspend failed\n");
3039 	goto backout;
3040     }
3041     slp_state = ACPI_SS_DEV_SUSPEND;
3042 
3043     status = AcpiEnterSleepStatePrep(state);
3044     if (ACPI_FAILURE(status)) {
3045 	device_printf(sc->acpi_dev, "AcpiEnterSleepStatePrep failed - %s\n",
3046 		      AcpiFormatException(status));
3047 	goto backout;
3048     }
3049     slp_state = ACPI_SS_SLP_PREP;
3050 
3051     if (sc->acpi_sleep_delay > 0)
3052 	DELAY(sc->acpi_sleep_delay * 1000000);
3053 
3054     suspendclock();
3055     intr = intr_disable();
3056     if (state != ACPI_STATE_S1) {
3057 	sleep_result = acpi_sleep_machdep(sc, state);
3058 	acpi_wakeup_machdep(sc, state, sleep_result, 0);
3059 
3060 	/*
3061 	 * XXX According to ACPI specification SCI_EN bit should be restored
3062 	 * by ACPI platform (BIOS, firmware) to its pre-sleep state.
3063 	 * Unfortunately some BIOSes fail to do that and that leads to
3064 	 * unexpected and serious consequences during wake up like a system
3065 	 * getting stuck in SMI handlers.
3066 	 * This hack is picked up from Linux, which claims that it follows
3067 	 * Windows behavior.
3068 	 */
3069 	if (sleep_result == 1 && state != ACPI_STATE_S4)
3070 	    AcpiWriteBitRegister(ACPI_BITREG_SCI_ENABLE, ACPI_ENABLE_EVENT);
3071 
3072 	if (sleep_result == 1 && state == ACPI_STATE_S3) {
3073 	    /*
3074 	     * Prevent mis-interpretation of the wakeup by power button
3075 	     * as a request for power off.
3076 	     * Ideally we should post an appropriate wakeup event,
3077 	     * perhaps using acpi_event_power_button_wake or alike.
3078 	     *
3079 	     * Clearing of power button status after wakeup is mandated
3080 	     * by ACPI specification in section "Fixed Power Button".
3081 	     *
3082 	     * XXX As of ACPICA 20121114 AcpiGetEventStatus provides
3083 	     * status as 0/1 corressponding to inactive/active despite
3084 	     * its type being ACPI_EVENT_STATUS.  In other words,
3085 	     * we should not test for ACPI_EVENT_FLAG_SET for time being.
3086 	     */
3087 	    if (ACPI_SUCCESS(AcpiGetEventStatus(ACPI_EVENT_POWER_BUTTON,
3088 		&power_button_status)) && power_button_status != 0) {
3089 		AcpiClearEvent(ACPI_EVENT_POWER_BUTTON);
3090 		device_printf(sc->acpi_dev,
3091 		    "cleared fixed power button status\n");
3092 	    }
3093 	}
3094 
3095 	intr_restore(intr);
3096 
3097 	/* call acpi_wakeup_machdep() again with interrupt enabled */
3098 	acpi_wakeup_machdep(sc, state, sleep_result, 1);
3099 
3100 	AcpiLeaveSleepStatePrep(state);
3101 
3102 	if (sleep_result == -1)
3103 		goto backout;
3104 
3105 	/* Re-enable ACPI hardware on wakeup from sleep state 4. */
3106 	if (state == ACPI_STATE_S4)
3107 	    AcpiEnable();
3108     } else {
3109 	status = AcpiEnterSleepState(state);
3110 	intr_restore(intr);
3111 	AcpiLeaveSleepStatePrep(state);
3112 	if (ACPI_FAILURE(status)) {
3113 	    device_printf(sc->acpi_dev, "AcpiEnterSleepState failed - %s\n",
3114 			  AcpiFormatException(status));
3115 	    goto backout;
3116 	}
3117     }
3118     slp_state = ACPI_SS_SLEPT;
3119 
3120     /*
3121      * Back out state according to how far along we got in the suspend
3122      * process.  This handles both the error and success cases.
3123      */
3124 backout:
3125     if (slp_state >= ACPI_SS_SLP_PREP)
3126 	resumeclock();
3127     if (slp_state >= ACPI_SS_GPE_SET) {
3128 	acpi_wake_prep_walk(state);
3129 	sc->acpi_sstate = ACPI_STATE_S0;
3130     }
3131     if (slp_state >= ACPI_SS_DEV_SUSPEND)
3132 	DEVICE_RESUME(root_bus);
3133     if (slp_state >= ACPI_SS_SLP_PREP)
3134 	AcpiLeaveSleepState(state);
3135     if (slp_state >= ACPI_SS_SLEPT) {
3136 #if defined(__i386__) || defined(__amd64__)
3137 	/* NB: we are still using ACPI timecounter at this point. */
3138 	resume_TSC();
3139 #endif
3140 	acpi_resync_clock(sc);
3141 	acpi_enable_fixed_events(sc);
3142     }
3143     sc->acpi_next_sstate = 0;
3144 
3145     mtx_unlock(&Giant);
3146 
3147 #ifdef EARLY_AP_STARTUP
3148     thread_lock(curthread);
3149     sched_unbind(curthread);
3150     thread_unlock(curthread);
3151 #else
3152     if (smp_started) {
3153 	thread_lock(curthread);
3154 	sched_unbind(curthread);
3155 	thread_unlock(curthread);
3156     }
3157 #endif
3158 
3159     resume_all_proc();
3160 
3161     EVENTHANDLER_INVOKE(power_resume);
3162 
3163     /* Allow another sleep request after a while. */
3164     callout_schedule(&acpi_sleep_timer, hz * ACPI_MINIMUM_AWAKETIME);
3165 
3166     /* Run /etc/rc.resume after we are back. */
3167     if (devctl_process_running())
3168 	acpi_UserNotify("Resume", ACPI_ROOT_OBJECT, state);
3169 
3170     return_ACPI_STATUS (status);
3171 }
3172 
3173 static void
acpi_resync_clock(struct acpi_softc * sc)3174 acpi_resync_clock(struct acpi_softc *sc)
3175 {
3176 
3177     /*
3178      * Warm up timecounter again and reset system clock.
3179      */
3180     (void)timecounter->tc_get_timecount(timecounter);
3181     (void)timecounter->tc_get_timecount(timecounter);
3182     inittodr(time_second + sc->acpi_sleep_delay);
3183 }
3184 
3185 /* Enable or disable the device's wake GPE. */
3186 int
acpi_wake_set_enable(device_t dev,int enable)3187 acpi_wake_set_enable(device_t dev, int enable)
3188 {
3189     struct acpi_prw_data prw;
3190     ACPI_STATUS status;
3191     int flags;
3192 
3193     /* Make sure the device supports waking the system and get the GPE. */
3194     if (acpi_parse_prw(acpi_get_handle(dev), &prw) != 0)
3195 	return (ENXIO);
3196 
3197     flags = acpi_get_flags(dev);
3198     if (enable) {
3199 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
3200 	    ACPI_GPE_ENABLE);
3201 	if (ACPI_FAILURE(status)) {
3202 	    device_printf(dev, "enable wake failed\n");
3203 	    return (ENXIO);
3204 	}
3205 	acpi_set_flags(dev, flags | ACPI_FLAG_WAKE_ENABLED);
3206     } else {
3207 	status = AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit,
3208 	    ACPI_GPE_DISABLE);
3209 	if (ACPI_FAILURE(status)) {
3210 	    device_printf(dev, "disable wake failed\n");
3211 	    return (ENXIO);
3212 	}
3213 	acpi_set_flags(dev, flags & ~ACPI_FLAG_WAKE_ENABLED);
3214     }
3215 
3216     return (0);
3217 }
3218 
3219 static int
acpi_wake_sleep_prep(ACPI_HANDLE handle,int sstate)3220 acpi_wake_sleep_prep(ACPI_HANDLE handle, int sstate)
3221 {
3222     struct acpi_prw_data prw;
3223     device_t dev;
3224 
3225     /* Check that this is a wake-capable device and get its GPE. */
3226     if (acpi_parse_prw(handle, &prw) != 0)
3227 	return (ENXIO);
3228     dev = acpi_get_device(handle);
3229 
3230     /*
3231      * The destination sleep state must be less than (i.e., higher power)
3232      * or equal to the value specified by _PRW.  If this GPE cannot be
3233      * enabled for the next sleep state, then disable it.  If it can and
3234      * the user requested it be enabled, turn on any required power resources
3235      * and set _PSW.
3236      */
3237     if (sstate > prw.lowest_wake) {
3238 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_DISABLE);
3239 	if (bootverbose)
3240 	    device_printf(dev, "wake_prep disabled wake for %s (S%d)\n",
3241 		acpi_name(handle), sstate);
3242     } else if (dev && (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) != 0) {
3243 	acpi_pwr_wake_enable(handle, 1);
3244 	acpi_SetInteger(handle, "_PSW", 1);
3245 	if (bootverbose)
3246 	    device_printf(dev, "wake_prep enabled for %s (S%d)\n",
3247 		acpi_name(handle), sstate);
3248     }
3249 
3250     return (0);
3251 }
3252 
3253 static int
acpi_wake_run_prep(ACPI_HANDLE handle,int sstate)3254 acpi_wake_run_prep(ACPI_HANDLE handle, int sstate)
3255 {
3256     struct acpi_prw_data prw;
3257     device_t dev;
3258 
3259     /*
3260      * Check that this is a wake-capable device and get its GPE.  Return
3261      * now if the user didn't enable this device for wake.
3262      */
3263     if (acpi_parse_prw(handle, &prw) != 0)
3264 	return (ENXIO);
3265     dev = acpi_get_device(handle);
3266     if (dev == NULL || (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) == 0)
3267 	return (0);
3268 
3269     /*
3270      * If this GPE couldn't be enabled for the previous sleep state, it was
3271      * disabled before going to sleep so re-enable it.  If it was enabled,
3272      * clear _PSW and turn off any power resources it used.
3273      */
3274     if (sstate > prw.lowest_wake) {
3275 	AcpiSetGpeWakeMask(prw.gpe_handle, prw.gpe_bit, ACPI_GPE_ENABLE);
3276 	if (bootverbose)
3277 	    device_printf(dev, "run_prep re-enabled %s\n", acpi_name(handle));
3278     } else {
3279 	acpi_SetInteger(handle, "_PSW", 0);
3280 	acpi_pwr_wake_enable(handle, 0);
3281 	if (bootverbose)
3282 	    device_printf(dev, "run_prep cleaned up for %s\n",
3283 		acpi_name(handle));
3284     }
3285 
3286     return (0);
3287 }
3288 
3289 static ACPI_STATUS
acpi_wake_prep(ACPI_HANDLE handle,UINT32 level,void * context,void ** status)3290 acpi_wake_prep(ACPI_HANDLE handle, UINT32 level, void *context, void **status)
3291 {
3292     int sstate;
3293 
3294     /* If suspending, run the sleep prep function, otherwise wake. */
3295     sstate = *(int *)context;
3296     if (AcpiGbl_SystemAwakeAndRunning)
3297 	acpi_wake_sleep_prep(handle, sstate);
3298     else
3299 	acpi_wake_run_prep(handle, sstate);
3300     return (AE_OK);
3301 }
3302 
3303 /* Walk the tree rooted at acpi0 to prep devices for suspend/resume. */
3304 static int
acpi_wake_prep_walk(int sstate)3305 acpi_wake_prep_walk(int sstate)
3306 {
3307     ACPI_HANDLE sb_handle;
3308 
3309     if (ACPI_SUCCESS(AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle)))
3310 	AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle, 100,
3311 	    acpi_wake_prep, NULL, &sstate, NULL);
3312     return (0);
3313 }
3314 
3315 /* Walk the tree rooted at acpi0 to attach per-device wake sysctls. */
3316 static int
acpi_wake_sysctl_walk(device_t dev)3317 acpi_wake_sysctl_walk(device_t dev)
3318 {
3319     int error, i, numdevs;
3320     device_t *devlist;
3321     device_t child;
3322     ACPI_STATUS status;
3323 
3324     error = device_get_children(dev, &devlist, &numdevs);
3325     if (error != 0 || numdevs == 0) {
3326 	if (numdevs == 0)
3327 	    free(devlist, M_TEMP);
3328 	return (error);
3329     }
3330     for (i = 0; i < numdevs; i++) {
3331 	child = devlist[i];
3332 	acpi_wake_sysctl_walk(child);
3333 	if (!device_is_attached(child))
3334 	    continue;
3335 	status = AcpiEvaluateObject(acpi_get_handle(child), "_PRW", NULL, NULL);
3336 	if (ACPI_SUCCESS(status)) {
3337 	    SYSCTL_ADD_PROC(device_get_sysctl_ctx(child),
3338 		SYSCTL_CHILDREN(device_get_sysctl_tree(child)), OID_AUTO,
3339 		"wake", CTLTYPE_INT | CTLFLAG_RW, child, 0,
3340 		acpi_wake_set_sysctl, "I", "Device set to wake the system");
3341 	}
3342     }
3343     free(devlist, M_TEMP);
3344 
3345     return (0);
3346 }
3347 
3348 /* Enable or disable wake from userland. */
3349 static int
acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)3350 acpi_wake_set_sysctl(SYSCTL_HANDLER_ARGS)
3351 {
3352     int enable, error;
3353     device_t dev;
3354 
3355     dev = (device_t)arg1;
3356     enable = (acpi_get_flags(dev) & ACPI_FLAG_WAKE_ENABLED) ? 1 : 0;
3357 
3358     error = sysctl_handle_int(oidp, &enable, 0, req);
3359     if (error != 0 || req->newptr == NULL)
3360 	return (error);
3361     if (enable != 0 && enable != 1)
3362 	return (EINVAL);
3363 
3364     return (acpi_wake_set_enable(dev, enable));
3365 }
3366 
3367 /* Parse a device's _PRW into a structure. */
3368 int
acpi_parse_prw(ACPI_HANDLE h,struct acpi_prw_data * prw)3369 acpi_parse_prw(ACPI_HANDLE h, struct acpi_prw_data *prw)
3370 {
3371     ACPI_STATUS			status;
3372     ACPI_BUFFER			prw_buffer;
3373     ACPI_OBJECT			*res, *res2;
3374     int				error, i, power_count;
3375 
3376     if (h == NULL || prw == NULL)
3377 	return (EINVAL);
3378 
3379     /*
3380      * The _PRW object (7.2.9) is only required for devices that have the
3381      * ability to wake the system from a sleeping state.
3382      */
3383     error = EINVAL;
3384     prw_buffer.Pointer = NULL;
3385     prw_buffer.Length = ACPI_ALLOCATE_BUFFER;
3386     status = AcpiEvaluateObject(h, "_PRW", NULL, &prw_buffer);
3387     if (ACPI_FAILURE(status))
3388 	return (ENOENT);
3389     res = (ACPI_OBJECT *)prw_buffer.Pointer;
3390     if (res == NULL)
3391 	return (ENOENT);
3392     if (!ACPI_PKG_VALID(res, 2))
3393 	goto out;
3394 
3395     /*
3396      * Element 1 of the _PRW object:
3397      * The lowest power system sleeping state that can be entered while still
3398      * providing wake functionality.  The sleeping state being entered must
3399      * be less than (i.e., higher power) or equal to this value.
3400      */
3401     if (acpi_PkgInt32(res, 1, &prw->lowest_wake) != 0)
3402 	goto out;
3403 
3404     /*
3405      * Element 0 of the _PRW object:
3406      */
3407     switch (res->Package.Elements[0].Type) {
3408     case ACPI_TYPE_INTEGER:
3409 	/*
3410 	 * If the data type of this package element is numeric, then this
3411 	 * _PRW package element is the bit index in the GPEx_EN, in the
3412 	 * GPE blocks described in the FADT, of the enable bit that is
3413 	 * enabled for the wake event.
3414 	 */
3415 	prw->gpe_handle = NULL;
3416 	prw->gpe_bit = res->Package.Elements[0].Integer.Value;
3417 	error = 0;
3418 	break;
3419     case ACPI_TYPE_PACKAGE:
3420 	/*
3421 	 * If the data type of this package element is a package, then this
3422 	 * _PRW package element is itself a package containing two
3423 	 * elements.  The first is an object reference to the GPE Block
3424 	 * device that contains the GPE that will be triggered by the wake
3425 	 * event.  The second element is numeric and it contains the bit
3426 	 * index in the GPEx_EN, in the GPE Block referenced by the
3427 	 * first element in the package, of the enable bit that is enabled for
3428 	 * the wake event.
3429 	 *
3430 	 * For example, if this field is a package then it is of the form:
3431 	 * Package() {\_SB.PCI0.ISA.GPE, 2}
3432 	 */
3433 	res2 = &res->Package.Elements[0];
3434 	if (!ACPI_PKG_VALID(res2, 2))
3435 	    goto out;
3436 	prw->gpe_handle = acpi_GetReference(NULL, &res2->Package.Elements[0]);
3437 	if (prw->gpe_handle == NULL)
3438 	    goto out;
3439 	if (acpi_PkgInt32(res2, 1, &prw->gpe_bit) != 0)
3440 	    goto out;
3441 	error = 0;
3442 	break;
3443     default:
3444 	goto out;
3445     }
3446 
3447     /* Elements 2 to N of the _PRW object are power resources. */
3448     power_count = res->Package.Count - 2;
3449     if (power_count > ACPI_PRW_MAX_POWERRES) {
3450 	printf("ACPI device %s has too many power resources\n", acpi_name(h));
3451 	power_count = 0;
3452     }
3453     prw->power_res_count = power_count;
3454     for (i = 0; i < power_count; i++)
3455 	prw->power_res[i] = res->Package.Elements[i];
3456 
3457 out:
3458     if (prw_buffer.Pointer != NULL)
3459 	AcpiOsFree(prw_buffer.Pointer);
3460     return (error);
3461 }
3462 
3463 /*
3464  * ACPI Event Handlers
3465  */
3466 
3467 /* System Event Handlers (registered by EVENTHANDLER_REGISTER) */
3468 
3469 static void
acpi_system_eventhandler_sleep(void * arg,int state)3470 acpi_system_eventhandler_sleep(void *arg, int state)
3471 {
3472     struct acpi_softc *sc = (struct acpi_softc *)arg;
3473     int ret;
3474 
3475     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
3476 
3477     /* Check if button action is disabled or unknown. */
3478     if (state == ACPI_STATE_UNKNOWN)
3479 	return;
3480 
3481     /* Request that the system prepare to enter the given suspend state. */
3482     ret = acpi_ReqSleepState(sc, state);
3483     if (ret != 0)
3484 	device_printf(sc->acpi_dev,
3485 	    "request to enter state S%d failed (err %d)\n", state, ret);
3486 
3487     return_VOID;
3488 }
3489 
3490 static void
acpi_system_eventhandler_wakeup(void * arg,int state)3491 acpi_system_eventhandler_wakeup(void *arg, int state)
3492 {
3493 
3494     ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, state);
3495 
3496     /* Currently, nothing to do for wakeup. */
3497 
3498     return_VOID;
3499 }
3500 
3501 /*
3502  * ACPICA Event Handlers (FixedEvent, also called from button notify handler)
3503  */
3504 static void
acpi_invoke_sleep_eventhandler(void * context)3505 acpi_invoke_sleep_eventhandler(void *context)
3506 {
3507 
3508     EVENTHANDLER_INVOKE(acpi_sleep_event, *(int *)context);
3509 }
3510 
3511 static void
acpi_invoke_wake_eventhandler(void * context)3512 acpi_invoke_wake_eventhandler(void *context)
3513 {
3514 
3515     EVENTHANDLER_INVOKE(acpi_wakeup_event, *(int *)context);
3516 }
3517 
3518 UINT32
acpi_event_power_button_sleep(void * context)3519 acpi_event_power_button_sleep(void *context)
3520 {
3521     struct acpi_softc	*sc = (struct acpi_softc *)context;
3522 
3523     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3524 
3525     if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3526 	acpi_invoke_sleep_eventhandler, &sc->acpi_power_button_sx)))
3527 	return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3528     return_VALUE (ACPI_INTERRUPT_HANDLED);
3529 }
3530 
3531 UINT32
acpi_event_power_button_wake(void * context)3532 acpi_event_power_button_wake(void *context)
3533 {
3534     struct acpi_softc	*sc = (struct acpi_softc *)context;
3535 
3536     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3537 
3538     if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3539 	acpi_invoke_wake_eventhandler, &sc->acpi_power_button_sx)))
3540 	return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3541     return_VALUE (ACPI_INTERRUPT_HANDLED);
3542 }
3543 
3544 UINT32
acpi_event_sleep_button_sleep(void * context)3545 acpi_event_sleep_button_sleep(void *context)
3546 {
3547     struct acpi_softc	*sc = (struct acpi_softc *)context;
3548 
3549     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3550 
3551     if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3552 	acpi_invoke_sleep_eventhandler, &sc->acpi_sleep_button_sx)))
3553 	return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3554     return_VALUE (ACPI_INTERRUPT_HANDLED);
3555 }
3556 
3557 UINT32
acpi_event_sleep_button_wake(void * context)3558 acpi_event_sleep_button_wake(void *context)
3559 {
3560     struct acpi_softc	*sc = (struct acpi_softc *)context;
3561 
3562     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
3563 
3564     if (ACPI_FAILURE(AcpiOsExecute(OSL_NOTIFY_HANDLER,
3565 	acpi_invoke_wake_eventhandler, &sc->acpi_sleep_button_sx)))
3566 	return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
3567     return_VALUE (ACPI_INTERRUPT_HANDLED);
3568 }
3569 
3570 /*
3571  * XXX This static buffer is suboptimal.  There is no locking so only
3572  * use this for single-threaded callers.
3573  */
3574 char *
acpi_name(ACPI_HANDLE handle)3575 acpi_name(ACPI_HANDLE handle)
3576 {
3577     ACPI_BUFFER buf;
3578     static char data[256];
3579 
3580     buf.Length = sizeof(data);
3581     buf.Pointer = data;
3582 
3583     if (handle && ACPI_SUCCESS(AcpiGetName(handle, ACPI_FULL_PATHNAME, &buf)))
3584 	return (data);
3585     return ("(unknown)");
3586 }
3587 
3588 /*
3589  * Debugging/bug-avoidance.  Avoid trying to fetch info on various
3590  * parts of the namespace.
3591  */
3592 int
acpi_avoid(ACPI_HANDLE handle)3593 acpi_avoid(ACPI_HANDLE handle)
3594 {
3595     char	*cp, *env, *np;
3596     int		len;
3597 
3598     np = acpi_name(handle);
3599     if (*np == '\\')
3600 	np++;
3601     if ((env = kern_getenv("debug.acpi.avoid")) == NULL)
3602 	return (0);
3603 
3604     /* Scan the avoid list checking for a match */
3605     cp = env;
3606     for (;;) {
3607 	while (*cp != 0 && isspace(*cp))
3608 	    cp++;
3609 	if (*cp == 0)
3610 	    break;
3611 	len = 0;
3612 	while (cp[len] != 0 && !isspace(cp[len]))
3613 	    len++;
3614 	if (!strncmp(cp, np, len)) {
3615 	    freeenv(env);
3616 	    return(1);
3617 	}
3618 	cp += len;
3619     }
3620     freeenv(env);
3621 
3622     return (0);
3623 }
3624 
3625 /*
3626  * Debugging/bug-avoidance.  Disable ACPI subsystem components.
3627  */
3628 int
acpi_disabled(char * subsys)3629 acpi_disabled(char *subsys)
3630 {
3631     char	*cp, *env;
3632     int		len;
3633 
3634     if ((env = kern_getenv("debug.acpi.disabled")) == NULL)
3635 	return (0);
3636     if (strcmp(env, "all") == 0) {
3637 	freeenv(env);
3638 	return (1);
3639     }
3640 
3641     /* Scan the disable list, checking for a match. */
3642     cp = env;
3643     for (;;) {
3644 	while (*cp != '\0' && isspace(*cp))
3645 	    cp++;
3646 	if (*cp == '\0')
3647 	    break;
3648 	len = 0;
3649 	while (cp[len] != '\0' && !isspace(cp[len]))
3650 	    len++;
3651 	if (strncmp(cp, subsys, len) == 0) {
3652 	    freeenv(env);
3653 	    return (1);
3654 	}
3655 	cp += len;
3656     }
3657     freeenv(env);
3658 
3659     return (0);
3660 }
3661 
3662 static void
acpi_lookup(void * arg,const char * name,device_t * dev)3663 acpi_lookup(void *arg, const char *name, device_t *dev)
3664 {
3665     ACPI_HANDLE handle;
3666 
3667     if (*dev != NULL)
3668 	return;
3669 
3670     /*
3671      * Allow any handle name that is specified as an absolute path and
3672      * starts with '\'.  We could restrict this to \_SB and friends,
3673      * but see acpi_probe_children() for notes on why we scan the entire
3674      * namespace for devices.
3675      *
3676      * XXX: The pathname argument to AcpiGetHandle() should be fixed to
3677      * be const.
3678      */
3679     if (name[0] != '\\')
3680 	return;
3681     if (ACPI_FAILURE(AcpiGetHandle(ACPI_ROOT_OBJECT, __DECONST(char *, name),
3682 	&handle)))
3683 	return;
3684     *dev = acpi_get_device(handle);
3685 }
3686 
3687 /*
3688  * Control interface.
3689  *
3690  * We multiplex ioctls for all participating ACPI devices here.  Individual
3691  * drivers wanting to be accessible via /dev/acpi should use the
3692  * register/deregister interface to make their handlers visible.
3693  */
3694 struct acpi_ioctl_hook
3695 {
3696     TAILQ_ENTRY(acpi_ioctl_hook) link;
3697     u_long			 cmd;
3698     acpi_ioctl_fn		 fn;
3699     void			 *arg;
3700 };
3701 
3702 static TAILQ_HEAD(,acpi_ioctl_hook)	acpi_ioctl_hooks;
3703 static int				acpi_ioctl_hooks_initted;
3704 
3705 int
acpi_register_ioctl(u_long cmd,acpi_ioctl_fn fn,void * arg)3706 acpi_register_ioctl(u_long cmd, acpi_ioctl_fn fn, void *arg)
3707 {
3708     struct acpi_ioctl_hook	*hp;
3709 
3710     if ((hp = malloc(sizeof(*hp), M_ACPIDEV, M_NOWAIT)) == NULL)
3711 	return (ENOMEM);
3712     hp->cmd = cmd;
3713     hp->fn = fn;
3714     hp->arg = arg;
3715 
3716     ACPI_LOCK(acpi);
3717     if (acpi_ioctl_hooks_initted == 0) {
3718 	TAILQ_INIT(&acpi_ioctl_hooks);
3719 	acpi_ioctl_hooks_initted = 1;
3720     }
3721     TAILQ_INSERT_TAIL(&acpi_ioctl_hooks, hp, link);
3722     ACPI_UNLOCK(acpi);
3723 
3724     return (0);
3725 }
3726 
3727 void
acpi_deregister_ioctl(u_long cmd,acpi_ioctl_fn fn)3728 acpi_deregister_ioctl(u_long cmd, acpi_ioctl_fn fn)
3729 {
3730     struct acpi_ioctl_hook	*hp;
3731 
3732     ACPI_LOCK(acpi);
3733     TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link)
3734 	if (hp->cmd == cmd && hp->fn == fn)
3735 	    break;
3736 
3737     if (hp != NULL) {
3738 	TAILQ_REMOVE(&acpi_ioctl_hooks, hp, link);
3739 	free(hp, M_ACPIDEV);
3740     }
3741     ACPI_UNLOCK(acpi);
3742 }
3743 
3744 static int
acpiopen(struct cdev * dev,int flag,int fmt,struct thread * td)3745 acpiopen(struct cdev *dev, int flag, int fmt, struct thread *td)
3746 {
3747     return (0);
3748 }
3749 
3750 static int
acpiclose(struct cdev * dev,int flag,int fmt,struct thread * td)3751 acpiclose(struct cdev *dev, int flag, int fmt, struct thread *td)
3752 {
3753     return (0);
3754 }
3755 
3756 static int
acpiioctl(struct cdev * dev,u_long cmd,caddr_t addr,int flag,struct thread * td)3757 acpiioctl(struct cdev *dev, u_long cmd, caddr_t addr, int flag, struct thread *td)
3758 {
3759     struct acpi_softc		*sc;
3760     struct acpi_ioctl_hook	*hp;
3761     int				error, state;
3762 
3763     error = 0;
3764     hp = NULL;
3765     sc = dev->si_drv1;
3766 
3767     /*
3768      * Scan the list of registered ioctls, looking for handlers.
3769      */
3770     ACPI_LOCK(acpi);
3771     if (acpi_ioctl_hooks_initted)
3772 	TAILQ_FOREACH(hp, &acpi_ioctl_hooks, link) {
3773 	    if (hp->cmd == cmd)
3774 		break;
3775 	}
3776     ACPI_UNLOCK(acpi);
3777     if (hp)
3778 	return (hp->fn(cmd, addr, hp->arg));
3779 
3780     /*
3781      * Core ioctls are not permitted for non-writable user.
3782      * Currently, other ioctls just fetch information.
3783      * Not changing system behavior.
3784      */
3785     if ((flag & FWRITE) == 0)
3786 	return (EPERM);
3787 
3788     /* Core system ioctls. */
3789     switch (cmd) {
3790     case ACPIIO_REQSLPSTATE:
3791 	state = *(int *)addr;
3792 	if (state != ACPI_STATE_S5)
3793 	    return (acpi_ReqSleepState(sc, state));
3794 	device_printf(sc->acpi_dev, "power off via acpi ioctl not supported\n");
3795 	error = EOPNOTSUPP;
3796 	break;
3797     case ACPIIO_ACKSLPSTATE:
3798 	error = *(int *)addr;
3799 	error = acpi_AckSleepState(sc->acpi_clone, error);
3800 	break;
3801     case ACPIIO_SETSLPSTATE:	/* DEPRECATED */
3802 	state = *(int *)addr;
3803 	if (state < ACPI_STATE_S0 || state > ACPI_S_STATES_MAX)
3804 	    return (EINVAL);
3805 	if (!acpi_sleep_states[state])
3806 	    return (EOPNOTSUPP);
3807 	if (ACPI_FAILURE(acpi_SetSleepState(sc, state)))
3808 	    error = ENXIO;
3809 	break;
3810     default:
3811 	error = ENXIO;
3812 	break;
3813     }
3814 
3815     return (error);
3816 }
3817 
3818 static int
acpi_sname2sstate(const char * sname)3819 acpi_sname2sstate(const char *sname)
3820 {
3821     int sstate;
3822 
3823     if (toupper(sname[0]) == 'S') {
3824 	sstate = sname[1] - '0';
3825 	if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5 &&
3826 	    sname[2] == '\0')
3827 	    return (sstate);
3828     } else if (strcasecmp(sname, "NONE") == 0)
3829 	return (ACPI_STATE_UNKNOWN);
3830     return (-1);
3831 }
3832 
3833 static const char *
acpi_sstate2sname(int sstate)3834 acpi_sstate2sname(int sstate)
3835 {
3836     static const char *snames[] = { "S0", "S1", "S2", "S3", "S4", "S5" };
3837 
3838     if (sstate >= ACPI_STATE_S0 && sstate <= ACPI_STATE_S5)
3839 	return (snames[sstate]);
3840     else if (sstate == ACPI_STATE_UNKNOWN)
3841 	return ("NONE");
3842     return (NULL);
3843 }
3844 
3845 static int
acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)3846 acpi_supported_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3847 {
3848     int error;
3849     struct sbuf sb;
3850     UINT8 state;
3851 
3852     sbuf_new(&sb, NULL, 32, SBUF_AUTOEXTEND);
3853     for (state = ACPI_STATE_S1; state < ACPI_S_STATE_COUNT; state++)
3854 	if (acpi_sleep_states[state])
3855 	    sbuf_printf(&sb, "%s ", acpi_sstate2sname(state));
3856     sbuf_trim(&sb);
3857     sbuf_finish(&sb);
3858     error = sysctl_handle_string(oidp, sbuf_data(&sb), sbuf_len(&sb), req);
3859     sbuf_delete(&sb);
3860     return (error);
3861 }
3862 
3863 static int
acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)3864 acpi_sleep_state_sysctl(SYSCTL_HANDLER_ARGS)
3865 {
3866     char sleep_state[10];
3867     int error, new_state, old_state;
3868 
3869     old_state = *(int *)oidp->oid_arg1;
3870     strlcpy(sleep_state, acpi_sstate2sname(old_state), sizeof(sleep_state));
3871     error = sysctl_handle_string(oidp, sleep_state, sizeof(sleep_state), req);
3872     if (error == 0 && req->newptr != NULL) {
3873 	new_state = acpi_sname2sstate(sleep_state);
3874 	if (new_state < ACPI_STATE_S1)
3875 	    return (EINVAL);
3876 	if (new_state < ACPI_S_STATE_COUNT && !acpi_sleep_states[new_state])
3877 	    return (EOPNOTSUPP);
3878 	if (new_state != old_state)
3879 	    *(int *)oidp->oid_arg1 = new_state;
3880     }
3881     return (error);
3882 }
3883 
3884 /* Inform devctl(4) when we receive a Notify. */
3885 void
acpi_UserNotify(const char * subsystem,ACPI_HANDLE h,uint8_t notify)3886 acpi_UserNotify(const char *subsystem, ACPI_HANDLE h, uint8_t notify)
3887 {
3888     char		notify_buf[16];
3889     ACPI_BUFFER		handle_buf;
3890     ACPI_STATUS		status;
3891 
3892     if (subsystem == NULL)
3893 	return;
3894 
3895     handle_buf.Pointer = NULL;
3896     handle_buf.Length = ACPI_ALLOCATE_BUFFER;
3897     status = AcpiNsHandleToPathname(h, &handle_buf, FALSE);
3898     if (ACPI_FAILURE(status))
3899 	return;
3900     snprintf(notify_buf, sizeof(notify_buf), "notify=0x%02x", notify);
3901     devctl_notify("ACPI", subsystem, handle_buf.Pointer, notify_buf);
3902     AcpiOsFree(handle_buf.Pointer);
3903 }
3904 
3905 #ifdef ACPI_DEBUG
3906 /*
3907  * Support for parsing debug options from the kernel environment.
3908  *
3909  * Bits may be set in the AcpiDbgLayer and AcpiDbgLevel debug registers
3910  * by specifying the names of the bits in the debug.acpi.layer and
3911  * debug.acpi.level environment variables.  Bits may be unset by
3912  * prefixing the bit name with !.
3913  */
3914 struct debugtag
3915 {
3916     char	*name;
3917     UINT32	value;
3918 };
3919 
3920 static struct debugtag	dbg_layer[] = {
3921     {"ACPI_UTILITIES",		ACPI_UTILITIES},
3922     {"ACPI_HARDWARE",		ACPI_HARDWARE},
3923     {"ACPI_EVENTS",		ACPI_EVENTS},
3924     {"ACPI_TABLES",		ACPI_TABLES},
3925     {"ACPI_NAMESPACE",		ACPI_NAMESPACE},
3926     {"ACPI_PARSER",		ACPI_PARSER},
3927     {"ACPI_DISPATCHER",		ACPI_DISPATCHER},
3928     {"ACPI_EXECUTER",		ACPI_EXECUTER},
3929     {"ACPI_RESOURCES",		ACPI_RESOURCES},
3930     {"ACPI_CA_DEBUGGER",	ACPI_CA_DEBUGGER},
3931     {"ACPI_OS_SERVICES",	ACPI_OS_SERVICES},
3932     {"ACPI_CA_DISASSEMBLER",	ACPI_CA_DISASSEMBLER},
3933     {"ACPI_ALL_COMPONENTS",	ACPI_ALL_COMPONENTS},
3934 
3935     {"ACPI_AC_ADAPTER",		ACPI_AC_ADAPTER},
3936     {"ACPI_BATTERY",		ACPI_BATTERY},
3937     {"ACPI_BUS",		ACPI_BUS},
3938     {"ACPI_BUTTON",		ACPI_BUTTON},
3939     {"ACPI_EC", 		ACPI_EC},
3940     {"ACPI_FAN",		ACPI_FAN},
3941     {"ACPI_POWERRES",		ACPI_POWERRES},
3942     {"ACPI_PROCESSOR",		ACPI_PROCESSOR},
3943     {"ACPI_THERMAL",		ACPI_THERMAL},
3944     {"ACPI_TIMER",		ACPI_TIMER},
3945     {"ACPI_ALL_DRIVERS",	ACPI_ALL_DRIVERS},
3946     {NULL, 0}
3947 };
3948 
3949 static struct debugtag dbg_level[] = {
3950     {"ACPI_LV_INIT",		ACPI_LV_INIT},
3951     {"ACPI_LV_DEBUG_OBJECT",	ACPI_LV_DEBUG_OBJECT},
3952     {"ACPI_LV_INFO",		ACPI_LV_INFO},
3953     {"ACPI_LV_REPAIR",		ACPI_LV_REPAIR},
3954     {"ACPI_LV_ALL_EXCEPTIONS",	ACPI_LV_ALL_EXCEPTIONS},
3955 
3956     /* Trace verbosity level 1 [Standard Trace Level] */
3957     {"ACPI_LV_INIT_NAMES",	ACPI_LV_INIT_NAMES},
3958     {"ACPI_LV_PARSE",		ACPI_LV_PARSE},
3959     {"ACPI_LV_LOAD",		ACPI_LV_LOAD},
3960     {"ACPI_LV_DISPATCH",	ACPI_LV_DISPATCH},
3961     {"ACPI_LV_EXEC",		ACPI_LV_EXEC},
3962     {"ACPI_LV_NAMES",		ACPI_LV_NAMES},
3963     {"ACPI_LV_OPREGION",	ACPI_LV_OPREGION},
3964     {"ACPI_LV_BFIELD",		ACPI_LV_BFIELD},
3965     {"ACPI_LV_TABLES",		ACPI_LV_TABLES},
3966     {"ACPI_LV_VALUES",		ACPI_LV_VALUES},
3967     {"ACPI_LV_OBJECTS",		ACPI_LV_OBJECTS},
3968     {"ACPI_LV_RESOURCES",	ACPI_LV_RESOURCES},
3969     {"ACPI_LV_USER_REQUESTS",	ACPI_LV_USER_REQUESTS},
3970     {"ACPI_LV_PACKAGE",		ACPI_LV_PACKAGE},
3971     {"ACPI_LV_VERBOSITY1",	ACPI_LV_VERBOSITY1},
3972 
3973     /* Trace verbosity level 2 [Function tracing and memory allocation] */
3974     {"ACPI_LV_ALLOCATIONS",	ACPI_LV_ALLOCATIONS},
3975     {"ACPI_LV_FUNCTIONS",	ACPI_LV_FUNCTIONS},
3976     {"ACPI_LV_OPTIMIZATIONS",	ACPI_LV_OPTIMIZATIONS},
3977     {"ACPI_LV_VERBOSITY2",	ACPI_LV_VERBOSITY2},
3978     {"ACPI_LV_ALL",		ACPI_LV_ALL},
3979 
3980     /* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
3981     {"ACPI_LV_MUTEX",		ACPI_LV_MUTEX},
3982     {"ACPI_LV_THREADS",		ACPI_LV_THREADS},
3983     {"ACPI_LV_IO",		ACPI_LV_IO},
3984     {"ACPI_LV_INTERRUPTS",	ACPI_LV_INTERRUPTS},
3985     {"ACPI_LV_VERBOSITY3",	ACPI_LV_VERBOSITY3},
3986 
3987     /* Exceptionally verbose output -- also used in the global "DebugLevel"  */
3988     {"ACPI_LV_AML_DISASSEMBLE",	ACPI_LV_AML_DISASSEMBLE},
3989     {"ACPI_LV_VERBOSE_INFO",	ACPI_LV_VERBOSE_INFO},
3990     {"ACPI_LV_FULL_TABLES",	ACPI_LV_FULL_TABLES},
3991     {"ACPI_LV_EVENTS",		ACPI_LV_EVENTS},
3992     {"ACPI_LV_VERBOSE",		ACPI_LV_VERBOSE},
3993     {NULL, 0}
3994 };
3995 
3996 static void
acpi_parse_debug(char * cp,struct debugtag * tag,UINT32 * flag)3997 acpi_parse_debug(char *cp, struct debugtag *tag, UINT32 *flag)
3998 {
3999     char	*ep;
4000     int		i, l;
4001     int		set;
4002 
4003     while (*cp) {
4004 	if (isspace(*cp)) {
4005 	    cp++;
4006 	    continue;
4007 	}
4008 	ep = cp;
4009 	while (*ep && !isspace(*ep))
4010 	    ep++;
4011 	if (*cp == '!') {
4012 	    set = 0;
4013 	    cp++;
4014 	    if (cp == ep)
4015 		continue;
4016 	} else {
4017 	    set = 1;
4018 	}
4019 	l = ep - cp;
4020 	for (i = 0; tag[i].name != NULL; i++) {
4021 	    if (!strncmp(cp, tag[i].name, l)) {
4022 		if (set)
4023 		    *flag |= tag[i].value;
4024 		else
4025 		    *flag &= ~tag[i].value;
4026 	    }
4027 	}
4028 	cp = ep;
4029     }
4030 }
4031 
4032 static void
acpi_set_debugging(void * junk)4033 acpi_set_debugging(void *junk)
4034 {
4035     char	*layer, *level;
4036 
4037     if (cold) {
4038 	AcpiDbgLayer = 0;
4039 	AcpiDbgLevel = 0;
4040     }
4041 
4042     layer = kern_getenv("debug.acpi.layer");
4043     level = kern_getenv("debug.acpi.level");
4044     if (layer == NULL && level == NULL)
4045 	return;
4046 
4047     printf("ACPI set debug");
4048     if (layer != NULL) {
4049 	if (strcmp("NONE", layer) != 0)
4050 	    printf(" layer '%s'", layer);
4051 	acpi_parse_debug(layer, &dbg_layer[0], &AcpiDbgLayer);
4052 	freeenv(layer);
4053     }
4054     if (level != NULL) {
4055 	if (strcmp("NONE", level) != 0)
4056 	    printf(" level '%s'", level);
4057 	acpi_parse_debug(level, &dbg_level[0], &AcpiDbgLevel);
4058 	freeenv(level);
4059     }
4060     printf("\n");
4061 }
4062 
4063 SYSINIT(acpi_debugging, SI_SUB_TUNABLES, SI_ORDER_ANY, acpi_set_debugging,
4064 	NULL);
4065 
4066 static int
acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)4067 acpi_debug_sysctl(SYSCTL_HANDLER_ARGS)
4068 {
4069     int		 error, *dbg;
4070     struct	 debugtag *tag;
4071     struct	 sbuf sb;
4072     char	 temp[128];
4073 
4074     if (sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND) == NULL)
4075 	return (ENOMEM);
4076     if (strcmp(oidp->oid_arg1, "debug.acpi.layer") == 0) {
4077 	tag = &dbg_layer[0];
4078 	dbg = &AcpiDbgLayer;
4079     } else {
4080 	tag = &dbg_level[0];
4081 	dbg = &AcpiDbgLevel;
4082     }
4083 
4084     /* Get old values if this is a get request. */
4085     ACPI_SERIAL_BEGIN(acpi);
4086     if (*dbg == 0) {
4087 	sbuf_cpy(&sb, "NONE");
4088     } else if (req->newptr == NULL) {
4089 	for (; tag->name != NULL; tag++) {
4090 	    if ((*dbg & tag->value) == tag->value)
4091 		sbuf_printf(&sb, "%s ", tag->name);
4092 	}
4093     }
4094     sbuf_trim(&sb);
4095     sbuf_finish(&sb);
4096     strlcpy(temp, sbuf_data(&sb), sizeof(temp));
4097     sbuf_delete(&sb);
4098 
4099     error = sysctl_handle_string(oidp, temp, sizeof(temp), req);
4100 
4101     /* Check for error or no change */
4102     if (error == 0 && req->newptr != NULL) {
4103 	*dbg = 0;
4104 	kern_setenv((char *)oidp->oid_arg1, temp);
4105 	acpi_set_debugging(NULL);
4106     }
4107     ACPI_SERIAL_END(acpi);
4108 
4109     return (error);
4110 }
4111 
4112 SYSCTL_PROC(_debug_acpi, OID_AUTO, layer, CTLFLAG_RW | CTLTYPE_STRING,
4113 	    "debug.acpi.layer", 0, acpi_debug_sysctl, "A", "");
4114 SYSCTL_PROC(_debug_acpi, OID_AUTO, level, CTLFLAG_RW | CTLTYPE_STRING,
4115 	    "debug.acpi.level", 0, acpi_debug_sysctl, "A", "");
4116 #endif /* ACPI_DEBUG */
4117 
4118 static int
acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)4119 acpi_debug_objects_sysctl(SYSCTL_HANDLER_ARGS)
4120 {
4121 	int	error;
4122 	int	old;
4123 
4124 	old = acpi_debug_objects;
4125 	error = sysctl_handle_int(oidp, &acpi_debug_objects, 0, req);
4126 	if (error != 0 || req->newptr == NULL)
4127 		return (error);
4128 	if (old == acpi_debug_objects || (old && acpi_debug_objects))
4129 		return (0);
4130 
4131 	ACPI_SERIAL_BEGIN(acpi);
4132 	AcpiGbl_EnableAmlDebugObject = acpi_debug_objects ? TRUE : FALSE;
4133 	ACPI_SERIAL_END(acpi);
4134 
4135 	return (0);
4136 }
4137 
4138 static int
acpi_parse_interfaces(char * str,struct acpi_interface * iface)4139 acpi_parse_interfaces(char *str, struct acpi_interface *iface)
4140 {
4141 	char *p;
4142 	size_t len;
4143 	int i, j;
4144 
4145 	p = str;
4146 	while (isspace(*p) || *p == ',')
4147 		p++;
4148 	len = strlen(p);
4149 	if (len == 0)
4150 		return (0);
4151 	p = strdup(p, M_TEMP);
4152 	for (i = 0; i < len; i++)
4153 		if (p[i] == ',')
4154 			p[i] = '\0';
4155 	i = j = 0;
4156 	while (i < len)
4157 		if (isspace(p[i]) || p[i] == '\0')
4158 			i++;
4159 		else {
4160 			i += strlen(p + i) + 1;
4161 			j++;
4162 		}
4163 	if (j == 0) {
4164 		free(p, M_TEMP);
4165 		return (0);
4166 	}
4167 	iface->data = malloc(sizeof(*iface->data) * j, M_TEMP, M_WAITOK);
4168 	iface->num = j;
4169 	i = j = 0;
4170 	while (i < len)
4171 		if (isspace(p[i]) || p[i] == '\0')
4172 			i++;
4173 		else {
4174 			iface->data[j] = p + i;
4175 			i += strlen(p + i) + 1;
4176 			j++;
4177 		}
4178 
4179 	return (j);
4180 }
4181 
4182 static void
acpi_free_interfaces(struct acpi_interface * iface)4183 acpi_free_interfaces(struct acpi_interface *iface)
4184 {
4185 
4186 	free(iface->data[0], M_TEMP);
4187 	free(iface->data, M_TEMP);
4188 }
4189 
4190 static void
acpi_reset_interfaces(device_t dev)4191 acpi_reset_interfaces(device_t dev)
4192 {
4193 	struct acpi_interface list;
4194 	ACPI_STATUS status;
4195 	int i;
4196 
4197 	if (acpi_parse_interfaces(acpi_install_interface, &list) > 0) {
4198 		for (i = 0; i < list.num; i++) {
4199 			status = AcpiInstallInterface(list.data[i]);
4200 			if (ACPI_FAILURE(status))
4201 				device_printf(dev,
4202 				    "failed to install _OSI(\"%s\"): %s\n",
4203 				    list.data[i], AcpiFormatException(status));
4204 			else if (bootverbose)
4205 				device_printf(dev, "installed _OSI(\"%s\")\n",
4206 				    list.data[i]);
4207 		}
4208 		acpi_free_interfaces(&list);
4209 	}
4210 	if (acpi_parse_interfaces(acpi_remove_interface, &list) > 0) {
4211 		for (i = 0; i < list.num; i++) {
4212 			status = AcpiRemoveInterface(list.data[i]);
4213 			if (ACPI_FAILURE(status))
4214 				device_printf(dev,
4215 				    "failed to remove _OSI(\"%s\"): %s\n",
4216 				    list.data[i], AcpiFormatException(status));
4217 			else if (bootverbose)
4218 				device_printf(dev, "removed _OSI(\"%s\")\n",
4219 				    list.data[i]);
4220 		}
4221 		acpi_free_interfaces(&list);
4222 	}
4223 }
4224 
4225 static int
acpi_pm_func(u_long cmd,void * arg,...)4226 acpi_pm_func(u_long cmd, void *arg, ...)
4227 {
4228 	int	state, acpi_state;
4229 	int	error;
4230 	struct	acpi_softc *sc;
4231 	va_list	ap;
4232 
4233 	error = 0;
4234 	switch (cmd) {
4235 	case POWER_CMD_SUSPEND:
4236 		sc = (struct acpi_softc *)arg;
4237 		if (sc == NULL) {
4238 			error = EINVAL;
4239 			goto out;
4240 		}
4241 
4242 		va_start(ap, arg);
4243 		state = va_arg(ap, int);
4244 		va_end(ap);
4245 
4246 		switch (state) {
4247 		case POWER_SLEEP_STATE_STANDBY:
4248 			acpi_state = sc->acpi_standby_sx;
4249 			break;
4250 		case POWER_SLEEP_STATE_SUSPEND:
4251 			acpi_state = sc->acpi_suspend_sx;
4252 			break;
4253 		case POWER_SLEEP_STATE_HIBERNATE:
4254 			acpi_state = ACPI_STATE_S4;
4255 			break;
4256 		default:
4257 			error = EINVAL;
4258 			goto out;
4259 		}
4260 
4261 		if (ACPI_FAILURE(acpi_EnterSleepState(sc, acpi_state)))
4262 			error = ENXIO;
4263 		break;
4264 	default:
4265 		error = EINVAL;
4266 		goto out;
4267 	}
4268 
4269 out:
4270 	return (error);
4271 }
4272 
4273 static void
acpi_pm_register(void * arg)4274 acpi_pm_register(void *arg)
4275 {
4276     if (!cold || resource_disabled("acpi", 0))
4277 	return;
4278 
4279     power_pm_register(POWER_PM_TYPE_ACPI, acpi_pm_func, NULL);
4280 }
4281 
4282 SYSINIT(power, SI_SUB_KLD, SI_ORDER_ANY, acpi_pm_register, NULL);
4283