]>
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 | |
2ad1deb8 | 30 | /** @cond PRIVATE */ |
3544f848 | 31 | #define LOG_PREFIX "hwdriver" |
2ad1deb8 | 32 | /** @endcond */ |
bd36d826 | 33 | |
5d8c55f9 BV |
34 | extern SR_PRIV struct sr_dev_driver *drivers_list[]; |
35 | ||
393fb9cb UH |
36 | /** |
37 | * @file | |
38 | * | |
39 | * Hardware driver handling in libsigrok. | |
40 | */ | |
41 | ||
7b870c38 UH |
42 | /** |
43 | * @defgroup grp_driver Hardware drivers | |
44 | * | |
45 | * Hardware driver handling in libsigrok. | |
46 | * | |
47 | * @{ | |
48 | */ | |
8bfdc8c4 | 49 | |
c89c1c9c | 50 | static struct sr_config_info sr_config_info_data[] = { |
ace218f9 | 51 | {SR_CONF_CONN, SR_T_STRING, "conn", |
083d64f9 | 52 | "Connection", NULL}, |
ace218f9 | 53 | {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm", |
083d64f9 | 54 | "Serial communication", NULL}, |
1953564a | 55 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", |
083d64f9 | 56 | "Sample rate", NULL}, |
1953564a | 57 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", |
083d64f9 | 58 | "Pre-trigger capture ratio", NULL}, |
ace218f9 | 59 | {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern", |
2438b737 | 60 | "Pattern", NULL}, |
795c9de3 BV |
61 | {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch", |
62 | "Trigger matches", NULL}, | |
eb1b610b MR |
63 | {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", |
64 | "External clock mode", NULL}, | |
7b0a57fd MR |
65 | {SR_CONF_SWAP, SR_T_BOOL, "swap", |
66 | "Swap channel order", NULL}, | |
1953564a | 67 | {SR_CONF_RLE, SR_T_BOOL, "rle", |
083d64f9 | 68 | "Run Length Encoding", NULL}, |
ace218f9 | 69 | {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope", |
083d64f9 | 70 | "Trigger slope", NULL}, |
ace218f9 | 71 | {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource", |
083d64f9 | 72 | "Trigger source", NULL}, |
1953564a | 73 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", |
083d64f9 | 74 | "Horizontal trigger position", NULL}, |
1953564a | 75 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", |
083d64f9 | 76 | "Buffer size", NULL}, |
1953564a | 77 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", |
083d64f9 | 78 | "Time base", NULL}, |
ace218f9 | 79 | {SR_CONF_FILTER, SR_T_STRING, "filter", |
083d64f9 | 80 | "Filter targets", NULL}, |
1953564a | 81 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", |
083d64f9 | 82 | "Volts/div", NULL}, |
ace218f9 | 83 | {SR_CONF_COUPLING, SR_T_STRING, "coupling", |
083d64f9 | 84 | "Coupling", NULL}, |
e6551ea6 BV |
85 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", |
86 | "Datalog", NULL}, | |
ace218f9 | 87 | {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq", |
fd8854c4 | 88 | "Sound pressure level frequency weighting", NULL}, |
ace218f9 | 89 | {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time", |
fd8854c4 | 90 | "Sound pressure level time weighting", NULL}, |
9fd6bc20 BV |
91 | {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max", |
92 | "Hold max", NULL}, | |
93 | {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min", | |
94 | "Hold min", NULL}, | |
8417ebad BV |
95 | {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range", |
96 | "Sound pressure level measurement range", NULL}, | |
db11d7d2 MC |
97 | {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold", |
98 | "Voltage threshold", NULL }, | |
32de50b7 BV |
99 | {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", |
100 | "Power off", NULL}, | |
ace218f9 | 101 | {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source", |
6caeef6e | 102 | "Data source", NULL}, |
fca75cbb UH |
103 | {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", |
104 | "Number of logic channels", NULL}, | |
105 | {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", | |
106 | "Number of analog channels", NULL}, | |
471607f0 BV |
107 | {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage", |
108 | "Current output voltage", NULL}, | |
109 | {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max", | |
110 | "Maximum output voltage", NULL}, | |
111 | {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current", | |
112 | "Current output current", NULL}, | |
113 | {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max", | |
114 | "Maximum output current", NULL}, | |
115 | {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled", | |
116 | "Output enabled", NULL}, | |
a1eaa9e0 | 117 | {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config", |
471607f0 | 118 | "Output channel modes", NULL}, |
a1eaa9e0 BV |
119 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled", |
120 | "Over-voltage protection enabled", NULL}, | |
121 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active", | |
122 | "Over-voltage protection active", NULL}, | |
123 | {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold", | |
124 | "Over-voltage protection threshold", NULL}, | |
125 | {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled", | |
126 | "Over-current protection enabled", NULL}, | |
127 | {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active", | |
128 | "Over-current protection active", NULL}, | |
129 | {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold", | |
130 | "Over-current protection threshold", NULL}, | |
f0de2dd0 BV |
131 | {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", |
132 | "Sample limit", NULL}, | |
ace218f9 | 133 | {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge", |
860bc59b | 134 | "Clock edge", NULL}, |
cff7d8d6 BV |
135 | {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude", |
136 | "Amplitude", NULL}, | |
a1eaa9e0 BV |
137 | {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp", |
138 | "Over-temperature protection", NULL}, | |
139 | {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation", | |
140 | "Output channel regulation", NULL}, | |
083d64f9 | 141 | {0, 0, NULL, NULL, NULL}, |
a1bb33af UH |
142 | }; |
143 | ||
13fef1ed ML |
144 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) |
145 | { | |
146 | switch (datatype) { | |
147 | case SR_T_INT32: | |
148 | return G_VARIANT_TYPE_INT32; | |
149 | case SR_T_UINT64: | |
150 | return G_VARIANT_TYPE_UINT64; | |
151 | case SR_T_STRING: | |
152 | return G_VARIANT_TYPE_STRING; | |
153 | case SR_T_BOOL: | |
154 | return G_VARIANT_TYPE_BOOLEAN; | |
155 | case SR_T_FLOAT: | |
156 | return G_VARIANT_TYPE_DOUBLE; | |
157 | case SR_T_RATIONAL_PERIOD: | |
158 | case SR_T_RATIONAL_VOLT: | |
159 | case SR_T_UINT64_RANGE: | |
160 | case SR_T_DOUBLE_RANGE: | |
161 | return G_VARIANT_TYPE_TUPLE; | |
162 | case SR_T_KEYVALUE: | |
163 | return G_VARIANT_TYPE_DICTIONARY; | |
164 | default: | |
165 | return NULL; | |
166 | } | |
167 | } | |
168 | ||
584560f1 | 169 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) |
13fef1ed ML |
170 | { |
171 | const struct sr_config_info *info; | |
172 | const GVariantType *type, *expected; | |
173 | info = sr_config_info_get(key); | |
174 | if (!info) | |
175 | return SR_OK; | |
176 | expected = sr_variant_type_get(info->datatype); | |
177 | type = g_variant_get_type(value); | |
178 | if (!g_variant_type_equal(type, expected)) { | |
179 | gchar *expected_string = g_variant_type_dup_string(expected); | |
180 | gchar *type_string = g_variant_type_dup_string(type); | |
181 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", | |
182 | info->name, expected_string, type_string); | |
183 | g_free(expected_string); | |
184 | g_free(type_string); | |
185 | return SR_ERR_ARG; | |
186 | } | |
187 | return SR_OK; | |
188 | } | |
189 | ||
a1645fcd | 190 | /** |
cfe064d8 | 191 | * Return the list of supported hardware drivers. |
a1645fcd | 192 | * |
c09f0b57 | 193 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
47117241 UH |
194 | * |
195 | * @since 0.1.0 | |
a1645fcd | 196 | */ |
cfe064d8 | 197 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 198 | { |
80bf0426 | 199 | |
c09f0b57 | 200 | return drivers_list; |
a1bb33af UH |
201 | } |
202 | ||
a1645fcd | 203 | /** |
c09f0b57 | 204 | * Initialize a hardware driver. |
a1645fcd | 205 | * |
c0eea11c UH |
206 | * This usually involves memory allocations and variable initializations |
207 | * within the driver, but _not_ scanning for attached devices. | |
208 | * The API call sr_driver_scan() is used for that. | |
209 | * | |
44fc870c | 210 | * @param ctx A libsigrok context object allocated by a previous call to |
c0eea11c UH |
211 | * sr_init(). Must not be NULL. |
212 | * @param driver The driver to initialize. This must be a pointer to one of | |
213 | * the entries returned by sr_driver_list(). Must not be NULL. | |
a1645fcd | 214 | * |
67eb6bcb MH |
215 | * @retval SR_OK Success |
216 | * @retval SR_ERR_ARG Invalid parameter(s). | |
217 | * @retval SR_ERR_BUG Internal errors. | |
218 | * @retval other Another negative error code upon other errors. | |
47117241 UH |
219 | * |
220 | * @since 0.2.0 | |
a1645fcd | 221 | */ |
44fc870c | 222 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 223 | { |
c0eea11c UH |
224 | int ret; |
225 | ||
226 | if (!ctx) { | |
227 | sr_err("Invalid libsigrok context, can't initialize."); | |
228 | return SR_ERR_ARG; | |
229 | } | |
230 | ||
231 | if (!driver) { | |
232 | sr_err("Invalid driver, can't initialize."); | |
233 | return SR_ERR_ARG; | |
234 | } | |
8722c31e | 235 | |
c0eea11c UH |
236 | sr_spew("Initializing driver '%s'.", driver->name); |
237 | if ((ret = driver->init(ctx)) < 0) | |
238 | sr_err("Failed to initialize the driver: %d.", ret); | |
80bf0426 | 239 | |
c0eea11c | 240 | return ret; |
80bf0426 BV |
241 | } |
242 | ||
243 | /** | |
244 | * Tell a hardware driver to scan for devices. | |
245 | * | |
a5f2e707 BV |
246 | * In addition to the detection, the devices that are found are also |
247 | * initialized automatically. On some devices, this involves a firmware upload, | |
248 | * or other such measures. | |
249 | * | |
250 | * The order in which the system is scanned for devices is not specified. The | |
251 | * caller should not assume or rely on any specific order. | |
252 | * | |
4b97c74e UH |
253 | * Before calling sr_driver_scan(), the user must have previously initialized |
254 | * the driver by calling sr_driver_init(). | |
80bf0426 | 255 | * |
4b97c74e UH |
256 | * @param driver The driver that should scan. This must be a pointer to one of |
257 | * the entries returned by sr_driver_list(). Must not be NULL. | |
258 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
259 | * scanner. Can be NULL/empty. | |
260 | * | |
261 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
262 | * found (or errors were encountered). This list must be freed by the | |
263 | * caller using g_slist_free(), but without freeing the data pointed | |
264 | * to in the list. | |
47117241 UH |
265 | * |
266 | * @since 0.2.0 | |
80bf0426 BV |
267 | */ |
268 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
269 | { | |
4b97c74e | 270 | GSList *l; |
13fef1ed | 271 | struct sr_config *src; |
4b97c74e UH |
272 | |
273 | if (!driver) { | |
274 | sr_err("Invalid driver, can't scan for devices."); | |
275 | return NULL; | |
276 | } | |
277 | ||
278 | if (!driver->priv) { | |
279 | sr_err("Driver not initialized, can't scan for devices."); | |
280 | return NULL; | |
281 | } | |
282 | ||
13fef1ed ML |
283 | for (l = options; l; l = l->next) { |
284 | src = l->data; | |
285 | if (sr_variant_type_check(src->key, src->data) != SR_OK) | |
286 | return NULL; | |
287 | } | |
288 | ||
4b97c74e | 289 | l = driver->scan(options); |
80bf0426 | 290 | |
4b97c74e UH |
291 | sr_spew("Scan of '%s' found %d devices.", driver->name, |
292 | g_slist_length(l)); | |
80bf0426 | 293 | |
4b97c74e | 294 | return l; |
8722c31e BV |
295 | } |
296 | ||
67eb6bcb MH |
297 | /** Call driver cleanup function for all drivers. |
298 | * @private */ | |
93a04e3b | 299 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 300 | { |
050e9219 | 301 | int i; |
c09f0b57 | 302 | struct sr_dev_driver **drivers; |
8722c31e | 303 | |
cfe064d8 | 304 | drivers = sr_driver_list(); |
c09f0b57 UH |
305 | for (i = 0; drivers[i]; i++) { |
306 | if (drivers[i]->cleanup) | |
307 | drivers[i]->cleanup(); | |
8722c31e | 308 | } |
8722c31e BV |
309 | } |
310 | ||
67eb6bcb MH |
311 | /** Allocate struct sr_config. |
312 | * A floating reference can be passed in for data. | |
313 | * @private | |
314 | */ | |
584560f1 | 315 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) |
4c0e310c BV |
316 | { |
317 | struct sr_config *src; | |
318 | ||
319 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
320 | return NULL; | |
321 | src->key = key; | |
bc1c2f00 | 322 | src->data = g_variant_ref_sink(data); |
4c0e310c BV |
323 | |
324 | return src; | |
325 | } | |
326 | ||
67eb6bcb MH |
327 | /** Free struct sr_config. |
328 | * @private | |
329 | */ | |
722db131 BV |
330 | SR_PRIV void sr_config_free(struct sr_config *src) |
331 | { | |
332 | ||
333 | if (!src || !src->data) { | |
334 | sr_err("%s: invalid data!", __func__); | |
335 | return; | |
336 | } | |
337 | ||
338 | g_variant_unref(src->data); | |
339 | g_free(src); | |
340 | ||
341 | } | |
342 | ||
df123801 | 343 | /** |
67eb6bcb | 344 | * Query value of a configuration key at the given driver or device instance. |
df123801 | 345 | * |
67eb6bcb MH |
346 | * @param[in] driver The sr_dev_driver struct to query. |
347 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 BV |
348 | * contain a pointer to the struct sr_dev_inst to be checked. |
349 | * Otherwise it must be NULL. | |
53b4680f | 350 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 351 | * values, or NULL. |
67eb6bcb MH |
352 | * @param[in] key The configuration key (SR_CONF_*). |
353 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
354 | * Must not be NULL. The caller is given ownership of the GVariant | |
bc1c2f00 BV |
355 | * and must thus decrease the refcount after use. However if |
356 | * this function returns an error code, the field should be | |
357 | * considered unused, and should not be unreferenced. | |
df123801 | 358 | * |
67eb6bcb MH |
359 | * @retval SR_OK Success. |
360 | * @retval SR_ERR Error. | |
361 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
362 | * interpreted as an error by the caller; merely as an indication | |
363 | * that it's not applicable. | |
47117241 UH |
364 | * |
365 | * @since 0.3.0 | |
df123801 | 366 | */ |
8f996b89 ML |
367 | SR_API int sr_config_get(const struct sr_dev_driver *driver, |
368 | const struct sr_dev_inst *sdi, | |
53b4680f | 369 | const struct sr_channel_group *cg, |
584560f1 | 370 | uint32_t key, GVariant **data) |
df123801 BV |
371 | { |
372 | int ret; | |
373 | ||
cbadb856 | 374 | if (!driver || !data) |
df123801 BV |
375 | return SR_ERR; |
376 | ||
6cefe516 BV |
377 | if (!driver->config_get) |
378 | return SR_ERR_ARG; | |
379 | ||
53b4680f | 380 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { |
bc1c2f00 BV |
381 | /* Got a floating reference from the driver. Sink it here, |
382 | * caller will need to unref when done with it. */ | |
383 | g_variant_ref_sink(*data); | |
384 | } | |
df123801 BV |
385 | |
386 | return ret; | |
387 | } | |
388 | ||
cbadb856 | 389 | /** |
67eb6bcb | 390 | * Set value of a configuration key in a device instance. |
cbadb856 | 391 | * |
67eb6bcb | 392 | * @param[in] sdi The device instance. |
53b4680f | 393 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 394 | * values, or NULL. |
67eb6bcb | 395 | * @param[in] key The configuration key (SR_CONF_*). |
bc1c2f00 BV |
396 | * @param data The new value for the key, as a GVariant with GVariantType |
397 | * appropriate to that key. A floating reference can be passed | |
398 | * in; its refcount will be sunk and unreferenced after use. | |
cbadb856 | 399 | * |
67eb6bcb MH |
400 | * @retval SR_OK Success. |
401 | * @retval SR_ERR Error. | |
402 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
403 | * interpreted as an error by the caller; merely as an indication | |
404 | * that it's not applicable. | |
47117241 UH |
405 | * |
406 | * @since 0.3.0 | |
cbadb856 | 407 | */ |
8f996b89 | 408 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, |
53b4680f | 409 | const struct sr_channel_group *cg, |
584560f1 | 410 | uint32_t key, GVariant *data) |
cbadb856 BV |
411 | { |
412 | int ret; | |
413 | ||
bc1c2f00 | 414 | g_variant_ref_sink(data); |
cbadb856 | 415 | |
bc1c2f00 BV |
416 | if (!sdi || !sdi->driver || !data) |
417 | ret = SR_ERR; | |
418 | else if (!sdi->driver->config_set) | |
419 | ret = SR_ERR_ARG; | |
13fef1ed | 420 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) |
53b4680f | 421 | ret = sdi->driver->config_set(key, data, sdi, cg); |
cbadb856 | 422 | |
bc1c2f00 | 423 | g_variant_unref(data); |
cbadb856 BV |
424 | |
425 | return ret; | |
426 | } | |
427 | ||
2a854d71 DE |
428 | /** |
429 | * Apply configuration settings to the device hardware. | |
430 | * | |
431 | * @param sdi The device instance. | |
432 | * | |
433 | * @return SR_OK upon success or SR_ERR in case of error. | |
47117241 UH |
434 | * |
435 | * @since 0.3.0 | |
2a854d71 DE |
436 | */ |
437 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
438 | { | |
439 | int ret; | |
440 | ||
441 | if (!sdi || !sdi->driver) | |
442 | ret = SR_ERR; | |
443 | else if (!sdi->driver->config_commit) | |
444 | ret = SR_OK; | |
445 | else | |
446 | ret = sdi->driver->config_commit(sdi); | |
447 | ||
448 | return ret; | |
449 | } | |
450 | ||
cbadb856 BV |
451 | /** |
452 | * List all possible values for a configuration key. | |
453 | * | |
67eb6bcb MH |
454 | * @param[in] driver The sr_dev_driver struct to query. |
455 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 | 456 | * contain a pointer to the struct sr_dev_inst to be checked. |
53b4680f | 457 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 458 | * values, or NULL. |
67eb6bcb MH |
459 | * @param[in] key The configuration key (SR_CONF_*). |
460 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
461 | * The caller is given ownership of the GVariant and must thus | |
bc1c2f00 BV |
462 | * unref the GVariant after use. However if this function |
463 | * returns an error code, the field should be considered | |
464 | * unused, and should not be unreferenced. | |
cbadb856 | 465 | * |
67eb6bcb MH |
466 | * @retval SR_OK Success. |
467 | * @retval SR_ERR Error. | |
468 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
469 | * interpreted as an error by the caller; merely as an indication | |
470 | * that it's not applicable. | |
47117241 UH |
471 | * |
472 | * @since 0.3.0 | |
cbadb856 | 473 | */ |
8f996b89 ML |
474 | SR_API int sr_config_list(const struct sr_dev_driver *driver, |
475 | const struct sr_dev_inst *sdi, | |
53b4680f | 476 | const struct sr_channel_group *cg, |
584560f1 | 477 | uint32_t key, GVariant **data) |
c5fb502f BV |
478 | { |
479 | int ret; | |
480 | ||
6cefe516 | 481 | if (!driver || !data) |
bc1c2f00 | 482 | ret = SR_ERR; |
d8284802 | 483 | else if (!driver->config_list) |
6cefe516 | 484 | ret = SR_ERR_ARG; |
53b4680f | 485 | else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) |
bc1c2f00 | 486 | g_variant_ref_sink(*data); |
c5fb502f BV |
487 | |
488 | return ret; | |
489 | } | |
490 | ||
8bfdc8c4 | 491 | /** |
67eb6bcb | 492 | * Get information about a configuration key, by key. |
a1645fcd | 493 | * |
67eb6bcb | 494 | * @param[in] key The configuration key. |
15cb43d6 | 495 | * |
c89c1c9c | 496 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 497 | * was not found. |
47117241 UH |
498 | * |
499 | * @since 0.2.0 | |
15cb43d6 | 500 | */ |
584560f1 | 501 | SR_API const struct sr_config_info *sr_config_info_get(uint32_t key) |
15cb43d6 BV |
502 | { |
503 | int i; | |
504 | ||
c89c1c9c BV |
505 | for (i = 0; sr_config_info_data[i].key; i++) { |
506 | if (sr_config_info_data[i].key == key) | |
507 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
508 | } |
509 | ||
510 | return NULL; | |
511 | } | |
512 | ||
513 | /** | |
67eb6bcb | 514 | * Get information about a configuration key, by name. |
15cb43d6 | 515 | * |
67eb6bcb | 516 | * @param[in] optname The configuration key. |
a1645fcd | 517 | * |
c89c1c9c | 518 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 519 | * was not found. |
47117241 UH |
520 | * |
521 | * @since 0.2.0 | |
a1645fcd | 522 | */ |
c89c1c9c | 523 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 524 | { |
a1bb33af UH |
525 | int i; |
526 | ||
c89c1c9c BV |
527 | for (i = 0; sr_config_info_data[i].key; i++) { |
528 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
529 | return &sr_config_info_data[i]; | |
a1bb33af UH |
530 | } |
531 | ||
49d0ce50 | 532 | return NULL; |
a1bb33af UH |
533 | } |
534 | ||
7b870c38 | 535 | /** @} */ |