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