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