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] == 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 index, 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->index = index;
 228         sdi->status = status;
 229         sdi->inst_type = -1;
 230         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 231         sdi->model = model ? g_strdup(model) : NULL;
 232         sdi->version = version ? g_strdup(version) : NULL;
 233         sdi->channels = NULL;
 234         sdi->channel_groups = NULL;
 235         sdi->session = NULL;
 236         sdi->conn = NULL;
 237         sdi->priv = NULL;
 238
 239         return sdi;
 240 }
 241
 242 /** @private
 243  *  Free device instance struct created by sr_dev_inst().
 244  *  @param sdi  struct* to free.
 245  */
 246 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 247 {
 248         struct sr_channel *ch;
 249         GSList *l;
 250
 251         for (l = sdi->channels; l; l = l->next) {
 252                 ch = l->data;
 253                 g_free(ch->name);
 254                 g_free(ch->priv);
 255                 g_free(ch);
 256         }
 257         g_slist_free(sdi->channels);
 258
 259         if (sdi->channel_groups)
 260                 g_slist_free(sdi->channel_groups);
 261
 262         g_free(sdi->vendor);
 263         g_free(sdi->model);
 264         g_free(sdi->version);
 265         g_free(sdi);
 266 }
 267
 268 #ifdef HAVE_LIBUSB_1_0
 269
 270 /** @private
 271  *  Allocate and init struct for USB device instance.
 272  *  @param[in]  bus @copydoc sr_usb_dev_inst::bus
 273  *  @param[in]  address @copydoc sr_usb_dev_inst::address
 274  *  @param[in]  hdl @copydoc sr_usb_dev_inst::devhdl
 275  *
 276  *  @retval NULL Error
 277  *  @retval other struct sr_usb_dev_inst * for USB device instance.
 278  */
 279 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 280                         uint8_t address, struct libusb_device_handle *hdl)
 281 {
 282         struct sr_usb_dev_inst *udi;
 283
 284         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 285                 sr_err("USB device instance malloc failed.");
 286                 return NULL;
 287         }
 288
 289         udi->bus = bus;
 290         udi->address = address;
 291         udi->devhdl = hdl;
 292
 293         return udi;
 294 }
 295
 296 /** @private
 297  *  Free struct * allocated by sr_usb_dev_inst().
 298  *  @param usb  struct* to free. Must not be NULL.
 299  */
 300 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 301 {
 302         g_free(usb);
 303 }
 304
 305 #endif
 306
 307 #ifdef HAVE_LIBSERIALPORT
 308
 309 /**
 310  * @private
 311  *
 312  * Both parameters are copied to newly allocated strings, and freed
 313  * automatically by sr_serial_dev_inst_free().
 314  *
 315  * @param[in] port OS-specific serial port specification. Examples:
 316  *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
 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.
 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         if (!port) {
 331                 sr_err("Serial port required.");
 332                 return NULL;
 333         }
 334
 335         if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
 336                 sr_err("Serial device instance malloc failed.");
 337                 return NULL;
 338         }
 339
 340         serial->port = g_strdup(port);
 341         if (serialcomm)
 342                 serial->serialcomm = g_strdup(serialcomm);
 343
 344         return serial;
 345 }
 346
 347 /** @private
 348  *  Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
 349  *  @param serial   struct sr_serial_dev_inst * to free. Must not be NULL.
 350  */
 351 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 352 {
 353         g_free(serial->port);
 354         g_free(serial->serialcomm);
 355         g_free(serial);
 356 }
 357 #endif
 358
 359 /** @private */
 360 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
 361 {
 362         struct sr_usbtmc_dev_inst *usbtmc;
 363
 364         if (!device) {
 365                 sr_err("Device name required.");
 366                 return NULL;
 367         }
 368
 369         if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
 370                 sr_err("USBTMC device instance malloc failed.");
 371                 return NULL;
 372         }
 373
 374         usbtmc->device = g_strdup(device);
 375         usbtmc->fd = -1;
 376
 377         return usbtmc;
 378 }
 379
 380 /** @private */
 381 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
 382 {
 383         g_free(usbtmc->device);
 384         g_free(usbtmc);
 385 }
 386
 387 /**
 388  * Get the list of devices/instances of the specified driver.
 389  *
 390  * @param driver The driver to use. Must not be NULL.
 391  *
 392  * @return The list of devices/instances of this driver, or NULL upon errors
 393  *         or if the list is empty.
 394  *
 395  * @since 0.2.0
 396  */
 397 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 398 {
 399         if (driver && driver->dev_list)
 400                 return driver->dev_list();
 401         else
 402                 return NULL;
 403 }
 404
 405 /**
 406  * Clear the list of device instances a driver knows about.
 407  *
 408  * @param driver The driver to use. This must be a pointer to one of
 409  *               the entries returned by sr_driver_list(). Must not be NULL.
 410  *
 411  * @retval SR_OK Success
 412  * @retval SR_ERR_ARG Invalid driver
 413  *
 414  * @since 0.2.0
 415  */
 416 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
 417 {
 418         int ret;
 419
 420         if (!driver) {
 421                 sr_err("Invalid driver.");
 422                 return SR_ERR_ARG;
 423         }
 424
 425         if (driver->dev_clear)
 426                 ret = driver->dev_clear();
 427         else
 428                 ret = std_dev_clear(driver, NULL);
 429
 430         return ret;
 431 }
 432
 433 /**
 434  * Open the specified device.
 435  *
 436  * @param sdi Device instance to use. Must not be NULL.
 437  *
 438  * @return SR_OK upon success, a negative error code upon errors.
 439  *
 440  * @since 0.2.0
 441  */
 442 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
 443 {
 444         int ret;
 445
 446         if (!sdi || !sdi->driver || !sdi->driver->dev_open)
 447                 return SR_ERR;
 448
 449         ret = sdi->driver->dev_open(sdi);
 450
 451         return ret;
 452 }
 453
 454 /**
 455  * Close the specified device.
 456  *
 457  * @param sdi Device instance to use. Must not be NULL.
 458  *
 459  * @return SR_OK upon success, a negative error code upon errors.
 460  *
 461  * @since 0.2.0
 462  */
 463 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
 464 {
 465         int ret;
 466
 467         if (!sdi || !sdi->driver || !sdi->driver->dev_close)
 468                 return SR_ERR;
 469
 470         ret = sdi->driver->dev_close(sdi);
 471
 472         return ret;
 473 }
 474
 475 /** @} */