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;
56 static struct sr_dev_driver *di_dt4000zc = &digitek_dt4000zc_driver_info;
57 static struct sr_dev_driver *di_tp4000zc = &tekpower_tp4000zc_driver_info;
58 static struct sr_dev_driver *di_me31 = &metex_me31_driver_info;
59 static struct sr_dev_driver *di_3410 = &peaktech_3410_driver_info;
60 static struct sr_dev_driver *di_mas345 = &mastech_mas345_driver_info;
62 /* After hw_init() this will point to a device-specific entry (see above). */
63 static struct sr_dev_driver *di = NULL;
65 SR_PRIV struct dmm_info dmms[] = {
67 "Digitek", "DT4000ZC", "2400/8n1", 2400,
68 FS9721_PACKET_SIZE, NULL,
69 sr_fs9721_packet_valid, sr_fs9721_parse,
73 "TekPower", "TP4000ZC", "2400/8n1", 2400,
74 FS9721_PACKET_SIZE, NULL,
75 sr_fs9721_packet_valid, sr_fs9721_parse,
79 "Metex", "ME-31", "600/7n2/rts=0/dtr=1", 600,
80 METEX14_PACKET_SIZE, sr_metex14_packet_request,
81 sr_metex14_packet_valid, sr_metex14_parse,
85 "Peaktech", "3410", "600/7n2/rts=0/dtr=1", 600,
86 METEX14_PACKET_SIZE, sr_metex14_packet_request,
87 sr_metex14_packet_valid, sr_metex14_parse,
91 "MASTECH", "MAS345", "600/7n2/rts=0/dtr=1", 600,
92 METEX14_PACKET_SIZE, sr_metex14_packet_request,
93 sr_metex14_packet_valid, sr_metex14_parse,
98 /* Properly close and free all devices. */
99 static int clear_instances(void)
101 struct sr_dev_inst *sdi;
102 struct drv_context *drvc;
103 struct dev_context *devc;
106 if (!(drvc = di->priv))
110 for (l = drvc->instances; l; l = l->next) {
111 if (!(sdi = l->data))
113 if (!(devc = sdi->priv))
115 sr_serial_dev_inst_free(devc->serial);
116 sr_dev_inst_free(sdi);
118 g_slist_free(drvc->instances);
119 drvc->instances = NULL;
124 static int hw_init(int dmm)
126 struct drv_context *drvc;
128 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
129 sr_err("Driver context malloc failed.");
130 return SR_ERR_MALLOC;
133 if (dmm == DIGITEK_DT4000ZC)
135 if (dmm == TEKPOWER_TP4000ZC)
137 if (dmm == METEX_ME31)
139 if (dmm == PEAKTECH_3410)
141 if (dmm == MASTECH_MAS345)
143 sr_dbg("Selected '%s' subdriver.", di->name);
150 static int hw_init_digitek_dt4000zc(void)
152 return hw_init(DIGITEK_DT4000ZC);
155 static int hw_init_tekpower_tp4000zc(void)
157 return hw_init(TEKPOWER_TP4000ZC);
160 static int hw_init_metex_me31(void)
162 return hw_init(METEX_ME31);
165 static int hw_init_peaktech_3410(void)
167 return hw_init(PEAKTECH_3410);
170 static int hw_init_mastech_mas345(void)
172 return hw_init(MASTECH_MAS345);
175 static GSList *scan(const char *conn, const char *serialcomm, int dmm)
177 struct sr_dev_inst *sdi;
178 struct drv_context *drvc;
179 struct dev_context *devc;
180 struct sr_probe *probe;
181 struct sr_serial_dev_inst *serial;
187 if (!(serial = sr_serial_dev_inst_new(conn, serialcomm)))
190 if (serial_open(serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
193 sr_info("Probing port %s.", conn);
197 serial_flush(serial);
200 * There's no way to get an ID from the multimeter. It just sends data
201 * periodically, so the best we can do is check if the packets match
202 * the expected format.
205 /* Let's get a bit of data and see if we can find a packet. */
208 /* Request a packet if the DMM requires this. */
209 if (dmms[dmm].packet_request) {
210 if ((ret = dmms[dmm].packet_request(serial)) < 0) {
211 sr_err("Failed to request packet: %d.", ret);
216 ret = serial_stream_detect(serial, buf, &len, dmms[dmm].packet_size,
217 dmms[dmm].packet_valid, 1000,
223 * If we dropped more than two packets worth of data, something is
224 * wrong. We shouldn't quit however, since the dropped bytes might be
225 * just zeroes at the beginning of the stream. Those can occur as a
226 * combination of the nonstandard cable that ships with this device and
227 * the serial port or USB to serial adapter.
229 dropped = len - dmms[dmm].packet_size;
230 if (dropped > 2 * dmms[dmm].packet_size)
231 sr_warn("Had to drop too much data.");
233 sr_info("Found device on port %s.", conn);
235 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, dmms[dmm].vendor,
236 dmms[dmm].device, "")))
239 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
240 sr_err("Device context malloc failed.");
244 devc->serial = serial;
248 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
250 sdi->probes = g_slist_append(sdi->probes, probe);
251 drvc->instances = g_slist_append(drvc->instances, sdi);
252 devices = g_slist_append(devices, sdi);
255 serial_close(serial);
260 static GSList *hw_scan(GSList *options)
262 struct sr_hwopt *opt;
264 const char *conn, *serialcomm;
267 conn = serialcomm = NULL;
268 for (l = options; l; l = l->next) {
270 switch (opt->hwopt) {
274 case SR_HWOPT_SERIALCOMM:
275 serialcomm = opt->value;
282 if (!strcmp(di->name, "digitek-dt4000zc"))
284 if (!strcmp(di->name, "tekpower-tp4000zc"))
286 if (!strcmp(di->name, "metex-me31"))
288 if (!strcmp(di->name, "peaktech-3410"))
290 if (!strcmp(di->name, "mastech-mas345"))
294 /* Use the provided comm specs. */
295 devices = scan(conn, serialcomm, dmm);
297 /* Try the default. */
298 devices = scan(conn, dmms[dmm].conn, dmm);
304 static GSList *hw_dev_list(void)
306 struct drv_context *drvc;
310 return drvc->instances;
313 static int hw_dev_open(struct sr_dev_inst *sdi)
315 struct dev_context *devc;
317 if (!(devc = sdi->priv)) {
318 sr_err("sdi->priv was NULL.");
322 if (serial_open(devc->serial, SERIAL_RDWR | SERIAL_NONBLOCK) != SR_OK)
325 sdi->status = SR_ST_ACTIVE;
330 static int hw_dev_close(struct sr_dev_inst *sdi)
332 struct dev_context *devc;
334 if (!(devc = sdi->priv)) {
335 sr_err("sdi->priv was NULL.");
339 if (devc->serial && devc->serial->fd != -1) {
340 serial_close(devc->serial);
341 sdi->status = SR_ST_INACTIVE;
347 static int hw_cleanup(void)
354 static int hw_info_get(int info_id, const void **data,
355 const struct sr_dev_inst *sdi)
366 case SR_DI_NUM_PROBES:
367 *data = GINT_TO_POINTER(1);
369 case SR_DI_PROBE_NAMES:
379 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
382 struct dev_context *devc;
384 if (sdi->status != SR_ST_ACTIVE)
387 if (!(devc = sdi->priv)) {
388 sr_err("sdi->priv was NULL.");
393 case SR_HWCAP_LIMIT_SAMPLES:
394 devc->limit_samples = *(const uint64_t *)value;
395 sr_dbg("Setting sample limit to %" PRIu64 ".",
396 devc->limit_samples);
399 sr_err("Unknown capability: %d.", hwcap);
407 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
410 struct sr_datafeed_packet packet;
411 struct sr_datafeed_header header;
412 struct sr_datafeed_meta_analog meta;
413 struct dev_context *devc;
414 int (*receive_data)(int, int, void *) = NULL;
416 if (!(devc = sdi->priv)) {
417 sr_err("sdi->priv was NULL.");
421 sr_dbg("Starting acquisition.");
423 devc->cb_data = cb_data;
426 * Reset the number of samples to take. If we've already collected our
427 * quota, but we start a new session, and don't reset this, we'll just
428 * quit without acquiring any new samples.
430 devc->num_samples = 0;
432 /* Send header packet to the session bus. */
433 sr_dbg("Sending SR_DF_HEADER.");
434 packet.type = SR_DF_HEADER;
435 packet.payload = (uint8_t *)&header;
436 header.feed_version = 1;
437 gettimeofday(&header.starttime, NULL);
438 sr_session_send(devc->cb_data, &packet);
440 /* Send metadata about the SR_DF_ANALOG packets to come. */
441 sr_dbg("Sending SR_DF_META_ANALOG.");
442 packet.type = SR_DF_META_ANALOG;
443 packet.payload = &meta;
445 sr_session_send(devc->cb_data, &packet);
447 if (!strcmp(di->name, "digitek-dt4000zc"))
448 receive_data = digitek_dt4000zc_receive_data;
449 if (!strcmp(di->name, "tekpower-tp4000zc"))
450 receive_data = tekpower_tp4000zc_receive_data;
451 if (!strcmp(di->name, "metex-me31"))
452 receive_data = metex_me31_receive_data;
453 if (!strcmp(di->name, "peaktech-3410"))
454 receive_data = peaktech_3410_receive_data;
455 if (!strcmp(di->name, "mastech-mas345"))
456 receive_data = mastech_mas345_receive_data;
458 /* Poll every 50ms, or whenever some data comes in. */
459 sr_source_add(devc->serial->fd, G_IO_IN, 50,
460 receive_data, (void *)sdi);
465 static int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
467 struct sr_datafeed_packet packet;
468 struct dev_context *devc;
470 if (sdi->status != SR_ST_ACTIVE)
473 if (!(devc = sdi->priv)) {
474 sr_err("sdi->priv was NULL.");
478 sr_dbg("Stopping acquisition.");
480 sr_source_remove(devc->serial->fd);
481 hw_dev_close((struct sr_dev_inst *)sdi);
483 /* Send end packet to the session bus. */
484 sr_dbg("Sending SR_DF_END.");
485 packet.type = SR_DF_END;
486 sr_session_send(cb_data, &packet);
491 SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info = {
492 .name = "digitek-dt4000zc",
493 .longname = "Digitek DT4000ZC",
495 .init = hw_init_digitek_dt4000zc,
496 .cleanup = hw_cleanup,
498 .dev_list = hw_dev_list,
499 .dev_clear = clear_instances,
500 .dev_open = hw_dev_open,
501 .dev_close = hw_dev_close,
502 .info_get = hw_info_get,
503 .dev_config_set = hw_dev_config_set,
504 .dev_acquisition_start = hw_dev_acquisition_start,
505 .dev_acquisition_stop = hw_dev_acquisition_stop,
509 SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info = {
510 .name = "tekpower-tp4000zc",
511 .longname = "TekPower TP4000ZC",
513 .init = hw_init_tekpower_tp4000zc,
514 .cleanup = hw_cleanup,
516 .dev_list = hw_dev_list,
517 .dev_clear = clear_instances,
518 .dev_open = hw_dev_open,
519 .dev_close = hw_dev_close,
520 .info_get = hw_info_get,
521 .dev_config_set = hw_dev_config_set,
522 .dev_acquisition_start = hw_dev_acquisition_start,
523 .dev_acquisition_stop = hw_dev_acquisition_stop,
527 SR_PRIV struct sr_dev_driver metex_me31_driver_info = {
528 .name = "metex-me31",
529 .longname = "Metex ME-31",
531 .init = hw_init_metex_me31,
532 .cleanup = hw_cleanup,
534 .dev_list = hw_dev_list,
535 .dev_clear = clear_instances,
536 .dev_open = hw_dev_open,
537 .dev_close = hw_dev_close,
538 .info_get = hw_info_get,
539 .dev_config_set = hw_dev_config_set,
540 .dev_acquisition_start = hw_dev_acquisition_start,
541 .dev_acquisition_stop = hw_dev_acquisition_stop,
545 SR_PRIV struct sr_dev_driver peaktech_3410_driver_info = {
546 .name = "peaktech-3410",
547 .longname = "PeakTech 3410",
549 .init = hw_init_peaktech_3410,
550 .cleanup = hw_cleanup,
552 .dev_list = hw_dev_list,
553 .dev_clear = clear_instances,
554 .dev_open = hw_dev_open,
555 .dev_close = hw_dev_close,
556 .info_get = hw_info_get,
557 .dev_config_set = hw_dev_config_set,
558 .dev_acquisition_start = hw_dev_acquisition_start,
559 .dev_acquisition_stop = hw_dev_acquisition_stop,
563 SR_PRIV struct sr_dev_driver mastech_mas345_driver_info = {
564 .name = "mastech-mas345",
565 .longname = "MASTECH MAS345",
567 .init = hw_init_mastech_mas345,
568 .cleanup = hw_cleanup,
570 .dev_list = hw_dev_list,
571 .dev_clear = clear_instances,
572 .dev_open = hw_dev_open,
573 .dev_close = hw_dev_close,
574 .info_get = hw_info_get,
575 .dev_config_set = hw_dev_config_set,
576 .dev_acquisition_start = hw_dev_acquisition_start,
577 .dev_acquisition_stop = hw_dev_acquisition_stop,