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. */
81 /* Update sr_strerror()/sr_strerror_name() (error.c) upon changes! */
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 /* Update sr_variant_type_get() (hwdriver.c) upon changes! */
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. */
175 /* Update datafeed_dump() (session.c) upon changes! */
178 /** Measured quantity, sr_datafeed_analog.mq. */
180 SR_MQ_VOLTAGE = 10000,
186 /** Duty cycle, e.g. on/off ratio. */
188 /** Continuity test. */
192 /** Electrical power, usually in W, or dBm. */
194 /** Gain (a transistor's gain, or hFE, for example). */
196 /** Logarithmic representation of sound pressure relative to a
197 * reference value. */
198 SR_MQ_SOUND_PRESSURE_LEVEL,
199 /** Carbon monoxide level */
200 SR_MQ_CARBON_MONOXIDE,
202 SR_MQ_RELATIVE_HUMIDITY,
209 /** Parallel inductance (LCR meter model). */
210 SR_MQ_PARALLEL_INDUCTANCE,
211 /** Parallel capacitance (LCR meter model). */
212 SR_MQ_PARALLEL_CAPACITANCE,
213 /** Parallel resistance (LCR meter model). */
214 SR_MQ_PARALLEL_RESISTANCE,
215 /** Series inductance (LCR meter model). */
216 SR_MQ_SERIES_INDUCTANCE,
217 /** Series capacitance (LCR meter model). */
218 SR_MQ_SERIES_CAPACITANCE,
219 /** Series resistance (LCR meter model). */
220 SR_MQ_SERIES_RESISTANCE,
221 /** Dissipation factor. */
222 SR_MQ_DISSIPATION_FACTOR,
223 /** Quality factor. */
224 SR_MQ_QUALITY_FACTOR,
227 /** Difference from reference value. */
233 /** Apparent power */
234 SR_MQ_APPARENT_POWER,
238 /* Update sr_key_info_mq[] (hwdriver.c) upon changes! */
241 /** Unit of measured quantity, sr_datafeed_analog.unit. */
244 SR_UNIT_VOLT = 10000,
245 /** Ampere (current). */
247 /** Ohm (resistance). */
249 /** Farad (capacity). */
251 /** Kelvin (temperature). */
253 /** Degrees Celsius (temperature). */
255 /** Degrees Fahrenheit (temperature). */
257 /** Hertz (frequency, 1/s, [Hz]). */
259 /** Percent value. */
261 /** Boolean value. */
263 /** Time in seconds. */
265 /** Unit of conductance, the inverse of resistance. */
268 * An absolute measurement of power, in decibels, referenced to
272 /** Voltage in decibel, referenced to 1 volt (dBV). */
273 SR_UNIT_DECIBEL_VOLT,
275 * Measurements that intrinsically do not have units attached, such
276 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
277 * a unitless quantity, for example.
280 /** Sound pressure level, in decibels, relative to 20 micropascals. */
283 * Normalized (0 to 1) concentration of a substance or compound with 0
284 * representing a concentration of 0%, and 1 being 100%. This is
285 * represented as the fraction of number of particles of the substance.
287 SR_UNIT_CONCENTRATION,
288 /** Revolutions per minute. */
289 SR_UNIT_REVOLUTIONS_PER_MINUTE,
290 /** Apparent power [VA]. */
292 /** Real power [W]. */
294 /** Consumption [Wh]. */
296 /** Wind speed in meters per second. */
297 SR_UNIT_METER_SECOND,
298 /** Pressure in hectopascal */
300 /** Relative humidity assuming air temperature of 293 Kelvin (%rF). */
301 SR_UNIT_HUMIDITY_293K,
302 /** Plane angle in 1/360th of a full circle. */
304 /** Henry (inductance). */
306 /** Mass in gram [g]. */
308 /** Mass in carat [ct]. */
310 /** Mass in ounce [oz]. */
312 /** Mass in troy ounce [oz t]. */
314 /** Mass in pound [lb]. */
316 /** Mass in pennyweight [dwt]. */
318 /** Mass in grain [gr]. */
320 /** Mass in tael (variants: Hong Kong, Singapore/Malaysia, Taiwan) */
322 /** Mass in momme. */
326 /** Pieces (number of items). */
330 * Update unit_strings[] (analog.c) and fancyprint() (output/analog.c)
335 /** Values for sr_datafeed_analog.flags. */
337 /** Voltage measurement is alternating current (AC). */
339 /** Voltage measurement is direct current (DC). */
341 /** This is a true RMS measurement. */
342 SR_MQFLAG_RMS = 0x04,
343 /** Value is voltage drop across a diode, or NAN. */
344 SR_MQFLAG_DIODE = 0x08,
345 /** Device is in "hold" mode (repeating the last measurement). */
346 SR_MQFLAG_HOLD = 0x10,
347 /** Device is in "max" mode, only updating upon a new max value. */
348 SR_MQFLAG_MAX = 0x20,
349 /** Device is in "min" mode, only updating upon a new min value. */
350 SR_MQFLAG_MIN = 0x40,
351 /** Device is in autoranging mode. */
352 SR_MQFLAG_AUTORANGE = 0x80,
353 /** Device is in relative mode. */
354 SR_MQFLAG_RELATIVE = 0x100,
355 /** Sound pressure level is A-weighted in the frequency domain,
356 * according to IEC 61672:2003. */
357 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
358 /** Sound pressure level is C-weighted in the frequency domain,
359 * according to IEC 61672:2003. */
360 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
361 /** Sound pressure level is Z-weighted (i.e. not at all) in the
362 * frequency domain, according to IEC 61672:2003. */
363 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
364 /** Sound pressure level is not weighted in the frequency domain,
365 * albeit without standards-defined low and high frequency limits. */
366 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
367 /** Sound pressure level measurement is S-weighted (1s) in the
369 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
370 /** Sound pressure level measurement is F-weighted (125ms) in the
372 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
373 /** Sound pressure level is time-averaged (LAT), also known as
374 * Equivalent Continuous A-weighted Sound Level (LEQ). */
375 SR_MQFLAG_SPL_LAT = 0x8000,
376 /** Sound pressure level represented as a percentage of measurements
377 * that were over a preset alarm level. */
378 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
379 /** Time is duration (as opposed to epoch, ...). */
380 SR_MQFLAG_DURATION = 0x20000,
381 /** Device is in "avg" mode, averaging upon each new value. */
382 SR_MQFLAG_AVG = 0x40000,
383 /** Reference value shown. */
384 SR_MQFLAG_REFERENCE = 0x80000,
385 /** Unstable value (hasn't settled yet). */
386 SR_MQFLAG_UNSTABLE = 0x100000,
389 * Update mq_strings[] (analog.c) and fancyprint() (output/analog.c)
394 enum sr_trigger_matches {
404 /** The representation of a trigger, consisting of one or more stages
405 * containing one or more matches on a channel.
408 /** A name for this trigger. This may be NULL if none is needed. */
410 /** List of pointers to struct sr_trigger_stage. */
414 /** A trigger stage. */
415 struct sr_trigger_stage {
418 /** List of pointers to struct sr_trigger_match. */
422 /** A channel to match and what to match it on. */
423 struct sr_trigger_match {
424 /** The channel to trigger on. */
425 struct sr_channel *channel;
426 /** The trigger match to use.
427 * For logic channels, only the following matches may be used:
434 * For analog channels, only these matches may be used:
442 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
443 * this contains the value to compare against. */
449 * Opaque structure representing a libsigrok context.
451 * None of the fields of this structure are meant to be accessed directly.
453 * @see sr_init(), sr_exit().
459 * Opaque structure representing a libsigrok session.
461 * None of the fields of this structure are meant to be accessed directly.
463 * @see sr_session_new(), sr_session_destroy().
468 /** Numerator of the rational number. */
470 /** Denominator of the rational number. */
474 /** Packet in a sigrok data feed. */
475 struct sr_datafeed_packet {
480 /** Header of a sigrok data feed. */
481 struct sr_datafeed_header {
483 struct timeval starttime;
486 /** Datafeed payload for type SR_DF_META. */
487 struct sr_datafeed_meta {
491 /** Logic datafeed payload for type SR_DF_LOGIC. */
492 struct sr_datafeed_logic {
498 /** Analog datafeed payload for type SR_DF_ANALOG. */
499 struct sr_datafeed_analog {
500 /** The channels for which data is included in this packet. */
502 /** Number of samples in data */
504 /** Measured quantity (voltage, current, temperature, and so on).
505 * Use SR_MQ_VOLTAGE, ... */
507 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
509 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
511 /** The analog value(s). The data is interleaved according to
512 * the channels list. */
516 /** Analog datafeed payload for type SR_DF_ANALOG2. */
517 struct sr_datafeed_analog2 {
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 gboolean is_digits_decimal;
532 struct sr_rational scale;
533 struct sr_rational offset;
536 struct sr_analog_meaning {
539 enum sr_mqflag mqflags;
543 struct sr_analog_spec {
547 /** Generic option struct used by various subsystems. */
549 /* Short name suitable for commandline usage, [a-z0-9-]. */
551 /* Short name suitable for GUI usage, can contain UTF-8. */
553 /* Description of the option, in a sentence. */
555 /* Default value for this option. */
557 /* List of possible values, if this is an option with few values. */
561 /** Output module flags. */
562 enum sr_output_flag {
563 /** If set, this output module writes the output itself. */
564 SR_OUTPUT_INTERNAL_IO_HANDLING = 0x01,
568 struct sr_input_module;
570 struct sr_output_module;
572 struct sr_transform_module;
574 /** Constants for channel type. */
575 enum sr_channeltype {
576 /** Channel type is logic channel. */
577 SR_CHANNEL_LOGIC = 10000,
578 /** Channel type is analog channel. */
582 /** Information on single channel. */
584 /** The device this channel is attached to. */
585 struct sr_dev_inst *sdi;
586 /** The index of this channel, starting at 0. Logic channels will
587 * be encoded according to this index in SR_DF_LOGIC packets. */
589 /** Channel type (SR_CHANNEL_LOGIC, ...) */
591 /** Is this channel enabled? */
593 /** Name of channel. */
595 /** Private data for driver use. */
599 /** Structure for groups of channels that have common properties. */
600 struct sr_channel_group {
601 /** Name of the channel group. */
603 /** List of sr_channel structs of the channels belonging to this group. */
605 /** Private data for driver use. */
609 /** Used for setting or getting value of a config item. */
611 /** Config key like SR_CONF_CONN, etc. */
613 /** Key-specific data. */
623 /** Information about a key. */
625 /** Config key like SR_CONF_CONN, MQ value like SR_MQ_VOLTAGE, etc. */
627 /** Data type like SR_T_STRING, etc if applicable. */
629 /** Short, lowercase ID string, e.g. "serialcomm", "voltage". */
631 /** Full capitalized name, e.g. "Serial communication". */
633 /** Verbose description (unused currently). */
637 #define SR_CONF_GET (1 << 31)
638 #define SR_CONF_SET (1 << 30)
639 #define SR_CONF_LIST (1 << 29)
640 #define SR_CONF_MASK 0x1fffffff
642 /** Configuration keys */
644 /*--- Device classes ------------------------------------------------*/
646 /** The device can act as logic analyzer. */
647 SR_CONF_LOGIC_ANALYZER = 10000,
649 /** The device can act as an oscilloscope. */
650 SR_CONF_OSCILLOSCOPE,
652 /** The device can act as a multimeter. */
655 /** The device is a demo device. */
658 /** The device can act as a sound level meter. */
659 SR_CONF_SOUNDLEVELMETER,
661 /** The device can measure temperature. */
664 /** The device can measure humidity. */
667 /** The device can measure energy consumption. */
670 /** The device can act as a signal demodulator. */
673 /** The device can act as a programmable power supply. */
674 SR_CONF_POWER_SUPPLY,
676 /** The device can act as an LCR meter. */
679 /** The device can act as an electronic load. */
680 SR_CONF_ELECTRONIC_LOAD,
682 /** The device can act as a scale. */
685 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
687 /*--- Driver scan options -------------------------------------------*/
690 * Specification on how to connect to a device.
692 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
693 * the form which makes sense to the OS (e.g., /dev/ttyS0).
694 * Otherwise this specifies a USB device, either in the form of
695 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
696 * @verbatim <vendorid>.<productid> @endverbatim
697 * (hexadecimal, e.g. 1d6b.0001).
699 SR_CONF_CONN = 20000,
702 * Serial communication specification, in the form:
704 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
708 * The string may also be followed by one or more special settings,
709 * in the form "/key=value". Supported keys and their values are:
711 * rts 0,1 set the port's RTS pin to low or high
712 * dtr 0,1 set the port's DTR pin to low or high
713 * flow 0 no flow control
714 * 1 hardware-based (RTS/CTS) flow control
715 * 2 software-based (XON/XOFF) flow control
717 * This is always an optional parameter, since a driver typically
718 * knows the speed at which the device wants to communicate.
723 * Modbus slave address specification.
725 * This is always an optional parameter, since a driver typically
726 * knows the default slave address of the device.
730 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
732 /*--- Device (or channel group) configuration -----------------------*/
734 /** The device supports setting its samplerate, in Hz. */
735 SR_CONF_SAMPLERATE = 30000,
737 /** The device supports setting a pre/post-trigger capture ratio. */
738 SR_CONF_CAPTURE_RATIO,
740 /** The device supports setting a pattern (pattern generator mode). */
741 SR_CONF_PATTERN_MODE,
743 /** The device supports run-length encoding (RLE). */
746 /** The device supports setting trigger slope. */
747 SR_CONF_TRIGGER_SLOPE,
749 /** The device supports averaging. */
753 * The device supports setting number of samples to be
758 /** Trigger source. */
759 SR_CONF_TRIGGER_SOURCE,
761 /** Horizontal trigger position. */
762 SR_CONF_HORIZ_TRIGGERPOS,
779 /** Trigger matches. */
780 SR_CONF_TRIGGER_MATCH,
782 /** The device supports setting its sample interval, in ms. */
783 SR_CONF_SAMPLE_INTERVAL,
785 /** Number of horizontal divisions, as related to SR_CONF_TIMEBASE. */
788 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
791 /** Sound pressure level frequency weighting. */
792 SR_CONF_SPL_WEIGHT_FREQ,
794 /** Sound pressure level time weighting. */
795 SR_CONF_SPL_WEIGHT_TIME,
797 /** Sound pressure level measurement range. */
798 SR_CONF_SPL_MEASUREMENT_RANGE,
800 /** Max hold mode. */
803 /** Min hold mode. */
806 /** Logic low-high threshold range. */
807 SR_CONF_VOLTAGE_THRESHOLD,
809 /** The device supports using an external clock. */
810 SR_CONF_EXTERNAL_CLOCK,
813 * The device supports swapping channels. Typical this is between
814 * buffered and unbuffered channels.
818 /** Center frequency.
819 * The input signal is downmixed by this frequency before the ADC
820 * anti-aliasing filter.
822 SR_CONF_CENTER_FREQUENCY,
824 /** The device supports setting the number of logic channels. */
825 SR_CONF_NUM_LOGIC_CHANNELS,
827 /** The device supports setting the number of analog channels. */
828 SR_CONF_NUM_ANALOG_CHANNELS,
833 * @arg get: get measured voltage
838 * Maximum target voltage.
840 * @arg get: get target voltage
841 * @arg set: change target voltage
843 SR_CONF_VOLTAGE_TARGET,
848 * @arg get: get measured current
855 * @arg get: get current limit
856 * @arg set: change current limit
858 SR_CONF_CURRENT_LIMIT,
861 * Enabling/disabling channel.
863 * @arg get: @b true if currently enabled
864 * @arg set: enable/disable
869 * Channel configuration.
871 * @arg get: get current setting
872 * @arg set: change current setting
873 * @arg list: array of possible values
875 SR_CONF_CHANNEL_CONFIG,
878 * Over-voltage protection (OVP) feature
880 * @arg get: @b true if currently enabled
881 * @arg set: enable/disable
883 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
886 * Over-voltage protection (OVP) active
888 * @arg get: @b true if device has activated OVP, i.e. the output voltage
889 * exceeds the over-voltage protection threshold.
891 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
894 * Over-voltage protection (OVP) threshold
895 * @arg type: double (voltage)
896 * @arg get: get current threshold
897 * @arg set: set new threshold
899 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
902 * Over-current protection (OCP) feature
904 * @arg get: @b true if currently enabled
905 * @arg set: enable/disable
907 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
910 * Over-current protection (OCP) active
912 * @arg get: @b true if device has activated OCP, i.e. the current current
913 * exceeds the over-current protection threshold.
915 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
918 * Over-current protection (OCP) threshold
919 * @arg type: double (current)
920 * @arg get: get current threshold
921 * @arg set: set new threshold
923 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
925 /** Choice of clock edge for external clock ("r" or "f"). */
928 /** Amplitude of a source without strictly-defined MQ. */
933 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
938 /** Over-temperature protection (OTP) */
939 SR_CONF_OVER_TEMPERATURE_PROTECTION,
941 /** Output frequency in Hz. */
942 SR_CONF_OUTPUT_FREQUENCY,
944 /** Output frequency target in Hz. */
945 SR_CONF_OUTPUT_FREQUENCY_TARGET,
947 /** Measured quantity. */
948 SR_CONF_MEASURED_QUANTITY,
950 /** Measured secondary quantity. */
951 SR_CONF_MEASURED_2ND_QUANTITY,
953 /** Equivalent circuit model. */
954 SR_CONF_EQUIV_CIRCUIT_MODEL,
956 /** Over-temperature protection (OTP) active. */
957 SR_CONF_OVER_TEMPERATURE_PROTECTION_ACTIVE,
959 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
961 /*--- Special stuff -------------------------------------------------*/
963 /** Scan options supported by the driver. */
964 SR_CONF_SCAN_OPTIONS = 40000,
966 /** Device options for a particular device. */
967 SR_CONF_DEVICE_OPTIONS,
969 /** Session filename. */
972 /** The device supports specifying a capturefile to inject. */
975 /** The device supports specifying the capturefile unit size. */
976 SR_CONF_CAPTURE_UNITSIZE,
978 /** Power off the device. */
982 * Data source for acquisition. If not present, acquisition from
983 * the device is always "live", i.e. acquisition starts when the
984 * frontend asks and the results are sent out as soon as possible.
986 * If present, it indicates that either the device has no live
987 * acquisition capability (for example a pure data logger), or
988 * there is a choice. sr_config_list() returns those choices.
990 * In any case if a device has live acquisition capabilities, it
991 * is always the default.
995 /** The device supports setting a probe factor. */
996 SR_CONF_PROBE_FACTOR,
998 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1000 /*--- Acquisition modes, sample limiting ----------------------------*/
1003 * The device supports setting a sample time limit (how long
1004 * the sample acquisition should run, in ms).
1006 SR_CONF_LIMIT_MSEC = 50000,
1009 * The device supports setting a sample number limit (how many
1010 * samples should be acquired).
1012 SR_CONF_LIMIT_SAMPLES,
1015 * The device supports setting a frame limit (how many
1016 * frames should be acquired).
1018 SR_CONF_LIMIT_FRAMES,
1021 * The device supports continuous sampling. Neither a time limit
1022 * nor a sample number limit has to be supplied, it will just acquire
1023 * samples continuously, until explicitly stopped by a certain command.
1027 /** The device has internal storage, into which data is logged. This
1028 * starts or stops the internal logging. */
1031 /** Device mode for multi-function devices. */
1032 SR_CONF_DEVICE_MODE,
1034 /** Self test mode. */
1037 /* Update sr_key_info_config[] (hwdriver.c) upon changes! */
1041 * Opaque structure representing a libsigrok device instance.
1043 * None of the fields of this structure are meant to be accessed directly.
1047 /** Types of device instance, struct sr_dev_inst.type */
1048 enum sr_dev_inst_type {
1049 /** Device instance type for USB devices. */
1050 SR_INST_USB = 10000,
1051 /** Device instance type for serial port devices. */
1053 /** Device instance type for SCPI devices. */
1055 /** Device-instance type for user-created "devices". */
1057 /** Device instance type for Modbus devices. */
1061 /** Device instance status, struct sr_dev_inst.status */
1062 enum sr_dev_inst_status {
1063 /** The device instance was not found. */
1064 SR_ST_NOT_FOUND = 10000,
1065 /** The device instance was found, but is still booting. */
1067 /** The device instance is live, but not in use. */
1069 /** The device instance is actively in use in a session. */
1071 /** The device is winding down its session. */
1075 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
1076 struct sr_dev_driver {
1077 /* Driver-specific */
1078 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
1080 /** Long name. Verbose driver name shown to user. */
1082 /** API version (currently 1). */
1084 /** Called when driver is loaded, e.g. program startup. */
1085 int (*init) (struct sr_dev_driver *driver, struct sr_context *sr_ctx);
1086 /** Called before driver is unloaded.
1087 * Driver must free all resources held by it. */
1088 int (*cleanup) (const struct sr_dev_driver *driver);
1089 /** Scan for devices. Driver should do all initialisation required.
1090 * Can be called several times, e.g. with different port options.
1091 * @retval NULL Error or no devices found.
1092 * @retval other GSList of a struct sr_dev_inst for each device.
1093 * Must be freed by caller!
1095 GSList *(*scan) (struct sr_dev_driver *driver, GSList *options);
1096 /** Get list of device instances the driver knows about.
1097 * @returns NULL or GSList of a struct sr_dev_inst for each device.
1098 * Must not be freed by caller!
1100 GSList *(*dev_list) (const struct sr_dev_driver *driver);
1101 /** Clear list of devices the driver knows about. */
1102 int (*dev_clear) (const struct sr_dev_driver *driver);
1103 /** Query value of a configuration key in driver or given device instance.
1104 * @see sr_config_get().
1106 int (*config_get) (uint32_t key, GVariant **data,
1107 const struct sr_dev_inst *sdi,
1108 const struct sr_channel_group *cg);
1109 /** Set value of a configuration key in driver or a given device instance.
1110 * @see sr_config_set(). */
1111 int (*config_set) (uint32_t key, GVariant *data,
1112 const struct sr_dev_inst *sdi,
1113 const struct sr_channel_group *cg);
1114 /** Channel status change.
1115 * @see sr_dev_channel_enable(). */
1116 int (*config_channel_set) (const struct sr_dev_inst *sdi,
1117 struct sr_channel *ch, unsigned int changes);
1118 /** Apply configuration settings to the device hardware.
1119 * @see sr_config_commit().*/
1120 int (*config_commit) (const struct sr_dev_inst *sdi);
1121 /** List all possible values for a configuration key in a device instance.
1122 * @see sr_config_list().
1124 int (*config_list) (uint32_t key, GVariant **data,
1125 const struct sr_dev_inst *sdi,
1126 const struct sr_channel_group *cg);
1128 /* Device-specific */
1130 int (*dev_open) (struct sr_dev_inst *sdi);
1132 int (*dev_close) (struct sr_dev_inst *sdi);
1133 /** Begin data acquisition on the specified device. */
1134 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
1136 /** End data acquisition on the specified device. */
1137 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1141 /** Device driver context, considered private. Initialized by init(). */
1146 * @struct sr_session
1148 * Opaque data structure representing a libsigrok session. None of the fields
1149 * of this structure are meant to be accessed directly.
1153 /** Serial port descriptor. */
1154 struct sr_serial_port {
1155 /** The OS dependent name of the serial port. */
1157 /** An end user friendly description for the serial port. */
1161 #include <libsigrok/proto.h>
1162 #include <libsigrok/version.h>