2 * This file is part of the sigrok 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 int hwopts[] = {
38 static const int hwcaps[] = {
40 SR_HWCAP_LIMIT_SAMPLES,
46 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
47 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
48 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
49 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
50 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
51 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
52 SR_PRIV struct sr_dev_driver metex_m3640d_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_812_driver_info;
57 SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
58 SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
59 SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
61 SR_PRIV struct dmm_info dmms[] = {
63 "Digitek", "DT4000ZC", "2400/8n1", 2400,
64 FS9721_PACKET_SIZE, NULL,
65 sr_fs9721_packet_valid, sr_fs9721_parse,
67 &digitek_dt4000zc_driver_info, receive_data_DIGITEK_DT4000ZC,
70 "TekPower", "TP4000ZC", "2400/8n1", 2400,
71 FS9721_PACKET_SIZE, NULL,
72 sr_fs9721_packet_valid, sr_fs9721_parse,
74 &tekpower_tp4000zc_driver_info, receive_data_TEKPOWER_TP4000ZC,
77 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
78 METEX14_PACKET_SIZE, sr_metex14_packet_request,
79 sr_metex14_packet_valid, sr_metex14_parse,
81 &metex_me31_driver_info, receive_data_METEX_ME31,
84 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
85 METEX14_PACKET_SIZE, sr_metex14_packet_request,
86 sr_metex14_packet_valid, sr_metex14_parse,
88 &peaktech_3410_driver_info, receive_data_PEAKTECH_3410,
91 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
92 METEX14_PACKET_SIZE, sr_metex14_packet_request,
93 sr_metex14_packet_valid, sr_metex14_parse,
95 &mastech_mas345_driver_info, receive_data_MASTECH_MAS345,
98 "V&A", "VA18B", "2400/8n1", 2400,
99 FS9721_PACKET_SIZE, NULL,
100 sr_fs9721_packet_valid, sr_fs9721_parse,
102 &va_va18b_driver_info, receive_data_VA_VA18B,
105 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
106 METEX14_PACKET_SIZE, sr_metex14_packet_request,
107 sr_metex14_packet_valid, sr_metex14_parse,
109 &metex_m3640d_driver_info, receive_data_METEX_M3640D,
112 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
113 METEX14_PACKET_SIZE, sr_metex14_packet_request,
114 sr_metex14_packet_valid, sr_metex14_parse,
116 &peaktech_4370_driver_info, receive_data_PEAKTECH_4370,
119 "PCE", "PCE-DM32", "2400/8n1", 2400,
120 FS9721_PACKET_SIZE, NULL,
121 sr_fs9721_packet_valid, sr_fs9721_parse,
122 dmm_details_pce_dm32,
123 &pce_pce_dm32_driver_info, receive_data_PCE_PCE_DM32,
126 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
127 METEX14_PACKET_SIZE, sr_metex14_packet_request,
128 sr_metex14_packet_valid, sr_metex14_parse,
130 &radioshack_22_168_driver_info, receive_data_RADIOSHACK_22_168,
133 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
134 RS9LCD_PACKET_SIZE, NULL,
135 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
137 &radioshack_22_812_driver_info, receive_data_RADIOSHACK_22_812,
140 "Voltcraft", "VC-820 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
141 2400, FS9721_PACKET_SIZE, NULL,
142 sr_fs9721_packet_valid, sr_fs9721_parse,
144 &voltcraft_vc820_ser_driver_info,
145 receive_data_VOLTCRAFT_VC820_SER,
148 "Voltcraft", "VC-840 (UT-D02 cable)", "2400/8n1/rts=0/dtr=1",
149 2400, FS9721_PACKET_SIZE, NULL,
150 sr_fs9721_packet_valid, sr_fs9721_parse,
152 &voltcraft_vc840_ser_driver_info,
153 receive_data_VOLTCRAFT_VC840_SER,
156 /* Note: ES51922 baudrate is actually 19230! */
157 "UNI-T", "UT61E (UT-D02 cable)", "19200/7o1/rts=0/dtr=1",
158 19200, ES51922_PACKET_SIZE, NULL,
159 sr_es51922_packet_valid, sr_es51922_parse, NULL,
160 &uni_t_ut61e_ser_driver_info, receive_data_UNI_T_UT61E_SER,
164 /* Properly close and free all devices. */
165 static int clear_instances(int dmm)
167 struct sr_dev_inst *sdi;
168 struct drv_context *drvc;
169 struct dev_context *devc;
171 struct sr_dev_driver *di;
175 if (!(drvc = di->priv))
179 for (l = drvc->instances; l; l = l->next) {
180 if (!(sdi = l->data))
182 if (!(devc = sdi->priv))
184 sr_serial_dev_inst_free(devc->serial);
185 sr_dev_inst_free(sdi);
187 g_slist_free(drvc->instances);
188 drvc->instances = NULL;
193 static int hw_init(struct sr_context *sr_ctx, int dmm)
195 struct drv_context *drvc;
197 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
198 sr_err("Driver context malloc failed.");
199 return SR_ERR_MALLOC;
202 sr_dbg("Selected '%s' subdriver.", dmms[dmm].di->name);
204 drvc->sr_ctx = sr_ctx;
205 dmms[dmm].di->priv = drvc;
210 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
212 struct sr_dev_inst *sdi;
213 struct drv_context *drvc;
214 struct dev_context *devc;
215 struct sr_probe *probe;
216 struct sr_serial_dev_inst *serial;
222 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
225 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
228 sr_info("Probing serial port %s.", conn);
230 drvc = dmms[dmm].di->priv;
232 serial_flush(serial);
234 /* Request a packet if the DMM requires this. */
235 if (dmms[dmm].packet_request) {
236 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
237 sr_err("Failed to request packet: %d.", ret);
243 * There's no way to get an ID from the multimeter. It just sends data
244 * periodically (or upon request), so the best we can do is check if
245 * the packets match the expected format.
248 /* Let's get a bit of data and see if we can find a packet. */
250 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
251 dmms[dmm].packet_valid, 1000,
257 * If we dropped more than two packets worth of data, something is
258 * wrong. We shouldn't quit however, since the dropped bytes might be
259 * just zeroes at the beginning of the stream. Those can occur as a
260 * combination of the nonstandard cable that ships with some devices
261 * and the serial port or USB to serial adapter.
263 dropped = len - dmms[dmm].packet_size;
264 if (dropped > 2 * dmms[dmm].packet_size)
265 sr_warn("Had to drop too much data.");
267 sr_info("Found device on port %s.", conn);
269 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
270 dmms[dmm].device, "")))
273 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
274 sr_err("Device context malloc failed.");
278 devc->serial = serial;
281 sdi->driver = dmms[dmm].di;
282 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
284 sdi->probes = g_slist_append(sdi->probes, probe);
285 drvc->instances = g_slist_append(drvc->instances, sdi);
286 devices = g_slist_append(devices, sdi);
289 serial_close(serial);
294 static GSList *hw_scan(GSList *options, int dmm)
296 struct sr_config *src;
298 const char *conn, *serialcomm;
300 conn = serialcomm = NULL;
301 for (l = options; l; l = l->next) {
307 case SR_HWOPT_SERIALCOMM:
308 serialcomm = src->value;
316 /* Use the provided comm specs. */
317 devices = scan(conn, serialcomm, dmm);
319 /* Try the default. */
320 devices = scan(conn, dmms[dmm].conn, dmm);
326 static GSList *hw_dev_list(int dmm)
328 struct drv_context *drvc;
330 drvc = dmms[dmm].di->priv;
332 return drvc->instances;
335 static int hw_dev_open(struct sr_dev_inst *sdi)
337 struct dev_context *devc;
339 if (!(devc = sdi->priv)) {
340 sr_err("sdi->priv was NULL.");
344 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
347 sdi->status = SR_ST_ACTIVE;
352 static int hw_dev_close(struct sr_dev_inst *sdi)
354 struct dev_context *devc;
356 if (!(devc = sdi->priv)) {
357 sr_err("sdi->priv was NULL.");
361 if (devc->serial && devc->serial->fd != -1) {
362 serial_close(devc->serial);
363 sdi->status = SR_ST_INACTIVE;
369 static int hw_cleanup(int dmm)
371 clear_instances(dmm);
376 static int hw_info_get(int info_id, const void **data,
377 const struct sr_dev_inst *sdi)
395 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
398 struct dev_context *devc;
400 if (sdi->status != SR_ST_ACTIVE)
403 if (!(devc = sdi->priv)) {
404 sr_err("sdi->priv was NULL.");
409 case SR_HWCAP_LIMIT_SAMPLES:
410 devc->limit_samples = *(const uint64_t *)value;
411 sr_dbg("Setting sample limit to %" PRIu64 ".",
412 devc->limit_samples);
414 case SR_HWCAP_LIMIT_MSEC:
415 devc->limit_msec = *(const uint64_t *)value;
416 sr_dbg("Setting time limit to %" PRIu64 "ms.",
420 sr_err("Unknown capability: %d.", hwcap);
428 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
429 void *cb_data, int dmm)
431 struct sr_datafeed_packet packet;
432 struct sr_datafeed_header header;
433 struct dev_context *devc;
435 if (!(devc = sdi->priv)) {
436 sr_err("sdi->priv was NULL.");
440 sr_dbg("Starting acquisition.");
442 devc->cb_data = cb_data;
445 * Reset the number of samples to take. If we've already collected our
446 * quota, but we start a new session, and don't reset this, we'll just
447 * quit without acquiring any new samples.
449 devc->num_samples = 0;
450 devc->starttime = g_get_monotonic_time();
452 /* Send header packet to the session bus. */
453 sr_dbg("Sending SR_DF_HEADER.");
454 packet.type = SR_DF_HEADER;
455 packet.payload = (uint8_t *)&header;
456 header.feed_version = 1;
457 gettimeofday(&header.starttime, NULL);
458 sr_session_send(devc->cb_data, &packet);
460 /* Poll every 50ms, or whenever some data comes in. */
461 sr_source_add(devc->serial->fd, G_IO_IN, 50,
462 dmms[dmm].receive_data, (void *)sdi);
467 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
469 struct sr_datafeed_packet packet;
470 struct dev_context *devc;
472 if (sdi->status != SR_ST_ACTIVE)
475 if (!(devc = sdi->priv)) {
476 sr_err("sdi->priv was NULL.");
480 sr_dbg("Stopping acquisition.");
482 sr_source_remove(devc->serial->fd);
483 hw_dev_close((struct sr_dev_inst *)sdi);
485 /* Send end packet to the session bus. */
486 sr_dbg("Sending SR_DF_END.");
487 packet.type = SR_DF_END;
488 sr_session_send(cb_data, &packet);
493 /* Driver-specific API function wrappers */
495 static int hw_init_##X(struct sr_context *sr_ctx) { return hw_init(sr_ctx, X); }
496 #define HW_CLEANUP(X) \
497 static int hw_cleanup_##X(void) { return hw_cleanup(X); }
499 static GSList *hw_scan_##X(GSList *options) { return hw_scan(options, X); }
500 #define HW_DEV_LIST(X) \
501 static GSList *hw_dev_list_##X(void) { return hw_dev_list(X); }
502 #define CLEAR_INSTANCES(X) \
503 static int clear_instances_##X(void) { return clear_instances(X); }
504 #define HW_DEV_ACQUISITION_START(X) \
505 static int hw_dev_acquisition_start_##X(const struct sr_dev_inst *sdi, \
506 void *cb_data) { return hw_dev_acquisition_start(sdi, cb_data, X); }
508 /* Driver structs and API function wrappers */
509 #define DRV(ID, ID_UPPER, NAME, LONGNAME) \
511 HW_CLEANUP(ID_UPPER) \
513 HW_DEV_LIST(ID_UPPER) \
514 CLEAR_INSTANCES(ID_UPPER) \
515 HW_DEV_ACQUISITION_START(ID_UPPER) \
516 SR_PRIV struct sr_dev_driver ID##_driver_info = { \
518 .longname = LONGNAME, \
520 .init = hw_init_##ID_UPPER, \
521 .cleanup = hw_cleanup_##ID_UPPER, \
522 .scan = hw_scan_##ID_UPPER, \
523 .dev_list = hw_dev_list_##ID_UPPER, \
524 .dev_clear = clear_instances_##ID_UPPER, \
525 .dev_open = hw_dev_open, \
526 .dev_close = hw_dev_close, \
527 .info_get = hw_info_get, \
528 .dev_config_set = hw_dev_config_set, \
529 .dev_acquisition_start = hw_dev_acquisition_start_##ID_UPPER, \
530 .dev_acquisition_stop = hw_dev_acquisition_stop, \
534 DRV(digitek_dt4000zc, DIGITEK_DT4000ZC, "digitek-dt4000zc", "Digitek DT4000ZC")
535 DRV(tekpower_tp4000zc, TEKPOWER_TP4000ZC, "tekpower-tp4000zc", "TekPower TP4000ZC")
536 DRV(metex_me31, METEX_ME31, "metex-me31", "Metex ME-31")
537 DRV(peaktech_3410, PEAKTECH_3410, "peaktech-3410", "PeakTech 3410")
538 DRV(mastech_mas345, MASTECH_MAS345, "mastech-mas345", "MASTECH MAS345")
539 DRV(va_va18b, VA_VA18B, "va-va18b", "V&A VA18B")
540 DRV(metex_m3640d, METEX_M3640D, "metex-m3640d", "Metex M-3640D")
541 DRV(peaktech_4370, PEAKTECH_4370, "peaktech-4370", "PeakTech 4370")
542 DRV(pce_pce_dm32, PCE_PCE_DM32, "pce-pce-dm32", "PCE PCE-DM32")
543 DRV(radioshack_22_168, RADIOSHACK_22_168, "radioshack-22-168", "RadioShack 22-168")
544 DRV(radioshack_22_812, RADIOSHACK_22_812, "radioshack-22-812", "RadioShack 22-812")
545 DRV(voltcraft_vc820_ser, VOLTCRAFT_VC820_SER, "voltcraft-vc820-ser", "Voltcraft VC-820 (UT-D02 cable)")
546 DRV(voltcraft_vc840_ser, VOLTCRAFT_VC840_SER, "voltcraft-vc840-ser", "Voltcraft VC-840 (UT-D02 cable)")
547 DRV(uni_t_ut61e_ser, UNI_T_UT61E_SER, "uni-t-ut61e-ser", "UNI-T UT61E (UT-D02 cable)")