2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
20 #ifndef LIBSIGROK_SIGROK_H
21 #define LIBSIGROK_SIGROK_H
36 * The public libsigrok header file to be used by frontends.
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.
42 * The correct way to get/use the libsigrok API functions is:
45 * #include <libsigrok/libsigrok.h>
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.
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
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.
65 /** Status/error codes returned by libsigrok functions. */
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. */
75 #define SR_MAX_NUM_PROBES 64 /* Limited by uint64_t. */
76 #define SR_MAX_PROBENAME_LEN 32
78 /* Handy little macros */
80 #define SR_KHZ(n) ((n) * 1000)
81 #define SR_MHZ(n) ((n) * 1000000)
82 #define SR_GHZ(n) ((n) * 1000000000)
84 #define SR_HZ_TO_NS(n) (1000000000 / (n))
86 /** libsigrok loglevels. */
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. */
97 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
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.
104 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
106 * This feature is not available on MinGW/Windows, as it is a feature of
107 * ELF files and MinGW/Windows uses PE files.
109 * Details: http://gcc.gnu.org/wiki/Visibility
112 /* Marks public libsigrok API symbols. */
114 #define SR_API __attribute__((visibility("default")))
119 /* Marks private, non-public libsigrok symbols (not part of the API). */
121 #define SR_PRIV __attribute__((visibility("hidden")))
126 typedef int (*sr_receive_data_callback_t)(int fd, int revents, void *cb_data);
128 /** Data types used by sr_config_info(). */
134 SR_T_RATIONAL_PERIOD,
139 /** Rational number data type, containing numerator and denominator values. */
141 /** Numerator of the rational number. */
143 /** Denominator of the rational number. */
147 /** Value for sr_datafeed_packet.type. */
149 SR_DF_HEADER = 10000,
159 /** Values for sr_datafeed_analog.mq. */
161 SR_MQ_VOLTAGE = 10000,
171 /** Electrical power, usually in W, or dBm. */
173 /** Gain (a transistor's gain, or hFE, for example). */
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,
182 /** Values for sr_datafeed_analog.unit. */
184 SR_UNIT_VOLT = 10000,
195 /** Unit of conductance, the inverse of resistance. */
198 * An absolute measurement of power, in decibels, referenced to
202 /** Voltage in decibel, referenced to 1 volt (dBV). */
203 SR_UNIT_DECIBEL_VOLT,
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.
210 /** Sound pressure level relative so 20 micropascals. */
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.
217 SR_UNIT_CONCENTRATION,
220 /** Values for sr_datafeed_analog.flags. */
222 /** Voltage measurement is alternating current (AC). */
224 /** Voltage measurement is direct current (DC). */
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
254 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
255 /** Sound pressure level measurement is F-weighted (125ms) in the
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,
268 struct sr_datafeed_packet {
273 struct sr_datafeed_header {
275 struct timeval starttime;
278 struct sr_datafeed_meta {
282 struct sr_datafeed_logic {
288 struct sr_datafeed_analog {
290 /** Measured quantity (voltage, current, temperature, and so on). */
292 /** Unit in which the MQ is measured. */
294 /** Bitmap with extra information about the MQ. */
296 /** The analog value. */
301 struct sr_input_format *format;
303 struct sr_dev_inst *sdi;
307 struct sr_input_format {
310 int (*format_match) (const char *filename);
311 int (*init) (struct sr_input *in);
312 int (*loadfile) (struct sr_input *in, const char *filename);
316 struct sr_output_format *format;
317 struct sr_dev_inst *sdi;
322 struct sr_output_format {
326 int (*init) (struct sr_output *o);
327 /* Obsolete, use recv() instead. */
328 int (*data) (struct sr_output *o, const uint8_t *data_in,
329 uint64_t length_in, uint8_t **data_out,
330 uint64_t *length_out);
331 /* Obsolete, use recv() instead. */
332 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
333 uint64_t *length_out);
334 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
335 const struct sr_datafeed_packet *packet);
336 int (*cleanup) (struct sr_output *o);
340 SR_PROBE_LOGIC = 10000,
345 /* The index field will go: use g_slist_length(sdi->probes) instead. */
358 struct sr_config_info {
367 /*--- Device classes ------------------------------------------------*/
369 /** The device can act as logic analyzer. */
370 SR_CONF_LOGIC_ANALYZER = 10000,
372 /** The device can act as an oscilloscope. */
373 SR_CONF_OSCILLOSCOPE,
375 /** The device can act as a multimeter. */
378 /** The device is a demo device. */
381 /** The device can act as a sound level meter. */
382 SR_CONF_SOUNDLEVELMETER,
384 /** The device can measure temperature. */
387 /** The device can measure humidity. */
390 /*--- Driver options ------------------------------------------------*/
393 * Specification on how to connect to a device.
395 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
396 * the form which makes sense to the OS (e.g., /dev/ttyS0).
397 * Otherwise this specifies a USB device, either in the form of
398 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
399 * @verbatim <vendorid>.<productid> @endverbatim
400 * (hexadecimal, e.g. 1d6b.0001).
402 SR_CONF_CONN = 20000,
405 * Serial communication specification, in the form:
407 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
411 * The string may also be followed by one or more special settings,
412 * in the form "/key=value". Supported keys and their values are:
414 * rts 0,1 set the port's RTS pin to low or high
415 * dtr 0,1 set the port's DTR pin to low or high
416 * flow 0 no flow control
417 * 1 hardware-based (RTS/CTS) flow control
418 * 2 software-based (XON/XOFF) flow control
420 * This is always an optional parameter, since a driver typically
421 * knows the speed at which the device wants to communicate.
425 /*--- Device configuration ------------------------------------------*/
427 /** The device supports setting/changing its samplerate. */
428 SR_CONF_SAMPLERATE = 30000,
430 /** The device supports setting a pre/post-trigger capture ratio. */
431 SR_CONF_CAPTURE_RATIO,
433 /** The device supports setting a pattern (pattern generator mode). */
434 SR_CONF_PATTERN_MODE,
436 /** The device supports Run Length Encoding. */
439 /** The device supports setting trigger slope. */
440 SR_CONF_TRIGGER_SLOPE,
442 /** Trigger source. */
443 SR_CONF_TRIGGER_SOURCE,
445 /** Horizontal trigger position. */
446 SR_CONF_HORIZ_TRIGGERPOS,
463 /*--- Special stuff -------------------------------------------------*/
465 /** Session filename. */
466 SR_CONF_SESSIONFILE = 40000,
468 /* TODO: Better description. */
469 /** The device supports specifying a capturefile to inject. */
472 /* TODO: Better description. */
473 /** The device supports specifying the capturefile unit size. */
474 SR_CONF_CAPTURE_UNITSIZE,
476 /* TODO: Better description. */
477 /** The device supports setting the number of probes. */
478 SR_CONF_CAPTURE_NUM_PROBES,
480 /*--- Acquisition modes ---------------------------------------------*/
483 * The device supports setting a sample time limit (how long
484 * the sample acquisition should run, in ms).
486 SR_CONF_LIMIT_MSEC = 50000,
489 * The device supports setting a sample number limit (how many
490 * samples should be acquired).
492 SR_CONF_LIMIT_SAMPLES,
495 * The device supports setting a frame limit (how many
496 * frames should be acquired).
498 SR_CONF_LIMIT_FRAMES,
501 * The device supports continuous sampling. Neither a time limit
502 * nor a sample number limit has to be supplied, it will just acquire
503 * samples continuously, until explicitly stopped by a certain command.
509 struct sr_dev_driver *driver;
520 /** Types of device instances (sr_dev_inst). */
522 /** Device instance type for USB devices. */
524 /** Device instance type for serial port devices. */
528 /** Device instance status. */
530 /** The device instance was not found. */
531 SR_ST_NOT_FOUND = 10000,
532 /** The device instance was found, but is still booting. */
534 /** The device instance is live, but not in use. */
536 /** The device instance is actively in use in a session. */
538 /** The device is winding down its session. */
543 * TODO: This sucks, you just kinda have to "know" the returned type.
544 * TODO: Need a DI to return the number of trigger stages supported.
547 /** Device info IDs. */
549 /** A list of options supported by the driver. */
550 SR_DI_HWOPTS = 10000,
551 /** A list of capabilities supported by the device. */
553 /** Samplerates supported by this device (struct sr_samplerates). */
555 /** Types of logic trigger supported, out of "01crf" (char *). */
557 /** The currently set samplerate in Hz (uint64_t). */
558 SR_DI_CUR_SAMPLERATE,
559 /** Supported patterns (in pattern generator mode). */
561 /** Supported buffer sizes. */
563 /** Supported time bases. */
565 /** Supported trigger sources. */
566 SR_DI_TRIGGER_SOURCES,
567 /** Supported filter targets. */
569 /** Valid volts/div values. */
571 /** Coupling options. */
576 * A device supports either a range of samplerates with steps of a given
577 * granularity, or is limited to a set of defined samplerates. Use either
578 * step or list, but not both.
580 struct sr_samplerates {
584 const uint64_t *list;
587 struct sr_dev_driver {
588 /* Driver-specific */
592 int (*init) (struct sr_context *sr_ctx);
593 int (*cleanup) (void);
594 GSList *(*scan) (GSList *options);
595 GSList *(*dev_list) (void);
596 int (*dev_clear) (void);
598 /* Device-specific */
599 int (*dev_open) (struct sr_dev_inst *sdi);
600 int (*dev_close) (struct sr_dev_inst *sdi);
601 int (*info_get) (int info_id, const void **data,
602 const struct sr_dev_inst *sdi);
603 int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
605 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
607 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
615 /** List of struct sr_dev pointers. */
617 /** List of sr_receive_data_callback_t items. */
618 GSList *datafeed_callbacks;
621 unsigned int num_sources;
624 * Both "sources" and "pollfds" are of the same size and contain pairs
625 * of descriptor and callback function. We can not embed the GPollFD
626 * into the source struct since we want to be able to pass the array
627 * of all poll descriptors to g_poll().
629 struct source *sources;