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 SR_PRIV struct sr_dev_driver hameg_hmo_driver_info;
27 static struct sr_dev_driver *di = &hameg_hmo_driver_info;
29 static const char *manufacturers[] = {
33 static const int32_t hwopts[] = {
43 static struct usb_id_info ho_models[] = {
44 { 0x0403, 0xed72 }, /* HO720 */
45 { 0x0403, 0xed73 }, /* HO730 */
55 static int init(struct sr_context *sr_ctx)
57 return std_init(sr_ctx, di, LOG_PREFIX);
61 * Find USB serial devices via the USB vendor ID and product ID.
63 * @param vendor_id Vendor ID of the USB device.
64 * @param product_id Product ID of the USB device.
66 * @return A GSList of strings containing the path of the serial device or
67 * NULL if no serial device is found. The returned list must be freed
70 static GSList *auto_find_usb(uint16_t vendor_id, uint16_t product_id)
74 const char device_tree[] = "/sys/bus/usb/devices/";
75 GDir *devices_dir, *device_dir;
78 GSList *matched_paths;
81 gchar *vendor_path, *product_path, *path_copy;
82 gchar *prefix, *subdir_path, *device_path, *tty_path;
83 unsigned long read_vendor_id, read_product_id;
90 if (!(devices_dir = g_dir_open(device_tree, 0, NULL)))
94 * Find potential candidates using the vendor ID and product ID
95 * and store them in matched_paths.
97 while ((usb_dev = g_dir_read_name(devices_dir))) {
98 vendor_path = g_strconcat(device_tree,
99 usb_dev, "/idVendor", NULL);
100 product_path = g_strconcat(device_tree,
101 usb_dev, "/idProduct", NULL);
103 if (!g_file_test(vendor_path, G_FILE_TEST_EXISTS) ||
104 !g_file_test(product_path, G_FILE_TEST_EXISTS))
107 if ((fd = g_fopen(vendor_path, "r")) == NULL)
110 if (fgets(tmp, sizeof(tmp), fd) == NULL) {
114 read_vendor_id = strtoul(tmp, NULL, 16);
118 if ((fd = g_fopen(product_path, "r")) == NULL)
121 if (fgets(tmp, sizeof(tmp), fd) == NULL) {
125 read_product_id = strtoul(tmp, NULL, 16);
129 if (vendor_id == read_vendor_id &&
130 product_id == read_product_id) {
131 path_copy = g_strdup(usb_dev);
132 matched_paths = g_slist_prepend(matched_paths,
138 g_free(product_path);
140 g_dir_close(devices_dir);
142 /* For every matched device try to find a ttyUSBX subfolder. */
143 for (l = matched_paths; l; l = l->next) {
146 device_path = g_strconcat(device_tree, l->data, NULL);
148 if (!(device_dir = g_dir_open(device_path, 0, NULL))) {
153 prefix = g_strconcat(l->data, ":", NULL);
155 while ((file = g_dir_read_name(device_dir))) {
156 if (g_str_has_prefix(file, prefix)) {
157 subdir_path = g_strconcat(device_path,
162 g_dir_close(device_dir);
168 if (!(device_dir = g_dir_open(subdir_path, 0, NULL))) {
174 while ((file = g_dir_read_name(device_dir))) {
175 if (g_str_has_prefix(file, "ttyUSB")) {
176 tty_path = g_strconcat("/dev/",
178 sr_dbg("Found USB device %04x:%04x attached to %s.",
179 vendor_id, product_id, tty_path);
180 tty_devs = g_slist_prepend(tty_devs,
185 g_dir_close(device_dir);
188 g_slist_free_full(matched_paths, g_free);
196 static int check_manufacturer(const char *manufacturer)
200 for (i = 0; i < ARRAY_SIZE(manufacturers); ++i)
201 if (!strcmp(manufacturer, manufacturers[i]))
207 static struct sr_dev_inst *hmo_probe_serial_device(const char *serial_device,
208 const char *serial_options)
210 struct sr_dev_inst *sdi;
211 struct dev_context *devc;
212 struct sr_scpi_hw_info *hw_info;
213 struct sr_scpi_dev_inst *scpi;
220 if (!(scpi = scpi_dev_inst_new(serial_device, serial_options)))
223 sr_info("Probing %s.", serial_device);
224 if (sr_scpi_open(scpi) != SR_OK)
227 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
228 sr_info("Couldn't get IDN response.");
232 if (check_manufacturer(hw_info->manufacturer) != SR_OK)
235 if (!(sdi = sr_dev_inst_new(0, SR_ST_ACTIVE,
236 hw_info->manufacturer, hw_info->model,
237 hw_info->firmware_version))) {
240 sr_scpi_hw_info_free(hw_info);
243 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
248 sdi->inst_type = SR_INST_SCPI;
251 if (hmo_init_device(sdi) != SR_OK)
254 sr_scpi_close(sdi->conn);
256 sdi->status = SR_ST_INACTIVE;
262 sr_scpi_hw_info_free(hw_info);
266 sr_dev_inst_free(sdi);
273 static GSList *scan(GSList *options)
276 struct drv_context *drvc;
277 struct sr_dev_inst *sdi;
278 const char *serial_device, *serial_options;
279 GSList *l, *tty_devs;
282 serial_device = NULL;
283 serial_options = SERIALCOMM;
287 drvc->instances = NULL;
289 if (sr_serial_extract_options(options, &serial_device,
290 &serial_options) == SR_OK) {
291 sdi = hmo_probe_serial_device(serial_device, serial_options);
293 devices = g_slist_append(devices, sdi);
294 drvc->instances = g_slist_append(drvc->instances, sdi);
299 for (i = 0; i < ARRAY_SIZE(ho_models); i++) {
300 if ((l = auto_find_usb(ho_models[i].vendor_id,
301 ho_models[i].product_id)) == NULL)
303 tty_devs = g_slist_concat(tty_devs, l);
306 for (l = tty_devs; l; l = l->next) {
307 sdi = hmo_probe_serial_device(l->data, serial_options);
309 devices = g_slist_append(devices, sdi);
310 drvc->instances = g_slist_append(drvc->instances, sdi);
314 g_slist_free_full(tty_devs, g_free);
320 static GSList *dev_list(void)
322 return ((struct drv_context *)(di->priv))->instances;
325 static void clear_helper(void *priv)
328 struct dev_context *devc;
329 struct scope_config *model;
332 model = devc->model_config;
334 hmo_scope_state_free(devc->model_state);
336 for (i = 0; i < model->analog_channels; ++i)
337 g_slist_free(devc->analog_groups[i].probes);
339 for (i = 0; i < model->digital_pods; ++i) {
340 g_slist_free(devc->digital_groups[i].probes);
341 g_free(devc->digital_groups[i].name);
344 g_free(devc->analog_groups);
345 g_free(devc->digital_groups);
350 static int dev_clear(void)
352 return std_dev_clear(di, clear_helper);
355 static int dev_open(struct sr_dev_inst *sdi)
357 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
360 if (hmo_scope_state_get(sdi) != SR_OK)
363 sdi->status = SR_ST_ACTIVE;
368 static int dev_close(struct sr_dev_inst *sdi)
370 if (sdi->status == SR_ST_INACTIVE)
373 sr_scpi_close(sdi->conn);
375 sdi->status = SR_ST_INACTIVE;
380 static int cleanup(void)
387 static int check_probe_group(struct dev_context *devc,
388 const struct sr_probe_group *probe_group)
391 struct scope_config *model;
393 model = devc->model_config;
398 for (i = 0; i < model->analog_channels; ++i)
399 if (probe_group == &devc->analog_groups[i])
402 for (i = 0; i < model->digital_pods; ++i)
403 if (probe_group == &devc->digital_groups[i])
406 sr_err("Invalid probe group specified.");
411 static int config_get(int key, GVariant **data, const struct sr_dev_inst *sdi,
412 const struct sr_probe_group *probe_group)
416 struct dev_context *devc;
417 struct scope_config *model;
418 struct scope_state *state;
420 if (!sdi || !(devc = sdi->priv))
423 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
427 model = devc->model_config;
428 state = devc->model_state;
431 case SR_CONF_NUM_TIMEBASE:
432 *data = g_variant_new_int32(model->num_xdivs);
435 case SR_CONF_NUM_VDIV:
436 if (pg_type == PG_NONE) {
437 sr_err("No probe group specified.");
438 return SR_ERR_PROBE_GROUP;
439 } else if (pg_type == PG_ANALOG) {
440 for (i = 0; i < model->analog_channels; ++i) {
441 if (probe_group != &devc->analog_groups[i])
443 *data = g_variant_new_int32(model->num_ydivs);
452 case SR_CONF_TRIGGER_SOURCE:
453 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
456 case SR_CONF_COUPLING:
457 if (pg_type == PG_NONE) {
458 sr_err("No probe group specified.");
459 return SR_ERR_PROBE_GROUP;
460 } else if (pg_type == PG_ANALOG) {
461 for (i = 0; i < model->analog_channels; ++i) {
462 if (probe_group != &devc->analog_groups[i])
464 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
473 case SR_CONF_SAMPLERATE:
474 *data = g_variant_new_uint64(state->sample_rate);
484 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
487 GVariant *rational[2];
490 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
492 for (i = 0; i < n; i++) {
493 rational[0] = g_variant_new_uint64((*array)[i][0]);
494 rational[1] = g_variant_new_uint64((*array)[i][1]);
496 /* FIXME: Valgrind reports a memory leak here. */
497 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
500 return g_variant_builder_end(&gvb);
503 static int config_set(int key, GVariant *data, const struct sr_dev_inst *sdi,
504 const struct sr_probe_group *probe_group)
508 char command[MAX_COMMAND_SIZE], float_str[30];
509 struct dev_context *devc;
510 struct scope_config *model;
511 struct scope_state *state;
513 uint64_t p, q, tmp_u64;
515 gboolean update_sample_rate;
517 if (!sdi || !(devc = sdi->priv))
520 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
523 model = devc->model_config;
524 state = devc->model_state;
525 update_sample_rate = FALSE;
530 case SR_CONF_LIMIT_FRAMES:
531 devc->frame_limit = g_variant_get_uint64(data);
534 case SR_CONF_TRIGGER_SOURCE:
535 tmp = g_variant_get_string(data, NULL);
536 for (i = 0; (*model->trigger_sources)[i]; i++) {
537 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
539 state->trigger_source = i;
540 g_snprintf(command, sizeof(command),
541 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
542 (*model->trigger_sources)[i]);
544 ret = sr_scpi_send(sdi->conn, command);
549 if (pg_type == PG_NONE) {
550 sr_err("No probe group specified.");
551 return SR_ERR_PROBE_GROUP;
554 g_variant_get(data, "(tt)", &p, &q);
556 for (i = 0; i < model->num_vdivs; i++) {
557 if (p != (*model->vdivs)[i][0] ||
558 q != (*model->vdivs)[i][1])
560 for (j = 1; j <= model->analog_channels; ++j) {
561 if (probe_group != &devc->analog_groups[j - 1])
563 state->analog_channels[j - 1].vdiv = i;
564 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
565 g_snprintf(command, sizeof(command),
566 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
569 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
570 sr_scpi_get_opc(sdi->conn) != SR_OK)
580 case SR_CONF_TIMEBASE:
581 g_variant_get(data, "(tt)", &p, &q);
583 for (i = 0; i < model->num_timebases; i++) {
584 if (p != (*model->timebases)[i][0] ||
585 q != (*model->timebases)[i][1])
588 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
589 g_snprintf(command, sizeof(command),
590 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
593 ret = sr_scpi_send(sdi->conn, command);
594 update_sample_rate = TRUE;
598 case SR_CONF_HORIZ_TRIGGERPOS:
599 tmp_d = g_variant_get_double(data);
601 if (tmp_d < 0.0 || tmp_d > 1.0)
604 state->horiz_triggerpos = -(tmp_d - 0.5) * state->timebase * model->num_xdivs;
605 g_snprintf(command, sizeof(command),
606 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
607 state->horiz_triggerpos);
609 ret = sr_scpi_send(sdi->conn, command);
611 case SR_CONF_TRIGGER_SLOPE:
612 tmp_u64 = g_variant_get_uint64(data);
614 if (tmp_u64 != 0 && tmp_u64 != 1)
617 state->trigger_slope = tmp_u64;
619 g_snprintf(command, sizeof(command),
620 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
621 tmp_u64 ? "POS" : "NEG");
623 ret = sr_scpi_send(sdi->conn, command);
625 case SR_CONF_COUPLING:
626 if (pg_type == PG_NONE) {
627 sr_err("No probe group specified.");
628 return SR_ERR_PROBE_GROUP;
631 tmp = g_variant_get_string(data, NULL);
633 for (i = 0; (*model->coupling_options)[i]; i++) {
634 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
636 for (j = 1; j <= model->analog_channels; ++j) {
637 if (probe_group != &devc->analog_groups[j - 1])
639 state->analog_channels[j-1].coupling = i;
641 g_snprintf(command, sizeof(command),
642 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
645 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
646 sr_scpi_get_opc(sdi->conn) != SR_OK)
661 ret = sr_scpi_get_opc(sdi->conn);
663 if (ret == SR_OK && update_sample_rate)
664 ret = hmo_update_sample_rate(sdi);
669 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi,
670 const struct sr_probe_group *probe_group)
673 struct dev_context *devc;
674 struct scope_config *model;
676 if (!sdi || !(devc = sdi->priv))
679 if ((pg_type = check_probe_group(devc, probe_group)) == PG_INVALID)
682 model = devc->model_config;
685 case SR_CONF_DEVICE_OPTIONS:
686 if (pg_type == PG_NONE) {
687 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
688 model->hw_caps, model->num_hwcaps,
690 } else if (pg_type == PG_ANALOG) {
691 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
692 model->analog_hwcaps, model->num_analog_hwcaps,
695 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
696 NULL, 0, sizeof(int32_t));
699 case SR_CONF_COUPLING:
700 if (pg_type == PG_NONE)
701 return SR_ERR_PROBE_GROUP;
702 *data = g_variant_new_strv(*model->coupling_options,
703 g_strv_length((char **)*model->coupling_options));
705 case SR_CONF_TRIGGER_SOURCE:
706 *data = g_variant_new_strv(*model->trigger_sources,
707 g_strv_length((char **)*model->trigger_sources));
709 case SR_CONF_TIMEBASE:
710 *data = build_tuples(model->timebases, model->num_timebases);
713 if (pg_type == PG_NONE)
714 return SR_ERR_PROBE_GROUP;
715 *data = build_tuples(model->vdivs, model->num_vdivs);
724 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
726 char command[MAX_COMMAND_SIZE];
727 struct sr_probe *probe;
728 struct dev_context *devc;
729 struct scope_config *model;
732 model = devc->model_config;
734 probe = devc->current_probe->data;
736 switch (probe->type) {
737 case SR_PROBE_ANALOG:
738 g_snprintf(command, sizeof(command),
739 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
743 g_snprintf(command, sizeof(command),
744 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
745 probe->index < 8 ? 1 : 2);
748 sr_err("Invalid probe type.");
752 return sr_scpi_send(sdi->conn, command);
755 static int hmo_check_probes(GSList *probes)
758 struct sr_probe *probe;
759 gboolean enabled_pod1, enabled_pod2, enabled_chan3, enabled_chan4;
761 enabled_pod1 = enabled_pod2 = enabled_chan3 = enabled_chan4 = FALSE;
763 for (l = probes; l; l = l->next) {
765 switch (probe->type) {
766 case SR_PROBE_ANALOG:
767 if (probe->index == 2)
768 enabled_chan3 = TRUE;
769 else if (probe->index == 3)
770 enabled_chan4 = TRUE;
773 if (probe->index < 8)
783 if ((enabled_pod1 && enabled_chan3) ||
784 (enabled_pod2 && enabled_chan4))
790 static int hmo_setup_probes(const struct sr_dev_inst *sdi)
794 gboolean *pod_enabled, setup_changed;
795 char command[MAX_COMMAND_SIZE];
796 struct scope_state *state;
797 struct scope_config *model;
798 struct sr_probe *probe;
799 struct dev_context *devc;
800 struct sr_scpi_dev_inst *scpi;
804 state = devc->model_state;
805 model = devc->model_config;
806 setup_changed = FALSE;
808 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
810 for (l = sdi->probes; l; l = l->next) {
812 switch (probe->type) {
813 case SR_PROBE_ANALOG:
814 if (probe->enabled == state->analog_channels[probe->index].state)
816 g_snprintf(command, sizeof(command),
817 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
818 probe->index + 1, probe->enabled);
820 if (sr_scpi_send(scpi, command) != SR_OK)
822 state->analog_channels[probe->index].state = probe->enabled;
823 setup_changed = TRUE;
827 * A digital POD needs to be enabled for every group of
831 pod_enabled[probe->index < 8 ? 0 : 1] = TRUE;
833 if (probe->enabled == state->digital_channels[probe->index])
835 g_snprintf(command, sizeof(command),
836 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
837 probe->index, probe->enabled);
839 if (sr_scpi_send(scpi, command) != SR_OK)
842 state->digital_channels[probe->index] = probe->enabled;
843 setup_changed = TRUE;
850 for (i = 1; i <= model->digital_pods; ++i) {
851 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
853 g_snprintf(command, sizeof(command),
854 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
855 i, pod_enabled[i - 1]);
856 if (sr_scpi_send(scpi, command) != SR_OK)
858 state->digital_pods[i - 1] = pod_enabled[i - 1];
859 setup_changed = TRUE;
864 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
870 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
873 gboolean digital_added;
874 struct sr_probe *probe;
875 struct dev_context *devc;
876 struct sr_scpi_dev_inst *scpi;
878 if (sdi->status != SR_ST_ACTIVE)
879 return SR_ERR_DEV_CLOSED;
883 digital_added = FALSE;
885 for (l = sdi->probes; l; l = l->next) {
889 /* Only add a single digital probe. */
890 if (probe->type != SR_PROBE_LOGIC || !digital_added) {
891 devc->enabled_probes = g_slist_append(
892 devc->enabled_probes, probe);
893 if (probe->type == SR_PROBE_LOGIC)
894 digital_added = TRUE;
898 if (!devc->enabled_probes)
901 if (hmo_check_probes(devc->enabled_probes) != SR_OK) {
902 sr_err("Invalid probe configuration specified!");
906 if (hmo_setup_probes(sdi) != SR_OK) {
907 sr_err("Failed to setup probe configuration!");
911 sr_scpi_source_add(scpi, G_IO_IN, 50, hmo_receive_data, (void *)sdi);
913 /* Send header packet to the session bus. */
914 std_session_send_df_header(cb_data, LOG_PREFIX);
916 devc->current_probe = devc->enabled_probes;
918 return hmo_request_data(sdi);
921 static int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
923 struct dev_context *devc;
924 struct sr_scpi_dev_inst *scpi;
925 struct sr_datafeed_packet packet;
929 packet.type = SR_DF_END;
930 packet.payload = NULL;
931 sr_session_send(sdi, &packet);
933 if (sdi->status != SR_ST_ACTIVE)
934 return SR_ERR_DEV_CLOSED;
938 devc->num_frames = 0;
939 g_slist_free(devc->enabled_probes);
940 devc->enabled_probes = NULL;
942 sr_scpi_source_remove(scpi);
947 SR_PRIV struct sr_dev_driver hameg_hmo_driver_info = {
949 .longname = "Hameg HMO",
954 .dev_list = dev_list,
955 .dev_clear = dev_clear,
956 .config_get = config_get,
957 .config_set = config_set,
958 .config_list = config_list,
959 .dev_open = dev_open,
960 .dev_close = dev_close,
961 .dev_acquisition_start = dev_acquisition_start,
962 .dev_acquisition_stop = dev_acquisition_stop,