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