]> sigrok.org Git - libsigrok.git/blame - src/hardware/lecroy-logicstudio/api.c
Remove unnecessary dev_clear() callbacks
[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
194static GSList *dev_list(const struct sr_dev_driver *di)
195{
196 return ((struct drv_context *)(di->context))->instances;
197}
198
c7b17bcb
TS
199static int open_device(struct sr_dev_inst *sdi)
200{
201 struct drv_context *drvc;
202 struct sr_usb_dev_inst *usb;
203 struct libusb_device_descriptor des;
204 libusb_device **devlist;
205 char connection_id[64];
206 bool is_opened;
207 size_t i;
208 int r;
209
210 if (sdi->status == SR_ST_ACTIVE)
211 return SR_ERR;
212
213 drvc = sdi->driver->context;
214 usb = sdi->conn;
215
216 is_opened = FALSE;
217
218 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
219
220 for (i = 0; devlist[i]; i++) {
221 libusb_get_device_descriptor(devlist[i], &des);
222
223 if (des.idVendor != LOGICSTUDIO16_VID ||
224 des.idProduct != LOGICSTUDIO16_PID_HAVE_FIRMWARE)
225 continue;
226
227 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
228
229 /*
230 * Check if this device is the same one that we associated
231 * with this sdi in scan() and bail if it isn't.
232 */
233 if (strcmp(sdi->connection_id, connection_id))
234 continue;
235
236 r = libusb_open(devlist[i], &usb->devhdl);
237
238 if (r) {
239 sr_err("Failed to open device: %s.",
240 libusb_error_name(r));
241 break;
242 }
243
244 /* Fix up address after firmware upload. */
245 if (usb->address == UNKNOWN_ADDRESS)
246 usb->address = libusb_get_device_address(devlist[i]);
247
248 is_opened = TRUE;
249
250 break;
251 }
252
253 libusb_free_device_list(devlist, 1);
254
255 if (!is_opened)
256 return SR_ERR;
257
258 if ((r = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
259 sr_err("Failed to claim interface: %s.",
260 libusb_error_name(r));
261 return SR_ERR;
262 }
263
264 sdi->status = SR_ST_ACTIVE;
265
266 return SR_OK;
267}
268
269static int dev_open(struct sr_dev_inst *sdi)
270{
271 struct drv_context *drvc;
272 struct dev_context *devc;
273 int64_t timediff_us, timediff_ms;
274 int ret;
275
276 drvc = sdi->driver->context;
277 devc = sdi->priv;
278
279 if (!drvc) {
280 sr_err("Driver was not initialized.");
281 return SR_ERR;
282 }
283
284 /*
285 * If we didn't need to upload FX2 firmware in scan(), open the device
286 * right away. Otherwise, wait up to MAX_RENUM_DELAY_MS ms for the
287 * FX2 to renumerate.
288 */
289 if (!devc->fw_updated) {
290 ret = open_device(sdi);
291 } else {
292 sr_info("Waiting for device to reset.");
293
294 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
295 g_usleep(300 * 1000);
296 timediff_ms = 0;
297
298 while (timediff_ms < MAX_RENUM_DELAY_MS) {
299 ret = open_device(sdi);
300
301 if (ret == SR_OK)
302 break;
303
304 g_usleep(100 * 1000);
305
306 timediff_us = g_get_monotonic_time() - devc->fw_updated;
307 timediff_ms = timediff_us / 1000;
308
309 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
310 }
311
312 if (ret != SR_OK) {
313 sr_err("Device failed to renumerate.");
314 return SR_ERR;
315 }
316
317 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
318 }
319
320 if (ret != SR_OK) {
321 sr_err("Unable to open device.");
322 return ret;
323 }
324
325 /*
326 * Only allocate the sample buffer now since it's rather large.
327 * Don't want to allocate it before we know we are going to use it.
328 */
329 devc->fetched_samples = g_malloc(SAMPLE_BUF_SIZE);
330
331 devc->conv8to16 = g_malloc(CONV_8TO16_BUF_SIZE);
332
333 devc->intr_xfer = libusb_alloc_transfer(0);
334 devc->bulk_xfer = libusb_alloc_transfer(0);
335
336 return SR_OK;
337}
338
339static int dev_close(struct sr_dev_inst *sdi)
340{
341 struct sr_usb_dev_inst *usb;
342 struct dev_context *devc;
343
344 usb = sdi->conn;
345 devc = sdi->priv;
346
347 g_free(devc->fetched_samples);
348 devc->fetched_samples = NULL;
349
350 g_free(devc->conv8to16);
351 devc->conv8to16 = NULL;
352
353 if (devc->intr_xfer) {
354 devc->intr_xfer->buffer = NULL; /* Points into devc. */
355 libusb_free_transfer(devc->intr_xfer);
356 devc->intr_xfer = NULL;
357 }
358
359 if (devc->bulk_xfer) {
360 devc->bulk_xfer->buffer = NULL; /* Points into devc. */
361 libusb_free_transfer(devc->bulk_xfer);
362 devc->bulk_xfer = NULL;
363 }
364
365 if (!usb->devhdl)
366 return SR_ERR;
367
368 libusb_release_interface(usb->devhdl, 0);
369
370 libusb_close(usb->devhdl);
371 usb->devhdl = NULL;
372
373 sdi->status = SR_ST_INACTIVE;
374
375 return SR_OK;
376}
377
c7b17bcb
TS
378static int config_get(uint32_t key, GVariant **data,
379 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
380{
381 struct dev_context *devc;
382
383 (void)cg;
384
385 if (!sdi)
386 return SR_ERR_ARG;
387
388 devc = sdi->priv;
389
390 switch (key) {
391 case SR_CONF_SAMPLERATE:
392 *data = g_variant_new_uint64(lls_get_samplerate(sdi));
393 break;
394 case SR_CONF_CAPTURE_RATIO:
395 *data = g_variant_new_uint64(devc->capture_ratio);
396 break;
397 default:
398 return SR_ERR_NA;
399 }
400
401 return SR_OK;
402}
403
404static int config_set(uint32_t key, GVariant *data,
405 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
406{
407 struct dev_context *devc;
408
409 (void)cg;
410
411 if (!sdi)
412 return SR_ERR_ARG;
413
414 devc = sdi->priv;
415
416 if (sdi->status != SR_ST_ACTIVE)
417 return SR_ERR_DEV_CLOSED;
418
419 switch (key) {
420 case SR_CONF_SAMPLERATE:
421 return lls_set_samplerate(sdi, g_variant_get_uint64(data));
422 case SR_CONF_CAPTURE_RATIO:
423 devc->capture_ratio = g_variant_get_uint64(data);
424 if (devc->capture_ratio > 100)
425 return SR_ERR;
426 break;
427 default:
428 return SR_ERR_NA;
429 }
430
431 return SR_OK;
432}
433
434static int config_list(uint32_t key, GVariant **data,
435 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
436{
437 GVariantBuilder vb;
438 GVariant *var;
439
440 (void)sdi;
441 (void)cg;
442
443 switch (key) {
444 case SR_CONF_DEVICE_OPTIONS:
445 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
446 devopts, ARRAY_SIZE(devopts),
447 sizeof(uint32_t));
448 break;
449 case SR_CONF_SAMPLERATE:
450 g_variant_builder_init(&vb, G_VARIANT_TYPE("a{sv}"));
451 var = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
452 samplerates, ARRAY_SIZE(samplerates),
453 sizeof(uint64_t));
454 g_variant_builder_add(&vb, "{sv}", "samplerates", var);
455 *data = g_variant_builder_end(&vb);
456 break;
457 case SR_CONF_TRIGGER_MATCH:
458 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
459 trigger_matches, ARRAY_SIZE(trigger_matches),
460 sizeof(int32_t));
461 break;
462 default:
463 return SR_ERR_NA;
464 }
465
466 return SR_OK;
467}
468
469static int config_commit(const struct sr_dev_inst *sdi)
470{
471 return lls_setup_acquisition(sdi);
472}
473
474static int receive_usb_data(int fd, int revents, void *cb_data)
475{
476 struct drv_context *drvc;
477 struct timeval tv;
478
479 (void)fd;
480 (void)revents;
481
695dc859 482 drvc = (struct drv_context *)cb_data;
c7b17bcb
TS
483
484 tv.tv_sec = 0;
485 tv.tv_usec = 0;
486
487 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx,
488 &tv, NULL);
489
490 return TRUE;
491}
492
695dc859 493static int dev_acquisition_start(const struct sr_dev_inst *sdi)
c7b17bcb
TS
494{
495 struct drv_context *drvc;
496 int ret;
497
498 if (sdi->status != SR_ST_ACTIVE)
499 return SR_ERR_DEV_CLOSED;
500
501 drvc = sdi->driver->context;
502
503 if ((ret = lls_start_acquisition(sdi)) < 0)
504 return ret;
505
695dc859 506 std_session_send_df_header(sdi, LOG_PREFIX);
c7b17bcb
TS
507
508 return usb_source_add(sdi->session, drvc->sr_ctx, 100,
509 receive_usb_data, drvc);
510}
511
695dc859 512static int dev_acquisition_stop(struct sr_dev_inst *sdi)
c7b17bcb 513{
c7b17bcb
TS
514 if (sdi->status != SR_ST_ACTIVE)
515 return SR_ERR_DEV_CLOSED;
516
517 return lls_stop_acquisition(sdi);
518}
519
520SR_PRIV struct sr_dev_driver lecroy_logicstudio_driver_info = {
521 .name = "lecroy-logicstudio",
522 .longname = "LeCroy LogicStudio",
523 .api_version = 1,
524 .init = init,
700d6b64 525 .cleanup = std_cleanup,
c7b17bcb
TS
526 .scan = scan,
527 .dev_list = dev_list,
c7b17bcb
TS
528 .config_get = config_get,
529 .config_set = config_set,
530 .config_list = config_list,
531 .config_commit = config_commit,
532 .dev_open = dev_open,
533 .dev_close = dev_close,
534 .dev_acquisition_start = dev_acquisition_start,
535 .dev_acquisition_stop = dev_acquisition_stop,
536 .context = NULL,
537};