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 int32_t hwopts[] = {
35 static const int32_t hwcaps[] = {
39 SR_CONF_LIMIT_SAMPLES,
42 /* Properly close and free all devices. */
43 static int clear_instances(void)
45 struct sr_dev_inst *sdi;
46 struct drv_context *drvc;
47 struct dev_context *devc;
50 if (!(drvc = di->priv))
53 for (l = drvc->instances; l; l = l->next) {
56 if (!(devc = sdi->priv))
60 sr_usb_dev_inst_free(sdi->conn);
61 sr_dev_inst_free(sdi);
64 g_slist_free(drvc->instances);
65 drvc->instances = NULL;
70 static int hw_init(struct sr_context *sr_ctx)
72 return std_hw_init(sr_ctx, di, LOG_PREFIX);
75 static GSList *hw_scan(GSList *options)
77 struct drv_context *drvc;
78 struct sr_dev_inst *sdi;
79 struct sr_usb_dev_inst *usb;
80 struct sr_config *src;
81 GSList *usb_devices, *devices, *l;
89 for (l = options; l; l = l->next) {
93 conn = g_variant_get_string(src->data, NULL);
101 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
102 /* We have a list of sr_usb_dev_inst matching the connection
103 * string. Wrap them in sr_dev_inst and we're done. */
104 for (l = usb_devices; l; l = l->next) {
106 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
107 /* Not a Lascar EL-USB. */
111 sdi->inst_type = SR_INST_USB;
113 drvc->instances = g_slist_append(drvc->instances, sdi);
114 devices = g_slist_append(devices, sdi);
116 g_slist_free(usb_devices);
118 g_slist_free_full(usb_devices, g_free);
123 static GSList *hw_dev_list(void)
125 return ((struct drv_context *)(di->priv))->instances;
128 static int hw_dev_open(struct sr_dev_inst *sdi)
130 struct drv_context *drvc;
131 struct sr_usb_dev_inst *usb;
134 if (!(drvc = di->priv)) {
135 sr_err("Driver was not initialized.");
141 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
144 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
145 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
148 sdi->status = SR_ST_ACTIVE;
153 static int hw_dev_close(struct sr_dev_inst *sdi)
155 struct sr_usb_dev_inst *usb;
158 sr_err("Driver was not initialized.");
168 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
169 libusb_close(usb->devhdl);
171 sdi->status = SR_ST_INACTIVE;
176 static int hw_cleanup(void)
178 struct drv_context *drvc;
180 if (!(drvc = di->priv))
181 /* Can get called on an unused driver, doesn't matter. */
191 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
193 struct dev_context *devc;
194 struct sr_usb_dev_inst *usb;
201 if (!sdi || !sdi->conn)
204 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
205 *data = g_variant_new_string(str);
207 case SR_CONF_DATALOG:
210 if ((ret = lascar_is_logging(sdi)) == -1)
212 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
214 case SR_CONF_LIMIT_SAMPLES:
215 *data = g_variant_new_uint64(devc->limit_samples);
224 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
226 struct dev_context *devc;
229 if (sdi->status != SR_ST_ACTIVE)
230 return SR_ERR_DEV_CLOSED;
233 sr_err("Driver was not initialized.");
240 case SR_CONF_DATALOG:
241 if (g_variant_get_boolean(data)) {
243 ret = lascar_start_logging(sdi);
246 ret = lascar_stop_logging(sdi);
249 case SR_CONF_LIMIT_SAMPLES:
250 devc->limit_samples = g_variant_get_uint64(data);
251 sr_dbg("Setting sample limit to %" PRIu64 ".",
252 devc->limit_samples);
261 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
267 case SR_CONF_SCAN_OPTIONS:
268 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
269 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
271 case SR_CONF_DEVICE_OPTIONS:
272 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
273 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
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;
314 struct sr_usb_dev_inst *usb;
320 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
324 switch (devc->profile->logformat) {
326 devc->sample_size = 2;
327 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
328 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
329 sr_dbg("invalid temperature unit %d", devc->temp_unit);
330 /* Default to Celcius, we're all adults here. */
333 sr_dbg("temperature unit is %s", devc->temp_unit
334 ? "Fahrenheit" : "Celcius");
337 devc->sample_size = 2;
338 devc->co_high = binary32_le_to_float(devc->config + 0x24);
339 devc->co_low = binary32_le_to_float(devc->config + 0x28);
340 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
346 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
347 sr_dbg("device log contains %d samples.", devc->logged_samples);
352 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
355 struct sr_datafeed_packet packet;
356 struct sr_datafeed_meta meta;
357 struct sr_config *src;
358 struct dev_context *devc;
359 struct drv_context *drvc;
360 struct sr_usb_dev_inst *usb;
361 struct libusb_transfer *xfer_in, *xfer_out;
362 const struct libusb_pollfd **pfd;
366 unsigned char cmd[3], resp[4], *buf;
368 if (sdi->status != SR_ST_ACTIVE)
369 return SR_ERR_DEV_CLOSED;
372 sr_err("Driver was not initialized.");
379 devc->cb_data = cb_data;
381 if (lascar_proc_config(sdi) != SR_OK)
384 sr_dbg("Starting log retrieval.");
386 /* Send header packet to the session bus. */
387 std_session_send_df_header(cb_data, LOG_PREFIX);
389 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
390 packet.type = SR_DF_META;
391 packet.payload = &meta;
392 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
393 meta.config = g_slist_append(NULL, src);
394 sr_session_send(devc->cb_data, &packet);
397 if (devc->logged_samples == 0) {
398 /* This ensures the frontend knows the session is done. */
399 packet.type = SR_DF_END;
400 sr_session_send(devc->cb_data, &packet);
404 if (!(xfer_in = libusb_alloc_transfer(0)) ||
405 !(xfer_out = libusb_alloc_transfer(0)))
408 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
409 0x00, 0xffff, 0x00, NULL, 0, 50);
410 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
411 0x02, 0x0002, 0x00, NULL, 0, 50);
412 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
413 0x02, 0x0001, 0x00, NULL, 0, 50);
416 /* Flush input. The F321 requires this. */
417 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
418 256, &ret, 5) == 0 && ret > 0)
421 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
422 resp, sizeof(resp), mark_xfer, 0, 10000);
423 if (libusb_submit_transfer(xfer_in) != 0) {
424 libusb_free_transfer(xfer_in);
425 libusb_free_transfer(xfer_out);
432 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
433 cmd, 3, mark_xfer, 0, 100);
434 if (libusb_submit_transfer(xfer_out) != 0) {
435 libusb_free_transfer(xfer_in);
436 libusb_free_transfer(xfer_out);
442 while (!xfer_in->user_data || !xfer_out->user_data) {
444 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
446 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
447 xfer_in->user_data != GINT_TO_POINTER(1)) {
448 sr_dbg("no response to log transfer request");
449 libusb_free_transfer(xfer_in);
450 libusb_free_transfer(xfer_out);
453 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
454 sr_dbg("invalid response to log transfer request");
455 libusb_free_transfer(xfer_in);
456 libusb_free_transfer(xfer_out);
459 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
460 libusb_free_transfer(xfer_out);
462 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
463 for (i = 0; pfd[i]; i++) {
464 /* Handle USB events every 100ms, for decent latency. */
465 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
466 lascar_el_usb_handle_events, (void *)sdi);
467 /* We'll need to remove this fd later. */
468 devc->usbfd[i] = pfd[i]->fd;
472 buf = g_try_malloc(4096);
473 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
474 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
475 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
476 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
477 libusb_free_transfer(xfer_in);
485 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
490 sr_err("Driver was not initialized.");
494 if (sdi->status != SR_ST_ACTIVE) {
495 sr_err("Device inactive, can't stop acquisition.");
499 sdi->status = SR_ST_STOPPING;
500 /* TODO: free ongoing transfers? */
505 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
506 .name = "lascar-el-usb",
507 .longname = "Lascar EL-USB",
510 .cleanup = hw_cleanup,
512 .dev_list = hw_dev_list,
513 .dev_clear = clear_instances,
514 .config_get = config_get,
515 .config_set = config_set,
516 .config_list = config_list,
517 .dev_open = hw_dev_open,
518 .dev_close = hw_dev_close,
519 .dev_acquisition_start = hw_dev_acquisition_start,
520 .dev_acquisition_stop = hw_dev_acquisition_stop,