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