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