root/lm-sensors/trunk/doc/chips/sis5595 @ 3000

Revision 3000, 7.8 KB (checked in by khali, 10 years ago)

Fix common spelling errors.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1Kernel driver `sis5595.o'
2=========================
3
4Status: Complete and tested
5
6Supported chips:
7  * Silicon Integrated Systems Corp. SiS5595 Southbridge Hardware Monitor
8    Prefix: sis5595
9    Addresses scanned: ISA in PCI-space encoded address
10    Datasheet: Publicly available at the Silicon Integrated Systems Corp. site.
11
12    Supports following revisions:
13        Version         PCI ID          PCI Revision
14        1               1039/0008       01
15        2               1039/0008       C0
16
17Author: Kyösti Mälkki <kmalkki@cc.hut.fi>
18
19   Note: The chips below contain a 0008 device which is incompatible with the
20         5595. We recognize these by the presence of the listed
21         "blacklist" PCI ID and refuse to load.
22
23   NOT SUPPORTED        PCI ID          BLACKLIST PCI ID       
24         540            0008            0540
25         550            0008            0550
26        5513            0008            5511
27        5581            0008            5597
28        5582            0008            5597
29        5597            0008            5597
30        5598            0008            5597/5598
31         630            0008            0630
32         645            0008            0645
33         730            0008            0730
34         735            0008            0735
35
36Module Parameters
37-----------------
38force_addr=0xaddr       Set the I/O base address. Useful for boards
39                        that don't set the address in the BIOS. Does not do a
40                        PCI force; the device must still be present in lspci.
41                        Don't use this unless the driver complains that the
42                        base address is not set.
43                        Example: 'modprobe sis5595 force_addr=0x290'
44
45
46Description
47-----------
48
49The Sis5595 southbridge has integrated hardware monitor functions.
50It also has an I2C bus, but this driver only supports the hardware monitor.
51For the I2C bus driver see i2c-sis5595.
52
53The SiS5595 implements zero or one temperature sensor, two FAN speed
54sensors, four or five voltage sensors, and alarms.
55
56On the first version of the chip, there are four voltage
57sensors and one temperature sensor.
58
59On the second version of the chip,
60the temperature sensor (temp) and the fifth voltage sensor (in4) share a pin
61which is configurable, but not through the driver. Sorry.
62The driver senses the configuration of the pin, which was hopefully
63set by the BIOS.
64If the temperature function is enabled, in4 will return 0.
65If the in4 function is enabled, temp will return 0.
66
67Temperatures are measured in degrees Celsius. An alarm is triggered once
68when the max is crossed; it is also triggered
69when it drops below the min value.
70Measurements are guaranteed
71between -55 and +125 degrees, with a resolution of 1 degree.
72
73FAN rotation speeds are reported in RPM (rotations per minute). An alarm is
74triggered if the rotation speed has dropped below a programmable limit. FAN
75readings can be divided by a programmable divider (1, 2, 4 or 8) to give
76the readings more range or accuracy. This is important because some FANs
77report only one 'tick' each rotation, while others report two - making
78all readings twice as high. Not all RPM values can accurately be represented,
79so some rounding is done. With a divider of 2, the lowest representable
80value is around 2600 RPM.
81
82Voltage sensors (also known as IN sensors) report their values in volts.
83An alarm is triggered if the voltage has crossed a programmable minimum
84or maximum limit. Note that minimum in this case always means 'closest to
85zero'; this is important for negative voltage measurements. All voltage
86inputs can measure voltages between 0 and 4.08 volts, with a resolution
87of 0.016 volt.
88
89In addition to the alarms described above, there is a BTI alarm, which gets
90triggered when an external chip has crossed its limits. Usually, this is
91connected to some LM75-like chip; if at least one crosses its limits, this
92bit gets set.
93
94If an alarm triggers, it will remain triggered until the hardware register
95is read at least once. This means that the cause for the alarm may
96already have disappeared!  Note that in the current implementation, all
97hardware registers are read whenever any data is read (unless it is less
98than 1.5 seconds since the last update). This means that you can easily
99miss once-only alarms.
100
101The Sis5595 only updates its values each 1.5 seconds; reading it more often
102will do no harm, but will return 'old' values.
103
104Problems
105--------
106Some chips refuse to be enabled. We don't know why.
107The driver will recognize this and print a message in dmesg.
108
109Chip Features
110-------------
111
112Chip `sis5595'
113             LABEL        LABEL CLASS      COMPUTE CLASS ACCESS MAGNITUDE
114               in0               NONE               NONE     R     2
115               in1               NONE               NONE     R     2
116               in2               NONE               NONE     R     2
117               in3               NONE               NONE     R     2
118               in4               NONE               NONE     R     2
119           in0_min                in0                in0     RW    2
120           in1_min                in1                in1     RW    2
121           in2_min                in2                in2     RW    2
122           in3_min                in3                in3     RW    2
123           in4_min                in4                in4     RW    2
124           in0_max                in0                in0     RW    2
125           in1_max                in1                in1     RW    2
126           in2_max                in2                in2     RW    2
127           in3_max                in3                in3     RW    2
128           in4_max                in4                in4     RW    2
129              fan1               NONE               NONE     R     0
130              fan2               NONE               NONE     R     0
131          fan1_min               fan1               fan1     RW    0
132          fan2_min               fan2               fan2     RW    0
133              temp               NONE               NONE     R     1
134         temp_hyst               temp               temp     RW    1
135         temp_over               temp               temp     RW    1
136          fan1_div               fan1               NONE     RW    0
137          fan2_div               fan2               NONE     RW    0
138            alarms               NONE               NONE     R     0
139
140             LABEL                          FEATURE SYMBOL        SYSCTL FILE:NR
141               in0                     SENSORS_SIS5595_IN0                in0:3
142               in1                     SENSORS_SIS5595_IN1                in1:3
143               in2                     SENSORS_SIS5595_IN2                in2:3
144               in3                     SENSORS_SIS5595_IN3                in3:3
145               in4                     SENSORS_SIS5595_IN4                in3:3
146           in0_min                 SENSORS_SIS5595_IN0_MIN                in0:1
147           in1_min                 SENSORS_SIS5595_IN1_MIN                in1:1
148           in2_min                 SENSORS_SIS5595_IN2_MIN                in2:1
149           in3_min                 SENSORS_SIS5595_IN3_MIN                in3:1
150           in4_min                 SENSORS_SIS5595_IN4_MIN                in4:1
151           in0_max                 SENSORS_SIS5595_IN0_MAX                in0:2
152           in1_max                 SENSORS_SIS5595_IN1_MAX                in1:2
153           in2_max                 SENSORS_SIS5595_IN2_MAX                in2:2
154           in3_max                 SENSORS_SIS5595_IN3_MAX                in3:2
155           in4_max                 SENSORS_SIS5595_IN4_MAX                in4:2
156              fan1                    SENSORS_SIS5595_FAN1               fan1:2
157              fan2                    SENSORS_SIS5595_FAN2               fan2:2
158          fan1_min                SENSORS_SIS5595_FAN1_MIN               fan1:1
159          fan2_min                SENSORS_SIS5595_FAN2_MIN               fan2:1
160              temp                    SENSORS_SIS5595_TEMP               temp:3
161         temp_hyst               SENSORS_SIS5595_TEMP_HYST               temp:2
162         temp_over               SENSORS_SIS5595_TEMP_OVER               temp:1
163          fan1_div                SENSORS_SIS5595_FAN1_DIV            fan_div:1
164          fan2_div                SENSORS_SIS5595_FAN2_DIV            fan_div:2
165            alarms                  SENSORS_SIS5595_ALARMS             alarms:1
166
167
Note: See TracBrowser for help on using the browser.