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