]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
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 <config.h> | |
21 | #include <stdlib.h> | |
22 | #include <stdio.h> | |
23 | #include <sys/types.h> | |
24 | #include <dirent.h> | |
25 | #include <string.h> | |
26 | #include <glib.h> | |
27 | #include <libsigrok/libsigrok.h> | |
28 | #include "libsigrok-internal.h" | |
29 | ||
30 | /** @cond PRIVATE */ | |
31 | #define LOG_PREFIX "hwdriver" | |
32 | /** @endcond */ | |
33 | ||
34 | /** | |
35 | * @file | |
36 | * | |
37 | * Hardware driver handling in libsigrok. | |
38 | */ | |
39 | ||
40 | /** | |
41 | * @defgroup grp_driver Hardware drivers | |
42 | * | |
43 | * Hardware driver handling in libsigrok. | |
44 | * | |
45 | * @{ | |
46 | */ | |
47 | ||
48 | /* Please use the same order/grouping as in enum sr_configkey (libsigrok.h). */ | |
49 | static struct sr_key_info sr_key_info_config[] = { | |
50 | /* Device classes */ | |
51 | {SR_CONF_LOGIC_ANALYZER, SR_T_STRING, NULL, "Logic analyzer", NULL}, | |
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 | {SR_CONF_ELECTRONIC_LOAD, SR_T_STRING, NULL, "Electronic load", NULL}, | |
63 | {SR_CONF_SCALE, SR_T_STRING, NULL, "Scale", NULL}, | |
64 | {SR_CONF_SIGNAL_GENERATOR, SR_T_STRING, NULL, "Signal generator", NULL}, | |
65 | ||
66 | /* Driver scan options */ | |
67 | {SR_CONF_CONN, SR_T_STRING, "conn", | |
68 | "Connection", NULL}, | |
69 | {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm", | |
70 | "Serial communication", NULL}, | |
71 | {SR_CONF_MODBUSADDR, SR_T_UINT64, "modbusaddr", | |
72 | "Modbus slave address", NULL}, | |
73 | ||
74 | /* Device (or channel group) configuration */ | |
75 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", | |
76 | "Sample rate", NULL}, | |
77 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", | |
78 | "Pre-trigger capture ratio", NULL}, | |
79 | {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern", | |
80 | "Pattern", NULL}, | |
81 | {SR_CONF_RLE, SR_T_BOOL, "rle", | |
82 | "Run length encoding", NULL}, | |
83 | {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope", | |
84 | "Trigger slope", NULL}, | |
85 | {SR_CONF_AVERAGING, SR_T_BOOL, "averaging", | |
86 | "Averaging", NULL}, | |
87 | {SR_CONF_AVG_SAMPLES, SR_T_UINT64, "avg_samples", | |
88 | "Number of samples to average over", NULL}, | |
89 | {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource", | |
90 | "Trigger source", NULL}, | |
91 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", | |
92 | "Horizontal trigger position", NULL}, | |
93 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", | |
94 | "Buffer size", NULL}, | |
95 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", | |
96 | "Time base", NULL}, | |
97 | {SR_CONF_FILTER, SR_T_BOOL, "filter", | |
98 | "Filter", NULL}, | |
99 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", | |
100 | "Volts/div", NULL}, | |
101 | {SR_CONF_COUPLING, SR_T_STRING, "coupling", | |
102 | "Coupling", NULL}, | |
103 | {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch", | |
104 | "Trigger matches", NULL}, | |
105 | {SR_CONF_SAMPLE_INTERVAL, SR_T_UINT64, "sample_interval", | |
106 | "Sample interval", NULL}, | |
107 | {SR_CONF_NUM_HDIV, SR_T_INT32, "num_hdiv", | |
108 | "Number of horizontal divisions", NULL}, | |
109 | {SR_CONF_NUM_VDIV, SR_T_INT32, "num_vdiv", | |
110 | "Number of vertical divisions", NULL}, | |
111 | {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq", | |
112 | "Sound pressure level frequency weighting", NULL}, | |
113 | {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time", | |
114 | "Sound pressure level time weighting", NULL}, | |
115 | {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range", | |
116 | "Sound pressure level measurement range", NULL}, | |
117 | {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max", | |
118 | "Hold max", NULL}, | |
119 | {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min", | |
120 | "Hold min", NULL}, | |
121 | {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold", | |
122 | "Voltage threshold", NULL }, | |
123 | {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", | |
124 | "External clock mode", NULL}, | |
125 | {SR_CONF_SWAP, SR_T_BOOL, "swap", | |
126 | "Swap channel order", NULL}, | |
127 | {SR_CONF_CENTER_FREQUENCY, SR_T_UINT64, "center_frequency", | |
128 | "Center frequency", NULL}, | |
129 | {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", | |
130 | "Number of logic channels", NULL}, | |
131 | {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", | |
132 | "Number of analog channels", NULL}, | |
133 | {SR_CONF_VOLTAGE, SR_T_FLOAT, "voltage", | |
134 | "Current voltage", NULL}, | |
135 | {SR_CONF_VOLTAGE_TARGET, SR_T_FLOAT, "voltage_target", | |
136 | "Voltage target", NULL}, | |
137 | {SR_CONF_CURRENT, SR_T_FLOAT, "current", | |
138 | "Current current", NULL}, | |
139 | {SR_CONF_CURRENT_LIMIT, SR_T_FLOAT, "current_limit", | |
140 | "Current limit", NULL}, | |
141 | {SR_CONF_ENABLED, SR_T_BOOL, "enabled", | |
142 | "Channel enabled", NULL}, | |
143 | {SR_CONF_CHANNEL_CONFIG, SR_T_STRING, "channel_config", | |
144 | "Channel modes", NULL}, | |
145 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled", | |
146 | "Over-voltage protection enabled", NULL}, | |
147 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active", | |
148 | "Over-voltage protection active", NULL}, | |
149 | {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold", | |
150 | "Over-voltage protection threshold", NULL}, | |
151 | {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled", | |
152 | "Over-current protection enabled", NULL}, | |
153 | {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active", | |
154 | "Over-current protection active", NULL}, | |
155 | {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold", | |
156 | "Over-current protection threshold", NULL}, | |
157 | {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge", | |
158 | "Clock edge", NULL}, | |
159 | {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude", | |
160 | "Amplitude", NULL}, | |
161 | {SR_CONF_REGULATION, SR_T_STRING, "regulation", | |
162 | "Channel regulation", NULL}, | |
163 | {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp", | |
164 | "Over-temperature protection", NULL}, | |
165 | {SR_CONF_OUTPUT_FREQUENCY, SR_T_FLOAT, "output_frequency", | |
166 | "Output frequency", NULL}, | |
167 | {SR_CONF_OUTPUT_FREQUENCY_TARGET, SR_T_FLOAT, "output_frequency_target", | |
168 | "Output frequency target", NULL}, | |
169 | {SR_CONF_MEASURED_QUANTITY, SR_T_MQ, "measured_quantity", | |
170 | "Measured quantity", NULL}, | |
171 | {SR_CONF_EQUIV_CIRCUIT_MODEL, SR_T_STRING, "equiv_circuit_model", | |
172 | "Equivalent circuit model", NULL}, | |
173 | {SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE, SR_T_BOOL, "otp_active", | |
174 | "Over-temperature protection active", NULL}, | |
175 | {SR_CONF_UNDER_VOLTAGE_CONDITION, SR_T_BOOL, "uvc", | |
176 | "Under-voltage condition", NULL}, | |
177 | {SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE, SR_T_BOOL, "uvc_active", | |
178 | "Under-voltage condition active", NULL}, | |
179 | {SR_CONF_TRIGGER_LEVEL, SR_T_FLOAT, "triggerlevel", | |
180 | "Trigger level", NULL}, | |
181 | ||
182 | /* Special stuff */ | |
183 | {SR_CONF_SESSIONFILE, SR_T_STRING, "sessionfile", | |
184 | "Session file", NULL}, | |
185 | {SR_CONF_CAPTUREFILE, SR_T_STRING, "capturefile", | |
186 | "Capture file", NULL}, | |
187 | {SR_CONF_CAPTURE_UNITSIZE, SR_T_UINT64, "capture_unitsize", | |
188 | "Capture unitsize", NULL}, | |
189 | {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", | |
190 | "Power off", NULL}, | |
191 | {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source", | |
192 | "Data source", NULL}, | |
193 | {SR_CONF_PROBE_FACTOR, SR_T_UINT64, "probe_factor", | |
194 | "Probe factor", NULL}, | |
195 | {SR_CONF_ADC_POWERLINE_CYCLES, SR_T_FLOAT, "nplc", | |
196 | "Number of ADC powerline cycles", NULL}, | |
197 | ||
198 | /* Acquisition modes, sample limiting */ | |
199 | {SR_CONF_LIMIT_MSEC, SR_T_UINT64, "limit_time", | |
200 | "Time limit", NULL}, | |
201 | {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", | |
202 | "Sample limit", NULL}, | |
203 | {SR_CONF_LIMIT_FRAMES, SR_T_UINT64, "limit_frames", | |
204 | "Frame limit", NULL}, | |
205 | {SR_CONF_CONTINUOUS, SR_T_BOOL, "continuous", | |
206 | "Continuous sampling", NULL}, | |
207 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", | |
208 | "Datalog", NULL}, | |
209 | {SR_CONF_DEVICE_MODE, SR_T_STRING, "device_mode", | |
210 | "Device mode", NULL}, | |
211 | {SR_CONF_TEST_MODE, SR_T_STRING, "test_mode", | |
212 | "Test mode", NULL}, | |
213 | ||
214 | ALL_ZERO | |
215 | }; | |
216 | ||
217 | /* Please use the same order as in enum sr_mq (libsigrok.h). */ | |
218 | static struct sr_key_info sr_key_info_mq[] = { | |
219 | {SR_MQ_VOLTAGE, 0, "voltage", "Voltage", NULL}, | |
220 | {SR_MQ_CURRENT, 0, "current", "Current", NULL}, | |
221 | {SR_MQ_RESISTANCE, 0, "resistance", "Resistance", NULL}, | |
222 | {SR_MQ_CAPACITANCE, 0, "capacitance", "Capacitance", NULL}, | |
223 | {SR_MQ_TEMPERATURE, 0, "temperature", "Temperature", NULL}, | |
224 | {SR_MQ_FREQUENCY, 0, "frequency", "Frequency", NULL}, | |
225 | {SR_MQ_DUTY_CYCLE, 0, "duty_cycle", "Duty cycle", NULL}, | |
226 | {SR_MQ_CONTINUITY, 0, "continuity", "Continuity", NULL}, | |
227 | {SR_MQ_PULSE_WIDTH, 0, "pulse_width", "Pulse width", NULL}, | |
228 | {SR_MQ_CONDUCTANCE, 0, "conductance", "Conductance", NULL}, | |
229 | {SR_MQ_POWER, 0, "power", "Power", NULL}, | |
230 | {SR_MQ_GAIN, 0, "gain", "Gain", NULL}, | |
231 | {SR_MQ_SOUND_PRESSURE_LEVEL, 0, "spl", "Sound pressure level", NULL}, | |
232 | {SR_MQ_CARBON_MONOXIDE, 0, "co", "Carbon monoxide", NULL}, | |
233 | {SR_MQ_RELATIVE_HUMIDITY, 0, "rh", "Relative humidity", NULL}, | |
234 | {SR_MQ_TIME, 0, "time", "Time", NULL}, | |
235 | {SR_MQ_WIND_SPEED, 0, "wind_speed", "Wind speed", NULL}, | |
236 | {SR_MQ_PRESSURE, 0, "pressure", "Pressure", NULL}, | |
237 | {SR_MQ_PARALLEL_INDUCTANCE, 0, "parallel_inductance", "Parallel inductance", NULL}, | |
238 | {SR_MQ_PARALLEL_CAPACITANCE, 0, "parallel_capacitance", "Parallel capacitance", NULL}, | |
239 | {SR_MQ_PARALLEL_RESISTANCE, 0, "parallel_resistance", "Parallel resistance", NULL}, | |
240 | {SR_MQ_SERIES_INDUCTANCE, 0, "series_inductance", "Series inductance", NULL}, | |
241 | {SR_MQ_SERIES_CAPACITANCE, 0, "series_capacitance", "Series capacitance", NULL}, | |
242 | {SR_MQ_SERIES_RESISTANCE, 0, "series_resistance", "Series resistance", NULL}, | |
243 | {SR_MQ_DISSIPATION_FACTOR, 0, "dissipation_factor", "Dissipation factor", NULL}, | |
244 | {SR_MQ_QUALITY_FACTOR, 0, "quality_factor", "Quality factor", NULL}, | |
245 | {SR_MQ_PHASE_ANGLE, 0, "phase_angle", "Phase angle", NULL}, | |
246 | {SR_MQ_DIFFERENCE, 0, "difference", "Difference", NULL}, | |
247 | {SR_MQ_COUNT, 0, "count", "Count", NULL}, | |
248 | {SR_MQ_POWER_FACTOR, 0, "power_factor", "Power factor", NULL}, | |
249 | {SR_MQ_APPARENT_POWER, 0, "apparent_power", "Apparent power", NULL}, | |
250 | {SR_MQ_MASS, 0, "mass", "Mass", NULL}, | |
251 | {SR_MQ_HARMONIC_RATIO, 0, "harmonic_ratio", "Harmonic ratio", NULL}, | |
252 | ALL_ZERO | |
253 | }; | |
254 | ||
255 | /* Please use the same order as in enum sr_mqflag (libsigrok.h). */ | |
256 | static struct sr_key_info sr_key_info_mqflag[] = { | |
257 | {SR_MQFLAG_AC, 0, "ac", "AC", NULL}, | |
258 | {SR_MQFLAG_DC, 0, "dc", "DC", NULL}, | |
259 | {SR_MQFLAG_RMS, 0, "rms", "RMS", NULL}, | |
260 | {SR_MQFLAG_DIODE, 0, "diode", "Diode", NULL}, | |
261 | {SR_MQFLAG_HOLD, 0, "hold", "Hold", NULL}, | |
262 | {SR_MQFLAG_MAX, 0, "max", "Max", NULL}, | |
263 | {SR_MQFLAG_MIN, 0, "min", "Min", NULL}, | |
264 | {SR_MQFLAG_AUTORANGE, 0, "auto_range", "Auto range", NULL}, | |
265 | {SR_MQFLAG_RELATIVE, 0, "relative", "Relative", NULL}, | |
266 | {SR_MQFLAG_SPL_FREQ_WEIGHT_A, 0, "spl_freq_weight_a", | |
267 | "Frequency weighted (A)", NULL}, | |
268 | {SR_MQFLAG_SPL_FREQ_WEIGHT_C, 0, "spl_freq_weight_c", | |
269 | "Frequency weighted (C)", NULL}, | |
270 | {SR_MQFLAG_SPL_FREQ_WEIGHT_Z, 0, "spl_freq_weight_z", | |
271 | "Frequency weighted (Z)", NULL}, | |
272 | {SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT, 0, "spl_freq_weight_flat", | |
273 | "Frequency weighted (flat)", NULL}, | |
274 | {SR_MQFLAG_SPL_TIME_WEIGHT_S, 0, "spl_time_weight_s", | |
275 | "Time weighted (S)", NULL}, | |
276 | {SR_MQFLAG_SPL_TIME_WEIGHT_F, 0, "spl_time_weight_f", | |
277 | "Time weighted (F)", NULL}, | |
278 | {SR_MQFLAG_SPL_LAT, 0, "spl_time_average", "Time-averaged (LEQ)", NULL}, | |
279 | {SR_MQFLAG_SPL_PCT_OVER_ALARM, 0, "spl_pct_over_alarm", | |
280 | "Percentage over alarm", NULL}, | |
281 | {SR_MQFLAG_DURATION, 0, "duration", "Duration", NULL}, | |
282 | {SR_MQFLAG_AVG, 0, "average", "Average", NULL}, | |
283 | {SR_MQFLAG_REFERENCE, 0, "reference", "Reference", NULL}, | |
284 | {SR_MQFLAG_UNSTABLE, 0, "unstable", "Unstable", NULL}, | |
285 | {SR_MQFLAG_FOUR_WIRE, 0, "four_wire", "4-Wire", NULL}, | |
286 | ALL_ZERO | |
287 | }; | |
288 | ||
289 | /* This must handle all the keys from enum sr_datatype (libsigrok.h). */ | |
290 | /** @private */ | |
291 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) | |
292 | { | |
293 | switch (datatype) { | |
294 | case SR_T_INT32: | |
295 | return G_VARIANT_TYPE_INT32; | |
296 | case SR_T_UINT64: | |
297 | return G_VARIANT_TYPE_UINT64; | |
298 | case SR_T_STRING: | |
299 | return G_VARIANT_TYPE_STRING; | |
300 | case SR_T_BOOL: | |
301 | return G_VARIANT_TYPE_BOOLEAN; | |
302 | case SR_T_FLOAT: | |
303 | return G_VARIANT_TYPE_DOUBLE; | |
304 | case SR_T_RATIONAL_PERIOD: | |
305 | case SR_T_RATIONAL_VOLT: | |
306 | case SR_T_UINT64_RANGE: | |
307 | case SR_T_DOUBLE_RANGE: | |
308 | return G_VARIANT_TYPE_TUPLE; | |
309 | case SR_T_KEYVALUE: | |
310 | return G_VARIANT_TYPE_DICTIONARY; | |
311 | case SR_T_MQ: | |
312 | return G_VARIANT_TYPE_TUPLE; | |
313 | default: | |
314 | return NULL; | |
315 | } | |
316 | } | |
317 | ||
318 | /** @private */ | |
319 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) | |
320 | { | |
321 | const struct sr_key_info *info; | |
322 | const GVariantType *type, *expected; | |
323 | char *expected_string, *type_string; | |
324 | ||
325 | info = sr_key_info_get(SR_KEY_CONFIG, key); | |
326 | if (!info) | |
327 | return SR_OK; | |
328 | ||
329 | expected = sr_variant_type_get(info->datatype); | |
330 | type = g_variant_get_type(value); | |
331 | if (!g_variant_type_equal(type, expected) | |
332 | && !g_variant_type_is_subtype_of(type, expected)) { | |
333 | expected_string = g_variant_type_dup_string(expected); | |
334 | type_string = g_variant_type_dup_string(type); | |
335 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", | |
336 | info->name, expected_string, type_string); | |
337 | g_free(expected_string); | |
338 | g_free(type_string); | |
339 | return SR_ERR_ARG; | |
340 | } | |
341 | ||
342 | return SR_OK; | |
343 | } | |
344 | ||
345 | /** | |
346 | * Return the list of supported hardware drivers. | |
347 | * | |
348 | * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL. | |
349 | * | |
350 | * @retval NULL The ctx argument was NULL, or there are no supported drivers. | |
351 | * @retval Other Pointer to the NULL-terminated list of hardware drivers. | |
352 | * The user should NOT g_free() this list, sr_exit() will do that. | |
353 | * | |
354 | * @since 0.4.0 | |
355 | */ | |
356 | SR_API struct sr_dev_driver **sr_driver_list(const struct sr_context *ctx) | |
357 | { | |
358 | if (!ctx) | |
359 | return NULL; | |
360 | ||
361 | return ctx->driver_list; | |
362 | } | |
363 | ||
364 | /** | |
365 | * Initialize a hardware driver. | |
366 | * | |
367 | * This usually involves memory allocations and variable initializations | |
368 | * within the driver, but _not_ scanning for attached devices. | |
369 | * The API call sr_driver_scan() is used for that. | |
370 | * | |
371 | * @param ctx A libsigrok context object allocated by a previous call to | |
372 | * sr_init(). Must not be NULL. | |
373 | * @param driver The driver to initialize. This must be a pointer to one of | |
374 | * the entries returned by sr_driver_list(). Must not be NULL. | |
375 | * | |
376 | * @retval SR_OK Success | |
377 | * @retval SR_ERR_ARG Invalid parameter(s). | |
378 | * @retval SR_ERR_BUG Internal errors. | |
379 | * @retval other Another negative error code upon other errors. | |
380 | * | |
381 | * @since 0.2.0 | |
382 | */ | |
383 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) | |
384 | { | |
385 | int ret; | |
386 | ||
387 | if (!ctx) { | |
388 | sr_err("Invalid libsigrok context, can't initialize."); | |
389 | return SR_ERR_ARG; | |
390 | } | |
391 | ||
392 | if (!driver) { | |
393 | sr_err("Invalid driver, can't initialize."); | |
394 | return SR_ERR_ARG; | |
395 | } | |
396 | ||
397 | if ((ret = driver->init(driver, ctx)) < 0) | |
398 | sr_err("Failed to initialize the driver: %d.", ret); | |
399 | ||
400 | return ret; | |
401 | } | |
402 | ||
403 | /** | |
404 | * Enumerate scan options supported by this driver. | |
405 | * | |
406 | * Before calling sr_driver_scan_options_list(), the user must have previously | |
407 | * initialized the driver by calling sr_driver_init(). | |
408 | * | |
409 | * @param driver The driver to enumerate options for. This must be a pointer | |
410 | * to one of the entries returned by sr_driver_list(). Must not | |
411 | * be NULL. | |
412 | * | |
413 | * @return A GArray * of uint32_t entries, or NULL on invalid arguments. Each | |
414 | * entry is a configuration key that is supported as a scan option. | |
415 | * The array must be freed by the caller using g_array_free(). | |
416 | * | |
417 | * @since 0.4.0 | |
418 | */ | |
419 | SR_API GArray *sr_driver_scan_options_list(const struct sr_dev_driver *driver) | |
420 | { | |
421 | GVariant *gvar; | |
422 | const uint32_t *opts; | |
423 | gsize num_opts; | |
424 | GArray *result; | |
425 | ||
426 | if (sr_config_list(driver, NULL, NULL, SR_CONF_SCAN_OPTIONS, &gvar) != SR_OK) | |
427 | return NULL; | |
428 | ||
429 | opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t)); | |
430 | ||
431 | result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts); | |
432 | ||
433 | g_array_insert_vals(result, 0, opts, num_opts); | |
434 | ||
435 | g_variant_unref(gvar); | |
436 | ||
437 | return result; | |
438 | } | |
439 | ||
440 | static int check_options(struct sr_dev_driver *driver, GSList *options, | |
441 | uint32_t optlist_key, struct sr_dev_inst *sdi, | |
442 | struct sr_channel_group *cg) | |
443 | { | |
444 | struct sr_config *src; | |
445 | const struct sr_key_info *srci; | |
446 | GVariant *gvar_opts; | |
447 | GSList *l; | |
448 | const uint32_t *opts; | |
449 | gsize num_opts, i; | |
450 | int ret; | |
451 | ||
452 | if (sr_config_list(driver, sdi, cg, optlist_key, &gvar_opts) != SR_OK) { | |
453 | /* Driver publishes no options for this optlist. */ | |
454 | return SR_ERR; | |
455 | } | |
456 | ||
457 | ret = SR_OK; | |
458 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
459 | for (l = options; l; l = l->next) { | |
460 | src = l->data; | |
461 | for (i = 0; i < num_opts; i++) { | |
462 | if (opts[i] == src->key) | |
463 | break; | |
464 | } | |
465 | if (i == num_opts) { | |
466 | if (!(srci = sr_key_info_get(SR_KEY_CONFIG, src->key))) | |
467 | /* Shouldn't happen. */ | |
468 | sr_err("Invalid option %d.", src->key); | |
469 | else | |
470 | sr_err("Invalid option '%s'.", srci->id); | |
471 | ret = SR_ERR_ARG; | |
472 | break; | |
473 | } | |
474 | if (sr_variant_type_check(src->key, src->data) != SR_OK) { | |
475 | ret = SR_ERR_ARG; | |
476 | break; | |
477 | } | |
478 | } | |
479 | g_variant_unref(gvar_opts); | |
480 | ||
481 | return ret; | |
482 | } | |
483 | ||
484 | /** | |
485 | * Tell a hardware driver to scan for devices. | |
486 | * | |
487 | * In addition to the detection, the devices that are found are also | |
488 | * initialized automatically. On some devices, this involves a firmware upload, | |
489 | * or other such measures. | |
490 | * | |
491 | * The order in which the system is scanned for devices is not specified. The | |
492 | * caller should not assume or rely on any specific order. | |
493 | * | |
494 | * Before calling sr_driver_scan(), the user must have previously initialized | |
495 | * the driver by calling sr_driver_init(). | |
496 | * | |
497 | * @param driver The driver that should scan. This must be a pointer to one of | |
498 | * the entries returned by sr_driver_list(). Must not be NULL. | |
499 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
500 | * scanner. Can be NULL/empty. | |
501 | * | |
502 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
503 | * found (or errors were encountered). This list must be freed by the | |
504 | * caller using g_slist_free(), but without freeing the data pointed | |
505 | * to in the list. | |
506 | * | |
507 | * @since 0.2.0 | |
508 | */ | |
509 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
510 | { | |
511 | GSList *l; | |
512 | ||
513 | if (!driver) { | |
514 | sr_err("Invalid driver, can't scan for devices."); | |
515 | return NULL; | |
516 | } | |
517 | ||
518 | if (!driver->context) { | |
519 | sr_err("Driver not initialized, can't scan for devices."); | |
520 | return NULL; | |
521 | } | |
522 | ||
523 | if (options) { | |
524 | if (check_options(driver, options, SR_CONF_SCAN_OPTIONS, NULL, NULL) != SR_OK) | |
525 | return NULL; | |
526 | } | |
527 | ||
528 | l = driver->scan(driver, options); | |
529 | ||
530 | sr_spew("Scan of '%s' found %d devices.", driver->name, | |
531 | g_slist_length(l)); | |
532 | ||
533 | return l; | |
534 | } | |
535 | ||
536 | /** | |
537 | * Call driver cleanup function for all drivers. | |
538 | * | |
539 | * @param[in] ctx Pointer to a libsigrok context struct. Must not be NULL. | |
540 | * | |
541 | * @private | |
542 | */ | |
543 | SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx) | |
544 | { | |
545 | int i; | |
546 | struct sr_dev_driver **drivers; | |
547 | ||
548 | if (!ctx) | |
549 | return; | |
550 | ||
551 | drivers = sr_driver_list(ctx); | |
552 | for (i = 0; drivers[i]; i++) { | |
553 | if (drivers[i]->cleanup) | |
554 | drivers[i]->cleanup(drivers[i]); | |
555 | drivers[i]->context = NULL; | |
556 | } | |
557 | } | |
558 | ||
559 | /** | |
560 | * Allocate struct sr_config. | |
561 | * | |
562 | * A floating reference can be passed in for data. | |
563 | * | |
564 | * @private | |
565 | */ | |
566 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) | |
567 | { | |
568 | struct sr_config *src; | |
569 | ||
570 | src = g_malloc0(sizeof(struct sr_config)); | |
571 | src->key = key; | |
572 | src->data = g_variant_ref_sink(data); | |
573 | ||
574 | return src; | |
575 | } | |
576 | ||
577 | /** | |
578 | * Free struct sr_config. | |
579 | * | |
580 | * @private | |
581 | */ | |
582 | SR_PRIV void sr_config_free(struct sr_config *src) | |
583 | { | |
584 | ||
585 | if (!src || !src->data) { | |
586 | sr_err("%s: invalid data!", __func__); | |
587 | return; | |
588 | } | |
589 | ||
590 | g_variant_unref(src->data); | |
591 | g_free(src); | |
592 | ||
593 | } | |
594 | ||
595 | static void log_key(const struct sr_dev_inst *sdi, | |
596 | const struct sr_channel_group *cg, uint32_t key, int op, GVariant *data) | |
597 | { | |
598 | const char *opstr; | |
599 | const struct sr_key_info *srci; | |
600 | gchar *tmp_str; | |
601 | ||
602 | /* Don't log SR_CONF_DEVICE_OPTIONS, it's verbose and not too useful. */ | |
603 | if (key == SR_CONF_DEVICE_OPTIONS) | |
604 | return; | |
605 | ||
606 | opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list"; | |
607 | srci = sr_key_info_get(SR_KEY_CONFIG, key); | |
608 | ||
609 | tmp_str = g_variant_print(data, TRUE); | |
610 | sr_spew("sr_config_%s(): key %d (%s) sdi %p cg %s -> %s", opstr, key, | |
611 | srci ? srci->id : "NULL", sdi, cg ? cg->name : "NULL", | |
612 | data ? tmp_str : "NULL"); | |
613 | g_free(tmp_str); | |
614 | } | |
615 | ||
616 | static int check_key(const struct sr_dev_driver *driver, | |
617 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, | |
618 | uint32_t key, int op, GVariant *data) | |
619 | { | |
620 | const struct sr_key_info *srci; | |
621 | gsize num_opts, i; | |
622 | GVariant *gvar_opts; | |
623 | const uint32_t *opts; | |
624 | uint32_t pub_opt; | |
625 | const char *suffix; | |
626 | const char *opstr; | |
627 | ||
628 | if (sdi && cg) | |
629 | suffix = " for this device and channel group"; | |
630 | else if (sdi) | |
631 | suffix = " for this device"; | |
632 | else | |
633 | suffix = ""; | |
634 | ||
635 | if (!(srci = sr_key_info_get(SR_KEY_CONFIG, key))) { | |
636 | sr_err("Invalid key %d.", key); | |
637 | return SR_ERR_ARG; | |
638 | } | |
639 | opstr = op == SR_CONF_GET ? "get" : op == SR_CONF_SET ? "set" : "list"; | |
640 | ||
641 | switch (key) { | |
642 | case SR_CONF_LIMIT_MSEC: | |
643 | case SR_CONF_LIMIT_SAMPLES: | |
644 | case SR_CONF_SAMPLERATE: | |
645 | /* Setting any of these to 0 is not useful. */ | |
646 | if (op != SR_CONF_SET || !data) | |
647 | break; | |
648 | if (g_variant_get_uint64(data) == 0) { | |
649 | sr_err("Cannot set '%s' to 0.", srci->id); | |
650 | return SR_ERR_ARG; | |
651 | } | |
652 | break; | |
653 | } | |
654 | ||
655 | if (sr_config_list(driver, sdi, cg, SR_CONF_DEVICE_OPTIONS, &gvar_opts) != SR_OK) { | |
656 | /* Driver publishes no options. */ | |
657 | sr_err("No options available%s.", suffix); | |
658 | return SR_ERR_ARG; | |
659 | } | |
660 | opts = g_variant_get_fixed_array(gvar_opts, &num_opts, sizeof(uint32_t)); | |
661 | pub_opt = 0; | |
662 | for (i = 0; i < num_opts; i++) { | |
663 | if ((opts[i] & SR_CONF_MASK) == key) { | |
664 | pub_opt = opts[i]; | |
665 | break; | |
666 | } | |
667 | } | |
668 | g_variant_unref(gvar_opts); | |
669 | if (!pub_opt) { | |
670 | sr_err("Option '%s' not available%s.", srci->id, suffix); | |
671 | return SR_ERR_ARG; | |
672 | } | |
673 | ||
674 | if (!(pub_opt & op)) { | |
675 | sr_err("Option '%s' not available to %s%s.", srci->id, opstr, suffix); | |
676 | return SR_ERR_ARG; | |
677 | } | |
678 | ||
679 | return SR_OK; | |
680 | } | |
681 | ||
682 | /** | |
683 | * Query value of a configuration key at the given driver or device instance. | |
684 | * | |
685 | * @param[in] driver The sr_dev_driver struct to query. Must not be NULL. | |
686 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
687 | * contain a pointer to the struct sr_dev_inst to be checked. | |
688 | * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must | |
689 | * also be != NULL. | |
690 | * @param[in] cg The channel group on the device for which to list the | |
691 | * values, or NULL. | |
692 | * @param[in] key The configuration key (SR_CONF_*). | |
693 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
694 | * Must not be NULL. The caller is given ownership of the GVariant | |
695 | * and must thus decrease the refcount after use. However if | |
696 | * this function returns an error code, the field should be | |
697 | * considered unused, and should not be unreferenced. | |
698 | * | |
699 | * @retval SR_OK Success. | |
700 | * @retval SR_ERR Error. | |
701 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
702 | * interpreted as an error by the caller; merely as an indication | |
703 | * that it's not applicable. | |
704 | * | |
705 | * @since 0.3.0 | |
706 | */ | |
707 | SR_API int sr_config_get(const struct sr_dev_driver *driver, | |
708 | const struct sr_dev_inst *sdi, | |
709 | const struct sr_channel_group *cg, | |
710 | uint32_t key, GVariant **data) | |
711 | { | |
712 | int ret; | |
713 | ||
714 | if (!driver || !data) | |
715 | return SR_ERR; | |
716 | ||
717 | if (!driver->config_get) | |
718 | return SR_ERR_ARG; | |
719 | ||
720 | if (check_key(driver, sdi, cg, key, SR_CONF_GET, NULL) != SR_OK) | |
721 | return SR_ERR_ARG; | |
722 | ||
723 | if (sdi && !sdi->priv) { | |
724 | sr_err("Can't get config (sdi != NULL, sdi->priv == NULL)."); | |
725 | return SR_ERR; | |
726 | } | |
727 | ||
728 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { | |
729 | log_key(sdi, cg, key, SR_CONF_GET, *data); | |
730 | /* Got a floating reference from the driver. Sink it here, | |
731 | * caller will need to unref when done with it. */ | |
732 | g_variant_ref_sink(*data); | |
733 | } | |
734 | ||
735 | return ret; | |
736 | } | |
737 | ||
738 | /** | |
739 | * Set value of a configuration key in a device instance. | |
740 | * | |
741 | * @param[in] sdi The device instance. Must not be NULL. sdi->driver and | |
742 | * sdi->priv must not be NULL either. | |
743 | * @param[in] cg The channel group on the device for which to list the | |
744 | * values, or NULL. | |
745 | * @param[in] key The configuration key (SR_CONF_*). | |
746 | * @param data The new value for the key, as a GVariant with GVariantType | |
747 | * appropriate to that key. A floating reference can be passed | |
748 | * in; its refcount will be sunk and unreferenced after use. | |
749 | * | |
750 | * @retval SR_OK Success. | |
751 | * @retval SR_ERR Error. | |
752 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
753 | * interpreted as an error by the caller; merely as an indication | |
754 | * that it's not applicable. | |
755 | * | |
756 | * @since 0.3.0 | |
757 | */ | |
758 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, | |
759 | const struct sr_channel_group *cg, | |
760 | uint32_t key, GVariant *data) | |
761 | { | |
762 | int ret; | |
763 | ||
764 | g_variant_ref_sink(data); | |
765 | ||
766 | if (!sdi || !sdi->driver || !sdi->priv || !data) | |
767 | ret = SR_ERR; | |
768 | else if (!sdi->driver->config_set) | |
769 | ret = SR_ERR_ARG; | |
770 | else if (check_key(sdi->driver, sdi, cg, key, SR_CONF_SET, data) != SR_OK) | |
771 | return SR_ERR_ARG; | |
772 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) { | |
773 | log_key(sdi, cg, key, SR_CONF_SET, data); | |
774 | ret = sdi->driver->config_set(key, data, sdi, cg); | |
775 | } | |
776 | ||
777 | g_variant_unref(data); | |
778 | ||
779 | return ret; | |
780 | } | |
781 | ||
782 | /** | |
783 | * Apply configuration settings to the device hardware. | |
784 | * | |
785 | * @param sdi The device instance. | |
786 | * | |
787 | * @return SR_OK upon success or SR_ERR in case of error. | |
788 | * | |
789 | * @since 0.3.0 | |
790 | */ | |
791 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
792 | { | |
793 | int ret; | |
794 | ||
795 | if (!sdi || !sdi->driver) | |
796 | ret = SR_ERR; | |
797 | else if (!sdi->driver->config_commit) | |
798 | ret = SR_OK; | |
799 | else | |
800 | ret = sdi->driver->config_commit(sdi); | |
801 | ||
802 | return ret; | |
803 | } | |
804 | ||
805 | /** | |
806 | * List all possible values for a configuration key. | |
807 | * | |
808 | * @param[in] driver The sr_dev_driver struct to query. Must not be NULL. | |
809 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
810 | * contain a pointer to the struct sr_dev_inst to be checked. | |
811 | * Otherwise it must be NULL. If sdi is != NULL, sdi->priv must | |
812 | * also be != NULL. | |
813 | * @param[in] cg The channel group on the device for which to list the | |
814 | * values, or NULL. | |
815 | * @param[in] key The configuration key (SR_CONF_*). | |
816 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
817 | * The caller is given ownership of the GVariant and must thus | |
818 | * unref the GVariant after use. However if this function | |
819 | * returns an error code, the field should be considered | |
820 | * unused, and should not be unreferenced. | |
821 | * | |
822 | * @retval SR_OK Success. | |
823 | * @retval SR_ERR Error. | |
824 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
825 | * interpreted as an error by the caller; merely as an indication | |
826 | * that it's not applicable. | |
827 | * | |
828 | * @since 0.3.0 | |
829 | */ | |
830 | SR_API int sr_config_list(const struct sr_dev_driver *driver, | |
831 | const struct sr_dev_inst *sdi, | |
832 | const struct sr_channel_group *cg, | |
833 | uint32_t key, GVariant **data) | |
834 | { | |
835 | int ret; | |
836 | ||
837 | if (!driver || !data) | |
838 | return SR_ERR; | |
839 | else if (!driver->config_list) | |
840 | return SR_ERR_ARG; | |
841 | else if (key != SR_CONF_SCAN_OPTIONS && key != SR_CONF_DEVICE_OPTIONS) { | |
842 | if (check_key(driver, sdi, cg, key, SR_CONF_LIST, NULL) != SR_OK) | |
843 | return SR_ERR_ARG; | |
844 | } | |
845 | if (sdi && !sdi->priv) { | |
846 | sr_err("Can't list config (sdi != NULL, sdi->priv == NULL)."); | |
847 | return SR_ERR; | |
848 | } | |
849 | if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) { | |
850 | log_key(sdi, cg, key, SR_CONF_LIST, *data); | |
851 | g_variant_ref_sink(*data); | |
852 | } | |
853 | ||
854 | return ret; | |
855 | } | |
856 | ||
857 | static struct sr_key_info *get_keytable(int keytype) | |
858 | { | |
859 | struct sr_key_info *table; | |
860 | ||
861 | switch (keytype) { | |
862 | case SR_KEY_CONFIG: | |
863 | table = sr_key_info_config; | |
864 | break; | |
865 | case SR_KEY_MQ: | |
866 | table = sr_key_info_mq; | |
867 | break; | |
868 | case SR_KEY_MQFLAGS: | |
869 | table = sr_key_info_mqflag; | |
870 | break; | |
871 | default: | |
872 | sr_err("Invalid keytype %d", keytype); | |
873 | return NULL; | |
874 | } | |
875 | ||
876 | return table; | |
877 | } | |
878 | ||
879 | /** | |
880 | * Get information about a key, by key. | |
881 | * | |
882 | * @param[in] keytype The namespace the key is in. | |
883 | * @param[in] key The key to find. | |
884 | * | |
885 | * @return A pointer to a struct sr_key_info, or NULL if the key | |
886 | * was not found. | |
887 | * | |
888 | * @since 0.3.0 | |
889 | */ | |
890 | SR_API const struct sr_key_info *sr_key_info_get(int keytype, uint32_t key) | |
891 | { | |
892 | struct sr_key_info *table; | |
893 | int i; | |
894 | ||
895 | if (!(table = get_keytable(keytype))) | |
896 | return NULL; | |
897 | ||
898 | for (i = 0; table[i].key; i++) { | |
899 | if (table[i].key == key) | |
900 | return &table[i]; | |
901 | } | |
902 | ||
903 | return NULL; | |
904 | } | |
905 | ||
906 | /** | |
907 | * Get information about a key, by name. | |
908 | * | |
909 | * @param[in] keytype The namespace the key is in. | |
910 | * @param[in] keyid The key id string. | |
911 | * | |
912 | * @return A pointer to a struct sr_key_info, or NULL if the key | |
913 | * was not found. | |
914 | * | |
915 | * @since 0.2.0 | |
916 | */ | |
917 | SR_API const struct sr_key_info *sr_key_info_name_get(int keytype, const char *keyid) | |
918 | { | |
919 | struct sr_key_info *table; | |
920 | int i; | |
921 | ||
922 | if (!(table = get_keytable(keytype))) | |
923 | return NULL; | |
924 | ||
925 | for (i = 0; table[i].key; i++) { | |
926 | if (!table[i].id) | |
927 | continue; | |
928 | if (!strcmp(table[i].id, keyid)) | |
929 | return &table[i]; | |
930 | } | |
931 | ||
932 | return NULL; | |
933 | } | |
934 | ||
935 | /** @} */ |