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/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
27 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
29 static const uint32_t scanopts[] = {
33 static const uint32_t devopts[] = {
36 SR_CONF_CONN | SR_CONF_GET,
37 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
38 SR_CONF_DATALOG | SR_CONF_GET | SR_CONF_SET,
41 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
43 return std_init(sr_ctx, di, LOG_PREFIX);
46 static GSList *scan(struct sr_dev_driver *di, GSList *options)
48 struct drv_context *drvc;
49 struct sr_dev_inst *sdi;
50 struct sr_usb_dev_inst *usb;
51 struct sr_config *src;
52 GSList *usb_devices, *devices, *l;
58 for (l = options; l; l = l->next) {
62 conn = g_variant_get_string(src->data, NULL);
70 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
71 /* We have a list of sr_usb_dev_inst matching the connection
72 * string. Wrap them in sr_dev_inst and we're done. */
73 for (l = usb_devices; l; l = l->next) {
75 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
76 /* Not a Lascar EL-USB. */
80 sdi->inst_type = SR_INST_USB;
82 drvc->instances = g_slist_append(drvc->instances, sdi);
83 devices = g_slist_append(devices, sdi);
85 g_slist_free(usb_devices);
87 g_slist_free_full(usb_devices, g_free);
92 static GSList *dev_list(const struct sr_dev_driver *di)
94 return ((struct drv_context *)(di->context))->instances;
97 static int dev_open(struct sr_dev_inst *sdi)
99 struct sr_dev_driver *di = sdi->driver;
100 struct drv_context *drvc;
101 struct sr_usb_dev_inst *usb;
104 if (!(drvc = di->context)) {
105 sr_err("Driver was not initialized.");
111 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
114 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
115 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
118 sdi->status = SR_ST_ACTIVE;
123 static int dev_close(struct sr_dev_inst *sdi)
125 struct sr_dev_driver *di = sdi->driver;
126 struct sr_usb_dev_inst *usb;
129 sr_err("Driver was not initialized.");
139 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
140 libusb_close(usb->devhdl);
142 sdi->status = SR_ST_INACTIVE;
147 static int cleanup(const struct sr_dev_driver *di)
150 struct drv_context *drvc;
152 if (!(drvc = di->context))
153 /* Can get called on an unused driver, doesn't matter. */
156 ret = std_dev_clear(di, NULL);
162 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
163 const struct sr_channel_group *cg)
165 struct dev_context *devc;
166 struct sr_usb_dev_inst *usb;
175 if (!sdi || !sdi->conn)
178 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
179 *data = g_variant_new_string(str);
181 case SR_CONF_DATALOG:
184 if ((ret = lascar_is_logging(sdi)) == -1)
186 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
188 case SR_CONF_LIMIT_SAMPLES:
189 *data = g_variant_new_uint64(devc->limit_samples);
198 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
199 const struct sr_channel_group *cg)
201 struct sr_dev_driver *di = sdi->driver;
202 struct dev_context *devc;
207 if (sdi->status != SR_ST_ACTIVE)
208 return SR_ERR_DEV_CLOSED;
211 sr_err("Driver was not initialized.");
218 case SR_CONF_DATALOG:
219 if (g_variant_get_boolean(data))
220 ret = lascar_start_logging(sdi);
222 ret = lascar_stop_logging(sdi);
224 case SR_CONF_LIMIT_SAMPLES:
225 devc->limit_samples = g_variant_get_uint64(data);
234 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
235 const struct sr_channel_group *cg)
241 case SR_CONF_SCAN_OPTIONS:
242 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
243 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
245 case SR_CONF_DEVICE_OPTIONS:
246 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
247 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
256 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
259 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
260 xfer->user_data = GINT_TO_POINTER(1);
262 xfer->user_data = GINT_TO_POINTER(-1);
266 /* The Lascar software, in its infinite ignorance, reads a set of four
267 * bytes from the device config struct and interprets it as a float.
268 * That only works because they only use windows, and only on x86. However
269 * we may be running on any architecture, any operating system. So we have
270 * to convert these four bytes as the Lascar software would on windows/x86,
271 * to the local representation of a float.
272 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
273 static float binary32_le_to_float(unsigned char *buf)
278 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
279 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
280 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
285 static int lascar_proc_config(const struct sr_dev_inst *sdi)
287 struct dev_context *devc;
288 struct sr_usb_dev_inst *usb;
294 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
298 switch (devc->profile->logformat) {
300 devc->sample_size = 2;
301 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
302 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
303 sr_dbg("invalid temperature unit %d", devc->temp_unit);
304 /* Default to Celsius, we're all adults here. */
307 sr_dbg("temperature unit is %s", devc->temp_unit
308 ? "Fahrenheit" : "Celsius");
311 devc->sample_size = 2;
312 devc->co_high = binary32_le_to_float(devc->config + 0x24);
313 devc->co_low = binary32_le_to_float(devc->config + 0x28);
314 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
320 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
321 sr_dbg("device log contains %d samples.", devc->logged_samples);
326 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
328 struct sr_dev_driver *di = sdi->driver;
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;
339 unsigned char cmd[3], resp[4], *buf;
341 if (sdi->status != SR_ST_ACTIVE)
342 return SR_ERR_DEV_CLOSED;
345 sr_err("Driver was not initialized.");
352 devc->cb_data = cb_data;
354 if (lascar_proc_config(sdi) != SR_OK)
357 sr_dbg("Starting log retrieval.");
359 /* Send header packet to the session bus. */
360 std_session_send_df_header(cb_data, LOG_PREFIX);
362 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
363 packet.type = SR_DF_META;
364 packet.payload = &meta;
365 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
366 meta.config = g_slist_append(NULL, src);
367 sr_session_send(devc->cb_data, &packet);
370 if (devc->logged_samples == 0) {
371 /* This ensures the frontend knows the session is done. */
372 packet.type = SR_DF_END;
373 sr_session_send(devc->cb_data, &packet);
377 if (!(xfer_in = libusb_alloc_transfer(0)) ||
378 !(xfer_out = libusb_alloc_transfer(0)))
381 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
382 0x00, 0xffff, 0x00, NULL, 0, 50);
383 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
384 0x02, 0x0002, 0x00, NULL, 0, 50);
385 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
386 0x02, 0x0001, 0x00, NULL, 0, 50);
388 /* Flush input. The F321 requires this. */
389 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
390 256, &ret, 5) == 0 && ret > 0)
393 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
394 resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
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, 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) {
415 g_usleep(SLEEP_US_LONG);
416 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
418 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
419 xfer_out->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 usb_source_add(sdi->session, drvc->sr_ctx, 100,
435 lascar_el_usb_handle_events, (void *)sdi);
437 buf = g_malloc(4096);
438 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
439 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
440 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
441 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
442 libusb_free_transfer(xfer_in);
450 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
452 struct sr_dev_driver *di = sdi->driver;
456 sr_err("Driver was not initialized.");
460 if (sdi->status != SR_ST_ACTIVE) {
461 sr_err("Device inactive, can't stop acquisition.");
465 sdi->status = SR_ST_STOPPING;
466 /* TODO: free ongoing transfers? */
471 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
472 .name = "lascar-el-usb",
473 .longname = "Lascar EL-USB",
478 .dev_list = dev_list,
480 .config_get = config_get,
481 .config_set = config_set,
482 .config_list = config_list,
483 .dev_open = dev_open,
484 .dev_close = dev_close,
485 .dev_acquisition_start = dev_acquisition_start,
486 .dev_acquisition_stop = dev_acquisition_stop,