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
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 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.mic_mute
277 Indicates, whether the microphone led (present on some model) is on or not.
278 Note that this does not mean that the microphone input is muted.
279 .It Va dev.acpi_ibm.0.thinklight
280 Indicates, whether the ThinkLight keyboard light is activated or not.
281 .It Va dev.acpi_ibm.0.bluetooth
282 Toggle Bluetooth chip activity.
283 .It Va dev.acpi_ibm.0.wlan
285 Indicates whether the WLAN chip is active or not.
286 .It Va dev.acpi_ibm.0.fan
287 Indicates whether the fan is in automatic (1) or manual (0) mode.
288 Default is automatic mode.
289 This sysctl should be used with extreme precaution, since disabling automatic
290 fan control might overheat the ThinkPad and lead to permanent damage if the
292 is not set accordingly.
293 .It Va dev.acpi_ibm.0.fan_level
294 Indicates at what speed the fan should run when being in manual mode.
295 Values are ranging from 0 (off) to 7 (max).
296 The resulting speed differs from model to model.
297 On a T41p this is as follows:
299 .Bl -tag -width indent-two -compact
309 .It Va dev.acpi_ibm.0.fan_speed
311 Fan speed in rounds per minute.
312 A few older ThinkPads report the fan speed in levels ranging from 0 (off)
314 .It Va dev.acpi_ibm.0.thermal
316 Shows the readings of up to eight different temperature sensors.
317 Most ThinkPads include six or more temperature sensors but
318 only expose the CPU temperature through
320 Some ThinkPads have the below sensor layout which might vary depending on the
341 .It Va dev.acpi_ibm.0.handlerevents
348 Events are specified as a whitespace-separated list of event code in
349 hexadecimal or decimal form.
350 Note that the event maybe handled twice (e.g., Brightness up/down) if ACPI BIOS
351 already handled the event.
354 Defaults for these sysctls can be set in
357 .Bl -tag -width ".Pa /dev/led/thinklight"
358 .It Pa /dev/led/thinklight
364 The following can be added to
366 in order to pass button events to a
367 .Pa /usr/local/sbin/acpi_oem_exec.sh
369 .Bd -literal -offset indent
371 match "system" "ACPI";
372 match "subsystem" "IBM";
373 action "/usr/local/sbin/acpi_oem_exec.sh $notify ibm";
378 .Pa /usr/local/sbin/acpi_oem_exec.sh
379 script might look like:
380 .Bd -literal -offset indent
383 if [ "$1" = "" -o "$2" = "" ]
385 echo "usage: $0 notify oem_name"
391 BC_PRECOMMANDS="scale=2"
397 DISPLAY_PIPE=/tmp/acpi_${OEM}_display
401 LEVEL=`sysctl -n dev.acpi_${OEM}.0.bluetooth`
402 if [ "$LEVEL" = "1" ]
404 sysctl dev.acpi_${OEM}.0.bluetooth=0
405 MESSAGE="bluetooth disabled"
407 sysctl dev.acpi_${OEM}.0.bluetooth=1
408 MESSAGE="bluetooth enabled"
412 LEVEL=`sysctl -n dev.acpi_${OEM}.0.lcd_brightness`
413 PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\
414 ${LEVEL} / ${MAX_LCD_BRIGHTNESS} * 100" |\\
415 ${CALC} | ${CUT} -d . -f 1`
416 MESSAGE="brightness level ${PERCENT}%"
419 LEVEL=`sysctl -n dev.acpi_${OEM}.0.thinklight`
420 if [ "$LEVEL" = "1" ]
422 MESSAGE="thinklight enabled"
424 MESSAGE="thinklight disabled"
428 LEVEL=`sysctl -n dev.acpi_${OEM}.0.volume`
429 PERCENT=`${ECHO} "${BC_PRECOMMANDS} ; \\
430 ${LEVEL} / ${MAX_VOLUME} * 100" | \\
431 ${CALC} | ${CUT} -d . -f 1`
432 MESSAGE="volume level ${PERCENT}%"
435 LEVEL=`sysctl -n dev.acpi_${OEM}.0.mute`
436 if [ "$LEVEL" = "1" ]
438 MESSAGE="volume muted"
440 MESSAGE="volume unmuted"
444 LEVEL=`sysctl -n dev.acpi_ibm.0.mic_led`
445 if [ $LEVEL -eq 0 ]; then
446 sysctl dev.acpi_ibm.0.mic_led=1
449 if [ $LEVEL -eq 1 ]; then
450 sysctl dev.acpi_ibm.0.mic_led=0
458 if [ -p ${DISPLAY_PIPE} ]
460 ${ECHO} ${MESSAGE} >> ${DISPLAY_PIPE} &
465 The following example specify that event code 0x04 (Suspend to RAM),
466 0x10 (Brightness up) and 0x11 (Brightness down) are handled by
468 .Bd -literal -offset indent
469 sysctl dev.acpi_ibm.0.handlerevents='0x04 0x10 0x11'
474 .Bd -literal -offset indent
475 dev.acpi_ibm.0.handlerevents=0x04\\ 0x10\\ 0x11
486 device driver first appeared in
492 driver was written by
493 .An Takanori Watanabe Aq Mt takawata@FreeBSD.org
494 and later mostly rewritten by
495 .An Markus Brueffer Aq Mt markus@FreeBSD.org .
496 This manual page was written by
497 .An Christian Brueffer Aq Mt brueffer@FreeBSD.org
499 .An Markus Brueffer Aq Mt markus@FreeBSD.org .