2 * This file is part of the libsigrok project.
4 * Copyright (C) 2017 Sven Schnelle <svens@stackframe.org>
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 struct lecroy_wavedesc_2_x {
28 uint16_t comm_order; /* 1 - little endian */
29 uint32_t wave_descriptor_length;
30 uint32_t user_text_len;
32 uint32_t trigtime_array_length;
33 uint32_t ris_time1_array_length;
35 uint32_t wave_array1_length;
36 uint32_t wave_array2_length;
37 uint32_t wave_array3_length;
38 uint32_t wave_array4_length;
39 char instrument_name[16];
40 uint32_t instrument_number;
43 uint32_t wave_array_count;
44 uint32_t points_per_screen;
45 uint32_t first_valid_point;
46 uint32_t last_valid_point;
48 uint32_t sparsing_factor;
49 uint32_t segment_index;
50 uint32_t subarray_count;
51 uint32_t sweeps_per_acq;
52 uint16_t points_per_pair;
55 float vertical_offset;
58 uint16_t nominal_bits;
59 uint16_t nom_subarray_count;
67 } __attribute__((packed));
69 struct lecroy_wavedesc {
70 char descriptor_name[16];
71 char template_name[16];
73 struct lecroy_wavedesc_2_x version_2_x;
75 } __attribute__((packed));
77 static const uint32_t devopts[] = {
79 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
80 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
81 SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
82 SR_CONF_NUM_HDIV | SR_CONF_GET,
83 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
84 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
85 SR_CONF_SAMPLERATE | SR_CONF_GET,
88 static const uint32_t analog_devopts[] = {
89 SR_CONF_NUM_VDIV | SR_CONF_GET,
90 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
91 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
94 static const char *coupling_options[] = {
95 "A1M", // AC with 1 MOhm termination
96 "D50", // DC with 50 Ohm termination
97 "D1M", // DC with 1 MOhm termination
103 static const char *scope_trigger_slopes[] = {
109 static const char *trigger_sources[] = {
119 static const struct sr_rational timebases[] = {
121 { 20, 1000000000000 },
122 { 50, 1000000000000 },
123 { 100, 1000000000000 },
124 { 200, 1000000000000 },
125 { 500, 1000000000000 },
169 static const struct sr_rational vdivs[] = {
189 static const char *scope_analog_channel_names[] = {
196 static const struct scope_config scope_models[] = {
198 .name = { "WP7000", "WP7100", "WP7200", "WP7300" },
200 .analog_channels = 4,
201 .analog_names = &scope_analog_channel_names,
204 .num_devopts = ARRAY_SIZE(devopts),
206 .analog_devopts = &analog_devopts,
207 .num_analog_devopts = ARRAY_SIZE(analog_devopts),
209 .coupling_options = &coupling_options,
210 .trigger_sources = &trigger_sources,
211 .trigger_slopes = &scope_trigger_slopes,
213 .timebases = timebases,
214 .num_timebases = ARRAY_SIZE(timebases),
217 .num_vdivs = ARRAY_SIZE(vdivs),
224 static void scope_state_dump(const struct scope_config *config,
225 struct scope_state *state)
230 for (i = 0; i < config->analog_channels; i++) {
231 tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
232 config->vdivs[state->analog_channels[i].vdiv].q);
233 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
234 i + 1, state->analog_channels[i].state ? "On" : "Off",
235 (*config->coupling_options)[state->analog_channels[i].coupling],
236 tmp, state->analog_channels[i].vertical_offset);
239 tmp = sr_period_string(((float)config->timebases[state->timebase].q) /
240 ((float)config->timebases[state->timebase].p));
241 sr_info("Current timebase: %s", tmp);
244 tmp = sr_samplerate_string(state->sample_rate);
245 sr_info("Current samplerate: %s", tmp);
248 sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
249 (*config->trigger_sources)[state->trigger_source],
250 (*config->trigger_slopes)[state->trigger_slope],
251 state->horiz_triggerpos);
254 static int scope_state_get_array_option(const char *resp,
255 const char *(*array)[], int *result)
259 for (i = 0; (*array)[i]; i++) {
260 if (!g_strcmp0(resp, (*array)[i])) {
270 * This function takes a value of the form "2.000E-03" and returns the index
271 * of an array where a matching pair was found.
273 * @param value The string to be parsed.
274 * @param array The array of s/f pairs.
275 * @param array_len The number of pairs in the array.
276 * @param result The index at which a matching pair was found.
278 * @return SR_ERR on any parsing error, SR_OK otherwise.
280 static int array_float_get(gchar *value, const struct sr_rational *aval,
281 int array_len, unsigned int *result)
283 struct sr_rational rval;
285 if (sr_parse_rational(value, &rval) != SR_OK)
288 for (int i = 0; i < array_len; i++) {
289 if (sr_rational_eq(&rval, aval + i)) {
298 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
299 const struct scope_config *config,
300 struct scope_state *state)
303 char command[MAX_COMMAND_SIZE];
306 for (i = 0; i < config->analog_channels; i++) {
307 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
309 if (sr_scpi_get_bool(scpi, command,
310 &state->analog_channels[i].state) != SR_OK)
313 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
315 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
318 if (array_float_get(tmp_str, vdivs, ARRAY_SIZE(vdivs), &j) != SR_OK) {
320 sr_err("Could not determine array index for vertical div scale.");
325 state->analog_channels[i].vdiv = j;
327 g_snprintf(command, sizeof(command), "C%d:OFFSET?", i + 1);
329 if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
332 g_snprintf(command, sizeof(command), "C%d:COUPLING?", i + 1);
334 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
338 if (scope_state_get_array_option(tmp_str, config->coupling_options,
339 &state->analog_channels[i].coupling) != SR_OK)
348 SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
350 struct dev_context *devc;
351 struct scope_state *state;
352 const struct scope_config *config;
353 float memsize, timediv;
356 state = devc->model_state;
357 config = devc->model_config;
359 if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
362 if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
365 state->sample_rate = 1 / ((timediv * config->num_xdivs) / memsize);
370 SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
372 struct dev_context *devc;
373 struct scope_state *state;
374 const struct scope_config *config;
376 char *tmp_str, *tmp_str2, *tmpp, *p, *key;
377 char command[MAX_COMMAND_SIZE];
378 char *trig_source = NULL;
381 config = devc->model_config;
382 state = devc->model_state;
384 sr_info("Fetching scope state");
386 if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
389 if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
392 if (array_float_get(tmp_str, timebases, ARRAY_SIZE(timebases), &i) != SR_OK) {
394 sr_err("Could not determine array index for timbase scale.");
400 if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
406 while ((p = strtok_r(tmp_str2, ",", &tmpp))) {
413 } else if (!(i & 1)) {
414 if (!strcmp(key, "SR"))
420 if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources, &state->trigger_source) != SR_OK)
423 g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
424 if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
427 if (scope_state_get_array_option(tmp_str,
428 config->trigger_slopes, &state->trigger_slope) != SR_OK)
431 if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
434 if (lecroy_xstream_update_sample_rate(sdi) != SR_OK)
437 sr_info("Fetching finished.");
439 scope_state_dump(config, state);
444 static struct scope_state *scope_state_new(const struct scope_config *config)
446 struct scope_state *state;
448 state = g_malloc0(sizeof(struct scope_state));
449 state->analog_channels = g_malloc0_n(config->analog_channels,
450 sizeof(struct analog_channel_state));
454 SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
456 g_free(state->analog_channels);
460 SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
462 char command[MAX_COMMAND_SIZE];
465 struct sr_channel *ch;
466 struct dev_context *devc;
467 gboolean channel_enabled;
472 /* Find the exact model. */
473 for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
474 for (j = 0; scope_models[i].name[j]; j++) {
475 if (!strcmp(sdi->model, scope_models[i].name[j])) {
480 if (model_index != -1)
484 if (model_index == -1) {
485 sr_dbg("Unsupported LeCroy device.");
489 devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
490 scope_models[model_index].analog_channels);
492 /* Add analog channels. */
493 for (i = 0; i < scope_models[model_index].analog_channels; i++) {
494 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
496 if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
499 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
501 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
502 (*scope_models[model_index].analog_names)[i]);
504 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
506 devc->analog_groups[i]->name = g_strdup(
507 (char *)(*scope_models[model_index].analog_names)[i]);
508 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
510 sdi->channel_groups = g_slist_append(sdi->channel_groups,
511 devc->analog_groups[i]);
514 devc->model_config = &scope_models[model_index];
515 devc->frame_limit = 0;
517 if (!(devc->model_state = scope_state_new(devc->model_config)))
518 return SR_ERR_MALLOC;
520 /* Set the desired response mode. */
521 sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");
526 static int lecroy_waveform_2_x_to_analog(GByteArray *data,
527 struct lecroy_wavedesc *desc,
528 struct sr_datafeed_analog *analog)
530 struct sr_analog_encoding *encoding = analog->encoding;
531 struct sr_analog_meaning *meaning = analog->meaning;
532 struct sr_analog_spec *spec = analog->spec;
534 int16_t *waveform_data;
535 unsigned int i, num_samples;
537 data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
538 num_samples = desc->version_2_x.wave_array_count;
540 waveform_data = (int16_t *)(data->data +
541 + desc->version_2_x.wave_descriptor_length
542 + desc->version_2_x.user_text_len);
544 for (i = 0; i < num_samples; i++)
545 data_float[i] = (float)waveform_data[i]
546 * desc->version_2_x.vertical_gain
547 + desc->version_2_x.vertical_offset;
549 analog->data = data_float;
550 analog->num_samples = num_samples;
552 encoding->unitsize = sizeof(float);
553 encoding->is_signed = TRUE;
554 encoding->is_float = TRUE;
555 encoding->is_bigendian = FALSE;
556 encoding->scale.p = 1;
557 encoding->scale.q = 1;
558 encoding->offset.p = 0;
559 encoding->offset.q = 1;
561 encoding->digits = 6;
562 encoding->is_digits_decimal = FALSE;
564 if (strcmp(desc->version_2_x.vertunit, "A")) {
565 meaning->mq = SR_MQ_CURRENT;
566 meaning->unit = SR_UNIT_AMPERE;
568 /* Default to voltage. */
569 meaning->mq = SR_MQ_VOLTAGE;
570 meaning->unit = SR_UNIT_VOLT;
573 meaning->mqflags = 0;
574 spec->spec_digits = 3;
579 static int lecroy_waveform_to_analog(GByteArray *data,
580 struct sr_datafeed_analog *analog)
582 struct lecroy_wavedesc *desc;
584 if (data->len < sizeof(struct lecroy_wavedesc))
587 desc = (struct lecroy_wavedesc *)data->data;
589 if (!strncmp(desc->template_name, "LECROY_2_2", 16) ||
590 !strncmp(desc->template_name, "LECROY_2_3", 16)) {
591 return lecroy_waveform_2_x_to_analog(data, desc, analog);
594 sr_err("Waveformat template '%.16s' not supported.",
595 desc->template_name);
600 SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
602 struct sr_channel *ch;
603 struct sr_dev_inst *sdi;
604 struct dev_context *devc;
605 struct sr_datafeed_packet packet;
607 struct sr_datafeed_analog analog;
608 struct sr_analog_encoding encoding;
609 struct sr_analog_meaning meaning;
610 struct sr_analog_spec spec;
618 if (!(sdi = cb_data))
621 if (!(devc = sdi->priv))
624 ch = devc->current_channel->data;
627 * Send "frame begin" packet upon reception of data for the
628 * first enabled channel.
630 if (devc->current_channel == devc->enabled_channels) {
631 packet.type = SR_DF_FRAME_BEGIN;
632 sr_session_send(sdi, &packet);
635 if (ch->type != SR_CHANNEL_ANALOG)
638 /* Pass on the received data of the channel(s). */
639 if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
640 sr_err("Reading header failed.");
644 if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
646 g_byte_array_free(data, TRUE);
650 analog.encoding = &encoding;
651 analog.meaning = &meaning;
654 if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
657 meaning.channels = g_slist_append(NULL, ch);
658 packet.payload = &analog;
659 packet.type = SR_DF_ANALOG;
660 sr_session_send(sdi, &packet);
662 g_byte_array_free(data, TRUE);
665 g_slist_free(meaning.channels);
669 * Advance to the next enabled channel. When data for all enabled
670 * channels was received, then flush potentially queued logic data,
671 * and send the "frame end" packet.
673 if (devc->current_channel->next) {
674 devc->current_channel = devc->current_channel->next;
675 lecroy_xstream_request_data(sdi);
679 packet.type = SR_DF_FRAME_END;
680 sr_session_send(sdi, &packet);
683 * End of frame was reached. Stop acquisition after the specified
684 * number of frames, or continue reception by starting over at
685 * the first enabled channel.
687 if (++devc->num_frames == devc->frame_limit) {
688 sdi->driver->dev_acquisition_stop(sdi);
690 devc->current_channel = devc->enabled_channels;
691 lecroy_xstream_request_data(sdi);