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[] = {
40 SR_CONF_LIMIT_SAMPLES,
45 static int BOOL_TRUE = TRUE;
46 static int BOOL_FALSE = FALSE;
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 return std_hw_init(sr_ctx, di, DRIVER_LOG_DOMAIN);
81 static GSList *hw_scan(GSList *options)
83 struct drv_context *drvc;
84 struct dev_context *devc;
85 struct sr_dev_inst *sdi;
86 struct sr_usb_dev_inst *usb;
87 struct sr_config *src;
88 GSList *usb_devices, *devices, *l;
95 /* USB scan is always authoritative. */
99 for (l = options; l; l = l->next) {
111 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
112 /* We have a list of sr_usb_dev_inst matching the connection
113 * string. Wrap them in sr_dev_inst and we're done. */
114 for (l = usb_devices; l; l = l->next) {
116 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
117 /* Not a Lascar EL-USB. */
123 drvc->instances = g_slist_append(drvc->instances, sdi);
124 devices = g_slist_append(devices, sdi);
126 g_slist_free(usb_devices);
128 g_slist_free_full(usb_devices, g_free);
133 static GSList *hw_dev_list(void)
135 return ((struct drv_context *)(di->priv))->instances;
138 static int hw_dev_open(struct sr_dev_inst *sdi)
140 struct drv_context *drvc;
141 struct dev_context *devc;
144 if (!(drvc = di->priv)) {
145 sr_err("Driver was not initialized.");
150 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK)
153 if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) {
154 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
157 sdi->status = SR_ST_ACTIVE;
162 static int hw_dev_close(struct sr_dev_inst *sdi)
164 struct dev_context *devc;
167 sr_err("Driver was not initialized.");
172 if (!devc->usb->devhdl)
176 libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE);
177 libusb_close(devc->usb->devhdl);
178 devc->usb->devhdl = NULL;
179 sdi->status = SR_ST_INACTIVE;
185 static int hw_cleanup(void)
187 struct drv_context *drvc;
189 if (!(drvc = di->priv))
190 /* Can get called on an unused driver, doesn't matter. */
200 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
202 struct dev_context *devc;
207 case SR_CONF_DATALOG:
210 if ((ret = lascar_is_logging(sdi)) == -1)
212 *data = ret ? &BOOL_TRUE : &BOOL_FALSE;
214 case SR_CONF_LIMIT_SAMPLES:
215 *data = &devc->limit_samples;
224 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
226 struct dev_context *devc;
230 sr_err("Driver was not initialized.");
233 if (sdi->status != SR_ST_ACTIVE) {
234 sr_err("Device inactive, can't set config options.");
241 case SR_CONF_DATALOG:
244 ret = lascar_start_logging(sdi);
247 ret = lascar_stop_logging(sdi);
250 case SR_CONF_LIMIT_SAMPLES:
251 devc->limit_samples = *(const uint64_t *)value;
252 sr_dbg("Setting sample limit to %" PRIu64 ".",
253 devc->limit_samples);
256 sr_err("Unknown hardware capability: %d.", id);
263 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
269 case SR_CONF_SCAN_OPTIONS:
272 case SR_CONF_DEVICE_OPTIONS:
282 static void mark_xfer(struct libusb_transfer *xfer)
285 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
286 xfer->user_data = GINT_TO_POINTER(1);
288 xfer->user_data = GINT_TO_POINTER(-1);
292 /* The Lascar software, in its infinite ignorance, reads a set of four
293 * bytes from the device config struct and interprets it as a float.
294 * That only works because they only use windows, and only on x86. However
295 * we may be running on any architecture, any operating system. So we have
296 * to convert these four bytes as the Lascar software would on windows/x86,
297 * to the local representation of a float.
298 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
299 static float binary32_le_to_float(unsigned char *buf)
304 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
305 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
306 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
311 static int lascar_proc_config(const struct sr_dev_inst *sdi)
313 struct dev_context *devc;
317 if (lascar_get_config(devc->usb->devhdl, devc->config, &dummy) != SR_OK)
321 switch (devc->profile->logformat) {
323 devc->sample_size = 2;
324 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
325 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
326 sr_dbg("invalid temperature unit %d", devc->temp_unit);
327 /* Default to Celcius, we're all adults here. */
330 sr_dbg("temperature unit is %s", devc->temp_unit
331 ? "Fahrenheit" : "Celcius");
334 devc->sample_size = 2;
335 devc->co_high = binary32_le_to_float(devc->config + 0x24);
336 devc->co_low = binary32_le_to_float(devc->config + 0x28);
337 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
343 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
344 sr_dbg("device log contains %d samples.", devc->logged_samples);
349 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
352 struct sr_datafeed_packet packet;
353 struct sr_datafeed_meta meta;
354 struct sr_config *src;
355 struct dev_context *devc;
356 struct drv_context *drvc;
357 struct libusb_transfer *xfer_in, *xfer_out;
358 const struct libusb_pollfd **pfd;
362 unsigned char cmd[3], resp[4], *buf;
365 sr_err("Driver was not initialized.");
371 devc->cb_data = cb_data;
373 if (lascar_proc_config(sdi) != SR_OK)
376 sr_dbg("Starting log retrieval.");
378 /* Send header packet to the session bus. */
379 std_session_send_df_header(cb_data, DRIVER_LOG_DOMAIN);
381 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
382 packet.type = SR_DF_META;
383 packet.payload = &meta;
384 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, (const void *)&interval);
385 meta.config = g_slist_append(NULL, src);
386 sr_session_send(devc->cb_data, &packet);
389 if (devc->logged_samples == 0) {
390 /* This ensures the frontend knows the session is done. */
391 packet.type = SR_DF_END;
392 sr_session_send(devc->cb_data, &packet);
396 if (!(xfer_in = libusb_alloc_transfer(0)) ||
397 !(xfer_out = libusb_alloc_transfer(0)))
400 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
401 0x00, 0xffff, 0x00, NULL, 0, 50);
402 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
403 0x02, 0x0002, 0x00, NULL, 0, 50);
404 libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
405 0x02, 0x0001, 0x00, NULL, 0, 50);
408 /* Flush input. The F321 requires this. */
409 while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp,
410 256, &ret, 5) == 0 && ret > 0)
413 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
414 resp, sizeof(resp), mark_xfer, 0, 10000);
415 if (libusb_submit_transfer(xfer_in) != 0) {
416 libusb_free_transfer(xfer_in);
417 libusb_free_transfer(xfer_out);
424 libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT,
425 cmd, 3, mark_xfer, 0, 100);
426 if (libusb_submit_transfer(xfer_out) != 0) {
427 libusb_free_transfer(xfer_in);
428 libusb_free_transfer(xfer_out);
434 while (!xfer_in->user_data || !xfer_out->user_data) {
436 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
438 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
439 xfer_in->user_data != GINT_TO_POINTER(1)) {
440 sr_dbg("no response to log transfer request");
441 libusb_free_transfer(xfer_in);
442 libusb_free_transfer(xfer_out);
445 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
446 sr_dbg("invalid response to log transfer request");
447 libusb_free_transfer(xfer_in);
448 libusb_free_transfer(xfer_out);
451 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
452 libusb_free_transfer(xfer_out);
454 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
455 for (i = 0; pfd[i]; i++) {
456 /* Handle USB events every 100ms, for decent latency. */
457 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
458 lascar_el_usb_handle_events, (void *)sdi);
459 /* We'll need to remove this fd later. */
460 devc->usbfd[i] = pfd[i]->fd;
464 buf = g_try_malloc(4096);
465 libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
466 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
467 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
468 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
469 libusb_free_transfer(xfer_in);
477 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
482 sr_err("Driver was not initialized.");
486 if (sdi->status != SR_ST_ACTIVE) {
487 sr_err("Device inactive, can't stop acquisition.");
491 sdi->status = SR_ST_STOPPING;
492 /* TODO: free ongoing transfers? */
497 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
498 .name = "lascar-el-usb",
499 .longname = "Lascar EL-USB",
502 .cleanup = hw_cleanup,
504 .dev_list = hw_dev_list,
505 .dev_clear = clear_instances,
506 .config_get = config_get,
507 .config_set = config_set,
508 .config_list = config_list,
509 .dev_open = hw_dev_open,
510 .dev_close = hw_dev_close,
511 .dev_acquisition_start = hw_dev_acquisition_start,
512 .dev_acquisition_stop = hw_dev_acquisition_stop,