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/>.
26 static const char *hameg_scpi_dialect[] = {
27 [SCPI_CMD_GET_DIG_DATA] = ":FORM UINT,8;:POD%d:DATA?",
28 [SCPI_CMD_GET_TIMEBASE] = ":TIM:SCAL?",
29 [SCPI_CMD_SET_TIMEBASE] = ":TIM:SCAL %s",
30 [SCPI_CMD_GET_COUPLING] = ":CHAN%d:COUP?",
31 [SCPI_CMD_SET_COUPLING] = ":CHAN%d:COUP %s",
32 [SCPI_CMD_GET_SAMPLE_RATE] = ":ACQ:SRAT?",
33 [SCPI_CMD_GET_SAMPLE_RATE_LIVE] = ":%s:DATA:POINTS?",
34 [SCPI_CMD_GET_ANALOG_DATA] = ":FORM REAL,32;:CHAN%d:DATA?",
35 [SCPI_CMD_GET_VERTICAL_DIV] = ":CHAN%d:SCAL?",
36 [SCPI_CMD_SET_VERTICAL_DIV] = ":CHAN%d:SCAL %s",
37 [SCPI_CMD_GET_DIG_POD_STATE] = ":POD%d:STAT?",
38 [SCPI_CMD_SET_DIG_POD_STATE] = ":POD%d:STAT %d",
39 [SCPI_CMD_GET_TRIGGER_SLOPE] = ":TRIG:A:EDGE:SLOP?",
40 [SCPI_CMD_SET_TRIGGER_SLOPE] = ":TRIG:A:EDGE:SLOP %s",
41 [SCPI_CMD_GET_TRIGGER_SOURCE] = ":TRIG:A:SOUR?",
42 [SCPI_CMD_SET_TRIGGER_SOURCE] = ":TRIG:A:SOUR %s",
43 [SCPI_CMD_GET_DIG_CHAN_STATE] = ":LOG%d:STAT?",
44 [SCPI_CMD_SET_DIG_CHAN_STATE] = ":LOG%d:STAT %d",
45 [SCPI_CMD_GET_VERTICAL_OFFSET] = ":CHAN%d:POS?",
46 [SCPI_CMD_GET_HORIZ_TRIGGERPOS] = ":TIM:POS?",
47 [SCPI_CMD_SET_HORIZ_TRIGGERPOS] = ":TIM:POS %s",
48 [SCPI_CMD_GET_ANALOG_CHAN_STATE] = ":CHAN%d:STAT?",
49 [SCPI_CMD_SET_ANALOG_CHAN_STATE] = ":CHAN%d:STAT %d",
50 [SCPI_CMD_GET_PROBE_UNIT] = ":PROB%d:SET:ATT:UNIT?",
53 static const uint32_t hmo_devopts[] = {
55 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
56 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
57 SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
58 SR_CONF_NUM_HDIV | SR_CONF_GET,
59 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
60 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
61 SR_CONF_SAMPLERATE | SR_CONF_GET,
64 static const uint32_t hmo_analog_devopts[] = {
65 SR_CONF_NUM_VDIV | SR_CONF_GET,
66 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
67 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
70 static const char *hmo_coupling_options[] = {
71 "AC", // AC with 50 Ohm termination (152x, 202x, 30xx, 1202)
72 "ACL", // AC with 1 MOhm termination
73 "DC", // DC with 50 Ohm termination
74 "DCL", // DC with 1 MOhm termination
79 static const char *scope_trigger_slopes[] = {
86 static const char *hmo_compact2_trigger_sources[] = {
105 static const char *hmo_compact4_trigger_sources[] = {
126 static const uint64_t hmo_timebases[][2] = {
165 static const uint64_t hmo_vdivs[][2] = {
185 static const char *scope_analog_channel_names[] = {
192 static const char *scope_digital_channel_names[] = {
211 static const struct scope_config scope_models[] = {
213 /* HMO2522/3032/3042/3052 support 16 digital channels but they're not supported yet. */
214 .name = {"HMO1002", "HMO722", "HMO1022", "HMO1522", "HMO2022", "HMO2522",
215 "HMO3032", "HMO3042", "HMO3052", NULL},
216 .analog_channels = 2,
217 .digital_channels = 8,
220 .analog_names = &scope_analog_channel_names,
221 .digital_names = &scope_digital_channel_names,
223 .devopts = &hmo_devopts,
224 .num_devopts = ARRAY_SIZE(hmo_devopts),
226 .analog_devopts = &hmo_analog_devopts,
227 .num_analog_devopts = ARRAY_SIZE(hmo_analog_devopts),
229 .coupling_options = &hmo_coupling_options,
230 .trigger_sources = &hmo_compact2_trigger_sources,
231 .trigger_slopes = &scope_trigger_slopes,
233 .timebases = &hmo_timebases,
234 .num_timebases = ARRAY_SIZE(hmo_timebases),
237 .num_vdivs = ARRAY_SIZE(hmo_vdivs),
242 .scpi_dialect = &hameg_scpi_dialect,
245 /* HMO2524/3034/3044/3054 support 16 digital channels but they're not supported yet. */
246 .name = {"HMO724", "HMO1024", "HMO1524", "HMO2024", "HMO2524",
247 "HMO3034", "HMO3044", "HMO3054", NULL},
248 .analog_channels = 4,
249 .digital_channels = 8,
252 .analog_names = &scope_analog_channel_names,
253 .digital_names = &scope_digital_channel_names,
255 .devopts = &hmo_devopts,
256 .num_devopts = ARRAY_SIZE(hmo_devopts),
258 .analog_devopts = &hmo_analog_devopts,
259 .num_analog_devopts = ARRAY_SIZE(hmo_analog_devopts),
261 .coupling_options = &hmo_coupling_options,
262 .trigger_sources = &hmo_compact4_trigger_sources,
263 .trigger_slopes = &scope_trigger_slopes,
265 .timebases = &hmo_timebases,
266 .num_timebases = ARRAY_SIZE(hmo_timebases),
269 .num_vdivs = ARRAY_SIZE(hmo_vdivs),
274 .scpi_dialect = &hameg_scpi_dialect,
278 static void scope_state_dump(const struct scope_config *config,
279 struct scope_state *state)
284 for (i = 0; i < config->analog_channels; i++) {
285 tmp = sr_voltage_string((*config->vdivs)[state->analog_channels[i].vdiv][0],
286 (*config->vdivs)[state->analog_channels[i].vdiv][1]);
287 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
288 i + 1, state->analog_channels[i].state ? "On" : "Off",
289 (*config->coupling_options)[state->analog_channels[i].coupling],
290 tmp, state->analog_channels[i].vertical_offset);
293 for (i = 0; i < config->digital_channels; i++) {
294 sr_info("State of digital channel %d -> %s", i,
295 state->digital_channels[i] ? "On" : "Off");
298 for (i = 0; i < config->digital_pods; i++) {
299 sr_info("State of digital POD %d -> %s", i,
300 state->digital_pods[i] ? "On" : "Off");
303 tmp = sr_period_string((*config->timebases)[state->timebase][0] *
304 (*config->timebases)[state->timebase][1]);
305 sr_info("Current timebase: %s", tmp);
308 tmp = sr_samplerate_string(state->sample_rate);
309 sr_info("Current samplerate: %s", tmp);
312 sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
313 (*config->trigger_sources)[state->trigger_source],
314 (*config->trigger_slopes)[state->trigger_slope],
315 state->horiz_triggerpos);
318 static int scope_state_get_array_option(struct sr_scpi_dev_inst *scpi,
319 const char *command, const char *(*array)[], int *result)
324 if (sr_scpi_get_string(scpi, command, &tmp) != SR_OK) {
329 for (i = 0; (*array)[i]; i++) {
330 if (!g_strcmp0(tmp, (*array)[i])) {
347 * This function takes a value of the form "2.000E-03" and returns the index
348 * of an array where a matching pair was found.
350 * @param value The string to be parsed.
351 * @param array The array of s/f pairs.
352 * @param array_len The number of pairs in the array.
353 * @param result The index at which a matching pair was found.
355 * @return SR_ERR on any parsing error, SR_OK otherwise.
357 static int array_float_get(gchar *value, const uint64_t array[][2],
358 int array_len, unsigned int *result)
360 struct sr_rational rval;
361 struct sr_rational aval;
363 if (sr_parse_rational(value, &rval) != SR_OK)
366 for (int i = 0; i < array_len; i++) {
367 sr_rational_set(&aval, array[i][0], array[i][1]);
368 if (sr_rational_eq(&rval, &aval)) {
377 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
378 const struct scope_config *config,
379 struct scope_state *state)
382 char command[MAX_COMMAND_SIZE];
385 for (i = 0; i < config->analog_channels; i++) {
386 g_snprintf(command, sizeof(command),
387 (*config->scpi_dialect)[SCPI_CMD_GET_ANALOG_CHAN_STATE],
390 if (sr_scpi_get_bool(scpi, command,
391 &state->analog_channels[i].state) != SR_OK)
394 g_snprintf(command, sizeof(command),
395 (*config->scpi_dialect)[SCPI_CMD_GET_VERTICAL_DIV],
398 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
401 if (array_float_get(tmp_str, hmo_vdivs, ARRAY_SIZE(hmo_vdivs),
404 sr_err("Could not determine array index for vertical div scale.");
409 state->analog_channels[i].vdiv = j;
411 g_snprintf(command, sizeof(command),
412 (*config->scpi_dialect)[SCPI_CMD_GET_VERTICAL_OFFSET],
415 if (sr_scpi_get_float(scpi, command,
416 &state->analog_channels[i].vertical_offset) != SR_OK)
419 g_snprintf(command, sizeof(command),
420 (*config->scpi_dialect)[SCPI_CMD_GET_COUPLING],
423 if (scope_state_get_array_option(scpi, command, config->coupling_options,
424 &state->analog_channels[i].coupling) != SR_OK)
427 g_snprintf(command, sizeof(command),
428 (*config->scpi_dialect)[SCPI_CMD_GET_PROBE_UNIT],
431 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
434 if (tmp_str[0] == 'A')
435 state->analog_channels[i].probe_unit = 'A';
437 state->analog_channels[i].probe_unit = 'V';
444 static int digital_channel_state_get(struct sr_scpi_dev_inst *scpi,
445 const struct scope_config *config,
446 struct scope_state *state)
449 char command[MAX_COMMAND_SIZE];
451 for (i = 0; i < config->digital_channels; i++) {
452 g_snprintf(command, sizeof(command),
453 (*config->scpi_dialect)[SCPI_CMD_GET_DIG_CHAN_STATE],
456 if (sr_scpi_get_bool(scpi, command,
457 &state->digital_channels[i]) != SR_OK)
461 for (i = 0; i < config->digital_pods; i++) {
462 g_snprintf(command, sizeof(command),
463 (*config->scpi_dialect)[SCPI_CMD_GET_DIG_POD_STATE],
466 if (sr_scpi_get_bool(scpi, command,
467 &state->digital_pods[i]) != SR_OK)
474 SR_PRIV int hmo_update_sample_rate(const struct sr_dev_inst *sdi)
476 struct dev_context *devc;
477 struct scope_state *state;
478 const struct scope_config *config;
483 gboolean channel_found;
484 char tmp_str[MAX_COMMAND_SIZE];
488 config = devc->model_config;
489 state = devc->model_state;
490 channel_found = FALSE;
492 for (i = 0; i < config->analog_channels; i++) {
493 if (state->analog_channels[i].state) {
494 g_snprintf(chan_name, sizeof(chan_name), "CHAN%d", i + 1);
495 g_snprintf(tmp_str, sizeof(tmp_str),
496 (*config->scpi_dialect)[SCPI_CMD_GET_SAMPLE_RATE_LIVE],
498 channel_found = TRUE;
503 if (!channel_found) {
504 for (i = 0; i < config->digital_pods; i++) {
505 if (state->digital_pods[i]) {
506 g_snprintf(chan_name, sizeof(chan_name), "POD%d", i);
507 g_snprintf(tmp_str, sizeof(tmp_str),
508 (*config->scpi_dialect)[SCPI_CMD_GET_SAMPLE_RATE_LIVE],
510 channel_found = TRUE;
516 /* No channel is active, ask the instrument for the sample rate
517 * in single shot mode */
518 if (!channel_found) {
519 if (sr_scpi_get_float(sdi->conn,
520 (*config->scpi_dialect)[SCPI_CMD_GET_SAMPLE_RATE],
521 &tmp_float) != SR_OK)
524 state->sample_rate = tmp_float;
526 if (sr_scpi_get_int(sdi->conn, tmp_str, &tmp) != SR_OK)
528 state->sample_rate = tmp / (((float) (*config->timebases)[state->timebase][0] /
529 (*config->timebases)[state->timebase][1]) *
536 SR_PRIV int hmo_scope_state_get(struct sr_dev_inst *sdi)
538 struct dev_context *devc;
539 struct scope_state *state;
540 const struct scope_config *config;
546 config = devc->model_config;
547 state = devc->model_state;
549 sr_info("Fetching scope state");
551 if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
554 if (digital_channel_state_get(sdi->conn, config, state) != SR_OK)
557 if (sr_scpi_get_float(sdi->conn,
558 (*config->scpi_dialect)[SCPI_CMD_GET_TIMEBASE],
559 &tmp_float) != SR_OK)
562 if (sr_scpi_get_string(sdi->conn,
563 (*config->scpi_dialect)[SCPI_CMD_GET_TIMEBASE],
567 if (array_float_get(tmp_str, hmo_timebases, ARRAY_SIZE(hmo_timebases),
570 sr_err("Could not determine array index for time base.");
577 if (sr_scpi_get_float(sdi->conn,
578 (*config->scpi_dialect)[SCPI_CMD_GET_HORIZ_TRIGGERPOS],
579 &tmp_float) != SR_OK)
581 state->horiz_triggerpos = tmp_float /
582 (((double) (*config->timebases)[state->timebase][0] /
583 (*config->timebases)[state->timebase][1]) * config->num_xdivs);
584 state->horiz_triggerpos -= 0.5;
585 state->horiz_triggerpos *= -1;
587 if (scope_state_get_array_option(sdi->conn,
588 (*config->scpi_dialect)[SCPI_CMD_GET_TRIGGER_SOURCE],
589 config->trigger_sources, &state->trigger_source) != SR_OK)
592 if (scope_state_get_array_option(sdi->conn,
593 (*config->scpi_dialect)[SCPI_CMD_GET_TRIGGER_SLOPE],
594 config->trigger_slopes, &state->trigger_slope) != SR_OK)
597 if (hmo_update_sample_rate(sdi) != SR_OK)
600 sr_info("Fetching finished.");
602 scope_state_dump(config, state);
607 static struct scope_state *scope_state_new(const struct scope_config *config)
609 struct scope_state *state;
611 state = g_malloc0(sizeof(struct scope_state));
612 state->analog_channels = g_malloc0_n(config->analog_channels,
613 sizeof(struct analog_channel_state));
614 state->digital_channels = g_malloc0_n(
615 config->digital_channels, sizeof(gboolean));
616 state->digital_pods = g_malloc0_n(config->digital_pods,
622 SR_PRIV void hmo_scope_state_free(struct scope_state *state)
624 g_free(state->analog_channels);
625 g_free(state->digital_channels);
626 g_free(state->digital_pods);
630 SR_PRIV int hmo_init_device(struct sr_dev_inst *sdi)
635 struct sr_channel *ch;
636 struct dev_context *devc;
641 /* Find the exact model. */
642 for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
643 for (j = 0; scope_models[i].name[j]; j++) {
644 if (!strcmp(sdi->model, scope_models[i].name[j])) {
649 if (model_index != -1)
653 if (model_index == -1) {
654 sr_dbg("Unsupported HMO device.");
658 devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
659 scope_models[model_index].analog_channels);
661 devc->digital_groups = g_malloc0(sizeof(struct sr_channel_group*) *
662 scope_models[model_index].digital_pods);
664 /* Add analog channels. */
665 for (i = 0; i < scope_models[model_index].analog_channels; i++) {
666 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, TRUE,
667 (*scope_models[model_index].analog_names)[i]);
669 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
671 devc->analog_groups[i]->name = g_strdup(
672 (char *)(*scope_models[model_index].analog_names)[i]);
673 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
675 sdi->channel_groups = g_slist_append(sdi->channel_groups,
676 devc->analog_groups[i]);
679 /* Add digital channel groups. */
680 for (i = 0; i < scope_models[model_index].digital_pods; i++) {
681 g_snprintf(tmp, 25, "POD%d", i);
683 devc->digital_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
685 devc->digital_groups[i]->name = g_strdup(tmp);
686 sdi->channel_groups = g_slist_append(sdi->channel_groups,
687 devc->digital_groups[i < 8 ? 0 : 1]);
690 /* Add digital channels. */
691 for (i = 0; i < scope_models[model_index].digital_channels; i++) {
692 ch = sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE,
693 (*scope_models[model_index].digital_names)[i]);
695 devc->digital_groups[i < 8 ? 0 : 1]->channels = g_slist_append(
696 devc->digital_groups[i < 8 ? 0 : 1]->channels, ch);
699 devc->model_config = &scope_models[model_index];
700 devc->frame_limit = 0;
702 if (!(devc->model_state = scope_state_new(devc->model_config)))
703 return SR_ERR_MALLOC;
708 SR_PRIV int hmo_receive_data(int fd, int revents, void *cb_data)
710 struct sr_channel *ch;
711 struct sr_dev_inst *sdi;
712 struct dev_context *devc;
713 struct scope_state *state;
714 struct sr_datafeed_packet packet;
716 struct sr_datafeed_analog analog;
717 struct sr_analog_encoding encoding;
718 struct sr_analog_meaning meaning;
719 struct sr_analog_spec spec;
720 struct sr_datafeed_logic logic;
727 if (!(sdi = cb_data))
730 if (!(devc = sdi->priv))
733 /* Although this is correct in general, the USBTMC libusb implementation
734 * currently does not generate an event prior to the first read. Often
735 * it is ok to start reading just after the 50ms timeout. See bug #785.
736 if (revents != G_IO_IN)
740 ch = devc->current_channel->data;
741 state = devc->model_state;
744 case SR_CHANNEL_ANALOG:
745 if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
747 g_byte_array_free(data, TRUE);
752 packet.type = SR_DF_FRAME_BEGIN;
753 sr_session_send(sdi, &packet);
755 packet.type = SR_DF_ANALOG;
757 analog.data = data->data;
758 analog.num_samples = data->len / sizeof(float);
759 analog.encoding = &encoding;
760 analog.meaning = &meaning;
763 encoding.unitsize = sizeof(float);
764 encoding.is_signed = TRUE;
765 encoding.is_float = TRUE;
766 encoding.is_bigendian = FALSE;
768 encoding.is_digits_decimal = FALSE;
769 encoding.scale.p = 1;
770 encoding.scale.q = 1;
771 encoding.offset.p = 0;
772 encoding.offset.q = 1;
773 if (state->analog_channels[ch->index].probe_unit == 'V') {
774 meaning.mq = SR_MQ_VOLTAGE;
775 meaning.unit = SR_UNIT_VOLT;
777 meaning.mq = SR_MQ_CURRENT;
778 meaning.unit = SR_UNIT_AMPERE;
781 meaning.channels = g_slist_append(NULL, ch);
782 spec.spec_digits = 0;
783 packet.payload = &analog;
784 sr_session_send(sdi, &packet);
785 g_slist_free(meaning.channels);
786 g_byte_array_free(data, TRUE);
789 case SR_CHANNEL_LOGIC:
790 if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
795 packet.type = SR_DF_FRAME_BEGIN;
796 sr_session_send(sdi, &packet);
798 logic.length = data->len;
800 logic.data = data->data;
801 packet.type = SR_DF_LOGIC;
802 packet.payload = &logic;
803 sr_session_send(sdi, &packet);
804 g_byte_array_free(data, TRUE);
808 sr_err("Invalid channel type.");
812 packet.type = SR_DF_FRAME_END;
813 sr_session_send(sdi, &packet);
815 if (devc->current_channel->next) {
816 devc->current_channel = devc->current_channel->next;
817 hmo_request_data(sdi);
818 } else if (++devc->num_frames == devc->frame_limit) {
819 sdi->driver->dev_acquisition_stop(sdi);
821 devc->current_channel = devc->enabled_channels;
822 hmo_request_data(sdi);