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