]> sigrok.org Git - libsigrok.git/blob - hardware/serial-dmm/api.c
added Voltcraft M-3650D Multimeter
[libsigrok.git] / hardware / serial-dmm / api.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5  * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
6  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <fcntl.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <glib.h>
28 #include "libsigrok.h"
29 #include "libsigrok-internal.h"
30 #include "protocol.h"
31
32 static const int32_t hwopts[] = {
33         SR_CONF_CONN,
34         SR_CONF_SERIALCOMM,
35 };
36
37 static const int32_t hwcaps[] = {
38         SR_CONF_MULTIMETER,
39         SR_CONF_LIMIT_SAMPLES,
40         SR_CONF_LIMIT_MSEC,
41         SR_CONF_CONTINUOUS,
42 };
43
44 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
45 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
46 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
47 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
48 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
49 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
50 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
51 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
52 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
53 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
54 SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
55 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
56 SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
57 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
58 SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
59 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
60 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
61 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
62 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
63
64 SR_PRIV struct dmm_info dmms[] = {
65         {
66                 "Digitek", "DT4000ZC", "2400/8n1", 2400,
67                 FS9721_PACKET_SIZE, NULL,
68                 sr_fs9721_packet_valid, sr_fs9721_parse,
69                 sr_fs9721_10_temp_c,
70                 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
71         },
72         {
73                 "TekPower", "TP4000ZC", "2400/8n1", 2400,
74                 FS9721_PACKET_SIZE, NULL,
75                 sr_fs9721_packet_valid, sr_fs9721_parse,
76                 sr_fs9721_10_temp_c,
77                 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
78         },
79         {
80                 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
81                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
82                 sr_metex14_packet_valid, sr_metex14_parse,
83                 NULL,
84                 &metex_me31_driver_info, receive_data_METEX_ME31,
85         },
86         {
87                 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
88                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
89                 sr_metex14_packet_valid, sr_metex14_parse,
90                 NULL,
91                 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
92         },
93         {
94                 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
95                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
96                 sr_metex14_packet_valid, sr_metex14_parse,
97                 NULL,
98                 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
99         },
100         {
101                 "V&A", "VA18B", "2400/8n1", 2400,
102                 FS9721_PACKET_SIZE, NULL,
103                 sr_fs9721_packet_valid, sr_fs9721_parse,
104                 sr_fs9721_01_temp_c,
105                 &va_va18b_driver_info, receive_data_VA_VA18B,
106         },
107         {
108                 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
109                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
110                 sr_metex14_packet_valid, sr_metex14_parse,
111                 NULL,
112                 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
113         },
114         {
115                 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
116                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
117                 sr_metex14_packet_valid, sr_metex14_parse,
118                 NULL,
119                 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
120         },
121         {
122                 "PCE", "PCE-DM32", "2400/8n1", 2400,
123                 FS9721_PACKET_SIZE, NULL,
124                 sr_fs9721_packet_valid, sr_fs9721_parse,
125                 sr_fs9721_01_10_temp_f_c,
126                 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
127         },
128         {
129                 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
130                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
131                 sr_metex14_packet_valid, sr_metex14_parse,
132                 NULL,
133                 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
134         },
135         {
136                 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
137                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
138                 sr_metex14_packet_valid, sr_metex14_parse,
139                 NULL,
140                 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
141         },
142         {
143                 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
144                 RS9LCD_PACKET_SIZE, NULL,
145                 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
146                 NULL,
147                 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
148         },
149         {
150                 "Tecpel", "DMM-8060 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
151                 2400, FS9721_PACKET_SIZE, NULL,
152                 sr_fs9721_packet_valid, sr_fs9721_parse,
153                 NULL,
154                 &tecpel_dmm_8060_ser_driver_info,
155                 receive_data_TECPEL_DMM_8060_SER,
156         },
157         {
158                 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
159                 2400, FS9721_PACKET_SIZE, NULL,
160                 sr_fs9721_packet_valid, sr_fs9721_parse,
161                 sr_fs9721_00_temp_c,
162                 &tecpel_dmm_8061_ser_driver_info,
163                 receive_data_TECPEL_DMM_8061_SER,
164         },
165         {
166                 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
167                 METEX14_PACKET_SIZE, sr_metex14_packet_request,
168                 sr_metex14_packet_valid, sr_metex14_parse,
169                 NULL,
170                 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
171         },
172         {
173                 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
174                 2400, FS9721_PACKET_SIZE, NULL,
175                 sr_fs9721_packet_valid, sr_fs9721_parse,
176                 NULL,
177                 &voltcraft_vc820_ser_driver_info,
178                 receive_data_VOLTCRAFT_VC820_SER,
179         },
180         {
181                 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
182                 2400, FS9721_PACKET_SIZE, NULL,
183                 sr_fs9721_packet_valid, sr_fs9721_parse,
184                 sr_fs9721_00_temp_c,
185                 &voltcraft_vc840_ser_driver_info,
186                 receive_data_VOLTCRAFT_VC840_SER,
187         },
188         {
189                 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
190                 2400, FS9922_PACKET_SIZE, NULL,
191                 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
192                 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
193         },
194         {
195                 /* Note: ES51922 baudrate is actually 19230! */
196                 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
197                 19200, ES51922_PACKET_SIZE, NULL,
198                 sr_es51922_packet_valid, sr_es51922_parse, NULL,
199                 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
200         },
201 };
202
203 static int dev_clear(int dmm)
204 {
205         return std_dev_clear(dmms[dmm].di, NULL);
206 }
207
208 static int init(struct sr_context *sr_ctx, int dmm)
209 {
210         sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
211
212         return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
213 }
214
215 static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
216 {
217         struct sr_dev_inst *sdi;
218         struct drv_context *drvc;
219         struct dev_context *devc;
220         struct sr_probe *probe;
221         struct sr_serial_dev_inst *serial;
222         GSList *devices;
223         int dropped, ret;
224         size_t len;
225         uint8_t buf[128];
226
227         if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
228                 return NULL;
229
230         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
231                 return NULL;
232
233         sr_info("Probing serial port %s.", conn);
234
235         drvc = dmms[dmm].di->priv;
236         devices = NULL;
237         serial_flush(serial);
238
239         /* Request a packet if the DMM requires this. */
240         if (dmms[dmm].packet_request) {
241                 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
242                         sr_err("Failed to request packet: %d.", ret);
243                         return FALSE;
244                 }
245         }
246
247         /*
248          * There's no way to get an ID from the multimeter. It just sends data
249          * periodically (or upon request), so the best we can do is check if
250          * the packets match the expected format.
251          */
252
253         /* Let's get a bit of data and see if we can find a packet. */
254         len = sizeof(buf);
255         ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
256                                    dmms[dmm].packet_valid, 1000,
257                                    dmms[dmm].baudrate);
258         if (ret != SR_OK)
259                 goto scan_cleanup;
260
261         /*
262          * If we dropped more than two packets worth of data, something is
263          * wrong. We shouldn't quit however, since the dropped bytes might be
264          * just zeroes at the beginning of the stream. Those can occur as a
265          * combination of the nonstandard cable that ships with some devices
266          * and the serial port or USB to serial adapter.
267          */
268         dropped = len - dmms[dmm].packet_size;
269         if (dropped > 2 * dmms[dmm].packet_size)
270                 sr_warn("Had to drop too much data.");
271
272         sr_info("Found device on port %s.", conn);
273
274         if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
275                                     dmms[dmm].device, "")))
276                 goto scan_cleanup;
277
278         if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
279                 sr_err("Device context malloc failed.");
280                 goto scan_cleanup;
281         }
282
283         sdi->inst_type = SR_INST_SERIAL;
284         sdi->conn = serial;
285
286         sdi->priv = devc;
287         sdi->driver = dmms[dmm].di;
288         if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
289                 goto scan_cleanup;
290         sdi->probes = g_slist_append(sdi->probes, probe);
291         drvc->instances = g_slist_append(drvc->instances, sdi);
292         devices = g_slist_append(devices, sdi);
293
294 scan_cleanup:
295         serial_close(serial);
296
297         return devices;
298 }
299
300 static GSList *scan(GSList *options, int dmm)
301 {
302         struct sr_config *src;
303         GSList *l, *devices;
304         const char *conn, *serialcomm;
305
306         conn = serialcomm = NULL;
307         for (l = options; l; l = l->next) {
308                 src = l->data;
309                 switch (src->key) {
310                 case SR_CONF_CONN:
311                         conn = g_variant_get_string(src->data, NULL);
312                         break;
313                 case SR_CONF_SERIALCOMM:
314                         serialcomm = g_variant_get_string(src->data, NULL);
315                         break;
316                 }
317         }
318         if (!conn)
319                 return NULL;
320
321         if (serialcomm) {
322                 /* Use the provided comm specs. */
323                 devices = sdmm_scan(conn, serialcomm, dmm);
324         } else {
325                 /* Try the default. */
326                 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
327         }
328
329         return devices;
330 }
331
332 static GSList *dev_list(int dmm)
333 {
334         return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
335 }
336
337 static int dev_open(struct sr_dev_inst *sdi)
338 {
339         struct sr_serial_dev_inst *serial;
340
341         serial = sdi->conn;
342         if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
343                 return SR_ERR;
344
345         sdi->status = SR_ST_ACTIVE;
346
347         return SR_OK;
348 }
349
350 static int dev_close(struct sr_dev_inst *sdi)
351 {
352         struct sr_serial_dev_inst *serial;
353
354         serial = sdi->conn;
355         if (serial && serial->fd != -1) {
356                 serial_close(serial);
357                 sdi->status = SR_ST_INACTIVE;
358         }
359
360         return SR_OK;
361 }
362
363 static int cleanup(int dmm)
364 {
365         return dev_clear(dmm);
366 }
367
368 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
369 {
370         struct dev_context *devc;
371
372         if (sdi->status != SR_ST_ACTIVE)
373                 return SR_ERR_DEV_CLOSED;
374
375         if (!(devc = sdi->priv)) {
376                 sr_err("sdi->priv was NULL.");
377                 return SR_ERR_BUG;
378         }
379
380         switch (id) {
381         case SR_CONF_LIMIT_SAMPLES:
382                 devc->limit_samples = g_variant_get_uint64(data);
383                 sr_dbg("Setting sample limit to %" PRIu64 ".",
384                        devc->limit_samples);
385                 break;
386         case SR_CONF_LIMIT_MSEC:
387                 devc->limit_msec = g_variant_get_uint64(data);
388                 sr_dbg("Setting time limit to %" PRIu64 "ms.",
389                        devc->limit_msec);
390                 break;
391         default:
392                 return SR_ERR_NA;
393         }
394
395         return SR_OK;
396 }
397
398 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
399 {
400
401         (void)sdi;
402
403         switch (key) {
404         case SR_CONF_SCAN_OPTIONS:
405                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
406                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
407                 break;
408         case SR_CONF_DEVICE_OPTIONS:
409                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
410                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
411                 break;
412         default:
413                 return SR_ERR_NA;
414         }
415
416         return SR_OK;
417 }
418
419 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
420                                     void *cb_data, int dmm)
421 {
422         struct dev_context *devc;
423         struct sr_serial_dev_inst *serial;
424
425         if (sdi->status != SR_ST_ACTIVE)
426                 return SR_ERR_DEV_CLOSED;
427
428         if (!(devc = sdi->priv)) {
429                 sr_err("sdi->priv was NULL.");
430                 return SR_ERR_BUG;
431         }
432
433         devc->cb_data = cb_data;
434
435         /*
436          * Reset the number of samples to take. If we've already collected our
437          * quota, but we start a new session, and don't reset this, we'll just
438          * quit without acquiring any new samples.
439          */
440         devc->num_samples = 0;
441         devc->starttime = g_get_monotonic_time();
442
443         /* Send header packet to the session bus. */
444         std_session_send_df_header(cb_data, LOG_PREFIX);
445
446         /* Poll every 50ms, or whenever some data comes in. */
447         serial = sdi->conn;
448         sr_source_add(serial->fd, G_IO_IN, 50,
449                       dmms[dmm].receive_data, (void *)sdi);
450
451         return SR_OK;
452 }
453
454 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
455 {
456         return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
457                                                sdi->conn, LOG_PREFIX);
458 }
459
460 /* Driver-specific API function wrappers */
461 #define HW_INIT(X) \
462 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
463 #define HW_CLEANUP(X) \
464 static int cleanup_##X(void) { return cleanup(X); }
465 #define HW_SCAN(X) \
466 static GSList *scan_##X(GSList *options) { return scan(options, X); }
467 #define HW_DEV_LIST(X) \
468 static GSList *dev_list_##X(void) { return dev_list(X); }
469 #define HW_DEV_CLEAR(X) \
470 static int dev_clear_##X(void) { return dev_clear(X); }
471 #define HW_DEV_ACQUISITION_START(X) \
472 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
473 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
474
475 /* Driver structs and API function wrappers */
476 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
477 HW_INIT(ID_UPPER) \
478 HW_CLEANUP(ID_UPPER) \
479 HW_SCAN(ID_UPPER) \
480 HW_DEV_LIST(ID_UPPER) \
481 HW_DEV_CLEAR(ID_UPPER) \
482 HW_DEV_ACQUISITION_START(ID_UPPER) \
483 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
484         .name = NAME, \
485         .longname = LONGNAME, \
486         .api_version = 1, \
487         .init = init_##ID_UPPER, \
488         .cleanup = cleanup_##ID_UPPER, \
489         .scan = scan_##ID_UPPER, \
490         .dev_list = dev_list_##ID_UPPER, \
491         .dev_clear = dev_clear_##ID_UPPER, \
492         .config_get = NULL, \
493         .config_set = config_set, \
494         .config_list = config_list, \
495         .dev_open = dev_open, \
496         .dev_close = dev_close, \
497         .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
498         .dev_acquisition_stop = dev_acquisition_stop, \
499         .priv = NULL, \
500 };
501
502 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
503 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
504 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
505 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
506 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
507 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
508 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
509 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
510 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
511 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
512 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
513 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
514 DRV(tecpel_dmm_8060_ser, TECPEL_DMM_8060_SER, "tecpel-dmm-8060-ser", "Tecpel DMM-8060 (UT-D02 cable)")
515 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
516 DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
517 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
518 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
519 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
520 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")