]>
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 | * | |
04cb9157 MH |
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. */ | |
66 | enum { | |
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. */ | |
bd6fbf62 | 73 | SR_ERR_NA = -6, /**< Not applicable. */ |
e73ffd42 | 74 | SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but needs to be open. */ |
3e62166e | 75 | SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */ |
bdc955bc | 76 | SR_ERR_PROBE_GROUP= -9, /**< A probe 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 | |
b2ff9506 | 84 | #define SR_MAX_PROBENAME_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 UH |
94 | /** libsigrok loglevels. */ |
95 | enum { | |
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. */ |
1f9813eb | 135 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 136 | |
08a9260b | 137 | /** Data types used by sr_config_info(). */ |
a1bb33af | 138 | enum { |
24d04d1e | 139 | SR_T_UINT64 = 10000, |
5a2326a7 | 140 | SR_T_CHAR, |
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. */ |
a1bb33af | 152 | enum { |
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. */ |
9956f285 | 172 | enum { |
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, | |
9956f285 UH |
198 | }; |
199 | ||
04cb9157 | 200 | /** Unit of measured quantity, sr_datafeed_analog.unit. */ |
aff5a729 | 201 | enum { |
98582bf5 BV |
202 | /** Volt */ |
203 | SR_UNIT_VOLT = 10000, | |
204 | /** Ampere (current). */ | |
205 | SR_UNIT_AMPERE, | |
206 | /** Ohm (resistance). */ | |
207 | SR_UNIT_OHM, | |
208 | /** Farad (capacity). */ | |
209 | SR_UNIT_FARAD, | |
210 | /** Kelvin (temperature). */ | |
211 | SR_UNIT_KELVIN, | |
212 | /** Degrees Celsius (temperature). */ | |
213 | SR_UNIT_CELSIUS, | |
214 | /** Degrees Fahrenheit (temperature). */ | |
215 | SR_UNIT_FAHRENHEIT, | |
216 | /** Hertz (frequency, 1/s, [Hz]). */ | |
217 | SR_UNIT_HERTZ, | |
218 | /** Percent value. */ | |
219 | SR_UNIT_PERCENTAGE, | |
220 | /** Boolean value. */ | |
221 | SR_UNIT_BOOLEAN, | |
222 | /** Time in seconds. */ | |
223 | SR_UNIT_SECOND, | |
224 | /** Unit of conductance, the inverse of resistance. */ | |
225 | SR_UNIT_SIEMENS, | |
3c0839d5 UH |
226 | /** |
227 | * An absolute measurement of power, in decibels, referenced to | |
228 | * 1 milliwatt (dBu). | |
229 | */ | |
b82a17d3 | 230 | SR_UNIT_DECIBEL_MW, |
6b869234 BV |
231 | /** Voltage in decibel, referenced to 1 volt (dBV). */ |
232 | SR_UNIT_DECIBEL_VOLT, | |
3c0839d5 UH |
233 | /** |
234 | * Measurements that intrinsically do not have units attached, such | |
6b869234 | 235 | * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is |
3c0839d5 UH |
236 | * a unitless quantity, for example. |
237 | */ | |
b82a17d3 | 238 | SR_UNIT_UNITLESS, |
fc19c288 BV |
239 | /** Sound pressure level relative so 20 micropascals. */ |
240 | SR_UNIT_DECIBEL_SPL, | |
801c7800 AG |
241 | /** |
242 | * Normalized (0 to 1) concentration of a substance or compound with 0 | |
243 | * representing a concentration of 0%, and 1 being 100%. This is | |
244 | * represented as the fraction of number of particles of the substance. | |
245 | */ | |
4f3bd685 | 246 | SR_UNIT_CONCENTRATION, |
98582bf5 BV |
247 | /** Revolutions per minute. */ |
248 | SR_UNIT_REVOLUTIONS_PER_MINUTE, | |
249 | /** Apparent power [VA]. */ | |
250 | SR_UNIT_VOLT_AMPERE, | |
251 | /** Real power [W]. */ | |
252 | SR_UNIT_WATT, | |
253 | /** Consumption [Wh]. */ | |
254 | SR_UNIT_WATT_HOUR, | |
aff5a729 BV |
255 | }; |
256 | ||
3c0839d5 | 257 | /** Values for sr_datafeed_analog.flags. */ |
02e864d0 | 258 | enum { |
3c0839d5 | 259 | /** Voltage measurement is alternating current (AC). */ |
02e864d0 | 260 | SR_MQFLAG_AC = 0x01, |
3c0839d5 | 261 | /** Voltage measurement is direct current (DC). */ |
02e864d0 BV |
262 | SR_MQFLAG_DC = 0x02, |
263 | /** This is a true RMS measurement. */ | |
264 | SR_MQFLAG_RMS = 0x04, | |
265 | /** Value is voltage drop across a diode, or NAN. */ | |
266 | SR_MQFLAG_DIODE = 0x08, | |
a02d77bc | 267 | /** Device is in "hold" mode (repeating the last measurement). */ |
02e864d0 | 268 | SR_MQFLAG_HOLD = 0x10, |
3c0839d5 | 269 | /** Device is in "max" mode, only updating upon a new max value. */ |
02e864d0 | 270 | SR_MQFLAG_MAX = 0x20, |
3c0839d5 | 271 | /** Device is in "min" mode, only updating upon a new min value. */ |
02e864d0 BV |
272 | SR_MQFLAG_MIN = 0x40, |
273 | /** Device is in autoranging mode. */ | |
274 | SR_MQFLAG_AUTORANGE = 0x80, | |
275 | /** Device is in relative mode. */ | |
276 | SR_MQFLAG_RELATIVE = 0x100, | |
fc19c288 | 277 | /** Sound pressure level is A-weighted in the frequency domain, |
2244356d | 278 | * according to IEC 61672:2003. */ |
fc19c288 BV |
279 | SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, |
280 | /** Sound pressure level is C-weighted in the frequency domain, | |
2244356d | 281 | * according to IEC 61672:2003. */ |
fc19c288 BV |
282 | SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400, |
283 | /** Sound pressure level is Z-weighted (i.e. not at all) in the | |
2244356d | 284 | * frequency domain, according to IEC 61672:2003. */ |
fc19c288 BV |
285 | SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800, |
286 | /** Sound pressure level is not weighted in the frequency domain, | |
287 | * albeit without standards-defined low and high frequency limits. */ | |
288 | SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000, | |
289 | /** Sound pressure level measurement is S-weighted (1s) in the | |
290 | * time domain. */ | |
291 | SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000, | |
292 | /** Sound pressure level measurement is F-weighted (125ms) in the | |
293 | * time domain. */ | |
294 | SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000, | |
295 | /** Sound pressure level is time-averaged (LAT), also known as | |
296 | * Equivalent Continuous A-weighted Sound Level (LEQ). */ | |
297 | SR_MQFLAG_SPL_LAT = 0x8000, | |
298 | /** Sound pressure level represented as a percentage of measurements | |
299 | * that were over a preset alarm level. */ | |
300 | SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, | |
367983a7 MH |
301 | /** Time is duration (as opposed to epoch, ...). */ |
302 | SR_MQFLAG_DURATION = 0x20000, | |
f5027ca4 AJ |
303 | /** Device is in "avg" mode, averaging upon each new value. */ |
304 | SR_MQFLAG_AVG = 0x40000, | |
02e864d0 BV |
305 | }; |
306 | ||
df823ac4 UH |
307 | /** |
308 | * @struct sr_context | |
309 | * Opaque structure representing a libsigrok context. | |
310 | * | |
311 | * None of the fields of this structure are meant to be accessed directly. | |
312 | * | |
313 | * @see sr_init(), sr_exit(). | |
314 | */ | |
b8072700 PS |
315 | struct sr_context; |
316 | ||
04cb9157 | 317 | /** Packet in a sigrok data feed. */ |
b9c735a2 | 318 | struct sr_datafeed_packet { |
a1bb33af | 319 | uint16_t type; |
bf53457d | 320 | const void *payload; |
a1bb33af UH |
321 | }; |
322 | ||
04cb9157 | 323 | /** Header of a sigrok data feed. */ |
b9c735a2 | 324 | struct sr_datafeed_header { |
a1bb33af UH |
325 | int feed_version; |
326 | struct timeval starttime; | |
ee7489d2 BV |
327 | }; |
328 | ||
04cb9157 | 329 | /** Datafeed payload for type SR_DF_META. */ |
9a5693a5 BV |
330 | struct sr_datafeed_meta { |
331 | GSList *config; | |
332 | }; | |
333 | ||
04cb9157 | 334 | /** Logic datafeed payload for type SR_DF_LOGIC. */ |
38ab3ee7 BV |
335 | struct sr_datafeed_logic { |
336 | uint64_t length; | |
337 | uint16_t unitsize; | |
9c939c51 | 338 | void *data; |
38ab3ee7 BV |
339 | }; |
340 | ||
04cb9157 | 341 | /** Analog datafeed payload for type SR_DF_ANALOG. */ |
ee7489d2 | 342 | struct sr_datafeed_analog { |
aeba33ba | 343 | /** The probes for which data is included in this packet. */ |
69e19dd7 | 344 | GSList *probes; |
98582bf5 BV |
345 | /** Number of samples in data */ |
346 | int num_samples; | |
04cb9157 MH |
347 | /** Measured quantity (voltage, current, temperature, and so on). |
348 | * Use SR_MQ_VOLTAGE, ... */ | |
02e864d0 | 349 | int mq; |
04cb9157 | 350 | /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */ |
02e864d0 | 351 | int unit; |
04cb9157 | 352 | /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */ |
02e864d0 | 353 | uint64_t mqflags; |
aeba33ba BV |
354 | /** The analog value(s). The data is interleaved according to |
355 | * the probes list. */ | |
ee7489d2 BV |
356 | float *data; |
357 | }; | |
358 | ||
83687343 | 359 | /** Input (file) format struct. */ |
f50f3f40 | 360 | struct sr_input { |
83687343 UH |
361 | /** |
362 | * A pointer to this input format's 'struct sr_input_format'. | |
363 | * The frontend can use this to call the module's callbacks. | |
364 | */ | |
f50f3f40 | 365 | struct sr_input_format *format; |
83687343 | 366 | |
3dafb92b | 367 | GHashTable *param; |
83687343 | 368 | |
5c3c1241 | 369 | struct sr_dev_inst *sdi; |
83687343 | 370 | |
3dafb92b | 371 | void *internal; |
34e4813f BV |
372 | }; |
373 | ||
04cb9157 | 374 | /** Input (file) format driver. */ |
f50f3f40 | 375 | struct sr_input_format { |
83687343 | 376 | /** The unique ID for this input format. Must not be NULL. */ |
cdb3573c | 377 | char *id; |
83687343 UH |
378 | |
379 | /** | |
380 | * A short description of the input format, which can (for example) | |
381 | * be displayed to the user by frontends. Must not be NULL. | |
382 | */ | |
34e4813f | 383 | char *description; |
83687343 UH |
384 | |
385 | /** | |
386 | * Check if this input module can load and parse the specified file. | |
387 | * | |
04cb9157 | 388 | * @param[in] filename The name (and path) of the file to check. |
83687343 | 389 | * |
04cb9157 MH |
390 | * @retval TRUE This module knows the format. |
391 | * @retval FALSE This module does not know the format. | |
83687343 | 392 | */ |
757b8c62 | 393 | int (*format_match) (const char *filename); |
83687343 UH |
394 | |
395 | /** | |
396 | * Initialize the input module. | |
397 | * | |
398 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
399 | * has to allocate and provide to this function. It is also | |
400 | * the responsibility of the caller to free it later. | |
04cb9157 | 401 | * @param[in] filename The name (and path) of the file to use. |
83687343 | 402 | * |
04cb9157 MH |
403 | * @retval SR_OK Success |
404 | * @retval other Negative error code. | |
83687343 | 405 | */ |
543d45c5 | 406 | int (*init) (struct sr_input *in, const char *filename); |
83687343 UH |
407 | |
408 | /** | |
409 | * Load a file, parsing the input according to the file's format. | |
410 | * | |
411 | * This function will send datafeed packets to the session bus, so | |
412 | * the calling frontend must have registered its session callbacks | |
413 | * beforehand. | |
414 | * | |
415 | * The packet types sent across the session bus by this function must | |
416 | * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data | |
417 | * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet | |
418 | * if appropriate. | |
419 | * | |
420 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
421 | * has to allocate and provide to this function. It is also | |
422 | * the responsibility of the caller to free it later. | |
423 | * @param filename The name (and path) of the file to use. | |
424 | * | |
04cb9157 MH |
425 | * @retval SR_OK Success |
426 | * @retval other Negative error code. | |
83687343 | 427 | */ |
f50f3f40 | 428 | int (*loadfile) (struct sr_input *in, const char *filename); |
34e4813f BV |
429 | }; |
430 | ||
07e1aad5 | 431 | /** Output (file) format struct. */ |
f50f3f40 | 432 | struct sr_output { |
07e1aad5 UH |
433 | /** |
434 | * A pointer to this output format's 'struct sr_output_format'. | |
435 | * The frontend can use this to call the module's callbacks. | |
436 | */ | |
f50f3f40 | 437 | struct sr_output_format *format; |
07e1aad5 UH |
438 | |
439 | /** | |
440 | * The device for which this output module is creating output. This | |
441 | * can be used by the module to find out probe names and numbers. | |
442 | */ | |
5c3c1241 | 443 | struct sr_dev_inst *sdi; |
07e1aad5 UH |
444 | |
445 | /** | |
446 | * An optional parameter which the frontend can pass in to the | |
447 | * output module. How the string is interpreted is entirely up to | |
448 | * the module. | |
449 | */ | |
a1bb33af | 450 | char *param; |
07e1aad5 UH |
451 | |
452 | /** | |
453 | * A generic pointer which can be used by the module to keep internal | |
454 | * state between calls into its callback functions. | |
455 | * | |
456 | * For example, the module might store a pointer to a chunk of output | |
457 | * there, and only flush it when it reaches a certain size. | |
458 | */ | |
a1bb33af UH |
459 | void *internal; |
460 | }; | |
461 | ||
04cb9157 | 462 | /** Output (file) format driver. */ |
f50f3f40 | 463 | struct sr_output_format { |
07e1aad5 UH |
464 | /** |
465 | * A unique ID for this output format. Must not be NULL. | |
466 | * | |
467 | * It can be used by frontends to select this output format for use. | |
468 | * | |
469 | * For example, calling sigrok-cli with <code>-O hex</code> will | |
470 | * select the hexadecimal text output format. | |
471 | */ | |
cdb3573c | 472 | char *id; |
07e1aad5 UH |
473 | |
474 | /** | |
475 | * A short description of the output format. Must not be NULL. | |
476 | * | |
477 | * This can be displayed by frontends, e.g. when selecting the output | |
478 | * format for saving a file. | |
479 | */ | |
a1bb33af | 480 | char *description; |
07e1aad5 | 481 | |
98582bf5 BV |
482 | /** Datafeed type, SR_DF_HEADER, etc. */ |
483 | int df_type; | |
07e1aad5 UH |
484 | |
485 | /** | |
486 | * This function is called once, at the beginning of an output stream. | |
487 | * | |
488 | * The device struct will be available in the output struct passed in, | |
489 | * as well as the param field -- which may be NULL or an empty string, | |
490 | * if no parameter was passed. | |
491 | * | |
492 | * The module can use this to initialize itself, create a struct for | |
493 | * keeping state and storing it in the <code>internal</code> field. | |
494 | * | |
495 | * @param o Pointer to the respective 'struct sr_output'. | |
496 | * | |
04cb9157 MH |
497 | * @retval SR_OK Success |
498 | * @retval other Negative error code. | |
07e1aad5 | 499 | */ |
f50f3f40 | 500 | int (*init) (struct sr_output *o); |
07e1aad5 UH |
501 | |
502 | /** | |
503 | * Whenever a chunk of data comes in, it will be passed to the | |
504 | * output module via this function. The <code>data_in</code> and | |
505 | * <code>length_in</code> values refers to this data; the module | |
506 | * must not alter or g_free() this buffer. | |
507 | * | |
508 | * The function must allocate a buffer for storing its output, and | |
509 | * pass along a pointer to this buffer in the <code>data_out</code> | |
510 | * parameter, as well as storing the length of the buffer in | |
511 | * <code>length_out</code>. The calling frontend will g_free() | |
512 | * this buffer when it's done with it. | |
513 | * | |
514 | * IMPORTANT: The memory allocation much happen using a glib memory | |
515 | * allocation call (not a "normal" malloc) since g_free() will be | |
516 | * used to free the memory! | |
517 | * | |
518 | * If there is no output, this function MUST store NULL in the | |
519 | * <code>data_out</code> parameter, so the caller knows not to try | |
520 | * and g_free() it. | |
521 | * | |
17f63de6 | 522 | * Note: This API call is obsolete, use receive() instead. |
07e1aad5 UH |
523 | * |
524 | * @param o Pointer to the respective 'struct sr_output'. | |
525 | * @param data_in Pointer to the input data buffer. | |
526 | * @param length_in Length of the input. | |
527 | * @param data_out Pointer to the allocated output buffer. | |
528 | * @param length_out Length (in bytes) of the output. | |
529 | * | |
04cb9157 MH |
530 | * @retval SR_OK Success |
531 | * @retval other Negative error code. | |
07e1aad5 | 532 | */ |
054e6709 UH |
533 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
534 | uint64_t length_in, uint8_t **data_out, | |
535 | uint64_t *length_out); | |
07e1aad5 UH |
536 | |
537 | /** | |
538 | * This function is called when an event occurs in the datafeed | |
539 | * which the output module may need to be aware of. No data is | |
540 | * passed in, only the fact that the event occurs. The following | |
541 | * events can currently be passed in: | |
542 | * | |
543 | * - SR_DF_TRIGGER: At this point in the datafeed, the trigger | |
544 | * matched. The output module may mark this in some way, e.g. by | |
545 | * plotting a red line on a graph. | |
546 | * | |
547 | * - SR_DF_END: This marks the end of the datafeed. No more calls | |
548 | * into the output module will be done, so this is a good time to | |
549 | * free up any memory used to keep state, for example. | |
550 | * | |
551 | * Any output generated by this function must have a reference to | |
552 | * it stored in the <code>data_out</code> and <code>length_out</code> | |
553 | * parameters, or NULL if no output was generated. | |
554 | * | |
17f63de6 | 555 | * Note: This API call is obsolete, use receive() instead. |
07e1aad5 UH |
556 | * |
557 | * @param o Pointer to the respective 'struct sr_output'. | |
558 | * @param event_type Type of event that occured. | |
559 | * @param data_out Pointer to the allocated output buffer. | |
560 | * @param length_out Length (in bytes) of the output. | |
561 | * | |
04cb9157 MH |
562 | * @retval SR_OK Success |
563 | * @retval other Negative error code. | |
07e1aad5 | 564 | */ |
054e6709 | 565 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, |
17f63de6 | 566 | uint64_t *length_out); |
07e1aad5 | 567 | |
17f63de6 BV |
568 | /** |
569 | * This function is passed a copy of every packed in the data feed. | |
570 | * Any output generated by the output module in response to the | |
571 | * packet should be returned in a newly allocated GString | |
572 | * <code>out</code>, which will be freed by the caller. | |
573 | * | |
574 | * Packets not of interest to the output module can just be ignored, | |
575 | * and the <code>out</code> parameter set to NULL. | |
576 | * | |
577 | * @param o Pointer to the respective 'struct sr_output'. | |
578 | * @param sdi The device instance that generated the packet. | |
579 | * @param packet The complete packet. | |
580 | * @param out A pointer where a GString * should be stored if | |
581 | * the module generates output, or NULL if not. | |
582 | * | |
04cb9157 MH |
583 | * @retval SR_OK Success |
584 | * @retval other Negative error code. | |
17f63de6 BV |
585 | */ |
586 | int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, | |
587 | const struct sr_datafeed_packet *packet, GString **out); | |
07e1aad5 | 588 | |
17f63de6 BV |
589 | /** |
590 | * This function is called after the caller is finished using | |
591 | * the output module, and can be used to free any internal | |
592 | * resources the module may keep. | |
593 | * | |
04cb9157 MH |
594 | * @retval SR_OK Success |
595 | * @retval other Negative error code. | |
17f63de6 | 596 | */ |
f45b7590 | 597 | int (*cleanup) (struct sr_output *o); |
a1bb33af UH |
598 | }; |
599 | ||
04cb9157 | 600 | /** Constants for probe type. */ |
921e753f | 601 | enum { |
98582bf5 BV |
602 | /** Probe type is logic probe. */ |
603 | SR_PROBE_LOGIC = 10000, | |
604 | /** Probe type is analog probe. */ | |
605 | SR_PROBE_ANALOG, | |
921e753f DR |
606 | }; |
607 | ||
04cb9157 | 608 | /** Information on single probe. */ |
1afe8989 | 609 | struct sr_probe { |
98582bf5 BV |
610 | /** Number of probes, starting at 0. @deprecated The index field |
611 | * will go: use g_slist_length(sdi->probes) instead. */ | |
612 | int index; | |
613 | /** Probe type (SR_PROBE_LOGIC, ...) */ | |
614 | int type; | |
615 | /** Is this probe enabled? */ | |
616 | gboolean enabled; | |
617 | /** Name of probe. */ | |
618 | char *name; | |
619 | /** Trigger string, format like used by sigrok-cli */ | |
620 | char *trigger; | |
a1bb33af UH |
621 | }; |
622 | ||
a0dc461d | 623 | /** Structure for groups of probes that have common properties. */ |
8f996b89 | 624 | struct sr_probe_group { |
a0dc461d | 625 | /** Name of the probe group. */ |
5150ef33 | 626 | char *name; |
a0dc461d | 627 | /** List of sr_probe structs of the probes belonging to this group. */ |
8f996b89 | 628 | GSList *probes; |
a0dc461d | 629 | /** Private data for driver use. */ |
5daed4bc | 630 | void *priv; |
8f996b89 ML |
631 | }; |
632 | ||
04cb9157 | 633 | /** Used for setting or getting value of a config item. */ |
9a5693a5 | 634 | struct sr_config { |
98582bf5 BV |
635 | /** Config key like SR_CONF_CONN, etc. */ |
636 | int key; | |
637 | /** Key-specific data. */ | |
638 | GVariant *data; | |
b159add3 BV |
639 | }; |
640 | ||
04cb9157 | 641 | /** Information about a config key. */ |
9a5693a5 | 642 | struct sr_config_info { |
98582bf5 BV |
643 | /** Config key like SR_CONF_CONN, etc. */ |
644 | int key; | |
645 | /** Data type like SR_T_CHAR, etc. */ | |
646 | int datatype; | |
647 | /** Id string, e.g. "serialcomm". */ | |
648 | char *id; | |
649 | /** Name, e.g. "Serial communication". */ | |
650 | char *name; | |
651 | /** Verbose description (unused currently). */ | |
652 | char *description; | |
9a5693a5 BV |
653 | }; |
654 | ||
04cb9157 | 655 | /** Constants for device classes */ |
a1bb33af | 656 | enum { |
e88dadd7 UH |
657 | /*--- Device classes ------------------------------------------------*/ |
658 | ||
659 | /** The device can act as logic analyzer. */ | |
1953564a | 660 | SR_CONF_LOGIC_ANALYZER = 10000, |
925dbf9f | 661 | |
ee7489d2 | 662 | /** The device can act as an oscilloscope. */ |
1953564a | 663 | SR_CONF_OSCILLOSCOPE, |
e88dadd7 | 664 | |
ca3d84cc | 665 | /** The device can act as a multimeter. */ |
1953564a | 666 | SR_CONF_MULTIMETER, |
a141db8c | 667 | |
ca3d84cc | 668 | /** The device is a demo device. */ |
1953564a | 669 | SR_CONF_DEMO_DEV, |
a141db8c | 670 | |
fc19c288 | 671 | /** The device can act as a sound level meter. */ |
1953564a | 672 | SR_CONF_SOUNDLEVELMETER, |
ca3d84cc | 673 | |
40270444 | 674 | /** The device can measure temperature. */ |
1953564a | 675 | SR_CONF_THERMOMETER, |
40270444 BV |
676 | |
677 | /** The device can measure humidity. */ | |
1953564a | 678 | SR_CONF_HYGROMETER, |
40270444 | 679 | |
45315d04 AJ |
680 | /** The device can measure energy consumption. */ |
681 | SR_CONF_ENERGYMETER, | |
682 | ||
32c426d2 BV |
683 | /** The device can demodulate signals. */ |
684 | SR_CONF_DEMODULATOR, | |
685 | ||
471607f0 BV |
686 | /** Programmable power supply. */ |
687 | SR_CONF_POWER_SUPPLY, | |
688 | ||
9a6517d1 | 689 | /*--- Driver scan options -------------------------------------------*/ |
c89c1c9c BV |
690 | |
691 | /** | |
692 | * Specification on how to connect to a device. | |
693 | * | |
1953564a | 694 | * In combination with SR_CONF_SERIALCOMM, this is a serial port in |
c89c1c9c BV |
695 | * the form which makes sense to the OS (e.g., /dev/ttyS0). |
696 | * Otherwise this specifies a USB device, either in the form of | |
697 | * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or | |
698 | * @verbatim <vendorid>.<productid> @endverbatim | |
699 | * (hexadecimal, e.g. 1d6b.0001). | |
700 | */ | |
1953564a | 701 | SR_CONF_CONN = 20000, |
c89c1c9c BV |
702 | |
703 | /** | |
704 | * Serial communication specification, in the form: | |
705 | * | |
706 | * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim | |
707 | * | |
708 | * Example: 9600/8n1 | |
709 | * | |
710 | * The string may also be followed by one or more special settings, | |
711 | * in the form "/key=value". Supported keys and their values are: | |
712 | * | |
713 | * rts 0,1 set the port's RTS pin to low or high | |
714 | * dtr 0,1 set the port's DTR pin to low or high | |
715 | * flow 0 no flow control | |
716 | * 1 hardware-based (RTS/CTS) flow control | |
717 | * 2 software-based (XON/XOFF) flow control | |
c1e45c65 | 718 | * |
c89c1c9c BV |
719 | * This is always an optional parameter, since a driver typically |
720 | * knows the speed at which the device wants to communicate. | |
721 | */ | |
1953564a | 722 | SR_CONF_SERIALCOMM, |
c89c1c9c | 723 | |
ca3d84cc | 724 | /*--- Device configuration ------------------------------------------*/ |
e88dadd7 | 725 | |
7231a145 | 726 | /** The device supports setting its samplerate, in Hz. */ |
1953564a | 727 | SR_CONF_SAMPLERATE = 30000, |
e88dadd7 | 728 | |
e88dadd7 | 729 | /** The device supports setting a pre/post-trigger capture ratio. */ |
1953564a | 730 | SR_CONF_CAPTURE_RATIO, |
e88dadd7 | 731 | |
e88dadd7 | 732 | /** The device supports setting a pattern (pattern generator mode). */ |
1953564a | 733 | SR_CONF_PATTERN_MODE, |
e88dadd7 | 734 | |
3a4d09c0 | 735 | /** The device supports Run Length Encoding. */ |
1953564a | 736 | SR_CONF_RLE, |
3a4d09c0 | 737 | |
ee7489d2 | 738 | /** The device supports setting trigger slope. */ |
1953564a | 739 | SR_CONF_TRIGGER_SLOPE, |
0fe11789 BV |
740 | |
741 | /** Trigger source. */ | |
1953564a | 742 | SR_CONF_TRIGGER_SOURCE, |
0fe11789 | 743 | |
3c0839d5 | 744 | /** Horizontal trigger position. */ |
1953564a | 745 | SR_CONF_HORIZ_TRIGGERPOS, |
0fe11789 BV |
746 | |
747 | /** Buffer size. */ | |
1953564a | 748 | SR_CONF_BUFFERSIZE, |
0fe11789 BV |
749 | |
750 | /** Time base. */ | |
1953564a | 751 | SR_CONF_TIMEBASE, |
ee7489d2 | 752 | |
3c4976c9 | 753 | /** Filter. */ |
1953564a | 754 | SR_CONF_FILTER, |
3c4976c9 | 755 | |
bd8db307 | 756 | /** Volts/div. */ |
1953564a | 757 | SR_CONF_VDIV, |
bd8db307 | 758 | |
e1c8b2ab | 759 | /** Coupling. */ |
1953564a | 760 | SR_CONF_COUPLING, |
e1c8b2ab | 761 | |
c50277a6 BV |
762 | /** Trigger types. */ |
763 | SR_CONF_TRIGGER_TYPE, | |
764 | ||
7231a145 BV |
765 | /** The device supports setting its sample interval, in ms. */ |
766 | SR_CONF_SAMPLE_INTERVAL, | |
767 | ||
2efa699f BV |
768 | /** Number of timebases, as related to SR_CONF_TIMEBASE. */ |
769 | SR_CONF_NUM_TIMEBASE, | |
770 | ||
771 | /** Number of vertical divisions, as related to SR_CONF_VDIV. */ | |
772 | SR_CONF_NUM_VDIV, | |
773 | ||
fd8854c4 BV |
774 | /** Sound pressure level frequency weighting. */ |
775 | SR_CONF_SPL_WEIGHT_FREQ, | |
776 | ||
777 | /** Sound pressure level time weighting. */ | |
778 | SR_CONF_SPL_WEIGHT_TIME, | |
779 | ||
8417ebad BV |
780 | /** Sound pressure level measurement range. */ |
781 | SR_CONF_SPL_MEASUREMENT_RANGE, | |
782 | ||
9fd6bc20 BV |
783 | /** Max hold mode. */ |
784 | SR_CONF_HOLD_MAX, | |
785 | ||
786 | /** Min hold mode. */ | |
787 | SR_CONF_HOLD_MIN, | |
788 | ||
db11d7d2 MC |
789 | /** Logic low-high threshold range. */ |
790 | SR_CONF_VOLTAGE_THRESHOLD, | |
791 | ||
bf90d4c6 | 792 | /** The device supports using an external clock. */ |
d5c5ea2a UH |
793 | SR_CONF_EXTERNAL_CLOCK, |
794 | ||
795 | /** | |
796 | * The device supports swapping channels. Typical this is between | |
797 | * buffered and unbuffered channels. | |
798 | */ | |
799 | SR_CONF_SWAP, | |
800 | ||
bf90d4c6 BV |
801 | /** Center frequency. |
802 | * The input signal is downmixed by this frequency before the ADC | |
803 | * anti-aliasing filter. | |
804 | */ | |
805 | SR_CONF_CENTER_FREQUENCY, | |
806 | ||
807 | /** The device supports setting the number of logic probes. */ | |
808 | SR_CONF_NUM_LOGIC_PROBES, | |
809 | ||
810 | /** The device supports setting the number of analog probes. */ | |
811 | SR_CONF_NUM_ANALOG_PROBES, | |
32c426d2 | 812 | |
471607f0 BV |
813 | /** Output voltage. */ |
814 | SR_CONF_OUTPUT_VOLTAGE, | |
815 | ||
816 | /** Maximum output voltage. */ | |
817 | SR_CONF_OUTPUT_VOLTAGE_MAX, | |
818 | ||
819 | /** Output current. */ | |
820 | SR_CONF_OUTPUT_CURRENT, | |
821 | ||
822 | /** Maximum output current. */ | |
823 | SR_CONF_OUTPUT_CURRENT_MAX, | |
824 | ||
825 | /** Enabling/disabling output. */ | |
826 | SR_CONF_OUTPUT_ENABLED, | |
827 | ||
828 | /** Channel output configuration. */ | |
829 | SR_CONF_OUTPUT_CHANNEL, | |
830 | ||
831 | /** Over-voltage protection (OVP) */ | |
832 | SR_CONF_OVER_VOLTAGE_PROTECTION, | |
833 | ||
834 | /** Over-current protection (OCP) */ | |
835 | SR_CONF_OVER_CURRENT_PROTECTION, | |
836 | ||
e88dadd7 UH |
837 | /*--- Special stuff -------------------------------------------------*/ |
838 | ||
9a6517d1 | 839 | /** Scan options supported by the driver. */ |
aeba33ba | 840 | SR_CONF_SCAN_OPTIONS = 40000, |
9a6517d1 BV |
841 | |
842 | /** Device options for a particular device. */ | |
843 | SR_CONF_DEVICE_OPTIONS, | |
844 | ||
3c0839d5 | 845 | /** Session filename. */ |
aeba33ba | 846 | SR_CONF_SESSIONFILE, |
40dda2c3 | 847 | |
e88dadd7 | 848 | /** The device supports specifying a capturefile to inject. */ |
1953564a | 849 | SR_CONF_CAPTUREFILE, |
925dbf9f | 850 | |
e88dadd7 | 851 | /** The device supports specifying the capturefile unit size. */ |
1953564a | 852 | SR_CONF_CAPTURE_UNITSIZE, |
7d658874 | 853 | |
32de50b7 BV |
854 | /** Power off the device. */ |
855 | SR_CONF_POWER_OFF, | |
856 | ||
d86e0b11 BV |
857 | /** |
858 | * Data source for acquisition. If not present, acquisition from | |
6caeef6e BV |
859 | * the device is always "live", i.e. acquisition starts when the |
860 | * frontend asks and the results are sent out as soon as possible. | |
861 | * | |
862 | * If present, it indicates that either the device has no live | |
863 | * acquisition capability (for example a pure data logger), or | |
864 | * there is a choice. sr_config_list() returns those choices. | |
865 | * | |
866 | * In any case if a device has live acquisition capabilities, it | |
d86e0b11 BV |
867 | * is always the default. |
868 | */ | |
6caeef6e BV |
869 | SR_CONF_DATA_SOURCE, |
870 | ||
e88dadd7 UH |
871 | /*--- Acquisition modes ---------------------------------------------*/ |
872 | ||
873 | /** | |
a02d77bc UH |
874 | * The device supports setting a sample time limit (how long |
875 | * the sample acquisition should run, in ms). | |
e88dadd7 | 876 | */ |
1953564a | 877 | SR_CONF_LIMIT_MSEC = 50000, |
e88dadd7 UH |
878 | |
879 | /** | |
a02d77bc UH |
880 | * The device supports setting a sample number limit (how many |
881 | * samples should be acquired). | |
e88dadd7 | 882 | */ |
1953564a | 883 | SR_CONF_LIMIT_SAMPLES, |
e88dadd7 | 884 | |
6ea7669c | 885 | /** |
a02d77bc UH |
886 | * The device supports setting a frame limit (how many |
887 | * frames should be acquired). | |
6ea7669c | 888 | */ |
1953564a | 889 | SR_CONF_LIMIT_FRAMES, |
6ea7669c | 890 | |
e88dadd7 | 891 | /** |
a02d77bc | 892 | * The device supports continuous sampling. Neither a time limit |
e88dadd7 UH |
893 | * nor a sample number limit has to be supplied, it will just acquire |
894 | * samples continuously, until explicitly stopped by a certain command. | |
895 | */ | |
1953564a | 896 | SR_CONF_CONTINUOUS, |
e6551ea6 BV |
897 | |
898 | /** The device has internal storage, into which data is logged. This | |
899 | * starts or stops the internal logging. */ | |
900 | SR_CONF_DATALOG, | |
a1bb33af UH |
901 | }; |
902 | ||
98582bf5 | 903 | /** Device instance data |
04cb9157 | 904 | */ |
d68e2d1a | 905 | struct sr_dev_inst { |
98582bf5 BV |
906 | /** Device driver. */ |
907 | struct sr_dev_driver *driver; | |
908 | /** Index of device in driver. */ | |
909 | int index; | |
910 | /** Device instance status. SR_ST_NOT_FOUND, etc. */ | |
911 | int status; | |
912 | /** Device instance type. SR_INST_USB, etc. */ | |
913 | int inst_type; | |
914 | /** Device vendor. */ | |
915 | char *vendor; | |
916 | /** Device model. */ | |
917 | char *model; | |
918 | /** Device version. */ | |
919 | char *version; | |
920 | /** List of probes. */ | |
921 | GSList *probes; | |
922 | /** List of sr_probe_group structs */ | |
923 | GSList *probe_groups; | |
924 | /** Device instance connection data (used?) */ | |
925 | void *conn; | |
926 | /** Device instance private data (used?) */ | |
927 | void *priv; | |
a1bb33af UH |
928 | }; |
929 | ||
04cb9157 | 930 | /** Types of device instance, struct sr_dev_inst.type */ |
a1bb33af | 931 | enum { |
4101f961 | 932 | /** Device instance type for USB devices. */ |
24d04d1e | 933 | SR_INST_USB = 10000, |
4101f961 UH |
934 | /** Device instance type for serial port devices. */ |
935 | SR_INST_SERIAL, | |
23f43dff ML |
936 | /** Device instance type for SCPI devices. */ |
937 | SR_INST_SCPI, | |
a1bb33af UH |
938 | }; |
939 | ||
04cb9157 | 940 | /** Device instance status, struct sr_dev_inst.status */ |
a1bb33af | 941 | enum { |
3c0839d5 | 942 | /** The device instance was not found. */ |
24d04d1e | 943 | SR_ST_NOT_FOUND = 10000, |
3c0839d5 | 944 | /** The device instance was found, but is still booting. */ |
5a2326a7 | 945 | SR_ST_INITIALIZING, |
3c0839d5 | 946 | /** The device instance is live, but not in use. */ |
5a2326a7 | 947 | SR_ST_INACTIVE, |
3c0839d5 | 948 | /** The device instance is actively in use in a session. */ |
5a2326a7 | 949 | SR_ST_ACTIVE, |
69b07d14 BV |
950 | /** The device is winding down its session. */ |
951 | SR_ST_STOPPING, | |
a1bb33af UH |
952 | }; |
953 | ||
04cb9157 | 954 | /** Device driver data */ |
c09f0b57 UH |
955 | struct sr_dev_driver { |
956 | /* Driver-specific */ | |
98582bf5 BV |
957 | /** Driver name */ |
958 | char *name; | |
959 | /** Long name, e.g. device name. */ | |
960 | char *longname; | |
961 | /** API version (currently 1). */ | |
962 | int api_version; | |
963 | /** Init driver */ | |
964 | int (*init) (struct sr_context *sr_ctx); | |
965 | /** Free driver */ | |
966 | int (*cleanup) (void); | |
967 | /** Scan for devices */ | |
968 | GSList *(*scan) (GSList *options); | |
969 | /** Get device list */ | |
970 | GSList *(*dev_list) (void); | |
811deee4 | 971 | int (*dev_clear) (void); |
bc1c2f00 | 972 | int (*config_get) (int id, GVariant **data, |
8f996b89 ML |
973 | const struct sr_dev_inst *sdi, |
974 | const struct sr_probe_group *probe_group); | |
bc1c2f00 | 975 | int (*config_set) (int id, GVariant *data, |
8f996b89 ML |
976 | const struct sr_dev_inst *sdi, |
977 | const struct sr_probe_group *probe_group); | |
bc1c2f00 | 978 | int (*config_list) (int info_id, GVariant **data, |
8f996b89 ML |
979 | const struct sr_dev_inst *sdi, |
980 | const struct sr_probe_group *probe_group); | |
a1bb33af | 981 | |
1b452b85 | 982 | /* Device-specific */ |
98582bf5 BV |
983 | /** Open device */ |
984 | int (*dev_open) (struct sr_dev_inst *sdi); | |
985 | /** Close device */ | |
986 | int (*dev_close) (struct sr_dev_inst *sdi); | |
987 | /** Start data aquisition. */ | |
3ffb6964 | 988 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
98582bf5 BV |
989 | void *cb_data); |
990 | /** Stop data aquisition. */ | |
69b07d14 | 991 | int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, |
98582bf5 | 992 | void *cb_data); |
dd34b8d3 BV |
993 | |
994 | /* Dynamic */ | |
98582bf5 BV |
995 | /** Device driver private data */ |
996 | void *priv; | |
a1bb33af UH |
997 | }; |
998 | ||
e2b23821 | 999 | /** |
df823ac4 UH |
1000 | * @struct sr_session |
1001 | * | |
e2b23821 UH |
1002 | * Opaque data structure representing a libsigrok session. None of the fields |
1003 | * of this structure are meant to be accessed directly. | |
1004 | */ | |
1005 | struct sr_session; | |
a1bb33af | 1006 | |
45c59c8b BV |
1007 | #include "proto.h" |
1008 | #include "version.h" | |
c2bd92ec | 1009 | |
a00b530c UH |
1010 | #ifdef __cplusplus |
1011 | } | |
1012 | #endif | |
1013 | ||
a1bb33af | 1014 | #endif |