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