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_8061_ser_driver_info;
57 SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
58 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
59 SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
60 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
61 SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
62 SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
63 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
64 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
65 SR_PRIV struct sr_dev_driver iso_tech_idm103n_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-8061 (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_8061_ser_driver_info,
158 receive_data_TECPEL_DMM_8061_SER,
161 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
162 METEX14_PACKET_SIZE, sr_metex14_packet_request,
163 sr_metex14_packet_valid, sr_metex14_parse,
165 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
168 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
169 2400, FS9721_PACKET_SIZE, NULL,
170 sr_fs9721_packet_valid, sr_fs9721_parse,
172 &voltcraft_vc820_ser_driver_info,
173 receive_data_VOLTCRAFT_VC820_SER,
177 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
178 * the FS9922 protocol. Instead, it only sets the user-defined
179 * bit "z1" to indicate "diode mode" and "voltage".
181 "Voltcraft", "VC-830 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
182 2400, FS9922_PACKET_SIZE, NULL,
183 sr_fs9922_packet_valid, sr_fs9922_parse,
185 &voltcraft_vc830_ser_driver_info,
186 receive_data_VOLTCRAFT_VC830_SER,
189 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
190 2400, FS9721_PACKET_SIZE, NULL,
191 sr_fs9721_packet_valid, sr_fs9721_parse,
193 &voltcraft_vc840_ser_driver_info,
194 receive_data_VOLTCRAFT_VC840_SER,
197 "UNI-T", "UT60A (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
198 2400, FS9721_PACKET_SIZE, NULL,
199 sr_fs9721_packet_valid, sr_fs9721_parse,
201 &uni_t_ut60a_ser_driver_info,
202 receive_data_UNI_T_UT60A_SER,
205 "UNI-T", "UT60E (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
206 2400, FS9721_PACKET_SIZE, NULL,
207 sr_fs9721_packet_valid, sr_fs9721_parse,
209 &uni_t_ut60e_ser_driver_info,
210 receive_data_UNI_T_UT60E_SER,
213 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
214 2400, FS9922_PACKET_SIZE, NULL,
215 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
216 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
219 /* Note: ES51922 baudrate is actually 19230! */
220 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
221 19200, ES51922_PACKET_SIZE, NULL,
222 sr_es51922_packet_valid, sr_es51922_parse, NULL,
223 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
226 "ISO-TECH", "IDM103N", "2400/7o1/rts=0/dtr=1",
227 2400, ES519XX_11B_PACKET_SIZE, NULL,
228 sr_es519xx_2400_11B_packet_valid, sr_es519xx_2400_11B_parse, NULL,
229 &iso_tech_idm103n_ser_driver_info, receive_data_ISO_TECH_IDM103N_SER,
233 static int dev_clear(int dmm)
235 return std_dev_clear(dmms[dmm].di, NULL);
238 static int init(struct sr_context *sr_ctx, int dmm)
240 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
242 return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
245 static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
247 struct sr_dev_inst *sdi;
248 struct drv_context *drvc;
249 struct dev_context *devc;
250 struct sr_probe *probe;
251 struct sr_serial_dev_inst *serial;
257 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
260 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
263 sr_info("Probing serial port %s.", conn);
265 drvc = dmms[dmm].di->priv;
267 serial_flush(serial);
269 /* Request a packet if the DMM requires this. */
270 if (dmms[dmm].packet_request) {
271 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
272 sr_err("Failed to request packet: %d.", ret);
278 * There's no way to get an ID from the multimeter. It just sends data
279 * periodically (or upon request), so the best we can do is check if
280 * the packets match the expected format.
283 /* Let's get a bit of data and see if we can find a packet. */
285 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
286 dmms[dmm].packet_valid, 1000,
292 * If we dropped more than two packets worth of data, something is
293 * wrong. We shouldn't quit however, since the dropped bytes might be
294 * just zeroes at the beginning of the stream. Those can occur as a
295 * combination of the nonstandard cable that ships with some devices
296 * and the serial port or USB to serial adapter.
298 dropped = len - dmms[dmm].packet_size;
299 if (dropped > 2 * dmms[dmm].packet_size)
300 sr_warn("Had to drop too much data.");
302 sr_info("Found device on port %s.", conn);
304 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
305 dmms[dmm].device, "")))
308 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
309 sr_err("Device context malloc failed.");
313 sdi->inst_type = SR_INST_SERIAL;
317 sdi->driver = dmms[dmm].di;
318 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
320 sdi->probes = g_slist_append(sdi->probes, probe);
321 drvc->instances = g_slist_append(drvc->instances, sdi);
322 devices = g_slist_append(devices, sdi);
325 serial_close(serial);
330 static GSList *scan(GSList *options, int dmm)
332 struct sr_config *src;
334 const char *conn, *serialcomm;
336 conn = serialcomm = NULL;
337 for (l = options; l; l = l->next) {
341 conn = g_variant_get_string(src->data, NULL);
343 case SR_CONF_SERIALCOMM:
344 serialcomm = g_variant_get_string(src->data, NULL);
352 /* Use the provided comm specs. */
353 devices = sdmm_scan(conn, serialcomm, dmm);
355 /* Try the default. */
356 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
362 static GSList *dev_list(int dmm)
364 return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
367 static int dev_open(struct sr_dev_inst *sdi)
369 struct sr_serial_dev_inst *serial;
372 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
375 sdi->status = SR_ST_ACTIVE;
380 static int dev_close(struct sr_dev_inst *sdi)
382 struct sr_serial_dev_inst *serial;
385 if (serial && serial->fd != -1) {
386 serial_close(serial);
387 sdi->status = SR_ST_INACTIVE;
393 static int cleanup(int dmm)
395 return dev_clear(dmm);
398 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
400 struct dev_context *devc;
402 if (sdi->status != SR_ST_ACTIVE)
403 return SR_ERR_DEV_CLOSED;
405 if (!(devc = sdi->priv)) {
406 sr_err("sdi->priv was NULL.");
411 case SR_CONF_LIMIT_SAMPLES:
412 devc->limit_samples = g_variant_get_uint64(data);
413 sr_dbg("Setting sample limit to %" PRIu64 ".",
414 devc->limit_samples);
416 case SR_CONF_LIMIT_MSEC:
417 devc->limit_msec = g_variant_get_uint64(data);
418 sr_dbg("Setting time limit to %" PRIu64 "ms.",
428 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
434 case SR_CONF_SCAN_OPTIONS:
435 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
436 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
438 case SR_CONF_DEVICE_OPTIONS:
439 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
440 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
449 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
450 void *cb_data, int dmm)
452 struct dev_context *devc;
453 struct sr_serial_dev_inst *serial;
455 if (sdi->status != SR_ST_ACTIVE)
456 return SR_ERR_DEV_CLOSED;
458 if (!(devc = sdi->priv)) {
459 sr_err("sdi->priv was NULL.");
463 devc->cb_data = cb_data;
466 * Reset the number of samples to take. If we've already collected our
467 * quota, but we start a new session, and don't reset this, we'll just
468 * quit without acquiring any new samples.
470 devc->num_samples = 0;
471 devc->starttime = g_get_monotonic_time();
473 /* Send header packet to the session bus. */
474 std_session_send_df_header(cb_data, LOG_PREFIX);
476 /* Poll every 50ms, or whenever some data comes in. */
478 sr_source_add(serial->fd, G_IO_IN, 50,
479 dmms[dmm].receive_data, (void *)sdi);
484 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
486 return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
487 sdi->conn, LOG_PREFIX);
490 /* Driver-specific API function wrappers */
492 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
493 #define HW_CLEANUP(X) \
494 static int cleanup_##X(void) { return cleanup(X); }
496 static GSList *scan_##X(GSList *options) { return scan(options, X); }
497 #define HW_DEV_LIST(X) \
498 static GSList *dev_list_##X(void) { return dev_list(X); }
499 #define HW_DEV_CLEAR(X) \
500 static int dev_clear_##X(void) { return dev_clear(X); }
501 #define HW_DEV_ACQUISITION_START(X) \
502 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
503 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
505 /* Driver structs and API function wrappers */
506 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
508 HW_CLEANUP(ID_UPPER) \
510 HW_DEV_LIST(ID_UPPER) \
511 HW_DEV_CLEAR(ID_UPPER) \
512 HW_DEV_ACQUISITION_START(ID_UPPER) \
513 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
515 .longname = LONGNAME, \
517 .init = init_##ID_UPPER, \
518 .cleanup = cleanup_##ID_UPPER, \
519 .scan = scan_##ID_UPPER, \
520 .dev_list = dev_list_##ID_UPPER, \
521 .dev_clear = dev_clear_##ID_UPPER, \
522 .config_get = NULL, \
523 .config_set = config_set, \
524 .config_list = config_list, \
525 .dev_open = dev_open, \
526 .dev_close = dev_close, \
527 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
528 .dev_acquisition_stop = dev_acquisition_stop, \
532 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
533 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
534 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
535 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
536 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
537 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
538 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
539 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
540 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
541 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
542 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
543 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
544 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
545 DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
546 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
547 DRV(voltcraft_vc830_ser, VOLTCRAFT_VC830_SER, "voltcraft-vc830-ser", "Voltcraft VC-830 (UT-D02 cable)")
548 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
549 DRV(uni_t_ut60a_ser, UNI_T_UT60A_SER, "uni-t-ut60a-ser", "UNI-T UT60A (UT-D02 cable)")
550 DRV(uni_t_ut60e_ser, UNI_T_UT60E_SER, "uni-t-ut60e-ser", "UNI-T UT60E (UT-D02 cable)")
551 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
552 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")
553 DRV(iso_tech_idm103n_ser, ISO_TECH_IDM103N_SER, "iso-tech-idm103n-ser", "ISO-TECH IDM103N")