git.sur5r.net Git - groeck-it87/blob - README

   1 Kernel driver it87
   2 ==================
   3
   4 Supported chips:
   5   * IT8705F
   6     Prefix: 'it87'
   7     Addresses scanned: from Super I/O config space (8 I/O ports)
   8     Datasheet: Once publicly available at the ITE website, but no longer
   9   * IT8712F
  10     Prefix: 'it8712'
  11     Addresses scanned: from Super I/O config space (8 I/O ports)
  12     Datasheet: Once publicly available at the ITE website, but no longer
  13   * IT8716F/IT8726F
  14     Prefix: 'it8716'
  15     Addresses scanned: from Super I/O config space (8 I/O ports)
  16     Datasheet: Once publicly available at the ITE website, but no longer
  17   * IT8718F
  18     Prefix: 'it8718'
  19     Addresses scanned: from Super I/O config space (8 I/O ports)
  20     Datasheet: Once publicly available at the ITE website, but no longer
  21   * IT8720F
  22     Prefix: 'it8720'
  23     Addresses scanned: from Super I/O config space (8 I/O ports)
  24     Datasheet: Not publicly available
  25   * IT8721F/IT8758E
  26     Prefix: 'it8721'
  27     Addresses scanned: from Super I/O config space (8 I/O ports)
  28     Datasheet: Not publicly available
  29   * IT8728F
  30     Prefix: 'it8728'
  31     Addresses scanned: from Super I/O config space (8 I/O ports)
  32     Datasheet: Not publicly available
  33   * IT8771E
  34     Prefix: 'it8771'
  35     Addresses scanned: from Super I/O config space (8 I/O ports)
  36     Datasheet: Not publicly available
  37   * IT8772E
  38     Prefix: 'it8772'
  39     Addresses scanned: from Super I/O config space (8 I/O ports)
  40     Datasheet: Not publicly available
  41   * IT8783E/F
  42     Prefix: 'it8783'
  43     Addresses scanned: from Super I/O config space (8 I/O ports)
  44     Datasheet: Not publicly available
  45   * SiS950   [clone of IT8705F]
  46     Prefix: 'it87'
  47     Addresses scanned: from Super I/O config space (8 I/O ports)
  48     Datasheet: No longer be available
  49
  50 Authors:
  51     Christophe Gauthron
  52     Jean Delvare <khali@linux-fr.org>
  53
  54
  55 Module Parameters
  56 -----------------
  57
  58 * update_vbat: int
  59
  60   0 if vbat should report power on value, 1 if vbat should be updated after
  61   each read. Default is 0. On some boards the battery voltage is provided
  62   by either the battery or the onboard power supply. Only the first reading
  63   at power on will be the actual battery voltage (which the chip does
  64   automatically). On other boards the battery voltage is always fed to
  65   the chip so can be read at any time. Excessive reading may decrease
  66   battery life but no information is given in the datasheet.
  67
  68 * fix_pwm_polarity int
  69
  70   Force PWM polarity to active high (DANGEROUS). Some chips are
  71   misconfigured by BIOS - PWM values would be inverted. This option tries
  72   to fix this. Please contact your BIOS manufacturer and ask him for fix.
  73
  74
  75 Hardware Interfaces
  76 -------------------
  77
  78 All the chips suported by this driver are LPC Super-I/O chips, accessed
  79 through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
  80 SMBus interface to the hardware monitoring functions. This driver no
  81 longer supports this interface though, as it is slower and less reliable
  82 than the ISA access, and was only available on a small number of
  83 motherboard models.
  84
  85
  86 Description
  87 -----------
  88
  89 This driver implements support for the IT8705F, IT8712F, IT8716F,
  90 IT8718F, IT8720F, IT8721F, IT8726F, IT8728F, IT8758E, IT8387E/F,
  91 and SiS950 chips.
  92
  93 These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
  94 joysticks and other miscellaneous stuff. For hardware monitoring, they
  95 include an 'environment controller' with 3 temperature sensors, 3 fan
  96 rotation speed sensors, 8 voltage sensors, associated alarms, and chassis
  97 intrusion detection.
  98
  99 The IT8712F and IT8716F additionally feature VID inputs, used to report
 100 the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
 101 the IT8716F and late IT8712F have 6. They are shared with other functions
 102 though, so the functionality may not be available on a given system.
 103
 104 The IT8718F and IT8720F also features VID inputs (up to 8 pins) but the value
 105 is stored in the Super-I/O configuration space. Due to technical limitations,
 106 this value can currently only be read once at initialization time, so
 107 the driver won't notice and report changes in the VID value. The two
 108 upper VID bits share their pins with voltage inputs (in5 and in6) so you
 109 can't have both on a given board.
 110
 111 The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8783E/F, and later IT8712F
 112 revisions have support for 2 additional fans. The additional fans are supported
 113 by the driver.
 114
 115 The IT8716F, IT8718F, IT8720F and IT8721F/IT8758E, IT8783E/F, and late IT8712F
 116 and IT8705F also have optional 16-bit tachometer counters for fans 1 to 3. This
 117 is better (no more fan clock divider mess) but not compatible with the older
 118 chips and revisions. The 16-bit tachometer mode is enabled by the driver when
 119 one of the above chips is detected.
 120
 121 The IT8726F is just bit enhanced IT8716F with additional hardware
 122 for AMD power sequencing. Therefore the chip will appear as IT8716F
 123 to userspace applications.
 124
 125 The IT8728F is considered compatible with the IT8721F, until a datasheet
 126 becomes available (hopefully.)
 127
 128 Temperatures are measured in degrees Celsius. An alarm is triggered once
 129 when the Overtemperature Shutdown limit is crossed.
 130
 131 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
 132 triggered if the rotation speed has dropped below a programmable limit. When
 133 16-bit tachometer counters aren't used, fan readings can be divided by
 134 a programmable divider (1, 2, 4 or 8) to give the readings more range or
 135 accuracy. With a divider of 2, the lowest representable value is around
 136 2600 RPM. Not all RPM values can accurately be represented, so some rounding
 137 is done.
 138
 139 Voltage sensors (also known as IN sensors) report their values in volts. An
 140 alarm is triggered if the voltage has crossed a programmable minimum or
 141 maximum limit. Note that minimum in this case always means 'closest to
 142 zero'; this is important for negative voltage measurements. All voltage
 143 inputs can measure voltages between 0 and 4.08 volts, with a resolution of
 144 0.016 volt (except IT8721F/IT8758E and IT8728F: 0.012 volt.) The battery
 145 voltage in8 does not have limit registers.
 146
 147 On the IT8721F/IT8758E/IT8783E/F, some voltage inputs are internal and scaled
 148 inside the chip (in7, in8 and optionally in3). The driver handles this
 149 transparently so user-space doesn't have to care.
 150
 151 The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
 152 the voltage level your processor should work with. This is hardcoded by
 153 the mainboard and/or processor itself. It is a value in volts.
 154
 155 If an alarm triggers, it will remain triggered until the hardware register
 156 is read at least once. This means that the cause for the alarm may already
 157 have disappeared! Note that in the current implementation, all hardware
 158 registers are read whenever any data is read (unless it is less than 1.5
 159 seconds since the last update). This means that you can easily miss
 160 once-only alarms.
 161
 162 Out-of-limit readings can also result in beeping, if the chip is properly
 163 wired and configured. Beeping can be enabled or disabled per sensor type
 164 (temperatures, voltages and fans.)
 165
 166 The IT87xx only updates its values each 1.5 seconds; reading it more often
 167 will do no harm, but will return 'old' values.
 168
 169 To change sensor N to a thermistor, 'echo 4 > tempN_type' where N is 1, 2,
 170 or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
 171 Give 0 for unused sensor. Any other value is invalid. To configure this at
 172 startup, consult lm_sensors's /etc/sensors.conf. (4 = thermistor;
 173 3 = thermal diode)
 174
 175
 176 Fan speed control
 177 -----------------
 178
 179 The fan speed control features are limited to manual PWM mode. Automatic
 180 "Smart Guardian" mode control handling is only implemented for older chips
 181 (see below.) However if you want to go for "manual mode" just write 1 to
 182 pwmN_enable.
 183
 184 If you are only able to control the fan speed with very small PWM values,
 185 try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
 186 it may give you a somewhat greater control range. The same frequency is
 187 used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
 188 read-only.
 189
 190
 191 Automatic fan speed control (old interface)
 192 -------------------------------------------
 193
 194 The driver supports the old interface to automatic fan speed control
 195 which is implemented by IT8705F chips up to revision F and IT8712F
 196 chips up to revision G.
 197
 198 This interface implements 4 temperature vs. PWM output trip points.
 199 The PWM output of trip point 4 is always the maximum value (fan running
 200 at full speed) while the PWM output of the other 3 trip points can be
 201 freely chosen. The temperature of all 4 trip points can be freely chosen.
 202 Additionally, trip point 1 has an hysteresis temperature attached, to
 203 prevent fast switching between fan on and off.
 204
 205 The chip automatically computes the PWM output value based on the input
 206 temperature, based on this simple rule: if the temperature value is
 207 between trip point N and trip point N+1 then the PWM output value is
 208 the one of trip point N. The automatic control mode is less flexible
 209 than the manual control mode, but it reacts faster, is more robust and
 210 doesn't use CPU cycles.
 211
 212 Trip points must be set properly before switching to automatic fan speed
 213 control mode. The driver will perform basic integrity checks before
 214 actually switching to automatic control mode.