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