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. */
81 * Note: When adding entries here, don't forget to also update the
82 * sr_strerror() and sr_strerror_name() functions in error.c.
86 #define SR_MAX_CHANNELNAME_LEN 32
88 /* Handy little macros */
90 #define SR_KHZ(n) ((n) * (uint64_t)(1000ULL))
91 #define SR_MHZ(n) ((n) * (uint64_t)(1000000ULL))
92 #define SR_GHZ(n) ((n) * (uint64_t)(1000000000ULL))
94 #define SR_HZ_TO_NS(n) ((uint64_t)(1000000000ULL) / (n))
96 /** libsigrok loglevels. */
98 SR_LOG_NONE = 0, /**< Output no messages at all. */
99 SR_LOG_ERR = 1, /**< Output error messages. */
100 SR_LOG_WARN = 2, /**< Output warnings. */
101 SR_LOG_INFO = 3, /**< Output informational messages. */
102 SR_LOG_DBG = 4, /**< Output debug messages. */
103 SR_LOG_SPEW = 5, /**< Output very noisy debug messages. */
107 * Use SR_API to mark public API symbols, and SR_PRIV for private symbols.
109 * Variables and functions marked 'static' are private already and don't
110 * need SR_PRIV. However, functions which are not static (because they need
111 * to be used in other libsigrok-internal files) but are also not meant to
112 * be part of the public libsigrok API, must use SR_PRIV.
114 * This uses the 'visibility' feature of gcc (requires gcc >= 4.0).
116 * This feature is not available on MinGW/Windows, as it is a feature of
117 * ELF files and MinGW/Windows uses PE files.
119 * Details: http://gcc.gnu.org/wiki/Visibility
122 /* Marks public libsigrok API symbols. */
124 #define SR_API __attribute__((visibility("default")))
129 /* Marks private, non-public libsigrok symbols (not part of the API). */
131 #define SR_PRIV __attribute__((visibility("hidden")))
136 /** Type definition for callback function for data reception. */
137 typedef int (*sr_receive_data_callback)(int fd, int revents, void *cb_data);
139 /** Data types used by sr_config_info(). */
145 SR_T_RATIONAL_PERIOD,
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 /** Payload is struct sr_datafeed_analog. */
167 /** Beginning of frame. No payload. */
169 /** End of frame. No payload. */
173 /** Measured quantity, sr_datafeed_analog.mq. */
175 SR_MQ_VOLTAGE = 10000,
181 /** Duty cycle, e.g. on/off ratio. */
183 /** Continuity test. */
187 /** Electrical power, usually in W, or dBm. */
189 /** Gain (a transistor's gain, or hFE, for example). */
191 /** Logarithmic representation of sound pressure relative to a
192 * reference value. */
193 SR_MQ_SOUND_PRESSURE_LEVEL,
194 /** Carbon monoxide level */
195 SR_MQ_CARBON_MONOXIDE,
197 SR_MQ_RELATIVE_HUMIDITY,
206 /** Unit of measured quantity, sr_datafeed_analog.unit. */
209 SR_UNIT_VOLT = 10000,
210 /** Ampere (current). */
212 /** Ohm (resistance). */
214 /** Farad (capacity). */
216 /** Kelvin (temperature). */
218 /** Degrees Celsius (temperature). */
220 /** Degrees Fahrenheit (temperature). */
222 /** Hertz (frequency, 1/s, [Hz]). */
224 /** Percent value. */
226 /** Boolean value. */
228 /** Time in seconds. */
230 /** Unit of conductance, the inverse of resistance. */
233 * An absolute measurement of power, in decibels, referenced to
237 /** Voltage in decibel, referenced to 1 volt (dBV). */
238 SR_UNIT_DECIBEL_VOLT,
240 * Measurements that intrinsically do not have units attached, such
241 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
242 * a unitless quantity, for example.
245 /** Sound pressure level, in decibels, relative to 20 micropascals. */
248 * Normalized (0 to 1) concentration of a substance or compound with 0
249 * representing a concentration of 0%, and 1 being 100%. This is
250 * represented as the fraction of number of particles of the substance.
252 SR_UNIT_CONCENTRATION,
253 /** Revolutions per minute. */
254 SR_UNIT_REVOLUTIONS_PER_MINUTE,
255 /** Apparent power [VA]. */
257 /** Real power [W]. */
259 /** Consumption [Wh]. */
261 /** Wind speed in meters per second. */
262 SR_UNIT_METER_SECOND,
263 /** Pressure in hectopascal */
265 /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
266 SR_UNIT_HUMIDITY_293K,
269 /** Values for sr_datafeed_analog.flags. */
271 /** Voltage measurement is alternating current (AC). */
273 /** Voltage measurement is direct current (DC). */
275 /** This is a true RMS measurement. */
276 SR_MQFLAG_RMS = 0x04,
277 /** Value is voltage drop across a diode, or NAN. */
278 SR_MQFLAG_DIODE = 0x08,
279 /** Device is in "hold" mode (repeating the last measurement). */
280 SR_MQFLAG_HOLD = 0x10,
281 /** Device is in "max" mode, only updating upon a new max value. */
282 SR_MQFLAG_MAX = 0x20,
283 /** Device is in "min" mode, only updating upon a new min value. */
284 SR_MQFLAG_MIN = 0x40,
285 /** Device is in autoranging mode. */
286 SR_MQFLAG_AUTORANGE = 0x80,
287 /** Device is in relative mode. */
288 SR_MQFLAG_RELATIVE = 0x100,
289 /** Sound pressure level is A-weighted in the frequency domain,
290 * according to IEC 61672:2003. */
291 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
292 /** Sound pressure level is C-weighted in the frequency domain,
293 * according to IEC 61672:2003. */
294 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
295 /** Sound pressure level is Z-weighted (i.e. not at all) in the
296 * frequency domain, according to IEC 61672:2003. */
297 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
298 /** Sound pressure level is not weighted in the frequency domain,
299 * albeit without standards-defined low and high frequency limits. */
300 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
301 /** Sound pressure level measurement is S-weighted (1s) in the
303 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
304 /** Sound pressure level measurement is F-weighted (125ms) in the
306 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
307 /** Sound pressure level is time-averaged (LAT), also known as
308 * Equivalent Continuous A-weighted Sound Level (LEQ). */
309 SR_MQFLAG_SPL_LAT = 0x8000,
310 /** Sound pressure level represented as a percentage of measurements
311 * that were over a preset alarm level. */
312 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
313 /** Time is duration (as opposed to epoch, ...). */
314 SR_MQFLAG_DURATION = 0x20000,
315 /** Device is in "avg" mode, averaging upon each new value. */
316 SR_MQFLAG_AVG = 0x40000,
319 enum sr_trigger_matches {
329 /** The representation of a trigger, consisting of one or more stages
330 * containing one or more matches on a channel.
333 /** A name for this trigger. This may be NULL if none is needed. */
335 /** List of pointers to struct sr_trigger_stage. */
339 /** A trigger stage. */
340 struct sr_trigger_stage {
343 /** List of pointers to struct sr_trigger_match. */
347 /** A channel to match and what to match it on. */
348 struct sr_trigger_match {
349 /** The channel to trigger on. */
350 struct sr_channel *channel;
351 /** The trigger match to use.
352 * For logic channels, only the following matches may be used:
359 * For analog channels, only these matches may be used:
367 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
368 * this contains the value to compare against. */
374 * Opaque structure representing a libsigrok context.
376 * None of the fields of this structure are meant to be accessed directly.
378 * @see sr_init(), sr_exit().
384 * Opaque structure representing a libsigrok session.
386 * None of the fields of this structure are meant to be accessed directly.
388 * @see sr_session_new(), sr_session_destroy().
392 /** Packet in a sigrok data feed. */
393 struct sr_datafeed_packet {
398 /** Header of a sigrok data feed. */
399 struct sr_datafeed_header {
401 struct timeval starttime;
404 /** Datafeed payload for type SR_DF_META. */
405 struct sr_datafeed_meta {
409 /** Logic datafeed payload for type SR_DF_LOGIC. */
410 struct sr_datafeed_logic {
416 /** Analog datafeed payload for type SR_DF_ANALOG. */
417 struct sr_datafeed_analog {
418 /** The channels for which data is included in this packet. */
420 /** Number of samples in data */
422 /** Measured quantity (voltage, current, temperature, and so on).
423 * Use SR_MQ_VOLTAGE, ... */
425 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
427 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
429 /** The analog value(s). The data is interleaved according to
430 * the channels list. */
434 /** Generic option struct used by various subsystems. */
436 /* Short name suitable for commandline usage, [a-z0-9-]. */
438 /* Short name suitable for GUI usage, can contain UTF-8. */
440 /* Description of the option, in a sentence. */
442 /* Default value for this option. */
444 /* List of possible values, if this is an option with few values. */
449 struct sr_input_module;
451 struct sr_output_module;
453 /** Constants for channel type. */
454 enum sr_channeltype {
455 /** Channel type is logic channel. */
456 SR_CHANNEL_LOGIC = 10000,
457 /** Channel type is analog channel. */
461 /** Information on single channel. */
463 /** The index of this channel, starting at 0. Logic channels will
464 * be encoded according to this index in SR_DF_LOGIC packets. */
466 /** Channel type (SR_CHANNEL_LOGIC, ...) */
468 /** Is this channel enabled? */
470 /** Name of channel. */
472 /** Private data for driver use. */
476 /** Structure for groups of channels that have common properties. */
477 struct sr_channel_group {
478 /** Name of the channel group. */
480 /** List of sr_channel structs of the channels belonging to this group. */
482 /** Private data for driver use. */
486 /** Used for setting or getting value of a config item. */
488 /** Config key like SR_CONF_CONN, etc. */
490 /** Key-specific data. */
494 /** Information about a config key. */
495 struct sr_config_info {
496 /** Config key like SR_CONF_CONN, etc. */
498 /** Data type like SR_T_STRING, etc. */
500 /** Id string, e.g. "serialcomm". */
502 /** Name, e.g. "Serial communication". */
504 /** Verbose description (unused currently). */
508 #define SR_CONF_GET (1 << 31)
509 #define SR_CONF_SET (1 << 30)
510 #define SR_CONF_LIST (1 << 29)
511 #define SR_CONF_MASK 0x1fffffff
513 /** Constants for device classes */
515 /*--- Device classes ------------------------------------------------*/
517 /** The device can act as logic analyzer. */
518 SR_CONF_LOGIC_ANALYZER = 10000,
520 /** The device can act as an oscilloscope. */
521 SR_CONF_OSCILLOSCOPE,
523 /** The device can act as a multimeter. */
526 /** The device is a demo device. */
529 /** The device can act as a sound level meter. */
530 SR_CONF_SOUNDLEVELMETER,
532 /** The device can measure temperature. */
535 /** The device can measure humidity. */
538 /** The device can measure energy consumption. */
541 /** The device can demodulate signals. */
544 /** Programmable power supply. */
545 SR_CONF_POWER_SUPPLY,
547 /*--- Driver scan options -------------------------------------------*/
550 * Specification on how to connect to a device.
552 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
553 * the form which makes sense to the OS (e.g., /dev/ttyS0).
554 * Otherwise this specifies a USB device, either in the form of
555 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
556 * @verbatim <vendorid>.<productid> @endverbatim
557 * (hexadecimal, e.g. 1d6b.0001).
559 SR_CONF_CONN = 20000,
562 * Serial communication specification, in the form:
564 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
568 * The string may also be followed by one or more special settings,
569 * in the form "/key=value". Supported keys and their values are:
571 * rts 0,1 set the port's RTS pin to low or high
572 * dtr 0,1 set the port's DTR pin to low or high
573 * flow 0 no flow control
574 * 1 hardware-based (RTS/CTS) flow control
575 * 2 software-based (XON/XOFF) flow control
577 * This is always an optional parameter, since a driver typically
578 * knows the speed at which the device wants to communicate.
582 /*--- Device configuration ------------------------------------------*/
584 /** The device supports setting its samplerate, in Hz. */
585 SR_CONF_SAMPLERATE = 30000,
587 /** The device supports setting a pre/post-trigger capture ratio. */
588 SR_CONF_CAPTURE_RATIO,
590 /** The device supports setting a pattern (pattern generator mode). */
591 SR_CONF_PATTERN_MODE,
593 /** The device supports Run Length Encoding. */
596 /** The device supports setting trigger slope. */
597 SR_CONF_TRIGGER_SLOPE,
599 /** Trigger source. */
600 SR_CONF_TRIGGER_SOURCE,
602 /** Horizontal trigger position. */
603 SR_CONF_HORIZ_TRIGGERPOS,
620 /** Trigger matches. */
621 SR_CONF_TRIGGER_MATCH,
623 /** The device supports setting its sample interval, in ms. */
624 SR_CONF_SAMPLE_INTERVAL,
626 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
627 SR_CONF_NUM_TIMEBASE,
629 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
632 /** Sound pressure level frequency weighting. */
633 SR_CONF_SPL_WEIGHT_FREQ,
635 /** Sound pressure level time weighting. */
636 SR_CONF_SPL_WEIGHT_TIME,
638 /** Sound pressure level measurement range. */
639 SR_CONF_SPL_MEASUREMENT_RANGE,
641 /** Max hold mode. */
644 /** Min hold mode. */
647 /** Logic low-high threshold range. */
648 SR_CONF_VOLTAGE_THRESHOLD,
650 /** The device supports using an external clock. */
651 SR_CONF_EXTERNAL_CLOCK,
654 * The device supports swapping channels. Typical this is between
655 * buffered and unbuffered channels.
659 /** Center frequency.
660 * The input signal is downmixed by this frequency before the ADC
661 * anti-aliasing filter.
663 SR_CONF_CENTER_FREQUENCY,
665 /** The device supports setting the number of logic channels. */
666 SR_CONF_NUM_LOGIC_CHANNELS,
668 /** The device supports setting the number of analog channels. */
669 SR_CONF_NUM_ANALOG_CHANNELS,
674 * @arg get: get output voltage
676 SR_CONF_OUTPUT_VOLTAGE,
679 * Maximum output voltage.
681 * @arg get: get maximum output voltage limit
682 * @arg set: change output voltage limit
684 SR_CONF_OUTPUT_VOLTAGE_MAX,
689 * @arg get: get output current
691 SR_CONF_OUTPUT_CURRENT,
694 * Maximum output current.
696 * @arg get: get maximum output voltage limit
697 * @arg set: change output voltage limit
699 SR_CONF_OUTPUT_CURRENT_MAX,
702 * Enabling/disabling output.
704 * @arg get: @b true if currently enabled
705 * @arg set: enable/disable
707 SR_CONF_OUTPUT_ENABLED,
710 * Output channel configuration.
712 * @arg get: get current setting
713 * @arg set: change current setting
714 * @arg list: array of possible values
716 SR_CONF_OUTPUT_CHANNEL_CONFIG,
719 * Over-voltage protection (OVP) feature
721 * @arg get: @b true if currently enabled
722 * @arg set: enable/disable
724 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
727 * Over-voltage protection (OVP) active
729 * @arg get: @b true if device has activated OVP, i.e. the output voltage
730 * exceeds the over-voltage protection threshold.
732 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
735 * Over-voltage protection (OVP) threshold
736 * @arg type: double (voltage)
737 * @arg get: get current threshold
738 * @arg set: set new threshold
740 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
743 * Over-current protection (OCP) feature
745 * @arg get: @b true if currently enabled
746 * @arg set: enable/disable
748 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
751 * Over-current protection (OCP) active
753 * @arg get: @b true if device has activated OCP, i.e. the output current
754 * exceeds the over-current protection threshold.
756 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
759 * Over-current protection (OCP) threshold
760 * @arg type: double (current)
761 * @arg get: get current threshold
762 * @arg set: set new threshold
764 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
766 /** Choice of clock edge for external clock ("r" or "f"). */
769 /** Amplitude of a source without strictly-defined MQ. */
773 * Output channel regulation
774 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
777 SR_CONF_OUTPUT_REGULATION,
779 /** Over-temperature protection (OTP) */
780 SR_CONF_OVER_TEMPERATURE_PROTECTION,
782 /*--- Special stuff -------------------------------------------------*/
784 /** Scan options supported by the driver. */
785 SR_CONF_SCAN_OPTIONS = 40000,
787 /** Device options for a particular device. */
788 SR_CONF_DEVICE_OPTIONS,
790 /** Session filename. */
793 /** The device supports specifying a capturefile to inject. */
796 /** The device supports specifying the capturefile unit size. */
797 SR_CONF_CAPTURE_UNITSIZE,
799 /** Power off the device. */
803 * Data source for acquisition. If not present, acquisition from
804 * the device is always "live", i.e. acquisition starts when the
805 * frontend asks and the results are sent out as soon as possible.
807 * If present, it indicates that either the device has no live
808 * acquisition capability (for example a pure data logger), or
809 * there is a choice. sr_config_list() returns those choices.
811 * In any case if a device has live acquisition capabilities, it
812 * is always the default.
816 /*--- Acquisition modes ---------------------------------------------*/
819 * The device supports setting a sample time limit (how long
820 * the sample acquisition should run, in ms).
822 SR_CONF_LIMIT_MSEC = 50000,
825 * The device supports setting a sample number limit (how many
826 * samples should be acquired).
828 SR_CONF_LIMIT_SAMPLES,
831 * The device supports setting a frame limit (how many
832 * frames should be acquired).
834 SR_CONF_LIMIT_FRAMES,
837 * The device supports continuous sampling. Neither a time limit
838 * nor a sample number limit has to be supplied, it will just acquire
839 * samples continuously, until explicitly stopped by a certain command.
843 /** The device has internal storage, into which data is logged. This
844 * starts or stops the internal logging. */
847 /** Device mode for multi-function devices. */
850 /** Self test mode. */
854 /** Device instance data
857 /** Device driver. */
858 struct sr_dev_driver *driver;
859 /** Device instance status. SR_ST_NOT_FOUND, etc. */
861 /** Device instance type. SR_INST_USB, etc. */
863 /** Device vendor. */
867 /** Device version. */
869 /** Serial number. */
871 /** Connection string to uniquely identify devices. */
873 /** List of channels. */
875 /** List of sr_channel_group structs */
876 GSList *channel_groups;
877 /** Device instance connection data (used?) */
879 /** Device instance private data (used?) */
881 /** Session to which this device is currently assigned. */
882 struct sr_session *session;
885 /** Types of device instance, struct sr_dev_inst.type */
886 enum sr_dev_inst_type {
887 /** Device instance type for USB devices. */
889 /** Device instance type for serial port devices. */
891 /** Device instance type for SCPI devices. */
895 /** Device instance status, struct sr_dev_inst.status */
896 enum sr_dev_inst_status {
897 /** The device instance was not found. */
898 SR_ST_NOT_FOUND = 10000,
899 /** The device instance was found, but is still booting. */
901 /** The device instance is live, but not in use. */
903 /** The device instance is actively in use in a session. */
905 /** The device is winding down its session. */
909 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
910 struct sr_dev_driver {
911 /* Driver-specific */
912 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
914 /** Long name. Verbose driver name shown to user. */
916 /** API version (currently 1). */
918 /** Called when driver is loaded, e.g. program startup. */
919 int (*init) (struct sr_context *sr_ctx);
920 /** Called before driver is unloaded.
921 * Driver must free all resouces held by it. */
922 int (*cleanup) (void);
923 /** Scan for devices. Driver should do all initialisation required.
924 * Can be called several times, e.g. with different port options.
925 * \retval NULL Error or no devices found.
926 * \retval other GSList of a struct sr_dev_inst for each device.
927 * Must be freed by caller!
929 GSList *(*scan) (GSList *options);
930 /** Get list of device instances the driver knows about.
931 * \returns NULL or GSList of a struct sr_dev_inst for each device.
932 * Must not be freed by caller!
934 GSList *(*dev_list) (void);
935 /** Clear list of devices the driver knows about. */
936 int (*dev_clear) (void);
937 /** Query value of a configuration key in driver or given device instance.
938 * @see sr_config_get().
940 int (*config_get) (uint32_t key, GVariant **data,
941 const struct sr_dev_inst *sdi,
942 const struct sr_channel_group *cg);
943 /** Set value of a configuration key in driver or a given device instance.
944 * @see sr_config_set(). */
945 int (*config_set) (uint32_t key, GVariant *data,
946 const struct sr_dev_inst *sdi,
947 const struct sr_channel_group *cg);
948 /** Channel status change.
949 * @see sr_dev_channel_enable(). */
950 int (*config_channel_set) (const struct sr_dev_inst *sdi,
951 struct sr_channel *ch, unsigned int changes);
952 /** Apply configuration settings to the device hardware.
953 * @see sr_config_commit().*/
954 int (*config_commit) (const struct sr_dev_inst *sdi);
955 /** List all possible values for a configuration key in a device instance.
956 * @see sr_config_list().
958 int (*config_list) (uint32_t key, GVariant **data,
959 const struct sr_dev_inst *sdi,
960 const struct sr_channel_group *cg);
962 /* Device-specific */
964 int (*dev_open) (struct sr_dev_inst *sdi);
966 int (*dev_close) (struct sr_dev_inst *sdi);
967 /** Begin data acquisition on the specified device. */
968 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
970 /** End data acquisition on the specified device. */
971 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
975 /** Device driver private data. Initialized by init(). */
982 * Opaque data structure representing a libsigrok session. None of the fields
983 * of this structure are meant to be accessed directly.