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