2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 poljar (Damir Jelić) <poljarinho@gmail.com>
5 * Copyright (C) 2018 Guido Trentalancia <guido@trentalancia.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 3 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, see <http://www.gnu.org/licenses/>.
26 static struct sr_dev_driver hameg_hmo_driver_info;
28 static const char *manufacturers[] = {
33 static const uint32_t scanopts[] = {
38 static const uint32_t drvopts[] = {
49 static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
51 struct sr_dev_inst *sdi;
52 struct dev_context *devc;
53 struct sr_scpi_hw_info *hw_info;
59 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
60 sr_info("Couldn't get IDN response.");
64 if (std_str_idx_s(hw_info->manufacturer, ARRAY_AND_SIZE(manufacturers)) < 0)
67 sdi = g_malloc0(sizeof(struct sr_dev_inst));
68 sdi->vendor = g_strdup(hw_info->manufacturer);
69 sdi->model = g_strdup(hw_info->model);
70 sdi->version = g_strdup(hw_info->firmware_version);
71 sdi->serial_num = g_strdup(hw_info->serial_number);
72 sdi->driver = &hameg_hmo_driver_info;
73 sdi->inst_type = SR_INST_SCPI;
76 sr_scpi_hw_info_free(hw_info);
79 devc = g_malloc0(sizeof(struct dev_context));
83 if (hmo_init_device(sdi) != SR_OK)
89 sr_scpi_hw_info_free(hw_info);
90 sr_dev_inst_free(sdi);
96 static GSList *scan(struct sr_dev_driver *di, GSList *options)
98 return sr_scpi_scan(di->context, options, probe_device);
101 static void clear_helper(struct dev_context *devc)
103 hmo_scope_state_free(devc->model_state);
104 g_free(devc->analog_groups);
105 g_free(devc->digital_groups);
108 static int dev_clear(const struct sr_dev_driver *di)
110 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
113 static int dev_open(struct sr_dev_inst *sdi)
115 if (sr_scpi_open(sdi->conn) != SR_OK)
118 if (hmo_scope_state_get(sdi) != SR_OK)
124 static int dev_close(struct sr_dev_inst *sdi)
126 return sr_scpi_close(sdi->conn);
129 static int check_channel_group(struct dev_context *devc,
130 const struct sr_channel_group *cg)
132 const struct scope_config *model;
134 model = devc->model_config;
139 if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) >= 0)
142 if (std_cg_idx(cg, devc->digital_groups, model->digital_pods) >= 0)
145 sr_err("Invalid channel group specified.");
150 static int config_get(uint32_t key, GVariant **data,
151 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
154 struct dev_context *devc;
155 const struct scope_config *model;
156 struct scope_state *state;
163 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
166 model = devc->model_config;
167 state = devc->model_state;
170 case SR_CONF_NUM_HDIV:
171 *data = g_variant_new_int32(model->num_xdivs);
173 case SR_CONF_TIMEBASE:
174 *data = g_variant_new("(tt)", (*model->timebases)[state->timebase][0],
175 (*model->timebases)[state->timebase][1]);
177 case SR_CONF_NUM_VDIV:
179 return SR_ERR_CHANNEL_GROUP;
180 if (cg_type != CG_ANALOG)
182 if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) < 0)
184 *data = g_variant_new_int32(model->num_ydivs);
188 return SR_ERR_CHANNEL_GROUP;
189 if (cg_type != CG_ANALOG)
191 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
193 *data = g_variant_new("(tt)",
194 (*model->vdivs)[state->analog_channels[idx].vdiv][0],
195 (*model->vdivs)[state->analog_channels[idx].vdiv][1]);
197 case SR_CONF_TRIGGER_SOURCE:
198 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
200 case SR_CONF_TRIGGER_SLOPE:
201 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
203 case SR_CONF_TRIGGER_PATTERN:
204 *data = g_variant_new_string(state->trigger_pattern);
206 case SR_CONF_HORIZ_TRIGGERPOS:
207 *data = g_variant_new_double(state->horiz_triggerpos);
209 case SR_CONF_COUPLING:
211 return SR_ERR_CHANNEL_GROUP;
212 if (cg_type != CG_ANALOG)
214 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
216 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[idx].coupling]);
218 case SR_CONF_SAMPLERATE:
219 *data = g_variant_new_uint64(state->sample_rate);
221 case SR_CONF_LOGIC_THRESHOLD:
223 return SR_ERR_CHANNEL_GROUP;
224 if (cg_type != CG_DIGITAL)
228 if ((idx = std_cg_idx(cg, devc->digital_groups, model->digital_pods)) < 0)
230 *data = g_variant_new_string((*model->logic_threshold)[state->digital_pods[idx].threshold]);
232 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
234 return SR_ERR_CHANNEL_GROUP;
235 if (cg_type != CG_DIGITAL)
239 if ((idx = std_cg_idx(cg, devc->digital_groups, model->digital_pods)) < 0)
241 if (strcmp("USER2", (*model->logic_threshold)[state->digital_pods[idx].threshold]))
243 *data = g_variant_new_double(state->digital_pods[idx].user_threshold);
252 static int config_set(uint32_t key, GVariant *data,
253 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
255 int ret, cg_type, idx, j;
256 char command[MAX_COMMAND_SIZE], float_str[30], *tmp_str;
257 struct dev_context *devc;
258 const struct scope_config *model;
259 struct scope_state *state;
261 gboolean update_sample_rate;
268 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
271 model = devc->model_config;
272 state = devc->model_state;
273 update_sample_rate = FALSE;
276 case SR_CONF_LIMIT_SAMPLES:
277 devc->samples_limit = g_variant_get_uint64(data);
280 case SR_CONF_LIMIT_FRAMES:
281 devc->frame_limit = g_variant_get_uint64(data);
284 case SR_CONF_TRIGGER_SOURCE:
285 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
287 state->trigger_source = idx;
288 g_snprintf(command, sizeof(command),
289 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
290 (*model->trigger_sources)[idx]);
291 ret = sr_scpi_send(sdi->conn, command);
295 return SR_ERR_CHANNEL_GROUP;
296 if ((idx = std_u64_tuple_idx(data, *model->vdivs, model->num_vdivs)) < 0)
298 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
300 state->analog_channels[j].vdiv = idx;
301 g_ascii_formatd(float_str, sizeof(float_str), "%E",
302 (float) (*model->vdivs)[idx][0] / (*model->vdivs)[idx][1]);
303 g_snprintf(command, sizeof(command),
304 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
306 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
307 sr_scpi_get_opc(sdi->conn) != SR_OK)
311 case SR_CONF_TIMEBASE:
312 if ((idx = std_u64_tuple_idx(data, *model->timebases, model->num_timebases)) < 0)
314 state->timebase = idx;
315 g_ascii_formatd(float_str, sizeof(float_str), "%E",
316 (float) (*model->timebases)[idx][0] / (*model->timebases)[idx][1]);
317 g_snprintf(command, sizeof(command),
318 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
320 ret = sr_scpi_send(sdi->conn, command);
321 update_sample_rate = TRUE;
323 case SR_CONF_HORIZ_TRIGGERPOS:
324 tmp_d = g_variant_get_double(data);
325 if (tmp_d < 0.0 || tmp_d > 1.0)
327 state->horiz_triggerpos = tmp_d;
328 tmp_d = -(tmp_d - 0.5) *
329 ((double) (*model->timebases)[state->timebase][0] /
330 (*model->timebases)[state->timebase][1])
332 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
333 g_snprintf(command, sizeof(command),
334 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
336 ret = sr_scpi_send(sdi->conn, command);
338 case SR_CONF_TRIGGER_SLOPE:
339 if ((idx = std_str_idx(data, *model->trigger_slopes, model->num_trigger_slopes)) < 0)
341 state->trigger_slope = idx;
342 g_snprintf(command, sizeof(command),
343 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
344 (*model->trigger_slopes)[idx]);
345 ret = sr_scpi_send(sdi->conn, command);
347 case SR_CONF_TRIGGER_PATTERN:
348 tmp_str = (char *)g_variant_get_string(data, 0);
349 idx = strlen(tmp_str);
350 if (idx == 0 || idx > model->analog_channels + model->digital_channels)
352 g_snprintf(command, sizeof(command),
353 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_PATTERN],
355 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
356 sr_scpi_get_opc(sdi->conn) != SR_OK)
358 g_free(state->trigger_pattern);
359 state->trigger_pattern = g_strdup(tmp_str);
362 case SR_CONF_COUPLING:
364 return SR_ERR_CHANNEL_GROUP;
365 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
367 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
369 state->analog_channels[j].coupling = idx;
370 g_snprintf(command, sizeof(command),
371 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
372 j + 1, (*model->coupling_options)[idx]);
373 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
374 sr_scpi_get_opc(sdi->conn) != SR_OK)
378 case SR_CONF_LOGIC_THRESHOLD:
380 return SR_ERR_CHANNEL_GROUP;
381 if (cg_type != CG_DIGITAL)
385 if ((idx = std_str_idx(data, *model->logic_threshold, model->num_logic_threshold)) < 0)
387 if ((j = std_cg_idx(cg, devc->digital_groups, model->digital_pods)) < 0)
389 g_snprintf(command, sizeof(command),
390 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_THRESHOLD],
391 j + 1, (*model->logic_threshold)[idx]);
392 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
393 sr_scpi_get_opc(sdi->conn) != SR_OK)
395 state->digital_pods[j].threshold = idx;
398 case SR_CONF_LOGIC_THRESHOLD_CUSTOM:
400 return SR_ERR_CHANNEL_GROUP;
401 if (cg_type != CG_DIGITAL)
405 if ((j = std_cg_idx(cg, devc->digital_groups, model->digital_pods)) < 0)
407 tmp_d = g_variant_get_double(data);
408 if (tmp_d < -2.0 || tmp_d > 8.0)
410 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
411 g_snprintf(command, sizeof(command),
412 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_USER_THRESHOLD],
413 j + 1, 2, float_str); // USER2 for custom logic_threshold setting
414 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
415 sr_scpi_get_opc(sdi->conn) != SR_OK)
417 g_snprintf(command, sizeof(command),
418 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_THRESHOLD],
420 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
421 sr_scpi_get_opc(sdi->conn) != SR_OK)
423 state->digital_pods[j].user_threshold = tmp_d;
432 ret = sr_scpi_get_opc(sdi->conn);
434 if (ret == SR_OK && update_sample_rate)
435 ret = hmo_update_sample_rate(sdi);
440 static int config_list(uint32_t key, GVariant **data,
441 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
443 int cg_type = CG_NONE;
444 struct dev_context *devc = NULL;
445 const struct scope_config *model = NULL;
449 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
452 model = devc->model_config;
456 case SR_CONF_SCAN_OPTIONS:
457 *data = std_gvar_array_u32(ARRAY_AND_SIZE(scanopts));
459 case SR_CONF_DEVICE_OPTIONS:
462 *data = std_gvar_array_u32(*model->devopts, model->num_devopts);
464 *data = std_gvar_array_u32(ARRAY_AND_SIZE(drvopts));
465 } else if (cg_type == CG_ANALOG) {
466 *data = std_gvar_array_u32(*model->devopts_cg_analog, model->num_devopts_cg_analog);
467 } else if (cg_type == CG_DIGITAL) {
468 *data = std_gvar_array_u32(*model->devopts_cg_digital, model->num_devopts_cg_digital);
470 *data = std_gvar_array_u32(NULL, 0);
473 case SR_CONF_COUPLING:
475 return SR_ERR_CHANNEL_GROUP;
478 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
480 case SR_CONF_TRIGGER_SOURCE:
483 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
485 case SR_CONF_TRIGGER_SLOPE:
488 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
490 case SR_CONF_TIMEBASE:
493 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
497 return SR_ERR_CHANNEL_GROUP;
500 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
502 case SR_CONF_LOGIC_THRESHOLD:
504 return SR_ERR_CHANNEL_GROUP;
507 *data = g_variant_new_strv(*model->logic_threshold, model->num_logic_threshold);
516 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
518 char command[MAX_COMMAND_SIZE];
519 struct sr_channel *ch;
520 struct dev_context *devc;
521 const struct scope_config *model;
524 model = devc->model_config;
526 ch = devc->current_channel->data;
529 case SR_CHANNEL_ANALOG:
530 g_snprintf(command, sizeof(command),
531 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
532 #ifdef WORDS_BIGENDIAN
539 case SR_CHANNEL_LOGIC:
540 g_snprintf(command, sizeof(command),
541 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
542 ch->index < 8 ? 1 : 2);
545 sr_err("Invalid channel type.");
549 return sr_scpi_send(sdi->conn, command);
552 static int hmo_check_channels(GSList *channels)
555 struct sr_channel *ch;
556 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
557 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
560 /* Preset "not enabled" for all channels / pods. */
561 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
562 enabled_chan[idx] = FALSE;
563 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
564 enabled_pod[idx] = FALSE;
567 * Determine which channels / pods are required for the caller's
568 * specified configuration.
570 for (l = channels; l; l = l->next) {
573 case SR_CHANNEL_ANALOG:
575 if (idx < ARRAY_SIZE(enabled_chan))
576 enabled_chan[idx] = TRUE;
578 case SR_CHANNEL_LOGIC:
580 if (idx < ARRAY_SIZE(enabled_pod))
581 enabled_pod[idx] = TRUE;
589 * Check for resource conflicts. Some channels can be either
590 * analog or digital, but never both at the same time.
592 * Note that the constraints might depend on the specific model.
593 * These tests might need some adjustment when support for more
594 * models gets added to the driver.
596 if (enabled_pod[0] && enabled_chan[2])
598 if (enabled_pod[1] && enabled_chan[3])
603 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
607 gboolean *pod_enabled, setup_changed;
608 char command[MAX_COMMAND_SIZE];
609 struct scope_state *state;
610 const struct scope_config *model;
611 struct sr_channel *ch;
612 struct dev_context *devc;
613 struct sr_scpi_dev_inst *scpi;
618 state = devc->model_state;
619 model = devc->model_config;
620 setup_changed = FALSE;
622 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
624 for (l = sdi->channels; l; l = l->next) {
627 case SR_CHANNEL_ANALOG:
628 if (ch->enabled == state->analog_channels[ch->index].state)
630 g_snprintf(command, sizeof(command),
631 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
632 ch->index + 1, ch->enabled);
634 if (sr_scpi_send(scpi, command) != SR_OK) {
638 state->analog_channels[ch->index].state = ch->enabled;
639 setup_changed = TRUE;
641 case SR_CHANNEL_LOGIC:
643 * A digital POD needs to be enabled for every group of
647 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
649 if (ch->enabled == state->digital_channels[ch->index])
651 g_snprintf(command, sizeof(command),
652 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
653 ch->index, ch->enabled);
655 if (sr_scpi_send(scpi, command) != SR_OK) {
660 state->digital_channels[ch->index] = ch->enabled;
661 setup_changed = TRUE;
670 for (i = 0; i < model->digital_pods; i++) {
671 if (state->digital_pods[i].state == pod_enabled[i])
673 g_snprintf(command, sizeof(command),
674 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
675 i + 1, pod_enabled[i]);
676 if (sr_scpi_send(scpi, command) != SR_OK) {
680 state->digital_pods[i].state = pod_enabled[i];
681 setup_changed = TRUE;
687 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
693 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
696 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
697 size_t group, pod_count;
698 struct sr_channel *ch;
699 struct dev_context *devc;
700 struct sr_scpi_dev_inst *scpi;
706 devc->num_samples = 0;
707 devc->num_frames = 0;
709 /* Preset empty results. */
710 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
711 digital_added[group] = FALSE;
712 g_slist_free(devc->enabled_channels);
713 devc->enabled_channels = NULL;
716 * Contruct the list of enabled channels. Determine the highest
717 * number of digital pods involved in the acquisition.
720 for (l = sdi->channels; l; l = l->next) {
724 /* Only add a single digital channel per group (pod). */
725 group = ch->index / 8;
726 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
727 devc->enabled_channels = g_slist_append(
728 devc->enabled_channels, ch);
729 if (ch->type == SR_CHANNEL_LOGIC) {
730 digital_added[group] = TRUE;
731 if (pod_count < group + 1)
732 pod_count = group + 1;
736 if (!devc->enabled_channels)
738 devc->pod_count = pod_count;
739 devc->logic_data = NULL;
742 * Check constraints. Some channels can be either analog or
743 * digital, but not both at the same time.
745 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
746 sr_err("Invalid channel configuration specified!");
752 * Configure the analog and digital channels and the
753 * corresponding digital pods.
755 if (hmo_setup_channels(sdi) != SR_OK) {
756 sr_err("Failed to setup channel configuration!");
762 * Start acquisition on the first enabled channel. The
763 * receive routine will continue driving the acquisition.
765 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
766 hmo_receive_data, (void *)sdi);
768 std_session_send_df_header(sdi);
770 devc->current_channel = devc->enabled_channels;
772 return hmo_request_data(sdi);
775 g_slist_free(devc->enabled_channels);
776 devc->enabled_channels = NULL;
780 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
782 struct dev_context *devc;
783 struct sr_scpi_dev_inst *scpi;
785 std_session_send_df_end(sdi);
789 devc->num_samples = 0;
790 devc->num_frames = 0;
791 g_slist_free(devc->enabled_channels);
792 devc->enabled_channels = NULL;
794 sr_scpi_source_remove(sdi->session, scpi);
799 static struct sr_dev_driver hameg_hmo_driver_info = {
801 .longname = "Hameg HMO",
804 .cleanup = std_cleanup,
806 .dev_list = std_dev_list,
807 .dev_clear = dev_clear,
808 .config_get = config_get,
809 .config_set = config_set,
810 .config_list = config_list,
811 .dev_open = dev_open,
812 .dev_close = dev_close,
813 .dev_acquisition_start = dev_acquisition_start,
814 .dev_acquisition_stop = dev_acquisition_stop,
817 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);