Blame view

Documentation/hwmon/abituguru-datasheet 12 KB
f2b84bbce   Hans de Goede   [PATCH] abituguru...
1
2
3
4
5
6
7
  uGuru datasheet
  ===============
  
  First of all, what I know about uGuru is no fact based on any help, hints or
  datasheet from Abit. The data I have got on uGuru have I assembled through
  my weak knowledge in "backwards engineering".
  And just for the record, you may have noticed uGuru isn't a chip developed by
25985edce   Lucas De Marchi   Fix common misspe...
8
  Abit, as they claim it to be. It's really just an microprocessor (uC) created by
f2b84bbce   Hans de Goede   [PATCH] abituguru...
9
  Winbond (W83L950D). And no, reading the manual for this specific uC or
25985edce   Lucas De Marchi   Fix common misspe...
10
  mailing  Windbond for help won't give any useful data about uGuru, as it is
f2b84bbce   Hans de Goede   [PATCH] abituguru...
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
  the program inside the uC that is responding to calls.
  
  Olle Sandberg <ollebull@gmail.com>, 2005-05-25
  
  
  Original version by Olle Sandberg who did the heavy lifting of the initial
  reverse engineering. This version has been almost fully rewritten for clarity
  and extended with write support and info on more databanks, the write support
  is once again reverse engineered by Olle the additional databanks have been
  reverse engineered by me. I would like to express my thanks to Olle, this
  document and the Linux driver could not have been written without his efforts.
  
  Note: because of the lack of specs only the sensors part of the uGuru is
  described here and not the CPU / RAM / etc voltage & frequency control.
  
  Hans de Goede <j.w.r.degoede@hhs.nl>, 28-01-2006
  
  
  Detection
  =========
  
  As far as known the uGuru is always placed at and using the (ISA) I/O-ports
  0xE0 and 0xE4, so we don't have to scan any port-range, just check what the two
  ports are holding for detection. We will refer to 0xE0 as CMD (command-port)
  and 0xE4 as DATA because Abit refers to them with these names.
  
  If DATA holds 0x00 or 0x08 and CMD holds 0x00 or 0xAC an uGuru could be
  present. We have to check for two different values at data-port, because
  after a reboot uGuru will hold 0x00 here, but if the driver is removed and
  later on attached again data-port will hold 0x08, more about this later.
  
  After wider testing of the Linux kernel driver some variants of the uGuru have
  turned up which will hold 0x00 instead of 0xAC at the CMD port, thus we also
25985edce   Lucas De Marchi   Fix common misspe...
44
  have to test CMD for two different values. On these uGuru's DATA will initially
f2b84bbce   Hans de Goede   [PATCH] abituguru...
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
  hold 0x09 and will only hold 0x08 after reading CMD first, so CMD must be read
  first!
  
  To be really sure an uGuru is present a test read of one or more register
  sets should be done.
  
  
  Reading / Writing
  =================
  
  Addressing
  ----------
  
  The uGuru has a number of different addressing levels. The first addressing
  level we will call banks. A bank holds data for one or more sensors. The data
  in a bank for a sensor is one or more bytes large.
  
  The number of bytes is fixed for a given bank, you should always read or write
  that many bytes, reading / writing more will fail, the results when writing
  less then the number of bytes for a given bank are undetermined.
  
  See below for all known bank addresses, numbers of sensors in that bank,
  number of bytes data per sensor and contents/meaning of those bytes.
  
  Although both this document and the kernel driver have kept the sensor
  terminoligy for the addressing within a bank this is not 100% correct, in
  bank 0x24 for example the addressing within the bank selects a PWM output not
  a sensor.
  
  Notice that some banks have both a read and a write address this is how the
  uGuru determines if a read from or a write to the bank is taking place, thus
  when reading you should always use the read address and when writing the
025dfdafe   Frederik Schwarzer   trivial: fix then...
77
  write address. The write address is always one (1) more than the read address.
f2b84bbce   Hans de Goede   [PATCH] abituguru...
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
  
  
  uGuru ready
  -----------
  
  Before you can read from or write to the uGuru you must first put the uGuru
  in "ready" mode.
  
  To put the uGuru in ready mode first write 0x00 to DATA and then wait for DATA
  to hold 0x09, DATA should read 0x09 within 250 read cycles.
  
  Next CMD _must_ be read and should hold 0xAC, usually CMD will hold 0xAC the
  first read but sometimes it takes a while before CMD holds 0xAC and thus it
  has to be read a number of times (max 50).
  
  After reading CMD, DATA should hold 0x08 which means that the uGuru is ready
  for input. As above DATA will usually hold 0x08 the first read but not always.
  This step can be skipped, but it is undetermined what happens if the uGuru has
  not yet reported 0x08 at DATA and you proceed with writing a bank address.
  
  
  Sending bank and sensor addresses to the uGuru
  ----------------------------------------------
  
  First the uGuru must be in "ready" mode as described above, DATA should hold
  0x08 indicating that the uGuru wants input, in this case the bank address.
  
  Next write the bank address to DATA. After the bank address has been written
  wait for to DATA to hold 0x08 again indicating that it wants / is ready for
  more input (max 250 reads).
  
  Once DATA holds 0x08 again write the sensor address to CMD.
  
  
  Reading
  -------
  
  First send the bank and sensor addresses as described above.
  Then for each byte of data you want to read wait for DATA to hold 0x01
  which indicates that the uGuru is ready to be read (max 250 reads) and once
  DATA holds 0x01 read the byte from CMD.
  
  Once all bytes have been read data will hold 0x09, but there is no reason to
  test for this. Notice that the number of bytes is bank address dependent see
  above and below.
73ac36ea1   Coly Li   fix similar typos...
123
  After completing a successful read it is advised to put the uGuru back in
f2b84bbce   Hans de Goede   [PATCH] abituguru...
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
  ready mode, so that it is ready for the next read / write cycle. This way
  if your program / driver is unloaded and later loaded again the detection
  algorithm described above will still work.
  
  
  
  Writing
  -------
  
  First send the bank and sensor addresses as described above.
  Then for each byte of data you want to write wait for DATA to hold 0x00
  which indicates that the uGuru is ready to be written (max 250 reads) and
  once DATA holds 0x00 write the byte to CMD.
  
  Once all bytes have been written wait for DATA to hold 0x01 (max 250 reads)
  don't ask why this is the way it is.
  
  Once DATA holds 0x01 read CMD it should hold 0xAC now.
73ac36ea1   Coly Li   fix similar typos...
142
  After completing a successful write it is advised to put the uGuru back in
f2b84bbce   Hans de Goede   [PATCH] abituguru...
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
  ready mode, so that it is ready for the next read / write cycle. This way
  if your program / driver is unloaded and later loaded again the detection
  algorithm described above will still work.
  
  
  Gotchas
  -------
  
  After wider testing of the Linux kernel driver some variants of the uGuru have
  turned up which do not hold 0x08 at DATA within 250 reads after writing the
  bank address. With these versions this happens quite frequent, using larger
  timeouts doesn't help, they just go offline for a second or 2, doing some
  internal callibration or whatever. Your code should be prepared to handle
  this and in case of no response in this specific case just goto sleep for a
  while and then retry.
  
  
  Address Map
  ===========
  
  Bank 0x20 Alarms (R)
  --------------------
  This bank contains 0 sensors, iow the sensor address is ignored (but must be
  written) just use 0. Bank 0x20 contains 3 bytes:
  
  Byte 0:
  This byte holds the alarm flags for sensor 0-7 of Sensor Bank1, with bit 0
  corresponding to sensor 0, 1 to 1, etc.
  
  Byte 1:
  This byte holds the alarm flags for sensor 8-15 of Sensor Bank1, with bit 0
  corresponding to sensor 8, 1 to 9, etc.
  
  Byte 2:
  This byte holds the alarm flags for sensor 0-5 of Sensor Bank2, with bit 0
  corresponding to sensor 0, 1 to 1, etc.
  
  
  Bank 0x21 Sensor Bank1 Values / Readings (R)
  --------------------------------------------
  This bank contains 16 sensors, for each sensor it contains 1 byte.
  So far the following sensors are known to be available on all motherboards:
  Sensor  0 CPU temp
  Sensor  1 SYS temp
  Sensor  3 CPU core volt
  Sensor  4 DDR volt
  Sensor 10 DDR Vtt volt
  Sensor 15 PWM temp
  
  Byte 0:
  This byte holds the reading from the sensor. Sensors in Bank1 can be both
  volt and temp sensors, this is motherboard specific. The uGuru however does
  seem to know (be programmed with) what kindoff sensor is attached see Sensor
  Bank1 Settings description.
  
  Volt sensors use a linear scale, a reading 0 corresponds with 0 volt and a
  reading of 255 with 3494 mV. The sensors for higher voltages however are
  connected through a division circuit. The currently known division circuits
  in use result in ranges of: 0-4361mV, 0-6248mV or 0-14510mV. 3.3 volt sources
  use the 0-4361mV range, 5 volt the 0-6248mV and 12 volt the 0-14510mV .
  
  Temp sensors also use a linear scale, a reading of 0 corresponds with 0 degree
  Celsius and a reading of 255 with a reading of 255 degrees Celsius.
  
  
  Bank 0x22 Sensor Bank1 Settings (R)
  Bank 0x23 Sensor Bank1 Settings (W)
  -----------------------------------
  
  This bank contains 16 sensors, for each sensor it contains 3 bytes. Each
  set of 3 bytes contains the settings for the sensor with the same sensor
  address in Bank 0x21 .
  
  Byte 0:
  Alarm behaviour for the selected sensor. A 1 enables the described behaviour.
  Bit 0: Give an alarm if measured temp is over the warning threshold	(RW) *
  Bit 1: Give an alarm if measured volt is over the max threshold		(RW) **
  Bit 2: Give an alarm if measured volt is under the min threshold	(RW) **
  Bit 3: Beep if alarm							(RW)
  Bit 4: 1 if alarm cause measured temp is over the warning threshold	(R)
  Bit 5: 1 if alarm cause measured volt is over the max threshold		(R)
  Bit 6: 1 if alarm cause measured volt is under the min threshold	(R)
025dfdafe   Frederik Schwarzer   trivial: fix then...
225
  Bit 7: Volt sensor: Shutdown if alarm persist for more than 4 seconds	(RW)
f2b84bbce   Hans de Goede   [PATCH] abituguru...
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
         Temp sensor: Shutdown if temp is over the shutdown threshold	(RW)
  
  *  This bit is only honored/used by the uGuru if a temp sensor is connected
  ** This bit is only honored/used by the uGuru if a volt sensor is connected
  Note with some trickery this can be used to find out what kinda sensor is
  detected see the Linux kernel driver for an example with many comments on
  how todo this.
  
  Byte 1:
  Temp sensor: warning threshold  (scale as bank 0x21)
  Volt sensor: min threshold      (scale as bank 0x21)
  
  Byte 2:
  Temp sensor: shutdown threshold (scale as bank 0x21)
  Volt sensor: max threshold      (scale as bank 0x21)
  
  
  Bank 0x24 PWM outputs for FAN's (R)
  Bank 0x25 PWM outputs for FAN's (W)
  -----------------------------------
  
  This bank contains 3 "sensors", for each sensor it contains 5 bytes.
  Sensor 0 usually controls the CPU fan
  Sensor 1 usually controls the NB (or chipset for single chip) fan
  Sensor 2 usually controls the System fan
  
  Byte 0:
  Flag 0x80 to enable control, Fan runs at 100% when disabled.
  low nibble (temp)sensor address at bank 0x21 used for control.
  
  Byte 1:
  0-255 = 0-12v (linear), specify voltage at which fan will rotate when under
  low threshold temp (specified in byte 3)
  
  Byte 2:
  0-255 = 0-12v (linear), specify voltage at which fan will rotate when above
  high threshold temp (specified in byte 4)
  
  Byte 3:
  Low threshold temp  (scale as bank 0x21)
  
  byte 4:
  High threshold temp (scale as bank 0x21)
  
  
  Bank 0x26 Sensors Bank2 Values / Readings (R)
  ---------------------------------------------
  
  This bank contains 6 sensors (AFAIK), for each sensor it contains 1 byte.
  So far the following sensors are known to be available on all motherboards:
  Sensor 0: CPU fan speed
  Sensor 1: NB (or chipset for single chip) fan speed
  Sensor 2: SYS fan speed
  
  Byte 0:
  This byte holds the reading from the sensor. 0-255 = 0-15300 (linear)
  
  
  Bank 0x27 Sensors Bank2 Settings (R)
  Bank 0x28 Sensors Bank2 Settings (W)
  ------------------------------------
  
  This bank contains 6 sensors (AFAIK), for each sensor it contains 2 bytes.
  
  Byte 0:
  Alarm behaviour for the selected sensor. A 1 enables the described behaviour.
  Bit 0: Give an alarm if measured rpm is under the min threshold	(RW)
  Bit 3: Beep if alarm						(RW)
025dfdafe   Frederik Schwarzer   trivial: fix then...
294
  Bit 7: Shutdown if alarm persist for more than 4 seconds	(RW)
f2b84bbce   Hans de Goede   [PATCH] abituguru...
295
296
297
298
299
300
301
302
303
304
305
306
307
308
  
  Byte 1:
  min threshold (scale as bank 0x26)
  
  
  Warning for the adventerous
  ===========================
  
  A word of caution to those who want to experiment and see if they can figure
  the voltage / clock programming out, I tried reading and only reading banks
  0-0x30 with the reading code used for the sensor banks (0x20-0x28) and this
  resulted in a _permanent_ reprogramming of the voltages, luckily I had the
  sensors part configured so that it would shutdown my system on any out of spec
  voltages which proprably safed my computer (after a reboot I managed to
25985edce   Lucas De Marchi   Fix common misspe...
309
  immediately enter the bios and reload the defaults). This probably means that
f2b84bbce   Hans de Goede   [PATCH] abituguru...
310
  the read/write cycle for the non sensor part is different from the sensor part.