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