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