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