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