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;
59 static struct sr_dev_driver *di_dt4000zc = &digitek_dt4000zc_driver_info;
60 static struct sr_dev_driver *di_tp4000zc = &tekpower_tp4000zc_driver_info;
61 static struct sr_dev_driver *di_me31 = &metex_me31_driver_info;
62 static struct sr_dev_driver *di_3410 = &peaktech_3410_driver_info;
63 static struct sr_dev_driver *di_mas345 = &mastech_mas345_driver_info;
64 static struct sr_dev_driver *di_va18b = &va_va18b_driver_info;
65 static struct sr_dev_driver *di_m3640d = &metex_m3640d_driver_info;
66 static struct sr_dev_driver *di_4370 = &peaktech_4370_driver_info;
68 /* After hw_init() this will point to a device-specific entry (see above). */
69 static struct sr_dev_driver *di = NULL;
71 SR_PRIV struct dmm_info dmms[] = {
73 "Digitek", "DT4000ZC", "2400/8n1", 2400,
74 FS9721_PACKET_SIZE, NULL,
75 sr_fs9721_packet_valid, sr_fs9721_parse,
79 "TekPower", "TP4000ZC", "2400/8n1", 2400,
80 FS9721_PACKET_SIZE, NULL,
81 sr_fs9721_packet_valid, sr_fs9721_parse,
85 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
86 METEX14_PACKET_SIZE, sr_metex14_packet_request,
87 sr_metex14_packet_valid, sr_metex14_parse,
91 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
92 METEX14_PACKET_SIZE, sr_metex14_packet_request,
93 sr_metex14_packet_valid, sr_metex14_parse,
97 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
98 METEX14_PACKET_SIZE, sr_metex14_packet_request,
99 sr_metex14_packet_valid, sr_metex14_parse,
103 "V&A", "VA18B", "2400/8n1", 2400,
104 FS9721_PACKET_SIZE, NULL,
105 sr_fs9721_packet_valid, sr_fs9721_parse,
109 "Metex", "M-3640D", "1200/7n2/rts=0/dtr=1", 1200,
110 METEX14_PACKET_SIZE, sr_metex14_packet_request,
111 sr_metex14_packet_valid, sr_metex14_parse,
115 "PeakTech", "4370", "1200/7n2/rts=0/dtr=1", 1200,
116 METEX14_PACKET_SIZE, sr_metex14_packet_request,
117 sr_metex14_packet_valid, sr_metex14_parse,
122 /* Properly close and free all devices. */
123 static int clear_instances(void)
125 struct sr_dev_inst *sdi;
126 struct drv_context *drvc;
127 struct dev_context *devc;
130 if (!(drvc = di->priv))
134 for (l = drvc->instances; l; l = l->next) {
135 if (!(sdi = l->data))
137 if (!(devc = sdi->priv))
139 sr_serial_dev_inst_free(devc->serial);
140 sr_dev_inst_free(sdi);
142 g_slist_free(drvc->instances);
143 drvc->instances = NULL;
148 static int hw_init(int dmm)
150 struct drv_context *drvc;
152 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
153 sr_err("Driver context malloc failed.");
154 return SR_ERR_MALLOC;
157 if (dmm == DIGITEK_DT4000ZC)
159 if (dmm == TEKPOWER_TP4000ZC)
161 if (dmm == METEX_ME31)
163 if (dmm == PEAKTECH_3410)
165 if (dmm == MASTECH_MAS345)
169 if (dmm == METEX_M3640D)
171 if (dmm == PEAKTECH_4370)
173 sr_dbg("Selected '%s' subdriver.", di->name);
180 static int hw_init_digitek_dt4000zc(void)
182 return hw_init(DIGITEK_DT4000ZC);
185 static int hw_init_tekpower_tp4000zc(void)
187 return hw_init(TEKPOWER_TP4000ZC);
190 static int hw_init_metex_me31(void)
192 return hw_init(METEX_ME31);
195 static int hw_init_peaktech_3410(void)
197 return hw_init(PEAKTECH_3410);
200 static int hw_init_mastech_mas345(void)
202 return hw_init(MASTECH_MAS345);
205 static int hw_init_va_va18b(void)
207 return hw_init(VA_VA18B);
210 static int hw_init_metex_m3640d(void)
212 return hw_init(METEX_M3640D);
215 static int hw_init_peaktech_4370(void)
217 return hw_init(PEAKTECH_4370);
220 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
222 struct sr_dev_inst *sdi;
223 struct drv_context *drvc;
224 struct dev_context *devc;
225 struct sr_probe *probe;
226 struct sr_serial_dev_inst *serial;
232 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
235 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
238 sr_info("Probing port %s.", conn);
242 serial_flush(serial);
245 * There's no way to get an ID from the multimeter. It just sends data
246 * periodically, so the best we can do is check if the packets match
247 * the expected format.
250 /* Let's get a bit of data and see if we can find a packet. */
253 /* Request a packet if the DMM requires this. */
254 if (dmms[dmm].packet_request) {
255 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
256 sr_err("Failed to request packet: %d.", ret);
261 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
262 dmms[dmm].packet_valid, 1000,
268 * If we dropped more than two packets worth of data, something is
269 * wrong. We shouldn't quit however, since the dropped bytes might be
270 * just zeroes at the beginning of the stream. Those can occur as a
271 * combination of the nonstandard cable that ships with this device and
272 * the serial port or USB to serial adapter.
274 dropped = len - dmms[dmm].packet_size;
275 if (dropped > 2 * dmms[dmm].packet_size)
276 sr_warn("Had to drop too much data.");
278 sr_info("Found device on port %s.", conn);
280 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
281 dmms[dmm].device, "")))
284 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
285 sr_err("Device context malloc failed.");
289 devc->serial = serial;
293 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
295 sdi->probes = g_slist_append(sdi->probes, probe);
296 drvc->instances = g_slist_append(drvc->instances, sdi);
297 devices = g_slist_append(devices, sdi);
300 serial_close(serial);
305 static GSList *hw_scan(GSList *options)
307 struct sr_hwopt *opt;
309 const char *conn, *serialcomm;
312 conn = serialcomm = NULL;
313 for (l = options; l; l = l->next) {
315 switch (opt->hwopt) {
319 case SR_HWOPT_SERIALCOMM:
320 serialcomm = opt->value;
327 if (!strcmp(di->name, "digitek-dt4000zc"))
329 if (!strcmp(di->name, "tekpower-tp4000zc"))
331 if (!strcmp(di->name, "metex-me31"))
333 if (!strcmp(di->name, "peaktech-3410"))
335 if (!strcmp(di->name, "mastech-mas345"))
337 if (!strcmp(di->name, "va-va18b"))
339 if (!strcmp(di->name, "metex-m3640d"))
341 if (!strcmp(di->name, "peaktech-4370"))
345 /* Use the provided comm specs. */
346 devices = scan(conn, serialcomm, dmm);
348 /* Try the default. */
349 devices = scan(conn, dmms[dmm].conn, dmm);
355 static GSList *hw_dev_list(void)
357 struct drv_context *drvc;
361 return drvc->instances;
364 static int hw_dev_open(struct sr_dev_inst *sdi)
366 struct dev_context *devc;
368 if (!(devc = sdi->priv)) {
369 sr_err("sdi->priv was NULL.");
373 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
376 sdi->status = SR_ST_ACTIVE;
381 static int hw_dev_close(struct sr_dev_inst *sdi)
383 struct dev_context *devc;
385 if (!(devc = sdi->priv)) {
386 sr_err("sdi->priv was NULL.");
390 if (devc->serial && devc->serial->fd != -1) {
391 serial_close(devc->serial);
392 sdi->status = SR_ST_INACTIVE;
398 static int hw_cleanup(void)
405 static int hw_info_get(int info_id, const void **data,
406 const struct sr_dev_inst *sdi)
417 case SR_DI_NUM_PROBES:
418 *data = GINT_TO_POINTER(1);
420 case SR_DI_PROBE_NAMES:
430 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
433 struct dev_context *devc;
435 if (sdi->status != SR_ST_ACTIVE)
438 if (!(devc = sdi->priv)) {
439 sr_err("sdi->priv was NULL.");
444 case SR_HWCAP_LIMIT_SAMPLES:
445 devc->limit_samples = *(const uint64_t *)value;
446 sr_dbg("Setting sample limit to %" PRIu64 ".",
447 devc->limit_samples);
450 sr_err("Unknown capability: %d.", hwcap);
458 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
461 struct sr_datafeed_packet packet;
462 struct sr_datafeed_header header;
463 struct sr_datafeed_meta_analog meta;
464 struct dev_context *devc;
465 int (*receive_data)(int, int, void *) = NULL;
467 if (!(devc = sdi->priv)) {
468 sr_err("sdi->priv was NULL.");
472 sr_dbg("Starting acquisition.");
474 devc->cb_data = cb_data;
477 * Reset the number of samples to take. If we've already collected our
478 * quota, but we start a new session, and don't reset this, we'll just
479 * quit without acquiring any new samples.
481 devc->num_samples = 0;
483 /* Send header packet to the session bus. */
484 sr_dbg("Sending SR_DF_HEADER.");
485 packet.type = SR_DF_HEADER;
486 packet.payload = (uint8_t *)&header;
487 header.feed_version = 1;
488 gettimeofday(&header.starttime, NULL);
489 sr_session_send(devc->cb_data, &packet);
491 /* Send metadata about the SR_DF_ANALOG packets to come. */
492 sr_dbg("Sending SR_DF_META_ANALOG.");
493 packet.type = SR_DF_META_ANALOG;
494 packet.payload = &meta;
496 sr_session_send(devc->cb_data, &packet);
498 if (!strcmp(di->name, "digitek-dt4000zc"))
499 receive_data = digitek_dt4000zc_receive_data;
500 if (!strcmp(di->name, "tekpower-tp4000zc"))
501 receive_data = tekpower_tp4000zc_receive_data;
502 if (!strcmp(di->name, "metex-me31"))
503 receive_data = metex_me31_receive_data;
504 if (!strcmp(di->name, "peaktech-3410"))
505 receive_data = peaktech_3410_receive_data;
506 if (!strcmp(di->name, "mastech-mas345"))
507 receive_data = mastech_mas345_receive_data;
508 if (!strcmp(di->name, "va-va18b"))
509 receive_data = va_va18b_receive_data;
510 if (!strcmp(di->name, "metex-m3640d"))
511 receive_data = metex_m3640d_receive_data;
512 if (!strcmp(di->name, "peaktech-4370"))
513 receive_data = peaktech_4370_receive_data;
515 /* Poll every 50ms, or whenever some data comes in. */
516 sr_source_add(devc->serial->fd, G_IO_IN, 50,
517 receive_data, (void *)sdi);
522 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
524 struct sr_datafeed_packet packet;
525 struct dev_context *devc;
527 if (sdi->status != SR_ST_ACTIVE)
530 if (!(devc = sdi->priv)) {
531 sr_err("sdi->priv was NULL.");
535 sr_dbg("Stopping acquisition.");
537 sr_source_remove(devc->serial->fd);
538 hw_dev_close((struct sr_dev_inst *)sdi);
540 /* Send end packet to the session bus. */
541 sr_dbg("Sending SR_DF_END.");
542 packet.type = SR_DF_END;
543 sr_session_send(cb_data, &packet);
548 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
549 .name = "digitek-dt4000zc",
550 .longname = "Digitek DT4000ZC",
552 .init = hw_init_digitek_dt4000zc,
553 .cleanup = hw_cleanup,
555 .dev_list = hw_dev_list,
556 .dev_clear = clear_instances,
557 .dev_open = hw_dev_open,
558 .dev_close = hw_dev_close,
559 .info_get = hw_info_get,
560 .dev_config_set = hw_dev_config_set,
561 .dev_acquisition_start = hw_dev_acquisition_start,
562 .dev_acquisition_stop = hw_dev_acquisition_stop,
566 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
567 .name = "tekpower-tp4000zc",
568 .longname = "TekPower TP4000ZC",
570 .init = hw_init_tekpower_tp4000zc,
571 .cleanup = hw_cleanup,
573 .dev_list = hw_dev_list,
574 .dev_clear = clear_instances,
575 .dev_open = hw_dev_open,
576 .dev_close = hw_dev_close,
577 .info_get = hw_info_get,
578 .dev_config_set = hw_dev_config_set,
579 .dev_acquisition_start = hw_dev_acquisition_start,
580 .dev_acquisition_stop = hw_dev_acquisition_stop,
584 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
585 .name = "metex-me31",
586 .longname = "Metex ME-31",
588 .init = hw_init_metex_me31,
589 .cleanup = hw_cleanup,
591 .dev_list = hw_dev_list,
592 .dev_clear = clear_instances,
593 .dev_open = hw_dev_open,
594 .dev_close = hw_dev_close,
595 .info_get = hw_info_get,
596 .dev_config_set = hw_dev_config_set,
597 .dev_acquisition_start = hw_dev_acquisition_start,
598 .dev_acquisition_stop = hw_dev_acquisition_stop,
602 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
603 .name = "peaktech-3410",
604 .longname = "PeakTech 3410",
606 .init = hw_init_peaktech_3410,
607 .cleanup = hw_cleanup,
609 .dev_list = hw_dev_list,
610 .dev_clear = clear_instances,
611 .dev_open = hw_dev_open,
612 .dev_close = hw_dev_close,
613 .info_get = hw_info_get,
614 .dev_config_set = hw_dev_config_set,
615 .dev_acquisition_start = hw_dev_acquisition_start,
616 .dev_acquisition_stop = hw_dev_acquisition_stop,
620 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
621 .name = "mastech-mas345",
622 .longname = "MASTECH MAS345",
624 .init = hw_init_mastech_mas345,
625 .cleanup = hw_cleanup,
627 .dev_list = hw_dev_list,
628 .dev_clear = clear_instances,
629 .dev_open = hw_dev_open,
630 .dev_close = hw_dev_close,
631 .info_get = hw_info_get,
632 .dev_config_set = hw_dev_config_set,
633 .dev_acquisition_start = hw_dev_acquisition_start,
634 .dev_acquisition_stop = hw_dev_acquisition_stop,
638 SR_PRIV struct sr_dev_driver va_va18b_driver_info = {
640 .longname = "V&A VA18B",
642 .init = hw_init_va_va18b,
643 .cleanup = hw_cleanup,
645 .dev_list = hw_dev_list,
646 .dev_clear = clear_instances,
647 .dev_open = hw_dev_open,
648 .dev_close = hw_dev_close,
649 .info_get = hw_info_get,
650 .dev_config_set = hw_dev_config_set,
651 .dev_acquisition_start = hw_dev_acquisition_start,
652 .dev_acquisition_stop = hw_dev_acquisition_stop,
656 SR_PRIV struct sr_dev_driver metex_m3640d_driver_info = {
657 .name = "metex-m3640d",
658 .longname = "Metex M-3640D",
660 .init = hw_init_metex_m3640d,
661 .cleanup = hw_cleanup,
663 .dev_list = hw_dev_list,
664 .dev_clear = clear_instances,
665 .dev_open = hw_dev_open,
666 .dev_close = hw_dev_close,
667 .info_get = hw_info_get,
668 .dev_config_set = hw_dev_config_set,
669 .dev_acquisition_start = hw_dev_acquisition_start,
670 .dev_acquisition_stop = hw_dev_acquisition_stop,
674 SR_PRIV struct sr_dev_driver peaktech_4370_driver_info = {
675 .name = "peaktech-4370",
676 .longname = "PeakTech 4370",
678 .init = hw_init_peaktech_4370,
679 .cleanup = hw_cleanup,
681 .dev_list = hw_dev_list,
682 .dev_clear = clear_instances,
683 .dev_open = hw_dev_open,
684 .dev_close = hw_dev_close,
685 .info_get = hw_info_get,
686 .dev_config_set = hw_dev_config_set,
687 .dev_acquisition_start = hw_dev_acquisition_start,
688 .dev_acquisition_stop = hw_dev_acquisition_stop,