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

Revision 2790, 13.7 KB (checked in by mds, 8 years ago)

it87 doc cleanup

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1Kernel driver `it87.o'
2======================
3
4Status: Complete, stable
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
48
49Description
50-----------
51
52This driver implements support for the IT8705F chip.
53This chip is also known as SIS 950.
54
55This driver also supports IT8712F, which adds SmBus access, and a Vid
56input, used to report the Vcore voltage of the Pentium processor.
57
58These chips are 'Super I/O chips', supporting floppy disks, infrared ports,
59joysticks and other miscellaneous stuff. For hardware monitoring,
60they include an 'environmnent controller' with 3 temperature sensors,
613 fan rotation speed sensors, 8 voltage sensors, and associated alarms.
62
63Temperatures are measured in degrees Celcius. An alarm is triggered once
64when the Overtemperature Shutdown limit is crossed; it is triggered again
65as soon as it drops below the Hysteresis value.
66
67Fan rotation speeds are reported in RPM (rotations per minute). An alarm is
68triggered if the rotation speed has dropped below a programmable limit. Fan
69readings can be divided by a programmable divider (1, 2, 4 or 8) to give
70the readings more range or accuracy. This is important because some Fans
71report only one 'tick' each rotation, while others report two - making
72all readings twice as high. Not all RPM values can accurately be represented,
73so some rounding is done. With a divider of 2, the lowest representable
74value is around 2600 RPM.
75
76Voltage sensors (also known as IN sensors) report their values in volts.
77An alarm is triggered if the voltage has crossed a programmable minimum
78or maximum limit. Note that minimum in this case always means 'closest to
79zero'; this is important for negative voltage measurements. All voltage
80inputs can measure voltages between 0 and 4.08 volts, with a resolution
81of 0.016 volt.  The battery voltage in8 does not have limit registers.
82
83The VID lines (IT8712F only) encode the core voltage value: the voltage level
84your processor should work with. This is hardcoded by the mainboard and/or
85processor itself. It is a value in volts.
86
87If an alarm triggers, it will remain triggered until the hardware register
88is read at least once. This means that the cause for the alarm may
89already have disappeared!  Note that in the current implementation, all
90hardware registers are read whenever any data is read (unless it is less
91than 1.5 seconds since the last update). This means that you can easily
92miss once-only alarms.
93
94The IT87xx only updates its values each 1.5 seconds; reading it more often
95will do no harm, but will return 'old' values.
96
97The sensor type can be set at runtime as of release 2.8.2.
98To change sensor N to a thermistor, 'echo 2 > sensorN'
99where N is 1, 2, or 3.
100To change sensor N to a thermal diode, 'echo 3 > sensorN'.
101Give 0 for unused sensor. Any other value is invalid.
102To configure this at startup, put the following lines in the it87 section
103of /etc/sensors.conf.
104(2 = thermistor; 3 = thermal diode; 0 = unused)
105        set sensor1 3
106        set sensor2 3
107        set sensor3 3
108
109If you set a sensor to 0, you'll also want to ignore its value:
110        ignore tempN
111
112The fan speed control features can be enabled by setting the bits 0-2 of
113the fan_ctl register to 1. (Note: bits 6-4 of this register must be set to
1141 to enable the fan monitoring).
115        0x40 : enable fan speed monitoring for fan3
116        0x20 : enable fan speed monitoring for fan2
117        0x10 : enable fan speed monitoring for fan1
118        0x04 : enable fan smart guardian mode for fan3
119        0x02 : enable fan smart guardian mode for fan2
120        0x01 : enable fan smart guardian mode for fan1
121
122If a fan's smart guardian bit is not set this fan is in on-off mode.
123It can be switched on or off by setting/clearing the corresponding bit 0-2
124of the second fan control register fan_on_off. This register has no effect if
125a fan is in smart guardian mode.
126        0x04 : fan3 is on
127        0x02 : fan2 is on
128        0x01 : fan1 is on
129
130Bit 7 of the pwm[1-3] registers enables/disables the chip's automatic
131temperature control mode for the specified fan. If Bit 7 is set the bits
1321 and 0 encode the number of the temperature sensor used for this feature.
133Possible register values are:
134        0x00-0x7f direct power control for the fan speed
135        0x80  automatic smart guardian mode use temperature sensor 1
136        0x81  automatic smart guardian mode use temperature sensor 2
137        0x82  automatic smart guardian mode use temperature sensor 3
138
139In automatic smart guardian mode pwm values for low, medium and high speed
140can be set in sg_pwm[1-3]. The temperature limits for fan off, low, medium,
141hi speed and over temperature are set in sg_tl[1-3]. While the sensor's
142temperature is between the low and medium speed value the fan will run in
143low speed. When the sensor's temperature is between the medium and high speed
144value the fan spins in medium speed. When the sensor's temperature is between
145the high speed and over temperature value the fan spins in high speed.
146If the sensor's temperature is higher than the over temperature limit the
147fan will spin with the highest possible speed.
148
149Example:
150The preconfigured (BIOS set) values of the Shuttle XPC SN41G2 Barebone.
151The MB uses temp2 to monitor the CPU temperature and fan3 as the fan for their
152special ICE heatpipe cooling system.
153        $ cat fan_ctl
154        116
155        $ cat tan_on_off
156        215
157        $ cat pwm3
158        129
159        $ cat sg_tl3
160        16.0 16.0 48.0 54.0 58.0
161        $ cat sg_pwm3
162        3 4 9
163
164Explanation:
165        fan_ctl -> 116 = 0x74 = 01110100 : fan monitoring on for all fans,
166                and fan3 is in smart guardian mode.
167        fan_on_off -> 215 = 0xd7 =11010111 : all fans are on this setting is
168                ignored for fan3 which is in smart guardian mode
169        pwm3 -> 129 = 0x81 = 10000001 : fan3 is in automatic mode and uses
170                temp2 for speed control
171        sg_tl3 -> 16.0 16.0 48.0 54.0 58.0 : off, low, med, high, and
172                over temperature limits of fan3
173        sg_pwm3 -> 3 4 9 : pwm values for low, medium and high fan speed of fan3.
174
175
176
177Chip features
178-------------
179
180Chip `it87`
181          LABEL     LABEL CLASS   COMPUTE CLASS ACCESS MAGNITUDE
182            in0            NONE            NONE      R     2
183            in1            NONE            NONE      R     2
184            in2            NONE            NONE      R     2
185            in3            NONE            NONE      R     2
186            in4            NONE            NONE      R     2
187            in5            NONE            NONE      R     2
188            in6            NONE            NONE      R     2
189            in7            NONE            NONE      R     2
190            in8            NONE            NONE      R     2
191        in0_min             in0             in0      RW    2
192        in1_min             in1             in1      RW    2
193        in2_min             in2             in2      RW    2
194        in3_min             in3             in3      RW    2
195        in4_min             in4             in4      RW    2
196        in5_min             in5             in5      RW    2
197        in6_min             in6             in6      RW    2
198        in7_min             in6             in6      RW    2
199        in0_max             in0             in0      RW    2
200        in1_max             in1             in1      RW    2
201        in2_max             in2             in2      RW    2
202        in3_max             in3             in3      RW    2
203        in4_max             in4             in4      RW    2
204        in5_max             in5             in5      RW    2
205        in6_max             in6             in6      RW    2
206        in7_max             in6             in6      RW    2
207           fan1            NONE            NONE      R     0
208           fan2            NONE            NONE      R     0
209           fan3            NONE            NONE      R     0
210       fan1_min            fan1            fan1      RW    0
211       fan2_min            fan2            fan2      RW    0
212       fan3_min            fan3            fan3      RW    0
213          temp1            NONE            NONE      R     1
214          temp2            NONE            NONE      R     1
215          temp3            NONE            NONE      R     1
216      temp1_low            temp            temp      RW    1
217     temp1_over            temp            temp      RW    1
218      temp2_low            temp            temp      RW    1
219     temp2_over            temp            temp      RW    1
220      temp3_low            temp            temp      RW    1
221     temp3_over            temp            temp      RW    1
222            vid            NONE            NONE      R     2
223       fan1_div            fan1            NONE      RW    0
224       fan2_div            fan2            NONE      RW    0
225       fan3_div            fan3            NONE      R     0
226     alarms_vin            NONE            NONE      R     0
227     alarms_fan            NONE            NONE      R     0
228    alarms_temp            NONE            NONE      R     0
229
230          LABEL                           FEATURE SYMBOL     SYSCTL FILE:OFFSET
231            in0                         SENSORS_IT87_IN0             in0:3
232            in1                         SENSORS_IT87_IN1             in1:3
233            in2                         SENSORS_IT87_IN2             in2:3
234            in3                         SENSORS_IT87_IN3             in3:3
235            in4                         SENSORS_IT87_IN4             in4:3
236            in5                         SENSORS_IT87_IN5             in5:3
237            in6                         SENSORS_IT87_IN6             in6:3
238            in7                         SENSORS_IT87_IN7             in7:3
239        in0_min                     SENSORS_IT87_IN0_MIN             in0:1
240        in1_min                     SENSORS_IT87_IN1_MIN             in1:1
241        in2_min                     SENSORS_IT87_IN2_MIN             in2:1
242        in3_min                     SENSORS_IT87_IN3_MIN             in3:1
243        in4_min                     SENSORS_IT87_IN4_MIN             in4:1
244        in5_min                     SENSORS_IT87_IN5_MIN             in5:1
245        in6_min                     SENSORS_IT87_IN6_MIN             in6:1
246        in7_min                     SENSORS_IT87_IN7_MIN             in7:1
247        in0_max                     SENSORS_IT87_IN0_MAX             in0:2
248        in1_max                     SENSORS_IT87_IN1_MAX             in1:2
249        in2_max                     SENSORS_IT87_IN2_MAX             in2:2
250        in3_max                     SENSORS_IT87_IN3_MAX             in3:2
251        in4_max                     SENSORS_IT87_IN4_MAX             in4:2
252        in5_max                     SENSORS_IT87_IN5_MAX             in5:2
253        in6_max                     SENSORS_IT87_IN6_MAX             in6:2
254        in7_max                     SENSORS_IT87_IN7_MAX             in7:2
255           fan1                        SENSORS_IT87_FAN1            fan1:2
256           fan2                        SENSORS_IT87_FAN2            fan2:2
257           fan3                        SENSORS_IT87_FAN3            fan3:2
258       fan1_min                    SENSORS_IT87_FAN1_MIN            fan1:1
259       fan2_min                    SENSORS_IT87_FAN2_MIN            fan2:1
260       fan3_min                    SENSORS_IT87_FAN3_MIN            fan3:1
261          temp1                       SENSORS_IT87_TEMP1           temp1:3
262          temp2                       SENSORS_IT87_TEMP2           temp2:3
263          temp3                       SENSORS_IT87_TEMP3           temp3:3
264      temp1_low                   SENSORS_IT87_TEMP1_LOW           temp1:2
265     temp1_over                  SENSORS_IT87_TEMP1_HIGH           temp1:1
266      temp2_low                   SENSORS_IT87_TEMP2_LOW           temp2:2
267     temp2_over                  SENSORS_IT87_TEMP2_HIGH           temp2:1
268      temp3_low                   SENSORS_IT87_TEMP3_LOW           temp3:2
269     temp3_over                  SENSORS_IT87_TEMP3_HIGH           temp3:1
270            vid                         SENSORS_IT87_VID             vid:1
271       fan1_div                    SENSORS_IT87_FAN1_DIV         fan_div:1
272       fan2_div                    SENSORS_IT87_FAN2_DIV         fan_div:2
273       fan3_div                    SENSORS_IT87_FAN3_DIV         fan_div:3
274     alarms_fan                  SENSORS_IT87_ALARMS_FAN      alarms_fan:1
275     alarms_vin                  SENSORS_IT87_ALARMS_VIN      alarms_vin:1
276    alarms_temp                 SENSORS_IT87_ALARMS_TEMP     alarms_temp:1
277
278
Note: See TracBrowser for help on using the browser.