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