]>
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[] = { |
51b1b95e BV |
51 | /* Device types */ |
52 | {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic Analyzer", NULL}, | |
53 | {SR_CONF_OSCILLOSCOPE, SR_T_STRING, NULL, "Oscilloscope", NULL}, | |
54 | {SR_CONF_MULTIMETER, SR_T_STRING, NULL, "Multimeter", NULL}, | |
55 | {SR_CONF_DEMO_DEV, SR_T_STRING, NULL, "Demo device", NULL}, | |
56 | {SR_CONF_SOUNDLEVELMETER, SR_T_STRING, NULL, "Sound level meter", NULL}, | |
57 | {SR_CONF_THERMOMETER, SR_T_STRING, NULL, "Thermometer", NULL}, | |
58 | {SR_CONF_HYGROMETER, SR_T_STRING, NULL, "Hygrometer", NULL}, | |
59 | {SR_CONF_ENERGYMETER, SR_T_STRING, NULL, "Energy meter", NULL}, | |
60 | {SR_CONF_DEMODULATOR, SR_T_STRING, NULL, "Demodulator", NULL}, | |
61 | {SR_CONF_POWER_SUPPLY, SR_T_STRING, NULL, "Power supply", NULL}, | |
62 | {SR_CONF_LCRMETER, SR_T_STRING, NULL, "LCR meter", NULL}, | |
63 | ||
64 | /* Sample limiting */ | |
65 | {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", | |
66 | "Sample limit", NULL}, | |
67 | {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time", | |
68 | "Time limit", NULL}, | |
69 | {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames", | |
70 | "Frame limit", NULL}, | |
71 | {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous", | |
72 | "Continuous sampling", NULL}, | |
73 | ||
74 | /* Scan options */ | |
ace218f9 | 75 | {SR_CONF_CONN, SR_T_STRING, "conn", |
083d64f9 | 76 | "Connection", NULL}, |
ace218f9 | 77 | {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm", |
083d64f9 | 78 | "Serial communication", NULL}, |
51b1b95e BV |
79 | |
80 | /* Device/channel group options */ | |
1953564a | 81 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", |
083d64f9 | 82 | "Sample rate", NULL}, |
1953564a | 83 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", |
083d64f9 | 84 | "Pre-trigger capture ratio", NULL}, |
ace218f9 | 85 | {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern", |
2438b737 | 86 | "Pattern", NULL}, |
795c9de3 BV |
87 | {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch", |
88 | "Trigger matches", NULL}, | |
eb1b610b MR |
89 | {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", |
90 | "External clock mode", NULL}, | |
7b0a57fd MR |
91 | {SR_CONF_SWAP, SR_T_BOOL, "swap", |
92 | "Swap channel order", NULL}, | |
1953564a | 93 | {SR_CONF_RLE, SR_T_BOOL, "rle", |
083d64f9 | 94 | "Run Length Encoding", NULL}, |
ace218f9 | 95 | {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope", |
083d64f9 | 96 | "Trigger slope", NULL}, |
ace218f9 | 97 | {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource", |
083d64f9 | 98 | "Trigger source", NULL}, |
1953564a | 99 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", |
083d64f9 | 100 | "Horizontal trigger position", NULL}, |
1953564a | 101 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", |
083d64f9 | 102 | "Buffer size", NULL}, |
1953564a | 103 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", |
083d64f9 | 104 | "Time base", NULL}, |
6fad08e6 BV |
105 | {SR_CONF_FILTER, SR_T_BOOL, "filter", |
106 | "Filter", NULL}, | |
1953564a | 107 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", |
083d64f9 | 108 | "Volts/div", NULL}, |
ace218f9 | 109 | {SR_CONF_COUPLING, SR_T_STRING, "coupling", |
083d64f9 | 110 | "Coupling", NULL}, |
e6551ea6 BV |
111 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", |
112 | "Datalog", NULL}, | |
ace218f9 | 113 | {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq", |
fd8854c4 | 114 | "Sound pressure level frequency weighting", NULL}, |
ace218f9 | 115 | {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time", |
fd8854c4 | 116 | "Sound pressure level time weighting", NULL}, |
9fd6bc20 BV |
117 | {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max", |
118 | "Hold max", NULL}, | |
119 | {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min", | |
120 | "Hold min", NULL}, | |
8417ebad BV |
121 | {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range", |
122 | "Sound pressure level measurement range", NULL}, | |
db11d7d2 MC |
123 | {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold", |
124 | "Voltage threshold", NULL }, | |
32de50b7 BV |
125 | {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", |
126 | "Power off", NULL}, | |
ace218f9 | 127 | {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source", |
6caeef6e | 128 | "Data source", NULL}, |
fca75cbb UH |
129 | {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", |
130 | "Number of logic channels", NULL}, | |
131 | {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", | |
132 | "Number of analog channels", NULL}, | |
471607f0 BV |
133 | {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage", |
134 | "Current output voltage", NULL}, | |
ae431bc8 | 135 | {SR_CONF_OUTPUT_VOLTAGE_TARGET, SR_T_FLOAT, "output_voltage_target", |
ca95e90f | 136 | "Output voltage target", NULL}, |
471607f0 BV |
137 | {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current", |
138 | "Current output current", NULL}, | |
ae431bc8 | 139 | {SR_CONF_OUTPUT_CURRENT_LIMIT, SR_T_FLOAT, "output_current_limit", |
ca95e90f | 140 | "Output current limit", NULL}, |
471607f0 BV |
141 | {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled", |
142 | "Output enabled", NULL}, | |
a1eaa9e0 | 143 | {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config", |
471607f0 | 144 | "Output channel modes", NULL}, |
a1eaa9e0 BV |
145 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled", |
146 | "Over-voltage protection enabled", NULL}, | |
147 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active", | |
148 | "Over-voltage protection active", NULL}, | |
149 | {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold", | |
150 | "Over-voltage protection threshold", NULL}, | |
151 | {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled", | |
152 | "Over-current protection enabled", NULL}, | |
153 | {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active", | |
154 | "Over-current protection active", NULL}, | |
155 | {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold", | |
156 | "Over-current protection threshold", NULL}, | |
ace218f9 | 157 | {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge", |
860bc59b | 158 | "Clock edge", NULL}, |
cff7d8d6 BV |
159 | {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude", |
160 | "Amplitude", NULL}, | |
a1eaa9e0 BV |
161 | {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp", |
162 | "Over-temperature protection", NULL}, | |
163 | {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation", | |
164 | "Output channel regulation", NULL}, | |
a42a39ac JH |
165 | {SR_CONF_OUTPUT_FREQUENCY, SR_T_UINT64, "output_frequency", |
166 | "Output frequency", NULL}, | |
167 | {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity", | |
168 | "Measured quantity", NULL}, | |
169 | {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity", | |
170 | "Measured secondary quantity", NULL}, | |
171 | {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model", | |
172 | "Equivalent circuit model", NULL}, | |
083d64f9 | 173 | {0, 0, NULL, NULL, NULL}, |
a1bb33af UH |
174 | }; |
175 | ||
13fef1ed ML |
176 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) |
177 | { | |
178 | switch (datatype) { | |
179 | case SR_T_INT32: | |
180 | return G_VARIANT_TYPE_INT32; | |
181 | case SR_T_UINT64: | |
182 | return G_VARIANT_TYPE_UINT64; | |
183 | case SR_T_STRING: | |
184 | return G_VARIANT_TYPE_STRING; | |
185 | case SR_T_BOOL: | |
186 | return G_VARIANT_TYPE_BOOLEAN; | |
187 | case SR_T_FLOAT: | |
188 | return G_VARIANT_TYPE_DOUBLE; | |
189 | case SR_T_RATIONAL_PERIOD: | |
190 | case SR_T_RATIONAL_VOLT: | |
191 | case SR_T_UINT64_RANGE: | |
192 | case SR_T_DOUBLE_RANGE: | |
193 | return G_VARIANT_TYPE_TUPLE; | |
194 | case SR_T_KEYVALUE: | |
195 | return G_VARIANT_TYPE_DICTIONARY; | |
196 | default: | |
197 | return NULL; | |
198 | } | |
199 | } | |
200 | ||
584560f1 | 201 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) |
13fef1ed ML |
202 | { |
203 | const struct sr_config_info *info; | |
204 | const GVariantType *type, *expected; | |
61b02922 BV |
205 | char *expected_string, *type_string; |
206 | ||
13fef1ed ML |
207 | info = sr_config_info_get(key); |
208 | if (!info) | |
209 | return SR_OK; | |
61b02922 | 210 | |
13fef1ed ML |
211 | expected = sr_variant_type_get(info->datatype); |
212 | type = g_variant_get_type(value); | |
61b02922 BV |
213 | if (!g_variant_type_equal(type, expected) |
214 | && !g_variant_type_is_subtype_of(type, expected)) { | |
215 | expected_string = g_variant_type_dup_string(expected); | |
216 | type_string = g_variant_type_dup_string(type); | |
13fef1ed ML |
217 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", |
218 | info->name, expected_string, type_string); | |
219 | g_free(expected_string); | |
220 | g_free(type_string); | |
221 | return SR_ERR_ARG; | |
222 | } | |
61b02922 | 223 | |
13fef1ed ML |
224 | return SR_OK; |
225 | } | |
226 | ||
a1645fcd | 227 | /** |
cfe064d8 | 228 | * Return the list of supported hardware drivers. |
a1645fcd | 229 | * |
c09f0b57 | 230 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
47117241 UH |
231 | * |
232 | * @since 0.1.0 | |
a1645fcd | 233 | */ |
cfe064d8 | 234 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 235 | { |
80bf0426 | 236 | |
c09f0b57 | 237 | return drivers_list; |
a1bb33af UH |
238 | } |
239 | ||
a1645fcd | 240 | /** |
c09f0b57 | 241 | * Initialize a hardware driver. |
a1645fcd | 242 | * |
c0eea11c UH |
243 | * This usually involves memory allocations and variable initializations |
244 | * within the driver, but _not_ scanning for attached devices. | |
245 | * The API call sr_driver_scan() is used for that. | |
246 | * | |
44fc870c | 247 | * @param ctx A libsigrok context object allocated by a previous call to |
c0eea11c UH |
248 | * sr_init(). Must not be NULL. |
249 | * @param driver The driver to initialize. This must be a pointer to one of | |
250 | * the entries returned by sr_driver_list(). Must not be NULL. | |
a1645fcd | 251 | * |
67eb6bcb MH |
252 | * @retval SR_OK Success |
253 | * @retval SR_ERR_ARG Invalid parameter(s). | |
254 | * @retval SR_ERR_BUG Internal errors. | |
255 | * @retval other Another negative error code upon other errors. | |
47117241 UH |
256 | * |
257 | * @since 0.2.0 | |
a1645fcd | 258 | */ |
44fc870c | 259 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 260 | { |
c0eea11c UH |
261 | int ret; |
262 | ||
263 | if (!ctx) { | |
264 | sr_err("Invalid libsigrok context, can't initialize."); | |
265 | return SR_ERR_ARG; | |
266 | } | |
267 | ||
268 | if (!driver) { | |
269 | sr_err("Invalid driver, can't initialize."); | |
270 | return SR_ERR_ARG; | |
271 | } | |
8722c31e | 272 | |
c0eea11c UH |
273 | sr_spew("Initializing driver '%s'.", driver->name); |
274 | if ((ret = driver->init(ctx)) < 0) | |
275 | sr_err("Failed to initialize the driver: %d.", ret); | |
80bf0426 | 276 | |
c0eea11c | 277 | return ret; |
80bf0426 BV |
278 | } |
279 | ||
adfba736 BV |
280 | static int check_options(struct sr_dev_driver *driver, GSList *options, |
281 | uint32_t optlist_key, struct sr_dev_inst *sdi, | |
282 | struct sr_channel_group *cg) | |
283 | { | |
284 | struct sr_config *src; | |
285 | const struct sr_config_info *srci; | |
286 | GVariant *gvar_opts; | |
287 | GSList *l; | |
288 | const uint32_t *opts; | |
289 | gsize num_opts, i; | |
290 | int ret; | |
291 | ||
292 | if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) { | |
293 | /* Driver publishes no options for this optlist. */ | |
294 | return SR_ERR; | |
295 | } | |
296 | ||
297 | ret = SR_OK; | |
298 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
299 | for (l = options; l; l = l->next) { | |
300 | src = l->data; | |
301 | for (i = 0; i < num_opts; i++) { | |
302 | if (opts[i] == src->key) | |
303 | break; | |
304 | } | |
305 | if (i == num_opts) { | |
306 | if (!(srci = sr_config_info_get(src->key))) | |
307 | /* Shouldn't happen. */ | |
308 | sr_err("Invalid option %d.", src->key); | |
309 | else | |
310 | sr_err("Invalid option '%s'.", srci->id); | |
311 | ret = SR_ERR_ARG; | |
312 | break; | |
313 | } | |
314 | if (sr_variant_type_check(src->key, src->data) != SR_OK) { | |
315 | ret = SR_ERR_ARG; | |
316 | break; | |
317 | } | |
318 | } | |
319 | g_variant_unref(gvar_opts); | |
320 | ||
321 | return ret; | |
322 | } | |
323 | ||
80bf0426 BV |
324 | /** |
325 | * Tell a hardware driver to scan for devices. | |
326 | * | |
a5f2e707 BV |
327 | * In addition to the detection, the devices that are found are also |
328 | * initialized automatically. On some devices, this involves a firmware upload, | |
329 | * or other such measures. | |
330 | * | |
331 | * The order in which the system is scanned for devices is not specified. The | |
332 | * caller should not assume or rely on any specific order. | |
333 | * | |
4b97c74e UH |
334 | * Before calling sr_driver_scan(), the user must have previously initialized |
335 | * the driver by calling sr_driver_init(). | |
80bf0426 | 336 | * |
4b97c74e UH |
337 | * @param driver The driver that should scan. This must be a pointer to one of |
338 | * the entries returned by sr_driver_list(). Must not be NULL. | |
339 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
340 | * scanner. Can be NULL/empty. | |
341 | * | |
342 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
343 | * found (or errors were encountered). This list must be freed by the | |
344 | * caller using g_slist_free(), but without freeing the data pointed | |
345 | * to in the list. | |
47117241 UH |
346 | * |
347 | * @since 0.2.0 | |
80bf0426 BV |
348 | */ |
349 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
350 | { | |
071151b5 | 351 | GSList *l; |
4b97c74e UH |
352 | |
353 | if (!driver) { | |
354 | sr_err("Invalid driver, can't scan for devices."); | |
355 | return NULL; | |
356 | } | |
357 | ||
358 | if (!driver->priv) { | |
359 | sr_err("Driver not initialized, can't scan for devices."); | |
360 | return NULL; | |
361 | } | |
362 | ||
adfba736 BV |
363 | if (options) { |
364 | if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK) | |
13fef1ed ML |
365 | return NULL; |
366 | } | |
367 | ||
4b97c74e | 368 | l = driver->scan(options); |
80bf0426 | 369 | |
4b97c74e UH |
370 | sr_spew("Scan of '%s' found %d devices.", driver->name, |
371 | g_slist_length(l)); | |
80bf0426 | 372 | |
4b97c74e | 373 | return l; |
8722c31e BV |
374 | } |
375 | ||
67eb6bcb MH |
376 | /** Call driver cleanup function for all drivers. |
377 | * @private */ | |
93a04e3b | 378 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 379 | { |
050e9219 | 380 | int i; |
c09f0b57 | 381 | struct sr_dev_driver **drivers; |
8722c31e | 382 | |
cfe064d8 | 383 | drivers = sr_driver_list(); |
c09f0b57 UH |
384 | for (i = 0; drivers[i]; i++) { |
385 | if (drivers[i]->cleanup) | |
386 | drivers[i]->cleanup(); | |
8722c31e | 387 | } |
8722c31e BV |
388 | } |
389 | ||
67eb6bcb MH |
390 | /** Allocate struct sr_config. |
391 | * A floating reference can be passed in for data. | |
392 | * @private | |
393 | */ | |
584560f1 | 394 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) |
4c0e310c BV |
395 | { |
396 | struct sr_config *src; | |
397 | ||
398 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
399 | return NULL; | |
400 | src->key = key; | |
bc1c2f00 | 401 | src->data = g_variant_ref_sink(data); |
4c0e310c BV |
402 | |
403 | return src; | |
404 | } | |
405 | ||
67eb6bcb MH |
406 | /** Free struct sr_config. |
407 | * @private | |
408 | */ | |
722db131 BV |
409 | SR_PRIV void sr_config_free(struct sr_config *src) |
410 | { | |
411 | ||
412 | if (!src || !src->data) { | |
413 | sr_err("%s: invalid data!", __func__); | |
414 | return; | |
415 | } | |
416 | ||
417 | g_variant_unref(src->data); | |
418 | g_free(src); | |
419 | ||
420 | } | |
421 | ||
c6dde812 BV |
422 | static int check_key(const struct sr_dev_driver *driver, |
423 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, | |
424 | uint32_t key, int op) | |
425 | { | |
426 | const struct sr_config_info *srci; | |
427 | gsize num_opts, i; | |
428 | GVariant *gvar_opts; | |
429 | const uint32_t *opts; | |
430 | uint32_t pub_opt; | |
431 | char *suffix, *opstr; | |
432 | ||
433 | if (sdi && cg) | |
434 | suffix = " for this device and channel group"; | |
435 | else if (sdi) | |
436 | suffix = " for this device"; | |
437 | else | |
438 | suffix = ""; | |
439 | ||
440 | if (!(srci = sr_config_info_get(key))) { | |
441 | sr_err("Invalid key %d.", key); | |
442 | return SR_ERR_ARG; | |
443 | } | |
444 | opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list"; | |
445 | ||
446 | if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) { | |
447 | /* Driver publishes no options. */ | |
448 | sr_err("No options available%s.", srci->id, suffix); | |
449 | return SR_ERR_ARG; | |
450 | } | |
451 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
452 | pub_opt = 0; | |
453 | for (i = 0; i < num_opts; i++) { | |
454 | if ((opts[i] & SR_CONF_MASK) == key) { | |
455 | pub_opt = opts[i]; | |
456 | break; | |
457 | } | |
458 | } | |
459 | g_variant_unref(gvar_opts); | |
460 | if (!pub_opt) { | |
461 | sr_err("Option '%s' not available%s.", srci->id, suffix); | |
462 | return SR_ERR_ARG; | |
463 | } | |
464 | ||
465 | if (!(pub_opt & op)) { | |
466 | sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix); | |
467 | return SR_ERR_ARG; | |
468 | } | |
469 | ||
470 | return SR_OK; | |
471 | } | |
472 | ||
df123801 | 473 | /** |
67eb6bcb | 474 | * Query value of a configuration key at the given driver or device instance. |
df123801 | 475 | * |
67eb6bcb MH |
476 | * @param[in] driver The sr_dev_driver struct to query. |
477 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 BV |
478 | * contain a pointer to the struct sr_dev_inst to be checked. |
479 | * Otherwise it must be NULL. | |
53b4680f | 480 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 481 | * values, or NULL. |
67eb6bcb MH |
482 | * @param[in] key The configuration key (SR_CONF_*). |
483 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
484 | * Must not be NULL. The caller is given ownership of the GVariant | |
bc1c2f00 BV |
485 | * and must thus decrease the refcount after use. However if |
486 | * this function returns an error code, the field should be | |
487 | * considered unused, and should not be unreferenced. | |
df123801 | 488 | * |
67eb6bcb MH |
489 | * @retval SR_OK Success. |
490 | * @retval SR_ERR Error. | |
491 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
492 | * interpreted as an error by the caller; merely as an indication | |
493 | * that it's not applicable. | |
47117241 UH |
494 | * |
495 | * @since 0.3.0 | |
df123801 | 496 | */ |
8f996b89 ML |
497 | SR_API int sr_config_get(const struct sr_dev_driver *driver, |
498 | const struct sr_dev_inst *sdi, | |
53b4680f | 499 | const struct sr_channel_group *cg, |
584560f1 | 500 | uint32_t key, GVariant **data) |
df123801 BV |
501 | { |
502 | int ret; | |
503 | ||
cbadb856 | 504 | if (!driver || !data) |
df123801 BV |
505 | return SR_ERR; |
506 | ||
6cefe516 BV |
507 | if (!driver->config_get) |
508 | return SR_ERR_ARG; | |
509 | ||
c6dde812 BV |
510 | if (check_key(driver, sdi, cg, key, SR_CONF_GET) != SR_OK) |
511 | return SR_ERR_ARG; | |
512 | ||
53b4680f | 513 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { |
bc1c2f00 BV |
514 | /* Got a floating reference from the driver. Sink it here, |
515 | * caller will need to unref when done with it. */ | |
516 | g_variant_ref_sink(*data); | |
517 | } | |
df123801 BV |
518 | |
519 | return ret; | |
520 | } | |
521 | ||
cbadb856 | 522 | /** |
67eb6bcb | 523 | * Set value of a configuration key in a device instance. |
cbadb856 | 524 | * |
67eb6bcb | 525 | * @param[in] sdi The device instance. |
53b4680f | 526 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 527 | * values, or NULL. |
67eb6bcb | 528 | * @param[in] key The configuration key (SR_CONF_*). |
bc1c2f00 BV |
529 | * @param data The new value for the key, as a GVariant with GVariantType |
530 | * appropriate to that key. A floating reference can be passed | |
531 | * in; its refcount will be sunk and unreferenced after use. | |
cbadb856 | 532 | * |
67eb6bcb MH |
533 | * @retval SR_OK Success. |
534 | * @retval SR_ERR Error. | |
535 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
536 | * interpreted as an error by the caller; merely as an indication | |
537 | * that it's not applicable. | |
47117241 UH |
538 | * |
539 | * @since 0.3.0 | |
cbadb856 | 540 | */ |
8f996b89 | 541 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, |
53b4680f | 542 | const struct sr_channel_group *cg, |
584560f1 | 543 | uint32_t key, GVariant *data) |
cbadb856 BV |
544 | { |
545 | int ret; | |
546 | ||
bc1c2f00 | 547 | g_variant_ref_sink(data); |
cbadb856 | 548 | |
bc1c2f00 BV |
549 | if (!sdi || !sdi->driver || !data) |
550 | ret = SR_ERR; | |
551 | else if (!sdi->driver->config_set) | |
552 | ret = SR_ERR_ARG; | |
c6dde812 BV |
553 | else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET) != SR_OK) |
554 | return SR_ERR_ARG; | |
13fef1ed | 555 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) |
53b4680f | 556 | ret = sdi->driver->config_set(key, data, sdi, cg); |
cbadb856 | 557 | |
bc1c2f00 | 558 | g_variant_unref(data); |
cbadb856 BV |
559 | |
560 | return ret; | |
561 | } | |
562 | ||
2a854d71 DE |
563 | /** |
564 | * Apply configuration settings to the device hardware. | |
565 | * | |
566 | * @param sdi The device instance. | |
567 | * | |
568 | * @return SR_OK upon success or SR_ERR in case of error. | |
47117241 UH |
569 | * |
570 | * @since 0.3.0 | |
2a854d71 DE |
571 | */ |
572 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
573 | { | |
574 | int ret; | |
575 | ||
576 | if (!sdi || !sdi->driver) | |
577 | ret = SR_ERR; | |
578 | else if (!sdi->driver->config_commit) | |
579 | ret = SR_OK; | |
580 | else | |
581 | ret = sdi->driver->config_commit(sdi); | |
582 | ||
583 | return ret; | |
584 | } | |
585 | ||
cbadb856 BV |
586 | /** |
587 | * List all possible values for a configuration key. | |
588 | * | |
67eb6bcb MH |
589 | * @param[in] driver The sr_dev_driver struct to query. |
590 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 | 591 | * contain a pointer to the struct sr_dev_inst to be checked. |
53b4680f | 592 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 593 | * values, or NULL. |
67eb6bcb MH |
594 | * @param[in] key The configuration key (SR_CONF_*). |
595 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
596 | * The caller is given ownership of the GVariant and must thus | |
bc1c2f00 BV |
597 | * unref the GVariant after use. However if this function |
598 | * returns an error code, the field should be considered | |
599 | * unused, and should not be unreferenced. | |
cbadb856 | 600 | * |
67eb6bcb MH |
601 | * @retval SR_OK Success. |
602 | * @retval SR_ERR Error. | |
603 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
604 | * interpreted as an error by the caller; merely as an indication | |
605 | * that it's not applicable. | |
47117241 UH |
606 | * |
607 | * @since 0.3.0 | |
cbadb856 | 608 | */ |
8f996b89 ML |
609 | SR_API int sr_config_list(const struct sr_dev_driver *driver, |
610 | const struct sr_dev_inst *sdi, | |
53b4680f | 611 | const struct sr_channel_group *cg, |
584560f1 | 612 | uint32_t key, GVariant **data) |
c5fb502f BV |
613 | { |
614 | int ret; | |
615 | ||
6cefe516 | 616 | if (!driver || !data) |
bc1c2f00 | 617 | ret = SR_ERR; |
d8284802 | 618 | else if (!driver->config_list) |
6cefe516 | 619 | ret = SR_ERR_ARG; |
c6dde812 BV |
620 | else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) { |
621 | if (check_key(driver, sdi, cg, key, SR_CONF_LIST) != SR_OK) | |
622 | return SR_ERR_ARG; | |
623 | } | |
53b4680f | 624 | else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) |
bc1c2f00 | 625 | g_variant_ref_sink(*data); |
c5fb502f BV |
626 | |
627 | return ret; | |
628 | } | |
629 | ||
8bfdc8c4 | 630 | /** |
67eb6bcb | 631 | * Get information about a configuration key, by key. |
a1645fcd | 632 | * |
67eb6bcb | 633 | * @param[in] key The configuration key. |
15cb43d6 | 634 | * |
c89c1c9c | 635 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 636 | * was not found. |
47117241 UH |
637 | * |
638 | * @since 0.2.0 | |
15cb43d6 | 639 | */ |
584560f1 | 640 | SR_API const struct sr_config_info *sr_config_info_get(uint32_t key) |
15cb43d6 BV |
641 | { |
642 | int i; | |
643 | ||
c89c1c9c BV |
644 | for (i = 0; sr_config_info_data[i].key; i++) { |
645 | if (sr_config_info_data[i].key == key) | |
646 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
647 | } |
648 | ||
649 | return NULL; | |
650 | } | |
651 | ||
652 | /** | |
67eb6bcb | 653 | * Get information about a configuration key, by name. |
15cb43d6 | 654 | * |
67eb6bcb | 655 | * @param[in] optname The configuration key. |
a1645fcd | 656 | * |
c89c1c9c | 657 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 658 | * was not found. |
47117241 UH |
659 | * |
660 | * @since 0.2.0 | |
a1645fcd | 661 | */ |
c89c1c9c | 662 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 663 | { |
a1bb33af UH |
664 | int i; |
665 | ||
c89c1c9c | 666 | for (i = 0; sr_config_info_data[i].key; i++) { |
a700a3a4 BV |
667 | if (!sr_config_info_data[i].id) |
668 | continue; | |
c89c1c9c BV |
669 | if (!strcmp(sr_config_info_data[i].id, optname)) |
670 | return &sr_config_info_data[i]; | |
a1bb33af UH |
671 | } |
672 | ||
49d0ce50 | 673 | return NULL; |
a1bb33af UH |
674 | } |
675 | ||
7b870c38 | 676 | /** @} */ |