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