share/man/man4/acpi_asus.4

   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
  33 To compile this driver into the kernel,
  34 place the following line in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device acpi_asus"
  38 .Ed
  39 .Pp
  40 Alternatively, to load the driver as a
  41 module at boot time, place the following line in
  42 .Xr loader.conf 5 :
  43 .Bd -literal -offset indent
  44 acpi_asus_load="YES"
  45 .Ed
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 driver provides support for the extra ACPI-controlled gadgets, such as hotkeys
  50 and leds, found on recent Asus (and Medion) laptops.
  51 It allows one to use the
  52 .Xr sysctl 8
  53 interface to manipulate the brightness of the LCD panel and the display output
  54 state.
  55 Hotkey events are passed to
  56 .Xr devd 8
  57 for easy handling in userspace with the default configuration in
  58 .Pa /etc/devd/asus.conf .
  59 .Pp
  60 Currently, the following Asus laptops are fully supported:
  61 .Pp
  62 .Bl -item -offset indent -compact
  63 .It
  64 xxN
  65 .It
  66 A1x
  67 .It
  68 A2x
  69 .It
  70 A3N
  71 .It
  72 A4D
  73 .It
  74 A6VM
  75 .It
  76 D1x
  77 .It
  78 J1x
  79 .It
  80 L2B
  81 .It
  82 L2D
  83 .It
  84 L2E
  85 .It
  86 L3C
  87 .It
  88 L3D
  89 .It
  90 L3H
  91 .It
  92 L4E
  93 .It
  94 L4R
  95 .It
  96 L5x
  97 .It
  98 L8x
  99 .It
 100 M1A
 101 .It
 102 M2E
 103 .It
 104 M6N
 105 .It
 106 M6R
 107 .It
 108 S1x
 109 .It
 110 S2x
 111 .It
 112 V6V
 113 .It
 114 W5A
 115 .It
 116 Eee PC
 117 .El
 118 .Pp
 119 Additionally,
 120 .Nm
 121 also supports the Asus-compatible
 122 .Em ATK0100
 123 interface found in
 124 .Em Samsung P30/P35
 125 laptops.
 126 .Sh SYSCTL VARIABLES
 127 The following sysctls are currently implemented:
 128 .Bl -tag -width indent
 129 .It Va hw.acpi.asus.lcd_brightness
 130 Makes the LCD backlight brighter or dimmer (higher values are brighter).
 131 .It Va hw.acpi.asus.lcd_backlight
 132 Turns the LCD backlight on or off.
 133 .It Va hw.acpi.asus.video_output
 134 Sets 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
 138 No display
 139 .It Li 1
 140 LCD
 141 .It Li 2
 142 CRT
 143 .It Li 4
 144 TV-Out
 145 .El
 146 .Pp
 147 Some models also support video switching via the generic
 148 .Xr acpi_video 4
 149 driver.
 150 Most models do not, however.
 151 .El
 152 .Pp
 153 Defaults for these variables can be set in
 154 .Xr sysctl.conf 5 ,
 155 which 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
 167 The
 168 .Nm
 169 driver first appeared in
 170 .Fx 5.3 .
 171 .Sh AUTHORS
 172 .An -nosplit
 173 The
 174 .Nm
 175 driver and this manual page were written by
 176 .An Philip Paeps Aq Mt philip@FreeBSD.org .
 177 .Pp
 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.