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 drvopts[] = {
36 static const uint32_t devopts[] = {
37 SR_CONF_CONN | SR_CONF_GET,
38 SR_CONF_LIMIT_SAMPLES | SR_CONF_GET | SR_CONF_SET,
39 SR_CONF_DATALOG | SR_CONF_GET | SR_CONF_SET,
42 static GSList *scan(struct sr_dev_driver *di, GSList *options)
44 struct drv_context *drvc;
45 struct sr_dev_inst *sdi;
46 struct sr_usb_dev_inst *usb;
47 struct sr_config *src;
48 GSList *usb_devices, *devices, *l;
54 for (l = options; l; l = l->next) {
58 conn = g_variant_get_string(src->data, NULL);
66 if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
67 /* We have a list of sr_usb_dev_inst matching the connection
68 * string. Wrap them in sr_dev_inst and we're done. */
69 for (l = usb_devices; l; l = l->next) {
71 if (!(sdi = lascar_scan(usb->bus, usb->address))) {
72 /* Not a Lascar EL-USB. */
76 sdi->inst_type = SR_INST_USB;
78 devices = g_slist_append(devices, sdi);
80 g_slist_free(usb_devices);
82 g_slist_free_full(usb_devices, g_free);
84 return std_scan_complete(di, devices);
87 static int dev_open(struct sr_dev_inst *sdi)
89 struct sr_dev_driver *di = sdi->driver;
90 struct drv_context *drvc = di->context;;
91 struct sr_usb_dev_inst *usb;
96 if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
99 if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
100 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
107 static int dev_close(struct sr_dev_inst *sdi)
109 struct sr_usb_dev_inst *usb;
116 libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
117 libusb_close(usb->devhdl);
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;
170 case SR_CONF_DATALOG:
171 if (g_variant_get_boolean(data))
172 ret = lascar_start_logging(sdi);
174 ret = lascar_stop_logging(sdi);
176 case SR_CONF_LIMIT_SAMPLES:
177 devc->limit_samples = g_variant_get_uint64(data);
186 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
187 const struct sr_channel_group *cg)
189 return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
192 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
195 if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
196 xfer->user_data = GINT_TO_POINTER(1);
198 xfer->user_data = GINT_TO_POINTER(-1);
202 /* The Lascar software, in its infinite ignorance, reads a set of four
203 * bytes from the device config struct and interprets it as a float.
204 * That only works because they only use windows, and only on x86. However
205 * we may be running on any architecture, any operating system. So we have
206 * to convert these four bytes as the Lascar software would on windows/x86,
207 * to the local representation of a float.
208 * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
209 static float binary32_le_to_float(unsigned char *buf)
214 f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
215 f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
216 f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
221 static int lascar_proc_config(const struct sr_dev_inst *sdi)
223 struct dev_context *devc;
224 struct sr_usb_dev_inst *usb;
230 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
234 switch (devc->profile->logformat) {
236 devc->sample_size = 2;
237 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
238 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
239 sr_dbg("invalid temperature unit %d", devc->temp_unit);
240 /* Default to Celsius, we're all adults here. */
243 sr_dbg("temperature unit is %s", devc->temp_unit
244 ? "Fahrenheit" : "Celsius");
247 devc->sample_size = 2;
248 devc->co_high = binary32_le_to_float(devc->config + 0x24);
249 devc->co_low = binary32_le_to_float(devc->config + 0x28);
250 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
256 devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
257 sr_dbg("device log contains %d samples.", devc->logged_samples);
262 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
264 struct sr_dev_driver *di = sdi->driver;
265 struct sr_datafeed_packet packet;
266 struct sr_datafeed_meta meta;
267 struct sr_config *src;
268 struct dev_context *devc;
269 struct drv_context *drvc;
270 struct sr_usb_dev_inst *usb;
271 struct libusb_transfer *xfer_in, *xfer_out;
275 unsigned char cmd[3], resp[4], *buf;
281 if (lascar_proc_config(sdi) != SR_OK)
284 sr_dbg("Starting log retrieval.");
286 std_session_send_df_header(sdi);
288 interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
289 packet.type = SR_DF_META;
290 packet.payload = &meta;
291 src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
292 meta.config = g_slist_append(NULL, src);
293 sr_session_send(sdi, &packet);
296 if (devc->logged_samples == 0) {
297 /* This ensures the frontend knows the session is done. */
298 std_session_send_df_end(sdi);
302 if (!(xfer_in = libusb_alloc_transfer(0)) ||
303 !(xfer_out = libusb_alloc_transfer(0)))
306 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
307 0x00, 0xffff, 0x00, NULL, 0, 50);
308 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
309 0x02, 0x0002, 0x00, NULL, 0, 50);
310 libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
311 0x02, 0x0001, 0x00, NULL, 0, 50);
313 /* Flush input. The F321 requires this. */
314 while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
315 256, &ret, 5) == 0 && ret > 0)
318 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
319 resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
320 if (libusb_submit_transfer(xfer_in) != 0) {
321 libusb_free_transfer(xfer_in);
322 libusb_free_transfer(xfer_out);
329 libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
330 cmd, 3, mark_xfer, 0, 100);
331 if (libusb_submit_transfer(xfer_out) != 0) {
332 libusb_free_transfer(xfer_in);
333 libusb_free_transfer(xfer_out);
339 while (!xfer_in->user_data || !xfer_out->user_data) {
340 g_usleep(SLEEP_US_LONG);
341 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
343 if (xfer_in->user_data != GINT_TO_POINTER(1) ||
344 xfer_out->user_data != GINT_TO_POINTER(1)) {
345 sr_dbg("no response to log transfer request");
346 libusb_free_transfer(xfer_in);
347 libusb_free_transfer(xfer_out);
350 if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
351 sr_dbg("invalid response to log transfer request");
352 libusb_free_transfer(xfer_in);
353 libusb_free_transfer(xfer_out);
356 devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
357 libusb_free_transfer(xfer_out);
359 usb_source_add(sdi->session, drvc->sr_ctx, 100,
360 lascar_el_usb_handle_events, (void *)sdi);
362 buf = g_malloc(4096);
363 libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
364 buf, 4096, lascar_el_usb_receive_transfer,
365 (struct sr_dev_inst *)sdi, 100);
366 if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
367 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
368 libusb_free_transfer(xfer_in);
376 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
378 sdi->status = SR_ST_STOPPING;
379 /* TODO: free ongoing transfers? */
384 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
385 .name = "lascar-el-usb",
386 .longname = "Lascar EL-USB",
389 .cleanup = std_cleanup,
391 .dev_list = std_dev_list,
392 .dev_clear = std_dev_clear,
393 .config_get = config_get,
394 .config_set = config_set,
395 .config_list = config_list,
396 .dev_open = dev_open,
397 .dev_close = dev_close,
398 .dev_acquisition_start = dev_acquisition_start,
399 .dev_acquisition_stop = dev_acquisition_stop,
402 SR_REGISTER_DEV_DRIVER(lascar_el_usb_driver_info);