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   * IT8613E
  10     Prefix: 'it8613'
  11     Addresses scanned: from Super I/O config space (8 I/O ports)
  12     Datasheet: Not publicly available
  13   * IT8620E
  14     Prefix: 'it8620'
  15     Addresses scanned: from Super I/O config space (8 I/O ports)
  16   * IT8622E
  17     Prefix: 'it8622'
  18     Addresses scanned: from Super I/O config space (8 I/O ports)
  19     Datasheet: Not publicly available
  20   * IT8625E
  21     Prefix: 'it8625'
  22     Addresses scanned: from Super I/O config space (8 I/O ports)
  23     Datasheet: Not publicly available
  24   * IT8628E
  25     Prefix: 'it8628'
  26     Addresses scanned: from Super I/O config space (8 I/O ports)
  27     Datasheet: Not publicly available
  28   * IT8705F
  29     Prefix: 'it87'
  30     Addresses scanned: from Super I/O config space (8 I/O ports)
  31     Datasheet: Once publicly available at the ITE website, but no longer
  32   * IT8712F
  33     Prefix: 'it8712'
  34     Addresses scanned: from Super I/O config space (8 I/O ports)
  35     Datasheet: Once publicly available at the ITE website, but no longer
  36   * IT8716F/IT8726F
  37     Prefix: 'it8716'
  38     Addresses scanned: from Super I/O config space (8 I/O ports)
  39     Datasheet: Once publicly available at the ITE website, but no longer
  40   * IT8718F
  41     Prefix: 'it8718'
  42     Addresses scanned: from Super I/O config space (8 I/O ports)
  43     Datasheet: Once publicly available at the ITE website, but no longer
  44   * IT8720F
  45     Prefix: 'it8720'
  46     Addresses scanned: from Super I/O config space (8 I/O ports)
  47     Datasheet: Not publicly available
  48   * IT8721F/IT8758E
  49     Prefix: 'it8721'
  50     Addresses scanned: from Super I/O config space (8 I/O ports)
  51     Datasheet: Not publicly available
  52   * IT8728F
  53     Prefix: 'it8728'
  54     Addresses scanned: from Super I/O config space (8 I/O ports)
  55     Datasheet: Not publicly available
  56   * IT8732F
  57     Prefix: 'it8732'
  58     Addresses scanned: from Super I/O config space (8 I/O ports)
  59     Datasheet: Not publicly available
  60   * IT8771E
  61     Prefix: 'it8771'
  62     Addresses scanned: from Super I/O config space (8 I/O ports)
  63     Datasheet: Not publicly available
  64   * IT8772E
  65     Prefix: 'it8772'
  66     Addresses scanned: from Super I/O config space (8 I/O ports)
  67     Datasheet: Not publicly available
  68   * IT8781F
  69     Prefix: 'it8781'
  70     Addresses scanned: from Super I/O config space (8 I/O ports)
  71     Datasheet: Not publicly available
  72   * IT8782F
  73     Prefix: 'it8782'
  74     Addresses scanned: from Super I/O config space (8 I/O ports)
  75     Datasheet: Not publicly available
  76   * IT8783E/F
  77     Prefix: 'it8783'
  78     Addresses scanned: from Super I/O config space (8 I/O ports)
  79     Datasheet: Not publicly available
  80   * IT8786E
  81     Prefix: 'it8786'
  82     Addresses scanned: from Super I/O config space (8 I/O ports)
  83     Datasheet: Not publicly available
  84   * IT8790E
  85     Prefix: 'it8790'
  86     Addresses scanned: from Super I/O config space (8 I/O ports)
  87     Datasheet: Not publicly available
  88   * SiS950   [clone of IT8705F]
  89     Prefix: 'it87'
  90     Addresses scanned: from Super I/O config space (8 I/O ports)
  91     Datasheet: No longer be available
  92
  93 Authors:
  94     Christophe Gauthron
  95     Jean Delvare <jdelvare@suse.de>
  96     Guenter Roeck <linux@roeck-us.net>
  97
  98
  99 Building & Installing
 100 ---------------------
 101
 102 * make clean
 103 * make
 104 * sudo make install
 105
 106
 107 Module Parameters
 108 -----------------
 109
 110 * update_vbat: int
 111
 112   0 if vbat should report power on value, 1 if vbat should be updated after
 113   each read. Default is 0. On some boards the battery voltage is provided
 114   by either the battery or the onboard power supply. Only the first reading
 115   at power on will be the actual battery voltage (which the chip does
 116   automatically). On other boards the battery voltage is always fed to
 117   the chip so can be read at any time. Excessive reading may decrease
 118   battery life but no information is given in the datasheet.
 119
 120 * fix_pwm_polarity int
 121
 122   Force PWM polarity to active high (DANGEROUS). Some chips are
 123   misconfigured by BIOS - PWM values would be inverted. This option tries
 124   to fix this. Please contact your BIOS manufacturer and ask him for fix.
 125
 126 * force_id
 127
 128   Force chip ID to specified value. Should only be used for testing.
 129
 130 * ignore_resource_conflict
 131
 132   Similar to acpi_enforce_resources=lax, but only affects this driver.
 133   ACPI resource conflicts are ignored if this parameter is provided and
 134   set to 1.
 135   Provided since there are reports that system-wide acpi_enfore_resources=lax
 136   can result in boot failures on some systems.
 137   Note: This is inherently risky since it means that both ACPI and this driver
 138   may access the chip at the same time. This can result in race conditions and,
 139   worst casa, result in unexpected system reboots.
 140
 141 * mmio
 142
 143   If set to 1, the driver uses MMIO to access the chip if supported. This is
 144   faster and less risky (untested!).
 145
 146
 147 Hardware Interfaces
 148 -------------------
 149
 150 All the chips supported by this driver are LPC Super-I/O chips, accessed
 151 through the LPC bus (ISA-like I/O ports). The IT8712F additionally has an
 152 SMBus interface to the hardware monitoring functions. This driver no
 153 longer supports this interface though, as it is slower and less reliable
 154 than the ISA access, and was only available on a small number of
 155 motherboard models.
 156
 157
 158 Description
 159 -----------
 160
 161 This driver implements support for the IT8603E, IT8620E, IT8622E, IT8623E,
 162 IT8628E, IT8705F, IT8712F, IT8716F, IT8718F, IT8720F, IT8721F, IT8726F, IT8728F,
 163 IT8732F, IT8758E, IT8771E, IT8772E, IT8781F, IT8782F, IT8783E/F, IT8786E,
 164 IT8790E, and SiS950 chips.
 165
 166 These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
 167 joysticks and other miscellaneous stuff. For hardware monitoring, they
 168 include an 'environment controller' with 3 temperature sensors, 3 fan
 169 rotation speed sensors, 8 voltage sensors, associated alarms, and chassis
 170 intrusion detection.
 171
 172 The IT8712F and IT8716F additionally feature VID inputs, used to report
 173 the Vcore voltage of the processor. The early IT8712F have 5 VID pins,
 174 the IT8716F and late IT8712F have 6. They are shared with other functions
 175 though, so the functionality may not be available on a given system.
 176
 177 The IT8718F and IT8720F also features VID inputs (up to 8 pins) but the value
 178 is stored in the Super-I/O configuration space. Due to technical limitations,
 179 this value can currently only be read once at initialization time, so
 180 the driver won't notice and report changes in the VID value. The two
 181 upper VID bits share their pins with voltage inputs (in5 and in6) so you
 182 can't have both on a given board.
 183
 184 The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E and later IT8712F revisions
 185 have support for 2 additional fans. The additional fans are supported by the
 186 driver.
 187
 188 The IT8716F, IT8718F, IT8720F, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
 189 IT8783E/F, and late IT8712F and IT8705F also have optional 16-bit tachometer
 190 counters for fans 1 to 3. This is better (no more fan clock divider mess) but
 191 not compatible with the older chips and revisions. The 16-bit tachometer mode
 192 is enabled by the driver when one of the above chips is detected.
 193
 194 The IT8726F is just bit enhanced IT8716F with additional hardware
 195 for AMD power sequencing. Therefore the chip will appear as IT8716F
 196 to userspace applications.
 197
 198 The IT8728F, IT8771E, and IT8772E are considered compatible with the IT8721F,
 199 until a datasheet becomes available (hopefully.)
 200
 201 The IT8603E/IT8623E is a custom design, hardware monitoring part is similar to
 202 IT8728F. It only supports 3 fans, 16-bit fan mode, and the full speed mode
 203 of the fan is not supported (value 0 of pwmX_enable).
 204
 205 The IT8620E and IT8628E are custom designs, hardware monitoring part is similar
 206 to IT8728F. It only supports 16-bit fan mode. Both chips support up to 6 fans.
 207
 208 The IT8790E supports up to 3 fans. 16-bit fan mode is always enabled.
 209
 210 The IT8732F supports a closed-loop mode for fan control, but this is not
 211 currently implemented by the driver.
 212
 213 Temperatures are measured in degrees Celsius. An alarm is triggered once
 214 when the Overtemperature Shutdown limit is crossed.
 215
 216 Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
 217 triggered if the rotation speed has dropped below a programmable limit. When
 218 16-bit tachometer counters aren't used, fan readings can be divided by
 219 a programmable divider (1, 2, 4 or 8) to give the readings more range or
 220 accuracy. With a divider of 2, the lowest representable value is around
 221 2600 RPM. Not all RPM values can accurately be represented, so some rounding
 222 is done.
 223
 224 Voltage sensors (also known as IN sensors) report their values in volts. An
 225 alarm is triggered if the voltage has crossed a programmable minimum or
 226 maximum limit. Note that minimum in this case always means 'closest to
 227 zero'; this is important for negative voltage measurements. On most chips, all
 228 voltage inputs can measure voltages between 0 and 4.08 volts, with a resolution
 229 of 0.016 volt.  IT8603E, IT8721F/IT8758E and IT8728F can measure between 0 and
 230 3.06 volts, with a resolution of 0.012 volt.  IT8732F can measure between 0 and
 231 2.8 volts with a resolution of 0.0109 volt.  The battery voltage in8 does not
 232 have limit registers.
 233
 234 On the IT8603E, IT8620E, IT8628E, IT8721F/IT8758E, IT8732F, IT8781F, IT8782F,
 235 and IT8783E/F, some voltage inputs are internal and scaled inside the chip:
 236 * in3 (optional)
 237 * in7 (optional for IT8781F, IT8782F, and IT8783E/F)
 238 * in8 (always)
 239 * in9 (relevant for IT8603E only)
 240 The driver handles this transparently so user-space doesn't have to care.
 241
 242 The VID lines (IT8712F/IT8716F/IT8718F/IT8720F) encode the core voltage value:
 243 the voltage level your processor should work with. This is hardcoded by
 244 the mainboard and/or processor itself. It is a value in volts.
 245
 246 If an alarm triggers, it will remain triggered until the hardware register
 247 is read at least once. This means that the cause for the alarm may already
 248 have disappeared! Note that in the current implementation, all hardware
 249 registers are read whenever any data is read (unless it is less than 1.5
 250 seconds since the last update). This means that you can easily miss
 251 once-only alarms.
 252
 253 Out-of-limit readings can also result in beeping, if the chip is properly
 254 wired and configured. Beeping can be enabled or disabled per sensor type
 255 (temperatures, voltages and fans.)
 256
 257 The IT87xx only updates its values each 1.5 seconds; reading it more often
 258 will do no harm, but will return 'old' values.
 259
 260 To change sensor N to a thermistor, 'echo 4 > tempN_type' where N is 1, 2,
 261 or 3. To change sensor N to a thermal diode, 'echo 3 > tempN_type'.
 262 Give 0 for unused sensor. Any other value is invalid. To configure this at
 263 startup, consult lm_sensors's /etc/sensors.conf. (4 = thermistor;
 264 3 = thermal diode)
 265
 266
 267 Fan speed control
 268 -----------------
 269
 270 The fan speed control features are limited to manual PWM mode. Automatic
 271 "Smart Guardian" mode control handling is only implemented for older chips
 272 (see below.) However if you want to go for "manual mode" just write 1 to
 273 pwmN_enable.
 274
 275 If you are only able to control the fan speed with very small PWM values,
 276 try lowering the PWM base frequency (pwm1_freq). Depending on the fan,
 277 it may give you a somewhat greater control range. The same frequency is
 278 used to drive all fan outputs, which is why pwm2_freq and pwm3_freq are
 279 read-only.
 280
 281
 282 Automatic fan speed control (old interface)
 283 -------------------------------------------
 284
 285 The driver supports the old interface to automatic fan speed control
 286 which is implemented by IT8705F chips up to revision F and IT8712F
 287 chips up to revision G.
 288
 289 This interface implements 4 temperature vs. PWM output trip points.
 290 The PWM output of trip point 4 is always the maximum value (fan running
 291 at full speed) while the PWM output of the other 3 trip points can be
 292 freely chosen. The temperature of all 4 trip points can be freely chosen.
 293 Additionally, trip point 1 has an hysteresis temperature attached, to
 294 prevent fast switching between fan on and off.
 295
 296 The chip automatically computes the PWM output value based on the input
 297 temperature, based on this simple rule: if the temperature value is
 298 between trip point N and trip point N+1 then the PWM output value is
 299 the one of trip point N. The automatic control mode is less flexible
 300 than the manual control mode, but it reacts faster, is more robust and
 301 doesn't use CPU cycles.
 302
 303 Trip points must be set properly before switching to automatic fan speed
 304 control mode. The driver will perform basic integrity checks before
 305 actually switching to automatic control mode.
 306
 307
 308 Temperature offset attributes
 309 -----------------------------
 310
 311 The driver supports temp[1-3]_offset sysfs attributes to adjust the reported
 312 temperature for thermal diodes or diode-connected thermal transistors.
 313 If a temperature sensor is configured for thermistors, the attribute values
 314 are ignored. If the thermal sensor type is Intel PECI, the temperature offset
 315 must be programmed to the critical CPU temperature.
 316
 317 Preliminary support
 318 -------------------
 319
 320 Support for IT8607E is preliminary. Voltage readings, temperature readings,
 321 fan control, and fan speed measurements may be wrong and/or missing.
 322 Fan control and fan speed may be enabled and reported for non-existing
 323 fans. Please report any problems and inconsistencies.
 324
 325 Reporting information for unsupported chips
 326 -------------------------------------------
 327
 328 If the chip in your system is not yet supported by the driver, please provide
 329 the following information.
 330
 331 First, run sensors-detect. It will tell you something like
 332
 333     Probing for Super-I/O at 0x2e/0x2f
 334     ...
 335     Trying family `ITE'...                                      Yes
 336     Found unknown chip with ID 0x8665
 337         (logical device 4 has address 0x290, could be sensors)
 338
 339 With this information, run the following commands.
 340
 341 sudo isadump -k 0x87,0x01,0x55,0x55 0x2e 0x2f 7
 342 sudo isadump 0x295 0x296
 343
 344 and report the results.
 345
 346 The addresses in the first command are from "Probing for Super-I/O at
 347 0x2e/0x2f". Use those addresses in the first command.
 348     sudo isadump -k 0x87,0x01,0x55,0x55 0x2e 0x2f 7
 349
 350 The addresses in the second command are from "has address 0x290".
 351 Add 5 and 6 to this address for the next command.
 352     sudo isadump 0x295 0x296
 353
 354 Next, force-install the driver by providing one of the already supported chips
 355 as forced ID. Useful IDs to test are 0x8622, 0x8628, 0x8728, and 0x8732, though
 356 feel free to test more IDs. For each ID, instantiate the driver as follows
 357 (this example is instantiating driver with ID 0x8622).
 358         sudo modprobe it87 force_id=0x8622
 359 After entering this command, run the "sensors" command and provide the output.
 360 Then unload the driver with
 361         sudo modprobe -r it87
 362 Repeat with different chip IDs, and report each result.
 363
 364 Please also report your board type as well as voltages and fan settings from
 365 the BIOS. If possible, connect fans to different fan headers and let us know
 366 if all fans are detected and reported.
 367
 368 This information _might_ give us enough information to add experimental support
 369 for the chip in question. No guarantees, though - unless a datasheet is
 370 available, something is likely to be wrong.
 371
 372 A note on sensors-detect
 373 ========================
 374
 375 There is a persistent perception that changes in this driver would have impact
 376 on the output of sensors-detect. This is not the case. sensors-detect is an
 377 independent application. Changes in this driver do not affect sensors-detect,
 378 and changes in sensors-detect do not affect this driver.