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