dma: rework config parsing
[dragonfly.git] / share / man / man4 / acpi_asus.4
blob62fbdef2c425be5bdbe67338c86957c84abce10f
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 .\" $FreeBSD: src/share/man/man4/acpi_asus.4,v 1.3 2008/08/21 00:40:55 rpaulo Exp $
27 .\"
28 .Dd August 20, 2008
29 .Dt ACPI_ASUS 4 i386
30 .Os
31 .Sh NAME
32 .Nm acpi_asus
33 .Nd Asus Laptop Extras
34 .Sh SYNOPSIS
35 To compile this driver into the kernel,
36 place the following line in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
39 .Cd "device acpi_asus"
40 .Ed
41 .Pp
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
44 .Xr loader.conf 5 :
45 .Bd -literal -offset indent
46 acpi_asus_load="YES"
47 .Ed
48 .Sh DESCRIPTION
49 The
50 .Nm
51 driver provides support for the extra ACPI-controlled gadgets, such as hotkeys
52 and leds, found on recent Asus (and Medion) laptops.
53 It allows one to use the
54 .Xr sysctl 8
55 interface to manipulate the brightness of the LCD panel and the display output
56 state.
57 Hotkey events are passed to
58 .Xr devd 8
59 for easy handling in userspace.
60 .Pp
61 Currently, the following Asus laptops are fully supported:
62 .Pp
63 .Bl -item -offset indent -compact
64 .It
65 xxN
66 .It
67 A1x
68 .It
69 A2x
70 .It
71 A3N
72 .It
73 A4D
74 .It
75 A6VM
76 .It
77 D1x
78 .It
79 J1x
80 .It
81 L2B
82 .It
83 L2D
84 .It
85 L2E
86 .It
87 L3C
88 .It
89 L3D
90 .It
91 L3H
92 .It
93 L4E
94 .It
95 L4R
96 .It
97 L5x
98 .It
99 L8x
117 Eee PC
120 Additionally,
122 also supports the Asus-compatible
123 .Em ATK0100
124 interface found in
125 .Em Samsung P30/P35
126 laptops.
127 .Sh SYSCTL VARIABLES
128 The following sysctls are currently implemented:
129 .Bl -tag -width indent
130 .It Va hw.acpi.asus.lcd_brightness
131 Makes the LCD backlight brighter or dimmer (higher values are brighter).
132 .It Va hw.acpi.asus.lcd_backlight
133 Turns the LCD backlight on or off.
134 .It Va hw.acpi.asus.video_output
135 Sets the active display to use according to a bitwise OR of the following:
137 .Bl -tag -width indent -compact
138 .It Li 0
139 No display
140 .It Li 1
142 .It Li 2
144 .It Li 4
145 TV-Out
148 Some models also support video switching via the generic
149 .Xr acpi_video 4
150 driver.
151 Most models do not, however.
154 Defaults for these variables can be set in
155 .Xr sysctl.conf 5 ,
156 which is parsed at boot-time.
157 .Sh SEE ALSO
158 .Xr acpi 4 ,
159 .Xr acpi_video 4 ,
160 .Xr sysctl.conf 5 ,
161 .Xr sysctl 8
163 .%T The acpi4asus Project
164 .%O http://sourceforge.net/projects/acpi4asus/
166 .Sh HISTORY
169 driver first appeared in
170 .Fx 5.3 .
171 .Sh AUTHORS
172 .An -nosplit
175 driver and this manual page were written by
176 .An Philip Paeps Aq philip@FreeBSD.org .
178 Inspiration came from the
179 .Em acpi4asus project
180 started by
181 .An Julien Lerouge
182 which maintains a driver implementing this
183 functionality in the
184 .Tn Linux
185 kernel.