2 * Copyright (c) 2005-2006 Mitsuru IWASAKI <iwasaki@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/param.h>
32 #include <sys/kernel.h>
33 #include <sys/module.h>
35 #include <contrib/dev/acpica/include/acpi.h>
36 #include <contrib/dev/acpica/include/accommon.h>
38 #include <dev/acpica/acpivar.h>
39 #include <dev/acpica/acpiio.h>
41 /* Hooks for the ACPI CA debugging infrastructure */
42 #define _COMPONENT ACPI_DOCK
43 ACPI_MODULE_NAME("DOCK")
45 /* For Docking status */
46 #define ACPI_DOCK_STATUS_UNKNOWN -1
47 #define ACPI_DOCK_STATUS_UNDOCKED 0
48 #define ACPI_DOCK_STATUS_DOCKED 1
50 #define ACPI_DOCK_UNLOCK 0 /* Allow device to be ejected */
51 #define ACPI_DOCK_LOCK 1 /* Prevent dev from being removed */
53 #define ACPI_DOCK_ISOLATE 0 /* Isolate from dock connector */
54 #define ACPI_DOCK_CONNECT 1 /* Connect to dock */
56 struct acpi_dock_softc {
61 struct sysctl_ctx_list *sysctl_ctx;
62 struct sysctl_oid *sysctl_tree;
65 ACPI_SERIAL_DECL(dock, "ACPI Docking Station");
72 acpi_dock_get_info(device_t dev)
74 struct acpi_dock_softc *sc;
77 sc = device_get_softc(dev);
78 h = acpi_get_handle(dev);
80 if (ACPI_FAILURE(acpi_GetInteger(h, "_STA", &sc->_sta)))
81 sc->_sta = ACPI_DOCK_STATUS_UNKNOWN;
82 if (ACPI_FAILURE(acpi_GetInteger(h, "_BDN", &sc->_bdn)))
83 sc->_bdn = ACPI_DOCK_STATUS_UNKNOWN;
84 if (ACPI_FAILURE(acpi_GetInteger(h, "_UID", &sc->_uid)))
85 sc->_uid = ACPI_DOCK_STATUS_UNKNOWN;
86 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
87 "_STA: %04x, _BDN: %04x, _UID: %04x\n", sc->_sta,
92 acpi_dock_execute_dck(device_t dev, int dock)
96 ACPI_OBJECT_LIST args;
101 h = acpi_get_handle(dev);
103 argobj.Type = ACPI_TYPE_INTEGER;
104 argobj.Integer.Value = dock;
106 args.Pointer = &argobj;
107 buf.Pointer = &retobj;
108 buf.Length = sizeof(retobj);
109 status = AcpiEvaluateObject(h, "_DCK", &args, &buf);
112 * When _DCK is called with 0, OSPM will ignore the return value.
114 if (dock == ACPI_DOCK_ISOLATE)
117 /* If _DCK returned 1, the request succeeded. */
118 if (ACPI_SUCCESS(status) && retobj.Type == ACPI_TYPE_INTEGER &&
119 retobj.Integer.Value == 1)
125 /* Lock devices while docked to prevent surprise removal. */
127 acpi_dock_execute_lck(device_t dev, int lock)
131 h = acpi_get_handle(dev);
132 acpi_SetInteger(h, "_LCK", lock);
135 /* Eject a device (i.e., motorized). */
137 acpi_dock_execute_ejx(device_t dev, int eject, int state)
143 h = acpi_get_handle(dev);
144 snprintf(ejx, sizeof(ejx), "_EJ%d", state);
145 status = acpi_SetInteger(h, ejx, eject);
146 if (ACPI_SUCCESS(status))
152 /* Find dependent devices. When their parent is removed, so are they. */
154 acpi_dock_is_ejd_device(ACPI_HANDLE dock_handle, ACPI_HANDLE handle)
157 ACPI_STATUS ret_status;
158 ACPI_BUFFER ejd_buffer;
163 ejd_buffer.Pointer = NULL;
164 ejd_buffer.Length = ACPI_ALLOCATE_BUFFER;
165 ret_status = AcpiEvaluateObject(handle, "_EJD", NULL, &ejd_buffer);
166 if (ACPI_FAILURE(ret_status))
169 obj = (ACPI_OBJECT *)ejd_buffer.Pointer;
170 if (dock_handle == acpi_GetReference(NULL, obj))
174 if (ejd_buffer.Pointer != NULL)
175 AcpiOsFree(ejd_buffer.Pointer);
185 acpi_dock_attach_later(void *context)
189 dev = (device_t)context;
191 if (!device_is_enabled(dev))
195 device_probe_and_attach(dev);
200 acpi_dock_insert_child(ACPI_HANDLE handle, UINT32 level, void *context,
203 device_t dock_dev, dev;
204 ACPI_HANDLE dock_handle;
206 dock_dev = (device_t)context;
207 dock_handle = acpi_get_handle(dock_dev);
209 if (!acpi_dock_is_ejd_device(dock_handle, handle))
212 ACPI_VPRINT(dock_dev, acpi_device_get_parent_softc(dock_dev),
213 "inserting device for %s\n", acpi_name(handle));
217 * If the system boot up w/o Docking, the devices under the dock
218 * still un-initialized, also control methods such as _INI, _STA
220 * Normal devices are initialized at booting by calling
221 * AcpiInitializeObjects(), however the devices under the dock
222 * need to be initialized here on the scheme of ACPICA.
224 ACPI_INIT_WALK_INFO Info;
226 AcpiNsWalkNamespace(ACPI_TYPE_ANY, handle,
227 100, TRUE, AcpiNsInitOneDevice, NULL, &Info, NULL);
230 dev = acpi_get_device(handle);
232 device_printf(dock_dev, "error: %s has no associated device\n",
237 AcpiOsExecute(OSL_NOTIFY_HANDLER, acpi_dock_attach_later, dev);
244 acpi_dock_insert_children(device_t dev)
247 ACPI_HANDLE sb_handle;
249 status = AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle);
250 if (ACPI_SUCCESS(status)) {
251 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle,
252 100, acpi_dock_insert_child, NULL, dev, NULL);
257 acpi_dock_insert(device_t dev)
259 struct acpi_dock_softc *sc;
261 ACPI_SERIAL_ASSERT(dock);
263 sc = device_get_softc(dev);
265 if (sc->status == ACPI_DOCK_STATUS_UNDOCKED ||
266 sc->status == ACPI_DOCK_STATUS_UNKNOWN) {
267 acpi_dock_execute_lck(dev, ACPI_DOCK_LOCK);
268 if (acpi_dock_execute_dck(dev, ACPI_DOCK_CONNECT) != 0) {
269 device_printf(dev, "_DCK failed\n");
274 acpi_dock_insert_children(dev);
275 sc->status = ACPI_DOCK_STATUS_DOCKED;
284 acpi_dock_eject_child(ACPI_HANDLE handle, UINT32 level, void *context,
287 device_t dock_dev, dev;
288 ACPI_HANDLE dock_handle;
290 dock_dev = *(device_t *)context;
291 dock_handle = acpi_get_handle(dock_dev);
293 if (!acpi_dock_is_ejd_device(dock_handle, handle))
296 ACPI_VPRINT(dock_dev, acpi_device_get_parent_softc(dock_dev),
297 "ejecting device for %s\n", acpi_name(handle));
299 dev = acpi_get_device(handle);
300 if (dev != NULL && device_is_attached(dev)) {
306 acpi_SetInteger(handle, "_EJ0", 0);
312 acpi_dock_eject_children(device_t dev)
314 ACPI_HANDLE sb_handle;
317 status = AcpiGetHandle(ACPI_ROOT_OBJECT, "\\_SB_", &sb_handle);
318 if (ACPI_SUCCESS(status)) {
319 AcpiWalkNamespace(ACPI_TYPE_DEVICE, sb_handle,
320 100, acpi_dock_eject_child, NULL, &dev, NULL);
325 acpi_dock_removal(device_t dev)
327 struct acpi_dock_softc *sc;
329 ACPI_SERIAL_ASSERT(dock);
331 sc = device_get_softc(dev);
332 if (sc->status == ACPI_DOCK_STATUS_DOCKED ||
333 sc->status == ACPI_DOCK_STATUS_UNKNOWN) {
334 acpi_dock_eject_children(dev);
335 if (acpi_dock_execute_dck(dev, ACPI_DOCK_ISOLATE) != 0)
338 acpi_dock_execute_lck(dev, ACPI_DOCK_UNLOCK);
340 if (acpi_dock_execute_ejx(dev, 1, 0) != 0) {
341 device_printf(dev, "_EJ0 failed\n");
345 sc->status = ACPI_DOCK_STATUS_UNDOCKED;
348 acpi_dock_get_info(dev);
350 device_printf(dev, "mechanical failure (%#x).\n", sc->_sta);
358 acpi_dock_device_check(device_t dev)
360 struct acpi_dock_softc *sc;
362 ACPI_SERIAL_ASSERT(dock);
364 sc = device_get_softc(dev);
365 acpi_dock_get_info(dev);
368 * If the _STA method indicates 'present' and 'functioning', the
369 * system is docked. If _STA does not exist for this device, it
372 if (sc->_sta == ACPI_DOCK_STATUS_UNKNOWN ||
373 ACPI_DEVICE_PRESENT(sc->_sta))
374 acpi_dock_insert(dev);
375 else if (sc->_sta == 0)
376 acpi_dock_removal(dev);
384 acpi_dock_notify_handler(ACPI_HANDLE h, UINT32 notify, void *context)
388 dev = (device_t) context;
389 ACPI_VPRINT(dev, acpi_device_get_parent_softc(dev),
390 "got notification %#x\n", notify);
392 ACPI_SERIAL_BEGIN(dock);
394 case ACPI_NOTIFY_BUS_CHECK:
395 case ACPI_NOTIFY_DEVICE_CHECK:
396 acpi_dock_device_check(dev);
398 case ACPI_NOTIFY_EJECT_REQUEST:
399 acpi_dock_removal(dev);
402 device_printf(dev, "unknown notify %#x\n", notify);
405 ACPI_SERIAL_END(dock);
409 acpi_dock_status_sysctl(SYSCTL_HANDLER_ARGS)
411 struct acpi_dock_softc *sc;
415 dev = (device_t)arg1;
417 sc = device_get_softc(dev);
420 ACPI_SERIAL_BEGIN(dock);
421 err = sysctl_handle_int(oidp, &status, 0, req);
422 if (err != 0 || req->newptr == NULL)
425 if (status != ACPI_DOCK_STATUS_UNDOCKED &&
426 status != ACPI_DOCK_STATUS_DOCKED) {
431 if (status == sc->status)
435 case ACPI_DOCK_STATUS_UNDOCKED:
436 acpi_dock_removal(dev);
438 case ACPI_DOCK_STATUS_DOCKED:
439 acpi_dock_device_check(dev);
446 ACPI_SERIAL_END(dock);
451 acpi_dock_probe(device_t dev)
455 h = acpi_get_handle(dev);
456 if (acpi_disabled("dock") ||
457 ACPI_FAILURE(AcpiGetHandle(h, "_DCK", &tmp)))
460 device_set_desc(dev, "ACPI Docking Station");
463 * XXX Somewhere else in the kernel panics on "sysctl kern" if we
464 * return a negative value here (reprobe ok).
470 acpi_dock_attach(device_t dev)
472 struct acpi_dock_softc *sc;
475 sc = device_get_softc(dev);
476 h = acpi_get_handle(dev);
477 if (sc == NULL || h == NULL)
480 sc->status = ACPI_DOCK_STATUS_UNKNOWN;
482 AcpiEvaluateObject(h, "_INI", NULL, NULL);
484 ACPI_SERIAL_BEGIN(dock);
486 acpi_dock_device_check(dev);
488 /* Get the sysctl tree */
489 sc->sysctl_ctx = device_get_sysctl_ctx(dev);
490 sc->sysctl_tree = device_get_sysctl_tree(dev);
492 SYSCTL_ADD_INT(sc->sysctl_ctx,
493 SYSCTL_CHILDREN(sc->sysctl_tree),
494 OID_AUTO, "_sta", CTLFLAG_RD,
495 &sc->_sta, 0, "Dock _STA");
496 SYSCTL_ADD_INT(sc->sysctl_ctx,
497 SYSCTL_CHILDREN(sc->sysctl_tree),
498 OID_AUTO, "_bdn", CTLFLAG_RD,
499 &sc->_bdn, 0, "Dock _BDN");
500 SYSCTL_ADD_INT(sc->sysctl_ctx,
501 SYSCTL_CHILDREN(sc->sysctl_tree),
502 OID_AUTO, "_uid", CTLFLAG_RD,
503 &sc->_uid, 0, "Dock _UID");
504 SYSCTL_ADD_PROC(sc->sysctl_ctx,
505 SYSCTL_CHILDREN(sc->sysctl_tree),
507 CTLTYPE_INT|CTLFLAG_RW, dev, 0,
508 acpi_dock_status_sysctl, "I",
509 "Dock/Undock operation");
511 ACPI_SERIAL_END(dock);
513 AcpiInstallNotifyHandler(h, ACPI_ALL_NOTIFY,
514 acpi_dock_notify_handler, dev);
519 static device_method_t acpi_dock_methods[] = {
520 /* Device interface */
521 DEVMETHOD(device_probe, acpi_dock_probe),
522 DEVMETHOD(device_attach, acpi_dock_attach),
527 static driver_t acpi_dock_driver = {
530 sizeof(struct acpi_dock_softc),
533 static devclass_t acpi_dock_devclass;
535 DRIVER_MODULE(acpi_dock, acpi, acpi_dock_driver, acpi_dock_devclass, 0, 0);
536 MODULE_DEPEND(acpi_dock, acpi, 1, 1, 1);