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 drvopts[] = {
38 static const uint32_t scanopts[] = {
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 GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
275 GVariant *rational[2];
278 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
280 for (i = 0; i < n; i++) {
281 rational[0] = g_variant_new_uint64((*array)[i][0]);
282 rational[1] = g_variant_new_uint64((*array)[i][1]);
284 /* FIXME: Valgrind reports a memory leak here. */
285 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
288 return g_variant_builder_end(&gvb);
291 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
292 const struct sr_channel_group *cg)
296 char command[MAX_COMMAND_SIZE], float_str[30];
297 struct dev_context *devc;
298 const struct scope_config *model;
299 struct scope_state *state;
303 gboolean update_sample_rate;
310 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
313 model = devc->model_config;
314 state = devc->model_state;
315 update_sample_rate = FALSE;
320 case SR_CONF_LIMIT_FRAMES:
321 devc->frame_limit = g_variant_get_uint64(data);
324 case SR_CONF_TRIGGER_SOURCE:
325 tmp = g_variant_get_string(data, NULL);
326 for (i = 0; (*model->trigger_sources)[i]; i++) {
327 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
329 state->trigger_source = i;
330 g_snprintf(command, sizeof(command),
331 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
332 (*model->trigger_sources)[i]);
334 ret = sr_scpi_send(sdi->conn, command);
339 if (cg_type == CG_NONE) {
340 sr_err("No channel group specified.");
341 return SR_ERR_CHANNEL_GROUP;
344 g_variant_get(data, "(tt)", &p, &q);
346 for (i = 0; i < model->num_vdivs; i++) {
347 if (p != (*model->vdivs)[i][0] ||
348 q != (*model->vdivs)[i][1])
350 for (j = 1; j <= model->analog_channels; j++) {
351 if (cg != devc->analog_groups[j - 1])
353 state->analog_channels[j - 1].vdiv = i;
354 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
355 g_snprintf(command, sizeof(command),
356 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
359 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
360 sr_scpi_get_opc(sdi->conn) != SR_OK)
370 case SR_CONF_TIMEBASE:
371 g_variant_get(data, "(tt)", &p, &q);
373 for (i = 0; i < model->num_timebases; i++) {
374 if (p != (*model->timebases)[i][0] ||
375 q != (*model->timebases)[i][1])
378 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
379 g_snprintf(command, sizeof(command),
380 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
383 ret = sr_scpi_send(sdi->conn, command);
384 update_sample_rate = TRUE;
388 case SR_CONF_HORIZ_TRIGGERPOS:
389 tmp_d = g_variant_get_double(data);
391 if (tmp_d < 0.0 || tmp_d > 1.0)
394 state->horiz_triggerpos = tmp_d;
395 tmp_d = -(tmp_d - 0.5) *
396 ((double) (*model->timebases)[state->timebase][0] /
397 (*model->timebases)[state->timebase][1])
400 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
401 g_snprintf(command, sizeof(command),
402 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
405 ret = sr_scpi_send(sdi->conn, command);
407 case SR_CONF_TRIGGER_SLOPE:
408 tmp = g_variant_get_string(data, NULL);
409 for (i = 0; (*model->trigger_slopes)[i]; i++) {
410 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
412 state->trigger_slope = i;
413 g_snprintf(command, sizeof(command),
414 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
415 (*model->trigger_slopes)[i]);
417 ret = sr_scpi_send(sdi->conn, command);
421 case SR_CONF_COUPLING:
422 if (cg_type == CG_NONE) {
423 sr_err("No channel group specified.");
424 return SR_ERR_CHANNEL_GROUP;
427 tmp = g_variant_get_string(data, NULL);
429 for (i = 0; (*model->coupling_options)[i]; i++) {
430 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
432 for (j = 1; j <= model->analog_channels; j++) {
433 if (cg != devc->analog_groups[j - 1])
435 state->analog_channels[j-1].coupling = i;
437 g_snprintf(command, sizeof(command),
438 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
441 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
442 sr_scpi_get_opc(sdi->conn) != SR_OK)
457 ret = sr_scpi_get_opc(sdi->conn);
459 if (ret == SR_OK && update_sample_rate)
460 ret = hmo_update_sample_rate(sdi);
465 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
466 const struct sr_channel_group *cg)
468 int cg_type = CG_NONE;
469 struct dev_context *devc = NULL;
470 const struct scope_config *model = NULL;
474 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
477 model = devc->model_config;
481 case SR_CONF_SCAN_OPTIONS:
482 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
483 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
485 case SR_CONF_DEVICE_OPTIONS:
486 if (cg_type == CG_NONE) {
488 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
489 model->devopts, model->num_devopts, sizeof(uint32_t));
491 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
492 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
493 } else if (cg_type == CG_ANALOG) {
494 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
495 model->analog_devopts, model->num_analog_devopts,
498 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
499 NULL, 0, sizeof(uint32_t));
502 case SR_CONF_COUPLING:
503 if (cg_type == CG_NONE)
504 return SR_ERR_CHANNEL_GROUP;
505 *data = g_variant_new_strv(*model->coupling_options,
506 g_strv_length((char **)*model->coupling_options));
508 case SR_CONF_TRIGGER_SOURCE:
511 *data = g_variant_new_strv(*model->trigger_sources,
512 g_strv_length((char **)*model->trigger_sources));
514 case SR_CONF_TRIGGER_SLOPE:
517 *data = g_variant_new_strv(*model->trigger_slopes,
518 g_strv_length((char **)*model->trigger_slopes));
520 case SR_CONF_TIMEBASE:
523 *data = build_tuples(model->timebases, model->num_timebases);
526 if (cg_type == CG_NONE)
527 return SR_ERR_CHANNEL_GROUP;
528 *data = build_tuples(model->vdivs, model->num_vdivs);
537 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
539 char command[MAX_COMMAND_SIZE];
540 struct sr_channel *ch;
541 struct dev_context *devc;
542 const struct scope_config *model;
545 model = devc->model_config;
547 ch = devc->current_channel->data;
550 case SR_CHANNEL_ANALOG:
551 g_snprintf(command, sizeof(command),
552 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
553 #ifdef WORDS_BIGENDIAN
560 case SR_CHANNEL_LOGIC:
561 g_snprintf(command, sizeof(command),
562 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
563 ch->index < 8 ? 1 : 2);
566 sr_err("Invalid channel type.");
570 return sr_scpi_send(sdi->conn, command);
573 static int hmo_check_channels(GSList *channels)
576 struct sr_channel *ch;
577 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
578 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
581 /* Preset "not enabled" for all channels / pods. */
582 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
583 enabled_chan[idx] = FALSE;
584 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
585 enabled_pod[idx] = FALSE;
588 * Determine which channels / pods are required for the caller's
589 * specified configuration.
591 for (l = channels; l; l = l->next) {
594 case SR_CHANNEL_ANALOG:
596 if (idx < ARRAY_SIZE(enabled_chan))
597 enabled_chan[idx] = TRUE;
599 case SR_CHANNEL_LOGIC:
601 if (idx < ARRAY_SIZE(enabled_pod))
602 enabled_pod[idx] = TRUE;
610 * Check for resource conflicts. Some channels can be either
611 * analog or digital, but never both at the same time.
613 * Note that the constraints might depend on the specific model.
614 * These tests might need some adjustment when support for more
615 * models gets added to the driver.
617 if (enabled_pod[0] && enabled_chan[2])
619 if (enabled_pod[1] && enabled_chan[3])
624 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
628 gboolean *pod_enabled, setup_changed;
629 char command[MAX_COMMAND_SIZE];
630 struct scope_state *state;
631 const struct scope_config *model;
632 struct sr_channel *ch;
633 struct dev_context *devc;
634 struct sr_scpi_dev_inst *scpi;
638 state = devc->model_state;
639 model = devc->model_config;
640 setup_changed = FALSE;
642 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
644 for (l = sdi->channels; l; l = l->next) {
647 case SR_CHANNEL_ANALOG:
648 if (ch->enabled == state->analog_channels[ch->index].state)
650 g_snprintf(command, sizeof(command),
651 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
652 ch->index + 1, ch->enabled);
654 if (sr_scpi_send(scpi, command) != SR_OK)
656 state->analog_channels[ch->index].state = ch->enabled;
657 setup_changed = TRUE;
659 case SR_CHANNEL_LOGIC:
661 * A digital POD needs to be enabled for every group of
665 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
667 if (ch->enabled == state->digital_channels[ch->index])
669 g_snprintf(command, sizeof(command),
670 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
671 ch->index, ch->enabled);
673 if (sr_scpi_send(scpi, command) != SR_OK)
676 state->digital_channels[ch->index] = ch->enabled;
677 setup_changed = TRUE;
684 for (i = 1; i <= model->digital_pods; i++) {
685 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
687 g_snprintf(command, sizeof(command),
688 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
689 i, pod_enabled[i - 1]);
690 if (sr_scpi_send(scpi, command) != SR_OK)
692 state->digital_pods[i - 1] = pod_enabled[i - 1];
693 setup_changed = TRUE;
698 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
704 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
707 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
708 size_t group, pod_count;
709 struct sr_channel *ch;
710 struct dev_context *devc;
711 struct sr_scpi_dev_inst *scpi;
717 /* Preset empty results. */
718 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
719 digital_added[group] = FALSE;
720 g_slist_free(devc->enabled_channels);
721 devc->enabled_channels = NULL;
724 * Contruct the list of enabled channels. Determine the highest
725 * number of digital pods involved in the acquisition.
728 for (l = sdi->channels; l; l = l->next) {
732 /* Only add a single digital channel per group (pod). */
733 group = ch->index / 8;
734 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
735 devc->enabled_channels = g_slist_append(
736 devc->enabled_channels, ch);
737 if (ch->type == SR_CHANNEL_LOGIC) {
738 digital_added[group] = TRUE;
739 if (pod_count < group + 1)
740 pod_count = group + 1;
744 if (!devc->enabled_channels)
746 devc->pod_count = pod_count;
747 devc->logic_data = NULL;
750 * Check constraints. Some channels can be either analog or
751 * digital, but not both at the same time.
753 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
754 sr_err("Invalid channel configuration specified!");
760 * Configure the analog and digital channels and the
761 * corresponding digital pods.
763 if (hmo_setup_channels(sdi) != SR_OK) {
764 sr_err("Failed to setup channel configuration!");
770 * Start acquisition on the first enabled channel. The
771 * receive routine will continue driving the acquisition.
773 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
774 hmo_receive_data, (void *)sdi);
776 std_session_send_df_header(sdi);
778 devc->current_channel = devc->enabled_channels;
780 return hmo_request_data(sdi);
783 g_slist_free(devc->enabled_channels);
784 devc->enabled_channels = NULL;
788 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
790 struct dev_context *devc;
791 struct sr_scpi_dev_inst *scpi;
793 std_session_send_df_end(sdi);
797 devc->num_frames = 0;
798 g_slist_free(devc->enabled_channels);
799 devc->enabled_channels = NULL;
801 sr_scpi_source_remove(sdi->session, scpi);
806 static struct sr_dev_driver hameg_hmo_driver_info = {
808 .longname = "Hameg HMO",
811 .cleanup = std_cleanup,
813 .dev_list = std_dev_list,
814 .dev_clear = dev_clear,
815 .config_get = config_get,
816 .config_set = config_set,
817 .config_list = config_list,
818 .dev_open = dev_open,
819 .dev_close = dev_close,
820 .dev_acquisition_start = dev_acquisition_start,
821 .dev_acquisition_stop = dev_acquisition_stop,
824 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);