hardware/lascar-el-usb/api.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 <glib.h>
  21 #include <libusb.h>
  22 #include "libsigrok.h"
  23 #include "libsigrok-internal.h"
  24 #include "protocol.h"
  25
  26 SR_PRIV struct sr_dev_inst *lascar_scan(int bus, int address);
  27 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  28 static struct sr_dev_driver *di = &lascar_el_usb_driver_info;
  29 static int hw_dev_close(struct sr_dev_inst *sdi);
  30
  31 static const int32_t hwopts[] = {
  32         SR_CONF_CONN,
  33 };
  34
  35 static const int32_t hwcaps[] = {
  36         SR_CONF_THERMOMETER,
  37         SR_CONF_HYGROMETER,
  38         SR_CONF_DATALOG,
  39         SR_CONF_LIMIT_SAMPLES,
  40 };
  41
  42 /* Properly close and free all devices. */
  43 static int clear_instances(void)
  44 {
  45         struct sr_dev_inst *sdi;
  46         struct drv_context *drvc;
  47         struct dev_context *devc;
  48         GSList *l;
  49
  50         if (!(drvc = di->priv))
  51                 return SR_OK;
  52
  53         for (l = drvc->instances; l; l = l->next) {
  54                 if (!(sdi = l->data))
  55                         continue;
  56                 if (!(devc = sdi->priv))
  57                         continue;
  58
  59                 hw_dev_close(sdi);
  60                 sr_usb_dev_inst_free(sdi->conn);
  61                 sr_dev_inst_free(sdi);
  62         }
  63
  64         g_slist_free(drvc->instances);
  65         drvc->instances = NULL;
  66
  67         return SR_OK;
  68 }
  69
  70 static int hw_init(struct sr_context *sr_ctx)
  71 {
  72         return std_hw_init(sr_ctx, di, LOG_PREFIX);
  73 }
  74
  75 static GSList *hw_scan(GSList *options)
  76 {
  77         struct drv_context *drvc;
  78         struct sr_dev_inst *sdi;
  79         struct sr_usb_dev_inst *usb;
  80         struct sr_config *src;
  81         GSList *usb_devices, *devices, *l;
  82         const char *conn;
  83
  84         (void)options;
  85
  86         drvc = di->priv;
  87
  88         conn = NULL;
  89         for (l = options; l; l = l->next) {
  90                 src = l->data;
  91                 switch (src->key) {
  92                 case SR_CONF_CONN:
  93                         conn = g_variant_get_string(src->data, NULL);
  94                         break;
  95                 }
  96         }
  97         if (!conn)
  98                 return NULL;
  99
 100         devices = NULL;
 101         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 102                 /* We have a list of sr_usb_dev_inst matching the connection
 103                  * string. Wrap them in sr_dev_inst and we're done. */
 104                 for (l = usb_devices; l; l = l->next) {
 105                         usb = l->data;
 106                         if (!(sdi = lascar_scan(usb->bus, usb->address))) {
 107                                 /* Not a Lascar EL-USB. */
 108                                 g_free(usb);
 109                                 continue;
 110                         }
 111                         sdi->inst_type = SR_INST_USB;
 112                         sdi->conn = usb;
 113                         drvc->instances = g_slist_append(drvc->instances, sdi);
 114                         devices = g_slist_append(devices, sdi);
 115                 }
 116                 g_slist_free(usb_devices);
 117         } else
 118                 g_slist_free_full(usb_devices, g_free);
 119
 120         return devices;
 121 }
 122
 123 static GSList *hw_dev_list(void)
 124 {
 125         return ((struct drv_context *)(di->priv))->instances;
 126 }
 127
 128 static int hw_dev_open(struct sr_dev_inst *sdi)
 129 {
 130         struct drv_context *drvc;
 131         struct sr_usb_dev_inst *usb;
 132         int ret;
 133
 134         if (!(drvc = di->priv)) {
 135                 sr_err("Driver was not initialized.");
 136                 return SR_ERR;
 137         }
 138
 139         usb = sdi->conn;
 140
 141         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, usb) != SR_OK)
 142                 return SR_ERR;
 143
 144         if ((ret = libusb_claim_interface(usb->devhdl, LASCAR_INTERFACE))) {
 145                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 146                 return SR_ERR;
 147         }
 148         sdi->status = SR_ST_ACTIVE;
 149
 150         return ret;
 151 }
 152
 153 static int hw_dev_close(struct sr_dev_inst *sdi)
 154 {
 155         struct sr_usb_dev_inst *usb;
 156
 157         if (!di->priv) {
 158                 sr_err("Driver was not initialized.");
 159                 return SR_ERR;
 160         }
 161
 162         usb = sdi->conn;
 163
 164         if (!usb->devhdl)
 165                 /*  Nothing to do. */
 166                 return SR_OK;
 167
 168         libusb_release_interface(usb->devhdl, LASCAR_INTERFACE);
 169         libusb_close(usb->devhdl);
 170         usb->devhdl = NULL;
 171         sdi->status = SR_ST_INACTIVE;
 172
 173         return SR_OK;
 174 }
 175
 176 static int hw_cleanup(void)
 177 {
 178         struct drv_context *drvc;
 179
 180         if (!(drvc = di->priv))
 181                 /* Can get called on an unused driver, doesn't matter. */
 182                 return SR_OK;
 183
 184         clear_instances();
 185         g_free(drvc);
 186         di->priv = NULL;
 187
 188         return SR_OK;
 189 }
 190
 191 static int config_get(int id, GVariant **data, const struct sr_dev_inst *sdi)
 192 {
 193         struct dev_context *devc;
 194         struct sr_usb_dev_inst *usb;
 195         int ret;
 196         char str[128];
 197
 198         devc = sdi->priv;
 199         switch (id) {
 200         case SR_CONF_CONN:
 201                 if (!sdi || !sdi->conn)
 202                         return SR_ERR_ARG;
 203                 usb = sdi->conn;
 204                 snprintf(str, 128, "%d.%d", usb->bus, usb->address);
 205                 *data = g_variant_new_string(str);
 206                 break;
 207         case SR_CONF_DATALOG:
 208                 if (!sdi)
 209                         return SR_ERR_ARG;
 210                 if ((ret = lascar_is_logging(sdi)) == -1)
 211                         return SR_ERR;
 212                 *data = g_variant_new_boolean(ret ? TRUE : FALSE);
 213                 break;
 214         case SR_CONF_LIMIT_SAMPLES:
 215                 *data = g_variant_new_uint64(devc->limit_samples);
 216                 break;
 217         default:
 218                 return SR_ERR_NA;
 219         }
 220
 221         return SR_OK;
 222 }
 223
 224 static int config_set(int id, GVariant *data, const struct sr_dev_inst *sdi)
 225 {
 226         struct dev_context *devc;
 227         int ret;
 228
 229         if (sdi->status != SR_ST_ACTIVE)
 230                 return SR_ERR_DEV_CLOSED;
 231
 232         if (!di->priv) {
 233                 sr_err("Driver was not initialized.");
 234                 return SR_ERR;
 235         }
 236
 237         devc = sdi->priv;
 238         ret = SR_OK;
 239         switch (id) {
 240         case SR_CONF_DATALOG:
 241                 if (g_variant_get_boolean(data)) {
 242                         /* Start logging. */
 243                         ret = lascar_start_logging(sdi);
 244                 } else {
 245                         /* Stop logging. */
 246                         ret = lascar_stop_logging(sdi);
 247                 }
 248                 break;
 249         case SR_CONF_LIMIT_SAMPLES:
 250                 devc->limit_samples = g_variant_get_uint64(data);
 251                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 252                        devc->limit_samples);
 253                 break;
 254         default:
 255                 ret = SR_ERR_NA;
 256         }
 257
 258         return ret;
 259 }
 260
 261 static int config_list(int key, GVariant **data, const struct sr_dev_inst *sdi)
 262 {
 263
 264         (void)sdi;
 265
 266         switch (key) {
 267         case SR_CONF_SCAN_OPTIONS:
 268                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 269                                 hwopts, ARRAY_SIZE(hwopts), sizeof(int32_t));
 270                 break;
 271         case SR_CONF_DEVICE_OPTIONS:
 272                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_INT32,
 273                                 hwcaps, ARRAY_SIZE(hwcaps), sizeof(int32_t));
 274                 break;
 275         default:
 276                 return SR_ERR_NA;
 277         }
 278
 279         return SR_OK;
 280 }
 281
 282 static void mark_xfer(struct libusb_transfer *xfer)
 283 {
 284
 285         if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
 286                 xfer->user_data = GINT_TO_POINTER(1);
 287         else
 288                 xfer->user_data = GINT_TO_POINTER(-1);
 289
 290 }
 291
 292 /* The Lascar software, in its infinite ignorance, reads a set of four
 293  * bytes from the device config struct and interprets it as a float.
 294  * That only works because they only use windows, and only on x86. However
 295  * we may be running on any architecture, any operating system. So we have
 296  * to convert these four bytes as the Lascar software would on windows/x86,
 297  * to the local representation of a float.
 298  * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
 299 static float binary32_le_to_float(unsigned char *buf)
 300 {
 301         GFloatIEEE754 f;
 302
 303         f.v_float = 0;
 304         f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
 305         f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
 306         f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
 307
 308         return f.v_float;
 309 }
 310
 311 static int lascar_proc_config(const struct sr_dev_inst *sdi)
 312 {
 313         struct dev_context *devc;
 314         struct sr_usb_dev_inst *usb;
 315         int dummy, ret;
 316
 317         devc = sdi->priv;
 318         usb = sdi->conn;
 319
 320         if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
 321                 return SR_ERR;
 322
 323         ret = SR_OK;
 324         switch (devc->profile->logformat) {
 325         case LOG_TEMP_RH:
 326                 devc->sample_size = 2;
 327                 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
 328                 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
 329                         sr_dbg("invalid temperature unit %d", devc->temp_unit);
 330                         /* Default to Celcius, we're all adults here. */
 331                         devc->temp_unit = 0;
 332                 } else
 333                         sr_dbg("temperature unit is %s", devc->temp_unit
 334                                         ? "Fahrenheit" : "Celcius");
 335                 break;
 336         case LOG_CO:
 337                 devc->sample_size = 2;
 338                 devc->co_high = binary32_le_to_float(devc->config + 0x24);
 339                 devc->co_low = binary32_le_to_float(devc->config + 0x28);
 340                 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
 341                                 devc->co_low);
 342                 break;
 343         default:
 344                 ret = SR_ERR_ARG;
 345         }
 346         devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
 347         sr_dbg("device log contains %d samples.", devc->logged_samples);
 348
 349         return ret;
 350 }
 351
 352 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 353                 void *cb_data)
 354 {
 355         struct sr_datafeed_packet packet;
 356         struct sr_datafeed_meta meta;
 357         struct sr_config *src;
 358         struct dev_context *devc;
 359         struct drv_context *drvc;
 360         struct sr_usb_dev_inst *usb;
 361         struct libusb_transfer *xfer_in, *xfer_out;
 362         const struct libusb_pollfd **pfd;
 363         struct timeval tv;
 364         uint64_t interval;
 365         int ret, i;
 366         unsigned char cmd[3], resp[4], *buf;
 367
 368         if (sdi->status != SR_ST_ACTIVE)
 369                 return SR_ERR_DEV_CLOSED;
 370
 371         if (!di->priv) {
 372                 sr_err("Driver was not initialized.");
 373                 return SR_ERR;
 374         }
 375
 376         drvc = di->priv;
 377         devc = sdi->priv;
 378         usb = sdi->conn;
 379         devc->cb_data = cb_data;
 380
 381         if (lascar_proc_config(sdi) != SR_OK)
 382                 return SR_ERR;
 383
 384         sr_dbg("Starting log retrieval.");
 385
 386         /* Send header packet to the session bus. */
 387         std_session_send_df_header(cb_data, LOG_PREFIX);
 388
 389         interval = (devc->config[0x1c] | (devc->config[0x1d] << 8)) * 1000;
 390         packet.type = SR_DF_META;
 391         packet.payload = &meta;
 392         src = sr_config_new(SR_CONF_SAMPLE_INTERVAL, g_variant_new_uint64(interval));
 393         meta.config = g_slist_append(NULL, src);
 394         sr_session_send(devc->cb_data, &packet);
 395         g_free(src);
 396
 397         if (devc->logged_samples == 0) {
 398                 /* This ensures the frontend knows the session is done. */
 399                 packet.type = SR_DF_END;
 400                 sr_session_send(devc->cb_data, &packet);
 401                 return SR_OK;
 402         }
 403
 404         if (!(xfer_in = libusb_alloc_transfer(0)) ||
 405                         !(xfer_out = libusb_alloc_transfer(0)))
 406                 return SR_ERR;
 407
 408         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 409                         0x00, 0xffff, 0x00, NULL, 0, 50);
 410         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 411                         0x02, 0x0002, 0x00, NULL, 0, 50);
 412         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 413                         0x02, 0x0001, 0x00, NULL, 0, 50);
 414
 415
 416         /* Flush input. The F321 requires this. */
 417         while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
 418                         256, &ret, 5) == 0 && ret > 0)
 419                 ;
 420
 421         libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
 422                         resp, sizeof(resp), mark_xfer, 0, 10000);
 423         if (libusb_submit_transfer(xfer_in) != 0) {
 424                 libusb_free_transfer(xfer_in);
 425                 libusb_free_transfer(xfer_out);
 426                 return SR_ERR;
 427         }
 428
 429         cmd[0] = 0x03;
 430         cmd[1] = 0xff;
 431         cmd[2] = 0xff;
 432         libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
 433                         cmd, 3, mark_xfer, 0, 100);
 434         if (libusb_submit_transfer(xfer_out) != 0) {
 435                 libusb_free_transfer(xfer_in);
 436                 libusb_free_transfer(xfer_out);
 437                 return SR_ERR;
 438         }
 439
 440         tv.tv_sec = 0;
 441         tv.tv_usec = 0;
 442         while (!xfer_in->user_data || !xfer_out->user_data) {
 443                 g_usleep(5000);
 444                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 445         }
 446         if (xfer_in->user_data != GINT_TO_POINTER(1) ||
 447                         xfer_in->user_data != GINT_TO_POINTER(1)) {
 448                 sr_dbg("no response to log transfer request");
 449                 libusb_free_transfer(xfer_in);
 450                 libusb_free_transfer(xfer_out);
 451                 return SR_ERR;
 452         }
 453         if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
 454                 sr_dbg("invalid response to log transfer request");
 455                 libusb_free_transfer(xfer_in);
 456                 libusb_free_transfer(xfer_out);
 457                 return SR_ERR;
 458         }
 459         devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
 460         libusb_free_transfer(xfer_out);
 461
 462         pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 463         for (i = 0; pfd[i]; i++) {
 464                 /* Handle USB events every 100ms, for decent latency. */
 465                 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
 466                                 lascar_el_usb_handle_events, (void *)sdi);
 467                 /* We'll need to remove this fd later. */
 468                 devc->usbfd[i] = pfd[i]->fd;
 469         }
 470         devc->usbfd[i] = -1;
 471
 472         buf = g_try_malloc(4096);
 473         libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
 474                         buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
 475         if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
 476                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 477                 libusb_free_transfer(xfer_in);
 478                 g_free(buf);
 479                 return SR_ERR;
 480         }
 481
 482         return SR_OK;
 483 }
 484
 485 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 486 {
 487         (void)cb_data;
 488
 489         if (!di->priv) {
 490                 sr_err("Driver was not initialized.");
 491                 return SR_ERR;
 492         }
 493
 494         if (sdi->status != SR_ST_ACTIVE) {
 495                 sr_err("Device inactive, can't stop acquisition.");
 496                 return SR_ERR;
 497         }
 498
 499         sdi->status = SR_ST_STOPPING;
 500         /* TODO: free ongoing transfers? */
 501
 502         return SR_OK;
 503 }
 504
 505 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
 506         .name = "lascar-el-usb",
 507         .longname = "Lascar EL-USB",
 508         .api_version = 1,
 509         .init = hw_init,
 510         .cleanup = hw_cleanup,
 511         .scan = hw_scan,
 512         .dev_list = hw_dev_list,
 513         .dev_clear = clear_instances,
 514         .config_get = config_get,
 515         .config_set = config_set,
 516         .config_list = config_list,
 517         .dev_open = hw_dev_open,
 518         .dev_close = hw_dev_close,
 519         .dev_acquisition_start = hw_dev_acquisition_start,
 520         .dev_acquisition_stop = hw_dev_acquisition_stop,
 521         .priv = NULL,
 522 };