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