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 static const uint32_t scanopts[] = {
31 static const uint32_t devopts[] = {
34 SR_CONF_CONN | SR_CONF_GET,
35 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
36 SR_CONF_DATALOG | SR_CONF_GET | SR_CONF_SET,
39 static GSList *scan(struct sr_dev_driver *di, GSList *options)
41 struct drv_context *drvc;
42 struct sr_dev_inst *sdi;
43 struct sr_usb_dev_inst *usb;
44 struct sr_config *src;
45 GSList *usb_devices, *devices, *l;
51 for (l = options; l; l = l->next) {
55 conn = g_variant_get_string(src->data, NULL);
63 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
64 /* We have a list of sr_usb_dev_inst matching the connection
65 * string. Wrap them in sr_dev_inst and we're done. */
66 for (l = usb_devices; l; l = l->next) {
68 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
69 /* Not a Lascar EL-USB. */
73 sdi->inst_type = SR_INST_USB;
75 devices = g_slist_append(devices, sdi);
77 g_slist_free(usb_devices);
79 g_slist_free_full(usb_devices, g_free);
81 return std_scan_complete(di, devices);
84 static int dev_open(struct sr_dev_inst *sdi)
86 struct sr_dev_driver *di = sdi->driver;
87 struct drv_context *drvc = di->context;;
88 struct sr_usb_dev_inst *usb;
93 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
96 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
97 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
100 sdi->status = SR_ST_ACTIVE;
105 static int dev_close(struct sr_dev_inst *sdi)
107 struct sr_usb_dev_inst *usb;
115 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
116 libusb_close(usb->devhdl);
118 sdi->status = SR_ST_INACTIVE;
123 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
124 const struct sr_channel_group *cg)
126 struct dev_context *devc;
127 struct sr_usb_dev_inst *usb;
136 if (!sdi || !sdi->conn)
139 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
140 *data = g_variant_new_string(str);
142 case SR_CONF_DATALOG:
145 if ((ret = lascar_is_logging(sdi)) == -1)
147 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
149 case SR_CONF_LIMIT_SAMPLES:
150 *data = g_variant_new_uint64(devc->limit_samples);
159 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
160 const struct sr_channel_group *cg)
162 struct dev_context *devc;
167 if (sdi->status != SR_ST_ACTIVE)
168 return SR_ERR_DEV_CLOSED;
173 case SR_CONF_DATALOG:
174 if (g_variant_get_boolean(data))
175 ret = lascar_start_logging(sdi);
177 ret = lascar_stop_logging(sdi);
179 case SR_CONF_LIMIT_SAMPLES:
180 devc->limit_samples = g_variant_get_uint64(data);
189 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
190 const struct sr_channel_group *cg)
196 case SR_CONF_SCAN_OPTIONS:
197 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
198 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
200 case SR_CONF_DEVICE_OPTIONS:
201 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
202 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
211 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
214 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
215 xfer->user_data = GINT_TO_POINTER(1);
217 xfer->user_data = GINT_TO_POINTER(-1);
221 /* The Lascar software, in its infinite ignorance, reads a set of four
222 * bytes from the device config struct and interprets it as a float.
223 * That only works because they only use windows, and only on x86. However
224 * we may be running on any architecture, any operating system. So we have
225 * to convert these four bytes as the Lascar software would on windows/x86,
226 * to the local representation of a float.
227 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
228 static float binary32_le_to_float(unsigned char *buf)
233 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
234 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
235 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
240 static int lascar_proc_config(const struct sr_dev_inst *sdi)
242 struct dev_context *devc;
243 struct sr_usb_dev_inst *usb;
249 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
253 switch (devc->profile->logformat) {
255 devc->sample_size = 2;
256 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
257 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
258 sr_dbg("invalid temperature unit %d", devc->temp_unit);
259 /* Default to Celsius, we're all adults here. */
262 sr_dbg("temperature unit is %s", devc->temp_unit
263 ? "Fahrenheit" : "Celsius");
266 devc->sample_size = 2;
267 devc->co_high = binary32_le_to_float(devc->config + 0x24);
268 devc->co_low = binary32_le_to_float(devc->config + 0x28);
269 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
275 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
276 sr_dbg("device log contains %d samples.", devc->logged_samples);
281 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
283 struct sr_dev_driver *di = sdi->driver;
284 struct sr_datafeed_packet packet;
285 struct sr_datafeed_meta meta;
286 struct sr_config *src;
287 struct dev_context *devc;
288 struct drv_context *drvc;
289 struct sr_usb_dev_inst *usb;
290 struct libusb_transfer *xfer_in, *xfer_out;
294 unsigned char cmd[3], resp[4], *buf;
296 if (sdi->status != SR_ST_ACTIVE)
297 return SR_ERR_DEV_CLOSED;
303 if (lascar_proc_config(sdi) != SR_OK)
306 sr_dbg("Starting log retrieval.");
308 std_session_send_df_header(sdi);
310 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
311 packet.type = SR_DF_META;
312 packet.payload = &meta;
313 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
314 meta.config = g_slist_append(NULL, src);
315 sr_session_send(sdi, &packet);
318 if (devc->logged_samples == 0) {
319 /* This ensures the frontend knows the session is done. */
320 std_session_send_df_end(sdi);
324 if (!(xfer_in = libusb_alloc_transfer(0)) ||
325 !(xfer_out = libusb_alloc_transfer(0)))
328 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
329 0x00, 0xffff, 0x00, NULL, 0, 50);
330 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
331 0x02, 0x0002, 0x00, NULL, 0, 50);
332 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
333 0x02, 0x0001, 0x00, NULL, 0, 50);
335 /* Flush input. The F321 requires this. */
336 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
337 256, &ret, 5) == 0 && ret > 0)
340 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
341 resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
342 if (libusb_submit_transfer(xfer_in) != 0) {
343 libusb_free_transfer(xfer_in);
344 libusb_free_transfer(xfer_out);
351 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
352 cmd, 3, mark_xfer, 0, 100);
353 if (libusb_submit_transfer(xfer_out) != 0) {
354 libusb_free_transfer(xfer_in);
355 libusb_free_transfer(xfer_out);
361 while (!xfer_in->user_data || !xfer_out->user_data) {
362 g_usleep(SLEEP_US_LONG);
363 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
365 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
366 xfer_out->user_data != GINT_TO_POINTER(1)) {
367 sr_dbg("no response to log transfer request");
368 libusb_free_transfer(xfer_in);
369 libusb_free_transfer(xfer_out);
372 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
373 sr_dbg("invalid response to log transfer request");
374 libusb_free_transfer(xfer_in);
375 libusb_free_transfer(xfer_out);
378 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
379 libusb_free_transfer(xfer_out);
381 usb_source_add(sdi->session, drvc->sr_ctx, 100,
382 lascar_el_usb_handle_events, (void *)sdi);
384 buf = g_malloc(4096);
385 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
386 buf, 4096, lascar_el_usb_receive_transfer,
387 (struct sr_dev_inst *)sdi, 100);
388 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
389 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
390 libusb_free_transfer(xfer_in);
398 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi)
400 if (sdi->status != SR_ST_ACTIVE) {
401 sr_err("Device inactive, can't stop acquisition.");
405 sdi->status = SR_ST_STOPPING;
406 /* TODO: free ongoing transfers? */
411 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
412 .name = "lascar-el-usb",
413 .longname = "Lascar EL-USB",
416 .cleanup = std_cleanup,
418 .dev_list = std_dev_list,
420 .config_get = config_get,
421 .config_set = config_set,
422 .config_list = config_list,
423 .dev_open = dev_open,
424 .dev_close = dev_close,
425 .dev_acquisition_start = dev_acquisition_start,
426 .dev_acquisition_stop = dev_acquisition_stop,
429 SR_REGISTER_DEV_DRIVER(lascar_el_usb_driver_info);