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_CONTINUE = 1, /**< Keep going. */
68 SR_OK = 0, /**< No error. */
69 SR_ERR = -1, /**< Generic/unspecified error. */
70 SR_ERR_MALLOC = -2, /**< Malloc/calloc/realloc error. */
71 SR_ERR_ARG = -3, /**< Function argument error. */
72 SR_ERR_BUG = -4, /**< Errors hinting at internal bugs. */
73 SR_ERR_SAMPLERATE = -5, /**< Incorrect samplerate. */
74 SR_ERR_NA = -6, /**< Not applicable. */
75 SR_ERR_DEV_CLOSED = -7, /**< Device is closed, but must be open. */
76 SR_ERR_TIMEOUT = -8, /**< A timeout occurred. */
77 SR_ERR_CHANNEL_GROUP = -9, /**< A channel group must be specified. */
78 SR_ERR_DATA =-10, /**< Data is invalid. */
79 SR_ERR_IO =-11, /**< Input/output error. */
82 * Note: When adding entries here, don't forget to also update the
83 * sr_strerror() and sr_strerror_name() functions in error.c.
87 #define SR_MAX_CHANNELNAME_LEN 32
89 /* Handy little macros */
91 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
92 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
93 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
95 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
97 /** libsigrok loglevels. */
99 SR_LOG_NONE = 0, /**< Output no messages at all. */
100 SR_LOG_ERR = 1, /**< Output error messages. */
101 SR_LOG_WARN = 2, /**< Output warnings. */
102 SR_LOG_INFO = 3, /**< Output informational messages. */
103 SR_LOG_DBG = 4, /**< Output debug messages. */
104 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
108 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
110 * Variables and functions marked 'static' are private already and don't
111 * need SR_PRIV. However, functions which are not static (because they need
112 * to be used in other libsigrok-internal files) but are also not meant to
113 * be part of the public libsigrok API, must use SR_PRIV.
115 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
117 * This feature is not available on MinGW/Windows, as it is a feature of
118 * ELF files and MinGW/Windows uses PE files.
120 * Details: http://gcc.gnu.org/wiki/Visibility
123 /* Marks public libsigrok API symbols. */
125 #define SR_API __attribute__((visibility("default")))
130 /* Marks private, non-public libsigrok symbols (not part of the API). */
132 #define SR_PRIV __attribute__((visibility("hidden")))
137 /** Type definition for callback function for data reception. */
138 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
140 /** Data types used by sr_config_info(). */
146 SR_T_RATIONAL_PERIOD,
154 /** Value for sr_datafeed_packet.type. */
156 /** Payload is sr_datafeed_header. */
157 SR_DF_HEADER = 10000,
158 /** End of stream (no further data). */
160 /** Payload is struct sr_datafeed_meta */
162 /** The trigger matched at this point in the data feed. No payload. */
164 /** Payload is struct sr_datafeed_logic. */
166 /** Payload is struct sr_datafeed_analog. */
168 /** Beginning of frame. No payload. */
170 /** End of frame. No payload. */
172 /** Payload is struct sr_datafeed_analog2. */
176 /** Measured quantity, sr_datafeed_analog.mq. */
178 SR_MQ_VOLTAGE = 10000,
184 /** Duty cycle, e.g. on/off ratio. */
186 /** Continuity test. */
190 /** Electrical power, usually in W, or dBm. */
192 /** Gain (a transistor's gain, or hFE, for example). */
194 /** Logarithmic representation of sound pressure relative to a
195 * reference value. */
196 SR_MQ_SOUND_PRESSURE_LEVEL,
197 /** Carbon monoxide level */
198 SR_MQ_CARBON_MONOXIDE,
200 SR_MQ_RELATIVE_HUMIDITY,
207 /** Parallel inductance (LCR meter model). */
208 SR_MQ_PARALLEL_INDUCTANCE,
209 /** Parallel capacitance (LCR meter model). */
210 SR_MQ_PARALLEL_CAPACITANCE,
211 /** Parallel resistance (LCR meter model). */
212 SR_MQ_PARALLEL_RESISTANCE,
213 /** Series inductance (LCR meter model). */
214 SR_MQ_SERIES_INDUCTANCE,
215 /** Series capacitance (LCR meter model). */
216 SR_MQ_SERIES_CAPACITANCE,
217 /** Series resistance (LCR meter model). */
218 SR_MQ_SERIES_RESISTANCE,
219 /** Dissipation factor. */
220 SR_MQ_DISSIPATION_FACTOR,
221 /** Quality factor. */
222 SR_MQ_QUALITY_FACTOR,
225 /** Difference from reference value. */
231 /** Apparent power */
232 SR_MQ_APPARENT_POWER,
235 /** Unit of measured quantity, sr_datafeed_analog.unit. */
238 SR_UNIT_VOLT = 10000,
239 /** Ampere (current). */
241 /** Ohm (resistance). */
243 /** Farad (capacity). */
245 /** Kelvin (temperature). */
247 /** Degrees Celsius (temperature). */
249 /** Degrees Fahrenheit (temperature). */
251 /** Hertz (frequency, 1/s, [Hz]). */
253 /** Percent value. */
255 /** Boolean value. */
257 /** Time in seconds. */
259 /** Unit of conductance, the inverse of resistance. */
262 * An absolute measurement of power, in decibels, referenced to
266 /** Voltage in decibel, referenced to 1 volt (dBV). */
267 SR_UNIT_DECIBEL_VOLT,
269 * Measurements that intrinsically do not have units attached, such
270 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
271 * a unitless quantity, for example.
274 /** Sound pressure level, in decibels, relative to 20 micropascals. */
277 * Normalized (0 to 1) concentration of a substance or compound with 0
278 * representing a concentration of 0%, and 1 being 100%. This is
279 * represented as the fraction of number of particles of the substance.
281 SR_UNIT_CONCENTRATION,
282 /** Revolutions per minute. */
283 SR_UNIT_REVOLUTIONS_PER_MINUTE,
284 /** Apparent power [VA]. */
286 /** Real power [W]. */
288 /** Consumption [Wh]. */
290 /** Wind speed in meters per second. */
291 SR_UNIT_METER_SECOND,
292 /** Pressure in hectopascal */
294 /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
295 SR_UNIT_HUMIDITY_293K,
296 /** Plane angle in 1/360th of a full circle. */
298 /** Henry (inductance). */
302 /** Values for sr_datafeed_analog.flags. */
304 /** Voltage measurement is alternating current (AC). */
306 /** Voltage measurement is direct current (DC). */
308 /** This is a true RMS measurement. */
309 SR_MQFLAG_RMS = 0x04,
310 /** Value is voltage drop across a diode, or NAN. */
311 SR_MQFLAG_DIODE = 0x08,
312 /** Device is in "hold" mode (repeating the last measurement). */
313 SR_MQFLAG_HOLD = 0x10,
314 /** Device is in "max" mode, only updating upon a new max value. */
315 SR_MQFLAG_MAX = 0x20,
316 /** Device is in "min" mode, only updating upon a new min value. */
317 SR_MQFLAG_MIN = 0x40,
318 /** Device is in autoranging mode. */
319 SR_MQFLAG_AUTORANGE = 0x80,
320 /** Device is in relative mode. */
321 SR_MQFLAG_RELATIVE = 0x100,
322 /** Sound pressure level is A-weighted in the frequency domain,
323 * according to IEC 61672:2003. */
324 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
325 /** Sound pressure level is C-weighted in the frequency domain,
326 * according to IEC 61672:2003. */
327 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
328 /** Sound pressure level is Z-weighted (i.e. not at all) in the
329 * frequency domain, according to IEC 61672:2003. */
330 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
331 /** Sound pressure level is not weighted in the frequency domain,
332 * albeit without standards-defined low and high frequency limits. */
333 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
334 /** Sound pressure level measurement is S-weighted (1s) in the
336 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
337 /** Sound pressure level measurement is F-weighted (125ms) in the
339 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
340 /** Sound pressure level is time-averaged (LAT), also known as
341 * Equivalent Continuous A-weighted Sound Level (LEQ). */
342 SR_MQFLAG_SPL_LAT = 0x8000,
343 /** Sound pressure level represented as a percentage of measurements
344 * that were over a preset alarm level. */
345 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
346 /** Time is duration (as opposed to epoch, ...). */
347 SR_MQFLAG_DURATION = 0x20000,
348 /** Device is in "avg" mode, averaging upon each new value. */
349 SR_MQFLAG_AVG = 0x40000,
350 /** Reference value shown. */
351 SR_MQFLAG_REFERENCE = 0x80000,
354 enum sr_trigger_matches {
364 /** The representation of a trigger, consisting of one or more stages
365 * containing one or more matches on a channel.
368 /** A name for this trigger. This may be NULL if none is needed. */
370 /** List of pointers to struct sr_trigger_stage. */
374 /** A trigger stage. */
375 struct sr_trigger_stage {
378 /** List of pointers to struct sr_trigger_match. */
382 /** A channel to match and what to match it on. */
383 struct sr_trigger_match {
384 /** The channel to trigger on. */
385 struct sr_channel *channel;
386 /** The trigger match to use.
387 * For logic channels, only the following matches may be used:
394 * For analog channels, only these matches may be used:
402 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
403 * this contains the value to compare against. */
409 * Opaque structure representing a libsigrok context.
411 * None of the fields of this structure are meant to be accessed directly.
413 * @see sr_init(), sr_exit().
419 * Opaque structure representing a libsigrok session.
421 * None of the fields of this structure are meant to be accessed directly.
423 * @see sr_session_new(), sr_session_destroy().
428 /** Numerator of the rational number. */
430 /** Denominator of the rational number. */
434 /** Packet in a sigrok data feed. */
435 struct sr_datafeed_packet {
440 /** Header of a sigrok data feed. */
441 struct sr_datafeed_header {
443 struct timeval starttime;
446 /** Datafeed payload for type SR_DF_META. */
447 struct sr_datafeed_meta {
451 /** Logic datafeed payload for type SR_DF_LOGIC. */
452 struct sr_datafeed_logic {
458 /** Analog datafeed payload for type SR_DF_ANALOG. */
459 struct sr_datafeed_analog {
460 /** The channels for which data is included in this packet. */
462 /** Number of samples in data */
464 /** Measured quantity (voltage, current, temperature, and so on).
465 * Use SR_MQ_VOLTAGE, ... */
467 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
469 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
471 /** The analog value(s). The data is interleaved according to
472 * the channels list. */
476 /** Analog datafeed payload for type SR_DF_ANALOG2. */
477 struct sr_datafeed_analog2 {
479 uint32_t num_samples;
480 struct sr_analog_encoding *encoding;
481 struct sr_analog_meaning *meaning;
482 struct sr_analog_spec *spec;
485 struct sr_analog_encoding {
489 gboolean is_bigendian;
491 gboolean is_digits_decimal;
492 struct sr_rational scale;
493 struct sr_rational offset;
496 struct sr_analog_meaning {
499 enum sr_mqflag mqflags;
503 struct sr_analog_spec {
507 /** Generic option struct used by various subsystems. */
509 /* Short name suitable for commandline usage, [a-z0-9-]. */
511 /* Short name suitable for GUI usage, can contain UTF-8. */
513 /* Description of the option, in a sentence. */
515 /* Default value for this option. */
517 /* List of possible values, if this is an option with few values. */
521 /** Output module flags. */
522 enum sr_output_flag {
523 /** If set, this output module writes the output itself. */
524 SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
528 struct sr_input_module;
530 struct sr_output_module;
532 struct sr_transform_module;
534 /** Constants for channel type. */
535 enum sr_channeltype {
536 /** Channel type is logic channel. */
537 SR_CHANNEL_LOGIC = 10000,
538 /** Channel type is analog channel. */
542 /** Information on single channel. */
544 /** The device this channel is attached to. */
545 struct sr_dev_inst *sdi;
546 /** The index of this channel, starting at 0. Logic channels will
547 * be encoded according to this index in SR_DF_LOGIC packets. */
549 /** Channel type (SR_CHANNEL_LOGIC, ...) */
551 /** Is this channel enabled? */
553 /** Name of channel. */
555 /** Private data for driver use. */
559 /** Structure for groups of channels that have common properties. */
560 struct sr_channel_group {
561 /** Name of the channel group. */
563 /** List of sr_channel structs of the channels belonging to this group. */
565 /** Private data for driver use. */
569 /** Used for setting or getting value of a config item. */
571 /** Config key like SR_CONF_CONN, etc. */
573 /** Key-specific data. */
577 /** Information about a config key. */
578 struct sr_config_info {
579 /** Config key like SR_CONF_CONN, etc. */
581 /** Data type like SR_T_STRING, etc. */
583 /** Id string, e.g. "serialcomm". */
585 /** Name, e.g. "Serial communication". */
587 /** Verbose description (unused currently). */
591 #define SR_CONF_GET (1 << 31)
592 #define SR_CONF_SET (1 << 30)
593 #define SR_CONF_LIST (1 << 29)
594 #define SR_CONF_MASK 0x1fffffff
596 /** Configuration keys */
598 /*--- Device classes ------------------------------------------------*/
600 /** The device can act as logic analyzer. */
601 SR_CONF_LOGIC_ANALYZER = 10000,
603 /** The device can act as an oscilloscope. */
604 SR_CONF_OSCILLOSCOPE,
606 /** The device can act as a multimeter. */
609 /** The device is a demo device. */
612 /** The device can act as a sound level meter. */
613 SR_CONF_SOUNDLEVELMETER,
615 /** The device can measure temperature. */
618 /** The device can measure humidity. */
621 /** The device can measure energy consumption. */
624 /** The device can act as a signal demodulator. */
627 /** The device can act as a programmable power supply. */
628 SR_CONF_POWER_SUPPLY,
630 /** The device can act as an LCR meter. */
633 /** The device can act as an electronic load. */
634 SR_CONF_ELECTRONIC_LOAD,
636 /*--- Driver scan options -------------------------------------------*/
639 * Specification on how to connect to a device.
641 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
642 * the form which makes sense to the OS (e.g., /dev/ttyS0).
643 * Otherwise this specifies a USB device, either in the form of
644 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
645 * @verbatim <vendorid>.<productid> @endverbatim
646 * (hexadecimal, e.g. 1d6b.0001).
648 SR_CONF_CONN = 20000,
651 * Serial communication specification, in the form:
653 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
657 * The string may also be followed by one or more special settings,
658 * in the form "/key=value". Supported keys and their values are:
660 * rts 0,1 set the port's RTS pin to low or high
661 * dtr 0,1 set the port's DTR pin to low or high
662 * flow 0 no flow control
663 * 1 hardware-based (RTS/CTS) flow control
664 * 2 software-based (XON/XOFF) flow control
666 * This is always an optional parameter, since a driver typically
667 * knows the speed at which the device wants to communicate.
672 * Modbus slave address specification.
674 * This is always an optional parameter, since a driver typically
675 * knows the default slave address of the device.
679 /*--- Device (or channel group) configuration -----------------------*/
681 /** The device supports setting its samplerate, in Hz. */
682 SR_CONF_SAMPLERATE = 30000,
684 /** The device supports setting a pre/post-trigger capture ratio. */
685 SR_CONF_CAPTURE_RATIO,
687 /** The device supports setting a pattern (pattern generator mode). */
688 SR_CONF_PATTERN_MODE,
690 /** The device supports run-length encoding (RLE). */
693 /** The device supports setting trigger slope. */
694 SR_CONF_TRIGGER_SLOPE,
696 /** The device supports averaging. */
700 * The device supports setting number of samples to be
705 /** Trigger source. */
706 SR_CONF_TRIGGER_SOURCE,
708 /** Horizontal trigger position. */
709 SR_CONF_HORIZ_TRIGGERPOS,
726 /** Trigger matches. */
727 SR_CONF_TRIGGER_MATCH,
729 /** The device supports setting its sample interval, in ms. */
730 SR_CONF_SAMPLE_INTERVAL,
732 /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
735 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
738 /** Sound pressure level frequency weighting. */
739 SR_CONF_SPL_WEIGHT_FREQ,
741 /** Sound pressure level time weighting. */
742 SR_CONF_SPL_WEIGHT_TIME,
744 /** Sound pressure level measurement range. */
745 SR_CONF_SPL_MEASUREMENT_RANGE,
747 /** Max hold mode. */
750 /** Min hold mode. */
753 /** Logic low-high threshold range. */
754 SR_CONF_VOLTAGE_THRESHOLD,
756 /** The device supports using an external clock. */
757 SR_CONF_EXTERNAL_CLOCK,
760 * The device supports swapping channels. Typical this is between
761 * buffered and unbuffered channels.
765 /** Center frequency.
766 * The input signal is downmixed by this frequency before the ADC
767 * anti-aliasing filter.
769 SR_CONF_CENTER_FREQUENCY,
771 /** The device supports setting the number of logic channels. */
772 SR_CONF_NUM_LOGIC_CHANNELS,
774 /** The device supports setting the number of analog channels. */
775 SR_CONF_NUM_ANALOG_CHANNELS,
780 * @arg get: get measured voltage
785 * Maximum target voltage.
787 * @arg get: get target voltage
788 * @arg set: change target voltage
790 SR_CONF_VOLTAGE_TARGET,
795 * @arg get: get measured current
802 * @arg get: get current limit
803 * @arg set: change current limit
805 SR_CONF_CURRENT_LIMIT,
808 * Enabling/disabling channel.
810 * @arg get: @b true if currently enabled
811 * @arg set: enable/disable
816 * Channel configuration.
818 * @arg get: get current setting
819 * @arg set: change current setting
820 * @arg list: array of possible values
822 SR_CONF_CHANNEL_CONFIG,
825 * Over-voltage protection (OVP) feature
827 * @arg get: @b true if currently enabled
828 * @arg set: enable/disable
830 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
833 * Over-voltage protection (OVP) active
835 * @arg get: @b true if device has activated OVP, i.e. the output voltage
836 * exceeds the over-voltage protection threshold.
838 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
841 * Over-voltage protection (OVP) threshold
842 * @arg type: double (voltage)
843 * @arg get: get current threshold
844 * @arg set: set new threshold
846 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
849 * Over-current protection (OCP) feature
851 * @arg get: @b true if currently enabled
852 * @arg set: enable/disable
854 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
857 * Over-current protection (OCP) active
859 * @arg get: @b true if device has activated OCP, i.e. the current current
860 * exceeds the over-current protection threshold.
862 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
865 * Over-current protection (OCP) threshold
866 * @arg type: double (current)
867 * @arg get: get current threshold
868 * @arg set: set new threshold
870 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
872 /** Choice of clock edge for external clock ("r" or "f"). */
875 /** Amplitude of a source without strictly-defined MQ. */
880 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
885 /** Over-temperature protection (OTP) */
886 SR_CONF_OVER_TEMPERATURE_PROTECTION,
888 /** Output frequency in Hz. */
889 SR_CONF_OUTPUT_FREQUENCY,
891 /** Measured quantity. */
892 SR_CONF_MEASURED_QUANTITY,
894 /** Measured secondary quantity. */
895 SR_CONF_MEASURED_2ND_QUANTITY,
897 /** Equivalent circuit model. */
898 SR_CONF_EQUIV_CIRCUIT_MODEL,
900 /* Output frequency target in Hz. */
901 SR_CONF_OUTPUT_FREQUENCY_TARGET,
903 /** Over-temperature protection (OTP) active. */
904 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
906 /*--- Special stuff -------------------------------------------------*/
908 /** Scan options supported by the driver. */
909 SR_CONF_SCAN_OPTIONS = 40000,
911 /** Device options for a particular device. */
912 SR_CONF_DEVICE_OPTIONS,
914 /** Session filename. */
917 /** The device supports specifying a capturefile to inject. */
920 /** The device supports specifying the capturefile unit size. */
921 SR_CONF_CAPTURE_UNITSIZE,
923 /** Power off the device. */
927 * Data source for acquisition. If not present, acquisition from
928 * the device is always "live", i.e. acquisition starts when the
929 * frontend asks and the results are sent out as soon as possible.
931 * If present, it indicates that either the device has no live
932 * acquisition capability (for example a pure data logger), or
933 * there is a choice. sr_config_list() returns those choices.
935 * In any case if a device has live acquisition capabilities, it
936 * is always the default.
940 /** The device supports setting a probe factor. */
941 SR_CONF_PROBE_FACTOR,
943 /*--- Acquisition modes, sample limiting ----------------------------*/
946 * The device supports setting a sample time limit (how long
947 * the sample acquisition should run, in ms).
949 SR_CONF_LIMIT_MSEC = 50000,
952 * The device supports setting a sample number limit (how many
953 * samples should be acquired).
955 SR_CONF_LIMIT_SAMPLES,
958 * The device supports setting a frame limit (how many
959 * frames should be acquired).
961 SR_CONF_LIMIT_FRAMES,
964 * The device supports continuous sampling. Neither a time limit
965 * nor a sample number limit has to be supplied, it will just acquire
966 * samples continuously, until explicitly stopped by a certain command.
970 /** The device has internal storage, into which data is logged. This
971 * starts or stops the internal logging. */
974 /** Device mode for multi-function devices. */
977 /** Self test mode. */
982 * Opaque structure representing a libsigrok device instance.
984 * None of the fields of this structure are meant to be accessed directly.
988 /** Types of device instance, struct sr_dev_inst.type */
989 enum sr_dev_inst_type {
990 /** Device instance type for USB devices. */
992 /** Device instance type for serial port devices. */
994 /** Device instance type for SCPI devices. */
996 /** Device-instance type for user-created "devices". */
998 /** Device instance type for Modbus devices. */
1002 /** Device instance status, struct sr_dev_inst.status */
1003 enum sr_dev_inst_status {
1004 /** The device instance was not found. */
1005 SR_ST_NOT_FOUND = 10000,
1006 /** The device instance was found, but is still booting. */
1008 /** The device instance is live, but not in use. */
1010 /** The device instance is actively in use in a session. */
1012 /** The device is winding down its session. */
1016 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1017 struct sr_dev_driver {
1018 /* Driver-specific */
1019 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1021 /** Long name. Verbose driver name shown to user. */
1023 /** API version (currently 1). */
1025 /** Called when driver is loaded, e.g. program startup. */
1026 int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1027 /** Called before driver is unloaded.
1028 * Driver must free all resources held by it. */
1029 int (*cleanup) (const struct sr_dev_driver *driver);
1030 /** Scan for devices. Driver should do all initialisation required.
1031 * Can be called several times, e.g. with different port options.
1032 * @retval NULL Error or no devices found.
1033 * @retval other GSList of a struct sr_dev_inst for each device.
1034 * Must be freed by caller!
1036 GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1037 /** Get list of device instances the driver knows about.
1038 * @returns NULL or GSList of a struct sr_dev_inst for each device.
1039 * Must not be freed by caller!
1041 GSList *(*dev_list) (const struct sr_dev_driver *driver);
1042 /** Clear list of devices the driver knows about. */
1043 int (*dev_clear) (const struct sr_dev_driver *driver);
1044 /** Query value of a configuration key in driver or given device instance.
1045 * @see sr_config_get().
1047 int (*config_get) (uint32_t key, GVariant **data,
1048 const struct sr_dev_inst *sdi,
1049 const struct sr_channel_group *cg);
1050 /** Set value of a configuration key in driver or a given device instance.
1051 * @see sr_config_set(). */
1052 int (*config_set) (uint32_t key, GVariant *data,
1053 const struct sr_dev_inst *sdi,
1054 const struct sr_channel_group *cg);
1055 /** Channel status change.
1056 * @see sr_dev_channel_enable(). */
1057 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1058 struct sr_channel *ch, unsigned int changes);
1059 /** Apply configuration settings to the device hardware.
1060 * @see sr_config_commit().*/
1061 int (*config_commit) (const struct sr_dev_inst *sdi);
1062 /** List all possible values for a configuration key in a device instance.
1063 * @see sr_config_list().
1065 int (*config_list) (uint32_t key, GVariant **data,
1066 const struct sr_dev_inst *sdi,
1067 const struct sr_channel_group *cg);
1069 /* Device-specific */
1071 int (*dev_open) (struct sr_dev_inst *sdi);
1073 int (*dev_close) (struct sr_dev_inst *sdi);
1074 /** Begin data acquisition on the specified device. */
1075 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1077 /** End data acquisition on the specified device. */
1078 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1082 /** Device driver context, considered private. Initialized by init(). */
1087 * @struct sr_session
1089 * Opaque data structure representing a libsigrok session. None of the fields
1090 * of this structure are meant to be accessed directly.
1094 /** Serial port descriptor. */
1095 struct sr_serial_port {
1096 /** The OS dependent name of the serial port. */
1098 /** An end user friendly description for the serial port. */
1102 #include <libsigrok/proto.h>
1103 #include <libsigrok/version.h>