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_driver lascar_el_usb_driver_info;
28 static const uint32_t scanopts[] = {
32 static const uint32_t devopts[] = {
35 SR_CONF_CONN | SR_CONF_GET,
36 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
37 SR_CONF_DATALOG | SR_CONF_GET | SR_CONF_SET,
40 static int init(struct sr_dev_driver *di, struct sr_context *sr_ctx)
42 return std_init(sr_ctx, di, LOG_PREFIX);
45 static GSList *scan(struct sr_dev_driver *di, GSList *options)
47 struct drv_context *drvc;
48 struct sr_dev_inst *sdi;
49 struct sr_usb_dev_inst *usb;
50 struct sr_config *src;
51 GSList *usb_devices, *devices, *l;
57 for (l = options; l; l = l->next) {
61 conn = g_variant_get_string(src->data, NULL);
69 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
70 /* We have a list of sr_usb_dev_inst matching the connection
71 * string. Wrap them in sr_dev_inst and we're done. */
72 for (l = usb_devices; l; l = l->next) {
74 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
75 /* Not a Lascar EL-USB. */
79 sdi->inst_type = SR_INST_USB;
81 drvc->instances = g_slist_append(drvc->instances, sdi);
82 devices = g_slist_append(devices, sdi);
84 g_slist_free(usb_devices);
86 g_slist_free_full(usb_devices, g_free);
91 static GSList *dev_list(const struct sr_dev_driver *di)
93 return ((struct drv_context *)(di->context))->instances;
96 static int dev_open(struct sr_dev_inst *sdi)
98 struct sr_dev_driver *di = sdi->driver;
99 struct drv_context *drvc;
100 struct sr_usb_dev_inst *usb;
103 if (!(drvc = di->context)) {
104 sr_err("Driver was not initialized.");
110 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
113 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
114 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
117 sdi->status = SR_ST_ACTIVE;
122 static int dev_close(struct sr_dev_inst *sdi)
124 struct sr_dev_driver *di = sdi->driver;
125 struct sr_usb_dev_inst *usb;
128 sr_err("Driver was not initialized.");
138 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
139 libusb_close(usb->devhdl);
141 sdi->status = SR_ST_INACTIVE;
146 static int cleanup(const struct sr_dev_driver *di)
149 struct drv_context *drvc;
151 if (!(drvc = di->context))
152 /* Can get called on an unused driver, doesn't matter. */
155 ret = std_dev_clear(di, NULL);
161 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
162 const struct sr_channel_group *cg)
164 struct dev_context *devc;
165 struct sr_usb_dev_inst *usb;
174 if (!sdi || !sdi->conn)
177 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
178 *data = g_variant_new_string(str);
180 case SR_CONF_DATALOG:
183 if ((ret = lascar_is_logging(sdi)) == -1)
185 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
187 case SR_CONF_LIMIT_SAMPLES:
188 *data = g_variant_new_uint64(devc->limit_samples);
197 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
198 const struct sr_channel_group *cg)
200 struct sr_dev_driver *di = sdi->driver;
201 struct dev_context *devc;
206 if (sdi->status != SR_ST_ACTIVE)
207 return SR_ERR_DEV_CLOSED;
210 sr_err("Driver was not initialized.");
217 case SR_CONF_DATALOG:
218 if (g_variant_get_boolean(data))
219 ret = lascar_start_logging(sdi);
221 ret = lascar_stop_logging(sdi);
223 case SR_CONF_LIMIT_SAMPLES:
224 devc->limit_samples = g_variant_get_uint64(data);
233 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
234 const struct sr_channel_group *cg)
240 case SR_CONF_SCAN_OPTIONS:
241 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
242 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
244 case SR_CONF_DEVICE_OPTIONS:
245 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
246 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
255 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
258 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
259 xfer->user_data = GINT_TO_POINTER(1);
261 xfer->user_data = GINT_TO_POINTER(-1);
265 /* The Lascar software, in its infinite ignorance, reads a set of four
266 * bytes from the device config struct and interprets it as a float.
267 * That only works because they only use windows, and only on x86. However
268 * we may be running on any architecture, any operating system. So we have
269 * to convert these four bytes as the Lascar software would on windows/x86,
270 * to the local representation of a float.
271 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
272 static float binary32_le_to_float(unsigned char *buf)
277 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
278 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
279 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
284 static int lascar_proc_config(const struct sr_dev_inst *sdi)
286 struct dev_context *devc;
287 struct sr_usb_dev_inst *usb;
293 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
297 switch (devc->profile->logformat) {
299 devc->sample_size = 2;
300 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
301 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
302 sr_dbg("invalid temperature unit %d", devc->temp_unit);
303 /* Default to Celsius, we're all adults here. */
306 sr_dbg("temperature unit is %s", devc->temp_unit
307 ? "Fahrenheit" : "Celsius");
310 devc->sample_size = 2;
311 devc->co_high = binary32_le_to_float(devc->config + 0x24);
312 devc->co_low = binary32_le_to_float(devc->config + 0x28);
313 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
319 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
320 sr_dbg("device log contains %d samples.", devc->logged_samples);
325 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
327 struct sr_dev_driver *di = sdi->driver;
328 struct sr_datafeed_packet packet;
329 struct sr_datafeed_meta meta;
330 struct sr_config *src;
331 struct dev_context *devc;
332 struct drv_context *drvc;
333 struct sr_usb_dev_inst *usb;
334 struct libusb_transfer *xfer_in, *xfer_out;
338 unsigned char cmd[3], resp[4], *buf;
340 if (sdi->status != SR_ST_ACTIVE)
341 return SR_ERR_DEV_CLOSED;
344 sr_err("Driver was not initialized.");
351 devc->cb_data = cb_data;
353 if (lascar_proc_config(sdi) != SR_OK)
356 sr_dbg("Starting log retrieval.");
358 /* Send header packet to the session bus. */
359 std_session_send_df_header(cb_data, LOG_PREFIX);
361 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
362 packet.type = SR_DF_META;
363 packet.payload = &meta;
364 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
365 meta.config = g_slist_append(NULL, src);
366 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(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
381 0x00, 0xffff, 0x00, NULL, 0, 50);
382 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
383 0x02, 0x0002, 0x00, NULL, 0, 50);
384 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
385 0x02, 0x0001, 0x00, NULL, 0, 50);
387 /* Flush input. The F321 requires this. */
388 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
389 256, &ret, 5) == 0 && ret > 0)
392 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
393 resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
394 if (libusb_submit_transfer(xfer_in) != 0) {
395 libusb_free_transfer(xfer_in);
396 libusb_free_transfer(xfer_out);
403 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
404 cmd, 3, mark_xfer, 0, 100);
405 if (libusb_submit_transfer(xfer_out) != 0) {
406 libusb_free_transfer(xfer_in);
407 libusb_free_transfer(xfer_out);
413 while (!xfer_in->user_data || !xfer_out->user_data) {
414 g_usleep(SLEEP_US_LONG);
415 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
417 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
418 xfer_in->user_data != GINT_TO_POINTER(1)) {
419 sr_dbg("no response to log transfer request");
420 libusb_free_transfer(xfer_in);
421 libusb_free_transfer(xfer_out);
424 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
425 sr_dbg("invalid response to log transfer request");
426 libusb_free_transfer(xfer_in);
427 libusb_free_transfer(xfer_out);
430 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
431 libusb_free_transfer(xfer_out);
433 usb_source_add(sdi->session, drvc->sr_ctx, 100,
434 lascar_el_usb_handle_events, (void *)sdi);
436 buf = g_malloc(4096);
437 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
438 buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
439 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
440 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
441 libusb_free_transfer(xfer_in);
449 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
451 struct sr_dev_driver *di = sdi->driver;
455 sr_err("Driver was not initialized.");
459 if (sdi->status != SR_ST_ACTIVE) {
460 sr_err("Device inactive, can't stop acquisition.");
464 sdi->status = SR_ST_STOPPING;
465 /* TODO: free ongoing transfers? */
470 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
471 .name = "lascar-el-usb",
472 .longname = "Lascar EL-USB",
477 .dev_list = dev_list,
479 .config_get = config_get,
480 .config_set = config_set,
481 .config_list = config_list,
482 .dev_open = dev_open,
483 .dev_close = dev_close,
484 .dev_acquisition_start = dev_acquisition_start,
485 .dev_acquisition_stop = dev_acquisition_stop,