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