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