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