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