Introduce acpiasus(4), a driver for the ACPI based hotkeys found in many

ASUS laptops (including the ASUS EeePC) - largely based on NetBSD's
asus(4) driver. On the ASUS EeePC this allows us to enable/disable
wireless, change screen brightness and use the volume keys.

ok jsg@, weingart@

8 files changed, 277 insertions, 8 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 77371ee9bb7..0a674c3d293 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,7 +1,7 @@
-#	$OpenBSD: Makefile,v 1.449 2008/04/23 13:28:58 jsg Exp $
+#	$OpenBSD: Makefile,v 1.450 2008/04/24 13:57:49 jsing Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
-	acpi.4 acpiac.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
+	acpi.4 acpiac.4 acpiasus.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
 	acpiec.4 acpihpet.4 acpimadt.4 acpiprt.4 acpitimer.4 acpitz.4 \
 	acx.4 adc.4 addcom.4 adl.4 admcts.4 admlc.4 admtemp.4 \
 	admtm.4 admtmp.4 admtt.4 adt.4 adtfsm.4 adv.4 agp.4 \
diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4
index cfb3b31e2b5..1b1dac7d8c7 100644
--- a/share/man/man4/acpi.4
+++ b/share/man/man4/acpi.4
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: acpi.4,v 1.28 2007/12/05 19:17:12 deraadt Exp $
+.\"	$OpenBSD: acpi.4,v 1.29 2008/04/24 13:57:49 jsing Exp $
 .\"
 .\" Copyright (c) 2006 Alexander Yurchenko <grange@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: December 5 2007 $
+.Dd $Mdocdate: April 24 2008 $
 .Dt ACPI 4
 .Os
 .Sh NAME
@@ -47,6 +47,8 @@ The following devices can attach to
 .Bl -tag -width "acpitimer(4)XXX" -offset indent -compact
 .It Xr acpiac 4
 ACPI AC adapter
+.It Xr acpiasus 4
+ASUS ACPI hotkeys
 .It Xr acpibat 4
 ACPI control method battery
 .It Xr acpibtn 4
diff --git a/share/man/man4/acpiasus.4 b/share/man/man4/acpiasus.4
new file mode 100644
index 00000000000..5f413259ea8
--- /dev/null
+++ b/share/man/man4/acpiasus.4
@@ -0,0 +1,45 @@
+.\"	$OpenBSD: acpiasus.4,v 1.1 2008/04/24 13:57:49 jsing Exp $
+.\"
+.\" Copyright (c) 2008 Joel Sing (jsing@openbsd.org)
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: April 24 2008 $
+.Dt ACPIASUS 4
+.Os
+.Sh NAME
+.Nm acpiasus
+.Nd ASUS ACPI hotkeys
+.Sh SYNOPSIS
+.Cd "acpiasus* at acpi?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the ACPI based hotkeys found in many ASUS laptops,
+including the ASUS EeePC.
+.Sh SEE ALSO
+.Xr acpi 4 ,
+.Xr intro 4
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.4 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by Jared D. McNeill and was ported to
+.Ox
+by
+.An Joel Sing Aq jsing@openbsd.org .
diff --git a/sys/arch/i386/conf/GENERIC b/sys/arch/i386/conf/GENERIC
index 3fdfd7d6b2e..80d1858e681 100644
--- a/sys/arch/i386/conf/GENERIC
+++ b/sys/arch/i386/conf/GENERIC
@@ -1,4 +1,4 @@
-#	$OpenBSD: GENERIC,v 1.612 2008/04/19 01:18:39 djm Exp $
+#	$OpenBSD: GENERIC,v 1.613 2008/04/24 13:57:49 jsing Exp $
 #
 # For further information on compiling OpenBSD kernels, see the config(8)
 # man page.
@@ -57,6 +57,7 @@ acpicpu*	at acpi?
 acpiec*		at acpi?
 acpiprt*	at acpi?
 acpitz*		at acpi?
+acpiasus*	at acpi?
 
 option		PCIVERBOSE
 option		EISAVERBOSE
diff --git a/sys/dev/acpi/acpi.c b/sys/dev/acpi/acpi.c
index 2519faacc53..cb7827566df 100644
--- a/sys/dev/acpi/acpi.c
+++ b/sys/dev/acpi/acpi.c
@@ -1,4 +1,4 @@
-/*	$OpenBSD: acpi.c,v 1.114 2008/04/12 12:49:28 kettenis Exp $	*/
+/*	$OpenBSD: acpi.c,v 1.115 2008/04/24 13:57:49 jsing Exp $	*/
 /*
  * Copyright (c) 2005 Thorsten Lockert <tholo@sigmasoft.com>
  * Copyright (c) 2005 Jordan Hargrave <jordan@openbsd.org>
@@ -1853,6 +1853,8 @@ acpi_foundhid(struct aml_node *node, void *arg)
 	    !strcmp(dev, ACPI_DEV_PBD) ||
 	    !strcmp(dev, ACPI_DEV_SBD))
 		aaa.aaa_name = "acpibtn";
+	else if (!strcmp(dev, ACPI_DEV_ASUS))
+		aaa.aaa_name = "acpiasus";
 
 	if (aaa.aaa_name)
 		config_found(self, &aaa, acpi_print);
diff --git a/sys/dev/acpi/acpiasus.c b/sys/dev/acpi/acpiasus.c
new file mode 100644
index 00000000000..78e23f2bc02
--- /dev/null
+++ b/sys/dev/acpi/acpiasus.c
@@ -0,0 +1,214 @@
+/* $OpenBSD: acpiasus.c,v 1.1 2008/04/24 13:57:49 jsing Exp $ */
+/* $NetBSD: asus_acpi.c,v 1.2.2.2 2008/04/03 12:42:37 mjf Exp $ */
+
+/*-
+ * Copyright (c) 2007, 2008 Jared D. McNeill <jmcneill@invisible.ca>
+ * All rights reserved.
+ *
+ * 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.
+ * 3. All advertising materials mentioning features or use of this software
+ *    must display the following acknowledgement:
+ *        This product includes software developed by Jared D. McNeill.
+ * 4. Neither the name of The NetBSD Foundation nor the names of its
+ *    contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
+ */
+
+/*
+ * ASUS ACPI hotkeys driver.
+ */
+
+#include <sys/param.h>
+#include <sys/device.h>
+#include <sys/systm.h>
+#include <sys/workq.h>
+
+#include <dev/acpi/acpireg.h>
+#include <dev/acpi/acpivar.h>
+#include <dev/acpi/acpidev.h>
+#include <dev/acpi/amltypes.h>
+#include <dev/acpi/dsdt.h>
+
+#include "audio.h"
+#include "wskbd.h"
+
+struct acpiasus_softc {
+	struct device		sc_dev;
+
+	struct acpi_softc	*sc_acpi;
+	struct aml_node		*sc_devnode;
+
+	void 			*sc_powerhook;
+};
+
+#define ASUS_NOTIFY_WirelessSwitch	0x10
+#define ASUS_NOTIFY_BrightnessLow	0x20
+#define ASUS_NOTIFY_BrightnessHigh	0x2f
+#define ASUS_NOTIFY_DisplayCycle	0x30
+#define ASUS_NOTIFY_TaskSwitch		0x12
+#define ASUS_NOTIFY_VolumeMute		0x13
+#define ASUS_NOTIFY_VolumeDown		0x14
+#define ASUS_NOTIFY_VolumeUp		0x15
+
+#define	ASUS_SDSP_LCD			0x01
+#define	ASUS_SDSP_CRT			0x02
+#define	ASUS_SDSP_TV			0x04
+#define	ASUS_SDSP_DVI			0x08
+#define	ASUS_SDSP_ALL \
+	(ASUS_SDSP_LCD | ASUS_SDSP_CRT | ASUS_SDSP_TV | ASUS_SDSP_DVI)
+
+int	acpiasus_match(struct device *, void *, void *);
+void	acpiasus_attach(struct device *, struct device *, void *);
+void	acpiasus_init(struct device *);
+int	acpiasus_notify(struct aml_node *, int, void *);
+void	acpiasus_power(int, void *);
+
+#if NAUDIO > 0 && NWSKBD > 0
+extern int wskbd_set_mixervolume(long dir);
+#endif
+
+struct cfattach acpiasus_ca = {
+	sizeof(struct acpiasus_softc), acpiasus_match, acpiasus_attach
+};
+
+struct cfdriver acpiasus_cd = {
+	NULL, "acpiasus", DV_DULL
+};
+
+int
+acpiasus_match(struct device *parent, void *match, void *aux)
+{
+	struct acpi_attach_args *aa = aux;
+	struct cfdata *cf = match;
+
+	if (aa->aaa_name == NULL ||
+	    strcmp(aa->aaa_name, cf->cf_driver->cd_name) != 0 ||
+	    aa->aaa_table != NULL)
+		return 0;
+
+	return 1;
+}
+
+void
+acpiasus_attach(struct device *parent, struct device *self, void *aux)
+{
+	struct acpiasus_softc *sc = (struct acpiasus_softc *)self;
+	struct acpi_attach_args *aa = aux;
+
+	sc->sc_acpi = (struct acpi_softc *)parent;
+	sc->sc_devnode = aa->aaa_node->child;
+
+	sc->sc_powerhook = powerhook_establish(acpiasus_power, sc);
+
+	printf("\n");
+
+	acpiasus_init(self);
+
+	aml_register_notify(sc->sc_devnode->parent, aa->aaa_dev,
+	    acpiasus_notify, sc, ACPIDEV_NOPOLL);
+}
+
+void
+acpiasus_init(struct device *self)
+{
+	struct acpiasus_softc *sc = (struct acpiasus_softc *)self;
+	struct aml_value cmd;
+	struct aml_value ret;
+
+	cmd.type = AML_OBJTYPE_INTEGER;
+	cmd.v_integer = 0x40;		/* Disable ASL display switching. */
+
+	if (aml_evalname(sc->sc_acpi, sc->sc_devnode, "INIT", 1, &cmd, &ret))
+		printf("%s: no INIT\n", DEVNAME(sc));
+}
+
+int
+acpiasus_notify(struct aml_node *node, int notify, void *arg)
+{
+	struct acpiasus_softc *sc = arg;
+
+	if (notify >= ASUS_NOTIFY_BrightnessLow &&
+	    notify <= ASUS_NOTIFY_BrightnessHigh) {
+#if ACPIASUS_DEBUG
+		printf("%s: brightness %d percent\n", DEVNAME(sc),
+		    (notify & 0xf) * 100 / 0xf);
+#endif
+		return 0;
+	}
+
+	switch (notify) {
+	case ASUS_NOTIFY_WirelessSwitch:	/* Handled by AML. */
+		break;
+	case ASUS_NOTIFY_TaskSwitch:
+		break;
+	case ASUS_NOTIFY_DisplayCycle:
+		break;
+#if NAUDIO > 0 && NWSKBD > 0
+	case ASUS_NOTIFY_VolumeMute:
+		workq_add_task(NULL, 0, (workq_fn)wskbd_set_mixervolume,
+		    (void *)(long)0, NULL);
+		break;
+	case ASUS_NOTIFY_VolumeDown:
+		workq_add_task(NULL, 0, (workq_fn)wskbd_set_mixervolume,
+		    (void *)(long)-1, NULL);
+		break;
+	case ASUS_NOTIFY_VolumeUp:
+		workq_add_task(NULL, 0, (workq_fn)wskbd_set_mixervolume,
+		    (void *)(long)1, NULL);
+		break;
+#else
+	case ASUS_NOTIFY_VolumeMute:
+	case ASUS_NOTIFY_VolumeDown:
+	case ASUS_NOTIFY_VolumeUp:
+		break;
+#endif
+	default:
+		printf("%s: unknown event 0x%02x\n", DEVNAME(sc), notify);
+		break;
+	}
+
+	return 0;
+}
+
+void
+acpiasus_power(int why, void *arg)
+{
+	struct acpiasus_softc *sc = (struct acpiasus_softc *)arg;
+	struct aml_value cmd;
+	struct aml_value ret;
+
+	switch (why) {
+	case PWR_STANDBY:
+	case PWR_SUSPEND:
+		break;
+	case PWR_RESUME:
+		acpiasus_init(arg);
+
+		cmd.type = AML_OBJTYPE_INTEGER;
+		cmd.v_integer = ASUS_SDSP_LCD;
+
+		if (aml_evalname(sc->sc_acpi, sc->sc_devnode, "SDSP", 1,
+		    &cmd, &ret))
+			printf("%s: no SDSP\n", DEVNAME(sc));
+		break;
+	}
+}
diff --git a/sys/dev/acpi/acpireg.h b/sys/dev/acpi/acpireg.h
index f8356056f8b..e2e42e311df 100644
--- a/sys/dev/acpi/acpireg.h
+++ b/sys/dev/acpi/acpireg.h
@@ -1,4 +1,4 @@
-/*	$OpenBSD: acpireg.h,v 1.12 2006/12/12 18:07:25 mk Exp $	*/
+/*	$OpenBSD: acpireg.h,v 1.13 2008/04/24 13:57:49 jsing Exp $	*/
 /*
  * Copyright (c) 2005 Thorsten Lockert <tholo@sigmasoft.com>
  * Copyright (c) 2005 Marco Peereboom <marco@openbsd.org>
@@ -484,5 +484,6 @@ struct acpi_facs {
 #define ACPI_DEV_IOSA	"ACPI000B"	/* IO SAPIC Device */
 #define ACPI_DEV_THZ	"THERMALZONE"	/* Thermal Zone */
 #define ACPI_DEV_FFB	"FIXEDBUTTON"	/* Fixed Feature Button */
+#define ACPI_DEV_ASUS	"ASUS010"	/* ASUS Hotkeys */
 
 #endif	/* !_DEV_ACPI_ACPIREG_H_ */
diff --git a/sys/dev/acpi/files.acpi b/sys/dev/acpi/files.acpi
index c24ade21fc5..62f2ff27020 100644
--- a/sys/dev/acpi/files.acpi
+++ b/sys/dev/acpi/files.acpi
@@ -1,4 +1,4 @@
-#	$OpenBSD: files.acpi,v 1.16 2007/12/05 19:17:13 deraadt Exp $
+#	$OpenBSD: files.acpi,v 1.17 2008/04/24 13:57:49 jsing Exp $
 #
 # Config file and device description for machine-independent ACPI code.
 # Included by ports that need it.
@@ -66,3 +66,7 @@ device	acpidock
 attach	acpidock at acpi
 file	dev/acpi/acpidock.c		acpidock
 
+# ASUS ACPI Hotkeys
+device	acpiasus
+attach	acpiasus at acpi
+file	dev/acpi/acpiasus.c		acpiasus