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