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