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