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

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