hardware/lascar-el-usb/protocol.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #include <stdlib.h>
  21 #include <sys/time.h>
  22 #include <string.h>
  23 #include <math.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27 #include "protocol.h"
  28
  29 extern struct sr_dev_driver lascar_el_usb_driver_info;
  30 static struct sr_dev_driver *di = &lascar_el_usb_driver_info;
  31
  32 static const struct elusb_profile profiles[] = {
  33         { 1, "EL-USB-1", LOG_UNSUPPORTED },
  34         { 2, "EL-USB-1", LOG_UNSUPPORTED },
  35         { 3, "EL-USB-2", LOG_TEMP_RH },
  36         { 4, "EL-USB-3", LOG_UNSUPPORTED },
  37         { 5, "EL-USB-4", LOG_UNSUPPORTED },
  38         { 6, "EL-USB-3", LOG_UNSUPPORTED },
  39         { 7, "EL-USB-4", LOG_UNSUPPORTED },
  40         { 8, "EL-USB-LITE", LOG_UNSUPPORTED },
  41         { 9, "EL-USB-CO", LOG_CO },
  42         { 10, "EL-USB-TC", LOG_UNSUPPORTED },
  43         { 11, "EL-USB-CO300", LOG_CO },
  44         { 12, "EL-USB-2-LCD", LOG_UNSUPPORTED },
  45         { 13, "EL-USB-2+", LOG_UNSUPPORTED },
  46         { 14, "EL-USB-1-PRO", LOG_UNSUPPORTED },
  47         { 15, "EL-USB-TC-LCD", LOG_UNSUPPORTED },
  48         { 16, "EL-USB-2-LCD+", LOG_UNSUPPORTED },
  49         { 17, "EL-USB-5", LOG_UNSUPPORTED },
  50         { 18, "EL-USB-1-RCG", LOG_UNSUPPORTED },
  51         { 19, "EL-USB-1-LCD", LOG_UNSUPPORTED },
  52         { 20, "EL-OEM-3", LOG_UNSUPPORTED },
  53         { 21, "EL-USB-1-LCD", LOG_UNSUPPORTED },
  54         { 0, NULL, 0 }
  55 };
  56
  57
  58 SR_PRIV libusb_device_handle *lascar_open(struct libusb_device *dev)
  59 {
  60         libusb_device_handle *dev_hdl;
  61         int ret;
  62
  63         if ((ret = libusb_open(dev, &dev_hdl)) != 0) {
  64                 sr_dbg("failed to open device for scan: %s",
  65                                 libusb_error_name(ret));
  66                 return NULL;
  67         }
  68
  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);
  77
  78         return dev_hdl;
  79 }
  80
  81 static void mark_xfer(struct libusb_transfer *xfer)
  82 {
  83
  84         xfer->user_data = GINT_TO_POINTER(1);
  85
  86 }
  87
  88 SR_PRIV unsigned char *lascar_get_config(libusb_device_handle *dev_hdl)
  89 {
  90         struct drv_context *drvc;
  91         struct libusb_transfer *xfer_in, *xfer_out;
  92         struct timeval tv;
  93         int64_t start;
  94         int buflen;
  95         unsigned char cmd[3], buf[256], *config;
  96
  97         drvc = di->priv;
  98         config = NULL;
  99
 100         if (!(xfer_in = libusb_alloc_transfer(0)) ||
 101                         !(xfer_out = libusb_alloc_transfer(0)))
 102                 return NULL;
 103
 104         /* Flush anything the F321 still has queued. */
 105         while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
 106                         5) == 0 && buflen > 0)
 107                 ;
 108
 109         /* Keep a read request waiting in the wings, ready to pounce
 110          * the moment the device sends something. */
 111         libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
 112                         buf, 256, mark_xfer, 0, 10000);
 113         if (libusb_submit_transfer(xfer_in) != 0)
 114                 goto cleanup;
 115
 116         /* Request device configuration structure. */
 117         cmd[0] = 0x00;
 118         cmd[1] = 0xff;
 119         cmd[2] = 0xff;
 120         libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
 121                         cmd, 3, mark_xfer, 0, 100);
 122         if (libusb_submit_transfer(xfer_out) != 0)
 123                 goto cleanup;
 124
 125         tv.tv_sec = 0;
 126         tv.tv_usec = 0;
 127         start = g_get_monotonic_time();
 128         while (!xfer_in->user_data || !xfer_out->user_data) {
 129                 if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
 130                         start = 0;
 131                         break;
 132                 }
 133                 g_usleep(5000);
 134                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 135         }
 136         if (!start) {
 137                 sr_dbg("no response");
 138                 goto cleanup;
 139         }
 140         if (xfer_in->actual_length != 3) {
 141                 sr_dbg("expected 3-byte header, got %d bytes", xfer_in->actual_length);
 142                 goto cleanup;
 143         }
 144
 145         /* Got configuration structure header. */
 146         sr_dbg("response to config request: 0x%.2x 0x%.2x 0x%.2x ",
 147                         buf[0], buf[1], buf[2]);
 148         buflen = buf[1] | (buf[2] << 8);
 149         if (buf[0] != 0x02 || buflen > 256) {
 150                 sr_dbg("Invalid response to config request: "
 151                                 "0x%.2x 0x%.2x 0x%.2x ", buf[0], buf[1], buf[2]);
 152                 libusb_close(dev_hdl);
 153                 goto cleanup;
 154         }
 155
 156         /* Get configuration structure. */
 157         xfer_in->length = buflen;
 158         xfer_in->user_data = 0;
 159         if (libusb_submit_transfer(xfer_in) != 0)
 160                 goto cleanup;
 161         while (!xfer_in->user_data) {
 162                 if (g_get_monotonic_time() - start > SCAN_TIMEOUT) {
 163                         start = 0;
 164                         break;
 165                 }
 166                 g_usleep(5000);
 167                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 168         }
 169         if (!start) {
 170                 sr_dbg("Timeout waiting for configuration structure.");
 171                 goto cleanup;
 172         }
 173         if (xfer_in->actual_length != buflen) {
 174                 sr_dbg("expected %d-byte structure, got %d bytes", buflen,
 175                                 xfer_in->actual_length);
 176                 goto cleanup;
 177         }
 178
 179         if (!(config = g_try_malloc(256)))
 180                 return NULL;
 181         memcpy(config, buf, buflen);
 182
 183 cleanup:
 184         if (!xfer_in->user_data || !xfer_in->user_data) {
 185                 if (!xfer_in->user_data)
 186                         libusb_cancel_transfer(xfer_in);
 187                 if (!xfer_out->user_data)
 188                         libusb_cancel_transfer(xfer_out);
 189                 start = g_get_monotonic_time();
 190                 while (!xfer_in->user_data || !xfer_out->user_data) {
 191                         if (g_get_monotonic_time() - start > 10000)
 192                                 break;
 193                         g_usleep(1000);
 194                         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 195                 }
 196         }
 197         libusb_free_transfer(xfer_in);
 198         libusb_free_transfer(xfer_out);
 199
 200         return config;
 201 }
 202
 203 /* Currently unused. */
 204 SR_PRIV int lascar_save_config(libusb_device_handle *dev_hdl,
 205                 unsigned char *config, int configlen)
 206 {
 207         struct drv_context *drvc;
 208         struct libusb_transfer *xfer_in, *xfer_out;
 209         struct timeval tv;
 210         int64_t start;
 211         int buflen, ret;
 212         unsigned char cmd[3], buf[256];
 213
 214         drvc = di->priv;
 215
 216         if (!(xfer_in = libusb_alloc_transfer(0)) ||
 217                         !(xfer_out = libusb_alloc_transfer(0)))
 218                 return SR_ERR;
 219
 220         /* Flush anything the F321 still has queued. */
 221         while (libusb_bulk_transfer(dev_hdl, LASCAR_EP_IN, buf, 256, &buflen,
 222                         5) == 0 && buflen > 0)
 223                 ;
 224         ret = SR_OK;
 225
 226         /* Keep a read request waiting in the wings, ready to pounce
 227          * the moment the device sends something. */
 228         libusb_fill_bulk_transfer(xfer_in, dev_hdl, LASCAR_EP_IN,
 229                         buf, 256, mark_xfer, 0, 10000);
 230         if (libusb_submit_transfer(xfer_in) != 0) {
 231                 ret = SR_ERR;
 232                 goto cleanup;
 233         }
 234
 235         /* Request device configuration structure. */
 236         cmd[0] = 0x01;
 237         cmd[1] = configlen & 0xff;
 238         cmd[2] = (configlen >> 8) & 0xff;
 239         libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
 240                         cmd, 3, mark_xfer, 0, 100);
 241         if (libusb_submit_transfer(xfer_out) != 0) {
 242                 ret = SR_ERR;
 243                 goto cleanup;
 244         }
 245         tv.tv_sec = 0;
 246         tv.tv_usec = 0;
 247         while (!xfer_out->user_data) {
 248                 g_usleep(5000);
 249                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 250         }
 251
 252         libusb_fill_bulk_transfer(xfer_out, dev_hdl, LASCAR_EP_OUT,
 253                         config, configlen, mark_xfer, 0, 100);
 254         if (libusb_submit_transfer(xfer_out) != 0) {
 255                 ret = SR_ERR;
 256                 goto cleanup;
 257         }
 258         while (!xfer_in->user_data || !xfer_out->user_data) {
 259                 g_usleep(5000);
 260                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 261         }
 262
 263         if (xfer_in->actual_length != 1 || buf[0] != 0xff) {
 264                 sr_dbg("unexpected response after transfer");
 265                 ret = SR_ERR;
 266         }
 267
 268 cleanup:
 269         if (!xfer_in->user_data || !xfer_in->user_data) {
 270                 if (!xfer_in->user_data)
 271                         libusb_cancel_transfer(xfer_in);
 272                 if (!xfer_out->user_data)
 273                         libusb_cancel_transfer(xfer_out);
 274                 start = g_get_monotonic_time();
 275                 while (!xfer_in->user_data || !xfer_out->user_data) {
 276                         if (g_get_monotonic_time() - start > 10000)
 277                                 break;
 278                         g_usleep(1000);
 279                         libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 280                 }
 281         }
 282         libusb_free_transfer(xfer_in);
 283         libusb_free_transfer(xfer_out);
 284
 285         return ret;
 286 }
 287
 288 static struct sr_dev_inst *lascar_identify(unsigned char *config)
 289 {
 290         struct dev_context *devc;
 291         const struct elusb_profile *profile;
 292         struct sr_dev_inst *sdi;
 293         struct sr_probe *probe;
 294         int modelid, i;
 295         char firmware[5];
 296
 297         modelid = config[0];
 298         sdi = NULL;
 299         if (modelid) {
 300                 profile = NULL;
 301                 for (i = 0; profiles[i].modelid; i++) {
 302                         if (profiles[i].modelid == modelid) {
 303                                 profile = &profiles[i];
 304                                 break;
 305                         }
 306                 }
 307                 if (!profile) {
 308                         sr_dbg("unknown EL-USB modelid %d", modelid);
 309                         return NULL;
 310                 }
 311
 312                 i = config[52] | (config[53] << 8);
 313                 memcpy(firmware, config + 0x30, 4);
 314                 firmware[4] = '\0';
 315                 sr_dbg("found %s with firmware version %s serial %d",
 316                                 profile->modelname, firmware, i);
 317
 318                 if (profile->logformat == LOG_UNSUPPORTED) {
 319                         sr_dbg("unsupported EL-USB logformat for %s", profile->modelname);
 320                         return NULL;
 321                 }
 322
 323                 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, LASCAR_VENDOR,
 324                                 profile->modelname, firmware)))
 325                         return NULL;
 326                 sdi->driver = di;
 327
 328                 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
 329                         return NULL;
 330                 sdi->probes = g_slist_append(NULL, probe);
 331
 332                 if (!(devc = g_try_malloc0(sizeof(struct dev_context))))
 333                         return NULL;
 334                 sdi->priv = devc;
 335                 devc->profile = profile;
 336         }
 337
 338         return sdi;
 339 }
 340
 341 SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address)
 342 {
 343         struct drv_context *drvc;
 344         struct sr_dev_inst *sdi;
 345         struct libusb_device **devlist;
 346         struct libusb_device_descriptor des;
 347         libusb_device_handle *dev_hdl;
 348         int ret, i;
 349         unsigned char *config;
 350
 351         drvc = di->priv;
 352         sdi = NULL;
 353
 354         libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist);
 355         for (i = 0; devlist[i]; i++) {
 356                 if ((ret = libusb_get_device_descriptor(devlist[i], &des))) {
 357                         sr_err("Failed to get device descriptor: %d.", ret);
 358                         continue;
 359                 }
 360
 361                 if (libusb_get_bus_number(devlist[i]) != bus ||
 362                                 libusb_get_device_address(devlist[i]) != address)
 363                         continue;
 364
 365                 if (!(dev_hdl = lascar_open(devlist[i])))
 366                         continue;
 367
 368                 if (!(config = lascar_get_config(dev_hdl)))
 369                         continue;
 370
 371                 libusb_close(dev_hdl);
 372                 sdi = lascar_identify(config);
 373                 g_free(config);
 374         }
 375
 376         return sdi;
 377 }
 378
 379 static void lascar_el_usb_dispatch(struct sr_dev_inst *sdi, unsigned char *buf,
 380                 int buflen)
 381 {
 382         struct dev_context *devc;
 383         struct sr_datafeed_packet packet;
 384         struct sr_datafeed_analog analog;
 385         uint16_t s;
 386         int samples, samples_left, i;
 387
 388         devc = sdi->priv;
 389         samples = buflen / devc->sample_size;
 390         samples_left = devc->logged_samples - devc->rcvd_samples;
 391         if (samples_left < samples)
 392                 samples = samples_left;
 393         switch (devc->profile->logformat) {
 394         case LOG_TEMP_RH:
 395                 /* TODO */
 396                 break;
 397         case LOG_CO:
 398                 packet.type = SR_DF_ANALOG;
 399                 packet.payload = &analog;
 400                 analog.num_samples = samples;
 401                 analog.mq = SR_MQ_CARBON_MONOXIDE;
 402                 analog.unit = SR_UNIT_CONCENTRATION;
 403                 analog.mqflags = 0;
 404                 if (!(analog.data = g_try_malloc(sizeof(float) * samples)))
 405                         break;
 406                 for (i = 0; i < samples; i++) {
 407                         s = (buf[i * 2] << 8) | buf[i * 2 + 1];
 408                         analog.data[i] = s * devc->co_high + devc->co_low;
 409                         if (analog.data[i] < 0.0)
 410                                 analog.data[i] = 0.0;
 411                 }
 412                 sr_session_send(devc->cb_data, &packet);
 413                 g_free(analog.data);
 414                 break;
 415         default:
 416                 /* How did we even get this far? */
 417                 break;
 418         }
 419         devc->rcvd_samples += samples;
 420
 421 }
 422
 423 SR_PRIV int lascar_el_usb_handle_events(int fd, int revents, void *cb_data)
 424 {
 425         struct dev_context *devc;
 426         struct drv_context *drvc = di->priv;
 427         struct sr_datafeed_packet packet;
 428         struct sr_dev_inst *sdi;
 429         struct timeval tv;
 430         int i;
 431
 432         (void)fd;
 433         (void)revents;
 434
 435         sdi = cb_data;
 436         devc = sdi->priv;
 437
 438         if (sdi->status == SR_ST_STOPPING) {
 439                 for (i = 0; devc->usbfd[i] != -1; i++)
 440                         sr_source_remove(devc->usbfd[i]);
 441
 442                 sdi->driver->dev_close(sdi);
 443
 444                 packet.type = SR_DF_END;
 445                 sr_session_send(cb_data, &packet);
 446         }
 447
 448         memset(&tv, 0, sizeof(struct timeval));
 449         libusb_handle_events_timeout_completed(drvc->sr_ctx->libusb_ctx, &tv,
 450                                                NULL);
 451
 452         return TRUE;
 453 }
 454
 455 SR_PRIV void lascar_el_usb_receive_transfer(struct libusb_transfer *transfer)
 456 {
 457         struct dev_context *devc;
 458         struct sr_dev_inst *sdi;
 459         int ret;
 460         gboolean packet_has_error;
 461
 462         sdi = transfer->user_data;
 463         devc = sdi->priv;
 464
 465         packet_has_error = FALSE;
 466         switch (transfer->status) {
 467         case LIBUSB_TRANSFER_NO_DEVICE:
 468                 /* USB device was unplugged. */
 469                 hw_dev_acquisition_stop(sdi, sdi);
 470                 return;
 471         case LIBUSB_TRANSFER_COMPLETED:
 472         case LIBUSB_TRANSFER_TIMED_OUT: /* We may have received some data though */
 473                 break;
 474         default:
 475                 packet_has_error = TRUE;
 476                 break;
 477         }
 478
 479         if (!packet_has_error) {
 480                 if (devc->rcvd_samples < devc->logged_samples)
 481                         lascar_el_usb_dispatch(sdi, transfer->buffer,
 482                                         transfer->actual_length);
 483                 devc->rcvd_bytes += transfer->actual_length;
 484                 sr_spew("received %d/%d bytes (%d/%d samples)",
 485                                 devc->rcvd_bytes, devc->log_size,
 486                                 devc->rcvd_samples, devc->logged_samples);
 487                 if (devc->rcvd_bytes >= devc->log_size)
 488                         hw_dev_acquisition_stop(sdi, sdi);
 489         }
 490
 491         if (sdi->status == SR_ST_ACTIVE) {
 492                 /* Send the same request again. */
 493                 if ((ret = libusb_submit_transfer(transfer) != 0)) {
 494                         sr_err("Unable to resubmit transfer: %s.",
 495                                libusb_error_name(ret));
 496                         g_free(transfer->buffer);
 497                         libusb_free_transfer(transfer);
 498                         hw_dev_acquisition_stop(sdi, sdi);
 499                 }
 500         } else {
 501                 /* This was the last transfer we're going to receive, so
 502                  * clean up now. */
 503                 g_free(transfer->buffer);
 504                 libusb_free_transfer(transfer);
 505         }
 506
 507 }