2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include <glib/gstdio.h>
24 #define SERIALCOMM "115200/8n1/flow=1"
26 static const int32_t hwopts[] = {
36 static struct usb_id_info ho_models[] = {
37 { 0x0403, 0xed72 }, /* HO720 */
38 { 0x0403, 0xed73 }, /* HO730 */
48 static int init(struct sr_context *sr_ctx)
50 return std_init(sr_ctx, di, LOG_PREFIX);
54 * Find USB serial devices via the USB vendor ID and product ID.
56 * @param vendor_id Vendor ID of the USB device.
57 * @param product_id Product ID of the USB device.
59 * @return A GSList of strings containing the path of the serial device or
60 * NULL if no serial device is found. The returned list must be freed
63 static GSList *auto_find_usb(uint16_t vendor_id, uint16_t product_id)
67 const char device_tree[] = "/sys/bus/usb/devices/";
68 GDir *devices_dir, *device_dir;
71 GSList *matched_paths;
74 gchar *vendor_path, *product_path, *path_copy;
75 gchar *prefix, *subdir_path, *device_path, *tty_path;
76 unsigned long read_vendor_id, read_product_id;
83 if (!(devices_dir = g_dir_open(device_tree, 0, NULL)))
87 * Find potential candidates using the vendor ID and product ID
88 * and store them in matched_paths.
90 while ((usb_dev = g_dir_read_name(devices_dir))) {
91 vendor_path = g_strconcat(device_tree,
92 usb_dev, "/idVendor", NULL);
93 product_path = g_strconcat(device_tree,
94 usb_dev, "/idProduct", NULL);
96 if (!g_file_test(vendor_path, G_FILE_TEST_EXISTS) ||
97 !g_file_test(product_path, G_FILE_TEST_EXISTS))
100 if ((fd = g_fopen(vendor_path, "r")) == NULL)
103 if (fgets(tmp, sizeof(tmp), fd) == NULL) {
107 read_vendor_id = strtoul(tmp, NULL, 16);
111 if ((fd = g_fopen(product_path, "r")) == NULL)
114 if (fgets(tmp, sizeof(tmp), fd) == NULL) {
118 read_product_id = strtoul(tmp, NULL, 16);
122 if (vendor_id == read_vendor_id &&
123 product_id == read_product_id) {
124 path_copy = g_strdup(usb_dev);
125 matched_paths = g_slist_prepend(matched_paths,
131 g_free(product_path);
133 g_dir_close(devices_dir);
135 /* For every matched device try to find a ttyUSBX subfolder. */
136 for (l = matched_paths; l; l = l->next) {
139 device_path = g_strconcat(device_tree, l->data, NULL);
141 if (!(device_dir = g_dir_open(device_path, 0, NULL))) {
146 prefix = g_strconcat(l->data, ":", NULL);
148 while ((file = g_dir_read_name(device_dir))) {
149 if (g_str_has_prefix(file, prefix)) {
150 subdir_path = g_strconcat(device_path,
155 g_dir_close(device_dir);
161 if (!(device_dir = g_dir_open(subdir_path, 0, NULL))) {
167 while ((file = g_dir_read_name(device_dir))) {
168 if (g_str_has_prefix(file, "ttyUSB")) {
169 tty_path = g_strconcat("/dev/",
171 sr_dbg("Found USB device %04x:%04x attached to %s.",
172 vendor_id, product_id, tty_path);
173 tty_devs = g_slist_prepend(tty_devs,
178 g_dir_close(device_dir);
181 g_slist_free_full(matched_paths, g_free);
189 static GSList *scan(GSList *options)
192 struct drv_context *drvc;
193 struct sr_dev_inst *sdi;
194 const char *serial_device, *serial_options;
195 GSList *l, *tty_devs;
198 serial_device = NULL;
199 serial_options = SERIALCOMM;
203 drvc->instances = NULL;
205 if (sr_serial_extract_options(options, &serial_device,
206 &serial_options) == SR_OK) {
207 sdi = hmo_probe_serial_device(serial_device, serial_options);
209 devices = g_slist_append(devices, sdi);
210 drvc->instances = g_slist_append(drvc->instances, sdi);
215 for (i = 0; i < ARRAY_SIZE(ho_models); i++) {
216 if ((l = auto_find_usb(ho_models[i].vendor_id,
217 ho_models[i].product_id)) == NULL)
219 tty_devs = g_slist_concat(tty_devs, l);
222 for (l = tty_devs; l; l = l->next) {
223 sdi = hmo_probe_serial_device(l->data, serial_options);
225 devices = g_slist_append(devices, sdi);
226 drvc->instances = g_slist_append(drvc->instances, sdi);
230 g_slist_free_full(tty_devs, g_free);
236 static GSList *dev_list(void)
238 return ((struct drv_context *)(di->priv))->instances;
241 static void clear_helper(void *priv)
244 struct dev_context *devc;
245 struct scope_config *model;
248 model = devc->model_config;
250 hmo_scope_state_free(devc->model_state);
252 for (i = 0; i < model->analog_channels; ++i)
253 g_slist_free(devc->analog_groups[i].probes);
255 for (i = 0; i < model->digital_pods; ++i) {
256 g_slist_free(devc->digital_groups[i].probes);
257 g_free(devc->digital_groups[i].name);
260 g_free(devc->analog_groups);
261 g_free(devc->digital_groups);
266 static int dev_clear(void)
268 return std_dev_clear(di, clear_helper);
271 static int dev_open(struct sr_dev_inst *sdi)
273 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
276 if (hmo_scope_state_get(sdi) != SR_OK)
279 sdi->status = SR_ST_ACTIVE;
284 static int dev_close(struct sr_dev_inst *sdi)
286 if (sdi->status == SR_ST_INACTIVE)
289 sr_scpi_close(sdi->conn);
291 sdi->status = SR_ST_INACTIVE;
296 static int cleanup(void)
303 static int check_probe_group(struct dev_context *devc,
304 const struct sr_probe_group *probe_group)
307 struct scope_config *model;
309 model = devc->model_config;
314 for (i = 0; i < model->analog_channels; ++i)
315 if (probe_group == &devc->analog_groups[i])
318 for (i = 0; i < model->digital_pods; ++i)
319 if (probe_group == &devc->digital_groups[i])
322 sr_err("Invalid probe group specified.");
327 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
328 const struct sr_probe_group *probe_group)
332 struct dev_context *devc;
333 struct scope_config *model;
335 if (!sdi || !(devc = sdi->priv))
338 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
342 model = devc->model_config;
345 case SR_CONF_NUM_TIMEBASE:
346 *data = g_variant_new_int32(model->num_xdivs);
349 case SR_CONF_NUM_VDIV:
350 if (pg_type == PG_NONE) {
351 sr_err("No probe group specified.");
352 return SR_ERR_PROBE_GROUP;
353 } else if (pg_type == PG_ANALOG) {
354 for (i = 0; i < model->analog_channels; ++i) {
355 if (probe_group != &devc->analog_groups[i])
357 *data = g_variant_new_int32(model->num_ydivs);
373 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
376 GVariant *rational[2];
379 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
381 for (i = 0; i < n; i++) {
382 rational[0] = g_variant_new_uint64((*array)[i][0]);
383 rational[1] = g_variant_new_uint64((*array)[i][1]);
385 /* FIXME: Valgrind reports a memory leak here. */
386 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
389 return g_variant_builder_end(&gvb);
392 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
393 const struct sr_probe_group *probe_group)
397 char command[MAX_COMMAND_SIZE];
398 struct dev_context *devc;
399 struct scope_config *model;
400 struct scope_state *state;
402 uint64_t p, q, tmp_u64;
405 if (!sdi || !(devc = sdi->priv))
408 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
411 model = devc->model_config;
412 state = devc->model_state;
417 case SR_CONF_LIMIT_FRAMES:
418 devc->frame_limit = g_variant_get_uint64(data);
421 case SR_CONF_TRIGGER_SOURCE:
422 tmp = g_variant_get_string(data, NULL);
423 for (i = 0; (*model->trigger_sources)[i]; i++) {
424 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
426 state->trigger_source = i;
427 g_snprintf(command, sizeof(command),
428 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
429 (*model->trigger_sources)[i]);
431 ret = sr_scpi_send(sdi->conn, command);
436 if (pg_type == PG_NONE) {
437 sr_err("No probe group specified.");
438 return SR_ERR_PROBE_GROUP;
441 g_variant_get(data, "(tt)", &p, &q);
443 for (i = 0; i < model->num_vdivs; i++) {
444 if (p != (*model->vdivs)[i][0] ||
445 q != (*model->vdivs)[i][1])
447 for (j = 1; j <= model->analog_channels; ++j) {
448 if (probe_group != &devc->analog_groups[j - 1])
450 state->analog_channels[j - 1].vdiv = (float) p / q;
451 g_snprintf(command, sizeof(command),
452 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
453 j, state->analog_channels[j-1].vdiv);
455 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
456 sr_scpi_get_opc(sdi->conn) != SR_OK)
466 case SR_CONF_TIMEBASE:
467 g_variant_get(data, "(tt)", &p, &q);
469 for (i = 0; i < model->num_timebases; i++) {
470 if (p != (*model->timebases)[i][0] ||
471 q != (*model->timebases)[i][1])
473 state->timebase = (float) p / q;
474 g_snprintf(command, sizeof(command),
475 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
478 ret = sr_scpi_send(sdi->conn, command);
482 case SR_CONF_HORIZ_TRIGGERPOS:
483 tmp_d = g_variant_get_double(data);
485 if (tmp_d < 0.0 || tmp_d > 1.0)
488 state->horiz_triggerpos = -(tmp_d - 0.5) * state->timebase * model->num_xdivs;
489 g_snprintf(command, sizeof(command),
490 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
491 state->horiz_triggerpos);
493 ret = sr_scpi_send(sdi->conn, command);
495 case SR_CONF_TRIGGER_SLOPE:
496 tmp_u64 = g_variant_get_uint64(data);
498 if (tmp_u64 != 0 && tmp_u64 != 1)
501 state->trigger_slope = tmp_u64;
503 g_snprintf(command, sizeof(command),
504 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
505 tmp_u64 ? "POS" : "NEG");
507 ret = sr_scpi_send(sdi->conn, command);
509 case SR_CONF_COUPLING:
510 if (pg_type == PG_NONE) {
511 sr_err("No probe group specified.");
512 return SR_ERR_PROBE_GROUP;
515 tmp = g_variant_get_string(data, NULL);
517 for (i = 0; (*model->coupling_options)[i]; i++) {
518 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
520 for (j = 1; j <= model->analog_channels; ++j) {
521 if (probe_group != &devc->analog_groups[j - 1])
523 state->analog_channels[j-1].coupling = i;
525 g_snprintf(command, sizeof(command),
526 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
529 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
530 sr_scpi_get_opc(sdi->conn) != SR_OK)
545 ret = sr_scpi_get_opc(sdi->conn);
550 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
551 const struct sr_probe_group *probe_group)
554 struct dev_context *devc;
555 struct scope_config *model;
557 if (!sdi || !(devc = sdi->priv))
560 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
563 model = devc->model_config;
566 case SR_CONF_DEVICE_OPTIONS:
567 if (pg_type == PG_NONE) {
568 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
569 model->hw_caps, model->num_hwcaps,
571 } else if (pg_type == PG_ANALOG) {
572 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
573 model->analog_hwcaps, model->num_analog_hwcaps,
576 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
577 NULL, 0, sizeof(int32_t));
580 case SR_CONF_COUPLING:
581 if (pg_type == PG_NONE)
582 return SR_ERR_PROBE_GROUP;
583 *data = g_variant_new_strv(*model->coupling_options,
584 g_strv_length((char **)*model->coupling_options));
586 case SR_CONF_TRIGGER_SOURCE:
587 *data = g_variant_new_strv(*model->trigger_sources,
588 g_strv_length((char **)*model->trigger_sources));
590 case SR_CONF_TIMEBASE:
591 *data = build_tuples(model->timebases, model->num_timebases);
594 if (pg_type == PG_NONE)
595 return SR_ERR_PROBE_GROUP;
596 *data = build_tuples(model->vdivs, model->num_vdivs);
605 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
607 char command[MAX_COMMAND_SIZE];
608 struct sr_probe *probe;
609 struct dev_context *devc;
610 struct scope_config *model;
613 model = devc->model_config;
615 probe = devc->current_probe->data;
617 switch (probe->type) {
618 case SR_PROBE_ANALOG:
619 g_snprintf(command, sizeof(command),
620 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
624 g_snprintf(command, sizeof(command),
625 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
626 probe->index < 8 ? 1 : 2);
629 sr_err("Invalid probe type.");
633 return sr_scpi_send(sdi->conn, command);
636 static int hmo_check_probes(GSList *probes)
639 struct sr_probe *probe;
640 gboolean enabled_pod1, enabled_pod2, enabled_chan3, enabled_chan4;
642 enabled_pod1 = enabled_pod2 = enabled_chan3 = enabled_chan4 = FALSE;
644 for (l = probes; l; l = l->next) {
646 switch (probe->type) {
647 case SR_PROBE_ANALOG:
648 if (probe->index == 2)
649 enabled_chan3 = TRUE;
650 else if (probe->index == 3)
651 enabled_chan4 = TRUE;
654 if (probe->index < 8)
664 if ((enabled_pod1 && enabled_chan3) ||
665 (enabled_pod2 && enabled_chan4))
671 static int hmo_setup_probes(const struct sr_dev_inst *sdi)
675 gboolean *pod_enabled;
676 char command[MAX_COMMAND_SIZE];
677 struct scope_state *state;
678 struct scope_config *model;
679 struct sr_probe *probe;
680 struct dev_context *devc;
681 struct sr_scpi_dev_inst *scpi;
685 state = devc->model_state;
686 model = devc->model_config;
688 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
690 for (l = sdi->probes; l; l = l->next) {
692 switch (probe->type) {
693 case SR_PROBE_ANALOG:
694 if (probe->enabled == state->analog_channels[probe->index].state)
696 g_snprintf(command, sizeof(command),
697 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
698 probe->index + 1, probe->enabled);
700 if (sr_scpi_send(scpi, command) != SR_OK)
702 state->analog_channels[probe->index].state = probe->enabled;
706 * A digital POD needs to be enabled for every group of
710 pod_enabled[probe->index < 8 ? 0 : 1] = TRUE;
712 if (probe->enabled == state->digital_channels[probe->index])
714 g_snprintf(command, sizeof(command),
715 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
716 probe->index, probe->enabled);
718 if (sr_scpi_send(scpi, command) != SR_OK)
721 state->digital_channels[probe->index] = probe->enabled;
728 for (i = 1; i <= model->digital_pods; ++i) {
729 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
731 g_snprintf(command, sizeof(command),
732 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
733 i, pod_enabled[i - 1]);
734 if (sr_scpi_send(scpi, command) != SR_OK)
736 state->digital_pods[i - 1] = pod_enabled[i - 1];
744 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
747 gboolean digital_added;
748 struct sr_probe *probe;
749 struct dev_context *devc;
750 struct sr_scpi_dev_inst *scpi;
752 if (sdi->status != SR_ST_ACTIVE)
753 return SR_ERR_DEV_CLOSED;
757 digital_added = FALSE;
759 for (l = sdi->probes; l; l = l->next) {
763 /* Only add a single digital probe. */
764 if (probe->type != SR_PROBE_LOGIC || !digital_added) {
765 devc->enabled_probes = g_slist_append(
766 devc->enabled_probes, probe);
767 if (probe->type == SR_PROBE_LOGIC)
768 digital_added = TRUE;
772 if (!devc->enabled_probes)
775 if (hmo_check_probes(devc->enabled_probes) != SR_OK) {
776 sr_err("Invalid probe configuration specified!");
780 if (hmo_setup_probes(sdi) != SR_OK) {
781 sr_err("Failed to setup probe configuration!");
785 sr_scpi_source_add(scpi, G_IO_IN, 50, hmo_receive_data, (void *)sdi);
787 /* Send header packet to the session bus. */
788 std_session_send_df_header(cb_data, LOG_PREFIX);
790 devc->current_probe = devc->enabled_probes;
792 return hmo_request_data(sdi);
795 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
797 struct dev_context *devc;
798 struct sr_scpi_dev_inst *scpi;
802 if (sdi->status != SR_ST_ACTIVE)
803 return SR_ERR_DEV_CLOSED;
807 g_slist_free(devc->enabled_probes);
808 devc->enabled_probes = NULL;
810 sr_scpi_source_remove(scpi);
815 SR_PRIV struct sr_dev_driver hameg_hmo_driver_info = {
817 .longname = "Hameg HMO",
822 .dev_list = dev_list,
823 .dev_clear = dev_clear,
824 .config_get = config_get,
825 .config_set = config_set,
826 .config_list = config_list,
827 .dev_open = dev_open,
828 .dev_close = dev_close,
829 .dev_acquisition_start = dev_acquisition_start,
830 .dev_acquisition_stop = dev_acquisition_stop,