]> sigrok.org Git - libsigrok.git/blame - src/hardware/lecroy-xstream/api.c
lecroy-xstream: Use array-based approach for timebases/vdivs.
[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));
86
87 sdi->priv = devc;
88
89 if (lecroy_xstream_init_device(sdi) != SR_OK)
90 goto fail;
91
92 return sdi;
93
94fail:
95 sr_scpi_hw_info_free(hw_info);
4bf93988 96 sr_dev_inst_free(sdi);
3f2c7c94
SS
97 g_free(devc);
98
99 return NULL;
100}
e3b83c5e
SS
101
102static GSList *scan(struct sr_dev_driver *di, GSList *options)
103{
373e92a4 104 return sr_scpi_scan(di->context, options, probe_device);
3f2c7c94
SS
105}
106
3553451f 107static void clear_helper(struct dev_context *devc)
3f2c7c94 108{
3f2c7c94 109 lecroy_xstream_state_free(devc->model_state);
3f2c7c94 110 g_free(devc->analog_groups);
e3b83c5e
SS
111}
112
113static int dev_clear(const struct sr_dev_driver *di)
114{
3553451f 115 return std_dev_clear_with_callback(di, (std_dev_clear_callback)clear_helper);
e3b83c5e
SS
116}
117
118static int dev_open(struct sr_dev_inst *sdi)
119{
6402c379 120 if (sr_scpi_open(sdi->conn) != SR_OK)
3f2c7c94 121 return SR_ERR;
e3b83c5e 122
3f2c7c94
SS
123 if (lecroy_xstream_state_get(sdi) != SR_OK)
124 return SR_ERR;
e3b83c5e 125
e3b83c5e
SS
126 return SR_OK;
127}
128
129static int dev_close(struct sr_dev_inst *sdi)
130{
f1ba6b4b 131 return sr_scpi_close(sdi->conn);
e3b83c5e
SS
132}
133
134static int config_get(uint32_t key, GVariant **data,
ea257cdc 135 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 136{
3f2c7c94
SS
137 unsigned int i;
138 struct dev_context *devc;
139 const struct scope_config *model;
140 struct scope_state *state;
e3b83c5e 141
3f2c7c94
SS
142 if (!sdi)
143 return SR_ERR_ARG;
144
145 devc = sdi->priv;
e3b83c5e 146
3f2c7c94
SS
147 model = devc->model_config;
148 state = devc->model_state;
149 *data = NULL;
ea257cdc 150
e3b83c5e 151 switch (key) {
3f2c7c94
SS
152 case SR_CONF_NUM_HDIV:
153 *data = g_variant_new_int32(model->num_xdivs);
3f2c7c94
SS
154 break;
155 case SR_CONF_TIMEBASE:
156 *data = g_variant_new("(tt)",
76f0fa5d
UH
157 (*model->timebases)[state->timebase][0],
158 (*model->timebases)[state->timebase][1]);
3f2c7c94
SS
159 break;
160 case SR_CONF_NUM_VDIV:
161 for (i = 0; i < model->analog_channels; i++) {
162 if (cg != devc->analog_groups[i])
163 continue;
164 *data = g_variant_new_int32(model->num_ydivs);
3f2c7c94
SS
165 }
166 break;
167 case SR_CONF_VDIV:
168 for (i = 0; i < model->analog_channels; i++) {
169 if (cg != devc->analog_groups[i])
170 continue;
171 *data = g_variant_new("(tt)",
76f0fa5d
UH
172 (*model->vdivs)[state->analog_channels[i].vdiv][0],
173 (*model->vdivs)[state->analog_channels[i].vdiv][1]);
3f2c7c94
SS
174 }
175 break;
176 case SR_CONF_TRIGGER_SOURCE:
177 *data = g_variant_new_string((*model->trigger_sources)[state->trigger_source]);
3f2c7c94
SS
178 break;
179 case SR_CONF_TRIGGER_SLOPE:
180 *data = g_variant_new_string((*model->trigger_slopes)[state->trigger_slope]);
3f2c7c94
SS
181 break;
182 case SR_CONF_HORIZ_TRIGGERPOS:
183 *data = g_variant_new_double(state->horiz_triggerpos);
3f2c7c94
SS
184 break;
185 case SR_CONF_COUPLING:
3f2c7c94 186 for (i = 0; i < model->analog_channels; i++) {
ea257cdc 187 if (cg != devc->analog_groups[i])
3f2c7c94 188 continue;
3f2c7c94 189 *data = g_variant_new_string((*model->coupling_options)[state->analog_channels[i].coupling]);
3f2c7c94
SS
190 }
191 break;
192 case SR_CONF_SAMPLERATE:
193 *data = g_variant_new_uint64(state->sample_rate);
3f2c7c94
SS
194 break;
195 case SR_CONF_ENABLED:
196 *data = g_variant_new_boolean(FALSE);
3f2c7c94 197 break;
e3b83c5e 198 default:
a9010323 199 return SR_ERR_NA;
e3b83c5e 200 }
ea257cdc 201
a9010323 202 return SR_OK;
e3b83c5e
SS
203}
204
ea257cdc
UH
205static int config_set(uint32_t key, GVariant *data,
206 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e
SS
207{
208 int ret;
3f2c7c94
SS
209 unsigned int i, j;
210 char command[MAX_COMMAND_SIZE];
211 struct dev_context *devc;
212 const struct scope_config *model;
213 struct scope_state *state;
214 const char *tmp;
76f0fa5d 215 uint64_t p, q;
3f2c7c94
SS
216 double tmp_d;
217 gboolean update_sample_rate;
e3b83c5e 218
3f2c7c94
SS
219 if (!sdi)
220 return SR_ERR_ARG;
e3b83c5e 221
3f2c7c94
SS
222 devc = sdi->priv;
223
224 model = devc->model_config;
225 state = devc->model_state;
226 update_sample_rate = FALSE;
227
228 ret = SR_ERR_NA;
e3b83c5e 229
e3b83c5e 230 switch (key) {
3f2c7c94
SS
231 case SR_CONF_LIMIT_FRAMES:
232 devc->frame_limit = g_variant_get_uint64(data);
233 ret = SR_OK;
234 break;
235 case SR_CONF_TRIGGER_SOURCE:
236 tmp = g_variant_get_string(data, NULL);
692716f5 237 for (i = 0; i < model->num_trigger_sources; i++) {
3f2c7c94
SS
238 if (g_strcmp0(tmp, (*model->trigger_sources)[i]) != 0)
239 continue;
240 state->trigger_source = i;
241 g_snprintf(command, sizeof(command),
242 "SET TRIGGER SOURCE %s",
243 (*model->trigger_sources)[i]);
244
245 ret = sr_scpi_send(sdi->conn, command);
246 break;
247 }
248 break;
249 case SR_CONF_VDIV:
250 g_variant_get(data, "(tt)", &p, &q);
251
252 for (i = 0; i < model->num_vdivs; i++) {
76f0fa5d 253 if (p != (*model->vdivs)[i][0] || q != (*model->vdivs)[i][1])
3f2c7c94
SS
254 continue;
255 for (j = 1; j <= model->analog_channels; j++) {
256 if (cg != devc->analog_groups[j - 1])
257 continue;
258 state->analog_channels[j - 1].vdiv = i;
259 g_snprintf(command, sizeof(command),
260 "C%d:VDIV %E", j, (float)p/q);
261
262 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
263 sr_scpi_get_opc(sdi->conn) != SR_OK)
264 return SR_ERR;
265
266 break;
267 }
268
269 ret = SR_OK;
270 break;
271 }
272 break;
273 case SR_CONF_TIMEBASE:
274 g_variant_get(data, "(tt)", &p, &q);
275
276 for (i = 0; i < model->num_timebases; i++) {
76f0fa5d
UH
277 if (p != (*model->timebases)[i][0] ||
278 q != (*model->timebases)[i][1])
3f2c7c94
SS
279 continue;
280 state->timebase = i;
281 g_snprintf(command, sizeof(command),
282 "TIME_DIV %E", (float)p/q);
283
284 ret = sr_scpi_send(sdi->conn, command);
285 update_sample_rate = TRUE;
286 break;
287 }
288 break;
289 case SR_CONF_HORIZ_TRIGGERPOS:
290 tmp_d = g_variant_get_double(data);
291
292 if (tmp_d < 0.0 || tmp_d > 1.0)
293 return SR_ERR;
294
295 state->horiz_triggerpos = tmp_d;
296 tmp_d = -(tmp_d - 0.5) *
76f0fa5d
UH
297 ((double)(*model->timebases)[state->timebase][0] /
298 (*model->timebases)[state->timebase][1])
3f2c7c94
SS
299 * model->num_xdivs;
300
301 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
302
303 ret = sr_scpi_send(sdi->conn, command);
304 break;
305 case SR_CONF_TRIGGER_SLOPE:
306 tmp = g_variant_get_string(data, NULL);
692716f5 307 for (i = 0; i < model->num_trigger_slopes; i++) {
3f2c7c94
SS
308 if (g_strcmp0(tmp, (*model->trigger_slopes)[i]) != 0)
309 continue;
310 state->trigger_slope = i;
311 g_snprintf(command, sizeof(command),
312 "SET TRIGGER SLOPE %s",
313 (*model->trigger_slopes)[i]);
314
315 ret = sr_scpi_send(sdi->conn, command);
316 break;
317 }
318 break;
319 case SR_CONF_COUPLING:
3f2c7c94
SS
320 tmp = g_variant_get_string(data, NULL);
321
692716f5 322 for (i = 0; i < model->num_coupling_options; i++) {
3f2c7c94
SS
323 if (strcmp(tmp, (*model->coupling_options)[i]) != 0)
324 continue;
325 for (j = 1; j <= model->analog_channels; j++) {
326 if (cg != devc->analog_groups[j - 1])
327 continue;
ea257cdc 328 state->analog_channels[j - 1].coupling = i;
3f2c7c94
SS
329
330 g_snprintf(command, sizeof(command),
331 "C%d:COUPLING %s", j, tmp);
332
333 if (sr_scpi_send(sdi->conn, command) != SR_OK ||
334 sr_scpi_get_opc(sdi->conn) != SR_OK)
335 return SR_ERR;
336 break;
337 }
338
339 ret = SR_OK;
340 break;
341 }
342 break;
e3b83c5e
SS
343 default:
344 ret = SR_ERR_NA;
3f2c7c94 345 break;
e3b83c5e
SS
346 }
347
3f2c7c94
SS
348 if (ret == SR_OK)
349 ret = sr_scpi_get_opc(sdi->conn);
350
351 if (ret == SR_OK && update_sample_rate)
352 ret = lecroy_xstream_update_sample_rate(sdi);
353
e3b83c5e
SS
354 return ret;
355}
356
ea257cdc
UH
357static int config_list(uint32_t key, GVariant **data,
358 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 359{
e66d1892
UH
360 struct dev_context *devc;
361 const struct scope_config *model;
90230cfa 362
e66d1892
UH
363 devc = (sdi) ? sdi->priv : NULL;
364 model = (devc) ? devc->model_config : NULL;
90230cfa
SA
365
366 switch (key) {
e66d1892
UH
367 case SR_CONF_SCAN_OPTIONS:
368 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
3f2c7c94 369 case SR_CONF_DEVICE_OPTIONS:
e66d1892
UH
370 if (!cg)
371 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
53012da6 372 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
3f2c7c94
SS
373 break;
374 case SR_CONF_COUPLING:
692716f5 375 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
3f2c7c94
SS
376 break;
377 case SR_CONF_TRIGGER_SOURCE:
378 if (!model)
379 return SR_ERR_ARG;
692716f5 380 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
3f2c7c94
SS
381 break;
382 case SR_CONF_TRIGGER_SLOPE:
383 if (!model)
384 return SR_ERR_ARG;
692716f5 385 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
3f2c7c94
SS
386 break;
387 case SR_CONF_TIMEBASE:
388 if (!model)
389 return SR_ERR_ARG;
76f0fa5d 390 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
3f2c7c94
SS
391 break;
392 case SR_CONF_VDIV:
393 if (!model)
394 return SR_ERR_ARG;
76f0fa5d 395 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
3f2c7c94 396 break;
e3b83c5e
SS
397 default:
398 return SR_ERR_NA;
399 }
758906aa 400
3f2c7c94
SS
401 return SR_OK;
402}
e3b83c5e 403
3f2c7c94
SS
404SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
405{
406 char command[MAX_COMMAND_SIZE];
407 struct sr_channel *ch;
408 struct dev_context *devc;
409
410 devc = sdi->priv;
411
412 ch = devc->current_channel->data;
413
414 if (ch->type != SR_CHANNEL_ANALOG)
415 return SR_ERR;
416
417 g_snprintf(command, sizeof(command),
ea257cdc 418 "COMM_FORMAT DEF9,WORD,BIN;C%d:WAVEFORM?", ch->index + 1);
3f2c7c94
SS
419 return sr_scpi_send(sdi->conn, command);
420}
421
6d13a46c 422static int setup_channels(const struct sr_dev_inst *sdi)
3f2c7c94
SS
423{
424 GSList *l;
425 gboolean setup_changed;
426 char command[MAX_COMMAND_SIZE];
427 struct scope_state *state;
428 struct sr_channel *ch;
429 struct dev_context *devc;
430 struct sr_scpi_dev_inst *scpi;
431
432 devc = sdi->priv;
433 scpi = sdi->conn;
434 state = devc->model_state;
435 setup_changed = FALSE;
436
437 for (l = sdi->channels; l; l = l->next) {
438 ch = l->data;
439 switch (ch->type) {
440 case SR_CHANNEL_ANALOG:
441 if (ch->enabled == state->analog_channels[ch->index].state)
442 break;
443 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
ea257cdc 444 ch->index + 1, ch->enabled ? "ON" : "OFF");
3f2c7c94
SS
445
446 if (sr_scpi_send(scpi, command) != SR_OK)
447 return SR_ERR;
448 state->analog_channels[ch->index].state = ch->enabled;
449 setup_changed = TRUE;
450 break;
451 default:
452 return SR_ERR;
453 }
454 }
455
456 if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
457 return SR_ERR;
458
459 return SR_OK;
e3b83c5e
SS
460}
461
462static int dev_acquisition_start(const struct sr_dev_inst *sdi)
463{
3f2c7c94
SS
464 GSList *l;
465 struct sr_channel *ch;
466 struct dev_context *devc;
467 int ret;
468 struct sr_scpi_dev_inst *scpi;
469
3f2c7c94
SS
470 devc = sdi->priv;
471 scpi = sdi->conn;
ca314e06 472
3f2c7c94
SS
473 /* Preset empty results. */
474 g_slist_free(devc->enabled_channels);
475 devc->enabled_channels = NULL;
476
477 /*
478 * Contruct the list of enabled channels. Determine the highest
479 * number of digital pods involved in the acquisition.
480 */
481
482 for (l = sdi->channels; l; l = l->next) {
483 ch = l->data;
484 if (!ch->enabled)
485 continue;
486 /* Only add a single digital channel per group (pod). */
487 devc->enabled_channels = g_slist_append(
488 devc->enabled_channels, ch);
489 }
e3b83c5e 490
3f2c7c94
SS
491 if (!devc->enabled_channels)
492 return SR_ERR;
493
494 /*
495 * Configure the analog channels and the
496 * corresponding digital pods.
497 */
6d13a46c 498 if (setup_channels(sdi) != SR_OK) {
3f2c7c94
SS
499 sr_err("Failed to setup channel configuration!");
500 ret = SR_ERR;
501 goto free_enabled;
502 }
503
504 /*
505 * Start acquisition on the first enabled channel. The
506 * receive routine will continue driving the acquisition.
507 */
508 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
509 lecroy_xstream_receive_data, (void *)sdi);
510
511 std_session_send_df_header(sdi);
512
513 devc->current_channel = devc->enabled_channels;
514
515 return lecroy_xstream_request_data(sdi);
516
517free_enabled:
518 g_slist_free(devc->enabled_channels);
519 devc->enabled_channels = NULL;
ea257cdc 520
3f2c7c94 521 return ret;
e3b83c5e
SS
522}
523
524static int dev_acquisition_stop(struct sr_dev_inst *sdi)
525{
3f2c7c94
SS
526 struct dev_context *devc;
527 struct sr_scpi_dev_inst *scpi;
528
529 std_session_send_df_end(sdi);
530
3f2c7c94
SS
531 devc = sdi->priv;
532
533 devc->num_frames = 0;
534 g_slist_free(devc->enabled_channels);
535 devc->enabled_channels = NULL;
536 scpi = sdi->conn;
537 sr_scpi_source_remove(sdi->session, scpi);
e3b83c5e
SS
538
539 return SR_OK;
540}
541
3f2c7c94 542static struct sr_dev_driver lecroy_xstream_driver_info = {
e3b83c5e 543 .name = "lecroy-xstream",
bb08570f 544 .longname = "LeCroy X-Stream",
e3b83c5e
SS
545 .api_version = 1,
546 .init = std_init,
547 .cleanup = std_cleanup,
548 .scan = scan,
549 .dev_list = std_dev_list,
550 .dev_clear = dev_clear,
551 .config_get = config_get,
552 .config_set = config_set,
553 .config_list = config_list,
554 .dev_open = dev_open,
555 .dev_close = dev_close,
556 .dev_acquisition_start = dev_acquisition_start,
557 .dev_acquisition_stop = dev_acquisition_stop,
558 .context = NULL,
559};
e3b83c5e 560SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);