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