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 devopts_cg_analog[] = {
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 struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
57 struct sr_dev_inst *sdi;
58 struct dev_context *devc;
59 struct sr_scpi_hw_info *hw_info;
65 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
66 sr_info("Couldn't get IDN response.");
70 if (std_str_idx_s(hw_info->manufacturer, ARRAY_AND_SIZE(manufacturers)) < 0)
73 sdi = g_malloc0(sizeof(struct sr_dev_inst));
74 sdi->vendor = g_strdup(hw_info->manufacturer);
75 sdi->model = g_strdup(hw_info->model);
76 sdi->version = g_strdup(hw_info->firmware_version);
77 sdi->serial_num = g_strdup(hw_info->serial_number);
78 sdi->driver = &lecroy_xstream_driver_info;
79 sdi->inst_type = SR_INST_SCPI;
82 sr_scpi_hw_info_free(hw_info);
85 devc = g_malloc0(sizeof(struct dev_context));
89 if (lecroy_xstream_init_device(sdi) != SR_OK)
95 sr_scpi_hw_info_free(hw_info);
96 sr_dev_inst_free(sdi);
102 static GSList *scan(struct sr_dev_driver *di, GSList *options)
104 return sr_scpi_scan(di->context, options, probe_device);
107 static void clear_helper(struct dev_context *devc)
109 lecroy_xstream_state_free(devc->model_state);
110 g_free(devc->analog_groups);
113 static int dev_clear(const struct sr_dev_driver *di)
115 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
118 static int dev_open(struct sr_dev_inst *sdi)
120 if (sr_scpi_open(sdi->conn) != SR_OK)
123 if (lecroy_xstream_state_get(sdi) != SR_OK)
129 static int dev_close(struct sr_dev_inst *sdi)
131 return sr_scpi_close(sdi->conn);
134 static int config_get(uint32_t key, GVariant **data,
135 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
138 struct dev_context *devc;
139 const struct scope_config *model;
140 struct scope_state *state;
147 model = devc->model_config;
148 state = devc->model_state;
152 case SR_CONF_NUM_HDIV:
153 *data = g_variant_new_int32(model->num_xdivs);
155 case SR_CONF_TIMEBASE:
156 *data = g_variant_new("(tt)",
157 model->timebases[state->timebase].p,
158 model->timebases[state->timebase].q);
160 case SR_CONF_NUM_VDIV:
161 for (i = 0; i < model->analog_channels; i++) {
162 if (cg != devc->analog_groups[i])
164 *data = g_variant_new_int32(model->num_ydivs);
168 for (i = 0; i < model->analog_channels; i++) {
169 if (cg != devc->analog_groups[i])
171 *data = g_variant_new("(tt)",
172 model->vdivs[state->analog_channels[i].vdiv].p,
173 model->vdivs[state->analog_channels[i].vdiv].q);
176 case SR_CONF_TRIGGER_SOURCE:
177 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
179 case SR_CONF_TRIGGER_SLOPE:
180 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
182 case SR_CONF_HORIZ_TRIGGERPOS:
183 *data = g_variant_new_double(state->horiz_triggerpos);
185 case SR_CONF_COUPLING:
186 for (i = 0; i < model->analog_channels; i++) {
187 if (cg != devc->analog_groups[i])
189 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
192 case SR_CONF_SAMPLERATE:
193 *data = g_variant_new_uint64(state->sample_rate);
195 case SR_CONF_ENABLED:
196 *data = g_variant_new_boolean(FALSE);
205 static int config_set(uint32_t key, GVariant *data,
206 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
210 char command[MAX_COMMAND_SIZE];
211 struct dev_context *devc;
212 const struct scope_config *model;
213 struct scope_state *state;
218 gboolean update_sample_rate;
225 model = devc->model_config;
226 state = devc->model_state;
227 update_sample_rate = FALSE;
232 case SR_CONF_LIMIT_FRAMES:
233 devc->frame_limit = g_variant_get_uint64(data);
236 case SR_CONF_TRIGGER_SOURCE:
237 tmp = g_variant_get_string(data, NULL);
238 for (i = 0; i < model->num_trigger_sources; i++) {
239 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
241 state->trigger_source = i;
242 g_snprintf(command, sizeof(command),
243 "SET TRIGGER SOURCE %s",
244 (*model->trigger_sources)[i]);
246 ret = sr_scpi_send(sdi->conn, command);
251 g_variant_get(data, "(tt)", &p, &q);
253 for (i = 0; i < model->num_vdivs; i++) {
254 if (p != model->vdivs[i].p || q != model->vdivs[i].q)
256 for (j = 1; j <= model->analog_channels; j++) {
257 if (cg != devc->analog_groups[j - 1])
259 state->analog_channels[j - 1].vdiv = i;
260 g_snprintf(command, sizeof(command),
261 "C%d:VDIV %E", j, (float)p/q);
263 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
264 sr_scpi_get_opc(sdi->conn) != SR_OK)
274 case SR_CONF_TIMEBASE:
275 g_variant_get(data, "(tt)", &p, &q);
277 for (i = 0; i < model->num_timebases; i++) {
278 if (p != model->timebases[i].p ||
279 q != model->timebases[i].q)
282 g_snprintf(command, sizeof(command),
283 "TIME_DIV %E", (float)p/q);
285 ret = sr_scpi_send(sdi->conn, command);
286 update_sample_rate = TRUE;
290 case SR_CONF_HORIZ_TRIGGERPOS:
291 tmp_d = g_variant_get_double(data);
293 if (tmp_d < 0.0 || tmp_d > 1.0)
296 state->horiz_triggerpos = tmp_d;
297 tmp_d = -(tmp_d - 0.5) *
298 ((double)model->timebases[state->timebase].p /
299 model->timebases[state->timebase].q)
302 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
304 ret = sr_scpi_send(sdi->conn, command);
306 case SR_CONF_TRIGGER_SLOPE:
307 tmp = g_variant_get_string(data, NULL);
308 for (i = 0; i < model->num_trigger_slopes; i++) {
309 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
311 state->trigger_slope = i;
312 g_snprintf(command, sizeof(command),
313 "SET TRIGGER SLOPE %s",
314 (*model->trigger_slopes)[i]);
316 ret = sr_scpi_send(sdi->conn, command);
320 case SR_CONF_COUPLING:
321 tmp = g_variant_get_string(data, NULL);
323 for (i = 0; i < model->num_coupling_options; i++) {
324 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
326 for (j = 1; j <= model->analog_channels; j++) {
327 if (cg != devc->analog_groups[j - 1])
329 state->analog_channels[j - 1].coupling = i;
331 g_snprintf(command, sizeof(command),
332 "C%d:COUPLING %s", j, tmp);
334 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
335 sr_scpi_get_opc(sdi->conn) != SR_OK)
350 ret = sr_scpi_get_opc(sdi->conn);
352 if (ret == SR_OK && update_sample_rate)
353 ret = lecroy_xstream_update_sample_rate(sdi);
358 static int config_list(uint32_t key, GVariant **data,
359 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
361 struct dev_context *devc;
362 const struct scope_config *model;
364 devc = (sdi) ? sdi->priv : NULL;
365 model = (devc) ? devc->model_config : NULL;
368 case SR_CONF_SCAN_OPTIONS:
369 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
370 case SR_CONF_DEVICE_OPTIONS:
372 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
373 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
375 case SR_CONF_COUPLING:
376 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
378 case SR_CONF_TRIGGER_SOURCE:
381 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
383 case SR_CONF_TRIGGER_SLOPE:
386 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
388 case SR_CONF_TIMEBASE:
391 *data = std_gvar_tuple_rational(model->timebases, model->num_timebases);
396 *data = std_gvar_tuple_rational(model->vdivs, model->num_vdivs);
405 SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
407 char command[MAX_COMMAND_SIZE];
408 struct sr_channel *ch;
409 struct dev_context *devc;
413 ch = devc->current_channel->data;
415 if (ch->type != SR_CHANNEL_ANALOG)
418 g_snprintf(command, sizeof(command),
419 "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
420 return sr_scpi_send(sdi->conn, command);
423 static int setup_channels(const struct sr_dev_inst *sdi)
426 gboolean setup_changed;
427 char command[MAX_COMMAND_SIZE];
428 struct scope_state *state;
429 struct sr_channel *ch;
430 struct dev_context *devc;
431 struct sr_scpi_dev_inst *scpi;
435 state = devc->model_state;
436 setup_changed = FALSE;
438 for (l = sdi->channels; l; l = l->next) {
441 case SR_CHANNEL_ANALOG:
442 if (ch->enabled == state->analog_channels[ch->index].state)
444 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
445 ch->index + 1, ch->enabled ? "ON" : "OFF");
447 if (sr_scpi_send(scpi, command) != SR_OK)
449 state->analog_channels[ch->index].state = ch->enabled;
450 setup_changed = TRUE;
457 if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
463 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
466 struct sr_channel *ch;
467 struct dev_context *devc;
469 struct sr_scpi_dev_inst *scpi;
474 /* Preset empty results. */
475 g_slist_free(devc->enabled_channels);
476 devc->enabled_channels = NULL;
479 * Contruct the list of enabled channels. Determine the highest
480 * number of digital pods involved in the acquisition.
483 for (l = sdi->channels; l; l = l->next) {
487 /* Only add a single digital channel per group (pod). */
488 devc->enabled_channels = g_slist_append(
489 devc->enabled_channels, ch);
492 if (!devc->enabled_channels)
496 * Configure the analog channels and the
497 * corresponding digital pods.
499 if (setup_channels(sdi) != SR_OK) {
500 sr_err("Failed to setup channel configuration!");
506 * Start acquisition on the first enabled channel. The
507 * receive routine will continue driving the acquisition.
509 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
510 lecroy_xstream_receive_data, (void *)sdi);
512 std_session_send_df_header(sdi);
514 devc->current_channel = devc->enabled_channels;
516 return lecroy_xstream_request_data(sdi);
519 g_slist_free(devc->enabled_channels);
520 devc->enabled_channels = NULL;
525 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
527 struct dev_context *devc;
528 struct sr_scpi_dev_inst *scpi;
530 std_session_send_df_end(sdi);
534 devc->num_frames = 0;
535 g_slist_free(devc->enabled_channels);
536 devc->enabled_channels = NULL;
538 sr_scpi_source_remove(sdi->session, scpi);
543 static struct sr_dev_driver lecroy_xstream_driver_info = {
544 .name = "lecroy-xstream",
545 .longname = "LeCroy X-Stream",
548 .cleanup = std_cleanup,
550 .dev_list = std_dev_list,
551 .dev_clear = dev_clear,
552 .config_get = config_get,
553 .config_set = config_set,
554 .config_list = config_list,
555 .dev_open = dev_open,
556 .dev_close = dev_close,
557 .dev_acquisition_start = dev_acquisition_start,
558 .dev_acquisition_stop = dev_acquisition_stop,
561 SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);