2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
27 #include "genericdmm.h"
30 extern SR_PRIV struct dmmchip dmmchip_fs9922;
32 static struct dev_profile dev_profiles[] = {
33 { "victor-70c", "Victor", "70C", &dmmchip_fs9922,
34 0x1244, 0xd237, DMM_TRANSPORT_USBHID },
35 { "mastech-va18b", "Mastech", "VA18B", NULL, 0, 0, DMM_TRANSPORT_SERIAL},
38 static const int hwcaps[] = {
40 SR_HWCAP_LIMIT_SAMPLES,
49 static const char *probe_names[] = {
54 /* TODO need a way to keep these local to the static library */
55 SR_PRIV GSList *genericdmm_dev_insts = NULL;
56 SR_PRIV libusb_context *genericdmm_usb_context = NULL;
59 static int hw_init(void)
61 struct sr_dev_inst *sdi;
65 if (libusb_init(&genericdmm_usb_context) != 0) {
66 sr_err("genericdmm: Failed to initialize USB.");
70 if (!(ctx = g_try_malloc0(sizeof(struct context)))) {
71 sr_err("genericdmm: ctx malloc failed.");
75 devcnt = g_slist_length(genericdmm_dev_insts);
76 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE, "Generic DMM",
78 sr_err("genericdmm: sr_dev_inst_new returned NULL.");
82 genericdmm_dev_insts = g_slist_append(genericdmm_dev_insts, sdi);
84 /* Always initialized just one device instance. */
88 static int hw_dev_open(int dev_index)
90 struct sr_dev_inst *sdi;
93 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
94 sr_err("genericdmm: sdi was NULL.");
98 if (!(ctx = sdi->priv)) {
99 sr_err("genericdmm: sdi->priv was NULL.");
103 sr_dbg("genericdmm: Opening serial port '%s'.", ctx->serial->port);
105 switch (ctx->profile->transport) {
106 case DMM_TRANSPORT_USBHID:
109 case DMM_TRANSPORT_SERIAL:
110 /* TODO: O_NONBLOCK? */
111 ctx->serial->fd = serial_open(ctx->serial->port, O_RDWR | O_NONBLOCK);
112 if (ctx->serial->fd == -1) {
113 sr_err("genericdmm: Couldn't open serial port '%s'.",
117 // serial_set_params(ctx->serial->fd, 2400, 8, 0, 1, 2);
120 sr_err("No transport set.");
126 static int hw_dev_close(int dev_index)
128 struct sr_dev_inst *sdi;
131 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
132 sr_err("genericdmm: %s: sdi was NULL.", __func__);
136 if (!(ctx = sdi->priv)) {
137 sr_err("genericdmm: %s: sdi->priv was NULL.", __func__);
141 /* TODO: Check for != NULL. */
143 switch (ctx->profile->transport) {
144 case DMM_TRANSPORT_USBHID:
147 case DMM_TRANSPORT_SERIAL:
148 if (ctx->serial && ctx->serial->fd != -1) {
149 serial_close(ctx->serial->fd);
150 ctx->serial->fd = -1;
151 sdi->status = SR_ST_INACTIVE;
159 static int hw_cleanup(void)
162 struct sr_dev_inst *sdi;
165 /* Properly close and free all devices. */
166 for (l = genericdmm_dev_insts; l; l = l->next) {
167 if (!(sdi = l->data)) {
168 /* Log error, but continue cleaning up the rest. */
169 sr_err("genericdmm: sdi was NULL, continuing.");
172 if (!(ctx = sdi->priv)) {
173 /* Log error, but continue cleaning up the rest. */
174 sr_err("genericdmm: sdi->priv was NULL, continuing.");
179 switch (ctx->profile->transport) {
180 case DMM_TRANSPORT_USBHID:
183 case DMM_TRANSPORT_SERIAL:
184 if (ctx->serial && ctx->serial->fd != -1)
185 serial_close(ctx->serial->fd);
186 sr_serial_dev_inst_free(ctx->serial);
191 sr_dev_inst_free(sdi);
194 g_slist_free(genericdmm_dev_insts);
195 genericdmm_dev_insts = NULL;
197 if (genericdmm_usb_context)
198 libusb_exit(genericdmm_usb_context);
203 static const void *hw_dev_info_get(int dev_index, int dev_info_id)
205 struct sr_dev_inst *sdi;
209 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
210 sr_err("genericdmm: sdi was NULL.");
214 if (!(ctx = sdi->priv)) {
215 sr_err("genericdmm: sdi->priv was NULL.");
219 sr_spew("genericdmm: dev_index %d, dev_info_id %d.",
220 dev_index, dev_info_id);
222 switch (dev_info_id) {
225 sr_spew("genericdmm: Returning sdi.");
227 case SR_DI_NUM_PROBES:
228 info = GINT_TO_POINTER(1);
229 sr_spew("genericdmm: Returning number of probes: 1.");
231 case SR_DI_PROBE_NAMES:
233 sr_spew("genericdmm: Returning probenames.");
235 case SR_DI_CUR_SAMPLERATE:
236 /* TODO get rid of this */
238 sr_spew("genericdmm: Returning samplerate: 0.");
241 /* Unknown device info ID. */
242 sr_err("genericdmm: Unknown device info ID: %d.", dev_info_id);
250 static int hw_dev_status_get(int dev_index)
252 struct sr_dev_inst *sdi;
254 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
255 sr_err("genericdmm: sdi was NULL, device not found.");
256 return SR_ST_NOT_FOUND;
259 sr_dbg("genericdmm: Returning status: %d.", sdi->status);
264 static const int *hw_hwcap_get_all(void)
266 sr_spew("genericdmm: Returning list of device capabilities.");
271 static int parse_conn_vidpid(struct sr_dev_inst *sdi, const char *conn)
274 libusb_device **devlist;
275 struct libusb_device_descriptor des;
278 int vid, pid, found, err, i;
279 char *vidstr, *pidstr;
283 reg = g_regex_new(DMM_CONN_USB_VIDPID, 0, 0, NULL);
284 if (g_regex_match(reg, conn, 0, &match)) {
286 if (!(vidstr = g_match_info_fetch(match, 0))) {
287 sr_err("failed to fetch VID from regex");
290 vid = strtoul(vidstr, NULL, 16);
293 sr_err("invalid VID");
298 if (!(pidstr = g_match_info_fetch(match, 0))) {
299 sr_err("failed to fetch PID from regex");
302 pid = strtoul(pidstr, NULL, 16);
305 sr_err("invalid PID");
309 /* Looks like a valid VID:PID, but is it connected? */
310 libusb_get_device_list(genericdmm_usb_context, &devlist);
311 for (i = 0; devlist[i]; i++) {
312 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
313 sr_err("genericdmm: failed to get device descriptor: %d", err);
317 if (des.idVendor == vid && des.idProduct == pid) {
319 ctx->usb = sr_usb_dev_inst_new(
320 libusb_get_bus_number(devlist[i]),
321 libusb_get_device_address(devlist[i]), NULL);
326 libusb_free_device_list(devlist, 1);
331 g_match_info_unref(match);
337 static int parse_conn_busaddr(struct sr_dev_inst *sdi, const char *conn)
340 libusb_device **devlist;
341 struct libusb_device_descriptor des;
344 int bus, addr, found, err, i;
345 char *busstr, *addrstr;
349 reg = g_regex_new(DMM_CONN_USB_BUSADDR, 0, 0, NULL);
350 if (g_regex_match(reg, conn, 0, &match)) {
352 if (!(busstr = g_match_info_fetch(match, 0))) {
353 sr_err("failed to fetch bus from regex");
356 bus = strtoul(busstr, NULL, 16);
359 sr_err("invalid bus");
363 /* Extract address. */
364 if (!(addrstr = g_match_info_fetch(match, 0))) {
365 sr_err("failed to fetch address from regex");
368 addr = strtoul(addrstr, NULL, 16);
371 sr_err("invalid address");
375 /* Looks like a valid bus/address, but is it connected? */
376 libusb_get_device_list(genericdmm_usb_context, &devlist);
377 for (i = 0; devlist[i]; i++) {
378 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
379 sr_err("genericdmm: failed to get device descriptor: %d", err);
383 if (libusb_get_bus_number(devlist[i]) == bus
384 && libusb_get_device_address(devlist[i]) == addr) {
386 ctx->usb = sr_usb_dev_inst_new(bus, addr, NULL);
391 libusb_free_device_list(devlist, 1);
396 g_match_info_unref(match);
402 static int parse_conn_serial(struct sr_dev_inst *sdi, const char *conn)
413 static int parse_conn(struct sr_dev_inst *sdi, const char *conn)
416 if (parse_conn_vidpid(sdi, conn))
419 if (parse_conn_busaddr(sdi, conn))
422 if (parse_conn_serial(sdi, conn))
425 sr_err("Invalid connection specification");
430 static int parse_serialcomm(struct sr_dev_inst *sdi, const char *conn)
434 /* set ctx->serial_* */
439 static int hw_dev_config_set(int dev_index, int hwcap, const void *value)
441 struct sr_dev_inst *sdi;
445 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
446 sr_err("genericdmm: sdi was NULL.");
450 if (!(ctx = sdi->priv)) {
451 sr_err("genericdmm: sdi->priv was NULL.");
455 sr_spew("genericdmm: dev_index %d, hwcap %d.", dev_index, hwcap);
458 case SR_HWCAP_LIMIT_MSEC:
459 if (*(const uint64_t *)value == 0) {
460 sr_err("genericdmm: LIMIT_MSEC can't be 0.");
463 ctx->limit_msec = *(const uint64_t *)value;
464 sr_dbg("genericdmm: Setting LIMIT_MSEC to %" PRIu64 ".",
467 case SR_HWCAP_LIMIT_SAMPLES:
468 ctx->limit_samples = *(const uint64_t *)value;
469 sr_dbg("genericdmm: Setting LIMIT_SAMPLES to %" PRIu64 ".",
473 for (i = 0; dev_profiles[i].model; i++) {
474 if (!strcasecmp(dev_profiles[i].model, value)) {
475 ctx->profile = &dev_profiles[i];
476 /* Frontends access these fields directly, so we
477 * need to copy them over. */
478 sdi->vendor = g_strdup(dev_profiles[i].vendor);
479 sdi->model = g_strdup(dev_profiles[i].model);
480 /* This is the first time we actually know which
481 * DMM chip we're talking to, so let's init
482 * anything specific to it now */
483 if (ctx->profile->chip->init)
484 if (ctx->profile->chip->init(ctx) != SR_OK)
490 sr_err("unknown model %s", value);
495 if (parse_conn(sdi, value) != SR_OK)
498 case SR_HWCAP_SERIALCOMM:
499 if (parse_serialcomm(sdi, value) != SR_OK)
503 sr_err("genericdmm: Unknown capability: %d.", hwcap);
511 static int receive_data(int fd, int revents, void *cb_data)
513 struct sr_dev_inst *sdi;
516 if (!(sdi = cb_data))
519 if (!(ctx = sdi->priv))
522 if (revents != G_IO_IN) {
523 sr_err("genericdmm: No data?");
527 switch (ctx->profile->transport) {
528 case DMM_TRANSPORT_USBHID:
531 case DMM_TRANSPORT_SERIAL:
539 static int hw_dev_acquisition_start(int dev_index, void *cb_data)
541 struct sr_datafeed_packet packet;
542 struct sr_datafeed_header header;
543 struct sr_datafeed_meta_analog meta;
544 struct sr_dev_inst *sdi;
547 if (!(sdi = sr_dev_inst_get(genericdmm_dev_insts, dev_index))) {
548 sr_err("genericdmm: sdi was NULL.");
552 if (!(ctx = sdi->priv)) {
553 sr_err("genericdmm: sdi->priv was NULL.");
557 sr_dbg("genericdmm: Starting acquisition.");
559 ctx->cb_data = cb_data;
561 /* Send header packet to the session bus. */
562 sr_dbg("genericdmm: Sending SR_DF_HEADER.");
563 packet.type = SR_DF_HEADER;
564 packet.payload = (uint8_t *)&header;
565 header.feed_version = 1;
566 gettimeofday(&header.starttime, NULL);
567 sr_session_send(ctx->cb_data, &packet);
569 /* Send metadata about the SR_DF_ANALOG packets to come. */
570 sr_dbg("genericdmm: Sending SR_DF_META_ANALOG.");
571 packet.type = SR_DF_META_ANALOG;
572 packet.payload = &meta;
574 sr_session_send(ctx->cb_data, &packet);
576 /* Hook up a proxy handler to receive data from the device. */
577 switch (ctx->profile->transport) {
578 case DMM_TRANSPORT_USBHID:
579 /* TODO libusb FD setup */
581 case DMM_TRANSPORT_SERIAL:
582 /* TODO serial FD setup */
583 // sr_source_add(ctx->serial->fd, G_IO_IN, -1, receive_data, sdi);
590 static int hw_dev_acquisition_stop(int dev_index, void *cb_data)
592 struct sr_datafeed_packet packet;
594 /* Avoid compiler warnings. */
597 sr_dbg("genericdmm: Stopping acquisition.");
599 /* Send end packet to the session bus. */
600 sr_dbg("genericdmm: Sending SR_DF_END.");
601 packet.type = SR_DF_END;
602 sr_session_send(cb_data, &packet);
607 SR_PRIV struct sr_dev_driver genericdmm_driver_info = {
608 .name = "genericdmm",
609 .longname = "Generic DMM",
612 .cleanup = hw_cleanup,
613 .dev_open = hw_dev_open,
614 .dev_close = hw_dev_close,
615 .dev_info_get = hw_dev_info_get,
616 .dev_status_get = hw_dev_status_get,
617 .hwcap_get_all = hw_hwcap_get_all,
618 .dev_config_set = hw_dev_config_set,
619 .dev_acquisition_start = hw_dev_acquisition_start,
620 .dev_acquisition_stop = hw_dev_acquisition_stop,