]> sigrok.org Git - libsigrok.git/blame - src/hardware/lecroy-xstream/api.c
lecroy-xstream: Keep acquiring infinitely if no frame limit is set
[libsigrok.git] / src / hardware / lecroy-xstream / api.c
CommitLineData
e3b83c5e
SS
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>
3f2c7c94
SS
21#include <stdlib.h>
22#include "scpi.h"
e3b83c5e
SS
23#include "protocol.h"
24
3f2c7c94
SS
25static struct sr_dev_driver lecroy_xstream_driver_info;
26
27static const char *manufacturers[] = {
28 "LECROY",
29};
30
31static const uint32_t scanopts[] = {
32 SR_CONF_CONN,
33};
34
90230cfa
SA
35static const uint32_t drvopts[] = {
36 SR_CONF_OSCILLOSCOPE,
37};
38
39static const uint32_t devopts[] = {
40 SR_CONF_LIMIT_FRAMES | SR_CONF_GET | SR_CONF_SET,
86621306 41 SR_CONF_SAMPLERATE | SR_CONF_GET,
90230cfa
SA
42 SR_CONF_TIMEBASE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
43 SR_CONF_NUM_HDIV | SR_CONF_GET,
90230cfa 44 SR_CONF_HORIZ_TRIGGERPOS | SR_CONF_GET | SR_CONF_SET,
86621306
UH
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,
90230cfa
SA
47};
48
6b82c3e5 49static const uint32_t devopts_cg_analog[] = {
90230cfa 50 SR_CONF_NUM_VDIV | SR_CONF_GET,
90230cfa 51 SR_CONF_VDIV | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
86621306 52 SR_CONF_COUPLING | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
90230cfa
SA
53};
54
373e92a4 55static struct sr_dev_inst *probe_device(struct sr_scpi_dev_inst *scpi)
3f2c7c94
SS
56{
57 struct sr_dev_inst *sdi;
58 struct dev_context *devc;
59 struct sr_scpi_hw_info *hw_info;
60
61 sdi = NULL;
62 devc = NULL;
63 hw_info = NULL;
64
3f2c7c94
SS
65 if (sr_scpi_get_hw_id(scpi, &hw_info) != SR_OK) {
66 sr_info("Couldn't get IDN response.");
67 goto fail;
68 }
69
697fb6dd 70 if (std_str_idx_s(hw_info->manufacturer, ARRAY_AND_SIZE(manufacturers)) < 0)
3f2c7c94
SS
71 goto fail;
72
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;
80 sdi->conn = scpi;
81
82 sr_scpi_hw_info_free(hw_info);
83 hw_info = NULL;
84
85 devc = g_malloc0(sizeof(struct dev_context));
3f2c7c94
SS
86 sdi->priv = devc;
87
88 if (lecroy_xstream_init_device(sdi) != SR_OK)
89 goto fail;
90
91 return sdi;
92
93fail:
94 sr_scpi_hw_info_free(hw_info);
4bf93988 95 sr_dev_inst_free(sdi);
3f2c7c94
SS
96 g_free(devc);
97
98 return NULL;
99}
e3b83c5e
SS
100
101static GSList *scan(struct sr_dev_driver *di, GSList *options)
102{
373e92a4 103 return sr_scpi_scan(di->context, options, probe_device);
3f2c7c94
SS
104}
105
3553451f 106static void clear_helper(struct dev_context *devc)
3f2c7c94 107{
3f2c7c94 108 lecroy_xstream_state_free(devc->model_state);
3f2c7c94 109 g_free(devc->analog_groups);
e3b83c5e
SS
110}
111
112static int dev_clear(const struct sr_dev_driver *di)
113{
3553451f 114 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
e3b83c5e
SS
115}
116
117static int dev_open(struct sr_dev_inst *sdi)
118{
6402c379 119 if (sr_scpi_open(sdi->conn) != SR_OK)
3f2c7c94 120 return SR_ERR;
e3b83c5e 121
3f2c7c94
SS
122 if (lecroy_xstream_state_get(sdi) != SR_OK)
123 return SR_ERR;
e3b83c5e 124
e3b83c5e
SS
125 return SR_OK;
126}
127
128static int dev_close(struct sr_dev_inst *sdi)
129{
f1ba6b4b 130 return sr_scpi_close(sdi->conn);
e3b83c5e
SS
131}
132
133static int config_get(uint32_t key, GVariant **data,
952c7376 134 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 135{
fcd6a8bd 136 int idx;
3f2c7c94
SS
137 struct dev_context *devc;
138 const struct scope_config *model;
139 struct scope_state *state;
e3b83c5e 140
3f2c7c94
SS
141 if (!sdi)
142 return SR_ERR_ARG;
143
144 devc = sdi->priv;
e3b83c5e 145
3f2c7c94
SS
146 model = devc->model_config;
147 state = devc->model_state;
148 *data = NULL;
ea257cdc 149
e3b83c5e 150 switch (key) {
3f2c7c94
SS
151 case SR_CONF_NUM_HDIV:
152 *data = g_variant_new_int32(model->num_xdivs);
3f2c7c94
SS
153 break;
154 case SR_CONF_TIMEBASE:
155 *data = g_variant_new("(tt)",
76f0fa5d
UH
156 (*model->timebases)[state->timebase][0],
157 (*model->timebases)[state->timebase][1]);
3f2c7c94
SS
158 break;
159 case SR_CONF_NUM_VDIV:
fcd6a8bd
UH
160 if (std_cg_idx(cg, devc->analog_groups, model->analog_channels) < 0)
161 return SR_ERR_ARG;
162 *data = g_variant_new_int32(model->num_ydivs);
3f2c7c94
SS
163 break;
164 case SR_CONF_VDIV:
fcd6a8bd
UH
165 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
166 return SR_ERR_ARG;
167 *data = g_variant_new("(tt)",
952c7376
SA
168 (*model->vdivs)[state->analog_channels[idx].vdiv][0],
169 (*model->vdivs)[state->analog_channels[idx].vdiv][1]);
3f2c7c94
SS
170 break;
171 case SR_CONF_TRIGGER_SOURCE:
172 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
3f2c7c94
SS
173 break;
174 case SR_CONF_TRIGGER_SLOPE:
175 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
3f2c7c94
SS
176 break;
177 case SR_CONF_HORIZ_TRIGGERPOS:
178 *data = g_variant_new_double(state->horiz_triggerpos);
3f2c7c94
SS
179 break;
180 case SR_CONF_COUPLING:
fcd6a8bd
UH
181 if ((idx = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
182 return SR_ERR_ARG;
183 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[idx].coupling]);
3f2c7c94
SS
184 break;
185 case SR_CONF_SAMPLERATE:
186 *data = g_variant_new_uint64(state->sample_rate);
3f2c7c94
SS
187 break;
188 case SR_CONF_ENABLED:
189 *data = g_variant_new_boolean(FALSE);
3f2c7c94 190 break;
e3b83c5e 191 default:
a9010323 192 return SR_ERR_NA;
e3b83c5e 193 }
ea257cdc 194
a9010323 195 return SR_OK;
e3b83c5e
SS
196}
197
ea257cdc 198static int config_set(uint32_t key, GVariant *data,
952c7376 199 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 200{
fcd6a8bd 201 int ret, idx, j;
3f2c7c94
SS
202 char command[MAX_COMMAND_SIZE];
203 struct dev_context *devc;
204 const struct scope_config *model;
205 struct scope_state *state;
3f2c7c94 206 double tmp_d;
e3b83c5e 207
3f2c7c94
SS
208 if (!sdi)
209 return SR_ERR_ARG;
e3b83c5e 210
3f2c7c94
SS
211 devc = sdi->priv;
212
213 model = devc->model_config;
214 state = devc->model_state;
3f2c7c94
SS
215
216 ret = SR_ERR_NA;
e3b83c5e 217
e3b83c5e 218 switch (key) {
3f2c7c94
SS
219 case SR_CONF_LIMIT_FRAMES:
220 devc->frame_limit = g_variant_get_uint64(data);
221 ret = SR_OK;
222 break;
223 case SR_CONF_TRIGGER_SOURCE:
bd633efa
UH
224 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
225 return SR_ERR_ARG;
226 state->trigger_source = idx;
227 g_snprintf(command, sizeof(command),
5000c12f 228 "TRIG_SELECT EDGE,SR,%s", (*model->trigger_sources)[idx]);
bd633efa 229 ret = sr_scpi_send(sdi->conn, command);
3f2c7c94
SS
230 break;
231 case SR_CONF_VDIV:
bd633efa
UH
232 if ((idx = std_u64_tuple_idx(data, *model->vdivs, model->num_vdivs)) < 0)
233 return SR_ERR_ARG;
fcd6a8bd
UH
234 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
235 return SR_ERR_ARG;
236 state->analog_channels[j].vdiv = idx;
237 g_snprintf(command, sizeof(command),
952c7376
SA
238 "C%d:VDIV %E", j + 1, (float) (*model->vdivs)[idx][0] / (*model->vdivs)[idx][1]);
239 if (sr_scpi_send(sdi->conn, command) != SR_OK || sr_scpi_get_opc(sdi->conn) != SR_OK)
fcd6a8bd 240 return SR_ERR;
bd633efa 241 ret = SR_OK;
3f2c7c94
SS
242 break;
243 case SR_CONF_TIMEBASE:
bd633efa
UH
244 if ((idx = std_u64_tuple_idx(data, *model->timebases, model->num_timebases)) < 0)
245 return SR_ERR_ARG;
246 state->timebase = idx;
247 g_snprintf(command, sizeof(command),
952c7376 248 "TIME_DIV %E", (float) (*model->timebases)[idx][0] / (*model->timebases)[idx][1]);
bd633efa 249 ret = sr_scpi_send(sdi->conn, command);
3f2c7c94
SS
250 break;
251 case SR_CONF_HORIZ_TRIGGERPOS:
252 tmp_d = g_variant_get_double(data);
253
254 if (tmp_d < 0.0 || tmp_d > 1.0)
255 return SR_ERR;
256
257 state->horiz_triggerpos = tmp_d;
258 tmp_d = -(tmp_d - 0.5) *
952c7376
SA
259 ((double)(*model->timebases)[state->timebase][0] /
260 (*model->timebases)[state->timebase][1])
261 * model->num_xdivs;
3f2c7c94
SS
262
263 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
264
265 ret = sr_scpi_send(sdi->conn, command);
266 break;
267 case SR_CONF_TRIGGER_SLOPE:
bd633efa
UH
268 if ((idx = std_str_idx(data, *model->trigger_slopes, model->num_trigger_slopes)) < 0)
269 return SR_ERR_ARG;
270 state->trigger_slope = idx;
271 g_snprintf(command, sizeof(command),
5000c12f
SA
272 "%s:TRIG_SLOPE %s", (*model->trigger_sources)[state->trigger_source],
273 (*model->trigger_slopes)[idx]);
bd633efa 274 ret = sr_scpi_send(sdi->conn, command);
3f2c7c94
SS
275 break;
276 case SR_CONF_COUPLING:
bd633efa
UH
277 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
278 return SR_ERR_ARG;
fcd6a8bd
UH
279 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
280 return SR_ERR_ARG;
281 state->analog_channels[j].coupling = idx;
282 g_snprintf(command, sizeof(command), "C%d:COUPLING %s",
283 j + 1, (*model->coupling_options)[idx]);
952c7376 284 if (sr_scpi_send(sdi->conn, command) != SR_OK || sr_scpi_get_opc(sdi->conn) != SR_OK)
fcd6a8bd 285 return SR_ERR;
bd633efa 286 ret = SR_OK;
3f2c7c94 287 break;
e3b83c5e
SS
288 default:
289 ret = SR_ERR_NA;
3f2c7c94 290 break;
e3b83c5e
SS
291 }
292
3f2c7c94
SS
293 if (ret == SR_OK)
294 ret = sr_scpi_get_opc(sdi->conn);
295
e3b83c5e
SS
296 return ret;
297}
298
79100d4e
SA
299static int config_channel_set(const struct sr_dev_inst *sdi,
300 struct sr_channel *ch, unsigned int changes)
301{
302 /* Currently we only handle SR_CHANNEL_SET_ENABLED. */
303 if (changes != SR_CHANNEL_SET_ENABLED)
304 return SR_ERR_NA;
305
306 return lecroy_xstream_channel_state_set(sdi, ch->index, ch->enabled);
307}
308
ea257cdc 309static int config_list(uint32_t key, GVariant **data,
952c7376 310 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 311{
e66d1892
UH
312 struct dev_context *devc;
313 const struct scope_config *model;
90230cfa 314
e66d1892
UH
315 devc = (sdi) ? sdi->priv : NULL;
316 model = (devc) ? devc->model_config : NULL;
90230cfa
SA
317
318 switch (key) {
e66d1892
UH
319 case SR_CONF_SCAN_OPTIONS:
320 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
3f2c7c94 321 case SR_CONF_DEVICE_OPTIONS:
e66d1892
UH
322 if (!cg)
323 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
53012da6 324 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
3f2c7c94
SS
325 break;
326 case SR_CONF_COUPLING:
692716f5 327 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
3f2c7c94
SS
328 break;
329 case SR_CONF_TRIGGER_SOURCE:
330 if (!model)
331 return SR_ERR_ARG;
692716f5 332 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
3f2c7c94
SS
333 break;
334 case SR_CONF_TRIGGER_SLOPE:
335 if (!model)
336 return SR_ERR_ARG;
692716f5 337 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
3f2c7c94
SS
338 break;
339 case SR_CONF_TIMEBASE:
340 if (!model)
341 return SR_ERR_ARG;
76f0fa5d 342 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
3f2c7c94
SS
343 break;
344 case SR_CONF_VDIV:
345 if (!model)
346 return SR_ERR_ARG;
76f0fa5d 347 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
3f2c7c94 348 break;
e3b83c5e
SS
349 default:
350 return SR_ERR_NA;
351 }
758906aa 352
3f2c7c94
SS
353 return SR_OK;
354}
e3b83c5e 355
3f2c7c94
SS
356SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
357{
358 char command[MAX_COMMAND_SIZE];
359 struct sr_channel *ch;
360 struct dev_context *devc;
361
362 devc = sdi->priv;
3f2c7c94
SS
363 ch = devc->current_channel->data;
364
365 if (ch->type != SR_CHANNEL_ANALOG)
366 return SR_ERR;
367
952c7376 368 g_snprintf(command, sizeof(command), "C%d:WAVEFORM?", ch->index + 1);
3f2c7c94
SS
369 return sr_scpi_send(sdi->conn, command);
370}
371
6d13a46c 372static int setup_channels(const struct sr_dev_inst *sdi)
3f2c7c94
SS
373{
374 GSList *l;
3f2c7c94
SS
375 char command[MAX_COMMAND_SIZE];
376 struct scope_state *state;
377 struct sr_channel *ch;
378 struct dev_context *devc;
379 struct sr_scpi_dev_inst *scpi;
380
381 devc = sdi->priv;
382 scpi = sdi->conn;
383 state = devc->model_state;
3f2c7c94
SS
384
385 for (l = sdi->channels; l; l = l->next) {
386 ch = l->data;
387 switch (ch->type) {
388 case SR_CHANNEL_ANALOG:
389 if (ch->enabled == state->analog_channels[ch->index].state)
390 break;
391 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
952c7376 392 ch->index + 1, ch->enabled ? "ON" : "OFF");
3f2c7c94
SS
393
394 if (sr_scpi_send(scpi, command) != SR_OK)
395 return SR_ERR;
952c7376 396
3f2c7c94 397 state->analog_channels[ch->index].state = ch->enabled;
3f2c7c94
SS
398 break;
399 default:
400 return SR_ERR;
401 }
402 }
403
3f2c7c94 404 return SR_OK;
e3b83c5e
SS
405}
406
407static int dev_acquisition_start(const struct sr_dev_inst *sdi)
408{
3f2c7c94
SS
409 GSList *l;
410 struct sr_channel *ch;
411 struct dev_context *devc;
e0b6855b 412 struct scope_state *state;
3f2c7c94
SS
413 int ret;
414 struct sr_scpi_dev_inst *scpi;
415
3f2c7c94
SS
416 devc = sdi->priv;
417 scpi = sdi->conn;
ca314e06 418
3f2c7c94
SS
419 /* Preset empty results. */
420 g_slist_free(devc->enabled_channels);
421 devc->enabled_channels = NULL;
e0b6855b
SA
422 state = devc->model_state;
423 state->sample_rate = 0;
3f2c7c94 424
6e9606db 425 /* Contruct the list of enabled channels. */
3f2c7c94
SS
426 for (l = sdi->channels; l; l = l->next) {
427 ch = l->data;
428 if (!ch->enabled)
429 continue;
6e9606db
SA
430
431 devc->enabled_channels = g_slist_append(devc->enabled_channels, ch);
3f2c7c94 432 }
e3b83c5e 433
3f2c7c94
SS
434 if (!devc->enabled_channels)
435 return SR_ERR;
436
6e9606db 437 /* Configure the analog channels. */
6d13a46c 438 if (setup_channels(sdi) != SR_OK) {
3f2c7c94
SS
439 sr_err("Failed to setup channel configuration!");
440 ret = SR_ERR;
441 goto free_enabled;
442 }
443
444 /*
445 * Start acquisition on the first enabled channel. The
446 * receive routine will continue driving the acquisition.
447 */
448 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
449 lecroy_xstream_receive_data, (void *)sdi);
450
451 std_session_send_df_header(sdi);
452
453 devc->current_channel = devc->enabled_channels;
454
455 return lecroy_xstream_request_data(sdi);
456
457free_enabled:
458 g_slist_free(devc->enabled_channels);
459 devc->enabled_channels = NULL;
ea257cdc 460
3f2c7c94 461 return ret;
e3b83c5e
SS
462}
463
464static int dev_acquisition_stop(struct sr_dev_inst *sdi)
465{
3f2c7c94
SS
466 struct dev_context *devc;
467 struct sr_scpi_dev_inst *scpi;
468
469 std_session_send_df_end(sdi);
470
3f2c7c94
SS
471 devc = sdi->priv;
472
473 devc->num_frames = 0;
474 g_slist_free(devc->enabled_channels);
475 devc->enabled_channels = NULL;
476 scpi = sdi->conn;
477 sr_scpi_source_remove(sdi->session, scpi);
e3b83c5e
SS
478
479 return SR_OK;
480}
481
3f2c7c94 482static struct sr_dev_driver lecroy_xstream_driver_info = {
e3b83c5e 483 .name = "lecroy-xstream",
bb08570f 484 .longname = "LeCroy X-Stream",
e3b83c5e
SS
485 .api_version = 1,
486 .init = std_init,
487 .cleanup = std_cleanup,
488 .scan = scan,
489 .dev_list = std_dev_list,
490 .dev_clear = dev_clear,
491 .config_get = config_get,
492 .config_set = config_set,
79100d4e 493 .config_channel_set = config_channel_set,
e3b83c5e
SS
494 .config_list = config_list,
495 .dev_open = dev_open,
496 .dev_close = dev_close,
497 .dev_acquisition_start = dev_acquisition_start,
498 .dev_acquisition_stop = dev_acquisition_stop,
499 .context = NULL,
500};
e3b83c5e 501SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);