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(struct dev_context *devc)
120 lecroy_xstream_state_free(devc->model_state);
121 g_free(devc->analog_groups);
124 static int dev_clear(const struct sr_dev_driver *di)
126 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
129 static int dev_open(struct sr_dev_inst *sdi)
131 if (sr_scpi_open(sdi->conn) != SR_OK)
134 if (lecroy_xstream_state_get(sdi) != SR_OK)
140 static int dev_close(struct sr_dev_inst *sdi)
142 return sr_scpi_close(sdi->conn);
145 static int config_get(uint32_t key, GVariant **data,
146 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
149 struct dev_context *devc;
150 const struct scope_config *model;
151 struct scope_state *state;
158 model = devc->model_config;
159 state = devc->model_state;
163 case SR_CONF_NUM_HDIV:
164 *data = g_variant_new_int32(model->num_xdivs);
166 case SR_CONF_TIMEBASE:
167 *data = g_variant_new("(tt)",
168 model->timebases[state->timebase].p,
169 model->timebases[state->timebase].q);
171 case SR_CONF_NUM_VDIV:
172 for (i = 0; i < model->analog_channels; i++) {
173 if (cg != devc->analog_groups[i])
175 *data = g_variant_new_int32(model->num_ydivs);
179 for (i = 0; i < model->analog_channels; i++) {
180 if (cg != devc->analog_groups[i])
182 *data = g_variant_new("(tt)",
183 model->vdivs[state->analog_channels[i].vdiv].p,
184 model->vdivs[state->analog_channels[i].vdiv].q);
187 case SR_CONF_TRIGGER_SOURCE:
188 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
190 case SR_CONF_TRIGGER_SLOPE:
191 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
193 case SR_CONF_HORIZ_TRIGGERPOS:
194 *data = g_variant_new_double(state->horiz_triggerpos);
196 case SR_CONF_COUPLING:
197 for (i = 0; i < model->analog_channels; i++) {
198 if (cg != devc->analog_groups[i])
200 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
203 case SR_CONF_SAMPLERATE:
204 *data = g_variant_new_uint64(state->sample_rate);
206 case SR_CONF_ENABLED:
207 *data = g_variant_new_boolean(FALSE);
216 static GVariant *build_tuples(const struct sr_rational *array, unsigned int n)
219 GVariant *rational[2];
222 g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY);
224 for (i = 0; i < n; i++) {
225 rational[0] = g_variant_new_uint64(array[i].p);
226 rational[1] = g_variant_new_uint64(array[i].q);
228 /* FIXME: Valgrind reports a memory leak here. */
229 g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2));
232 return g_variant_builder_end(&gvb);
235 static int config_set(uint32_t key, GVariant *data,
236 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
240 char command[MAX_COMMAND_SIZE];
241 struct dev_context *devc;
242 const struct scope_config *model;
243 struct scope_state *state;
248 gboolean update_sample_rate;
255 model = devc->model_config;
256 state = devc->model_state;
257 update_sample_rate = FALSE;
262 case SR_CONF_LIMIT_FRAMES:
263 devc->frame_limit = g_variant_get_uint64(data);
266 case SR_CONF_TRIGGER_SOURCE:
267 tmp = g_variant_get_string(data, NULL);
268 for (i = 0; (*model->trigger_sources)[i]; i++) {
269 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
271 state->trigger_source = i;
272 g_snprintf(command, sizeof(command),
273 "SET TRIGGER SOURCE %s",
274 (*model->trigger_sources)[i]);
276 ret = sr_scpi_send(sdi->conn, command);
281 g_variant_get(data, "(tt)", &p, &q);
283 for (i = 0; i < model->num_vdivs; i++) {
284 if (p != model->vdivs[i].p || q != model->vdivs[i].q)
286 for (j = 1; j <= model->analog_channels; j++) {
287 if (cg != devc->analog_groups[j - 1])
289 state->analog_channels[j - 1].vdiv = i;
290 g_snprintf(command, sizeof(command),
291 "C%d:VDIV %E", j, (float)p/q);
293 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
294 sr_scpi_get_opc(sdi->conn) != SR_OK)
304 case SR_CONF_TIMEBASE:
305 g_variant_get(data, "(tt)", &p, &q);
307 for (i = 0; i < model->num_timebases; i++) {
308 if (p != model->timebases[i].p ||
309 q != model->timebases[i].q)
312 g_snprintf(command, sizeof(command),
313 "TIME_DIV %E", (float)p/q);
315 ret = sr_scpi_send(sdi->conn, command);
316 update_sample_rate = TRUE;
320 case SR_CONF_HORIZ_TRIGGERPOS:
321 tmp_d = g_variant_get_double(data);
323 if (tmp_d < 0.0 || tmp_d > 1.0)
326 state->horiz_triggerpos = tmp_d;
327 tmp_d = -(tmp_d - 0.5) *
328 ((double)model->timebases[state->timebase].p /
329 model->timebases[state->timebase].q)
332 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
334 ret = sr_scpi_send(sdi->conn, command);
336 case SR_CONF_TRIGGER_SLOPE:
337 tmp = g_variant_get_string(data, NULL);
338 for (i = 0; (*model->trigger_slopes)[i]; i++) {
339 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
341 state->trigger_slope = i;
342 g_snprintf(command, sizeof(command),
343 "SET TRIGGER SLOPE %s",
344 (*model->trigger_slopes)[i]);
346 ret = sr_scpi_send(sdi->conn, command);
350 case SR_CONF_COUPLING:
351 tmp = g_variant_get_string(data, NULL);
353 for (i = 0; (*model->coupling_options)[i]; i++) {
354 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
356 for (j = 1; j <= model->analog_channels; j++) {
357 if (cg != devc->analog_groups[j - 1])
359 state->analog_channels[j - 1].coupling = i;
361 g_snprintf(command, sizeof(command),
362 "C%d:COUPLING %s", j, tmp);
364 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
365 sr_scpi_get_opc(sdi->conn) != SR_OK)
380 ret = sr_scpi_get_opc(sdi->conn);
382 if (ret == SR_OK && update_sample_rate)
383 ret = lecroy_xstream_update_sample_rate(sdi);
388 static int config_list(uint32_t key, GVariant **data,
389 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
391 struct dev_context *devc;
392 const struct scope_config *model;
394 devc = (sdi) ? sdi->priv : NULL;
395 model = (devc) ? devc->model_config : NULL;
398 case SR_CONF_SCAN_OPTIONS:
399 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
400 case SR_CONF_DEVICE_OPTIONS:
402 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
403 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
404 analog_devopts, ARRAY_SIZE(analog_devopts),
407 case SR_CONF_COUPLING:
408 *data = g_variant_new_strv(*model->coupling_options,
409 g_strv_length((char **)*model->coupling_options));
411 case SR_CONF_TRIGGER_SOURCE:
414 *data = g_variant_new_strv(*model->trigger_sources,
415 g_strv_length((char **)*model->trigger_sources));
417 case SR_CONF_TRIGGER_SLOPE:
420 *data = g_variant_new_strv(*model->trigger_slopes,
421 g_strv_length((char **)*model->trigger_slopes));
423 case SR_CONF_TIMEBASE:
426 *data = build_tuples(model->timebases, model->num_timebases);
431 *data = build_tuples(model->vdivs, model->num_vdivs);
439 SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
441 char command[MAX_COMMAND_SIZE];
442 struct sr_channel *ch;
443 struct dev_context *devc;
447 ch = devc->current_channel->data;
449 if (ch->type != SR_CHANNEL_ANALOG)
452 g_snprintf(command, sizeof(command),
453 "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
454 return sr_scpi_send(sdi->conn, command);
457 static int setup_channels(const struct sr_dev_inst *sdi)
460 gboolean setup_changed;
461 char command[MAX_COMMAND_SIZE];
462 struct scope_state *state;
463 struct sr_channel *ch;
464 struct dev_context *devc;
465 struct sr_scpi_dev_inst *scpi;
469 state = devc->model_state;
470 setup_changed = FALSE;
472 for (l = sdi->channels; l; l = l->next) {
475 case SR_CHANNEL_ANALOG:
476 if (ch->enabled == state->analog_channels[ch->index].state)
478 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
479 ch->index + 1, ch->enabled ? "ON" : "OFF");
481 if (sr_scpi_send(scpi, command) != SR_OK)
483 state->analog_channels[ch->index].state = ch->enabled;
484 setup_changed = TRUE;
491 if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
497 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
500 struct sr_channel *ch;
501 struct dev_context *devc;
503 struct sr_scpi_dev_inst *scpi;
508 /* Preset empty results. */
509 g_slist_free(devc->enabled_channels);
510 devc->enabled_channels = NULL;
513 * Contruct the list of enabled channels. Determine the highest
514 * number of digital pods involved in the acquisition.
517 for (l = sdi->channels; l; l = l->next) {
521 /* Only add a single digital channel per group (pod). */
522 devc->enabled_channels = g_slist_append(
523 devc->enabled_channels, ch);
526 if (!devc->enabled_channels)
530 * Configure the analog channels and the
531 * corresponding digital pods.
533 if (setup_channels(sdi) != SR_OK) {
534 sr_err("Failed to setup channel configuration!");
540 * Start acquisition on the first enabled channel. The
541 * receive routine will continue driving the acquisition.
543 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
544 lecroy_xstream_receive_data, (void *)sdi);
546 std_session_send_df_header(sdi);
548 devc->current_channel = devc->enabled_channels;
550 return lecroy_xstream_request_data(sdi);
553 g_slist_free(devc->enabled_channels);
554 devc->enabled_channels = NULL;
559 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
561 struct dev_context *devc;
562 struct sr_scpi_dev_inst *scpi;
564 std_session_send_df_end(sdi);
568 devc->num_frames = 0;
569 g_slist_free(devc->enabled_channels);
570 devc->enabled_channels = NULL;
572 sr_scpi_source_remove(sdi->session, scpi);
577 static struct sr_dev_driver lecroy_xstream_driver_info = {
578 .name = "lecroy-xstream",
579 .longname = "LeCroy X-Stream",
582 .cleanup = std_cleanup,
584 .dev_list = std_dev_list,
585 .dev_clear = dev_clear,
586 .config_get = config_get,
587 .config_set = config_set,
588 .config_list = config_list,
589 .dev_open = dev_open,
590 .dev_close = dev_close,
591 .dev_acquisition_start = dev_acquisition_start,
592 .dev_acquisition_stop = dev_acquisition_stop,
595 SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);