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