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(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);
210 static int hw_init_digitek_dt4000zc(void)
212 return hw_init(DIGITEK_DT4000ZC);
215 static int hw_init_tekpower_tp4000zc(void)
217 return hw_init(TEKPOWER_TP4000ZC);
220 static int hw_init_metex_me31(void)
222 return hw_init(METEX_ME31);
225 static int hw_init_peaktech_3410(void)
227 return hw_init(PEAKTECH_3410);
230 static int hw_init_mastech_mas345(void)
232 return hw_init(MASTECH_MAS345);
235 static int hw_init_va_va18b(void)
237 return hw_init(VA_VA18B);
240 static int hw_init_metex_m3640d(void)
242 return hw_init(METEX_M3640D);
245 static int hw_init_peaktech_4370(void)
247 return hw_init(PEAKTECH_4370);
250 static int hw_init_pce_pce_dm32(void)
252 return hw_init(PCE_PCE_DM32);
255 static int hw_init_radioshack_22_168(void)
257 return hw_init(RADIOSHACK_22_168);
260 static int hw_init_radioshack_22_812(void)
262 return hw_init(RADIOSHACK_22_812);
265 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
267 struct sr_dev_inst *sdi;
268 struct drv_context *drvc;
269 struct dev_context *devc;
270 struct sr_probe *probe;
271 struct sr_serial_dev_inst *serial;
277 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
280 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
283 sr_info("Probing port %s.", conn);
287 serial_flush(serial);
290 * There's no way to get an ID from the multimeter. It just sends data
291 * periodically, so the best we can do is check if the packets match
292 * the expected format.
295 /* Let's get a bit of data and see if we can find a packet. */
298 /* Request a packet if the DMM requires this. */
299 if (dmms[dmm].packet_request) {
300 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
301 sr_err("Failed to request packet: %d.", ret);
306 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
307 dmms[dmm].packet_valid, 1000,
313 * If we dropped more than two packets worth of data, something is
314 * wrong. We shouldn't quit however, since the dropped bytes might be
315 * just zeroes at the beginning of the stream. Those can occur as a
316 * combination of the nonstandard cable that ships with this device and
317 * the serial port or USB to serial adapter.
319 dropped = len - dmms[dmm].packet_size;
320 if (dropped > 2 * dmms[dmm].packet_size)
321 sr_warn("Had to drop too much data.");
323 sr_info("Found device on port %s.", conn);
325 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
326 dmms[dmm].device, "")))
329 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
330 sr_err("Device context malloc failed.");
334 devc->serial = serial;
338 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
340 sdi->probes = g_slist_append(sdi->probes, probe);
341 drvc->instances = g_slist_append(drvc->instances, sdi);
342 devices = g_slist_append(devices, sdi);
345 serial_close(serial);
350 static GSList *hw_scan(GSList *options)
352 struct sr_hwopt *opt;
354 const char *conn, *serialcomm;
357 conn = serialcomm = NULL;
358 for (l = options; l; l = l->next) {
360 switch (opt->hwopt) {
364 case SR_HWOPT_SERIALCOMM:
365 serialcomm = opt->value;
372 if (!strcmp(di->name, "digitek-dt4000zc"))
374 if (!strcmp(di->name, "tekpower-tp4000zc"))
376 if (!strcmp(di->name, "metex-me31"))
378 if (!strcmp(di->name, "peaktech-3410"))
380 if (!strcmp(di->name, "mastech-mas345"))
382 if (!strcmp(di->name, "va-va18b"))
384 if (!strcmp(di->name, "metex-m3640d"))
386 if (!strcmp(di->name, "peaktech-4370"))
388 if (!strcmp(di->name, "pce-pce-dm32"))
390 if (!strcmp(di->name, "radioshack-22-168"))
392 if (!strcmp(di->name, "radioshack-22-812"))
396 /* Use the provided comm specs. */
397 devices = scan(conn, serialcomm, dmm);
399 /* Try the default. */
400 devices = scan(conn, dmms[dmm].conn, dmm);
406 static GSList *hw_dev_list(void)
408 struct drv_context *drvc;
412 return drvc->instances;
415 static int hw_dev_open(struct sr_dev_inst *sdi)
417 struct dev_context *devc;
419 if (!(devc = sdi->priv)) {
420 sr_err("sdi->priv was NULL.");
424 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
427 sdi->status = SR_ST_ACTIVE;
432 static int hw_dev_close(struct sr_dev_inst *sdi)
434 struct dev_context *devc;
436 if (!(devc = sdi->priv)) {
437 sr_err("sdi->priv was NULL.");
441 if (devc->serial && devc->serial->fd != -1) {
442 serial_close(devc->serial);
443 sdi->status = SR_ST_INACTIVE;
449 static int hw_cleanup(void)
456 static int hw_info_get(int info_id, const void **data,
457 const struct sr_dev_inst *sdi)
468 case SR_DI_NUM_PROBES:
469 *data = GINT_TO_POINTER(1);
471 case SR_DI_PROBE_NAMES:
481 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
484 struct dev_context *devc;
486 if (sdi->status != SR_ST_ACTIVE)
489 if (!(devc = sdi->priv)) {
490 sr_err("sdi->priv was NULL.");
495 case SR_HWCAP_LIMIT_SAMPLES:
496 devc->limit_samples = *(const uint64_t *)value;
497 sr_dbg("Setting sample limit to %" PRIu64 ".",
498 devc->limit_samples);
501 sr_err("Unknown capability: %d.", hwcap);
509 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
512 struct sr_datafeed_packet packet;
513 struct sr_datafeed_header header;
514 struct sr_datafeed_meta_analog meta;
515 struct dev_context *devc;
516 int (*receive_data)(int, int, void *) = NULL;
518 if (!(devc = sdi->priv)) {
519 sr_err("sdi->priv was NULL.");
523 sr_dbg("Starting acquisition.");
525 devc->cb_data = cb_data;
528 * Reset the number of samples to take. If we've already collected our
529 * quota, but we start a new session, and don't reset this, we'll just
530 * quit without acquiring any new samples.
532 devc->num_samples = 0;
534 /* Send header packet to the session bus. */
535 sr_dbg("Sending SR_DF_HEADER.");
536 packet.type = SR_DF_HEADER;
537 packet.payload = (uint8_t *)&header;
538 header.feed_version = 1;
539 gettimeofday(&header.starttime, NULL);
540 sr_session_send(devc->cb_data, &packet);
542 /* Send metadata about the SR_DF_ANALOG packets to come. */
543 sr_dbg("Sending SR_DF_META_ANALOG.");
544 packet.type = SR_DF_META_ANALOG;
545 packet.payload = &meta;
547 sr_session_send(devc->cb_data, &packet);
549 if (!strcmp(di->name, "digitek-dt4000zc"))
550 receive_data = digitek_dt4000zc_receive_data;
551 if (!strcmp(di->name, "tekpower-tp4000zc"))
552 receive_data = tekpower_tp4000zc_receive_data;
553 if (!strcmp(di->name, "metex-me31"))
554 receive_data = metex_me31_receive_data;
555 if (!strcmp(di->name, "peaktech-3410"))
556 receive_data = peaktech_3410_receive_data;
557 if (!strcmp(di->name, "mastech-mas345"))
558 receive_data = mastech_mas345_receive_data;
559 if (!strcmp(di->name, "va-va18b"))
560 receive_data = va_va18b_receive_data;
561 if (!strcmp(di->name, "metex-m3640d"))
562 receive_data = metex_m3640d_receive_data;
563 if (!strcmp(di->name, "peaktech-4370"))
564 receive_data = peaktech_4370_receive_data;
565 if (!strcmp(di->name, "pce-pce-dm32"))
566 receive_data = pce_pce_dm32_receive_data;
567 if (!strcmp(di->name, "radioshack-22-168"))
568 receive_data = radioshack_22_168_receive_data;
569 if (!strcmp(di->name, "radioshack-22-812"))
570 receive_data = radioshack_22_812_receive_data;
572 /* Poll every 50ms, or whenever some data comes in. */
573 sr_source_add(devc->serial->fd, G_IO_IN, 50,
574 receive_data, (void *)sdi);
579 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
581 struct sr_datafeed_packet packet;
582 struct dev_context *devc;
584 if (sdi->status != SR_ST_ACTIVE)
587 if (!(devc = sdi->priv)) {
588 sr_err("sdi->priv was NULL.");
592 sr_dbg("Stopping acquisition.");
594 sr_source_remove(devc->serial->fd);
595 hw_dev_close((struct sr_dev_inst *)sdi);
597 /* Send end packet to the session bus. */
598 sr_dbg("Sending SR_DF_END.");
599 packet.type = SR_DF_END;
600 sr_session_send(cb_data, &packet);
605 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
606 .name = "digitek-dt4000zc",
607 .longname = "Digitek DT4000ZC",
609 .init = hw_init_digitek_dt4000zc,
610 .cleanup = hw_cleanup,
612 .dev_list = hw_dev_list,
613 .dev_clear = clear_instances,
614 .dev_open = hw_dev_open,
615 .dev_close = hw_dev_close,
616 .info_get = hw_info_get,
617 .dev_config_set = hw_dev_config_set,
618 .dev_acquisition_start = hw_dev_acquisition_start,
619 .dev_acquisition_stop = hw_dev_acquisition_stop,
623 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
624 .name = "tekpower-tp4000zc",
625 .longname = "TekPower TP4000ZC",
627 .init = hw_init_tekpower_tp4000zc,
628 .cleanup = hw_cleanup,
630 .dev_list = hw_dev_list,
631 .dev_clear = clear_instances,
632 .dev_open = hw_dev_open,
633 .dev_close = hw_dev_close,
634 .info_get = hw_info_get,
635 .dev_config_set = hw_dev_config_set,
636 .dev_acquisition_start = hw_dev_acquisition_start,
637 .dev_acquisition_stop = hw_dev_acquisition_stop,
641 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
642 .name = "metex-me31",
643 .longname = "Metex ME-31",
645 .init = hw_init_metex_me31,
646 .cleanup = hw_cleanup,
648 .dev_list = hw_dev_list,
649 .dev_clear = clear_instances,
650 .dev_open = hw_dev_open,
651 .dev_close = hw_dev_close,
652 .info_get = hw_info_get,
653 .dev_config_set = hw_dev_config_set,
654 .dev_acquisition_start = hw_dev_acquisition_start,
655 .dev_acquisition_stop = hw_dev_acquisition_stop,
659 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
660 .name = "peaktech-3410",
661 .longname = "PeakTech 3410",
663 .init = hw_init_peaktech_3410,
664 .cleanup = hw_cleanup,
666 .dev_list = hw_dev_list,
667 .dev_clear = clear_instances,
668 .dev_open = hw_dev_open,
669 .dev_close = hw_dev_close,
670 .info_get = hw_info_get,
671 .dev_config_set = hw_dev_config_set,
672 .dev_acquisition_start = hw_dev_acquisition_start,
673 .dev_acquisition_stop = hw_dev_acquisition_stop,
677 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
678 .name = "mastech-mas345",
679 .longname = "MASTECH MAS345",
681 .init = hw_init_mastech_mas345,
682 .cleanup = hw_cleanup,
684 .dev_list = hw_dev_list,
685 .dev_clear = clear_instances,
686 .dev_open = hw_dev_open,
687 .dev_close = hw_dev_close,
688 .info_get = hw_info_get,
689 .dev_config_set = hw_dev_config_set,
690 .dev_acquisition_start = hw_dev_acquisition_start,
691 .dev_acquisition_stop = hw_dev_acquisition_stop,
695 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
697 .longname = "V&A VA18B",
699 .init = hw_init_va_va18b,
700 .cleanup = hw_cleanup,
702 .dev_list = hw_dev_list,
703 .dev_clear = clear_instances,
704 .dev_open = hw_dev_open,
705 .dev_close = hw_dev_close,
706 .info_get = hw_info_get,
707 .dev_config_set = hw_dev_config_set,
708 .dev_acquisition_start = hw_dev_acquisition_start,
709 .dev_acquisition_stop = hw_dev_acquisition_stop,
713 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
714 .name = "metex-m3640d",
715 .longname = "Metex M-3640D",
717 .init = hw_init_metex_m3640d,
718 .cleanup = hw_cleanup,
720 .dev_list = hw_dev_list,
721 .dev_clear = clear_instances,
722 .dev_open = hw_dev_open,
723 .dev_close = hw_dev_close,
724 .info_get = hw_info_get,
725 .dev_config_set = hw_dev_config_set,
726 .dev_acquisition_start = hw_dev_acquisition_start,
727 .dev_acquisition_stop = hw_dev_acquisition_stop,
731 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
732 .name = "peaktech-4370",
733 .longname = "PeakTech 4370",
735 .init = hw_init_peaktech_4370,
736 .cleanup = hw_cleanup,
738 .dev_list = hw_dev_list,
739 .dev_clear = clear_instances,
740 .dev_open = hw_dev_open,
741 .dev_close = hw_dev_close,
742 .info_get = hw_info_get,
743 .dev_config_set = hw_dev_config_set,
744 .dev_acquisition_start = hw_dev_acquisition_start,
745 .dev_acquisition_stop = hw_dev_acquisition_stop,
749 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info = {
750 .name = "pce-pce-dm32",
751 .longname = "PCE PCE-DM32",
753 .init = hw_init_pce_pce_dm32,
754 .cleanup = hw_cleanup,
756 .dev_list = hw_dev_list,
757 .dev_clear = clear_instances,
758 .dev_open = hw_dev_open,
759 .dev_close = hw_dev_close,
760 .info_get = hw_info_get,
761 .dev_config_set = hw_dev_config_set,
762 .dev_acquisition_start = hw_dev_acquisition_start,
763 .dev_acquisition_stop = hw_dev_acquisition_stop,
767 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info = {
768 .name = "radioshack-22-168",
769 .longname = "RadioShack 22-168",
771 .init = hw_init_radioshack_22_168,
772 .cleanup = hw_cleanup,
774 .dev_list = hw_dev_list,
775 .dev_clear = clear_instances,
776 .dev_open = hw_dev_open,
777 .dev_close = hw_dev_close,
778 .info_get = hw_info_get,
779 .dev_config_set = hw_dev_config_set,
780 .dev_acquisition_start = hw_dev_acquisition_start,
781 .dev_acquisition_stop = hw_dev_acquisition_stop,
785 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info = {
786 .name = "radioshack-22-812",
787 .longname = "RadioShack 22-812",
789 .init = hw_init_radioshack_22_812,
790 .cleanup = hw_cleanup,
792 .dev_list = hw_dev_list,
793 .dev_clear = clear_instances,
794 .dev_open = hw_dev_open,
795 .dev_close = hw_dev_close,
796 .info_get = hw_info_get,
797 .dev_config_set = hw_dev_config_set,
798 .dev_acquisition_start = hw_dev_acquisition_start,
799 .dev_acquisition_stop = hw_dev_acquisition_stop,