]>
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}, | |
ae431bc8 | 109 | {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target", |
ca95e90f | 110 | "Output voltage target", NULL}, |
471607f0 BV |
111 | {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current", |
112 | "Current output current", NULL}, | |
ae431bc8 | 113 | {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit", |
ca95e90f | 114 | "Output current limit", NULL}, |
471607f0 BV |
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}, | |
a42a39ac JH |
141 | {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency", |
142 | "Output frequency", NULL}, | |
143 | {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity", | |
144 | "Measured quantity", NULL}, | |
145 | {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity", | |
146 | "Measured secondary quantity", NULL}, | |
147 | {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model", | |
148 | "Equivalent circuit model", NULL}, | |
083d64f9 | 149 | {0, 0, NULL, NULL, NULL}, |
a1bb33af UH |
150 | }; |
151 | ||
13fef1ed ML |
152 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) |
153 | { | |
154 | switch (datatype) { | |
155 | case SR_T_INT32: | |
156 | return G_VARIANT_TYPE_INT32; | |
157 | case SR_T_UINT64: | |
158 | return G_VARIANT_TYPE_UINT64; | |
159 | case SR_T_STRING: | |
160 | return G_VARIANT_TYPE_STRING; | |
161 | case SR_T_BOOL: | |
162 | return G_VARIANT_TYPE_BOOLEAN; | |
163 | case SR_T_FLOAT: | |
164 | return G_VARIANT_TYPE_DOUBLE; | |
165 | case SR_T_RATIONAL_PERIOD: | |
166 | case SR_T_RATIONAL_VOLT: | |
167 | case SR_T_UINT64_RANGE: | |
168 | case SR_T_DOUBLE_RANGE: | |
169 | return G_VARIANT_TYPE_TUPLE; | |
170 | case SR_T_KEYVALUE: | |
171 | return G_VARIANT_TYPE_DICTIONARY; | |
172 | default: | |
173 | return NULL; | |
174 | } | |
175 | } | |
176 | ||
584560f1 | 177 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) |
13fef1ed ML |
178 | { |
179 | const struct sr_config_info *info; | |
180 | const GVariantType *type, *expected; | |
181 | info = sr_config_info_get(key); | |
182 | if (!info) | |
183 | return SR_OK; | |
184 | expected = sr_variant_type_get(info->datatype); | |
185 | type = g_variant_get_type(value); | |
186 | if (!g_variant_type_equal(type, expected)) { | |
187 | gchar *expected_string = g_variant_type_dup_string(expected); | |
188 | gchar *type_string = g_variant_type_dup_string(type); | |
189 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", | |
190 | info->name, expected_string, type_string); | |
191 | g_free(expected_string); | |
192 | g_free(type_string); | |
193 | return SR_ERR_ARG; | |
194 | } | |
195 | return SR_OK; | |
196 | } | |
197 | ||
a1645fcd | 198 | /** |
cfe064d8 | 199 | * Return the list of supported hardware drivers. |
a1645fcd | 200 | * |
c09f0b57 | 201 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
47117241 UH |
202 | * |
203 | * @since 0.1.0 | |
a1645fcd | 204 | */ |
cfe064d8 | 205 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 206 | { |
80bf0426 | 207 | |
c09f0b57 | 208 | return drivers_list; |
a1bb33af UH |
209 | } |
210 | ||
a1645fcd | 211 | /** |
c09f0b57 | 212 | * Initialize a hardware driver. |
a1645fcd | 213 | * |
c0eea11c UH |
214 | * This usually involves memory allocations and variable initializations |
215 | * within the driver, but _not_ scanning for attached devices. | |
216 | * The API call sr_driver_scan() is used for that. | |
217 | * | |
44fc870c | 218 | * @param ctx A libsigrok context object allocated by a previous call to |
c0eea11c UH |
219 | * sr_init(). Must not be NULL. |
220 | * @param driver The driver to initialize. This must be a pointer to one of | |
221 | * the entries returned by sr_driver_list(). Must not be NULL. | |
a1645fcd | 222 | * |
67eb6bcb MH |
223 | * @retval SR_OK Success |
224 | * @retval SR_ERR_ARG Invalid parameter(s). | |
225 | * @retval SR_ERR_BUG Internal errors. | |
226 | * @retval other Another negative error code upon other errors. | |
47117241 UH |
227 | * |
228 | * @since 0.2.0 | |
a1645fcd | 229 | */ |
44fc870c | 230 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 231 | { |
c0eea11c UH |
232 | int ret; |
233 | ||
234 | if (!ctx) { | |
235 | sr_err("Invalid libsigrok context, can't initialize."); | |
236 | return SR_ERR_ARG; | |
237 | } | |
238 | ||
239 | if (!driver) { | |
240 | sr_err("Invalid driver, can't initialize."); | |
241 | return SR_ERR_ARG; | |
242 | } | |
8722c31e | 243 | |
c0eea11c UH |
244 | sr_spew("Initializing driver '%s'.", driver->name); |
245 | if ((ret = driver->init(ctx)) < 0) | |
246 | sr_err("Failed to initialize the driver: %d.", ret); | |
80bf0426 | 247 | |
c0eea11c | 248 | return ret; |
80bf0426 BV |
249 | } |
250 | ||
251 | /** | |
252 | * Tell a hardware driver to scan for devices. | |
253 | * | |
a5f2e707 BV |
254 | * In addition to the detection, the devices that are found are also |
255 | * initialized automatically. On some devices, this involves a firmware upload, | |
256 | * or other such measures. | |
257 | * | |
258 | * The order in which the system is scanned for devices is not specified. The | |
259 | * caller should not assume or rely on any specific order. | |
260 | * | |
4b97c74e UH |
261 | * Before calling sr_driver_scan(), the user must have previously initialized |
262 | * the driver by calling sr_driver_init(). | |
80bf0426 | 263 | * |
4b97c74e UH |
264 | * @param driver The driver that should scan. This must be a pointer to one of |
265 | * the entries returned by sr_driver_list(). Must not be NULL. | |
266 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
267 | * scanner. Can be NULL/empty. | |
268 | * | |
269 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
270 | * found (or errors were encountered). This list must be freed by the | |
271 | * caller using g_slist_free(), but without freeing the data pointed | |
272 | * to in the list. | |
47117241 UH |
273 | * |
274 | * @since 0.2.0 | |
80bf0426 BV |
275 | */ |
276 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
277 | { | |
4b97c74e | 278 | GSList *l; |
13fef1ed | 279 | struct sr_config *src; |
4b97c74e UH |
280 | |
281 | if (!driver) { | |
282 | sr_err("Invalid driver, can't scan for devices."); | |
283 | return NULL; | |
284 | } | |
285 | ||
286 | if (!driver->priv) { | |
287 | sr_err("Driver not initialized, can't scan for devices."); | |
288 | return NULL; | |
289 | } | |
290 | ||
13fef1ed ML |
291 | for (l = options; l; l = l->next) { |
292 | src = l->data; | |
293 | if (sr_variant_type_check(src->key, src->data) != SR_OK) | |
294 | return NULL; | |
295 | } | |
296 | ||
4b97c74e | 297 | l = driver->scan(options); |
80bf0426 | 298 | |
4b97c74e UH |
299 | sr_spew("Scan of '%s' found %d devices.", driver->name, |
300 | g_slist_length(l)); | |
80bf0426 | 301 | |
4b97c74e | 302 | return l; |
8722c31e BV |
303 | } |
304 | ||
67eb6bcb MH |
305 | /** Call driver cleanup function for all drivers. |
306 | * @private */ | |
93a04e3b | 307 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 308 | { |
050e9219 | 309 | int i; |
c09f0b57 | 310 | struct sr_dev_driver **drivers; |
8722c31e | 311 | |
cfe064d8 | 312 | drivers = sr_driver_list(); |
c09f0b57 UH |
313 | for (i = 0; drivers[i]; i++) { |
314 | if (drivers[i]->cleanup) | |
315 | drivers[i]->cleanup(); | |
8722c31e | 316 | } |
8722c31e BV |
317 | } |
318 | ||
67eb6bcb MH |
319 | /** Allocate struct sr_config. |
320 | * A floating reference can be passed in for data. | |
321 | * @private | |
322 | */ | |
584560f1 | 323 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) |
4c0e310c BV |
324 | { |
325 | struct sr_config *src; | |
326 | ||
327 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
328 | return NULL; | |
329 | src->key = key; | |
bc1c2f00 | 330 | src->data = g_variant_ref_sink(data); |
4c0e310c BV |
331 | |
332 | return src; | |
333 | } | |
334 | ||
67eb6bcb MH |
335 | /** Free struct sr_config. |
336 | * @private | |
337 | */ | |
722db131 BV |
338 | SR_PRIV void sr_config_free(struct sr_config *src) |
339 | { | |
340 | ||
341 | if (!src || !src->data) { | |
342 | sr_err("%s: invalid data!", __func__); | |
343 | return; | |
344 | } | |
345 | ||
346 | g_variant_unref(src->data); | |
347 | g_free(src); | |
348 | ||
349 | } | |
350 | ||
df123801 | 351 | /** |
67eb6bcb | 352 | * Query value of a configuration key at the given driver or device instance. |
df123801 | 353 | * |
67eb6bcb MH |
354 | * @param[in] driver The sr_dev_driver struct to query. |
355 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 BV |
356 | * contain a pointer to the struct sr_dev_inst to be checked. |
357 | * Otherwise it must be NULL. | |
53b4680f | 358 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 359 | * values, or NULL. |
67eb6bcb MH |
360 | * @param[in] key The configuration key (SR_CONF_*). |
361 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
362 | * Must not be NULL. The caller is given ownership of the GVariant | |
bc1c2f00 BV |
363 | * and must thus decrease the refcount after use. However if |
364 | * this function returns an error code, the field should be | |
365 | * considered unused, and should not be unreferenced. | |
df123801 | 366 | * |
67eb6bcb MH |
367 | * @retval SR_OK Success. |
368 | * @retval SR_ERR Error. | |
369 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
370 | * interpreted as an error by the caller; merely as an indication | |
371 | * that it's not applicable. | |
47117241 UH |
372 | * |
373 | * @since 0.3.0 | |
df123801 | 374 | */ |
8f996b89 ML |
375 | SR_API int sr_config_get(const struct sr_dev_driver *driver, |
376 | const struct sr_dev_inst *sdi, | |
53b4680f | 377 | const struct sr_channel_group *cg, |
584560f1 | 378 | uint32_t key, GVariant **data) |
df123801 BV |
379 | { |
380 | int ret; | |
381 | ||
cbadb856 | 382 | if (!driver || !data) |
df123801 BV |
383 | return SR_ERR; |
384 | ||
6cefe516 BV |
385 | if (!driver->config_get) |
386 | return SR_ERR_ARG; | |
387 | ||
53b4680f | 388 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { |
bc1c2f00 BV |
389 | /* Got a floating reference from the driver. Sink it here, |
390 | * caller will need to unref when done with it. */ | |
391 | g_variant_ref_sink(*data); | |
392 | } | |
df123801 BV |
393 | |
394 | return ret; | |
395 | } | |
396 | ||
cbadb856 | 397 | /** |
67eb6bcb | 398 | * Set value of a configuration key in a device instance. |
cbadb856 | 399 | * |
67eb6bcb | 400 | * @param[in] sdi The device instance. |
53b4680f | 401 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 402 | * values, or NULL. |
67eb6bcb | 403 | * @param[in] key The configuration key (SR_CONF_*). |
bc1c2f00 BV |
404 | * @param data The new value for the key, as a GVariant with GVariantType |
405 | * appropriate to that key. A floating reference can be passed | |
406 | * in; its refcount will be sunk and unreferenced after use. | |
cbadb856 | 407 | * |
67eb6bcb MH |
408 | * @retval SR_OK Success. |
409 | * @retval SR_ERR Error. | |
410 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
411 | * interpreted as an error by the caller; merely as an indication | |
412 | * that it's not applicable. | |
47117241 UH |
413 | * |
414 | * @since 0.3.0 | |
cbadb856 | 415 | */ |
8f996b89 | 416 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, |
53b4680f | 417 | const struct sr_channel_group *cg, |
584560f1 | 418 | uint32_t key, GVariant *data) |
cbadb856 BV |
419 | { |
420 | int ret; | |
421 | ||
bc1c2f00 | 422 | g_variant_ref_sink(data); |
cbadb856 | 423 | |
bc1c2f00 BV |
424 | if (!sdi || !sdi->driver || !data) |
425 | ret = SR_ERR; | |
426 | else if (!sdi->driver->config_set) | |
427 | ret = SR_ERR_ARG; | |
13fef1ed | 428 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) |
53b4680f | 429 | ret = sdi->driver->config_set(key, data, sdi, cg); |
cbadb856 | 430 | |
bc1c2f00 | 431 | g_variant_unref(data); |
cbadb856 BV |
432 | |
433 | return ret; | |
434 | } | |
435 | ||
2a854d71 DE |
436 | /** |
437 | * Apply configuration settings to the device hardware. | |
438 | * | |
439 | * @param sdi The device instance. | |
440 | * | |
441 | * @return SR_OK upon success or SR_ERR in case of error. | |
47117241 UH |
442 | * |
443 | * @since 0.3.0 | |
2a854d71 DE |
444 | */ |
445 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
446 | { | |
447 | int ret; | |
448 | ||
449 | if (!sdi || !sdi->driver) | |
450 | ret = SR_ERR; | |
451 | else if (!sdi->driver->config_commit) | |
452 | ret = SR_OK; | |
453 | else | |
454 | ret = sdi->driver->config_commit(sdi); | |
455 | ||
456 | return ret; | |
457 | } | |
458 | ||
cbadb856 BV |
459 | /** |
460 | * List all possible values for a configuration key. | |
461 | * | |
67eb6bcb MH |
462 | * @param[in] driver The sr_dev_driver struct to query. |
463 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 | 464 | * contain a pointer to the struct sr_dev_inst to be checked. |
53b4680f | 465 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 466 | * values, or NULL. |
67eb6bcb MH |
467 | * @param[in] key The configuration key (SR_CONF_*). |
468 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
469 | * The caller is given ownership of the GVariant and must thus | |
bc1c2f00 BV |
470 | * unref the GVariant after use. However if this function |
471 | * returns an error code, the field should be considered | |
472 | * unused, and should not be unreferenced. | |
cbadb856 | 473 | * |
67eb6bcb MH |
474 | * @retval SR_OK Success. |
475 | * @retval SR_ERR Error. | |
476 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
477 | * interpreted as an error by the caller; merely as an indication | |
478 | * that it's not applicable. | |
47117241 UH |
479 | * |
480 | * @since 0.3.0 | |
cbadb856 | 481 | */ |
8f996b89 ML |
482 | SR_API int sr_config_list(const struct sr_dev_driver *driver, |
483 | const struct sr_dev_inst *sdi, | |
53b4680f | 484 | const struct sr_channel_group *cg, |
584560f1 | 485 | uint32_t key, GVariant **data) |
c5fb502f BV |
486 | { |
487 | int ret; | |
488 | ||
6cefe516 | 489 | if (!driver || !data) |
bc1c2f00 | 490 | ret = SR_ERR; |
d8284802 | 491 | else if (!driver->config_list) |
6cefe516 | 492 | ret = SR_ERR_ARG; |
53b4680f | 493 | else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) |
bc1c2f00 | 494 | g_variant_ref_sink(*data); |
c5fb502f BV |
495 | |
496 | return ret; | |
497 | } | |
498 | ||
8bfdc8c4 | 499 | /** |
67eb6bcb | 500 | * Get information about a configuration key, by key. |
a1645fcd | 501 | * |
67eb6bcb | 502 | * @param[in] key The configuration key. |
15cb43d6 | 503 | * |
c89c1c9c | 504 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 505 | * was not found. |
47117241 UH |
506 | * |
507 | * @since 0.2.0 | |
15cb43d6 | 508 | */ |
584560f1 | 509 | SR_API const struct sr_config_info *sr_config_info_get(uint32_t key) |
15cb43d6 BV |
510 | { |
511 | int i; | |
512 | ||
c89c1c9c BV |
513 | for (i = 0; sr_config_info_data[i].key; i++) { |
514 | if (sr_config_info_data[i].key == key) | |
515 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
516 | } |
517 | ||
518 | return NULL; | |
519 | } | |
520 | ||
521 | /** | |
67eb6bcb | 522 | * Get information about a configuration key, by name. |
15cb43d6 | 523 | * |
67eb6bcb | 524 | * @param[in] optname The configuration key. |
a1645fcd | 525 | * |
c89c1c9c | 526 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 527 | * was not found. |
47117241 UH |
528 | * |
529 | * @since 0.2.0 | |
a1645fcd | 530 | */ |
c89c1c9c | 531 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 532 | { |
a1bb33af UH |
533 | int i; |
534 | ||
c89c1c9c BV |
535 | for (i = 0; sr_config_info_data[i].key; i++) { |
536 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
537 | return &sr_config_info_data[i]; | |
a1bb33af UH |
538 | } |
539 | ||
49d0ce50 | 540 | return NULL; |
a1bb33af UH |
541 | } |
542 | ||
7b870c38 | 543 | /** @} */ |