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