]>
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 | ||
a5827886 UH |
20 | #ifndef LIBSIGROK_LIBSIGROK_H |
21 | #define LIBSIGROK_LIBSIGROK_H | |
a1bb33af UH |
22 | |
23 | #include <stdio.h> | |
24 | #include <sys/time.h> | |
25 | #include <stdint.h> | |
26 | #include <inttypes.h> | |
27 | #include <glib.h> | |
a1bb33af | 28 | |
a00b530c UH |
29 | #ifdef __cplusplus |
30 | extern "C" { | |
31 | #endif | |
32 | ||
393fb9cb UH |
33 | /** |
34 | * @file | |
35 | * | |
36 | * The public libsigrok header file to be used by frontends. | |
1f345a21 UH |
37 | * |
38 | * This is the only file that libsigrok users (frontends) are supposed to | |
ca0938c5 | 39 | * use and \#include. There are other header files which get installed with |
1f345a21 UH |
40 | * libsigrok, but those are not meant to be used directly by frontends. |
41 | * | |
42 | * The correct way to get/use the libsigrok API functions is: | |
43 | * | |
47117241 UH |
44 | * @code{.c} |
45 | * #include <libsigrok/libsigrok.h> | |
46 | * @endcode | |
393fb9cb UH |
47 | */ |
48 | ||
e31b636d | 49 | /* |
e31b636d UH |
50 | * All possible return codes of libsigrok functions must be listed here. |
51 | * Functions should never return hardcoded numbers as status, but rather | |
3c0839d5 | 52 | * use these enum values. All error codes are negative numbers. |
e31b636d UH |
53 | * |
54 | * The error codes are globally unique in libsigrok, i.e. if one of the | |
2b3414a4 UH |
55 | * libsigrok functions returns a "malloc error" it must be exactly the same |
56 | * return value as used by all other functions to indicate "malloc error". | |
e31b636d UH |
57 | * There must be no functions which indicate two different errors via the |
58 | * same return code. | |
59 | * | |
60 | * Also, for compatibility reasons, no defined return codes are ever removed | |
3c0839d5 | 61 | * or reused for different errors later. You can only add new entries and |
e31b636d UH |
62 | * return codes, but never remove or redefine existing ones. |
63 | */ | |
3c0839d5 UH |
64 | |
65 | /** Status/error codes returned by libsigrok functions. */ | |
76857945 | 66 | enum sr_error_code { |
3e2cd211 | 67 | SR_OK_CONTINUE = 1, /**< Keep going. */ |
a68bf88e UH |
68 | SR_OK = 0, /**< No error. */ |
69 | SR_ERR = -1, /**< Generic/unspecified error. */ | |
70 | SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */ | |
71 | SR_ERR_ARG = -3, /**< Function argument error. */ | |
72 | SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */ | |
73 | SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */ | |
74 | SR_ERR_NA = -6, /**< Not applicable. */ | |
75 | SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but must be open. */ | |
76 | SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */ | |
77 | SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */ | |
b7f44605 | 78 | SR_ERR_DATA =-10, /**< Data is invalid. */ |
3c558259 | 79 | SR_ERR_IO =-11, /**< Input/output error. */ |
409a811b UH |
80 | |
81 | /* | |
82 | * Note: When adding entries here, don't forget to also update the | |
83 | * sr_strerror() and sr_strerror_name() functions in error.c. | |
84 | */ | |
3c0839d5 | 85 | }; |
a1bb33af | 86 | |
3f239f08 | 87 | #define SR_MAX_CHANNELNAME_LEN 32 |
2a3f9541 | 88 | |
a1bb33af | 89 | /* Handy little macros */ |
c9140419 | 90 | #define SR_HZ(n) (n) |
0b4b41ee UH |
91 | #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL)) |
92 | #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL)) | |
93 | #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL)) | |
a1bb33af | 94 | |
0b4b41ee | 95 | #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n)) |
3677f3ec | 96 | |
3c0839d5 | 97 | /** libsigrok loglevels. */ |
e958f921 | 98 | enum sr_loglevel { |
3c0839d5 UH |
99 | SR_LOG_NONE = 0, /**< Output no messages at all. */ |
100 | SR_LOG_ERR = 1, /**< Output error messages. */ | |
101 | SR_LOG_WARN = 2, /**< Output warnings. */ | |
102 | SR_LOG_INFO = 3, /**< Output informational messages. */ | |
103 | SR_LOG_DBG = 4, /**< Output debug messages. */ | |
104 | SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */ | |
105 | }; | |
1352eedd | 106 | |
1a081ca6 UH |
107 | /* |
108 | * Use SR_API to mark public API symbols, and SR_PRIV for private symbols. | |
109 | * | |
110 | * Variables and functions marked 'static' are private already and don't | |
111 | * need SR_PRIV. However, functions which are not static (because they need | |
112 | * to be used in other libsigrok-internal files) but are also not meant to | |
113 | * be part of the public libsigrok API, must use SR_PRIV. | |
114 | * | |
115 | * This uses the 'visibility' feature of gcc (requires gcc >= 4.0). | |
116 | * | |
69e70c23 UH |
117 | * This feature is not available on MinGW/Windows, as it is a feature of |
118 | * ELF files and MinGW/Windows uses PE files. | |
119 | * | |
1a081ca6 UH |
120 | * Details: http://gcc.gnu.org/wiki/Visibility |
121 | */ | |
122 | ||
123 | /* Marks public libsigrok API symbols. */ | |
69e70c23 | 124 | #ifndef _WIN32 |
1a081ca6 | 125 | #define SR_API __attribute__((visibility("default"))) |
69e70c23 UH |
126 | #else |
127 | #define SR_API | |
128 | #endif | |
1a081ca6 UH |
129 | |
130 | /* Marks private, non-public libsigrok symbols (not part of the API). */ | |
69e70c23 | 131 | #ifndef _WIN32 |
1a081ca6 | 132 | #define SR_PRIV __attribute__((visibility("hidden"))) |
69e70c23 UH |
133 | #else |
134 | #define SR_PRIV | |
135 | #endif | |
1a081ca6 | 136 | |
04cb9157 | 137 | /** Type definition for callback function for data reception. */ |
144f6660 | 138 | typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data); |
882e2075 | 139 | |
08a9260b | 140 | /** Data types used by sr_config_info(). */ |
e958f921 | 141 | enum sr_datatype { |
24d04d1e | 142 | SR_T_UINT64 = 10000, |
ace218f9 | 143 | SR_T_STRING, |
4d436e71 | 144 | SR_T_BOOL, |
0fe11789 | 145 | SR_T_FLOAT, |
c1e48618 | 146 | SR_T_RATIONAL_PERIOD, |
bd8db307 | 147 | SR_T_RATIONAL_VOLT, |
45edd0b2 | 148 | SR_T_KEYVALUE, |
8417ebad | 149 | SR_T_UINT64_RANGE, |
db11d7d2 | 150 | SR_T_DOUBLE_RANGE, |
bf90d4c6 | 151 | SR_T_INT32, |
0fe11789 BV |
152 | }; |
153 | ||
3c0839d5 | 154 | /** Value for sr_datafeed_packet.type. */ |
e958f921 | 155 | enum sr_packettype { |
98582bf5 BV |
156 | /** Payload is sr_datafeed_header. */ |
157 | SR_DF_HEADER = 10000, | |
158 | /** End of stream (no further data). */ | |
159 | SR_DF_END, | |
160 | /** Payload is struct sr_datafeed_meta */ | |
161 | SR_DF_META, | |
162 | /** The trigger matched at this point in the data feed. No payload. */ | |
163 | SR_DF_TRIGGER, | |
164 | /** Payload is struct sr_datafeed_logic. */ | |
165 | SR_DF_LOGIC, | |
166 | /** Payload is struct sr_datafeed_analog. */ | |
167 | SR_DF_ANALOG, | |
168 | /** Beginning of frame. No payload. */ | |
169 | SR_DF_FRAME_BEGIN, | |
170 | /** End of frame. No payload. */ | |
171 | SR_DF_FRAME_END, | |
d2e0f585 BV |
172 | /** Payload is struct sr_datafeed_analog2. */ |
173 | SR_DF_ANALOG2, | |
a1bb33af UH |
174 | }; |
175 | ||
04cb9157 | 176 | /** Measured quantity, sr_datafeed_analog.mq. */ |
e958f921 | 177 | enum sr_mq { |
24d04d1e | 178 | SR_MQ_VOLTAGE = 10000, |
9956f285 UH |
179 | SR_MQ_CURRENT, |
180 | SR_MQ_RESISTANCE, | |
181 | SR_MQ_CAPACITANCE, | |
182 | SR_MQ_TEMPERATURE, | |
183 | SR_MQ_FREQUENCY, | |
98582bf5 BV |
184 | /** Duty cycle, e.g. on/off ratio. */ |
185 | SR_MQ_DUTY_CYCLE, | |
186 | /** Continuity test. */ | |
187 | SR_MQ_CONTINUITY, | |
aa839a5c | 188 | SR_MQ_PULSE_WIDTH, |
96b3b3d5 | 189 | SR_MQ_CONDUCTANCE, |
98582bf5 BV |
190 | /** Electrical power, usually in W, or dBm. */ |
191 | SR_MQ_POWER, | |
192 | /** Gain (a transistor's gain, or hFE, for example). */ | |
193 | SR_MQ_GAIN, | |
fc19c288 BV |
194 | /** Logarithmic representation of sound pressure relative to a |
195 | * reference value. */ | |
196 | SR_MQ_SOUND_PRESSURE_LEVEL, | |
98582bf5 BV |
197 | /** Carbon monoxide level */ |
198 | SR_MQ_CARBON_MONOXIDE, | |
199 | /** Humidity */ | |
200 | SR_MQ_RELATIVE_HUMIDITY, | |
201 | /** Time */ | |
202 | SR_MQ_TIME, | |
31801362 BV |
203 | /** Wind speed */ |
204 | SR_MQ_WIND_SPEED, | |
205 | /** Pressure */ | |
206 | SR_MQ_PRESSURE, | |
87d81245 JH |
207 | /** Parallel inductance (LCR meter model). */ |
208 | SR_MQ_PARALLEL_INDUCTANCE, | |
209 | /** Parallel capacitance (LCR meter model). */ | |
210 | SR_MQ_PARALLEL_CAPACITANCE, | |
211 | /** Parallel resistance (LCR meter model). */ | |
212 | SR_MQ_PARALLEL_RESISTANCE, | |
c7c8994c JH |
213 | /** Series inductance (LCR meter model). */ |
214 | SR_MQ_SERIES_INDUCTANCE, | |
215 | /** Series capacitance (LCR meter model). */ | |
216 | SR_MQ_SERIES_CAPACITANCE, | |
217 | /** Series resistance (LCR meter model). */ | |
218 | SR_MQ_SERIES_RESISTANCE, | |
87d81245 JH |
219 | /** Dissipation factor. */ |
220 | SR_MQ_DISSIPATION_FACTOR, | |
221 | /** Quality factor. */ | |
222 | SR_MQ_QUALITY_FACTOR, | |
223 | /** Phase angle. */ | |
224 | SR_MQ_PHASE_ANGLE, | |
23601f2c JH |
225 | /** Difference from reference value. */ |
226 | SR_MQ_DIFFERENCE, | |
b9c10ae1 ML |
227 | /** Count. */ |
228 | SR_MQ_COUNT, | |
ded3e508 UH |
229 | /** Power factor. */ |
230 | SR_MQ_POWER_FACTOR, | |
231 | /** Apparent power */ | |
232 | SR_MQ_APPARENT_POWER, | |
9956f285 UH |
233 | }; |
234 | ||
04cb9157 | 235 | /** Unit of measured quantity, sr_datafeed_analog.unit. */ |
e958f921 | 236 | enum sr_unit { |
98582bf5 BV |
237 | /** Volt */ |
238 | SR_UNIT_VOLT = 10000, | |
239 | /** Ampere (current). */ | |
240 | SR_UNIT_AMPERE, | |
241 | /** Ohm (resistance). */ | |
242 | SR_UNIT_OHM, | |
243 | /** Farad (capacity). */ | |
244 | SR_UNIT_FARAD, | |
245 | /** Kelvin (temperature). */ | |
246 | SR_UNIT_KELVIN, | |
247 | /** Degrees Celsius (temperature). */ | |
248 | SR_UNIT_CELSIUS, | |
249 | /** Degrees Fahrenheit (temperature). */ | |
250 | SR_UNIT_FAHRENHEIT, | |
251 | /** Hertz (frequency, 1/s, [Hz]). */ | |
252 | SR_UNIT_HERTZ, | |
253 | /** Percent value. */ | |
254 | SR_UNIT_PERCENTAGE, | |
255 | /** Boolean value. */ | |
256 | SR_UNIT_BOOLEAN, | |
257 | /** Time in seconds. */ | |
258 | SR_UNIT_SECOND, | |
259 | /** Unit of conductance, the inverse of resistance. */ | |
260 | SR_UNIT_SIEMENS, | |
3c0839d5 UH |
261 | /** |
262 | * An absolute measurement of power, in decibels, referenced to | |
263 | * 1 milliwatt (dBu). | |
264 | */ | |
b82a17d3 | 265 | SR_UNIT_DECIBEL_MW, |
6b869234 BV |
266 | /** Voltage in decibel, referenced to 1 volt (dBV). */ |
267 | SR_UNIT_DECIBEL_VOLT, | |
3c0839d5 UH |
268 | /** |
269 | * Measurements that intrinsically do not have units attached, such | |
6b869234 | 270 | * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is |
3c0839d5 UH |
271 | * a unitless quantity, for example. |
272 | */ | |
b82a17d3 | 273 | SR_UNIT_UNITLESS, |
d0a92abd | 274 | /** Sound pressure level, in decibels, relative to 20 micropascals. */ |
fc19c288 | 275 | SR_UNIT_DECIBEL_SPL, |
801c7800 AG |
276 | /** |
277 | * Normalized (0 to 1) concentration of a substance or compound with 0 | |
278 | * representing a concentration of 0%, and 1 being 100%. This is | |
279 | * represented as the fraction of number of particles of the substance. | |
280 | */ | |
4f3bd685 | 281 | SR_UNIT_CONCENTRATION, |
98582bf5 BV |
282 | /** Revolutions per minute. */ |
283 | SR_UNIT_REVOLUTIONS_PER_MINUTE, | |
284 | /** Apparent power [VA]. */ | |
285 | SR_UNIT_VOLT_AMPERE, | |
286 | /** Real power [W]. */ | |
287 | SR_UNIT_WATT, | |
288 | /** Consumption [Wh]. */ | |
289 | SR_UNIT_WATT_HOUR, | |
31801362 BV |
290 | /** Wind speed in meters per second. */ |
291 | SR_UNIT_METER_SECOND, | |
292 | /** Pressure in hectopascal */ | |
293 | SR_UNIT_HECTOPASCAL, | |
f3f19d11 | 294 | /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */ |
31801362 | 295 | SR_UNIT_HUMIDITY_293K, |
01789adc JH |
296 | /** Plane angle in 1/360th of a full circle. */ |
297 | SR_UNIT_DEGREE, | |
298 | /** Henry (inductance). */ | |
299 | SR_UNIT_HENRY, | |
aff5a729 BV |
300 | }; |
301 | ||
3c0839d5 | 302 | /** Values for sr_datafeed_analog.flags. */ |
e958f921 | 303 | enum sr_mqflag { |
3c0839d5 | 304 | /** Voltage measurement is alternating current (AC). */ |
02e864d0 | 305 | SR_MQFLAG_AC = 0x01, |
3c0839d5 | 306 | /** Voltage measurement is direct current (DC). */ |
02e864d0 BV |
307 | SR_MQFLAG_DC = 0x02, |
308 | /** This is a true RMS measurement. */ | |
309 | SR_MQFLAG_RMS = 0x04, | |
310 | /** Value is voltage drop across a diode, or NAN. */ | |
311 | SR_MQFLAG_DIODE = 0x08, | |
a02d77bc | 312 | /** Device is in "hold" mode (repeating the last measurement). */ |
02e864d0 | 313 | SR_MQFLAG_HOLD = 0x10, |
3c0839d5 | 314 | /** Device is in "max" mode, only updating upon a new max value. */ |
02e864d0 | 315 | SR_MQFLAG_MAX = 0x20, |
3c0839d5 | 316 | /** Device is in "min" mode, only updating upon a new min value. */ |
02e864d0 BV |
317 | SR_MQFLAG_MIN = 0x40, |
318 | /** Device is in autoranging mode. */ | |
319 | SR_MQFLAG_AUTORANGE = 0x80, | |
320 | /** Device is in relative mode. */ | |
321 | SR_MQFLAG_RELATIVE = 0x100, | |
fc19c288 | 322 | /** Sound pressure level is A-weighted in the frequency domain, |
2244356d | 323 | * according to IEC 61672:2003. */ |
fc19c288 BV |
324 | SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, |
325 | /** Sound pressure level is C-weighted in the frequency domain, | |
2244356d | 326 | * according to IEC 61672:2003. */ |
fc19c288 BV |
327 | SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400, |
328 | /** Sound pressure level is Z-weighted (i.e. not at all) in the | |
2244356d | 329 | * frequency domain, according to IEC 61672:2003. */ |
fc19c288 BV |
330 | SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800, |
331 | /** Sound pressure level is not weighted in the frequency domain, | |
332 | * albeit without standards-defined low and high frequency limits. */ | |
333 | SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000, | |
334 | /** Sound pressure level measurement is S-weighted (1s) in the | |
335 | * time domain. */ | |
336 | SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000, | |
337 | /** Sound pressure level measurement is F-weighted (125ms) in the | |
338 | * time domain. */ | |
339 | SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000, | |
340 | /** Sound pressure level is time-averaged (LAT), also known as | |
341 | * Equivalent Continuous A-weighted Sound Level (LEQ). */ | |
342 | SR_MQFLAG_SPL_LAT = 0x8000, | |
343 | /** Sound pressure level represented as a percentage of measurements | |
344 | * that were over a preset alarm level. */ | |
345 | SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, | |
367983a7 MH |
346 | /** Time is duration (as opposed to epoch, ...). */ |
347 | SR_MQFLAG_DURATION = 0x20000, | |
f5027ca4 AJ |
348 | /** Device is in "avg" mode, averaging upon each new value. */ |
349 | SR_MQFLAG_AVG = 0x40000, | |
23601f2c JH |
350 | /** Reference value shown. */ |
351 | SR_MQFLAG_REFERENCE = 0x80000, | |
02e864d0 BV |
352 | }; |
353 | ||
7b5e6d29 BV |
354 | enum sr_trigger_matches { |
355 | SR_TRIGGER_ZERO = 1, | |
356 | SR_TRIGGER_ONE, | |
357 | SR_TRIGGER_RISING, | |
358 | SR_TRIGGER_FALLING, | |
359 | SR_TRIGGER_EDGE, | |
360 | SR_TRIGGER_OVER, | |
361 | SR_TRIGGER_UNDER, | |
362 | }; | |
363 | ||
364 | /** The representation of a trigger, consisting of one or more stages | |
365 | * containing one or more matches on a channel. | |
366 | */ | |
367 | struct sr_trigger { | |
368 | /** A name for this trigger. This may be NULL if none is needed. */ | |
369 | char *name; | |
370 | /** List of pointers to struct sr_trigger_stage. */ | |
371 | GSList *stages; | |
372 | }; | |
373 | ||
374 | /** A trigger stage. */ | |
375 | struct sr_trigger_stage { | |
376 | /** Starts at 0. */ | |
377 | int stage; | |
378 | /** List of pointers to struct sr_trigger_match. */ | |
379 | GSList *matches; | |
380 | }; | |
381 | ||
382 | /** A channel to match and what to match it on. */ | |
383 | struct sr_trigger_match { | |
384 | /** The channel to trigger on. */ | |
385 | struct sr_channel *channel; | |
386 | /** The trigger match to use. | |
387 | * For logic channels, only the following matches may be used: | |
388 | * SR_TRIGGER_ZERO | |
389 | * SR_TRIGGER_ONE | |
390 | * SR_TRIGGER_RISING | |
391 | * SR_TRIGGER_FALLING | |
392 | * SR_TRIGGER_EDGE | |
393 | * | |
394 | * For analog channels, only these matches may be used: | |
395 | * SR_TRIGGER_RISING | |
396 | * SR_TRIGGER_FALLING | |
397 | * SR_TRIGGER_OVER | |
398 | * SR_TRIGGER_UNDER | |
399 | * | |
400 | */ | |
401 | int match; | |
402 | /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER, | |
403 | * this contains the value to compare against. */ | |
404 | float value; | |
405 | }; | |
406 | ||
df823ac4 UH |
407 | /** |
408 | * @struct sr_context | |
409 | * Opaque structure representing a libsigrok context. | |
410 | * | |
411 | * None of the fields of this structure are meant to be accessed directly. | |
412 | * | |
413 | * @see sr_init(), sr_exit(). | |
414 | */ | |
b8072700 PS |
415 | struct sr_context; |
416 | ||
0812c40e ML |
417 | /** |
418 | * @struct sr_session | |
419 | * Opaque structure representing a libsigrok session. | |
420 | * | |
421 | * None of the fields of this structure are meant to be accessed directly. | |
422 | * | |
423 | * @see sr_session_new(), sr_session_destroy(). | |
424 | */ | |
425 | struct sr_session; | |
426 | ||
d2e0f585 BV |
427 | struct sr_rational { |
428 | /** Numerator of the rational number. */ | |
429 | uint64_t p; | |
430 | /** Denominator of the rational number. */ | |
431 | uint64_t q; | |
432 | }; | |
433 | ||
04cb9157 | 434 | /** Packet in a sigrok data feed. */ |
b9c735a2 | 435 | struct sr_datafeed_packet { |
a1bb33af | 436 | uint16_t type; |
bf53457d | 437 | const void *payload; |
a1bb33af UH |
438 | }; |
439 | ||
04cb9157 | 440 | /** Header of a sigrok data feed. */ |
b9c735a2 | 441 | struct sr_datafeed_header { |
a1bb33af UH |
442 | int feed_version; |
443 | struct timeval starttime; | |
ee7489d2 BV |
444 | }; |
445 | ||
04cb9157 | 446 | /** Datafeed payload for type SR_DF_META. */ |
9a5693a5 BV |
447 | struct sr_datafeed_meta { |
448 | GSList *config; | |
449 | }; | |
450 | ||
04cb9157 | 451 | /** Logic datafeed payload for type SR_DF_LOGIC. */ |
38ab3ee7 BV |
452 | struct sr_datafeed_logic { |
453 | uint64_t length; | |
454 | uint16_t unitsize; | |
9c939c51 | 455 | void *data; |
38ab3ee7 BV |
456 | }; |
457 | ||
04cb9157 | 458 | /** Analog datafeed payload for type SR_DF_ANALOG. */ |
ee7489d2 | 459 | struct sr_datafeed_analog { |
ba7dd8bb UH |
460 | /** The channels for which data is included in this packet. */ |
461 | GSList *channels; | |
98582bf5 BV |
462 | /** Number of samples in data */ |
463 | int num_samples; | |
04cb9157 MH |
464 | /** Measured quantity (voltage, current, temperature, and so on). |
465 | * Use SR_MQ_VOLTAGE, ... */ | |
02e864d0 | 466 | int mq; |
04cb9157 | 467 | /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */ |
02e864d0 | 468 | int unit; |
04cb9157 | 469 | /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */ |
02e864d0 | 470 | uint64_t mqflags; |
aeba33ba | 471 | /** The analog value(s). The data is interleaved according to |
ba7dd8bb | 472 | * the channels list. */ |
ee7489d2 BV |
473 | float *data; |
474 | }; | |
475 | ||
d2e0f585 BV |
476 | /** Analog datafeed payload for type SR_DF_ANALOG2. */ |
477 | struct sr_datafeed_analog2 { | |
478 | void *data; | |
479 | uint32_t num_samples; | |
480 | struct sr_analog_encoding *encoding; | |
481 | struct sr_analog_meaning *meaning; | |
482 | struct sr_analog_spec *spec; | |
483 | }; | |
484 | ||
485 | struct sr_analog_encoding { | |
486 | uint8_t unitsize; | |
487 | gboolean is_signed; | |
488 | gboolean is_float; | |
489 | gboolean is_bigendian; | |
490 | uint8_t digits; | |
491 | gboolean is_digits_decimal; | |
492 | struct sr_rational scale; | |
493 | struct sr_rational offset; | |
494 | }; | |
495 | ||
496 | struct sr_analog_meaning { | |
497 | enum sr_mq mq; | |
498 | enum sr_unit unit; | |
499 | enum sr_mqflag mqflags; | |
500 | GSList *channels; | |
501 | }; | |
502 | ||
503 | struct sr_analog_spec { | |
504 | uint8_t spec_digits; | |
505 | }; | |
506 | ||
a755b0e1 BV |
507 | /** Generic option struct used by various subsystems. */ |
508 | struct sr_option { | |
509 | /* Short name suitable for commandline usage, [a-z0-9-]. */ | |
510 | char *id; | |
511 | /* Short name suitable for GUI usage, can contain UTF-8. */ | |
512 | char *name; | |
513 | /* Description of the option, in a sentence. */ | |
514 | char *desc; | |
515 | /* Default value for this option. */ | |
516 | GVariant *def; | |
517 | /* List of possible values, if this is an option with few values. */ | |
518 | GSList *values; | |
519 | }; | |
520 | ||
d514d35d BV |
521 | struct sr_input; |
522 | struct sr_input_module; | |
a755b0e1 BV |
523 | struct sr_output; |
524 | struct sr_output_module; | |
790320f6 UH |
525 | struct sr_transform; |
526 | struct sr_transform_module; | |
a1bb33af | 527 | |
fca75cbb | 528 | /** Constants for channel type. */ |
e958f921 | 529 | enum sr_channeltype { |
fca75cbb UH |
530 | /** Channel type is logic channel. */ |
531 | SR_CHANNEL_LOGIC = 10000, | |
532 | /** Channel type is analog channel. */ | |
533 | SR_CHANNEL_ANALOG, | |
921e753f DR |
534 | }; |
535 | ||
91aea754 UH |
536 | /** Information on single channel. */ |
537 | struct sr_channel { | |
837b0866 ML |
538 | /** The device this channel is attached to. */ |
539 | struct sr_dev_inst *sdi; | |
7b5e6d29 BV |
540 | /** The index of this channel, starting at 0. Logic channels will |
541 | * be encoded according to this index in SR_DF_LOGIC packets. */ | |
98582bf5 | 542 | int index; |
3f239f08 | 543 | /** Channel type (SR_CHANNEL_LOGIC, ...) */ |
98582bf5 | 544 | int type; |
91aea754 | 545 | /** Is this channel enabled? */ |
98582bf5 | 546 | gboolean enabled; |
91aea754 | 547 | /** Name of channel. */ |
98582bf5 | 548 | char *name; |
379d2609 BV |
549 | /** Private data for driver use. */ |
550 | void *priv; | |
a1bb33af UH |
551 | }; |
552 | ||
a68bf88e | 553 | /** Structure for groups of channels that have common properties. */ |
660e398f UH |
554 | struct sr_channel_group { |
555 | /** Name of the channel group. */ | |
5150ef33 | 556 | char *name; |
91aea754 | 557 | /** List of sr_channel structs of the channels belonging to this group. */ |
a68bf88e | 558 | GSList *channels; |
a0dc461d | 559 | /** Private data for driver use. */ |
5daed4bc | 560 | void *priv; |
8f996b89 ML |
561 | }; |
562 | ||
04cb9157 | 563 | /** Used for setting or getting value of a config item. */ |
9a5693a5 | 564 | struct sr_config { |
98582bf5 | 565 | /** Config key like SR_CONF_CONN, etc. */ |
584560f1 | 566 | uint32_t key; |
98582bf5 BV |
567 | /** Key-specific data. */ |
568 | GVariant *data; | |
b159add3 BV |
569 | }; |
570 | ||
04cb9157 | 571 | /** Information about a config key. */ |
9a5693a5 | 572 | struct sr_config_info { |
98582bf5 | 573 | /** Config key like SR_CONF_CONN, etc. */ |
584560f1 | 574 | uint32_t key; |
ace218f9 | 575 | /** Data type like SR_T_STRING, etc. */ |
98582bf5 BV |
576 | int datatype; |
577 | /** Id string, e.g. "serialcomm". */ | |
578 | char *id; | |
579 | /** Name, e.g. "Serial communication". */ | |
580 | char *name; | |
581 | /** Verbose description (unused currently). */ | |
582 | char *description; | |
9a5693a5 BV |
583 | }; |
584 | ||
5827f61b BV |
585 | #define SR_CONF_GET (1 << 31) |
586 | #define SR_CONF_SET (1 << 30) | |
587 | #define SR_CONF_LIST (1 << 29) | |
588 | #define SR_CONF_MASK 0x1fffffff | |
589 | ||
54ab1dcd | 590 | /** Configuration keys */ |
e958f921 | 591 | enum sr_configkey { |
e88dadd7 UH |
592 | /*--- Device classes ------------------------------------------------*/ |
593 | ||
594 | /** The device can act as logic analyzer. */ | |
1953564a | 595 | SR_CONF_LOGIC_ANALYZER = 10000, |
925dbf9f | 596 | |
ee7489d2 | 597 | /** The device can act as an oscilloscope. */ |
1953564a | 598 | SR_CONF_OSCILLOSCOPE, |
e88dadd7 | 599 | |
ca3d84cc | 600 | /** The device can act as a multimeter. */ |
1953564a | 601 | SR_CONF_MULTIMETER, |
a141db8c | 602 | |
ca3d84cc | 603 | /** The device is a demo device. */ |
1953564a | 604 | SR_CONF_DEMO_DEV, |
a141db8c | 605 | |
fc19c288 | 606 | /** The device can act as a sound level meter. */ |
1953564a | 607 | SR_CONF_SOUNDLEVELMETER, |
ca3d84cc | 608 | |
40270444 | 609 | /** The device can measure temperature. */ |
1953564a | 610 | SR_CONF_THERMOMETER, |
40270444 BV |
611 | |
612 | /** The device can measure humidity. */ | |
1953564a | 613 | SR_CONF_HYGROMETER, |
40270444 | 614 | |
45315d04 AJ |
615 | /** The device can measure energy consumption. */ |
616 | SR_CONF_ENERGYMETER, | |
617 | ||
54ab1dcd | 618 | /** The device can act as a signal demodulator. */ |
32c426d2 BV |
619 | SR_CONF_DEMODULATOR, |
620 | ||
54ab1dcd | 621 | /** The device can act as a programmable power supply. */ |
471607f0 BV |
622 | SR_CONF_POWER_SUPPLY, |
623 | ||
54ab1dcd | 624 | /** The device can act as an LCR meter. */ |
b9a348f5 | 625 | SR_CONF_LCRMETER, |
0ffce50d | 626 | |
9a6517d1 | 627 | /*--- Driver scan options -------------------------------------------*/ |
c89c1c9c BV |
628 | |
629 | /** | |
630 | * Specification on how to connect to a device. | |
631 | * | |
1953564a | 632 | * In combination with SR_CONF_SERIALCOMM, this is a serial port in |
c89c1c9c BV |
633 | * the form which makes sense to the OS (e.g., /dev/ttyS0). |
634 | * Otherwise this specifies a USB device, either in the form of | |
635 | * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or | |
636 | * @verbatim <vendorid>.<productid> @endverbatim | |
637 | * (hexadecimal, e.g. 1d6b.0001). | |
638 | */ | |
1953564a | 639 | SR_CONF_CONN = 20000, |
c89c1c9c BV |
640 | |
641 | /** | |
642 | * Serial communication specification, in the form: | |
643 | * | |
644 | * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim | |
645 | * | |
646 | * Example: 9600/8n1 | |
647 | * | |
648 | * The string may also be followed by one or more special settings, | |
649 | * in the form "/key=value". Supported keys and their values are: | |
650 | * | |
651 | * rts 0,1 set the port's RTS pin to low or high | |
652 | * dtr 0,1 set the port's DTR pin to low or high | |
653 | * flow 0 no flow control | |
654 | * 1 hardware-based (RTS/CTS) flow control | |
655 | * 2 software-based (XON/XOFF) flow control | |
c1e45c65 | 656 | * |
c89c1c9c BV |
657 | * This is always an optional parameter, since a driver typically |
658 | * knows the speed at which the device wants to communicate. | |
659 | */ | |
1953564a | 660 | SR_CONF_SERIALCOMM, |
c89c1c9c | 661 | |
54ab1dcd | 662 | /*--- Device (or channel group) configuration -----------------------*/ |
e88dadd7 | 663 | |
7231a145 | 664 | /** The device supports setting its samplerate, in Hz. */ |
1953564a | 665 | SR_CONF_SAMPLERATE = 30000, |
e88dadd7 | 666 | |
e88dadd7 | 667 | /** The device supports setting a pre/post-trigger capture ratio. */ |
1953564a | 668 | SR_CONF_CAPTURE_RATIO, |
e88dadd7 | 669 | |
e88dadd7 | 670 | /** The device supports setting a pattern (pattern generator mode). */ |
1953564a | 671 | SR_CONF_PATTERN_MODE, |
e88dadd7 | 672 | |
54ab1dcd | 673 | /** The device supports run-length encoding (RLE). */ |
1953564a | 674 | SR_CONF_RLE, |
3a4d09c0 | 675 | |
ee7489d2 | 676 | /** The device supports setting trigger slope. */ |
1953564a | 677 | SR_CONF_TRIGGER_SLOPE, |
0fe11789 | 678 | |
9ed444e6 BG |
679 | /** The device supports averaging. */ |
680 | SR_CONF_AVERAGING, | |
681 | ||
682 | /** | |
683 | * The device supports setting number of samples to be | |
684 | * averaged over. | |
685 | */ | |
686 | SR_CONF_AVG_SAMPLES, | |
687 | ||
0fe11789 | 688 | /** Trigger source. */ |
1953564a | 689 | SR_CONF_TRIGGER_SOURCE, |
0fe11789 | 690 | |
3c0839d5 | 691 | /** Horizontal trigger position. */ |
1953564a | 692 | SR_CONF_HORIZ_TRIGGERPOS, |
0fe11789 BV |
693 | |
694 | /** Buffer size. */ | |
1953564a | 695 | SR_CONF_BUFFERSIZE, |
0fe11789 BV |
696 | |
697 | /** Time base. */ | |
1953564a | 698 | SR_CONF_TIMEBASE, |
ee7489d2 | 699 | |
3c4976c9 | 700 | /** Filter. */ |
1953564a | 701 | SR_CONF_FILTER, |
3c4976c9 | 702 | |
bd8db307 | 703 | /** Volts/div. */ |
1953564a | 704 | SR_CONF_VDIV, |
bd8db307 | 705 | |
e1c8b2ab | 706 | /** Coupling. */ |
1953564a | 707 | SR_CONF_COUPLING, |
e1c8b2ab | 708 | |
795c9de3 BV |
709 | /** Trigger matches. */ |
710 | SR_CONF_TRIGGER_MATCH, | |
c50277a6 | 711 | |
7231a145 BV |
712 | /** The device supports setting its sample interval, in ms. */ |
713 | SR_CONF_SAMPLE_INTERVAL, | |
714 | ||
bf622e6d ML |
715 | /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */ |
716 | SR_CONF_NUM_HDIV, | |
2efa699f BV |
717 | |
718 | /** Number of vertical divisions, as related to SR_CONF_VDIV. */ | |
719 | SR_CONF_NUM_VDIV, | |
720 | ||
fd8854c4 BV |
721 | /** Sound pressure level frequency weighting. */ |
722 | SR_CONF_SPL_WEIGHT_FREQ, | |
723 | ||
724 | /** Sound pressure level time weighting. */ | |
725 | SR_CONF_SPL_WEIGHT_TIME, | |
726 | ||
8417ebad BV |
727 | /** Sound pressure level measurement range. */ |
728 | SR_CONF_SPL_MEASUREMENT_RANGE, | |
729 | ||
9fd6bc20 BV |
730 | /** Max hold mode. */ |
731 | SR_CONF_HOLD_MAX, | |
732 | ||
733 | /** Min hold mode. */ | |
734 | SR_CONF_HOLD_MIN, | |
735 | ||
db11d7d2 MC |
736 | /** Logic low-high threshold range. */ |
737 | SR_CONF_VOLTAGE_THRESHOLD, | |
738 | ||
bf90d4c6 | 739 | /** The device supports using an external clock. */ |
d5c5ea2a UH |
740 | SR_CONF_EXTERNAL_CLOCK, |
741 | ||
742 | /** | |
743 | * The device supports swapping channels. Typical this is between | |
744 | * buffered and unbuffered channels. | |
745 | */ | |
746 | SR_CONF_SWAP, | |
747 | ||
bf90d4c6 BV |
748 | /** Center frequency. |
749 | * The input signal is downmixed by this frequency before the ADC | |
750 | * anti-aliasing filter. | |
751 | */ | |
752 | SR_CONF_CENTER_FREQUENCY, | |
753 | ||
fca75cbb | 754 | /** The device supports setting the number of logic channels. */ |
3f239f08 | 755 | SR_CONF_NUM_LOGIC_CHANNELS, |
bf90d4c6 | 756 | |
fca75cbb | 757 | /** The device supports setting the number of analog channels. */ |
3f239f08 | 758 | SR_CONF_NUM_ANALOG_CHANNELS, |
32c426d2 | 759 | |
a1eaa9e0 BV |
760 | /** |
761 | * Output voltage. | |
762 | * @arg type: double | |
ca95e90f | 763 | * @arg get: get measured output voltage |
a1eaa9e0 | 764 | */ |
471607f0 BV |
765 | SR_CONF_OUTPUT_VOLTAGE, |
766 | ||
a1eaa9e0 | 767 | /** |
ca95e90f | 768 | * Maximum output voltage target. |
a1eaa9e0 | 769 | * @arg type: double |
ca95e90f BV |
770 | * @arg get: get output voltage target |
771 | * @arg set: change output voltage target | |
a1eaa9e0 | 772 | */ |
ca95e90f | 773 | SR_CONF_OUTPUT_VOLTAGE_TARGET, |
471607f0 | 774 | |
a1eaa9e0 BV |
775 | /** |
776 | * Output current. | |
777 | * @arg type: double | |
ca95e90f | 778 | * @arg get: get measured output current |
a1eaa9e0 | 779 | */ |
471607f0 BV |
780 | SR_CONF_OUTPUT_CURRENT, |
781 | ||
a1eaa9e0 | 782 | /** |
ca95e90f | 783 | * Output current limit. |
a1eaa9e0 | 784 | * @arg type: double |
ca95e90f BV |
785 | * @arg get: get output current limit |
786 | * @arg set: change output current limit | |
a1eaa9e0 | 787 | */ |
ca95e90f | 788 | SR_CONF_OUTPUT_CURRENT_LIMIT, |
471607f0 | 789 | |
a1eaa9e0 BV |
790 | /** |
791 | * Enabling/disabling output. | |
792 | * @arg type: boolean | |
793 | * @arg get: @b true if currently enabled | |
794 | * @arg set: enable/disable | |
795 | */ | |
471607f0 BV |
796 | SR_CONF_OUTPUT_ENABLED, |
797 | ||
a1eaa9e0 BV |
798 | /** |
799 | * Output channel configuration. | |
800 | * @arg type: string | |
801 | * @arg get: get current setting | |
802 | * @arg set: change current setting | |
803 | * @arg list: array of possible values | |
804 | */ | |
805 | SR_CONF_OUTPUT_CHANNEL_CONFIG, | |
806 | ||
807 | /** | |
808 | * Over-voltage protection (OVP) feature | |
809 | * @arg type: boolean | |
810 | * @arg get: @b true if currently enabled | |
811 | * @arg set: enable/disable | |
812 | */ | |
813 | SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, | |
814 | ||
815 | /** | |
816 | * Over-voltage protection (OVP) active | |
817 | * @arg type: boolean | |
818 | * @arg get: @b true if device has activated OVP, i.e. the output voltage | |
819 | * exceeds the over-voltage protection threshold. | |
820 | */ | |
821 | SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, | |
822 | ||
823 | /** | |
824 | * Over-voltage protection (OVP) threshold | |
825 | * @arg type: double (voltage) | |
826 | * @arg get: get current threshold | |
827 | * @arg set: set new threshold | |
828 | */ | |
829 | SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, | |
830 | ||
831 | /** | |
832 | * Over-current protection (OCP) feature | |
833 | * @arg type: boolean | |
834 | * @arg get: @b true if currently enabled | |
835 | * @arg set: enable/disable | |
836 | */ | |
837 | SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, | |
471607f0 | 838 | |
a1eaa9e0 BV |
839 | /** |
840 | * Over-current protection (OCP) active | |
841 | * @arg type: boolean | |
842 | * @arg get: @b true if device has activated OCP, i.e. the output current | |
843 | * exceeds the over-current protection threshold. | |
844 | */ | |
845 | SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, | |
471607f0 | 846 | |
a1eaa9e0 BV |
847 | /** |
848 | * Over-current protection (OCP) threshold | |
849 | * @arg type: double (current) | |
850 | * @arg get: get current threshold | |
851 | * @arg set: set new threshold | |
852 | */ | |
853 | SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, | |
471607f0 | 854 | |
860bc59b DE |
855 | /** Choice of clock edge for external clock ("r" or "f"). */ |
856 | SR_CONF_CLOCK_EDGE, | |
857 | ||
cff7d8d6 BV |
858 | /** Amplitude of a source without strictly-defined MQ. */ |
859 | SR_CONF_AMPLITUDE, | |
860 | ||
a1eaa9e0 BV |
861 | /** |
862 | * Output channel regulation | |
863 | * get: "CV", "CC" or "UR", denoting constant voltage, constant current | |
864 | * or unregulated. | |
865 | */ | |
866 | SR_CONF_OUTPUT_REGULATION, | |
867 | ||
868 | /** Over-temperature protection (OTP) */ | |
869 | SR_CONF_OVER_TEMPERATURE_PROTECTION, | |
870 | ||
0f5b241e JH |
871 | /** Output frequency in Hz. */ |
872 | SR_CONF_OUTPUT_FREQUENCY, | |
873 | ||
a42a39ac JH |
874 | /** Measured quantity. */ |
875 | SR_CONF_MEASURED_QUANTITY, | |
876 | ||
877 | /** Measured secondary quantity. */ | |
878 | SR_CONF_MEASURED_2ND_QUANTITY, | |
879 | ||
880 | /** Equivalent circuit model. */ | |
881 | SR_CONF_EQUIV_CIRCUIT_MODEL, | |
882 | ||
a77585d4 AG |
883 | /* Output frequency target in Hz. */ |
884 | SR_CONF_OUTPUT_FREQUENCY_TARGET, | |
885 | ||
e88dadd7 UH |
886 | /*--- Special stuff -------------------------------------------------*/ |
887 | ||
9a6517d1 | 888 | /** Scan options supported by the driver. */ |
aeba33ba | 889 | SR_CONF_SCAN_OPTIONS = 40000, |
9a6517d1 BV |
890 | |
891 | /** Device options for a particular device. */ | |
892 | SR_CONF_DEVICE_OPTIONS, | |
893 | ||
3c0839d5 | 894 | /** Session filename. */ |
aeba33ba | 895 | SR_CONF_SESSIONFILE, |
40dda2c3 | 896 | |
e88dadd7 | 897 | /** The device supports specifying a capturefile to inject. */ |
1953564a | 898 | SR_CONF_CAPTUREFILE, |
925dbf9f | 899 | |
e88dadd7 | 900 | /** The device supports specifying the capturefile unit size. */ |
1953564a | 901 | SR_CONF_CAPTURE_UNITSIZE, |
7d658874 | 902 | |
32de50b7 BV |
903 | /** Power off the device. */ |
904 | SR_CONF_POWER_OFF, | |
905 | ||
d86e0b11 BV |
906 | /** |
907 | * Data source for acquisition. If not present, acquisition from | |
6caeef6e BV |
908 | * the device is always "live", i.e. acquisition starts when the |
909 | * frontend asks and the results are sent out as soon as possible. | |
910 | * | |
911 | * If present, it indicates that either the device has no live | |
912 | * acquisition capability (for example a pure data logger), or | |
913 | * there is a choice. sr_config_list() returns those choices. | |
914 | * | |
915 | * In any case if a device has live acquisition capabilities, it | |
d86e0b11 BV |
916 | * is always the default. |
917 | */ | |
6caeef6e BV |
918 | SR_CONF_DATA_SOURCE, |
919 | ||
d3c81725 BG |
920 | /** The device supports setting a probe factor. */ |
921 | SR_CONF_PROBE_FACTOR, | |
922 | ||
54ab1dcd | 923 | /*--- Acquisition modes, sample limiting ----------------------------*/ |
e88dadd7 UH |
924 | |
925 | /** | |
a02d77bc UH |
926 | * The device supports setting a sample time limit (how long |
927 | * the sample acquisition should run, in ms). | |
e88dadd7 | 928 | */ |
1953564a | 929 | SR_CONF_LIMIT_MSEC = 50000, |
e88dadd7 UH |
930 | |
931 | /** | |
a02d77bc UH |
932 | * The device supports setting a sample number limit (how many |
933 | * samples should be acquired). | |
e88dadd7 | 934 | */ |
1953564a | 935 | SR_CONF_LIMIT_SAMPLES, |
e88dadd7 | 936 | |
6ea7669c | 937 | /** |
a02d77bc UH |
938 | * The device supports setting a frame limit (how many |
939 | * frames should be acquired). | |
6ea7669c | 940 | */ |
1953564a | 941 | SR_CONF_LIMIT_FRAMES, |
6ea7669c | 942 | |
e88dadd7 | 943 | /** |
a02d77bc | 944 | * The device supports continuous sampling. Neither a time limit |
e88dadd7 UH |
945 | * nor a sample number limit has to be supplied, it will just acquire |
946 | * samples continuously, until explicitly stopped by a certain command. | |
947 | */ | |
1953564a | 948 | SR_CONF_CONTINUOUS, |
e6551ea6 BV |
949 | |
950 | /** The device has internal storage, into which data is logged. This | |
951 | * starts or stops the internal logging. */ | |
952 | SR_CONF_DATALOG, | |
831d7c70 ML |
953 | |
954 | /** Device mode for multi-function devices. */ | |
955 | SR_CONF_DEVICE_MODE, | |
956 | ||
957 | /** Self test mode. */ | |
958 | SR_CONF_TEST_MODE, | |
a1bb33af UH |
959 | }; |
960 | ||
96727ef0 UH |
961 | /** |
962 | * Opaque structure representing a libsigrok device instance. | |
963 | * | |
964 | * None of the fields of this structure are meant to be accessed directly. | |
04cb9157 | 965 | */ |
96727ef0 | 966 | struct sr_dev_inst; |
a1bb33af | 967 | |
04cb9157 | 968 | /** Types of device instance, struct sr_dev_inst.type */ |
76857945 | 969 | enum sr_dev_inst_type { |
4101f961 | 970 | /** Device instance type for USB devices. */ |
24d04d1e | 971 | SR_INST_USB = 10000, |
4101f961 UH |
972 | /** Device instance type for serial port devices. */ |
973 | SR_INST_SERIAL, | |
23f43dff ML |
974 | /** Device instance type for SCPI devices. */ |
975 | SR_INST_SCPI, | |
e705ce3b UH |
976 | /** Device-instance type for user-created "devices". */ |
977 | SR_INST_USER, | |
a1bb33af UH |
978 | }; |
979 | ||
04cb9157 | 980 | /** Device instance status, struct sr_dev_inst.status */ |
76857945 | 981 | enum sr_dev_inst_status { |
3c0839d5 | 982 | /** The device instance was not found. */ |
24d04d1e | 983 | SR_ST_NOT_FOUND = 10000, |
3c0839d5 | 984 | /** The device instance was found, but is still booting. */ |
5a2326a7 | 985 | SR_ST_INITIALIZING, |
3c0839d5 | 986 | /** The device instance is live, but not in use. */ |
5a2326a7 | 987 | SR_ST_INACTIVE, |
3c0839d5 | 988 | /** The device instance is actively in use in a session. */ |
5a2326a7 | 989 | SR_ST_ACTIVE, |
69b07d14 BV |
990 | /** The device is winding down its session. */ |
991 | SR_ST_STOPPING, | |
a1bb33af UH |
992 | }; |
993 | ||
813aab69 | 994 | /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */ |
c09f0b57 UH |
995 | struct sr_dev_driver { |
996 | /* Driver-specific */ | |
813aab69 | 997 | /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */ |
98582bf5 | 998 | char *name; |
813aab69 | 999 | /** Long name. Verbose driver name shown to user. */ |
98582bf5 BV |
1000 | char *longname; |
1001 | /** API version (currently 1). */ | |
1002 | int api_version; | |
813aab69 | 1003 | /** Called when driver is loaded, e.g. program startup. */ |
4f840ce9 | 1004 | int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx); |
813aab69 | 1005 | /** Called before driver is unloaded. |
99d090d8 | 1006 | * Driver must free all resources held by it. */ |
4f840ce9 | 1007 | int (*cleanup) (const struct sr_dev_driver *driver); |
813aab69 MH |
1008 | /** Scan for devices. Driver should do all initialisation required. |
1009 | * Can be called several times, e.g. with different port options. | |
1010 | * \retval NULL Error or no devices found. | |
1011 | * \retval other GSList of a struct sr_dev_inst for each device. | |
1012 | * Must be freed by caller! | |
1013 | */ | |
4f840ce9 | 1014 | GSList *(*scan) (struct sr_dev_driver *driver, GSList *options); |
813aab69 MH |
1015 | /** Get list of device instances the driver knows about. |
1016 | * \returns NULL or GSList of a struct sr_dev_inst for each device. | |
1017 | * Must not be freed by caller! | |
1018 | */ | |
4f840ce9 | 1019 | GSList *(*dev_list) (const struct sr_dev_driver *driver); |
813aab69 | 1020 | /** Clear list of devices the driver knows about. */ |
4f840ce9 | 1021 | int (*dev_clear) (const struct sr_dev_driver *driver); |
813aab69 MH |
1022 | /** Query value of a configuration key in driver or given device instance. |
1023 | * @see sr_config_get(). | |
1024 | */ | |
584560f1 | 1025 | int (*config_get) (uint32_t key, GVariant **data, |
8f996b89 | 1026 | const struct sr_dev_inst *sdi, |
53b4680f | 1027 | const struct sr_channel_group *cg); |
813aab69 MH |
1028 | /** Set value of a configuration key in driver or a given device instance. |
1029 | * @see sr_config_set(). */ | |
584560f1 | 1030 | int (*config_set) (uint32_t key, GVariant *data, |
8f996b89 | 1031 | const struct sr_dev_inst *sdi, |
53b4680f | 1032 | const struct sr_channel_group *cg); |
fca75cbb | 1033 | /** Channel status change. |
3b0ff21c | 1034 | * @see sr_dev_channel_enable(). */ |
f3ca73ed | 1035 | int (*config_channel_set) (const struct sr_dev_inst *sdi, |
ba7dd8bb | 1036 | struct sr_channel *ch, unsigned int changes); |
813aab69 MH |
1037 | /** Apply configuration settings to the device hardware. |
1038 | * @see sr_config_commit().*/ | |
2a854d71 | 1039 | int (*config_commit) (const struct sr_dev_inst *sdi); |
813aab69 MH |
1040 | /** List all possible values for a configuration key in a device instance. |
1041 | * @see sr_config_list(). | |
1042 | */ | |
584560f1 | 1043 | int (*config_list) (uint32_t key, GVariant **data, |
8f996b89 | 1044 | const struct sr_dev_inst *sdi, |
53b4680f | 1045 | const struct sr_channel_group *cg); |
a1bb33af | 1046 | |
1b452b85 | 1047 | /* Device-specific */ |
98582bf5 BV |
1048 | /** Open device */ |
1049 | int (*dev_open) (struct sr_dev_inst *sdi); | |
1050 | /** Close device */ | |
1051 | int (*dev_close) (struct sr_dev_inst *sdi); | |
a84f6ad3 | 1052 | /** Begin data acquisition on the specified device. */ |
3ffb6964 | 1053 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
98582bf5 | 1054 | void *cb_data); |
a84f6ad3 | 1055 | /** End data acquisition on the specified device. */ |
69b07d14 | 1056 | int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, |
98582bf5 | 1057 | void *cb_data); |
dd34b8d3 BV |
1058 | |
1059 | /* Dynamic */ | |
813aab69 | 1060 | /** Device driver private data. Initialized by init(). */ |
98582bf5 | 1061 | void *priv; |
a1bb33af UH |
1062 | }; |
1063 | ||
e2b23821 | 1064 | /** |
df823ac4 UH |
1065 | * @struct sr_session |
1066 | * | |
e2b23821 UH |
1067 | * Opaque data structure representing a libsigrok session. None of the fields |
1068 | * of this structure are meant to be accessed directly. | |
1069 | */ | |
1070 | struct sr_session; | |
a1bb33af | 1071 | |
24287ea9 AJ |
1072 | /** Serial port descriptor. */ |
1073 | struct sr_serial_port { | |
1074 | /** The OS dependent name of the serial port. */ | |
1075 | char *name; | |
1076 | /** An end user friendly description for the serial port. */ | |
1077 | char *description; | |
1078 | }; | |
1079 | ||
45c59c8b BV |
1080 | #include "proto.h" |
1081 | #include "version.h" | |
c2bd92ec | 1082 | |
a00b530c UH |
1083 | #ifdef __cplusplus |
1084 | } | |
1085 | #endif | |
1086 | ||
a1bb33af | 1087 | #endif |