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