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