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