]>
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 | ||
0f8522bf UH |
20 | #ifndef LIBSIGROK_SIGROK_H |
21 | #define LIBSIGROK_SIGROK_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 | * | |
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 | |
1f9813eb | 134 | typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data); |
882e2075 | 135 | |
08a9260b | 136 | /** Data types used by sr_config_info(). */ |
a1bb33af | 137 | enum { |
24d04d1e | 138 | SR_T_UINT64 = 10000, |
5a2326a7 | 139 | SR_T_CHAR, |
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, |
0fe11789 BV |
147 | }; |
148 | ||
3c0839d5 | 149 | /** Value for sr_datafeed_packet.type. */ |
a1bb33af | 150 | enum { |
24d04d1e | 151 | SR_DF_HEADER = 10000, |
5a2326a7 | 152 | SR_DF_END, |
9a5693a5 | 153 | SR_DF_META, |
5a2326a7 UH |
154 | SR_DF_TRIGGER, |
155 | SR_DF_LOGIC, | |
ee7489d2 | 156 | SR_DF_ANALOG, |
6ea7669c BV |
157 | SR_DF_FRAME_BEGIN, |
158 | SR_DF_FRAME_END, | |
a1bb33af UH |
159 | }; |
160 | ||
3c0839d5 | 161 | /** Values for sr_datafeed_analog.mq. */ |
9956f285 | 162 | enum { |
24d04d1e | 163 | SR_MQ_VOLTAGE = 10000, |
9956f285 UH |
164 | SR_MQ_CURRENT, |
165 | SR_MQ_RESISTANCE, | |
166 | SR_MQ_CAPACITANCE, | |
167 | SR_MQ_TEMPERATURE, | |
168 | SR_MQ_FREQUENCY, | |
169 | SR_MQ_DUTY_CYCLE, | |
64591be2 | 170 | SR_MQ_CONTINUITY, |
aa839a5c | 171 | SR_MQ_PULSE_WIDTH, |
96b3b3d5 | 172 | SR_MQ_CONDUCTANCE, |
3c0839d5 | 173 | /** Electrical power, usually in W, or dBm. */ |
b82a17d3 | 174 | SR_MQ_POWER, |
a02d77bc | 175 | /** Gain (a transistor's gain, or hFE, for example). */ |
b82a17d3 | 176 | SR_MQ_GAIN, |
fc19c288 BV |
177 | /** Logarithmic representation of sound pressure relative to a |
178 | * reference value. */ | |
179 | SR_MQ_SOUND_PRESSURE_LEVEL, | |
4f3bd685 | 180 | SR_MQ_CARBON_MONOXIDE, |
ef4344e7 | 181 | SR_MQ_RELATIVE_HUMIDITY, |
9956f285 UH |
182 | }; |
183 | ||
3c0839d5 | 184 | /** Values for sr_datafeed_analog.unit. */ |
aff5a729 | 185 | enum { |
24d04d1e | 186 | SR_UNIT_VOLT = 10000, |
9956f285 UH |
187 | SR_UNIT_AMPERE, |
188 | SR_UNIT_OHM, | |
189 | SR_UNIT_FARAD, | |
9956f285 | 190 | SR_UNIT_KELVIN, |
edb000eb BV |
191 | SR_UNIT_CELSIUS, |
192 | SR_UNIT_FAHRENHEIT, | |
9956f285 UH |
193 | SR_UNIT_HERTZ, |
194 | SR_UNIT_PERCENTAGE, | |
edb000eb | 195 | SR_UNIT_BOOLEAN, |
aa839a5c | 196 | SR_UNIT_SECOND, |
3c0839d5 | 197 | /** Unit of conductance, the inverse of resistance. */ |
96b3b3d5 | 198 | SR_UNIT_SIEMENS, |
3c0839d5 UH |
199 | /** |
200 | * An absolute measurement of power, in decibels, referenced to | |
201 | * 1 milliwatt (dBu). | |
202 | */ | |
b82a17d3 | 203 | SR_UNIT_DECIBEL_MW, |
6b869234 BV |
204 | /** Voltage in decibel, referenced to 1 volt (dBV). */ |
205 | SR_UNIT_DECIBEL_VOLT, | |
3c0839d5 UH |
206 | /** |
207 | * Measurements that intrinsically do not have units attached, such | |
6b869234 | 208 | * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is |
3c0839d5 UH |
209 | * a unitless quantity, for example. |
210 | */ | |
b82a17d3 | 211 | SR_UNIT_UNITLESS, |
fc19c288 BV |
212 | /** Sound pressure level relative so 20 micropascals. */ |
213 | SR_UNIT_DECIBEL_SPL, | |
801c7800 AG |
214 | /** |
215 | * Normalized (0 to 1) concentration of a substance or compound with 0 | |
216 | * representing a concentration of 0%, and 1 being 100%. This is | |
217 | * represented as the fraction of number of particles of the substance. | |
218 | */ | |
4f3bd685 | 219 | SR_UNIT_CONCENTRATION, |
87532f23 | 220 | SR_UNIT_REVOLUTIONS_PER_MINUTE, |
45315d04 AJ |
221 | SR_UNIT_VOLT_AMPERE, |
222 | SR_UNIT_WATT, | |
223 | SR_UNIT_WATT_HOUR, | |
aff5a729 BV |
224 | }; |
225 | ||
3c0839d5 | 226 | /** Values for sr_datafeed_analog.flags. */ |
02e864d0 | 227 | enum { |
3c0839d5 | 228 | /** Voltage measurement is alternating current (AC). */ |
02e864d0 | 229 | SR_MQFLAG_AC = 0x01, |
3c0839d5 | 230 | /** Voltage measurement is direct current (DC). */ |
02e864d0 BV |
231 | SR_MQFLAG_DC = 0x02, |
232 | /** This is a true RMS measurement. */ | |
233 | SR_MQFLAG_RMS = 0x04, | |
234 | /** Value is voltage drop across a diode, or NAN. */ | |
235 | SR_MQFLAG_DIODE = 0x08, | |
a02d77bc | 236 | /** Device is in "hold" mode (repeating the last measurement). */ |
02e864d0 | 237 | SR_MQFLAG_HOLD = 0x10, |
3c0839d5 | 238 | /** Device is in "max" mode, only updating upon a new max value. */ |
02e864d0 | 239 | SR_MQFLAG_MAX = 0x20, |
3c0839d5 | 240 | /** Device is in "min" mode, only updating upon a new min value. */ |
02e864d0 BV |
241 | SR_MQFLAG_MIN = 0x40, |
242 | /** Device is in autoranging mode. */ | |
243 | SR_MQFLAG_AUTORANGE = 0x80, | |
244 | /** Device is in relative mode. */ | |
245 | SR_MQFLAG_RELATIVE = 0x100, | |
fc19c288 | 246 | /** Sound pressure level is A-weighted in the frequency domain, |
2244356d | 247 | * according to IEC 61672:2003. */ |
fc19c288 BV |
248 | SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200, |
249 | /** Sound pressure level is C-weighted in the frequency domain, | |
2244356d | 250 | * according to IEC 61672:2003. */ |
fc19c288 BV |
251 | SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400, |
252 | /** Sound pressure level is Z-weighted (i.e. not at all) in the | |
2244356d | 253 | * frequency domain, according to IEC 61672:2003. */ |
fc19c288 BV |
254 | SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800, |
255 | /** Sound pressure level is not weighted in the frequency domain, | |
256 | * albeit without standards-defined low and high frequency limits. */ | |
257 | SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000, | |
258 | /** Sound pressure level measurement is S-weighted (1s) in the | |
259 | * time domain. */ | |
260 | SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000, | |
261 | /** Sound pressure level measurement is F-weighted (125ms) in the | |
262 | * time domain. */ | |
263 | SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000, | |
264 | /** Sound pressure level is time-averaged (LAT), also known as | |
265 | * Equivalent Continuous A-weighted Sound Level (LEQ). */ | |
266 | SR_MQFLAG_SPL_LAT = 0x8000, | |
267 | /** Sound pressure level represented as a percentage of measurements | |
268 | * that were over a preset alarm level. */ | |
269 | SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000, | |
02e864d0 BV |
270 | }; |
271 | ||
b8072700 PS |
272 | struct sr_context; |
273 | ||
b9c735a2 | 274 | struct sr_datafeed_packet { |
a1bb33af | 275 | uint16_t type; |
bf53457d | 276 | const void *payload; |
a1bb33af UH |
277 | }; |
278 | ||
b9c735a2 | 279 | struct sr_datafeed_header { |
a1bb33af UH |
280 | int feed_version; |
281 | struct timeval starttime; | |
ee7489d2 BV |
282 | }; |
283 | ||
9a5693a5 BV |
284 | struct sr_datafeed_meta { |
285 | GSList *config; | |
286 | }; | |
287 | ||
38ab3ee7 BV |
288 | struct sr_datafeed_logic { |
289 | uint64_t length; | |
290 | uint16_t unitsize; | |
9c939c51 | 291 | void *data; |
38ab3ee7 BV |
292 | }; |
293 | ||
ee7489d2 | 294 | struct sr_datafeed_analog { |
aeba33ba | 295 | /** The probes for which data is included in this packet. */ |
69e19dd7 | 296 | GSList *probes; |
ee7489d2 | 297 | int num_samples; |
a02d77bc | 298 | /** Measured quantity (voltage, current, temperature, and so on). */ |
02e864d0 BV |
299 | int mq; |
300 | /** Unit in which the MQ is measured. */ | |
301 | int unit; | |
302 | /** Bitmap with extra information about the MQ. */ | |
303 | uint64_t mqflags; | |
aeba33ba BV |
304 | /** The analog value(s). The data is interleaved according to |
305 | * the probes list. */ | |
ee7489d2 BV |
306 | float *data; |
307 | }; | |
308 | ||
83687343 | 309 | /** Input (file) format struct. */ |
f50f3f40 | 310 | struct sr_input { |
83687343 UH |
311 | /** |
312 | * A pointer to this input format's 'struct sr_input_format'. | |
313 | * The frontend can use this to call the module's callbacks. | |
314 | */ | |
f50f3f40 | 315 | struct sr_input_format *format; |
83687343 | 316 | |
3dafb92b | 317 | GHashTable *param; |
83687343 | 318 | |
5c3c1241 | 319 | struct sr_dev_inst *sdi; |
83687343 | 320 | |
3dafb92b | 321 | void *internal; |
34e4813f BV |
322 | }; |
323 | ||
f50f3f40 | 324 | struct sr_input_format { |
83687343 | 325 | /** The unique ID for this input format. Must not be NULL. */ |
cdb3573c | 326 | char *id; |
83687343 UH |
327 | |
328 | /** | |
329 | * A short description of the input format, which can (for example) | |
330 | * be displayed to the user by frontends. Must not be NULL. | |
331 | */ | |
34e4813f | 332 | char *description; |
83687343 UH |
333 | |
334 | /** | |
335 | * Check if this input module can load and parse the specified file. | |
336 | * | |
337 | * @param filename The name (and path) of the file to check. | |
338 | * | |
339 | * @return TRUE if this module knows the format, FALSE if it doesn't. | |
340 | */ | |
757b8c62 | 341 | int (*format_match) (const char *filename); |
83687343 UH |
342 | |
343 | /** | |
344 | * Initialize the input module. | |
345 | * | |
346 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
347 | * has to allocate and provide to this function. It is also | |
348 | * the responsibility of the caller to free it later. | |
349 | * @param filename The name (and path) of the file to use. | |
350 | * | |
351 | * @return SR_OK upon success, a negative error code upon failure. | |
352 | */ | |
543d45c5 | 353 | int (*init) (struct sr_input *in, const char *filename); |
83687343 UH |
354 | |
355 | /** | |
356 | * Load a file, parsing the input according to the file's format. | |
357 | * | |
358 | * This function will send datafeed packets to the session bus, so | |
359 | * the calling frontend must have registered its session callbacks | |
360 | * beforehand. | |
361 | * | |
362 | * The packet types sent across the session bus by this function must | |
363 | * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data | |
364 | * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet | |
365 | * if appropriate. | |
366 | * | |
367 | * @param in A pointer to a valid 'struct sr_input' that the caller | |
368 | * has to allocate and provide to this function. It is also | |
369 | * the responsibility of the caller to free it later. | |
370 | * @param filename The name (and path) of the file to use. | |
371 | * | |
372 | * @return SR_OK upon success, a negative error code upon failure. | |
373 | */ | |
f50f3f40 | 374 | int (*loadfile) (struct sr_input *in, const char *filename); |
34e4813f BV |
375 | }; |
376 | ||
07e1aad5 | 377 | /** Output (file) format struct. */ |
f50f3f40 | 378 | struct sr_output { |
07e1aad5 UH |
379 | /** |
380 | * A pointer to this output format's 'struct sr_output_format'. | |
381 | * The frontend can use this to call the module's callbacks. | |
382 | */ | |
f50f3f40 | 383 | struct sr_output_format *format; |
07e1aad5 UH |
384 | |
385 | /** | |
386 | * The device for which this output module is creating output. This | |
387 | * can be used by the module to find out probe names and numbers. | |
388 | */ | |
5c3c1241 | 389 | struct sr_dev_inst *sdi; |
07e1aad5 UH |
390 | |
391 | /** | |
392 | * An optional parameter which the frontend can pass in to the | |
393 | * output module. How the string is interpreted is entirely up to | |
394 | * the module. | |
395 | */ | |
a1bb33af | 396 | char *param; |
07e1aad5 UH |
397 | |
398 | /** | |
399 | * A generic pointer which can be used by the module to keep internal | |
400 | * state between calls into its callback functions. | |
401 | * | |
402 | * For example, the module might store a pointer to a chunk of output | |
403 | * there, and only flush it when it reaches a certain size. | |
404 | */ | |
a1bb33af UH |
405 | void *internal; |
406 | }; | |
407 | ||
f50f3f40 | 408 | struct sr_output_format { |
07e1aad5 UH |
409 | /** |
410 | * A unique ID for this output format. Must not be NULL. | |
411 | * | |
412 | * It can be used by frontends to select this output format for use. | |
413 | * | |
414 | * For example, calling sigrok-cli with <code>-O hex</code> will | |
415 | * select the hexadecimal text output format. | |
416 | */ | |
cdb3573c | 417 | char *id; |
07e1aad5 UH |
418 | |
419 | /** | |
420 | * A short description of the output format. Must not be NULL. | |
421 | * | |
422 | * This can be displayed by frontends, e.g. when selecting the output | |
423 | * format for saving a file. | |
424 | */ | |
a1bb33af | 425 | char *description; |
07e1aad5 | 426 | |
f0411b1d | 427 | int df_type; |
07e1aad5 UH |
428 | |
429 | /** | |
430 | * This function is called once, at the beginning of an output stream. | |
431 | * | |
432 | * The device struct will be available in the output struct passed in, | |
433 | * as well as the param field -- which may be NULL or an empty string, | |
434 | * if no parameter was passed. | |
435 | * | |
436 | * The module can use this to initialize itself, create a struct for | |
437 | * keeping state and storing it in the <code>internal</code> field. | |
438 | * | |
439 | * @param o Pointer to the respective 'struct sr_output'. | |
440 | * | |
441 | * @return SR_OK upon success, a negative error code otherwise. | |
442 | */ | |
f50f3f40 | 443 | int (*init) (struct sr_output *o); |
07e1aad5 UH |
444 | |
445 | /** | |
446 | * Whenever a chunk of data comes in, it will be passed to the | |
447 | * output module via this function. The <code>data_in</code> and | |
448 | * <code>length_in</code> values refers to this data; the module | |
449 | * must not alter or g_free() this buffer. | |
450 | * | |
451 | * The function must allocate a buffer for storing its output, and | |
452 | * pass along a pointer to this buffer in the <code>data_out</code> | |
453 | * parameter, as well as storing the length of the buffer in | |
454 | * <code>length_out</code>. The calling frontend will g_free() | |
455 | * this buffer when it's done with it. | |
456 | * | |
457 | * IMPORTANT: The memory allocation much happen using a glib memory | |
458 | * allocation call (not a "normal" malloc) since g_free() will be | |
459 | * used to free the memory! | |
460 | * | |
461 | * If there is no output, this function MUST store NULL in the | |
462 | * <code>data_out</code> parameter, so the caller knows not to try | |
463 | * and g_free() it. | |
464 | * | |
17f63de6 | 465 | * Note: This API call is obsolete, use receive() instead. |
07e1aad5 UH |
466 | * |
467 | * @param o Pointer to the respective 'struct sr_output'. | |
468 | * @param data_in Pointer to the input data buffer. | |
469 | * @param length_in Length of the input. | |
470 | * @param data_out Pointer to the allocated output buffer. | |
471 | * @param length_out Length (in bytes) of the output. | |
472 | * | |
473 | * @return SR_OK upon success, a negative error code otherwise. | |
474 | */ | |
054e6709 UH |
475 | int (*data) (struct sr_output *o, const uint8_t *data_in, |
476 | uint64_t length_in, uint8_t **data_out, | |
477 | uint64_t *length_out); | |
07e1aad5 UH |
478 | |
479 | /** | |
480 | * This function is called when an event occurs in the datafeed | |
481 | * which the output module may need to be aware of. No data is | |
482 | * passed in, only the fact that the event occurs. The following | |
483 | * events can currently be passed in: | |
484 | * | |
485 | * - SR_DF_TRIGGER: At this point in the datafeed, the trigger | |
486 | * matched. The output module may mark this in some way, e.g. by | |
487 | * plotting a red line on a graph. | |
488 | * | |
489 | * - SR_DF_END: This marks the end of the datafeed. No more calls | |
490 | * into the output module will be done, so this is a good time to | |
491 | * free up any memory used to keep state, for example. | |
492 | * | |
493 | * Any output generated by this function must have a reference to | |
494 | * it stored in the <code>data_out</code> and <code>length_out</code> | |
495 | * parameters, or NULL if no output was generated. | |
496 | * | |
17f63de6 | 497 | * Note: This API call is obsolete, use receive() instead. |
07e1aad5 UH |
498 | * |
499 | * @param o Pointer to the respective 'struct sr_output'. | |
500 | * @param event_type Type of event that occured. | |
501 | * @param data_out Pointer to the allocated output buffer. | |
502 | * @param length_out Length (in bytes) of the output. | |
503 | * | |
504 | * @return SR_OK upon success, a negative error code otherwise. | |
505 | */ | |
054e6709 | 506 | int (*event) (struct sr_output *o, int event_type, uint8_t **data_out, |
17f63de6 | 507 | uint64_t *length_out); |
07e1aad5 | 508 | |
17f63de6 BV |
509 | /** |
510 | * This function is passed a copy of every packed in the data feed. | |
511 | * Any output generated by the output module in response to the | |
512 | * packet should be returned in a newly allocated GString | |
513 | * <code>out</code>, which will be freed by the caller. | |
514 | * | |
515 | * Packets not of interest to the output module can just be ignored, | |
516 | * and the <code>out</code> parameter set to NULL. | |
517 | * | |
518 | * @param o Pointer to the respective 'struct sr_output'. | |
519 | * @param sdi The device instance that generated the packet. | |
520 | * @param packet The complete packet. | |
521 | * @param out A pointer where a GString * should be stored if | |
522 | * the module generates output, or NULL if not. | |
523 | * | |
524 | * @return SR_OK upon success, a negative error code otherwise. | |
525 | */ | |
526 | int (*receive) (struct sr_output *o, const struct sr_dev_inst *sdi, | |
527 | const struct sr_datafeed_packet *packet, GString **out); | |
07e1aad5 | 528 | |
17f63de6 BV |
529 | /** |
530 | * This function is called after the caller is finished using | |
531 | * the output module, and can be used to free any internal | |
532 | * resources the module may keep. | |
533 | * | |
534 | * @return SR_OK upon success, a negative error code otherwise. | |
535 | */ | |
f45b7590 | 536 | int (*cleanup) (struct sr_output *o); |
a1bb33af UH |
537 | }; |
538 | ||
921e753f | 539 | enum { |
24d04d1e | 540 | SR_PROBE_LOGIC = 10000, |
87ca93c5 | 541 | SR_PROBE_ANALOG, |
921e753f DR |
542 | }; |
543 | ||
1afe8989 | 544 | struct sr_probe { |
08a9260b | 545 | /* The index field will go: use g_slist_length(sdi->probes) instead. */ |
a1bb33af | 546 | int index; |
6ea7e235 | 547 | int type; |
a1bb33af UH |
548 | gboolean enabled; |
549 | char *name; | |
550 | char *trigger; | |
551 | }; | |
552 | ||
a0dc461d | 553 | /** Structure for groups of probes that have common properties. */ |
8f996b89 | 554 | struct sr_probe_group { |
a0dc461d | 555 | /** Name of the probe group. */ |
5150ef33 | 556 | char *name; |
a0dc461d | 557 | /** List of sr_probe structs of the probes belonging to this group. */ |
8f996b89 | 558 | GSList *probes; |
a0dc461d | 559 | /** Private data for driver use. */ |
5daed4bc | 560 | void *priv; |
8f996b89 ML |
561 | }; |
562 | ||
9a5693a5 BV |
563 | struct sr_config { |
564 | int key; | |
bc1c2f00 | 565 | GVariant *data; |
b159add3 BV |
566 | }; |
567 | ||
9a5693a5 BV |
568 | struct sr_config_info { |
569 | int key; | |
fbf394c6 | 570 | int datatype; |
9a5693a5 BV |
571 | char *id; |
572 | char *name; | |
573 | char *description; | |
9a5693a5 BV |
574 | }; |
575 | ||
a1bb33af | 576 | enum { |
e88dadd7 UH |
577 | /*--- Device classes ------------------------------------------------*/ |
578 | ||
579 | /** The device can act as logic analyzer. */ | |
1953564a | 580 | SR_CONF_LOGIC_ANALYZER = 10000, |
925dbf9f | 581 | |
ee7489d2 | 582 | /** The device can act as an oscilloscope. */ |
1953564a | 583 | SR_CONF_OSCILLOSCOPE, |
e88dadd7 | 584 | |
ca3d84cc | 585 | /** The device can act as a multimeter. */ |
1953564a | 586 | SR_CONF_MULTIMETER, |
a141db8c | 587 | |
ca3d84cc | 588 | /** The device is a demo device. */ |
1953564a | 589 | SR_CONF_DEMO_DEV, |
a141db8c | 590 | |
fc19c288 | 591 | /** The device can act as a sound level meter. */ |
1953564a | 592 | SR_CONF_SOUNDLEVELMETER, |
ca3d84cc | 593 | |
40270444 | 594 | /** The device can measure temperature. */ |
1953564a | 595 | SR_CONF_THERMOMETER, |
40270444 BV |
596 | |
597 | /** The device can measure humidity. */ | |
1953564a | 598 | SR_CONF_HYGROMETER, |
40270444 | 599 | |
45315d04 AJ |
600 | /** The device can measure energy consumption. */ |
601 | SR_CONF_ENERGYMETER, | |
602 | ||
9a6517d1 | 603 | /*--- Driver scan options -------------------------------------------*/ |
c89c1c9c BV |
604 | |
605 | /** | |
606 | * Specification on how to connect to a device. | |
607 | * | |
1953564a | 608 | * In combination with SR_CONF_SERIALCOMM, this is a serial port in |
c89c1c9c BV |
609 | * the form which makes sense to the OS (e.g., /dev/ttyS0). |
610 | * Otherwise this specifies a USB device, either in the form of | |
611 | * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or | |
612 | * @verbatim <vendorid>.<productid> @endverbatim | |
613 | * (hexadecimal, e.g. 1d6b.0001). | |
614 | */ | |
1953564a | 615 | SR_CONF_CONN = 20000, |
c89c1c9c BV |
616 | |
617 | /** | |
618 | * Serial communication specification, in the form: | |
619 | * | |
620 | * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim | |
621 | * | |
622 | * Example: 9600/8n1 | |
623 | * | |
624 | * The string may also be followed by one or more special settings, | |
625 | * in the form "/key=value". Supported keys and their values are: | |
626 | * | |
627 | * rts 0,1 set the port's RTS pin to low or high | |
628 | * dtr 0,1 set the port's DTR pin to low or high | |
629 | * flow 0 no flow control | |
630 | * 1 hardware-based (RTS/CTS) flow control | |
631 | * 2 software-based (XON/XOFF) flow control | |
632 | * | |
633 | * This is always an optional parameter, since a driver typically | |
634 | * knows the speed at which the device wants to communicate. | |
635 | */ | |
1953564a | 636 | SR_CONF_SERIALCOMM, |
c89c1c9c | 637 | |
ca3d84cc | 638 | /*--- Device configuration ------------------------------------------*/ |
e88dadd7 | 639 | |
7231a145 | 640 | /** The device supports setting its samplerate, in Hz. */ |
1953564a | 641 | SR_CONF_SAMPLERATE = 30000, |
e88dadd7 | 642 | |
e88dadd7 | 643 | /** The device supports setting a pre/post-trigger capture ratio. */ |
1953564a | 644 | SR_CONF_CAPTURE_RATIO, |
e88dadd7 | 645 | |
e88dadd7 | 646 | /** The device supports setting a pattern (pattern generator mode). */ |
1953564a | 647 | SR_CONF_PATTERN_MODE, |
e88dadd7 | 648 | |
3a4d09c0 | 649 | /** The device supports Run Length Encoding. */ |
1953564a | 650 | SR_CONF_RLE, |
3a4d09c0 | 651 | |
ee7489d2 | 652 | /** The device supports setting trigger slope. */ |
1953564a | 653 | SR_CONF_TRIGGER_SLOPE, |
0fe11789 BV |
654 | |
655 | /** Trigger source. */ | |
1953564a | 656 | SR_CONF_TRIGGER_SOURCE, |
0fe11789 | 657 | |
3c0839d5 | 658 | /** Horizontal trigger position. */ |
1953564a | 659 | SR_CONF_HORIZ_TRIGGERPOS, |
0fe11789 BV |
660 | |
661 | /** Buffer size. */ | |
1953564a | 662 | SR_CONF_BUFFERSIZE, |
0fe11789 BV |
663 | |
664 | /** Time base. */ | |
1953564a | 665 | SR_CONF_TIMEBASE, |
ee7489d2 | 666 | |
3c4976c9 | 667 | /** Filter. */ |
1953564a | 668 | SR_CONF_FILTER, |
3c4976c9 | 669 | |
bd8db307 | 670 | /** Volts/div. */ |
1953564a | 671 | SR_CONF_VDIV, |
bd8db307 | 672 | |
e1c8b2ab | 673 | /** Coupling. */ |
1953564a | 674 | SR_CONF_COUPLING, |
e1c8b2ab | 675 | |
c50277a6 BV |
676 | /** Trigger types. */ |
677 | SR_CONF_TRIGGER_TYPE, | |
678 | ||
7231a145 BV |
679 | /** The device supports setting its sample interval, in ms. */ |
680 | SR_CONF_SAMPLE_INTERVAL, | |
681 | ||
2efa699f BV |
682 | /** Number of timebases, as related to SR_CONF_TIMEBASE. */ |
683 | SR_CONF_NUM_TIMEBASE, | |
684 | ||
685 | /** Number of vertical divisions, as related to SR_CONF_VDIV. */ | |
686 | SR_CONF_NUM_VDIV, | |
687 | ||
fd8854c4 BV |
688 | /** Sound pressure level frequency weighting. */ |
689 | SR_CONF_SPL_WEIGHT_FREQ, | |
690 | ||
691 | /** Sound pressure level time weighting. */ | |
692 | SR_CONF_SPL_WEIGHT_TIME, | |
693 | ||
8417ebad BV |
694 | /** Sound pressure level measurement range. */ |
695 | SR_CONF_SPL_MEASUREMENT_RANGE, | |
696 | ||
9fd6bc20 BV |
697 | /** Max hold mode. */ |
698 | SR_CONF_HOLD_MAX, | |
699 | ||
700 | /** Min hold mode. */ | |
701 | SR_CONF_HOLD_MIN, | |
702 | ||
db11d7d2 MC |
703 | /** Logic low-high threshold range. */ |
704 | SR_CONF_VOLTAGE_THRESHOLD, | |
705 | ||
d5c5ea2a UH |
706 | /** The device supports using a external clock. */ |
707 | SR_CONF_EXTERNAL_CLOCK, | |
708 | ||
709 | /** | |
710 | * The device supports swapping channels. Typical this is between | |
711 | * buffered and unbuffered channels. | |
712 | */ | |
713 | SR_CONF_SWAP, | |
714 | ||
e88dadd7 UH |
715 | /*--- Special stuff -------------------------------------------------*/ |
716 | ||
9a6517d1 | 717 | /** Scan options supported by the driver. */ |
aeba33ba | 718 | SR_CONF_SCAN_OPTIONS = 40000, |
9a6517d1 BV |
719 | |
720 | /** Device options for a particular device. */ | |
721 | SR_CONF_DEVICE_OPTIONS, | |
722 | ||
3c0839d5 | 723 | /** Session filename. */ |
aeba33ba | 724 | SR_CONF_SESSIONFILE, |
40dda2c3 | 725 | |
e88dadd7 | 726 | /** The device supports specifying a capturefile to inject. */ |
1953564a | 727 | SR_CONF_CAPTUREFILE, |
925dbf9f | 728 | |
e88dadd7 | 729 | /** The device supports specifying the capturefile unit size. */ |
1953564a | 730 | SR_CONF_CAPTURE_UNITSIZE, |
7d658874 | 731 | |
e88dadd7 | 732 | /** The device supports setting the number of probes. */ |
1953564a | 733 | SR_CONF_CAPTURE_NUM_PROBES, |
e88dadd7 | 734 | |
32de50b7 BV |
735 | /** Power off the device. */ |
736 | SR_CONF_POWER_OFF, | |
737 | ||
6caeef6e BV |
738 | /** Data source for acquisition. If not present, acquisition from |
739 | * the device is always "live", i.e. acquisition starts when the | |
740 | * frontend asks and the results are sent out as soon as possible. | |
741 | * | |
742 | * If present, it indicates that either the device has no live | |
743 | * acquisition capability (for example a pure data logger), or | |
744 | * there is a choice. sr_config_list() returns those choices. | |
745 | * | |
746 | * In any case if a device has live acquisition capabilities, it | |
747 | * is always the default. */ | |
748 | SR_CONF_DATA_SOURCE, | |
749 | ||
e88dadd7 UH |
750 | /*--- Acquisition modes ---------------------------------------------*/ |
751 | ||
752 | /** | |
a02d77bc UH |
753 | * The device supports setting a sample time limit (how long |
754 | * the sample acquisition should run, in ms). | |
e88dadd7 | 755 | */ |
1953564a | 756 | SR_CONF_LIMIT_MSEC = 50000, |
e88dadd7 UH |
757 | |
758 | /** | |
a02d77bc UH |
759 | * The device supports setting a sample number limit (how many |
760 | * samples should be acquired). | |
e88dadd7 | 761 | */ |
1953564a | 762 | SR_CONF_LIMIT_SAMPLES, |
e88dadd7 | 763 | |
6ea7669c | 764 | /** |
a02d77bc UH |
765 | * The device supports setting a frame limit (how many |
766 | * frames should be acquired). | |
6ea7669c | 767 | */ |
1953564a | 768 | SR_CONF_LIMIT_FRAMES, |
6ea7669c | 769 | |
e88dadd7 | 770 | /** |
a02d77bc | 771 | * The device supports continuous sampling. Neither a time limit |
e88dadd7 UH |
772 | * nor a sample number limit has to be supplied, it will just acquire |
773 | * samples continuously, until explicitly stopped by a certain command. | |
774 | */ | |
1953564a | 775 | SR_CONF_CONTINUOUS, |
e6551ea6 BV |
776 | |
777 | /** The device has internal storage, into which data is logged. This | |
778 | * starts or stops the internal logging. */ | |
779 | SR_CONF_DATALOG, | |
a1bb33af UH |
780 | }; |
781 | ||
d68e2d1a | 782 | struct sr_dev_inst { |
9e41fdba | 783 | struct sr_dev_driver *driver; |
a1bb33af UH |
784 | int index; |
785 | int status; | |
1d9a8a5f | 786 | int inst_type; |
a1bb33af UH |
787 | char *vendor; |
788 | char *model; | |
789 | char *version; | |
47211d65 | 790 | GSList *probes; |
8f996b89 ML |
791 | /* List of sr_probe_group structs */ |
792 | GSList *probe_groups; | |
9e2e9864 | 793 | void *conn; |
8d672550 | 794 | void *priv; |
a1bb33af UH |
795 | }; |
796 | ||
3c0839d5 | 797 | /** Types of device instances (sr_dev_inst). */ |
a1bb33af | 798 | enum { |
4101f961 | 799 | /** Device instance type for USB devices. */ |
24d04d1e | 800 | SR_INST_USB = 10000, |
4101f961 UH |
801 | /** Device instance type for serial port devices. */ |
802 | SR_INST_SERIAL, | |
a1bb33af UH |
803 | }; |
804 | ||
3c0839d5 | 805 | /** Device instance status. */ |
a1bb33af | 806 | enum { |
3c0839d5 | 807 | /** The device instance was not found. */ |
24d04d1e | 808 | SR_ST_NOT_FOUND = 10000, |
3c0839d5 | 809 | /** The device instance was found, but is still booting. */ |
5a2326a7 | 810 | SR_ST_INITIALIZING, |
3c0839d5 | 811 | /** The device instance is live, but not in use. */ |
5a2326a7 | 812 | SR_ST_INACTIVE, |
3c0839d5 | 813 | /** The device instance is actively in use in a session. */ |
5a2326a7 | 814 | SR_ST_ACTIVE, |
69b07d14 BV |
815 | /** The device is winding down its session. */ |
816 | SR_ST_STOPPING, | |
a1bb33af UH |
817 | }; |
818 | ||
c09f0b57 UH |
819 | struct sr_dev_driver { |
820 | /* Driver-specific */ | |
a1bb33af | 821 | char *name; |
9f8274a5 | 822 | char *longname; |
a1bb33af | 823 | int api_version; |
34f06b90 | 824 | int (*init) (struct sr_context *sr_ctx); |
57ab7d9f | 825 | int (*cleanup) (void); |
80bf0426 | 826 | GSList *(*scan) (GSList *options); |
811deee4 BV |
827 | GSList *(*dev_list) (void); |
828 | int (*dev_clear) (void); | |
bc1c2f00 | 829 | int (*config_get) (int id, GVariant **data, |
8f996b89 ML |
830 | const struct sr_dev_inst *sdi, |
831 | const struct sr_probe_group *probe_group); | |
bc1c2f00 | 832 | int (*config_set) (int id, GVariant *data, |
8f996b89 ML |
833 | const struct sr_dev_inst *sdi, |
834 | const struct sr_probe_group *probe_group); | |
bc1c2f00 | 835 | int (*config_list) (int info_id, GVariant **data, |
8f996b89 ML |
836 | const struct sr_dev_inst *sdi, |
837 | const struct sr_probe_group *probe_group); | |
a1bb33af | 838 | |
1b452b85 | 839 | /* Device-specific */ |
25a0f108 BV |
840 | int (*dev_open) (struct sr_dev_inst *sdi); |
841 | int (*dev_close) (struct sr_dev_inst *sdi); | |
3ffb6964 BV |
842 | int (*dev_acquisition_start) (const struct sr_dev_inst *sdi, |
843 | void *cb_data); | |
69b07d14 | 844 | int (*dev_acquisition_stop) (struct sr_dev_inst *sdi, |
3ffb6964 | 845 | void *cb_data); |
dd34b8d3 BV |
846 | |
847 | /* Dynamic */ | |
c259726a | 848 | void *priv; |
a1bb33af UH |
849 | }; |
850 | ||
2872d21e | 851 | struct sr_session { |
3c0839d5 | 852 | /** List of struct sr_dev pointers. */ |
bb7ef793 | 853 | GSList *devs; |
2726474a | 854 | /** List of struct datafeed_callback pointers. */ |
a1bb33af UH |
855 | GSList *datafeed_callbacks; |
856 | GTimeVal starttime; | |
5451816f | 857 | gboolean running; |
b7e94111 LPC |
858 | |
859 | unsigned int num_sources; | |
860 | ||
3c0839d5 UH |
861 | /* |
862 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
863 | * of descriptor and callback function. We can not embed the GPollFD | |
864 | * into the source struct since we want to be able to pass the array | |
865 | * of all poll descriptors to g_poll(). | |
b7e94111 LPC |
866 | */ |
867 | struct source *sources; | |
868 | GPollFD *pollfds; | |
869 | int source_timeout; | |
33c6e4c5 AG |
870 | |
871 | /* | |
872 | * These are our synchronization primitives for stopping the session in | |
873 | * an async fashion. We need to make sure the session is stopped from | |
874 | * within the session thread itself. | |
875 | */ | |
876 | GMutex stop_mutex; | |
877 | gboolean abort_session; | |
a1bb33af UH |
878 | }; |
879 | ||
45c59c8b BV |
880 | #include "proto.h" |
881 | #include "version.h" | |
c2bd92ec | 882 | |
a00b530c UH |
883 | #ifdef __cplusplus |
884 | } | |
885 | #endif | |
886 | ||
a1bb33af | 887 | #endif |