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 drvopts[] = {
39 SR_CONF_LOGIC_ANALYZER,
42 static const uint32_t devopts[] = {
43 SR_CONF_SAMPLERATE | SR_CONF_GET | SR_CONF_SET | SR_CONF_LIST,
44 SR_CONF_CAPTURE_RATIO | SR_CONF_GET | SR_CONF_SET,
45 SR_CONF_TRIGGER_MATCH | SR_CONF_LIST,
48 static const int32_t trigger_matches[] = {
56 static const uint64_t samplerates[] = {
77 static struct sr_dev_inst *create_device(struct sr_usb_dev_inst *usb,
78 enum sr_dev_inst_status status, int64_t fw_updated)
80 struct sr_dev_inst *sdi;
81 struct dev_context *devc;
85 sdi = g_malloc0(sizeof(struct sr_dev_inst));
87 sdi->vendor = g_strdup("LeCroy");
88 sdi->model = g_strdup("LogicStudio16");
89 sdi->inst_type = SR_INST_USB;
92 for (i = 0; i < 16; i++) {
93 snprintf(channel_name, sizeof(channel_name), "D%i", i);
94 sr_channel_new(sdi, i, SR_CHANNEL_LOGIC, TRUE, channel_name);
97 devc = g_malloc0(sizeof(struct dev_context));
101 devc->fw_updated = fw_updated;
102 devc->capture_ratio = 50;
104 lls_set_samplerate(sdi, SR_MHZ(500));
109 static GSList *scan(struct sr_dev_driver *di, GSList *options)
111 struct sr_dev_inst *sdi;
112 struct drv_context *drvc;
113 struct sr_usb_dev_inst *usb;
114 struct libusb_device_descriptor des;
115 libusb_device **devlist;
117 char connection_id[64];
127 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
129 for (i = 0; devlist[i]; i++) {
130 libusb_get_device_descriptor(devlist[i], &des);
132 if (des.idVendor != LOGICSTUDIO16_VID)
135 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
139 switch (des.idProduct) {
140 case LOGICSTUDIO16_PID_HAVE_FIRMWARE:
141 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
142 libusb_get_device_address(devlist[i]), NULL);
144 sdi = create_device(usb, SR_ST_INACTIVE, 0);
146 case LOGICSTUDIO16_PID_LACK_FIRMWARE:
147 r = ezusb_upload_firmware(drvc->sr_ctx, devlist[i],
148 USB_CONFIGURATION, FX2_FIRMWARE);
151 * An error message has already been logged by
152 * ezusb_upload_firmware().
158 * Put unknown as the address so that we know we still
159 * need to get the proper address after the device
162 usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]),
163 UNKNOWN_ADDRESS, NULL);
165 sdi = create_device(usb, SR_ST_INITIALIZING,
166 g_get_monotonic_time());
172 /* Cannot handle this device? */
176 sdi->connection_id = g_strdup(connection_id);
178 devices = g_slist_append(devices, sdi);
181 libusb_free_device_list(devlist, 1);
183 return std_scan_complete(di, devices);
186 static int open_device(struct sr_dev_inst *sdi)
188 struct drv_context *drvc;
189 struct sr_usb_dev_inst *usb;
190 struct libusb_device_descriptor des;
191 libusb_device **devlist;
192 char connection_id[64];
197 drvc = sdi->driver->context;
202 libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
204 for (i = 0; devlist[i]; i++) {
205 libusb_get_device_descriptor(devlist[i], &des);
207 if (des.idVendor != LOGICSTUDIO16_VID ||
208 des.idProduct != LOGICSTUDIO16_PID_HAVE_FIRMWARE)
211 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
214 * Check if this device is the same one that we associated
215 * with this sdi in scan() and bail if it isn't.
217 if (strcmp(sdi->connection_id, connection_id))
220 r = libusb_open(devlist[i], &usb->devhdl);
223 sr_err("Failed to open device: %s.",
224 libusb_error_name(r));
228 /* Fix up address after firmware upload. */
229 if (usb->address == UNKNOWN_ADDRESS)
230 usb->address = libusb_get_device_address(devlist[i]);
237 libusb_free_device_list(devlist, 1);
242 if ((r = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) {
243 sr_err("Failed to claim interface: %s.",
244 libusb_error_name(r));
248 sdi->status = SR_ST_ACTIVE;
253 static int dev_open(struct sr_dev_inst *sdi)
255 struct dev_context *devc;
256 int64_t timediff_us, timediff_ms;
262 * If we didn't need to upload FX2 firmware in scan(), open the device
263 * right away. Otherwise, wait up to MAX_RENUM_DELAY_MS ms for the
266 if (!devc->fw_updated) {
267 ret = open_device(sdi);
269 sr_info("Waiting for device to reset.");
271 /* Takes >= 300ms for the FX2 to be gone from the USB bus. */
272 g_usleep(300 * 1000);
275 while (timediff_ms < MAX_RENUM_DELAY_MS) {
276 ret = open_device(sdi);
281 g_usleep(100 * 1000);
283 timediff_us = g_get_monotonic_time() - devc->fw_updated;
284 timediff_ms = timediff_us / 1000;
286 sr_spew("Waited %" PRIi64 "ms.", timediff_ms);
290 sr_err("Device failed to renumerate.");
294 sr_info("Device came back after %" PRIi64 "ms.", timediff_ms);
298 sr_err("Unable to open device.");
303 * Only allocate the sample buffer now since it's rather large.
304 * Don't want to allocate it before we know we are going to use it.
306 devc->fetched_samples = g_malloc(SAMPLE_BUF_SIZE);
308 devc->conv8to16 = g_malloc(CONV_8TO16_BUF_SIZE);
310 devc->intr_xfer = libusb_alloc_transfer(0);
311 devc->bulk_xfer = libusb_alloc_transfer(0);
316 static int dev_close(struct sr_dev_inst *sdi)
318 struct sr_usb_dev_inst *usb;
319 struct dev_context *devc;
324 g_free(devc->fetched_samples);
325 devc->fetched_samples = NULL;
327 g_free(devc->conv8to16);
328 devc->conv8to16 = NULL;
330 if (devc->intr_xfer) {
331 devc->intr_xfer->buffer = NULL; /* Points into devc. */
332 libusb_free_transfer(devc->intr_xfer);
333 devc->intr_xfer = NULL;
336 if (devc->bulk_xfer) {
337 devc->bulk_xfer->buffer = NULL; /* Points into devc. */
338 libusb_free_transfer(devc->bulk_xfer);
339 devc->bulk_xfer = NULL;
345 libusb_release_interface(usb->devhdl, 0);
347 libusb_close(usb->devhdl);
353 static int config_get(uint32_t key, GVariant **data,
354 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
356 struct dev_context *devc;
366 case SR_CONF_SAMPLERATE:
367 *data = g_variant_new_uint64(lls_get_samplerate(sdi));
369 case SR_CONF_CAPTURE_RATIO:
370 *data = g_variant_new_uint64(devc->capture_ratio);
379 static int config_set(uint32_t key, GVariant *data,
380 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
382 struct dev_context *devc;
392 case SR_CONF_SAMPLERATE:
393 return lls_set_samplerate(sdi, g_variant_get_uint64(data));
394 case SR_CONF_CAPTURE_RATIO:
395 devc->capture_ratio = g_variant_get_uint64(data);
404 static int config_list(uint32_t key, GVariant **data,
405 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
408 case SR_CONF_DEVICE_OPTIONS:
409 return STD_CONFIG_LIST(key, data, sdi, cg, NULL, drvopts, devopts);
410 case SR_CONF_SAMPLERATE:
411 *data = std_gvar_samplerates(ARRAY_AND_SIZE(samplerates));
413 case SR_CONF_TRIGGER_MATCH:
414 *data = std_gvar_array_i32(ARRAY_AND_SIZE(trigger_matches));
423 static int config_commit(const struct sr_dev_inst *sdi)
425 return lls_setup_acquisition(sdi);
428 static int receive_usb_data(int fd, int revents, void *cb_data)
430 struct drv_context *drvc;
436 drvc = (struct drv_context *)cb_data;
441 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx,
447 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
449 struct drv_context *drvc;
452 drvc = sdi->driver->context;
454 if ((ret = lls_start_acquisition(sdi)) < 0)
457 std_session_send_df_header(sdi);
459 return usb_source_add(sdi->session, drvc->sr_ctx, 100,
460 receive_usb_data, drvc);
463 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
465 return lls_stop_acquisition(sdi);
468 static struct sr_dev_driver lecroy_logicstudio_driver_info = {
469 .name = "lecroy-logicstudio",
470 .longname = "LeCroy LogicStudio",
473 .cleanup = std_cleanup,
475 .dev_list = std_dev_list,
476 .dev_clear = std_dev_clear,
477 .config_get = config_get,
478 .config_set = config_set,
479 .config_list = config_list,
480 .config_commit = config_commit,
481 .dev_open = dev_open,
482 .dev_close = dev_close,
483 .dev_acquisition_start = dev_acquisition_start,
484 .dev_acquisition_stop = dev_acquisition_stop,
487 SR_REGISTER_DEV_DRIVER(lecroy_logicstudio_driver_info);