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 bbcgm_m2110_driver_info;
45 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
46 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
47 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
48 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
49 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
50 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
51 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
52 SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
53 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
54 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
55 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
56 SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
57 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
58 SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
59 SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
60 SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
61 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
62 SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
63 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
64 SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
65 SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
66 SR_PRIV struct sr_dev_driver uni_t_ut61b_ser_driver_info;
67 SR_PRIV struct sr_dev_driver uni_t_ut61c_ser_driver_info;
68 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
69 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
70 SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
72 SR_PRIV struct dmm_info dmms[] = {
74 "BBC Goertz Metrawatt", "M2110", "1200/7n2", 1200,
75 BBCGM_M2110_PACKET_SIZE, NULL,
76 sr_m2110_packet_valid, sr_m2110_parse,
78 &bbcgm_m2110_driver_info, receive_data_BBCGM_M2110,
81 "Digitek", "DT4000ZC", "2400/8n1/dtr=1", 2400,
82 FS9721_PACKET_SIZE, NULL,
83 sr_fs9721_packet_valid, sr_fs9721_parse,
85 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
88 "TekPower", "TP4000ZC", "2400/8n1/dtr=1", 2400,
89 FS9721_PACKET_SIZE, NULL,
90 sr_fs9721_packet_valid, sr_fs9721_parse,
92 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
95 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
96 METEX14_PACKET_SIZE, sr_metex14_packet_request,
97 sr_metex14_packet_valid, sr_metex14_parse,
99 &metex_me31_driver_info, receive_data_METEX_ME31,
102 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
103 METEX14_PACKET_SIZE, sr_metex14_packet_request,
104 sr_metex14_packet_valid, sr_metex14_parse,
106 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
109 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
110 METEX14_PACKET_SIZE, sr_metex14_packet_request,
111 sr_metex14_packet_valid, sr_metex14_parse,
113 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
116 "V&A", "VA18B", "2400/8n1", 2400,
117 FS9721_PACKET_SIZE, NULL,
118 sr_fs9721_packet_valid, sr_fs9721_parse,
120 &va_va18b_driver_info, receive_data_VA_VA18B,
123 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
124 METEX14_PACKET_SIZE, sr_metex14_packet_request,
125 sr_metex14_packet_valid, sr_metex14_parse,
127 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
130 "Metex", "M-4650CR", "1200/7n2/rts=0/dtr=1", 1200,
131 METEX14_PACKET_SIZE, sr_metex14_packet_request,
132 sr_metex14_packet_valid, sr_metex14_parse,
134 &metex_m4650cr_driver_info, receive_data_METEX_M4650CR,
137 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
138 METEX14_PACKET_SIZE, sr_metex14_packet_request,
139 sr_metex14_packet_valid, sr_metex14_parse,
141 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
144 "PCE", "PCE-DM32", "2400/8n1", 2400,
145 FS9721_PACKET_SIZE, NULL,
146 sr_fs9721_packet_valid, sr_fs9721_parse,
147 sr_fs9721_01_10_temp_f_c,
148 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
151 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
152 METEX14_PACKET_SIZE, sr_metex14_packet_request,
153 sr_metex14_packet_valid, sr_metex14_parse,
155 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
158 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
159 METEX14_PACKET_SIZE, sr_metex14_packet_request,
160 sr_metex14_packet_valid, sr_metex14_parse,
162 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
165 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
166 RS9LCD_PACKET_SIZE, NULL,
167 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
169 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
172 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
173 2400, FS9721_PACKET_SIZE, NULL,
174 sr_fs9721_packet_valid, sr_fs9721_parse,
176 &tecpel_dmm_8061_ser_driver_info,
177 receive_data_TECPEL_DMM_8061_SER,
180 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
181 METEX14_PACKET_SIZE, sr_metex14_packet_request,
182 sr_metex14_packet_valid, sr_metex14_parse,
184 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
187 "Voltcraft", "M-4650CR", "1200/7n2/rts=0/dtr=1", 1200,
188 METEX14_PACKET_SIZE, sr_metex14_packet_request,
189 sr_metex14_packet_valid, sr_metex14_parse,
191 &voltcraft_m4650cr_driver_info, receive_data_VOLTCRAFT_M4650CR,
194 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
195 2400, FS9721_PACKET_SIZE, NULL,
196 sr_fs9721_packet_valid, sr_fs9721_parse,
198 &voltcraft_vc820_ser_driver_info,
199 receive_data_VOLTCRAFT_VC820_SER,
203 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
204 * the FS9922 protocol. Instead, it only sets the user-defined
205 * bit "z1" to indicate "diode mode" and "voltage".
207 "Voltcraft", "VC-830 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
208 2400, FS9922_PACKET_SIZE, NULL,
209 sr_fs9922_packet_valid, sr_fs9922_parse,
211 &voltcraft_vc830_ser_driver_info,
212 receive_data_VOLTCRAFT_VC830_SER,
215 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
216 2400, FS9721_PACKET_SIZE, NULL,
217 sr_fs9721_packet_valid, sr_fs9721_parse,
219 &voltcraft_vc840_ser_driver_info,
220 receive_data_VOLTCRAFT_VC840_SER,
223 "UNI-T", "UT60A (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
224 2400, FS9721_PACKET_SIZE, NULL,
225 sr_fs9721_packet_valid, sr_fs9721_parse,
227 &uni_t_ut60a_ser_driver_info,
228 receive_data_UNI_T_UT60A_SER,
231 "UNI-T", "UT60E (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
232 2400, FS9721_PACKET_SIZE, NULL,
233 sr_fs9721_packet_valid, sr_fs9721_parse,
235 &uni_t_ut60e_ser_driver_info,
236 receive_data_UNI_T_UT60E_SER,
239 "UNI-T", "UT61B (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
240 2400, FS9922_PACKET_SIZE, NULL,
241 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
242 &uni_t_ut61b_ser_driver_info, receive_data_UNI_T_UT61B_SER,
245 "UNI-T", "UT61C (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
246 2400, FS9922_PACKET_SIZE, NULL,
247 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
248 &uni_t_ut61c_ser_driver_info, receive_data_UNI_T_UT61C_SER,
251 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
252 2400, FS9922_PACKET_SIZE, NULL,
253 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
254 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
257 /* Note: ES51922 baudrate is actually 19230! */
258 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
259 19200, ES519XX_14B_PACKET_SIZE, NULL,
260 sr_es519xx_19200_14b_packet_valid, sr_es519xx_19200_14b_parse, NULL,
261 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
264 "ISO-TECH", "IDM103N", "2400/7o1/rts=0/dtr=1",
265 2400, ES519XX_11B_PACKET_SIZE, NULL,
266 sr_es519xx_2400_11b_packet_valid, sr_es519xx_2400_11b_parse, NULL,
267 &iso_tech_idm103n_driver_info, receive_data_ISO_TECH_IDM103N,
271 static int dev_clear(int dmm)
273 return std_dev_clear(dmms[dmm].di, NULL);
276 static int init(struct sr_context *sr_ctx, int dmm)
278 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
280 return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
283 static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
285 struct sr_dev_inst *sdi;
286 struct drv_context *drvc;
287 struct dev_context *devc;
288 struct sr_probe *probe;
289 struct sr_serial_dev_inst *serial;
295 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
298 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
301 sr_info("Probing serial port %s.", conn);
303 drvc = dmms[dmm].di->priv;
305 serial_flush(serial);
307 /* Request a packet if the DMM requires this. */
308 if (dmms[dmm].packet_request) {
309 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
310 sr_err("Failed to request packet: %d.", ret);
316 * There's no way to get an ID from the multimeter. It just sends data
317 * periodically (or upon request), so the best we can do is check if
318 * the packets match the expected format.
321 /* Let's get a bit of data and see if we can find a packet. */
323 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
324 dmms[dmm].packet_valid, 1000,
330 * If we dropped more than two packets worth of data, something is
331 * wrong. We shouldn't quit however, since the dropped bytes might be
332 * just zeroes at the beginning of the stream. Those can occur as a
333 * combination of the nonstandard cable that ships with some devices
334 * and the serial port or USB to serial adapter.
336 dropped = len - dmms[dmm].packet_size;
337 if (dropped > 2 * dmms[dmm].packet_size)
338 sr_warn("Had to drop too much data.");
340 sr_info("Found device on port %s.", conn);
342 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
343 dmms[dmm].device, "")))
346 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
347 sr_err("Device context malloc failed.");
351 sdi->inst_type = SR_INST_SERIAL;
355 sdi->driver = dmms[dmm].di;
356 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
358 sdi->probes = g_slist_append(sdi->probes, probe);
359 drvc->instances = g_slist_append(drvc->instances, sdi);
360 devices = g_slist_append(devices, sdi);
363 serial_close(serial);
368 static GSList *scan(GSList *options, int dmm)
370 struct sr_config *src;
372 const char *conn, *serialcomm;
374 conn = serialcomm = NULL;
375 for (l = options; l; l = l->next) {
379 conn = g_variant_get_string(src->data, NULL);
381 case SR_CONF_SERIALCOMM:
382 serialcomm = g_variant_get_string(src->data, NULL);
390 /* Use the provided comm specs. */
391 devices = sdmm_scan(conn, serialcomm, dmm);
393 /* Try the default. */
394 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
400 static GSList *dev_list(int dmm)
402 return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
405 static int cleanup(int dmm)
407 return dev_clear(dmm);
410 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
411 const struct sr_probe_group *probe_group)
413 struct dev_context *devc;
417 if (sdi->status != SR_ST_ACTIVE)
418 return SR_ERR_DEV_CLOSED;
420 if (!(devc = sdi->priv)) {
421 sr_err("sdi->priv was NULL.");
426 case SR_CONF_LIMIT_SAMPLES:
427 devc->limit_samples = g_variant_get_uint64(data);
428 sr_dbg("Setting sample limit to %" PRIu64 ".",
429 devc->limit_samples);
431 case SR_CONF_LIMIT_MSEC:
432 devc->limit_msec = g_variant_get_uint64(data);
433 sr_dbg("Setting time limit to %" PRIu64 "ms.",
443 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
444 const struct sr_probe_group *probe_group)
450 case SR_CONF_SCAN_OPTIONS:
451 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
452 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
454 case SR_CONF_DEVICE_OPTIONS:
455 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
456 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
465 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
466 void *cb_data, int dmm)
468 struct dev_context *devc;
469 struct sr_serial_dev_inst *serial;
471 if (sdi->status != SR_ST_ACTIVE)
472 return SR_ERR_DEV_CLOSED;
474 if (!(devc = sdi->priv)) {
475 sr_err("sdi->priv was NULL.");
479 devc->cb_data = cb_data;
482 * Reset the number of samples to take. If we've already collected our
483 * quota, but we start a new session, and don't reset this, we'll just
484 * quit without acquiring any new samples.
486 devc->num_samples = 0;
487 devc->starttime = g_get_monotonic_time();
489 /* Send header packet to the session bus. */
490 std_session_send_df_header(cb_data, LOG_PREFIX);
492 /* Poll every 50ms, or whenever some data comes in. */
494 serial_source_add(serial, G_IO_IN, 50,
495 dmms[dmm].receive_data, (void *)sdi);
500 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
502 return std_serial_dev_acquisition_stop(sdi, cb_data, std_serial_dev_close,
503 sdi->conn, LOG_PREFIX);
506 /* Driver-specific API function wrappers */
508 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
509 #define HW_CLEANUP(X) \
510 static int cleanup_##X(void) { return cleanup(X); }
512 static GSList *scan_##X(GSList *options) { return scan(options, X); }
513 #define HW_DEV_LIST(X) \
514 static GSList *dev_list_##X(void) { return dev_list(X); }
515 #define HW_DEV_CLEAR(X) \
516 static int dev_clear_##X(void) { return dev_clear(X); }
517 #define HW_DEV_ACQUISITION_START(X) \
518 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
519 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
521 /* Driver structs and API function wrappers */
522 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
524 HW_CLEANUP(ID_UPPER) \
526 HW_DEV_LIST(ID_UPPER) \
527 HW_DEV_CLEAR(ID_UPPER) \
528 HW_DEV_ACQUISITION_START(ID_UPPER) \
529 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
531 .longname = LONGNAME, \
533 .init = init_##ID_UPPER, \
534 .cleanup = cleanup_##ID_UPPER, \
535 .scan = scan_##ID_UPPER, \
536 .dev_list = dev_list_##ID_UPPER, \
537 .dev_clear = dev_clear_##ID_UPPER, \
538 .config_get = NULL, \
539 .config_set = config_set, \
540 .config_list = config_list, \
541 .dev_open = std_serial_dev_open, \
542 .dev_close = std_serial_dev_close, \
543 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
544 .dev_acquisition_stop = dev_acquisition_stop, \
548 DRV(bbcgm_m2110, BBCGM_M2110, "bbcgm-m2110", "BBC Goertz Metrawatt M2110")
549 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
550 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
551 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
552 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
553 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
554 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
555 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
556 DRV(metex_m4650cr, METEX_M4650CR, "metex-m4650cr", "Metex M-4650CR")
557 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
558 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
559 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
560 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
561 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
562 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
563 DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
564 DRV(voltcraft_m4650cr, VOLTCRAFT_M4650CR, "voltcraft-m4650cr", "Voltcraft M-4650CR")
565 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
566 DRV(voltcraft_vc830_ser, VOLTCRAFT_VC830_SER, "voltcraft-vc830-ser", "Voltcraft VC-830 (UT-D02 cable)")
567 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
568 DRV(uni_t_ut60a_ser, UNI_T_UT60A_SER, "uni-t-ut60a-ser", "UNI-T UT60A (UT-D02 cable)")
569 DRV(uni_t_ut60e_ser, UNI_T_UT60E_SER, "uni-t-ut60e-ser", "UNI-T UT60E (UT-D02 cable)")
570 DRV(uni_t_ut61b_ser, UNI_T_UT61B_SER, "uni-t-ut61b-ser", "UNI-T UT61B (UT-D02 cable)")
571 DRV(uni_t_ut61c_ser, UNI_T_UT61C_SER, "uni-t-ut61c-ser", "UNI-T UT61C (UT-D02 cable)")
572 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
573 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")
574 DRV(iso_tech_idm103n, ISO_TECH_IDM103N, "iso-tech-idm103n", "ISO-TECH IDM103N")