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. */
77 SR_ERR_DATA =-10, /**< Data is invalid. */
78 SR_ERR_IO =-11, /**< Input/output error. */
80 /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
83 #define SR_MAX_CHANNELNAME_LEN 32
85 /* Handy little macros */
87 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
88 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
89 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
91 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
93 /** libsigrok loglevels. */
95 SR_LOG_NONE = 0, /**< Output no messages at all. */
96 SR_LOG_ERR = 1, /**< Output error messages. */
97 SR_LOG_WARN = 2, /**< Output warnings. */
98 SR_LOG_INFO = 3, /**< Output informational messages. */
99 SR_LOG_DBG = 4, /**< Output debug messages. */
100 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
104 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
106 * Variables and functions marked 'static' are private already and don't
107 * need SR_PRIV. However, functions which are not static (because they need
108 * to be used in other libsigrok-internal files) but are also not meant to
109 * be part of the public libsigrok API, must use SR_PRIV.
111 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
113 * This feature is not available on MinGW/Windows, as it is a feature of
114 * ELF files and MinGW/Windows uses PE files.
116 * Details: http://gcc.gnu.org/wiki/Visibility
119 /* Marks public libsigrok API symbols. */
121 #define SR_API __attribute__((visibility("default")))
126 /* Marks private, non-public libsigrok symbols (not part of the API). */
128 #define SR_PRIV __attribute__((visibility("hidden")))
133 /** Type definition for callback function for data reception. */
134 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
136 /** Data types used by sr_config_info(). */
142 SR_T_RATIONAL_PERIOD,
150 /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
153 /** Value for sr_datafeed_packet.type. */
155 /** Payload is sr_datafeed_header. */
156 SR_DF_HEADER = 10000,
157 /** End of stream (no further data). */
159 /** Payload is struct sr_datafeed_meta */
161 /** The trigger matched at this point in the data feed. No payload. */
163 /** Payload is struct sr_datafeed_logic. */
165 /** Beginning of frame. No payload. */
167 /** End of frame. No payload. */
169 /** Payload is struct sr_datafeed_analog. */
172 /* Update datafeed_dump() (session.c) upon changes! */
175 /** Measured quantity, sr_analog_meaning.mq. */
177 SR_MQ_VOLTAGE = 10000,
183 /** Duty cycle, e.g. on/off ratio. */
185 /** Continuity test. */
189 /** Electrical power, usually in W, or dBm. */
191 /** Gain (a transistor's gain, or hFE, for example). */
193 /** Logarithmic representation of sound pressure relative to a
194 * reference value. */
195 SR_MQ_SOUND_PRESSURE_LEVEL,
196 /** Carbon monoxide level */
197 SR_MQ_CARBON_MONOXIDE,
199 SR_MQ_RELATIVE_HUMIDITY,
206 /** Parallel inductance (LCR meter model). */
207 SR_MQ_PARALLEL_INDUCTANCE,
208 /** Parallel capacitance (LCR meter model). */
209 SR_MQ_PARALLEL_CAPACITANCE,
210 /** Parallel resistance (LCR meter model). */
211 SR_MQ_PARALLEL_RESISTANCE,
212 /** Series inductance (LCR meter model). */
213 SR_MQ_SERIES_INDUCTANCE,
214 /** Series capacitance (LCR meter model). */
215 SR_MQ_SERIES_CAPACITANCE,
216 /** Series resistance (LCR meter model). */
217 SR_MQ_SERIES_RESISTANCE,
218 /** Dissipation factor. */
219 SR_MQ_DISSIPATION_FACTOR,
220 /** Quality factor. */
221 SR_MQ_QUALITY_FACTOR,
224 /** Difference from reference value. */
230 /** Apparent power */
231 SR_MQ_APPARENT_POWER,
234 /** Harmonic ratio */
235 SR_MQ_HARMONIC_RATIO,
237 /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
240 /** Unit of measured quantity, sr_analog_meaning.unit. */
243 SR_UNIT_VOLT = 10000,
244 /** Ampere (current). */
246 /** Ohm (resistance). */
248 /** Farad (capacity). */
250 /** Kelvin (temperature). */
252 /** Degrees Celsius (temperature). */
254 /** Degrees Fahrenheit (temperature). */
256 /** Hertz (frequency, 1/s, [Hz]). */
258 /** Percent value. */
260 /** Boolean value. */
262 /** Time in seconds. */
264 /** Unit of conductance, the inverse of resistance. */
267 * An absolute measurement of power, in decibels, referenced to
271 /** Voltage in decibel, referenced to 1 volt (dBV). */
272 SR_UNIT_DECIBEL_VOLT,
274 * Measurements that intrinsically do not have units attached, such
275 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
276 * a unitless quantity, for example.
279 /** Sound pressure level, in decibels, relative to 20 micropascals. */
282 * Normalized (0 to 1) concentration of a substance or compound with 0
283 * representing a concentration of 0%, and 1 being 100%. This is
284 * represented as the fraction of number of particles of the substance.
286 SR_UNIT_CONCENTRATION,
287 /** Revolutions per minute. */
288 SR_UNIT_REVOLUTIONS_PER_MINUTE,
289 /** Apparent power [VA]. */
291 /** Real power [W]. */
293 /** Consumption [Wh]. */
295 /** Wind speed in meters per second. */
296 SR_UNIT_METER_SECOND,
297 /** Pressure in hectopascal */
299 /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
300 SR_UNIT_HUMIDITY_293K,
301 /** Plane angle in 1/360th of a full circle. */
303 /** Henry (inductance). */
305 /** Mass in gram [g]. */
307 /** Mass in carat [ct]. */
309 /** Mass in ounce [oz]. */
311 /** Mass in troy ounce [oz t]. */
313 /** Mass in pound [lb]. */
315 /** Mass in pennyweight [dwt]. */
317 /** Mass in grain [gr]. */
319 /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
321 /** Mass in momme. */
325 /** Pieces (number of items). */
329 * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
334 /** Values for sr_analog_meaning.mqflags. */
336 /** Voltage measurement is alternating current (AC). */
338 /** Voltage measurement is direct current (DC). */
340 /** This is a true RMS measurement. */
341 SR_MQFLAG_RMS = 0x04,
342 /** Value is voltage drop across a diode, or NAN. */
343 SR_MQFLAG_DIODE = 0x08,
344 /** Device is in "hold" mode (repeating the last measurement). */
345 SR_MQFLAG_HOLD = 0x10,
346 /** Device is in "max" mode, only updating upon a new max value. */
347 SR_MQFLAG_MAX = 0x20,
348 /** Device is in "min" mode, only updating upon a new min value. */
349 SR_MQFLAG_MIN = 0x40,
350 /** Device is in autoranging mode. */
351 SR_MQFLAG_AUTORANGE = 0x80,
352 /** Device is in relative mode. */
353 SR_MQFLAG_RELATIVE = 0x100,
354 /** Sound pressure level is A-weighted in the frequency domain,
355 * according to IEC 61672:2003. */
356 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
357 /** Sound pressure level is C-weighted in the frequency domain,
358 * according to IEC 61672:2003. */
359 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
360 /** Sound pressure level is Z-weighted (i.e. not at all) in the
361 * frequency domain, according to IEC 61672:2003. */
362 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
363 /** Sound pressure level is not weighted in the frequency domain,
364 * albeit without standards-defined low and high frequency limits. */
365 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
366 /** Sound pressure level measurement is S-weighted (1s) in the
368 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
369 /** Sound pressure level measurement is F-weighted (125ms) in the
371 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
372 /** Sound pressure level is time-averaged (LAT), also known as
373 * Equivalent Continuous A-weighted Sound Level (LEQ). */
374 SR_MQFLAG_SPL_LAT = 0x8000,
375 /** Sound pressure level represented as a percentage of measurements
376 * that were over a preset alarm level. */
377 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
378 /** Time is duration (as opposed to epoch, ...). */
379 SR_MQFLAG_DURATION = 0x20000,
380 /** Device is in "avg" mode, averaging upon each new value. */
381 SR_MQFLAG_AVG = 0x40000,
382 /** Reference value shown. */
383 SR_MQFLAG_REFERENCE = 0x80000,
384 /** Unstable value (hasn't settled yet). */
385 SR_MQFLAG_UNSTABLE = 0x100000,
386 /** Measurement is four wire (e.g. Kelvin connection). */
387 SR_MQFLAG_FOUR_WIRE = 0x200000,
390 * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
395 enum sr_trigger_matches {
405 /** The representation of a trigger, consisting of one or more stages
406 * containing one or more matches on a channel.
409 /** A name for this trigger. This may be NULL if none is needed. */
411 /** List of pointers to struct sr_trigger_stage. */
415 /** A trigger stage. */
416 struct sr_trigger_stage {
419 /** List of pointers to struct sr_trigger_match. */
423 /** A channel to match and what to match it on. */
424 struct sr_trigger_match {
425 /** The channel to trigger on. */
426 struct sr_channel *channel;
427 /** The trigger match to use.
428 * For logic channels, only the following matches may be used:
435 * For analog channels, only these matches may be used:
443 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
444 * this contains the value to compare against. */
450 * Opaque structure representing a libsigrok context.
452 * None of the fields of this structure are meant to be accessed directly.
454 * @see sr_init(), sr_exit().
460 * Opaque structure representing a libsigrok session.
462 * None of the fields of this structure are meant to be accessed directly.
464 * @see sr_session_new(), sr_session_destroy().
469 /** Numerator of the rational number. */
471 /** Denominator of the rational number. */
475 /** Packet in a sigrok data feed. */
476 struct sr_datafeed_packet {
481 /** Header of a sigrok data feed. */
482 struct sr_datafeed_header {
484 struct timeval starttime;
487 /** Datafeed payload for type SR_DF_META. */
488 struct sr_datafeed_meta {
492 /** Logic datafeed payload for type SR_DF_LOGIC. */
493 struct sr_datafeed_logic {
499 /** Analog datafeed payload for type SR_DF_ANALOG. */
500 struct sr_datafeed_analog {
502 uint32_t num_samples;
503 struct sr_analog_encoding *encoding;
504 struct sr_analog_meaning *meaning;
505 struct sr_analog_spec *spec;
508 struct sr_analog_encoding {
512 gboolean is_bigendian;
514 * Number of significant digits after the decimal point if positive,
515 * or number of non-significant digits before the decimal point if
516 * negative (refers to the value we actually read on the wire).
519 gboolean is_digits_decimal;
520 struct sr_rational scale;
521 struct sr_rational offset;
524 struct sr_analog_meaning {
527 enum sr_mqflag mqflags;
531 struct sr_analog_spec {
533 * Number of significant digits after the decimal point if positive,
534 * or number of non-significant digits before the decimal point if
535 * negative (refers to vendor specifications/datasheet or actual
541 /** Generic option struct used by various subsystems. */
543 /* Short name suitable for commandline usage, [a-z0-9-]. */
545 /* Short name suitable for GUI usage, can contain UTF-8. */
547 /* Description of the option, in a sentence. */
549 /* Default value for this option. */
551 /* List of possible values, if this is an option with few values. */
558 enum sr_resource_type {
559 SR_RESOURCE_FIRMWARE = 1,
562 /** Resource descriptor.
566 /** Size of resource in bytes; set by resource open callback. */
568 /** File handle or equivalent; set by resource open callback. */
570 /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
574 /** Output module flags. */
575 enum sr_output_flag {
576 /** If set, this output module writes the output itself. */
577 SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
581 struct sr_input_module;
583 struct sr_output_module;
585 struct sr_transform_module;
587 /** Constants for channel type. */
588 enum sr_channeltype {
589 /** Channel type is logic channel. */
590 SR_CHANNEL_LOGIC = 10000,
591 /** Channel type is analog channel. */
595 /** Information on single channel. */
597 /** The device this channel is attached to. */
598 struct sr_dev_inst *sdi;
599 /** The index of this channel, starting at 0. Logic channels will
600 * be encoded according to this index in SR_DF_LOGIC packets. */
602 /** Channel type (SR_CHANNEL_LOGIC, ...) */
604 /** Is this channel enabled? */
606 /** Name of channel. */
608 /** Private data for driver use. */
612 /** Structure for groups of channels that have common properties. */
613 struct sr_channel_group {
614 /** Name of the channel group. */
616 /** List of sr_channel structs of the channels belonging to this group. */
618 /** Private data for driver use. */
622 /** Used for setting or getting value of a config item. */
624 /** Config key like SR_CONF_CONN, etc. */
626 /** Key-specific data. */
636 /** Information about a key. */
638 /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
640 /** Data type like SR_T_STRING, etc if applicable. */
642 /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
644 /** Full capitalized name, e.g. "Serial communication". */
646 /** Verbose description (unused currently). */
647 const char *description;
650 /** Configuration capabilities. */
652 /** Value can be read. */
653 SR_CONF_GET = (1 << 31),
654 /** Value can be written. */
655 SR_CONF_SET = (1 << 30),
656 /** Possible values can be enumerated. */
657 SR_CONF_LIST = (1 << 29),
660 /** Configuration keys */
662 /*--- Device classes ------------------------------------------------*/
664 /** The device can act as logic analyzer. */
665 SR_CONF_LOGIC_ANALYZER = 10000,
667 /** The device can act as an oscilloscope. */
668 SR_CONF_OSCILLOSCOPE,
670 /** The device can act as a multimeter. */
673 /** The device is a demo device. */
676 /** The device can act as a sound level meter. */
677 SR_CONF_SOUNDLEVELMETER,
679 /** The device can measure temperature. */
682 /** The device can measure humidity. */
685 /** The device can measure energy consumption. */
688 /** The device can act as a signal demodulator. */
691 /** The device can act as a programmable power supply. */
692 SR_CONF_POWER_SUPPLY,
694 /** The device can act as an LCR meter. */
697 /** The device can act as an electronic load. */
698 SR_CONF_ELECTRONIC_LOAD,
700 /** The device can act as a scale. */
703 /** The device can act as a function generator. */
704 SR_CONF_SIGNAL_GENERATOR,
706 /** The device can measure power. */
709 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
711 /*--- Driver scan options -------------------------------------------*/
714 * Specification on how to connect to a device.
716 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
717 * the form which makes sense to the OS (e.g., /dev/ttyS0).
718 * Otherwise this specifies a USB device, either in the form of
719 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
720 * @verbatim <vendorid>.<productid> @endverbatim
721 * (hexadecimal, e.g. 1d6b.0001).
723 SR_CONF_CONN = 20000,
726 * Serial communication specification, in the form:
728 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
732 * The string may also be followed by one or more special settings,
733 * in the form "/key=value". Supported keys and their values are:
735 * rts 0,1 set the port's RTS pin to low or high
736 * dtr 0,1 set the port's DTR pin to low or high
737 * flow 0 no flow control
738 * 1 hardware-based (RTS/CTS) flow control
739 * 2 software-based (XON/XOFF) flow control
741 * This is always an optional parameter, since a driver typically
742 * knows the speed at which the device wants to communicate.
747 * Modbus slave address specification.
749 * This is always an optional parameter, since a driver typically
750 * knows the default slave address of the device.
754 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
756 /*--- Device (or channel group) configuration -----------------------*/
758 /** The device supports setting its samplerate, in Hz. */
759 SR_CONF_SAMPLERATE = 30000,
761 /** The device supports setting a pre/post-trigger capture ratio. */
762 SR_CONF_CAPTURE_RATIO,
764 /** The device supports setting a pattern (pattern generator mode). */
765 SR_CONF_PATTERN_MODE,
767 /** The device supports run-length encoding (RLE). */
770 /** The device supports setting trigger slope. */
771 SR_CONF_TRIGGER_SLOPE,
773 /** The device supports averaging. */
777 * The device supports setting number of samples to be
782 /** Trigger source. */
783 SR_CONF_TRIGGER_SOURCE,
785 /** Horizontal trigger position. */
786 SR_CONF_HORIZ_TRIGGERPOS,
803 /** Trigger matches. */
804 SR_CONF_TRIGGER_MATCH,
806 /** The device supports setting its sample interval, in ms. */
807 SR_CONF_SAMPLE_INTERVAL,
809 /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
812 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
815 /** Sound pressure level frequency weighting. */
816 SR_CONF_SPL_WEIGHT_FREQ,
818 /** Sound pressure level time weighting. */
819 SR_CONF_SPL_WEIGHT_TIME,
821 /** Sound pressure level measurement range. */
822 SR_CONF_SPL_MEASUREMENT_RANGE,
824 /** Max hold mode. */
827 /** Min hold mode. */
830 /** Logic low-high threshold range. */
831 SR_CONF_VOLTAGE_THRESHOLD,
833 /** The device supports using an external clock. */
834 SR_CONF_EXTERNAL_CLOCK,
837 * The device supports swapping channels. Typical this is between
838 * buffered and unbuffered channels.
842 /** Center frequency.
843 * The input signal is downmixed by this frequency before the ADC
844 * anti-aliasing filter.
846 SR_CONF_CENTER_FREQUENCY,
848 /** The device supports setting the number of logic channels. */
849 SR_CONF_NUM_LOGIC_CHANNELS,
851 /** The device supports setting the number of analog channels. */
852 SR_CONF_NUM_ANALOG_CHANNELS,
857 * @arg get: get measured voltage
862 * Maximum target voltage.
864 * @arg get: get target voltage
865 * @arg set: change target voltage
867 SR_CONF_VOLTAGE_TARGET,
872 * @arg get: get measured current
879 * @arg get: get current limit
880 * @arg set: change current limit
882 SR_CONF_CURRENT_LIMIT,
885 * Enabling/disabling channel.
887 * @arg get: @b true if currently enabled
888 * @arg set: enable/disable
893 * Channel configuration.
895 * @arg get: get current setting
896 * @arg set: change current setting
897 * @arg list: array of possible values
899 SR_CONF_CHANNEL_CONFIG,
902 * Over-voltage protection (OVP) feature
904 * @arg get: @b true if currently enabled
905 * @arg set: enable/disable
907 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
910 * Over-voltage protection (OVP) active
912 * @arg get: @b true if device has activated OVP, i.e. the output voltage
913 * exceeds the over-voltage protection threshold.
915 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
918 * Over-voltage protection (OVP) threshold
919 * @arg type: double (voltage)
920 * @arg get: get current threshold
921 * @arg set: set new threshold
923 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
926 * Over-current protection (OCP) feature
928 * @arg get: @b true if currently enabled
929 * @arg set: enable/disable
931 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
934 * Over-current protection (OCP) active
936 * @arg get: @b true if device has activated OCP, i.e. the current current
937 * exceeds the over-current protection threshold.
939 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
942 * Over-current protection (OCP) threshold
943 * @arg type: double (current)
944 * @arg get: get current threshold
945 * @arg set: set new threshold
947 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
949 /** Choice of clock edge for external clock ("r" or "f"). */
952 /** Amplitude of a source without strictly-defined MQ. */
957 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
962 /** Over-temperature protection (OTP) */
963 SR_CONF_OVER_TEMPERATURE_PROTECTION,
965 /** Output frequency in Hz. */
966 SR_CONF_OUTPUT_FREQUENCY,
968 /** Output frequency target in Hz. */
969 SR_CONF_OUTPUT_FREQUENCY_TARGET,
971 /** Measured quantity. */
972 SR_CONF_MEASURED_QUANTITY,
974 /** Equivalent circuit model. */
975 SR_CONF_EQUIV_CIRCUIT_MODEL,
977 /** Over-temperature protection (OTP) active. */
978 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
980 /** Under-voltage condition. */
981 SR_CONF_UNDER_VOLTAGE_CONDITION,
983 /** Under-voltage condition active. */
984 SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
986 /** Trigger level. */
987 SR_CONF_TRIGGER_LEVEL,
989 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
991 /*--- Special stuff -------------------------------------------------*/
993 /** Session filename. */
994 SR_CONF_SESSIONFILE = 40000,
996 /** The device supports specifying a capturefile to inject. */
999 /** The device supports specifying the capturefile unit size. */
1000 SR_CONF_CAPTURE_UNITSIZE,
1002 /** Power off the device. */
1006 * Data source for acquisition. If not present, acquisition from
1007 * the device is always "live", i.e. acquisition starts when the
1008 * frontend asks and the results are sent out as soon as possible.
1010 * If present, it indicates that either the device has no live
1011 * acquisition capability (for example a pure data logger), or
1012 * there is a choice. sr_config_list() returns those choices.
1014 * In any case if a device has live acquisition capabilities, it
1015 * is always the default.
1017 SR_CONF_DATA_SOURCE,
1019 /** The device supports setting a probe factor. */
1020 SR_CONF_PROBE_FACTOR,
1022 /** Number of powerline cycles for ADC integration time. */
1023 SR_CONF_ADC_POWERLINE_CYCLES,
1025 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1027 /*--- Acquisition modes, sample limiting ----------------------------*/
1030 * The device supports setting a sample time limit (how long
1031 * the sample acquisition should run, in ms).
1033 SR_CONF_LIMIT_MSEC = 50000,
1036 * The device supports setting a sample number limit (how many
1037 * samples should be acquired).
1039 SR_CONF_LIMIT_SAMPLES,
1042 * The device supports setting a frame limit (how many
1043 * frames should be acquired).
1045 SR_CONF_LIMIT_FRAMES,
1048 * The device supports continuous sampling. Neither a time limit
1049 * nor a sample number limit has to be supplied, it will just acquire
1050 * samples continuously, until explicitly stopped by a certain command.
1054 /** The device has internal storage, into which data is logged. This
1055 * starts or stops the internal logging. */
1058 /** Device mode for multi-function devices. */
1059 SR_CONF_DEVICE_MODE,
1061 /** Self test mode. */
1064 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1068 * Opaque structure representing a libsigrok device instance.
1070 * None of the fields of this structure are meant to be accessed directly.
1074 /** Types of device instance, struct sr_dev_inst.type */
1075 enum sr_dev_inst_type {
1076 /** Device instance type for USB devices. */
1077 SR_INST_USB = 10000,
1078 /** Device instance type for serial port devices. */
1080 /** Device instance type for SCPI devices. */
1082 /** Device-instance type for user-created "devices". */
1084 /** Device instance type for Modbus devices. */
1088 /** Device instance status, struct sr_dev_inst.status */
1089 enum sr_dev_inst_status {
1090 /** The device instance was not found. */
1091 SR_ST_NOT_FOUND = 10000,
1092 /** The device instance was found, but is still booting. */
1094 /** The device instance is live, but not in use. */
1096 /** The device instance is actively in use in a session. */
1098 /** The device is winding down its session. */
1102 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1103 struct sr_dev_driver {
1104 /* Driver-specific */
1105 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1107 /** Long name. Verbose driver name shown to user. */
1108 const char *longname;
1109 /** API version (currently 1). */
1111 /** Called when driver is loaded, e.g. program startup. */
1112 int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1113 /** Called before driver is unloaded.
1114 * Driver must free all resources held by it. */
1115 int (*cleanup) (const struct sr_dev_driver *driver);
1116 /** Scan for devices. Driver should do all initialisation required.
1117 * Can be called several times, e.g. with different port options.
1118 * @retval NULL Error or no devices found.
1119 * @retval other GSList of a struct sr_dev_inst for each device.
1120 * Must be freed by caller!
1122 GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1123 /** Get list of device instances the driver knows about.
1124 * @returns NULL or GSList of a struct sr_dev_inst for each device.
1125 * Must not be freed by caller!
1127 GSList *(*dev_list) (const struct sr_dev_driver *driver);
1128 /** Clear list of devices the driver knows about. */
1129 int (*dev_clear) (const struct sr_dev_driver *driver);
1130 /** Query value of a configuration key in driver or given device instance.
1131 * @see sr_config_get().
1133 int (*config_get) (uint32_t key, GVariant **data,
1134 const struct sr_dev_inst *sdi,
1135 const struct sr_channel_group *cg);
1136 /** Set value of a configuration key in driver or a given device instance.
1137 * @see sr_config_set(). */
1138 int (*config_set) (uint32_t key, GVariant *data,
1139 const struct sr_dev_inst *sdi,
1140 const struct sr_channel_group *cg);
1141 /** Channel status change.
1142 * @see sr_dev_channel_enable(). */
1143 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1144 struct sr_channel *ch, unsigned int changes);
1145 /** Apply configuration settings to the device hardware.
1146 * @see sr_config_commit().*/
1147 int (*config_commit) (const struct sr_dev_inst *sdi);
1148 /** List all possible values for a configuration key in a device instance.
1149 * @see sr_config_list().
1151 int (*config_list) (uint32_t key, GVariant **data,
1152 const struct sr_dev_inst *sdi,
1153 const struct sr_channel_group *cg);
1155 /* Device-specific */
1157 int (*dev_open) (struct sr_dev_inst *sdi);
1159 int (*dev_close) (struct sr_dev_inst *sdi);
1160 /** Begin data acquisition on the specified device. */
1161 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
1162 /** End data acquisition on the specified device. */
1163 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
1166 /** Device driver context, considered private. Initialized by init(). */
1170 /** Serial port descriptor. */
1171 struct sr_serial_port {
1172 /** The OS dependent name of the serial port. */
1174 /** An end user friendly description for the serial port. */
1178 #include <libsigrok/proto.h>
1179 #include <libsigrok/version.h>