]> sigrok.org Git - libsigrok.git/blame - src/hardware/gmc-mh-1x-2x/protocol.c
projects / libsigrok.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Random whitespace and other minor fixes.
[libsigrok.git] / src / hardware / gmc-mh-1x-2x / protocol.c
CommitLineData
7b4edcb6
MH		 1/*
2 * This file is part of the libsigrok project.
3 *
c90beca7 4 * Copyright (C) 2013, 2014 Matthias Heidbrink <m-sigrok@heidbrink.biz>
7b4edcb6
MH		 5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
6392d599
MH		 20/** @file
21 * Gossen Metrawatt Metrahit 1x/2x drivers
c90beca7 22 * @internal
6392d599
MH		 23 */
24
f5792417
MH		 25#include <math.h>
26#include <string.h>
7b4edcb6
MH		 27#include "protocol.h"
28
c90beca7
MH		 29/* Internal Headers */
30static guchar calc_chksum_14(guchar* dta);
31static int chk_msg14(struct sr_dev_inst *sdi);
32
f5792417
MH		 33/** Set or clear flags in devc->mqflags. */
34static void setmqf(struct dev_context *devc, uint64_t flags, gboolean set)
35{
36 if (set)
37 devc->mqflags |= flags;
38 else
39 devc->mqflags &= ~flags;
40}
41
fc348b77
UH		 42/** Decode current type and measured value, Metrahit 12-16. */
43static void decode_ctmv_16(uint8_t ctmv, struct dev_context *devc)
f5792417
MH		 44{
45 devc->mq = 0;
46 devc->unit = 0;
47 devc->mqflags = 0;
48
49 switch (ctmv) {
50 case 0x00: /* 0000 - */
51 break;
52 case 0x01: /* 0001 mV DC */
53 devc->scale1000 = -1; /* Fall through */
54 case 0x02: /* 0010 V DC */
55 case 0x03: /* 0011 V AC+DC */
56 case 0x04: /* 0100 V AC */
57 devc->mq = SR_MQ_VOLTAGE;
58 devc->unit = SR_UNIT_VOLT;
59 if (ctmv <= 0x03)
60 devc->mqflags |= SR_MQFLAG_DC;
61 if (ctmv >= 0x03) {
62 devc->mqflags |= SR_MQFLAG_AC;
873e0c12 63 if (devc->model >= METRAHIT_16S)
f5792417 64 devc->mqflags |= SR_MQFLAG_RMS;
fc348b77 65 }
f5792417
MH		 66 break;
67 case 0x05: /* 0101 Hz (15S/16S only) */
68 case 0x06: /* 0110 kHz (15S/16S only) */
69 devc->mq = SR_MQ_FREQUENCY;
70 devc->unit = SR_UNIT_HERTZ;
71 if (ctmv == 0x06)
72 devc->scale1000 = 1;
73 break;
74 case 0x07: /* 0111 % (15S/16S only) */
75 devc->mq = SR_MQ_DUTY_CYCLE;
76 devc->unit = SR_UNIT_PERCENTAGE;
77 break;
78 case 0x08: /* 1000 Diode */
79 devc->mq = SR_MQ_VOLTAGE;
80 devc->unit = SR_UNIT_VOLT;
81 devc->mqflags |= SR_MQFLAG_DIODE;
82 break;
83 case 0x09: /* 1001 Ohm, °C */
84 case 0x0a: /* 1010 kOhm */
85 case 0x0b: /* 1011 MOhm */
86 devc->mq = SR_MQ_RESISTANCE; /* Changed to temp. later if req.*/
87 devc->unit = SR_UNIT_OHM;
88 devc->scale1000 = ctmv - 0x09;
89 break;
90 case 0x0c: /* 1100 nF (15S/16S only) */
91 case 0x0d: /* 1101 µF (15S/16S only) */
92 devc->mq = SR_MQ_CAPACITANCE;
93 devc->unit = SR_UNIT_FARAD;
94 if (ctmv == 0x0c)
95 devc->scale1000 = -3;
96 else
97 devc->scale1000 = -2;
98 break;
99 case 0x0e: /* mA, µA */
100 devc->scale1000 = -1; /* Fall through. */
101 case 0x0f: /* A */
102 devc->mq = SR_MQ_CURRENT;
103 devc->unit = SR_UNIT_AMPERE;
873e0c12 104 if (devc->model == METRAHIT_16S)
f5792417
MH		 105 devc->mqflags |= SR_MQFLAG_RMS;
106 /* 16I A only with clamp, RMS questionable. */
107 break;
108 }
109}
110
fc348b77
UH		 111/**
112 * Decode range/sign/acdc byte special chars (Metrahit 12-16).
113 *
1d4a2839 114 * @param[in] rs Range and sign byte.
f5792417 115 */
fc348b77 116static void decode_rs_16(uint8_t rs, struct dev_context *devc)
f5792417
MH		 117{
118 sr_spew("decode_rs_16(%d) scale = %f", rs, devc->scale);
119
1d4a2839 120 if (rs & 0x04) /* Sign */
f5792417
MH		 121 devc->scale *= -1.0;
122
123 if (devc->mq == SR_MQ_CURRENT) {
1d4a2839 124 if (rs & 0x08) /* Current is AC */
f5792417
MH		 125 devc->mqflags |= SR_MQFLAG_AC;
126 else
127 devc->mqflags |= SR_MQFLAG_DC;
128 }
129
130 switch (rs & 0x03) {
131 case 0:
fc348b77 132 if (devc->mq == SR_MQ_VOLTAGE) /* V */
f5792417
MH		 133 devc->scale *= 0.1;
134 else if (devc->mq == SR_MQ_CURRENT) /* 000.0 µA */
7f7f6a2e 135 devc->scale *= 0.00001;
f5792417
MH		 136 else if (devc->mq == SR_MQ_RESISTANCE) {
137 if (devc->buflen >= 10) {
138 /* °C with 10 byte msg type, otherwise GOhm. */
139 devc->mq = SR_MQ_TEMPERATURE;
140 devc->unit = SR_UNIT_CELSIUS;
141 devc->scale *= 0.01;
42f2f8a5 142 } else if (devc->scale1000 == 2) {
f5792417
MH		 143 /* 16I Iso 500/1000V 3 GOhm */
144 devc->scale *= 0.1;
145 }
146 }
147 break;
148 case 1:
149 devc->scale *= 0.0001;
150 break;
151 case 2:
152 devc->scale *= 0.001;
153 break;
154 case 3:
155 devc->scale *= 0.01;
156 break;
157 }
158}
159
fc348b77
UH		 160/**
161 * Decode special chars, Metrahit 12-16.
162 *
163 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
f5792417 164 */
fc348b77 165static void decode_spc_16(uint8_t spc, struct dev_context *devc)
f5792417
MH		 166{
167 /* xxxx1xxx ON */
168 /* TODO: What does that mean? Power on? The 16I sets this. */
169 /* xxxxx1xx BEEP */
170 /* xxxxxx1x Low battery */
171 /* xxxxxxx1 FUSE */
172 /* 1xxxxxxx MIN */
173 setmqf(devc, SR_MQFLAG_MIN, spc & 0x80);
174
175 /* x1xxxxxx MAN */
176 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x40));
177
178 /* xx1xxxxx DATA */
179 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x20);
180
181 /* xxx1xxxx MAX */
182 setmqf(devc, SR_MQFLAG_MAX, spc & 0x10);
183}
184
fc348b77
UH		 185/** Decode current type and measured value, Metrahit 18. */
186static void decode_ctmv_18(uint8_t ctmv, struct dev_context *devc)
f5792417
MH		 187{
188 devc->mq = 0;
189 devc->unit = 0;
190 devc->mqflags = 0;
191
192 switch (ctmv) {
193 case 0x00: /* 0000 - */
194 break;
195 case 0x01: /* 0001 V AC */
196 case 0x02: /* 0010 V AC+DC */
197 case 0x03: /* 0011 V DC */
198 devc->mq = SR_MQ_VOLTAGE;
199 devc->unit = SR_UNIT_VOLT;
200 if (ctmv <= 0x02)
201 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
202 if (ctmv >= 0x02)
203 devc->mqflags |= SR_MQFLAG_DC;
204 break;
205 case 0x04: /* 0100 Ohm/Ohm with buzzer */
206 devc->mq = SR_MQ_RESISTANCE;
207 devc->unit = SR_UNIT_OHM;
208 break;
fc348b77 209 case 0x05: /* 0101 Diode/Diode with buzzer */
f5792417
MH		 210 devc->mq = SR_MQ_VOLTAGE;
211 devc->unit = SR_UNIT_VOLT;
212 devc->mqflags |= SR_MQFLAG_DIODE;
213 break;
214 case 0x06: /* 0110 °C */
215 devc->mq = SR_MQ_TEMPERATURE;
216 devc->unit = SR_UNIT_CELSIUS;
217 break;
218 case 0x07: /* 0111 F */
219 devc->mq = SR_MQ_CAPACITANCE;
220 devc->unit = SR_UNIT_FARAD;
221 break;
222 case 0x08: /* 1000 mA DC */
223 case 0x09: /* 1001 A DC */
224 case 0x0a: /* 1010 mA AC+DC */
225 case 0x0b: /* 1011 A AC+DC */
226 devc->mq = SR_MQ_CURRENT;
227 devc->unit = SR_UNIT_AMPERE;
228 devc->mqflags |= SR_MQFLAG_DC;
229 if (ctmv >= 0x0a)
230 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_RMS);
231 if ((ctmv == 0x08) || (ctmv == 0x0a))
232 devc->scale1000 = -1;
233 break;
234 case 0x0c: /* 1100 Hz */
235 devc->mq = SR_MQ_FREQUENCY;
236 devc->unit = SR_UNIT_HERTZ;
237 break;
238 case 0x0d: /* 1101 dB */
239 devc->mq = SR_MQ_VOLTAGE;
240 devc->unit = SR_UNIT_DECIBEL_VOLT;
241 devc->mqflags |= SR_MQFLAG_AC; /* dB available for AC only */
242 break;
243 case 0x0e: /* 1110 Events AC, Events AC+DC. Actually delivers just
c90beca7 244 * current voltage via IR, nothing more. */
f5792417
MH		 245 devc->mq = SR_MQ_VOLTAGE;
246 devc->unit = SR_UNIT_VOLT;
247 devc->mqflags |= SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS;
248 break;
249 case 0x0f: /* 1111 Clock */
250 devc->mq = SR_MQ_TIME;
251 devc->unit = SR_UNIT_SECOND;
252 devc->mqflags |= SR_MQFLAG_DURATION;
253 break;
254 }
255}
256
fc348b77
UH		 257/**
258 * Decode range/sign/acdc byte special chars, Metrahit 18.
259 *
260 * @param[in] rs Rance/sign byte.
f5792417 261 */
fc348b77 262static void decode_rs_18(uint8_t rs, struct dev_context *devc)
f5792417
MH		 263{
264 int range;
265
266 /* Sign */
267 if (((devc->scale > 0) && (rs & 0x08)) ||
c90beca7 268 ((devc->scale < 0) && !(rs & 0x08)))
f5792417
MH		 269 devc->scale *= -1.0;
270
271 /* Range */
272 range = rs & 0x07;
273 switch (devc->mq) {
274 case SR_MQ_VOLTAGE:
275 if (devc->unit == SR_UNIT_DECIBEL_VOLT) {
276 devc->scale *= pow(10.0, -2);
fc348b77
UH		 277 /*
278 * When entering relative mode, the device switches
f5792417
MH		 279 * from 10 byte to 6 byte msg format. Unfortunately
280 * it switches back to 10 byte when the second value
281 * is measured, so that's not sufficient to
282 * identify relative mode.
283 */
284 }
f5792417
MH		 285 else
286 devc->scale *= pow(10.0, range - 5);
287 break;
288 case SR_MQ_CURRENT:
289 if (devc->scale1000 == -1)
290 devc->scale *= pow(10.0, range - 5);
291 else
292 devc->scale *= pow(10.0, range - 4);
293 break;
294 case SR_MQ_RESISTANCE:
295 devc->scale *= pow(10.0, range - 2);
296 break;
297 case SR_MQ_FREQUENCY:
c90beca7 298 devc->scale *= pow(10.0, range - 2);
f5792417
MH		 299 break;
300 case SR_MQ_TEMPERATURE:
301 devc->scale *= pow(10.0, range - 2);
302 break;
303 case SR_MQ_CAPACITANCE:
c90beca7 304 devc->scale *= pow(10.0, range - 13);
f5792417 305 break;
c90beca7 306 /* TODO: 29S Mains measurements. */
f5792417
MH		 307 }
308}
309
fc348b77
UH		 310/**
311 * Decode special chars, Metrahit 18.
312 *
313 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
f5792417 314 */
fc348b77 315static void decode_spc_18(uint8_t spc, struct dev_context *devc)
f5792417
MH		 316{
317 /* xxxx1xxx ZERO */
318 /* xxxxx1xx BEEP */
319 /* xxxxxx1x Low battery */
320 /* xxxxxxx1 Fuse */
321
322 if (devc->mq == SR_MQ_TIME) {
323 /* xxx1xxxx Clock running: 1; stop: 0 */
324 sr_spew("Clock running: %d", spc >> 4);
fc348b77 325 } else {
f5792417
MH		 326 /* 1xxxxxxx MAN */
327 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
328
329 /* x1xxxxxx MIN */
330 setmqf(devc, SR_MQFLAG_MIN, spc & 0x40);
331
332 /* xx1xxxxx MAX */
333 setmqf(devc, SR_MQFLAG_MAX, spc & 0x20);
334
335 /* xxx1xxxx DATA */
336 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
337 }
338}
339
fc348b77
UH		 340/**
341 * Decode current type and measured value, Metrahit 2x.
342 *
343 * @param[in] ctmv Current type and measured value (v1 | (v2 << 4)).
f5792417 344 */
fc348b77 345static void decode_ctmv_2x(uint8_t ctmv, struct dev_context *devc)
f5792417 346{
5791bdf6
MH		 347 if ((ctmv > 0x20) || (!devc)) {
348 sr_err("decode_ctmv_2x(0x%x): invalid param(s)!", ctmv);
f5792417
MH		 349 return;
350 }
351
352 devc->mq = 0;
353 devc->unit = 0;
354 devc->mqflags = 0;
355
356 switch (ctmv) {
357 /* 00000 unused */
358 case 0x01: /* 00001 V DC */
359 case 0x02: /* 00010 V AC+DC */
360 case 0x03: /* 00011 V AC */
361 devc->mq = SR_MQ_VOLTAGE;
362 devc->unit = SR_UNIT_VOLT;
363 if (ctmv <= 0x02)
364 devc->mqflags |= SR_MQFLAG_DC;
365 if (ctmv >= 0x02) {
366 devc->mqflags |= SR_MQFLAG_AC;
873e0c12 367 if (devc->model >= METRAHIT_24S)
6392d599 368 devc->mqflags |= SR_MQFLAG_RMS;
f5792417
MH		 369 }
370 break;
371 case 0x04: /* 00100 mA DC */
372 case 0x05: /* 00101 mA AC+DC */
373 devc->scale1000 = -1;
5791bdf6 374 /* Fall through! */
f5792417
MH		 375 case 0x06: /* 00110 A DC */
376 case 0x07: /* 00111 A AC+DC */
377 devc->mq = SR_MQ_CURRENT;
378 devc->unit = SR_UNIT_AMPERE;
379 devc->mqflags |= SR_MQFLAG_DC;
380 if ((ctmv == 0x05) || (ctmv == 0x07)) {
381 devc->mqflags |= SR_MQFLAG_AC;
873e0c12 382 if (devc->model >= METRAHIT_24S)
f5792417
MH		 383 devc->mqflags |= SR_MQFLAG_RMS;
384 }
385 break;
386 case 0x08: /* 01000 Ohm */
387 devc->mq = SR_MQ_RESISTANCE;
388 devc->unit = SR_UNIT_OHM;
389 break;
390 case 0x09: /* 01001 F */
391 devc->mq = SR_MQ_CAPACITANCE;
392 devc->unit = SR_UNIT_FARAD;
393 devc->scale *= 0.1;
394 break;
c90beca7 395 case 0x0a: /* 01010 V dB */
f5792417
MH		 396 devc->mq = SR_MQ_VOLTAGE;
397 devc->unit = SR_UNIT_DECIBEL_VOLT;
398 devc->mqflags |= SR_MQFLAG_AC;
6392d599
MH		 399 if (devc->model >= METRAHIT_24S)
400 devc->mqflags |= SR_MQFLAG_RMS;
f5792417
MH		 401 break;
402 case 0x0b: /* 01011 Hz U ACDC */
403 case 0x0c: /* 01100 Hz U AC */
404 devc->mq = SR_MQ_FREQUENCY;
405 devc->unit = SR_UNIT_HERTZ;
406 devc->mqflags |= SR_MQFLAG_AC;
407 if (ctmv <= 0x0b)
408 devc->mqflags |= SR_MQFLAG_DC;
409 break;
410 case 0x0d: /* 01101 W on power, mA range (29S only) */
5791bdf6 411 devc->scale *= 0.1;
6392d599 412 /* Fall through! */
f5792417 413 case 0x0e: /* 01110 W on power, A range (29S only) */
5791bdf6
MH		 414 devc->scale *= 0.1;
415 devc->scale1000 = -1;
f5792417
MH		 416 devc->mq = SR_MQ_POWER;
417 devc->unit = SR_UNIT_WATT;
5791bdf6 418 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
f5792417
MH		 419 break;
420 case 0x0f: /* 01111 Diode */
421 case 0x10: /* 10000 Diode with buzzer (actually cont. with voltage) */
422 devc->unit = SR_UNIT_VOLT;
423 if (ctmv == 0x0f) {
424 devc->mq = SR_MQ_VOLTAGE;
425 devc->mqflags |= SR_MQFLAG_DIODE;
fc348b77 426 } else {
f5792417
MH		 427 devc->mq = SR_MQ_CONTINUITY;
428 devc->scale *= 0.00001;
429 }
430 devc->unit = SR_UNIT_VOLT;
431 break;
432 case 0x11: /* 10001 Ohm with buzzer */
433 devc->mq = SR_MQ_CONTINUITY;
434 devc->unit = SR_UNIT_OHM;
435 devc->scale1000 = -1;
436 break;
437 case 0x12: /* 10010 Temperature */
438 devc->mq = SR_MQ_TEMPERATURE;
439 devc->unit = SR_UNIT_CELSIUS;
440 /* This can be Fahrenheit. That is detected by range=4 later. */
441 break;
5791bdf6
MH		 442 /* 0x13 10011 unused */
443 /* 0x14 10100 unused */
f5792417
MH		 444 case 0x15: /* 10101 Press (29S only) */
445 /* TODO: What does that mean? Possibly phase shift?
446 Then we need a unit/flag for it. */
447 devc->mq = SR_MQ_GAIN;
448 devc->unit = SR_UNIT_PERCENTAGE;
449 break;
450 case 0x16: /* 10110 Pulse W (29S only) */
451 /* TODO: Own unit and flag for this! */
452 devc->mq = SR_MQ_POWER;
453 devc->unit = SR_UNIT_WATT;
454 break;
455 case 0x17: /* 10111 TRMS V on mains (29S only) */
456 devc->mq = SR_MQ_VOLTAGE;
457 devc->unit = SR_UNIT_VOLT;
5791bdf6 458 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
f5792417
MH		 459 break;
460 case 0x18: /* 11000 Counter (zero crossings of a signal) */
461 devc->mq = SR_MQ_VOLTAGE;
462 devc->unit = SR_UNIT_UNITLESS;
463 break;
464 case 0x19: /* 11001 Events U ACDC */
465 case 0x1a: /* 11010 Events U AC */
466 /* TODO: No unit or flags for this yet! */
467 devc->mq = SR_MQ_VOLTAGE;
468 devc->unit = SR_UNIT_UNITLESS;
469 devc->mqflags |= SR_MQFLAG_AC;
470 if (ctmv <= 0x19)
471 devc->mqflags |= SR_MQFLAG_DC;
472 break;
5791bdf6
MH		 473 case 0x1b: /* 11011 Milliamperes in power mode (29S only); error in docs, "pulse on mains" */
474 devc->mq = SR_MQ_CURRENT;
475 devc->unit = SR_UNIT_AMPERE;
476 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
477 devc->scale1000 = -1;
f5792417
MH		 478 break;
479 case 0x1c: /* 11100 dropout on mains (29S only) */
480 /* TODO: No unit or flags for this yet! */
481 devc->mq = SR_MQ_VOLTAGE;
482 devc->unit = SR_UNIT_UNITLESS;
483 devc->mqflags |= SR_MQFLAG_AC;
484 break;
5791bdf6
MH		 485 case 0x1d: /* 11101 Voltage in power mode (29S); undocumented! */
486 devc->mq = SR_MQ_VOLTAGE;
487 devc->unit = SR_UNIT_VOLT;
488 devc->mqflags |= (SR_MQFLAG_AC | SR_MQFLAG_DC | SR_MQFLAG_RMS);
489 break;
490 /* 0x1e: 11110 Undocumented */
491 case 0x1f: /* 11111 25S in stopwatch mode; undocumented!
d1d3b7df
MH		 492 The value is voltage, not time, so treat it such. */
493 devc->mq = SR_MQ_VOLTAGE;
494 devc->unit = SR_UNIT_VOLT;
495 devc->mqflags |= SR_MQFLAG_DC;
496 break;
5791bdf6
MH		 497 case 0x20: /* 100000 25S in event count mode; undocumented!
498 Value is 0 anyway. */
d1d3b7df
MH		 499 devc->mq = SR_MQ_VOLTAGE;
500 devc->unit = SR_UNIT_UNITLESS;
501 break;
f5792417 502 default:
d1d3b7df 503 sr_err("decode_ctmv_2x(%d, ...): Unknown ctmv!", ctmv);
fc348b77 504 break;
f5792417
MH		 505 }
506}
507
fc348b77 508/**
6392d599 509 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR.
fc348b77 510 *
6392d599 511 * @param[in] rs Range/sign byte.
f5792417 512 */
fc348b77 513static void decode_rs_2x(uint8_t rs, struct dev_context *devc)
f5792417 514{
fc348b77 515 int range;
f5792417
MH		 516
517 /* Sign */
518 if (((devc->scale > 0) && (rs & 0x08)) ||
6392d599 519 ((devc->scale < 0) && !(rs & 0x08)))
f5792417
MH		 520 devc->scale *= -1.0;
521
522 /* Range */
523 range = rs & 0x07;
524 switch (devc->mq) {
525 case SR_MQ_VOLTAGE:
fc348b77 526 if (devc->unit == SR_UNIT_DECIBEL_VOLT)
f5792417 527 devc->scale *= pow(10.0, -3);
c90beca7 528 else
f5792417 529 devc->scale *= pow(10.0, range - 6);
f5792417
MH		 530 break;
531 case SR_MQ_CURRENT:
c90beca7
MH		 532 if (devc->scale1000 != -1) /* uA, mA */
533 range += 1;/* mA and A ranges differ by 10^4, not 10^3!*/
534 devc->scale *= pow(10.0, range - 6);
f5792417
MH		 535 break;
536 case SR_MQ_RESISTANCE:
537 devc->scale *= pow(10.0, range - 3);
538 break;
539 case SR_MQ_FREQUENCY:
540 devc->scale *= pow(10.0, range - 3);
541 break;
542 case SR_MQ_TEMPERATURE:
fc348b77 543 if (range == 4) /* Indicator for °F */
f5792417 544 devc->unit = SR_UNIT_FAHRENHEIT;
f5792417
MH		 545 devc->scale *= pow(10.0, - 2);
546 break;
547 case SR_MQ_CAPACITANCE:
6392d599
MH		 548 if (range == 7)
549 range -= 1; /* Same value as range 6 */
f5792417
MH		 550 devc->scale *= pow(10.0, range - 13);
551 break;
552 /* TODO: 29S Mains measurements. */
553 }
554}
555
c90beca7
MH		 556/**
557 * Decode range/sign/acdc byte special chars, Metrahit 2x, table TR 2.
558 *
559 * @param[in] rs Range/sign byte.
560 */
561static void decode_rs_2x_TR2(uint8_t rs, struct dev_context *devc)
562{
563 int range;
564
565 /* Range */
566 range = rs & 0x07;
567 switch (devc->mq) {
568 case SR_MQ_CURRENT:
569 if (devc->scale1000 == -1) /* mA */
0c5f2abc 570 switch (range) {
c90beca7
MH		 571 case 0: case 1: /* 100, 300 µA */
572 devc->scale *= pow(10.0, -6);
573 break;
574 case 2: case 3: /* 1, 3 mA */
575 devc->scale *= pow(10.0, -5);
576 break;
577 case 4: case 5: /* 10, 30 mA */
578 devc->scale *= pow(10.0, -4);
579 break;
580 case 6: case 7: /* 100, 300 mA */
581 devc->scale *= pow(10.0, -3);
582 break;
583 }
584 else /* A */
0c5f2abc 585 switch (range) {
c90beca7
MH		 586 case 0: case 1: /* 1, 3 A */
587 devc->scale *= pow(10.0, -5);
588 break;
589 case 2: /* 10 A */
590 devc->scale *= pow(10.0, -4);
591 break;
592 }
593 break;
594 default:
595 decode_rs_2x(rs, devc);
596 return;
597 }
598
599 /* Sign */
600 if (((devc->scale > 0) && (rs & 0x08)) ||
601 ((devc->scale < 0) && !(rs & 0x08)))
602 devc->scale *= -1.0;
603}
604
fc348b77
UH		 605/**
606 * Decode special chars (Metrahit 2x).
607 *
608 * @param[in] spc Special characters 1 and 2 (s1 | (s2 << 4)).
f5792417 609 */
fc348b77 610static void decode_spc_2x(uint8_t spc, struct dev_context *devc)
f5792417
MH		 611{
612 /* xxxxxxx1 Fuse */
613
614 /* xxxxxx1x Low battery */
615
616 /* xxxxx1xx BEEP */
617
618 /* xxxx1xxx ZERO */
619
620 /* xxx1xxxx DATA */
621 setmqf(devc, SR_MQFLAG_HOLD, spc & 0x10);
622
623 /* x11xxxxx unused */
624 /* 1xxxxxxx MAN */
625 setmqf(devc, SR_MQFLAG_AUTORANGE, !(spc & 0x80));
626}
627
628/** Clean range and sign. */
629static void clean_rs_v(struct dev_context *devc)
630{
631 devc->value = 0.0;
632 devc->scale = 1.0;
633}
634
635/** Clean current type, measured variable, range and sign. */
636static void clean_ctmv_rs_v(struct dev_context *devc)
637{
638 devc->mq = 0;
639 devc->unit = 0;
640 devc->mqflags = 0;
641 devc->scale1000 = 0;
f5792417
MH		 642 clean_rs_v(devc);
643}
644
645/** Send prepared value. */
646static void send_value(struct sr_dev_inst *sdi)
647{
648 struct dev_context *devc;
649 struct sr_datafeed_analog analog;
650 struct sr_datafeed_packet packet;
651
652 devc = sdi->priv;
653
654 memset(&analog, 0, sizeof(analog));
ba7dd8bb 655 analog.channels = sdi->channels;
f5792417
MH		 656 analog.num_samples = 1;
657 analog.mq = devc->mq;
658 analog.unit = devc->unit;
659 analog.mqflags = devc->mqflags;
660 analog.data = &devc->value;
661
662 memset(&packet, 0, sizeof(packet));
663 packet.type = SR_DF_ANALOG;
664 packet.payload = &analog;
665 sr_session_send(devc->cb_data, &packet);
666
667 devc->num_samples++;
668}
669
6392d599 670/** Process 6-byte data message, Metrahit 1x/2x send mode. */
f5792417
MH		 671static void process_msg_dta_6(struct sr_dev_inst *sdi)
672{
673 struct dev_context *devc;
674 int cnt;
fc348b77 675 uint8_t dgt;
f5792417
MH		 676
677 devc = sdi->priv;
678 clean_rs_v(devc);
679
680 /* Byte 0, range and sign */
873e0c12 681 if (devc->model <= METRAHIT_16X)
f5792417 682 decode_rs_16(bc(devc->buf[0]), devc);
873e0c12 683 else if (devc->model < METRAHIT_2X)
f5792417 684 decode_rs_18(bc(devc->buf[0]), devc);
c90beca7 685 else {
f5792417 686 decode_rs_2x(bc(devc->buf[0]), devc);
c90beca7
MH		 687 devc->scale *= 10; /* Compensate for format having only 5 digits, decode_rs_2x() assumes 6. */
688 }
f5792417
MH		 689
690 /* Bytes 1-5, digits (ls first). */
691 for (cnt = 0; cnt < 5; cnt++) {
692 dgt = bc(devc->buf[1 + cnt]);
693 if (dgt >= 10) {
694 /* 10 Overload; on model <= 16X also 11 possible. */
695 devc->value = NAN;
696 devc->scale = 1.0;
697 break;
698 }
699 devc->value += pow(10.0, cnt) * dgt;
700 }
6392d599 701
c90beca7 702 sr_spew("process_msg_dta_6() value=%f scale=%f scale1000=%d",
f5792417
MH		 703 devc->value, devc->scale, devc->scale1000);
704 if (devc->value != NAN)
705 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
706
707 /* Create and send packet. */
708 send_value(sdi);
709}
710
711/** Process 5-byte info message, Metrahit 1x/2x. */
712static void process_msg_inf_5(struct sr_dev_inst *sdi)
713{
714 struct dev_context *devc;
715 enum model model;
716
717 devc = sdi->priv;
718
719 clean_ctmv_rs_v(devc);
720
721 /* Process byte 0 */
873e0c12 722 model = gmc_decode_model_sm(bc(devc->buf[0]));
f5792417
MH		 723 if (model != devc->model) {
724 sr_warn("Model mismatch in data: Detected %s, now %s",
873e0c12 725 gmc_model_str(devc->model), gmc_model_str(model));
f5792417
MH		 726 }
727
728 /* Process bytes 1-4 */
873e0c12 729 if (devc->model <= METRAHIT_16X) {
f5792417
MH		 730 decode_ctmv_16(bc(devc->buf[1]), devc);
731 decode_spc_16(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
732 decode_rs_16(bc(devc->buf[4]), devc);
873e0c12 733 } else if (devc->model <= METRAHIT_18S) {
f5792417
MH		 734 decode_ctmv_18(bc(devc->buf[1]), devc);
735 decode_spc_18(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
736 decode_rs_18(bc(devc->buf[4]), devc);
fc348b77 737 } else { /* Must be Metrahit 2x */
f5792417
MH		 738 decode_ctmv_2x(bc(devc->buf[1]), devc);
739 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
740 decode_rs_2x(bc(devc->buf[4]), devc);
741 }
742}
743
744/** Process 10-byte info/data message, Metrahit 15+. */
745static void process_msg_inf_10(struct sr_dev_inst *sdi)
746{
747 struct dev_context *devc;
748 int cnt;
fc348b77 749 uint8_t dgt;
f5792417
MH		 750
751 devc = sdi->priv;
752
753 process_msg_inf_5(sdi);
754
755 /* Now decode numbers */
756 for (cnt = 0; cnt < 5; cnt++) {
757 dgt = bc(devc->buf[5 + cnt]);
c90beca7
MH		 758 if (dgt == 11) { /* Empty digit */
759 dgt = 0;
760 }
761 else if (dgt >= 12) { /* Overload */
f5792417
MH		 762 devc->value = NAN;
763 devc->scale = 1.0;
764 break;
765 }
766 devc->value += pow(10.0, cnt) * dgt;
767 }
768 sr_spew("process_msg_inf_10() value=%f scale=%f scalet=%d",
c90beca7 769 devc->value, devc->scale, devc->scale1000);
f5792417
MH		 770
771 if (devc->value != NAN)
772 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
773
774 /* Create and send packet. */
775 send_value(sdi);
776}
777
778/** Decode send interval (Metrahit 2x only). */
fc348b77 779static const char *decode_send_interval(uint8_t si)
f5792417
MH		 780{
781 switch (si) {
fc348b77
UH		 782 case 0x00:
783 return "0.05";
784 case 0x01:
785 return "0.1";
786 case 0x02:
787 return "0.2";
788 case 0x03:
789 return "0.5";
790 case 0x04:
791 return "00:01";
792 case 0x05:
793 return "00:02";
794 case 0x06:
795 return "00:05";
796 case 0x07:
797 return "00:10";
798 case 0x08:
799 return "00:20";
800 case 0x09:
801 return "00:30";
802 case 0x0a:
803 return "01:00";
804 case 0x0b:
805 return "02:00";
806 case 0x0c:
807 return "05:00";
808 case 0x0d:
809 return "10:00";
810 case 0x0e:
811 return "----";
812 case 0x0f:
813 return "data";
814 default:
815 return "Unknown value";
f5792417
MH		 816 }
817}
818
819/** Process 13-byte info/data message, Metrahit 2x. */
820static void process_msg_inf_13(struct sr_dev_inst *sdi)
821{
822 struct dev_context *devc;
823 enum model model;
824 int cnt;
fc348b77 825 uint8_t dgt;
f5792417
MH		 826
827 devc = sdi->priv;
828
829 clean_ctmv_rs_v(devc);
830
831 /* Byte 0, model. */
873e0c12 832 model = gmc_decode_model_sm(bc(devc->buf[0]));
f5792417
MH		 833 if (model != devc->model) {
834 sr_warn("Model mismatch in data: Detected %s, now %s",
873e0c12 835 gmc_model_str(devc->model), gmc_model_str(model));
f5792417
MH		 836 }
837
838 /* Bytes 1-4, 11. */
839 decode_ctmv_2x(bc(devc->buf[1]) | (bc(devc->buf[11]) << 4), devc);
840 decode_spc_2x(bc(devc->buf[2]) | (bc(devc->buf[3]) << 4), devc);
841 decode_rs_2x(bc(devc->buf[4]), devc);
842
843 /* Bytes 5-10, digits (ls first). */
844 for (cnt = 0; cnt < 6; cnt++) {
845 dgt = bc(devc->buf[5 + cnt]);
846 if (dgt == 10) { /* Overload */
847 devc->value = NAN;
848 devc->scale = 1.0;
849 break;
850 }
851 devc->value += pow(10.0, cnt) * dgt;
852 }
853 sr_spew("process_msg_inf_13() value=%f scale=%f scale1000=%d mq=%d "
854 "unit=%d mqflags=0x%02llx", devc->value, devc->scale,
855 devc->scale1000, devc->mq, devc->unit, devc->mqflags);
856 if (devc->value != NAN)
857 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
858
859 /* Byte 12, Send Interval */
860 sr_spew("Send interval: %s", decode_send_interval(bc(devc->buf[12])));
861
862 /* Create and send packet. */
863 send_value(sdi);
864}
865
c90beca7
MH		 866/** Dump contents of 14-byte message.
867 * @param buf Pointer to array of 14 data bytes.
868 * @param[in] raw Write only data bytes, no interpretation.
869 */
870void dump_msg14(guchar* buf, gboolean raw)
871{
872 if (!buf)
873 return;
874
875 if (raw)
876 sr_spew("msg14: 0x %02x %02x %02x %02x %02x %02x %02x %02x "
877 "%02x %02x %02x %02x %02x %02x",
878 buf[0], buf[1], buf[2], buf[3], buf[4], buf[5], buf[6],
879 buf[7], buf[8], buf[9], buf[10], buf[11], buf[12],
880 buf[13]);
881 else
882 sr_spew("msg14: 0x a=%d c1=%02x c2=%02x cmd=%02x dta=%02x "
883 "%02x %02x %02x %02x %02x %02x %02x %02x chs=%02x",
884 buf[1] == 0x2b?buf[0] >> 2:buf[0] % 0x0f, buf[1], buf[2], buf[3], buf[4], buf[5],
885 buf[6], buf[7], buf[8], buf[9], buf[10], buf[11],
886 buf[12], buf[13]);
887}
888
889/** Calc checksum for 14 byte message type.
890 *
891 * @param[in] dta Pointer to array of 13 data bytes.
892 * @return Checksum.
893 */
894static guchar calc_chksum_14(guchar* dta)
895{
896 guchar cnt, chs;
897
898 for (chs = 0, cnt = 0; cnt < 13; cnt++)
899 chs += dta[cnt];
900
901 return (64 - chs) & MASK_6BITS;
902}
903
904/** Check 14-byte message, Metrahit 2x. */
905static int chk_msg14(struct sr_dev_inst *sdi)
906{
907 struct dev_context *devc;
908 int retc;
909 gboolean isreq; /* Message is request to multimeter (otherwise response) */
910 uint8_t addr; /* Adaptor address */
911
912 retc = SR_OK;
913
914 /* Check parameters and message */
915 if (!sdi || !(devc = sdi->priv))
916 return SR_ERR_ARG;
917
918 if (devc->buflen != 14) {
919 sr_err("process_msg_14(): Msg len 14 expected!");
920 return SR_ERR_ARG;
921 }
922
923 isreq = devc->buf[1] == 0x2b;
924 if (isreq)
925 addr = devc->buf[0] >> 2;
926 else
927 addr = devc->buf[0] & 0x0f;
928
929 if ((devc->addr != addr) && !(isreq && (addr == 0))) {
930 sr_err("process_msg_14(): Address mismatch, msg for other device!");
931 retc = SR_ERR_ARG;
932 }
933
934 if (devc->buf[1] == 0) { /* Error msg from device! */
935 retc = SR_ERR_ARG;
936 switch (devc->buf[2]) {
937 case 1: /* Not used */
938 sr_err("Device: Illegal error code!");
939 break;
940 case 2: /* Incorrect check sum of received block */
941 sr_err("Device: Incorrect checksum in cmd!");
942 break;
943 case 3: /* Incorrect length of received block */
944 sr_err("Device: Incorrect block length in cmd!");
945 break;
946 case 4: /* Incorrect 2nd or 3rd byte */
947 sr_err("Device: Incorrect byte 2 or 3 in cmd!");
948 break;
949 case 5: /* Parameter out of range */
950 sr_err("Device: Parameter out of range!");
951 break;
952 default:
953 sr_err("Device: Unknown error code!");
954 }
955 retc = SR_ERR_ARG;
956 }
957 else if (!isreq && ((devc->buf[1] != 0x27) || (devc->buf[2] != 0x3f))) {
958 sr_err("process_msg_14(): byte 1/2 unexpected!");
959 retc = SR_ERR_ARG;
960 }
961
962 if (calc_chksum_14(devc->buf) != devc->buf[13]) {
963 sr_err("process_msg_14(): Invalid checksum!");
964 retc = SR_ERR_ARG;
965 }
966
967 if (retc != SR_OK)
968 dump_msg14(devc->buf, TRUE);
969
970 return retc;
971}
972
973/** Check 14-byte message, Metrahit 2x. */
974SR_PRIV int process_msg14(struct sr_dev_inst *sdi)
975{
976 struct dev_context *devc;
977 int retc;
978 uint8_t addr;
979 uint8_t cnt, dgt;
980
981 if ((retc = chk_msg14(sdi)) != SR_OK)
982 return retc;
983
984 devc = sdi->priv;
985
986 clean_ctmv_rs_v(devc);
987 addr = devc->buf[0] & MASK_6BITS;
988 if (addr != devc->addr)
989 sr_info("Device address mismatch %d/%d!", addr, devc->addr);
990
991 switch (devc->buf[3]) { /* That's the command this reply is for */
992 /* 0 cannot occur, the respective message is not a 14-byte message */
993 case 1: /* Read first free and occupied address */
994 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
995 break;
996 case 2: /* Clear all RAM in multimeter */
997 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
998 break;
999 case 3: /* Read firmware version and status */
1000 sr_spew("Cmd 3, Read firmware and status", devc->buf[3]);
1001 switch (devc->cmd_idx) {
1002 case 0:
1003 devc->fw_ver_maj = devc->buf[5];
1004 devc->fw_ver_min = devc->buf[4];
1005 sr_spew("Firmware version %d.%d", (int)devc->fw_ver_maj, (int)devc->fw_ver_min);
1006 sr_spew("Rotary Switch Position (1..10): %d", (int)devc->buf[6]);
1007 /** Docs say values 0..9, but that's not true */
1008 sr_spew("Measurement Function: %d ", (int)devc->buf[7]);
1009 decode_ctmv_2x(devc->buf[7], devc);
1010 sr_spew("Range: 0x%x", devc->buf[8]);
1011 decode_rs_2x_TR2(devc->buf[8] & 0x0f, devc); /* Docs wrong, uses conversion table TR_2! */
1012 devc->autorng = (devc->buf[8] & 0x20) == 0;
1013 // TODO 9, 10: 29S special functions
1014 devc->ubatt = 0.1 * (float)devc->buf[11];
1015 devc->model = gmc_decode_model_bd(devc->buf[12]);
1016 sr_spew("Model=%s, battery voltage=%2.1f V", gmc_model_str(devc->model), (double)devc->ubatt);
1017 break;
1018 case 1:
1019 sr_spew("Internal version %d.%d", (int)devc->buf[5], (int)devc->buf[4]);
1020 sr_spew("Comm mode: 0x%x", (int)devc->buf[6]);
1021 sr_spew("Block cnt%%64: %d", (int)devc->buf[7]);
1022 sr_spew("drpCi: %d drpCh: %d", (int)devc->buf[8], (int)devc->buf[9]);
1023 // Semantics undocumented. Possibly Metrahit 29S dropouts stuff?
1024 break;
1025 default:
1026 sr_spew("Cmd 3: Unknown cmd_idx=%d", devc->cmd_idx);
1027 break;
1028 }
1029 break;
1030 case 4: /* Set real time, date, sample rate, trigger, ... */
1031 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1032 break;
1033 case 5: /* Read real time, date, sample rate, trigger... */
1034 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1035 break;
1036 case 6: /* Set modes or power off */
1037 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1038 break;
1039 case 7: /* Set measurement function, range, autom/man. */
1040 sr_spew("Cmd %d unimplemented!", devc->buf[3]);
1041 break;
1042 case 8: /* Get one measurement value */
1043 sr_spew("Cmd 8, get one measurement value");
1044 sr_spew("Measurement Function: %d ", (int)devc->buf[5]);
1045 decode_ctmv_2x(devc->buf[5], devc);
1046 if (!(devc->buf[6] & 0x10)) /* If bit4=0, old data. */
1047 return SR_OK;
1048
1049 decode_rs_2x_TR2(devc->buf[6] & 0x0f, devc); // The docs say conversion table TR_3, but that does not work
1050 setmqf(devc, SR_MQFLAG_AUTORANGE, devc->autorng);
1051 /* 6 digits */
1052 for (cnt = 0; cnt < 6; cnt++) {
1053 dgt = bc(devc->buf[7 + cnt]);
1054 if (dgt == 10) { /* Overload */
1055 devc->value = NAN;
1056 devc->scale = 1.0;
1057 break;
1058 }
1059 else if (dgt == 13) { /* FUSE */
1060 sr_err("FUSE!");
1061 }
1062 else if (dgt == 14) { /* Function recognition mode, OPEN */
1063 sr_info("Function recognition mode, OPEN!");
1064 devc->value = NAN;
1065 devc->scale = 1.0;
1066 break;
1067 }
1068 devc->value += pow(10.0, cnt) * dgt;
1069 }
1070 sr_spew("process_msg14() value=%f scale=%f scale1000=%d mq=%d "
1071 "unit=%d mqflags=0x%02llx", devc->value, devc->scale,
1072 devc->scale1000, devc->mq, devc->unit, devc->mqflags);
1073 if (devc->value != NAN)
1074 devc->value *= devc->scale * pow(1000.0, devc->scale1000);
1075
1076 send_value(sdi);
1077
1078 break;
1079 default:
1080 sr_spew("Unknown cmd %d!", devc->buf[3]);
1081 break;
1082 }
1083
1084 return SR_OK;
1085}
1086
1087/** Data reception callback function. */
7b4edcb6
MH		 1088SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data)
1089{
f5792417 1090 struct sr_dev_inst *sdi;
7b4edcb6 1091 struct dev_context *devc;
f5792417 1092 struct sr_serial_dev_inst *serial;
fc348b77 1093 uint8_t buf, msgt;
f5792417 1094 int len;
fc348b77 1095 gdouble elapsed_s;
7b4edcb6
MH		 1096
1097 (void)fd;
1098
1099 if (!(sdi = cb_data))
1100 return TRUE;
1101
1102 if (!(devc = sdi->priv))
1103 return TRUE;
1104
f5792417
MH		 1105 serial = sdi->conn;
1106
1107 if (revents == G_IO_IN) { /* Serial data arrived. */
1108 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
4a0eda2b 1109 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
f5792417
MH		 1110 if (len < 1)
1111 break;
1112 buf = *(devc->buf + devc->buflen);
1113 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MSGC_MASK);
1114 devc->buflen += len;
1115 if (!devc->settings_ok) {
fc348b77
UH		 1116 /*
1117 * If no device type/settings record processed
1118 * yet, wait for one.
1119 */
f5792417
MH		 1120 if ((devc->buf[0] & MSGID_MASK) != MSGID_INF) {
1121 devc->buflen = 0;
1122 continue;
1123 }
1124 devc->settings_ok = TRUE;
1125 }
1126
1127 msgt = devc->buf[0] & MSGID_MASK;
1128 switch (msgt) {
1129 case MSGID_INF:
1130 if (devc->buflen == 13) {
1131 process_msg_inf_13(sdi);
1132 devc->buflen = 0;
1133 continue;
fc348b77 1134 } else if ((devc->buflen == 10) &&
c90beca7 1135 (devc->model <= METRAHIT_18S)) {
f5792417
MH		 1136 process_msg_inf_10(sdi);
1137 devc->buflen = 0;
1138 continue;
1139 }
1140 else if ((devc->buflen >= 5) &&
c90beca7
MH		 1141 (devc->buf[devc->buflen - 1] &
1142 MSGID_MASK) != MSGID_DATA) {
fc348b77
UH		 1143 /*
1144 * Char just received is beginning
1145 * of next message.
1146 */
f5792417 1147 process_msg_inf_5(sdi);
fc348b77 1148 devc->buf[0] =
c90beca7 1149 devc->buf[devc->buflen - 1];
f5792417
MH		 1150 devc->buflen = 1;
1151 continue;
1152 }
1153 break;
1154 case MSGID_DTA:
1155 case MSGID_D10:
1156 if (devc->buflen == 6) {
1157 process_msg_dta_6(sdi);
1158 devc->buflen = 0;
1159 }
1160 break;
1161 case MSGID_DATA:
1162 sr_err("Comm error, unexpected data byte!");
1163 devc->buflen = 0;
1164 break;
1165 }
1166 }
1167 }
1168
a84f6ad3 1169 /* If number of samples or time limit reached, stop acquisition. */
fc348b77 1170 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples))
f5792417 1171 sdi->driver->dev_acquisition_stop(sdi, cb_data);
f5792417
MH		 1172
1173 if (devc->limit_msec) {
fc348b77
UH		 1174 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
1175 if ((elapsed_s * 1000) >= devc->limit_msec)
f5792417 1176 sdi->driver->dev_acquisition_stop(sdi, cb_data);
7b4edcb6
MH		 1177 }
1178
1179 return TRUE;
1180}
f5792417 1181
c90beca7
MH		 1182SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data)
1183{
1184 struct sr_dev_inst *sdi;
1185 struct dev_context *devc;
1186 struct sr_serial_dev_inst *serial;
1187 uint8_t buf;
1188 int len;
1189 gdouble elapsed_s;
1190
1191 (void)fd;
1192
1193 if (!(sdi = cb_data))
1194 return TRUE;
1195
1196 if (!(devc = sdi->priv))
1197 return TRUE;
1198
1199 serial = sdi->conn;
1200
1201 if (revents == G_IO_IN) { /* Serial data arrived. */
1202 while (GMC_BUFSIZE - devc->buflen - 1 > 0) {
4a0eda2b 1203 len = serial_read_nonblocking(serial, devc->buf + devc->buflen, 1);
c90beca7
MH		 1204 if (len < 1)
1205 break;
1206 buf = *(devc->buf + devc->buflen);
1207 sr_spew("read 0x%02x/%d/%d", buf, buf, buf & MASK_6BITS);
1208 devc->buf[devc->buflen] &= MASK_6BITS;
1209 devc->buflen += len;
1210
1211 if (devc->buflen == 14) {
1212 devc->response_pending = FALSE;
1213 sr_spew("gmc_mh_2x_receive_data processing msg");
1214 process_msg14(sdi);
1215 devc->buflen = 0;
1216 }
1217 }
1218 }
1219
a84f6ad3 1220 /* If number of samples or time limit reached, stop acquisition. */
c90beca7
MH		 1221 if (devc->limit_samples && (devc->num_samples >= devc->limit_samples))
1222 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1223
1224 if (devc->limit_msec) {
1225 elapsed_s = g_timer_elapsed(devc->elapsed_msec, NULL);
1226 if ((elapsed_s * 1000) >= devc->limit_msec)
1227 sdi->driver->dev_acquisition_stop(sdi, cb_data);
1228 }
1229
1230 /* Request next data set, if required */
1231 if (sdi->status == SR_ST_ACTIVE) {
1232 if (devc->response_pending) {
1233 gint64 elapsed_us = g_get_monotonic_time() - devc->req_sent_at;
1234 if (elapsed_us > 1*1000*1000) /* Timeout! */
1235 devc->response_pending = FALSE;
1236 }
1237 if (!devc->response_pending) {
1238 devc->cmd_seq++;
1239 if (devc->cmd_seq % 10 == 0) {
1240 if (req_stat14(sdi, FALSE) != SR_OK)
1241 return FALSE;
1242 }
1243 else if (req_meas14(sdi) != SR_OK)
1244 return FALSE;
1245 }
1246 }
1247
1248 return TRUE;
1249}
1250
1251/** Create 14 (42) byte command for Metrahit 2x multimeter in bidir mode.
1252 *
1253 * Actually creates 42 bytes due to the encoding method used.
1254 * @param[in] addr Device address (0=adapter, 1..15 multimeter; for byte 0).
1255 * @param[in] func Function code (byte 3).
1256 * @param[in] params Further parameters (9 bytes)
1257 * @param[out] buf Buffer to create msg in (42 bytes).
1258 */
1259void create_cmd_14(guchar addr, guchar func, guchar* params, guchar* buf)
1260{
1261 uint8_t dta[14]; /* Unencoded message */
1262 int cnt;
1263
1264 if (!params || !buf)
1265 return;
1266
1267 /* 0: Address */
1268 dta[0] = ((addr << 2) | 0x03) & MASK_6BITS;
1269
1270 /* 1-3: Set command header */
1271 dta[1] = 0x2b;
1272 dta[2] = 0x3f;
1273 dta[3] = func;
1274
1275 /* 4-12: Copy further parameters */
1276 for (cnt = 0; cnt < 9; cnt++)
1277 dta[cnt+4] = (params[cnt] & MASK_6BITS);
1278
1279 /* 13: Checksum (b complement) */
1280 dta[13] = calc_chksum_14(dta);
1281
1282 /* The whole message is packed into 3 bytes per byte now (lower 6 bits only) the most
1283 * peculiar way I have ever seen. Possibly to improve IR communication? */
1284 for (cnt = 0; cnt < 14; cnt++) {
1285 buf[3*cnt] = (dta[cnt] & 0x01 ? 0x0f : 0) | (dta[cnt] & 0x02 ? 0xf0 : 0);
1286 buf[3*cnt + 1] = (dta[cnt] & 0x04 ? 0x0f : 0) | (dta[cnt] & 0x08 ? 0xf0 : 0);
1287 buf[3*cnt + 2] = (dta[cnt] & 0x10 ? 0x0f : 0) | (dta[cnt] & 0x20 ? 0xf0 : 0);
1288 }
1289}
1290
1291/** Request one measurement from 2x multimeter (msg 8).
1292 *
1293 */
1294int req_meas14(const struct sr_dev_inst *sdi)
1295{
1296 struct dev_context *devc;
1297 struct sr_serial_dev_inst *serial;
1298 uint8_t params[9];
1299 uint8_t msg[42];
1300
1301 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1302 return SR_ERR;
1303
1304 memset(params, 0, sizeof(params));
1305 params[0] = 0;
1306 devc->cmd_idx = 0;
1307 create_cmd_14(devc->addr, 8, params, msg);
1308 devc->req_sent_at = g_get_monotonic_time();
eead2782 1309 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < (int)sizeof(msg)) {
c90beca7
MH		 1310 return SR_ERR;
1311 }
1312
1313 devc->response_pending = TRUE;
1314
1315 return SR_OK;
1316}
1317
1318/** Request status from 2x multimeter (msg 3).
1319 * @param[in] power_on Try to power on powered off multimeter by sending additional messages.
1320 */
1321int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on)
1322{
1323 struct dev_context *devc;
1324 struct sr_serial_dev_inst *serial;
1325 uint8_t params[9];
1326 uint8_t msg[42];
1327
1328 if (!sdi || !(devc = sdi->priv) || !(serial = sdi->conn))
1329 return SR_ERR;
1330
1331 memset(params, 0, sizeof(params));
1332 params[0] = 0;
1333 devc->cmd_idx = 0;
1334 create_cmd_14(devc->addr, 3, params, msg);
1335
1336 if (power_on) {
1337 sr_info("Write some data and wait 3s to turn on powered off device...");
eead2782 1338 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
c90beca7 1339 return SR_ERR;
fadd0707 1340 g_usleep(1*1000*1000);
eead2782 1341 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
fadd0707
MH		 1342 return SR_ERR;
1343 g_usleep(1*1000*1000);
eead2782 1344 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < 0)
fadd0707
MH		 1345 return SR_ERR;
1346 g_usleep(1*1000*1000);
c90beca7
MH		 1347 serial_flush(serial);
1348 }
1349
1350 /* Write message and wait for reply */
1351 devc->req_sent_at = g_get_monotonic_time();
eead2782 1352 if (serial_write_blocking(serial, msg, sizeof(msg), 0) < (int)sizeof(msg)) {
c90beca7
MH		 1353 return SR_ERR;
1354 }
1355
1356 devc->response_pending = TRUE;
1357
1358 return SR_OK;
1359}
1360
1361/** Decode model in "send mode".
1362 *
1363 * @param[in] mcode Model code.
1364 * @return Model code.
1365 */
873e0c12 1366SR_PRIV int gmc_decode_model_sm(uint8_t mcode)
f5792417
MH		 1367{
1368 if (mcode > 0xf) {
1369 sr_err("decode_model(%d): Model code 0..15 expected!", mcode);
873e0c12 1370 return METRAHIT_NONE;
f5792417
MH		 1371 }
1372
0c5f2abc 1373 switch (mcode) {
fc348b77 1374 case 0x04: /* 0100b */
873e0c12 1375 return METRAHIT_12S;
fc348b77 1376 case 0x08: /* 1000b */
873e0c12 1377 return METRAHIT_13S14A;
fc348b77 1378 case 0x09: /* 1001b */
873e0c12 1379 return METRAHIT_14S;
fc348b77 1380 case 0x0A: /* 1010b */
873e0c12 1381 return METRAHIT_15S;
fc348b77 1382 case 0x0B: /* 1011b */
873e0c12 1383 return METRAHIT_16S;
fc348b77 1384 case 0x06: /* 0110b (undocumented by GMC!) */
873e0c12 1385 return METRAHIT_16I;
2c1a012e
MH		 1386 case 0x07: /* 0111b (undocumented by GMC!) */
1387 return METRAHIT_16T;
fc348b77 1388 case 0x0D: /* 1101b */
873e0c12 1389 return METRAHIT_18S;
fc348b77 1390 case 0x02: /* 0010b */
873e0c12 1391 return METRAHIT_22SM;
fc348b77 1392 case 0x03: /* 0011b */
873e0c12 1393 return METRAHIT_23S;
2c1a012e 1394 case 0x0F: /* 1111b */
873e0c12 1395 return METRAHIT_24S;
fc348b77 1396 case 0x05: /* 0101b */
c90beca7 1397 return METRAHIT_25S;
fc348b77 1398 case 0x01: /* 0001b */
c90beca7 1399 return METRAHIT_26SM;
2c1a012e 1400 case 0x0C: /* 1100b */
873e0c12 1401 return METRAHIT_28S;
2c1a012e 1402 case 0x0E: /* 1110b */
873e0c12 1403 return METRAHIT_29S;
f5792417
MH		 1404 default:
1405 sr_err("Unknown model code %d!", mcode);
873e0c12 1406 return METRAHIT_NONE;
f5792417
MH		 1407 }
1408}
1409
6392d599 1410/** Convert GMC model code in bidirectional mode to sigrok-internal one.
fc348b77 1411 *
6392d599 1412 * @param[in] mcode Model code.
fc348b77 1413 *
6392d599 1414 * @return Model code.
fc348b77 1415 */
6392d599 1416SR_PRIV int gmc_decode_model_bd(uint8_t mcode)
f5792417 1417{
6392d599 1418 switch (mcode & 0x1f) {
fc348b77 1419 case 2:
c90beca7
MH		 1420 if (mcode & 0x20)
1421 return METRAHIT_22M;
1422 else
1423 return METRAHIT_22S;
fc348b77 1424 case 3:
873e0c12 1425 return METRAHIT_23S;
fc348b77 1426 case 4:
873e0c12 1427 return METRAHIT_24S;
fc348b77 1428 case 5:
6392d599 1429 return METRAHIT_25S;
fc348b77 1430 case 1:
c90beca7
MH		 1431 if (mcode & 0x20)
1432 return METRAHIT_26M;
1433 else
1434 return METRAHIT_26S;
fc348b77 1435 case 12:
873e0c12 1436 return METRAHIT_28S;
fc348b77 1437 case 14:
873e0c12 1438 return METRAHIT_29S;
f5792417
MH		 1439 default:
1440 sr_err("Unknown model code %d!", mcode);
873e0c12 1441 return METRAHIT_NONE;
f5792417
MH		 1442 }
1443}
1444
6392d599
MH		 1445/** Convert sigrok-internal model code to string.
1446 *
1447 * @param[in] mcode Model code.
1448 *
1449 * @return Model code string.
1450 */
873e0c12 1451SR_PRIV const char *gmc_model_str(enum model mcode)
f5792417
MH		 1452{
1453 switch (mcode) {
873e0c12 1454 case METRAHIT_NONE:
f5792417 1455 return "-uninitialized model variable-";
873e0c12 1456 case METRAHIT_12S:
f5792417 1457 return "METRAHit 12S";
873e0c12 1458 case METRAHIT_13S14A:
f5792417 1459 return "METRAHit 13S/14A";
873e0c12 1460 case METRAHIT_14S:
f5792417 1461 return "METRAHit 14S";
873e0c12 1462 case METRAHIT_15S:
f5792417 1463 return "METRAHit 15S";
873e0c12 1464 case METRAHIT_16S:
f5792417 1465 return "METRAHit 16S";
873e0c12 1466 case METRAHIT_16I:
2c1a012e
MH		 1467 return "METRAHit 16I/16L";
1468 case METRAHIT_16T:
1469 return "METRAHit 16T/16U/KMM2002";
873e0c12 1470 case METRAHIT_18S:
f5792417 1471 return "METRAHit 18S";
873e0c12 1472 case METRAHIT_22SM:
f5792417 1473 return "METRAHit 22S/M";
c90beca7
MH		 1474 case METRAHIT_22S:
1475 return "METRAHit 22S";
1476 case METRAHIT_22M:
1477 return "METRAHit 22M";
873e0c12 1478 case METRAHIT_23S:
f5792417 1479 return "METRAHit 23S";
873e0c12 1480 case METRAHIT_24S:
f5792417 1481 return "METRAHit 24S";
6392d599
MH		 1482 case METRAHIT_25S:
1483 return "METRAHit 25S";
1484 case METRAHIT_26SM:
1485 return "METRAHit 26S/M";
c90beca7
MH		 1486 case METRAHIT_26S:
1487 return "METRAHit 26S";
1488 case METRAHIT_26M:
1489 return "METRAHit 26M";
873e0c12 1490 case METRAHIT_28S:
f5792417 1491 return "METRAHit 28S";
873e0c12 1492 case METRAHIT_29S:
f5792417
MH		 1493 return "METRAHit 29S";
1494 default:
1495 return "Unknown model code";
1496 }
1497}
c90beca7 1498
dcd438ee 1499/** @copydoc sr_dev_driver.config_set */
584560f1
BV		 1500SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
1501 const struct sr_channel_group *cg)
c90beca7
MH		 1502{
1503 struct dev_context *devc;
1504 uint8_t params[9];
1505 uint8_t msg[42];
1506
53b4680f 1507 (void)cg;
c90beca7
MH		 1508
1509 if (sdi->status != SR_ST_ACTIVE)
1510 return SR_ERR_DEV_CLOSED;
1511
1512 if (!(devc = sdi->priv)) {
1513 sr_err("sdi->priv was NULL.");
1514 return SR_ERR_BUG;
1515 }
1516
1517 switch (key) {
1518 case SR_CONF_POWER_OFF:
1519 if (devc->model < METRAHIT_2X)
1520 return SR_ERR_NA;
1521 if (!g_variant_get_boolean(data))
1522 return SR_ERR;
1523 sr_info("Powering device off.");
1524
1525 memset(params, 0, sizeof(params));
1526 params[0] = 5;
1527 params[1] = 5;
1528 create_cmd_14(devc->addr, 6, params, msg);
eead2782 1529 if (serial_write_blocking(sdi->conn, msg, sizeof(msg), 0) < 0)
c90beca7
MH		 1530 return SR_ERR;
1531 else
1532 g_usleep(2000000); /* Wait to ensure transfer before interface switched off. */
1533 break;
1534 case SR_CONF_LIMIT_MSEC:
c90beca7 1535 devc->limit_msec = g_variant_get_uint64(data);
c90beca7
MH		 1536 break;
1537 case SR_CONF_LIMIT_SAMPLES:
1538 devc->limit_samples = g_variant_get_uint64(data);
c90beca7
MH		 1539 break;
1540 default:
1541 return SR_ERR_NA;
1542 }
1543
1544 return SR_OK;
1545}
Hardware access and backend lib