Difference between revisions of "Fan control scripts"

From ThinkWiki
Jump to: navigation, search
 
(Comprehensive bash script with fine control over fan speed)
 
(106 intermediate revisions by 26 users not shown)
Line 1: Line 1:
'''sh script example'''
+
{| width="100%"
 +
|style="vertical-align:top;padding-right:20px;width:10px;white-space:nowrap;" | __TOC__
 +
|style="vertical-align:top" |
 +
This page provides several scripts for controlling the ThinkPad's system fan according the its [[thermal sensors]] (overriding the embedded controller), in order to reduce [[problem with fan noise|fan noise]] and decrease [[how to reduce power consumption|power consumption]].
  
  #!/bin/sh
+
{{WARN|These scripts rely on undocumented hardware features and override nominal hardware behavior. They may thus cause arbitrary damage to your laptop or data. Watch your temperatures!}}
 +
{{NOTE|Closed-loop fan control requires a thermal sensor sweep, which is an expensive operation. The firmware doesn't update the sensors more than once every 2s, so care should be taken not to waste resources by reading them too often.}}
 +
|}
 +
 
 +
==Variable speed control scripts==
 +
The following scripts sets the fan speed according to the system's [[thermal sensors]]. In addition, they include a hack for preventing the annoying fan pulsing that occurs on some systems. Note that the fan levels, thresholds and anti-pulsing hacks are system-specific, so you may need to adjust them.
 +
 
 +
===Comprehensive <tt>bash</tt> script with fine control over fan speed===
 +
This script works with any recent Linux kernel (2.6.14 and higher). It requires the [[ibm-acpi]] module to be loaded with the <tt>experimental=1</tt> module parameter (e.g., {{cmdroot|1=modprobe ibm_acpi experimental=1}}).
 +
 
 +
In Linux 2.6.22 and higher you need to additionally pass fan_control=1 to the module thinkpad_acpi (e.g., {{cmdroot|1=modprobe thinkpad-acpi experimental=1 fan_control=1}})
 +
 
 +
On Ubuntu > 10.04 or from kernel 2.6.32 onwards: To make the kernel module settings permanent and to make them be executed at boot run below command and reboot afterwards:
 +
 
 +
{{cmdroot|1=sudo echo "options thinkpad_acpi experimental=1 fan_control=1" >/etc/modprobe.d/thinkpad_acpi.conf}}
 +
 
 +
 
 +
The code lets you define a temperature range for each [[thermal sensors|thermal sensor]]. The script computes the fan level needed by each sensor based on the configured range, and then sets the the actual fan level to the slowest that will satisfy all sensors (plus some hysteresis to avoid fluctiations). It also includes a workaround for the [[Problem with fan noise|pulsing noise]] problem. The script provides an (optional) daemon mode and logging to syslog. The method of controlling fan speed is documented [[How to control fan speed|here]].
 +
 
 +
The system hard disk temperature is monitored as well, using the hard disk's internal sensor. This works only on certain Hitachi disks and requires kernel >= 2.6.19-rc1 or the ide driver, since it uses a [[Thermal Sensors#Hitachi_harddisks_SENSE_CONDITION_temperature_sensor|non-standard method]] for reading the temperature without causing a head unload or spinup.
 +
 
 +
The code:
 +
* {{CodeRef|tp-fancontrol}}
 +
 
 +
{{WARN|There is a bug in the code which causes the script to exit immediately after start with bash version is 4.1.0(7)-release. The problem line is line 356 which returns zero and cause the script to exit if set -e is called, which is unfortunately true. A simple solution is to append a true expression after the command.}}
 +
 
 +
Current options:
 +
 
 +
Usage: ./tp-fancontrol [OPTION]...
 
   
 
   
  MAXTEMP=50
+
  Available options:
+
  -s N  Shift up the min temperature thresholds by N degrees
while [ 1 ];
+
          (positive for quieter, negative for cooler).
do
+
          Max temperature thresholds are not affected.
        fan=no
+
  -S N  Shift up the max temperature thresholds by N degrees
+
          (positive for quieter, negative for cooler). DANGEROUS.
        for temp in `sed s/temperatures:// < /proc/acpi/ibm/thermal`
+
  -t    Test mode
        do
+
  -q    Quiet mode
                test $temp -gt $MAXTEMP && fan=yes
+
  -d    Daemon mode, go into background (implies -q)
        done
+
  -l    Log to syslog
   
+
  -k    Kill already-running daemon
        command='disable'
+
  -u    Tell already-running daemon that the system is being suspended
        test "$fan" = "yes" && command='enable'
+
  -p    Pid file location for daemon mode
        echo $command > /proc/acpi/ibm/fan
+
{{WARN|The list of temperature ranges used in this script is much more liberal than the rules used by the embedded controller firmware, and is derived mostly from anecdotal evidence, hunches and wishful thinking. It is also model-specific - see [[thermal sensors]].}}
+
 
        sleep 20
+
====init script for the comprehensive script====
done
+
 
 +
This is optional. It assumes that the above <tt>tp-fancontrol</tt> script is saved at {{path|/usr/bin/tp-fancontrol}}.
 +
* Init script: {{CodeRef|tp-fancontrol.init}} (save as {{path|/etc/init.d/tp-fancontrol}})
 +
* Init script (Debian): {{CodeRef|tp-fancontrol.init.debian}} (save as {{path|/etc/init.d/tp-fancontrol}})
 +
* Configuration file for init script: {{CodeRef|tp-fancontrol.conf}} (save as {{path|/etc/tp-fancontrol.conf}})
 +
 
 +
===Simple <tt>bash</tt> script with fine control over fan speed (requires kernel patch)===
 +
The following is a simpler patch (without extra features like daemon mode and logging). It requires the [[patch for controlling fan speed]] or a recent kernel (>=2.6.19).
 +
 
 +
{{CodeRef|tp-fancontrol-basic}}
 +
 
 +
===tp-fan: Automatic daemon with GTK+ GUI===
 +
Provides easy setup and monitoring through graphical GTK+ interface. Temperature thresholds can be set separately for each sensor since version 0.90.
 +
 
 +
At the moment packages are available for Ubuntu 8.04, 8.10, and 9.04. However, porting to other distributions or manual setup should be easy.
 +
 
 +
* Home page: http://www.gambitchess.org/mediawiki/index.php/ThinkPad_Fan_Control
 +
http://www.gambitchess.org/moin.py/tpfan
 +
 
 +
===thinkfan: A minimalist fan control program===
 +
Written in C to use as little CPU power as possible. Configuration is done via a simple text file, by providing (FAN_LEVEL, LOWER_LIMIT, UPPER_LIMIT) tuples. Inspired by i8kfan. Requires thinkpad_acpi with fan_control=1. Just released version 0.7, which now allows a more fine-grained control over temperature limits.
 +
 
 +
* Download here: http://sourceforge.net/projects/thinkfan/
 +
 
 +
==Fan enable/disable scripts==
 +
The following scripts were written before it was known [[patch for controlling fan speed|how to control the fan speed]], so they only toggle between fan disabled and default (noisy) fan behavior. In some models, they also do not monitor all available [[thermal sensors]].
 +
 
 +
===<tt>sh</tt> script example===
 +
{{CodeRef|fan-enable-basic}}
 +
 
 +
===<tt>sh</tt> script with more features===
 +
{{CodeRef|fan-enable-extended}}
 +
 
 +
===<tt>sh</tt> script with extra safety functionality===
 +
ibm_acpi usually works well. But to rely on it completely, this script provides some extra safety functionality:
 +
# It catches various signals and turns the fan on before it quits.
 +
# It turns off the fan under very strict conditions, leaving it on when unexpected errors occur.
 +
 
 +
{{CodeRef|fan-enable-safe}}
 +
 
 +
==Init scripts==
 +
 
 +
===Init script example===
 +
 
 +
{{CodeRef|fan-enable.init}}
 +
 
 +
===Init script example for gentoo===
 +
Assume one of the above control scripts is {{path|/usr/sbin/ibm-fancontrold}}, for gentoo use the following init script in /etc/init.d/ibm-fancontrol.
 +
Copy the script to {{path|/etc/init.d/ibm-fancontrol}}, then do  
 +
 
 +
# rc-update add ibm-fancontrol default
 +
 
 +
This will add the init script to the default runlevel.
 +
 
 +
{{CodeRef|ibm-fancontrol.init}}
 +
 
 +
===Init script example for rh/fedora===
 +
Assume one of the above control scripts is {{path|/sbin/tp-fancontrold}},
 +
copy the script to {{path|/etc/init.d/tp-fancontrol}}, then do
 +
 
 +
  # chkconfig --add tp-fancontrol
 +
 
 +
This will add the init script to the default runlevel.
 +
 
 +
{{CodeRef|tp-fancontrol-fc.init}}
 +
 
 +
You'd have to install also "kernel-module-ibm-acpi" package.
 +
 
 +
==Other==
 +
 
 +
===tpfand===
 +
This little piece of python code is only there to speed up your fan in a T400 with an ATI card cause the fglrx driver does not control the fan speed which leads to overheating while gaming or do other graphic stuff with the ati chip. This script relies on the normal bios control of the fan. If the laptop gets to hot it will speed up the fan to max speed (somehow the bios does not do this ??!!) and re-enables the bios control on a certain temperature. This was only tested on a T400 with ATI chip.
 +
You can just run in in the background as root. It is very chatty and writes in a logfile in /tmp. It should work with any Thinkpad who has /proc/acpi/ibm/fan interface.
 +
[http://pastebin.ca/1884323 tpfand]
 +
 
 +
Tested on:
 +
T400 with Radeon HD 3400
 +
Please test on other models with ATI chip.
 +
 
 +
===fanctrld===
 +
[http://log.does-not-exist.org/archives/2005/08/13/2043_t_43_fan_control_daemon.html fanctrld] is a daemon (written in C) that controls the Thinkpad's fan. The basic approach is to monitor both temperature and fan speed. The fan is enabled when a certain temperature is exceeded, and disabled when the BIOS slows down the fan below a certain speed.
 +
 
 +
===ThinkPad Fan Control GTK GUI tool===
 +
 
 +
[http://www.gambitchess.org/moin.py/ThinkPad_Fan_Control A GTK GUI program (packaged for Ubuntu Gutsy Gibbon 7.10)] may also help.
 +
 
 +
For those using Ubuntu 8.10 and recent Thinkpad models (eg: X200), this is the fan control packages to use: sudo apt-get install tpfand tpfan-admin tpfand-profiles (The packages are part of the main ubuntu repository). It solves the problem of a constantly-on fan. I don't think there are yet profiles for those newer thinkpad models, but it's fairly easy to manually configure the right thresholds. For reference, this is the /etc/tpfand.conf I use for my X200:
 +
 
 +
 
 +
 
 +
enabled = True
 +
 
 +
override_profile = True
 +
 
 +
 
 +
0. Sensor 0 = 0:0 50:3 58:5 67:8
 +
 
 +
1. Sensor 1 = 0:0 55:3 62:5 69:8
 +
 
 +
2. Sensor 2 = 0:255
 +
 
 +
3. Sensor 3 = 0:0 48:3 61:5 69:8
 +
 
 +
4. Sensor 4 = 0:0 43:3 50:8
  
'''sh script example with more features'''
+
5. Sensor 5 = 0:255
  
#!/bin/sh
+
6. Sensor 6 = 0:0 40:8
 
# fan control-script
 
#
 
# based upon ibm-acpi 0.11 (experimental=1 !)
 
#
 
# eliminates anoying "fan always on" in battery mode
 
# works with hysteresis (DELTA) so that always-turn-on/turn-off is avoided
 
# fan acivates at MAXTEMP and cools down CPU, GPU etc. to MAXTEMP-DELTA than the fan is turned off
 
# furthermore detects if AC is on and gives back fan control to default behaviour than
 
#
 
# one can change MAXTEMP and DELTA to individual values
 
# but take care of your THINKPAD don`t melt it!
 
#
 
# have fun!
 
# mk 05.05.05
 
 
MAXTEMP=51
 
DELTA=4
 
 
SWITCHTEMP=$MAXTEMP
 
 
#make sure the script doesn't leave the fan off on error
 
trap "echo enable > /proc/acpi/ibm/fan" EXIT
 
 
while [ 1 ];
 
do
 
  for ac in `sed s/state:// < /proc/acpi/ac_adapter/AC/state`
 
    do
 
      if [ "$ac" = "off-line" ]; then
 
          fan=no
 
          for temp in `sed s/temperatures:// < /proc/acpi/ibm/thermal`
 
            do
 
              test $temp -gt $SWITCHTEMP && fan=yes
 
            done
 
 
          if [ "$fan" = "yes" ]; then
 
            command='enable'
 
            SWITCHTEMP=`expr $MAXTEMP - $DELTA`
 
          else
 
            SWITCHTEMP=$MAXTEMP
 
            command='disable'
 
          fi
 
 
        else # ac-adapter on -> set fan control to standard behaviour
 
          command='enable'
 
        fi
 
 
        echo $command > /proc/acpi/ibm/fan
 
        sleep 15
 
      done
 
  done
 
  
'''init script example'''
+
7. Sensor 7 = 0:255
  
#! /bin/sh
+
==Ideas for improvement==
+
* Use the [[HDAPS]] sensor to automatically lower the temperature thresholds when the laptop is moving. Prolonged movement usually happens when the laptop is on the user's lap (see [[Problem with hot surfaces]] for implications), or when in a moving vehicle where fan noise is typically overshadowed by vehicle noise.
N=/etc/init.d/fan
+
* Use a [http://en.wikipedia.org/wiki/PID_controller PID controller] feedback loop instead of simple thresholds.
+
* Monitor the UltraBay disk temperature too.
set -e
 
 
case "$1" in
 
  start)
 
        # make sure privileges don't persist across reboots
 
        if [ -d /var/run/fan ] && [ "x`ls /var/run/fan`" != x ]
 
        then
 
                touch -t 198501010000 /var/run/fan/*
 
        fi
 
        fan.sh &    # Script from above
 
        ;;
 
  stop|reload|restart|force-reload)
 
        killall fan.sh
 
        echo enable > /proc/acpi/ibm/fan
 
        ;;
 
  *)
 
        echo "Usage: $N {start|stop|restart|force-reload}" >&2
 
        exit 1
 
        ;;
 
esac
 
 
exit 0
 
  
 +
==See also==
 +
* [[How to control fan speed]]
 +
* Shimodax's ThinkPad fan control tool for a Windows offers functionality similar to these scripts; see the [http://forum.thinkpads.com/viewtopic.php?t=17715 forum discussion] at thinkpads.com.
 +
* Yury Polyanskiy has a [http://mailman.linux-thinkpad.org/pipermail/linux-thinkpad/2005-November/030697.html kernel patch] for automatic fan control in kernelspace (only enable/disable based on maximum temperature).
  
 
[[Category:Scripts]]
 
[[Category:Scripts]]

Latest revision as of 17:06, 16 February 2011

This page provides several scripts for controlling the ThinkPad's system fan according the its thermal sensors (overriding the embedded controller), in order to reduce fan noise and decrease power consumption.

ATTENTION!
These scripts rely on undocumented hardware features and override nominal hardware behavior. They may thus cause arbitrary damage to your laptop or data. Watch your temperatures!
NOTE!
Closed-loop fan control requires a thermal sensor sweep, which is an expensive operation. The firmware doesn't update the sensors more than once every 2s, so care should be taken not to waste resources by reading them too often.

Variable speed control scripts

The following scripts sets the fan speed according to the system's thermal sensors. In addition, they include a hack for preventing the annoying fan pulsing that occurs on some systems. Note that the fan levels, thresholds and anti-pulsing hacks are system-specific, so you may need to adjust them.

Comprehensive bash script with fine control over fan speed

This script works with any recent Linux kernel (2.6.14 and higher). It requires the ibm-acpi module to be loaded with the experimental=1 module parameter (e.g., # modprobe ibm_acpi experimental=1).

In Linux 2.6.22 and higher you need to additionally pass fan_control=1 to the module thinkpad_acpi (e.g., # modprobe thinkpad-acpi experimental=1 fan_control=1)

On Ubuntu > 10.04 or from kernel 2.6.32 onwards: To make the kernel module settings permanent and to make them be executed at boot run below command and reboot afterwards:

# sudo echo "options thinkpad_acpi experimental=1 fan_control=1" >/etc/modprobe.d/thinkpad_acpi.conf


The code lets you define a temperature range for each thermal sensor. The script computes the fan level needed by each sensor based on the configured range, and then sets the the actual fan level to the slowest that will satisfy all sensors (plus some hysteresis to avoid fluctiations). It also includes a workaround for the pulsing noise problem. The script provides an (optional) daemon mode and logging to syslog. The method of controlling fan speed is documented here.

The system hard disk temperature is monitored as well, using the hard disk's internal sensor. This works only on certain Hitachi disks and requires kernel >= 2.6.19-rc1 or the ide driver, since it uses a non-standard method for reading the temperature without causing a head unload or spinup.

The code:

ATTENTION!
There is a bug in the code which causes the script to exit immediately after start with bash version is 4.1.0(7)-release. The problem line is line 356 which returns zero and cause the script to exit if set -e is called, which is unfortunately true. A simple solution is to append a true expression after the command.

Current options:

Usage: ./tp-fancontrol [OPTION]...

Available options:
  -s N   Shift up the min temperature thresholds by N degrees
         (positive for quieter, negative for cooler).
         Max temperature thresholds are not affected.
  -S N   Shift up the max temperature thresholds by N degrees
         (positive for quieter, negative for cooler). DANGEROUS.
  -t     Test mode
  -q     Quiet mode
  -d     Daemon mode, go into background (implies -q)
  -l     Log to syslog
  -k     Kill already-running daemon
  -u     Tell already-running daemon that the system is being suspended
  -p     Pid file location for daemon mode
ATTENTION!
The list of temperature ranges used in this script is much more liberal than the rules used by the embedded controller firmware, and is derived mostly from anecdotal evidence, hunches and wishful thinking. It is also model-specific - see thermal sensors.

init script for the comprehensive script

This is optional. It assumes that the above tp-fancontrol script is saved at /usr/bin/tp-fancontrol.

Simple bash script with fine control over fan speed (requires kernel patch)

The following is a simpler patch (without extra features like daemon mode and logging). It requires the patch for controlling fan speed or a recent kernel (>=2.6.19).

tp-fancontrol-basic (download)

tp-fan: Automatic daemon with GTK+ GUI

Provides easy setup and monitoring through graphical GTK+ interface. Temperature thresholds can be set separately for each sensor since version 0.90.

At the moment packages are available for Ubuntu 8.04, 8.10, and 9.04. However, porting to other distributions or manual setup should be easy.

http://www.gambitchess.org/moin.py/tpfan

thinkfan: A minimalist fan control program

Written in C to use as little CPU power as possible. Configuration is done via a simple text file, by providing (FAN_LEVEL, LOWER_LIMIT, UPPER_LIMIT) tuples. Inspired by i8kfan. Requires thinkpad_acpi with fan_control=1. Just released version 0.7, which now allows a more fine-grained control over temperature limits.

Fan enable/disable scripts

The following scripts were written before it was known how to control the fan speed, so they only toggle between fan disabled and default (noisy) fan behavior. In some models, they also do not monitor all available thermal sensors.

sh script example

fan-enable-basic (download)

sh script with more features

fan-enable-extended (download)

sh script with extra safety functionality

ibm_acpi usually works well. But to rely on it completely, this script provides some extra safety functionality:

  1. It catches various signals and turns the fan on before it quits.
  2. It turns off the fan under very strict conditions, leaving it on when unexpected errors occur.

fan-enable-safe (download)

Init scripts

Init script example

fan-enable.init (download)

Init script example for gentoo

Assume one of the above control scripts is /usr/sbin/ibm-fancontrold, for gentoo use the following init script in /etc/init.d/ibm-fancontrol. Copy the script to /etc/init.d/ibm-fancontrol, then do

# rc-update add ibm-fancontrol default

This will add the init script to the default runlevel.

ibm-fancontrol.init (download)

Init script example for rh/fedora

Assume one of the above control scripts is /sbin/tp-fancontrold, copy the script to /etc/init.d/tp-fancontrol, then do

# chkconfig --add tp-fancontrol

This will add the init script to the default runlevel.

tp-fancontrol-fc.init (download)

You'd have to install also "kernel-module-ibm-acpi" package.

Other

tpfand

This little piece of python code is only there to speed up your fan in a T400 with an ATI card cause the fglrx driver does not control the fan speed which leads to overheating while gaming or do other graphic stuff with the ati chip. This script relies on the normal bios control of the fan. If the laptop gets to hot it will speed up the fan to max speed (somehow the bios does not do this ??!!) and re-enables the bios control on a certain temperature. This was only tested on a T400 with ATI chip. You can just run in in the background as root. It is very chatty and writes in a logfile in /tmp. It should work with any Thinkpad who has /proc/acpi/ibm/fan interface. tpfand

Tested on: T400 with Radeon HD 3400 Please test on other models with ATI chip.

fanctrld

fanctrld is a daemon (written in C) that controls the Thinkpad's fan. The basic approach is to monitor both temperature and fan speed. The fan is enabled when a certain temperature is exceeded, and disabled when the BIOS slows down the fan below a certain speed.

ThinkPad Fan Control GTK GUI tool

A GTK GUI program (packaged for Ubuntu Gutsy Gibbon 7.10) may also help.

For those using Ubuntu 8.10 and recent Thinkpad models (eg: X200), this is the fan control packages to use: sudo apt-get install tpfand tpfan-admin tpfand-profiles (The packages are part of the main ubuntu repository). It solves the problem of a constantly-on fan. I don't think there are yet profiles for those newer thinkpad models, but it's fairly easy to manually configure the right thresholds. For reference, this is the /etc/tpfand.conf I use for my X200:


enabled = True

override_profile = True


0. Sensor 0 = 0:0 50:3 58:5 67:8

1. Sensor 1 = 0:0 55:3 62:5 69:8

2. Sensor 2 = 0:255

3. Sensor 3 = 0:0 48:3 61:5 69:8

4. Sensor 4 = 0:0 43:3 50:8

5. Sensor 5 = 0:255

6. Sensor 6 = 0:0 40:8

7. Sensor 7 = 0:255

Ideas for improvement

  • Use the HDAPS sensor to automatically lower the temperature thresholds when the laptop is moving. Prolonged movement usually happens when the laptop is on the user's lap (see Problem with hot surfaces for implications), or when in a moving vehicle where fan noise is typically overshadowed by vehicle noise.
  • Use a PID controller feedback loop instead of simple thresholds.
  • Monitor the UltraBay disk temperature too.

See also

  • How to control fan speed
  • Shimodax's ThinkPad fan control tool for a Windows offers functionality similar to these scripts; see the forum discussion at thinkpads.com.
  • Yury Polyanskiy has a kernel patch for automatic fan control in kernelspace (only enable/disable based on maximum temperature).