diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile --- a/share/man/man4/Makefile +++ b/share/man/man4/Makefile @@ -8,6 +8,7 @@ acpi.4 \ ${_acpi_asus.4} \ ${_acpi_asus_wmi.4} \ + ${_acpi_cros_tbmc.4} \ ${_acpi_dock.4} \ ${_acpi_fujitsu.4} \ ${_acpi_hp.4} \ @@ -775,6 +776,7 @@ .if ${MACHINE_CPUARCH} == "amd64" || ${MACHINE_CPUARCH} == "i386" _acpi_asus.4= acpi_asus.4 _acpi_asus_wmi.4= acpi_asus_wmi.4 +_acpi_cros_tbmc.4= acpi_cros_tbmc.4 _acpi_dock.4= acpi_dock.4 _acpi_fujitsu.4=acpi_fujitsu.4 _acpi_hp.4= acpi_hp.4 diff --git a/share/man/man4/acpi_cros_tbmc.4 b/share/man/man4/acpi_cros_tbmc.4 new file mode 100644 --- /dev/null +++ b/share/man/man4/acpi_cros_tbmc.4 @@ -0,0 +1,67 @@ +.\" Copyright (c) 2023 Val Packett +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.Dd February 4, 2023 +.Dt ACPI_CROS_TBMC 4 +.Os +.Sh NAME +.Nm acpi_cros_tbmc +.Nd "ACPI tablet mode switch driver for Chromebooks" +.Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent +.Cd "device acpi_cros_tbmc" +.Cd "device evdev" +.Ed +.Pp +Alternatively, to load the driver as a +module at boot time, place the following line in +.Xr loader.conf 5 : +.Bd -literal -offset indent +acpi_cros_tbmc_load="YES" +.Ed +.Sh DESCRIPTION +The +.Nm +driver provides support for tablet mode detection for ChromeOS convertibles. +.Pp +The +.Pa /dev/input/eventX +device presents the switch as an +.Ar evdev +type device. +.Sh SEE ALSO +.Xr acpi 4 +.Sh HISTORY +The +.Nm +device driver first appeared in +.Fx 14.0 . +.Sh AUTHORS +.An -nosplit +The +.Nm +driver was written by +.An Val Packett Aq Mt val@packett.cool diff --git a/sys/conf/files b/sys/conf/files --- a/sys/conf/files +++ b/sys/conf/files @@ -784,6 +784,7 @@ dev/acpi_support/acpi_wmi.c optional acpi_wmi acpi dev/acpi_support/acpi_asus.c optional acpi_asus acpi dev/acpi_support/acpi_asus_wmi.c optional acpi_asus_wmi acpi +dev/acpi_support/acpi_cros_tbmc.c optional acpi_cros_tbmc acpi dev/acpi_support/acpi_fujitsu.c optional acpi_fujitsu acpi dev/acpi_support/acpi_hp.c optional acpi_hp acpi dev/acpi_support/acpi_ibm.c optional acpi_ibm acpi diff --git a/sys/dev/acpi_support/acpi_cros_tbmc.c b/sys/dev/acpi_support/acpi_cros_tbmc.c new file mode 100644 --- /dev/null +++ b/sys/dev/acpi_support/acpi_cros_tbmc.c @@ -0,0 +1,177 @@ +/*- + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2019 Val Packett + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include + +#include "opt_acpi.h" +#include +#include +#include +#include +#include + +#include +#include + +#include "acpi_if.h" +#include +#include +#include +#include + +ACPI_MODULE_NAME("CROS_TBMC") + +struct acpi_cros_tbmc_softc { + device_t dev; + ACPI_HANDLE handle; + + struct evdev_dev *evdev; +}; + +static void +acpi_cros_tbmc_read_status(struct acpi_cros_tbmc_softc *sc) +{ + int32_t val = 0; + + ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); + + if (ACPI_FAILURE(acpi_GetInteger(sc->handle, "TBMC", &val))) { + device_printf(sc->dev, "ACPI failure\n"); + return; + } + + evdev_push_sw(sc->evdev, SW_TABLET_MODE, val); + evdev_sync(sc->evdev); +} + +static void +acpi_cros_tbmc_notify(ACPI_HANDLE h, UINT32 notify, void *context) +{ + device_t dev = context; + struct acpi_cros_tbmc_softc *sc = device_get_softc(dev); + + ACPI_FUNCTION_TRACE_U32((char *)(uintptr_t)__func__, notify); + + if (notify != 0x80) + device_printf(dev, "Unknown notify\n"); + + acpi_cros_tbmc_read_status(sc); +} + +static int +acpi_cros_tbmc_resume(device_t dev) +{ + struct acpi_cros_tbmc_softc *sc = device_get_softc(dev); + + ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); + + acpi_cros_tbmc_read_status(sc); + + return (0); +} + +static char *cros_tbmc_ids[] = {"GOOG0006", NULL}; + +static int +acpi_cros_tbmc_probe(device_t dev) +{ + int rv; + + if (acpi_disabled("cros_tbmc") || + device_get_unit(dev) != 0) + return (ENXIO); + + rv = ACPI_ID_PROBE(device_get_parent(dev), dev, cros_tbmc_ids, NULL); + + if (rv <= 0) + device_set_desc(dev, "Chromebook Tablet Mode Switch"); + + return (rv); +} + +static int +acpi_cros_tbmc_attach(device_t dev) +{ + struct acpi_cros_tbmc_softc *sc; + + ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); + + sc = device_get_softc(dev); + sc->dev = dev; + sc->handle = acpi_get_handle(dev); + + sc->evdev = evdev_alloc(); + evdev_set_name(sc->evdev, device_get_desc(dev)); + evdev_set_phys(sc->evdev, device_get_nameunit(dev)); + evdev_set_id(sc->evdev, BUS_HOST, 0, 0, 1); + evdev_support_event(sc->evdev, EV_SYN); + evdev_support_event(sc->evdev, EV_SW); + evdev_support_sw(sc->evdev, SW_TABLET_MODE); + + if (evdev_register(sc->evdev)) + return (ENXIO); + + AcpiInstallNotifyHandler(sc->handle, ACPI_ALL_NOTIFY, + acpi_cros_tbmc_notify, dev); + + acpi_cros_tbmc_read_status(sc); + + return (0); +} + +static int +acpi_cros_tbmc_detach(device_t dev) +{ + ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); + + struct acpi_cros_tbmc_softc *sc = device_get_softc(dev); + + AcpiRemoveNotifyHandler(sc->handle, ACPI_ALL_NOTIFY, acpi_cros_tbmc_notify); + evdev_free(sc->evdev); + + return (0); +} + +static device_method_t acpi_cros_tbmc_methods[] = { + /* Device interface */ + DEVMETHOD(device_probe, acpi_cros_tbmc_probe), + DEVMETHOD(device_attach, acpi_cros_tbmc_attach), + DEVMETHOD(device_detach, acpi_cros_tbmc_detach), + DEVMETHOD(device_resume, acpi_cros_tbmc_resume), + + DEVMETHOD_END +}; + +static driver_t acpi_cros_tbmc_driver = { + "acpi_cros_tbmc", + acpi_cros_tbmc_methods, + sizeof(struct acpi_cros_tbmc_softc), +}; + +DRIVER_MODULE(acpi_cros_tbmc, acpi, acpi_cros_tbmc_driver, 0, 0); +MODULE_DEPEND(acpi_cros_tbmc, acpi, 1, 1, 1); +MODULE_DEPEND(acpi_cros_tbmc, evdev, 1, 1, 1); diff --git a/sys/modules/acpi/Makefile b/sys/modules/acpi/Makefile --- a/sys/modules/acpi/Makefile +++ b/sys/modules/acpi/Makefile @@ -1,6 +1,6 @@ # $FreeBSD$ -SUBDIR= acpi_asus acpi_asus_wmi acpi_dock acpi_fujitsu acpi_hp \ +SUBDIR= acpi_asus acpi_asus_wmi acpi_cros_tbmc acpi_dock acpi_fujitsu acpi_hp \ acpi_ged acpi_ibm acpi_panasonic acpi_sony acpi_toshiba \ acpi_video acpi_wmi aibs diff --git a/sys/modules/acpi/acpi_cros_tbmc/Makefile b/sys/modules/acpi/acpi_cros_tbmc/Makefile new file mode 100644 --- /dev/null +++ b/sys/modules/acpi/acpi_cros_tbmc/Makefile @@ -0,0 +1,5 @@ +.PATH: ${SRCTOP}/sys/dev/acpi_support +KMOD= acpi_cros_tbmc +SRCS= acpi_cros_tbmc.c opt_acpi.h device_if.h bus_if.h acpi_if.h + +.include