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