root/lm-sensors/trunk/doc/chips/it87 @ 2651

Revision 2651, 13.6 KB (checked in by khali, 9 years ago)

Discard outdated module parameters.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1Kernel driver `it87.o'
2======================
3
4Status: Beta
5
6Supported chips:
7  * IT8705F
8    ISA 0x290
9    Datasheet: Publicly available at the ITE website
10               http://www.ite.com.tw
11  * IT8712F (untested)
12    Addresses scanned: I2C 0x20 - 0x2f (inclusive), ISA 0x290 (8 I/O ports)
13    Datasheet: Publicly available at the ITE website
14               http://www.ite.com.tw
15  * Sis950   [clone of IT8705F]
16    ISA 0x290
17    Datasheet: Publicly available at the SIS website
18        Appears to no longer be available on SIS website, found at
19        http://ic.doma.kiev.ua/pdf/chip/sio.htm
20
21Author: Christophe Gauthron <chrisg@0-in.com>
22
23
24Module Parameters
25-----------------
26
27* force: short array (min = 1, max = 48)
28  List of adapter,address pairs to boldly assume to be present
29* ignore: short array (min = 1, max = 48)
30  List of adapter,address pairs not to scan
31* ignore_range: short array (min = 1, max = 48)
32  List of adapter,start-addr,end-addr triples not to scan
33* probe: short array (min = 1, max = 48)
34  List of adapter,address pairs to scan additionally
35* probe_range: short array (min = 1, max = 48)
36  List of adapter,start-addr,end-addr triples to scan additionally
37* update_vbat: integer 0 if vbat should report power on value, 1 if
38  vbat should be updated after each read.  Default is 0.
39  On some boards the battery voltage is provided by either the battery or
40  the onboard power supply. Only the first reading at power on will be
41  the actual battery voltage (which the chip does automatically).  On other
42  boards the battery voltage is always fed to the chip so can be read at
43  any time.  Excessive reading may decrease battery life but no information
44  is given in the datasheet.
45* reset: integer 1 if the registers of the chip should be reset at
46  module load time, 0 to not reset the registers. Default is 0.
47
48Description
49-----------
50
51This driver implements support for the IT8705F chip.
52This chip is also known as SIS 950.
53
54This driver also supports IT8712F, which adds SmBus access, and a Vid
55input, used to report the Vcore voltage of the Pentium processor.
56
57These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
58joysticks and other miscellaneous stuff. For hardware monitoring,
59they include an 'environmnent controller' with 3 temperature sensors,
603 FAN rotation speed sensors, 8 voltage sensors, and associated alarms.
61
62Temperatures are measured in degrees Celcius. An alarm is triggered once
63when the Overtemperature Shutdown limit is crossed; it is triggered again
64as soon as it drops below the Hysteresis value.
65
66FAN rotation speeds are reported in RPM (rotations per minute). An alarm is
67triggered if the rotation speed has dropped below a programmable limit. FAN
68readings can be divided by a programmable divider (1, 2, 4 or 8) to give
69the readings more range or accuracy. This is important because some FANs
70report only one 'tick' each rotation, while others report two - making
71all readings twice as high. Not all RPM values can accurately be represented,
72so some rounding is done. With a divider of 2, the lowest representable
73value is around 2600 RPM.
74
75Voltage sensors (also known as IN sensors) report their values in volts.
76An alarm is triggered if the voltage has crossed a programmable minimum
77or maximum limit. Note that minimum in this case always means 'closest to
78zero'; this is important for negative voltage measurements. All voltage
79inputs can measure voltages between 0 and 4.08 volts, with a resolution
80of 0.016 volt.  The battery voltage in8 does not have limit registers.
81
82The VID lines (IT8712F only) encode the core voltage value: the voltage level
83your processor should work with. This is hardcoded by the mainboard and/or
84processor itself. It is a value in volts.
85
86If an alarm triggers, it will remain triggered until the hardware register
87is read at least once. This means that the cause for the alarm may
88already have disappeared!  Note that in the current implementation, all
89hardware registers are read whenever any data is read (unless it is less
90than 1.5 seconds since the last update). This means that you can easily
91miss once-only alarms.
92
93The IT87xx only updates its values each 1.5 seconds; reading it more often
94will do no harm, but will return 'old' values.
95
96The sensor type can be set at runtime as of release 2.8.2.
97To change sensor N to a thermistor, 'echo 2 > sensorN'
98where N is 1, 2, or 3.
99To change sensor N to a thermal diode, 'echo 3 > sensorN'.
100Give 0 for unused sensor. Any other value is invalid.
101To configure this at startup, put the following lines in the it87 section
102of /etc/sensors.conf.
1032 = thermistor; 3 = thermal diode; 0 = unused
104           set sensor1 3
105           set sensor2 3
106           set sensor3 3
107If you set a sensor to 0, you'll also want to ignore its value:
108           ignore tempN
109
110The fan speed control features can be enabled by setting the bits 0-2 of
111the fan_ctl register to 1. (Note: bits 6-4 of this register must be set to
1121 to enable the fan monitoring).
1130x40 : enable fan speed monitoring for fan3
1140x20 : enable fan speed monitoring for fan2
1150x10 : enable fan speed monitoring for fan1
1160x04 : enable fan smart guardian mode for fan3
1170x02 : enable fan smart guardian mode for fan2
1180x01 : enable fan smart guardian mode for fan1
119If a fans smart guardian bit is not set this fan is in on-off mode
120it can be switched on or off by setting/clearing the corresponding bit 0-2
121of the second fan control register fan_on_off. This register has no effect if
122a fan is in smart guardian mode.
1230x04 : fan3 is on
1240x02 : fan2 is on
1250x01 : fan1 is on
126Bit 7 of the pwm[1-3] registers enables/disables the chips automatic
127temperature control mode for the specified fan. If Bit 7 is set the bits
1281 and 0 encode the number of the temperature sensor used for this feature.
129Possible register values are:
1300x00-0x7f direct power control for the fan speed
1310x80  automatic smart guardian mode use temperatur sensor 1,
1320x81  automatic smart guardian mode use temperatur sensor 2,
1330x82  automatic smart guardian mode use temperatur sensor 3
134In automatic smart guardian mode pwm values for low, medium and high speed
135can be set in sg_pwm[1-3]. The temperature limits for fan off, low, medium,
136hi speed and over temperature are set in sg_tl[1-3]. While the sensors
137temperature is between the low and medium speed value the fan will run in
138low speed. When the sensors temperature is between the medium and high speed
139value the fan spins in medium speed. When the sensors temperature is between
140the high speed and over temperature value the fan spins in high speed.
141If the sensors temperature is higher than the over temperature limit the
142fan will spin with the highest possible speed.
143Example:
144The preconfigured (BIOS set) values of the Shuttle XPC SN41G2 Barebone.
145The MB uses temp2 to monitor the CPU temperature and fan3 as the fan for their
146special ICE heatpipe cooling system.
147---
148$ cat fan_ctl
149116
150$ cat tan_on_off
151215
152$ cat pwm3
153129
154$ cat sg_tl3
15516.0 16.0 48.0 54.0 58.0
156$ cat sg_pwm3
1573 4 9
158---
159Explanation:
160fan_ctl -> 116 = 0x74 = 01110100 : fan monitoring on for all fans, and fan3 is in smart guardian mode.
161fan_on_off -> 215 = 0xd7 =11010111 : all fans are on this setting is ignored for fan3 which is in smart guardian mode
162pwm3 -> 129 = 0x81 = 10000001 : fan3 is in automatic mode and uses temp2 for speed control
163sg_tl3 -> 16.0 16.0 48.0 54.0 58.0 : off, low, med, high, and over temperature limits of fan3
164sg_pwm3 -> 3 4 9 : pwm values for low, medium and high fan speed of fan3.
165
166Chip features
167-------------
168
169Chip `it87`
170          LABEL     LABEL CLASS   COMPUTE CLASS ACCESS MAGNITUDE
171            in0            NONE            NONE      R     2
172            in1            NONE            NONE      R     2
173            in2            NONE            NONE      R     2
174            in3            NONE            NONE      R     2
175            in4            NONE            NONE      R     2
176            in5            NONE            NONE      R     2
177            in6            NONE            NONE      R     2
178            in7            NONE            NONE      R     2
179            in8            NONE            NONE      R     2
180        in0_min             in0             in0      RW    2
181        in1_min             in1             in1      RW    2
182        in2_min             in2             in2      RW    2
183        in3_min             in3             in3      RW    2
184        in4_min             in4             in4      RW    2
185        in5_min             in5             in5      RW    2
186        in6_min             in6             in6      RW    2
187        in7_min             in6             in6      RW    2
188        in0_max             in0             in0      RW    2
189        in1_max             in1             in1      RW    2
190        in2_max             in2             in2      RW    2
191        in3_max             in3             in3      RW    2
192        in4_max             in4             in4      RW    2
193        in5_max             in5             in5      RW    2
194        in6_max             in6             in6      RW    2
195        in7_max             in6             in6      RW    2
196           fan1            NONE            NONE      R     0
197           fan2            NONE            NONE      R     0
198           fan3            NONE            NONE      R     0
199       fan1_min            fan1            fan1      RW    0
200       fan2_min            fan2            fan2      RW    0
201       fan3_min            fan3            fan3      RW    0
202          temp1            NONE            NONE      R     1
203          temp2            NONE            NONE      R     1
204          temp3            NONE            NONE      R     1
205      temp1_low            temp            temp      RW    1
206     temp1_over            temp            temp      RW    1
207      temp2_low            temp            temp      RW    1
208     temp2_over            temp            temp      RW    1
209      temp3_low            temp            temp      RW    1
210     temp3_over            temp            temp      RW    1
211            vid            NONE            NONE      R     2
212       fan1_div            fan1            NONE      RW    0
213       fan2_div            fan2            NONE      RW    0
214       fan3_div            fan3            NONE      R     0
215     alarms_vin            NONE            NONE      R     0
216     alarms_fan            NONE            NONE      R     0
217    alarms_temp            NONE            NONE      R     0
218
219          LABEL                           FEATURE SYMBOL     SYSCTL FILE:OFFSET
220            in0                         SENSORS_IT87_IN0             in0:3
221            in1                         SENSORS_IT87_IN1             in1:3
222            in2                         SENSORS_IT87_IN2             in2:3
223            in3                         SENSORS_IT87_IN3             in3:3
224            in4                         SENSORS_IT87_IN4             in4:3
225            in5                         SENSORS_IT87_IN5             in5:3
226            in6                         SENSORS_IT87_IN6             in6:3
227            in7                         SENSORS_IT87_IN7             in7:3
228        in0_min                     SENSORS_IT87_IN0_MIN             in0:1
229        in1_min                     SENSORS_IT87_IN1_MIN             in1:1
230        in2_min                     SENSORS_IT87_IN2_MIN             in2:1
231        in3_min                     SENSORS_IT87_IN3_MIN             in3:1
232        in4_min                     SENSORS_IT87_IN4_MIN             in4:1
233        in5_min                     SENSORS_IT87_IN5_MIN             in5:1
234        in6_min                     SENSORS_IT87_IN6_MIN             in6:1
235        in7_min                     SENSORS_IT87_IN7_MIN             in7:1
236        in0_max                     SENSORS_IT87_IN0_MAX             in0:2
237        in1_max                     SENSORS_IT87_IN1_MAX             in1:2
238        in2_max                     SENSORS_IT87_IN2_MAX             in2:2
239        in3_max                     SENSORS_IT87_IN3_MAX             in3:2
240        in4_max                     SENSORS_IT87_IN4_MAX             in4:2
241        in5_max                     SENSORS_IT87_IN5_MAX             in5:2
242        in6_max                     SENSORS_IT87_IN6_MAX             in6:2
243        in7_max                     SENSORS_IT87_IN7_MAX             in7:2
244           fan1                        SENSORS_IT87_FAN1            fan1:2
245           fan2                        SENSORS_IT87_FAN2            fan2:2
246           fan3                        SENSORS_IT87_FAN3            fan3:2
247       fan1_min                    SENSORS_IT87_FAN1_MIN            fan1:1
248       fan2_min                    SENSORS_IT87_FAN2_MIN            fan2:1
249       fan3_min                    SENSORS_IT87_FAN3_MIN            fan3:1
250          temp1                       SENSORS_IT87_TEMP1           temp1:3
251          temp2                       SENSORS_IT87_TEMP2           temp2:3
252          temp3                       SENSORS_IT87_TEMP3           temp3:3
253      temp1_low                   SENSORS_IT87_TEMP1_LOW           temp1:2
254     temp1_over                  SENSORS_IT87_TEMP1_HIGH           temp1:1
255      temp2_low                   SENSORS_IT87_TEMP2_LOW           temp2:2
256     temp2_over                  SENSORS_IT87_TEMP2_HIGH           temp2:1
257      temp3_low                   SENSORS_IT87_TEMP3_LOW           temp3:2
258     temp3_over                  SENSORS_IT87_TEMP3_HIGH           temp3:1
259            vid                         SENSORS_IT87_VID             vid:1
260       fan1_div                    SENSORS_IT87_FAN1_DIV         fan_div:1
261       fan2_div                    SENSORS_IT87_FAN2_DIV         fan_div:2
262       fan3_div                    SENSORS_IT87_FAN3_DIV         fan_div:3
263     alarms_fan                  SENSORS_IT87_ALARMS_FAN      alarms_fan:1
264     alarms_vin                  SENSORS_IT87_ALARMS_VIN      alarms_vin:1
265    alarms_temp                 SENSORS_IT87_ALARMS_TEMP     alarms_temp:1
266
267
Note: See TracBrowser for help on using the browser.