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_inst *lascar_scan(int bus, int address);
  27 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
  28 static struct sr_dev_driver *di = &lascar_el_usb_driver_info;
  29 static int hw_dev_close(struct sr_dev_inst *sdi);
  30
  31 static const int hwopts[] = {
  32         SR_CONF_CONN,
  33         0,
  34 };
  35
  36 static const int hwcaps[] = {
  37         SR_CONF_THERMOMETER,
  38         SR_CONF_HYGROMETER,
  39         SR_CONF_LIMIT_SAMPLES,
  40         0
  41 };
  42
  43 /* Properly close and free all devices. */
  44 static int clear_instances(void)
  45 {
  46         struct sr_dev_inst *sdi;
  47         struct drv_context *drvc;
  48         struct dev_context *devc;
  49         GSList *l;
  50
  51         if (!(drvc = di->priv))
  52                 return SR_OK;
  53
  54         for (l = drvc->instances; l; l = l->next) {
  55                 if (!(sdi = l->data))
  56                         continue;
  57                 if (!(devc = sdi->priv))
  58                         continue;
  59
  60                 hw_dev_close(sdi);
  61                 sr_usb_dev_inst_free(devc->usb);
  62                 sr_dev_inst_free(sdi);
  63         }
  64
  65         g_slist_free(drvc->instances);
  66         drvc->instances = NULL;
  67
  68         return SR_OK;
  69 }
  70
  71 static int hw_init(struct sr_context *sr_ctx)
  72 {
  73         struct drv_context *drvc;
  74
  75         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
  76                 sr_err("Driver context malloc failed.");
  77                 return SR_ERR_MALLOC;
  78         }
  79
  80         drvc->sr_ctx = sr_ctx;
  81         di->priv = drvc;
  82
  83         return SR_OK;
  84 }
  85
  86 static GSList *hw_scan(GSList *options)
  87 {
  88         struct drv_context *drvc;
  89         struct dev_context *devc;
  90         struct sr_dev_inst *sdi;
  91         struct sr_usb_dev_inst *usb;
  92         struct sr_config *src;
  93         GSList *usb_devices, *devices, *l;
  94         const char *conn;
  95
  96         (void)options;
  97
  98         if (!(drvc = di->priv)) {
  99                 sr_err("Driver was not initialized.");
 100                 return NULL;
 101         }
 102
 103         /* USB scan is always authoritative. */
 104         clear_instances();
 105
 106         conn = NULL;
 107         for (l = options; l; l = l->next) {
 108                 src = l->data;
 109                 switch (src->key) {
 110                 case SR_CONF_CONN:
 111                         conn = src->value;
 112                         break;
 113                 }
 114         }
 115         if (!conn)
 116                 return NULL;
 117
 118         devices = NULL;
 119         if ((usb_devices = sr_usb_find(drvc->sr_ctx->libusb_ctx, conn))) {
 120                 /* We have a list of sr_usb_dev_inst matching the connection
 121                  * string. Wrap them in sr_dev_inst and we're done. */
 122                 for (l = usb_devices; l; l = l->next) {
 123                         usb = l->data;
 124                         if (!(sdi = lascar_scan(usb->bus, usb->address))) {
 125                                 /* Not a Lascar EL-USB. */
 126                                 g_free(usb);
 127                                 continue;
 128                         }
 129                         devc = sdi->priv;
 130                         devc->usb = usb;
 131                         drvc->instances = g_slist_append(drvc->instances, sdi);
 132                         devices = g_slist_append(devices, sdi);
 133                 }
 134                 g_slist_free(usb_devices);
 135         } else
 136                 g_slist_free_full(usb_devices, g_free);
 137
 138         return devices;
 139 }
 140
 141 static GSList *hw_dev_list(void)
 142 {
 143         struct drv_context *drvc;
 144
 145         if (!(drvc = di->priv)) {
 146                 sr_err("Driver was not initialized.");
 147                 return NULL;
 148         }
 149
 150         return drvc->instances;
 151 }
 152
 153 static int hw_dev_open(struct sr_dev_inst *sdi)
 154 {
 155         struct drv_context *drvc;
 156         struct dev_context *devc;
 157         int ret;
 158
 159         if (!(drvc = di->priv)) {
 160                 sr_err("Driver was not initialized.");
 161                 return SR_ERR;
 162         }
 163
 164         devc = sdi->priv;
 165         if (sr_usb_open(drvc->sr_ctx->libusb_ctx, devc->usb) != SR_OK)
 166                 return SR_ERR;
 167
 168         if ((ret = libusb_claim_interface(devc->usb->devhdl, LASCAR_INTERFACE))) {
 169                 sr_err("Failed to claim interface: %s.", libusb_error_name(ret));
 170                 return SR_ERR;
 171         }
 172         sdi->status = SR_ST_ACTIVE;
 173
 174         return ret;
 175 }
 176
 177 static int hw_dev_close(struct sr_dev_inst *sdi)
 178 {
 179         struct dev_context *devc;
 180
 181         if (!di->priv) {
 182                 sr_err("Driver was not initialized.");
 183                 return SR_ERR;
 184         }
 185
 186         devc = sdi->priv;
 187         if (!devc->usb->devhdl)
 188                 /*  Nothing to do. */
 189                 return SR_OK;
 190
 191         libusb_release_interface(devc->usb->devhdl, LASCAR_INTERFACE);
 192         libusb_close(devc->usb->devhdl);
 193         devc->usb->devhdl = NULL;
 194         g_free(devc->config);
 195         sdi->status = SR_ST_INACTIVE;
 196
 197
 198         return SR_OK;
 199 }
 200
 201 static int hw_cleanup(void)
 202 {
 203         struct drv_context *drvc;
 204
 205         if (!(drvc = di->priv))
 206                 /* Can get called on an unused driver, doesn't matter. */
 207                 return SR_OK;
 208
 209         clear_instances();
 210         g_free(drvc);
 211         di->priv = NULL;
 212
 213         return SR_OK;
 214 }
 215
 216 static int config_get(int id, const void **data, const struct sr_dev_inst *sdi)
 217 {
 218         (void)sdi;
 219
 220         switch (id) {
 221         case SR_DI_HWOPTS:
 222                 *data = hwopts;
 223                 break;
 224         case SR_DI_HWCAPS:
 225                 *data = hwcaps;
 226                 break;
 227         default:
 228                 return SR_ERR_ARG;
 229         }
 230
 231         return SR_OK;
 232 }
 233
 234 static int config_set(int id, const void *value, const struct sr_dev_inst *sdi)
 235 {
 236         struct dev_context *devc;
 237         int ret;
 238
 239         if (!di->priv) {
 240                 sr_err("Driver was not initialized.");
 241                 return SR_ERR;
 242         }
 243         if (sdi->status != SR_ST_ACTIVE) {
 244                 sr_err("Device inactive, can't set config options.");
 245                 return SR_ERR;
 246         }
 247
 248         devc = sdi->priv;
 249         ret = SR_OK;
 250         switch (id) {
 251         case SR_CONF_LIMIT_SAMPLES:
 252                 devc->limit_samples = *(const uint64_t *)value;
 253                 sr_dbg("Setting sample limit to %" PRIu64 ".",
 254                        devc->limit_samples);
 255                 break;
 256         default:
 257                 sr_err("Unknown hardware capability: %d.", id);
 258                 ret = SR_ERR_ARG;
 259         }
 260
 261         return ret;
 262 }
 263
 264 static int config_list(int key, const void **data, const struct sr_dev_inst *sdi)
 265 {
 266
 267         (void)sdi;
 268
 269         switch (key) {
 270         default:
 271                 return SR_ERR_ARG;
 272         }
 273
 274         return SR_OK;
 275 }
 276
 277 static void mark_xfer(struct libusb_transfer *xfer)
 278 {
 279
 280         if (xfer->status == LIBUSB_TRANSFER_COMPLETED)
 281                 xfer->user_data = GINT_TO_POINTER(1);
 282         else
 283                 xfer->user_data = GINT_TO_POINTER(-1);
 284
 285 }
 286
 287 /* The Lascar software, in its infinite ignorance, reads a set of four
 288  * bytes from the device config struct and interprets it as a float.
 289  * That only works because they only use windows, and only on x86. However
 290  * we may be running on any architecture, any operating system. So we have
 291  * to convert these four bytes as the Lascar software would on windows/x86,
 292  * to the local representation of a float.
 293  * The source format is little-endian, with IEEE 754-2008 BINARY32 encoding. */
 294 static float binary32_le_to_float(unsigned char *buf)
 295 {
 296         GFloatIEEE754 f;
 297
 298         f.v_float = 0;
 299         f.mpn.sign = (buf[3] & 0x80) ? 1 : 0;
 300         f.mpn.biased_exponent = (buf[3] << 1) | (buf[2] >> 7);
 301         f.mpn.mantissa = buf[0] | (buf[1] << 8) | ((buf[2] & 0x7f) << 16);
 302
 303         return f.v_float;
 304 }
 305
 306 static int lascar_proc_config(const struct sr_dev_inst *sdi)
 307 {
 308         struct dev_context *devc;
 309         int ret;
 310
 311         devc = sdi->priv;
 312         if (!(devc->config = lascar_get_config(devc->usb->devhdl)))
 313                 return SR_ERR;
 314
 315         ret = SR_OK;
 316         switch (devc->profile->logformat) {
 317         case LOG_TEMP_RH:
 318                 devc->sample_size = 2;
 319                 devc->temp_unit = devc->config[0x2e] | (devc->config[0x2f] << 8);
 320                 if (devc->temp_unit != 0 && devc->temp_unit != 1) {
 321                         sr_dbg("invalid temperature unit %d", devc->temp_unit);
 322                         /* Default to Celcius, we're all adults here. */
 323                         devc->temp_unit = 0;
 324                 } else
 325                         sr_dbg("temperature unit is %s", devc->temp_unit
 326                                         ? "Fahrenheit" : "Celcius");
 327                 break;
 328         case LOG_CO:
 329                 devc->sample_size = 2;
 330                 devc->co_high = binary32_le_to_float(devc->config + 0x24);
 331                 devc->co_low = binary32_le_to_float(devc->config + 0x28);
 332                 sr_dbg("EL-USB-CO calibration high %f low %f", devc->co_high,
 333                                 devc->co_low);
 334                 break;
 335         default:
 336                 ret = SR_ERR_ARG;
 337         }
 338         devc->logged_samples = devc->config[0x1e] | (devc->config[0x1f] << 8);
 339         sr_dbg("device log contains %d samples.", devc->logged_samples);
 340
 341         return ret;
 342 }
 343
 344 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
 345                 void *cb_data)
 346 {
 347         struct sr_datafeed_packet packet;
 348         struct sr_datafeed_header header;
 349         struct dev_context *devc;
 350         struct drv_context *drvc = di->priv;
 351         struct libusb_transfer *xfer_in, *xfer_out;
 352         const struct libusb_pollfd **pfd;
 353         struct timeval tv;
 354         int ret, i;
 355         unsigned char cmd[3], resp[4], *buf;
 356
 357         if (!di->priv) {
 358                 sr_err("Driver was not initialized.");
 359                 return SR_ERR;
 360         }
 361
 362         devc = sdi->priv;
 363         devc->cb_data = cb_data;
 364
 365         if (lascar_proc_config(sdi) != SR_OK)
 366                 return SR_ERR;
 367
 368         sr_dbg("Starting log retrieval.");
 369
 370         /* Send header packet to the session bus. */
 371         sr_dbg("Sending SR_DF_HEADER.");
 372         packet.type = SR_DF_HEADER;
 373         packet.payload = (uint8_t *)&header;
 374         header.feed_version = 1;
 375         sr_session_send(devc->cb_data, &packet);
 376
 377         if (devc->logged_samples == 0) {
 378                 /* This ensures the frontend knows the session is done. */
 379                 packet.type = SR_DF_END;
 380                 sr_session_send(devc->cb_data, &packet);
 381                 return SR_OK;
 382         }
 383
 384         if (!(xfer_in = libusb_alloc_transfer(0)) ||
 385                         !(xfer_out = libusb_alloc_transfer(0)))
 386                 return SR_ERR;
 387
 388         libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 389                         0x00, 0xffff, 0x00, NULL, 0, 50);
 390         libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 391                         0x02, 0x0002, 0x00, NULL, 0, 50);
 392         libusb_control_transfer(devc->usb->devhdl, LIBUSB_REQUEST_TYPE_VENDOR,
 393                         0x02, 0x0001, 0x00, NULL, 0, 50);
 394
 395
 396         /* Flush input. The F321 requires this. */
 397         while (libusb_bulk_transfer(devc->usb->devhdl, LASCAR_EP_IN, resp,
 398                         256, &ret, 5) == 0 && ret > 0)
 399                 ;
 400
 401         libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
 402                         resp, sizeof(resp), mark_xfer, 0, 10000);
 403         if (libusb_submit_transfer(xfer_in) != 0) {
 404                 libusb_free_transfer(xfer_in);
 405                 libusb_free_transfer(xfer_out);
 406                 return SR_ERR;
 407         }
 408
 409         cmd[0] = 0x03;
 410         cmd[1] = 0xff;
 411         cmd[2] = 0xff;
 412         libusb_fill_bulk_transfer(xfer_out, devc->usb->devhdl, LASCAR_EP_OUT,
 413                         cmd, 3, mark_xfer, 0, 100);
 414         if (libusb_submit_transfer(xfer_out) != 0) {
 415                 libusb_free_transfer(xfer_in);
 416                 libusb_free_transfer(xfer_out);
 417                 return SR_ERR;
 418         }
 419
 420         tv.tv_sec = 0;
 421         tv.tv_usec = 0;
 422         while (!xfer_in->user_data || !xfer_out->user_data) {
 423                 g_usleep(5000);
 424                 libusb_handle_events_timeout(drvc->sr_ctx->libusb_ctx, &tv);
 425         }
 426         if (xfer_in->user_data != GINT_TO_POINTER(1) ||
 427                         xfer_in->user_data != GINT_TO_POINTER(1)) {
 428                 sr_dbg("no response to log transfer request");
 429                 libusb_free_transfer(xfer_in);
 430                 libusb_free_transfer(xfer_out);
 431                 return SR_ERR;
 432         }
 433         if (xfer_in->actual_length != 3 || xfer_in->buffer[0] != 2) {
 434                 sr_dbg("invalid response to log transfer request");
 435                 libusb_free_transfer(xfer_in);
 436                 libusb_free_transfer(xfer_out);
 437                 return SR_ERR;
 438         }
 439         devc->log_size = xfer_in->buffer[1] + (xfer_in->buffer[2] << 8);
 440         libusb_free_transfer(xfer_out);
 441
 442         pfd = libusb_get_pollfds(drvc->sr_ctx->libusb_ctx);
 443         for (i = 0; pfd[i]; i++) {
 444                 /* Handle USB events every 100ms, for decent latency. */
 445                 sr_source_add(pfd[i]->fd, pfd[i]->events, 100,
 446                                 lascar_el_usb_handle_events, (void *)sdi);
 447                 /* We'll need to remove this fd later. */
 448                 devc->usbfd[i] = pfd[i]->fd;
 449         }
 450         devc->usbfd[i] = -1;
 451
 452         buf = g_try_malloc(4096);
 453         libusb_fill_bulk_transfer(xfer_in, devc->usb->devhdl, LASCAR_EP_IN,
 454                         buf, 4096, lascar_el_usb_receive_transfer, cb_data, 100);
 455         if ((ret = libusb_submit_transfer(xfer_in) != 0)) {
 456                 sr_err("Unable to submit transfer: %s.", libusb_error_name(ret));
 457                 libusb_free_transfer(xfer_in);
 458                 g_free(buf);
 459                 return SR_ERR;
 460         }
 461
 462         return SR_OK;
 463 }
 464
 465 SR_PRIV int hw_dev_acquisition_stop(struct sr_dev_inst *sdi, void *cb_data)
 466 {
 467         (void)cb_data;
 468
 469         if (!di->priv) {
 470                 sr_err("Driver was not initialized.");
 471                 return SR_ERR;
 472         }
 473
 474         if (sdi->status != SR_ST_ACTIVE) {
 475                 sr_err("Device inactive, can't stop acquisition.");
 476                 return SR_ERR;
 477         }
 478
 479         sdi->status = SR_ST_STOPPING;
 480         /* TODO: free ongoing transfers? */
 481
 482         return SR_OK;
 483 }
 484
 485 SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info = {
 486         .name = "lascar-el-usb",
 487         .longname = "Lascar EL-USB",
 488         .api_version = 1,
 489         .init = hw_init,
 490         .cleanup = hw_cleanup,
 491         .scan = hw_scan,
 492         .dev_list = hw_dev_list,
 493         .dev_clear = clear_instances,
 494         .config_get = config_get,
 495         .config_set = config_set,
 496         .config_list = config_list,
 497         .dev_open = hw_dev_open,
 498         .dev_close = hw_dev_close,
 499         .dev_acquisition_start = hw_dev_acquisition_start,
 500         .dev_acquisition_stop = hw_dev_acquisition_stop,
 501         .priv = NULL,
 502 };