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