]> sigrok.org Git - libsigrok.git/blame - libsigrok.h
autotools: Don't use "foreign" option.
[libsigrok.git] / libsigrok.h
CommitLineData
a1bb33af
UH
1/*
2 * This file is part of the sigrok project.
3 *
c73d2ea4 4 * Copyright (C) 2010-2012 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
30extern "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
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
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. */
66enum {
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};
a1bb33af 74
b2ff9506
BV
75#define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
76#define SR_MAX_PROBENAME_LEN 32
2a3f9541 77
a1bb33af 78/* Handy little macros */
c9140419 79#define SR_HZ(n) (n)
0b4b41ee
UH
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))
a1bb33af 83
0b4b41ee 84#define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
3677f3ec 85
3c0839d5
UH
86/** libsigrok loglevels. */
87enum {
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};
1352eedd 95
1a081ca6
UH
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 *
69e70c23
UH
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 *
1a081ca6
UH
109 * Details: http://gcc.gnu.org/wiki/Visibility
110 */
111
112/* Marks public libsigrok API symbols. */
69e70c23 113#ifndef _WIN32
1a081ca6 114#define SR_API __attribute__((visibility("default")))
69e70c23
UH
115#else
116#define SR_API
117#endif
1a081ca6
UH
118
119/* Marks private, non-public libsigrok symbols (not part of the API). */
69e70c23 120#ifndef _WIN32
1a081ca6 121#define SR_PRIV __attribute__((visibility("hidden")))
69e70c23
UH
122#else
123#define SR_PRIV
124#endif
1a081ca6 125
1f9813eb 126typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
882e2075 127
08a9260b 128/** Data types used by sr_config_info(). */
a1bb33af 129enum {
24d04d1e 130 SR_T_UINT64 = 10000,
5a2326a7 131 SR_T_CHAR,
4d436e71 132 SR_T_BOOL,
0fe11789 133 SR_T_FLOAT,
c1e48618 134 SR_T_RATIONAL_PERIOD,
bd8db307 135 SR_T_RATIONAL_VOLT,
45edd0b2 136 SR_T_KEYVALUE,
0fe11789
BV
137};
138
3c0839d5 139/** Rational number data type, containing numerator and denominator values. */
0fe11789 140struct sr_rational {
3c0839d5 141 /** Numerator of the rational number. */
0fe11789 142 uint64_t p;
3c0839d5 143 /** Denominator of the rational number. */
0fe11789 144 uint64_t q;
a1bb33af
UH
145};
146
3c0839d5 147/** Value for sr_datafeed_packet.type. */
a1bb33af 148enum {
24d04d1e 149 SR_DF_HEADER = 10000,
5a2326a7 150 SR_DF_END,
9a5693a5 151 SR_DF_META,
5a2326a7
UH
152 SR_DF_TRIGGER,
153 SR_DF_LOGIC,
ee7489d2 154 SR_DF_ANALOG,
6ea7669c
BV
155 SR_DF_FRAME_BEGIN,
156 SR_DF_FRAME_END,
a1bb33af
UH
157};
158
3c0839d5 159/** Values for sr_datafeed_analog.mq. */
9956f285 160enum {
24d04d1e 161 SR_MQ_VOLTAGE = 10000,
9956f285
UH
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,
64591be2 168 SR_MQ_CONTINUITY,
aa839a5c 169 SR_MQ_PULSE_WIDTH,
96b3b3d5 170 SR_MQ_CONDUCTANCE,
3c0839d5 171 /** Electrical power, usually in W, or dBm. */
b82a17d3 172 SR_MQ_POWER,
a02d77bc 173 /** Gain (a transistor's gain, or hFE, for example). */
b82a17d3 174 SR_MQ_GAIN,
fc19c288
BV
175 /** Logarithmic representation of sound pressure relative to a
176 * reference value. */
177 SR_MQ_SOUND_PRESSURE_LEVEL,
4f3bd685 178 SR_MQ_CARBON_MONOXIDE,
ef4344e7 179 SR_MQ_RELATIVE_HUMIDITY,
9956f285
UH
180};
181
3c0839d5 182/** Values for sr_datafeed_analog.unit. */
aff5a729 183enum {
24d04d1e 184 SR_UNIT_VOLT = 10000,
9956f285
UH
185 SR_UNIT_AMPERE,
186 SR_UNIT_OHM,
187 SR_UNIT_FARAD,
9956f285 188 SR_UNIT_KELVIN,
edb000eb
BV
189 SR_UNIT_CELSIUS,
190 SR_UNIT_FAHRENHEIT,
9956f285
UH
191 SR_UNIT_HERTZ,
192 SR_UNIT_PERCENTAGE,
edb000eb 193 SR_UNIT_BOOLEAN,
aa839a5c 194 SR_UNIT_SECOND,
3c0839d5 195 /** Unit of conductance, the inverse of resistance. */
96b3b3d5 196 SR_UNIT_SIEMENS,
3c0839d5
UH
197 /**
198 * An absolute measurement of power, in decibels, referenced to
199 * 1 milliwatt (dBu).
200 */
b82a17d3 201 SR_UNIT_DECIBEL_MW,
6b869234
BV
202 /** Voltage in decibel, referenced to 1 volt (dBV). */
203 SR_UNIT_DECIBEL_VOLT,
3c0839d5
UH
204 /**
205 * Measurements that intrinsically do not have units attached, such
6b869234 206 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
3c0839d5
UH
207 * a unitless quantity, for example.
208 */
b82a17d3 209 SR_UNIT_UNITLESS,
fc19c288
BV
210 /** Sound pressure level relative so 20 micropascals. */
211 SR_UNIT_DECIBEL_SPL,
801c7800
AG
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 */
4f3bd685 217 SR_UNIT_CONCENTRATION,
aff5a729
BV
218};
219
3c0839d5 220/** Values for sr_datafeed_analog.flags. */
02e864d0 221enum {
3c0839d5 222 /** Voltage measurement is alternating current (AC). */
02e864d0 223 SR_MQFLAG_AC = 0x01,
3c0839d5 224 /** Voltage measurement is direct current (DC). */
02e864d0
BV
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,
a02d77bc 230 /** Device is in "hold" mode (repeating the last measurement). */
02e864d0 231 SR_MQFLAG_HOLD = 0x10,
3c0839d5 232 /** Device is in "max" mode, only updating upon a new max value. */
02e864d0 233 SR_MQFLAG_MAX = 0x20,
3c0839d5 234 /** Device is in "min" mode, only updating upon a new min value. */
02e864d0
BV
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,
fc19c288 240 /** Sound pressure level is A-weighted in the frequency domain,
2244356d 241 * according to IEC 61672:2003. */
fc19c288
BV
242 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
243 /** Sound pressure level is C-weighted in the frequency domain,
2244356d 244 * according to IEC 61672:2003. */
fc19c288
BV
245 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
246 /** Sound pressure level is Z-weighted (i.e. not at all) in the
2244356d 247 * frequency domain, according to IEC 61672:2003. */
fc19c288
BV
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,
02e864d0
BV
264};
265
b8072700
PS
266struct sr_context;
267
b9c735a2 268struct sr_datafeed_packet {
a1bb33af 269 uint16_t type;
bf53457d 270 const void *payload;
a1bb33af
UH
271};
272
b9c735a2 273struct sr_datafeed_header {
a1bb33af
UH
274 int feed_version;
275 struct timeval starttime;
ee7489d2
BV
276};
277
9a5693a5
BV
278struct sr_datafeed_meta {
279 GSList *config;
280};
281
38ab3ee7
BV
282struct sr_datafeed_logic {
283 uint64_t length;
284 uint16_t unitsize;
9c939c51 285 void *data;
38ab3ee7
BV
286};
287
ee7489d2 288struct sr_datafeed_analog {
aeba33ba 289 /** The probes for which data is included in this packet. */
69e19dd7 290 GSList *probes;
ee7489d2 291 int num_samples;
a02d77bc 292 /** Measured quantity (voltage, current, temperature, and so on). */
02e864d0
BV
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;
aeba33ba
BV
298 /** The analog value(s). The data is interleaved according to
299 * the probes list. */
ee7489d2
BV
300 float *data;
301};
302
83687343 303/** Input (file) format struct. */
f50f3f40 304struct sr_input {
83687343
UH
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 */
f50f3f40 309 struct sr_input_format *format;
83687343 310
3dafb92b 311 GHashTable *param;
83687343 312
5c3c1241 313 struct sr_dev_inst *sdi;
83687343 314
3dafb92b 315 void *internal;
34e4813f
BV
316};
317
f50f3f40 318struct sr_input_format {
83687343 319 /** The unique ID for this input format. Must not be NULL. */
cdb3573c 320 char *id;
83687343
UH
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 */
34e4813f 326 char *description;
83687343
UH
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 */
757b8c62 335 int (*format_match) (const char *filename);
83687343
UH
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 */
543d45c5 347 int (*init) (struct sr_input *in, const char *filename);
83687343
UH
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 */
f50f3f40 368 int (*loadfile) (struct sr_input *in, const char *filename);
34e4813f
BV
369};
370
07e1aad5 371/** Output (file) format struct. */
f50f3f40 372struct sr_output {
07e1aad5
UH
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 */
f50f3f40 377 struct sr_output_format *format;
07e1aad5
UH
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 */
5c3c1241 383 struct sr_dev_inst *sdi;
07e1aad5
UH
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 */
a1bb33af 390 char *param;
07e1aad5
UH
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 */
a1bb33af
UH
399 void *internal;
400};
401
f50f3f40 402struct sr_output_format {
07e1aad5
UH
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 */
cdb3573c 411 char *id;
07e1aad5
UH
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 */
a1bb33af 419 char *description;
07e1aad5 420
f0411b1d 421 int df_type;
07e1aad5
UH
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 */
f50f3f40 437 int (*init) (struct sr_output *o);
07e1aad5
UH
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 */
054e6709
UH
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);
07e1aad5
UH
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 */
054e6709 500 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
a1bb33af 501 uint64_t *length_out);
07e1aad5 502
f45b7590 503 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
bf53457d 504 const struct sr_datafeed_packet *packet);
07e1aad5 505
f45b7590 506 int (*cleanup) (struct sr_output *o);
a1bb33af
UH
507};
508
921e753f 509enum {
24d04d1e 510 SR_PROBE_LOGIC = 10000,
87ca93c5 511 SR_PROBE_ANALOG,
921e753f
DR
512};
513
1afe8989 514struct sr_probe {
08a9260b 515 /* The index field will go: use g_slist_length(sdi->probes) instead. */
a1bb33af 516 int index;
6ea7e235 517 int type;
a1bb33af
UH
518 gboolean enabled;
519 char *name;
520 char *trigger;
521};
522
9a5693a5
BV
523struct sr_config {
524 int key;
b159add3
BV
525 const void *value;
526};
527
9a5693a5
BV
528struct sr_config_info {
529 int key;
fbf394c6 530 int datatype;
9a5693a5
BV
531 char *id;
532 char *name;
533 char *description;
9a5693a5
BV
534};
535
a1bb33af 536enum {
e88dadd7
UH
537 /*--- Device classes ------------------------------------------------*/
538
539 /** The device can act as logic analyzer. */
1953564a 540 SR_CONF_LOGIC_ANALYZER = 10000,
925dbf9f 541
ee7489d2 542 /** The device can act as an oscilloscope. */
1953564a 543 SR_CONF_OSCILLOSCOPE,
e88dadd7 544
ca3d84cc 545 /** The device can act as a multimeter. */
1953564a 546 SR_CONF_MULTIMETER,
a141db8c 547
ca3d84cc 548 /** The device is a demo device. */
1953564a 549 SR_CONF_DEMO_DEV,
a141db8c 550
fc19c288 551 /** The device can act as a sound level meter. */
1953564a 552 SR_CONF_SOUNDLEVELMETER,
ca3d84cc 553
40270444 554 /** The device can measure temperature. */
1953564a 555 SR_CONF_THERMOMETER,
40270444
BV
556
557 /** The device can measure humidity. */
1953564a 558 SR_CONF_HYGROMETER,
40270444 559
9a6517d1 560 /*--- Driver scan options -------------------------------------------*/
c89c1c9c
BV
561
562 /**
563 * Specification on how to connect to a device.
564 *
1953564a 565 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
c89c1c9c
BV
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 */
1953564a 572 SR_CONF_CONN = 20000,
c89c1c9c
BV
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 */
1953564a 593 SR_CONF_SERIALCOMM,
c89c1c9c 594
ca3d84cc 595 /*--- Device configuration ------------------------------------------*/
e88dadd7 596
7231a145 597 /** The device supports setting its samplerate, in Hz. */
1953564a 598 SR_CONF_SAMPLERATE = 30000,
e88dadd7 599
e88dadd7 600 /** The device supports setting a pre/post-trigger capture ratio. */
1953564a 601 SR_CONF_CAPTURE_RATIO,
e88dadd7 602
e88dadd7 603 /** The device supports setting a pattern (pattern generator mode). */
1953564a 604 SR_CONF_PATTERN_MODE,
e88dadd7 605
3a4d09c0 606 /** The device supports Run Length Encoding. */
1953564a 607 SR_CONF_RLE,
3a4d09c0 608
ee7489d2 609 /** The device supports setting trigger slope. */
1953564a 610 SR_CONF_TRIGGER_SLOPE,
0fe11789
BV
611
612 /** Trigger source. */
1953564a 613 SR_CONF_TRIGGER_SOURCE,
0fe11789 614
3c0839d5 615 /** Horizontal trigger position. */
1953564a 616 SR_CONF_HORIZ_TRIGGERPOS,
0fe11789
BV
617
618 /** Buffer size. */
1953564a 619 SR_CONF_BUFFERSIZE,
0fe11789
BV
620
621 /** Time base. */
1953564a 622 SR_CONF_TIMEBASE,
ee7489d2 623
3c4976c9 624 /** Filter. */
1953564a 625 SR_CONF_FILTER,
3c4976c9 626
bd8db307 627 /** Volts/div. */
1953564a 628 SR_CONF_VDIV,
bd8db307 629
e1c8b2ab 630 /** Coupling. */
1953564a 631 SR_CONF_COUPLING,
e1c8b2ab 632
c50277a6
BV
633 /** Trigger types. */
634 SR_CONF_TRIGGER_TYPE,
635
7231a145
BV
636 /** The device supports setting its sample interval, in ms. */
637 SR_CONF_SAMPLE_INTERVAL,
638
e88dadd7
UH
639 /*--- Special stuff -------------------------------------------------*/
640
9a6517d1 641 /** Scan options supported by the driver. */
aeba33ba 642 SR_CONF_SCAN_OPTIONS = 40000,
9a6517d1
BV
643
644 /** Device options for a particular device. */
645 SR_CONF_DEVICE_OPTIONS,
646
3c0839d5 647 /** Session filename. */
aeba33ba 648 SR_CONF_SESSIONFILE,
40dda2c3 649
e88dadd7 650 /** The device supports specifying a capturefile to inject. */
1953564a 651 SR_CONF_CAPTUREFILE,
925dbf9f 652
e88dadd7 653 /** The device supports specifying the capturefile unit size. */
1953564a 654 SR_CONF_CAPTURE_UNITSIZE,
7d658874 655
e88dadd7 656 /** The device supports setting the number of probes. */
1953564a 657 SR_CONF_CAPTURE_NUM_PROBES,
e88dadd7
UH
658
659 /*--- Acquisition modes ---------------------------------------------*/
660
661 /**
a02d77bc
UH
662 * The device supports setting a sample time limit (how long
663 * the sample acquisition should run, in ms).
e88dadd7 664 */
1953564a 665 SR_CONF_LIMIT_MSEC = 50000,
e88dadd7
UH
666
667 /**
a02d77bc
UH
668 * The device supports setting a sample number limit (how many
669 * samples should be acquired).
e88dadd7 670 */
1953564a 671 SR_CONF_LIMIT_SAMPLES,
e88dadd7 672
6ea7669c 673 /**
a02d77bc
UH
674 * The device supports setting a frame limit (how many
675 * frames should be acquired).
6ea7669c 676 */
1953564a 677 SR_CONF_LIMIT_FRAMES,
6ea7669c 678
e88dadd7 679 /**
a02d77bc 680 * The device supports continuous sampling. Neither a time limit
e88dadd7
UH
681 * nor a sample number limit has to be supplied, it will just acquire
682 * samples continuously, until explicitly stopped by a certain command.
683 */
1953564a 684 SR_CONF_CONTINUOUS,
e6551ea6
BV
685
686 /** The device has internal storage, into which data is logged. This
687 * starts or stops the internal logging. */
688 SR_CONF_DATALOG,
a1bb33af
UH
689};
690
d68e2d1a 691struct sr_dev_inst {
9e41fdba 692 struct sr_dev_driver *driver;
a1bb33af
UH
693 int index;
694 int status;
1d9a8a5f 695 int inst_type;
a1bb33af
UH
696 char *vendor;
697 char *model;
698 char *version;
47211d65 699 GSList *probes;
8d672550 700 void *priv;
a1bb33af
UH
701};
702
3c0839d5 703/** Types of device instances (sr_dev_inst). */
a1bb33af 704enum {
4101f961 705 /** Device instance type for USB devices. */
24d04d1e 706 SR_INST_USB = 10000,
4101f961
UH
707 /** Device instance type for serial port devices. */
708 SR_INST_SERIAL,
a1bb33af
UH
709};
710
3c0839d5 711/** Device instance status. */
a1bb33af 712enum {
3c0839d5 713 /** The device instance was not found. */
24d04d1e 714 SR_ST_NOT_FOUND = 10000,
3c0839d5 715 /** The device instance was found, but is still booting. */
5a2326a7 716 SR_ST_INITIALIZING,
3c0839d5 717 /** The device instance is live, but not in use. */
5a2326a7 718 SR_ST_INACTIVE,
3c0839d5 719 /** The device instance is actively in use in a session. */
5a2326a7 720 SR_ST_ACTIVE,
69b07d14
BV
721 /** The device is winding down its session. */
722 SR_ST_STOPPING,
a1bb33af
UH
723};
724
1b452b85
UH
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
a1bb33af
UH
728 * step or list, but not both.
729 */
60679b18 730struct sr_samplerates {
a1bb33af
UH
731 uint64_t low;
732 uint64_t high;
733 uint64_t step;
a533743d 734 const uint64_t *list;
a1bb33af
UH
735};
736
c09f0b57
UH
737struct sr_dev_driver {
738 /* Driver-specific */
a1bb33af 739 char *name;
9f8274a5 740 char *longname;
a1bb33af 741 int api_version;
34f06b90 742 int (*init) (struct sr_context *sr_ctx);
57ab7d9f 743 int (*cleanup) (void);
80bf0426 744 GSList *(*scan) (GSList *options);
811deee4
BV
745 GSList *(*dev_list) (void);
746 int (*dev_clear) (void);
035a1078
BV
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);
c5fb502f
BV
751 int (*config_list) (int info_id, const void **data,
752 const struct sr_dev_inst *sdi);
a1bb33af 753
1b452b85 754 /* Device-specific */
25a0f108
BV
755 int (*dev_open) (struct sr_dev_inst *sdi);
756 int (*dev_close) (struct sr_dev_inst *sdi);
3ffb6964
BV
757 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
758 void *cb_data);
69b07d14 759 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
3ffb6964 760 void *cb_data);
dd34b8d3
BV
761
762 /* Dynamic */
c259726a 763 void *priv;
a1bb33af
UH
764};
765
2872d21e 766struct sr_session {
3c0839d5 767 /** List of struct sr_dev pointers. */
bb7ef793 768 GSList *devs;
3c0839d5 769 /** List of sr_receive_data_callback_t items. */
a1bb33af
UH
770 GSList *datafeed_callbacks;
771 GTimeVal starttime;
b7e94111
LPC
772
773 unsigned int num_sources;
774
3c0839d5
UH
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().
b7e94111
LPC
780 */
781 struct source *sources;
782 GPollFD *pollfds;
783 int source_timeout;
a1bb33af
UH
784};
785
45c59c8b
BV
786#include "proto.h"
787#include "version.h"
c2bd92ec 788
a00b530c
UH
789#ifdef __cplusplus
790}
791#endif
792
a1bb33af 793#endif