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 /** Ternary return type for DMM/LCR/etc packet parser validity checks. */
85 SR_PACKET_INVALID = -1, /**< Certainly invalid. */
86 SR_PACKET_VALID = 0, /**< Certainly valid. */
87 SR_PACKET_NEED_RX = +1, /**< Need more RX data. */
90 #define SR_MAX_CHANNELNAME_LEN 32
92 /* Handy little macros */
94 #define SR_KHZ(n) ((n) * UINT64_C(1000))
95 #define SR_MHZ(n) ((n) * UINT64_C(1000000))
96 #define SR_GHZ(n) ((n) * UINT64_C(1000000000))
98 #define SR_HZ_TO_NS(n) (UINT64_C(1000000000) / (n))
100 /** libsigrok loglevels. */
102 SR_LOG_NONE = 0, /**< Output no messages at all. */
103 SR_LOG_ERR = 1, /**< Output error messages. */
104 SR_LOG_WARN = 2, /**< Output warnings. */
105 SR_LOG_INFO = 3, /**< Output informational messages. */
106 SR_LOG_DBG = 4, /**< Output debug messages. */
107 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
111 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
113 * Variables and functions marked 'static' are private already and don't
114 * need SR_PRIV. However, functions which are not static (because they need
115 * to be used in other libsigrok-internal files) but are also not meant to
116 * be part of the public libsigrok API, must use SR_PRIV.
118 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
120 * This feature is not available on MinGW/Windows, as it is a feature of
121 * ELF files and MinGW/Windows uses PE files.
123 * Details: http://gcc.gnu.org/wiki/Visibility
126 /* Marks public libsigrok API symbols. */
128 #define SR_API __attribute__((visibility("default")))
133 /* Marks private, non-public libsigrok symbols (not part of the API). */
135 #define SR_PRIV __attribute__((visibility("hidden")))
140 /** Type definition for callback function for data reception. */
141 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
143 /** Data types used by sr_config_info(). */
149 SR_T_RATIONAL_PERIOD,
157 /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
160 /** Value for sr_datafeed_packet.type. */
162 /** Payload is sr_datafeed_header. */
163 SR_DF_HEADER = 10000,
164 /** End of stream (no further data). */
166 /** Payload is struct sr_datafeed_meta */
168 /** The trigger matched at this point in the data feed. No payload. */
170 /** Payload is struct sr_datafeed_logic. */
172 /** Beginning of frame. No payload. */
174 /** End of frame. No payload. */
176 /** Payload is struct sr_datafeed_analog. */
179 /* Update datafeed_dump() (session.c) upon changes! */
182 /** Measured quantity, sr_analog_meaning.mq. */
184 SR_MQ_VOLTAGE = 10000,
190 /** Duty cycle, e.g. on/off ratio. */
192 /** Continuity test. */
196 /** Electrical power, usually in W, or dBm. */
198 /** Gain (a transistor's gain, or hFE, for example). */
200 /** Logarithmic representation of sound pressure relative to a
201 * reference value. */
202 SR_MQ_SOUND_PRESSURE_LEVEL,
203 /** Carbon monoxide level */
204 SR_MQ_CARBON_MONOXIDE,
206 SR_MQ_RELATIVE_HUMIDITY,
213 /** Parallel inductance (LCR meter model). */
214 SR_MQ_PARALLEL_INDUCTANCE,
215 /** Parallel capacitance (LCR meter model). */
216 SR_MQ_PARALLEL_CAPACITANCE,
217 /** Parallel resistance (LCR meter model). */
218 SR_MQ_PARALLEL_RESISTANCE,
219 /** Series inductance (LCR meter model). */
220 SR_MQ_SERIES_INDUCTANCE,
221 /** Series capacitance (LCR meter model). */
222 SR_MQ_SERIES_CAPACITANCE,
223 /** Series resistance (LCR meter model). */
224 SR_MQ_SERIES_RESISTANCE,
225 /** Dissipation factor. */
226 SR_MQ_DISSIPATION_FACTOR,
227 /** Quality factor. */
228 SR_MQ_QUALITY_FACTOR,
231 /** Difference from reference value. */
237 /** Apparent power */
238 SR_MQ_APPARENT_POWER,
241 /** Harmonic ratio */
242 SR_MQ_HARMONIC_RATIO,
245 /** Electric charge. */
246 SR_MQ_ELECTRIC_CHARGE,
248 /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
251 /** Unit of measured quantity, sr_analog_meaning.unit. */
254 SR_UNIT_VOLT = 10000,
255 /** Ampere (current). */
257 /** Ohm (resistance). */
259 /** Farad (capacity). */
261 /** Kelvin (temperature). */
263 /** Degrees Celsius (temperature). */
265 /** Degrees Fahrenheit (temperature). */
267 /** Hertz (frequency, 1/s, [Hz]). */
269 /** Percent value. */
271 /** Boolean value. */
273 /** Time in seconds. */
275 /** Unit of conductance, the inverse of resistance. */
278 * An absolute measurement of power, in decibels, referenced to
282 /** Voltage in decibel, referenced to 1 volt (dBV). */
283 SR_UNIT_DECIBEL_VOLT,
285 * Measurements that intrinsically do not have units attached, such
286 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
287 * a unitless quantity, for example.
290 /** Sound pressure level, in decibels, relative to 20 micropascals. */
293 * Normalized (0 to 1) concentration of a substance or compound with 0
294 * representing a concentration of 0%, and 1 being 100%. This is
295 * represented as the fraction of number of particles of the substance.
297 SR_UNIT_CONCENTRATION,
298 /** Revolutions per minute. */
299 SR_UNIT_REVOLUTIONS_PER_MINUTE,
300 /** Apparent power [VA]. */
302 /** Real power [W]. */
304 /** Energy (consumption) in watt hour [Wh]. */
306 /** Wind speed in meters per second. */
307 SR_UNIT_METER_SECOND,
308 /** Pressure in hectopascal */
310 /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
311 SR_UNIT_HUMIDITY_293K,
312 /** Plane angle in 1/360th of a full circle. */
314 /** Henry (inductance). */
316 /** Mass in gram [g]. */
318 /** Mass in carat [ct]. */
320 /** Mass in ounce [oz]. */
322 /** Mass in troy ounce [oz t]. */
324 /** Mass in pound [lb]. */
326 /** Mass in pennyweight [dwt]. */
328 /** Mass in grain [gr]. */
330 /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
332 /** Mass in momme. */
336 /** Pieces (number of items). */
338 /** Energy in joule. */
340 /** Electric charge in coulomb. */
342 /** Electric charge in ampere hour [Ah]. */
346 * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
351 /** Values for sr_analog_meaning.mqflags. */
353 /** Voltage measurement is alternating current (AC). */
355 /** Voltage measurement is direct current (DC). */
357 /** This is a true RMS measurement. */
358 SR_MQFLAG_RMS = 0x04,
359 /** Value is voltage drop across a diode, or NAN. */
360 SR_MQFLAG_DIODE = 0x08,
361 /** Device is in "hold" mode (repeating the last measurement). */
362 SR_MQFLAG_HOLD = 0x10,
363 /** Device is in "max" mode, only updating upon a new max value. */
364 SR_MQFLAG_MAX = 0x20,
365 /** Device is in "min" mode, only updating upon a new min value. */
366 SR_MQFLAG_MIN = 0x40,
367 /** Device is in autoranging mode. */
368 SR_MQFLAG_AUTORANGE = 0x80,
369 /** Device is in relative mode. */
370 SR_MQFLAG_RELATIVE = 0x100,
371 /** Sound pressure level is A-weighted in the frequency domain,
372 * according to IEC 61672:2003. */
373 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
374 /** Sound pressure level is C-weighted in the frequency domain,
375 * according to IEC 61672:2003. */
376 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
377 /** Sound pressure level is Z-weighted (i.e. not at all) in the
378 * frequency domain, according to IEC 61672:2003. */
379 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
380 /** Sound pressure level is not weighted in the frequency domain,
381 * albeit without standards-defined low and high frequency limits. */
382 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
383 /** Sound pressure level measurement is S-weighted (1s) in the
385 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
386 /** Sound pressure level measurement is F-weighted (125ms) in the
388 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
389 /** Sound pressure level is time-averaged (LAT), also known as
390 * Equivalent Continuous A-weighted Sound Level (LEQ). */
391 SR_MQFLAG_SPL_LAT = 0x8000,
392 /** Sound pressure level represented as a percentage of measurements
393 * that were over a preset alarm level. */
394 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
395 /** Time is duration (as opposed to epoch, ...). */
396 SR_MQFLAG_DURATION = 0x20000,
397 /** Device is in "avg" mode, averaging upon each new value. */
398 SR_MQFLAG_AVG = 0x40000,
399 /** Reference value shown. */
400 SR_MQFLAG_REFERENCE = 0x80000,
401 /** Unstable value (hasn't settled yet). */
402 SR_MQFLAG_UNSTABLE = 0x100000,
403 /** Measurement is four wire (e.g. Kelvin connection). */
404 SR_MQFLAG_FOUR_WIRE = 0x200000,
407 * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
412 enum sr_trigger_matches {
422 /** The representation of a trigger, consisting of one or more stages
423 * containing one or more matches on a channel.
426 /** A name for this trigger. This may be NULL if none is needed. */
428 /** List of pointers to struct sr_trigger_stage. */
432 /** A trigger stage. */
433 struct sr_trigger_stage {
436 /** List of pointers to struct sr_trigger_match. */
440 /** A channel to match and what to match it on. */
441 struct sr_trigger_match {
442 /** The channel to trigger on. */
443 struct sr_channel *channel;
444 /** The trigger match to use.
445 * For logic channels, only the following matches may be used:
452 * For analog channels, only these matches may be used:
460 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
461 * this contains the value to compare against. */
467 * Opaque structure representing a libsigrok context.
469 * None of the fields of this structure are meant to be accessed directly.
471 * @see sr_init(), sr_exit().
477 * Opaque structure representing a libsigrok session.
479 * None of the fields of this structure are meant to be accessed directly.
481 * @see sr_session_new(), sr_session_destroy().
486 /** Numerator of the rational number. */
488 /** Denominator of the rational number. */
492 /** Packet in a sigrok data feed. */
493 struct sr_datafeed_packet {
498 /** Header of a sigrok data feed. */
499 struct sr_datafeed_header {
501 struct timeval starttime;
504 /** Datafeed payload for type SR_DF_META. */
505 struct sr_datafeed_meta {
509 /** Logic datafeed payload for type SR_DF_LOGIC. */
510 struct sr_datafeed_logic {
516 /** Analog datafeed payload for type SR_DF_ANALOG. */
517 struct sr_datafeed_analog {
519 uint32_t num_samples;
520 struct sr_analog_encoding *encoding;
521 struct sr_analog_meaning *meaning;
522 struct sr_analog_spec *spec;
525 struct sr_analog_encoding {
529 gboolean is_bigendian;
531 * Number of significant digits after the decimal point if positive,
532 * or number of non-significant digits before the decimal point if
533 * negative (refers to the value we actually read on the wire).
536 gboolean is_digits_decimal;
537 struct sr_rational scale;
538 struct sr_rational offset;
541 struct sr_analog_meaning {
544 enum sr_mqflag mqflags;
548 struct sr_analog_spec {
550 * Number of significant digits after the decimal point if positive,
551 * or number of non-significant digits before the decimal point if
552 * negative (refers to vendor specifications/datasheet or actual
558 /** Generic option struct used by various subsystems. */
560 /* Short name suitable for commandline usage, [a-z0-9-]. */
562 /* Short name suitable for GUI usage, can contain UTF-8. */
564 /* Description of the option, in a sentence. */
566 /* Default value for this option. */
568 /* List of possible values, if this is an option with few values. */
575 enum sr_resource_type {
576 SR_RESOURCE_FIRMWARE = 1,
579 /** Resource descriptor.
583 /** Size of resource in bytes; set by resource open callback. */
585 /** File handle or equivalent; set by resource open callback. */
587 /** Resource type (SR_RESOURCE_FIRMWARE, ...) */
591 /** Output module flags. */
592 enum sr_output_flag {
593 /** If set, this output module writes the output itself. */
594 SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
598 struct sr_input_module;
600 struct sr_output_module;
602 struct sr_transform_module;
604 /** Constants for channel type. */
605 enum sr_channeltype {
606 /** Channel type is logic channel. */
607 SR_CHANNEL_LOGIC = 10000,
608 /** Channel type is analog channel. */
612 /** Information on single channel. */
614 /** The device this channel is attached to. */
615 struct sr_dev_inst *sdi;
616 /** The index of this channel, starting at 0. Logic channels will
617 * be encoded according to this index in SR_DF_LOGIC packets. */
619 /** Channel type (SR_CHANNEL_LOGIC, ...) */
621 /** Is this channel enabled? */
623 /** Name of channel. */
625 /** Private data for driver use. */
629 /** Structure for groups of channels that have common properties. */
630 struct sr_channel_group {
631 /** Name of the channel group. */
633 /** List of sr_channel structs of the channels belonging to this group. */
635 /** Private data for driver use. */
639 /** Used for setting or getting value of a config item. */
641 /** Config key like SR_CONF_CONN, etc. */
643 /** Key-specific data. */
653 /** Information about a key. */
655 /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
657 /** Data type like SR_T_STRING, etc if applicable. */
659 /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
661 /** Full capitalized name, e.g. "Serial communication". */
663 /** Verbose description (unused currently). */
664 const char *description;
667 /** Configuration capabilities. */
669 /** Value can be read. */
670 SR_CONF_GET = (1UL << 31),
671 /** Value can be written. */
672 SR_CONF_SET = (1UL << 30),
673 /** Possible values can be enumerated. */
674 SR_CONF_LIST = (1UL << 29),
677 /** Configuration keys */
679 /*--- Device classes ------------------------------------------------*/
681 /** The device can act as logic analyzer. */
682 SR_CONF_LOGIC_ANALYZER = 10000,
684 /** The device can act as an oscilloscope. */
685 SR_CONF_OSCILLOSCOPE,
687 /** The device can act as a multimeter. */
690 /** The device is a demo device. */
693 /** The device can act as a sound level meter. */
694 SR_CONF_SOUNDLEVELMETER,
696 /** The device can measure temperature. */
699 /** The device can measure humidity. */
702 /** The device can measure energy consumption. */
705 /** The device can act as a signal demodulator. */
708 /** The device can act as a programmable power supply. */
709 SR_CONF_POWER_SUPPLY,
711 /** The device can act as an LCR meter. */
714 /** The device can act as an electronic load. */
715 SR_CONF_ELECTRONIC_LOAD,
717 /** The device can act as a scale. */
720 /** The device can act as a function generator. */
721 SR_CONF_SIGNAL_GENERATOR,
723 /** The device can measure power. */
726 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
728 /*--- Driver scan options -------------------------------------------*/
731 * Specification on how to connect to a device.
733 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
734 * the form which makes sense to the OS (e.g., /dev/ttyS0).
735 * Otherwise this specifies a USB device, either in the form of
736 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
737 * @verbatim <vendorid>.<productid> @endverbatim
738 * (hexadecimal, e.g. 1d6b.0001).
740 SR_CONF_CONN = 20000,
743 * Serial communication specification, in the form:
745 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
749 * The string may also be followed by one or more special settings,
750 * in the form "/key=value". Supported keys and their values are:
752 * rts 0,1 set the port's RTS pin to low or high
753 * dtr 0,1 set the port's DTR pin to low or high
754 * flow 0 no flow control
755 * 1 hardware-based (RTS/CTS) flow control
756 * 2 software-based (XON/XOFF) flow control
758 * This is always an optional parameter, since a driver typically
759 * knows the speed at which the device wants to communicate.
764 * Modbus slave address specification.
766 * This is always an optional parameter, since a driver typically
767 * knows the default slave address of the device.
772 * User specified forced driver attachment to unknown devices.
774 * By design the interpretation of the string depends on the
775 * specific driver. It typically would be either a replacement
776 * '*IDN?' response value, or a sub-driver name. But could also
777 * be anything else and totally arbitrary.
779 SR_CONF_FORCE_DETECT,
781 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
783 /*--- Device (or channel group) configuration -----------------------*/
785 /** The device supports setting its samplerate, in Hz. */
786 SR_CONF_SAMPLERATE = 30000,
788 /** The device supports setting a pre/post-trigger capture ratio. */
789 SR_CONF_CAPTURE_RATIO,
791 /** The device supports setting a pattern (pattern generator mode). */
792 SR_CONF_PATTERN_MODE,
794 /** The device supports run-length encoding (RLE). */
797 /** The device supports setting trigger slope. */
798 SR_CONF_TRIGGER_SLOPE,
800 /** The device supports averaging. */
804 * The device supports setting number of samples to be
809 /** Trigger source. */
810 SR_CONF_TRIGGER_SOURCE,
812 /** Horizontal trigger position. */
813 SR_CONF_HORIZ_TRIGGERPOS,
830 /** Trigger matches. */
831 SR_CONF_TRIGGER_MATCH,
833 /** The device supports setting its sample interval, in ms. */
834 SR_CONF_SAMPLE_INTERVAL,
836 /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
839 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
842 /** Sound pressure level frequency weighting. */
843 SR_CONF_SPL_WEIGHT_FREQ,
845 /** Sound pressure level time weighting. */
846 SR_CONF_SPL_WEIGHT_TIME,
848 /** Sound pressure level measurement range. */
849 SR_CONF_SPL_MEASUREMENT_RANGE,
851 /** Max hold mode. */
854 /** Min hold mode. */
857 /** Logic low-high threshold range. */
858 SR_CONF_VOLTAGE_THRESHOLD,
860 /** The device supports using an external clock. */
861 SR_CONF_EXTERNAL_CLOCK,
864 * The device supports swapping channels. Typical this is between
865 * buffered and unbuffered channels.
869 /** Center frequency.
870 * The input signal is downmixed by this frequency before the ADC
871 * anti-aliasing filter.
873 SR_CONF_CENTER_FREQUENCY,
875 /** The device supports setting the number of logic channels. */
876 SR_CONF_NUM_LOGIC_CHANNELS,
878 /** The device supports setting the number of analog channels. */
879 SR_CONF_NUM_ANALOG_CHANNELS,
884 * @arg get: get measured voltage
889 * Maximum target voltage.
891 * @arg get: get target voltage
892 * @arg set: change target voltage
894 SR_CONF_VOLTAGE_TARGET,
899 * @arg get: get measured current
906 * @arg get: get current limit
907 * @arg set: change current limit
909 SR_CONF_CURRENT_LIMIT,
912 * Enabling/disabling channel.
914 * @arg get: @b true if currently enabled
915 * @arg set: enable/disable
920 * Channel configuration.
922 * @arg get: get current setting
923 * @arg set: change current setting
924 * @arg list: array of possible values
926 SR_CONF_CHANNEL_CONFIG,
929 * Over-voltage protection (OVP) feature
931 * @arg get: @b true if currently enabled
932 * @arg set: enable/disable
934 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
937 * Over-voltage protection (OVP) active
939 * @arg get: @b true if device has activated OVP, i.e. the output voltage
940 * exceeds the over-voltage protection threshold.
942 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
945 * Over-voltage protection (OVP) threshold
946 * @arg type: double (voltage)
947 * @arg get: get current threshold
948 * @arg set: set new threshold
950 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
953 * Over-current protection (OCP) feature
955 * @arg get: @b true if currently enabled
956 * @arg set: enable/disable
958 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
961 * Over-current protection (OCP) active
963 * @arg get: @b true if device has activated OCP, i.e. the current current
964 * exceeds the over-current protection threshold.
966 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
969 * Over-current protection (OCP) threshold
970 * @arg type: double (current)
971 * @arg get: get current threshold
972 * @arg set: set new threshold
974 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
976 /** Choice of clock edge for external clock ("r" or "f"). */
979 /** Amplitude of a source without strictly-defined MQ. */
984 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
986 * "CC-" denotes a power supply in current sink mode (e.g. HP 66xxB).
987 * "" is used when there is no regulation, e.g. the output is disabled.
991 /** Over-temperature protection (OTP) */
992 SR_CONF_OVER_TEMPERATURE_PROTECTION,
994 /** Output frequency in Hz. */
995 SR_CONF_OUTPUT_FREQUENCY,
997 /** Output frequency target in Hz. */
998 SR_CONF_OUTPUT_FREQUENCY_TARGET,
1000 /** Measured quantity. */
1001 SR_CONF_MEASURED_QUANTITY,
1003 /** Equivalent circuit model. */
1004 SR_CONF_EQUIV_CIRCUIT_MODEL,
1006 /** Over-temperature protection (OTP) active. */
1007 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
1009 /** Under-voltage condition. */
1010 SR_CONF_UNDER_VOLTAGE_CONDITION,
1012 /** Under-voltage condition active. */
1013 SR_CONF_UNDER_VOLTAGE_CONDITION_ACTIVE,
1015 /** Trigger level. */
1016 SR_CONF_TRIGGER_LEVEL,
1018 /** Under-voltage condition threshold. */
1019 SR_CONF_UNDER_VOLTAGE_CONDITION_THRESHOLD,
1022 * Which external clock source to use if the device supports
1023 * multiple external clock channels.
1025 SR_CONF_EXTERNAL_CLOCK_SOURCE,
1027 /** Offset of a source without strictly-defined MQ. */
1030 /** The device supports setting a pattern for the logic trigger. */
1031 SR_CONF_TRIGGER_PATTERN,
1033 /** High resolution mode. */
1034 SR_CONF_HIGH_RESOLUTION,
1036 /** Peak detection. */
1037 SR_CONF_PEAK_DETECTION,
1039 /** Logic threshold: predefined levels (TTL, ECL, CMOS, etc). */
1040 SR_CONF_LOGIC_THRESHOLD,
1042 /** Logic threshold: custom numerical value. */
1043 SR_CONF_LOGIC_THRESHOLD_CUSTOM,
1045 /** The measurement range of a DMM or the output range of a power supply. */
1048 /** The number of digits (e.g. for a DMM). */
1051 /** Phase of a source signal. */
1054 /** Duty cycle of a source signal. */
1060 * @arg get: get measured power
1067 * @arg get: get power target
1068 * @arg set: change power target
1070 SR_CONF_POWER_TARGET,
1073 * Resistance target.
1075 * @arg get: get resistance target
1076 * @arg set: change resistance target
1078 SR_CONF_RESISTANCE_TARGET,
1080 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1082 /*--- Special stuff -------------------------------------------------*/
1084 /** Session filename. */
1085 SR_CONF_SESSIONFILE = 40000,
1087 /** The device supports specifying a capturefile to inject. */
1088 SR_CONF_CAPTUREFILE,
1090 /** The device supports specifying the capturefile unit size. */
1091 SR_CONF_CAPTURE_UNITSIZE,
1093 /** Power off the device. */
1097 * Data source for acquisition. If not present, acquisition from
1098 * the device is always "live", i.e. acquisition starts when the
1099 * frontend asks and the results are sent out as soon as possible.
1101 * If present, it indicates that either the device has no live
1102 * acquisition capability (for example a pure data logger), or
1103 * there is a choice. sr_config_list() returns those choices.
1105 * In any case if a device has live acquisition capabilities, it
1106 * is always the default.
1108 SR_CONF_DATA_SOURCE,
1110 /** The device supports setting a probe factor. */
1111 SR_CONF_PROBE_FACTOR,
1113 /** Number of powerline cycles for ADC integration time. */
1114 SR_CONF_ADC_POWERLINE_CYCLES,
1116 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1118 /*--- Acquisition modes, sample limiting ----------------------------*/
1121 * The device supports setting a sample time limit (how long
1122 * the sample acquisition should run, in ms).
1124 SR_CONF_LIMIT_MSEC = 50000,
1127 * The device supports setting a sample number limit (how many
1128 * samples should be acquired).
1130 SR_CONF_LIMIT_SAMPLES,
1133 * The device supports setting a frame limit (how many
1134 * frames should be acquired).
1136 SR_CONF_LIMIT_FRAMES,
1139 * The device supports continuous sampling. Neither a time limit
1140 * nor a sample number limit has to be supplied, it will just acquire
1141 * samples continuously, until explicitly stopped by a certain command.
1145 /** The device has internal storage, into which data is logged. This
1146 * starts or stops the internal logging. */
1149 /** Device mode for multi-function devices. */
1150 SR_CONF_DEVICE_MODE,
1152 /** Self test mode. */
1155 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1159 * Opaque structure representing a libsigrok device instance.
1161 * None of the fields of this structure are meant to be accessed directly.
1165 /** Types of device instance, struct sr_dev_inst.type */
1166 enum sr_dev_inst_type {
1167 /** Device instance type for USB devices. */
1168 SR_INST_USB = 10000,
1169 /** Device instance type for serial port devices. */
1171 /** Device instance type for SCPI devices. */
1173 /** Device-instance type for user-created "devices". */
1175 /** Device instance type for Modbus devices. */
1179 /** Device instance status, struct sr_dev_inst.status */
1180 enum sr_dev_inst_status {
1181 /** The device instance was not found. */
1182 SR_ST_NOT_FOUND = 10000,
1183 /** The device instance was found, but is still booting. */
1185 /** The device instance is live, but not in use. */
1187 /** The device instance is actively in use in a session. */
1189 /** The device is winding down its session. */
1193 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1194 struct sr_dev_driver {
1195 /* Driver-specific */
1196 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1198 /** Long name. Verbose driver name shown to user. */
1199 const char *longname;
1200 /** API version (currently 1). */
1202 /** Called when driver is loaded, e.g. program startup. */
1203 int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1204 /** Called before driver is unloaded.
1205 * Driver must free all resources held by it. */
1206 int (*cleanup) (const struct sr_dev_driver *driver);
1207 /** Scan for devices. Driver should do all initialisation required.
1208 * Can be called several times, e.g. with different port options.
1209 * @retval NULL Error or no devices found.
1210 * @retval other GSList of a struct sr_dev_inst for each device.
1211 * Must be freed by caller!
1213 GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1214 /** Get list of device instances the driver knows about.
1215 * @returns NULL or GSList of a struct sr_dev_inst for each device.
1216 * Must not be freed by caller!
1218 GSList *(*dev_list) (const struct sr_dev_driver *driver);
1219 /** Clear list of devices the driver knows about. */
1220 int (*dev_clear) (const struct sr_dev_driver *driver);
1221 /** Query value of a configuration key in driver or given device instance.
1222 * @see sr_config_get().
1224 int (*config_get) (uint32_t key, GVariant **data,
1225 const struct sr_dev_inst *sdi,
1226 const struct sr_channel_group *cg);
1227 /** Set value of a configuration key in driver or a given device instance.
1228 * @see sr_config_set(). */
1229 int (*config_set) (uint32_t key, GVariant *data,
1230 const struct sr_dev_inst *sdi,
1231 const struct sr_channel_group *cg);
1232 /** Channel status change.
1233 * @see sr_dev_channel_enable(). */
1234 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1235 struct sr_channel *ch, unsigned int changes);
1236 /** Apply configuration settings to the device hardware.
1237 * @see sr_config_commit().*/
1238 int (*config_commit) (const struct sr_dev_inst *sdi);
1239 /** List all possible values for a configuration key in a device instance.
1240 * @see sr_config_list().
1242 int (*config_list) (uint32_t key, GVariant **data,
1243 const struct sr_dev_inst *sdi,
1244 const struct sr_channel_group *cg);
1246 /* Device-specific */
1248 int (*dev_open) (struct sr_dev_inst *sdi);
1250 int (*dev_close) (struct sr_dev_inst *sdi);
1251 /** Begin data acquisition on the specified device. */
1252 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi);
1253 /** End data acquisition on the specified device. */
1254 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi);
1257 /** Device driver context, considered private. Initialized by init(). */
1261 /** Serial port descriptor. */
1262 struct sr_serial_port {
1263 /** The OS dependent name of the serial port. */
1265 /** An end user friendly description for the serial port. */
1269 #include <libsigrok/proto.h>
1270 #include <libsigrok/version.h>