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(void *priv)
115 struct dev_context *devc;
119 hmo_scope_state_free(devc->model_state);
121 g_free(devc->analog_groups);
122 g_free(devc->digital_groups);
127 static int dev_clear(const struct sr_dev_driver *di)
129 return std_dev_clear(di, clear_helper);
132 static int dev_open(struct sr_dev_inst *sdi)
134 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
137 if (hmo_scope_state_get(sdi) != SR_OK)
140 sdi->status = SR_ST_ACTIVE;
145 static int dev_close(struct sr_dev_inst *sdi)
147 if (sdi->status == SR_ST_INACTIVE)
150 sr_scpi_close(sdi->conn);
152 sdi->status = SR_ST_INACTIVE;
157 static int check_channel_group(struct dev_context *devc,
158 const struct sr_channel_group *cg)
161 const struct scope_config *model;
163 model = devc->model_config;
168 for (i = 0; i < model->analog_channels; i++)
169 if (cg == devc->analog_groups[i])
172 for (i = 0; i < model->digital_pods; i++)
173 if (cg == devc->digital_groups[i])
176 sr_err("Invalid channel group specified.");
181 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
182 const struct sr_channel_group *cg)
186 struct dev_context *devc;
187 const struct scope_config *model;
188 struct scope_state *state;
195 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
199 model = devc->model_config;
200 state = devc->model_state;
203 case SR_CONF_NUM_HDIV:
204 *data = g_variant_new_int32(model->num_xdivs);
207 case SR_CONF_TIMEBASE:
208 *data = g_variant_new("(tt)", (*model->timebases)[state->timebase][0],
209 (*model->timebases)[state->timebase][1]);
212 case SR_CONF_NUM_VDIV:
213 if (cg_type == CG_NONE) {
214 sr_err("No channel group specified.");
215 return SR_ERR_CHANNEL_GROUP;
216 } else if (cg_type == CG_ANALOG) {
217 for (i = 0; i < model->analog_channels; i++) {
218 if (cg != devc->analog_groups[i])
220 *data = g_variant_new_int32(model->num_ydivs);
230 if (cg_type == CG_NONE) {
231 sr_err("No channel group specified.");
232 return SR_ERR_CHANNEL_GROUP;
233 } else if (cg_type == CG_ANALOG) {
234 for (i = 0; i < model->analog_channels; i++) {
235 if (cg != devc->analog_groups[i])
237 *data = g_variant_new("(tt)",
238 (*model->vdivs)[state->analog_channels[i].vdiv][0],
239 (*model->vdivs)[state->analog_channels[i].vdiv][1]);
248 case SR_CONF_TRIGGER_SOURCE:
249 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
252 case SR_CONF_TRIGGER_SLOPE:
253 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
256 case SR_CONF_HORIZ_TRIGGERPOS:
257 *data = g_variant_new_double(state->horiz_triggerpos);
260 case SR_CONF_COUPLING:
261 if (cg_type == CG_NONE) {
262 sr_err("No channel group specified.");
263 return SR_ERR_CHANNEL_GROUP;
264 } else if (cg_type == CG_ANALOG) {
265 for (i = 0; i < model->analog_channels; i++) {
266 if (cg != devc->analog_groups[i])
268 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
277 case SR_CONF_SAMPLERATE:
278 *data = g_variant_new_uint64(state->sample_rate);
288 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
291 GVariant *rational[2];
294 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
296 for (i = 0; i < n; i++) {
297 rational[0] = g_variant_new_uint64((*array)[i][0]);
298 rational[1] = g_variant_new_uint64((*array)[i][1]);
300 /* FIXME: Valgrind reports a memory leak here. */
301 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
304 return g_variant_builder_end(&gvb);
307 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
308 const struct sr_channel_group *cg)
312 char command[MAX_COMMAND_SIZE], float_str[30];
313 struct dev_context *devc;
314 const struct scope_config *model;
315 struct scope_state *state;
319 gboolean update_sample_rate;
326 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
329 model = devc->model_config;
330 state = devc->model_state;
331 update_sample_rate = FALSE;
336 case SR_CONF_LIMIT_FRAMES:
337 devc->frame_limit = g_variant_get_uint64(data);
340 case SR_CONF_TRIGGER_SOURCE:
341 tmp = g_variant_get_string(data, NULL);
342 for (i = 0; (*model->trigger_sources)[i]; i++) {
343 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
345 state->trigger_source = i;
346 g_snprintf(command, sizeof(command),
347 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
348 (*model->trigger_sources)[i]);
350 ret = sr_scpi_send(sdi->conn, command);
355 if (cg_type == CG_NONE) {
356 sr_err("No channel group specified.");
357 return SR_ERR_CHANNEL_GROUP;
360 g_variant_get(data, "(tt)", &p, &q);
362 for (i = 0; i < model->num_vdivs; i++) {
363 if (p != (*model->vdivs)[i][0] ||
364 q != (*model->vdivs)[i][1])
366 for (j = 1; j <= model->analog_channels; j++) {
367 if (cg != devc->analog_groups[j - 1])
369 state->analog_channels[j - 1].vdiv = i;
370 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
371 g_snprintf(command, sizeof(command),
372 (*model->scpi_dialect)[SCPI_CMD_SET_VERTICAL_DIV],
375 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
376 sr_scpi_get_opc(sdi->conn) != SR_OK)
386 case SR_CONF_TIMEBASE:
387 g_variant_get(data, "(tt)", &p, &q);
389 for (i = 0; i < model->num_timebases; i++) {
390 if (p != (*model->timebases)[i][0] ||
391 q != (*model->timebases)[i][1])
394 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
395 g_snprintf(command, sizeof(command),
396 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
399 ret = sr_scpi_send(sdi->conn, command);
400 update_sample_rate = TRUE;
404 case SR_CONF_HORIZ_TRIGGERPOS:
405 tmp_d = g_variant_get_double(data);
407 if (tmp_d < 0.0 || tmp_d > 1.0)
410 state->horiz_triggerpos = tmp_d;
411 tmp_d = -(tmp_d - 0.5) *
412 ((double) (*model->timebases)[state->timebase][0] /
413 (*model->timebases)[state->timebase][1])
416 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
417 g_snprintf(command, sizeof(command),
418 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
421 ret = sr_scpi_send(sdi->conn, command);
423 case SR_CONF_TRIGGER_SLOPE:
424 tmp = g_variant_get_string(data, NULL);
425 for (i = 0; (*model->trigger_slopes)[i]; i++) {
426 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
428 state->trigger_slope = i;
429 g_snprintf(command, sizeof(command),
430 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
431 (*model->trigger_slopes)[i]);
433 ret = sr_scpi_send(sdi->conn, command);
437 case SR_CONF_COUPLING:
438 if (cg_type == CG_NONE) {
439 sr_err("No channel group specified.");
440 return SR_ERR_CHANNEL_GROUP;
443 tmp = g_variant_get_string(data, NULL);
445 for (i = 0; (*model->coupling_options)[i]; i++) {
446 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
448 for (j = 1; j <= model->analog_channels; j++) {
449 if (cg != devc->analog_groups[j - 1])
451 state->analog_channels[j-1].coupling = i;
453 g_snprintf(command, sizeof(command),
454 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
457 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
458 sr_scpi_get_opc(sdi->conn) != SR_OK)
473 ret = sr_scpi_get_opc(sdi->conn);
475 if (ret == SR_OK && update_sample_rate)
476 ret = hmo_update_sample_rate(sdi);
481 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
482 const struct sr_channel_group *cg)
484 int cg_type = CG_NONE;
485 struct dev_context *devc = NULL;
486 const struct scope_config *model = NULL;
490 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
493 model = devc->model_config;
497 case SR_CONF_SCAN_OPTIONS:
498 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
499 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
501 case SR_CONF_DEVICE_OPTIONS:
502 if (cg_type == CG_NONE) {
504 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
505 model->devopts, model->num_devopts, sizeof(uint32_t));
507 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
508 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
509 } else if (cg_type == CG_ANALOG) {
510 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
511 model->analog_devopts, model->num_analog_devopts,
514 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
515 NULL, 0, sizeof(uint32_t));
518 case SR_CONF_COUPLING:
519 if (cg_type == CG_NONE)
520 return SR_ERR_CHANNEL_GROUP;
521 *data = g_variant_new_strv(*model->coupling_options,
522 g_strv_length((char **)*model->coupling_options));
524 case SR_CONF_TRIGGER_SOURCE:
527 *data = g_variant_new_strv(*model->trigger_sources,
528 g_strv_length((char **)*model->trigger_sources));
530 case SR_CONF_TRIGGER_SLOPE:
533 *data = g_variant_new_strv(*model->trigger_slopes,
534 g_strv_length((char **)*model->trigger_slopes));
536 case SR_CONF_TIMEBASE:
539 *data = build_tuples(model->timebases, model->num_timebases);
542 if (cg_type == CG_NONE)
543 return SR_ERR_CHANNEL_GROUP;
544 *data = build_tuples(model->vdivs, model->num_vdivs);
553 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
555 char command[MAX_COMMAND_SIZE];
556 struct sr_channel *ch;
557 struct dev_context *devc;
558 const struct scope_config *model;
561 model = devc->model_config;
563 ch = devc->current_channel->data;
566 case SR_CHANNEL_ANALOG:
567 g_snprintf(command, sizeof(command),
568 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
569 #ifdef WORDS_BIGENDIAN
576 case SR_CHANNEL_LOGIC:
577 g_snprintf(command, sizeof(command),
578 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
579 ch->index < 8 ? 1 : 2);
582 sr_err("Invalid channel type.");
586 return sr_scpi_send(sdi->conn, command);
589 static int hmo_check_channels(GSList *channels)
592 struct sr_channel *ch;
593 gboolean enabled_chan[MAX_ANALOG_CHANNEL_COUNT];
594 gboolean enabled_pod[MAX_DIGITAL_GROUP_COUNT];
597 /* Preset "not enabled" for all channels / pods. */
598 for (idx = 0; idx < ARRAY_SIZE(enabled_chan); idx++)
599 enabled_chan[idx] = FALSE;
600 for (idx = 0; idx < ARRAY_SIZE(enabled_pod); idx++)
601 enabled_pod[idx] = FALSE;
604 * Determine which channels / pods are required for the caller's
605 * specified configuration.
607 for (l = channels; l; l = l->next) {
610 case SR_CHANNEL_ANALOG:
612 if (idx < ARRAY_SIZE(enabled_chan))
613 enabled_chan[idx] = TRUE;
615 case SR_CHANNEL_LOGIC:
617 if (idx < ARRAY_SIZE(enabled_pod))
618 enabled_pod[idx] = TRUE;
626 * Check for resource conflicts. Some channels can be either
627 * analog or digital, but never both at the same time.
629 * Note that the constraints might depend on the specific model.
630 * These tests might need some adjustment when support for more
631 * models gets added to the driver.
633 if (enabled_pod[0] && enabled_chan[2])
635 if (enabled_pod[1] && enabled_chan[3])
640 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
644 gboolean *pod_enabled, setup_changed;
645 char command[MAX_COMMAND_SIZE];
646 struct scope_state *state;
647 const struct scope_config *model;
648 struct sr_channel *ch;
649 struct dev_context *devc;
650 struct sr_scpi_dev_inst *scpi;
654 state = devc->model_state;
655 model = devc->model_config;
656 setup_changed = FALSE;
658 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
660 for (l = sdi->channels; l; l = l->next) {
663 case SR_CHANNEL_ANALOG:
664 if (ch->enabled == state->analog_channels[ch->index].state)
666 g_snprintf(command, sizeof(command),
667 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
668 ch->index + 1, ch->enabled);
670 if (sr_scpi_send(scpi, command) != SR_OK)
672 state->analog_channels[ch->index].state = ch->enabled;
673 setup_changed = TRUE;
675 case SR_CHANNEL_LOGIC:
677 * A digital POD needs to be enabled for every group of
681 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
683 if (ch->enabled == state->digital_channels[ch->index])
685 g_snprintf(command, sizeof(command),
686 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
687 ch->index, ch->enabled);
689 if (sr_scpi_send(scpi, command) != SR_OK)
692 state->digital_channels[ch->index] = ch->enabled;
693 setup_changed = TRUE;
700 for (i = 1; i <= model->digital_pods; i++) {
701 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
703 g_snprintf(command, sizeof(command),
704 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
705 i, pod_enabled[i - 1]);
706 if (sr_scpi_send(scpi, command) != SR_OK)
708 state->digital_pods[i - 1] = pod_enabled[i - 1];
709 setup_changed = TRUE;
714 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
720 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
723 gboolean digital_added[MAX_DIGITAL_GROUP_COUNT];
724 size_t group, pod_count;
725 struct sr_channel *ch;
726 struct dev_context *devc;
727 struct sr_scpi_dev_inst *scpi;
730 if (sdi->status != SR_ST_ACTIVE)
731 return SR_ERR_DEV_CLOSED;
736 /* Preset empty results. */
737 for (group = 0; group < ARRAY_SIZE(digital_added); group++)
738 digital_added[group] = FALSE;
739 g_slist_free(devc->enabled_channels);
740 devc->enabled_channels = NULL;
743 * Contruct the list of enabled channels. Determine the highest
744 * number of digital pods involved in the acquisition.
747 for (l = sdi->channels; l; l = l->next) {
751 /* Only add a single digital channel per group (pod). */
752 group = ch->index / 8;
753 if (ch->type != SR_CHANNEL_LOGIC || !digital_added[group]) {
754 devc->enabled_channels = g_slist_append(
755 devc->enabled_channels, ch);
756 if (ch->type == SR_CHANNEL_LOGIC) {
757 digital_added[group] = TRUE;
758 if (pod_count < group + 1)
759 pod_count = group + 1;
763 if (!devc->enabled_channels)
765 devc->pod_count = pod_count;
766 devc->logic_data = NULL;
769 * Check constraints. Some channels can be either analog or
770 * digital, but not both at the same time.
772 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
773 sr_err("Invalid channel configuration specified!");
779 * Configure the analog and digital channels and the
780 * corresponding digital pods.
782 if (hmo_setup_channels(sdi) != SR_OK) {
783 sr_err("Failed to setup channel configuration!");
789 * Start acquisition on the first enabled channel. The
790 * receive routine will continue driving the acquisition.
792 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
793 hmo_receive_data, (void *)sdi);
795 std_session_send_df_header(sdi);
797 devc->current_channel = devc->enabled_channels;
799 return hmo_request_data(sdi);
802 g_slist_free(devc->enabled_channels);
803 devc->enabled_channels = NULL;
807 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
809 struct dev_context *devc;
810 struct sr_scpi_dev_inst *scpi;
812 std_session_send_df_end(sdi);
814 if (sdi->status != SR_ST_ACTIVE)
815 return SR_ERR_DEV_CLOSED;
819 devc->num_frames = 0;
820 g_slist_free(devc->enabled_channels);
821 devc->enabled_channels = NULL;
823 sr_scpi_source_remove(sdi->session, scpi);
828 static struct sr_dev_driver hameg_hmo_driver_info = {
830 .longname = "Hameg HMO",
833 .cleanup = std_cleanup,
835 .dev_list = std_dev_list,
836 .dev_clear = dev_clear,
837 .config_get = config_get,
838 .config_set = config_set,
839 .config_list = config_list,
840 .dev_open = dev_open,
841 .dev_close = dev_close,
842 .dev_acquisition_start = dev_acquisition_start,
843 .dev_acquisition_stop = dev_acquisition_stop,
846 SR_REGISTER_DEV_DRIVER(hameg_hmo_driver_info);