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));
104 static int dev_close(struct sr_dev_inst *sdi)
106 struct sr_usb_dev_inst *usb;
113 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
114 libusb_close(usb->devhdl);
120 static int config_get(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
121 const struct sr_channel_group *cg)
123 struct dev_context *devc;
124 struct sr_usb_dev_inst *usb;
133 if (!sdi || !sdi->conn)
136 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
137 *data = g_variant_new_string(str);
139 case SR_CONF_DATALOG:
142 if ((ret = lascar_is_logging(sdi)) == -1)
144 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
146 case SR_CONF_LIMIT_SAMPLES:
147 *data = g_variant_new_uint64(devc->limit_samples);
156 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
157 const struct sr_channel_group *cg)
159 struct dev_context *devc;
167 case SR_CONF_DATALOG:
168 if (g_variant_get_boolean(data))
169 ret = lascar_start_logging(sdi);
171 ret = lascar_stop_logging(sdi);
173 case SR_CONF_LIMIT_SAMPLES:
174 devc->limit_samples = g_variant_get_uint64(data);
183 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
184 const struct sr_channel_group *cg)
190 case SR_CONF_SCAN_OPTIONS:
191 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
192 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
194 case SR_CONF_DEVICE_OPTIONS:
195 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
196 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
205 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
208 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
209 xfer->user_data = GINT_TO_POINTER(1);
211 xfer->user_data = GINT_TO_POINTER(-1);
215 /* The Lascar software, in its infinite ignorance, reads a set of four
216 * bytes from the device config struct and interprets it as a float.
217 * That only works because they only use windows, and only on x86. However
218 * we may be running on any architecture, any operating system. So we have
219 * to convert these four bytes as the Lascar software would on windows/x86,
220 * to the local representation of a float.
221 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
222 static float binary32_le_to_float(unsigned char *buf)
227 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
228 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
229 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
234 static int lascar_proc_config(const struct sr_dev_inst *sdi)
236 struct dev_context *devc;
237 struct sr_usb_dev_inst *usb;
243 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
247 switch (devc->profile->logformat) {
249 devc->sample_size = 2;
250 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
251 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
252 sr_dbg("invalid temperature unit %d", devc->temp_unit);
253 /* Default to Celsius, we're all adults here. */
256 sr_dbg("temperature unit is %s", devc->temp_unit
257 ? "Fahrenheit" : "Celsius");
260 devc->sample_size = 2;
261 devc->co_high = binary32_le_to_float(devc->config + 0x24);
262 devc->co_low = binary32_le_to_float(devc->config + 0x28);
263 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
269 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
270 sr_dbg("device log contains %d samples.", devc->logged_samples);
275 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
277 struct sr_dev_driver *di = sdi->driver;
278 struct sr_datafeed_packet packet;
279 struct sr_datafeed_meta meta;
280 struct sr_config *src;
281 struct dev_context *devc;
282 struct drv_context *drvc;
283 struct sr_usb_dev_inst *usb;
284 struct libusb_transfer *xfer_in, *xfer_out;
288 unsigned char cmd[3], resp[4], *buf;
294 if (lascar_proc_config(sdi) != SR_OK)
297 sr_dbg("Starting log retrieval.");
299 std_session_send_df_header(sdi);
301 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
302 packet.type = SR_DF_META;
303 packet.payload = &meta;
304 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
305 meta.config = g_slist_append(NULL, src);
306 sr_session_send(sdi, &packet);
309 if (devc->logged_samples == 0) {
310 /* This ensures the frontend knows the session is done. */
311 std_session_send_df_end(sdi);
315 if (!(xfer_in = libusb_alloc_transfer(0)) ||
316 !(xfer_out = libusb_alloc_transfer(0)))
319 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
320 0x00, 0xffff, 0x00, NULL, 0, 50);
321 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
322 0x02, 0x0002, 0x00, NULL, 0, 50);
323 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
324 0x02, 0x0001, 0x00, NULL, 0, 50);
326 /* Flush input. The F321 requires this. */
327 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
328 256, &ret, 5) == 0 && ret > 0)
331 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
332 resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
333 if (libusb_submit_transfer(xfer_in) != 0) {
334 libusb_free_transfer(xfer_in);
335 libusb_free_transfer(xfer_out);
342 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
343 cmd, 3, mark_xfer, 0, 100);
344 if (libusb_submit_transfer(xfer_out) != 0) {
345 libusb_free_transfer(xfer_in);
346 libusb_free_transfer(xfer_out);
352 while (!xfer_in->user_data || !xfer_out->user_data) {
353 g_usleep(SLEEP_US_LONG);
354 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
356 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
357 xfer_out->user_data != GINT_TO_POINTER(1)) {
358 sr_dbg("no response to log transfer request");
359 libusb_free_transfer(xfer_in);
360 libusb_free_transfer(xfer_out);
363 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
364 sr_dbg("invalid response to log transfer request");
365 libusb_free_transfer(xfer_in);
366 libusb_free_transfer(xfer_out);
369 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
370 libusb_free_transfer(xfer_out);
372 usb_source_add(sdi->session, drvc->sr_ctx, 100,
373 lascar_el_usb_handle_events, (void *)sdi);
375 buf = g_malloc(4096);
376 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
377 buf, 4096, lascar_el_usb_receive_transfer,
378 (struct sr_dev_inst *)sdi, 100);
379 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
380 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
381 libusb_free_transfer(xfer_in);
389 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
391 sdi->status = SR_ST_STOPPING;
392 /* TODO: free ongoing transfers? */
397 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
398 .name = "lascar-el-usb",
399 .longname = "Lascar EL-USB",
402 .cleanup = std_cleanup,
404 .dev_list = std_dev_list,
406 .config_get = config_get,
407 .config_set = config_set,
408 .config_list = config_list,
409 .dev_open = dev_open,
410 .dev_close = dev_close,
411 .dev_acquisition_start = dev_acquisition_start,
412 .dev_acquisition_stop = dev_acquisition_stop,
415 SR_REGISTER_DEV_DRIVER(lascar_el_usb_driver_info);