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                         ret = lascar_start_logging(sdi);
 220                 else
 221                         ret = lascar_stop_logging(sdi);
 222                 break;
 223         case SR_CONF_LIMIT_SAMPLES:
 224                 devc->limit_samples = g_variant_get_uint64(data);
 225                 break;
 226         default:
 227                 ret = SR_ERR_NA;
 228         }
 229
 230         return ret;
 231 }
 232
 233 static int config_list(uint32_t key, GVariant **data, const struct sr_dev_inst *sdi,
 234                 const struct sr_channel_group *cg)
 235 {
 236         (void)sdi;
 237         (void)cg;
 238
 239         switch (key) {
 240         case SR_CONF_SCAN_OPTIONS:
 241                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 242                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 243                 break;
 244         case SR_CONF_DEVICE_OPTIONS:
 245                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 246                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 247                 break;
 248         default:
 249                 return SR_ERR_NA;
 250         }
 251
 252         return SR_OK;
 253 }
 254
 255 static void mark_xfer(struct libusb_transfer *xfer)
 256 {
 257
 258         if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
 259                 xfer->user_data = GINT_TO_POINTER(1);
 260         else
 261                 xfer->user_data = GINT_TO_POINTER(-1);
 262
 263 }
 264
 265 /* The Lascar software, in its infinite ignorance, reads a set of four
 266  * bytes from the device config struct and interprets it as a float.
 267  * That only works because they only use windows, and only on x86. However
 268  * we may be running on any architecture, any operating system. So we have
 269  * to convert these four bytes as the Lascar software would on windows/x86,
 270  * to the local representation of a float.
 271  * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
 272 static float binary32_le_to_float(unsigned char *buf)
 273 {
 274         GFloatIEEE754 f;
 275
 276         f.v_float = 0;
 277         f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
 278         f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
 279         f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
 280
 281         return f.v_float;
 282 }
 283
 284 static int lascar_proc_config(const struct sr_dev_inst *sdi)
 285 {
 286         struct dev_context *devc;
 287         struct sr_usb_dev_inst *usb;
 288         int dummy, ret;
 289
 290         devc = sdi->priv;
 291         usb = sdi->conn;
 292
 293         if (lascar_get_config(usb->devhdl, devc->config, &dummy) != SR_OK)
 294                 return SR_ERR;
 295
 296         ret = SR_OK;
 297         switch (devc->profile->logformat) {
 298         case LOG_TEMP_RH:
 299                 devc->sample_size = 2;
 300                 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
 301                 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
 302                         sr_dbg("invalid temperature unit %d", devc->temp_unit);
 303                         /* Default to Celsius, we're all adults here. */
 304                         devc->temp_unit = 0;
 305                 } else
 306                         sr_dbg("temperature unit is %s", devc->temp_unit
 307                                         ? "Fahrenheit" : "Celsius");
 308                 break;
 309         case LOG_CO:
 310                 devc->sample_size = 2;
 311                 devc->co_high = binary32_le_to_float(devc->config + 0x24);
 312                 devc->co_low = binary32_le_to_float(devc->config + 0x28);
 313                 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
 314                                 devc->co_low);
 315                 break;
 316         default:
 317                 ret = SR_ERR_ARG;
 318         }
 319         devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
 320         sr_dbg("device log contains %d samples.", devc->logged_samples);
 321
 322         return ret;
 323 }
 324
 325 static int dev_acquisition_start(const struct sr_dev_inst *sdi, void *cb_data)
 326 {
 327         struct sr_dev_driver *di = sdi->driver;
 328         struct sr_datafeed_packet packet;
 329         struct sr_datafeed_meta meta;
 330         struct sr_config *src;
 331         struct dev_context *devc;
 332         struct drv_context *drvc;
 333         struct sr_usb_dev_inst *usb;
 334         struct libusb_transfer *xfer_in, *xfer_out;
 335         struct timeval tv;
 336         uint64_t interval;
 337         int ret;
 338         unsigned char cmd[3], resp[4], *buf;
 339
 340         if (sdi->status != SR_ST_ACTIVE)
 341                 return SR_ERR_DEV_CLOSED;
 342
 343         if (!di->priv) {
 344                 sr_err("Driver was not initialized.");
 345                 return SR_ERR;
 346         }
 347
 348         drvc = di->priv;
 349         devc = sdi->priv;
 350         usb = sdi->conn;
 351         devc->cb_data = cb_data;
 352
 353         if (lascar_proc_config(sdi) != SR_OK)
 354                 return SR_ERR;
 355
 356         sr_dbg("Starting log retrieval.");
 357
 358         /* Send header packet to the session bus. */
 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                 packet.type = SR_DF_END;
 372                 sr_session_send(devc->cb_data, &packet);
 373                 return SR_OK;
 374         }
 375
 376         if (!(xfer_in = libusb_alloc_transfer(0)) ||
 377                         !(xfer_out = libusb_alloc_transfer(0)))
 378                 return SR_ERR;
 379
 380         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 381                         0x00, 0xffff, 0x00, NULL, 0, 50);
 382         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 383                         0x02, 0x0002, 0x00, NULL, 0, 50);
 384         libusb_control_transfer(usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 385                         0x02, 0x0001, 0x00, NULL, 0, 50);
 386
 387         /* Flush input. The F321 requires this. */
 388         while (libusb_bulk_transfer(usb->devhdl, LASCAR_EP_IN, resp,
 389                         256, &ret, 5) == 0 && ret > 0)
 390                 ;
 391
 392         libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
 393                         resp, sizeof(resp), mark_xfer, 0, BULK_XFER_TIMEOUT);
 394         if (libusb_submit_transfer(xfer_in) != 0) {
 395                 libusb_free_transfer(xfer_in);
 396                 libusb_free_transfer(xfer_out);
 397                 return SR_ERR;
 398         }
 399
 400         cmd[0] = 0x03;
 401         cmd[1] = 0xff;
 402         cmd[2] = 0xff;
 403         libusb_fill_bulk_transfer(xfer_out, usb->devhdl, LASCAR_EP_OUT,
 404                         cmd, 3, mark_xfer, 0, 100);
 405         if (libusb_submit_transfer(xfer_out) != 0) {
 406                 libusb_free_transfer(xfer_in);
 407                 libusb_free_transfer(xfer_out);
 408                 return SR_ERR;
 409         }
 410
 411         tv.tv_sec = 0;
 412         tv.tv_usec = 0;
 413         while (!xfer_in->user_data || !xfer_out->user_data) {
 414                 g_usleep(SLEEP_US_LONG);
 415                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 416         }
 417         if (xfer_in->user_data != GINT_TO_POINTER(1) ||
 418                         xfer_in->user_data != GINT_TO_POINTER(1)) {
 419                 sr_dbg("no response to log transfer request");
 420                 libusb_free_transfer(xfer_in);
 421                 libusb_free_transfer(xfer_out);
 422                 return SR_ERR;
 423         }
 424         if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
 425                 sr_dbg("invalid response to log transfer request");
 426                 libusb_free_transfer(xfer_in);
 427                 libusb_free_transfer(xfer_out);
 428                 return SR_ERR;
 429         }
 430         devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
 431         libusb_free_transfer(xfer_out);
 432
 433         usb_source_add(sdi->session, drvc->sr_ctx, 100,
 434                         lascar_el_usb_handle_events, (void *)sdi);
 435
 436         buf = g_malloc(4096);
 437         libusb_fill_bulk_transfer(xfer_in, usb->devhdl, LASCAR_EP_IN,
 438                         buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
 439         if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
 440                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 441                 libusb_free_transfer(xfer_in);
 442                 g_free(buf);
 443                 return SR_ERR;
 444         }
 445
 446         return SR_OK;
 447 }
 448
 449 SR_PRIV int dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 450 {
 451         struct sr_dev_driver *di = sdi->driver;
 452         (void)cb_data;
 453
 454         if (!di->priv) {
 455                 sr_err("Driver was not initialized.");
 456                 return SR_ERR;
 457         }
 458
 459         if (sdi->status != SR_ST_ACTIVE) {
 460                 sr_err("Device inactive, can't stop acquisition.");
 461                 return SR_ERR;
 462         }
 463
 464         sdi->status = SR_ST_STOPPING;
 465         /* TODO: free ongoing transfers? */
 466
 467         return SR_OK;
 468 }
 469
 470 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
 471         .name = "lascar-el-usb",
 472         .longname = "Lascar EL-USB",
 473         .api_version = 1,
 474         .init = init,
 475         .cleanup = cleanup,
 476         .scan = scan,
 477         .dev_list = dev_list,
 478         .dev_clear = NULL,
 479         .config_get = config_get,
 480         .config_set = config_set,
 481         .config_list = config_list,
 482         .dev_open = dev_open,
 483         .dev_close = dev_close,
 484         .dev_acquisition_start = dev_acquisition_start,
 485         .dev_acquisition_stop = dev_acquisition_stop,
 486         .priv = NULL,
 487 };