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. */
79 * Note: When adding entries here, don't forget to also update the
80 * sr_strerror() and sr_strerror_name() functions in error.c.
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 /** Value for sr_datafeed_packet.type. */
153 /** Payload is sr_datafeed_header. */
154 SR_DF_HEADER = 10000,
155 /** End of stream (no further data). */
157 /** Payload is struct sr_datafeed_meta */
159 /** The trigger matched at this point in the data feed. No payload. */
161 /** Payload is struct sr_datafeed_logic. */
163 /** Payload is struct sr_datafeed_analog. */
165 /** Beginning of frame. No payload. */
167 /** End of frame. No payload. */
171 /** Measured quantity, sr_datafeed_analog.mq. */
173 SR_MQ_VOLTAGE = 10000,
179 /** Duty cycle, e.g. on/off ratio. */
181 /** Continuity test. */
185 /** Electrical power, usually in W, or dBm. */
187 /** Gain (a transistor's gain, or hFE, for example). */
189 /** Logarithmic representation of sound pressure relative to a
190 * reference value. */
191 SR_MQ_SOUND_PRESSURE_LEVEL,
192 /** Carbon monoxide level */
193 SR_MQ_CARBON_MONOXIDE,
195 SR_MQ_RELATIVE_HUMIDITY,
200 /** Unit of measured quantity, sr_datafeed_analog.unit. */
203 SR_UNIT_VOLT = 10000,
204 /** Ampere (current). */
206 /** Ohm (resistance). */
208 /** Farad (capacity). */
210 /** Kelvin (temperature). */
212 /** Degrees Celsius (temperature). */
214 /** Degrees Fahrenheit (temperature). */
216 /** Hertz (frequency, 1/s, [Hz]). */
218 /** Percent value. */
220 /** Boolean value. */
222 /** Time in seconds. */
224 /** Unit of conductance, the inverse of resistance. */
227 * An absolute measurement of power, in decibels, referenced to
231 /** Voltage in decibel, referenced to 1 volt (dBV). */
232 SR_UNIT_DECIBEL_VOLT,
234 * Measurements that intrinsically do not have units attached, such
235 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
236 * a unitless quantity, for example.
239 /** Sound pressure level relative so 20 micropascals. */
242 * Normalized (0 to 1) concentration of a substance or compound with 0
243 * representing a concentration of 0%, and 1 being 100%. This is
244 * represented as the fraction of number of particles of the substance.
246 SR_UNIT_CONCENTRATION,
247 /** Revolutions per minute. */
248 SR_UNIT_REVOLUTIONS_PER_MINUTE,
249 /** Apparent power [VA]. */
251 /** Real power [W]. */
253 /** Consumption [Wh]. */
257 /** Values for sr_datafeed_analog.flags. */
259 /** Voltage measurement is alternating current (AC). */
261 /** Voltage measurement is direct current (DC). */
263 /** This is a true RMS measurement. */
264 SR_MQFLAG_RMS = 0x04,
265 /** Value is voltage drop across a diode, or NAN. */
266 SR_MQFLAG_DIODE = 0x08,
267 /** Device is in "hold" mode (repeating the last measurement). */
268 SR_MQFLAG_HOLD = 0x10,
269 /** Device is in "max" mode, only updating upon a new max value. */
270 SR_MQFLAG_MAX = 0x20,
271 /** Device is in "min" mode, only updating upon a new min value. */
272 SR_MQFLAG_MIN = 0x40,
273 /** Device is in autoranging mode. */
274 SR_MQFLAG_AUTORANGE = 0x80,
275 /** Device is in relative mode. */
276 SR_MQFLAG_RELATIVE = 0x100,
277 /** Sound pressure level is A-weighted in the frequency domain,
278 * according to IEC 61672:2003. */
279 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
280 /** Sound pressure level is C-weighted in the frequency domain,
281 * according to IEC 61672:2003. */
282 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
283 /** Sound pressure level is Z-weighted (i.e. not at all) in the
284 * frequency domain, according to IEC 61672:2003. */
285 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
286 /** Sound pressure level is not weighted in the frequency domain,
287 * albeit without standards-defined low and high frequency limits. */
288 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
289 /** Sound pressure level measurement is S-weighted (1s) in the
291 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
292 /** Sound pressure level measurement is F-weighted (125ms) in the
294 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
295 /** Sound pressure level is time-averaged (LAT), also known as
296 * Equivalent Continuous A-weighted Sound Level (LEQ). */
297 SR_MQFLAG_SPL_LAT = 0x8000,
298 /** Sound pressure level represented as a percentage of measurements
299 * that were over a preset alarm level. */
300 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
301 /** Time is duration (as opposed to epoch, ...). */
302 SR_MQFLAG_DURATION = 0x20000,
303 /** Device is in "avg" mode, averaging upon each new value. */
304 SR_MQFLAG_AVG = 0x40000,
309 * Opaque structure representing a libsigrok context.
311 * None of the fields of this structure are meant to be accessed directly.
313 * @see sr_init(), sr_exit().
317 /** Packet in a sigrok data feed. */
318 struct sr_datafeed_packet {
323 /** Header of a sigrok data feed. */
324 struct sr_datafeed_header {
326 struct timeval starttime;
329 /** Datafeed payload for type SR_DF_META. */
330 struct sr_datafeed_meta {
334 /** Logic datafeed payload for type SR_DF_LOGIC. */
335 struct sr_datafeed_logic {
341 /** Analog datafeed payload for type SR_DF_ANALOG. */
342 struct sr_datafeed_analog {
343 /** The channels for which data is included in this packet. */
345 /** Number of samples in data */
347 /** Measured quantity (voltage, current, temperature, and so on).
348 * Use SR_MQ_VOLTAGE, ... */
350 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
352 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
354 /** The analog value(s). The data is interleaved according to
355 * the channels list. */
359 /** Input (file) format struct. */
362 * A pointer to this input format's 'struct sr_input_format'.
363 * The frontend can use this to call the module's callbacks.
365 struct sr_input_format *format;
369 struct sr_dev_inst *sdi;
374 /** Input (file) format driver. */
375 struct sr_input_format {
376 /** The unique ID for this input format. Must not be NULL. */
380 * A short description of the input format, which can (for example)
381 * be displayed to the user by frontends. Must not be NULL.
386 * Check if this input module can load and parse the specified file.
388 * @param[in] filename The name (and path) of the file to check.
390 * @retval TRUE This module knows the format.
391 * @retval FALSE This module does not know the format.
393 int (*format_match) (const char *filename);
396 * Initialize the input module.
398 * @param in A pointer to a valid 'struct sr_input' that the caller
399 * has to allocate and provide to this function. It is also
400 * the responsibility of the caller to free it later.
401 * @param[in] filename The name (and path) of the file to use.
403 * @retval SR_OK Success
404 * @retval other Negative error code.
406 int (*init) (struct sr_input *in, const char *filename);
409 * Load a file, parsing the input according to the file's format.
411 * This function will send datafeed packets to the session bus, so
412 * the calling frontend must have registered its session callbacks
415 * The packet types sent across the session bus by this function must
416 * include at least SR_DF_HEADER, SR_DF_END, and an appropriate data
417 * type such as SR_DF_LOGIC. It may also send a SR_DF_TRIGGER packet
420 * @param in A pointer to a valid 'struct sr_input' that the caller
421 * has to allocate and provide to this function. It is also
422 * the responsibility of the caller to free it later.
423 * @param filename The name (and path) of the file to use.
425 * @retval SR_OK Success
426 * @retval other Negative error code.
428 int (*loadfile) (struct sr_input *in, const char *filename);
431 /** Output (file) format struct. */
433 /** A pointer to this output's format. */
434 struct sr_output_format *format;
437 * The device for which this output module is creating output. This
438 * can be used by the module to find out channel names and numbers.
440 const struct sr_dev_inst *sdi;
443 * An optional parameter which the frontend can pass in to the
444 * output module. How the string is interpreted is entirely up to
450 * A generic pointer which can be used by the module to keep internal
451 * state between calls into its callback functions.
453 * For example, the module might store a pointer to a chunk of output
454 * there, and only flush it when it reaches a certain size.
459 /** Output (file) format driver. */
460 struct sr_output_format {
462 * A unique ID for this output format. Must not be NULL.
464 * It can be used by frontends to select this output format for use.
466 * For example, calling sigrok-cli with <code>-O hex</code> will
467 * select the hexadecimal text output format.
472 * A short description of the output format. Must not be NULL.
474 * This can be displayed by frontends, e.g. when selecting the output
475 * format for saving a file.
480 * This function is called once, at the beginning of an output stream.
482 * The device struct will be available in the output struct passed in,
483 * as well as the param field -- which may be NULL or an empty string,
484 * if no parameter was passed.
486 * The module can use this to initialize itself, create a struct for
487 * keeping state and storing it in the <code>internal</code> field.
489 * @param o Pointer to the respective 'struct sr_output'.
491 * @retval SR_OK Success
492 * @retval other Negative error code.
494 int (*init) (struct sr_output *o);
497 * This function is passed a copy of every packed in the data feed.
498 * Any output generated by the output module in response to the
499 * packet should be returned in a newly allocated GString
500 * <code>out</code>, which will be freed by the caller.
502 * Packets not of interest to the output module can just be ignored,
503 * and the <code>out</code> parameter set to NULL.
505 * @param o Pointer to the respective 'struct sr_output'.
506 * @param sdi The device instance that generated the packet.
507 * @param packet The complete packet.
508 * @param out A pointer where a GString * should be stored if
509 * the module generates output, or NULL if not.
511 * @retval SR_OK Success
512 * @retval other Negative error code.
514 int (*receive) (struct sr_output *o,
515 const struct sr_datafeed_packet *packet, GString **out);
518 * This function is called after the caller is finished using
519 * the output module, and can be used to free any internal
520 * resources the module may keep.
522 * @retval SR_OK Success
523 * @retval other Negative error code.
525 int (*cleanup) (struct sr_output *o);
528 /** Constants for channel type. */
529 enum sr_channeltype {
530 /** Channel type is logic channel. */
531 SR_CHANNEL_LOGIC = 10000,
532 /** Channel type is analog channel. */
536 /** Information on single channel. */
538 /** Number of channels, starting at 0. */
540 /** Channel type (SR_CHANNEL_LOGIC, ...) */
542 /** Is this channel enabled? */
544 /** Name of channel. */
546 /** Trigger string, format like used by sigrok-cli */
550 /** Structure for groups of channels that have common properties. */
551 struct sr_channel_group {
552 /** Name of the channel group. */
554 /** List of sr_channel structs of the channels belonging to this group. */
556 /** Private data for driver use. */
560 /** Used for setting or getting value of a config item. */
562 /** Config key like SR_CONF_CONN, etc. */
564 /** Key-specific data. */
568 /** Information about a config key. */
569 struct sr_config_info {
570 /** Config key like SR_CONF_CONN, etc. */
572 /** Data type like SR_T_CHAR, etc. */
574 /** Id string, e.g. "serialcomm". */
576 /** Name, e.g. "Serial communication". */
578 /** Verbose description (unused currently). */
582 /** Constants for device classes */
584 /*--- Device classes ------------------------------------------------*/
586 /** The device can act as logic analyzer. */
587 SR_CONF_LOGIC_ANALYZER = 10000,
589 /** The device can act as an oscilloscope. */
590 SR_CONF_OSCILLOSCOPE,
592 /** The device can act as a multimeter. */
595 /** The device is a demo device. */
598 /** The device can act as a sound level meter. */
599 SR_CONF_SOUNDLEVELMETER,
601 /** The device can measure temperature. */
604 /** The device can measure humidity. */
607 /** The device can measure energy consumption. */
610 /** The device can demodulate signals. */
613 /** Programmable power supply. */
614 SR_CONF_POWER_SUPPLY,
616 /*--- Driver scan options -------------------------------------------*/
619 * Specification on how to connect to a device.
621 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
622 * the form which makes sense to the OS (e.g., /dev/ttyS0).
623 * Otherwise this specifies a USB device, either in the form of
624 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
625 * @verbatim <vendorid>.<productid> @endverbatim
626 * (hexadecimal, e.g. 1d6b.0001).
628 SR_CONF_CONN = 20000,
631 * Serial communication specification, in the form:
633 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
637 * The string may also be followed by one or more special settings,
638 * in the form "/key=value". Supported keys and their values are:
640 * rts 0,1 set the port's RTS pin to low or high
641 * dtr 0,1 set the port's DTR pin to low or high
642 * flow 0 no flow control
643 * 1 hardware-based (RTS/CTS) flow control
644 * 2 software-based (XON/XOFF) flow control
646 * This is always an optional parameter, since a driver typically
647 * knows the speed at which the device wants to communicate.
651 /*--- Device configuration ------------------------------------------*/
653 /** The device supports setting its samplerate, in Hz. */
654 SR_CONF_SAMPLERATE = 30000,
656 /** The device supports setting a pre/post-trigger capture ratio. */
657 SR_CONF_CAPTURE_RATIO,
659 /** The device supports setting a pattern (pattern generator mode). */
660 SR_CONF_PATTERN_MODE,
662 /** The device supports Run Length Encoding. */
665 /** The device supports setting trigger slope. */
666 SR_CONF_TRIGGER_SLOPE,
668 /** Trigger source. */
669 SR_CONF_TRIGGER_SOURCE,
671 /** Horizontal trigger position. */
672 SR_CONF_HORIZ_TRIGGERPOS,
689 /** Trigger types. */
690 SR_CONF_TRIGGER_TYPE,
692 /** The device supports setting its sample interval, in ms. */
693 SR_CONF_SAMPLE_INTERVAL,
695 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
696 SR_CONF_NUM_TIMEBASE,
698 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
701 /** Sound pressure level frequency weighting. */
702 SR_CONF_SPL_WEIGHT_FREQ,
704 /** Sound pressure level time weighting. */
705 SR_CONF_SPL_WEIGHT_TIME,
707 /** Sound pressure level measurement range. */
708 SR_CONF_SPL_MEASUREMENT_RANGE,
710 /** Max hold mode. */
713 /** Min hold mode. */
716 /** Logic low-high threshold range. */
717 SR_CONF_VOLTAGE_THRESHOLD,
719 /** The device supports using an external clock. */
720 SR_CONF_EXTERNAL_CLOCK,
723 * The device supports swapping channels. Typical this is between
724 * buffered and unbuffered channels.
728 /** Center frequency.
729 * The input signal is downmixed by this frequency before the ADC
730 * anti-aliasing filter.
732 SR_CONF_CENTER_FREQUENCY,
734 /** The device supports setting the number of logic channels. */
735 SR_CONF_NUM_LOGIC_CHANNELS,
737 /** The device supports setting the number of analog channels. */
738 SR_CONF_NUM_ANALOG_CHANNELS,
740 /** Output voltage. */
741 SR_CONF_OUTPUT_VOLTAGE,
743 /** Maximum output voltage. */
744 SR_CONF_OUTPUT_VOLTAGE_MAX,
746 /** Output current. */
747 SR_CONF_OUTPUT_CURRENT,
749 /** Maximum output current. */
750 SR_CONF_OUTPUT_CURRENT_MAX,
752 /** Enabling/disabling output. */
753 SR_CONF_OUTPUT_ENABLED,
755 /** Channel output configuration. */
756 SR_CONF_OUTPUT_CHANNEL,
758 /** Over-voltage protection (OVP) */
759 SR_CONF_OVER_VOLTAGE_PROTECTION,
761 /** Over-current protection (OCP) */
762 SR_CONF_OVER_CURRENT_PROTECTION,
764 /** Choice of clock edge for external clock ("r" or "f"). */
767 /*--- Special stuff -------------------------------------------------*/
769 /** Scan options supported by the driver. */
770 SR_CONF_SCAN_OPTIONS = 40000,
772 /** Device options for a particular device. */
773 SR_CONF_DEVICE_OPTIONS,
775 /** Session filename. */
778 /** The device supports specifying a capturefile to inject. */
781 /** The device supports specifying the capturefile unit size. */
782 SR_CONF_CAPTURE_UNITSIZE,
784 /** Power off the device. */
788 * Data source for acquisition. If not present, acquisition from
789 * the device is always "live", i.e. acquisition starts when the
790 * frontend asks and the results are sent out as soon as possible.
792 * If present, it indicates that either the device has no live
793 * acquisition capability (for example a pure data logger), or
794 * there is a choice. sr_config_list() returns those choices.
796 * In any case if a device has live acquisition capabilities, it
797 * is always the default.
801 /*--- Acquisition modes ---------------------------------------------*/
804 * The device supports setting a sample time limit (how long
805 * the sample acquisition should run, in ms).
807 SR_CONF_LIMIT_MSEC = 50000,
810 * The device supports setting a sample number limit (how many
811 * samples should be acquired).
813 SR_CONF_LIMIT_SAMPLES,
816 * The device supports setting a frame limit (how many
817 * frames should be acquired).
819 SR_CONF_LIMIT_FRAMES,
822 * The device supports continuous sampling. Neither a time limit
823 * nor a sample number limit has to be supplied, it will just acquire
824 * samples continuously, until explicitly stopped by a certain command.
828 /** The device has internal storage, into which data is logged. This
829 * starts or stops the internal logging. */
832 /** Device mode for multi-function devices. */
835 /** Self test mode. */
839 /** Device instance data
842 /** Device driver. */
843 struct sr_dev_driver *driver;
844 /** Index of device in driver. */
846 /** Device instance status. SR_ST_NOT_FOUND, etc. */
848 /** Device instance type. SR_INST_USB, etc. */
850 /** Device vendor. */
854 /** Device version. */
856 /** List of channels. */
858 /** List of sr_channel_group structs */
859 GSList *channel_groups;
860 /** Device instance connection data (used?) */
862 /** Device instance private data (used?) */
866 /** Types of device instance, struct sr_dev_inst.type */
867 enum sr_dev_inst_type {
868 /** Device instance type for USB devices. */
870 /** Device instance type for serial port devices. */
872 /** Device instance type for SCPI devices. */
876 /** Device instance status, struct sr_dev_inst.status */
877 enum sr_dev_inst_status {
878 /** The device instance was not found. */
879 SR_ST_NOT_FOUND = 10000,
880 /** The device instance was found, but is still booting. */
882 /** The device instance is live, but not in use. */
884 /** The device instance is actively in use in a session. */
886 /** The device is winding down its session. */
890 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
891 struct sr_dev_driver {
892 /* Driver-specific */
893 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
895 /** Long name. Verbose driver name shown to user. */
897 /** API version (currently 1). */
899 /** Called when driver is loaded, e.g. program startup. */
900 int (*init) (struct sr_context *sr_ctx);
901 /** Called before driver is unloaded.
902 * Driver must free all resouces held by it. */
903 int (*cleanup) (void);
904 /** Scan for devices. Driver should do all initialisation required.
905 * Can be called several times, e.g. with different port options.
906 * \retval NULL Error or no devices found.
907 * \retval other GSList of a struct sr_dev_inst for each device.
908 * Must be freed by caller!
910 GSList *(*scan) (GSList *options);
911 /** Get list of device instances the driver knows about.
912 * \returns NULL or GSList of a struct sr_dev_inst for each device.
913 * Must not be freed by caller!
915 GSList *(*dev_list) (void);
916 /** Clear list of devices the driver knows about. */
917 int (*dev_clear) (void);
918 /** Query value of a configuration key in driver or given device instance.
919 * @see sr_config_get().
921 int (*config_get) (int id, GVariant **data,
922 const struct sr_dev_inst *sdi,
923 const struct sr_channel_group *cg);
924 /** Set value of a configuration key in driver or a given device instance.
925 * @see sr_config_set(). */
926 int (*config_set) (int id, GVariant *data,
927 const struct sr_dev_inst *sdi,
928 const struct sr_channel_group *cg);
929 /** Channel status change.
930 * @see sr_dev_channel_enable(), sr_dev_trigger_set(). */
931 int (*config_channel_set) (const struct sr_dev_inst *sdi,
932 struct sr_channel *ch, unsigned int changes);
933 /** Apply configuration settings to the device hardware.
934 * @see sr_config_commit().*/
935 int (*config_commit) (const struct sr_dev_inst *sdi);
936 /** List all possible values for a configuration key in a device instance.
937 * @see sr_config_list().
939 int (*config_list) (int info_id, GVariant **data,
940 const struct sr_dev_inst *sdi,
941 const struct sr_channel_group *cg);
943 /* Device-specific */
945 int (*dev_open) (struct sr_dev_inst *sdi);
947 int (*dev_close) (struct sr_dev_inst *sdi);
948 /** Begin data acquisition on the specified device. */
949 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
951 /** End data acquisition on the specified device. */
952 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
956 /** Device driver private data. Initialized by init(). */
963 * Opaque data structure representing a libsigrok session. None of the fields
964 * of this structure are meant to be accessed directly.