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