]>
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}, |
daa39012 AJ |
68 | {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr", |
69 | "Modbus slave address", 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}, | |
7a0b98b5 AJ |
130 | {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage", |
131 | "Current voltage", NULL}, | |
132 | {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target", | |
133 | "Voltage target", NULL}, | |
134 | {SR_CONF_CURRENT, SR_T_FLOAT, "current", | |
135 | "Current current", NULL}, | |
136 | {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit", | |
137 | "Current limit", NULL}, | |
138 | {SR_CONF_ENABLED, SR_T_BOOL, "enabled", | |
139 | "Channel enabled", NULL}, | |
140 | {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config", | |
141 | "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}, | |
7a0b98b5 AJ |
158 | {SR_CONF_REGULATION, SR_T_STRING, "regulation", |
159 | "Channel regulation", NULL}, | |
54ab1dcd UH |
160 | {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp", |
161 | "Over-temperature protection", NULL}, | |
b94dd07b | 162 | {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency", |
a42a39ac | 163 | "Output frequency", NULL}, |
a77585d4 AG |
164 | {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target", |
165 | "Output frequency target", NULL}, | |
a42a39ac JH |
166 | {SR_CONF_MEASURED_QUANTITY, SR_T_STRING, "measured_quantity", |
167 | "Measured quantity", NULL}, | |
168 | {SR_CONF_MEASURED_2ND_QUANTITY, SR_T_STRING, "measured_2nd_quantity", | |
169 | "Measured secondary quantity", NULL}, | |
170 | {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model", | |
171 | "Equivalent circuit model", NULL}, | |
54ab1dcd UH |
172 | |
173 | /* Special stuff */ | |
174 | {SR_CONF_SCAN_OPTIONS, SR_T_STRING, "scan_options", | |
175 | "Scan options", NULL}, | |
176 | {SR_CONF_DEVICE_OPTIONS, SR_T_STRING, "device_options", | |
177 | "Device options", NULL}, | |
178 | {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile", | |
179 | "Session file", NULL}, | |
180 | {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile", | |
181 | "Capture file", NULL}, | |
182 | {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize", | |
183 | "Capture unitsize", NULL}, | |
184 | {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", | |
185 | "Power off", NULL}, | |
186 | {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source", | |
187 | "Data source", NULL}, | |
d3c81725 BG |
188 | {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor", |
189 | "Probe factor", NULL}, | |
54ab1dcd UH |
190 | |
191 | /* Acquisition modes, sample limiting */ | |
192 | {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time", | |
193 | "Time limit", NULL}, | |
194 | {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", | |
195 | "Sample limit", NULL}, | |
196 | {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames", | |
197 | "Frame limit", NULL}, | |
198 | {SR_CONF_CONTINUOUS, SR_T_UINT64, "continuous", | |
199 | "Continuous sampling", NULL}, | |
200 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", | |
201 | "Datalog", NULL}, | |
202 | {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode", | |
203 | "Device mode", NULL}, | |
204 | {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode", | |
205 | "Test mode", NULL}, | |
206 | ||
083d64f9 | 207 | {0, 0, NULL, NULL, NULL}, |
a1bb33af UH |
208 | }; |
209 | ||
13fef1ed ML |
210 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) |
211 | { | |
212 | switch (datatype) { | |
213 | case SR_T_INT32: | |
214 | return G_VARIANT_TYPE_INT32; | |
215 | case SR_T_UINT64: | |
216 | return G_VARIANT_TYPE_UINT64; | |
217 | case SR_T_STRING: | |
218 | return G_VARIANT_TYPE_STRING; | |
219 | case SR_T_BOOL: | |
220 | return G_VARIANT_TYPE_BOOLEAN; | |
221 | case SR_T_FLOAT: | |
222 | return G_VARIANT_TYPE_DOUBLE; | |
223 | case SR_T_RATIONAL_PERIOD: | |
224 | case SR_T_RATIONAL_VOLT: | |
225 | case SR_T_UINT64_RANGE: | |
226 | case SR_T_DOUBLE_RANGE: | |
227 | return G_VARIANT_TYPE_TUPLE; | |
228 | case SR_T_KEYVALUE: | |
229 | return G_VARIANT_TYPE_DICTIONARY; | |
230 | default: | |
231 | return NULL; | |
232 | } | |
233 | } | |
234 | ||
584560f1 | 235 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) |
13fef1ed ML |
236 | { |
237 | const struct sr_config_info *info; | |
238 | const GVariantType *type, *expected; | |
61b02922 BV |
239 | char *expected_string, *type_string; |
240 | ||
13fef1ed ML |
241 | info = sr_config_info_get(key); |
242 | if (!info) | |
243 | return SR_OK; | |
61b02922 | 244 | |
13fef1ed ML |
245 | expected = sr_variant_type_get(info->datatype); |
246 | type = g_variant_get_type(value); | |
61b02922 BV |
247 | if (!g_variant_type_equal(type, expected) |
248 | && !g_variant_type_is_subtype_of(type, expected)) { | |
249 | expected_string = g_variant_type_dup_string(expected); | |
250 | type_string = g_variant_type_dup_string(type); | |
13fef1ed ML |
251 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", |
252 | info->name, expected_string, type_string); | |
253 | g_free(expected_string); | |
254 | g_free(type_string); | |
255 | return SR_ERR_ARG; | |
256 | } | |
61b02922 | 257 | |
13fef1ed ML |
258 | return SR_OK; |
259 | } | |
260 | ||
a1645fcd | 261 | /** |
cfe064d8 | 262 | * Return the list of supported hardware drivers. |
a1645fcd | 263 | * |
032da34b UH |
264 | * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL. |
265 | * | |
266 | * @retval NULL The ctx argument was NULL, or there are no supported drivers. | |
267 | * @retval Other Pointer to the NULL-terminated list of hardware drivers. | |
268 | * The user should NOT g_free() this list, sr_exit() will do that. | |
47117241 | 269 | * |
032da34b | 270 | * @since 0.4.0 |
a1645fcd | 271 | */ |
032da34b | 272 | SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx) |
a1bb33af | 273 | { |
032da34b UH |
274 | if (!ctx) |
275 | return NULL; | |
9e60a31f | 276 | |
032da34b | 277 | return ctx->driver_list; |
a1bb33af UH |
278 | } |
279 | ||
a1645fcd | 280 | /** |
c09f0b57 | 281 | * Initialize a hardware driver. |
a1645fcd | 282 | * |
c0eea11c UH |
283 | * This usually involves memory allocations and variable initializations |
284 | * within the driver, but _not_ scanning for attached devices. | |
285 | * The API call sr_driver_scan() is used for that. | |
286 | * | |
44fc870c | 287 | * @param ctx A libsigrok context object allocated by a previous call to |
c0eea11c UH |
288 | * sr_init(). Must not be NULL. |
289 | * @param driver The driver to initialize. This must be a pointer to one of | |
290 | * the entries returned by sr_driver_list(). Must not be NULL. | |
a1645fcd | 291 | * |
67eb6bcb MH |
292 | * @retval SR_OK Success |
293 | * @retval SR_ERR_ARG Invalid parameter(s). | |
294 | * @retval SR_ERR_BUG Internal errors. | |
295 | * @retval other Another negative error code upon other errors. | |
47117241 UH |
296 | * |
297 | * @since 0.2.0 | |
a1645fcd | 298 | */ |
44fc870c | 299 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) |
8722c31e | 300 | { |
c0eea11c UH |
301 | int ret; |
302 | ||
303 | if (!ctx) { | |
304 | sr_err("Invalid libsigrok context, can't initialize."); | |
305 | return SR_ERR_ARG; | |
306 | } | |
307 | ||
308 | if (!driver) { | |
309 | sr_err("Invalid driver, can't initialize."); | |
310 | return SR_ERR_ARG; | |
311 | } | |
8722c31e | 312 | |
c0eea11c | 313 | sr_spew("Initializing driver '%s'.", driver->name); |
4f840ce9 | 314 | if ((ret = driver->init(driver, ctx)) < 0) |
c0eea11c | 315 | sr_err("Failed to initialize the driver: %d.", ret); |
80bf0426 | 316 | |
c0eea11c | 317 | return ret; |
80bf0426 BV |
318 | } |
319 | ||
adfba736 BV |
320 | static int check_options(struct sr_dev_driver *driver, GSList *options, |
321 | uint32_t optlist_key, struct sr_dev_inst *sdi, | |
322 | struct sr_channel_group *cg) | |
323 | { | |
324 | struct sr_config *src; | |
325 | const struct sr_config_info *srci; | |
326 | GVariant *gvar_opts; | |
327 | GSList *l; | |
328 | const uint32_t *opts; | |
329 | gsize num_opts, i; | |
330 | int ret; | |
331 | ||
332 | if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) { | |
333 | /* Driver publishes no options for this optlist. */ | |
334 | return SR_ERR; | |
335 | } | |
336 | ||
337 | ret = SR_OK; | |
338 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
339 | for (l = options; l; l = l->next) { | |
340 | src = l->data; | |
341 | for (i = 0; i < num_opts; i++) { | |
342 | if (opts[i] == src->key) | |
343 | break; | |
344 | } | |
345 | if (i == num_opts) { | |
346 | if (!(srci = sr_config_info_get(src->key))) | |
347 | /* Shouldn't happen. */ | |
348 | sr_err("Invalid option %d.", src->key); | |
349 | else | |
350 | sr_err("Invalid option '%s'.", srci->id); | |
351 | ret = SR_ERR_ARG; | |
352 | break; | |
353 | } | |
354 | if (sr_variant_type_check(src->key, src->data) != SR_OK) { | |
355 | ret = SR_ERR_ARG; | |
356 | break; | |
357 | } | |
358 | } | |
359 | g_variant_unref(gvar_opts); | |
360 | ||
361 | return ret; | |
362 | } | |
363 | ||
80bf0426 BV |
364 | /** |
365 | * Tell a hardware driver to scan for devices. | |
366 | * | |
a5f2e707 BV |
367 | * In addition to the detection, the devices that are found are also |
368 | * initialized automatically. On some devices, this involves a firmware upload, | |
369 | * or other such measures. | |
370 | * | |
371 | * The order in which the system is scanned for devices is not specified. The | |
372 | * caller should not assume or rely on any specific order. | |
373 | * | |
4b97c74e UH |
374 | * Before calling sr_driver_scan(), the user must have previously initialized |
375 | * the driver by calling sr_driver_init(). | |
80bf0426 | 376 | * |
4b97c74e UH |
377 | * @param driver The driver that should scan. This must be a pointer to one of |
378 | * the entries returned by sr_driver_list(). Must not be NULL. | |
379 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
380 | * scanner. Can be NULL/empty. | |
381 | * | |
382 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
383 | * found (or errors were encountered). This list must be freed by the | |
384 | * caller using g_slist_free(), but without freeing the data pointed | |
385 | * to in the list. | |
47117241 UH |
386 | * |
387 | * @since 0.2.0 | |
80bf0426 BV |
388 | */ |
389 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
390 | { | |
071151b5 | 391 | GSList *l; |
4b97c74e UH |
392 | |
393 | if (!driver) { | |
394 | sr_err("Invalid driver, can't scan for devices."); | |
395 | return NULL; | |
396 | } | |
397 | ||
398 | if (!driver->priv) { | |
399 | sr_err("Driver not initialized, can't scan for devices."); | |
400 | return NULL; | |
401 | } | |
402 | ||
adfba736 BV |
403 | if (options) { |
404 | if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK) | |
13fef1ed ML |
405 | return NULL; |
406 | } | |
407 | ||
4f840ce9 | 408 | l = driver->scan(driver, options); |
80bf0426 | 409 | |
4b97c74e UH |
410 | sr_spew("Scan of '%s' found %d devices.", driver->name, |
411 | g_slist_length(l)); | |
80bf0426 | 412 | |
4b97c74e | 413 | return l; |
8722c31e BV |
414 | } |
415 | ||
032da34b UH |
416 | /** |
417 | * Call driver cleanup function for all drivers. | |
418 | * | |
419 | * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL. | |
420 | * | |
421 | * @private | |
422 | */ | |
423 | SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx) | |
8722c31e | 424 | { |
050e9219 | 425 | int i; |
c09f0b57 | 426 | struct sr_dev_driver **drivers; |
8722c31e | 427 | |
032da34b UH |
428 | if (!ctx) |
429 | return; | |
430 | ||
431 | drivers = sr_driver_list(ctx); | |
c09f0b57 UH |
432 | for (i = 0; drivers[i]; i++) { |
433 | if (drivers[i]->cleanup) | |
4f840ce9 ML |
434 | drivers[i]->cleanup(drivers[i]); |
435 | drivers[i]->priv = NULL; | |
8722c31e | 436 | } |
8722c31e BV |
437 | } |
438 | ||
67eb6bcb MH |
439 | /** Allocate struct sr_config. |
440 | * A floating reference can be passed in for data. | |
441 | * @private | |
442 | */ | |
584560f1 | 443 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) |
4c0e310c BV |
444 | { |
445 | struct sr_config *src; | |
446 | ||
91219afc | 447 | src = g_malloc0(sizeof(struct sr_config)); |
4c0e310c | 448 | src->key = key; |
bc1c2f00 | 449 | src->data = g_variant_ref_sink(data); |
4c0e310c BV |
450 | |
451 | return src; | |
452 | } | |
453 | ||
67eb6bcb MH |
454 | /** Free struct sr_config. |
455 | * @private | |
456 | */ | |
722db131 BV |
457 | SR_PRIV void sr_config_free(struct sr_config *src) |
458 | { | |
459 | ||
460 | if (!src || !src->data) { | |
461 | sr_err("%s: invalid data!", __func__); | |
462 | return; | |
463 | } | |
464 | ||
465 | g_variant_unref(src->data); | |
466 | g_free(src); | |
467 | ||
468 | } | |
469 | ||
dcd438ee UH |
470 | static void log_key(const struct sr_dev_inst *sdi, |
471 | const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data) | |
472 | { | |
473 | const char *opstr; | |
474 | const struct sr_config_info *srci; | |
475 | ||
476 | /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */ | |
477 | if (key == SR_CONF_DEVICE_OPTIONS) | |
478 | return; | |
479 | ||
480 | opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list"; | |
481 | srci = sr_config_info_get(key); | |
482 | ||
483 | sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key, | |
484 | srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL", | |
485 | data ? g_variant_print(data, TRUE) : "NULL"); | |
486 | } | |
487 | ||
c6dde812 BV |
488 | static int check_key(const struct sr_dev_driver *driver, |
489 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, | |
dcd438ee | 490 | uint32_t key, int op, GVariant *data) |
c6dde812 BV |
491 | { |
492 | const struct sr_config_info *srci; | |
493 | gsize num_opts, i; | |
494 | GVariant *gvar_opts; | |
495 | const uint32_t *opts; | |
496 | uint32_t pub_opt; | |
497 | char *suffix, *opstr; | |
498 | ||
499 | if (sdi && cg) | |
500 | suffix = " for this device and channel group"; | |
501 | else if (sdi) | |
502 | suffix = " for this device"; | |
503 | else | |
504 | suffix = ""; | |
505 | ||
506 | if (!(srci = sr_config_info_get(key))) { | |
507 | sr_err("Invalid key %d.", key); | |
508 | return SR_ERR_ARG; | |
509 | } | |
510 | opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list"; | |
dcd438ee UH |
511 | |
512 | switch (key) { | |
513 | case SR_CONF_LIMIT_MSEC: | |
514 | case SR_CONF_LIMIT_SAMPLES: | |
515 | case SR_CONF_SAMPLERATE: | |
516 | /* Setting any of these to 0 is not useful. */ | |
517 | if (op != SR_CONF_SET || !data) | |
518 | break; | |
519 | if (g_variant_get_uint64(data) == 0) { | |
520 | sr_err("Cannot set '%s' to 0.", srci->id); | |
521 | return SR_ERR_ARG; | |
522 | } | |
523 | break; | |
524 | } | |
c6dde812 BV |
525 | |
526 | if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) { | |
527 | /* Driver publishes no options. */ | |
528 | sr_err("No options available%s.", srci->id, suffix); | |
529 | return SR_ERR_ARG; | |
530 | } | |
531 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
532 | pub_opt = 0; | |
533 | for (i = 0; i < num_opts; i++) { | |
534 | if ((opts[i] & SR_CONF_MASK) == key) { | |
535 | pub_opt = opts[i]; | |
536 | break; | |
537 | } | |
538 | } | |
539 | g_variant_unref(gvar_opts); | |
540 | if (!pub_opt) { | |
541 | sr_err("Option '%s' not available%s.", srci->id, suffix); | |
542 | return SR_ERR_ARG; | |
543 | } | |
544 | ||
545 | if (!(pub_opt & op)) { | |
546 | sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix); | |
547 | return SR_ERR_ARG; | |
548 | } | |
549 | ||
550 | return SR_OK; | |
551 | } | |
552 | ||
df123801 | 553 | /** |
67eb6bcb | 554 | * Query value of a configuration key at the given driver or device instance. |
df123801 | 555 | * |
67eb6bcb MH |
556 | * @param[in] driver The sr_dev_driver struct to query. |
557 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 BV |
558 | * contain a pointer to the struct sr_dev_inst to be checked. |
559 | * Otherwise it must be NULL. | |
53b4680f | 560 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 561 | * values, or NULL. |
67eb6bcb MH |
562 | * @param[in] key The configuration key (SR_CONF_*). |
563 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
564 | * Must not be NULL. The caller is given ownership of the GVariant | |
bc1c2f00 BV |
565 | * and must thus decrease the refcount after use. However if |
566 | * this function returns an error code, the field should be | |
567 | * considered unused, and should not be unreferenced. | |
df123801 | 568 | * |
67eb6bcb MH |
569 | * @retval SR_OK Success. |
570 | * @retval SR_ERR Error. | |
571 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
572 | * interpreted as an error by the caller; merely as an indication | |
573 | * that it's not applicable. | |
47117241 UH |
574 | * |
575 | * @since 0.3.0 | |
df123801 | 576 | */ |
8f996b89 ML |
577 | SR_API int sr_config_get(const struct sr_dev_driver *driver, |
578 | const struct sr_dev_inst *sdi, | |
53b4680f | 579 | const struct sr_channel_group *cg, |
584560f1 | 580 | uint32_t key, GVariant **data) |
df123801 BV |
581 | { |
582 | int ret; | |
583 | ||
cbadb856 | 584 | if (!driver || !data) |
df123801 BV |
585 | return SR_ERR; |
586 | ||
6cefe516 BV |
587 | if (!driver->config_get) |
588 | return SR_ERR_ARG; | |
589 | ||
dcd438ee | 590 | if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK) |
c6dde812 BV |
591 | return SR_ERR_ARG; |
592 | ||
53b4680f | 593 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { |
dcd438ee | 594 | log_key(sdi, cg, key, SR_CONF_GET, *data); |
bc1c2f00 BV |
595 | /* Got a floating reference from the driver. Sink it here, |
596 | * caller will need to unref when done with it. */ | |
597 | g_variant_ref_sink(*data); | |
598 | } | |
df123801 BV |
599 | |
600 | return ret; | |
601 | } | |
602 | ||
cbadb856 | 603 | /** |
67eb6bcb | 604 | * Set value of a configuration key in a device instance. |
cbadb856 | 605 | * |
67eb6bcb | 606 | * @param[in] sdi The device instance. |
53b4680f | 607 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 608 | * values, or NULL. |
67eb6bcb | 609 | * @param[in] key The configuration key (SR_CONF_*). |
bc1c2f00 BV |
610 | * @param data The new value for the key, as a GVariant with GVariantType |
611 | * appropriate to that key. A floating reference can be passed | |
612 | * in; its refcount will be sunk and unreferenced after use. | |
cbadb856 | 613 | * |
67eb6bcb MH |
614 | * @retval SR_OK Success. |
615 | * @retval SR_ERR Error. | |
616 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
617 | * interpreted as an error by the caller; merely as an indication | |
618 | * that it's not applicable. | |
47117241 UH |
619 | * |
620 | * @since 0.3.0 | |
cbadb856 | 621 | */ |
8f996b89 | 622 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, |
53b4680f | 623 | const struct sr_channel_group *cg, |
584560f1 | 624 | uint32_t key, GVariant *data) |
cbadb856 BV |
625 | { |
626 | int ret; | |
627 | ||
bc1c2f00 | 628 | g_variant_ref_sink(data); |
cbadb856 | 629 | |
bc1c2f00 BV |
630 | if (!sdi || !sdi->driver || !data) |
631 | ret = SR_ERR; | |
632 | else if (!sdi->driver->config_set) | |
633 | ret = SR_ERR_ARG; | |
dcd438ee | 634 | else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK) |
c6dde812 | 635 | return SR_ERR_ARG; |
dcd438ee UH |
636 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) { |
637 | log_key(sdi, cg, key, SR_CONF_SET, data); | |
53b4680f | 638 | ret = sdi->driver->config_set(key, data, sdi, cg); |
dcd438ee | 639 | } |
cbadb856 | 640 | |
bc1c2f00 | 641 | g_variant_unref(data); |
cbadb856 BV |
642 | |
643 | return ret; | |
644 | } | |
645 | ||
2a854d71 DE |
646 | /** |
647 | * Apply configuration settings to the device hardware. | |
648 | * | |
649 | * @param sdi The device instance. | |
650 | * | |
651 | * @return SR_OK upon success or SR_ERR in case of error. | |
47117241 UH |
652 | * |
653 | * @since 0.3.0 | |
2a854d71 DE |
654 | */ |
655 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
656 | { | |
657 | int ret; | |
658 | ||
659 | if (!sdi || !sdi->driver) | |
660 | ret = SR_ERR; | |
661 | else if (!sdi->driver->config_commit) | |
662 | ret = SR_OK; | |
663 | else | |
664 | ret = sdi->driver->config_commit(sdi); | |
665 | ||
666 | return ret; | |
667 | } | |
668 | ||
cbadb856 BV |
669 | /** |
670 | * List all possible values for a configuration key. | |
671 | * | |
67eb6bcb MH |
672 | * @param[in] driver The sr_dev_driver struct to query. |
673 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
57ecdbd7 | 674 | * contain a pointer to the struct sr_dev_inst to be checked. |
53b4680f | 675 | * @param[in] cg The channel group on the device for which to list the |
57ecdbd7 | 676 | * values, or NULL. |
67eb6bcb MH |
677 | * @param[in] key The configuration key (SR_CONF_*). |
678 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
679 | * The caller is given ownership of the GVariant and must thus | |
bc1c2f00 BV |
680 | * unref the GVariant after use. However if this function |
681 | * returns an error code, the field should be considered | |
682 | * unused, and should not be unreferenced. | |
cbadb856 | 683 | * |
67eb6bcb MH |
684 | * @retval SR_OK Success. |
685 | * @retval SR_ERR Error. | |
686 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
687 | * interpreted as an error by the caller; merely as an indication | |
688 | * that it's not applicable. | |
47117241 UH |
689 | * |
690 | * @since 0.3.0 | |
cbadb856 | 691 | */ |
8f996b89 ML |
692 | SR_API int sr_config_list(const struct sr_dev_driver *driver, |
693 | const struct sr_dev_inst *sdi, | |
53b4680f | 694 | const struct sr_channel_group *cg, |
584560f1 | 695 | uint32_t key, GVariant **data) |
c5fb502f BV |
696 | { |
697 | int ret; | |
698 | ||
6cefe516 | 699 | if (!driver || !data) |
8a58419d | 700 | return SR_ERR; |
d8284802 | 701 | else if (!driver->config_list) |
8a58419d | 702 | return SR_ERR_ARG; |
c6dde812 | 703 | else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) { |
dcd438ee | 704 | if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK) |
c6dde812 BV |
705 | return SR_ERR_ARG; |
706 | } | |
dcd438ee UH |
707 | if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) { |
708 | log_key(sdi, cg, key, SR_CONF_LIST, *data); | |
bc1c2f00 | 709 | g_variant_ref_sink(*data); |
dcd438ee | 710 | } |
c5fb502f BV |
711 | |
712 | return ret; | |
713 | } | |
714 | ||
8bfdc8c4 | 715 | /** |
67eb6bcb | 716 | * Get information about a configuration key, by key. |
a1645fcd | 717 | * |
67eb6bcb | 718 | * @param[in] key The configuration key. |
15cb43d6 | 719 | * |
c89c1c9c | 720 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 721 | * was not found. |
47117241 UH |
722 | * |
723 | * @since 0.2.0 | |
15cb43d6 | 724 | */ |
584560f1 | 725 | SR_API const struct sr_config_info *sr_config_info_get(uint32_t key) |
15cb43d6 BV |
726 | { |
727 | int i; | |
728 | ||
c89c1c9c BV |
729 | for (i = 0; sr_config_info_data[i].key; i++) { |
730 | if (sr_config_info_data[i].key == key) | |
731 | return &sr_config_info_data[i]; | |
15cb43d6 BV |
732 | } |
733 | ||
734 | return NULL; | |
735 | } | |
736 | ||
737 | /** | |
67eb6bcb | 738 | * Get information about a configuration key, by name. |
15cb43d6 | 739 | * |
67eb6bcb | 740 | * @param[in] optname The configuration key. |
a1645fcd | 741 | * |
c89c1c9c | 742 | * @return A pointer to a struct sr_config_info, or NULL if the key |
15cb43d6 | 743 | * was not found. |
47117241 UH |
744 | * |
745 | * @since 0.2.0 | |
a1645fcd | 746 | */ |
c89c1c9c | 747 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) |
a1bb33af | 748 | { |
a1bb33af UH |
749 | int i; |
750 | ||
c89c1c9c | 751 | for (i = 0; sr_config_info_data[i].key; i++) { |
a700a3a4 BV |
752 | if (!sr_config_info_data[i].id) |
753 | continue; | |
c89c1c9c BV |
754 | if (!strcmp(sr_config_info_data[i].id, optname)) |
755 | return &sr_config_info_data[i]; | |
a1bb33af UH |
756 | } |
757 | ||
49d0ce50 | 758 | return NULL; |
a1bb33af UH |
759 | } |
760 | ||
7b870c38 | 761 | /** @} */ |