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