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/>.
25 #define SERIALCOMM "115200/8n1/flow=1"
27 static struct sr_dev_driver hameg_hmo_driver_info;
29 static const char *manufacturers[] = {
34 static const uint32_t scanopts[] = {
39 static const uint32_t drvopts[] = {
50 static int check_manufacturer(const char *manufacturer)
54 for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
55 if (!strcmp(manufacturer, manufacturers[i]))
61 static struct sr_dev_inst *hmo_probe_serial_device(struct sr_scpi_dev_inst *scpi)
63 struct sr_dev_inst *sdi;
64 struct dev_context *devc;
65 struct sr_scpi_hw_info *hw_info;
71 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
72 sr_info("Couldn't get IDN response.");
76 if (check_manufacturer(hw_info->manufacturer) != SR_OK)
79 sdi = g_malloc0(sizeof(struct sr_dev_inst));
80 sdi->vendor = g_strdup(hw_info->manufacturer);
81 sdi->model = g_strdup(hw_info->model);
82 sdi->version = g_strdup(hw_info->firmware_version);
83 sdi->serial_num = g_strdup(hw_info->serial_number);
84 sdi->driver = &hameg_hmo_driver_info;
85 sdi->inst_type = SR_INST_SCPI;
88 sr_scpi_hw_info_free(hw_info);
91 devc = g_malloc0(sizeof(struct dev_context));
95 if (hmo_init_device(sdi) != SR_OK)
101 sr_scpi_hw_info_free(hw_info);
102 sr_dev_inst_free(sdi);
108 static GSList *scan(struct sr_dev_driver *di, GSList *options)
110 return sr_scpi_scan(di->context, options, hmo_probe_serial_device);
113 static void clear_helper(struct dev_context *devc)
115 hmo_scope_state_free(devc->model_state);
116 g_free(devc->analog_groups);
117 g_free(devc->digital_groups);
120 static int dev_clear(const struct sr_dev_driver *di)
122 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
125 static int dev_open(struct sr_dev_inst *sdi)
127 if (sr_scpi_open(sdi->conn) != SR_OK)
130 if (hmo_scope_state_get(sdi) != SR_OK)
136 static int dev_close(struct sr_dev_inst *sdi)
138 return sr_scpi_close(sdi->conn);
141 static int check_channel_group(struct dev_context *devc,
142 const struct sr_channel_group *cg)
145 const struct scope_config *model;
147 model = devc->model_config;
152 for (i = 0; i < model->analog_channels; i++)
153 if (cg == devc->analog_groups[i])
156 for (i = 0; i < model->digital_pods; i++)
157 if (cg == devc->digital_groups[i])
160 sr_err("Invalid channel group specified.");
165 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
166 const struct sr_channel_group *cg)
170 struct dev_context *devc;
171 const struct scope_config *model;
172 struct scope_state *state;
179 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
183 model = devc->model_config;
184 state = devc->model_state;
187 case SR_CONF_NUM_HDIV:
188 *data = g_variant_new_int32(model->num_xdivs);
191 case SR_CONF_TIMEBASE:
192 *data = g_variant_new("(tt)", (*model->timebases)[state->timebase][0],
193 (*model->timebases)[state->timebase][1]);
196 case SR_CONF_NUM_VDIV:
197 if (cg_type == CG_NONE) {
198 sr_err("No channel group specified.");
199 return SR_ERR_CHANNEL_GROUP;
200 } else if (cg_type == CG_ANALOG) {
201 for (i = 0; i < model->analog_channels; i++) {
202 if (cg != devc->analog_groups[i])
204 *data = g_variant_new_int32(model->num_ydivs);
214 if (cg_type == CG_NONE) {
215 sr_err("No channel group specified.");
216 return SR_ERR_CHANNEL_GROUP;
217 } else if (cg_type == CG_ANALOG) {
218 for (i = 0; i < model->analog_channels; i++) {
219 if (cg != devc->analog_groups[i])
221 *data = g_variant_new("(tt)",
222 (*model->vdivs)[state->analog_channels[i].vdiv][0],
223 (*model->vdivs)[state->analog_channels[i].vdiv][1]);
232 case SR_CONF_TRIGGER_SOURCE:
233 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
236 case SR_CONF_TRIGGER_SLOPE:
237 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
240 case SR_CONF_HORIZ_TRIGGERPOS:
241 *data = g_variant_new_double(state->horiz_triggerpos);
244 case SR_CONF_COUPLING:
245 if (cg_type == CG_NONE) {
246 sr_err("No channel group specified.");
247 return SR_ERR_CHANNEL_GROUP;
248 } else if (cg_type == CG_ANALOG) {
249 for (i = 0; i < model->analog_channels; i++) {
250 if (cg != devc->analog_groups[i])
252 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
261 case SR_CONF_SAMPLERATE:
262 *data = g_variant_new_uint64(state->sample_rate);
272 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
273 const struct sr_channel_group *cg)
277 char command[MAX_COMMAND_SIZE], float_str[30];
278 struct dev_context *devc;
279 const struct scope_config *model;
280 struct scope_state *state;
284 gboolean update_sample_rate;
291 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
294 model = devc->model_config;
295 state = devc->model_state;
296 update_sample_rate = FALSE;
301 case SR_CONF_LIMIT_FRAMES:
302 devc->frame_limit = g_variant_get_uint64(data);
305 case SR_CONF_TRIGGER_SOURCE:
306 tmp = g_variant_get_string(data, NULL);
307 for (i = 0; (*model->trigger_sources)[i]; i++) {
308 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
310 state->trigger_source = i;
311 g_snprintf(command, sizeof(command),
312 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
313 (*model->trigger_sources)[i]);
315 ret = sr_scpi_send(sdi->conn, command);
320 if (cg_type == CG_NONE) {
321 sr_err("No channel group specified.");
322 return SR_ERR_CHANNEL_GROUP;
325 g_variant_get(data, "(tt)", &p, &q);
327 for (i = 0; i < model->num_vdivs; i++) {
328 if (p != (*model->vdivs)[i][0] ||
329 q != (*model->vdivs)[i][1])
331 for (j = 1; j <= model->analog_channels; j++) {
332 if (cg != devc->analog_groups[j - 1])
334 state->analog_channels[j - 1].vdiv = i;
335 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
336 g_snprintf(command, sizeof(command),
337 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
340 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
341 sr_scpi_get_opc(sdi->conn) != SR_OK)
351 case SR_CONF_TIMEBASE:
352 g_variant_get(data, "(tt)", &p, &q);
354 for (i = 0; i < model->num_timebases; i++) {
355 if (p != (*model->timebases)[i][0] ||
356 q != (*model->timebases)[i][1])
359 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
360 g_snprintf(command, sizeof(command),
361 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
364 ret = sr_scpi_send(sdi->conn, command);
365 update_sample_rate = TRUE;
369 case SR_CONF_HORIZ_TRIGGERPOS:
370 tmp_d = g_variant_get_double(data);
372 if (tmp_d < 0.0 || tmp_d > 1.0)
375 state->horiz_triggerpos = tmp_d;
376 tmp_d = -(tmp_d - 0.5) *
377 ((double) (*model->timebases)[state->timebase][0] /
378 (*model->timebases)[state->timebase][1])
381 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
382 g_snprintf(command, sizeof(command),
383 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
386 ret = sr_scpi_send(sdi->conn, command);
388 case SR_CONF_TRIGGER_SLOPE:
389 tmp = g_variant_get_string(data, NULL);
390 for (i = 0; (*model->trigger_slopes)[i]; i++) {
391 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
393 state->trigger_slope = i;
394 g_snprintf(command, sizeof(command),
395 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
396 (*model->trigger_slopes)[i]);
398 ret = sr_scpi_send(sdi->conn, command);
402 case SR_CONF_COUPLING:
403 if (cg_type == CG_NONE) {
404 sr_err("No channel group specified.");
405 return SR_ERR_CHANNEL_GROUP;
408 tmp = g_variant_get_string(data, NULL);
410 for (i = 0; (*model->coupling_options)[i]; i++) {
411 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
413 for (j = 1; j <= model->analog_channels; j++) {
414 if (cg != devc->analog_groups[j - 1])
416 state->analog_channels[j-1].coupling = i;
418 g_snprintf(command, sizeof(command),
419 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
422 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
423 sr_scpi_get_opc(sdi->conn) != SR_OK)
438 ret = sr_scpi_get_opc(sdi->conn);
440 if (ret == SR_OK && update_sample_rate)
441 ret = hmo_update_sample_rate(sdi);
446 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
447 const struct sr_channel_group *cg)
449 int cg_type = CG_NONE;
450 struct dev_context *devc = NULL;
451 const struct scope_config *model = NULL;
455 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
458 model = devc->model_config;
462 case SR_CONF_SCAN_OPTIONS:
463 *data = std_gvar_array_u32(ARRAY_AND_SIZE(scanopts));
465 case SR_CONF_DEVICE_OPTIONS:
466 if (cg_type == CG_NONE) {
468 *data = std_gvar_array_u32((const uint32_t *)model->devopts, model->num_devopts);
470 *data = std_gvar_array_u32(ARRAY_AND_SIZE(drvopts));
471 } else if (cg_type == CG_ANALOG) {
472 *data = std_gvar_array_u32((const uint32_t *)model->devopts_cg_analog, model->num_devopts_cg_analog);
474 *data = std_gvar_array_u32(NULL, 0);
477 case SR_CONF_COUPLING:
478 if (cg_type == CG_NONE)
479 return SR_ERR_CHANNEL_GROUP;
480 *data = g_variant_new_strv(*model->coupling_options,
481 g_strv_length((char **)*model->coupling_options));
483 case SR_CONF_TRIGGER_SOURCE:
486 *data = g_variant_new_strv(*model->trigger_sources,
487 g_strv_length((char **)*model->trigger_sources));
489 case SR_CONF_TRIGGER_SLOPE:
492 *data = g_variant_new_strv(*model->trigger_slopes,
493 g_strv_length((char **)*model->trigger_slopes));
495 case SR_CONF_TIMEBASE:
498 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
501 if (cg_type == CG_NONE)
502 return SR_ERR_CHANNEL_GROUP;
503 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
512 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
514 char command[MAX_COMMAND_SIZE];
515 struct sr_channel *ch;
516 struct dev_context *devc;
517 const struct scope_config *model;
520 model = devc->model_config;
522 ch = devc->current_channel->data;
525 case SR_CHANNEL_ANALOG:
526 g_snprintf(command, sizeof(command),
527 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
528 #ifdef WORDS_BIGENDIAN
535 case SR_CHANNEL_LOGIC:
536 g_snprintf(command, sizeof(command),
537 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
538 ch->index < 8 ? 1 : 2);
541 sr_err("Invalid channel type.");
545 return sr_scpi_send(sdi->conn, command);
548 static int hmo_check_channels(GSList *channels)
551 struct sr_channel *ch;
552 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
553 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
556 /* Preset "not enabled" for all channels / pods. */
557 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
558 enabled_chan[idx] = FALSE;
559 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
560 enabled_pod[idx] = FALSE;
563 * Determine which channels / pods are required for the caller's
564 * specified configuration.
566 for (l = channels; l; l = l->next) {
569 case SR_CHANNEL_ANALOG:
571 if (idx < ARRAY_SIZE(enabled_chan))
572 enabled_chan[idx] = TRUE;
574 case SR_CHANNEL_LOGIC:
576 if (idx < ARRAY_SIZE(enabled_pod))
577 enabled_pod[idx] = TRUE;
585 * Check for resource conflicts. Some channels can be either
586 * analog or digital, but never both at the same time.
588 * Note that the constraints might depend on the specific model.
589 * These tests might need some adjustment when support for more
590 * models gets added to the driver.
592 if (enabled_pod[0] && enabled_chan[2])
594 if (enabled_pod[1] && enabled_chan[3])
599 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
603 gboolean *pod_enabled, setup_changed;
604 char command[MAX_COMMAND_SIZE];
605 struct scope_state *state;
606 const struct scope_config *model;
607 struct sr_channel *ch;
608 struct dev_context *devc;
609 struct sr_scpi_dev_inst *scpi;
613 state = devc->model_state;
614 model = devc->model_config;
615 setup_changed = FALSE;
617 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
619 for (l = sdi->channels; l; l = l->next) {
622 case SR_CHANNEL_ANALOG:
623 if (ch->enabled == state->analog_channels[ch->index].state)
625 g_snprintf(command, sizeof(command),
626 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
627 ch->index + 1, ch->enabled);
629 if (sr_scpi_send(scpi, command) != SR_OK)
631 state->analog_channels[ch->index].state = ch->enabled;
632 setup_changed = TRUE;
634 case SR_CHANNEL_LOGIC:
636 * A digital POD needs to be enabled for every group of
640 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
642 if (ch->enabled == state->digital_channels[ch->index])
644 g_snprintf(command, sizeof(command),
645 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
646 ch->index, ch->enabled);
648 if (sr_scpi_send(scpi, command) != SR_OK)
651 state->digital_channels[ch->index] = ch->enabled;
652 setup_changed = TRUE;
659 for (i = 1; i <= model->digital_pods; i++) {
660 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
662 g_snprintf(command, sizeof(command),
663 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
664 i, pod_enabled[i - 1]);
665 if (sr_scpi_send(scpi, command) != SR_OK)
667 state->digital_pods[i - 1] = pod_enabled[i - 1];
668 setup_changed = TRUE;
673 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
679 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
682 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
683 size_t group, pod_count;
684 struct sr_channel *ch;
685 struct dev_context *devc;
686 struct sr_scpi_dev_inst *scpi;
692 /* Preset empty results. */
693 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
694 digital_added[group] = FALSE;
695 g_slist_free(devc->enabled_channels);
696 devc->enabled_channels = NULL;
699 * Contruct the list of enabled channels. Determine the highest
700 * number of digital pods involved in the acquisition.
703 for (l = sdi->channels; l; l = l->next) {
707 /* Only add a single digital channel per group (pod). */
708 group = ch->index / 8;
709 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
710 devc->enabled_channels = g_slist_append(
711 devc->enabled_channels, ch);
712 if (ch->type == SR_CHANNEL_LOGIC) {
713 digital_added[group] = TRUE;
714 if (pod_count < group + 1)
715 pod_count = group + 1;
719 if (!devc->enabled_channels)
721 devc->pod_count = pod_count;
722 devc->logic_data = NULL;
725 * Check constraints. Some channels can be either analog or
726 * digital, but not both at the same time.
728 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
729 sr_err("Invalid channel configuration specified!");
735 * Configure the analog and digital channels and the
736 * corresponding digital pods.
738 if (hmo_setup_channels(sdi) != SR_OK) {
739 sr_err("Failed to setup channel configuration!");
745 * Start acquisition on the first enabled channel. The
746 * receive routine will continue driving the acquisition.
748 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
749 hmo_receive_data, (void *)sdi);
751 std_session_send_df_header(sdi);
753 devc->current_channel = devc->enabled_channels;
755 return hmo_request_data(sdi);
758 g_slist_free(devc->enabled_channels);
759 devc->enabled_channels = NULL;
763 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
765 struct dev_context *devc;
766 struct sr_scpi_dev_inst *scpi;
768 std_session_send_df_end(sdi);
772 devc->num_frames = 0;
773 g_slist_free(devc->enabled_channels);
774 devc->enabled_channels = NULL;
776 sr_scpi_source_remove(sdi->session, scpi);
781 static struct sr_dev_driver hameg_hmo_driver_info = {
783 .longname = "Hameg HMO",
786 .cleanup = std_cleanup,
788 .dev_list = std_dev_list,
789 .dev_clear = dev_clear,
790 .config_get = config_get,
791 .config_set = config_set,
792 .config_list = config_list,
793 .dev_open = dev_open,
794 .dev_close = dev_close,
795 .dev_acquisition_start = dev_acquisition_start,
796 .dev_acquisition_stop = dev_acquisition_stop,
799 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);