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_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
  97                 "Voltage threshold", NULL },
  98         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
  99                 "Power off", NULL},
 100         {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
 101                 "Data source", NULL},
 102         {0, 0, NULL, NULL, NULL},
 103 };
 104
 105 /** @cond PRIVATE */
 106 #ifdef HAVE_HW_BRYMEN_DMM
 107 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
 108 #endif
 109 #ifdef HAVE_HW_CEM_DT_885X
 110 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
 111 #endif
 112 #ifdef HAVE_HW_CENTER_3XX
 113 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
 114 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
 115 #endif
 116 #ifdef HAVE_HW_COLEAD_SLM
 117 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
 118 #endif
 119 #ifdef HAVE_HW_DEMO
 120 extern SR_PRIV struct sr_dev_driver demo_driver_info;
 121 #endif
 122 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 123 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
 124 #endif
 125 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
 126 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
 127 #endif
 128 #ifdef HAVE_HW_KECHENG_KC_330B
 129 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
 130 #endif
 131 #ifdef HAVE_HW_LASCAR_EL_USB
 132 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
 133 #endif
 134 #ifdef HAVE_HW_MIC_985XX
 135 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
 136 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
 137 #endif
 138 #ifdef HAVE_HW_OLS
 139 extern SR_PRIV struct sr_dev_driver ols_driver_info;
 140 #endif
 141 #ifdef HAVE_HW_RIGOL_DS1XX2
 142 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
 143 #endif
 144 #ifdef HAVE_HW_SALEAE_LOGIC16
 145 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
 146 #endif
 147 #ifdef HAVE_HW_TONDAJ_SL_814
 148 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
 149 #endif
 150 #ifdef HAVE_HW_UNI_T_UT32X
 151 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
 152 #endif
 153 #ifdef HAVE_HW_VICTOR_DMM
 154 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
 155 #endif
 156 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 157 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
 158 #endif
 159 #ifdef HAVE_HW_ASIX_SIGMA
 160 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
 161 #endif
 162 #ifdef HAVE_HW_CHRONOVU_LA8
 163 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
 164 #endif
 165 #ifdef HAVE_HW_LINK_MSO19
 166 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
 167 #endif
 168 #ifdef HAVE_HW_ALSA
 169 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
 170 #endif
 171 #ifdef HAVE_HW_FX2LAFW
 172 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
 173 #endif
 174 #ifdef HAVE_HW_HANTEK_DSO
 175 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
 176 #endif
 177 #ifdef HAVE_HW_AGILENT_DMM
 178 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
 179 #endif
 180 #ifdef HAVE_HW_FLUKE_DMM
 181 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
 182 #endif
 183 #ifdef HAVE_HW_SERIAL_DMM
 184 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
 185 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
 186 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
 187 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
 188 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
 189 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
 190 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
 191 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
 192 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
 193 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
 194 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
 195 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
 196 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
 197 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
 198 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
 199 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
 200 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
 201 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
 202 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
 203 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
 204 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
 205 #endif
 206 #ifdef HAVE_HW_UNI_T_DMM
 207 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
 208 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
 209 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
 210 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
 211 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
 212 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
 213 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
 214 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
 215 #endif
 216 /** @endcond */
 217
 218 static struct sr_dev_driver *drivers_list[] = {
 219 #ifdef HAVE_HW_BRYMEN_DMM
 220         &brymen_bm857_driver_info,
 221 #endif
 222 #ifdef HAVE_HW_CEM_DT_885X
 223         &cem_dt_885x_driver_info,
 224 #endif
 225 #ifdef HAVE_HW_CENTER_3XX
 226         &center_309_driver_info,
 227         &voltcraft_k204_driver_info,
 228 #endif
 229 #ifdef HAVE_HW_COLEAD_SLM
 230         &colead_slm_driver_info,
 231 #endif
 232 #ifdef HAVE_HW_DEMO
 233         &demo_driver_info,
 234 #endif
 235 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
 236         &ikalogic_scanalogic2_driver_info,
 237 #endif
 238 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
 239         &ikalogic_scanaplus_driver_info,
 240 #endif
 241 #ifdef HAVE_HW_KECHENG_KC_330B
 242         &kecheng_kc_330b_driver_info,
 243 #endif
 244 #ifdef HAVE_HW_LASCAR_EL_USB
 245         &lascar_el_usb_driver_info,
 246 #endif
 247 #ifdef HAVE_HW_MIC_985XX
 248         &mic_98581_driver_info,
 249         &mic_98583_driver_info,
 250 #endif
 251 #ifdef HAVE_HW_OLS
 252         &ols_driver_info,
 253 #endif
 254 #ifdef HAVE_HW_RIGOL_DS1XX2
 255         &rigol_ds1xx2_driver_info,
 256 #endif
 257 #ifdef HAVE_HW_SALEAE_LOGIC16
 258         &saleae_logic16_driver_info,
 259 #endif
 260 #ifdef HAVE_HW_TONDAJ_SL_814
 261         &tondaj_sl_814_driver_info,
 262 #endif
 263 #ifdef HAVE_HW_UNI_T_UT32X
 264         &uni_t_ut32x_driver_info,
 265 #endif
 266 #ifdef HAVE_HW_VICTOR_DMM
 267         &victor_dmm_driver_info,
 268 #endif
 269 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
 270         &zeroplus_logic_cube_driver_info,
 271 #endif
 272 #ifdef HAVE_HW_ASIX_SIGMA
 273         &asix_sigma_driver_info,
 274 #endif
 275 #ifdef HAVE_HW_CHRONOVU_LA8
 276         &chronovu_la8_driver_info,
 277 #endif
 278 #ifdef HAVE_HW_LINK_MSO19
 279         &link_mso19_driver_info,
 280 #endif
 281 #ifdef HAVE_HW_ALSA
 282         &alsa_driver_info,
 283 #endif
 284 #ifdef HAVE_HW_FX2LAFW
 285         &fx2lafw_driver_info,
 286 #endif
 287 #ifdef HAVE_HW_HANTEK_DSO
 288         &hantek_dso_driver_info,
 289 #endif
 290 #ifdef HAVE_HW_AGILENT_DMM
 291         &agdmm_driver_info,
 292 #endif
 293 #ifdef HAVE_HW_FLUKE_DMM
 294         &flukedmm_driver_info,
 295 #endif
 296 #ifdef HAVE_HW_SERIAL_DMM
 297         &digitek_dt4000zc_driver_info,
 298         &tekpower_tp4000zc_driver_info,
 299         &metex_me31_driver_info,
 300         &peaktech_3410_driver_info,
 301         &mastech_mas345_driver_info,
 302         &va_va18b_driver_info,
 303         &metex_m3640d_driver_info,
 304         &peaktech_4370_driver_info,
 305         &pce_pce_dm32_driver_info,
 306         &radioshack_22_168_driver_info,
 307         &radioshack_22_805_driver_info,
 308         &radioshack_22_812_driver_info,
 309         &tecpel_dmm_8061_ser_driver_info,
 310         &voltcraft_m3650d_driver_info,
 311         &voltcraft_vc820_ser_driver_info,
 312         &voltcraft_vc830_ser_driver_info,
 313         &voltcraft_vc840_ser_driver_info,
 314         &uni_t_ut60a_ser_driver_info,
 315         &uni_t_ut60e_ser_driver_info,
 316         &uni_t_ut61d_ser_driver_info,
 317         &uni_t_ut61e_ser_driver_info,
 318 #endif
 319 #ifdef HAVE_HW_UNI_T_DMM
 320         &tecpel_dmm_8061_driver_info,
 321         &uni_t_ut60a_driver_info,
 322         &uni_t_ut60e_driver_info,
 323         &uni_t_ut61d_driver_info,
 324         &uni_t_ut61e_driver_info,
 325         &voltcraft_vc820_driver_info,
 326         &voltcraft_vc830_driver_info,
 327         &voltcraft_vc840_driver_info,
 328 #endif
 329         NULL,
 330 };
 331
 332 /**
 333  * Return the list of supported hardware drivers.
 334  *
 335  * @return Pointer to the NULL-terminated list of hardware driver pointers.
 336  */
 337 SR_API struct sr_dev_driver **sr_driver_list(void)
 338 {
 339
 340         return drivers_list;
 341 }
 342
 343 /**
 344  * Initialize a hardware driver.
 345  *
 346  * This usually involves memory allocations and variable initializations
 347  * within the driver, but _not_ scanning for attached devices.
 348  * The API call sr_driver_scan() is used for that.
 349  *
 350  * @param ctx A libsigrok context object allocated by a previous call to
 351  *            sr_init(). Must not be NULL.
 352  * @param driver The driver to initialize. This must be a pointer to one of
 353  *               the entries returned by sr_driver_list(). Must not be NULL.
 354  *
 355  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
 356  *         SR_ERR_BUG upon internal errors, or another negative error code
 357  *         upon other errors.
 358  */
 359 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
 360 {
 361         int ret;
 362
 363         if (!ctx) {
 364                 sr_err("Invalid libsigrok context, can't initialize.");
 365                 return SR_ERR_ARG;
 366         }
 367
 368         if (!driver) {
 369                 sr_err("Invalid driver, can't initialize.");
 370                 return SR_ERR_ARG;
 371         }
 372
 373         sr_spew("Initializing driver '%s'.", driver->name);
 374         if ((ret = driver->init(ctx)) < 0)
 375                 sr_err("Failed to initialize the driver: %d.", ret);
 376
 377         return ret;
 378 }
 379
 380 /**
 381  * Tell a hardware driver to scan for devices.
 382  *
 383  * In addition to the detection, the devices that are found are also
 384  * initialized automatically. On some devices, this involves a firmware upload,
 385  * or other such measures.
 386  *
 387  * The order in which the system is scanned for devices is not specified. The
 388  * caller should not assume or rely on any specific order.
 389  *
 390  * Before calling sr_driver_scan(), the user must have previously initialized
 391  * the driver by calling sr_driver_init().
 392  *
 393  * @param driver The driver that should scan. This must be a pointer to one of
 394  *               the entries returned by sr_driver_list(). Must not be NULL.
 395  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
 396  *                scanner. Can be NULL/empty.
 397  *
 398  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
 399  *         found (or errors were encountered). This list must be freed by the
 400  *         caller using g_slist_free(), but without freeing the data pointed
 401  *         to in the list.
 402  */
 403 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
 404 {
 405         GSList *l;
 406
 407         if (!driver) {
 408                 sr_err("Invalid driver, can't scan for devices.");
 409                 return NULL;
 410         }
 411
 412         if (!driver->priv) {
 413                 sr_err("Driver not initialized, can't scan for devices.");
 414                 return NULL;
 415         }
 416
 417         l = driver->scan(options);
 418
 419         sr_spew("Scan of '%s' found %d devices.", driver->name,
 420                 g_slist_length(l));
 421
 422         return l;
 423 }
 424
 425 /** @private */
 426 SR_PRIV void sr_hw_cleanup_all(void)
 427 {
 428         int i;
 429         struct sr_dev_driver **drivers;
 430
 431         drivers = sr_driver_list();
 432         for (i = 0; drivers[i]; i++) {
 433                 if (drivers[i]->cleanup)
 434                         drivers[i]->cleanup();
 435         }
 436 }
 437
 438 /** A floating reference can be passed in for data. */
 439 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
 440 {
 441         struct sr_config *src;
 442
 443         if (!(src = g_try_malloc(sizeof(struct sr_config))))
 444                 return NULL;
 445         src->key = key;
 446         src->data = g_variant_ref_sink(data);
 447
 448         return src;
 449 }
 450
 451 SR_PRIV void sr_config_free(struct sr_config *src)
 452 {
 453
 454         if (!src || !src->data) {
 455                 sr_err("%s: invalid data!", __func__);
 456                 return;
 457         }
 458
 459         g_variant_unref(src->data);
 460         g_free(src);
 461
 462 }
 463
 464 /**
 465  * Returns information about the given driver or device instance.
 466  *
 467  * @param driver The sr_dev_driver struct to query.
 468  * @param key The configuration key (SR_CONF_*).
 469  * @param data Pointer to a GVariant where the value will be stored. Must
 470  *             not be NULL. The caller is given ownership of the GVariant
 471  *             and must thus decrease the refcount after use. However if
 472  *             this function returns an error code, the field should be
 473  *             considered unused, and should not be unreferenced.
 474  * @param sdi (optional) If the key is specific to a device, this must
 475  *            contain a pointer to the struct sr_dev_inst to be checked.
 476  *            Otherwise it must be NULL.
 477  *
 478  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 479  *         may be returned by the driver indicating it doesn't know that key,
 480  *         but this is not to be flagged as an error by the caller; merely
 481  *         as an indication that it's not applicable.
 482  */
 483 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
 484                 GVariant **data, const struct sr_dev_inst *sdi)
 485 {
 486         int ret;
 487
 488         if (!driver || !data)
 489                 return SR_ERR;
 490
 491         if (!driver->config_get)
 492                 return SR_ERR_ARG;
 493
 494         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
 495                 /* Got a floating reference from the driver. Sink it here,
 496                  * caller will need to unref when done with it. */
 497                 g_variant_ref_sink(*data);
 498         }
 499
 500         return ret;
 501 }
 502
 503 /**
 504  * Set a configuration key in a device instance.
 505  *
 506  * @param sdi The device instance.
 507  * @param key The configuration key (SR_CONF_*).
 508  * @param data The new value for the key, as a GVariant with GVariantType
 509  *        appropriate to that key. A floating reference can be passed
 510  *        in; its refcount will be sunk and unreferenced after use.
 511  *
 512  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 513  *         may be returned by the driver indicating it doesn't know that key,
 514  *         but this is not to be flagged as an error by the caller; merely
 515  *         as an indication that it's not applicable.
 516  */
 517 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
 518 {
 519         int ret;
 520
 521         g_variant_ref_sink(data);
 522
 523         if (!sdi || !sdi->driver || !data)
 524                 ret = SR_ERR;
 525         else if (!sdi->driver->config_set)
 526                 ret = SR_ERR_ARG;
 527         else
 528                 ret = sdi->driver->config_set(key, data, sdi);
 529
 530         g_variant_unref(data);
 531
 532         return ret;
 533 }
 534
 535 /**
 536  * List all possible values for a configuration key.
 537  *
 538  * @param driver The sr_dev_driver struct to query.
 539  * @param key The configuration key (SR_CONF_*).
 540  * @param data A pointer to a GVariant where the list will be stored. The
 541  *             caller is given ownership of the GVariant and must thus
 542  *             unref the GVariant after use. However if this function
 543  *             returns an error code, the field should be considered
 544  *             unused, and should not be unreferenced.
 545  * @param sdi (optional) If the key is specific to a device, this must
 546  *            contain a pointer to the struct sr_dev_inst to be checked.
 547  *
 548  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
 549  *         may be returned by the driver indicating it doesn't know that key,
 550  *         but this is not to be flagged as an error by the caller; merely
 551  *         as an indication that it's not applicable.
 552  */
 553 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
 554                 GVariant **data, const struct sr_dev_inst *sdi)
 555 {
 556         int ret;
 557
 558         if (!driver || !data)
 559                 ret = SR_ERR;
 560         else if (!driver->config_list)
 561                 ret = SR_ERR_ARG;
 562         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
 563                 g_variant_ref_sink(*data);
 564
 565         return ret;
 566 }
 567
 568 /**
 569  * Get information about a configuration key.
 570  *
 571  * @param key The configuration key.
 572  *
 573  * @return A pointer to a struct sr_config_info, or NULL if the key
 574  *         was not found.
 575  */
 576 SR_API const struct sr_config_info *sr_config_info_get(int key)
 577 {
 578         int i;
 579
 580         for (i = 0; sr_config_info_data[i].key; i++) {
 581                 if (sr_config_info_data[i].key == key)
 582                         return &sr_config_info_data[i];
 583         }
 584
 585         return NULL;
 586 }
 587
 588 /**
 589  * Get information about an configuration key, by name.
 590  *
 591  * @param optname The configuration key.
 592  *
 593  * @return A pointer to a struct sr_config_info, or NULL if the key
 594  *         was not found.
 595  */
 596 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
 597 {
 598         int i;
 599
 600         for (i = 0; sr_config_info_data[i].key; i++) {
 601                 if (!strcmp(sr_config_info_data[i].id, optname))
 602                         return &sr_config_info_data[i];
 603         }
 604
 605         return NULL;
 606 }
 607
 608 /* Unnecessary level of indirection follows. */
 609
 610 /** @private */
 611 SR_PRIV int sr_source_remove(int fd)
 612 {
 613         return sr_session_source_remove(fd);
 614 }
 615
 616 /** @private */
 617 SR_PRIV int sr_source_add(int fd, int events, int timeout,
 618                           sr_receive_data_callback_t cb, void *cb_data)
 619 {
 620         return sr_session_source_add(fd, events, timeout, cb, cb_data);
 621 }
 622
 623 /** @} */