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;
59 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
61 static struct sr_dev_driver *di_dt4000zc = &digitek_dt4000zc_driver_info;
62 static struct sr_dev_driver *di_tp4000zc = &tekpower_tp4000zc_driver_info;
63 static struct sr_dev_driver *di_me31 = &metex_me31_driver_info;
64 static struct sr_dev_driver *di_3410 = &peaktech_3410_driver_info;
65 static struct sr_dev_driver *di_mas345 = &mastech_mas345_driver_info;
66 static struct sr_dev_driver *di_va18b = &va_va18b_driver_info;
67 static struct sr_dev_driver *di_m3640d = &metex_m3640d_driver_info;
68 static struct sr_dev_driver *di_4370 = &peaktech_4370_driver_info;
69 static struct sr_dev_driver *di_pce_dm32 = &pce_pce_dm32_driver_info;
70 static struct sr_dev_driver *di_22_168 = &radioshack_22_168_driver_info;
72 /* After hw_init() this will point to a device-specific entry (see above). */
73 static struct sr_dev_driver *di = NULL;
75 SR_PRIV struct dmm_info dmms[] = {
77 "Digitek", "DT4000ZC", "2400/8n1", 2400,
78 FS9721_PACKET_SIZE, NULL,
79 sr_fs9721_packet_valid, sr_fs9721_parse,
83 "TekPower", "TP4000ZC", "2400/8n1", 2400,
84 FS9721_PACKET_SIZE, NULL,
85 sr_fs9721_packet_valid, sr_fs9721_parse,
89 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
90 METEX14_PACKET_SIZE, sr_metex14_packet_request,
91 sr_metex14_packet_valid, sr_metex14_parse,
95 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
96 METEX14_PACKET_SIZE, sr_metex14_packet_request,
97 sr_metex14_packet_valid, sr_metex14_parse,
101 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
102 METEX14_PACKET_SIZE, sr_metex14_packet_request,
103 sr_metex14_packet_valid, sr_metex14_parse,
107 "V&A", "VA18B", "2400/8n1", 2400,
108 FS9721_PACKET_SIZE, NULL,
109 sr_fs9721_packet_valid, sr_fs9721_parse,
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,
119 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
120 METEX14_PACKET_SIZE, sr_metex14_packet_request,
121 sr_metex14_packet_valid, sr_metex14_parse,
125 "PCE", "PCE-DM32", "2400/8n1", 2400,
126 FS9721_PACKET_SIZE, NULL,
127 sr_fs9721_packet_valid, sr_fs9721_parse,
128 dmm_details_pce_dm32,
131 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
132 METEX14_PACKET_SIZE, sr_metex14_packet_request,
133 sr_metex14_packet_valid, sr_metex14_parse,
138 /* Properly close and free all devices. */
139 static int clear_instances(void)
141 struct sr_dev_inst *sdi;
142 struct drv_context *drvc;
143 struct dev_context *devc;
146 if (!(drvc = di->priv))
150 for (l = drvc->instances; l; l = l->next) {
151 if (!(sdi = l->data))
153 if (!(devc = sdi->priv))
155 sr_serial_dev_inst_free(devc->serial);
156 sr_dev_inst_free(sdi);
158 g_slist_free(drvc->instances);
159 drvc->instances = NULL;
164 static int hw_init(int dmm)
166 struct drv_context *drvc;
168 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
169 sr_err("Driver context malloc failed.");
170 return SR_ERR_MALLOC;
173 if (dmm == DIGITEK_DT4000ZC)
175 if (dmm == TEKPOWER_TP4000ZC)
177 if (dmm == METEX_ME31)
179 if (dmm == PEAKTECH_3410)
181 if (dmm == MASTECH_MAS345)
185 if (dmm == METEX_M3640D)
187 if (dmm == PEAKTECH_4370)
189 if (dmm == PCE_PCE_DM32)
191 if (dmm == RADIOSHACK_22_168)
193 sr_dbg("Selected '%s' subdriver.", di->name);
200 static int hw_init_digitek_dt4000zc(void)
202 return hw_init(DIGITEK_DT4000ZC);
205 static int hw_init_tekpower_tp4000zc(void)
207 return hw_init(TEKPOWER_TP4000ZC);
210 static int hw_init_metex_me31(void)
212 return hw_init(METEX_ME31);
215 static int hw_init_peaktech_3410(void)
217 return hw_init(PEAKTECH_3410);
220 static int hw_init_mastech_mas345(void)
222 return hw_init(MASTECH_MAS345);
225 static int hw_init_va_va18b(void)
227 return hw_init(VA_VA18B);
230 static int hw_init_metex_m3640d(void)
232 return hw_init(METEX_M3640D);
235 static int hw_init_peaktech_4370(void)
237 return hw_init(PEAKTECH_4370);
240 static int hw_init_pce_pce_dm32(void)
242 return hw_init(PCE_PCE_DM32);
245 static int hw_init_radioshack_22_168(void)
247 return hw_init(RADIOSHACK_22_168);
250 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
252 struct sr_dev_inst *sdi;
253 struct drv_context *drvc;
254 struct dev_context *devc;
255 struct sr_probe *probe;
256 struct sr_serial_dev_inst *serial;
262 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
265 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
268 sr_info("Probing port %s.", conn);
272 serial_flush(serial);
275 * There's no way to get an ID from the multimeter. It just sends data
276 * periodically, so the best we can do is check if the packets match
277 * the expected format.
280 /* Let's get a bit of data and see if we can find a packet. */
283 /* Request a packet if the DMM requires this. */
284 if (dmms[dmm].packet_request) {
285 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
286 sr_err("Failed to request packet: %d.", ret);
291 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
292 dmms[dmm].packet_valid, 1000,
298 * If we dropped more than two packets worth of data, something is
299 * wrong. We shouldn't quit however, since the dropped bytes might be
300 * just zeroes at the beginning of the stream. Those can occur as a
301 * combination of the nonstandard cable that ships with this device and
302 * the serial port or USB to serial adapter.
304 dropped = len - dmms[dmm].packet_size;
305 if (dropped > 2 * dmms[dmm].packet_size)
306 sr_warn("Had to drop too much data.");
308 sr_info("Found device on port %s.", conn);
310 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
311 dmms[dmm].device, "")))
314 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
315 sr_err("Device context malloc failed.");
319 devc->serial = serial;
323 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
325 sdi->probes = g_slist_append(sdi->probes, probe);
326 drvc->instances = g_slist_append(drvc->instances, sdi);
327 devices = g_slist_append(devices, sdi);
330 serial_close(serial);
335 static GSList *hw_scan(GSList *options)
337 struct sr_hwopt *opt;
339 const char *conn, *serialcomm;
342 conn = serialcomm = NULL;
343 for (l = options; l; l = l->next) {
345 switch (opt->hwopt) {
349 case SR_HWOPT_SERIALCOMM:
350 serialcomm = opt->value;
357 if (!strcmp(di->name, "digitek-dt4000zc"))
359 if (!strcmp(di->name, "tekpower-tp4000zc"))
361 if (!strcmp(di->name, "metex-me31"))
363 if (!strcmp(di->name, "peaktech-3410"))
365 if (!strcmp(di->name, "mastech-mas345"))
367 if (!strcmp(di->name, "va-va18b"))
369 if (!strcmp(di->name, "metex-m3640d"))
371 if (!strcmp(di->name, "peaktech-4370"))
373 if (!strcmp(di->name, "pce-pce-dm32"))
375 if (!strcmp(di->name, "radioshack-22-168"))
379 /* Use the provided comm specs. */
380 devices = scan(conn, serialcomm, dmm);
382 /* Try the default. */
383 devices = scan(conn, dmms[dmm].conn, dmm);
389 static GSList *hw_dev_list(void)
391 struct drv_context *drvc;
395 return drvc->instances;
398 static int hw_dev_open(struct sr_dev_inst *sdi)
400 struct dev_context *devc;
402 if (!(devc = sdi->priv)) {
403 sr_err("sdi->priv was NULL.");
407 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
410 sdi->status = SR_ST_ACTIVE;
415 static int hw_dev_close(struct sr_dev_inst *sdi)
417 struct dev_context *devc;
419 if (!(devc = sdi->priv)) {
420 sr_err("sdi->priv was NULL.");
424 if (devc->serial && devc->serial->fd != -1) {
425 serial_close(devc->serial);
426 sdi->status = SR_ST_INACTIVE;
432 static int hw_cleanup(void)
439 static int hw_info_get(int info_id, const void **data,
440 const struct sr_dev_inst *sdi)
451 case SR_DI_NUM_PROBES:
452 *data = GINT_TO_POINTER(1);
454 case SR_DI_PROBE_NAMES:
464 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
467 struct dev_context *devc;
469 if (sdi->status != SR_ST_ACTIVE)
472 if (!(devc = sdi->priv)) {
473 sr_err("sdi->priv was NULL.");
478 case SR_HWCAP_LIMIT_SAMPLES:
479 devc->limit_samples = *(const uint64_t *)value;
480 sr_dbg("Setting sample limit to %" PRIu64 ".",
481 devc->limit_samples);
484 sr_err("Unknown capability: %d.", hwcap);
492 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
495 struct sr_datafeed_packet packet;
496 struct sr_datafeed_header header;
497 struct sr_datafeed_meta_analog meta;
498 struct dev_context *devc;
499 int (*receive_data)(int, int, void *) = NULL;
501 if (!(devc = sdi->priv)) {
502 sr_err("sdi->priv was NULL.");
506 sr_dbg("Starting acquisition.");
508 devc->cb_data = cb_data;
511 * Reset the number of samples to take. If we've already collected our
512 * quota, but we start a new session, and don't reset this, we'll just
513 * quit without acquiring any new samples.
515 devc->num_samples = 0;
517 /* Send header packet to the session bus. */
518 sr_dbg("Sending SR_DF_HEADER.");
519 packet.type = SR_DF_HEADER;
520 packet.payload = (uint8_t *)&header;
521 header.feed_version = 1;
522 gettimeofday(&header.starttime, NULL);
523 sr_session_send(devc->cb_data, &packet);
525 /* Send metadata about the SR_DF_ANALOG packets to come. */
526 sr_dbg("Sending SR_DF_META_ANALOG.");
527 packet.type = SR_DF_META_ANALOG;
528 packet.payload = &meta;
530 sr_session_send(devc->cb_data, &packet);
532 if (!strcmp(di->name, "digitek-dt4000zc"))
533 receive_data = digitek_dt4000zc_receive_data;
534 if (!strcmp(di->name, "tekpower-tp4000zc"))
535 receive_data = tekpower_tp4000zc_receive_data;
536 if (!strcmp(di->name, "metex-me31"))
537 receive_data = metex_me31_receive_data;
538 if (!strcmp(di->name, "peaktech-3410"))
539 receive_data = peaktech_3410_receive_data;
540 if (!strcmp(di->name, "mastech-mas345"))
541 receive_data = mastech_mas345_receive_data;
542 if (!strcmp(di->name, "va-va18b"))
543 receive_data = va_va18b_receive_data;
544 if (!strcmp(di->name, "metex-m3640d"))
545 receive_data = metex_m3640d_receive_data;
546 if (!strcmp(di->name, "peaktech-4370"))
547 receive_data = peaktech_4370_receive_data;
548 if (!strcmp(di->name, "pce-pce-dm32"))
549 receive_data = pce_pce_dm32_receive_data;
550 if (!strcmp(di->name, "radioshack-22-168"))
551 receive_data = radioshack_22_168_receive_data;
553 /* Poll every 50ms, or whenever some data comes in. */
554 sr_source_add(devc->serial->fd, G_IO_IN, 50,
555 receive_data, (void *)sdi);
560 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
562 struct sr_datafeed_packet packet;
563 struct dev_context *devc;
565 if (sdi->status != SR_ST_ACTIVE)
568 if (!(devc = sdi->priv)) {
569 sr_err("sdi->priv was NULL.");
573 sr_dbg("Stopping acquisition.");
575 sr_source_remove(devc->serial->fd);
576 hw_dev_close((struct sr_dev_inst *)sdi);
578 /* Send end packet to the session bus. */
579 sr_dbg("Sending SR_DF_END.");
580 packet.type = SR_DF_END;
581 sr_session_send(cb_data, &packet);
586 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
587 .name = "digitek-dt4000zc",
588 .longname = "Digitek DT4000ZC",
590 .init = hw_init_digitek_dt4000zc,
591 .cleanup = hw_cleanup,
593 .dev_list = hw_dev_list,
594 .dev_clear = clear_instances,
595 .dev_open = hw_dev_open,
596 .dev_close = hw_dev_close,
597 .info_get = hw_info_get,
598 .dev_config_set = hw_dev_config_set,
599 .dev_acquisition_start = hw_dev_acquisition_start,
600 .dev_acquisition_stop = hw_dev_acquisition_stop,
604 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
605 .name = "tekpower-tp4000zc",
606 .longname = "TekPower TP4000ZC",
608 .init = hw_init_tekpower_tp4000zc,
609 .cleanup = hw_cleanup,
611 .dev_list = hw_dev_list,
612 .dev_clear = clear_instances,
613 .dev_open = hw_dev_open,
614 .dev_close = hw_dev_close,
615 .info_get = hw_info_get,
616 .dev_config_set = hw_dev_config_set,
617 .dev_acquisition_start = hw_dev_acquisition_start,
618 .dev_acquisition_stop = hw_dev_acquisition_stop,
622 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
623 .name = "metex-me31",
624 .longname = "Metex ME-31",
626 .init = hw_init_metex_me31,
627 .cleanup = hw_cleanup,
629 .dev_list = hw_dev_list,
630 .dev_clear = clear_instances,
631 .dev_open = hw_dev_open,
632 .dev_close = hw_dev_close,
633 .info_get = hw_info_get,
634 .dev_config_set = hw_dev_config_set,
635 .dev_acquisition_start = hw_dev_acquisition_start,
636 .dev_acquisition_stop = hw_dev_acquisition_stop,
640 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
641 .name = "peaktech-3410",
642 .longname = "PeakTech 3410",
644 .init = hw_init_peaktech_3410,
645 .cleanup = hw_cleanup,
647 .dev_list = hw_dev_list,
648 .dev_clear = clear_instances,
649 .dev_open = hw_dev_open,
650 .dev_close = hw_dev_close,
651 .info_get = hw_info_get,
652 .dev_config_set = hw_dev_config_set,
653 .dev_acquisition_start = hw_dev_acquisition_start,
654 .dev_acquisition_stop = hw_dev_acquisition_stop,
658 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
659 .name = "mastech-mas345",
660 .longname = "MASTECH MAS345",
662 .init = hw_init_mastech_mas345,
663 .cleanup = hw_cleanup,
665 .dev_list = hw_dev_list,
666 .dev_clear = clear_instances,
667 .dev_open = hw_dev_open,
668 .dev_close = hw_dev_close,
669 .info_get = hw_info_get,
670 .dev_config_set = hw_dev_config_set,
671 .dev_acquisition_start = hw_dev_acquisition_start,
672 .dev_acquisition_stop = hw_dev_acquisition_stop,
676 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
678 .longname = "V&A VA18B",
680 .init = hw_init_va_va18b,
681 .cleanup = hw_cleanup,
683 .dev_list = hw_dev_list,
684 .dev_clear = clear_instances,
685 .dev_open = hw_dev_open,
686 .dev_close = hw_dev_close,
687 .info_get = hw_info_get,
688 .dev_config_set = hw_dev_config_set,
689 .dev_acquisition_start = hw_dev_acquisition_start,
690 .dev_acquisition_stop = hw_dev_acquisition_stop,
694 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
695 .name = "metex-m3640d",
696 .longname = "Metex M-3640D",
698 .init = hw_init_metex_m3640d,
699 .cleanup = hw_cleanup,
701 .dev_list = hw_dev_list,
702 .dev_clear = clear_instances,
703 .dev_open = hw_dev_open,
704 .dev_close = hw_dev_close,
705 .info_get = hw_info_get,
706 .dev_config_set = hw_dev_config_set,
707 .dev_acquisition_start = hw_dev_acquisition_start,
708 .dev_acquisition_stop = hw_dev_acquisition_stop,
712 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
713 .name = "peaktech-4370",
714 .longname = "PeakTech 4370",
716 .init = hw_init_peaktech_4370,
717 .cleanup = hw_cleanup,
719 .dev_list = hw_dev_list,
720 .dev_clear = clear_instances,
721 .dev_open = hw_dev_open,
722 .dev_close = hw_dev_close,
723 .info_get = hw_info_get,
724 .dev_config_set = hw_dev_config_set,
725 .dev_acquisition_start = hw_dev_acquisition_start,
726 .dev_acquisition_stop = hw_dev_acquisition_stop,
730 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info = {
731 .name = "pce-pce-dm32",
732 .longname = "PCE PCE-DM32",
734 .init = hw_init_pce_pce_dm32,
735 .cleanup = hw_cleanup,
737 .dev_list = hw_dev_list,
738 .dev_clear = clear_instances,
739 .dev_open = hw_dev_open,
740 .dev_close = hw_dev_close,
741 .info_get = hw_info_get,
742 .dev_config_set = hw_dev_config_set,
743 .dev_acquisition_start = hw_dev_acquisition_start,
744 .dev_acquisition_stop = hw_dev_acquisition_stop,
748 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info = {
749 .name = "radioshack-22-168",
750 .longname = "RadioShack 22-168",
752 .init = hw_init_radioshack_22_168,
753 .cleanup = hw_cleanup,
755 .dev_list = hw_dev_list,
756 .dev_clear = clear_instances,
757 .dev_open = hw_dev_open,
758 .dev_close = hw_dev_close,
759 .info_get = hw_info_get,
760 .dev_config_set = hw_dev_config_set,
761 .dev_acquisition_start = hw_dev_acquisition_start,
762 .dev_acquisition_stop = hw_dev_acquisition_stop,