xref: /freebsd/share/man/man4/acpi_asus_wmi.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\"
2.\" Copyright (c) 2012 Alexander Motin <mav@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
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.
13.\"
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
24.\" SUCH DAMAGE.
25.\"
26.Dd July 2, 2012
27.Dt ACPI_ASUS_WMI 4
28.Os
29.Sh NAME
30.Nm acpi_asus_wmi
31.Nd Asus Laptop WMI Extras
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following line in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device acpi_asus_wmi"
38.Ed
39.Pp
40Alternatively, to load the driver as a
41module at boot time, place the following line in
42.Xr loader.conf 5 :
43.Bd -literal -offset indent
44acpi_asus_wmi_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for the extra WMI-controlled gadgets, such as hotkeys
50and leds, found on Asus laptops.
51It allows one to use the
52.Xr sysctl 8
53interface to manipulate the brightness of the LCD panel and keyboard backlight,
54power on/off different internal components, such as WiFi, Bluetooth, camera,
55cardreader, etc, read some sensors.
56Hotkey events are passed to
57.Xr devd 8
58for easy handling in userspace with the default configuration in
59.Pa /etc/devd/asus.conf .
60Some hotkey events, such as keyboard backlight and touchpad control, are
61handled inside the driver.
62.Sh SYSCTL VARIABLES
63The following sysctls are currently implemented:
64.Bl -tag -width indent
65.It Va dev.acpi_asus_wmi.0.handle_keys
66Specifies whether driver should handle some harwdare keys, such as keyboard
67backlight, internally.
68.El
69.Pp
70Number of other variables under the same sysctl branch are model-specific.
71.Pp
72Defaults for these variables can be set in
73.Xr sysctl.conf 5 ,
74which is parsed at boot-time.
75.Sh SEE ALSO
76.Xr acpi 4 ,
77.Xr acpi_asus 4 ,
78.Xr acpi_video 4 ,
79.Xr sysctl.conf 5 ,
80.Xr devd 8 ,
81.Xr sysctl 8
82.Sh HISTORY
83The
84.Nm
85driver first appeared in
86.Fx 10.0 .
87.Sh AUTHORS
88.An Alexander Motin Aq Mt mav@FreeBSD.org
89