src/device.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 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 <stdio.h>
  21 #include <glib.h>
  22 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  23 #include "libsigrok.h"
  24 #include "libsigrok-internal.h"
  25
  26 /** @cond PRIVATE */
  27 #define LOG_PREFIX "device"
  28 /** @endcond */
  29
  30 /**
  31  * @file
  32  *
  33  * Device handling in libsigrok.
  34  */
  35
  36 /**
  37  * @defgroup grp_devices Devices
  38  *
  39  * Device handling in libsigrok.
  40  *
  41  * @{
  42  */
  43
  44 /** @private
  45  *  Allocate and initialize new struct sr_channel
  46  *  @param[in]  index @copydoc sr_channel::index
  47  *  @param[in]  type @copydoc sr_channel::type
  48  *  @param[in]  enabled @copydoc sr_channel::enabled
  49  *  @param[in]  name @copydoc sr_channel::name
  50  *
  51  *  @return NULL (failure) or new struct sr_channel*.
  52  */
  53 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
  54                 gboolean enabled, const char *name)
  55 {
  56         struct sr_channel *ch;
  57
  58         if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
  59                 sr_err("Channel malloc failed.");
  60                 return NULL;
  61         }
  62
  63         ch->index = index;
  64         ch->type = type;
  65         ch->enabled = enabled;
  66         if (name)
  67                 ch->name = g_strdup(name);
  68
  69         return ch;
  70 }
  71
  72 /**
  73  * Set the name of the specified channel in the specified device.
  74  *
  75  * If the channel already has a different name assigned to it, it will be
  76  * removed, and the new name will be saved instead.
  77  *
  78  * @param sdi The device instance the channel is connected to.
  79  * @param[in] channelnum The number of the channel whose name to set.
  80  *                 Note that the channel numbers start at 0.
  81  * @param[in] name The new name that the specified channel should get. A copy
  82  *             of the string is made.
  83  *
  84  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  85  *
  86  * @since 0.3.0
  87  */
  88 SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
  89                 int channelnum, const char *name)
  90 {
  91         GSList *l;
  92         struct sr_channel *ch;
  93         int ret;
  94
  95         if (!sdi) {
  96                 sr_err("%s: sdi was NULL", __func__);
  97                 return SR_ERR_ARG;
  98         }
  99
 100         ret = SR_ERR_ARG;
 101         for (l = sdi->channels; l; l = l->next) {
 102                 ch = l->data;
 103                 if (ch->index == channelnum) {
 104                         g_free(ch->name);
 105                         ch->name = g_strdup(name);
 106                         ret = SR_OK;
 107                         break;
 108                 }
 109         }
 110
 111         return ret;
 112 }
 113
 114 /**
 115  * Enable or disable a channel on the specified device.
 116  *
 117  * @param sdi The device instance the channel is connected to.
 118  * @param channelnum The channel number, starting from 0.
 119  * @param state TRUE to enable the channel, FALSE to disable.
 120  *
 121  * @return SR_OK on success or SR_ERR on failure.  In case of invalid
 122  *         arguments, SR_ERR_ARG is returned and the channel enabled state
 123  *         remains unchanged.
 124  *
 125  * @since 0.3.0
 126  */
 127 SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
 128                 gboolean state)
 129 {
 130         GSList *l;
 131         struct sr_channel *ch;
 132         int ret;
 133         gboolean was_enabled;
 134
 135         if (!sdi)
 136                 return SR_ERR_ARG;
 137
 138         ret = SR_ERR_ARG;
 139         for (l = sdi->channels; l; l = l->next) {
 140                 ch = l->data;
 141                 if (ch->index == channelnum) {
 142                         was_enabled = ch->enabled;
 143                         ch->enabled = state;
 144                         ret = SR_OK;
 145                         if (!state != !was_enabled && sdi->driver
 146                                         && sdi->driver->config_channel_set) {
 147                                 ret = sdi->driver->config_channel_set(
 148                                         sdi, ch, SR_CHANNEL_SET_ENABLED);
 149                                 /* Roll back change if it wasn't applicable. */
 150                                 if (ret == SR_ERR_ARG)
 151                                         ch->enabled = was_enabled;
 152                         }
 153                         break;
 154                 }
 155         }
 156
 157         return ret;
 158 }
 159
 160 /**
 161  * Determine whether the specified device instance has the specified
 162  * capability.
 163  *
 164  * @param sdi Pointer to the device instance to be checked. Must not be NULL.
 165  *            If the device's 'driver' field is NULL (virtual device), this
 166  *            function will always return FALSE (virtual devices don't have
 167  *            a hardware capabilities list).
 168  * @param[in] key The option that should be checked for is supported by the
 169  *            specified device.
 170  *
 171  * @retval TRUE Device has the specified option
 172  * @retval FALSE Device does not have the specified option, invalid input
 173  *         parameters or other error conditions.
 174  *
 175  * @since 0.2.0
 176  */
 177 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
 178 {
 179         GVariant *gvar;
 180         const int *devopts;
 181         gsize num_opts, i;
 182         int ret;
 183
 184         if (!sdi || !sdi->driver || !sdi->driver->config_list)
 185                 return FALSE;
 186
 187         if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
 188                                 &gvar, sdi, NULL) != SR_OK)
 189                 return FALSE;
 190
 191         ret = FALSE;
 192         devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
 193         for (i = 0; i < num_opts; i++) {
 194                 if ((devopts[i] & SR_CONF_MASK) == key) {
 195                         ret = TRUE;
 196                         break;
 197                 }
 198         }
 199         g_variant_unref(gvar);
 200
 201         return ret;
 202 }
 203
 204 /** @private
 205  *  Allocate and init new device instance struct.
 206  *  @param[in]  index   @copydoc sr_dev_inst::index
 207  *  @param[in]  status  @copydoc sr_dev_inst::status
 208  *  @param[in]  vendor  @copydoc sr_dev_inst::vendor
 209  *  @param[in]  model   @copydoc sr_dev_inst::model
 210  *  @param[in]  version @copydoc sr_dev_inst::version
 211  *
 212  *  @retval NULL Error
 213  *  @retval struct sr_dev_inst *. Dynamically allocated, free using
 214  *              sr_dev_inst_free().
 215  */
 216 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
 217                 const char *vendor, const char *model, const char *version)
 218 {
 219         struct sr_dev_inst *sdi;
 220
 221         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 222                 sr_err("Device instance malloc failed.");
 223                 return NULL;
 224         }
 225
 226         sdi->driver = NULL;
 227         sdi->status = status;
 228         sdi->inst_type = -1;
 229         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 230         sdi->model = model ? g_strdup(model) : NULL;
 231         sdi->version = version ? g_strdup(version) : NULL;
 232         sdi->serial_num = NULL;
 233         sdi->connection_id = NULL;
 234         sdi->channels = NULL;
 235         sdi->channel_groups = NULL;
 236         sdi->session = NULL;
 237         sdi->conn = NULL;
 238         sdi->priv = NULL;
 239
 240         return sdi;
 241 }
 242
 243 /** @private
 244  *  Free device instance struct created by sr_dev_inst().
 245  *  @param sdi device instance to free.
 246  */
 247 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 248 {
 249         struct sr_channel *ch;
 250         struct sr_channel_group *cg;
 251         GSList *l;
 252
 253         for (l = sdi->channels; l; l = l->next) {
 254                 ch = l->data;
 255                 g_free(ch->name);
 256                 g_free(ch->priv);
 257                 g_free(ch);
 258         }
 259         g_slist_free(sdi->channels);
 260
 261         for (l = sdi->channel_groups; l; l = l->next) {
 262                 cg = l->data;
 263                 g_free(cg->name);
 264                 g_slist_free(cg->channels);
 265                 g_free(cg->priv);
 266                 g_free(cg);
 267         }
 268         g_slist_free(sdi->channel_groups);
 269
 270         g_free(sdi->vendor);
 271         g_free(sdi->model);
 272         g_free(sdi->version);
 273         g_free(sdi->serial_num);
 274         g_free(sdi->connection_id);
 275         g_free(sdi);
 276 }
 277
 278 #ifdef HAVE_LIBUSB_1_0
 279
 280 /** @private
 281  *  Allocate and init struct for USB device instance.
 282  *  @param[in]  bus @copydoc sr_usb_dev_inst::bus
 283  *  @param[in]  address @copydoc sr_usb_dev_inst::address
 284  *  @param[in]  hdl @copydoc sr_usb_dev_inst::devhdl
 285  *
 286  *  @retval NULL Error
 287  *  @retval other struct sr_usb_dev_inst * for USB device instance.
 288  */
 289 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 290                         uint8_t address, struct libusb_device_handle *hdl)
 291 {
 292         struct sr_usb_dev_inst *udi;
 293
 294         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 295                 sr_err("USB device instance malloc failed.");
 296                 return NULL;
 297         }
 298
 299         udi->bus = bus;
 300         udi->address = address;
 301         udi->devhdl = hdl;
 302
 303         return udi;
 304 }
 305
 306 /** @private
 307  *  Free struct * allocated by sr_usb_dev_inst().
 308  *  @param usb  struct* to free. Must not be NULL.
 309  */
 310 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 311 {
 312         g_free(usb);
 313 }
 314
 315 #endif
 316
 317 #ifdef HAVE_LIBSERIALPORT
 318
 319 /**
 320  * @private
 321  *
 322  * Both parameters are copied to newly allocated strings, and freed
 323  * automatically by sr_serial_dev_inst_free().
 324  *
 325  * @param[in] port OS-specific serial port specification. Examples:
 326  *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
 327  * @param[in] serialcomm A serial communication parameters string, in the form
 328  *              of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
 329  *              "9600/8n1" or "600/7o2". This is an optional parameter;
 330  *              it may be filled in later.
 331  *
 332  * @return A pointer to a newly initialized struct sr_serial_dev_inst,
 333  *         or NULL on error.
 334  */
 335 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 336                 const char *serialcomm)
 337 {
 338         struct sr_serial_dev_inst *serial;
 339
 340         if (!port) {
 341                 sr_err("Serial port required.");
 342                 return NULL;
 343         }
 344
 345         if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
 346                 sr_err("Serial device instance malloc failed.");
 347                 return NULL;
 348         }
 349
 350         serial->port = g_strdup(port);
 351         if (serialcomm)
 352                 serial->serialcomm = g_strdup(serialcomm);
 353
 354         return serial;
 355 }
 356
 357 /** @private
 358  *  Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
 359  *  @param serial   struct sr_serial_dev_inst * to free. Must not be NULL.
 360  */
 361 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 362 {
 363         g_free(serial->port);
 364         g_free(serial->serialcomm);
 365         g_free(serial);
 366 }
 367 #endif
 368
 369 /** @private */
 370 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
 371 {
 372         struct sr_usbtmc_dev_inst *usbtmc;
 373
 374         if (!device) {
 375                 sr_err("Device name required.");
 376                 return NULL;
 377         }
 378
 379         if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
 380                 sr_err("USBTMC device instance malloc failed.");
 381                 return NULL;
 382         }
 383
 384         usbtmc->device = g_strdup(device);
 385         usbtmc->fd = -1;
 386
 387         return usbtmc;
 388 }
 389
 390 /** @private */
 391 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
 392 {
 393         g_free(usbtmc->device);
 394         g_free(usbtmc);
 395 }
 396
 397 /**
 398  * Get the list of devices/instances of the specified driver.
 399  *
 400  * @param driver The driver to use. Must not be NULL.
 401  *
 402  * @return The list of devices/instances of this driver, or NULL upon errors
 403  *         or if the list is empty.
 404  *
 405  * @since 0.2.0
 406  */
 407 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 408 {
 409         if (driver && driver->dev_list)
 410                 return driver->dev_list();
 411         else
 412                 return NULL;
 413 }
 414
 415 /**
 416  * Clear the list of device instances a driver knows about.
 417  *
 418  * @param driver The driver to use. This must be a pointer to one of
 419  *               the entries returned by sr_driver_list(). Must not be NULL.
 420  *
 421  * @retval SR_OK Success
 422  * @retval SR_ERR_ARG Invalid driver
 423  *
 424  * @since 0.2.0
 425  */
 426 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
 427 {
 428         int ret;
 429
 430         if (!driver) {
 431                 sr_err("Invalid driver.");
 432                 return SR_ERR_ARG;
 433         }
 434
 435         if (driver->dev_clear)
 436                 ret = driver->dev_clear();
 437         else
 438                 ret = std_dev_clear(driver, NULL);
 439
 440         return ret;
 441 }
 442
 443 /**
 444  * Open the specified device.
 445  *
 446  * @param sdi Device instance to use. Must not be NULL.
 447  *
 448  * @return SR_OK upon success, a negative error code upon errors.
 449  *
 450  * @since 0.2.0
 451  */
 452 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
 453 {
 454         int ret;
 455
 456         if (!sdi || !sdi->driver || !sdi->driver->dev_open)
 457                 return SR_ERR;
 458
 459         ret = sdi->driver->dev_open(sdi);
 460
 461         return ret;
 462 }
 463
 464 /**
 465  * Close the specified device.
 466  *
 467  * @param sdi Device instance to use. Must not be NULL.
 468  *
 469  * @return SR_OK upon success, a negative error code upon errors.
 470  *
 471  * @since 0.2.0
 472  */
 473 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
 474 {
 475         int ret;
 476
 477         if (!sdi || !sdi->driver || !sdi->driver->dev_close)
 478                 return SR_ERR;
 479
 480         ret = sdi->driver->dev_close(sdi);
 481
 482         return ret;
 483 }
 484
 485 /**
 486  * Queries a device instances' driver.
 487  *
 488  * @param sdi Device instance to use. Must not be NULL.
 489  *
 490  * @return The driver instance or NULL on error.
 491  */
 492 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(struct sr_dev_inst *sdi)
 493 {
 494         if (!sdi || !sdi->driver)
 495                 return NULL;
 496
 497         return sdi->driver;
 498 }
 499
 500 /**
 501  * Queries a device instances' vendor.
 502  *
 503  * @param sdi Device instance to use. Must not be NULL.
 504  *
 505  * @return The vendor string or NULL.
 506  */
 507 SR_API const char *sr_dev_inst_vendor_get(struct sr_dev_inst *sdi)
 508 {
 509         if (!sdi)
 510                 return NULL;
 511
 512         return sdi->vendor;
 513 }
 514
 515 /**
 516  * Queries a device instances' model.
 517  *
 518  * @param sdi Device instance to use. Must not be NULL.
 519  *
 520  * @return The model string or NULL.
 521  */
 522 SR_API const char *sr_dev_inst_model_get(struct sr_dev_inst *sdi)
 523 {
 524         if (!sdi)
 525                 return NULL;
 526
 527         return sdi->model;
 528 }
 529
 530 /**
 531  * Queries a device instances' version.
 532  *
 533  * @param sdi Device instance to use. Must not be NULL.
 534  *
 535  * @return The version string or NULL.
 536  */
 537 SR_API const char *sr_dev_inst_version_get(struct sr_dev_inst *sdi)
 538 {
 539         if (!sdi)
 540                 return NULL;
 541
 542         return sdi->version;
 543 }
 544
 545 /**
 546  * Queries a device instances' serial number.
 547  *
 548  * @param sdi Device instance to use. Must not be NULL.
 549  *
 550  * @return The serial number string or NULL.
 551  */
 552 SR_API const char *sr_dev_inst_sernum_get(struct sr_dev_inst *sdi)
 553 {
 554         if (!sdi)
 555                 return NULL;
 556
 557         return sdi->serial_num;
 558 }
 559
 560 /**
 561  * Queries a device instances' connection identifier.
 562  *
 563  * @param sdi Device instance to use. Must not be NULL.
 564  *
 565  * @return A copy of the connection id string or NULL. The caller is responsible
 566  *         for g_free()ing the string when it is no longer needed.
 567  */
 568 SR_API const char *sr_dev_inst_connid_get(struct sr_dev_inst *sdi)
 569 {
 570         struct drv_context *drvc;
 571         int r, cnt, i, a, b;
 572         char connection_id[64];
 573
 574 #ifdef HAVE_LIBUSB_1_0
 575         struct sr_usb_dev_inst *usb;
 576         struct libusb_device **devlist;
 577         struct libusb_device_descriptor des;
 578 #endif
 579
 580         if (!sdi)
 581                 return NULL;
 582
 583 #ifdef HAVE_LIBSERIALPORT
 584         struct sr_serial_dev_inst *serial;
 585
 586         if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
 587                 /* connection_id isn't populated, let's do that here. */
 588
 589                 serial = sdi->conn;
 590                 sdi->connection_id = g_strdup(serial->port);
 591         }
 592 #endif
 593
 594
 595 #ifdef HAVE_LIBUSB_1_0
 596         if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
 597                 /* connection_id isn't populated, let's do that here. */
 598
 599                 drvc = sdi->driver->priv;
 600                 usb = sdi->conn;
 601
 602                 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
 603                         sr_err("Failed to retrieve device list: %s.",
 604                                libusb_error_name(cnt));
 605                         return NULL;
 606                 }
 607
 608                 for (i = 0; i < cnt; i++) {
 609                         if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
 610                                 sr_err("Failed to get device descriptor: %s.",
 611                                        libusb_error_name(r));
 612                                 continue;
 613                         }
 614
 615                         /* Find the USB device by the logical address we know. */
 616                         b = libusb_get_bus_number(devlist[i]);
 617                         a = libusb_get_device_address(devlist[i]);
 618                         if (b != usb->bus || a != usb->address)
 619                                 continue;
 620
 621                         usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
 622                         sdi->connection_id = g_strdup(connection_id);
 623                         break;
 624                 }
 625
 626                 libusb_free_device_list(devlist, 1);
 627         }
 628 #endif
 629
 630         return sdi->connection_id;
 631 }
 632
 633 /**
 634  * Queries a device instances' channel list.
 635  *
 636  * @param sdi Device instance to use. Must not be NULL.
 637  *
 638  * @return The GSList of channels or NULL.
 639  */
 640 SR_API GSList *sr_dev_inst_channels_get(struct sr_dev_inst *sdi)
 641 {
 642         if (!sdi)
 643                 return NULL;
 644
 645         return sdi->channels;
 646 }
 647
 648 /**
 649  * Queries a device instances' channel groups list.
 650  *
 651  * @param sdi Device instance to use. Must not be NULL.
 652  *
 653  * @return The GSList of channel groups or NULL.
 654  */
 655 SR_API GSList *sr_dev_inst_channel_groups_get(struct sr_dev_inst *sdi)
 656 {
 657         if (!sdi)
 658                 return NULL;
 659
 660         return sdi->channel_groups;
 661 }
 662
 663 /** @} */