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