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 /* di is not necessarily initialized */
158 if (!(drvc = di->priv))
162 for (l = drvc->instances; l; l = l->next) {
163 if (!(sdi = l->data))
165 if (!(devc = sdi->priv))
167 sr_serial_dev_inst_free(devc->serial);
168 sr_dev_inst_free(sdi);
170 g_slist_free(drvc->instances);
171 drvc->instances = NULL;
176 static int hw_init(struct sr_context *sr_ctx, int dmm)
178 struct drv_context *drvc;
180 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
181 sr_err("Driver context malloc failed.");
182 return SR_ERR_MALLOC;
185 if (dmm == DIGITEK_DT4000ZC)
187 if (dmm == TEKPOWER_TP4000ZC)
189 if (dmm == METEX_ME31)
191 if (dmm == PEAKTECH_3410)
193 if (dmm == MASTECH_MAS345)
197 if (dmm == METEX_M3640D)
199 if (dmm == PEAKTECH_4370)
201 if (dmm == PCE_PCE_DM32)
203 if (dmm == RADIOSHACK_22_168)
205 if (dmm == RADIOSHACK_22_812)
207 sr_dbg("Selected '%s' subdriver.", di->name);
209 drvc->sr_ctx = sr_ctx;
215 static int hw_init_digitek_dt4000zc(struct sr_context *sr_ctx)
217 return hw_init(sr_ctx, DIGITEK_DT4000ZC);
220 static int hw_init_tekpower_tp4000zc(struct sr_context *sr_ctx)
222 return hw_init(sr_ctx, TEKPOWER_TP4000ZC);
225 static int hw_init_metex_me31(struct sr_context *sr_ctx)
227 return hw_init(sr_ctx, METEX_ME31);
230 static int hw_init_peaktech_3410(struct sr_context *sr_ctx)
232 return hw_init(sr_ctx, PEAKTECH_3410);
235 static int hw_init_mastech_mas345(struct sr_context *sr_ctx)
237 return hw_init(sr_ctx, MASTECH_MAS345);
240 static int hw_init_va_va18b(struct sr_context *sr_ctx)
242 return hw_init(sr_ctx, VA_VA18B);
245 static int hw_init_metex_m3640d(struct sr_context *sr_ctx)
247 return hw_init(sr_ctx, METEX_M3640D);
250 static int hw_init_peaktech_4370(struct sr_context *sr_ctx)
252 return hw_init(sr_ctx, PEAKTECH_4370);
255 static int hw_init_pce_pce_dm32(struct sr_context *sr_ctx)
257 return hw_init(sr_ctx, PCE_PCE_DM32);
260 static int hw_init_radioshack_22_168(struct sr_context *sr_ctx)
262 return hw_init(sr_ctx, RADIOSHACK_22_168);
265 static int hw_init_radioshack_22_812(struct sr_context *sr_ctx)
267 return hw_init(sr_ctx, RADIOSHACK_22_812);
270 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
272 struct sr_dev_inst *sdi;
273 struct drv_context *drvc;
274 struct dev_context *devc;
275 struct sr_probe *probe;
276 struct sr_serial_dev_inst *serial;
282 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
285 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
288 sr_info("Probing port %s.", conn);
292 serial_flush(serial);
295 * There's no way to get an ID from the multimeter. It just sends data
296 * periodically, so the best we can do is check if the packets match
297 * the expected format.
300 /* Let's get a bit of data and see if we can find a packet. */
303 /* Request a packet if the DMM requires this. */
304 if (dmms[dmm].packet_request) {
305 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
306 sr_err("Failed to request packet: %d.", ret);
311 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
312 dmms[dmm].packet_valid, 1000,
318 * If we dropped more than two packets worth of data, something is
319 * wrong. We shouldn't quit however, since the dropped bytes might be
320 * just zeroes at the beginning of the stream. Those can occur as a
321 * combination of the nonstandard cable that ships with this device and
322 * the serial port or USB to serial adapter.
324 dropped = len - dmms[dmm].packet_size;
325 if (dropped > 2 * dmms[dmm].packet_size)
326 sr_warn("Had to drop too much data.");
328 sr_info("Found device on port %s.", conn);
330 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
331 dmms[dmm].device, "")))
334 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
335 sr_err("Device context malloc failed.");
339 devc->serial = serial;
343 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
345 sdi->probes = g_slist_append(sdi->probes, probe);
346 drvc->instances = g_slist_append(drvc->instances, sdi);
347 devices = g_slist_append(devices, sdi);
350 serial_close(serial);
355 static GSList *hw_scan(GSList *options)
357 struct sr_hwopt *opt;
359 const char *conn, *serialcomm;
362 conn = serialcomm = NULL;
363 for (l = options; l; l = l->next) {
365 switch (opt->hwopt) {
369 case SR_HWOPT_SERIALCOMM:
370 serialcomm = opt->value;
377 if (!strcmp(di->name, "digitek-dt4000zc"))
379 if (!strcmp(di->name, "tekpower-tp4000zc"))
381 if (!strcmp(di->name, "metex-me31"))
383 if (!strcmp(di->name, "peaktech-3410"))
385 if (!strcmp(di->name, "mastech-mas345"))
387 if (!strcmp(di->name, "va-va18b"))
389 if (!strcmp(di->name, "metex-m3640d"))
391 if (!strcmp(di->name, "peaktech-4370"))
393 if (!strcmp(di->name, "pce-pce-dm32"))
395 if (!strcmp(di->name, "radioshack-22-168"))
397 if (!strcmp(di->name, "radioshack-22-812"))
401 /* Use the provided comm specs. */
402 devices = scan(conn, serialcomm, dmm);
404 /* Try the default. */
405 devices = scan(conn, dmms[dmm].conn, dmm);
411 static GSList *hw_dev_list(void)
413 struct drv_context *drvc;
417 return drvc->instances;
420 static int hw_dev_open(struct sr_dev_inst *sdi)
422 struct dev_context *devc;
424 if (!(devc = sdi->priv)) {
425 sr_err("sdi->priv was NULL.");
429 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
432 sdi->status = SR_ST_ACTIVE;
437 static int hw_dev_close(struct sr_dev_inst *sdi)
439 struct dev_context *devc;
441 if (!(devc = sdi->priv)) {
442 sr_err("sdi->priv was NULL.");
446 if (devc->serial && devc->serial->fd != -1) {
447 serial_close(devc->serial);
448 sdi->status = SR_ST_INACTIVE;
454 static int hw_cleanup(void)
461 static int hw_info_get(int info_id, const void **data,
462 const struct sr_dev_inst *sdi)
473 case SR_DI_NUM_PROBES:
474 *data = GINT_TO_POINTER(1);
476 case SR_DI_PROBE_NAMES:
486 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
489 struct dev_context *devc;
491 if (sdi->status != SR_ST_ACTIVE)
494 if (!(devc = sdi->priv)) {
495 sr_err("sdi->priv was NULL.");
500 case SR_HWCAP_LIMIT_SAMPLES:
501 devc->limit_samples = *(const uint64_t *)value;
502 sr_dbg("Setting sample limit to %" PRIu64 ".",
503 devc->limit_samples);
506 sr_err("Unknown capability: %d.", hwcap);
514 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
517 struct sr_datafeed_packet packet;
518 struct sr_datafeed_header header;
519 struct sr_datafeed_meta_analog meta;
520 struct dev_context *devc;
521 int (*receive_data)(int, int, void *) = NULL;
523 if (!(devc = sdi->priv)) {
524 sr_err("sdi->priv was NULL.");
528 sr_dbg("Starting acquisition.");
530 devc->cb_data = cb_data;
533 * Reset the number of samples to take. If we've already collected our
534 * quota, but we start a new session, and don't reset this, we'll just
535 * quit without acquiring any new samples.
537 devc->num_samples = 0;
539 /* Send header packet to the session bus. */
540 sr_dbg("Sending SR_DF_HEADER.");
541 packet.type = SR_DF_HEADER;
542 packet.payload = (uint8_t *)&header;
543 header.feed_version = 1;
544 gettimeofday(&header.starttime, NULL);
545 sr_session_send(devc->cb_data, &packet);
547 /* Send metadata about the SR_DF_ANALOG packets to come. */
548 sr_dbg("Sending SR_DF_META_ANALOG.");
549 packet.type = SR_DF_META_ANALOG;
550 packet.payload = &meta;
552 sr_session_send(devc->cb_data, &packet);
554 if (!strcmp(di->name, "digitek-dt4000zc"))
555 receive_data = digitek_dt4000zc_receive_data;
556 if (!strcmp(di->name, "tekpower-tp4000zc"))
557 receive_data = tekpower_tp4000zc_receive_data;
558 if (!strcmp(di->name, "metex-me31"))
559 receive_data = metex_me31_receive_data;
560 if (!strcmp(di->name, "peaktech-3410"))
561 receive_data = peaktech_3410_receive_data;
562 if (!strcmp(di->name, "mastech-mas345"))
563 receive_data = mastech_mas345_receive_data;
564 if (!strcmp(di->name, "va-va18b"))
565 receive_data = va_va18b_receive_data;
566 if (!strcmp(di->name, "metex-m3640d"))
567 receive_data = metex_m3640d_receive_data;
568 if (!strcmp(di->name, "peaktech-4370"))
569 receive_data = peaktech_4370_receive_data;
570 if (!strcmp(di->name, "pce-pce-dm32"))
571 receive_data = pce_pce_dm32_receive_data;
572 if (!strcmp(di->name, "radioshack-22-168"))
573 receive_data = radioshack_22_168_receive_data;
574 if (!strcmp(di->name, "radioshack-22-812"))
575 receive_data = radioshack_22_812_receive_data;
577 /* Poll every 50ms, or whenever some data comes in. */
578 sr_source_add(devc->serial->fd, G_IO_IN, 50,
579 receive_data, (void *)sdi);
584 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
586 struct sr_datafeed_packet packet;
587 struct dev_context *devc;
589 if (sdi->status != SR_ST_ACTIVE)
592 if (!(devc = sdi->priv)) {
593 sr_err("sdi->priv was NULL.");
597 sr_dbg("Stopping acquisition.");
599 sr_source_remove(devc->serial->fd);
600 hw_dev_close((struct sr_dev_inst *)sdi);
602 /* Send end packet to the session bus. */
603 sr_dbg("Sending SR_DF_END.");
604 packet.type = SR_DF_END;
605 sr_session_send(cb_data, &packet);
610 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
611 .name = "digitek-dt4000zc",
612 .longname = "Digitek DT4000ZC",
614 .init = hw_init_digitek_dt4000zc,
615 .cleanup = hw_cleanup,
617 .dev_list = hw_dev_list,
618 .dev_clear = clear_instances,
619 .dev_open = hw_dev_open,
620 .dev_close = hw_dev_close,
621 .info_get = hw_info_get,
622 .dev_config_set = hw_dev_config_set,
623 .dev_acquisition_start = hw_dev_acquisition_start,
624 .dev_acquisition_stop = hw_dev_acquisition_stop,
628 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
629 .name = "tekpower-tp4000zc",
630 .longname = "TekPower TP4000ZC",
632 .init = hw_init_tekpower_tp4000zc,
633 .cleanup = hw_cleanup,
635 .dev_list = hw_dev_list,
636 .dev_clear = clear_instances,
637 .dev_open = hw_dev_open,
638 .dev_close = hw_dev_close,
639 .info_get = hw_info_get,
640 .dev_config_set = hw_dev_config_set,
641 .dev_acquisition_start = hw_dev_acquisition_start,
642 .dev_acquisition_stop = hw_dev_acquisition_stop,
646 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
647 .name = "metex-me31",
648 .longname = "Metex ME-31",
650 .init = hw_init_metex_me31,
651 .cleanup = hw_cleanup,
653 .dev_list = hw_dev_list,
654 .dev_clear = clear_instances,
655 .dev_open = hw_dev_open,
656 .dev_close = hw_dev_close,
657 .info_get = hw_info_get,
658 .dev_config_set = hw_dev_config_set,
659 .dev_acquisition_start = hw_dev_acquisition_start,
660 .dev_acquisition_stop = hw_dev_acquisition_stop,
664 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
665 .name = "peaktech-3410",
666 .longname = "PeakTech 3410",
668 .init = hw_init_peaktech_3410,
669 .cleanup = hw_cleanup,
671 .dev_list = hw_dev_list,
672 .dev_clear = clear_instances,
673 .dev_open = hw_dev_open,
674 .dev_close = hw_dev_close,
675 .info_get = hw_info_get,
676 .dev_config_set = hw_dev_config_set,
677 .dev_acquisition_start = hw_dev_acquisition_start,
678 .dev_acquisition_stop = hw_dev_acquisition_stop,
682 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
683 .name = "mastech-mas345",
684 .longname = "MASTECH MAS345",
686 .init = hw_init_mastech_mas345,
687 .cleanup = hw_cleanup,
689 .dev_list = hw_dev_list,
690 .dev_clear = clear_instances,
691 .dev_open = hw_dev_open,
692 .dev_close = hw_dev_close,
693 .info_get = hw_info_get,
694 .dev_config_set = hw_dev_config_set,
695 .dev_acquisition_start = hw_dev_acquisition_start,
696 .dev_acquisition_stop = hw_dev_acquisition_stop,
700 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
702 .longname = "V&A VA18B",
704 .init = hw_init_va_va18b,
705 .cleanup = hw_cleanup,
707 .dev_list = hw_dev_list,
708 .dev_clear = clear_instances,
709 .dev_open = hw_dev_open,
710 .dev_close = hw_dev_close,
711 .info_get = hw_info_get,
712 .dev_config_set = hw_dev_config_set,
713 .dev_acquisition_start = hw_dev_acquisition_start,
714 .dev_acquisition_stop = hw_dev_acquisition_stop,
718 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
719 .name = "metex-m3640d",
720 .longname = "Metex M-3640D",
722 .init = hw_init_metex_m3640d,
723 .cleanup = hw_cleanup,
725 .dev_list = hw_dev_list,
726 .dev_clear = clear_instances,
727 .dev_open = hw_dev_open,
728 .dev_close = hw_dev_close,
729 .info_get = hw_info_get,
730 .dev_config_set = hw_dev_config_set,
731 .dev_acquisition_start = hw_dev_acquisition_start,
732 .dev_acquisition_stop = hw_dev_acquisition_stop,
736 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
737 .name = "peaktech-4370",
738 .longname = "PeakTech 4370",
740 .init = hw_init_peaktech_4370,
741 .cleanup = hw_cleanup,
743 .dev_list = hw_dev_list,
744 .dev_clear = clear_instances,
745 .dev_open = hw_dev_open,
746 .dev_close = hw_dev_close,
747 .info_get = hw_info_get,
748 .dev_config_set = hw_dev_config_set,
749 .dev_acquisition_start = hw_dev_acquisition_start,
750 .dev_acquisition_stop = hw_dev_acquisition_stop,
754 SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info = {
755 .name = "pce-pce-dm32",
756 .longname = "PCE PCE-DM32",
758 .init = hw_init_pce_pce_dm32,
759 .cleanup = hw_cleanup,
761 .dev_list = hw_dev_list,
762 .dev_clear = clear_instances,
763 .dev_open = hw_dev_open,
764 .dev_close = hw_dev_close,
765 .info_get = hw_info_get,
766 .dev_config_set = hw_dev_config_set,
767 .dev_acquisition_start = hw_dev_acquisition_start,
768 .dev_acquisition_stop = hw_dev_acquisition_stop,
772 SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info = {
773 .name = "radioshack-22-168",
774 .longname = "RadioShack 22-168",
776 .init = hw_init_radioshack_22_168,
777 .cleanup = hw_cleanup,
779 .dev_list = hw_dev_list,
780 .dev_clear = clear_instances,
781 .dev_open = hw_dev_open,
782 .dev_close = hw_dev_close,
783 .info_get = hw_info_get,
784 .dev_config_set = hw_dev_config_set,
785 .dev_acquisition_start = hw_dev_acquisition_start,
786 .dev_acquisition_stop = hw_dev_acquisition_stop,
790 SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info = {
791 .name = "radioshack-22-812",
792 .longname = "RadioShack 22-812",
794 .init = hw_init_radioshack_22_812,
795 .cleanup = hw_cleanup,
797 .dev_list = hw_dev_list,
798 .dev_clear = clear_instances,
799 .dev_open = hw_dev_open,
800 .dev_close = hw_dev_close,
801 .info_get = hw_info_get,
802 .dev_config_set = hw_dev_config_set,
803 .dev_acquisition_start = hw_dev_acquisition_start,
804 .dev_acquisition_stop = hw_dev_acquisition_stop,