]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> |
a1bb33af UH |
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> | |
545f9786 | 26 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ |
45c59c8b BV |
27 | #include "libsigrok.h" |
28 | #include "libsigrok-internal.h" | |
a1bb33af | 29 | |
bd36d826 UH |
30 | /* Message logging helpers with driver-specific prefix string. */ |
31 | #define DRIVER_LOG_DOMAIN "hwdriver: " | |
32 | #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args) | |
33 | #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args) | |
34 | #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args) | |
35 | #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args) | |
36 | #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args) | |
37 | #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args) | |
38 | ||
393fb9cb UH |
39 | /** |
40 | * @file | |
41 | * | |
42 | * Hardware driver handling in libsigrok. | |
43 | */ | |
44 | ||
7b870c38 UH |
45 | /** |
46 | * @defgroup grp_driver Hardware drivers | |
47 | * | |
48 | * Hardware driver handling in libsigrok. | |
49 | * | |
50 | * @{ | |
51 | */ | |
8bfdc8c4 | 52 | |
c89c1c9c | 53 | static struct sr_config_info sr_config_info_data[] = { |
1953564a | 54 | {SR_CONF_CONN, SR_T_CHAR, "conn", |
083d64f9 | 55 | "Connection", NULL}, |
1953564a | 56 | {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm", |
083d64f9 | 57 | "Serial communication", NULL}, |
1953564a | 58 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", |
083d64f9 | 59 | "Sample rate", NULL}, |
1953564a | 60 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", |
083d64f9 | 61 | "Pre-trigger capture ratio", NULL}, |
1953564a | 62 | {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", |
083d64f9 | 63 | "Pattern generator mode", NULL}, |
1953564a | 64 | {SR_CONF_RLE, SR_T_BOOL, "rle", |
083d64f9 | 65 | "Run Length Encoding", NULL}, |
1953564a | 66 | {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", |
083d64f9 | 67 | "Trigger slope", NULL}, |
1953564a | 68 | {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", |
083d64f9 | 69 | "Trigger source", NULL}, |
1953564a | 70 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", |
083d64f9 | 71 | "Horizontal trigger position", NULL}, |
1953564a | 72 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", |
083d64f9 | 73 | "Buffer size", NULL}, |
1953564a | 74 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", |
083d64f9 | 75 | "Time base", NULL}, |
1953564a | 76 | {SR_CONF_FILTER, SR_T_CHAR, "filter", |
083d64f9 | 77 | "Filter targets", NULL}, |
1953564a | 78 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", |
083d64f9 | 79 | "Volts/div", NULL}, |
1953564a | 80 | {SR_CONF_COUPLING, SR_T_CHAR, "coupling", |
083d64f9 BV |
81 | "Coupling", NULL}, |
82 | {0, 0, NULL, NULL, NULL}, | |
a1bb33af UH |
83 | }; |
84 | ||
b4bd7088 | 85 | /** @cond PRIVATE */ |
20cbc785 | 86 | #ifdef HAVE_HW_BRYMEN_DMM |
c5d6f5cc | 87 | extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info; |
20cbc785 | 88 | #endif |
4d729ddc BV |
89 | #ifdef HAVE_HW_COLEAD_SLM |
90 | extern SR_PRIV struct sr_dev_driver colead_slm_driver_info; | |
91 | #endif | |
a61b0e6a | 92 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 93 | extern SR_PRIV struct sr_dev_driver demo_driver_info; |
a61b0e6a | 94 | #endif |
46697e38 BV |
95 | #ifdef HAVE_HW_LASCAR_EL_USB |
96 | extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info; | |
97 | #endif | |
7ec5b549 | 98 | #ifdef HAVE_HW_MIC_985XX |
6f3e5335 | 99 | extern SR_PRIV struct sr_dev_driver mic_98581_driver_info; |
0cd8e231 | 100 | extern SR_PRIV struct sr_dev_driver mic_98583_driver_info; |
7ec5b549 | 101 | #endif |
35a078bc BV |
102 | #ifdef HAVE_HW_NEXUS_OSCIPRIME |
103 | extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info; | |
104 | #endif | |
960a75e4 | 105 | #ifdef HAVE_LA_OLS |
c09f0b57 | 106 | extern SR_PRIV struct sr_dev_driver ols_driver_info; |
960a75e4 | 107 | #endif |
f4816ac6 ML |
108 | #ifdef HAVE_HW_RIGOL_DS1XX2 |
109 | extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info; | |
110 | #endif | |
aa2af324 UH |
111 | #ifdef HAVE_HW_TONDAJ_SL_814 |
112 | extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info; | |
113 | #endif | |
ac3898d2 BV |
114 | #ifdef HAVE_HW_VICTOR_DMM |
115 | extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info; | |
116 | #endif | |
960a75e4 | 117 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE |
c09f0b57 | 118 | extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; |
960a75e4 | 119 | #endif |
5b907f9b | 120 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 121 | extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; |
5b907f9b | 122 | #endif |
f4314d7e | 123 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 124 | extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; |
f4314d7e | 125 | #endif |
bffed4fc | 126 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 127 | extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; |
bffed4fc | 128 | #endif |
0254651d | 129 | #ifdef HAVE_HW_ALSA |
c09f0b57 | 130 | extern SR_PRIV struct sr_dev_driver alsa_driver_info; |
6ed4f044 | 131 | #endif |
f302a082 | 132 | #ifdef HAVE_LA_FX2LAFW |
c09f0b57 | 133 | extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; |
f302a082 | 134 | #endif |
3b533202 | 135 | #ifdef HAVE_HW_HANTEK_DSO |
62bb8840 | 136 | extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; |
3b533202 | 137 | #endif |
e93cdf42 BV |
138 | #ifdef HAVE_HW_AGILENT_DMM |
139 | extern SR_PRIV struct sr_dev_driver agdmm_driver_info; | |
140 | #endif | |
e7edd64f BV |
141 | #ifdef HAVE_HW_FLUKE_DMM |
142 | extern SR_PRIV struct sr_dev_driver flukedmm_driver_info; | |
143 | #endif | |
21a7f269 | 144 | #ifdef HAVE_HW_SERIAL_DMM |
f086b830 | 145 | extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info; |
729b01f9 | 146 | extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info; |
ce3777ad | 147 | extern SR_PRIV struct sr_dev_driver metex_me31_driver_info; |
f0ac4929 | 148 | extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info; |
5887c9cc | 149 | extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info; |
6dca2f16 | 150 | extern SR_PRIV struct sr_dev_driver va_va18b_driver_info; |
a53da082 | 151 | extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info; |
a376ffea | 152 | extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info; |
d4bd66a0 | 153 | extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info; |
d5ce233f | 154 | extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info; |
21829e67 | 155 | extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info; |
40830061 | 156 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info; |
54d11221 | 157 | extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info; |
986fde75 | 158 | extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info; |
7dc55d93 | 159 | #endif |
79081ec8 | 160 | #ifdef HAVE_HW_UNI_T_DMM |
fdbcb86d UH |
161 | extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info; |
162 | extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info; | |
79081ec8 | 163 | #endif |
b4bd7088 | 164 | /** @endcond */ |
6ed4f044 | 165 | |
c09f0b57 | 166 | static struct sr_dev_driver *drivers_list[] = { |
20cbc785 | 167 | #ifdef HAVE_HW_BRYMEN_DMM |
c5d6f5cc | 168 | &brymen_bm857_driver_info, |
20cbc785 | 169 | #endif |
4d729ddc BV |
170 | #ifdef HAVE_HW_COLEAD_SLM |
171 | &colead_slm_driver_info, | |
172 | #endif | |
a61b0e6a | 173 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 174 | &demo_driver_info, |
a61b0e6a | 175 | #endif |
46697e38 BV |
176 | #ifdef HAVE_HW_LASCAR_EL_USB |
177 | &lascar_el_usb_driver_info, | |
178 | #endif | |
7ec5b549 | 179 | #ifdef HAVE_HW_MIC_985XX |
6f3e5335 | 180 | &mic_98581_driver_info, |
0cd8e231 | 181 | &mic_98583_driver_info, |
7ec5b549 | 182 | #endif |
35a078bc BV |
183 | #ifdef HAVE_HW_NEXUS_OSCIPRIME |
184 | &nexus_osciprime_driver_info, | |
185 | #endif | |
960a75e4 | 186 | #ifdef HAVE_LA_OLS |
c09f0b57 | 187 | &ols_driver_info, |
960a75e4 | 188 | #endif |
f4816ac6 ML |
189 | #ifdef HAVE_HW_RIGOL_DS1XX2 |
190 | &rigol_ds1xx2_driver_info, | |
191 | #endif | |
aa2af324 UH |
192 | #ifdef HAVE_HW_TONDAJ_SL_814 |
193 | &tondaj_sl_814_driver_info, | |
194 | #endif | |
ac3898d2 BV |
195 | #ifdef HAVE_HW_VICTOR_DMM |
196 | &victor_dmm_driver_info, | |
197 | #endif | |
960a75e4 | 198 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE |
c09f0b57 | 199 | &zeroplus_logic_cube_driver_info, |
960a75e4 | 200 | #endif |
5b907f9b | 201 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 202 | &asix_sigma_driver_info, |
5b907f9b | 203 | #endif |
f4314d7e | 204 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 205 | &chronovu_la8_driver_info, |
f4314d7e | 206 | #endif |
bffed4fc | 207 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 208 | &link_mso19_driver_info, |
bffed4fc | 209 | #endif |
0254651d | 210 | #ifdef HAVE_HW_ALSA |
c09f0b57 | 211 | &alsa_driver_info, |
f302a082 JH |
212 | #endif |
213 | #ifdef HAVE_LA_FX2LAFW | |
c09f0b57 | 214 | &fx2lafw_driver_info, |
3b533202 BV |
215 | #endif |
216 | #ifdef HAVE_HW_HANTEK_DSO | |
62bb8840 | 217 | &hantek_dso_driver_info, |
6ed4f044 | 218 | #endif |
e93cdf42 BV |
219 | #ifdef HAVE_HW_AGILENT_DMM |
220 | &agdmm_driver_info, | |
e7edd64f BV |
221 | #endif |
222 | #ifdef HAVE_HW_FLUKE_DMM | |
223 | &flukedmm_driver_info, | |
d375b3c3 | 224 | #endif |
21a7f269 | 225 | #ifdef HAVE_HW_SERIAL_DMM |
f086b830 | 226 | &digitek_dt4000zc_driver_info, |
729b01f9 | 227 | &tekpower_tp4000zc_driver_info, |
ce3777ad | 228 | &metex_me31_driver_info, |
f0ac4929 | 229 | &peaktech_3410_driver_info, |
5887c9cc | 230 | &mastech_mas345_driver_info, |
6dca2f16 | 231 | &va_va18b_driver_info, |
a53da082 | 232 | &metex_m3640d_driver_info, |
a376ffea | 233 | &peaktech_4370_driver_info, |
d4bd66a0 | 234 | &pce_pce_dm32_driver_info, |
d5ce233f | 235 | &radioshack_22_168_driver_info, |
21829e67 | 236 | &radioshack_22_812_driver_info, |
40830061 | 237 | &voltcraft_vc820_ser_driver_info, |
54d11221 | 238 | &voltcraft_vc840_ser_driver_info, |
986fde75 | 239 | &uni_t_ut61e_ser_driver_info, |
79081ec8 UH |
240 | #endif |
241 | #ifdef HAVE_HW_UNI_T_DMM | |
fdbcb86d UH |
242 | &uni_t_ut61d_driver_info, |
243 | &voltcraft_vc820_driver_info, | |
eb1f1eb4 | 244 | #endif |
050e9219 UH |
245 | NULL, |
246 | }; | |
a1bb33af | 247 | |
a1645fcd | 248 | /** |
cfe064d8 | 249 | * Return the list of supported hardware drivers. |
a1645fcd | 250 | * |
c09f0b57 | 251 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
a1645fcd | 252 | */ |
cfe064d8 | 253 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 254 | { |
80bf0426 | 255 | |
c09f0b57 | 256 | return drivers_list; |
a1bb33af UH |
257 | } |
258 | ||
a1645fcd | 259 | /** |
c09f0b57 | 260 | * Initialize a hardware driver. |
a1645fcd | 261 | * |
c0eea11c UH |
262 | * This usually involves memory allocations and variable initializations |
263 | * within the driver, but _not_ scanning for attached devices. | |
264 | * The API call sr_driver_scan() is used for that. | |
265 | * | |
44fc870c | 266 | * @param ctx A libsigrok context object allocated by a previous call to |
c0eea11c UH |
267 | * sr_init(). Must not be NULL. |
268 | * @param driver The driver to initialize. This must be a pointer to one of | |
269 | * the entries returned by sr_driver_list(). Must not be NULL. | |
a1645fcd | 270 | * |
c0eea11c UH |
271 | * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters, |
272 | * SR_ERR_BUG upon internal errors, or another negative error code | |
273 | * upon other errors. | |
a1645fcd | 274 | */ |
44fc870c | 275 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 276 | { |
c0eea11c UH |
277 | int ret; |
278 | ||
279 | if (!ctx) { | |
280 | sr_err("Invalid libsigrok context, can't initialize."); | |
281 | return SR_ERR_ARG; | |
282 | } | |
283 | ||
284 | if (!driver) { | |
285 | sr_err("Invalid driver, can't initialize."); | |
286 | return SR_ERR_ARG; | |
287 | } | |
8722c31e | 288 | |
c0eea11c UH |
289 | sr_spew("Initializing driver '%s'.", driver->name); |
290 | if ((ret = driver->init(ctx)) < 0) | |
291 | sr_err("Failed to initialize the driver: %d.", ret); | |
80bf0426 | 292 | |
c0eea11c | 293 | return ret; |
80bf0426 BV |
294 | } |
295 | ||
296 | /** | |
297 | * Tell a hardware driver to scan for devices. | |
298 | * | |
a5f2e707 BV |
299 | * In addition to the detection, the devices that are found are also |
300 | * initialized automatically. On some devices, this involves a firmware upload, | |
301 | * or other such measures. | |
302 | * | |
303 | * The order in which the system is scanned for devices is not specified. The | |
304 | * caller should not assume or rely on any specific order. | |
305 | * | |
4b97c74e UH |
306 | * Before calling sr_driver_scan(), the user must have previously initialized |
307 | * the driver by calling sr_driver_init(). | |
80bf0426 | 308 | * |
4b97c74e UH |
309 | * @param driver The driver that should scan. This must be a pointer to one of |
310 | * the entries returned by sr_driver_list(). Must not be NULL. | |
311 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
312 | * scanner. Can be NULL/empty. | |
313 | * | |
314 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
315 | * found (or errors were encountered). This list must be freed by the | |
316 | * caller using g_slist_free(), but without freeing the data pointed | |
317 | * to in the list. | |
80bf0426 BV |
318 | */ |
319 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
320 | { | |
4b97c74e UH |
321 | GSList *l; |
322 | ||
323 | if (!driver) { | |
324 | sr_err("Invalid driver, can't scan for devices."); | |
325 | return NULL; | |
326 | } | |
327 | ||
328 | if (!driver->priv) { | |
329 | sr_err("Driver not initialized, can't scan for devices."); | |
330 | return NULL; | |
331 | } | |
332 | ||
333 | l = driver->scan(options); | |
80bf0426 | 334 | |
4b97c74e UH |
335 | sr_spew("Scan of '%s' found %d devices.", driver->name, |
336 | g_slist_length(l)); | |
80bf0426 | 337 | |
4b97c74e | 338 | return l; |
8722c31e BV |
339 | } |
340 | ||
b4bd7088 | 341 | /** @private */ |
93a04e3b | 342 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 343 | { |
050e9219 | 344 | int i; |
c09f0b57 | 345 | struct sr_dev_driver **drivers; |
8722c31e | 346 | |
cfe064d8 | 347 | drivers = sr_driver_list(); |
c09f0b57 UH |
348 | for (i = 0; drivers[i]; i++) { |
349 | if (drivers[i]->cleanup) | |
350 | drivers[i]->cleanup(); | |
8722c31e | 351 | } |
8722c31e BV |
352 | } |
353 | ||
4c0e310c BV |
354 | SR_PRIV struct sr_config *sr_config_make(int key, const void *value) |
355 | { | |
356 | struct sr_config *src; | |
357 | ||
358 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
359 | return NULL; | |
360 | src->key = key; | |
361 | src->value = value; | |
362 | ||
363 | return src; | |
364 | } | |
365 | ||
df123801 BV |
366 | /** |
367 | * Returns information about the given driver or device instance. | |
368 | * | |
369 | * @param driver The sr_dev_driver struct to query. | |
cbadb856 BV |
370 | * @param key The configuration key (SR_CONF_*). |
371 | * @param data Pointer where the value will be stored. Must not be NULL. | |
372 | * @param sdi If the key is specific to a device, this must contain a | |
373 | * pointer to the struct sr_dev_inst to be checked. | |
df123801 BV |
374 | * |
375 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
cbadb856 | 376 | * may be returned by the driver indicating it doesn't know that key, |
df123801 BV |
377 | * but this is not to be flagged as an error by the caller; merely |
378 | * as an indication that it's not applicable. | |
379 | */ | |
9fd504b9 | 380 | SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, |
df123801 BV |
381 | const void **data, const struct sr_dev_inst *sdi) |
382 | { | |
383 | int ret; | |
384 | ||
cbadb856 | 385 | if (!driver || !data) |
df123801 BV |
386 | return SR_ERR; |
387 | ||
cbadb856 | 388 | ret = driver->config_get(key, data, sdi); |
df123801 BV |
389 | |
390 | return ret; | |
391 | } | |
392 | ||
cbadb856 BV |
393 | /** |
394 | * Set a configuration key in a device instance. | |
395 | * | |
396 | * @param sdi The device instance. | |
397 | * @param key The configuration key (SR_CONF_*). | |
398 | * @param value The new value for the key, as a pointer to whatever type | |
399 | * is appropriate for that key. | |
400 | * | |
401 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
402 | * may be returned by the driver indicating it doesn't know that key, | |
403 | * but this is not to be flagged as an error by the caller; merely | |
404 | * as an indication that it's not applicable. | |
405 | */ | |
406 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, | |
407 | const void *value) | |
408 | { | |
409 | int ret; | |
410 | ||
140185af | 411 | if (!sdi || !sdi->driver || !value) |
cbadb856 BV |
412 | return SR_ERR; |
413 | ||
414 | if (!sdi->driver->config_set) | |
415 | return SR_ERR_ARG; | |
416 | ||
417 | ret = sdi->driver->config_set(key, value, sdi); | |
418 | ||
419 | return ret; | |
420 | } | |
421 | ||
422 | /** | |
423 | * List all possible values for a configuration key. | |
424 | * | |
425 | * @param driver The sr_dev_driver struct to query. | |
426 | * @param key The configuration key (SR_CONF_*). | |
427 | * @param data A pointer to a list of values, in whatever format is | |
428 | * appropriate for that key. | |
429 | * @param sdi If the key is specific to a device, this must contain a | |
430 | * pointer to the struct sr_dev_inst to be checked. | |
431 | * | |
432 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
433 | * may be returned by the driver indicating it doesn't know that key, | |
434 | * but this is not to be flagged as an error by the caller; merely | |
435 | * as an indication that it's not applicable. | |
436 | */ | |
4c961f5e | 437 | SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, |
c5fb502f BV |
438 | const void **data, const struct sr_dev_inst *sdi) |
439 | { | |
440 | int ret; | |
441 | ||
cbadb856 | 442 | if (!driver || !data) |
c5fb502f BV |
443 | return SR_ERR; |
444 | ||
cbadb856 | 445 | ret = driver->config_list(key, data, sdi); |
c5fb502f BV |
446 | |
447 | return ret; | |
448 | } | |
449 | ||
8bfdc8c4 | 450 | /** |
cbadb856 | 451 | * Get information about a configuration key. |
a1645fcd | 452 | * |
cbadb856 | 453 | * @param opt The configuration key. |
15cb43d6 | 454 | * |
c89c1c9c | 455 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 BV |
456 | * was not found. |
457 | */ | |
c89c1c9c | 458 | SR_API const struct sr_config_info *sr_config_info_get(int key) |
15cb43d6 BV |
459 | { |
460 | int i; | |
461 | ||
c89c1c9c BV |
462 | for (i = 0; sr_config_info_data[i].key; i++) { |
463 | if (sr_config_info_data[i].key == key) | |
464 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
465 | } |
466 | ||
467 | return NULL; | |
468 | } | |
469 | ||
470 | /** | |
cbadb856 | 471 | * Get information about an configuration key, by name. |
15cb43d6 | 472 | * |
cbadb856 | 473 | * @param optname The configuration key. |
a1645fcd | 474 | * |
c89c1c9c | 475 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 476 | * was not found. |
a1645fcd | 477 | */ |
c89c1c9c | 478 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 479 | { |
a1bb33af UH |
480 | int i; |
481 | ||
c89c1c9c BV |
482 | for (i = 0; sr_config_info_data[i].key; i++) { |
483 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
484 | return &sr_config_info_data[i]; | |
a1bb33af UH |
485 | } |
486 | ||
49d0ce50 | 487 | return NULL; |
a1bb33af UH |
488 | } |
489 | ||
69cfcfc8 | 490 | /* Unnecessary level of indirection follows. */ |
544a4582 | 491 | |
b4bd7088 | 492 | /** @private */ |
69cfcfc8 | 493 | SR_PRIV int sr_source_remove(int fd) |
a1bb33af | 494 | { |
69cfcfc8 | 495 | return sr_session_source_remove(fd); |
a1bb33af UH |
496 | } |
497 | ||
b4bd7088 | 498 | /** @private */ |
69cfcfc8 UH |
499 | SR_PRIV int sr_source_add(int fd, int events, int timeout, |
500 | sr_receive_data_callback_t cb, void *cb_data) | |
a1bb33af | 501 | { |
69cfcfc8 | 502 | return sr_session_source_add(fd, events, timeout, cb, cb_data); |
a1bb33af | 503 | } |
7b870c38 UH |
504 | |
505 | /** @} */ |