2 * This file is part of the libsigrok project.
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>
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.
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.
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/>.
22 #include <sys/types.h>
28 #include "libsigrok.h"
29 #include "libsigrok-internal.h"
32 static const int32_t hwopts[] = {
37 static const int32_t hwcaps[] = {
39 SR_CONF_LIMIT_SAMPLES,
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_vc830_ser_driver_info;
61 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
62 SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
63 SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
64 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
65 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
67 SR_PRIV struct dmm_info dmms[] = {
69 "Digitek", "DT4000ZC", "2400/8n1", 2400,
70 FS9721_PACKET_SIZE, NULL,
71 sr_fs9721_packet_valid, sr_fs9721_parse,
73 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
76 "TekPower", "TP4000ZC", "2400/8n1", 2400,
77 FS9721_PACKET_SIZE, NULL,
78 sr_fs9721_packet_valid, sr_fs9721_parse,
80 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
83 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
84 METEX14_PACKET_SIZE, sr_metex14_packet_request,
85 sr_metex14_packet_valid, sr_metex14_parse,
87 &metex_me31_driver_info, receive_data_METEX_ME31,
90 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
91 METEX14_PACKET_SIZE, sr_metex14_packet_request,
92 sr_metex14_packet_valid, sr_metex14_parse,
94 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
97 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
98 METEX14_PACKET_SIZE, sr_metex14_packet_request,
99 sr_metex14_packet_valid, sr_metex14_parse,
101 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
104 "V&A", "VA18B", "2400/8n1", 2400,
105 FS9721_PACKET_SIZE, NULL,
106 sr_fs9721_packet_valid, sr_fs9721_parse,
108 &va_va18b_driver_info, receive_data_VA_VA18B,
111 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
112 METEX14_PACKET_SIZE, sr_metex14_packet_request,
113 sr_metex14_packet_valid, sr_metex14_parse,
115 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
118 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
119 METEX14_PACKET_SIZE, sr_metex14_packet_request,
120 sr_metex14_packet_valid, sr_metex14_parse,
122 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
125 "PCE", "PCE-DM32", "2400/8n1", 2400,
126 FS9721_PACKET_SIZE, NULL,
127 sr_fs9721_packet_valid, sr_fs9721_parse,
128 sr_fs9721_01_10_temp_f_c,
129 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
132 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
133 METEX14_PACKET_SIZE, sr_metex14_packet_request,
134 sr_metex14_packet_valid, sr_metex14_parse,
136 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
139 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
140 METEX14_PACKET_SIZE, sr_metex14_packet_request,
141 sr_metex14_packet_valid, sr_metex14_parse,
143 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
146 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
147 RS9LCD_PACKET_SIZE, NULL,
148 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
150 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
153 "Tecpel", "DMM-8060 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
154 2400, FS9721_PACKET_SIZE, NULL,
155 sr_fs9721_packet_valid, sr_fs9721_parse,
157 &tecpel_dmm_8060_ser_driver_info,
158 receive_data_TECPEL_DMM_8060_SER,
161 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
162 2400, FS9721_PACKET_SIZE, NULL,
163 sr_fs9721_packet_valid, sr_fs9721_parse,
165 &tecpel_dmm_8061_ser_driver_info,
166 receive_data_TECPEL_DMM_8061_SER,
169 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
170 METEX14_PACKET_SIZE, sr_metex14_packet_request,
171 sr_metex14_packet_valid, sr_metex14_parse,
173 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
176 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
177 2400, FS9721_PACKET_SIZE, NULL,
178 sr_fs9721_packet_valid, sr_fs9721_parse,
180 &voltcraft_vc820_ser_driver_info,
181 receive_data_VOLTCRAFT_VC820_SER,
184 "Voltcraft", "VC-830 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
185 2400, FS9922_PACKET_SIZE, NULL,
186 sr_fs9922_packet_valid, sr_fs9922_parse,
188 &voltcraft_vc830_ser_driver_info,
189 receive_data_VOLTCRAFT_VC830_SER,
192 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
193 2400, FS9721_PACKET_SIZE, NULL,
194 sr_fs9721_packet_valid, sr_fs9721_parse,
196 &voltcraft_vc840_ser_driver_info,
197 receive_data_VOLTCRAFT_VC840_SER,
200 "UNI-T", "UT60A (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
201 2400, FS9721_PACKET_SIZE, NULL,
202 sr_fs9721_packet_valid, sr_fs9721_parse,
204 &uni_t_ut60a_ser_driver_info,
205 receive_data_UNI_T_UT60A_SER,
208 "UNI-T", "UT60E (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
209 2400, FS9721_PACKET_SIZE, NULL,
210 sr_fs9721_packet_valid, sr_fs9721_parse,
212 &uni_t_ut60e_ser_driver_info,
213 receive_data_UNI_T_UT60E_SER,
216 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
217 2400, FS9922_PACKET_SIZE, NULL,
218 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
219 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
222 /* Note: ES51922 baudrate is actually 19230! */
223 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
224 19200, ES51922_PACKET_SIZE, NULL,
225 sr_es51922_packet_valid, sr_es51922_parse, NULL,
226 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
230 static int dev_clear(int dmm)
232 return std_dev_clear(dmms[dmm].di, NULL);
235 static int init(struct sr_context *sr_ctx, int dmm)
237 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
239 return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
242 static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
244 struct sr_dev_inst *sdi;
245 struct drv_context *drvc;
246 struct dev_context *devc;
247 struct sr_probe *probe;
248 struct sr_serial_dev_inst *serial;
254 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
257 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
260 sr_info("Probing serial port %s.", conn);
262 drvc = dmms[dmm].di->priv;
264 serial_flush(serial);
266 /* Request a packet if the DMM requires this. */
267 if (dmms[dmm].packet_request) {
268 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
269 sr_err("Failed to request packet: %d.", ret);
275 * There's no way to get an ID from the multimeter. It just sends data
276 * periodically (or upon request), so the best we can do is check if
277 * the packets match the expected format.
280 /* Let's get a bit of data and see if we can find a packet. */
282 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
283 dmms[dmm].packet_valid, 1000,
289 * If we dropped more than two packets worth of data, something is
290 * wrong. We shouldn't quit however, since the dropped bytes might be
291 * just zeroes at the beginning of the stream. Those can occur as a
292 * combination of the nonstandard cable that ships with some devices
293 * and the serial port or USB to serial adapter.
295 dropped = len - dmms[dmm].packet_size;
296 if (dropped > 2 * dmms[dmm].packet_size)
297 sr_warn("Had to drop too much data.");
299 sr_info("Found device on port %s.", conn);
301 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
302 dmms[dmm].device, "")))
305 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
306 sr_err("Device context malloc failed.");
310 sdi->inst_type = SR_INST_SERIAL;
314 sdi->driver = dmms[dmm].di;
315 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
317 sdi->probes = g_slist_append(sdi->probes, probe);
318 drvc->instances = g_slist_append(drvc->instances, sdi);
319 devices = g_slist_append(devices, sdi);
322 serial_close(serial);
327 static GSList *scan(GSList *options, int dmm)
329 struct sr_config *src;
331 const char *conn, *serialcomm;
333 conn = serialcomm = NULL;
334 for (l = options; l; l = l->next) {
338 conn = g_variant_get_string(src->data, NULL);
340 case SR_CONF_SERIALCOMM:
341 serialcomm = g_variant_get_string(src->data, NULL);
349 /* Use the provided comm specs. */
350 devices = sdmm_scan(conn, serialcomm, dmm);
352 /* Try the default. */
353 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
359 static GSList *dev_list(int dmm)
361 return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
364 static int dev_open(struct sr_dev_inst *sdi)
366 struct sr_serial_dev_inst *serial;
369 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
372 sdi->status = SR_ST_ACTIVE;
377 static int dev_close(struct sr_dev_inst *sdi)
379 struct sr_serial_dev_inst *serial;
382 if (serial && serial->fd != -1) {
383 serial_close(serial);
384 sdi->status = SR_ST_INACTIVE;
390 static int cleanup(int dmm)
392 return dev_clear(dmm);
395 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
397 struct dev_context *devc;
399 if (sdi->status != SR_ST_ACTIVE)
400 return SR_ERR_DEV_CLOSED;
402 if (!(devc = sdi->priv)) {
403 sr_err("sdi->priv was NULL.");
408 case SR_CONF_LIMIT_SAMPLES:
409 devc->limit_samples = g_variant_get_uint64(data);
410 sr_dbg("Setting sample limit to %" PRIu64 ".",
411 devc->limit_samples);
413 case SR_CONF_LIMIT_MSEC:
414 devc->limit_msec = g_variant_get_uint64(data);
415 sr_dbg("Setting time limit to %" PRIu64 "ms.",
425 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
431 case SR_CONF_SCAN_OPTIONS:
432 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
433 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
435 case SR_CONF_DEVICE_OPTIONS:
436 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
437 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
446 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
447 void *cb_data, int dmm)
449 struct dev_context *devc;
450 struct sr_serial_dev_inst *serial;
452 if (sdi->status != SR_ST_ACTIVE)
453 return SR_ERR_DEV_CLOSED;
455 if (!(devc = sdi->priv)) {
456 sr_err("sdi->priv was NULL.");
460 devc->cb_data = cb_data;
463 * Reset the number of samples to take. If we've already collected our
464 * quota, but we start a new session, and don't reset this, we'll just
465 * quit without acquiring any new samples.
467 devc->num_samples = 0;
468 devc->starttime = g_get_monotonic_time();
470 /* Send header packet to the session bus. */
471 std_session_send_df_header(cb_data, LOG_PREFIX);
473 /* Poll every 50ms, or whenever some data comes in. */
475 sr_source_add(serial->fd, G_IO_IN, 50,
476 dmms[dmm].receive_data, (void *)sdi);
481 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
483 return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
484 sdi->conn, LOG_PREFIX);
487 /* Driver-specific API function wrappers */
489 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
490 #define HW_CLEANUP(X) \
491 static int cleanup_##X(void) { return cleanup(X); }
493 static GSList *scan_##X(GSList *options) { return scan(options, X); }
494 #define HW_DEV_LIST(X) \
495 static GSList *dev_list_##X(void) { return dev_list(X); }
496 #define HW_DEV_CLEAR(X) \
497 static int dev_clear_##X(void) { return dev_clear(X); }
498 #define HW_DEV_ACQUISITION_START(X) \
499 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
500 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
502 /* Driver structs and API function wrappers */
503 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
505 HW_CLEANUP(ID_UPPER) \
507 HW_DEV_LIST(ID_UPPER) \
508 HW_DEV_CLEAR(ID_UPPER) \
509 HW_DEV_ACQUISITION_START(ID_UPPER) \
510 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
512 .longname = LONGNAME, \
514 .init = init_##ID_UPPER, \
515 .cleanup = cleanup_##ID_UPPER, \
516 .scan = scan_##ID_UPPER, \
517 .dev_list = dev_list_##ID_UPPER, \
518 .dev_clear = dev_clear_##ID_UPPER, \
519 .config_get = NULL, \
520 .config_set = config_set, \
521 .config_list = config_list, \
522 .dev_open = dev_open, \
523 .dev_close = dev_close, \
524 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
525 .dev_acquisition_stop = dev_acquisition_stop, \
529 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
530 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
531 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
532 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
533 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
534 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
535 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
536 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
537 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
538 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
539 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
540 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
541 DRV(tecpel_dmm_8060_ser, TECPEL_DMM_8060_SER, "tecpel-dmm-8060-ser", "Tecpel DMM-8060 (UT-D02 cable)")
542 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
543 DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
544 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
545 DRV(voltcraft_vc830_ser, VOLTCRAFT_VC830_SER, "voltcraft-vc830-ser", "Voltcraft VC-830 (UT-D02 cable)")
546 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
547 DRV(uni_t_ut60a_ser, UNI_T_UT60A_SER, "uni-t-ut60a-ser", "UNI-T UT60A (UT-D02 cable)")
548 DRV(uni_t_ut60e_ser, UNI_T_UT60E_SER, "uni-t-ut60e-ser", "UNI-T UT60E (UT-D02 cable)")
549 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
550 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")