2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 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_LIBSIGROK_H
21 #define LIBSIGROK_LIBSIGROK_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. */
73 SR_ERR_NA = -6, /**< Not applicable. */
74 SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but must be open. */
75 SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
76 SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
79 * Note: When adding entries here, don't forget to also update the
80 * sr_strerror() and sr_strerror_name() functions in error.c.
84 #define SR_MAX_CHANNELNAME_LEN 32
86 /* Handy little macros */
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))
92 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
94 /** libsigrok loglevels. */
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. */
105 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
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.
112 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
114 * This feature is not available on MinGW/Windows, as it is a feature of
115 * ELF files and MinGW/Windows uses PE files.
117 * Details: http://gcc.gnu.org/wiki/Visibility
120 /* Marks public libsigrok API symbols. */
122 #define SR_API __attribute__((visibility("default")))
127 /* Marks private, non-public libsigrok symbols (not part of the API). */
129 #define SR_PRIV __attribute__((visibility("hidden")))
134 /** Type definition for callback function for data reception. */
135 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
137 /** Data types used by sr_config_info(). */
143 SR_T_RATIONAL_PERIOD,
151 /** Value for sr_datafeed_packet.type. */
153 /** Payload is sr_datafeed_header. */
154 SR_DF_HEADER = 10000,
155 /** End of stream (no further data). */
157 /** Payload is struct sr_datafeed_meta */
159 /** The trigger matched at this point in the data feed. No payload. */
161 /** Payload is struct sr_datafeed_logic. */
163 /** Payload is struct sr_datafeed_analog. */
165 /** Beginning of frame. No payload. */
167 /** End of frame. No payload. */
171 /** Measured quantity, sr_datafeed_analog.mq. */
173 SR_MQ_VOLTAGE = 10000,
179 /** Duty cycle, e.g. on/off ratio. */
181 /** Continuity test. */
185 /** Electrical power, usually in W, or dBm. */
187 /** Gain (a transistor's gain, or hFE, for example). */
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,
195 SR_MQ_RELATIVE_HUMIDITY,
204 /** Unit of measured quantity, sr_datafeed_analog.unit. */
207 SR_UNIT_VOLT = 10000,
208 /** Ampere (current). */
210 /** Ohm (resistance). */
212 /** Farad (capacity). */
214 /** Kelvin (temperature). */
216 /** Degrees Celsius (temperature). */
218 /** Degrees Fahrenheit (temperature). */
220 /** Hertz (frequency, 1/s, [Hz]). */
222 /** Percent value. */
224 /** Boolean value. */
226 /** Time in seconds. */
228 /** Unit of conductance, the inverse of resistance. */
231 * An absolute measurement of power, in decibels, referenced to
235 /** Voltage in decibel, referenced to 1 volt (dBV). */
236 SR_UNIT_DECIBEL_VOLT,
238 * Measurements that intrinsically do not have units attached, such
239 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
240 * a unitless quantity, for example.
243 /** Sound pressure level, in decibels, relative to 20 micropascals. */
246 * Normalized (0 to 1) concentration of a substance or compound with 0
247 * representing a concentration of 0%, and 1 being 100%. This is
248 * represented as the fraction of number of particles of the substance.
250 SR_UNIT_CONCENTRATION,
251 /** Revolutions per minute. */
252 SR_UNIT_REVOLUTIONS_PER_MINUTE,
253 /** Apparent power [VA]. */
255 /** Real power [W]. */
257 /** Consumption [Wh]. */
259 /** Wind speed in meters per second. */
260 SR_UNIT_METER_SECOND,
261 /** Pressure in hectopascal */
263 /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
264 SR_UNIT_HUMIDITY_293K,
267 /** Values for sr_datafeed_analog.flags. */
269 /** Voltage measurement is alternating current (AC). */
271 /** Voltage measurement is direct current (DC). */
273 /** This is a true RMS measurement. */
274 SR_MQFLAG_RMS = 0x04,
275 /** Value is voltage drop across a diode, or NAN. */
276 SR_MQFLAG_DIODE = 0x08,
277 /** Device is in "hold" mode (repeating the last measurement). */
278 SR_MQFLAG_HOLD = 0x10,
279 /** Device is in "max" mode, only updating upon a new max value. */
280 SR_MQFLAG_MAX = 0x20,
281 /** Device is in "min" mode, only updating upon a new min value. */
282 SR_MQFLAG_MIN = 0x40,
283 /** Device is in autoranging mode. */
284 SR_MQFLAG_AUTORANGE = 0x80,
285 /** Device is in relative mode. */
286 SR_MQFLAG_RELATIVE = 0x100,
287 /** Sound pressure level is A-weighted in the frequency domain,
288 * according to IEC 61672:2003. */
289 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
290 /** Sound pressure level is C-weighted in the frequency domain,
291 * according to IEC 61672:2003. */
292 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
293 /** Sound pressure level is Z-weighted (i.e. not at all) in the
294 * frequency domain, according to IEC 61672:2003. */
295 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
296 /** Sound pressure level is not weighted in the frequency domain,
297 * albeit without standards-defined low and high frequency limits. */
298 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
299 /** Sound pressure level measurement is S-weighted (1s) in the
301 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
302 /** Sound pressure level measurement is F-weighted (125ms) in the
304 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
305 /** Sound pressure level is time-averaged (LAT), also known as
306 * Equivalent Continuous A-weighted Sound Level (LEQ). */
307 SR_MQFLAG_SPL_LAT = 0x8000,
308 /** Sound pressure level represented as a percentage of measurements
309 * that were over a preset alarm level. */
310 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
311 /** Time is duration (as opposed to epoch, ...). */
312 SR_MQFLAG_DURATION = 0x20000,
313 /** Device is in "avg" mode, averaging upon each new value. */
314 SR_MQFLAG_AVG = 0x40000,
317 enum sr_trigger_matches {
327 /** The representation of a trigger, consisting of one or more stages
328 * containing one or more matches on a channel.
331 /** A name for this trigger. This may be NULL if none is needed. */
333 /** List of pointers to struct sr_trigger_stage. */
337 /** A trigger stage. */
338 struct sr_trigger_stage {
341 /** List of pointers to struct sr_trigger_match. */
345 /** A channel to match and what to match it on. */
346 struct sr_trigger_match {
347 /** The channel to trigger on. */
348 struct sr_channel *channel;
349 /** The trigger match to use.
350 * For logic channels, only the following matches may be used:
357 * For analog channels, only these matches may be used:
365 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
366 * this contains the value to compare against. */
372 * Opaque structure representing a libsigrok context.
374 * None of the fields of this structure are meant to be accessed directly.
376 * @see sr_init(), sr_exit().
382 * Opaque structure representing a libsigrok session.
384 * None of the fields of this structure are meant to be accessed directly.
386 * @see sr_session_new(), sr_session_destroy().
390 /** Packet in a sigrok data feed. */
391 struct sr_datafeed_packet {
396 /** Header of a sigrok data feed. */
397 struct sr_datafeed_header {
399 struct timeval starttime;
402 /** Datafeed payload for type SR_DF_META. */
403 struct sr_datafeed_meta {
407 /** Logic datafeed payload for type SR_DF_LOGIC. */
408 struct sr_datafeed_logic {
414 /** Analog datafeed payload for type SR_DF_ANALOG. */
415 struct sr_datafeed_analog {
416 /** The channels for which data is included in this packet. */
418 /** Number of samples in data */
420 /** Measured quantity (voltage, current, temperature, and so on).
421 * Use SR_MQ_VOLTAGE, ... */
423 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
425 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
427 /** The analog value(s). The data is interleaved according to
428 * the channels list. */
432 /** Generic option struct used by various subsystems. */
434 /* Short name suitable for commandline usage, [a-z0-9-]. */
436 /* Short name suitable for GUI usage, can contain UTF-8. */
438 /* Description of the option, in a sentence. */
440 /* Default value for this option. */
442 /* List of possible values, if this is an option with few values. */
446 /** Input module metadata keys. */
447 enum sr_input_meta_keys {
448 /** The input filename, if there is one. */
449 SR_INPUT_META_FILENAME = 0x01,
450 /** The input file's size in bytes. */
451 SR_INPUT_META_FILESIZE = 0x02,
452 /** The first 128 bytes of the file, provided as a GString. */
453 SR_INPUT_META_HEADER = 0x04,
454 /** The file's MIME type. */
455 SR_INPUT_META_MIMETYPE = 0x08,
457 /** The module cannot identify a file without this metadata. */
458 SR_INPUT_META_REQUIRED = 0x80,
462 struct sr_input_module;
464 struct sr_output_module;
466 /** Constants for channel type. */
467 enum sr_channeltype {
468 /** Channel type is logic channel. */
469 SR_CHANNEL_LOGIC = 10000,
470 /** Channel type is analog channel. */
474 /** Information on single channel. */
476 /** The index of this channel, starting at 0. Logic channels will
477 * be encoded according to this index in SR_DF_LOGIC packets. */
479 /** Channel type (SR_CHANNEL_LOGIC, ...) */
481 /** Is this channel enabled? */
483 /** Name of channel. */
487 /** Structure for groups of channels that have common properties. */
488 struct sr_channel_group {
489 /** Name of the channel group. */
491 /** List of sr_channel structs of the channels belonging to this group. */
493 /** Private data for driver use. */
497 /** Used for setting or getting value of a config item. */
499 /** Config key like SR_CONF_CONN, etc. */
501 /** Key-specific data. */
505 /** Information about a config key. */
506 struct sr_config_info {
507 /** Config key like SR_CONF_CONN, etc. */
509 /** Data type like SR_T_STRING, etc. */
511 /** Id string, e.g. "serialcomm". */
513 /** Name, e.g. "Serial communication". */
515 /** Verbose description (unused currently). */
519 /** Constants for device classes */
521 /*--- Device classes ------------------------------------------------*/
523 /** The device can act as logic analyzer. */
524 SR_CONF_LOGIC_ANALYZER = 10000,
526 /** The device can act as an oscilloscope. */
527 SR_CONF_OSCILLOSCOPE,
529 /** The device can act as a multimeter. */
532 /** The device is a demo device. */
535 /** The device can act as a sound level meter. */
536 SR_CONF_SOUNDLEVELMETER,
538 /** The device can measure temperature. */
541 /** The device can measure humidity. */
544 /** The device can measure energy consumption. */
547 /** The device can demodulate signals. */
550 /** Programmable power supply. */
551 SR_CONF_POWER_SUPPLY,
553 /*--- Driver scan options -------------------------------------------*/
556 * Specification on how to connect to a device.
558 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
559 * the form which makes sense to the OS (e.g., /dev/ttyS0).
560 * Otherwise this specifies a USB device, either in the form of
561 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
562 * @verbatim <vendorid>.<productid> @endverbatim
563 * (hexadecimal, e.g. 1d6b.0001).
565 SR_CONF_CONN = 20000,
568 * Serial communication specification, in the form:
570 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
574 * The string may also be followed by one or more special settings,
575 * in the form "/key=value". Supported keys and their values are:
577 * rts 0,1 set the port's RTS pin to low or high
578 * dtr 0,1 set the port's DTR pin to low or high
579 * flow 0 no flow control
580 * 1 hardware-based (RTS/CTS) flow control
581 * 2 software-based (XON/XOFF) flow control
583 * This is always an optional parameter, since a driver typically
584 * knows the speed at which the device wants to communicate.
588 /*--- Device configuration ------------------------------------------*/
590 /** The device supports setting its samplerate, in Hz. */
591 SR_CONF_SAMPLERATE = 30000,
593 /** The device supports setting a pre/post-trigger capture ratio. */
594 SR_CONF_CAPTURE_RATIO,
596 /** The device supports setting a pattern (pattern generator mode). */
597 SR_CONF_PATTERN_MODE,
599 /** The device supports Run Length Encoding. */
602 /** The device supports setting trigger slope. */
603 SR_CONF_TRIGGER_SLOPE,
605 /** Trigger source. */
606 SR_CONF_TRIGGER_SOURCE,
608 /** Horizontal trigger position. */
609 SR_CONF_HORIZ_TRIGGERPOS,
626 /** Trigger matches. */
627 SR_CONF_TRIGGER_MATCH,
629 /** The device supports setting its sample interval, in ms. */
630 SR_CONF_SAMPLE_INTERVAL,
632 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
633 SR_CONF_NUM_TIMEBASE,
635 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
638 /** Sound pressure level frequency weighting. */
639 SR_CONF_SPL_WEIGHT_FREQ,
641 /** Sound pressure level time weighting. */
642 SR_CONF_SPL_WEIGHT_TIME,
644 /** Sound pressure level measurement range. */
645 SR_CONF_SPL_MEASUREMENT_RANGE,
647 /** Max hold mode. */
650 /** Min hold mode. */
653 /** Logic low-high threshold range. */
654 SR_CONF_VOLTAGE_THRESHOLD,
656 /** The device supports using an external clock. */
657 SR_CONF_EXTERNAL_CLOCK,
660 * The device supports swapping channels. Typical this is between
661 * buffered and unbuffered channels.
665 /** Center frequency.
666 * The input signal is downmixed by this frequency before the ADC
667 * anti-aliasing filter.
669 SR_CONF_CENTER_FREQUENCY,
671 /** The device supports setting the number of logic channels. */
672 SR_CONF_NUM_LOGIC_CHANNELS,
674 /** The device supports setting the number of analog channels. */
675 SR_CONF_NUM_ANALOG_CHANNELS,
677 /** Output voltage. */
678 SR_CONF_OUTPUT_VOLTAGE,
680 /** Maximum output voltage. */
681 SR_CONF_OUTPUT_VOLTAGE_MAX,
683 /** Output current. */
684 SR_CONF_OUTPUT_CURRENT,
686 /** Maximum output current. */
687 SR_CONF_OUTPUT_CURRENT_MAX,
689 /** Enabling/disabling output. */
690 SR_CONF_OUTPUT_ENABLED,
692 /** Channel output configuration. */
693 SR_CONF_OUTPUT_CHANNEL,
695 /** Over-voltage protection (OVP) */
696 SR_CONF_OVER_VOLTAGE_PROTECTION,
698 /** Over-current protection (OCP) */
699 SR_CONF_OVER_CURRENT_PROTECTION,
701 /** Choice of clock edge for external clock ("r" or "f"). */
704 /** Amplitude of a source without strictly-defined MQ. */
707 /*--- Special stuff -------------------------------------------------*/
709 /** Scan options supported by the driver. */
710 SR_CONF_SCAN_OPTIONS = 40000,
712 /** Device options for a particular device. */
713 SR_CONF_DEVICE_OPTIONS,
715 /** Session filename. */
718 /** The device supports specifying a capturefile to inject. */
721 /** The device supports specifying the capturefile unit size. */
722 SR_CONF_CAPTURE_UNITSIZE,
724 /** Power off the device. */
728 * Data source for acquisition. If not present, acquisition from
729 * the device is always "live", i.e. acquisition starts when the
730 * frontend asks and the results are sent out as soon as possible.
732 * If present, it indicates that either the device has no live
733 * acquisition capability (for example a pure data logger), or
734 * there is a choice. sr_config_list() returns those choices.
736 * In any case if a device has live acquisition capabilities, it
737 * is always the default.
741 /*--- Acquisition modes ---------------------------------------------*/
744 * The device supports setting a sample time limit (how long
745 * the sample acquisition should run, in ms).
747 SR_CONF_LIMIT_MSEC = 50000,
750 * The device supports setting a sample number limit (how many
751 * samples should be acquired).
753 SR_CONF_LIMIT_SAMPLES,
756 * The device supports setting a frame limit (how many
757 * frames should be acquired).
759 SR_CONF_LIMIT_FRAMES,
762 * The device supports continuous sampling. Neither a time limit
763 * nor a sample number limit has to be supplied, it will just acquire
764 * samples continuously, until explicitly stopped by a certain command.
768 /** The device has internal storage, into which data is logged. This
769 * starts or stops the internal logging. */
772 /** Device mode for multi-function devices. */
775 /** Self test mode. */
779 /** Device instance data
782 /** Device driver. */
783 struct sr_dev_driver *driver;
784 /** Index of device in driver. */
786 /** Device instance status. SR_ST_NOT_FOUND, etc. */
788 /** Device instance type. SR_INST_USB, etc. */
790 /** Device vendor. */
794 /** Device version. */
796 /** List of channels. */
798 /** List of sr_channel_group structs */
799 GSList *channel_groups;
800 /** Device instance connection data (used?) */
802 /** Device instance private data (used?) */
804 /** Session to which this device is currently assigned. */
805 struct sr_session *session;
808 /** Types of device instance, struct sr_dev_inst.type */
809 enum sr_dev_inst_type {
810 /** Device instance type for USB devices. */
812 /** Device instance type for serial port devices. */
814 /** Device instance type for SCPI devices. */
818 /** Device instance status, struct sr_dev_inst.status */
819 enum sr_dev_inst_status {
820 /** The device instance was not found. */
821 SR_ST_NOT_FOUND = 10000,
822 /** The device instance was found, but is still booting. */
824 /** The device instance is live, but not in use. */
826 /** The device instance is actively in use in a session. */
828 /** The device is winding down its session. */
832 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
833 struct sr_dev_driver {
834 /* Driver-specific */
835 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
837 /** Long name. Verbose driver name shown to user. */
839 /** API version (currently 1). */
841 /** Called when driver is loaded, e.g. program startup. */
842 int (*init) (struct sr_context *sr_ctx);
843 /** Called before driver is unloaded.
844 * Driver must free all resouces held by it. */
845 int (*cleanup) (void);
846 /** Scan for devices. Driver should do all initialisation required.
847 * Can be called several times, e.g. with different port options.
848 * \retval NULL Error or no devices found.
849 * \retval other GSList of a struct sr_dev_inst for each device.
850 * Must be freed by caller!
852 GSList *(*scan) (GSList *options);
853 /** Get list of device instances the driver knows about.
854 * \returns NULL or GSList of a struct sr_dev_inst for each device.
855 * Must not be freed by caller!
857 GSList *(*dev_list) (void);
858 /** Clear list of devices the driver knows about. */
859 int (*dev_clear) (void);
860 /** Query value of a configuration key in driver or given device instance.
861 * @see sr_config_get().
863 int (*config_get) (int id, GVariant **data,
864 const struct sr_dev_inst *sdi,
865 const struct sr_channel_group *cg);
866 /** Set value of a configuration key in driver or a given device instance.
867 * @see sr_config_set(). */
868 int (*config_set) (int id, GVariant *data,
869 const struct sr_dev_inst *sdi,
870 const struct sr_channel_group *cg);
871 /** Channel status change.
872 * @see sr_dev_channel_enable(). */
873 int (*config_channel_set) (const struct sr_dev_inst *sdi,
874 struct sr_channel *ch, unsigned int changes);
875 /** Apply configuration settings to the device hardware.
876 * @see sr_config_commit().*/
877 int (*config_commit) (const struct sr_dev_inst *sdi);
878 /** List all possible values for a configuration key in a device instance.
879 * @see sr_config_list().
881 int (*config_list) (int info_id, GVariant **data,
882 const struct sr_dev_inst *sdi,
883 const struct sr_channel_group *cg);
885 /* Device-specific */
887 int (*dev_open) (struct sr_dev_inst *sdi);
889 int (*dev_close) (struct sr_dev_inst *sdi);
890 /** Begin data acquisition on the specified device. */
891 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
893 /** End data acquisition on the specified device. */
894 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
898 /** Device driver private data. Initialized by init(). */
905 * Opaque data structure representing a libsigrok session. None of the fields
906 * of this structure are meant to be accessed directly.