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/>.
23 #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,
45 static const char *probe_names[] = {
50 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
51 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
52 SR_PRIV struct sr_dev_driver metex_me31_driver_info;
53 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
54 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
55 SR_PRIV struct sr_dev_driver va_va18b_driver_info;
56 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
57 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
58 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
60 static struct sr_dev_driver *di_dt4000zc = &digitek_dt4000zc_driver_info;
61 static struct sr_dev_driver *di_tp4000zc = &tekpower_tp4000zc_driver_info;
62 static struct sr_dev_driver *di_me31 = &metex_me31_driver_info;
63 static struct sr_dev_driver *di_3410 = &peaktech_3410_driver_info;
64 static struct sr_dev_driver *di_mas345 = &mastech_mas345_driver_info;
65 static struct sr_dev_driver *di_va18b = &va_va18b_driver_info;
66 static struct sr_dev_driver *di_m3640d = &metex_m3640d_driver_info;
67 static struct sr_dev_driver *di_4370 = &peaktech_4370_driver_info;
68 static struct sr_dev_driver *di_pce_dm32 = &pce_pce_dm32_driver_info;
70 /* After hw_init() this will point to a device-specific entry (see above). */
71 static struct sr_dev_driver *di = NULL;
73 SR_PRIV struct dmm_info dmms[] = {
75 "Digitek", "DT4000ZC", "2400/8n1", 2400,
76 FS9721_PACKET_SIZE, NULL,
77 sr_fs9721_packet_valid, sr_fs9721_parse,
81 "TekPower", "TP4000ZC", "2400/8n1", 2400,
82 FS9721_PACKET_SIZE, NULL,
83 sr_fs9721_packet_valid, sr_fs9721_parse,
87 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
88 METEX14_PACKET_SIZE, sr_metex14_packet_request,
89 sr_metex14_packet_valid, sr_metex14_parse,
93 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
94 METEX14_PACKET_SIZE, sr_metex14_packet_request,
95 sr_metex14_packet_valid, sr_metex14_parse,
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,
105 "V&A", "VA18B", "2400/8n1", 2400,
106 FS9721_PACKET_SIZE, NULL,
107 sr_fs9721_packet_valid, sr_fs9721_parse,
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,
117 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
118 METEX14_PACKET_SIZE, sr_metex14_packet_request,
119 sr_metex14_packet_valid, sr_metex14_parse,
123 "PCE", "PCE-DM32", "2400/8n1", 2400,
124 FS9721_PACKET_SIZE, NULL,
125 sr_fs9721_packet_valid, sr_fs9721_parse,
126 dmm_details_pce_dm32,
130 /* Properly close and free all devices. */
131 static int clear_instances(void)
133 struct sr_dev_inst *sdi;
134 struct drv_context *drvc;
135 struct dev_context *devc;
138 if (!(drvc = di->priv))
142 for (l = drvc->instances; l; l = l->next) {
143 if (!(sdi = l->data))
145 if (!(devc = sdi->priv))
147 sr_serial_dev_inst_free(devc->serial);
148 sr_dev_inst_free(sdi);
150 g_slist_free(drvc->instances);
151 drvc->instances = NULL;
156 static int hw_init(int dmm)
158 struct drv_context *drvc;
160 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
161 sr_err("Driver context malloc failed.");
162 return SR_ERR_MALLOC;
165 if (dmm == DIGITEK_DT4000ZC)
167 if (dmm == TEKPOWER_TP4000ZC)
169 if (dmm == METEX_ME31)
171 if (dmm == PEAKTECH_3410)
173 if (dmm == MASTECH_MAS345)
177 if (dmm == METEX_M3640D)
179 if (dmm == PEAKTECH_4370)
181 if (dmm == PCE_PCE_DM32)
183 sr_dbg("Selected '%s' subdriver.", di->name);
190 static int hw_init_digitek_dt4000zc(void)
192 return hw_init(DIGITEK_DT4000ZC);
195 static int hw_init_tekpower_tp4000zc(void)
197 return hw_init(TEKPOWER_TP4000ZC);
200 static int hw_init_metex_me31(void)
202 return hw_init(METEX_ME31);
205 static int hw_init_peaktech_3410(void)
207 return hw_init(PEAKTECH_3410);
210 static int hw_init_mastech_mas345(void)
212 return hw_init(MASTECH_MAS345);
215 static int hw_init_va_va18b(void)
217 return hw_init(VA_VA18B);
220 static int hw_init_metex_m3640d(void)
222 return hw_init(METEX_M3640D);
225 static int hw_init_peaktech_4370(void)
227 return hw_init(PEAKTECH_4370);
230 static int hw_init_pce_pce_dm32(void)
232 return hw_init(PCE_PCE_DM32);
235 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
237 struct sr_dev_inst *sdi;
238 struct drv_context *drvc;
239 struct dev_context *devc;
240 struct sr_probe *probe;
241 struct sr_serial_dev_inst *serial;
247 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
250 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
253 sr_info("Probing port %s.", conn);
257 serial_flush(serial);
260 * There's no way to get an ID from the multimeter. It just sends data
261 * periodically, so the best we can do is check if the packets match
262 * the expected format.
265 /* Let's get a bit of data and see if we can find a packet. */
268 /* Request a packet if the DMM requires this. */
269 if (dmms[dmm].packet_request) {
270 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
271 sr_err("Failed to request packet: %d.", ret);
276 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
277 dmms[dmm].packet_valid, 1000,
283 * If we dropped more than two packets worth of data, something is
284 * wrong. We shouldn't quit however, since the dropped bytes might be
285 * just zeroes at the beginning of the stream. Those can occur as a
286 * combination of the nonstandard cable that ships with this device and
287 * the serial port or USB to serial adapter.
289 dropped = len - dmms[dmm].packet_size;
290 if (dropped > 2 * dmms[dmm].packet_size)
291 sr_warn("Had to drop too much data.");
293 sr_info("Found device on port %s.", conn);
295 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
296 dmms[dmm].device, "")))
299 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
300 sr_err("Device context malloc failed.");
304 devc->serial = serial;
308 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
310 sdi->probes = g_slist_append(sdi->probes, probe);
311 drvc->instances = g_slist_append(drvc->instances, sdi);
312 devices = g_slist_append(devices, sdi);
315 serial_close(serial);
320 static GSList *hw_scan(GSList *options)
322 struct sr_hwopt *opt;
324 const char *conn, *serialcomm;
327 conn = serialcomm = NULL;
328 for (l = options; l; l = l->next) {
330 switch (opt->hwopt) {
334 case SR_HWOPT_SERIALCOMM:
335 serialcomm = opt->value;
342 if (!strcmp(di->name, "digitek-dt4000zc"))
344 if (!strcmp(di->name, "tekpower-tp4000zc"))
346 if (!strcmp(di->name, "metex-me31"))
348 if (!strcmp(di->name, "peaktech-3410"))
350 if (!strcmp(di->name, "mastech-mas345"))
352 if (!strcmp(di->name, "va-va18b"))
354 if (!strcmp(di->name, "metex-m3640d"))
356 if (!strcmp(di->name, "peaktech-4370"))
358 if (!strcmp(di->name, "pce-pce-dm32"))
362 /* Use the provided comm specs. */
363 devices = scan(conn, serialcomm, dmm);
365 /* Try the default. */
366 devices = scan(conn, dmms[dmm].conn, dmm);
372 static GSList *hw_dev_list(void)
374 struct drv_context *drvc;
378 return drvc->instances;
381 static int hw_dev_open(struct sr_dev_inst *sdi)
383 struct dev_context *devc;
385 if (!(devc = sdi->priv)) {
386 sr_err("sdi->priv was NULL.");
390 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
393 sdi->status = SR_ST_ACTIVE;
398 static int hw_dev_close(struct sr_dev_inst *sdi)
400 struct dev_context *devc;
402 if (!(devc = sdi->priv)) {
403 sr_err("sdi->priv was NULL.");
407 if (devc->serial && devc->serial->fd != -1) {
408 serial_close(devc->serial);
409 sdi->status = SR_ST_INACTIVE;
415 static int hw_cleanup(void)
422 static int hw_info_get(int info_id, const void **data,
423 const struct sr_dev_inst *sdi)
434 case SR_DI_NUM_PROBES:
435 *data = GINT_TO_POINTER(1);
437 case SR_DI_PROBE_NAMES:
447 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
450 struct dev_context *devc;
452 if (sdi->status != SR_ST_ACTIVE)
455 if (!(devc = sdi->priv)) {
456 sr_err("sdi->priv was NULL.");
461 case SR_HWCAP_LIMIT_SAMPLES:
462 devc->limit_samples = *(const uint64_t *)value;
463 sr_dbg("Setting sample limit to %" PRIu64 ".",
464 devc->limit_samples);
467 sr_err("Unknown capability: %d.", hwcap);
475 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
478 struct sr_datafeed_packet packet;
479 struct sr_datafeed_header header;
480 struct sr_datafeed_meta_analog meta;
481 struct dev_context *devc;
482 int (*receive_data)(int, int, void *) = NULL;
484 if (!(devc = sdi->priv)) {
485 sr_err("sdi->priv was NULL.");
489 sr_dbg("Starting acquisition.");
491 devc->cb_data = cb_data;
494 * Reset the number of samples to take. If we've already collected our
495 * quota, but we start a new session, and don't reset this, we'll just
496 * quit without acquiring any new samples.
498 devc->num_samples = 0;
500 /* Send header packet to the session bus. */
501 sr_dbg("Sending SR_DF_HEADER.");
502 packet.type = SR_DF_HEADER;
503 packet.payload = (uint8_t *)&header;
504 header.feed_version = 1;
505 gettimeofday(&header.starttime, NULL);
506 sr_session_send(devc->cb_data, &packet);
508 /* Send metadata about the SR_DF_ANALOG packets to come. */
509 sr_dbg("Sending SR_DF_META_ANALOG.");
510 packet.type = SR_DF_META_ANALOG;
511 packet.payload = &meta;
513 sr_session_send(devc->cb_data, &packet);
515 if (!strcmp(di->name, "digitek-dt4000zc"))
516 receive_data = digitek_dt4000zc_receive_data;
517 if (!strcmp(di->name, "tekpower-tp4000zc"))
518 receive_data = tekpower_tp4000zc_receive_data;
519 if (!strcmp(di->name, "metex-me31"))
520 receive_data = metex_me31_receive_data;
521 if (!strcmp(di->name, "peaktech-3410"))
522 receive_data = peaktech_3410_receive_data;
523 if (!strcmp(di->name, "mastech-mas345"))
524 receive_data = mastech_mas345_receive_data;
525 if (!strcmp(di->name, "va-va18b"))
526 receive_data = va_va18b_receive_data;
527 if (!strcmp(di->name, "metex-m3640d"))
528 receive_data = metex_m3640d_receive_data;
529 if (!strcmp(di->name, "peaktech-4370"))
530 receive_data = peaktech_4370_receive_data;
531 if (!strcmp(di->name, "pce-pce-dm32"))
532 receive_data = pce_pce_dm32_receive_data;
534 /* Poll every 50ms, or whenever some data comes in. */
535 sr_source_add(devc->serial->fd, G_IO_IN, 50,
536 receive_data, (void *)sdi);
541 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
543 struct sr_datafeed_packet packet;
544 struct dev_context *devc;
546 if (sdi->status != SR_ST_ACTIVE)
549 if (!(devc = sdi->priv)) {
550 sr_err("sdi->priv was NULL.");
554 sr_dbg("Stopping acquisition.");
556 sr_source_remove(devc->serial->fd);
557 hw_dev_close((struct sr_dev_inst *)sdi);
559 /* Send end packet to the session bus. */
560 sr_dbg("Sending SR_DF_END.");
561 packet.type = SR_DF_END;
562 sr_session_send(cb_data, &packet);
567 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
568 .name = "digitek-dt4000zc",
569 .longname = "Digitek DT4000ZC",
571 .init = hw_init_digitek_dt4000zc,
572 .cleanup = hw_cleanup,
574 .dev_list = hw_dev_list,
575 .dev_clear = clear_instances,
576 .dev_open = hw_dev_open,
577 .dev_close = hw_dev_close,
578 .info_get = hw_info_get,
579 .dev_config_set = hw_dev_config_set,
580 .dev_acquisition_start = hw_dev_acquisition_start,
581 .dev_acquisition_stop = hw_dev_acquisition_stop,
585 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
586 .name = "tekpower-tp4000zc",
587 .longname = "TekPower TP4000ZC",
589 .init = hw_init_tekpower_tp4000zc,
590 .cleanup = hw_cleanup,
592 .dev_list = hw_dev_list,
593 .dev_clear = clear_instances,
594 .dev_open = hw_dev_open,
595 .dev_close = hw_dev_close,
596 .info_get = hw_info_get,
597 .dev_config_set = hw_dev_config_set,
598 .dev_acquisition_start = hw_dev_acquisition_start,
599 .dev_acquisition_stop = hw_dev_acquisition_stop,
603 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
604 .name = "metex-me31",
605 .longname = "Metex ME-31",
607 .init = hw_init_metex_me31,
608 .cleanup = hw_cleanup,
610 .dev_list = hw_dev_list,
611 .dev_clear = clear_instances,
612 .dev_open = hw_dev_open,
613 .dev_close = hw_dev_close,
614 .info_get = hw_info_get,
615 .dev_config_set = hw_dev_config_set,
616 .dev_acquisition_start = hw_dev_acquisition_start,
617 .dev_acquisition_stop = hw_dev_acquisition_stop,
621 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
622 .name = "peaktech-3410",
623 .longname = "PeakTech 3410",
625 .init = hw_init_peaktech_3410,
626 .cleanup = hw_cleanup,
628 .dev_list = hw_dev_list,
629 .dev_clear = clear_instances,
630 .dev_open = hw_dev_open,
631 .dev_close = hw_dev_close,
632 .info_get = hw_info_get,
633 .dev_config_set = hw_dev_config_set,
634 .dev_acquisition_start = hw_dev_acquisition_start,
635 .dev_acquisition_stop = hw_dev_acquisition_stop,
639 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
640 .name = "mastech-mas345",
641 .longname = "MASTECH MAS345",
643 .init = hw_init_mastech_mas345,
644 .cleanup = hw_cleanup,
646 .dev_list = hw_dev_list,
647 .dev_clear = clear_instances,
648 .dev_open = hw_dev_open,
649 .dev_close = hw_dev_close,
650 .info_get = hw_info_get,
651 .dev_config_set = hw_dev_config_set,
652 .dev_acquisition_start = hw_dev_acquisition_start,
653 .dev_acquisition_stop = hw_dev_acquisition_stop,
657 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
659 .longname = "V&A VA18B",
661 .init = hw_init_va_va18b,
662 .cleanup = hw_cleanup,
664 .dev_list = hw_dev_list,
665 .dev_clear = clear_instances,
666 .dev_open = hw_dev_open,
667 .dev_close = hw_dev_close,
668 .info_get = hw_info_get,
669 .dev_config_set = hw_dev_config_set,
670 .dev_acquisition_start = hw_dev_acquisition_start,
671 .dev_acquisition_stop = hw_dev_acquisition_stop,
675 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
676 .name = "metex-m3640d",
677 .longname = "Metex M-3640D",
679 .init = hw_init_metex_m3640d,
680 .cleanup = hw_cleanup,
682 .dev_list = hw_dev_list,
683 .dev_clear = clear_instances,
684 .dev_open = hw_dev_open,
685 .dev_close = hw_dev_close,
686 .info_get = hw_info_get,
687 .dev_config_set = hw_dev_config_set,
688 .dev_acquisition_start = hw_dev_acquisition_start,
689 .dev_acquisition_stop = hw_dev_acquisition_stop,
693 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
694 .name = "peaktech-4370",
695 .longname = "PeakTech 4370",
697 .init = hw_init_peaktech_4370,
698 .cleanup = hw_cleanup,
700 .dev_list = hw_dev_list,
701 .dev_clear = clear_instances,
702 .dev_open = hw_dev_open,
703 .dev_close = hw_dev_close,
704 .info_get = hw_info_get,
705 .dev_config_set = hw_dev_config_set,
706 .dev_acquisition_start = hw_dev_acquisition_start,
707 .dev_acquisition_stop = hw_dev_acquisition_stop,
711 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info = {
712 .name = "pce-pce-dm32",
713 .longname = "PCE PCE-DM32",
715 .init = hw_init_pce_pce_dm32,
716 .cleanup = hw_cleanup,
718 .dev_list = hw_dev_list,
719 .dev_clear = clear_instances,
720 .dev_open = hw_dev_open,
721 .dev_close = hw_dev_close,
722 .info_get = hw_info_get,
723 .dev_config_set = hw_dev_config_set,
724 .dev_acquisition_start = hw_dev_acquisition_start,
725 .dev_acquisition_stop = hw_dev_acquisition_stop,