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