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