root/lm-sensors/branches/lm-sensors-2.10/doc/chips/fscher

Revision 3007, 11.5 KB (checked in by khali, 9 years ago)

Backport the cleanups and corrections Rudolf Marek and I did when
porting the chips documentation to Linux 2.6.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1Kernel driver `fscher.o'
2=======================
3
4Status: Stable
5   Tested with motherboard D1562
6   
7   Think twice before you're using the write mode of some
8   variables, especially the watchdog
9       
10
11Supported chips:
12  * Fujitsu-Siemens Hermes chip
13    Prefix: 'fscher'
14    Addresses scanned: I2C 0x73
15
16Author: Reinhard Nissl <rnissl@gmx.de> based on work from Hermann Jung
17        <hej@odn.de>, Frodo Looijaard <frodol@dds.nl> and Philip Edelbrock
18        <phil@netroedge.com>
19
20License: GPL
21
22
23Module Parameters
24-----------------
25
26* force: short array (min = 1, max = 48)
27  List of adapter,address pairs to boldly assume to be present
28* force_fscher: short array (min = 1, max = 48)
29  List of adapter,address pairs which are unquestionably assumed to contain
30  a `fscher' chip
31* probe: short array (min = 1, max = 48)
32  List of adapter,address pairs to scan additionally
33* probe_range: short array (min = 1, max = 48)
34  List of adapter,start-addr,end-addr triples to scan additionally
35* ignore: short array (min = 1, max = 48)
36  List of adapter,address pairs not to scan
37* ignore_range: short array (min = 1, max = 48)
38  List of adapter,start-addr,end-addr triples not to scan
39
40
41Description
42-----------
43
44This driver implements support for the Fujitsu-Siemens Hermes chip.
45It is described in the 'Register Set Specification BMC Hermes based
46Systemboard' from Fujitsu-Siemens.
47
48The Hermes chip implements a hardware-based system management,
49e.g. for controlling fan speed and core voltage.
50There is also a watchdog counter on the chip which can trigger
51an alarm and even shut the system down.
52
53The chip provides three temperature values (CPU, motherboard and auxiliary),
54three voltage values (+12V, +5V and battery) and three fans (power supply,
55CPU and auxiliary).
56
57Temperatures are measured in degrees Celsius. The resolution is 1 degree.
58
59Fan rotation speeds are reported in RPM (rotations per minute).
60The value can be divided by a programmable divider (1, 2 or 4) which
61is stored on the chip.
62
63Voltage sensors (also known as "in" sensors) report their values in volts.
64
65All values are reported as final values from the driver.
66There is no need for further calculations.
67
68
69Detailed description
70--------------------
71
72Below you'll find a single line description of all the bit values. With this
73information, you're able to decode e. g. alarms, wdog, etc.
74To make use of the watchdog, you'll need to set the watchdog time and enable
75the watchdog. After that it is necessary to restart the watchdog time within
76the specified period of time, or a system reset will occur.
77
78* rev:1
79  READING & 0xff = 0x??: HERMES revision identification
80
81* alarms:1
82  READING & 0x80 = 0x80: CPU throttling active
83  READING & 0x80 = 0x00: CPU running at full speed
84
85  READING & 0x10 = 0x10: software event (see control:1)
86  READING & 0x10 = 0x00: no software event
87
88  READING & 0x08 = 0x08: watchdog event (see wdog:2)
89  READING & 0x08 = 0x00: no watchdog event
90
91  READING & 0x02 = 0x02: thermal event (see temp*:1)
92  READING & 0x02 = 0x00: no thermal event
93
94  READING & 0x01 = 0x01: fan event (see fan*:1)
95  READING & 0x01 = 0x00: no fan event
96
97  READING & 0x13 ! 0x00: ALERT LED is flashing
98
99* control:1     
100  READING & 0x01 = 0x01: software event
101  READING & 0x01 = 0x00: no software event
102
103  WRITING & 0x01 = 0x01: set software event
104  WRITING & 0x01 = 0x00: clear software event
105
106* wdog:3
107  READING & 0x80 = 0x80: power off on watchdog event while thermal event
108  READING & 0x80 = 0x00: watchdog power off disabled (just system reset enabled)
109
110  READING & 0x40 = 0x40: watchdog timebase 60 seconds (see also wdog:1)
111  READING & 0x40 = 0x00: watchdog timebase  2 seconds
112
113  READING & 0x10 = 0x10: watchdog enabled
114  READING & 0x10 = 0x00: watchdog disabled
115
116  WRITING & 0x80 = 0x80: enable "power off on watchdog event while thermal event"
117  WRITING & 0x80 = 0x00: disable "power off on watchdog event while thermal event"
118
119  WRITING & 0x40 = 0x40: set watchdog timebase to 60 seconds
120  WRITING & 0x40 = 0x00: set watchdog timebase to  2 seconds
121
122  WRITING & 0x20 = 0x20: disable watchdog
123
124  WRITING & 0x10 = 0x10: enable watchdog / restart watchdog time
125
126* wdog:2     
127  READING & 0x02 = 0x02: watchdog system reset occurred
128  READING & 0x02 = 0x00: no watchdog system reset occurred
129
130  WRITING & 0x02 = 0x02: clear watchdog event
131
132* wdog:1
133  READING & 0xff = 0x??: configured watch dog time in units (see wdog:3 0x40)
134 
135  WRITING & 0xff = 0x??: configure watch dog time in units
136
137* in*:1     (0: +5V, 1: +12V, 2: onboard 3V battery)
138  READING: actual voltage value
139
140* temp*:1   (1: CPU sensor, 2: onboard sensor, 3: auxiliary sensor)
141  READING & 0x02 = 0x02: thermal event (overtemperature)
142  READING & 0x02 = 0x00: no thermal event
143
144  READING & 0x01 = 0x01: sensor is working
145  READING & 0x01 = 0x00: sensor is faulty
146
147  WRITING & 0x02 = 0x02: clear thermal event
148
149* temp*:2   (1: CPU sensor, 2: onboard sensor, 3: auxiliary sensor)
150  READING: actual temperature value
151 
152* fan*:1   (1: power supply fan, 2: CPU fan, 3: auxiliary fan)
153  READING & 0x04 = 0x04: fan event (fan fault)
154  READING & 0x04 = 0x00: no fan event
155
156  WRITING & 0x04 = 0x04: clear fan event
157
158* fan*:2   (1: power supply fan, 2: CPU fan, 3: auxiliary fan)
159  READING & 0x03 = 0x03: 8 ripples are one fan turn
160  READING & 0x03 = 0x02: 4 ripples are one fan turn
161  READING & 0x03 = 0x01: 2 ripples are one fan turn
162
163  WRITING & 0x03 = 0x03: set prescaler to "8 ripples are one fan turn"
164  WRITING & 0x03 = 0x02: set prescaler to "4 ripples are one fan turn"
165  WRITING & 0x03 = 0x01: set prescaler to "2 ripples are one fan turn"
166
167* fan*:3   (1: power supply fan, 2: CPU fan, 3: auxiliary fan)
168  READING & 0xff = 0x00: fan may be switched off
169  READING & 0xff = 0x01: fan must run at least at minimum speed (supply: 6V)
170  READING & 0xff = 0xff: fan must run at maximum speed (supply: 12V)
171  READING & 0xff = 0x??: fan must run at least at given speed (supply: 6V..12V)
172
173  WRITING & 0xff = 0x00: fan may be switched off
174  WRITING & 0xff = 0x01: fan must run at least at minimum speed (supply: 6V)
175  WRITING & 0xff = 0xff: fan must run at maximum speed (supply: 12V)
176  WRITING & 0xff = 0x??: fan must run at least at given speed (supply: 6V..12V)
177
178* fan*:4   (1: power supply fan, 2: CPU fan, 3: auxiliary fan)
179  READING: actual RPM value
180
181
182Limitations
183-----------
184
185* Measuring fan speed
186It seems that the chip counts "ripples" (typical fans produce 2 ripples per
187rotation while VERAX fans produce 18) in a 9-bit register. This register is
188read out every second, then the ripple prescaler (2, 4 or 8) is applied and
189the result is stored in the 8 bit output register. Due to the limitation of
190the counting register to 9 bits, it is impossible to measure a VERAX fan
191properly (even with a prescaler of 8). At its maximum speed of 3500 RPM the
192fan produces 1080 ripples per second which causes the counting register to
193overflow twice, leading to only 186 RPM.
194
195* Measuring input voltages
196in2 ("battery") reports the voltage of the onboard lithium battery and not
197+3.3V from the power supply.
198
199* Undocumented features
200Fujitsu-Siemens Computers has not documented all features of the chip so far.
201Their software, System Guard, shows that there are a still some features which
202cannot be controled by this implementation.
203
204
205Chip Features
206-------------
207
208Chip 'fscher'
209
210LABEL                 LABEL CLASS           COMPUTE CLASS          MODE  MAGN
211rev                   -                     -                       R-     0
212alarms                -                     -                       R-     0
213control               -                     -                       RW     0
214in0                   -                     -                       R-     2
215in1                   -                     -                       R-     2
216in2                   -                     -                       R-     2
217temp1                 -                     -                       R-     0
218temp2                 -                     -                       R-     0
219temp3                 -                     -                       R-     0
220temp1_state           temp1                 temp1                   RW     0
221temp2_state           temp2                 temp2                   RW     0
222temp3_state           temp3                 temp3                   RW     0
223fan1                  -                     -                       R-     0
224fan2                  -                     -                       R-     0
225fan3                  -                     -                       R-     0
226fan1_min              fan1                  fan1                    RW     0
227fan2_min              fan2                  fan2                    RW     0
228fan3_min              fan3                  fan3                    RW     0
229fan1_state            fan1                  fan1                    RW     0
230fan2_state            fan2                  fan2                    RW     0
231fan3_state            fan3                  fan3                    RW     0
232fan1_ripple           fan1                  fan1                    RW     0
233fan2_ripple           fan2                  fan2                    RW     0
234fan3_ripple           fan3                  fan3                    RW     0
235wdog_preset           -                     -                       RW     0
236wdog_state            wdog_preset           wdog_preset             RW     0
237wdog_control          wdog_preset           wdog_preset             RW     0
238       
239LABEL                 FEATURE SYMBOL                              SYSCTL FILE:N
240rev                   SENSORS_FSCHER_REV                                  rev:1
241alarms                SENSORS_FSCHER_EVENT                             alarms:1
242control               SENSORS_FSCHER_CONTROL                          control:1
243in0                   SENSORS_FSCHER_VOLTAGE1                             in0:1
244in1                   SENSORS_FSCHER_VOLTAGE2                             in1:1
245in2                   SENSORS_FSCHER_VOLTAGE3                             in2:1
246temp1                 SENSORS_FSCHER_TEMP1                              temp1:2
247temp2                 SENSORS_FSCHER_TEMP2                              temp2:2
248temp3                 SENSORS_FSCHER_TEMP3                              temp3:2
249temp1_state           SENSORS_FSCHER_TEMP1_STATE                        temp1:1
250temp2_state           SENSORS_FSCHER_TEMP2_STATE                        temp2:1
251temp3_state           SENSORS_FSCHER_TEMP3_STATE                        temp3:1
252fan1                  SENSORS_FSCHER_FAN1                                fan1:4
253fan2                  SENSORS_FSCHER_FAN2                                fan2:4
254fan3                  SENSORS_FSCHER_FAN3                                fan3:4
255fan1_min              SENSORS_FSCHER_FAN1_MIN                            fan1:2
256fan2_min              SENSORS_FSCHER_FAN2_MIN                            fan2:2
257fan3_min              SENSORS_FSCHER_FAN3_MIN                            fan3:2
258fan1_state            SENSORS_FSCHER_FAN1_STATE                          fan1:1
259fan2_state            SENSORS_FSCHER_FAN2_STATE                          fan2:1
260fan3_state            SENSORS_FSCHER_FAN3_STATE                          fan3:1
261fan1_ripple           SENSORS_FSCHER_FAN1_RIPPLE                         fan1:3
262fan2_ripple           SENSORS_FSCHER_FAN2_RIPPLE                         fan2:3
263fan3_ripple           SENSORS_FSCHER_FAN3_RIPPLE                         fan3:3
264wdog_preset           SENSORS_FSCHER_WDOG_PRESET                         wdog:1
265wdog_state            SENSORS_FSCHER_WDOG_STATE                          wdog:2
266wdog_control          SENSORS_FSCHER_WDOG_CONTROL                        wdog:3
Note: See TracBrowser for help on using the browser.