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