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[] = {
90 static const char *trigger_sources[] = {
91 "C1", "C2", "C3", "C4", "LINE", "EXT", NULL,
94 static const struct sr_rational timebases[] = {
96 { 20, 1000000000000 },
97 { 50, 1000000000000 },
98 { 100, 1000000000000 },
99 { 200, 1000000000000 },
100 { 500, 1000000000000 },
144 static const struct sr_rational vdivs[] = {
164 static const char *scope_analog_channel_names[] = {
165 "CH1", "CH2", "CH3", "CH4",
168 static const struct scope_config scope_models[] = {
170 .name = { "WP7000", "WP7100", "WP7200", "WP7300" },
172 .analog_channels = 4,
173 .analog_names = &scope_analog_channel_names,
175 .coupling_options = &coupling_options,
176 .trigger_sources = &trigger_sources,
177 .trigger_slopes = &scope_trigger_slopes,
179 .timebases = timebases,
180 .num_timebases = ARRAY_SIZE(timebases),
183 .num_vdivs = ARRAY_SIZE(vdivs),
190 static void scope_state_dump(const struct scope_config *config,
191 struct scope_state *state)
196 for (i = 0; i < config->analog_channels; i++) {
197 tmp = sr_voltage_string(config->vdivs[state->analog_channels[i].vdiv].p,
198 config->vdivs[state->analog_channels[i].vdiv].q);
199 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
200 i + 1, state->analog_channels[i].state ? "On" : "Off",
201 (*config->coupling_options)[state->analog_channels[i].coupling],
202 tmp, state->analog_channels[i].vertical_offset);
205 tmp = sr_period_string(config->timebases[state->timebase].p,
206 config->timebases[state->timebase].q);
207 sr_info("Current timebase: %s", tmp);
210 tmp = sr_samplerate_string(state->sample_rate);
211 sr_info("Current samplerate: %s", tmp);
214 sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
215 (*config->trigger_sources)[state->trigger_source],
216 (*config->trigger_slopes)[state->trigger_slope],
217 state->horiz_triggerpos);
220 static int scope_state_get_array_option(const char *resp,
221 const char *(*array)[], int *result)
225 for (i = 0; (*array)[i]; i++) {
226 if (!g_strcmp0(resp, (*array)[i])) {
236 * This function takes a value of the form "2.000E-03" and returns the index
237 * of an array where a matching pair was found.
239 * @param value The string to be parsed.
240 * @param array The array of s/f pairs.
241 * @param array_len The number of pairs in the array.
242 * @param result The index at which a matching pair was found.
244 * @return SR_ERR on any parsing error, SR_OK otherwise.
246 static int array_float_get(gchar *value, const struct sr_rational *aval,
247 int array_len, unsigned int *result)
249 struct sr_rational rval;
251 if (sr_parse_rational(value, &rval) != SR_OK)
254 for (int i = 0; i < array_len; i++) {
255 if (sr_rational_eq(&rval, aval + i)) {
264 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
265 const struct scope_config *config,
266 struct scope_state *state)
269 char command[MAX_COMMAND_SIZE];
272 for (i = 0; i < config->analog_channels; i++) {
273 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
275 if (sr_scpi_get_bool(scpi, command,
276 &state->analog_channels[i].state) != SR_OK)
279 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
281 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
284 if (array_float_get(tmp_str, ARRAY_AND_SIZE(vdivs), &j) != SR_OK) {
286 sr_err("Could not determine array index for vertical div scale.");
291 state->analog_channels[i].vdiv = j;
293 g_snprintf(command, sizeof(command), "C%d:OFFSET?", i + 1);
295 if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
298 g_snprintf(command, sizeof(command), "C%d:COUPLING?", i + 1);
300 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
304 if (scope_state_get_array_option(tmp_str, config->coupling_options,
305 &state->analog_channels[i].coupling) != SR_OK)
314 SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
316 struct dev_context *devc;
317 struct scope_state *state;
318 const struct scope_config *config;
319 float memsize, timediv;
322 state = devc->model_state;
323 config = devc->model_config;
325 if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
328 if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
331 state->sample_rate = 1 / ((timediv * config->num_xdivs) / memsize);
336 SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
338 struct dev_context *devc;
339 struct scope_state *state;
340 const struct scope_config *config;
342 char *tmp_str, *tmp_str2, *tmpp, *p, *key;
343 char command[MAX_COMMAND_SIZE];
344 char *trig_source = NULL;
347 config = devc->model_config;
348 state = devc->model_state;
350 sr_info("Fetching scope state");
352 if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
355 if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
358 if (array_float_get(tmp_str, ARRAY_AND_SIZE(timebases), &i) != SR_OK) {
360 sr_err("Could not determine array index for timbase scale.");
366 if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
372 while ((p = strtok_r(tmp_str2, ",", &tmpp))) {
379 } else if (!(i & 1)) {
380 if (!strcmp(key, "SR"))
386 if (!trig_source || scope_state_get_array_option(trig_source, config->trigger_sources, &state->trigger_source) != SR_OK)
389 g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
390 if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
393 if (scope_state_get_array_option(tmp_str,
394 config->trigger_slopes, &state->trigger_slope) != SR_OK)
397 if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
400 if (lecroy_xstream_update_sample_rate(sdi) != SR_OK)
403 sr_info("Fetching finished.");
405 scope_state_dump(config, state);
410 static struct scope_state *scope_state_new(const struct scope_config *config)
412 struct scope_state *state;
414 state = g_malloc0(sizeof(struct scope_state));
415 state->analog_channels = g_malloc0_n(config->analog_channels,
416 sizeof(struct analog_channel_state));
420 SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
422 g_free(state->analog_channels);
426 SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
428 char command[MAX_COMMAND_SIZE];
431 struct sr_channel *ch;
432 struct dev_context *devc;
433 gboolean channel_enabled;
438 /* Find the exact model. */
439 for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
440 for (j = 0; scope_models[i].name[j]; j++) {
441 if (!strcmp(sdi->model, scope_models[i].name[j])) {
446 if (model_index != -1)
450 if (model_index == -1) {
451 sr_dbg("Unsupported LeCroy device.");
455 devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
456 scope_models[model_index].analog_channels);
458 /* Add analog channels. */
459 for (i = 0; i < scope_models[model_index].analog_channels; i++) {
460 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
462 if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
465 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
467 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
468 (*scope_models[model_index].analog_names)[i]);
470 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
472 devc->analog_groups[i]->name = g_strdup(
473 (char *)(*scope_models[model_index].analog_names)[i]);
474 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
476 sdi->channel_groups = g_slist_append(sdi->channel_groups,
477 devc->analog_groups[i]);
480 devc->model_config = &scope_models[model_index];
481 devc->frame_limit = 0;
483 if (!(devc->model_state = scope_state_new(devc->model_config)))
484 return SR_ERR_MALLOC;
486 /* Set the desired response mode. */
487 sr_scpi_send(sdi->conn, "COMM_HEADER OFF,WORD,BIN");
492 static int lecroy_waveform_2_x_to_analog(GByteArray *data,
493 struct lecroy_wavedesc *desc,
494 struct sr_datafeed_analog *analog)
496 struct sr_analog_encoding *encoding = analog->encoding;
497 struct sr_analog_meaning *meaning = analog->meaning;
498 struct sr_analog_spec *spec = analog->spec;
500 int16_t *waveform_data;
501 unsigned int i, num_samples;
503 data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
504 num_samples = desc->version_2_x.wave_array_count;
506 waveform_data = (int16_t *)(data->data +
507 + desc->version_2_x.wave_descriptor_length
508 + desc->version_2_x.user_text_len);
510 for (i = 0; i < num_samples; i++)
511 data_float[i] = (float)waveform_data[i]
512 * desc->version_2_x.vertical_gain
513 + desc->version_2_x.vertical_offset;
515 analog->data = data_float;
516 analog->num_samples = num_samples;
518 encoding->unitsize = sizeof(float);
519 encoding->is_signed = TRUE;
520 encoding->is_float = TRUE;
521 encoding->is_bigendian = FALSE;
522 encoding->scale.p = 1;
523 encoding->scale.q = 1;
524 encoding->offset.p = 0;
525 encoding->offset.q = 1;
527 encoding->digits = 6;
528 encoding->is_digits_decimal = FALSE;
530 if (strcmp(desc->version_2_x.vertunit, "A")) {
531 meaning->mq = SR_MQ_CURRENT;
532 meaning->unit = SR_UNIT_AMPERE;
534 /* Default to voltage. */
535 meaning->mq = SR_MQ_VOLTAGE;
536 meaning->unit = SR_UNIT_VOLT;
539 meaning->mqflags = 0;
540 spec->spec_digits = 3;
545 static int lecroy_waveform_to_analog(GByteArray *data,
546 struct sr_datafeed_analog *analog)
548 struct lecroy_wavedesc *desc;
550 if (data->len < sizeof(struct lecroy_wavedesc))
553 desc = (struct lecroy_wavedesc *)data->data;
555 if (!strncmp(desc->template_name, "LECROY_2_2", 16) ||
556 !strncmp(desc->template_name, "LECROY_2_3", 16)) {
557 return lecroy_waveform_2_x_to_analog(data, desc, analog);
560 sr_err("Waveformat template '%.16s' not supported.",
561 desc->template_name);
566 SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
568 struct sr_channel *ch;
569 struct sr_dev_inst *sdi;
570 struct dev_context *devc;
571 struct sr_datafeed_packet packet;
573 struct sr_datafeed_analog analog;
574 struct sr_analog_encoding encoding;
575 struct sr_analog_meaning meaning;
576 struct sr_analog_spec spec;
584 if (!(sdi = cb_data))
587 if (!(devc = sdi->priv))
590 ch = devc->current_channel->data;
593 * Send "frame begin" packet upon reception of data for the
594 * first enabled channel.
596 if (devc->current_channel == devc->enabled_channels) {
597 packet.type = SR_DF_FRAME_BEGIN;
598 sr_session_send(sdi, &packet);
601 if (ch->type != SR_CHANNEL_ANALOG)
604 /* Pass on the received data of the channel(s). */
605 if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
606 sr_err("Reading header failed.");
610 if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
612 g_byte_array_free(data, TRUE);
616 analog.encoding = &encoding;
617 analog.meaning = &meaning;
620 if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
623 meaning.channels = g_slist_append(NULL, ch);
624 packet.payload = &analog;
625 packet.type = SR_DF_ANALOG;
626 sr_session_send(sdi, &packet);
628 g_byte_array_free(data, TRUE);
631 g_slist_free(meaning.channels);
635 * Advance to the next enabled channel. When data for all enabled
636 * channels was received, then flush potentially queued logic data,
637 * and send the "frame end" packet.
639 if (devc->current_channel->next) {
640 devc->current_channel = devc->current_channel->next;
641 lecroy_xstream_request_data(sdi);
645 packet.type = SR_DF_FRAME_END;
646 sr_session_send(sdi, &packet);
649 * End of frame was reached. Stop acquisition after the specified
650 * number of frames, or continue reception by starting over at
651 * the first enabled channel.
653 if (++devc->num_frames == devc->frame_limit) {
654 sr_dev_acquisition_stop(sdi);
656 devc->current_channel = devc->enabled_channels;
657 lecroy_xstream_request_data(sdi);