/share/man/man4/acpi_asus.4

https://bitbucket.org/freebsd/freebsd-head/ · Forth · 187 lines · 187 code · 0 blank · 0 comment · 3 complexity · cc8ffc4c764426ac41f8aaa2ba9adaf0 MD5 · raw file

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