]>
Commit | Line | Data |
---|---|---|
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 | ||
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, | |
43 | }; | |
44 | ||
45 | static 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 | ||
53 | static 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 | ||
15a5bfe4 LPC |
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) | |
c7b17bcb TS |
76 | { |
77 | struct sr_dev_inst *sdi; | |
78 | struct dev_context *devc; | |
79 | char channel_name[8]; | |
80 | int i; | |
81 | ||
82 | sdi = g_malloc0(sizeof(struct sr_dev_inst)); | |
83 | sdi->status = status; | |
84 | sdi->vendor = g_strdup("LeCroy"); | |
85 | sdi->model = g_strdup("LogicStudio16"); | |
c7b17bcb TS |
86 | sdi->inst_type = SR_INST_USB; |
87 | sdi->conn = usb; | |
88 | ||
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); | |
92 | } | |
93 | ||
94 | devc = g_malloc0(sizeof(struct dev_context)); | |
95 | ||
96 | sdi->priv = devc; | |
97 | ||
98 | devc->fw_updated = fw_updated; | |
99 | devc->capture_ratio = 50; | |
100 | ||
101 | lls_set_samplerate(sdi, SR_MHZ(500)); | |
102 | ||
103 | return sdi; | |
104 | } | |
105 | ||
106 | static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
107 | { | |
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; | |
113 | GSList *devices; | |
114 | char connection_id[64]; | |
115 | size_t i; | |
116 | int r; | |
117 | ||
118 | (void)options; | |
119 | ||
120 | drvc = di->context; | |
c7b17bcb TS |
121 | |
122 | devices = NULL; | |
123 | ||
124 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
125 | ||
126 | for (i = 0; devlist[i]; i++) { | |
127 | libusb_get_device_descriptor(devlist[i], &des); | |
128 | ||
129 | if (des.idVendor != LOGICSTUDIO16_VID) | |
130 | continue; | |
131 | ||
132 | usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)); | |
133 | ||
134 | usb = NULL; | |
135 | ||
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); | |
140 | ||
15a5bfe4 | 141 | sdi = create_device(usb, SR_ST_INACTIVE, 0); |
c7b17bcb TS |
142 | break; |
143 | case LOGICSTUDIO16_PID_LACK_FIRMWARE: | |
144 | r = ezusb_upload_firmware(drvc->sr_ctx, devlist[i], | |
145 | USB_CONFIGURATION, FX2_FIRMWARE); | |
146 | if (r != SR_OK) { | |
147 | /* | |
148 | * An error message has already been logged by | |
149 | * ezusb_upload_firmware(). | |
150 | */ | |
151 | continue; | |
152 | } | |
153 | ||
154 | /* | |
155 | * Put unknown as the address so that we know we still | |
156 | * need to get the proper address after the device | |
157 | * renumerates. | |
158 | */ | |
159 | usb = sr_usb_dev_inst_new(libusb_get_bus_number(devlist[i]), | |
160 | UNKNOWN_ADDRESS, NULL); | |
161 | ||
15a5bfe4 | 162 | sdi = create_device(usb, SR_ST_INITIALIZING, |
c7b17bcb TS |
163 | g_get_monotonic_time()); |
164 | break; | |
165 | default: | |
166 | break; | |
167 | } | |
168 | ||
169 | /* Cannot handle this device? */ | |
170 | if (!usb) | |
171 | continue; | |
172 | ||
173 | sdi->connection_id = g_strdup(connection_id); | |
174 | ||
c7b17bcb TS |
175 | devices = g_slist_append(devices, sdi); |
176 | } | |
177 | ||
178 | libusb_free_device_list(devlist, 1); | |
179 | ||
15a5bfe4 | 180 | return std_scan_complete(di, devices); |
c7b17bcb TS |
181 | } |
182 | ||
c7b17bcb TS |
183 | static int open_device(struct sr_dev_inst *sdi) |
184 | { | |
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]; | |
190 | bool is_opened; | |
191 | size_t i; | |
192 | int r; | |
193 | ||
194 | if (sdi->status == SR_ST_ACTIVE) | |
195 | return SR_ERR; | |
196 | ||
197 | drvc = sdi->driver->context; | |
198 | usb = sdi->conn; | |
199 | ||
200 | is_opened = FALSE; | |
201 | ||
202 | libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist); | |
203 | ||
204 | for (i = 0; devlist[i]; i++) { | |
205 | libusb_get_device_descriptor(devlist[i], &des); | |
206 | ||
207 | if (des.idVendor != LOGICSTUDIO16_VID || | |
208 | des.idProduct != LOGICSTUDIO16_PID_HAVE_FIRMWARE) | |
209 | continue; | |
210 | ||
211 | usb_get_port_path(devlist[i], connection_id, sizeof(connection_id)); | |
212 | ||
213 | /* | |
214 | * Check if this device is the same one that we associated | |
215 | * with this sdi in scan() and bail if it isn't. | |
216 | */ | |
217 | if (strcmp(sdi->connection_id, connection_id)) | |
218 | continue; | |
219 | ||
220 | r = libusb_open(devlist[i], &usb->devhdl); | |
221 | ||
222 | if (r) { | |
223 | sr_err("Failed to open device: %s.", | |
224 | libusb_error_name(r)); | |
225 | break; | |
226 | } | |
227 | ||
228 | /* Fix up address after firmware upload. */ | |
229 | if (usb->address == UNKNOWN_ADDRESS) | |
230 | usb->address = libusb_get_device_address(devlist[i]); | |
231 | ||
232 | is_opened = TRUE; | |
233 | ||
234 | break; | |
235 | } | |
236 | ||
237 | libusb_free_device_list(devlist, 1); | |
238 | ||
239 | if (!is_opened) | |
240 | return SR_ERR; | |
241 | ||
242 | if ((r = libusb_claim_interface(usb->devhdl, USB_INTERFACE))) { | |
243 | sr_err("Failed to claim interface: %s.", | |
244 | libusb_error_name(r)); | |
245 | return SR_ERR; | |
246 | } | |
247 | ||
248 | sdi->status = SR_ST_ACTIVE; | |
249 | ||
250 | return SR_OK; | |
251 | } | |
252 | ||
253 | static int dev_open(struct sr_dev_inst *sdi) | |
254 | { | |
c7b17bcb TS |
255 | struct dev_context *devc; |
256 | int64_t timediff_us, timediff_ms; | |
257 | int ret; | |
258 | ||
c7b17bcb TS |
259 | devc = sdi->priv; |
260 | ||
c7b17bcb TS |
261 | /* |
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 | |
264 | * FX2 to renumerate. | |
265 | */ | |
266 | if (!devc->fw_updated) { | |
267 | ret = open_device(sdi); | |
268 | } else { | |
269 | sr_info("Waiting for device to reset."); | |
270 | ||
271 | /* Takes >= 300ms for the FX2 to be gone from the USB bus. */ | |
272 | g_usleep(300 * 1000); | |
273 | timediff_ms = 0; | |
274 | ||
275 | while (timediff_ms < MAX_RENUM_DELAY_MS) { | |
276 | ret = open_device(sdi); | |
277 | ||
278 | if (ret == SR_OK) | |
279 | break; | |
280 | ||
281 | g_usleep(100 * 1000); | |
282 | ||
283 | timediff_us = g_get_monotonic_time() - devc->fw_updated; | |
284 | timediff_ms = timediff_us / 1000; | |
285 | ||
286 | sr_spew("Waited %" PRIi64 "ms.", timediff_ms); | |
287 | } | |
288 | ||
289 | if (ret != SR_OK) { | |
290 | sr_err("Device failed to renumerate."); | |
291 | return SR_ERR; | |
292 | } | |
293 | ||
294 | sr_info("Device came back after %" PRIi64 "ms.", timediff_ms); | |
295 | } | |
296 | ||
297 | if (ret != SR_OK) { | |
298 | sr_err("Unable to open device."); | |
299 | return ret; | |
300 | } | |
301 | ||
302 | /* | |
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. | |
305 | */ | |
306 | devc->fetched_samples = g_malloc(SAMPLE_BUF_SIZE); | |
307 | ||
308 | devc->conv8to16 = g_malloc(CONV_8TO16_BUF_SIZE); | |
309 | ||
310 | devc->intr_xfer = libusb_alloc_transfer(0); | |
311 | devc->bulk_xfer = libusb_alloc_transfer(0); | |
312 | ||
313 | return SR_OK; | |
314 | } | |
315 | ||
316 | static int dev_close(struct sr_dev_inst *sdi) | |
317 | { | |
318 | struct sr_usb_dev_inst *usb; | |
319 | struct dev_context *devc; | |
320 | ||
321 | usb = sdi->conn; | |
322 | devc = sdi->priv; | |
323 | ||
324 | g_free(devc->fetched_samples); | |
325 | devc->fetched_samples = NULL; | |
326 | ||
327 | g_free(devc->conv8to16); | |
328 | devc->conv8to16 = NULL; | |
329 | ||
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; | |
334 | } | |
335 | ||
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; | |
340 | } | |
341 | ||
342 | if (!usb->devhdl) | |
343 | return SR_ERR; | |
344 | ||
345 | libusb_release_interface(usb->devhdl, 0); | |
346 | ||
347 | libusb_close(usb->devhdl); | |
348 | usb->devhdl = NULL; | |
349 | ||
350 | sdi->status = SR_ST_INACTIVE; | |
351 | ||
352 | return SR_OK; | |
353 | } | |
354 | ||
c7b17bcb TS |
355 | static int config_get(uint32_t key, GVariant **data, |
356 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
357 | { | |
358 | struct dev_context *devc; | |
359 | ||
360 | (void)cg; | |
361 | ||
362 | if (!sdi) | |
363 | return SR_ERR_ARG; | |
364 | ||
365 | devc = sdi->priv; | |
366 | ||
367 | switch (key) { | |
368 | case SR_CONF_SAMPLERATE: | |
369 | *data = g_variant_new_uint64(lls_get_samplerate(sdi)); | |
370 | break; | |
371 | case SR_CONF_CAPTURE_RATIO: | |
372 | *data = g_variant_new_uint64(devc->capture_ratio); | |
373 | break; | |
374 | default: | |
375 | return SR_ERR_NA; | |
376 | } | |
377 | ||
378 | return SR_OK; | |
379 | } | |
380 | ||
381 | static int config_set(uint32_t key, GVariant *data, | |
382 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
383 | { | |
384 | struct dev_context *devc; | |
385 | ||
386 | (void)cg; | |
387 | ||
388 | if (!sdi) | |
389 | return SR_ERR_ARG; | |
390 | ||
391 | devc = sdi->priv; | |
392 | ||
393 | if (sdi->status != SR_ST_ACTIVE) | |
394 | return SR_ERR_DEV_CLOSED; | |
395 | ||
396 | switch (key) { | |
397 | case SR_CONF_SAMPLERATE: | |
398 | return lls_set_samplerate(sdi, g_variant_get_uint64(data)); | |
399 | case SR_CONF_CAPTURE_RATIO: | |
400 | devc->capture_ratio = g_variant_get_uint64(data); | |
401 | if (devc->capture_ratio > 100) | |
402 | return SR_ERR; | |
403 | break; | |
404 | default: | |
405 | return SR_ERR_NA; | |
406 | } | |
407 | ||
408 | return SR_OK; | |
409 | } | |
410 | ||
411 | static int config_list(uint32_t key, GVariant **data, | |
412 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
413 | { | |
414 | GVariantBuilder vb; | |
415 | GVariant *var; | |
416 | ||
417 | (void)sdi; | |
418 | (void)cg; | |
419 | ||
420 | switch (key) { | |
421 | case SR_CONF_DEVICE_OPTIONS: | |
422 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
423 | devopts, ARRAY_SIZE(devopts), | |
424 | sizeof(uint32_t)); | |
425 | break; | |
426 | case SR_CONF_SAMPLERATE: | |
427 | g_variant_builder_init(&vb, G_VARIANT_TYPE("a{sv}")); | |
428 | var = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), | |
429 | samplerates, ARRAY_SIZE(samplerates), | |
430 | sizeof(uint64_t)); | |
431 | g_variant_builder_add(&vb, "{sv}", "samplerates", var); | |
432 | *data = g_variant_builder_end(&vb); | |
433 | break; | |
434 | case SR_CONF_TRIGGER_MATCH: | |
435 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, | |
436 | trigger_matches, ARRAY_SIZE(trigger_matches), | |
437 | sizeof(int32_t)); | |
438 | break; | |
439 | default: | |
440 | return SR_ERR_NA; | |
441 | } | |
442 | ||
443 | return SR_OK; | |
444 | } | |
445 | ||
446 | static int config_commit(const struct sr_dev_inst *sdi) | |
447 | { | |
448 | return lls_setup_acquisition(sdi); | |
449 | } | |
450 | ||
451 | static int receive_usb_data(int fd, int revents, void *cb_data) | |
452 | { | |
453 | struct drv_context *drvc; | |
454 | struct timeval tv; | |
455 | ||
456 | (void)fd; | |
457 | (void)revents; | |
458 | ||
695dc859 | 459 | drvc = (struct drv_context *)cb_data; |
c7b17bcb TS |
460 | |
461 | tv.tv_sec = 0; | |
462 | tv.tv_usec = 0; | |
463 | ||
464 | libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, | |
465 | &tv, NULL); | |
466 | ||
467 | return TRUE; | |
468 | } | |
469 | ||
695dc859 | 470 | static int dev_acquisition_start(const struct sr_dev_inst *sdi) |
c7b17bcb TS |
471 | { |
472 | struct drv_context *drvc; | |
473 | int ret; | |
474 | ||
475 | if (sdi->status != SR_ST_ACTIVE) | |
476 | return SR_ERR_DEV_CLOSED; | |
477 | ||
478 | drvc = sdi->driver->context; | |
479 | ||
480 | if ((ret = lls_start_acquisition(sdi)) < 0) | |
481 | return ret; | |
482 | ||
bee2b016 | 483 | std_session_send_df_header(sdi); |
c7b17bcb TS |
484 | |
485 | return usb_source_add(sdi->session, drvc->sr_ctx, 100, | |
486 | receive_usb_data, drvc); | |
487 | } | |
488 | ||
695dc859 | 489 | static int dev_acquisition_stop(struct sr_dev_inst *sdi) |
c7b17bcb | 490 | { |
c7b17bcb TS |
491 | if (sdi->status != SR_ST_ACTIVE) |
492 | return SR_ERR_DEV_CLOSED; | |
493 | ||
494 | return lls_stop_acquisition(sdi); | |
495 | } | |
496 | ||
dd5c48a6 | 497 | static struct sr_dev_driver lecroy_logicstudio_driver_info = { |
c7b17bcb TS |
498 | .name = "lecroy-logicstudio", |
499 | .longname = "LeCroy LogicStudio", | |
500 | .api_version = 1, | |
c2fdcc25 | 501 | .init = std_init, |
700d6b64 | 502 | .cleanup = std_cleanup, |
c7b17bcb | 503 | .scan = scan, |
c01bf34c | 504 | .dev_list = std_dev_list, |
c7b17bcb TS |
505 | .config_get = config_get, |
506 | .config_set = config_set, | |
507 | .config_list = config_list, | |
508 | .config_commit = config_commit, | |
509 | .dev_open = dev_open, | |
510 | .dev_close = dev_close, | |
511 | .dev_acquisition_start = dev_acquisition_start, | |
512 | .dev_acquisition_stop = dev_acquisition_stop, | |
513 | .context = NULL, | |
514 | }; | |
dd5c48a6 | 515 | SR_REGISTER_DEV_DRIVER(lecroy_logicstudio_driver_info); |