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