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 hardware drivers for dev_config_set(). */
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,
160 /** Values for sr_datafeed_analog.mq. */
162 SR_MQ_VOLTAGE = 10000,
172 /** Electrical power, usually in W, or dBm. */
174 /** Gain (a transistor's gain, or hFE, for example). */
176 /** Logarithmic representation of sound pressure relative to a
177 * reference value. */
178 SR_MQ_SOUND_PRESSURE_LEVEL,
181 /** Values for sr_datafeed_analog.unit. */
183 SR_UNIT_VOLT = 10000,
194 /** Unit of conductance, the inverse of resistance. */
197 * An absolute measurement of power, in decibels, referenced to
201 /** Voltage in decibel, referenced to 1 volt (dBV). */
202 SR_UNIT_DECIBEL_VOLT,
204 * Measurements that intrinsically do not have units attached, such
205 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
206 * a unitless quantity, for example.
209 /** Sound pressure level relative so 20 micropascals. */
213 /** Values for sr_datafeed_analog.flags. */
215 /** Voltage measurement is alternating current (AC). */
217 /** Voltage measurement is direct current (DC). */
219 /** This is a true RMS measurement. */
220 SR_MQFLAG_RMS = 0x04,
221 /** Value is voltage drop across a diode, or NAN. */
222 SR_MQFLAG_DIODE = 0x08,
223 /** Device is in "hold" mode (repeating the last measurement). */
224 SR_MQFLAG_HOLD = 0x10,
225 /** Device is in "max" mode, only updating upon a new max value. */
226 SR_MQFLAG_MAX = 0x20,
227 /** Device is in "min" mode, only updating upon a new min value. */
228 SR_MQFLAG_MIN = 0x40,
229 /** Device is in autoranging mode. */
230 SR_MQFLAG_AUTORANGE = 0x80,
231 /** Device is in relative mode. */
232 SR_MQFLAG_RELATIVE = 0x100,
233 /** Sound pressure level is A-weighted in the frequency domain,
234 * according to IRC 61672:2003. */
235 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
236 /** Sound pressure level is C-weighted in the frequency domain,
237 * according to IRC 61672:2003. */
238 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
239 /** Sound pressure level is Z-weighted (i.e. not at all) in the
240 * frequency domain, according to IRC 61672:2003. */
241 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
242 /** Sound pressure level is not weighted in the frequency domain,
243 * albeit without standards-defined low and high frequency limits. */
244 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
245 /** Sound pressure level measurement is S-weighted (1s) in the
247 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
248 /** Sound pressure level measurement is F-weighted (125ms) in the
250 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
251 /** Sound pressure level is time-averaged (LAT), also known as
252 * Equivalent Continuous A-weighted Sound Level (LEQ). */
253 SR_MQFLAG_SPL_LAT = 0x8000,
254 /** Sound pressure level represented as a percentage of measurements
255 * that were over a preset alarm level. */
256 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
261 struct sr_datafeed_packet {
266 struct sr_datafeed_header {
268 struct timeval starttime;
271 struct sr_datafeed_meta_logic {
276 struct sr_datafeed_logic {
282 struct sr_datafeed_meta_analog {
286 struct sr_datafeed_analog {
288 /** Measured quantity (voltage, current, temperature, and so on). */
290 /** Unit in which the MQ is measured. */
292 /** Bitmap with extra information about the MQ. */
294 /** The analog value. */
299 struct sr_input_format *format;
301 struct sr_dev_inst *sdi;
305 struct sr_input_format {
308 int (*format_match) (const char *filename);
309 int (*init) (struct sr_input *in);
310 int (*loadfile) (struct sr_input *in, const char *filename);
314 struct sr_output_format *format;
315 struct sr_dev_inst *sdi;
320 struct sr_output_format {
324 int (*init) (struct sr_output *o);
325 int (*data) (struct sr_output *o, const uint8_t *data_in,
326 uint64_t length_in, uint8_t **data_out,
327 uint64_t *length_out);
328 int (*event) (struct sr_output *o, int event_type, uint8_t **data_out,
329 uint64_t *length_out);
330 GString *(*recv) (struct sr_output *o, const struct sr_dev_inst *sdi,
331 struct sr_datafeed_packet *packet);
332 int (*cleanup) (struct sr_output *o);
335 struct sr_datastore {
336 /** Size in bytes of the number of units stored in this datastore. */
338 unsigned int num_units; /* TODO: uint64_t */
343 * This represents a generic device connected to the system.
344 * For device-specific information, ask the driver. The driver_index refers
345 * to the device index within that driver; it may be handling more than one
346 * device. All relevant driver calls take a dev_index parameter for this.
349 /** Which driver handles this device. */
350 struct sr_dev_driver *driver;
351 /** A driver may handle multiple devices of the same type. */
353 /** List of struct sr_probe pointers. */
355 /** Data acquired by this device, if any. */
356 struct sr_datastore *datastore;
360 SR_PROBE_LOGIC = 10000,
377 /** Hardware driver options. */
380 * Some drivers cannot detect the exact model they're talking to
381 * (may be phased out).
383 SR_HWOPT_MODEL = 10000,
386 * Specification on how to connect to a device.
388 * In combination with SR_HWOPT_SERIALCOMM, this is a serial port in
389 * the form which makes sense to the OS (e.g., /dev/ttyS0).
390 * Otherwise this specifies a USB device, either in the form of
391 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
392 * @verbatim <vendorid>.<productid> @endverbatim
393 * (hexadecimal, e.g. 1d6b.0001).
398 * Serial communication specification, in the form:
400 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
404 * This is always an optional parameter, since a driver typically
405 * knows the speed at which the device wants to communicate.
410 /** Hardware device capabilities. */
412 /*--- Device classes ------------------------------------------------*/
414 /** The device can act as logic analyzer. */
415 SR_HWCAP_LOGIC_ANALYZER = 10000,
417 /** The device can act as an oscilloscope. */
418 SR_HWCAP_OSCILLOSCOPE,
420 /** The device can act as a multimeter. */
423 /** The device is a demo device. */
426 /** The device can act as a sound level meter. */
427 SR_HWCAP_SOUNDLEVELMETER,
429 /*--- Device configuration ------------------------------------------*/
431 /** The device supports setting/changing its samplerate. */
432 SR_HWCAP_SAMPLERATE = 20000,
434 /** The device supports setting a pre/post-trigger capture ratio. */
435 SR_HWCAP_CAPTURE_RATIO,
438 /** The device supports setting a pattern (pattern generator mode). */
439 SR_HWCAP_PATTERN_MODE,
441 /** The device supports Run Length Encoding. */
444 /** The device supports setting trigger slope. */
445 SR_HWCAP_TRIGGER_SLOPE,
447 /** Trigger source. */
448 SR_HWCAP_TRIGGER_SOURCE,
450 /** Horizontal trigger position. */
451 SR_HWCAP_HORIZ_TRIGGERPOS,
468 /*--- Special stuff -------------------------------------------------*/
470 /** Session filename. */
471 SR_HWCAP_SESSIONFILE = 30000,
473 /* TODO: Better description. */
474 /** The device supports specifying a capturefile to inject. */
475 SR_HWCAP_CAPTUREFILE,
477 /* TODO: Better description. */
478 /** The device supports specifying the capturefile unit size. */
479 SR_HWCAP_CAPTURE_UNITSIZE,
481 /* TODO: Better description. */
482 /** The device supports setting the number of probes. */
483 SR_HWCAP_CAPTURE_NUM_PROBES,
485 /*--- Acquisition modes ---------------------------------------------*/
488 * The device supports setting a sample time limit (how long
489 * the sample acquisition should run, in ms).
491 SR_HWCAP_LIMIT_MSEC = 40000,
494 * The device supports setting a sample number limit (how many
495 * samples should be acquired).
497 SR_HWCAP_LIMIT_SAMPLES,
500 * The device supports setting a frame limit (how many
501 * frames should be acquired).
503 SR_HWCAP_LIMIT_FRAMES,
506 * The device supports continuous sampling. Neither a time limit
507 * nor a sample number limit has to be supplied, it will just acquire
508 * samples continuously, until explicitly stopped by a certain command.
513 struct sr_hwcap_option {
521 struct sr_dev_driver *driver;
532 /** Types of device instances (sr_dev_inst). */
534 /** Device instance type for USB devices. */
536 /** Device instance type for serial port devices. */
540 /** Device instance status. */
542 /** The device instance was not found. */
543 SR_ST_NOT_FOUND = 10000,
544 /** The device instance was found, but is still booting. */
546 /** The device instance is live, but not in use. */
548 /** The device instance is actively in use in a session. */
553 * TODO: This sucks, you just kinda have to "know" the returned type.
554 * TODO: Need a DI to return the number of trigger stages supported.
557 /** Device info IDs. */
559 /** A list of options supported by the driver. */
560 SR_DI_HWOPTS = 10000,
561 /** A list of capabilities supported by the device. */
563 /** The number of probes connected to this device. */
565 /** The probe names on this device. */
567 /** Samplerates supported by this device (struct sr_samplerates). */
569 /** Types of logic trigger supported, out of "01crf" (char *). */
571 /** The currently set samplerate in Hz (uint64_t). */
572 SR_DI_CUR_SAMPLERATE,
573 /** Supported patterns (in pattern generator mode). */
575 /** Supported buffer sizes. */
577 /** Supported time bases. */
579 /** Supported trigger sources. */
580 SR_DI_TRIGGER_SOURCES,
581 /** Supported filter targets. */
583 /** Valid volts/div values. */
585 /** Coupling options. */
590 * A device supports either a range of samplerates with steps of a given
591 * granularity, or is limited to a set of defined samplerates. Use either
592 * step or list, but not both.
594 struct sr_samplerates {
598 const uint64_t *list;
601 struct sr_dev_driver {
602 /* Driver-specific */
607 int (*cleanup) (void);
608 GSList *(*scan) (GSList *options);
609 GSList *(*dev_list) (void);
610 int (*dev_clear) (void);
612 /* Device-specific */
613 int (*dev_open) (struct sr_dev_inst *sdi);
614 int (*dev_close) (struct sr_dev_inst *sdi);
615 int (*info_get) (int info_id, const void **data,
616 const struct sr_dev_inst *sdi);
617 int (*dev_config_set) (const struct sr_dev_inst *sdi, int hwcap,
619 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
621 int (*dev_acquisition_stop) (const struct sr_dev_inst *sdi,
629 /** List of struct sr_dev pointers. */
631 /** List of sr_receive_data_callback_t items. */
632 GSList *datafeed_callbacks;
635 unsigned int num_sources;
638 * Both "sources" and "pollfds" are of the same size and contain pairs
639 * of descriptor and callback function. We can not embed the GPollFD
640 * into the source struct since we want to be able to pass the array
641 * of all poll descriptors to g_poll().
643 struct source *sources;