hwdriver.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 <stdlib.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23 #include <dirent.h>
  24 #include <string.h>
  25 #include <glib.h>
  26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
  27 #include "libsigrok.h"
  28 #include "libsigrok-internal.h"
  29
  30 /* Message logging helpers with subsystem-specific prefix string. */
  31 #define LOG_PREFIX "hwdriver: "
  32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  37 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  38
  39 /**
  40  * @file
  41  *
  42  * Hardware driver handling in libsigrok.
  43  */
  44
  45 /**
  46  * @defgroup grp_driver Hardware drivers
  47  *
  48  * Hardware driver handling in libsigrok.
  49  *
  50  * @{
  51  */
  52
  53 static struct sr_config_info sr_config_info_data[] = {
  54         {SR_CONF_CONN, SR_T_CHAR, "conn",
  55                 "Connection", NULL},
  56         {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
  57                 "Serial communication", NULL},
  58         {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
  59                 "Sample rate", NULL},
  60         {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
  61                 "Pre-trigger capture ratio", NULL},
  62         {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
  63                 "Pattern generator mode", NULL},
  64         {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
  65                 "Trigger types", NULL},
  66         {SR_CONF_RLE, SR_T_BOOL, "rle",
  67                 "Run Length Encoding", NULL},
  68         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
  69                 "Trigger slope", NULL},
  70         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
  71                 "Trigger source", NULL},
  72         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
  73                 "Horizontal trigger position", NULL},
  74         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
  75                 "Buffer size", NULL},
  76         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
  77                 "Time base", NULL},
  78         {SR_CONF_FILTER, SR_T_CHAR, "filter",
  79                 "Filter targets", NULL},
  80         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
  81                 "Volts/div", NULL},
  82         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
  83                 "Coupling", NULL},
  84         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
  85                 "Datalog", NULL},
  86         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
  87                 "Sound pressure level frequency weighting", NULL},
  88         {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
  89                 "Sound pressure level time weighting", NULL},
  90         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
  91                 "Hold max", NULL},
  92         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
  93                 "Hold min", NULL},
  94         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
  95                 "Sound pressure level measurement range", NULL},
  96         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
  97                 "Power off", NULL},
  98         {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
  99                 "Data source", NULL},
 100         {0, 0, NULL, NULL, NULL},
 101 };
 102
 103 /** @cond PRIVATE */
 104 #ifdef HAVE_HW_BRYMEN_DMM
 105 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
 106 #endif
 107 #ifdef HAVE_HW_CEM_DT_885X
 108 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
 109 #endif
 110 #ifdef HAVE_HW_COLEAD_SLM
 111 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
 112 #endif
 113 #ifdef HAVE_HW_DEMO
 114 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 115 #endif
 116 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 117 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
 118 #endif
 119 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
 120 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
 121 #endif
 122 #ifdef HAVE_HW_LASCAR_EL_USB
 123 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
 124 #endif
 125 #ifdef HAVE_HW_MIC_985XX
 126 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
 127 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
 128 #endif
 129 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 130 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
 131 #endif
 132 #ifdef HAVE_HW_OLS
 133 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 134 #endif
 135 #ifdef HAVE_HW_RIGOL_DS1XX2
 136 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 137 #endif
 138 #ifdef HAVE_HW_TONDAJ_SL_814
 139 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 140 #endif
 141 #ifdef HAVE_HW_VICTOR_DMM
 142 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 143 #endif
 144 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 145 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 146 #endif
 147 #ifdef HAVE_HW_ASIX_SIGMA
 148 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 149 #endif
 150 #ifdef HAVE_HW_CHRONOVU_LA8
 151 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 152 #endif
 153 #ifdef HAVE_HW_LINK_MSO19
 154 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 155 #endif
 156 #ifdef HAVE_HW_ALSA
 157 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 158 #endif
 159 #ifdef HAVE_HW_FX2LAFW
 160 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 161 #endif
 162 #ifdef HAVE_HW_HANTEK_DSO
 163 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 164 #endif
 165 #ifdef HAVE_HW_AGILENT_DMM
 166 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 167 #endif
 168 #ifdef HAVE_HW_FLUKE_DMM
 169 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 170 #endif
 171 #ifdef HAVE_HW_SERIAL_DMM
 172 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 173 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 174 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 175 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 176 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 177 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 178 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 179 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 180 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 181 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 182 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
 183 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 184 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
 185 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
 186 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
 187 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 188 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
 189 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 190 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
 191 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
 192 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
 193 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 194 #endif
 195 #ifdef HAVE_HW_UNI_T_DMM
 196 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
 197 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
 198 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
 199 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
 200 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 201 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
 202 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 203 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
 204 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
 205 #endif
 206 /** @endcond */
 207
 208 static struct sr_dev_driver *drivers_list[] = {
 209 #ifdef HAVE_HW_BRYMEN_DMM
 210         &brymen_bm857_driver_info,
 211 #endif
 212 #ifdef HAVE_HW_CEM_DT_885X
 213         &cem_dt_885x_driver_info,
 214 #endif
 215 #ifdef HAVE_HW_COLEAD_SLM
 216         &colead_slm_driver_info,
 217 #endif
 218 #ifdef HAVE_HW_DEMO
 219         &demo_driver_info,
 220 #endif
 221 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 222         &ikalogic_scanalogic2_driver_info,
 223 #endif
 224 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
 225         &ikalogic_scanaplus_driver_info,
 226 #endif
 227 #ifdef HAVE_HW_LASCAR_EL_USB
 228         &lascar_el_usb_driver_info,
 229 #endif
 230 #ifdef HAVE_HW_MIC_985XX
 231         &mic_98581_driver_info,
 232         &mic_98583_driver_info,
 233 #endif
 234 #ifdef HAVE_HW_NEXUS_OSCIPRIME
 235         &nexus_osciprime_driver_info,
 236 #endif
 237 #ifdef HAVE_HW_OLS
 238         &ols_driver_info,
 239 #endif
 240 #ifdef HAVE_HW_RIGOL_DS1XX2
 241         &rigol_ds1xx2_driver_info,
 242 #endif
 243 #ifdef HAVE_HW_TONDAJ_SL_814
 244         &tondaj_sl_814_driver_info,
 245 #endif
 246 #ifdef HAVE_HW_VICTOR_DMM
 247         &victor_dmm_driver_info,
 248 #endif
 249 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 250         &zeroplus_logic_cube_driver_info,
 251 #endif
 252 #ifdef HAVE_HW_ASIX_SIGMA
 253         &asix_sigma_driver_info,
 254 #endif
 255 #ifdef HAVE_HW_CHRONOVU_LA8
 256         &chronovu_la8_driver_info,
 257 #endif
 258 #ifdef HAVE_HW_LINK_MSO19
 259         &link_mso19_driver_info,
 260 #endif
 261 #ifdef HAVE_HW_ALSA
 262         &alsa_driver_info,
 263 #endif
 264 #ifdef HAVE_HW_FX2LAFW
 265         &fx2lafw_driver_info,
 266 #endif
 267 #ifdef HAVE_HW_HANTEK_DSO
 268         &hantek_dso_driver_info,
 269 #endif
 270 #ifdef HAVE_HW_AGILENT_DMM
 271         &agdmm_driver_info,
 272 #endif
 273 #ifdef HAVE_HW_FLUKE_DMM
 274         &flukedmm_driver_info,
 275 #endif
 276 #ifdef HAVE_HW_SERIAL_DMM
 277         &digitek_dt4000zc_driver_info,
 278         &tekpower_tp4000zc_driver_info,
 279         &metex_me31_driver_info,
 280         &peaktech_3410_driver_info,
 281         &mastech_mas345_driver_info,
 282         &va_va18b_driver_info,
 283         &metex_m3640d_driver_info,
 284         &peaktech_4370_driver_info,
 285         &pce_pce_dm32_driver_info,
 286         &radioshack_22_168_driver_info,
 287         &radioshack_22_805_driver_info,
 288         &radioshack_22_812_driver_info,
 289         &tecpel_dmm_8060_ser_driver_info,
 290         &tecpel_dmm_8061_ser_driver_info,
 291         &voltcraft_m3650d_driver_info,
 292         &voltcraft_vc820_ser_driver_info,
 293         &voltcraft_vc830_ser_driver_info,
 294         &voltcraft_vc840_ser_driver_info,
 295         &uni_t_ut60a_ser_driver_info,
 296         &uni_t_ut60e_ser_driver_info,
 297         &uni_t_ut61d_ser_driver_info,
 298         &uni_t_ut61e_ser_driver_info,
 299 #endif
 300 #ifdef HAVE_HW_UNI_T_DMM
 301         &tecpel_dmm_8060_driver_info,
 302         &tecpel_dmm_8061_driver_info,
 303         &uni_t_ut60a_driver_info,
 304         &uni_t_ut60e_driver_info,
 305         &uni_t_ut61d_driver_info,
 306         &uni_t_ut61e_driver_info,
 307         &voltcraft_vc820_driver_info,
 308         &voltcraft_vc830_driver_info,
 309         &voltcraft_vc840_driver_info,
 310 #endif
 311         NULL,
 312 };
 313
 314 /**
 315  * Return the list of supported hardware drivers.
 316  *
 317  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 318  */
 319 SR_API struct sr_dev_driver **sr_driver_list(void)
 320 {
 321
 322         return drivers_list;
 323 }
 324
 325 /**
 326  * Initialize a hardware driver.
 327  *
 328  * This usually involves memory allocations and variable initializations
 329  * within the driver, but _not_ scanning for attached devices.
 330  * The API call sr_driver_scan() is used for that.
 331  *
 332  * @param ctx A libsigrok context object allocated by a previous call to
 333  *            sr_init(). Must not be NULL.
 334  * @param driver The driver to initialize. This must be a pointer to one of
 335  *               the entries returned by sr_driver_list(). Must not be NULL.
 336  *
 337  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 338  *         SR_ERR_BUG upon internal errors, or another negative error code
 339  *         upon other errors.
 340  */
 341 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 342 {
 343         int ret;
 344
 345         if (!ctx) {
 346                 sr_err("Invalid libsigrok context, can't initialize.");
 347                 return SR_ERR_ARG;
 348         }
 349
 350         if (!driver) {
 351                 sr_err("Invalid driver, can't initialize.");
 352                 return SR_ERR_ARG;
 353         }
 354
 355         sr_spew("Initializing driver '%s'.", driver->name);
 356         if ((ret = driver->init(ctx)) < 0)
 357                 sr_err("Failed to initialize the driver: %d.", ret);
 358
 359         return ret;
 360 }
 361
 362 /**
 363  * Tell a hardware driver to scan for devices.
 364  *
 365  * In addition to the detection, the devices that are found are also
 366  * initialized automatically. On some devices, this involves a firmware upload,
 367  * or other such measures.
 368  *
 369  * The order in which the system is scanned for devices is not specified. The
 370  * caller should not assume or rely on any specific order.
 371  *
 372  * Before calling sr_driver_scan(), the user must have previously initialized
 373  * the driver by calling sr_driver_init().
 374  *
 375  * @param driver The driver that should scan. This must be a pointer to one of
 376  *               the entries returned by sr_driver_list(). Must not be NULL.
 377  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 378  *                scanner. Can be NULL/empty.
 379  *
 380  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 381  *         found (or errors were encountered). This list must be freed by the
 382  *         caller using g_slist_free(), but without freeing the data pointed
 383  *         to in the list.
 384  */
 385 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 386 {
 387         GSList *l;
 388
 389         if (!driver) {
 390                 sr_err("Invalid driver, can't scan for devices.");
 391                 return NULL;
 392         }
 393
 394         if (!driver->priv) {
 395                 sr_err("Driver not initialized, can't scan for devices.");
 396                 return NULL;
 397         }
 398
 399         l = driver->scan(options);
 400
 401         sr_spew("Scan of '%s' found %d devices.", driver->name,
 402                 g_slist_length(l));
 403
 404         return l;
 405 }
 406
 407 /** @private */
 408 SR_PRIV void sr_hw_cleanup_all(void)
 409 {
 410         int i;
 411         struct sr_dev_driver **drivers;
 412
 413         drivers = sr_driver_list();
 414         for (i = 0; drivers[i]; i++) {
 415                 if (drivers[i]->cleanup)
 416                         drivers[i]->cleanup();
 417         }
 418 }
 419
 420 /** A floating reference can be passed in for data. */
 421 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 422 {
 423         struct sr_config *src;
 424
 425         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 426                 return NULL;
 427         src->key = key;
 428         src->data = g_variant_ref_sink(data);
 429
 430         return src;
 431 }
 432
 433 SR_PRIV void sr_config_free(struct sr_config *src)
 434 {
 435
 436         if (!src || !src->data) {
 437                 sr_err("%s: invalid data!", __func__);
 438                 return;
 439         }
 440
 441         g_variant_unref(src->data);
 442         g_free(src);
 443
 444 }
 445
 446 /**
 447  * Returns information about the given driver or device instance.
 448  *
 449  * @param driver The sr_dev_driver struct to query.
 450  * @param key The configuration key (SR_CONF_*).
 451  * @param data Pointer to a GVariant where the value will be stored. Must
 452  *             not be NULL. The caller is given ownership of the GVariant
 453  *             and must thus decrease the refcount after use. However if
 454  *             this function returns an error code, the field should be
 455  *             considered unused, and should not be unreferenced.
 456  * @param sdi (optional) If the key is specific to a device, this must
 457  *            contain a pointer to the struct sr_dev_inst to be checked.
 458  *            Otherwise it must be NULL.
 459  *
 460  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 461  *         may be returned by the driver indicating it doesn't know that key,
 462  *         but this is not to be flagged as an error by the caller; merely
 463  *         as an indication that it's not applicable.
 464  */
 465 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
 466                 GVariant **data, const struct sr_dev_inst *sdi)
 467 {
 468         int ret;
 469
 470         if (!driver || !data)
 471                 return SR_ERR;
 472
 473         if (!driver->config_get)
 474                 return SR_ERR_ARG;
 475
 476         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
 477                 /* Got a floating reference from the driver. Sink it here,
 478                  * caller will need to unref when done with it. */
 479                 g_variant_ref_sink(*data);
 480         }
 481
 482         return ret;
 483 }
 484
 485 /**
 486  * Set a configuration key in a device instance.
 487  *
 488  * @param sdi The device instance.
 489  * @param key The configuration key (SR_CONF_*).
 490  * @param data The new value for the key, as a GVariant with GVariantType
 491  *        appropriate to that key. A floating reference can be passed
 492  *        in; its refcount will be sunk and unreferenced after use.
 493  *
 494  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 495  *         may be returned by the driver indicating it doesn't know that key,
 496  *         but this is not to be flagged as an error by the caller; merely
 497  *         as an indication that it's not applicable.
 498  */
 499 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
 500 {
 501         int ret;
 502
 503         g_variant_ref_sink(data);
 504
 505         if (!sdi || !sdi->driver || !data)
 506                 ret = SR_ERR;
 507         else if (!sdi->driver->config_set)
 508                 ret = SR_ERR_ARG;
 509         else
 510                 ret = sdi->driver->config_set(key, data, sdi);
 511
 512         g_variant_unref(data);
 513
 514         return ret;
 515 }
 516
 517 /**
 518  * List all possible values for a configuration key.
 519  *
 520  * @param driver The sr_dev_driver struct to query.
 521  * @param key The configuration key (SR_CONF_*).
 522  * @param data A pointer to a GVariant where the list will be stored. The
 523  *             caller is given ownership of the GVariant and must thus
 524  *             unref the GVariant after use. However if this function
 525  *             returns an error code, the field should be considered
 526  *             unused, and should not be unreferenced.
 527  * @param sdi (optional) If the key is specific to a device, this must
 528  *            contain a pointer to the struct sr_dev_inst to be checked.
 529  *
 530  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 531  *         may be returned by the driver indicating it doesn't know that key,
 532  *         but this is not to be flagged as an error by the caller; merely
 533  *         as an indication that it's not applicable.
 534  */
 535 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 536                 GVariant **data, const struct sr_dev_inst *sdi)
 537 {
 538         int ret;
 539
 540         if (!driver || !data)
 541                 ret = SR_ERR;
 542         else if (!driver->config_list)
 543                 ret = SR_ERR_ARG;
 544         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
 545                 g_variant_ref_sink(*data);
 546
 547         return ret;
 548 }
 549
 550 /**
 551  * Get information about a configuration key.
 552  *
 553  * @param key The configuration key.
 554  *
 555  * @return A pointer to a struct sr_config_info, or NULL if the key
 556  *         was not found.
 557  */
 558 SR_API const struct sr_config_info *sr_config_info_get(int key)
 559 {
 560         int i;
 561
 562         for (i = 0; sr_config_info_data[i].key; i++) {
 563                 if (sr_config_info_data[i].key == key)
 564                         return &sr_config_info_data[i];
 565         }
 566
 567         return NULL;
 568 }
 569
 570 /**
 571  * Get information about an configuration key, by name.
 572  *
 573  * @param optname The configuration key.
 574  *
 575  * @return A pointer to a struct sr_config_info, or NULL if the key
 576  *         was not found.
 577  */
 578 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 579 {
 580         int i;
 581
 582         for (i = 0; sr_config_info_data[i].key; i++) {
 583                 if (!strcmp(sr_config_info_data[i].id, optname))
 584                         return &sr_config_info_data[i];
 585         }
 586
 587         return NULL;
 588 }
 589
 590 /* Unnecessary level of indirection follows. */
 591
 592 /** @private */
 593 SR_PRIV int sr_source_remove(int fd)
 594 {
 595         return sr_session_source_remove(fd);
 596 }
 597
 598 /** @private */
 599 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 600                           sr_receive_data_callback_t cb, void *cb_data)
 601 {
 602         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 603 }
 604
 605 /** @} */