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