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