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 #define LOG_PREFIX "device"
  27
  28 /**
  29  * @file
  30  *
  31  * Device handling in libsigrok.
  32  */
  33
  34 /**
  35  * @defgroup grp_devices Devices
  36  *
  37  * Device handling in libsigrok.
  38  *
  39  * @{
  40  */
  41
  42 /** @private
  43  *  Allocate and initialize new struct sr_channel
  44  *  @param[in]  index @copydoc sr_channel::index
  45  *  @param[in]  type @copydoc sr_channel::type
  46  *  @param[in]  enabled @copydoc sr_channel::enabled
  47  *  @param[in]  name @copydoc sr_channel::name
  48  *
  49  *  @return NULL (failure) or new struct sr_channel*.
  50  */
  51 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
  52                 gboolean enabled, const char *name)
  53 {
  54         struct sr_channel *ch;
  55
  56         if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
  57                 sr_err("Channel malloc failed.");
  58                 return NULL;
  59         }
  60
  61         ch->index = index;
  62         ch->type = type;
  63         ch->enabled = enabled;
  64         if (name)
  65                 ch->name = g_strdup(name);
  66
  67         return ch;
  68 }
  69
  70 /**
  71  * Set the name of the specified channel in the specified device.
  72  *
  73  * If the channel already has a different name assigned to it, it will be
  74  * removed, and the new name will be saved instead.
  75  *
  76  * @param sdi The device instance the channel is connected to.
  77  * @param[in] channelnum The number of the channel whose name to set.
  78  *                 Note that the channel numbers start at 0.
  79  * @param[in] name The new name that the specified channel should get. A copy
  80  *             of the string is made.
  81  *
  82  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
  83  *
  84  * @since 0.2.0
  85  */
  86 SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
  87                 int channelnum, const char *name)
  88 {
  89         GSList *l;
  90         struct sr_channel *ch;
  91         int ret;
  92
  93         if (!sdi) {
  94                 sr_err("%s: sdi was NULL", __func__);
  95                 return SR_ERR_ARG;
  96         }
  97
  98         ret = SR_ERR_ARG;
  99         for (l = sdi->channels; l; l = l->next) {
 100                 ch = l->data;
 101                 if (ch->index == channelnum) {
 102                         g_free(ch->name);
 103                         ch->name = g_strdup(name);
 104                         ret = SR_OK;
 105                         break;
 106                 }
 107         }
 108
 109         return ret;
 110 }
 111
 112 /**
 113  * Enable or disable a channel on the specified device.
 114  *
 115  * @param sdi The device instance the channel is connected to.
 116  * @param channelnum The channel number, starting from 0.
 117  * @param state TRUE to enable the channel, FALSE to disable.
 118  *
 119  * @return SR_OK on success or SR_ERR on failure.  In case of invalid
 120  *         arguments, SR_ERR_ARG is returned and the channel enabled state
 121  *         remains unchanged.
 122  *
 123  * @since 0.2.0
 124  */
 125 SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int channelnum,
 126                 gboolean state)
 127 {
 128         GSList *l;
 129         struct sr_channel *ch;
 130         int ret;
 131         gboolean was_enabled;
 132
 133         if (!sdi)
 134                 return SR_ERR_ARG;
 135
 136         ret = SR_ERR_ARG;
 137         for (l = sdi->channels; l; l = l->next) {
 138                 ch = l->data;
 139                 if (ch->index == channelnum) {
 140                         was_enabled = ch->enabled;
 141                         ch->enabled = state;
 142                         ret = SR_OK;
 143                         if (!state != !was_enabled && sdi->driver
 144                                         && sdi->driver->config_probe_set) {
 145                                 ret = sdi->driver->config_probe_set(
 146                                         sdi, ch, SR_CHANNEL_SET_ENABLED);
 147                                 /* Roll back change if it wasn't applicable. */
 148                                 if (ret == SR_ERR_ARG)
 149                                         ch->enabled = was_enabled;
 150                         }
 151                         break;
 152                 }
 153         }
 154
 155         return ret;
 156 }
 157
 158 /**
 159  * Add a trigger to the specified device (and the specified channel).
 160  *
 161  * If the specified channel of this device already has a trigger, it will
 162  * be silently replaced.
 163  *
 164  * @param[in,out] sdi Pointer to the device instance; must not be NULL.
 165  * @param[in] channelnum Number of channel, starting at 0.
 166  * @param[in] trigger Trigger string, in the format used by sigrok-cli
 167  *
 168  * @return SR_OK on success or SR_ERR on failure.  In case of invalid
 169  *         arguments, SR_ERR_ARG is returned and the trigger settings
 170  *         remain unchanged.
 171  *
 172  * @since 0.2.0
 173  */
 174 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum,
 175                 const char *trigger)
 176 {
 177         GSList *l;
 178         struct sr_channel *ch;
 179         char *old_trigger;
 180         int ret;
 181
 182         if (!sdi)
 183                 return SR_ERR_ARG;
 184
 185         ret = SR_ERR_ARG;
 186         for (l = sdi->channels; l; l = l->next) {
 187                 ch = l->data;
 188                 if (ch->index == channelnum) {
 189                         old_trigger = ch->trigger;
 190                         ret = SR_OK;
 191                         if (g_strcmp0(trigger, old_trigger) == 0)
 192                                 break;
 193                         /* Set new trigger if it has changed. */
 194                         ch->trigger = g_strdup(trigger);
 195
 196                         if (sdi->driver && sdi->driver->config_probe_set) {
 197                                 ret = sdi->driver->config_probe_set(
 198                                         sdi, ch, SR_CHANNEL_SET_TRIGGER);
 199                                 /* Roll back change if it wasn't applicable. */
 200                                 if (ret == SR_ERR_ARG) {
 201                                         g_free(ch->trigger);
 202                                         ch->trigger = old_trigger;
 203                                         break;
 204                                 }
 205                         }
 206                         g_free(old_trigger);
 207                         break;
 208                 }
 209         }
 210
 211         return ret;
 212 }
 213
 214 /**
 215  * Determine whether the specified device instance has the specified
 216  * capability.
 217  *
 218  * @param sdi Pointer to the device instance to be checked. Must not be NULL.
 219  *            If the device's 'driver' field is NULL (virtual device), this
 220  *            function will always return FALSE (virtual devices don't have
 221  *            a hardware capabilities list).
 222  * @param[in] key The option that should be checked for is supported by the
 223  *            specified device.
 224  *
 225  * @retval TRUE Device has the specified option
 226  * @retval FALSE Device does not have the specified option, invalid input
 227  *         parameters or other error conditions.
 228  *
 229  * @since 0.2.0
 230  */
 231 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
 232 {
 233         GVariant *gvar;
 234         const int *devopts;
 235         gsize num_opts, i;
 236         int ret;
 237
 238         if (!sdi || !sdi->driver || !sdi->driver->config_list)
 239                 return FALSE;
 240
 241         if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
 242                                 &gvar, sdi, NULL) != SR_OK)
 243                 return FALSE;
 244
 245         ret = FALSE;
 246         devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
 247         for (i = 0; i < num_opts; i++) {
 248                 if (devopts[i] == key) {
 249                         ret = TRUE;
 250                         break;
 251                 }
 252         }
 253         g_variant_unref(gvar);
 254
 255         return ret;
 256 }
 257
 258 /** @private
 259  *  Allocate and init new device instance struct.
 260  *  @param[in]  index   @copydoc sr_dev_inst::index
 261  *  @param[in]  status  @copydoc sr_dev_inst::status
 262  *  @param[in]  vendor  @copydoc sr_dev_inst::vendor
 263  *  @param[in]  model   @copydoc sr_dev_inst::model
 264  *  @param[in]  version @copydoc sr_dev_inst::version
 265  *
 266  *  @retval NULL Error
 267  *  @retval struct sr_dev_inst *. Dynamically allocated, free using
 268  *              sr_dev_inst_free().
 269  */
 270 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
 271                 const char *vendor, const char *model, const char *version)
 272 {
 273         struct sr_dev_inst *sdi;
 274
 275         if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
 276                 sr_err("Device instance malloc failed.");
 277                 return NULL;
 278         }
 279
 280         sdi->driver = NULL;
 281         sdi->index = index;
 282         sdi->status = status;
 283         sdi->inst_type = -1;
 284         sdi->vendor = vendor ? g_strdup(vendor) : NULL;
 285         sdi->model = model ? g_strdup(model) : NULL;
 286         sdi->version = version ? g_strdup(version) : NULL;
 287         sdi->channels = NULL;
 288         sdi->channel_groups = NULL;
 289         sdi->conn = NULL;
 290         sdi->priv = NULL;
 291
 292         return sdi;
 293 }
 294
 295 /** @private
 296  *  Free device instance struct created by sr_dev_inst().
 297  *  @param sdi  struct* to free.
 298  */
 299 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
 300 {
 301         struct sr_channel *ch;
 302         GSList *l;
 303
 304         for (l = sdi->channels; l; l = l->next) {
 305                 ch = l->data;
 306                 g_free(ch->name);
 307                 g_free(ch->trigger);
 308                 g_free(ch);
 309         }
 310         g_slist_free(sdi->channels);
 311
 312         if (sdi->channel_groups)
 313                 g_slist_free(sdi->channel_groups);
 314
 315         g_free(sdi->vendor);
 316         g_free(sdi->model);
 317         g_free(sdi->version);
 318         g_free(sdi);
 319 }
 320
 321 #ifdef HAVE_LIBUSB_1_0
 322
 323 /** @private
 324  *  Allocate and init struct for USB device instance.
 325  *  @param[in]  bus @copydoc sr_usb_dev_inst::bus
 326  *  @param[in]  address @copydoc sr_usb_dev_inst::address
 327  *  @param[in]  hdl @copydoc sr_usb_dev_inst::devhdl
 328  *
 329  *  @retval NULL Error
 330  *  @retval other struct sr_usb_dev_inst * for USB device instance.
 331  */
 332 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
 333                         uint8_t address, struct libusb_device_handle *hdl)
 334 {
 335         struct sr_usb_dev_inst *udi;
 336
 337         if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
 338                 sr_err("USB device instance malloc failed.");
 339                 return NULL;
 340         }
 341
 342         udi->bus = bus;
 343         udi->address = address;
 344         udi->devhdl = hdl;
 345
 346         return udi;
 347 }
 348
 349 /** @private
 350  *  Free struct * allocated by sr_usb_dev_inst().
 351  *  @param usb  struct* to free. Must not be NULL.
 352  */
 353 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
 354 {
 355         g_free(usb);
 356 }
 357
 358 #endif
 359
 360 #ifdef HAVE_LIBSERIALPORT
 361
 362 /**
 363  * @private
 364  *
 365  * Both parameters are copied to newly allocated strings, and freed
 366  * automatically by sr_serial_dev_inst_free().
 367  *
 368  * @param[in] port OS-specific serial port specification. Examples:
 369  *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
 370  * @param[in] serialcomm A serial communication parameters string, in the form
 371  *              of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
 372  *              "9600/8n1" or "600/7o2". This is an optional parameter;
 373  *              it may be filled in later.
 374  *
 375  * @return A pointer to a newly initialized struct sr_serial_dev_inst,
 376  *         or NULL on error.
 377  */
 378 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
 379                 const char *serialcomm)
 380 {
 381         struct sr_serial_dev_inst *serial;
 382
 383         if (!port) {
 384                 sr_err("Serial port required.");
 385                 return NULL;
 386         }
 387
 388         if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
 389                 sr_err("Serial device instance malloc failed.");
 390                 return NULL;
 391         }
 392
 393         serial->port = g_strdup(port);
 394         if (serialcomm)
 395                 serial->serialcomm = g_strdup(serialcomm);
 396
 397         return serial;
 398 }
 399
 400 /** @private
 401  *  Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
 402  *  @param serial   struct sr_serial_dev_inst * to free. Must not be NULL.
 403  */
 404 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
 405 {
 406         g_free(serial->port);
 407         g_free(serial->serialcomm);
 408         g_free(serial);
 409 }
 410 #endif
 411
 412 /** @private */
 413 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
 414 {
 415         struct sr_usbtmc_dev_inst *usbtmc;
 416
 417         if (!device) {
 418                 sr_err("Device name required.");
 419                 return NULL;
 420         }
 421
 422         if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
 423                 sr_err("USBTMC device instance malloc failed.");
 424                 return NULL;
 425         }
 426
 427         usbtmc->device = g_strdup(device);
 428         usbtmc->fd = -1;
 429
 430         return usbtmc;
 431 }
 432
 433 /** @private */
 434 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
 435 {
 436         g_free(usbtmc->device);
 437         g_free(usbtmc);
 438 }
 439
 440 /**
 441  * Get the list of devices/instances of the specified driver.
 442  *
 443  * @param driver The driver to use. Must not be NULL.
 444  *
 445  * @return The list of devices/instances of this driver, or NULL upon errors
 446  *         or if the list is empty.
 447  *
 448  * @since 0.2.0
 449  */
 450 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
 451 {
 452         if (driver && driver->dev_list)
 453                 return driver->dev_list();
 454         else
 455                 return NULL;
 456 }
 457
 458 /**
 459  * Clear the list of device instances a driver knows about.
 460  *
 461  * @param driver The driver to use. This must be a pointer to one of
 462  *               the entries returned by sr_driver_list(). Must not be NULL.
 463  *
 464  * @retval SR_OK Success
 465  * @retval SR_ERR_ARG Invalid driver
 466  *
 467  * @since 0.2.0
 468  */
 469 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
 470 {
 471         int ret;
 472
 473         if (!driver) {
 474                 sr_err("Invalid driver.");
 475                 return SR_ERR_ARG;
 476         }
 477
 478         if (driver->dev_clear)
 479                 ret = driver->dev_clear();
 480         else
 481                 ret = std_dev_clear(driver, NULL);
 482
 483         return ret;
 484 }
 485
 486 /**
 487  * Open the specified device.
 488  *
 489  * @param sdi Device instance to use. Must not be NULL.
 490  *
 491  * @return SR_OK upon success, a negative error code upon errors.
 492  *
 493  * @since 0.2.0
 494  */
 495 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
 496 {
 497         int ret;
 498
 499         if (!sdi || !sdi->driver || !sdi->driver->dev_open)
 500                 return SR_ERR;
 501
 502         ret = sdi->driver->dev_open(sdi);
 503
 504         return ret;
 505 }
 506
 507 /**
 508  * Close the specified device.
 509  *
 510  * @param sdi Device instance to use. Must not be NULL.
 511  *
 512  * @return SR_OK upon success, a negative error code upon errors.
 513  *
 514  * @since 0.2.0
 515  */
 516 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
 517 {
 518         int ret;
 519
 520         if (!sdi || !sdi->driver || !sdi->driver->dev_close)
 521                 return SR_ERR;
 522
 523         ret = sdi->driver->dev_close(sdi);
 524
 525         return ret;
 526 }
 527
 528 /** @} */