]> sigrok.org Git - libsigrok.git/blame - src/hardware/lecroy-xstream/api.c
lecroy-xstream: Fix trigger source/slope
[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
SS
206 double tmp_d;
207 gboolean update_sample_rate;
e3b83c5e 208
3f2c7c94
SS
209 if (!sdi)
210 return SR_ERR_ARG;
e3b83c5e 211
3f2c7c94
SS
212 devc = sdi->priv;
213
214 model = devc->model_config;
215 state = devc->model_state;
216 update_sample_rate = FALSE;
217
218 ret = SR_ERR_NA;
e3b83c5e 219
e3b83c5e 220 switch (key) {
3f2c7c94
SS
221 case SR_CONF_LIMIT_FRAMES:
222 devc->frame_limit = g_variant_get_uint64(data);
223 ret = SR_OK;
224 break;
225 case SR_CONF_TRIGGER_SOURCE:
bd633efa
UH
226 if ((idx = std_str_idx(data, *model->trigger_sources, model->num_trigger_sources)) < 0)
227 return SR_ERR_ARG;
228 state->trigger_source = idx;
229 g_snprintf(command, sizeof(command),
5000c12f 230 "TRIG_SELECT EDGE,SR,%s", (*model->trigger_sources)[idx]);
bd633efa 231 ret = sr_scpi_send(sdi->conn, command);
3f2c7c94
SS
232 break;
233 case SR_CONF_VDIV:
bd633efa
UH
234 if ((idx = std_u64_tuple_idx(data, *model->vdivs, model->num_vdivs)) < 0)
235 return SR_ERR_ARG;
fcd6a8bd
UH
236 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
237 return SR_ERR_ARG;
238 state->analog_channels[j].vdiv = idx;
239 g_snprintf(command, sizeof(command),
952c7376
SA
240 "C%d:VDIV %E", j + 1, (float) (*model->vdivs)[idx][0] / (*model->vdivs)[idx][1]);
241 if (sr_scpi_send(sdi->conn, command) != SR_OK || sr_scpi_get_opc(sdi->conn) != SR_OK)
fcd6a8bd 242 return SR_ERR;
bd633efa 243 ret = SR_OK;
3f2c7c94
SS
244 break;
245 case SR_CONF_TIMEBASE:
bd633efa
UH
246 if ((idx = std_u64_tuple_idx(data, *model->timebases, model->num_timebases)) < 0)
247 return SR_ERR_ARG;
248 state->timebase = idx;
249 g_snprintf(command, sizeof(command),
952c7376 250 "TIME_DIV %E", (float) (*model->timebases)[idx][0] / (*model->timebases)[idx][1]);
bd633efa
UH
251 ret = sr_scpi_send(sdi->conn, command);
252 update_sample_rate = TRUE;
3f2c7c94
SS
253 break;
254 case SR_CONF_HORIZ_TRIGGERPOS:
255 tmp_d = g_variant_get_double(data);
256
257 if (tmp_d < 0.0 || tmp_d > 1.0)
258 return SR_ERR;
259
260 state->horiz_triggerpos = tmp_d;
261 tmp_d = -(tmp_d - 0.5) *
952c7376
SA
262 ((double)(*model->timebases)[state->timebase][0] /
263 (*model->timebases)[state->timebase][1])
264 * model->num_xdivs;
3f2c7c94
SS
265
266 g_snprintf(command, sizeof(command), "TRIG POS %e S", tmp_d);
267
268 ret = sr_scpi_send(sdi->conn, command);
269 break;
270 case SR_CONF_TRIGGER_SLOPE:
bd633efa
UH
271 if ((idx = std_str_idx(data, *model->trigger_slopes, model->num_trigger_slopes)) < 0)
272 return SR_ERR_ARG;
273 state->trigger_slope = idx;
274 g_snprintf(command, sizeof(command),
5000c12f
SA
275 "%s:TRIG_SLOPE %s", (*model->trigger_sources)[state->trigger_source],
276 (*model->trigger_slopes)[idx]);
bd633efa 277 ret = sr_scpi_send(sdi->conn, command);
3f2c7c94
SS
278 break;
279 case SR_CONF_COUPLING:
bd633efa
UH
280 if ((idx = std_str_idx(data, *model->coupling_options, model->num_coupling_options)) < 0)
281 return SR_ERR_ARG;
fcd6a8bd
UH
282 if ((j = std_cg_idx(cg, devc->analog_groups, model->analog_channels)) < 0)
283 return SR_ERR_ARG;
284 state->analog_channels[j].coupling = idx;
285 g_snprintf(command, sizeof(command), "C%d:COUPLING %s",
286 j + 1, (*model->coupling_options)[idx]);
952c7376 287 if (sr_scpi_send(sdi->conn, command) != SR_OK || sr_scpi_get_opc(sdi->conn) != SR_OK)
fcd6a8bd 288 return SR_ERR;
bd633efa 289 ret = SR_OK;
3f2c7c94 290 break;
e3b83c5e
SS
291 default:
292 ret = SR_ERR_NA;
3f2c7c94 293 break;
e3b83c5e
SS
294 }
295
3f2c7c94
SS
296 if (ret == SR_OK)
297 ret = sr_scpi_get_opc(sdi->conn);
298
299 if (ret == SR_OK && update_sample_rate)
300 ret = lecroy_xstream_update_sample_rate(sdi);
301
e3b83c5e
SS
302 return ret;
303}
304
ea257cdc 305static int config_list(uint32_t key, GVariant **data,
952c7376 306 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
e3b83c5e 307{
e66d1892
UH
308 struct dev_context *devc;
309 const struct scope_config *model;
90230cfa 310
e66d1892
UH
311 devc = (sdi) ? sdi->priv : NULL;
312 model = (devc) ? devc->model_config : NULL;
90230cfa
SA
313
314 switch (key) {
e66d1892
UH
315 case SR_CONF_SCAN_OPTIONS:
316 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, NULL, NULL);
3f2c7c94 317 case SR_CONF_DEVICE_OPTIONS:
e66d1892
UH
318 if (!cg)
319 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
53012da6 320 *data = std_gvar_array_u32(ARRAY_AND_SIZE(devopts_cg_analog));
3f2c7c94
SS
321 break;
322 case SR_CONF_COUPLING:
692716f5 323 *data = g_variant_new_strv(*model->coupling_options, model->num_coupling_options);
3f2c7c94
SS
324 break;
325 case SR_CONF_TRIGGER_SOURCE:
326 if (!model)
327 return SR_ERR_ARG;
692716f5 328 *data = g_variant_new_strv(*model->trigger_sources, model->num_trigger_sources);
3f2c7c94
SS
329 break;
330 case SR_CONF_TRIGGER_SLOPE:
331 if (!model)
332 return SR_ERR_ARG;
692716f5 333 *data = g_variant_new_strv(*model->trigger_slopes, model->num_trigger_slopes);
3f2c7c94
SS
334 break;
335 case SR_CONF_TIMEBASE:
336 if (!model)
337 return SR_ERR_ARG;
76f0fa5d 338 *data = std_gvar_tuple_array(*model->timebases, model->num_timebases);
3f2c7c94
SS
339 break;
340 case SR_CONF_VDIV:
341 if (!model)
342 return SR_ERR_ARG;
76f0fa5d 343 *data = std_gvar_tuple_array(*model->vdivs, model->num_vdivs);
3f2c7c94 344 break;
e3b83c5e
SS
345 default:
346 return SR_ERR_NA;
347 }
758906aa 348
3f2c7c94
SS
349 return SR_OK;
350}
e3b83c5e 351
3f2c7c94
SS
352SR_PRIV int lecroy_xstream_request_data(const struct sr_dev_inst *sdi)
353{
354 char command[MAX_COMMAND_SIZE];
355 struct sr_channel *ch;
356 struct dev_context *devc;
357
358 devc = sdi->priv;
3f2c7c94
SS
359 ch = devc->current_channel->data;
360
361 if (ch->type != SR_CHANNEL_ANALOG)
362 return SR_ERR;
363
952c7376 364 g_snprintf(command, sizeof(command), "C%d:WAVEFORM?", ch->index + 1);
3f2c7c94
SS
365 return sr_scpi_send(sdi->conn, command);
366}
367
6d13a46c 368static int setup_channels(const struct sr_dev_inst *sdi)
3f2c7c94
SS
369{
370 GSList *l;
371 gboolean setup_changed;
372 char command[MAX_COMMAND_SIZE];
373 struct scope_state *state;
374 struct sr_channel *ch;
375 struct dev_context *devc;
376 struct sr_scpi_dev_inst *scpi;
377
378 devc = sdi->priv;
379 scpi = sdi->conn;
380 state = devc->model_state;
381 setup_changed = FALSE;
382
383 for (l = sdi->channels; l; l = l->next) {
384 ch = l->data;
385 switch (ch->type) {
386 case SR_CHANNEL_ANALOG:
387 if (ch->enabled == state->analog_channels[ch->index].state)
388 break;
389 g_snprintf(command, sizeof(command), "C%d:TRACE %s",
952c7376 390 ch->index + 1, ch->enabled ? "ON" : "OFF");
3f2c7c94
SS
391
392 if (sr_scpi_send(scpi, command) != SR_OK)
393 return SR_ERR;
952c7376 394
3f2c7c94
SS
395 state->analog_channels[ch->index].state = ch->enabled;
396 setup_changed = TRUE;
397 break;
398 default:
399 return SR_ERR;
400 }
401 }
402
403 if (setup_changed && lecroy_xstream_update_sample_rate(sdi) != SR_OK)
404 return SR_ERR;
405
406 return SR_OK;
e3b83c5e
SS
407}
408
409static int dev_acquisition_start(const struct sr_dev_inst *sdi)
410{
3f2c7c94
SS
411 GSList *l;
412 struct sr_channel *ch;
413 struct dev_context *devc;
414 int ret;
415 struct sr_scpi_dev_inst *scpi;
416
3f2c7c94
SS
417 devc = sdi->priv;
418 scpi = sdi->conn;
ca314e06 419
3f2c7c94
SS
420 /* Preset empty results. */
421 g_slist_free(devc->enabled_channels);
422 devc->enabled_channels = NULL;
423
424 /*
425 * Contruct the list of enabled channels. Determine the highest
426 * number of digital pods involved in the acquisition.
427 */
428
429 for (l = sdi->channels; l; l = l->next) {
430 ch = l->data;
431 if (!ch->enabled)
432 continue;
433 /* Only add a single digital channel per group (pod). */
434 devc->enabled_channels = g_slist_append(
435 devc->enabled_channels, ch);
436 }
e3b83c5e 437
3f2c7c94
SS
438 if (!devc->enabled_channels)
439 return SR_ERR;
440
441 /*
442 * Configure the analog channels and the
443 * corresponding digital pods.
444 */
6d13a46c 445 if (setup_channels(sdi) != SR_OK) {
3f2c7c94
SS
446 sr_err("Failed to setup channel configuration!");
447 ret = SR_ERR;
448 goto free_enabled;
449 }
450
451 /*
452 * Start acquisition on the first enabled channel. The
453 * receive routine will continue driving the acquisition.
454 */
455 sr_scpi_source_add(sdi->session, scpi, G_IO_IN, 50,
456 lecroy_xstream_receive_data, (void *)sdi);
457
458 std_session_send_df_header(sdi);
459
460 devc->current_channel = devc->enabled_channels;
461
462 return lecroy_xstream_request_data(sdi);
463
464free_enabled:
465 g_slist_free(devc->enabled_channels);
466 devc->enabled_channels = NULL;
ea257cdc 467
3f2c7c94 468 return ret;
e3b83c5e
SS
469}
470
471static int dev_acquisition_stop(struct sr_dev_inst *sdi)
472{
3f2c7c94
SS
473 struct dev_context *devc;
474 struct sr_scpi_dev_inst *scpi;
475
476 std_session_send_df_end(sdi);
477
3f2c7c94
SS
478 devc = sdi->priv;
479
480 devc->num_frames = 0;
481 g_slist_free(devc->enabled_channels);
482 devc->enabled_channels = NULL;
483 scpi = sdi->conn;
484 sr_scpi_source_remove(sdi->session, scpi);
e3b83c5e
SS
485
486 return SR_OK;
487}
488
3f2c7c94 489static struct sr_dev_driver lecroy_xstream_driver_info = {
e3b83c5e 490 .name = "lecroy-xstream",
bb08570f 491 .longname = "LeCroy X-Stream",
e3b83c5e
SS
492 .api_version = 1,
493 .init = std_init,
494 .cleanup = std_cleanup,
495 .scan = scan,
496 .dev_list = std_dev_list,
497 .dev_clear = dev_clear,
498 .config_get = config_get,
499 .config_set = config_set,
500 .config_list = config_list,
501 .dev_open = dev_open,
502 .dev_close = dev_close,
503 .dev_acquisition_start = dev_acquisition_start,
504 .dev_acquisition_stop = dev_acquisition_stop,
505 .context = NULL,
506};
e3b83c5e 507SR_REGISTER_DEV_DRIVER(lecroy_xstream_driver_info);