2 * This file is part of the libsigrok project.
4 * Copyright (C) 2015 Tilman Sauerbeck <tilman@code-monkey.de>
5 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
27 #define LOGICSTUDIO16_VID 0x05ff
28 #define LOGICSTUDIO16_PID_LACK_FIRMWARE 0xa001
29 #define LOGICSTUDIO16_PID_HAVE_FIRMWARE 0xa002
31 #define USB_INTERFACE 0
32 #define USB_CONFIGURATION 0
33 #define FX2_FIRMWARE "lecroy-logicstudio16-fx2lp.fw"
35 #define UNKNOWN_ADDRESS 0xff
36 #define MAX_RENUM_DELAY_MS 3000
38 static 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,
45 static const int32_t trigger_matches[] = {
53 static const uint64_t samplerates[] = {
74 static struct sr_dev_inst *create_device(struct sr_usb_dev_inst *usb,
75 enum sr_dev_inst_status status, int64_t fw_updated)
77 struct sr_dev_inst *sdi;
78 struct dev_context *devc;
82 sdi = g_malloc0(sizeof(struct sr_dev_inst));
84 sdi->vendor = g_strdup("LeCroy");
85 sdi->model = g_strdup("LogicStudio16");
86 sdi->inst_type = SR_INST_USB;
89 for (i = 0; i < 16; i++) {
90 snprintf(channel_name, sizeof(channel_name), "D%i", i);
91 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
94 devc = g_malloc0(sizeof(struct dev_context));
98 devc->fw_updated = fw_updated;
99 devc->capture_ratio = 50;
101 lls_set_samplerate(sdi, SR_MHZ(500));
106 static GSList *scan(struct sr_dev_driver *di, GSList *options)
108 struct sr_dev_inst *sdi;
109 struct drv_context *drvc;
110 struct sr_usb_dev_inst *usb;
111 struct libusb_device_descriptor des;
112 libusb_device **devlist;
114 char connection_id[64];
124 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
126 for (i = 0; devlist[i]; i++) {
127 libusb_get_device_descriptor(devlist[i], &des);
129 if (des.idVendor != LOGICSTUDIO16_VID)
132 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
136 switch (des.idProduct) {
137 case LOGICSTUDIO16_PID_HAVE_FIRMWARE:
138 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
139 libusb_get_device_address(devlist[i]), NULL);
141 sdi = create_device(usb, SR_ST_INACTIVE, 0);
143 case LOGICSTUDIO16_PID_LACK_FIRMWARE:
144 r = ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
145 USB_CONFIGURATION, FX2_FIRMWARE);
148 * An error message has already been logged by
149 * ezusb_upload_firmware().
155 * Put unknown as the address so that we know we still
156 * need to get the proper address after the device
159 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
160 UNKNOWN_ADDRESS, NULL);
162 sdi = create_device(usb, SR_ST_INITIALIZING,
163 g_get_monotonic_time());
169 /* Cannot handle this device? */
173 sdi->connection_id = g_strdup(connection_id);
175 devices = g_slist_append(devices, sdi);
178 libusb_free_device_list(devlist, 1);
180 return std_scan_complete(di, devices);
183 static int open_device(struct sr_dev_inst *sdi)
185 struct drv_context *drvc;
186 struct sr_usb_dev_inst *usb;
187 struct libusb_device_descriptor des;
188 libusb_device **devlist;
189 char connection_id[64];
194 drvc = sdi->driver->context;
199 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
201 for (i = 0; devlist[i]; i++) {
202 libusb_get_device_descriptor(devlist[i], &des);
204 if (des.idVendor != LOGICSTUDIO16_VID ||
205 des.idProduct != LOGICSTUDIO16_PID_HAVE_FIRMWARE)
208 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
211 * Check if this device is the same one that we associated
212 * with this sdi in scan() and bail if it isn't.
214 if (strcmp(sdi->connection_id, connection_id))
217 r = libusb_open(devlist[i], &usb->devhdl);
220 sr_err("Failed to open device: %s.",
221 libusb_error_name(r));
225 /* Fix up address after firmware upload. */
226 if (usb->address == UNKNOWN_ADDRESS)
227 usb->address = libusb_get_device_address(devlist[i]);
234 libusb_free_device_list(devlist, 1);
239 if ((r = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
240 sr_err("Failed to claim interface: %s.",
241 libusb_error_name(r));
245 sdi->status = SR_ST_ACTIVE;
250 static int dev_open(struct sr_dev_inst *sdi)
252 struct dev_context *devc;
253 int64_t timediff_us, timediff_ms;
259 * If we didn't need to upload FX2 firmware in scan(), open the device
260 * right away. Otherwise, wait up to MAX_RENUM_DELAY_MS ms for the
263 if (!devc->fw_updated) {
264 ret = open_device(sdi);
266 sr_info("Waiting for device to reset.");
268 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
269 g_usleep(300 * 1000);
272 while (timediff_ms < MAX_RENUM_DELAY_MS) {
273 ret = open_device(sdi);
278 g_usleep(100 * 1000);
280 timediff_us = g_get_monotonic_time() - devc->fw_updated;
281 timediff_ms = timediff_us / 1000;
283 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
287 sr_err("Device failed to renumerate.");
291 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
295 sr_err("Unable to open device.");
300 * Only allocate the sample buffer now since it's rather large.
301 * Don't want to allocate it before we know we are going to use it.
303 devc->fetched_samples = g_malloc(SAMPLE_BUF_SIZE);
305 devc->conv8to16 = g_malloc(CONV_8TO16_BUF_SIZE);
307 devc->intr_xfer = libusb_alloc_transfer(0);
308 devc->bulk_xfer = libusb_alloc_transfer(0);
313 static int dev_close(struct sr_dev_inst *sdi)
315 struct sr_usb_dev_inst *usb;
316 struct dev_context *devc;
321 g_free(devc->fetched_samples);
322 devc->fetched_samples = NULL;
324 g_free(devc->conv8to16);
325 devc->conv8to16 = NULL;
327 if (devc->intr_xfer) {
328 devc->intr_xfer->buffer = NULL; /* Points into devc. */
329 libusb_free_transfer(devc->intr_xfer);
330 devc->intr_xfer = NULL;
333 if (devc->bulk_xfer) {
334 devc->bulk_xfer->buffer = NULL; /* Points into devc. */
335 libusb_free_transfer(devc->bulk_xfer);
336 devc->bulk_xfer = NULL;
342 libusb_release_interface(usb->devhdl, 0);
344 libusb_close(usb->devhdl);
347 sdi->status = SR_ST_INACTIVE;
352 static int config_get(uint32_t key, GVariant **data,
353 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
355 struct dev_context *devc;
365 case SR_CONF_SAMPLERATE:
366 *data = g_variant_new_uint64(lls_get_samplerate(sdi));
368 case SR_CONF_CAPTURE_RATIO:
369 *data = g_variant_new_uint64(devc->capture_ratio);
378 static int config_set(uint32_t key, GVariant *data,
379 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
381 struct dev_context *devc;
391 case SR_CONF_SAMPLERATE:
392 return lls_set_samplerate(sdi, g_variant_get_uint64(data));
393 case SR_CONF_CAPTURE_RATIO:
394 devc->capture_ratio = g_variant_get_uint64(data);
395 if (devc->capture_ratio > 100)
405 static int config_list(uint32_t key, GVariant **data,
406 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
415 case SR_CONF_DEVICE_OPTIONS:
416 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
417 devopts, ARRAY_SIZE(devopts),
420 case SR_CONF_SAMPLERATE:
421 g_variant_builder_init(&vb, G_VARIANT_TYPE("a{sv}"));
422 var = g_variant_new_fixed_array(G_VARIANT_TYPE("t"),
423 samplerates, ARRAY_SIZE(samplerates),
425 g_variant_builder_add(&vb, "{sv}", "samplerates", var);
426 *data = g_variant_builder_end(&vb);
428 case SR_CONF_TRIGGER_MATCH:
429 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
430 trigger_matches, ARRAY_SIZE(trigger_matches),
440 static int config_commit(const struct sr_dev_inst *sdi)
442 return lls_setup_acquisition(sdi);
445 static int receive_usb_data(int fd, int revents, void *cb_data)
447 struct drv_context *drvc;
453 drvc = (struct drv_context *)cb_data;
458 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx,
464 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
466 struct drv_context *drvc;
469 drvc = sdi->driver->context;
471 if ((ret = lls_start_acquisition(sdi)) < 0)
474 std_session_send_df_header(sdi);
476 return usb_source_add(sdi->session, drvc->sr_ctx, 100,
477 receive_usb_data, drvc);
480 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
482 return lls_stop_acquisition(sdi);
485 static struct sr_dev_driver lecroy_logicstudio_driver_info = {
486 .name = "lecroy-logicstudio",
487 .longname = "LeCroy LogicStudio",
490 .cleanup = std_cleanup,
492 .dev_list = std_dev_list,
493 .config_get = config_get,
494 .config_set = config_set,
495 .config_list = config_list,
496 .config_commit = config_commit,
497 .dev_open = dev_open,
498 .dev_close = dev_close,
499 .dev_acquisition_start = dev_acquisition_start,
500 .dev_acquisition_stop = dev_acquisition_stop,
503 SR_REGISTER_DEV_DRIVER(lecroy_logicstudio_driver_info);