2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "libsigrok.h"
23 #include "libsigrok-internal.h"
26 SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
27 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
28 static struct sr_dev_driver *di = &lascar_el_usb_driver_info;
29 static int hw_dev_close(struct sr_dev_inst *sdi);
31 static const int hwopts[] = {
36 static const int hwcaps[] = {
39 SR_HWCAP_LIMIT_SAMPLES,
43 static const char *probe_names[] = {
48 /* Properly close and free all devices. */
49 static int clear_instances(void)
51 struct sr_dev_inst *sdi;
52 struct drv_context *drvc;
53 struct dev_context *devc;
56 if (!(drvc = di->priv))
59 for (l = drvc->instances; l; l = l->next) {
62 if (!(devc = sdi->priv))
66 sr_usb_dev_inst_free(devc->usb);
67 sr_dev_inst_free(sdi);
70 g_slist_free(drvc->instances);
71 drvc->instances = NULL;
76 static int hw_init(struct sr_context *sr_ctx)
78 struct drv_context *drvc;
80 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
81 sr_err("Driver context malloc failed.");
85 drvc->sr_ctx = sr_ctx;
91 static GSList *hw_scan(GSList *options)
93 struct drv_context *drvc;
94 struct dev_context *devc;
95 struct sr_dev_inst *sdi;
96 struct sr_usb_dev_inst *usb;
98 GSList *usb_devices, *devices, *l;
103 if (!(drvc = di->priv)) {
104 sr_err("Driver was not initialized.");
108 /* USB scan is always authoritative. */
112 for (l = options; l; l = l->next) {
114 switch (opt->hwopt) {
124 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
125 /* We have a list of sr_usb_dev_inst matching the connection
126 * string. Wrap them in sr_dev_inst and we're done. */
127 for (l = usb_devices; l; l = l->next) {
129 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
130 /* Not a Lascar EL-USB. */
136 drvc->instances = g_slist_append(drvc->instances, sdi);
137 devices = g_slist_append(devices, sdi);
139 g_slist_free(usb_devices);
141 g_slist_free_full(usb_devices, g_free);
146 static GSList *hw_dev_list(void)
148 struct drv_context *drvc;
150 if (!(drvc = di->priv)) {
151 sr_err("Driver was not initialized.");
155 return drvc->instances;
158 static int hw_dev_open(struct sr_dev_inst *sdi)
160 struct drv_context *drvc;
161 struct dev_context *devc;
164 if (!(drvc = di->priv)) {
165 sr_err("Driver was not initialized.");
170 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK)
173 if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) {
174 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
177 sdi->status = SR_ST_ACTIVE;
182 static int hw_dev_close(struct sr_dev_inst *sdi)
184 struct dev_context *devc;
187 sr_err("Driver was not initialized.");
192 if (!devc->usb->devhdl)
196 libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE);
197 libusb_close(devc->usb->devhdl);
198 devc->usb->devhdl = NULL;
199 g_free(devc->config);
200 sdi->status = SR_ST_INACTIVE;
206 static int hw_cleanup(void)
208 struct drv_context *drvc;
210 if (!(drvc = di->priv))
211 /* Can get called on an unused driver, doesn't matter. */
221 static int hw_info_get(int info_id, const void **data,
222 const struct sr_dev_inst *sdi)
234 case SR_DI_NUM_PROBES:
235 *data = GINT_TO_POINTER(1);
237 case SR_DI_PROBE_NAMES:
241 sr_err("Unknown info_id: %d.", info_id);
248 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
251 struct dev_context *devc;
255 sr_err("Driver was not initialized.");
258 if (sdi->status != SR_ST_ACTIVE) {
259 sr_err("Device inactive, can't set config options.");
266 case SR_HWCAP_LIMIT_SAMPLES:
267 devc->limit_samples = *(const uint64_t *)value;
268 sr_dbg("Setting sample limit to %" PRIu64 ".",
269 devc->limit_samples);
272 sr_err("Unknown hardware capability: %d.", hwcap);
279 static void mark_xfer(struct libusb_transfer *xfer)
282 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
283 xfer->user_data = GINT_TO_POINTER(1);
285 xfer->user_data = GINT_TO_POINTER(-1);
289 /* The Lascar software, in its infinite ignorance, reads a set of four
290 * bytes from the device config struct and interprets it as a float.
291 * That only works because they only use windows, and only on x86. However
292 * we may be running on any architecture, any operating system. So we have
293 * to convert these four bytes as the Lascar software would on windows/x86,
294 * to the local representation of a float.
295 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
296 static float binary32_le_to_float(unsigned char *buf)
301 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
302 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
303 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
308 static int lascar_proc_config(const struct sr_dev_inst *sdi)
310 struct dev_context *devc;
314 if (!(devc->config = lascar_get_config(devc->usb->devhdl)))
318 switch (devc->profile->logformat) {
323 devc->sample_size = 2;
324 devc->co_high = binary32_le_to_float(devc->config + 36);
325 devc->co_low = binary32_le_to_float(devc->config + 40);
326 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
332 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
333 sr_dbg("device log contains %d samples.", devc->logged_samples);
338 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
341 struct sr_datafeed_packet packet;
342 struct sr_datafeed_header header;
343 struct sr_datafeed_meta_analog meta;
344 struct dev_context *devc;
345 struct drv_context *drvc = di->priv;
346 struct libusb_transfer *xfer_in, *xfer_out;
347 const struct libusb_pollfd **pfd;
350 unsigned char cmd[3], resp[4], *buf;
353 sr_err("Driver was not initialized.");
358 devc->cb_data = cb_data;
360 if (lascar_proc_config(sdi) != SR_OK)
363 sr_dbg("Starting log retrieval.");
365 /* Send header packet to the session bus. */
366 sr_dbg("Sending SR_DF_HEADER.");
367 packet.type = SR_DF_HEADER;
368 packet.payload = (uint8_t *)&header;
369 header.feed_version = 1;
370 sr_session_send(devc->cb_data, &packet);
372 if (devc->logged_samples == 0) {
373 /* This ensures the frontend knows the session is done. */
374 packet.type = SR_DF_END;
375 sr_session_send(devc->cb_data, &packet);
379 if (!(xfer_in = libusb_alloc_transfer(0)) ||
380 !(xfer_out = libusb_alloc_transfer(0)))
383 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
384 0x00, 0xffff, 0x00, NULL, 0, 50);
385 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
386 0x02, 0x0002, 0x00, NULL, 0, 50);
387 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
388 0x02, 0x0001, 0x00, NULL, 0, 50);
391 /* Flush input. The F321 requires this. */
392 while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp,
393 256, &ret, 5) == 0 && ret > 0)
396 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
397 resp, sizeof(resp), mark_xfer, 0, 10000);
398 if (libusb_submit_transfer(xfer_in) != 0) {
399 libusb_free_transfer(xfer_in);
400 libusb_free_transfer(xfer_out);
407 libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT,
408 cmd, 3, mark_xfer, 0, 100);
409 if (libusb_submit_transfer(xfer_out) != 0) {
410 libusb_free_transfer(xfer_in);
411 libusb_free_transfer(xfer_out);
417 while (!xfer_in->user_data || !xfer_out->user_data) {
419 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
421 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
422 xfer_in->user_data != GINT_TO_POINTER(1)) {
423 sr_dbg("no response to log transfer request");
424 libusb_free_transfer(xfer_in);
425 libusb_free_transfer(xfer_out);
428 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
429 sr_dbg("invalid response to log transfer request");
430 libusb_free_transfer(xfer_in);
431 libusb_free_transfer(xfer_out);
434 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
435 libusb_free_transfer(xfer_out);
437 /* Send metadata about the SR_DF_ANALOG packets to come. */
438 packet.type = SR_DF_META_ANALOG;
439 packet.payload = &meta;
441 sr_session_send(devc->cb_data, &packet);
443 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
444 for (i = 0; pfd[i]; i++) {
445 /* Handle USB events every 100ms, for decent latency. */
446 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
447 lascar_el_usb_handle_events, (void *)sdi);
448 /* We'll need to remove this fd later. */
449 devc->usbfd[i] = pfd[i]->fd;
453 buf = g_try_malloc(4096);
454 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
455 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
456 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
457 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
458 libusb_free_transfer(xfer_in);
466 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
471 sr_err("Driver was not initialized.");
475 if (sdi->status != SR_ST_ACTIVE) {
476 sr_err("Device inactive, can't stop acquisition.");
480 sdi->status = SR_ST_STOPPING;
481 /* TODO: free ongoing transfers? */
486 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
487 .name = "lascar-el-usb",
488 .longname = "Lascar EL-USB",
491 .cleanup = hw_cleanup,
493 .dev_list = hw_dev_list,
494 .dev_clear = clear_instances,
495 .dev_open = hw_dev_open,
496 .dev_close = hw_dev_close,
497 .info_get = hw_info_get,
498 .dev_config_set = hw_dev_config_set,
499 .dev_acquisition_start = hw_dev_acquisition_start,
500 .dev_acquisition_stop = hw_dev_acquisition_stop,