]> sigrok.org Git - libsigrok.git/blob - src/hardware/lecroy-xstream/protocol.c
lecroy-xstream: Implement config_channel_set API callback
[libsigrok.git] / src / hardware / lecroy-xstream / protocol.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2017 Sven Schnelle <svens@stackframe.org>
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 #include <config.h>
21 #include <math.h>
22 #include <stdlib.h>
23 #include "scpi.h"
24 #include "protocol.h"
25
26 struct lecroy_wavedesc_2_x {
27         uint16_t comm_type;
28         uint16_t comm_order; /* 1 - little endian */
29         uint32_t wave_descriptor_length;
30         uint32_t user_text_len;
31         uint32_t res_desc1;
32         uint32_t trigtime_array_length;
33         uint32_t ris_time1_array_length;
34         uint32_t res_array1;
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;
41         char trace_label[16];
42         uint32_t reserved;
43         uint32_t wave_array_count;
44         uint32_t points_per_screen;
45         uint32_t first_valid_point;
46         uint32_t last_valid_point;
47         uint32_t first_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;
53         uint16_t pair_offset;
54         float vertical_gain;
55         float vertical_offset;
56         float max_value;
57         float min_value;
58         uint16_t nominal_bits;
59         uint16_t nom_subarray_count;
60         float horiz_interval;
61         double horiz_offset;
62         double pixel_offset;
63         char vertunit[48];
64         char horunit[48];
65         uint32_t reserved1;
66         double trigger_time;
67 } __attribute__((packed));
68
69 struct lecroy_wavedesc {
70         char descriptor_name[16];
71         char template_name[16];
72         union {
73                 struct lecroy_wavedesc_2_x version_2_x;
74         };
75 } __attribute__((packed));
76
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
81         "GND",
82         "OVL",
83 };
84
85 static const char *scope_trigger_slopes[] = {
86         "POS", "NEG",
87 };
88
89 static const char *trigger_sources[] = {
90         "C1", "C2", "C3", "C4", "LINE", "EXT",
91 };
92
93 static const uint64_t timebases[][2] = {
94         /* picoseconds */
95         { 20, 1000000000000 },
96         { 50, 1000000000000 },
97         { 100, 1000000000000 },
98         { 200, 1000000000000 },
99         { 500, 1000000000000 },
100         /* nanoseconds */
101         { 1, 1000000000 },
102         { 2, 1000000000 },
103         { 5, 1000000000 },
104         { 10, 1000000000 },
105         { 20, 1000000000 },
106         { 50, 1000000000 },
107         { 100, 1000000000 },
108         { 200, 1000000000 },
109         { 500, 1000000000 },
110         /* microseconds */
111         { 1, 1000000 },
112         { 2, 1000000 },
113         { 5, 1000000 },
114         { 10, 1000000 },
115         { 20, 1000000 },
116         { 50, 1000000 },
117         { 100, 1000000 },
118         { 200, 1000000 },
119         { 500, 1000000 },
120         /* milliseconds */
121         { 1, 1000 },
122         { 2, 1000 },
123         { 5, 1000 },
124         { 10, 1000 },
125         { 20, 1000 },
126         { 50, 1000 },
127         { 100, 1000 },
128         { 200, 1000 },
129         { 500, 1000 },
130         /* seconds */
131         { 1, 1 },
132         { 2, 1 },
133         { 5, 1 },
134         { 10, 1 },
135         { 20, 1 },
136         { 50, 1 },
137         { 100, 1 },
138         { 200, 1 },
139         { 500, 1 },
140         { 1000, 1 },
141 };
142
143 static const uint64_t vdivs[][2] = {
144         /* millivolts */
145         { 1, 1000 },
146         { 2, 1000 },
147         { 5, 1000 },
148         { 10, 1000 },
149         { 20, 1000 },
150         { 50, 1000 },
151         { 100, 1000 },
152         { 200, 1000 },
153         { 500, 1000 },
154         /* volts */
155         { 1, 1 },
156         { 2, 1 },
157         { 5, 1 },
158         { 10, 1 },
159         { 20, 1 },
160         { 50, 1 },
161 };
162
163 static const char *scope_analog_channel_names[] = {
164         "CH1", "CH2", "CH3", "CH4",
165 };
166
167 static const struct scope_config scope_models[] = {
168         {
169                  /* Default config */
170                 .name = {NULL},
171
172                 .analog_channels = 4,
173                 .analog_names = &scope_analog_channel_names,
174
175                 .coupling_options = &coupling_options,
176                 .num_coupling_options = ARRAY_SIZE(coupling_options),
177
178                 .trigger_sources = &trigger_sources,
179                 .num_trigger_sources = ARRAY_SIZE(trigger_sources),
180
181                 .trigger_slopes = &scope_trigger_slopes,
182                 .num_trigger_slopes = ARRAY_SIZE(scope_trigger_slopes),
183
184                 .timebases = &timebases,
185                 .num_timebases = ARRAY_SIZE(timebases),
186
187                 .vdivs = &vdivs,
188                 .num_vdivs = ARRAY_SIZE(vdivs),
189
190                 .num_xdivs = 10,
191                 .num_ydivs = 8,
192         },
193 };
194
195 static void scope_state_dump(const struct scope_config *config,
196                 struct scope_state *state)
197 {
198         unsigned int i;
199         char *tmp;
200
201         for (i = 0; i < config->analog_channels; i++) {
202                 tmp = sr_voltage_string((*config->vdivs)[state->analog_channels[i].vdiv][0],
203                                 (*config->vdivs)[state->analog_channels[i].vdiv][1]);
204                 sr_info("State of analog channel %d -> %s : %s (coupling) %s (vdiv) %2.2e (offset)",
205                                 i + 1, state->analog_channels[i].state ? "On" : "Off",
206                                 (*config->coupling_options)[state->analog_channels[i].coupling],
207                                 tmp, state->analog_channels[i].vertical_offset);
208         }
209
210         tmp = sr_period_string((*config->timebases)[state->timebase][0],
211                         (*config->timebases)[state->timebase][1]);
212         sr_info("Current timebase: %s", tmp);
213         g_free(tmp);
214
215         tmp = sr_samplerate_string(state->sample_rate);
216         sr_info("Current samplerate: %s", tmp);
217         g_free(tmp);
218
219         sr_info("Current trigger: %s (source), %s (slope) %.2f (offset)",
220                         (*config->trigger_sources)[state->trigger_source],
221                         (*config->trigger_slopes)[state->trigger_slope],
222                         state->horiz_triggerpos);
223 }
224
225 static int scope_state_get_array_option(const char *resp,
226                 const char *(*array)[], unsigned int n, int *result)
227 {
228         unsigned int i;
229
230         for (i = 0; i < n; i++) {
231                 if (!g_strcmp0(resp, (*array)[i])) {
232                         *result = i;
233                         return SR_OK;
234                 }
235         }
236
237         return SR_ERR;
238 }
239
240 /**
241  * This function takes a value of the form "2.000E-03" and returns the index
242  * of an array where a matching pair was found.
243  *
244  * @param value The string to be parsed.
245  * @param array The array of s/f pairs.
246  * @param array_len The number of pairs in the array.
247  * @param result The index at which a matching pair was found.
248  *
249  * @return SR_ERR on any parsing error, SR_OK otherwise.
250  */
251 static int array_float_get(gchar *value, const uint64_t array[][2],
252                 int array_len, unsigned int *result)
253 {
254         struct sr_rational rval;
255         struct sr_rational aval;
256
257         if (sr_parse_rational(value, &rval) != SR_OK)
258                 return SR_ERR;
259
260         for (int i = 0; i < array_len; i++) {
261                 sr_rational_set(&aval, array[i][0], array[i][1]);
262                 if (sr_rational_eq(&rval, &aval)) {
263                         *result = i;
264                         return SR_OK;
265                 }
266         }
267
268         return SR_ERR;
269 }
270
271 static int analog_channel_state_get(struct sr_scpi_dev_inst *scpi,
272                 const struct scope_config *config, struct scope_state *state)
273 {
274         unsigned int i, j;
275         char command[MAX_COMMAND_SIZE];
276         char *tmp_str;
277
278         for (i = 0; i < config->analog_channels; i++) {
279                 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
280
281                 if (sr_scpi_get_bool(scpi, command,
282                                 &state->analog_channels[i].state) != SR_OK)
283                         return SR_ERR;
284
285                 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
286
287                 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
288                         return SR_ERR;
289
290                 if (array_float_get(tmp_str, ARRAY_AND_SIZE(vdivs), &j) != SR_OK) {
291                         g_free(tmp_str);
292                         sr_err("Could not determine array index for vertical div scale.");
293                         return SR_ERR;
294                 }
295
296                 g_free(tmp_str);
297                 state->analog_channels[i].vdiv = j;
298
299                 g_snprintf(command, sizeof(command), "C%d:OFFSET?", i + 1);
300
301                 if (sr_scpi_get_float(scpi, command, &state->analog_channels[i].vertical_offset) != SR_OK)
302                         return SR_ERR;
303
304                 g_snprintf(command, sizeof(command), "C%d:COUPLING?", i + 1);
305
306                 if (sr_scpi_get_string(scpi, command, &tmp_str) != SR_OK)
307                         return SR_ERR;
308
309
310                 if (scope_state_get_array_option(tmp_str, config->coupling_options,
311                                  config->num_coupling_options,
312                                  &state->analog_channels[i].coupling) != SR_OK)
313                         return SR_ERR;
314
315                 g_free(tmp_str);
316         }
317
318         return SR_OK;
319 }
320
321 SR_PRIV int lecroy_xstream_channel_state_set(const struct sr_dev_inst *sdi,
322                 const int ch_index, gboolean ch_state)
323 {
324         GSList *l;
325         struct sr_channel *ch;
326         struct dev_context *devc = NULL;
327         struct scope_state *state;
328         char command[MAX_COMMAND_SIZE];
329         gboolean chan_found;
330         int result;
331
332         result = SR_OK;
333
334         devc = sdi->priv;
335         state = devc->model_state;
336         chan_found = FALSE;
337
338         for (l = sdi->channels; l; l = l->next) {
339                 ch = l->data;
340
341                 switch (ch->type) {
342                 case SR_CHANNEL_ANALOG:
343                         if (ch->index == ch_index) {
344                                 g_snprintf(command, sizeof(command), "C%d:TRACE %s", ch_index + 1,
345                                                 (ch_state ? "ON" : "OFF"));
346                                 if ((sr_scpi_send(sdi->conn, command) != SR_OK ||
347                                                 sr_scpi_get_opc(sdi->conn) != SR_OK)) {
348                                         result = SR_ERR;
349                                         break;
350                                 }
351
352                                 ch->enabled = ch_state;
353                                 state->analog_channels[ch->index].state = ch_state;
354                                 chan_found = TRUE;
355                                 break;
356                         }
357                         break;
358                 default:
359                         result = SR_ERR_NA;
360                 }
361         }
362
363         if ((result == SR_OK) && !chan_found)
364                 result = SR_ERR_BUG;
365
366         return result;
367 }
368
369 SR_PRIV int lecroy_xstream_update_sample_rate(const struct sr_dev_inst *sdi)
370 {
371         struct dev_context *devc;
372         struct scope_state *state;
373         const struct scope_config *config;
374         float memsize, timediv;
375
376         devc = sdi->priv;
377         state = devc->model_state;
378         config = devc->model_config;
379
380         if (sr_scpi_get_float(sdi->conn, "MEMORY_SIZE?", &memsize) != SR_OK)
381                 return SR_ERR;
382
383         if (sr_scpi_get_float(sdi->conn, "TIME_DIV?", &timediv) != SR_OK)
384                 return SR_ERR;
385
386         state->sample_rate = 1 / ((timediv * config->num_xdivs) / memsize);
387
388         return SR_OK;
389 }
390
391 SR_PRIV int lecroy_xstream_state_get(struct sr_dev_inst *sdi)
392 {
393         struct dev_context *devc;
394         struct scope_state *state;
395         const struct scope_config *config;
396         unsigned int i;
397         char *tmp_str, *tmp_str2, *tmpp, *p, *key;
398         char command[MAX_COMMAND_SIZE];
399         char *trig_source = NULL;
400
401         devc = sdi->priv;
402         config = devc->model_config;
403         state = devc->model_state;
404
405         sr_info("Fetching scope state");
406
407         if (analog_channel_state_get(sdi->conn, config, state) != SR_OK)
408                 return SR_ERR;
409
410         if (sr_scpi_get_string(sdi->conn, "TIME_DIV?", &tmp_str) != SR_OK)
411                 return SR_ERR;
412
413         if (array_float_get(tmp_str, ARRAY_AND_SIZE(timebases), &i) != SR_OK) {
414                 g_free(tmp_str);
415                 sr_err("Could not determine array index for timbase scale.");
416                 return SR_ERR;
417         }
418         g_free(tmp_str);
419         state->timebase = i;
420
421         if (sr_scpi_get_string(sdi->conn, "TRIG_SELECT?", &tmp_str) != SR_OK)
422                 return SR_ERR;
423
424         key = tmpp = NULL;
425         tmp_str2 = tmp_str;
426         i = 0;
427         while ((p = strtok_r(tmp_str2, ",", &tmpp))) {
428                 tmp_str2 = NULL;
429                 if (i == 0) {
430                         /* trigger type */
431                 } else if (i & 1) {
432                         key = p;
433                         /* key */
434                 } else if (!(i & 1)) {
435                         if (!strcmp(key, "SR"))
436                                 trig_source = p;
437                 }
438                 i++;
439         }
440
441         if (!trig_source || scope_state_get_array_option(trig_source,
442                         config->trigger_sources, config->num_trigger_sources,
443                         &state->trigger_source) != SR_OK)
444                 return SR_ERR;
445
446         g_snprintf(command, sizeof(command), "%s:TRIG_SLOPE?", trig_source);
447         if (sr_scpi_get_string(sdi->conn, command, &tmp_str) != SR_OK)
448                 return SR_ERR;
449
450         if (scope_state_get_array_option(tmp_str, config->trigger_slopes,
451                         config->num_trigger_slopes, &state->trigger_slope) != SR_OK)
452                 return SR_ERR;
453
454         if (sr_scpi_get_float(sdi->conn, "TRIG_DELAY?", &state->horiz_triggerpos) != SR_OK)
455                 return SR_ERR;
456
457         if (lecroy_xstream_update_sample_rate(sdi) != SR_OK)
458                 return SR_ERR;
459
460         sr_info("Fetching finished.");
461
462         scope_state_dump(config, state);
463
464         return SR_OK;
465 }
466
467 static struct scope_state *scope_state_new(const struct scope_config *config)
468 {
469         struct scope_state *state;
470
471         state = g_malloc0(sizeof(struct scope_state));
472         state->analog_channels = g_malloc0_n(config->analog_channels,
473                         sizeof(struct analog_channel_state));
474         return state;
475 }
476
477 SR_PRIV void lecroy_xstream_state_free(struct scope_state *state)
478 {
479         g_free(state->analog_channels);
480         g_free(state);
481 }
482
483 SR_PRIV int lecroy_xstream_init_device(struct sr_dev_inst *sdi)
484 {
485         char command[MAX_COMMAND_SIZE];
486         int model_index;
487         unsigned int i, j;
488         struct sr_channel *ch;
489         struct dev_context *devc;
490         gboolean channel_enabled;
491
492         devc = sdi->priv;
493         model_index = -1;
494
495         /* Find the exact model. */
496         for (i = 0; i < ARRAY_SIZE(scope_models); i++) {
497                 for (j = 0; scope_models[i].name[j]; j++) {
498                         if (!strcmp(sdi->model, scope_models[i].name[j])) {
499                                 model_index = i;
500                                 break;
501                         }
502                 }
503                 if (model_index != -1)
504                         break;
505         }
506
507         if (model_index == -1) {
508                 sr_dbg("Unknown LeCroy device, using default config.");
509                 for (i = 0; i < ARRAY_SIZE(scope_models); i++)
510                         if (scope_models[i].name[0] == NULL)
511                                 model_index = i;
512         }
513
514         /* Set the desired response and format modes. */
515         sr_scpi_send(sdi->conn, "COMM_HEADER OFF");
516         sr_scpi_send(sdi->conn, "COMM_FORMAT DEF9,WORD,BIN");
517
518         devc->analog_groups = g_malloc0(sizeof(struct sr_channel_group*) *
519                                 scope_models[model_index].analog_channels);
520
521         /* Add analog channels. */
522         for (i = 0; i < scope_models[model_index].analog_channels; i++) {
523                 g_snprintf(command, sizeof(command), "C%d:TRACE?", i + 1);
524
525                 if (sr_scpi_get_bool(sdi->conn, command, &channel_enabled) != SR_OK)
526                         return SR_ERR;
527
528                 g_snprintf(command, sizeof(command), "C%d:VDIV?", i + 1);
529
530                 ch = sr_channel_new(sdi, i, SR_CHANNEL_ANALOG, channel_enabled,
531                         (*scope_models[model_index].analog_names)[i]);
532
533                 devc->analog_groups[i] = g_malloc0(sizeof(struct sr_channel_group));
534
535                 devc->analog_groups[i]->name = g_strdup(
536                         (char *)(*scope_models[model_index].analog_names)[i]);
537                 devc->analog_groups[i]->channels = g_slist_append(NULL, ch);
538
539                 sdi->channel_groups = g_slist_append(sdi->channel_groups,
540                         devc->analog_groups[i]);
541         }
542
543         devc->model_config = &scope_models[model_index];
544         devc->frame_limit = 0;
545         devc->model_state = scope_state_new(devc->model_config);
546
547         return SR_OK;
548 }
549
550 static int lecroy_waveform_2_x_to_analog(GByteArray *data,
551                 struct lecroy_wavedesc *desc, struct sr_datafeed_analog *analog)
552 {
553         struct sr_analog_encoding *encoding = analog->encoding;
554         struct sr_analog_meaning *meaning = analog->meaning;
555         struct sr_analog_spec *spec = analog->spec;
556         float *data_float;
557         int16_t *waveform_data;
558         unsigned int i, num_samples;
559
560         data_float = g_malloc(desc->version_2_x.wave_array_count * sizeof(float));
561         num_samples = desc->version_2_x.wave_array_count;
562
563         waveform_data = (int16_t*)(data->data +
564                 + desc->version_2_x.wave_descriptor_length
565                 + desc->version_2_x.user_text_len);
566
567         for (i = 0; i < num_samples; i++)
568                 data_float[i] = (float)waveform_data[i]
569                         * desc->version_2_x.vertical_gain
570                         + desc->version_2_x.vertical_offset;
571
572         analog->data = data_float;
573         analog->num_samples = num_samples;
574
575         encoding->unitsize = sizeof(float);
576         encoding->is_signed = TRUE;
577         encoding->is_float = TRUE;
578         encoding->is_bigendian = FALSE;
579         encoding->scale.p = 1;
580         encoding->scale.q = 1;
581         encoding->offset.p = 0;
582         encoding->offset.q = 1;
583
584         encoding->digits = 6;
585         encoding->is_digits_decimal = FALSE;
586
587         if (strcmp(desc->version_2_x.vertunit, "A")) {
588                 meaning->mq = SR_MQ_CURRENT;
589                 meaning->unit = SR_UNIT_AMPERE;
590         } else {
591                 /* Default to voltage. */
592                 meaning->mq = SR_MQ_VOLTAGE;
593                 meaning->unit = SR_UNIT_VOLT;
594         }
595
596         meaning->mqflags = 0;
597         spec->spec_digits = 3;
598
599         return SR_OK;
600 }
601
602 static int lecroy_waveform_to_analog(GByteArray *data,
603                 struct sr_datafeed_analog *analog)
604 {
605         struct lecroy_wavedesc *desc;
606
607         if (data->len < sizeof(struct lecroy_wavedesc))
608                 return SR_ERR;
609
610         desc = (struct lecroy_wavedesc*)data->data;
611
612         if (!strncmp(desc->template_name, "LECROY_2_2", 16) ||
613             !strncmp(desc->template_name, "LECROY_2_3", 16)) {
614                 return lecroy_waveform_2_x_to_analog(data, desc, analog);
615         }
616
617         sr_err("Waveformat template '%.16s' not supported.", desc->template_name);
618         return SR_ERR;
619 }
620
621 SR_PRIV int lecroy_xstream_receive_data(int fd, int revents, void *cb_data)
622 {
623         struct sr_channel *ch;
624         struct sr_dev_inst *sdi;
625         struct dev_context *devc;
626         struct sr_datafeed_packet packet;
627         GByteArray *data;
628         struct sr_datafeed_analog analog;
629         struct sr_analog_encoding encoding;
630         struct sr_analog_meaning meaning;
631         struct sr_analog_spec spec;
632         char buf[8];
633
634         (void)fd;
635         (void)revents;
636
637         data = NULL;
638
639         if (!(sdi = cb_data))
640                 return TRUE;
641
642         if (!(devc = sdi->priv))
643                 return TRUE;
644
645         ch = devc->current_channel->data;
646
647         /*
648          * Send "frame begin" packet upon reception of data for the
649          * first enabled channel.
650          */
651         if (devc->current_channel == devc->enabled_channels) {
652                 packet.type = SR_DF_FRAME_BEGIN;
653                 sr_session_send(sdi, &packet);
654         }
655
656         if (ch->type != SR_CHANNEL_ANALOG)
657                 return SR_ERR;
658
659         /* Pass on the received data of the channel(s). */
660         if (sr_scpi_read_data(sdi->conn, buf, 4) != 4) {
661                 sr_err("Reading header failed.");
662                 return TRUE;
663         }
664
665         if (sr_scpi_get_block(sdi->conn, NULL, &data) != SR_OK) {
666                 if (data)
667                         g_byte_array_free(data, TRUE);
668                 return TRUE;
669         }
670
671         analog.encoding = &encoding;
672         analog.meaning = &meaning;
673         analog.spec = &spec;
674
675         if (lecroy_waveform_to_analog(data, &analog) != SR_OK)
676                 return SR_ERR;
677
678         meaning.channels = g_slist_append(NULL, ch);
679         packet.payload = &analog;
680         packet.type = SR_DF_ANALOG;
681         sr_session_send(sdi, &packet);
682
683         g_byte_array_free(data, TRUE);
684         data = NULL;
685
686         g_slist_free(meaning.channels);
687         g_free(analog.data);
688
689         /*
690          * Advance to the next enabled channel. When data for all enabled
691          * channels was received, then flush potentially queued logic data,
692          * and send the "frame end" packet.
693          */
694         if (devc->current_channel->next) {
695                 devc->current_channel = devc->current_channel->next;
696                 lecroy_xstream_request_data(sdi);
697                 return TRUE;
698         }
699
700         packet.type = SR_DF_FRAME_END;
701         sr_session_send(sdi, &packet);
702
703         /*
704          * End of frame was reached. Stop acquisition after the specified
705          * number of frames, or continue reception by starting over at
706          * the first enabled channel.
707          */
708         if (++devc->num_frames == devc->frame_limit) {
709                 sr_dev_acquisition_stop(sdi);
710         } else {
711                 devc->current_channel = devc->enabled_channels;
712                 lecroy_xstream_request_data(sdi);
713         }
714
715         return TRUE;
716 }