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