xref: /freebsd/share/man/man4/acpi_asus.4 (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
1.\"
2.\" Copyright (c) 2004 Philip Paeps <philip@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 February 8, 2010
27.Dt ACPI_ASUS 4
28.Os
29.Sh NAME
30.Nm acpi_asus
31.Nd Asus Laptop 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"
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_load="YES"
45.Ed
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for the extra ACPI-controlled gadgets, such as hotkeys
50and leds, found on recent Asus (and Medion) laptops.
51It allows one to use the
52.Xr sysctl 8
53interface to manipulate the brightness of the LCD panel and the display output
54state.
55Hotkey events are passed to
56.Xr devd 8
57for easy handling in userspace with the default configuration in
58.Pa /etc/devd/asus.conf .
59.Pp
60Currently, the following Asus laptops are fully supported:
61.Pp
62.Bl -item -offset indent -compact
63.It
64xxN
65.It
66A1x
67.It
68A2x
69.It
70A3N
71.It
72A4D
73.It
74A6VM
75.It
76D1x
77.It
78J1x
79.It
80L2B
81.It
82L2D
83.It
84L2E
85.It
86L3C
87.It
88L3D
89.It
90L3H
91.It
92L4E
93.It
94L4R
95.It
96L5x
97.It
98L8x
99.It
100M1A
101.It
102M2E
103.It
104M6N
105.It
106M6R
107.It
108S1x
109.It
110S2x
111.It
112V6V
113.It
114W5A
115.It
116Eee PC
117.El
118.Pp
119Additionally,
120.Nm
121also supports the Asus-compatible
122.Em ATK0100
123interface found in
124.Em Samsung P30/P35
125laptops.
126.Sh SYSCTL VARIABLES
127The following sysctls are currently implemented:
128.Bl -tag -width indent
129.It Va hw.acpi.asus.lcd_brightness
130Makes the LCD backlight brighter or dimmer (higher values are brighter).
131.It Va hw.acpi.asus.lcd_backlight
132Turns the LCD backlight on or off.
133.It Va hw.acpi.asus.video_output
134Sets the active display to use according to a bitwise OR of the following:
135.Pp
136.Bl -tag -width indent -compact
137.It Li 0
138No display
139.It Li 1
140LCD
141.It Li 2
142CRT
143.It Li 4
144TV-Out
145.El
146.Pp
147Some models also support video switching via the generic
148.Xr acpi_video 4
149driver.
150Most models do not, however.
151.El
152.Pp
153Defaults for these variables can be set in
154.Xr sysctl.conf 5 ,
155which is parsed at boot-time.
156.Sh SEE ALSO
157.Xr acpi 4 ,
158.Xr acpi_asus_wmi 4 ,
159.Xr acpi_video 4 ,
160.Xr sysctl.conf 5 ,
161.Xr sysctl 8
162.Rs
163.%T The acpi4asus Project
164.%U http://sourceforge.net/projects/acpi4asus/
165.Re
166.Sh HISTORY
167The
168.Nm
169driver first appeared in
170.Fx 5.3 .
171.Sh AUTHORS
172.An -nosplit
173The
174.Nm
175driver and this manual page were written by
176.An Philip Paeps Aq Mt philip@FreeBSD.org .
177.Pp
178Inspiration came from the
179.Em acpi4asus project
180started by
181.An Julien Lerouge
182which maintains a driver implementing this
183functionality in the
184.Tn Linux
185kernel.
186