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