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/>.
25 static struct sr_dev_driver lecroy_xstream_driver_info;
27 static const char *manufacturers[] = {
31 static const uint32_t scanopts[] = {
35 static const uint32_t drvopts[] = {
39 static const uint32_t devopts[] = {
40 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
41 SR_CONF_SAMPLERATE | SR_CONF_GET,
42 SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_NUM_HDIV | SR_CONF_GET,
44 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
45 SR_CONF_TRIGGER_SOURCE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
46 SR_CONF_TRIGGER_SLOPE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
49 static const uint32_t analog_devopts[] = {
50 SR_CONF_NUM_VDIV | SR_CONF_GET,
51 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
52 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
55 static int check_manufacturer(const char *manufacturer)
59 for (i = 0; i < ARRAY_SIZE(manufacturers); i++)
60 if (!strcmp(manufacturer, manufacturers[i]))
66 static struct sr_dev_inst *probe_serial_device(struct sr_scpi_dev_inst *scpi)
68 struct sr_dev_inst *sdi;
69 struct dev_context *devc;
70 struct sr_scpi_hw_info *hw_info;
76 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
77 sr_info("Couldn't get IDN response.");
81 if (check_manufacturer(hw_info->manufacturer) != SR_OK)
84 sdi = g_malloc0(sizeof(struct sr_dev_inst));
85 sdi->vendor = g_strdup(hw_info->manufacturer);
86 sdi->model = g_strdup(hw_info->model);
87 sdi->version = g_strdup(hw_info->firmware_version);
88 sdi->serial_num = g_strdup(hw_info->serial_number);
89 sdi->driver = &lecroy_xstream_driver_info;
90 sdi->inst_type = SR_INST_SCPI;
93 sr_scpi_hw_info_free(hw_info);
96 devc = g_malloc0(sizeof(struct dev_context));
100 if (lecroy_xstream_init_device(sdi) != SR_OK)
106 sr_scpi_hw_info_free(hw_info);
107 sr_dev_inst_free(sdi);
113 static GSList *scan(struct sr_dev_driver *di, GSList *options)
115 return sr_scpi_scan(di->context, options, probe_serial_device);
118 static void clear_helper(void *priv)
120 struct dev_context *devc;
124 lecroy_xstream_state_free(devc->model_state);
126 g_free(devc->analog_groups);
131 static int dev_clear(const struct sr_dev_driver *di)
133 return std_dev_clear(di, clear_helper);
136 static int dev_open(struct sr_dev_inst *sdi)
138 if (sdi->status != SR_ST_ACTIVE && sr_scpi_open(sdi->conn) != SR_OK)
141 if (lecroy_xstream_state_get(sdi) != SR_OK)
144 sdi->status = SR_ST_ACTIVE;
149 static int dev_close(struct sr_dev_inst *sdi)
151 sr_scpi_close(sdi->conn);
153 sdi->status = SR_ST_INACTIVE;
158 static int config_get(uint32_t key, GVariant **data,
159 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
163 struct dev_context *devc;
164 const struct scope_config *model;
165 struct scope_state *state;
173 model = devc->model_config;
174 state = devc->model_state;
178 case SR_CONF_NUM_HDIV:
179 *data = g_variant_new_int32(model->num_xdivs);
182 case SR_CONF_TIMEBASE:
183 *data = g_variant_new("(tt)",
184 model->timebases[state->timebase].p,
185 model->timebases[state->timebase].q);
188 case SR_CONF_NUM_VDIV:
189 for (i = 0; i < model->analog_channels; i++) {
190 if (cg != devc->analog_groups[i])
192 *data = g_variant_new_int32(model->num_ydivs);
197 for (i = 0; i < model->analog_channels; i++) {
198 if (cg != devc->analog_groups[i])
200 *data = g_variant_new("(tt)",
201 model->vdivs[state->analog_channels[i].vdiv].p,
202 model->vdivs[state->analog_channels[i].vdiv].q);
206 case SR_CONF_TRIGGER_SOURCE:
207 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
210 case SR_CONF_TRIGGER_SLOPE:
211 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
214 case SR_CONF_HORIZ_TRIGGERPOS:
215 *data = g_variant_new_double(state->horiz_triggerpos);
218 case SR_CONF_COUPLING:
219 for (i = 0; i < model->analog_channels; i++) {
220 if (cg != devc->analog_groups[i])
222 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
226 case SR_CONF_SAMPLERATE:
227 *data = g_variant_new_uint64(state->sample_rate);
230 case SR_CONF_ENABLED:
231 *data = g_variant_new_boolean(FALSE);
241 static GVariant *build_tuples(const struct sr_rational *array, unsigned int n)
244 GVariant *rational[2];
247 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
249 for (i = 0; i < n; i++) {
250 rational[0] = g_variant_new_uint64(array[i].p);
251 rational[1] = g_variant_new_uint64(array[i].q);
253 /* FIXME: Valgrind reports a memory leak here. */
254 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
257 return g_variant_builder_end(&gvb);
260 static int config_set(uint32_t key, GVariant *data,
261 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
265 char command[MAX_COMMAND_SIZE];
266 struct dev_context *devc;
267 const struct scope_config *model;
268 struct scope_state *state;
273 gboolean update_sample_rate;
280 model = devc->model_config;
281 state = devc->model_state;
282 update_sample_rate = FALSE;
287 case SR_CONF_LIMIT_FRAMES:
288 devc->frame_limit = g_variant_get_uint64(data);
291 case SR_CONF_TRIGGER_SOURCE:
292 tmp = g_variant_get_string(data, NULL);
293 for (i = 0; (*model->trigger_sources)[i]; i++) {
294 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
296 state->trigger_source = i;
297 g_snprintf(command, sizeof(command),
298 "SET TRIGGER SOURCE %s",
299 (*model->trigger_sources)[i]);
301 ret = sr_scpi_send(sdi->conn, command);
306 g_variant_get(data, "(tt)", &p, &q);
308 for (i = 0; i < model->num_vdivs; i++) {
309 if (p != model->vdivs[i].p || q != model->vdivs[i].q)
311 for (j = 1; j <= model->analog_channels; j++) {
312 if (cg != devc->analog_groups[j - 1])
314 state->analog_channels[j - 1].vdiv = i;
315 g_snprintf(command, sizeof(command),
316 "C%d:VDIV %E", j, (float)p/q);
318 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
319 sr_scpi_get_opc(sdi->conn) != SR_OK)
329 case SR_CONF_TIMEBASE:
330 g_variant_get(data, "(tt)", &p, &q);
332 for (i = 0; i < model->num_timebases; i++) {
333 if (p != model->timebases[i].p ||
334 q != model->timebases[i].q)
337 g_snprintf(command, sizeof(command),
338 "TIME_DIV %E", (float)p/q);
340 ret = sr_scpi_send(sdi->conn, command);
341 update_sample_rate = TRUE;
345 case SR_CONF_HORIZ_TRIGGERPOS:
346 tmp_d = g_variant_get_double(data);
348 if (tmp_d < 0.0 || tmp_d > 1.0)
351 state->horiz_triggerpos = tmp_d;
352 tmp_d = -(tmp_d - 0.5) *
353 ((double)model->timebases[state->timebase].p /
354 model->timebases[state->timebase].q)
357 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
359 ret = sr_scpi_send(sdi->conn, command);
361 case SR_CONF_TRIGGER_SLOPE:
362 tmp = g_variant_get_string(data, NULL);
363 for (i = 0; (*model->trigger_slopes)[i]; i++) {
364 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
366 state->trigger_slope = i;
367 g_snprintf(command, sizeof(command),
368 "SET TRIGGER SLOPE %s",
369 (*model->trigger_slopes)[i]);
371 ret = sr_scpi_send(sdi->conn, command);
375 case SR_CONF_COUPLING:
376 tmp = g_variant_get_string(data, NULL);
378 for (i = 0; (*model->coupling_options)[i]; i++) {
379 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
381 for (j = 1; j <= model->analog_channels; j++) {
382 if (cg != devc->analog_groups[j - 1])
384 state->analog_channels[j - 1].coupling = i;
386 g_snprintf(command, sizeof(command),
387 "C%d:COUPLING %s", j, tmp);
389 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
390 sr_scpi_get_opc(sdi->conn) != SR_OK)
405 ret = sr_scpi_get_opc(sdi->conn);
407 if (ret == SR_OK && update_sample_rate)
408 ret = lecroy_xstream_update_sample_rate(sdi);
413 static int config_list(uint32_t key, GVariant **data,
414 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
416 struct dev_context *devc = NULL;
417 const struct scope_config *model = NULL;
421 /* SR_CONF_SCAN_OPTIONS is always valid, regardless of sdi or channel group. */
422 if (key == SR_CONF_SCAN_OPTIONS) {
423 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
424 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
428 /* If sdi is NULL, nothing except SR_CONF_DEVICE_OPTIONS can be provided. */
429 if (key == SR_CONF_DEVICE_OPTIONS && !sdi) {
430 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
431 drvopts, ARRAY_SIZE(drvopts), sizeof(uint32_t));
435 /* Every other option requires a valid device instance. */
440 model = devc->model_config;
443 case SR_CONF_DEVICE_OPTIONS:
445 /* If cg is NULL, only the SR_CONF_DEVICE_OPTIONS that are not
446 * specific to a channel group must be returned. */
447 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
448 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
451 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
452 analog_devopts, ARRAY_SIZE(analog_devopts),
455 case SR_CONF_COUPLING:
456 *data = g_variant_new_strv(*model->coupling_options,
457 g_strv_length((char **)*model->coupling_options));
459 case SR_CONF_TRIGGER_SOURCE:
462 *data = g_variant_new_strv(*model->trigger_sources,
463 g_strv_length((char **)*model->trigger_sources));
465 case SR_CONF_TRIGGER_SLOPE:
468 *data = g_variant_new_strv(*model->trigger_slopes,
469 g_strv_length((char **)*model->trigger_slopes));
471 case SR_CONF_TIMEBASE:
474 *data = build_tuples(model->timebases, model->num_timebases);
479 *data = build_tuples(model->vdivs, model->num_vdivs);
487 SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
489 char command[MAX_COMMAND_SIZE];
490 struct sr_channel *ch;
491 struct dev_context *devc;
495 ch = devc->current_channel->data;
497 if (ch->type != SR_CHANNEL_ANALOG)
500 g_snprintf(command, sizeof(command),
501 "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
502 return sr_scpi_send(sdi->conn, command);
505 static int setup_channels(const struct sr_dev_inst *sdi)
508 gboolean setup_changed;
509 char command[MAX_COMMAND_SIZE];
510 struct scope_state *state;
511 struct sr_channel *ch;
512 struct dev_context *devc;
513 struct sr_scpi_dev_inst *scpi;
517 state = devc->model_state;
518 setup_changed = FALSE;
520 for (l = sdi->channels; l; l = l->next) {
523 case SR_CHANNEL_ANALOG:
524 if (ch->enabled == state->analog_channels[ch->index].state)
526 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
527 ch->index + 1, ch->enabled ? "ON" : "OFF");
529 if (sr_scpi_send(scpi, command) != SR_OK)
531 state->analog_channels[ch->index].state = ch->enabled;
532 setup_changed = TRUE;
539 if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
545 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
548 struct sr_channel *ch;
549 struct dev_context *devc;
551 struct sr_scpi_dev_inst *scpi;
555 /* Preset empty results. */
556 g_slist_free(devc->enabled_channels);
557 devc->enabled_channels = NULL;
560 * Contruct the list of enabled channels. Determine the highest
561 * number of digital pods involved in the acquisition.
564 for (l = sdi->channels; l; l = l->next) {
568 /* Only add a single digital channel per group (pod). */
569 devc->enabled_channels = g_slist_append(
570 devc->enabled_channels, ch);
573 if (!devc->enabled_channels)
577 * Configure the analog channels and the
578 * corresponding digital pods.
580 if (setup_channels(sdi) != SR_OK) {
581 sr_err("Failed to setup channel configuration!");
587 * Start acquisition on the first enabled channel. The
588 * receive routine will continue driving the acquisition.
590 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
591 lecroy_xstream_receive_data, (void *)sdi);
593 std_session_send_df_header(sdi);
595 devc->current_channel = devc->enabled_channels;
597 return lecroy_xstream_request_data(sdi);
600 g_slist_free(devc->enabled_channels);
601 devc->enabled_channels = NULL;
606 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
608 struct dev_context *devc;
609 struct sr_scpi_dev_inst *scpi;
611 std_session_send_df_end(sdi);
615 devc->num_frames = 0;
616 g_slist_free(devc->enabled_channels);
617 devc->enabled_channels = NULL;
619 sr_scpi_source_remove(sdi->session, scpi);
624 static struct sr_dev_driver lecroy_xstream_driver_info = {
625 .name = "lecroy-xstream",
626 .longname = "LeCroy X-Stream",
629 .cleanup = std_cleanup,
631 .dev_list = std_dev_list,
632 .dev_clear = dev_clear,
633 .config_get = config_get,
634 .config_set = config_set,
635 .config_list = config_list,
636 .dev_open = dev_open,
637 .dev_close = dev_close,
638 .dev_acquisition_start = dev_acquisition_start,
639 .dev_acquisition_stop = dev_acquisition_stop,
642 SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);