Documentation/hwmon/f71882fg

   1 Kernel driver f71882fg
   2 ======================
   3
   4 Supported chips:
   5   * Fintek F71808E
   6     Prefix: 'f71808e'
   7     Addresses scanned: none, address read from Super I/O config space
   8     Datasheet: Not public
   9   * Fintek F71858FG
  10     Prefix: 'f71858fg'
  11     Addresses scanned: none, address read from Super I/O config space
  12     Datasheet: Available from the Fintek website
  13   * Fintek F71862FG and F71863FG
  14     Prefix: 'f71862fg'
  15     Addresses scanned: none, address read from Super I/O config space
  16     Datasheet: Available from the Fintek website
  17   * Fintek F71869F and F71869E
  18     Prefix: 'f71869'
  19     Addresses scanned: none, address read from Super I/O config space
  20     Datasheet: Available from the Fintek website
  21   * Fintek F71882FG and F71883FG
  22     Prefix: 'f71882fg'
  23     Addresses scanned: none, address read from Super I/O config space
  24     Datasheet: Available from the Fintek website
  25   * Fintek F71889FG
  26     Prefix: 'f71889fg'
  27     Addresses scanned: none, address read from Super I/O config space
  28     Datasheet: Available from the Fintek website
  29   * Fintek F71889ED
  30     Prefix: 'f71889ed'
  31     Addresses scanned: none, address read from Super I/O config space
  32     Datasheet: Should become available on the Fintek website soon
  33   * Fintek F8000
  34     Prefix: 'f8000'
  35     Addresses scanned: none, address read from Super I/O config space
  36     Datasheet: Not public
  37   * Fintek F81801U
  38     Prefix: 'f71889fg'
  39     Addresses scanned: none, address read from Super I/O config space
  40     Datasheet: Not public
  41     Note: This is the 64-pin variant of the F71889FG, they have the
  42           same device ID and are fully compatible as far as hardware
  43           monitoring is concerned.
  44   * Fintek F81865F
  45     Prefix: 'f81865f'
  46     Addresses scanned: none, address read from Super I/O config space
  47     Datasheet: Available from the Fintek website
  48
  49 Author: Hans de Goede <hdegoede@redhat.com>
  50
  51
  52 Description
  53 -----------
  54
  55 Fintek F718xx/F8000 Super I/O chips include complete hardware monitoring
  56 capabilities. They can monitor up to 9 voltages, 4 fans and 3 temperature
  57 sensors.
  58
  59 These chips also have fan controlling features, using either DC or PWM, in
  60 three different modes (one manual, two automatic).
  61
  62 The driver assumes that no more than one chip is present, which seems
  63 reasonable.
  64
  65
  66 Monitoring
  67 ----------
  68
  69 The Voltage, Fan and Temperature Monitoring uses the standard sysfs
  70 interface as documented in sysfs-interface, without any exceptions.
  71
  72
  73 Fan Control
  74 -----------
  75
  76 Both PWM (pulse-width modulation) and DC fan speed control methods are
  77 supported. The right one to use depends on external circuitry on the
  78 motherboard, so the driver assumes that the BIOS set the method
  79 properly.
  80
  81 Note that the lowest numbered temperature zone trip point corresponds to
  82 to the border between the highest and one but highest temperature zones, and
  83 vica versa. So the temperature zone trip points 1-4 (or 1-2) go from high temp
  84 to low temp! This is how things are implemented in the IC, and the driver
  85 mimicks this.
  86
  87 There are 2 modes to specify the speed of the fan, PWM duty cycle (or DC
  88 voltage) mode, where 0-100% duty cycle (0-100% of 12V) is specified. And RPM
  89 mode where the actual RPM of the fan (as measured) is controlled and the speed
  90 gets specified as 0-100% of the fan#_full_speed file.
  91
  92 Since both modes work in a 0-100% (mapped to 0-255) scale, there isn't a
  93 whole lot of a difference when modifying fan control settings. The only
  94 important difference is that in RPM mode the 0-100% controls the fan speed
  95 between 0-100% of fan#_full_speed. It is assumed that if the BIOS programs
  96 RPM mode, it will also set fan#_full_speed properly, if it does not then
  97 fan control will not work properly, unless you set a sane fan#_full_speed
  98 value yourself.
  99
 100 Switching between these modes requires re-initializing a whole bunch of
 101 registers, so the mode which the BIOS has set is kept. The mode is
 102 printed when loading the driver.
 103
 104 Three different fan control modes are supported; the mode number is written
 105 to the pwm#_enable file. Note that not all modes are supported on all
 106 chips, and some modes may only be available in RPM / PWM mode.
 107 Writing an unsupported mode will result in an invalid parameter error.
 108
 109 * 1: Manual mode
 110   You ask for a specific PWM duty cycle / DC voltage or a specific % of
 111   fan#_full_speed by writing to the pwm# file. This mode is only
 112   available on the F71858FG / F8000 if the fan channel is in RPM mode.
 113
 114 * 2: Normal auto mode
 115   You can define a number of temperature/fan speed trip points, which % the
 116   fan should run at at this temp and which temp a fan should follow using the
 117   standard sysfs interface. The number and type of trip points is chip
 118   depended, see which files are available in sysfs.
 119   Fan/PWM channel 3 of the F8000 is always in this mode!
 120
 121 * 3: Thermostat mode (Only available on the F8000 when in duty cycle mode)
 122   The fan speed is regulated to keep the temp the fan is mapped to between
 123   temp#_auto_point2_temp and temp#_auto_point3_temp.
 124
 125 All of the automatic modes require that pwm1 corresponds to fan1, pwm2 to
 126 fan2 and pwm3 to fan3.