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;
30 static const int32_t hwopts[] = {
34 static const int32_t hwcaps[] = {
38 SR_CONF_LIMIT_SAMPLES,
41 static int clear_instances(void)
43 return std_dev_clear(di, NULL);
46 static int init(struct sr_context *sr_ctx)
48 return std_init(sr_ctx, di, LOG_PREFIX);
51 static GSList *scan(GSList *options)
53 struct drv_context *drvc;
54 struct sr_dev_inst *sdi;
55 struct sr_usb_dev_inst *usb;
56 struct sr_config *src;
57 GSList *usb_devices, *devices, *l;
63 for (l = options; l; l = l->next) {
67 conn = g_variant_get_string(src->data, NULL);
75 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
76 /* We have a list of sr_usb_dev_inst matching the connection
77 * string. Wrap them in sr_dev_inst and we're done. */
78 for (l = usb_devices; l; l = l->next) {
80 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
81 /* Not a Lascar EL-USB. */
85 sdi->inst_type = SR_INST_USB;
87 drvc->instances = g_slist_append(drvc->instances, sdi);
88 devices = g_slist_append(devices, sdi);
90 g_slist_free(usb_devices);
92 g_slist_free_full(usb_devices, g_free);
97 static GSList *dev_list(void)
99 return ((struct drv_context *)(di->priv))->instances;
102 static int dev_open(struct sr_dev_inst *sdi)
104 struct drv_context *drvc;
105 struct sr_usb_dev_inst *usb;
108 if (!(drvc = di->priv)) {
109 sr_err("Driver was not initialized.");
115 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
118 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
119 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
122 sdi->status = SR_ST_ACTIVE;
127 static int dev_close(struct sr_dev_inst *sdi)
129 struct sr_usb_dev_inst *usb;
132 sr_err("Driver was not initialized.");
142 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
143 libusb_close(usb->devhdl);
145 sdi->status = SR_ST_INACTIVE;
150 static int cleanup(void)
153 struct drv_context *drvc;
155 if (!(drvc = di->priv))
156 /* Can get called on an unused driver, doesn't matter. */
159 ret = clear_instances();
166 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
168 struct dev_context *devc;
169 struct sr_usb_dev_inst *usb;
176 if (!sdi || !sdi->conn)
179 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
180 *data = g_variant_new_string(str);
182 case SR_CONF_DATALOG:
185 if ((ret = lascar_is_logging(sdi)) == -1)
187 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
189 case SR_CONF_LIMIT_SAMPLES:
190 *data = g_variant_new_uint64(devc->limit_samples);
199 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
201 struct dev_context *devc;
204 if (sdi->status != SR_ST_ACTIVE)
205 return SR_ERR_DEV_CLOSED;
208 sr_err("Driver was not initialized.");
215 case SR_CONF_DATALOG:
216 if (g_variant_get_boolean(data)) {
218 ret = lascar_start_logging(sdi);
221 ret = lascar_stop_logging(sdi);
224 case SR_CONF_LIMIT_SAMPLES:
225 devc->limit_samples = g_variant_get_uint64(data);
226 sr_dbg("Setting sample limit to %" PRIu64 ".",
227 devc->limit_samples);
236 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
242 case SR_CONF_SCAN_OPTIONS:
243 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
244 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
246 case SR_CONF_DEVICE_OPTIONS:
247 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
248 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
257 static void mark_xfer(struct libusb_transfer *xfer)
260 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
261 xfer->user_data = GINT_TO_POINTER(1);
263 xfer->user_data = GINT_TO_POINTER(-1);
267 /* The Lascar software, in its infinite ignorance, reads a set of four
268 * bytes from the device config struct and interprets it as a float.
269 * That only works because they only use windows, and only on x86. However
270 * we may be running on any architecture, any operating system. So we have
271 * to convert these four bytes as the Lascar software would on windows/x86,
272 * to the local representation of a float.
273 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
274 static float binary32_le_to_float(unsigned char *buf)
279 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
280 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
281 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
286 static int lascar_proc_config(const struct sr_dev_inst *sdi)
288 struct dev_context *devc;
289 struct sr_usb_dev_inst *usb;
295 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
299 switch (devc->profile->logformat) {
301 devc->sample_size = 2;
302 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
303 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
304 sr_dbg("invalid temperature unit %d", devc->temp_unit);
305 /* Default to Celcius, we're all adults here. */
308 sr_dbg("temperature unit is %s", devc->temp_unit
309 ? "Fahrenheit" : "Celcius");
312 devc->sample_size = 2;
313 devc->co_high = binary32_le_to_float(devc->config + 0x24);
314 devc->co_low = binary32_le_to_float(devc->config + 0x28);
315 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
321 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
322 sr_dbg("device log contains %d samples.", devc->logged_samples);
327 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
329 struct sr_datafeed_packet packet;
330 struct sr_datafeed_meta meta;
331 struct sr_config *src;
332 struct dev_context *devc;
333 struct drv_context *drvc;
334 struct sr_usb_dev_inst *usb;
335 struct libusb_transfer *xfer_in, *xfer_out;
336 const struct libusb_pollfd **pfd;
340 unsigned char cmd[3], resp[4], *buf;
342 if (sdi->status != SR_ST_ACTIVE)
343 return SR_ERR_DEV_CLOSED;
346 sr_err("Driver was not initialized.");
353 devc->cb_data = cb_data;
355 if (lascar_proc_config(sdi) != SR_OK)
358 sr_dbg("Starting log retrieval.");
360 /* Send header packet to the session bus. */
361 std_session_send_df_header(cb_data, LOG_PREFIX);
363 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
364 packet.type = SR_DF_META;
365 packet.payload = &meta;
366 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
367 meta.config = g_slist_append(NULL, src);
368 sr_session_send(devc->cb_data, &packet);
371 if (devc->logged_samples == 0) {
372 /* This ensures the frontend knows the session is done. */
373 packet.type = SR_DF_END;
374 sr_session_send(devc->cb_data, &packet);
378 if (!(xfer_in = libusb_alloc_transfer(0)) ||
379 !(xfer_out = libusb_alloc_transfer(0)))
382 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
383 0x00, 0xffff, 0x00, NULL, 0, 50);
384 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
385 0x02, 0x0002, 0x00, NULL, 0, 50);
386 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
387 0x02, 0x0001, 0x00, NULL, 0, 50);
390 /* Flush input. The F321 requires this. */
391 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
392 256, &ret, 5) == 0 && ret > 0)
395 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
396 resp, sizeof(resp), mark_xfer, 0, 10000);
397 if (libusb_submit_transfer(xfer_in) != 0) {
398 libusb_free_transfer(xfer_in);
399 libusb_free_transfer(xfer_out);
406 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
407 cmd, 3, mark_xfer, 0, 100);
408 if (libusb_submit_transfer(xfer_out) != 0) {
409 libusb_free_transfer(xfer_in);
410 libusb_free_transfer(xfer_out);
416 while (!xfer_in->user_data || !xfer_out->user_data) {
418 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
420 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
421 xfer_in->user_data != GINT_TO_POINTER(1)) {
422 sr_dbg("no response to log transfer request");
423 libusb_free_transfer(xfer_in);
424 libusb_free_transfer(xfer_out);
427 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
428 sr_dbg("invalid response to log transfer request");
429 libusb_free_transfer(xfer_in);
430 libusb_free_transfer(xfer_out);
433 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
434 libusb_free_transfer(xfer_out);
436 pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
437 for (i = 0; pfd[i]; i++) {
438 /* Handle USB events every 100ms, for decent latency. */
439 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
440 lascar_el_usb_handle_events, (void *)sdi);
441 /* We'll need to remove this fd later. */
442 devc->usbfd[i] = pfd[i]->fd;
446 buf = g_try_malloc(4096);
447 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
448 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
449 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
450 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
451 libusb_free_transfer(xfer_in);
459 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
464 sr_err("Driver was not initialized.");
468 if (sdi->status != SR_ST_ACTIVE) {
469 sr_err("Device inactive, can't stop acquisition.");
473 sdi->status = SR_ST_STOPPING;
474 /* TODO: free ongoing transfers? */
479 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
480 .name = "lascar-el-usb",
481 .longname = "Lascar EL-USB",
486 .dev_list = dev_list,
487 .dev_clear = clear_instances,
488 .config_get = config_get,
489 .config_set = config_set,
490 .config_list = config_list,
491 .dev_open = dev_open,
492 .dev_close = dev_close,
493 .dev_acquisition_start = dev_acquisition_start,
494 .dev_acquisition_stop = dev_acquisition_stop,