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 metex_m4650cr_driver_info;
52 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
53 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
54 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
55 SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
56 SR_PRIV struct sr_dev_driver radioshack_22_812_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_m4650cr_driver_info;
60 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
61 SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
62 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
63 SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
64 SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
65 SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
66 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
67 SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
69 SR_PRIV struct dmm_info dmms[] = {
71 "Digitek", "DT4000ZC", "2400/8n1/dtr=1", 2400,
72 FS9721_PACKET_SIZE, NULL,
73 sr_fs9721_packet_valid, sr_fs9721_parse,
75 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
78 "TekPower", "TP4000ZC", "2400/8n1/dtr=1", 2400,
79 FS9721_PACKET_SIZE, NULL,
80 sr_fs9721_packet_valid, sr_fs9721_parse,
82 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
85 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
86 METEX14_PACKET_SIZE, sr_metex14_packet_request,
87 sr_metex14_packet_valid, sr_metex14_parse,
89 &metex_me31_driver_info, receive_data_METEX_ME31,
92 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
93 METEX14_PACKET_SIZE, sr_metex14_packet_request,
94 sr_metex14_packet_valid, sr_metex14_parse,
96 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
99 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
100 METEX14_PACKET_SIZE, sr_metex14_packet_request,
101 sr_metex14_packet_valid, sr_metex14_parse,
103 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
106 "V&A", "VA18B", "2400/8n1", 2400,
107 FS9721_PACKET_SIZE, NULL,
108 sr_fs9721_packet_valid, sr_fs9721_parse,
110 &va_va18b_driver_info, receive_data_VA_VA18B,
113 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
114 METEX14_PACKET_SIZE, sr_metex14_packet_request,
115 sr_metex14_packet_valid, sr_metex14_parse,
117 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
120 "Metex", "M-4650CR", "1200/7n2/rts=0/dtr=1", 1200,
121 METEX14_PACKET_SIZE, sr_metex14_packet_request,
122 sr_metex14_packet_valid, sr_metex14_parse,
124 &metex_m4650cr_driver_info, receive_data_METEX_M4650CR,
127 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
128 METEX14_PACKET_SIZE, sr_metex14_packet_request,
129 sr_metex14_packet_valid, sr_metex14_parse,
131 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
134 "PCE", "PCE-DM32", "2400/8n1", 2400,
135 FS9721_PACKET_SIZE, NULL,
136 sr_fs9721_packet_valid, sr_fs9721_parse,
137 sr_fs9721_01_10_temp_f_c,
138 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
141 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
142 METEX14_PACKET_SIZE, sr_metex14_packet_request,
143 sr_metex14_packet_valid, sr_metex14_parse,
145 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
148 "RadioShack", "22-805", "600/7n2/rts=0/dtr=1", 600,
149 METEX14_PACKET_SIZE, sr_metex14_packet_request,
150 sr_metex14_packet_valid, sr_metex14_parse,
152 &radioshack_22_805_driver_info, receive_data_RADIOSHACK_22_805,
155 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
156 RS9LCD_PACKET_SIZE, NULL,
157 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
159 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
162 "Tecpel", "DMM-8061 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
163 2400, FS9721_PACKET_SIZE, NULL,
164 sr_fs9721_packet_valid, sr_fs9721_parse,
166 &tecpel_dmm_8061_ser_driver_info,
167 receive_data_TECPEL_DMM_8061_SER,
170 "Voltcraft", "M-3650D", "1200/7n2/rts=0/dtr=1", 1200,
171 METEX14_PACKET_SIZE, sr_metex14_packet_request,
172 sr_metex14_packet_valid, sr_metex14_parse,
174 &voltcraft_m3650d_driver_info, receive_data_VOLTCRAFT_M3650D,
177 "Voltcraft", "M-4650CR", "1200/7n2/rts=0/dtr=1", 1200,
178 METEX14_PACKET_SIZE, sr_metex14_packet_request,
179 sr_metex14_packet_valid, sr_metex14_parse,
181 &voltcraft_m4650cr_driver_info, receive_data_VOLTCRAFT_M4650CR,
184 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
185 2400, FS9721_PACKET_SIZE, NULL,
186 sr_fs9721_packet_valid, sr_fs9721_parse,
188 &voltcraft_vc820_ser_driver_info,
189 receive_data_VOLTCRAFT_VC820_SER,
193 * Note: The VC830 doesn't set the 'volt' and 'diode' bits of
194 * the FS9922 protocol. Instead, it only sets the user-defined
195 * bit "z1" to indicate "diode mode" and "voltage".
197 "Voltcraft", "VC-830 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
198 2400, FS9922_PACKET_SIZE, NULL,
199 sr_fs9922_packet_valid, sr_fs9922_parse,
201 &voltcraft_vc830_ser_driver_info,
202 receive_data_VOLTCRAFT_VC830_SER,
205 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
206 2400, FS9721_PACKET_SIZE, NULL,
207 sr_fs9721_packet_valid, sr_fs9721_parse,
209 &voltcraft_vc840_ser_driver_info,
210 receive_data_VOLTCRAFT_VC840_SER,
213 "UNI-T", "UT60A (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
214 2400, FS9721_PACKET_SIZE, NULL,
215 sr_fs9721_packet_valid, sr_fs9721_parse,
217 &uni_t_ut60a_ser_driver_info,
218 receive_data_UNI_T_UT60A_SER,
221 "UNI-T", "UT60E (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
222 2400, FS9721_PACKET_SIZE, NULL,
223 sr_fs9721_packet_valid, sr_fs9721_parse,
225 &uni_t_ut60e_ser_driver_info,
226 receive_data_UNI_T_UT60E_SER,
229 "UNI-T", "UT61D (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
230 2400, FS9922_PACKET_SIZE, NULL,
231 sr_fs9922_packet_valid, sr_fs9922_parse, NULL,
232 &uni_t_ut61d_ser_driver_info, receive_data_UNI_T_UT61D_SER,
235 /* Note: ES51922 baudrate is actually 19230! */
236 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
237 19200, ES51922_PACKET_SIZE, NULL,
238 sr_es51922_packet_valid, sr_es51922_parse, NULL,
239 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
242 "ISO-TECH", "IDM103N", "2400/7o1/rts=0/dtr=1",
243 2400, ES519XX_11B_PACKET_SIZE, NULL,
244 sr_es519xx_2400_11b_packet_valid, sr_es519xx_2400_11b_parse, NULL,
245 &iso_tech_idm103n_driver_info, receive_data_ISO_TECH_IDM103N,
249 static int dev_clear(int dmm)
251 return std_dev_clear(dmms[dmm].di, NULL);
254 static int init(struct sr_context *sr_ctx, int dmm)
256 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
258 return std_init(sr_ctx, dmms[dmm].di, LOG_PREFIX);
261 static GSList *sdmm_scan(const char *conn, const char *serialcomm, int dmm)
263 struct sr_dev_inst *sdi;
264 struct drv_context *drvc;
265 struct dev_context *devc;
266 struct sr_probe *probe;
267 struct sr_serial_dev_inst *serial;
273 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
276 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
279 sr_info("Probing serial port %s.", conn);
281 drvc = dmms[dmm].di->priv;
283 serial_flush(serial);
285 /* Request a packet if the DMM requires this. */
286 if (dmms[dmm].packet_request) {
287 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
288 sr_err("Failed to request packet: %d.", ret);
294 * There's no way to get an ID from the multimeter. It just sends data
295 * periodically (or upon request), so the best we can do is check if
296 * the packets match the expected format.
299 /* Let's get a bit of data and see if we can find a packet. */
301 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
302 dmms[dmm].packet_valid, 1000,
308 * If we dropped more than two packets worth of data, something is
309 * wrong. We shouldn't quit however, since the dropped bytes might be
310 * just zeroes at the beginning of the stream. Those can occur as a
311 * combination of the nonstandard cable that ships with some devices
312 * and the serial port or USB to serial adapter.
314 dropped = len - dmms[dmm].packet_size;
315 if (dropped > 2 * dmms[dmm].packet_size)
316 sr_warn("Had to drop too much data.");
318 sr_info("Found device on port %s.", conn);
320 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
321 dmms[dmm].device, "")))
324 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
325 sr_err("Device context malloc failed.");
329 sdi->inst_type = SR_INST_SERIAL;
333 sdi->driver = dmms[dmm].di;
334 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
336 sdi->probes = g_slist_append(sdi->probes, probe);
337 drvc->instances = g_slist_append(drvc->instances, sdi);
338 devices = g_slist_append(devices, sdi);
341 serial_close(serial);
346 static GSList *scan(GSList *options, int dmm)
348 struct sr_config *src;
350 const char *conn, *serialcomm;
352 conn = serialcomm = NULL;
353 for (l = options; l; l = l->next) {
357 conn = g_variant_get_string(src->data, NULL);
359 case SR_CONF_SERIALCOMM:
360 serialcomm = g_variant_get_string(src->data, NULL);
368 /* Use the provided comm specs. */
369 devices = sdmm_scan(conn, serialcomm, dmm);
371 /* Try the default. */
372 devices = sdmm_scan(conn, dmms[dmm].conn, dmm);
378 static GSList *dev_list(int dmm)
380 return ((struct drv_context *)(dmms[dmm].di->priv))->instances;
383 static int dev_open(struct sr_dev_inst *sdi)
385 struct sr_serial_dev_inst *serial;
388 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
391 sdi->status = SR_ST_ACTIVE;
396 static int dev_close(struct sr_dev_inst *sdi)
398 struct sr_serial_dev_inst *serial;
401 if (serial && serial->fd != -1) {
402 serial_close(serial);
403 sdi->status = SR_ST_INACTIVE;
409 static int cleanup(int dmm)
411 return dev_clear(dmm);
414 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi,
415 const struct sr_probe_group *probe_group)
417 struct dev_context *devc;
421 if (sdi->status != SR_ST_ACTIVE)
422 return SR_ERR_DEV_CLOSED;
424 if (!(devc = sdi->priv)) {
425 sr_err("sdi->priv was NULL.");
430 case SR_CONF_LIMIT_SAMPLES:
431 devc->limit_samples = g_variant_get_uint64(data);
432 sr_dbg("Setting sample limit to %" PRIu64 ".",
433 devc->limit_samples);
435 case SR_CONF_LIMIT_MSEC:
436 devc->limit_msec = g_variant_get_uint64(data);
437 sr_dbg("Setting time limit to %" PRIu64 "ms.",
447 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
448 const struct sr_probe_group *probe_group)
454 case SR_CONF_SCAN_OPTIONS:
455 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
456 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
458 case SR_CONF_DEVICE_OPTIONS:
459 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
460 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
469 static int dev_acquisition_start(const struct sr_dev_inst *sdi,
470 void *cb_data, int dmm)
472 struct dev_context *devc;
473 struct sr_serial_dev_inst *serial;
475 if (sdi->status != SR_ST_ACTIVE)
476 return SR_ERR_DEV_CLOSED;
478 if (!(devc = sdi->priv)) {
479 sr_err("sdi->priv was NULL.");
483 devc->cb_data = cb_data;
486 * Reset the number of samples to take. If we've already collected our
487 * quota, but we start a new session, and don't reset this, we'll just
488 * quit without acquiring any new samples.
490 devc->num_samples = 0;
491 devc->starttime = g_get_monotonic_time();
493 /* Send header packet to the session bus. */
494 std_session_send_df_header(cb_data, LOG_PREFIX);
496 /* Poll every 50ms, or whenever some data comes in. */
498 sr_source_add(serial->fd, G_IO_IN, 50,
499 dmms[dmm].receive_data, (void *)sdi);
504 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
506 return std_dev_acquisition_stop_serial(sdi, cb_data, dev_close,
507 sdi->conn, LOG_PREFIX);
510 /* Driver-specific API function wrappers */
512 static int init_##X(struct sr_context *sr_ctx) { return init(sr_ctx, X); }
513 #define HW_CLEANUP(X) \
514 static int cleanup_##X(void) { return cleanup(X); }
516 static GSList *scan_##X(GSList *options) { return scan(options, X); }
517 #define HW_DEV_LIST(X) \
518 static GSList *dev_list_##X(void) { return dev_list(X); }
519 #define HW_DEV_CLEAR(X) \
520 static int dev_clear_##X(void) { return dev_clear(X); }
521 #define HW_DEV_ACQUISITION_START(X) \
522 static int dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
523 void *cb_data) { return dev_acquisition_start(sdi, cb_data, X); }
525 /* Driver structs and API function wrappers */
526 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
528 HW_CLEANUP(ID_UPPER) \
530 HW_DEV_LIST(ID_UPPER) \
531 HW_DEV_CLEAR(ID_UPPER) \
532 HW_DEV_ACQUISITION_START(ID_UPPER) \
533 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
535 .longname = LONGNAME, \
537 .init = init_##ID_UPPER, \
538 .cleanup = cleanup_##ID_UPPER, \
539 .scan = scan_##ID_UPPER, \
540 .dev_list = dev_list_##ID_UPPER, \
541 .dev_clear = dev_clear_##ID_UPPER, \
542 .config_get = NULL, \
543 .config_set = config_set, \
544 .config_list = config_list, \
545 .dev_open = dev_open, \
546 .dev_close = dev_close, \
547 .dev_acquisition_start = dev_acquisition_start_##ID_UPPER, \
548 .dev_acquisition_stop = dev_acquisition_stop, \
552 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
553 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
554 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
555 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
556 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
557 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
558 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
559 DRV(metex_m4650cr, METEX_M4650CR, "metex-m4650cr", "Metex M-4650CR")
560 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
561 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
562 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
563 DRV(radioshack_22_805, RADIOSHACK_22_805, "radioshack-22-805", "RadioShack 22-805")
564 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
565 DRV(tecpel_dmm_8061_ser, TECPEL_DMM_8061_SER, "tecpel-dmm-8061-ser", "Tecpel DMM-8061 (UT-D02 cable)")
566 DRV(voltcraft_m3650d, VOLTCRAFT_M3650D, "voltcraft-m3650d", "Voltcraft M-3650D")
567 DRV(voltcraft_m4650cr, VOLTCRAFT_M4650CR, "voltcraft-m4650cr", "Voltcraft M-4650CR")
568 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
569 DRV(voltcraft_vc830_ser, VOLTCRAFT_VC830_SER, "voltcraft-vc830-ser", "Voltcraft VC-830 (UT-D02 cable)")
570 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
571 DRV(uni_t_ut60a_ser, UNI_T_UT60A_SER, "uni-t-ut60a-ser", "UNI-T UT60A (UT-D02 cable)")
572 DRV(uni_t_ut60e_ser, UNI_T_UT60E_SER, "uni-t-ut60e-ser", "UNI-T UT60E (UT-D02 cable)")
573 DRV(uni_t_ut61d_ser, UNI_T_UT61D_SER, "uni-t-ut61d-ser", "UNI-T UT61D (UT-D02 cable)")
574 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")
575 DRV(iso_tech_idm103n, ISO_TECH_IDM103N, "iso-tech-idm103n", "ISO-TECH IDM103N")