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,
204 /** Parallel inductance (LCR meter model). */
205 SR_MQ_PARALLEL_INDUCTANCE,
206 /** Parallel capacitance (LCR meter model). */
207 SR_MQ_PARALLEL_CAPACITANCE,
208 /** Parallel resistance (LCR meter model). */
209 SR_MQ_PARALLEL_RESISTANCE,
210 /** Serial inductance (LCR meter model). */
211 SR_MQ_SERIAL_INDUCTANCE,
212 /** Serial capacitance (LCR meter model). */
213 SR_MQ_SERIAL_CAPACITANCE,
214 /** Serial resistance (LCR meter model). */
215 SR_MQ_SERIAL_RESISTANCE,
216 /** Dissipation factor. */
217 SR_MQ_DISSIPATION_FACTOR,
218 /** Quality factor. */
219 SR_MQ_QUALITY_FACTOR,
222 /** Difference from reference value. */
226 /** Unit of measured quantity, sr_datafeed_analog.unit. */
229 SR_UNIT_VOLT = 10000,
230 /** Ampere (current). */
232 /** Ohm (resistance). */
234 /** Farad (capacity). */
236 /** Kelvin (temperature). */
238 /** Degrees Celsius (temperature). */
240 /** Degrees Fahrenheit (temperature). */
242 /** Hertz (frequency, 1/s, [Hz]). */
244 /** Percent value. */
246 /** Boolean value. */
248 /** Time in seconds. */
250 /** Unit of conductance, the inverse of resistance. */
253 * An absolute measurement of power, in decibels, referenced to
257 /** Voltage in decibel, referenced to 1 volt (dBV). */
258 SR_UNIT_DECIBEL_VOLT,
260 * Measurements that intrinsically do not have units attached, such
261 * as ratios, gains, etc. Specifically, a transistor's gain (hFE) is
262 * a unitless quantity, for example.
265 /** Sound pressure level, in decibels, relative to 20 micropascals. */
268 * Normalized (0 to 1) concentration of a substance or compound with 0
269 * representing a concentration of 0%, and 1 being 100%. This is
270 * represented as the fraction of number of particles of the substance.
272 SR_UNIT_CONCENTRATION,
273 /** Revolutions per minute. */
274 SR_UNIT_REVOLUTIONS_PER_MINUTE,
275 /** Apparent power [VA]. */
277 /** Real power [W]. */
279 /** Consumption [Wh]. */
281 /** Wind speed in meters per second. */
282 SR_UNIT_METER_SECOND,
283 /** Pressure in hectopascal */
285 /** Relative humidity assuming air temperature of 293 kelvin (%rF). */
286 SR_UNIT_HUMIDITY_293K,
287 /** Plane angle in 1/360th of a full circle. */
289 /** Henry (inductance). */
293 /** Values for sr_datafeed_analog.flags. */
295 /** Voltage measurement is alternating current (AC). */
297 /** Voltage measurement is direct current (DC). */
299 /** This is a true RMS measurement. */
300 SR_MQFLAG_RMS = 0x04,
301 /** Value is voltage drop across a diode, or NAN. */
302 SR_MQFLAG_DIODE = 0x08,
303 /** Device is in "hold" mode (repeating the last measurement). */
304 SR_MQFLAG_HOLD = 0x10,
305 /** Device is in "max" mode, only updating upon a new max value. */
306 SR_MQFLAG_MAX = 0x20,
307 /** Device is in "min" mode, only updating upon a new min value. */
308 SR_MQFLAG_MIN = 0x40,
309 /** Device is in autoranging mode. */
310 SR_MQFLAG_AUTORANGE = 0x80,
311 /** Device is in relative mode. */
312 SR_MQFLAG_RELATIVE = 0x100,
313 /** Sound pressure level is A-weighted in the frequency domain,
314 * according to IEC 61672:2003. */
315 SR_MQFLAG_SPL_FREQ_WEIGHT_A = 0x200,
316 /** Sound pressure level is C-weighted in the frequency domain,
317 * according to IEC 61672:2003. */
318 SR_MQFLAG_SPL_FREQ_WEIGHT_C = 0x400,
319 /** Sound pressure level is Z-weighted (i.e. not at all) in the
320 * frequency domain, according to IEC 61672:2003. */
321 SR_MQFLAG_SPL_FREQ_WEIGHT_Z = 0x800,
322 /** Sound pressure level is not weighted in the frequency domain,
323 * albeit without standards-defined low and high frequency limits. */
324 SR_MQFLAG_SPL_FREQ_WEIGHT_FLAT = 0x1000,
325 /** Sound pressure level measurement is S-weighted (1s) in the
327 SR_MQFLAG_SPL_TIME_WEIGHT_S = 0x2000,
328 /** Sound pressure level measurement is F-weighted (125ms) in the
330 SR_MQFLAG_SPL_TIME_WEIGHT_F = 0x4000,
331 /** Sound pressure level is time-averaged (LAT), also known as
332 * Equivalent Continuous A-weighted Sound Level (LEQ). */
333 SR_MQFLAG_SPL_LAT = 0x8000,
334 /** Sound pressure level represented as a percentage of measurements
335 * that were over a preset alarm level. */
336 SR_MQFLAG_SPL_PCT_OVER_ALARM = 0x10000,
337 /** Time is duration (as opposed to epoch, ...). */
338 SR_MQFLAG_DURATION = 0x20000,
339 /** Device is in "avg" mode, averaging upon each new value. */
340 SR_MQFLAG_AVG = 0x40000,
341 /** Reference value shown. */
342 SR_MQFLAG_REFERENCE = 0x80000,
345 enum sr_trigger_matches {
355 /** The representation of a trigger, consisting of one or more stages
356 * containing one or more matches on a channel.
359 /** A name for this trigger. This may be NULL if none is needed. */
361 /** List of pointers to struct sr_trigger_stage. */
365 /** A trigger stage. */
366 struct sr_trigger_stage {
369 /** List of pointers to struct sr_trigger_match. */
373 /** A channel to match and what to match it on. */
374 struct sr_trigger_match {
375 /** The channel to trigger on. */
376 struct sr_channel *channel;
377 /** The trigger match to use.
378 * For logic channels, only the following matches may be used:
385 * For analog channels, only these matches may be used:
393 /** If the trigger match is one of SR_TRIGGER_OVER or SR_TRIGGER_UNDER,
394 * this contains the value to compare against. */
400 * Opaque structure representing a libsigrok context.
402 * None of the fields of this structure are meant to be accessed directly.
404 * @see sr_init(), sr_exit().
410 * Opaque structure representing a libsigrok session.
412 * None of the fields of this structure are meant to be accessed directly.
414 * @see sr_session_new(), sr_session_destroy().
418 /** Packet in a sigrok data feed. */
419 struct sr_datafeed_packet {
424 /** Header of a sigrok data feed. */
425 struct sr_datafeed_header {
427 struct timeval starttime;
430 /** Datafeed payload for type SR_DF_META. */
431 struct sr_datafeed_meta {
435 /** Logic datafeed payload for type SR_DF_LOGIC. */
436 struct sr_datafeed_logic {
442 /** Analog datafeed payload for type SR_DF_ANALOG. */
443 struct sr_datafeed_analog {
444 /** The channels for which data is included in this packet. */
446 /** Number of samples in data */
448 /** Measured quantity (voltage, current, temperature, and so on).
449 * Use SR_MQ_VOLTAGE, ... */
451 /** Unit in which the MQ is measured. Use SR_UNIT_VOLT, ... */
453 /** Bitmap with extra information about the MQ. Use SR_MQFLAG_AC, ... */
455 /** The analog value(s). The data is interleaved according to
456 * the channels list. */
460 /** Generic option struct used by various subsystems. */
462 /* Short name suitable for commandline usage, [a-z0-9-]. */
464 /* Short name suitable for GUI usage, can contain UTF-8. */
466 /* Description of the option, in a sentence. */
468 /* Default value for this option. */
470 /* List of possible values, if this is an option with few values. */
475 struct sr_input_module;
477 struct sr_output_module;
479 /** Constants for channel type. */
480 enum sr_channeltype {
481 /** Channel type is logic channel. */
482 SR_CHANNEL_LOGIC = 10000,
483 /** Channel type is analog channel. */
487 /** Information on single channel. */
489 /** The index of this channel, starting at 0. Logic channels will
490 * be encoded according to this index in SR_DF_LOGIC packets. */
492 /** Channel type (SR_CHANNEL_LOGIC, ...) */
494 /** Is this channel enabled? */
496 /** Name of channel. */
498 /** Private data for driver use. */
502 /** Structure for groups of channels that have common properties. */
503 struct sr_channel_group {
504 /** Name of the channel group. */
506 /** List of sr_channel structs of the channels belonging to this group. */
508 /** Private data for driver use. */
512 /** Used for setting or getting value of a config item. */
514 /** Config key like SR_CONF_CONN, etc. */
516 /** Key-specific data. */
520 /** Information about a config key. */
521 struct sr_config_info {
522 /** Config key like SR_CONF_CONN, etc. */
524 /** Data type like SR_T_STRING, etc. */
526 /** Id string, e.g. "serialcomm". */
528 /** Name, e.g. "Serial communication". */
530 /** Verbose description (unused currently). */
534 #define SR_CONF_GET (1 << 31)
535 #define SR_CONF_SET (1 << 30)
536 #define SR_CONF_LIST (1 << 29)
537 #define SR_CONF_MASK 0x1fffffff
539 /** Constants for device classes */
541 /*--- Device classes ------------------------------------------------*/
543 /** The device can act as logic analyzer. */
544 SR_CONF_LOGIC_ANALYZER = 10000,
546 /** The device can act as an oscilloscope. */
547 SR_CONF_OSCILLOSCOPE,
549 /** The device can act as a multimeter. */
552 /** The device is a demo device. */
555 /** The device can act as a sound level meter. */
556 SR_CONF_SOUNDLEVELMETER,
558 /** The device can measure temperature. */
561 /** The device can measure humidity. */
564 /** The device can measure energy consumption. */
567 /** The device can demodulate signals. */
570 /** Programmable power supply. */
571 SR_CONF_POWER_SUPPLY,
573 /*--- Driver scan options -------------------------------------------*/
576 * Specification on how to connect to a device.
578 * In combination with SR_CONF_SERIALCOMM, this is a serial port in
579 * the form which makes sense to the OS (e.g., /dev/ttyS0).
580 * Otherwise this specifies a USB device, either in the form of
581 * @verbatim <bus>.<address> @endverbatim (decimal, e.g. 1.65) or
582 * @verbatim <vendorid>.<productid> @endverbatim
583 * (hexadecimal, e.g. 1d6b.0001).
585 SR_CONF_CONN = 20000,
588 * Serial communication specification, in the form:
590 * @verbatim <baudrate>/<databits><parity><stopbits> @endverbatim
594 * The string may also be followed by one or more special settings,
595 * in the form "/key=value". Supported keys and their values are:
597 * rts 0,1 set the port's RTS pin to low or high
598 * dtr 0,1 set the port's DTR pin to low or high
599 * flow 0 no flow control
600 * 1 hardware-based (RTS/CTS) flow control
601 * 2 software-based (XON/XOFF) flow control
603 * This is always an optional parameter, since a driver typically
604 * knows the speed at which the device wants to communicate.
608 /*--- Device configuration ------------------------------------------*/
610 /** The device supports setting its samplerate, in Hz. */
611 SR_CONF_SAMPLERATE = 30000,
613 /** The device supports setting a pre/post-trigger capture ratio. */
614 SR_CONF_CAPTURE_RATIO,
616 /** The device supports setting a pattern (pattern generator mode). */
617 SR_CONF_PATTERN_MODE,
619 /** The device supports Run Length Encoding. */
622 /** The device supports setting trigger slope. */
623 SR_CONF_TRIGGER_SLOPE,
625 /** Trigger source. */
626 SR_CONF_TRIGGER_SOURCE,
628 /** Horizontal trigger position. */
629 SR_CONF_HORIZ_TRIGGERPOS,
646 /** Trigger matches. */
647 SR_CONF_TRIGGER_MATCH,
649 /** The device supports setting its sample interval, in ms. */
650 SR_CONF_SAMPLE_INTERVAL,
652 /** Number of timebases, as related to SR_CONF_TIMEBASE. */
653 SR_CONF_NUM_TIMEBASE,
655 /** Number of vertical divisions, as related to SR_CONF_VDIV. */
658 /** Sound pressure level frequency weighting. */
659 SR_CONF_SPL_WEIGHT_FREQ,
661 /** Sound pressure level time weighting. */
662 SR_CONF_SPL_WEIGHT_TIME,
664 /** Sound pressure level measurement range. */
665 SR_CONF_SPL_MEASUREMENT_RANGE,
667 /** Max hold mode. */
670 /** Min hold mode. */
673 /** Logic low-high threshold range. */
674 SR_CONF_VOLTAGE_THRESHOLD,
676 /** The device supports using an external clock. */
677 SR_CONF_EXTERNAL_CLOCK,
680 * The device supports swapping channels. Typical this is between
681 * buffered and unbuffered channels.
685 /** Center frequency.
686 * The input signal is downmixed by this frequency before the ADC
687 * anti-aliasing filter.
689 SR_CONF_CENTER_FREQUENCY,
691 /** The device supports setting the number of logic channels. */
692 SR_CONF_NUM_LOGIC_CHANNELS,
694 /** The device supports setting the number of analog channels. */
695 SR_CONF_NUM_ANALOG_CHANNELS,
700 * @arg get: get output voltage
702 SR_CONF_OUTPUT_VOLTAGE,
705 * Maximum output voltage.
707 * @arg get: get maximum output voltage limit
708 * @arg set: change output voltage limit
710 SR_CONF_OUTPUT_VOLTAGE_MAX,
715 * @arg get: get output current
717 SR_CONF_OUTPUT_CURRENT,
720 * Maximum output current.
722 * @arg get: get maximum output voltage limit
723 * @arg set: change output voltage limit
725 SR_CONF_OUTPUT_CURRENT_MAX,
728 * Enabling/disabling output.
730 * @arg get: @b true if currently enabled
731 * @arg set: enable/disable
733 SR_CONF_OUTPUT_ENABLED,
736 * Output channel configuration.
738 * @arg get: get current setting
739 * @arg set: change current setting
740 * @arg list: array of possible values
742 SR_CONF_OUTPUT_CHANNEL_CONFIG,
745 * Over-voltage protection (OVP) feature
747 * @arg get: @b true if currently enabled
748 * @arg set: enable/disable
750 SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED,
753 * Over-voltage protection (OVP) active
755 * @arg get: @b true if device has activated OVP, i.e. the output voltage
756 * exceeds the over-voltage protection threshold.
758 SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE,
761 * Over-voltage protection (OVP) threshold
762 * @arg type: double (voltage)
763 * @arg get: get current threshold
764 * @arg set: set new threshold
766 SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD,
769 * Over-current protection (OCP) feature
771 * @arg get: @b true if currently enabled
772 * @arg set: enable/disable
774 SR_CONF_OVER_CURRENT_PROTECTION_ENABLED,
777 * Over-current protection (OCP) active
779 * @arg get: @b true if device has activated OCP, i.e. the output current
780 * exceeds the over-current protection threshold.
782 SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE,
785 * Over-current protection (OCP) threshold
786 * @arg type: double (current)
787 * @arg get: get current threshold
788 * @arg set: set new threshold
790 SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD,
792 /** Choice of clock edge for external clock ("r" or "f"). */
795 /** Amplitude of a source without strictly-defined MQ. */
799 * Output channel regulation
800 * get: "CV", "CC" or "UR", denoting constant voltage, constant current
803 SR_CONF_OUTPUT_REGULATION,
805 /** Over-temperature protection (OTP) */
806 SR_CONF_OVER_TEMPERATURE_PROTECTION,
808 /*--- Special stuff -------------------------------------------------*/
810 /** Scan options supported by the driver. */
811 SR_CONF_SCAN_OPTIONS = 40000,
813 /** Device options for a particular device. */
814 SR_CONF_DEVICE_OPTIONS,
816 /** Session filename. */
819 /** The device supports specifying a capturefile to inject. */
822 /** The device supports specifying the capturefile unit size. */
823 SR_CONF_CAPTURE_UNITSIZE,
825 /** Power off the device. */
829 * Data source for acquisition. If not present, acquisition from
830 * the device is always "live", i.e. acquisition starts when the
831 * frontend asks and the results are sent out as soon as possible.
833 * If present, it indicates that either the device has no live
834 * acquisition capability (for example a pure data logger), or
835 * there is a choice. sr_config_list() returns those choices.
837 * In any case if a device has live acquisition capabilities, it
838 * is always the default.
842 /*--- Acquisition modes ---------------------------------------------*/
845 * The device supports setting a sample time limit (how long
846 * the sample acquisition should run, in ms).
848 SR_CONF_LIMIT_MSEC = 50000,
851 * The device supports setting a sample number limit (how many
852 * samples should be acquired).
854 SR_CONF_LIMIT_SAMPLES,
857 * The device supports setting a frame limit (how many
858 * frames should be acquired).
860 SR_CONF_LIMIT_FRAMES,
863 * The device supports continuous sampling. Neither a time limit
864 * nor a sample number limit has to be supplied, it will just acquire
865 * samples continuously, until explicitly stopped by a certain command.
869 /** The device has internal storage, into which data is logged. This
870 * starts or stops the internal logging. */
873 /** Device mode for multi-function devices. */
876 /** Self test mode. */
880 /** Device instance data
883 /** Device driver. */
884 struct sr_dev_driver *driver;
885 /** Device instance status. SR_ST_NOT_FOUND, etc. */
887 /** Device instance type. SR_INST_USB, etc. */
889 /** Device vendor. */
893 /** Device version. */
895 /** Serial number. */
897 /** Connection string to uniquely identify devices. */
899 /** List of channels. */
901 /** List of sr_channel_group structs */
902 GSList *channel_groups;
903 /** Device instance connection data (used?) */
905 /** Device instance private data (used?) */
907 /** Session to which this device is currently assigned. */
908 struct sr_session *session;
911 /** Types of device instance, struct sr_dev_inst.type */
912 enum sr_dev_inst_type {
913 /** Device instance type for USB devices. */
915 /** Device instance type for serial port devices. */
917 /** Device instance type for SCPI devices. */
921 /** Device instance status, struct sr_dev_inst.status */
922 enum sr_dev_inst_status {
923 /** The device instance was not found. */
924 SR_ST_NOT_FOUND = 10000,
925 /** The device instance was found, but is still booting. */
927 /** The device instance is live, but not in use. */
929 /** The device instance is actively in use in a session. */
931 /** The device is winding down its session. */
935 /** Device driver data. See also http://sigrok.org/wiki/Hardware_driver_API . */
936 struct sr_dev_driver {
937 /* Driver-specific */
938 /** Driver name. Lowercase a-z, 0-9 and dashes (-) only. */
940 /** Long name. Verbose driver name shown to user. */
942 /** API version (currently 1). */
944 /** Called when driver is loaded, e.g. program startup. */
945 int (*init) (struct sr_context *sr_ctx);
946 /** Called before driver is unloaded.
947 * Driver must free all resouces held by it. */
948 int (*cleanup) (void);
949 /** Scan for devices. Driver should do all initialisation required.
950 * Can be called several times, e.g. with different port options.
951 * \retval NULL Error or no devices found.
952 * \retval other GSList of a struct sr_dev_inst for each device.
953 * Must be freed by caller!
955 GSList *(*scan) (GSList *options);
956 /** Get list of device instances the driver knows about.
957 * \returns NULL or GSList of a struct sr_dev_inst for each device.
958 * Must not be freed by caller!
960 GSList *(*dev_list) (void);
961 /** Clear list of devices the driver knows about. */
962 int (*dev_clear) (void);
963 /** Query value of a configuration key in driver or given device instance.
964 * @see sr_config_get().
966 int (*config_get) (uint32_t key, GVariant **data,
967 const struct sr_dev_inst *sdi,
968 const struct sr_channel_group *cg);
969 /** Set value of a configuration key in driver or a given device instance.
970 * @see sr_config_set(). */
971 int (*config_set) (uint32_t key, GVariant *data,
972 const struct sr_dev_inst *sdi,
973 const struct sr_channel_group *cg);
974 /** Channel status change.
975 * @see sr_dev_channel_enable(). */
976 int (*config_channel_set) (const struct sr_dev_inst *sdi,
977 struct sr_channel *ch, unsigned int changes);
978 /** Apply configuration settings to the device hardware.
979 * @see sr_config_commit().*/
980 int (*config_commit) (const struct sr_dev_inst *sdi);
981 /** List all possible values for a configuration key in a device instance.
982 * @see sr_config_list().
984 int (*config_list) (uint32_t key, GVariant **data,
985 const struct sr_dev_inst *sdi,
986 const struct sr_channel_group *cg);
988 /* Device-specific */
990 int (*dev_open) (struct sr_dev_inst *sdi);
992 int (*dev_close) (struct sr_dev_inst *sdi);
993 /** Begin data acquisition on the specified device. */
994 int (*dev_acquisition_start) (const struct sr_dev_inst *sdi,
996 /** End data acquisition on the specified device. */
997 int (*dev_acquisition_stop) (struct sr_dev_inst *sdi,
1001 /** Device driver private data. Initialized by init(). */
1006 * @struct sr_session
1008 * Opaque data structure representing a libsigrok session. None of the fields
1009 * of this structure are meant to be accessed directly.
1014 #include "version.h"