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