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;
60 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
62 static struct sr_dev_driver *di_dt4000zc = &digitek_dt4000zc_driver_info;
63 static struct sr_dev_driver *di_tp4000zc = &tekpower_tp4000zc_driver_info;
64 static struct sr_dev_driver *di_me31 = &metex_me31_driver_info;
65 static struct sr_dev_driver *di_3410 = &peaktech_3410_driver_info;
66 static struct sr_dev_driver *di_mas345 = &mastech_mas345_driver_info;
67 static struct sr_dev_driver *di_va18b = &va_va18b_driver_info;
68 static struct sr_dev_driver *di_m3640d = &metex_m3640d_driver_info;
69 static struct sr_dev_driver *di_4370 = &peaktech_4370_driver_info;
70 static struct sr_dev_driver *di_pce_dm32 = &pce_pce_dm32_driver_info;
71 static struct sr_dev_driver *di_22_168 = &radioshack_22_168_driver_info;
72 static struct sr_dev_driver *di_22_812 = &radioshack_22_812_driver_info;
74 /* After hw_init() this will point to a device-specific entry (see above). */
75 static struct sr_dev_driver *di = NULL;
77 SR_PRIV struct dmm_info dmms[] = {
79 "Digitek", "DT4000ZC", "2400/8n1", 2400,
80 FS9721_PACKET_SIZE, NULL,
81 sr_fs9721_packet_valid, sr_fs9721_parse,
85 "TekPower", "TP4000ZC", "2400/8n1", 2400,
86 FS9721_PACKET_SIZE, NULL,
87 sr_fs9721_packet_valid, sr_fs9721_parse,
91 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
92 METEX14_PACKET_SIZE, sr_metex14_packet_request,
93 sr_metex14_packet_valid, sr_metex14_parse,
97 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
98 METEX14_PACKET_SIZE, sr_metex14_packet_request,
99 sr_metex14_packet_valid, sr_metex14_parse,
103 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
104 METEX14_PACKET_SIZE, sr_metex14_packet_request,
105 sr_metex14_packet_valid, sr_metex14_parse,
109 "V&A", "VA18B", "2400/8n1", 2400,
110 FS9721_PACKET_SIZE, NULL,
111 sr_fs9721_packet_valid, sr_fs9721_parse,
115 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
116 METEX14_PACKET_SIZE, sr_metex14_packet_request,
117 sr_metex14_packet_valid, sr_metex14_parse,
121 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
122 METEX14_PACKET_SIZE, sr_metex14_packet_request,
123 sr_metex14_packet_valid, sr_metex14_parse,
127 "PCE", "PCE-DM32", "2400/8n1", 2400,
128 FS9721_PACKET_SIZE, NULL,
129 sr_fs9721_packet_valid, sr_fs9721_parse,
130 dmm_details_pce_dm32,
133 "RadioShack", "22-168", "1200/7n2/rts=0/dtr=1", 1200,
134 METEX14_PACKET_SIZE, sr_metex14_packet_request,
135 sr_metex14_packet_valid, sr_metex14_parse,
139 "RadioShack", "22-812", "4800/8n1/rts=0/dtr=1", 4800,
140 RS9LCD_PACKET_SIZE, NULL,
141 sr_rs9lcd_packet_valid, sr_rs9lcd_parse,
146 /* Properly close and free all devices. */
147 static int clear_instances(void)
149 struct sr_dev_inst *sdi;
150 struct drv_context *drvc;
151 struct dev_context *devc;
154 if (!(drvc = di->priv))
158 for (l = drvc->instances; l; l = l->next) {
159 if (!(sdi = l->data))
161 if (!(devc = sdi->priv))
163 sr_serial_dev_inst_free(devc->serial);
164 sr_dev_inst_free(sdi);
166 g_slist_free(drvc->instances);
167 drvc->instances = NULL;
172 static int hw_init(struct sr_context *sr_ctx, int dmm)
174 struct drv_context *drvc;
176 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
177 sr_err("Driver context malloc failed.");
178 return SR_ERR_MALLOC;
181 if (dmm == DIGITEK_DT4000ZC)
183 if (dmm == TEKPOWER_TP4000ZC)
185 if (dmm == METEX_ME31)
187 if (dmm == PEAKTECH_3410)
189 if (dmm == MASTECH_MAS345)
193 if (dmm == METEX_M3640D)
195 if (dmm == PEAKTECH_4370)
197 if (dmm == PCE_PCE_DM32)
199 if (dmm == RADIOSHACK_22_168)
201 if (dmm == RADIOSHACK_22_812)
203 sr_dbg("Selected '%s' subdriver.", di->name);
205 drvc->sr_ctx = sr_ctx;
211 static int hw_init_digitek_dt4000zc(struct sr_context *sr_ctx)
213 return hw_init(sr_ctx, DIGITEK_DT4000ZC);
216 static int hw_init_tekpower_tp4000zc(struct sr_context *sr_ctx)
218 return hw_init(sr_ctx, TEKPOWER_TP4000ZC);
221 static int hw_init_metex_me31(struct sr_context *sr_ctx)
223 return hw_init(sr_ctx, METEX_ME31);
226 static int hw_init_peaktech_3410(struct sr_context *sr_ctx)
228 return hw_init(sr_ctx, PEAKTECH_3410);
231 static int hw_init_mastech_mas345(struct sr_context *sr_ctx)
233 return hw_init(sr_ctx, MASTECH_MAS345);
236 static int hw_init_va_va18b(struct sr_context *sr_ctx)
238 return hw_init(sr_ctx, VA_VA18B);
241 static int hw_init_metex_m3640d(struct sr_context *sr_ctx)
243 return hw_init(sr_ctx, METEX_M3640D);
246 static int hw_init_peaktech_4370(struct sr_context *sr_ctx)
248 return hw_init(sr_ctx, PEAKTECH_4370);
251 static int hw_init_pce_pce_dm32(struct sr_context *sr_ctx)
253 return hw_init(sr_ctx, PCE_PCE_DM32);
256 static int hw_init_radioshack_22_168(struct sr_context *sr_ctx)
258 return hw_init(sr_ctx, RADIOSHACK_22_168);
261 static int hw_init_radioshack_22_812(struct sr_context *sr_ctx)
263 return hw_init(sr_ctx, RADIOSHACK_22_812);
266 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
268 struct sr_dev_inst *sdi;
269 struct drv_context *drvc;
270 struct dev_context *devc;
271 struct sr_probe *probe;
272 struct sr_serial_dev_inst *serial;
278 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
281 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
284 sr_info("Probing port %s.", conn);
288 serial_flush(serial);
291 * There's no way to get an ID from the multimeter. It just sends data
292 * periodically, so the best we can do is check if the packets match
293 * the expected format.
296 /* Let's get a bit of data and see if we can find a packet. */
299 /* Request a packet if the DMM requires this. */
300 if (dmms[dmm].packet_request) {
301 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
302 sr_err("Failed to request packet: %d.", ret);
307 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
308 dmms[dmm].packet_valid, 1000,
314 * If we dropped more than two packets worth of data, something is
315 * wrong. We shouldn't quit however, since the dropped bytes might be
316 * just zeroes at the beginning of the stream. Those can occur as a
317 * combination of the nonstandard cable that ships with this device and
318 * the serial port or USB to serial adapter.
320 dropped = len - dmms[dmm].packet_size;
321 if (dropped > 2 * dmms[dmm].packet_size)
322 sr_warn("Had to drop too much data.");
324 sr_info("Found device on port %s.", conn);
326 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
327 dmms[dmm].device, "")))
330 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
331 sr_err("Device context malloc failed.");
335 devc->serial = serial;
339 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
341 sdi->probes = g_slist_append(sdi->probes, probe);
342 drvc->instances = g_slist_append(drvc->instances, sdi);
343 devices = g_slist_append(devices, sdi);
346 serial_close(serial);
351 static GSList *hw_scan(GSList *options)
353 struct sr_hwopt *opt;
355 const char *conn, *serialcomm;
358 conn = serialcomm = NULL;
359 for (l = options; l; l = l->next) {
361 switch (opt->hwopt) {
365 case SR_HWOPT_SERIALCOMM:
366 serialcomm = opt->value;
373 if (!strcmp(di->name, "digitek-dt4000zc"))
375 if (!strcmp(di->name, "tekpower-tp4000zc"))
377 if (!strcmp(di->name, "metex-me31"))
379 if (!strcmp(di->name, "peaktech-3410"))
381 if (!strcmp(di->name, "mastech-mas345"))
383 if (!strcmp(di->name, "va-va18b"))
385 if (!strcmp(di->name, "metex-m3640d"))
387 if (!strcmp(di->name, "peaktech-4370"))
389 if (!strcmp(di->name, "pce-pce-dm32"))
391 if (!strcmp(di->name, "radioshack-22-168"))
393 if (!strcmp(di->name, "radioshack-22-812"))
397 /* Use the provided comm specs. */
398 devices = scan(conn, serialcomm, dmm);
400 /* Try the default. */
401 devices = scan(conn, dmms[dmm].conn, dmm);
407 static GSList *hw_dev_list(void)
409 struct drv_context *drvc;
413 return drvc->instances;
416 static int hw_dev_open(struct sr_dev_inst *sdi)
418 struct dev_context *devc;
420 if (!(devc = sdi->priv)) {
421 sr_err("sdi->priv was NULL.");
425 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
428 sdi->status = SR_ST_ACTIVE;
433 static int hw_dev_close(struct sr_dev_inst *sdi)
435 struct dev_context *devc;
437 if (!(devc = sdi->priv)) {
438 sr_err("sdi->priv was NULL.");
442 if (devc->serial && devc->serial->fd != -1) {
443 serial_close(devc->serial);
444 sdi->status = SR_ST_INACTIVE;
450 static int hw_cleanup(void)
457 static int hw_info_get(int info_id, const void **data,
458 const struct sr_dev_inst *sdi)
469 case SR_DI_NUM_PROBES:
470 *data = GINT_TO_POINTER(1);
472 case SR_DI_PROBE_NAMES:
482 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
485 struct dev_context *devc;
487 if (sdi->status != SR_ST_ACTIVE)
490 if (!(devc = sdi->priv)) {
491 sr_err("sdi->priv was NULL.");
496 case SR_HWCAP_LIMIT_SAMPLES:
497 devc->limit_samples = *(const uint64_t *)value;
498 sr_dbg("Setting sample limit to %" PRIu64 ".",
499 devc->limit_samples);
502 sr_err("Unknown capability: %d.", hwcap);
510 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
513 struct sr_datafeed_packet packet;
514 struct sr_datafeed_header header;
515 struct sr_datafeed_meta_analog meta;
516 struct dev_context *devc;
517 int (*receive_data)(int, int, void *) = NULL;
519 if (!(devc = sdi->priv)) {
520 sr_err("sdi->priv was NULL.");
524 sr_dbg("Starting acquisition.");
526 devc->cb_data = cb_data;
529 * Reset the number of samples to take. If we've already collected our
530 * quota, but we start a new session, and don't reset this, we'll just
531 * quit without acquiring any new samples.
533 devc->num_samples = 0;
535 /* Send header packet to the session bus. */
536 sr_dbg("Sending SR_DF_HEADER.");
537 packet.type = SR_DF_HEADER;
538 packet.payload = (uint8_t *)&header;
539 header.feed_version = 1;
540 gettimeofday(&header.starttime, NULL);
541 sr_session_send(devc->cb_data, &packet);
543 /* Send metadata about the SR_DF_ANALOG packets to come. */
544 sr_dbg("Sending SR_DF_META_ANALOG.");
545 packet.type = SR_DF_META_ANALOG;
546 packet.payload = &meta;
548 sr_session_send(devc->cb_data, &packet);
550 if (!strcmp(di->name, "digitek-dt4000zc"))
551 receive_data = digitek_dt4000zc_receive_data;
552 if (!strcmp(di->name, "tekpower-tp4000zc"))
553 receive_data = tekpower_tp4000zc_receive_data;
554 if (!strcmp(di->name, "metex-me31"))
555 receive_data = metex_me31_receive_data;
556 if (!strcmp(di->name, "peaktech-3410"))
557 receive_data = peaktech_3410_receive_data;
558 if (!strcmp(di->name, "mastech-mas345"))
559 receive_data = mastech_mas345_receive_data;
560 if (!strcmp(di->name, "va-va18b"))
561 receive_data = va_va18b_receive_data;
562 if (!strcmp(di->name, "metex-m3640d"))
563 receive_data = metex_m3640d_receive_data;
564 if (!strcmp(di->name, "peaktech-4370"))
565 receive_data = peaktech_4370_receive_data;
566 if (!strcmp(di->name, "pce-pce-dm32"))
567 receive_data = pce_pce_dm32_receive_data;
568 if (!strcmp(di->name, "radioshack-22-168"))
569 receive_data = radioshack_22_168_receive_data;
570 if (!strcmp(di->name, "radioshack-22-812"))
571 receive_data = radioshack_22_812_receive_data;
573 /* Poll every 50ms, or whenever some data comes in. */
574 sr_source_add(devc->serial->fd, G_IO_IN, 50,
575 receive_data, (void *)sdi);
580 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
582 struct sr_datafeed_packet packet;
583 struct dev_context *devc;
585 if (sdi->status != SR_ST_ACTIVE)
588 if (!(devc = sdi->priv)) {
589 sr_err("sdi->priv was NULL.");
593 sr_dbg("Stopping acquisition.");
595 sr_source_remove(devc->serial->fd);
596 hw_dev_close((struct sr_dev_inst *)sdi);
598 /* Send end packet to the session bus. */
599 sr_dbg("Sending SR_DF_END.");
600 packet.type = SR_DF_END;
601 sr_session_send(cb_data, &packet);
606 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
607 .name = "digitek-dt4000zc",
608 .longname = "Digitek DT4000ZC",
610 .init = hw_init_digitek_dt4000zc,
611 .cleanup = hw_cleanup,
613 .dev_list = hw_dev_list,
614 .dev_clear = clear_instances,
615 .dev_open = hw_dev_open,
616 .dev_close = hw_dev_close,
617 .info_get = hw_info_get,
618 .dev_config_set = hw_dev_config_set,
619 .dev_acquisition_start = hw_dev_acquisition_start,
620 .dev_acquisition_stop = hw_dev_acquisition_stop,
624 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
625 .name = "tekpower-tp4000zc",
626 .longname = "TekPower TP4000ZC",
628 .init = hw_init_tekpower_tp4000zc,
629 .cleanup = hw_cleanup,
631 .dev_list = hw_dev_list,
632 .dev_clear = clear_instances,
633 .dev_open = hw_dev_open,
634 .dev_close = hw_dev_close,
635 .info_get = hw_info_get,
636 .dev_config_set = hw_dev_config_set,
637 .dev_acquisition_start = hw_dev_acquisition_start,
638 .dev_acquisition_stop = hw_dev_acquisition_stop,
642 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
643 .name = "metex-me31",
644 .longname = "Metex ME-31",
646 .init = hw_init_metex_me31,
647 .cleanup = hw_cleanup,
649 .dev_list = hw_dev_list,
650 .dev_clear = clear_instances,
651 .dev_open = hw_dev_open,
652 .dev_close = hw_dev_close,
653 .info_get = hw_info_get,
654 .dev_config_set = hw_dev_config_set,
655 .dev_acquisition_start = hw_dev_acquisition_start,
656 .dev_acquisition_stop = hw_dev_acquisition_stop,
660 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
661 .name = "peaktech-3410",
662 .longname = "PeakTech 3410",
664 .init = hw_init_peaktech_3410,
665 .cleanup = hw_cleanup,
667 .dev_list = hw_dev_list,
668 .dev_clear = clear_instances,
669 .dev_open = hw_dev_open,
670 .dev_close = hw_dev_close,
671 .info_get = hw_info_get,
672 .dev_config_set = hw_dev_config_set,
673 .dev_acquisition_start = hw_dev_acquisition_start,
674 .dev_acquisition_stop = hw_dev_acquisition_stop,
678 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
679 .name = "mastech-mas345",
680 .longname = "MASTECH MAS345",
682 .init = hw_init_mastech_mas345,
683 .cleanup = hw_cleanup,
685 .dev_list = hw_dev_list,
686 .dev_clear = clear_instances,
687 .dev_open = hw_dev_open,
688 .dev_close = hw_dev_close,
689 .info_get = hw_info_get,
690 .dev_config_set = hw_dev_config_set,
691 .dev_acquisition_start = hw_dev_acquisition_start,
692 .dev_acquisition_stop = hw_dev_acquisition_stop,
696 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
698 .longname = "V&A VA18B",
700 .init = hw_init_va_va18b,
701 .cleanup = hw_cleanup,
703 .dev_list = hw_dev_list,
704 .dev_clear = clear_instances,
705 .dev_open = hw_dev_open,
706 .dev_close = hw_dev_close,
707 .info_get = hw_info_get,
708 .dev_config_set = hw_dev_config_set,
709 .dev_acquisition_start = hw_dev_acquisition_start,
710 .dev_acquisition_stop = hw_dev_acquisition_stop,
714 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
715 .name = "metex-m3640d",
716 .longname = "Metex M-3640D",
718 .init = hw_init_metex_m3640d,
719 .cleanup = hw_cleanup,
721 .dev_list = hw_dev_list,
722 .dev_clear = clear_instances,
723 .dev_open = hw_dev_open,
724 .dev_close = hw_dev_close,
725 .info_get = hw_info_get,
726 .dev_config_set = hw_dev_config_set,
727 .dev_acquisition_start = hw_dev_acquisition_start,
728 .dev_acquisition_stop = hw_dev_acquisition_stop,
732 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
733 .name = "peaktech-4370",
734 .longname = "PeakTech 4370",
736 .init = hw_init_peaktech_4370,
737 .cleanup = hw_cleanup,
739 .dev_list = hw_dev_list,
740 .dev_clear = clear_instances,
741 .dev_open = hw_dev_open,
742 .dev_close = hw_dev_close,
743 .info_get = hw_info_get,
744 .dev_config_set = hw_dev_config_set,
745 .dev_acquisition_start = hw_dev_acquisition_start,
746 .dev_acquisition_stop = hw_dev_acquisition_stop,
750 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info = {
751 .name = "pce-pce-dm32",
752 .longname = "PCE PCE-DM32",
754 .init = hw_init_pce_pce_dm32,
755 .cleanup = hw_cleanup,
757 .dev_list = hw_dev_list,
758 .dev_clear = clear_instances,
759 .dev_open = hw_dev_open,
760 .dev_close = hw_dev_close,
761 .info_get = hw_info_get,
762 .dev_config_set = hw_dev_config_set,
763 .dev_acquisition_start = hw_dev_acquisition_start,
764 .dev_acquisition_stop = hw_dev_acquisition_stop,
768 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info = {
769 .name = "radioshack-22-168",
770 .longname = "RadioShack 22-168",
772 .init = hw_init_radioshack_22_168,
773 .cleanup = hw_cleanup,
775 .dev_list = hw_dev_list,
776 .dev_clear = clear_instances,
777 .dev_open = hw_dev_open,
778 .dev_close = hw_dev_close,
779 .info_get = hw_info_get,
780 .dev_config_set = hw_dev_config_set,
781 .dev_acquisition_start = hw_dev_acquisition_start,
782 .dev_acquisition_stop = hw_dev_acquisition_stop,
786 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info = {
787 .name = "radioshack-22-812",
788 .longname = "RadioShack 22-812",
790 .init = hw_init_radioshack_22_812,
791 .cleanup = hw_cleanup,
793 .dev_list = hw_dev_list,
794 .dev_clear = clear_instances,
795 .dev_open = hw_dev_open,
796 .dev_close = hw_dev_close,
797 .info_get = hw_info_get,
798 .dev_config_set = hw_dev_config_set,
799 .dev_acquisition_start = hw_dev_acquisition_start,
800 .dev_acquisition_stop = hw_dev_acquisition_stop,