1 .\" Copyright (c) 2005 Christian Brueffer
2 .\" Copyright (c) 2005 Markus Brueffer
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
33 .Nd "ACPI extras driver for IBM laptops"
35 To compile this driver into the kernel,
36 place the following line in your
37 kernel configuration file:
38 .Bd -ragged -offset indent
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
45 .Bd -literal -offset indent
51 driver provides support for hotkeys and other components of IBM laptops.
52 The main purpose of this driver is to provide an interface,
57 through which applications can determine the status of
58 various laptop components.
62 interface is enabled automatically after loading the driver, the
64 interface has to be enabled explicitly, as it may alter the default action of
66 This is done by setting the
68 sysctl as described below.
69 Specifying which keys should generate events is done by setting a bitmask,
70 whereas each bit represents one key or key combination.
71 This bitmask, accessible via the
75 by default, a value representing all possible keypress events on the specific
77 .Ss Xr devd 8 Ss Events
78 Hotkey events received by
80 provide the following information:
82 .Bl -tag -width "subsystem" -offset indent -compact
88 The source of the event in the ACPI namespace.
89 The value depends on the model.
91 Event code (see below).
94 Depending on the ThinkPad model, event codes may vary.
95 On a ThinkPad T41p these are as follows:
97 .Bl -tag -width "subsystem" -offset indent -compact
103 Fn + F3 (LCD backlight)
105 Fn + F4 (Suspend to RAM)
111 Fn + F7 (Screen expand)
121 Fn + F12 (Suspend to disk)
129 Fn + Home (Brightness up)
131 Fn + End (Brightness down)
133 Fn + PageUp (ThinkLight)
147 .Ss Xr led 4 Ss Interface
152 interface for the ThinkLight.
153 The ThinkLight can be made to blink by writing
156 .Pa /dev/led/thinklight
159 The following sysctls are currently implemented:
160 .Bl -tag -width indent
161 .It Va dev.acpi_ibm.0.initialmask
163 Bitmask of ACPI events before the
166 .It Va dev.acpi_ibm.0.availmask
168 Bitmask of all supported ACPI events.
169 .It Va dev.acpi_ibm.0.events
170 Enable ACPI events and set the
176 driver being loaded, only the Fn+F4 button generates an ACPI event.
177 .It Va dev.acpi_ibm.0.eventmask
178 Sets the ACPI events which are reported to
180 Fn+F3, Fn+F4 and Fn+F12 always generate ACPI events, regardless which value
183 Depending on the ThinkPad model, the meaning of different bits in the
186 On a ThinkPad T41p this is a bitwise OR of the following:
188 .Bl -tag -width indent-two -compact
194 Fn + F3 (LCD backlight)
196 Fn + F4 (Suspend to RAM)
202 Fn + F7 (Screen expand)
212 Fn + F12 (Suspend to disk)
220 Fn + Home (Brightness up)
222 Fn + End (Brightness down)
224 Fn + PageUp (ThinkLight)
238 .It Va dev.acpi_ibm.0.hotkey
240 Status of several buttons.
241 Every time a button is pressed, the respecting bit is toggled.
242 It is a bitwise OR of the following:
244 .Bl -tag -width indent-two -compact
266 Brightness Up/Down Button
268 Volume Up/Down/Mute Button
270 .It Va dev.acpi_ibm.0.lcd_brightness
271 Current brightness level of the display.
272 .It Va dev.acpi_ibm.0.volume
274 .It Va dev.acpi_ibm.0.mute
275 Indicates, whether the speakers are muted or not.
276 .It Va dev.acpi_ibm.0.thinklight
277 Indicates, whether the ThinkLight keyboard light is activated or not.
278 .It Va dev.acpi_ibm.0.bluetooth
279 Toggle Bluetooth chip activity.
280 .It Va dev.acpi_ibm.0.wlan
282 Indicates whether the WLAN chip is active or not.
283 .It Va dev.acpi_ibm.0.fan
284 Indicates whether the fan is in automatic (1) or manual (0) mode.
285 Default is automatic mode.
286 This sysctl should be used with extreme precaution, since disabling automatic
287 fan control might overheat the ThinkPad and lead to permanent damage if the
289 is not set accordingly.
290 .It Va dev.acpi_ibm.0.fan_level
291 Indicates at what speed the fan should run when being in manual mode.
292 Values are ranging from 0 (off) to 7 (max).
293 The resulting speed differs from model to model.
294 On a T41p this is as follows:
296 .Bl -tag -width indent-two -compact
306 .It Va dev.acpi_ibm.0.fan_speed
308 Fan speed in rounds per minute.
309 A few older ThinkPads report the fan speed in levels ranging from 0 (off)
311 .It Va dev.acpi_ibm.0.thermal
313 Shows the readings of up to eight different temperature sensors.
314 Most ThinkPads include six or more temperature sensors but
315 only expose the CPU temperature through
317 Some ThinkPads have the below sensor layout which might vary depending on the
338 .It Va dev.acpi_ibm.0.handlerevents
345 Events are specified as a whitespace-separated list of event code in
346 hexadecimal or decimal form.
347 Note that the event maybe handled twice (eg. Brightness up/down) if ACPI BIOS
348 already handled the event.
351 Defaults for these sysctls can be set in
354 .Bl -tag -width ".Pa /dev/led/thinklight"
355 .It Pa /dev/led/thinklight
361 The following can be added to
363 in order to pass button events to a
364 .Pa /usr/local/sbin/acpi_oem_exec.sh
366 .Bd -literal -offset indent
368 match "system" "ACPI";
369 match "subsystem" "IBM";
370 action "/usr/local/sbin/acpi_oem_exec.sh $notify ibm";
375 .Pa /usr/local/sbin/acpi_oem_exec.sh
376 script might look like:
377 .Bd -literal -offset indent
380 if [ "$1" = "" -o "$2" = "" ]
382 echo "usage: $0 notify oem_name"
388 BC_PRECOMMANDS="scale=2"
394 DISPLAY_PIPE=/tmp/acpi_${OEM}_display
398 LEVEL=`sysctl -n dev.acpi_${OEM}.0.bluetooth`
399 if [ "$LEVEL" = "1" ]
401 sysctl dev.acpi_${OEM}.0.bluetooth=0
402 MESSAGE="bluetooth disabled"
404 sysctl dev.acpi_${OEM}.0.bluetooth=1
405 MESSAGE="bluetooth enabled"
409 LEVEL=`sysctl -n dev.acpi_${OEM}.0.lcd_brightness`
410 PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\
411 ${LEVEL} / ${MAX_LCD_BRIGHTNESS} * 100" |\\
412 ${CALC} | ${CUT} -d . -f 1`
413 MESSAGE="brightness level ${PERCENT}%"
416 LEVEL=`sysctl -n dev.acpi_${OEM}.0.thinklight`
417 if [ "$LEVEL" = "1" ]
419 MESSAGE="thinklight enabled"
421 MESSAGE="thinklight disabled"
425 LEVEL=`sysctl -n dev.acpi_${OEM}.0.volume`
426 PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\
427 ${LEVEL} / ${MAX_VOLUME} * 100" | \\
428 ${CALC} | ${CUT} -d . -f 1`
429 MESSAGE="volume level ${PERCENT}%"
432 LEVEL=`sysctl -n dev.acpi_${OEM}.0.mute`
433 if [ "$LEVEL" = "1" ]
435 MESSAGE="volume muted"
437 MESSAGE="volume unmuted"
444 if [ -p ${DISPLAY_PIPE} ]
446 ${ECHO} ${MESSAGE} >> ${DISPLAY_PIPE} &
451 The following example specify that event code 0x04 (Suspend to RAM),
452 0x10 (Brightness up) and 0x11 (Brightness down) are handled by
454 .Bd -literal -offset indent
455 sysctl dev.acpi_ibm.0.handlerevents='0x04 0x10 0x11'
460 .Bd -literal -offset indent
461 dev.acpi_ibm.0.handlerevents=0x04\\ 0x10\\ 0x11
472 device driver first appeared in
478 driver was written by
479 .An Takanori Watanabe Aq takawata@FreeBSD.org
480 and later mostly rewritten by
481 .An Markus Brueffer Aq markus@FreeBSD.org .
482 This manual page was written by
483 .An Christian Brueffer Aq brueffer@FreeBSD.org
485 .An Markus Brueffer Aq markus@FreeBSD.org .