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 char *coupling_options[] = {
78 "A1M", // AC with 1 MOhm termination
79 "D50", // DC with 50 Ohm termination
80 "D1M", // DC with 1 MOhm termination
86 static const char *scope_trigger_slopes[] = {
92 static const char *trigger_sources[] = {
102 static const struct sr_rational timebases[] = {
104 { 20, 1000000000000 },
105 { 50, 1000000000000 },
106 { 100, 1000000000000 },
107 { 200, 1000000000000 },
108 { 500, 1000000000000 },
152 static const struct sr_rational vdivs[] = {
172 static const char *scope_analog_channel_names[] = {
179 static const struct scope_config scope_models[] = {
181 .name = { "WP7000", "WP7100", "WP7200", "WP7300" },
183 .analog_channels = 4,
184 .analog_names = &scope_analog_channel_names,
186 .coupling_options = &coupling_options,
187 .trigger_sources = &trigger_sources,
188 .trigger_slopes = &scope_trigger_slopes,
190 .timebases = timebases,
191 .num_timebases = ARRAY_SIZE(timebases),
194 .num_vdivs = ARRAY_SIZE(vdivs),
201 static void scope_state_dump(const struct scope_config *config,
202 struct scope_state *state)
207 for (i = 0; i < config->analog_channels; i++) {
208 tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
209 config->vdivs[state->analog_channels[i].vdiv].q);
210 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
211 i + 1, state->analog_channels[i].state ? "On" : "Off",
212 (*config->coupling_options)[state->analog_channels[i].coupling],
213 tmp, state->analog_channels[i].vertical_offset);
216 tmp = sr_period_string(config->timebases[state->timebase].p,
217 config->timebases[state->timebase].q);
218 sr_info("Current timebase: %s", tmp);
221 tmp = sr_samplerate_string(state->sample_rate);
222 sr_info("Current samplerate: %s", tmp);
225 sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
226 (*config->trigger_sources)[state->trigger_source],
227 (*config->trigger_slopes)[state->trigger_slope],
228 state->horiz_triggerpos);
231 static int scope_state_get_array_option(const char *resp,
232 const char *(*array)[], int *result)
236 for (i = 0; (*array)[i]; i++) {
237 if (!g_strcmp0(resp, (*array)[i])) {
247 * This function takes a value of the form "2.000E-03" and returns the index
248 * of an array where a matching pair was found.
250 * @param value The string to be parsed.
251 * @param array The array of s/f pairs.
252 * @param array_len The number of pairs in the array.
253 * @param result The index at which a matching pair was found.
255 * @return SR_ERR on any parsing error, SR_OK otherwise.
257 static int array_float_get(gchar *value, const struct sr_rational *aval,
258 int array_len, unsigned int *result)
260 struct sr_rational rval;
262 if (sr_parse_rational(value, &rval) != SR_OK)
265 for (int i = 0; i < array_len; i++) {
266 if (sr_rational_eq(&rval, aval + i)) {
275 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
276 const struct scope_config *config,
277 struct scope_state *state)
280 char command[MAX_COMMAND_SIZE];
283 for (i = 0; i < config->analog_channels; i++) {
284 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
286 if (sr_scpi_get_bool(scpi, command,
287 &state->analog_channels[i].state) != SR_OK)
290 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
292 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
295 if (array_float_get(tmp_str, vdivs, ARRAY_SIZE(vdivs), &j) != SR_OK) {
297 sr_err("Could not determine array index for vertical div scale.");
302 state->analog_channels[i].vdiv = j;
304 g_snprintf(command, sizeof(command), "C%d:OFFSET?", i + 1);
306 if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
309 g_snprintf(command, sizeof(command), "C%d:COUPLING?", i + 1);
311 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
315 if (scope_state_get_array_option(tmp_str, config->coupling_options,
316 &state->analog_channels[i].coupling) != SR_OK)
325 SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
327 struct dev_context *devc;
328 struct scope_state *state;
329 const struct scope_config *config;
330 float memsize, timediv;
333 state = devc->model_state;
334 config = devc->model_config;
336 if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
339 if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
342 state->sample_rate = 1 / ((timediv * config->num_xdivs) / memsize);
347 SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
349 struct dev_context *devc;
350 struct scope_state *state;
351 const struct scope_config *config;
353 char *tmp_str, *tmp_str2, *tmpp, *p, *key;
354 char command[MAX_COMMAND_SIZE];
355 char *trig_source = NULL;
358 config = devc->model_config;
359 state = devc->model_state;
361 sr_info("Fetching scope state");
363 if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
366 if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
369 if (array_float_get(tmp_str, timebases, ARRAY_SIZE(timebases), &i) != SR_OK) {
371 sr_err("Could not determine array index for timbase scale.");
377 if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
383 while ((p = strtok_r(tmp_str2, ",", &tmpp))) {
390 } else if (!(i & 1)) {
391 if (!strcmp(key, "SR"))
397 if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources, &state->trigger_source) != SR_OK)
400 g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
401 if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
404 if (scope_state_get_array_option(tmp_str,
405 config->trigger_slopes, &state->trigger_slope) != SR_OK)
408 if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
411 if (lecroy_xstream_update_sample_rate(sdi) != SR_OK)
414 sr_info("Fetching finished.");
416 scope_state_dump(config, state);
421 static struct scope_state *scope_state_new(const struct scope_config *config)
423 struct scope_state *state;
425 state = g_malloc0(sizeof(struct scope_state));
426 state->analog_channels = g_malloc0_n(config->analog_channels,
427 sizeof(struct analog_channel_state));
431 SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
433 g_free(state->analog_channels);
437 SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
439 char command[MAX_COMMAND_SIZE];
442 struct sr_channel *ch;
443 struct dev_context *devc;
444 gboolean channel_enabled;
449 /* Find the exact model. */
450 for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
451 for (j = 0; scope_models[i].name[j]; j++) {
452 if (!strcmp(sdi->model, scope_models[i].name[j])) {
457 if (model_index != -1)
461 if (model_index == -1) {
462 sr_dbg("Unsupported LeCroy device.");
466 devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
467 scope_models[model_index].analog_channels);
469 /* Add analog channels. */
470 for (i = 0; i < scope_models[model_index].analog_channels; i++) {
471 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
473 if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
476 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
478 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
479 (*scope_models[model_index].analog_names)[i]);
481 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
483 devc->analog_groups[i]->name = g_strdup(
484 (char *)(*scope_models[model_index].analog_names)[i]);
485 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
487 sdi->channel_groups = g_slist_append(sdi->channel_groups,
488 devc->analog_groups[i]);
491 devc->model_config = &scope_models[model_index];
492 devc->frame_limit = 0;
494 if (!(devc->model_state = scope_state_new(devc->model_config)))
495 return SR_ERR_MALLOC;
497 /* Set the desired response mode. */
498 sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");
503 static int lecroy_waveform_2_x_to_analog(GByteArray *data,
504 struct lecroy_wavedesc *desc,
505 struct sr_datafeed_analog *analog)
507 struct sr_analog_encoding *encoding = analog->encoding;
508 struct sr_analog_meaning *meaning = analog->meaning;
509 struct sr_analog_spec *spec = analog->spec;
511 int16_t *waveform_data;
512 unsigned int i, num_samples;
514 data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
515 num_samples = desc->version_2_x.wave_array_count;
517 waveform_data = (int16_t *)(data->data +
518 + desc->version_2_x.wave_descriptor_length
519 + desc->version_2_x.user_text_len);
521 for (i = 0; i < num_samples; i++)
522 data_float[i] = (float)waveform_data[i]
523 * desc->version_2_x.vertical_gain
524 + desc->version_2_x.vertical_offset;
526 analog->data = data_float;
527 analog->num_samples = num_samples;
529 encoding->unitsize = sizeof(float);
530 encoding->is_signed = TRUE;
531 encoding->is_float = TRUE;
532 encoding->is_bigendian = FALSE;
533 encoding->scale.p = 1;
534 encoding->scale.q = 1;
535 encoding->offset.p = 0;
536 encoding->offset.q = 1;
538 encoding->digits = 6;
539 encoding->is_digits_decimal = FALSE;
541 if (strcmp(desc->version_2_x.vertunit, "A")) {
542 meaning->mq = SR_MQ_CURRENT;
543 meaning->unit = SR_UNIT_AMPERE;
545 /* Default to voltage. */
546 meaning->mq = SR_MQ_VOLTAGE;
547 meaning->unit = SR_UNIT_VOLT;
550 meaning->mqflags = 0;
551 spec->spec_digits = 3;
556 static int lecroy_waveform_to_analog(GByteArray *data,
557 struct sr_datafeed_analog *analog)
559 struct lecroy_wavedesc *desc;
561 if (data->len < sizeof(struct lecroy_wavedesc))
564 desc = (struct lecroy_wavedesc *)data->data;
566 if (!strncmp(desc->template_name, "LECROY_2_2", 16) ||
567 !strncmp(desc->template_name, "LECROY_2_3", 16)) {
568 return lecroy_waveform_2_x_to_analog(data, desc, analog);
571 sr_err("Waveformat template '%.16s' not supported.",
572 desc->template_name);
577 SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
579 struct sr_channel *ch;
580 struct sr_dev_inst *sdi;
581 struct dev_context *devc;
582 struct sr_datafeed_packet packet;
584 struct sr_datafeed_analog analog;
585 struct sr_analog_encoding encoding;
586 struct sr_analog_meaning meaning;
587 struct sr_analog_spec spec;
595 if (!(sdi = cb_data))
598 if (!(devc = sdi->priv))
601 ch = devc->current_channel->data;
604 * Send "frame begin" packet upon reception of data for the
605 * first enabled channel.
607 if (devc->current_channel == devc->enabled_channels) {
608 packet.type = SR_DF_FRAME_BEGIN;
609 sr_session_send(sdi, &packet);
612 if (ch->type != SR_CHANNEL_ANALOG)
615 /* Pass on the received data of the channel(s). */
616 if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
617 sr_err("Reading header failed.");
621 if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
623 g_byte_array_free(data, TRUE);
627 analog.encoding = &encoding;
628 analog.meaning = &meaning;
631 if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
634 meaning.channels = g_slist_append(NULL, ch);
635 packet.payload = &analog;
636 packet.type = SR_DF_ANALOG;
637 sr_session_send(sdi, &packet);
639 g_byte_array_free(data, TRUE);
642 g_slist_free(meaning.channels);
646 * Advance to the next enabled channel. When data for all enabled
647 * channels was received, then flush potentially queued logic data,
648 * and send the "frame end" packet.
650 if (devc->current_channel->next) {
651 devc->current_channel = devc->current_channel->next;
652 lecroy_xstream_request_data(sdi);
656 packet.type = SR_DF_FRAME_END;
657 sr_session_send(sdi, &packet);
660 * End of frame was reached. Stop acquisition after the specified
661 * number of frames, or continue reception by starting over at
662 * the first enabled channel.
664 if (++devc->num_frames == devc->frame_limit) {
665 sdi->driver->dev_acquisition_stop(sdi);
667 devc->current_channel = devc->enabled_channels;
668 lecroy_xstream_request_data(sdi);