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 SR_PRIV 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 init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
52 return std_init(sr_ctx, di, LOG_PREFIX);
55 static int check_manufacturer(const char *manufacturer)
59 for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
60 if (!strcmp(manufacturer, manufacturers[i]))
66 static struct sr_dev_inst *hmo_probe_serial_device(struct sr_scpi_dev_inst *scpi)
68 struct sr_dev_inst *sdi;
69 struct dev_context *devc;
70 struct sr_scpi_hw_info *hw_info;
76 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
77 sr_info("Couldn't get IDN response.");
81 if (check_manufacturer(hw_info->manufacturer) != SR_OK)
84 sdi = g_malloc0(sizeof(struct sr_dev_inst));
85 sdi->vendor = g_strdup(hw_info->manufacturer);
86 sdi->model = g_strdup(hw_info->model);
87 sdi->version = g_strdup(hw_info->firmware_version);
88 sdi->serial_num = g_strdup(hw_info->serial_number);
89 sdi->driver = &hameg_hmo_driver_info;
90 sdi->inst_type = SR_INST_SCPI;
93 sr_scpi_hw_info_free(hw_info);
96 devc = g_malloc0(sizeof(struct dev_context));
100 if (hmo_init_device(sdi) != SR_OK)
107 sr_scpi_hw_info_free(hw_info);
109 sr_dev_inst_free(sdi);
115 static GSList *scan(struct sr_dev_driver *di, GSList *options)
117 return sr_scpi_scan(di->context, options, hmo_probe_serial_device);
120 static GSList *dev_list(const struct sr_dev_driver *di)
122 return ((struct drv_context *)(di->context))->instances;
125 static void clear_helper(void *priv)
127 struct dev_context *devc;
131 hmo_scope_state_free(devc->model_state);
133 g_free(devc->analog_groups);
134 g_free(devc->digital_groups);
139 static int dev_clear(const struct sr_dev_driver *di)
141 return std_dev_clear(di, clear_helper);
144 static int dev_open(struct sr_dev_inst *sdi)
146 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
149 if (hmo_scope_state_get(sdi) != SR_OK)
152 sdi->status = SR_ST_ACTIVE;
157 static int dev_close(struct sr_dev_inst *sdi)
159 if (sdi->status == SR_ST_INACTIVE)
162 sr_scpi_close(sdi->conn);
164 sdi->status = SR_ST_INACTIVE;
169 static int check_channel_group(struct dev_context *devc,
170 const struct sr_channel_group *cg)
173 const struct scope_config *model;
175 model = devc->model_config;
180 for (i = 0; i < model->analog_channels; i++)
181 if (cg == devc->analog_groups[i])
184 for (i = 0; i < model->digital_pods; i++)
185 if (cg == devc->digital_groups[i])
188 sr_err("Invalid channel group specified.");
193 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
194 const struct sr_channel_group *cg)
198 struct dev_context *devc;
199 const struct scope_config *model;
200 struct scope_state *state;
202 if (!sdi || !(devc = sdi->priv))
205 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
209 model = devc->model_config;
210 state = devc->model_state;
213 case SR_CONF_NUM_HDIV:
214 *data = g_variant_new_int32(model->num_xdivs);
217 case SR_CONF_TIMEBASE:
218 *data = g_variant_new("(tt)", (*model->timebases)[state->timebase][0],
219 (*model->timebases)[state->timebase][1]);
222 case SR_CONF_NUM_VDIV:
223 if (cg_type == CG_NONE) {
224 sr_err("No channel group specified.");
225 return SR_ERR_CHANNEL_GROUP;
226 } else if (cg_type == CG_ANALOG) {
227 for (i = 0; i < model->analog_channels; i++) {
228 if (cg != devc->analog_groups[i])
230 *data = g_variant_new_int32(model->num_ydivs);
240 if (cg_type == CG_NONE) {
241 sr_err("No channel group specified.");
242 return SR_ERR_CHANNEL_GROUP;
243 } else if (cg_type == CG_ANALOG) {
244 for (i = 0; i < model->analog_channels; i++) {
245 if (cg != devc->analog_groups[i])
247 *data = g_variant_new("(tt)",
248 (*model->vdivs)[state->analog_channels[i].vdiv][0],
249 (*model->vdivs)[state->analog_channels[i].vdiv][1]);
258 case SR_CONF_TRIGGER_SOURCE:
259 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
262 case SR_CONF_TRIGGER_SLOPE:
263 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
266 case SR_CONF_HORIZ_TRIGGERPOS:
267 *data = g_variant_new_double(state->horiz_triggerpos);
270 case SR_CONF_COUPLING:
271 if (cg_type == CG_NONE) {
272 sr_err("No channel group specified.");
273 return SR_ERR_CHANNEL_GROUP;
274 } else if (cg_type == CG_ANALOG) {
275 for (i = 0; i < model->analog_channels; i++) {
276 if (cg != devc->analog_groups[i])
278 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
287 case SR_CONF_SAMPLERATE:
288 *data = g_variant_new_uint64(state->sample_rate);
298 static GVariant *build_tuples(const uint64_t (*array)[][2], unsigned int n)
301 GVariant *rational[2];
304 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
306 for (i = 0; i < n; i++) {
307 rational[0] = g_variant_new_uint64((*array)[i][0]);
308 rational[1] = g_variant_new_uint64((*array)[i][1]);
310 /* FIXME: Valgrind reports a memory leak here. */
311 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
314 return g_variant_builder_end(&gvb);
317 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
318 const struct sr_channel_group *cg)
322 char command[MAX_COMMAND_SIZE], float_str[30];
323 struct dev_context *devc;
324 const struct scope_config *model;
325 struct scope_state *state;
329 gboolean update_sample_rate;
331 if (!sdi || !(devc = sdi->priv))
334 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
337 model = devc->model_config;
338 state = devc->model_state;
339 update_sample_rate = FALSE;
344 case SR_CONF_LIMIT_FRAMES:
345 devc->frame_limit = g_variant_get_uint64(data);
348 case SR_CONF_TRIGGER_SOURCE:
349 tmp = g_variant_get_string(data, NULL);
350 for (i = 0; (*model->trigger_sources)[i]; i++) {
351 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
353 state->trigger_source = i;
354 g_snprintf(command, sizeof(command),
355 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SOURCE],
356 (*model->trigger_sources)[i]);
358 ret = sr_scpi_send(sdi->conn, command);
363 if (cg_type == CG_NONE) {
364 sr_err("No channel group specified.");
365 return SR_ERR_CHANNEL_GROUP;
368 g_variant_get(data, "(tt)", &p, &q);
370 for (i = 0; i < model->num_vdivs; i++) {
371 if (p != (*model->vdivs)[i][0] ||
372 q != (*model->vdivs)[i][1])
374 for (j = 1; j <= model->analog_channels; j++) {
375 if (cg != devc->analog_groups[j - 1])
377 state->analog_channels[j - 1].vdiv = i;
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_VERTICAL_DIV],
383 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
384 sr_scpi_get_opc(sdi->conn) != SR_OK)
394 case SR_CONF_TIMEBASE:
395 g_variant_get(data, "(tt)", &p, &q);
397 for (i = 0; i < model->num_timebases; i++) {
398 if (p != (*model->timebases)[i][0] ||
399 q != (*model->timebases)[i][1])
402 g_ascii_formatd(float_str, sizeof(float_str), "%E", (float) p / q);
403 g_snprintf(command, sizeof(command),
404 (*model->scpi_dialect)[SCPI_CMD_SET_TIMEBASE],
407 ret = sr_scpi_send(sdi->conn, command);
408 update_sample_rate = TRUE;
412 case SR_CONF_HORIZ_TRIGGERPOS:
413 tmp_d = g_variant_get_double(data);
415 if (tmp_d < 0.0 || tmp_d > 1.0)
418 state->horiz_triggerpos = tmp_d;
419 tmp_d = -(tmp_d - 0.5) *
420 ((double) (*model->timebases)[state->timebase][0] /
421 (*model->timebases)[state->timebase][1])
424 g_ascii_formatd(float_str, sizeof(float_str), "%E", tmp_d);
425 g_snprintf(command, sizeof(command),
426 (*model->scpi_dialect)[SCPI_CMD_SET_HORIZ_TRIGGERPOS],
429 ret = sr_scpi_send(sdi->conn, command);
431 case SR_CONF_TRIGGER_SLOPE:
432 tmp = g_variant_get_string(data, NULL);
433 for (i = 0; (*model->trigger_slopes)[i]; i++) {
434 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
436 state->trigger_slope = i;
437 g_snprintf(command, sizeof(command),
438 (*model->scpi_dialect)[SCPI_CMD_SET_TRIGGER_SLOPE],
439 (*model->trigger_slopes)[i]);
441 ret = sr_scpi_send(sdi->conn, command);
445 case SR_CONF_COUPLING:
446 if (cg_type == CG_NONE) {
447 sr_err("No channel group specified.");
448 return SR_ERR_CHANNEL_GROUP;
451 tmp = g_variant_get_string(data, NULL);
453 for (i = 0; (*model->coupling_options)[i]; i++) {
454 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
456 for (j = 1; j <= model->analog_channels; j++) {
457 if (cg != devc->analog_groups[j - 1])
459 state->analog_channels[j-1].coupling = i;
461 g_snprintf(command, sizeof(command),
462 (*model->scpi_dialect)[SCPI_CMD_SET_COUPLING],
465 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
466 sr_scpi_get_opc(sdi->conn) != SR_OK)
481 ret = sr_scpi_get_opc(sdi->conn);
483 if (ret == SR_OK && update_sample_rate)
484 ret = hmo_update_sample_rate(sdi);
489 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
490 const struct sr_channel_group *cg)
492 int cg_type = CG_NONE;
493 struct dev_context *devc = NULL;
494 const struct scope_config *model = NULL;
496 if (sdi && (devc = sdi->priv)) {
497 if ((cg_type = check_channel_group(devc, cg)) == CG_INVALID)
500 model = devc->model_config;
504 case SR_CONF_SCAN_OPTIONS:
505 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
506 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
508 case SR_CONF_DEVICE_OPTIONS:
509 if (cg_type == CG_NONE) {
511 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
512 model->devopts, model->num_devopts, sizeof(uint32_t));
514 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
515 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
516 } else if (cg_type == CG_ANALOG) {
517 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
518 model->analog_devopts, model->num_analog_devopts,
521 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
522 NULL, 0, sizeof(uint32_t));
525 case SR_CONF_COUPLING:
526 if (cg_type == CG_NONE)
527 return SR_ERR_CHANNEL_GROUP;
528 *data = g_variant_new_strv(*model->coupling_options,
529 g_strv_length((char **)*model->coupling_options));
531 case SR_CONF_TRIGGER_SOURCE:
534 *data = g_variant_new_strv(*model->trigger_sources,
535 g_strv_length((char **)*model->trigger_sources));
537 case SR_CONF_TRIGGER_SLOPE:
540 *data = g_variant_new_strv(*model->trigger_slopes,
541 g_strv_length((char **)*model->trigger_slopes));
543 case SR_CONF_TIMEBASE:
546 *data = build_tuples(model->timebases, model->num_timebases);
549 if (cg_type == CG_NONE)
550 return SR_ERR_CHANNEL_GROUP;
551 *data = build_tuples(model->vdivs, model->num_vdivs);
560 SR_PRIV int hmo_request_data(const struct sr_dev_inst *sdi)
562 char command[MAX_COMMAND_SIZE];
563 struct sr_channel *ch;
564 struct dev_context *devc;
565 const struct scope_config *model;
568 model = devc->model_config;
570 ch = devc->current_channel->data;
573 case SR_CHANNEL_ANALOG:
574 g_snprintf(command, sizeof(command),
575 (*model->scpi_dialect)[SCPI_CMD_GET_ANALOG_DATA],
578 case SR_CHANNEL_LOGIC:
579 g_snprintf(command, sizeof(command),
580 (*model->scpi_dialect)[SCPI_CMD_GET_DIG_DATA],
581 ch->index < 8 ? 1 : 2);
584 sr_err("Invalid channel type.");
588 return sr_scpi_send(sdi->conn, command);
591 static int hmo_check_channels(GSList *channels)
594 struct sr_channel *ch;
595 gboolean enabled_pod1, enabled_pod2, enabled_chan3, enabled_chan4;
597 enabled_pod1 = enabled_pod2 = enabled_chan3 = enabled_chan4 = FALSE;
599 for (l = channels; l; l = l->next) {
602 case SR_CHANNEL_ANALOG:
604 enabled_chan3 = TRUE;
605 else if (ch->index == 3)
606 enabled_chan4 = TRUE;
608 case SR_CHANNEL_LOGIC:
619 if ((enabled_pod1 && enabled_chan3) ||
620 (enabled_pod2 && enabled_chan4))
626 static int hmo_setup_channels(const struct sr_dev_inst *sdi)
630 gboolean *pod_enabled, setup_changed;
631 char command[MAX_COMMAND_SIZE];
632 struct scope_state *state;
633 const struct scope_config *model;
634 struct sr_channel *ch;
635 struct dev_context *devc;
636 struct sr_scpi_dev_inst *scpi;
640 state = devc->model_state;
641 model = devc->model_config;
642 setup_changed = FALSE;
644 pod_enabled = g_try_malloc0(sizeof(gboolean) * model->digital_pods);
646 for (l = sdi->channels; l; l = l->next) {
649 case SR_CHANNEL_ANALOG:
650 if (ch->enabled == state->analog_channels[ch->index].state)
652 g_snprintf(command, sizeof(command),
653 (*model->scpi_dialect)[SCPI_CMD_SET_ANALOG_CHAN_STATE],
654 ch->index + 1, ch->enabled);
656 if (sr_scpi_send(scpi, command) != SR_OK)
658 state->analog_channels[ch->index].state = ch->enabled;
659 setup_changed = TRUE;
661 case SR_CHANNEL_LOGIC:
663 * A digital POD needs to be enabled for every group of
667 pod_enabled[ch->index < 8 ? 0 : 1] = TRUE;
669 if (ch->enabled == state->digital_channels[ch->index])
671 g_snprintf(command, sizeof(command),
672 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_CHAN_STATE],
673 ch->index, ch->enabled);
675 if (sr_scpi_send(scpi, command) != SR_OK)
678 state->digital_channels[ch->index] = ch->enabled;
679 setup_changed = TRUE;
686 for (i = 1; i <= model->digital_pods; i++) {
687 if (state->digital_pods[i - 1] == pod_enabled[i - 1])
689 g_snprintf(command, sizeof(command),
690 (*model->scpi_dialect)[SCPI_CMD_SET_DIG_POD_STATE],
691 i, pod_enabled[i - 1]);
692 if (sr_scpi_send(scpi, command) != SR_OK)
694 state->digital_pods[i - 1] = pod_enabled[i - 1];
695 setup_changed = TRUE;
700 if (setup_changed && hmo_update_sample_rate(sdi) != SR_OK)
706 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
709 gboolean digital_added;
710 struct sr_channel *ch;
711 struct dev_context *devc;
712 struct sr_scpi_dev_inst *scpi;
714 if (sdi->status != SR_ST_ACTIVE)
715 return SR_ERR_DEV_CLOSED;
719 digital_added = FALSE;
721 g_slist_free(devc->enabled_channels);
722 devc->enabled_channels = NULL;
724 for (l = sdi->channels; l; l = l->next) {
728 /* Only add a single digital channel. */
729 if (ch->type != SR_CHANNEL_LOGIC || !digital_added) {
730 devc->enabled_channels = g_slist_append(
731 devc->enabled_channels, ch);
732 if (ch->type == SR_CHANNEL_LOGIC)
733 digital_added = TRUE;
737 if (!devc->enabled_channels)
740 if (hmo_check_channels(devc->enabled_channels) != SR_OK) {
741 sr_err("Invalid channel configuration specified!");
745 if (hmo_setup_channels(sdi) != SR_OK) {
746 sr_err("Failed to setup channel configuration!");
750 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
751 hmo_receive_data, (void *)sdi);
753 std_session_send_df_header(sdi, LOG_PREFIX);
755 devc->current_channel = devc->enabled_channels;
757 return hmo_request_data(sdi);
760 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
762 struct dev_context *devc;
763 struct sr_scpi_dev_inst *scpi;
765 std_session_send_df_end(sdi, LOG_PREFIX);
767 if (sdi->status != SR_ST_ACTIVE)
768 return SR_ERR_DEV_CLOSED;
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 SR_PRIV struct sr_dev_driver hameg_hmo_driver_info = {
783 .longname = "Hameg HMO",
786 .cleanup = std_cleanup,
788 .dev_list = 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,