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 /* Properly close and free all devices. */
44 static int clear_instances(void)
46 struct sr_dev_inst *sdi;
47 struct drv_context *drvc;
48 struct dev_context *devc;
51 if (!(drvc = di->priv))
54 for (l = drvc->instances; l; l = l->next) {
57 if (!(devc = sdi->priv))
61 sr_usb_dev_inst_free(devc->usb);
62 sr_dev_inst_free(sdi);
65 g_slist_free(drvc->instances);
66 drvc->instances = NULL;
71 static int hw_init(struct sr_context *sr_ctx)
73 struct drv_context *drvc;
75 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
76 sr_err("Driver context malloc failed.");
80 drvc->sr_ctx = sr_ctx;
86 static GSList *hw_scan(GSList *options)
88 struct drv_context *drvc;
89 struct dev_context *devc;
90 struct sr_dev_inst *sdi;
91 struct sr_usb_dev_inst *usb;
93 GSList *usb_devices, *devices, *l;
98 if (!(drvc = di->priv)) {
99 sr_err("Driver was not initialized.");
103 /* USB scan is always authoritative. */
107 for (l = options; l; l = l->next) {
109 switch (opt->hwopt) {
119 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
120 /* We have a list of sr_usb_dev_inst matching the connection
121 * string. Wrap them in sr_dev_inst and we're done. */
122 for (l = usb_devices; l; l = l->next) {
124 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
125 /* Not a Lascar EL-USB. */
131 drvc->instances = g_slist_append(drvc->instances, sdi);
132 devices = g_slist_append(devices, sdi);
134 g_slist_free(usb_devices);
136 g_slist_free_full(usb_devices, g_free);
141 static GSList *hw_dev_list(void)
143 struct drv_context *drvc;
145 if (!(drvc = di->priv)) {
146 sr_err("Driver was not initialized.");
150 return drvc->instances;
153 static int hw_dev_open(struct sr_dev_inst *sdi)
155 struct drv_context *drvc;
156 struct dev_context *devc;
159 if (!(drvc = di->priv)) {
160 sr_err("Driver was not initialized.");
165 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK)
168 if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) {
169 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
172 sdi->status = SR_ST_ACTIVE;
177 static int hw_dev_close(struct sr_dev_inst *sdi)
179 struct dev_context *devc;
182 sr_err("Driver was not initialized.");
187 if (!devc->usb->devhdl)
191 libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE);
192 libusb_close(devc->usb->devhdl);
193 devc->usb->devhdl = NULL;
194 g_free(devc->config);
195 sdi->status = SR_ST_INACTIVE;
201 static int hw_cleanup(void)
203 struct drv_context *drvc;
205 if (!(drvc = di->priv))
206 /* Can get called on an unused driver, doesn't matter. */
216 static int hw_info_get(int info_id, const void **data,
217 const struct sr_dev_inst *sdi)
230 sr_err("Unknown info_id: %d.", info_id);
237 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
240 struct dev_context *devc;
244 sr_err("Driver was not initialized.");
247 if (sdi->status != SR_ST_ACTIVE) {
248 sr_err("Device inactive, can't set config options.");
255 case SR_HWCAP_LIMIT_SAMPLES:
256 devc->limit_samples = *(const uint64_t *)value;
257 sr_dbg("Setting sample limit to %" PRIu64 ".",
258 devc->limit_samples);
261 sr_err("Unknown hardware capability: %d.", hwcap);
268 static void mark_xfer(struct libusb_transfer *xfer)
271 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
272 xfer->user_data = GINT_TO_POINTER(1);
274 xfer->user_data = GINT_TO_POINTER(-1);
278 /* The Lascar software, in its infinite ignorance, reads a set of four
279 * bytes from the device config struct and interprets it as a float.
280 * That only works because they only use windows, and only on x86. However
281 * we may be running on any architecture, any operating system. So we have
282 * to convert these four bytes as the Lascar software would on windows/x86,
283 * to the local representation of a float.
284 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
285 static float binary32_le_to_float(unsigned char *buf)
290 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
291 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
292 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
297 static int lascar_proc_config(const struct sr_dev_inst *sdi)
299 struct dev_context *devc;
303 if (!(devc->config = lascar_get_config(devc->usb->devhdl)))
307 switch (devc->profile->logformat) {
309 devc->sample_size = 2;
310 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
311 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
312 sr_dbg("invalid temperature unit %d", devc->temp_unit);
313 /* Default to Celcius, we're all adults here. */
316 sr_dbg("temperature unit is %s", devc->temp_unit
317 ? "Fahrenheit" : "Celcius");
320 devc->sample_size = 2;
321 devc->co_high = binary32_le_to_float(devc->config + 0x24);
322 devc->co_low = binary32_le_to_float(devc->config + 0x28);
323 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
329 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
330 sr_dbg("device log contains %d samples.", devc->logged_samples);
335 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
338 struct sr_datafeed_packet packet;
339 struct sr_datafeed_header header;
340 struct sr_datafeed_meta_analog meta;
341 struct dev_context *devc;
342 struct drv_context *drvc = di->priv;
343 struct libusb_transfer *xfer_in, *xfer_out;
344 const struct libusb_pollfd **pfd;
347 unsigned char cmd[3], resp[4], *buf;
350 sr_err("Driver was not initialized.");
355 devc->cb_data = cb_data;
357 if (lascar_proc_config(sdi) != SR_OK)
360 sr_dbg("Starting log retrieval.");
362 /* Send header packet to the session bus. */
363 sr_dbg("Sending SR_DF_HEADER.");
364 packet.type = SR_DF_HEADER;
365 packet.payload = (uint8_t *)&header;
366 header.feed_version = 1;
367 sr_session_send(devc->cb_data, &packet);
369 if (devc->logged_samples == 0) {
370 /* This ensures the frontend knows the session is done. */
371 packet.type = SR_DF_END;
372 sr_session_send(devc->cb_data, &packet);
376 if (!(xfer_in = libusb_alloc_transfer(0)) ||
377 !(xfer_out = libusb_alloc_transfer(0)))
380 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
381 0x00, 0xffff, 0x00, NULL, 0, 50);
382 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
383 0x02, 0x0002, 0x00, NULL, 0, 50);
384 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
385 0x02, 0x0001, 0x00, NULL, 0, 50);
388 /* Flush input. The F321 requires this. */
389 while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp,
390 256, &ret, 5) == 0 && ret > 0)
393 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
394 resp, sizeof(resp), mark_xfer, 0, 10000);
395 if (libusb_submit_transfer(xfer_in) != 0) {
396 libusb_free_transfer(xfer_in);
397 libusb_free_transfer(xfer_out);
404 libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT,
405 cmd, 3, mark_xfer, 0, 100);
406 if (libusb_submit_transfer(xfer_out) != 0) {
407 libusb_free_transfer(xfer_in);
408 libusb_free_transfer(xfer_out);
414 while (!xfer_in->user_data || !xfer_out->user_data) {
416 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
418 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
419 xfer_in->user_data != GINT_TO_POINTER(1)) {
420 sr_dbg("no response to log transfer request");
421 libusb_free_transfer(xfer_in);
422 libusb_free_transfer(xfer_out);
425 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
426 sr_dbg("invalid response to log transfer request");
427 libusb_free_transfer(xfer_in);
428 libusb_free_transfer(xfer_out);
431 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
432 libusb_free_transfer(xfer_out);
434 /* Send metadata about the SR_DF_ANALOG packets to come. */
435 packet.type = SR_DF_META_ANALOG;
436 packet.payload = &meta;
438 sr_session_send(devc->cb_data, &packet);
440 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
441 for (i = 0; pfd[i]; i++) {
442 /* Handle USB events every 100ms, for decent latency. */
443 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
444 lascar_el_usb_handle_events, (void *)sdi);
445 /* We'll need to remove this fd later. */
446 devc->usbfd[i] = pfd[i]->fd;
450 buf = g_try_malloc(4096);
451 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
452 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
453 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
454 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
455 libusb_free_transfer(xfer_in);
463 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
468 sr_err("Driver was not initialized.");
472 if (sdi->status != SR_ST_ACTIVE) {
473 sr_err("Device inactive, can't stop acquisition.");
477 sdi->status = SR_ST_STOPPING;
478 /* TODO: free ongoing transfers? */
483 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
484 .name = "lascar-el-usb",
485 .longname = "Lascar EL-USB",
488 .cleanup = hw_cleanup,
490 .dev_list = hw_dev_list,
491 .dev_clear = clear_instances,
492 .dev_open = hw_dev_open,
493 .dev_close = hw_dev_close,
494 .info_get = hw_info_get,
495 .dev_config_set = hw_dev_config_set,
496 .dev_acquisition_start = hw_dev_acquisition_start,
497 .dev_acquisition_stop = hw_dev_acquisition_stop,