]> sigrok.org Git - libsigrok.git/blame - src/hardware/lecroy-logicstudio/api.c
Introduce standard implementation of the dev_list() callback
[libsigrok.git] / src / hardware / lecroy-logicstudio / api.c
CommitLineData
c7b17bcb
TS
1/*
2 * This file is part of the libsigrok project.
3 *
4 * Copyright (C) 2015 Tilman Sauerbeck <tilman@code-monkey.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#include <config.h>
22#include <stdbool.h>
23#include <stdint.h>
24#include <string.h>
25#include "protocol.h"
26
27#define LOGICSTUDIO16_VID 0x05ff
28#define LOGICSTUDIO16_PID_LACK_FIRMWARE 0xa001
29#define LOGICSTUDIO16_PID_HAVE_FIRMWARE 0xa002
30
31#define USB_INTERFACE 0
32#define USB_CONFIGURATION 0
33#define FX2_FIRMWARE "lecroy-logicstudio16-fx2lp.fw"
34
35#define UNKNOWN_ADDRESS 0xff
36#define MAX_RENUM_DELAY_MS 3000
37
38static const uint32_t devopts[] = {
39 SR_CONF_LOGIC_ANALYZER,
40 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
41 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
42 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
43};
44
45static const int32_t trigger_matches[] = {
46 SR_TRIGGER_ZERO,
47 SR_TRIGGER_ONE,
48 SR_TRIGGER_RISING,
49 SR_TRIGGER_FALLING,
50 SR_TRIGGER_EDGE,
51};
52
53static const uint64_t samplerates[] = {
54 SR_HZ(1000),
55 SR_HZ(2500),
56 SR_KHZ(5),
57 SR_KHZ(10),
58 SR_KHZ(25),
59 SR_KHZ(50),
60 SR_KHZ(100),
61 SR_KHZ(250),
62 SR_KHZ(500),
63 SR_KHZ(1000),
64 SR_KHZ(2500),
65 SR_MHZ(5),
66 SR_MHZ(10),
67 SR_MHZ(25),
68 SR_MHZ(50),
69 SR_MHZ(100),
70 SR_MHZ(250),
71 SR_MHZ(500),
72};
73
74SR_PRIV struct sr_dev_driver lecroy_logicstudio_driver_info;
75
76static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
77{
78 return std_init(sr_ctx, di, LOG_PREFIX);
79}
80
81static struct sr_dev_inst *create_device(struct sr_dev_driver *di,
82 struct sr_usb_dev_inst *usb, enum sr_dev_inst_status status,
83 int64_t fw_updated)
84{
85 struct sr_dev_inst *sdi;
86 struct dev_context *devc;
87 char channel_name[8];
88 int i;
89
90 sdi = g_malloc0(sizeof(struct sr_dev_inst));
91 sdi->status = status;
92 sdi->vendor = g_strdup("LeCroy");
93 sdi->model = g_strdup("LogicStudio16");
94 sdi->driver = di;
95 sdi->inst_type = SR_INST_USB;
96 sdi->conn = usb;
97
98 for (i = 0; i < 16; i++) {
99 snprintf(channel_name, sizeof(channel_name), "D%i", i);
100 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
101 }
102
103 devc = g_malloc0(sizeof(struct dev_context));
104
105 sdi->priv = devc;
106
107 devc->fw_updated = fw_updated;
108 devc->capture_ratio = 50;
109
110 lls_set_samplerate(sdi, SR_MHZ(500));
111
112 return sdi;
113}
114
115static GSList *scan(struct sr_dev_driver *di, GSList *options)
116{
117 struct sr_dev_inst *sdi;
118 struct drv_context *drvc;
119 struct sr_usb_dev_inst *usb;
120 struct libusb_device_descriptor des;
121 libusb_device **devlist;
122 GSList *devices;
123 char connection_id[64];
124 size_t i;
125 int r;
126
127 (void)options;
128
129 drvc = di->context;
130 drvc->instances = NULL;
131
132 devices = NULL;
133
134 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
135
136 for (i = 0; devlist[i]; i++) {
137 libusb_get_device_descriptor(devlist[i], &des);
138
139 if (des.idVendor != LOGICSTUDIO16_VID)
140 continue;
141
142 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
143
144 usb = NULL;
145
146 switch (des.idProduct) {
147 case LOGICSTUDIO16_PID_HAVE_FIRMWARE:
148 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
149 libusb_get_device_address(devlist[i]), NULL);
150
151 sdi = create_device(di, usb, SR_ST_INACTIVE, 0);
152 break;
153 case LOGICSTUDIO16_PID_LACK_FIRMWARE:
154 r = ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
155 USB_CONFIGURATION, FX2_FIRMWARE);
156 if (r != SR_OK) {
157 /*
158 * An error message has already been logged by
159 * ezusb_upload_firmware().
160 */
161 continue;
162 }
163
164 /*
165 * Put unknown as the address so that we know we still
166 * need to get the proper address after the device
167 * renumerates.
168 */
169 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
170 UNKNOWN_ADDRESS, NULL);
171
172 sdi = create_device(di, usb, SR_ST_INITIALIZING,
173 g_get_monotonic_time());
174 break;
175 default:
176 break;
177 }
178
179 /* Cannot handle this device? */
180 if (!usb)
181 continue;
182
183 sdi->connection_id = g_strdup(connection_id);
184
185 drvc->instances = g_slist_append(drvc->instances, sdi);
186 devices = g_slist_append(devices, sdi);
187 }
188
189 libusb_free_device_list(devlist, 1);
190
191 return devices;
192}
193
c7b17bcb
TS
194static int open_device(struct sr_dev_inst *sdi)
195{
196 struct drv_context *drvc;
197 struct sr_usb_dev_inst *usb;
198 struct libusb_device_descriptor des;
199 libusb_device **devlist;
200 char connection_id[64];
201 bool is_opened;
202 size_t i;
203 int r;
204
205 if (sdi->status == SR_ST_ACTIVE)
206 return SR_ERR;
207
208 drvc = sdi->driver->context;
209 usb = sdi->conn;
210
211 is_opened = FALSE;
212
213 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
214
215 for (i = 0; devlist[i]; i++) {
216 libusb_get_device_descriptor(devlist[i], &des);
217
218 if (des.idVendor != LOGICSTUDIO16_VID ||
219 des.idProduct != LOGICSTUDIO16_PID_HAVE_FIRMWARE)
220 continue;
221
222 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
223
224 /*
225 * Check if this device is the same one that we associated
226 * with this sdi in scan() and bail if it isn't.
227 */
228 if (strcmp(sdi->connection_id, connection_id))
229 continue;
230
231 r = libusb_open(devlist[i], &usb->devhdl);
232
233 if (r) {
234 sr_err("Failed to open device: %s.",
235 libusb_error_name(r));
236 break;
237 }
238
239 /* Fix up address after firmware upload. */
240 if (usb->address == UNKNOWN_ADDRESS)
241 usb->address = libusb_get_device_address(devlist[i]);
242
243 is_opened = TRUE;
244
245 break;
246 }
247
248 libusb_free_device_list(devlist, 1);
249
250 if (!is_opened)
251 return SR_ERR;
252
253 if ((r = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
254 sr_err("Failed to claim interface: %s.",
255 libusb_error_name(r));
256 return SR_ERR;
257 }
258
259 sdi->status = SR_ST_ACTIVE;
260
261 return SR_OK;
262}
263
264static int dev_open(struct sr_dev_inst *sdi)
265{
266 struct drv_context *drvc;
267 struct dev_context *devc;
268 int64_t timediff_us, timediff_ms;
269 int ret;
270
271 drvc = sdi->driver->context;
272 devc = sdi->priv;
273
274 if (!drvc) {
275 sr_err("Driver was not initialized.");
276 return SR_ERR;
277 }
278
279 /*
280 * If we didn't need to upload FX2 firmware in scan(), open the device
281 * right away. Otherwise, wait up to MAX_RENUM_DELAY_MS ms for the
282 * FX2 to renumerate.
283 */
284 if (!devc->fw_updated) {
285 ret = open_device(sdi);
286 } else {
287 sr_info("Waiting for device to reset.");
288
289 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
290 g_usleep(300 * 1000);
291 timediff_ms = 0;
292
293 while (timediff_ms < MAX_RENUM_DELAY_MS) {
294 ret = open_device(sdi);
295
296 if (ret == SR_OK)
297 break;
298
299 g_usleep(100 * 1000);
300
301 timediff_us = g_get_monotonic_time() - devc->fw_updated;
302 timediff_ms = timediff_us / 1000;
303
304 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
305 }
306
307 if (ret != SR_OK) {
308 sr_err("Device failed to renumerate.");
309 return SR_ERR;
310 }
311
312 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
313 }
314
315 if (ret != SR_OK) {
316 sr_err("Unable to open device.");
317 return ret;
318 }
319
320 /*
321 * Only allocate the sample buffer now since it's rather large.
322 * Don't want to allocate it before we know we are going to use it.
323 */
324 devc->fetched_samples = g_malloc(SAMPLE_BUF_SIZE);
325
326 devc->conv8to16 = g_malloc(CONV_8TO16_BUF_SIZE);
327
328 devc->intr_xfer = libusb_alloc_transfer(0);
329 devc->bulk_xfer = libusb_alloc_transfer(0);
330
331 return SR_OK;
332}
333
334static int dev_close(struct sr_dev_inst *sdi)
335{
336 struct sr_usb_dev_inst *usb;
337 struct dev_context *devc;
338
339 usb = sdi->conn;
340 devc = sdi->priv;
341
342 g_free(devc->fetched_samples);
343 devc->fetched_samples = NULL;
344
345 g_free(devc->conv8to16);
346 devc->conv8to16 = NULL;
347
348 if (devc->intr_xfer) {
349 devc->intr_xfer->buffer = NULL; /* Points into devc. */
350 libusb_free_transfer(devc->intr_xfer);
351 devc->intr_xfer = NULL;
352 }
353
354 if (devc->bulk_xfer) {
355 devc->bulk_xfer->buffer = NULL; /* Points into devc. */
356 libusb_free_transfer(devc->bulk_xfer);
357 devc->bulk_xfer = NULL;
358 }
359
360 if (!usb->devhdl)
361 return SR_ERR;
362
363 libusb_release_interface(usb->devhdl, 0);
364
365 libusb_close(usb->devhdl);
366 usb->devhdl = NULL;
367
368 sdi->status = SR_ST_INACTIVE;
369
370 return SR_OK;
371}
372
c7b17bcb
TS
373static int config_get(uint32_t key, GVariant **data,
374 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
375{
376 struct dev_context *devc;
377
378 (void)cg;
379
380 if (!sdi)
381 return SR_ERR_ARG;
382
383 devc = sdi->priv;
384
385 switch (key) {
386 case SR_CONF_SAMPLERATE:
387 *data = g_variant_new_uint64(lls_get_samplerate(sdi));
388 break;
389 case SR_CONF_CAPTURE_RATIO:
390 *data = g_variant_new_uint64(devc->capture_ratio);
391 break;
392 default:
393 return SR_ERR_NA;
394 }
395
396 return SR_OK;
397}
398
399static int config_set(uint32_t key, GVariant *data,
400 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
401{
402 struct dev_context *devc;
403
404 (void)cg;
405
406 if (!sdi)
407 return SR_ERR_ARG;
408
409 devc = sdi->priv;
410
411 if (sdi->status != SR_ST_ACTIVE)
412 return SR_ERR_DEV_CLOSED;
413
414 switch (key) {
415 case SR_CONF_SAMPLERATE:
416 return lls_set_samplerate(sdi, g_variant_get_uint64(data));
417 case SR_CONF_CAPTURE_RATIO:
418 devc->capture_ratio = g_variant_get_uint64(data);
419 if (devc->capture_ratio > 100)
420 return SR_ERR;
421 break;
422 default:
423 return SR_ERR_NA;
424 }
425
426 return SR_OK;
427}
428
429static int config_list(uint32_t key, GVariant **data,
430 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
431{
432 GVariantBuilder vb;
433 GVariant *var;
434
435 (void)sdi;
436 (void)cg;
437
438 switch (key) {
439 case SR_CONF_DEVICE_OPTIONS:
440 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
441 devopts, ARRAY_SIZE(devopts),
442 sizeof(uint32_t));
443 break;
444 case SR_CONF_SAMPLERATE:
445 g_variant_builder_init(&vb, G_VARIANT_TYPE("a{sv}"));
446 var = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
447 samplerates, ARRAY_SIZE(samplerates),
448 sizeof(uint64_t));
449 g_variant_builder_add(&vb, "{sv}", "samplerates", var);
450 *data = g_variant_builder_end(&vb);
451 break;
452 case SR_CONF_TRIGGER_MATCH:
453 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
454 trigger_matches, ARRAY_SIZE(trigger_matches),
455 sizeof(int32_t));
456 break;
457 default:
458 return SR_ERR_NA;
459 }
460
461 return SR_OK;
462}
463
464static int config_commit(const struct sr_dev_inst *sdi)
465{
466 return lls_setup_acquisition(sdi);
467}
468
469static int receive_usb_data(int fd, int revents, void *cb_data)
470{
471 struct drv_context *drvc;
472 struct timeval tv;
473
474 (void)fd;
475 (void)revents;
476
695dc859 477 drvc = (struct drv_context *)cb_data;
c7b17bcb
TS
478
479 tv.tv_sec = 0;
480 tv.tv_usec = 0;
481
482 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx,
483 &tv, NULL);
484
485 return TRUE;
486}
487
695dc859 488static int dev_acquisition_start(const struct sr_dev_inst *sdi)
c7b17bcb
TS
489{
490 struct drv_context *drvc;
491 int ret;
492
493 if (sdi->status != SR_ST_ACTIVE)
494 return SR_ERR_DEV_CLOSED;
495
496 drvc = sdi->driver->context;
497
498 if ((ret = lls_start_acquisition(sdi)) < 0)
499 return ret;
500
695dc859 501 std_session_send_df_header(sdi, LOG_PREFIX);
c7b17bcb
TS
502
503 return usb_source_add(sdi->session, drvc->sr_ctx, 100,
504 receive_usb_data, drvc);
505}
506
695dc859 507static int dev_acquisition_stop(struct sr_dev_inst *sdi)
c7b17bcb 508{
c7b17bcb
TS
509 if (sdi->status != SR_ST_ACTIVE)
510 return SR_ERR_DEV_CLOSED;
511
512 return lls_stop_acquisition(sdi);
513}
514
515SR_PRIV struct sr_dev_driver lecroy_logicstudio_driver_info = {
516 .name = "lecroy-logicstudio",
517 .longname = "LeCroy LogicStudio",
518 .api_version = 1,
519 .init = init,
700d6b64 520 .cleanup = std_cleanup,
c7b17bcb 521 .scan = scan,
c01bf34c 522 .dev_list = std_dev_list,
c7b17bcb
TS
523 .config_get = config_get,
524 .config_set = config_set,
525 .config_list = config_list,
526 .config_commit = config_commit,
527 .dev_open = dev_open,
528 .dev_close = dev_close,
529 .dev_acquisition_start = dev_acquisition_start,
530 .dev_acquisition_stop = dev_acquisition_stop,
531 .context = NULL,
532};