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