share/man/man4/man4.i386/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 .\" $FreeBSD$
  27 .\"
  28 .Dd April 9, 2006
  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 A4D
  72 .It
  73 A6VM
  74 .It
  75 D1x
  76 .It
  77 J1x
  78 .It
  79 L2B
  80 .It
  81 L2D
  82 .It
  83 L2E
  84 .It
  85 L3C
  86 .It
  87 L3D
  88 .It
  89 L3H
  90 .It
  91 L4E
  92 .It
  93 L4R
  94 .It
  95 L5x
  96 .It
  97 L8x
  98 .It
  99 M1A
 100 .It
 101 M2E
 102 .It
 103 M6N
 104 .It
 105 M6R
 106 .It
 107 S1x
 108 .It
 109 S2x
 110 .It
 111 V6V
 112 .It
 113 W5A
 114 .El
 115 .Pp
 116 Additionally,
 117 .Nm
 118 also supports the Asus-compatible
 119 .Em ATK0100
 120 interface found in
 121 .Em Samsung P30/P35
 122 laptops.
 123 .Sh SYSCTL VARIABLES
 124 The following sysctls are currently implemented:
 125 .Bl -tag -width indent
 126 .It Va hw.acpi.asus.lcd_brightness
 127 Makes the LCD backlight brighter or dimmer (higher values are brighter).
 128 .It Va hw.acpi.asus.lcd_backlight
 129 Turns the LCD backlight on or off.
 130 .It Va hw.acpi.asus.video_output
 131 Sets the active display to use according to a bitwise OR of the following:
 132 .Pp
 133 .Bl -tag -width indent -compact
 134 .It Li 0
 135 No display
 136 .It Li 1
 137 LCD
 138 .It Li 2
 139 CRT
 140 .It Li 4
 141 TV-Out
 142 .El
 143 .Pp
 144 Some models also support video switching via the generic
 145 .Xr acpi_video 4
 146 driver.
 147 Most models do not, however.
 148 .El
 149 .Pp
 150 Defaults for these variables can be set in
 151 .Xr sysctl.conf 5 ,
 152 which is parsed at boot-time.
 153 .Sh SEE ALSO
 154 .Xr acpi 4 ,
 155 .Xr acpi_video 4 ,
 156 .Xr sysctl.conf 5 ,
 157 .Xr sysctl 8
 158 .Rs
 159 .%T The acpi4asus Project
 160 .%O http://sourceforge.net/projects/acpi4asus/
 161 .Re
 162 .Sh HISTORY
 163 The
 164 .Nm
 165 driver first appeared in
 166 .Fx 5.3 .
 167 .Sh AUTHORS
 168 .An -nosplit
 169 The
 170 .Nm
 171 driver and this manual page were written by
 172 .An Philip Paeps Aq philip@FreeBSD.org .
 173 .Pp
 174 Inspiration came from the
 175 .Em acpi4asus project
 176 started by
 177 .An Julien Lerouge
 178 which maintains a driver implementing this
 179 functionality in the
 180 .Tn Linux
 181 kernel.