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/>.
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
30 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
31 struct sr_dev_driver *di = &lascar_el_usb_driver_info;
33 static const struct elusb_profile profiles[] = {
34 { 1, "EL-USB-1", LOG_UNSUPPORTED },
35 { 2, "EL-USB-1", LOG_UNSUPPORTED },
36 { 3, "EL-USB-2", LOG_TEMP_RH },
37 { 4, "EL-USB-3", LOG_UNSUPPORTED },
38 { 5, "EL-USB-4", LOG_UNSUPPORTED },
39 { 6, "EL-USB-3", LOG_UNSUPPORTED },
40 { 7, "EL-USB-4", LOG_UNSUPPORTED },
41 { 8, "EL-USB-LITE", LOG_UNSUPPORTED },
42 { 9, "EL-USB-CO", LOG_CO },
43 { 10, "EL-USB-TC", LOG_UNSUPPORTED },
44 { 11, "EL-USB-CO300", LOG_CO },
45 { 12, "EL-USB-2-LCD", LOG_TEMP_RH },
46 { 13, "EL-USB-2+", LOG_TEMP_RH },
47 { 14, "EL-USB-1-PRO", LOG_UNSUPPORTED },
48 { 15, "EL-USB-TC-LCD", LOG_UNSUPPORTED },
49 { 16, "EL-USB-2-LCD+", LOG_TEMP_RH },
50 { 17, "EL-USB-5", LOG_UNSUPPORTED },
51 { 18, "EL-USB-1-RCG", LOG_UNSUPPORTED },
52 { 19, "EL-USB-1-LCD", LOG_UNSUPPORTED },
53 { 20, "EL-OEM-3", LOG_UNSUPPORTED },
54 { 21, "EL-USB-1-LCD", LOG_UNSUPPORTED },
58 static libusb_device_handle *lascar_open(struct libusb_device *dev)
60 libusb_device_handle *dev_hdl;
63 if ((ret = libusb_open(dev, &dev_hdl)) != 0) {
64 sr_dbg("failed to open device for scan: %s",
65 libusb_error_name(ret));
69 /* Some of these fail, but it needs doing -- some sort of mode
70 * setup for the SiLabs F32x. */
71 libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
72 0x00, 0xffff, 0x00, NULL, 0, 50);
73 libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
74 0x02, 0x0002, 0x00, NULL, 0, 50);
75 libusb_control_transfer(dev_hdl, LIBUSB_REQUEST_TYPE_VENDOR,
76 0x02, 0x0001, 0x00, NULL, 0, 50);
81 static void LIBUSB_CALL mark_xfer(struct libusb_transfer *xfer)
84 xfer->user_data = GINT_TO_POINTER(1);
88 SR_PRIV int lascar_get_config(libusb_device_handle *dev_hdl,
89 unsigned char *configblock, int *configlen)
91 struct drv_context *drvc;
92 struct libusb_transfer *xfer_in, *xfer_out;
96 unsigned char cmd[3], buf[MAX_CONFIGBLOCK_SIZE];
98 sr_spew("Reading config block.");
103 if (!(xfer_in = libusb_alloc_transfer(0)) ||
104 !(xfer_out = libusb_alloc_transfer(0)))
107 /* Flush anything the F321 still has queued. */
108 while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
109 5) == 0 && buflen > 0)
112 /* Keep a read request waiting in the wings, ready to pounce
113 * the moment the device sends something. */
114 libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
115 buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
116 if (libusb_submit_transfer(xfer_in) != 0)
119 /* Request device configuration structure. */
123 libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
124 cmd, 3, mark_xfer, 0, 100);
125 if (libusb_submit_transfer(xfer_out) != 0)
130 start = g_get_monotonic_time();
131 while (!xfer_in->user_data || !xfer_out->user_data) {
132 if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
136 g_usleep(SLEEP_US_LONG);
137 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
140 sr_dbg("no response");
143 if (xfer_in->actual_length != 3) {
144 sr_dbg("expected 3-byte header, got %d bytes", xfer_in->actual_length);
148 /* Got configuration structure header. */
149 sr_spew("Response to config request: 0x%.2x 0x%.2x 0x%.2x ",
150 buf[0], buf[1], buf[2]);
151 buflen = buf[1] | (buf[2] << 8);
152 if (buf[0] != 0x02 || buflen > MAX_CONFIGBLOCK_SIZE) {
153 sr_dbg("Invalid response to config request: "
154 "0x%.2x 0x%.2x 0x%.2x ", buf[0], buf[1], buf[2]);
155 libusb_close(dev_hdl);
159 /* Get configuration structure. */
160 xfer_in->length = buflen;
161 xfer_in->user_data = 0;
162 if (libusb_submit_transfer(xfer_in) != 0)
164 while (!xfer_in->user_data) {
165 if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
169 g_usleep(SLEEP_US_LONG);
170 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
173 sr_dbg("Timeout waiting for configuration structure.");
176 if (xfer_in->actual_length != buflen) {
177 sr_dbg("expected %d-byte structure, got %d bytes", buflen,
178 xfer_in->actual_length);
182 memcpy(configblock, buf, buflen);
186 if (!xfer_in->user_data || !xfer_out->user_data) {
187 if (!xfer_in->user_data)
188 libusb_cancel_transfer(xfer_in);
189 if (!xfer_out->user_data)
190 libusb_cancel_transfer(xfer_out);
191 start = g_get_monotonic_time();
192 while (!xfer_in->user_data || !xfer_out->user_data) {
193 if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
195 g_usleep(SLEEP_US_SHORT);
196 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
199 libusb_free_transfer(xfer_in);
200 libusb_free_transfer(xfer_out);
202 return *configlen ? SR_OK : SR_ERR;
205 static int lascar_save_config(libusb_device_handle *dev_hdl,
206 unsigned char *config, int configlen)
208 struct drv_context *drvc;
209 struct libusb_transfer *xfer_in, *xfer_out;
213 unsigned char cmd[3], buf[256];
215 sr_spew("Writing config block.");
219 if (!(xfer_in = libusb_alloc_transfer(0)) ||
220 !(xfer_out = libusb_alloc_transfer(0)))
223 /* Flush anything the F321 still has queued. */
224 while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
225 5) == 0 && buflen > 0)
229 /* Keep a read request waiting in the wings, ready to pounce
230 * the moment the device sends something. */
231 libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
232 buf, 256, mark_xfer, 0, BULK_XFER_TIMEOUT);
233 if (libusb_submit_transfer(xfer_in) != 0) {
238 /* Request device configuration structure. */
240 cmd[1] = configlen & 0xff;
241 cmd[2] = (configlen >> 8) & 0xff;
242 libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
243 cmd, 3, mark_xfer, 0, 100);
244 if (libusb_submit_transfer(xfer_out) != 0) {
250 while (!xfer_out->user_data) {
251 g_usleep(SLEEP_US_LONG);
252 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
255 libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
256 config, configlen, mark_xfer, 0, 100);
257 if (libusb_submit_transfer(xfer_out) != 0) {
261 while (!xfer_in->user_data || !xfer_out->user_data) {
262 g_usleep(SLEEP_US_LONG);
263 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
266 if (xfer_in->actual_length != 1 || buf[0] != 0xff) {
267 sr_dbg("unexpected response after transfer");
272 if (!xfer_in->user_data || !xfer_out->user_data) {
273 if (!xfer_in->user_data)
274 libusb_cancel_transfer(xfer_in);
275 if (!xfer_out->user_data)
276 libusb_cancel_transfer(xfer_out);
277 start = g_get_monotonic_time();
278 while (!xfer_in->user_data || !xfer_out->user_data) {
279 if (g_get_monotonic_time() - start > EVENTS_TIMEOUT)
281 g_usleep(SLEEP_US_SHORT);
282 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
285 libusb_free_transfer(xfer_in);
286 libusb_free_transfer(xfer_out);
291 static struct sr_dev_inst *lascar_identify(unsigned char *config)
293 struct dev_context *devc;
294 const struct elusb_profile *profile;
295 struct sr_dev_inst *sdi;
306 for (i = 0; profiles[i].modelid; i++) {
307 if (profiles[i].modelid == modelid) {
308 profile = &profiles[i];
313 sr_dbg("unknown EL-USB modelid %d", modelid);
317 i = config[52] | (config[53] << 8);
318 memcpy(firmware, config + 0x30, 4);
320 sr_dbg("found %s with firmware version %s serial %d",
321 profile->modelname, firmware, i);
323 if (profile->logformat == LOG_UNSUPPORTED) {
324 sr_dbg("unsupported EL-USB logformat for %s", profile->modelname);
328 sdi = g_malloc0(sizeof(struct sr_dev_inst));
329 sdi->status = SR_ST_INACTIVE;
330 sdi->vendor = g_strdup("Lascar");
331 sdi->model = g_strdup(profile->modelname);
332 sdi->version = g_strdup(firmware);
334 if (profile->logformat == LOG_TEMP_RH) {
335 /* Model this as two channels: temperature and humidity. */
336 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Temp");
337 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "Hum");
338 } else if (profile->logformat == LOG_CO) {
339 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "CO");
341 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P1");
344 devc = g_malloc0(sizeof(struct dev_context));
346 devc->profile = profile;
351 SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address)
353 struct drv_context *drvc;
354 struct sr_dev_inst *sdi;
355 struct libusb_device **devlist;
356 libusb_device_handle *dev_hdl;
359 unsigned char config[MAX_CONFIGBLOCK_SIZE];
364 ret = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
368 for (i = 0; devlist[i]; i++) {
369 if (libusb_get_bus_number(devlist[i]) != bus ||
370 libusb_get_device_address(devlist[i]) != address)
373 if (!(dev_hdl = lascar_open(devlist[i])))
376 if (lascar_get_config(dev_hdl, config, &dummy) != SR_OK)
379 libusb_close(dev_hdl);
380 sdi = lascar_identify(config);
382 libusb_free_device_list(devlist, 1);
387 static void lascar_el_usb_dispatch(struct sr_dev_inst *sdi, unsigned char *buf,
390 struct dev_context *devc;
391 struct sr_datafeed_packet packet;
392 struct sr_datafeed_analog analog;
393 struct sr_analog_encoding encoding;
394 struct sr_analog_meaning meaning;
395 struct sr_analog_spec spec;
396 struct sr_channel *ch;
399 int samples, samples_left, i, j;
403 /* Note: digits/spec_digits will be overridden later. */
404 sr_analog_init(&analog, &encoding, &meaning, &spec, 0);
406 samples = buflen / devc->sample_size;
407 samples_left = devc->logged_samples - devc->rcvd_samples;
408 if (samples_left < samples)
409 samples = samples_left;
410 switch (devc->profile->logformat) {
412 packet.type = SR_DF_ANALOG;
413 packet.payload = &analog;
414 analog.meaning->mqflags = 0;
415 temp = g_try_malloc(sizeof(float) * samples);
416 rh = g_try_malloc(sizeof(float) * samples);
422 for (i = 0, j = 0; i < samples; i++) {
423 /* Both Celsius and Fahrenheit stored at base -40. */
424 if (devc->temp_unit == 0)
425 /* Celsius is stored in half-degree increments. */
426 temp[j] = buf[i * 2] / 2 - 40;
428 temp[j] = buf[i * 2] - 40;
430 rh[j] = buf[i * 2 + 1] / 2;
432 if (temp[j] == 0.0 && rh[j] == 0.0)
433 /* Skip invalid measurement. */
437 analog.num_samples = j;
439 ch = sdi->channels->data;
441 analog.meaning->channels = g_slist_append(NULL, ch);
442 analog.meaning->mq = SR_MQ_TEMPERATURE;
443 if (devc->temp_unit == 1) {
444 analog.meaning->unit = SR_UNIT_FAHRENHEIT;
445 analog.encoding->digits = 0;
446 analog.spec->spec_digits = 0;
448 analog.meaning->unit = SR_UNIT_CELSIUS;
449 analog.encoding->digits = 1;
450 analog.spec->spec_digits = 1;
452 analog.data = (void *)temp;
453 sr_session_send(sdi, &packet);
454 g_slist_free(analog.meaning->channels);
457 ch = sdi->channels->next->data;
459 analog.meaning->channels = g_slist_append(NULL, ch);
460 analog.meaning->mq = SR_MQ_RELATIVE_HUMIDITY;
461 analog.meaning->unit = SR_UNIT_PERCENTAGE;
462 analog.encoding->digits = 1;
463 analog.spec->spec_digits = 1;
464 analog.data = (void *)rh;
465 sr_session_send(sdi, &packet);
466 g_slist_free(analog.meaning->channels);
473 packet.type = SR_DF_ANALOG;
474 packet.payload = &analog;
475 analog.meaning->channels = sdi->channels;
476 analog.num_samples = samples;
477 analog.meaning->mq = SR_MQ_CARBON_MONOXIDE;
478 analog.meaning->unit = SR_UNIT_CONCENTRATION;
479 analog.meaning->mqflags = 0;
480 if (!(analog.data = g_try_malloc(sizeof(float) * samples)))
482 for (i = 0; i < samples; i++) {
483 s = (buf[i * 2] << 8) | buf[i * 2 + 1];
484 ((float *)analog.data)[i] = (s * devc->co_high + devc->co_low) / (1000 * 1000);
485 if (((float *)analog.data)[i] < 0.0)
486 ((float *)analog.data)[i] = 0.0;
488 sr_session_send(sdi, &packet);
492 /* How did we even get this far? */
495 devc->rcvd_samples += samples;
499 SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data)
501 struct drv_context *drvc = di->context;
502 struct sr_dev_inst *sdi;
510 if (sdi->status == SR_ST_STOPPING) {
511 usb_source_remove(sdi->session, drvc->sr_ctx);
512 std_session_send_df_end(sdi);
515 memset(&tv, 0, sizeof(struct timeval));
516 libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
522 SR_PRIV void LIBUSB_CALL lascar_el_usb_receive_transfer(struct libusb_transfer *transfer)
524 struct dev_context *devc;
525 struct sr_dev_inst *sdi;
527 gboolean packet_has_error;
529 sdi = transfer->user_data;
532 packet_has_error = FALSE;
533 switch (transfer->status) {
534 case LIBUSB_TRANSFER_NO_DEVICE:
535 /* USB device was unplugged. */
536 sr_dev_acquisition_stop(sdi);
538 case LIBUSB_TRANSFER_COMPLETED:
539 case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
542 packet_has_error = TRUE;
546 if (!packet_has_error) {
547 if (devc->rcvd_samples < devc->logged_samples)
548 lascar_el_usb_dispatch(sdi, transfer->buffer,
549 transfer->actual_length);
550 devc->rcvd_bytes += transfer->actual_length;
551 sr_spew("received %d/%d bytes (%d/%d samples)",
552 devc->rcvd_bytes, devc->log_size,
553 devc->rcvd_samples, devc->logged_samples);
554 if (devc->rcvd_bytes >= devc->log_size)
555 sr_dev_acquisition_stop(sdi);
558 if (sdi->status == SR_ST_ACTIVE) {
559 /* Send the same request again. */
560 if ((ret = libusb_submit_transfer(transfer) != 0)) {
561 sr_err("Unable to resubmit transfer: %s.",
562 libusb_error_name(ret));
563 g_free(transfer->buffer);
564 libusb_free_transfer(transfer);
565 sr_dev_acquisition_stop(sdi);
568 /* This was the last transfer we're going to receive, so
570 g_free(transfer->buffer);
571 libusb_free_transfer(transfer);
576 static int get_flags(unsigned char *configblock)
580 flags = (configblock[32] | (configblock[33] << 8)) & 0x1fff;
581 sr_spew("Read flags (0x%.4x).", flags);
586 static int set_flags(unsigned char *configblock, int flags)
589 sr_spew("Setting flags to 0x%.4x.", flags);
590 configblock[32] = flags & 0xff;
591 configblock[33] = (flags >> 8) & 0x1f;
596 SR_PRIV int lascar_is_logging(const struct sr_dev_inst *sdi)
598 struct dev_context *devc;
599 struct sr_usb_dev_inst *usb;
600 int dummy, flags, ret;
605 if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
608 flags = get_flags(devc->config);
617 SR_PRIV int lascar_start_logging(const struct sr_dev_inst *sdi)
619 struct dev_context *devc;
620 struct sr_usb_dev_inst *usb;
626 if (lascar_get_config(usb->devhdl, devc->config, &len) != SR_OK)
629 /* Turn on logging. */
630 flags = get_flags(devc->config);
632 set_flags(devc->config, flags);
634 /* Start logging in 0 seconds. */
635 memset(devc->config + 24, 0, 4);
637 ret = lascar_save_config(usb->devhdl, devc->config, len);
638 sr_info("Started internal logging.");
643 SR_PRIV int lascar_stop_logging(const struct sr_dev_inst *sdi)
645 struct dev_context *devc;
646 struct sr_usb_dev_inst *usb;
652 if (lascar_get_config(usb->devhdl, devc->config, &len) != SR_OK)
655 flags = get_flags(devc->config);
657 set_flags(devc->config, flags);
659 ret = lascar_save_config(usb->devhdl, devc->config, len);
660 sr_info("Stopped internal logging.");